iLLD_TC27xD  1.0
CMU Basic Functions
Collaboration diagram for CMU Basic Functions:

Functions

IFX_EXTERN void IfxGtm_Cmu_enableClocks (Ifx_GTM *gtm, uint32 clkMask)
 Enable / Disable the configurable, fixed, and external clocks. More...
 
IFX_EXTERN float32 IfxGtm_Cmu_getClkFrequency (Ifx_GTM *gtm, IfxGtm_Cmu_Clk clkIndex, boolean assumeEnabled)
 Returns the GTM configurable clock frequency in Hz. More...
 
IFX_EXTERN float32 IfxGtm_Cmu_getEclkFrequency (Ifx_GTM *gtm, IfxGtm_Cmu_Eclk clkIndex, boolean assumeEnabled)
 Returns the GTM external clock frequency in Hz. More...
 
IFX_EXTERN float32 IfxGtm_Cmu_getFxClkFrequency (Ifx_GTM *gtm, IfxGtm_Cmu_Fxclk clkIndex, boolean assumeEnabled)
 Returns the GTM fixed clock frequency in Hz. More...
 
IFX_EXTERN float32 IfxGtm_Cmu_getGclkFrequency (Ifx_GTM *gtm)
 Returns the GTM global clock frequency in Hz. More...
 
IFX_EXTERN float32 IfxGtm_Cmu_getModuleFrequency (Ifx_GTM *gtm)
 Returns the GTM module frequency in Hz. More...
 
IFX_EXTERN boolean IfxGtm_Cmu_isClkClockEnabled (Ifx_GTM *gtm, IfxGtm_Cmu_Clk clkIndex)
 Returns the configurable clock enable status. More...
 
IFX_EXTERN boolean IfxGtm_Cmu_isEclkClockEnabled (Ifx_GTM *gtm, IfxGtm_Cmu_Eclk clkIndex)
 Returns the external clock enable status. More...
 
IFX_EXTERN boolean IfxGtm_Cmu_isFxClockEnabled (Ifx_GTM *gtm)
 Returns the fixed clock enable status. More...
 
IFX_EXTERN void IfxGtm_Cmu_selectClkInput (Ifx_GTM *gtm, IfxGtm_Cmu_Clk clkIndex, boolean useGlobal)
 Select the clock input for CLK6 and CLK7 note The frequency can only be modified when the corresponding clock is disabled using IfxGtm_Cmu_enableClocks() More...
 
IFX_EXTERN void IfxGtm_Cmu_setClkFrequency (Ifx_GTM *gtm, IfxGtm_Cmu_Clk clkIndex, float32 frequency)
 Set the GTM configurable clock frequency in Hz. More...
 
IFX_EXTERN void IfxGtm_Cmu_setEclkFrequency (Ifx_GTM *gtm, IfxGtm_Cmu_Eclk clkIndex, float32 frequency)
 Set the GTM external clock frequency in Hz. More...
 
IFX_EXTERN void IfxGtm_Cmu_setGclkFrequency (Ifx_GTM *gtm, float32 frequency)
 Set the GTM global clock frequency in Hz. More...
 

Detailed Description

Function Documentation

IFX_EXTERN void IfxGtm_Cmu_enableClocks ( Ifx_GTM *  gtm,
uint32  clkMask 
)

Enable / Disable the configurable, fixed, and external clocks.

FIXME chek that CMU register are accessed 32 bitwise (See TS 3.0 27.8.8 CMU Configuration Register Description). If not use different coding way

Parameters
gtmPointer to GTM module
clkMaskEnable / Disable mask. Mask is from IfxLld_Gtm_cfg_cmu_clock_enable_disable
Returns
None

Definition at line 40 of file IfxGtm_Cmu.c.

IFX_EXTERN float32 IfxGtm_Cmu_getClkFrequency ( Ifx_GTM *  gtm,
IfxGtm_Cmu_Clk  clkIndex,
boolean  assumeEnabled 
)

Returns the GTM configurable clock frequency in Hz.

Parameters
gtmPointer to GTM module
clkIndexIndex of the configurable clock 0=CMU_CLK0, 1=CMU_CLK1, ...
assumeEnabledWhen TRUE, attempt to calculate the frequency as if the clock is enabled.
Returns
GTM configurable clock frequency in Hz

Definition at line 46 of file IfxGtm_Cmu.c.

Referenced by IfxGtm_Atom_Ch_getClockFrequency(), IfxGtm_Cmu_getFxClkFrequency(), and IfxGtm_Tbu_getClockFrequency().

IFX_EXTERN float32 IfxGtm_Cmu_getEclkFrequency ( Ifx_GTM *  gtm,
IfxGtm_Cmu_Eclk  clkIndex,
boolean  assumeEnabled 
)

Returns the GTM external clock frequency in Hz.

Parameters
gtmPointer to GTM module
clkIndexIndex of the external clock 0=CMU_ECLK0, 1=CMU_ECLK1, ...
assumeEnabledWhen TRUE, attempt to calculate the frequency as if the clock is enabled.
Returns
GTM external clock frequency in Hz

Definition at line 100 of file IfxGtm_Cmu.c.

