[aux_wuc.h] AUX Wake Up Controller

Functions
void	AUXWUCClockEnable (uint32_t ui32Clocks)
	Enable clocks for peripherals in the AUX domain. More...
void	AUXWUCClockDisable (uint32_t ui32Clocks)
	Disable clocks for peripherals in the AUX domain. More...
uint32_t	AUXWUCClockStatus (uint32_t ui32Clocks)
	Get the status of a clock. More...
static void	AUXWUCClockFreqReq (uint32_t ui32ClockFreq)
	Request a high or low frequency clock source. More...
void	AUXWUCPowerCtrl (uint32_t ui32PowerMode)
	Control the power to the AUX domain. More...
static void	AUXWUCFreezeEnable (void)
	Freeze the AUX IOs. More...
static void	AUXWUCFreezeDisable (void)
	Unfreeze the AUX IOs. More...

Detailed Description

Function Documentation

void AUXWUCClockDisable

(

uint32_t

ui32Clocks

)

Disable clocks for peripherals in the AUX domain.

Use this function to enable specific clocks in the AUX domain.

Parameters

ui32Clocks

a bitmap of clocks to disable. Use a bitwise OR combination of the following values: AUX_WUC_ADI_CLOCK AUX_WUC_OSCCTRL_CLOCK AUX_WUC_TDCIF_CLOCK AUX_WUC_ANAIF_CLOCK AUX_WUC_TIMER_CLOCK AUX_WUC_AIODIO0_CLOCK AUX_WUC_AIODIO1_CLOCK AUX_WUC_SMPH_CLOCK AUX_WUC_TDC_CLOCK AUX_WUC_ADC_CLOCK AUX_WUC_REF_CLOCK

Returns

None

See also

AUXWUCClockEnable()

{
    // Check the arguments.
    ASSERT((ui32Clocks & AUX_WUC_ADI_CLOCK) ||
           (ui32Clocks & AUX_WUC_OSCCTRL_CLOCK) ||
           (ui32Clocks & AUX_WUC_TDCIF_CLOCK) ||
           (ui32Clocks & AUX_WUC_ANAIF_CLOCK) ||
           (ui32Clocks & AUX_WUC_TIMER_CLOCK) ||
           (ui32Clocks & AUX_WUC_AIODIO0_CLOCK) ||
           (ui32Clocks & AUX_WUC_AIODIO1_CLOCK) ||
           (ui32Clocks & AUX_WUC_SMPH_CLOCK) ||
           (ui32Clocks & AUX_WUC_TDC_CLOCK) ||
           (ui32Clocks & AUX_WUC_ADC_CLOCK) ||
           (ui32Clocks & AUX_WUC_REF_CLOCK));

    // Disable some of the clocks in the clock register.
    HWREG(AUX_WUC_BASE + AUX_WUC_O_MODCLKEN0) &= ~(ui32Clocks &
            AUX_WUC_MODCLK_MASK);

    // Check the rest.
    if(ui32Clocks & AUX_WUC_ADC_CLOCK)
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_ADCCLKCTL) &=
            ~AUX_WUC_ADCCLKCTL_REQ;
    }
    if(ui32Clocks & AUX_WUC_TDC_CLOCK)
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_TDCCLKCTL) &=
            ~AUX_WUC_TDCCLKCTL_REQ;
    }
    if(ui32Clocks & AUX_WUC_REF_CLOCK)
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_REFCLKCTL) &=
            ~AUX_WUC_REFCLKCTL_REQ;
    }
}

void AUXWUCClockEnable

(

uint32_t

ui32Clocks

)

Enable clocks for peripherals in the AUX domain.

Use this function to enable specific clocks in the AUX domain.

Parameters

ui32Clocks

is a bitmap of clocks to enable. Use a bitwise OR combination of the following values: AUX_WUC_ADI_CLOCK AUX_WUC_OSCCTRL_CLOCK AUX_WUC_TDCIF_CLOCK AUX_WUC_ANAIF_CLOCK AUX_WUC_TIMER_CLOCK AUX_WUC_AIODIO0_CLOCK AUX_WUC_AIODIO1_CLOCK AUX_WUC_SMPH_CLOCK AUX_WUC_TDC_CLOCK AUX_WUC_ADC_CLOCK AUX_WUC_REF_CLOCK

