CoreGeneralPort.h

 
#ifndef MCXA153_B31BFF6B_C1BE_4E18_A7EE_2B374A8352B8
#define MCXA153_B31BFF6B_C1BE_4E18_A7EE_2B374A8352B8
 
/* ***************************************************************************************
 * Include
 */
#include "mframe.h"
 
//----------------------------------------------------------------------------------------
#include "./CoreDescriptor.h"
 
//----------------------------------------------------------------------------------------
 
/* ***************************************************************************************
 * Namespace
 */
namespace mcxa153::core {
  class CoreGeneralPort;
}  // namespace mcxa153::core
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
class mcxa153::core::CoreGeneralPort : public ufm::lang::Object,
                                       public hal::digital::GeneralPort {
  /* *************************************************************************************
   * Enum - Select
   */
 public:
  enum struct Select : unsigned char;
 
  struct Descriptor {
    mcxa153::chip::clock::GateName vGateName;
    mcxa153::chip::reset::Control  vControl;
    mcxa153::chip::clock::GateName vPortGateName;
    mcxa153::chip::reset::Control  vPortControl;
    uint32                         vMask;
  };
 
  /* *************************************************************************************
   * Variable
   */
 public:
  mcxa153::chip::gpio::Register* const vBase;
 
  mcxa153::chip::port::Register* const vBasePort;
 
  const Descriptor* const vDescriptor;
 
  /* *************************************************************************************
   * override Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  CoreGeneralPort(Select select);
 
  virtual ~CoreGeneralPort(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 
  /* *************************************************************************************
   * Override Method  hal::Base
   */
 public:
  virtual bool deinit(void) override;
 
  virtual bool init(void) override;
 
  virtual bool isInit(void) override;
 
  /* *************************************************************************************
   * Override Method  hal::digital::GeneralPort
   */
 public:
  virtual uint32 dir(uint32 port) override;
 
  virtual hal::digital::GeneralPort& dir(uint32 port, uint32 value) override;
 
  virtual hal::digital::GeneralPort& dirClear(uint32 port, uint32 mask) override;
 
  virtual hal::digital::GeneralPort& dirSet(uint32 port, uint32 mask) override;
 
  virtual uint32 pin(uint32 port) override;
 
  virtual hal::digital::GeneralPort& pin(uint32 port, uint32 value) override;
 
  virtual hal::digital::GeneralPort& pinClear(uint32 port, uint32 mask) override;
 
  virtual hal::digital::GeneralPort& pinSet(uint32 port, uint32 mask) override;
 
  virtual hal::digital::GeneralPort& pinToggle(uint32 port, uint32 mask) override;
  /* *************************************************************************************
   * Public Method
   */
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 
  /* *************************************************************************************
   * Static Variable
   */
 public:
  static constexpr const uint32 VALID_MASK[] = {
      // GPIO0
      ((1U << 0) | (1U << 1) | (1U << 2) | (1U << 3) | (1U << 6) | (1U << 16) |
       (1U << 17)),
      // GPIO1
      ((1U << 0) | (1U << 1) | (1U << 2) | (1U << 3) | (1U << 4) | (1U << 5) | (1U << 6) |
       (1U << 7) | (1U << 8) | (1U << 9) | (1U << 10) | (1U << 11) | (1U << 12) |
       (1U << 13) | (1U << 29) | (1U << 30) | (1U << 31)),
      // GPIO2
      ((1U << 0) | (1U << 1) | (1U << 2) | (1U << 3) | (1U << 4) | (1U << 5) | (1U << 6) |
       (1U << 7) | (1U << 12) | (1U << 13) | (1U << 16)),
      // GPIO3
      ((1U << 0) | (1U << 1) | (1U << 6) | (1U << 7) | (1U << 8) | (1U << 9) |
       (1U << 10) | (1U << 11) | (1U << 12) | (1U << 13) | (1U << 14) | (1U << 15) |
       (1U << 27) | (1U << 28) | (1U << 29) | (1U << 30) | (1U << 31))};
 
  static constexpr const Descriptor DESCRIPTORS[] = {
      // GPIO0
      {mcxa153::chip::clock::GateName::GPIO0,
       mcxa153::chip::reset::Control::GPIO0,
       mcxa153::chip::clock::GateName::PORT0,
       mcxa153::chip::reset::Control::PORT0,
       VALID_MASK[0]},
      // GPIO0
      {mcxa153::chip::clock::GateName::GPIO1,
       mcxa153::chip::reset::Control::GPIO1,
       mcxa153::chip::clock::GateName::PORT1,
       mcxa153::chip::reset::Control::PORT1,
       VALID_MASK[1]},
 
      // GPIO0
      {mcxa153::chip::clock::GateName::GPIO2,
       mcxa153::chip::reset::Control::GPIO2,
       mcxa153::chip::clock::GateName::PORT2,
       mcxa153::chip::reset::Control::PORT2,
       VALID_MASK[2]},
 
      // GPIO0
      {mcxa153::chip::clock::GateName::GPIO3,
       mcxa153::chip::reset::Control::GPIO3,
       mcxa153::chip::clock::GateName::PORT3,
       mcxa153::chip::reset::Control::PORT3,
       VALID_MASK[3]}};
 
  /* *************************************************************************************
   * Static Method
   */
 public:
  static inline constexpr mcxa153::chip::port::Register* toPortRegister(Select select) {
    return mcxa153::chip::port::PORT[static_cast<unsigned char>(select)];
  }
 
  static inline constexpr mcxa153::chip::gpio::Register* toRegister(Select select) {
    return mcxa153::chip::gpio::GPIO[static_cast<unsigned char>(select)];
  }
 
  static inline constexpr const Descriptor* toDescriptor(Select select) {
    return &DESCRIPTORS[static_cast<unsigned char>(select)];
  }
};
 
enum struct mcxa153::core::CoreGeneralPort::Select : unsigned char {
  GPIO0 = 0,  
  GPIO1 = 1,  
  GPIO2 = 2,  
  GPIO3 = 3   
};
 
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MCXA153_B31BFF6B_C1BE_4E18_A7EE_2B374A8352B8 */