IFX_EXTERN float32 IfxGtm_Cmu_getFxClkFrequency ( Ifx_GTM *  gtm,
IfxGtm_Cmu_Fxclk  clkIndex,
boolean  assumeEnabled 
)

Returns the GTM fixed clock frequency in Hz.

Parameters
gtmPointer to GTM module
clkIndexIndex of the fixed clock 0=CMU_FXCLK0, 1=CMU_FXCLK1, ...
assumeEnabledWhen TRUE, attempt to calculate the frequency as if the clock is enabled.
Returns
GTM fixed clock frequency in Hz

Definition at line 120 of file IfxGtm_Cmu.c.

Referenced by IfxGtm_Tom_Ch_getClockFrequency().

IFX_EXTERN float32 IfxGtm_Cmu_getGclkFrequency ( Ifx_GTM *  gtm)

Returns the GTM global clock frequency in Hz.

Parameters
gtmPointer to GTM module
Returns
GTM global clock frequency in Hz

Definition at line 181 of file IfxGtm_Cmu.c.

Referenced by IfxGtm_Cmu_getClkFrequency(), IfxGtm_Cmu_getEclkFrequency(), IfxGtm_Cmu_getFxClkFrequency(), IfxGtm_Cmu_setClkFrequency(), and IfxGtm_Cmu_setEclkFrequency().

IFX_EXTERN float32 IfxGtm_Cmu_getModuleFrequency ( Ifx_GTM *  gtm)

Returns the GTM module frequency in Hz.

Parameters
gtmPointer to GTM module
Returns
GTM module frequency in Hz

Definition at line 191 of file IfxGtm_Cmu.c.

Referenced by IfxGtm_Cmu_getGclkFrequency(), and IfxGtm_Cmu_setGclkFrequency().

IFX_EXTERN boolean IfxGtm_Cmu_isClkClockEnabled ( Ifx_GTM *  gtm,
IfxGtm_Cmu_Clk  clkIndex 
)

Returns the configurable clock enable status.

Parameters
gtmPointer to GTM module
clkIndexIndex of the configurable clock 0=CMU_CLK0, 1=CMU_CLK1, ...
Returns
TRUE The clock is enabled, FALSE The clock is disabled

Definition at line 197 of file IfxGtm_Cmu.c.

Referenced by IfxGtm_Cmu_getClkFrequency().

IFX_EXTERN boolean IfxGtm_Cmu_isEclkClockEnabled ( Ifx_GTM *  gtm,
IfxGtm_Cmu_Eclk  clkIndex 
)

Returns the external clock enable status.

Parameters
gtmPointer to GTM module
clkIndexIndex of the external clock 0=CMU_ECLK0, 1=CMU_ECLK1, ...
Returns
TRUE The clock is enabled, FALSE The clock is disabled

Definition at line 203 of file IfxGtm_Cmu.c.

Referenced by IfxGtm_Cmu_getEclkFrequency().

IFX_EXTERN boolean IfxGtm_Cmu_isFxClockEnabled ( Ifx_GTM *  gtm)

Returns the fixed clock enable status.

Parameters
gtmPointer to GTM module
Returns
TRUE The clock is enabled, FALSE The clock is disabled

Definition at line 209 of file IfxGtm_Cmu.c.

Referenced by IfxGtm_Cmu_getFxClkFrequency().

IFX_EXTERN void IfxGtm_Cmu_selectClkInput ( Ifx_GTM *  gtm,
IfxGtm_Cmu_Clk  clkIndex,
boolean  useGlobal 
)

Select the clock input for CLK6 and CLK7 note The frequency can only be modified when the corresponding clock is disabled using IfxGtm_Cmu_enableClocks()

Parameters
gtmPointer to GTM module
clkIndexIndex of the configurable clock 0=CMU_CLK0, 1=CMU_CLK1, ...
useGlobalif TRUE, uses the global clock as an input, else use the SUB_INC input
Returns
None

Definition at line 215 of file IfxGtm_Cmu.c.

IFX_EXTERN void IfxGtm_Cmu_setClkFrequency ( Ifx_GTM *  gtm,
IfxGtm_Cmu_Clk  clkIndex,
float32  frequency 
)

Set the GTM configurable clock frequency in Hz.

Parameters
gtmPointer to GTM module
clkIndexIndex of the configurable clock 0=CMU_CLK0, 1=CMU_CLK1, ...
frequencyFrequency in Hz
Returns
None

Definition at line 232 of file IfxGtm_Cmu.c.

IFX_EXTERN void IfxGtm_Cmu_setEclkFrequency ( Ifx_GTM *  gtm,
IfxGtm_Cmu_Eclk  clkIndex,
float32  frequency 
)

Set the GTM external clock frequency in Hz.

Parameters
gtmPointer to GTM module
clkIndexIndex of the external clock 0=CMU_ECLK0, 1=CMU_ECLK1, ...
frequencyFrequency in Hz
Returns
None

Definition at line 269 of file IfxGtm_Cmu.c.

IFX_EXTERN void IfxGtm_Cmu_setGclkFrequency ( Ifx_GTM *  gtm,
float32  frequency 
)

Set the GTM global clock frequency in Hz.

Parameters
gtmPointer to GTM module
frequencyFrequency in Hz
Returns
None

Definition at line 317 of file IfxGtm_Cmu.c.