Returns

None

See also

AUXWUCClockDisable()

{
    // Check the arguments.
    ASSERT((ui32Clocks & AUX_WUC_ADI_CLOCK) ||
           (ui32Clocks & AUX_WUC_OSCCTRL_CLOCK) ||
           (ui32Clocks & AUX_WUC_TDCIF_CLOCK) ||
           (ui32Clocks & AUX_WUC_ANAIF_CLOCK) ||
           (ui32Clocks & AUX_WUC_TIMER_CLOCK) ||
           (ui32Clocks & AUX_WUC_AIODIO0_CLOCK) ||
           (ui32Clocks & AUX_WUC_AIODIO1_CLOCK) ||
           (ui32Clocks & AUX_WUC_SMPH_CLOCK) ||
           (ui32Clocks & AUX_WUC_TDC_CLOCK) ||
           (ui32Clocks & AUX_WUC_ADC_CLOCK) ||
           (ui32Clocks & AUX_WUC_REF_CLOCK));

    // Enable some of the clocks in the clock register.
    HWREG(AUX_WUC_BASE + AUX_WUC_O_MODCLKEN0) |= (ui32Clocks &
                                                AUX_WUC_MODCLK_MASK);

    // Check the rest.
    if(ui32Clocks & AUX_WUC_ADC_CLOCK)
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_ADCCLKCTL) =
            AUX_WUC_ADCCLKCTL_REQ;
    }
    if(ui32Clocks & AUX_WUC_TDC_CLOCK)
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_TDCCLKCTL) =
            AUX_WUC_TDCCLKCTL_REQ;
    }
    if(ui32Clocks & AUX_WUC_REF_CLOCK)
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_REFCLKCTL) =
            AUX_WUC_REFCLKCTL_REQ;
    }
}

static void AUXWUCClockFreqReq ( uint32_t  ui32ClockFreq )

inlinestatic

Request a high or low frequency clock source.

Using this function it is possible to make a request to the System Control to use a high or low frequency clock as clock source for the AUX domain.

Note

A low frequency clock is always 32 kHz, while a high frequency clock is really a large span of frequencies determined by the clock source (High Frequency or Medium Frequency) and the setting for the clock divider for the AUX domain in the System Control.

Parameters

ui32ClockFreq

determines the clock source frequency. AUX_WUC_CLOCK_LOFREQ : Request low frequency clock source for AUX domain. AUX_WUC_CLOCK_HIFREQ : Request high frequency clock source for AUX domain.

Returns

{
    // Check the arguments.
    ASSERT((ui32ClockFreq == AUX_WUC_CLOCK_HIFREQ) ||
           (ui32ClockFreq == AUX_WUC_CLOCK_LOFREQ));

    // Set the request
    HWREG(AUX_WUC_BASE + AUX_WUC_O_CLKLFREQ) = ui32ClockFreq;
}

uint32_t AUXWUCClockStatus

(

uint32_t

ui32Clocks

)

Get the status of a clock.

Use this function to poll the status of a specific clock in the AUX domain.

Parameters

ui32Clocks

is the clock for which to return status. AUX_WUC_ADI_CLOCK AUX_WUC_OSCCTRL_CLOCK AUX_WUC_TDCIF_CLOCK AUX_WUC_ANAIF_CLOCK AUX_WUC_TIMER_CLOCK AUX_WUC_AIODIO0_CLOCK AUX_WUC_AIODIO1_CLOCK AUX_WUC_SMPH_CLOCK AUX_WUC_TDC_CLOCK AUX_WUC_ADC_CLOCK AUX_WUC_REF_CLOCK

Returns

Returns the status of the clock as one of two states:

• AUX_WUC_CLOCK_OFF
• AUX_WUC_CLOCK_READY

