mcxa153/src/mcxa153/chip/clock/Clock.h

 
#ifndef MCXA153_008A1453_A242_4775_9606_2ED0FF5092CA
#define MCXA153_008A1453_A242_4775_9606_2ED0FF5092CA
 
/* ***************************************************************************************
 * Include
 */
#include "mframe.h"
 
//----------------------------------------------------------------------------------------
#include "./../Status.h"
#include "./../clock/AttachID.h"
#include "./../clock/Div.h"
#include "./../clock/FircTrimConfig.h"
#include "./../clock/GateName.h"
#include "./../clock/MonitorMode.h"
#include "./../clock/Name.h"
#include "./../clock/SelectName.h"
#include "./../clock/SircTrimConfig.h"
#include "./../clock/SircTrimMode.h"
#include "./../clock/SircTrimSource.h"
#include "./../mrcc/MRCC.h"
#include "./../syscon/SYSCON.h"
 
//----------------------------------------------------------------------------------------
 
/* ***************************************************************************************
 * Namespace
 */
namespace mcxa153::chip::clock {
  class Clock;
}
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
 
class mcxa153::chip::clock::Clock final : public ufm::lang::NonInstantiable {
  /* *************************************************************************************
   * Variable
   */
 
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 protected:
  virtual ~Clock(void) override = default;
 
  /* *************************************************************************************
   * Operator Method
   */
 
  /* *************************************************************************************
   * Override Method
   */
 
  /* *************************************************************************************
   * Public Method
   */
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 
  /* *************************************************************************************
   * Static Variable
   */
 public:
  /* *************************************************************************************
   * Static Method
   */
 public:
  static inline constexpr uint32 ATTACH_REG_OFFSET(AttachID attachID) {
    return (+attachID >> 16U);
  }
 
  static inline bool getClockStatus(GateName clk) {
    uint32           reg_offset = mcxa153::chip::clock::getGateNameOffset(clk);
    uint32           bit_shift  = mcxa153::chip::clock::getGateNameShift(clk);
    volatile uint32 *pClkCtrl   = reinterpret_cast<volatile uint32 *>(
        reinterpret_cast<uint32>(&(mcxa153::chip::mrcc::MRCC0.mrcc_glb_cc0_set)) +
        reg_offset);
 
    if (clk == GateName::NOT_AVAIL) return false;
 
    if (reg_offset == REG_PWM0SUBCTL)
      return (mcxa153::chip::mrcc::MRCC0.mrcc_glb_cc0_set &
              +mcxa153::chip::mrcc::Mask::GLB_CC0_FLEXPWM0);
 
    else
      return (*pClkCtrl & (1UL << bit_shift));
  }
 
  static inline void enableClock(GateName clk) {
    uint32           reg_offset = mcxa153::chip::clock::getGateNameOffset(clk);
    uint32           bit_shift  = mcxa153::chip::clock::getGateNameShift(clk);
    volatile uint32 *pClkCtrl   = reinterpret_cast<volatile uint32 *>(
        reinterpret_cast<uint32>(&(mcxa153::chip::mrcc::MRCC0.mrcc_glb_cc0_set)) +
        reg_offset);
 
    if (clk == GateName::NOT_AVAIL) { return; }
 
    /* Unlock clock configuration */
    mcxa153::chip::syscon::SYSCON0.clkunlock &=
        ~+mcxa153::chip::syscon::Mask::CLKUNLOCK_UNLOCK;
 
    if (reg_offset == REG_PWM0SUBCTL) {
      mcxa153::chip::syscon::SYSCON0.pwm0subctl |= (1UL << bit_shift);
      mcxa153::chip::mrcc::MRCC0.mrcc_glb_cc0_set =
          +mcxa153::chip::mrcc::Mask::GLB_CC0_FLEXPWM0;
    } else {
      *pClkCtrl = (1UL << bit_shift);
    }
 
    /* Freeze clock configuration */
    mcxa153::chip::syscon::SYSCON0.clkunlock |=
        +mcxa153::chip::syscon::Mask::CLKUNLOCK_UNLOCK;
  }
 
  static inline void disableClock(GateName clk) {
    uint32           reg_offset = getGateNameOffset(clk);
    uint32           bit_shift  = getGateNameShift(clk);
    volatile uint32 *pClkCtrl   = reinterpret_cast<volatile uint32 *>(
        reinterpret_cast<uint32>(&(mcxa153::chip::mrcc::MRCC0.mrcc_glb_cc0_clr)) +
        reg_offset);
 
    if (clk == GateName::NOT_AVAIL) { return; }
 
    /* Unlock clock configuration */
    mcxa153::chip::syscon::SYSCON0.clkunlock &=
        ~+mcxa153::chip::syscon::Mask::CLKUNLOCK_UNLOCK;
 
    if (reg_offset == REG_PWM0SUBCTL) {
      mcxa153::chip::syscon::SYSCON0.pwm0subctl &= ~(1UL << bit_shift);
 
      if (0U == (mcxa153::chip::syscon::SYSCON0.pwm0subctl & 0xFU)) {
        mcxa153::chip::mrcc::MRCC0.mrcc_glb_cc0_clr =
            +mcxa153::chip::mrcc::Mask::GLB_CC0_FLEXPWM0;
      }
    } else {
      *pClkCtrl = (1UL << bit_shift);
    }
 
    /* Freeze clock configuration */
    mcxa153::chip::syscon::SYSCON0.clkunlock |=
        +mcxa153::chip::syscon::Mask::CLKUNLOCK_UNLOCK;
  }
 
  static void attachClock(AttachID connection);
 
  static AttachID getClockAttachId(AttachID connection);
 
  static void setClockSelect(SelectName sel_name, uint32 value);
 
  static uint32 getClockSelect(SelectName sel_name);
 
  static void setClockDiv(Div div_name, uint32 value);
 
  static uint32 getClockDiv(Div div_name);
 
  static void haltClockDiv(Div div_name);
 
  static mcxa153::chip::Status setupFROHFClocking(unsigned int iFreq);
 
  static mcxa153::chip::Status setupFRO12MClocking(void);
 
  static mcxa153::chip::Status setupFRO16KClocking(uint8 clk_16k_enable_mask);
 
  static mcxa153::chip::Status setupExtClocking(uint32 iFreq);
 
  static mcxa153::chip::Status setupExtRefClocking(uint32 iFreq);
 
  static uint32 getFreq(Name clockName);
 
  static uint32 getCoreSysClkFreq(void);
 
  static uint32 getI3CFClkFreq(void);
 
  static uint32 getCTimerClkFreq(uint32 id);
 
  static uint32 getLpi2cClkFreq(void);
 
  static uint32 getLpspiClkFreq(uint32 id);
 
  static uint32 getLpuartClkFreq(uint32 id);
 
  static uint32 getLptmrClkFreq(void);
 
  static uint32 getOstimerClkFreq(void);
 
  static uint32 getAdcClkFreq(void);
 
  static uint32 getCmpFClkFreq(uint32 id);
 
  static uint32 getCmpRRClkFreq(uint32 id);
 
  static uint32 getTraceClkFreq(void);
 
  static uint32 getClkoutClkFreq(void);
 
  static uint32 getSystickClkFreq(void);
 
  static uint32 getWwdtClkFreq(void);
 
  static mcxa153::chip::Status frohfTrimConfig(FircTrimConfig config);
 
  static mcxa153::chip::Status fro12MTrimConfig(SircTrimConfig config);
 
  static void setSysOscMonitorMode(MonitorMode mode);
 
  static bool enableUsbfsClock(void);
};
 
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MCXA153_008A1453_A242_4775_9606_2ED0FF5092CA */