{
    bool bClockStatus;
    uint32_t ui32ClockRegister;

    // Check the arguments.
    ASSERT((ui32Clocks & AUX_WUC_ADI_CLOCK) ||
           (ui32Clocks & AUX_WUC_OSCCTRL_CLOCK) ||
           (ui32Clocks & AUX_WUC_TDCIF_CLOCK) ||
           (ui32Clocks & AUX_WUC_ANAIF_CLOCK) ||
           (ui32Clocks & AUX_WUC_TIMER_CLOCK) ||
           (ui32Clocks & AUX_WUC_AIODIO0_CLOCK) ||
           (ui32Clocks & AUX_WUC_AIODIO1_CLOCK) ||
           (ui32Clocks & AUX_WUC_SMPH_CLOCK) ||
           (ui32Clocks & AUX_WUC_TDC_CLOCK) ||
           (ui32Clocks & AUX_WUC_ADC_CLOCK) ||
           (ui32Clocks & AUX_WUC_REF_CLOCK));

    bClockStatus = true;

    // Read the status registers.
    ui32ClockRegister = HWREG(AUX_WUC_BASE + AUX_WUC_O_MODCLKEN0);

    // Check all requested clocks
    if(ui32Clocks & AUX_WUC_ADI_CLOCK)
    {
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                              AUX_WUC_MODCLKEN0_AUX_ADI4 ?
                                              true : false);
    }
    if(ui32Clocks & AUX_WUC_OSCCTRL_CLOCK)
    {
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                              AUX_WUC_MODCLKEN0_AUX_DDI0_OSC ?
                                              true : false);
    }
    if(ui32Clocks & AUX_WUC_TDCIF_CLOCK)
    {
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                              AUX_WUC_MODCLKEN0_TDC ?
                                              true : false);
    }
    if(ui32Clocks & AUX_WUC_ANAIF_CLOCK)
    {
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                              AUX_WUC_MODCLKEN0_ANAIF ?
                                              true : false);
    }
    if(ui32Clocks & AUX_WUC_TIMER_CLOCK)
    {
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                              AUX_WUC_MODCLKEN0_TIMER ?
                                              true : false);
    }
    if(ui32Clocks & AUX_WUC_AIODIO0_CLOCK)
    {
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                              AUX_WUC_MODCLKEN0_AIODIO0 ?
                                              true : false);
    }
    if(ui32Clocks & AUX_WUC_AIODIO1_CLOCK)
    {
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                              AUX_WUC_MODCLKEN0_AIODIO1 ?
                                              true : false);
    }
    if(ui32Clocks & AUX_WUC_SMPH_CLOCK)
    {
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                              AUX_WUC_MODCLKEN0_SMPH ?
                                              true : false);
    }
    if(ui32Clocks & AUX_WUC_ADC_CLOCK)
    {
        ui32ClockRegister = HWREG(AUX_WUC_BASE + AUX_WUC_O_ADCCLKCTL);
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                        AUX_WUC_ADCCLKCTL_ACK ?
                                        true : false);
    }
    if(ui32Clocks & AUX_WUC_TDC_CLOCK)
    {
        ui32ClockRegister = HWREG(AUX_WUC_BASE + AUX_WUC_O_TDCCLKCTL);
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                        AUX_WUC_TDCCLKCTL_ACK ?
                                        true : false);
    }
    if(ui32Clocks & AUX_WUC_REF_CLOCK)
    {
        ui32ClockRegister = HWREG(AUX_WUC_BASE + AUX_WUC_O_REFCLKCTL);
        bClockStatus = bClockStatus && (ui32ClockRegister &
                                        AUX_WUC_REFCLKCTL_ACK ?
                                        true : false);
    }

    // Return the clock status.
    return bClockStatus ? AUX_WUC_CLOCK_READY : AUX_WUC_CLOCK_OFF;
}

static void AUXWUCFreezeDisable ( void  )

inlinestatic

Unfreeze the AUX IOs.

When restarting the AUX domain after it has entered powerdown mode, the software can regain control of the IOs by setting the IO latches as transparent.

Note

The IOs should not be unfrozen before software has restored the functionality of the IO.

Returns

None

See also

AUXWUCFreezeEnable()

{
    // Set the AUX WUC latches as transparent.
    HWREG(AUX_WUC_BASE + AUX_WUC_O_AUXIOLATCH) = AUX_WUC_AUXIOLATCH_EN;
}

static void AUXWUCFreezeEnable ( void  )

inlinestatic

Freeze the AUX IOs.

To retain the values of the output IOs during a powerdown of the AUX domain all IO latches in the AUX domain should be frozen in their current state. This ensures that software can regain control of the IOs after a powerdown without the IOs first falling back to the default values (i.e. input and pull-up).

Returns

None

See also

AUXWUCFreezeDisable()

{
    // Set the AUX WUC latches as static.
    HWREG(AUX_WUC_BASE + AUX_WUC_O_AUXIOLATCH) = 0x0;
}

void AUXWUCPowerCtrl

(

uint32_t

ui32PowerMode

)

Control the power to the AUX domain.

Use this function to set the power mode of the entire AUX domain.

Parameters

ui32PowerMode

control the desired power mode for the AUX domain. The domain has three different power modes: AUX_WUC_POWER_OFF AUX_WUC_POWER_DOWN AUX_WUC_POWER_ACTIVE

Returns

None

Referenced by TrimAfterColdResetWakeupFromShutDown().

{
    // Check the arguments.
    ASSERT((ui32PowerMode == AUX_WUC_POWER_OFF) ||
           (ui32PowerMode == AUX_WUC_POWER_DOWN) ||
           (ui32PowerMode == AUX_WUC_POWER_ACTIVE));

    // Power on/off.
    if(ui32PowerMode == AUX_WUC_POWER_OFF)
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_PWROFFREQ) = AUX_WUC_PWROFFREQ_REQ;
        HWREG(AUX_WUC_BASE + AUX_WUC_O_MCUBUSCTL) = AUX_WUC_MCUBUSCTL_DISCONNECT_REQ;
        return;
    }
    else
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_PWROFFREQ) = 0x0;
    }

    // Power down/active.
    if(ui32PowerMode == AUX_WUC_POWER_DOWN)
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_PWRDWNREQ) = AUX_WUC_PWRDWNREQ_REQ;
        HWREG(AUX_WUC_BASE + AUX_WUC_O_MCUBUSCTL) = AUX_WUC_MCUBUSCTL_DISCONNECT_REQ;
    }
    else
    {
        HWREG(AUX_WUC_BASE + AUX_WUC_O_PWRDWNREQ) = 0x0;
    }
}

Macro Definition Documentation

#define AUX_WUC_ADC_CLOCK   0x00000200

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_ADI_CLOCK   (AUX_WUC_MODCLKEN0_AUX_ADI4_EN)

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_AIODIO0_CLOCK   (AUX_WUC_MODCLKEN0_AIODIO0_EN)

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_AIODIO1_CLOCK   (AUX_WUC_MODCLKEN0_AIODIO1_EN)

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_ANAIF_CLOCK   (AUX_WUC_MODCLKEN0_ANAIF_EN)

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_CLOCK_HIFREQ   0x00000000

Referenced by AUXWUCClockFreqReq().

#define AUX_WUC_CLOCK_LOFREQ   0x00000001

Referenced by AUXWUCClockFreqReq().

#define AUX_WUC_CLOCK_OFF   0x00000000

Referenced by AUXWUCClockStatus().

#define AUX_WUC_CLOCK_READY   0x00000011

Referenced by AUXWUCClockStatus().

#define AUX_WUC_CLOCK_UNSTABLE   0x00000001

#define AUX_WUC_MODCLK_MASK   0x000000FF

Referenced by AUXWUCClockDisable(), and AUXWUCClockEnable().

#define AUX_WUC_OSCCTRL_CLOCK   (AUX_WUC_MODCLKEN0_AUX_DDI0_OSC_EN)

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_POWER_ACTIVE   0x00000004

Referenced by AUXWUCPowerCtrl().

#define AUX_WUC_POWER_DOWN   0x00000002

Referenced by AUXWUCPowerCtrl(), and TrimAfterColdResetWakeupFromShutDown().

#define AUX_WUC_POWER_OFF   0x00000001

Referenced by AUXWUCPowerCtrl().

#define AUX_WUC_REF_CLOCK   0x00000400

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_SMPH_CLOCK   (AUX_WUC_MODCLKEN0_SMPH_EN)

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_TDC_CLOCK   0x00000100

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_TDCIF_CLOCK   (AUX_WUC_MODCLKEN0_TDC_EN)

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().

#define AUX_WUC_TIMER_CLOCK   (AUX_WUC_MODCLKEN0_TIMER_EN)

Referenced by AUXWUCClockDisable(), AUXWUCClockEnable(), and AUXWUCClockStatus().