Functions

General Description

Functions
cy_en_sysclk_status_t	Cy_SysClk_PeriGroupSetDivider (uint32_t groupNum, uint32_t divider)
	Sets the divider value for a particular group. More...
uint32_t	Cy_SysClk_PeriGroupGetDivider (uint32_t groupNum)
	Gets the divider value for a particular group. More...
cy_en_sysclk_status_t	Cy_SysClk_PeriGroupSetSlaveCtl (uint32_t groupNum, cy_en_peri_grp_sl_ctl_num_t slaveCtl, uint32_t value)
	Sets the particular Slave Control value for a particular group. More...
uint32_t	Cy_SysClk_PeriGroupGetSlaveCtl (uint32_t groupNum, cy_en_peri_grp_sl_ctl_num_t slaveCtl)
	Gets the particular Slave Control value for a particular group. More...
bool	Cy_SysClk_IsPeriGroupSlaveCtlSet (uint32_t groupNum, cy_en_peri_grp_sl_ctl_num_t slaveCtl, uint32_t slaveMsk)
	Gets the mask value of particular slave control register for a particular group. More...

Function Documentation

Cy_SysClk_PeriGroupSetDivider()

cy_en_sysclk_status_t Cy_SysClk_PeriGroupSetDivider	(	uint32_t	groupNum,
		uint32_t	divider
	)

Sets the divider value for a particular group.

Returns

cy_en_sysclk_status_t

Parameters

groupNum

Selects the PERI Group Number

Note

Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1<subcategory> /include/<series>_config.h) CAT1B/CAT1C - group number

Parameters

divider

Selects the divider value

Note

This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices.

Clock divider functionality is product specific, Refer to TRM before using this API Example:- For CAT1B devices Group-0 does not have the clock divider functionality. For CAT1C devices Group-0,1 and 2 does not have the clock divider functionality. For the above not supported groups this API will return success, but write will not happen.

Cy_SysClk_PeriGroupGetDivider()

uint32_t Cy_SysClk_PeriGroupGetDivider

(

uint32_t

groupNum

)

Gets the divider value for a particular group.

Returns

Divider value

Parameters

groupNum

Selects the PERI Group Number

Note

Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1<subcategory> /include/<series>_config.h) CAT1B/CAT1C - group number

This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices.

Clock divider functionality is product specific, Refer to TRM before using this API Example:- For CAT1B devices Group-0 does not have the clock divider functionality. For CAT1C devices Group-0,1 and 2 does not have the clock divider functionality. For the above not supported groups this API returns zero.

Cy_SysClk_PeriGroupSetSlaveCtl()

cy_en_sysclk_status_t Cy_SysClk_PeriGroupSetSlaveCtl	(	uint32_t	groupNum,
		cy_en_peri_grp_sl_ctl_num_t	slaveCtl,
		uint32_t	value
	)

Sets the particular Slave Control value for a particular group.

Returns

cy_en_sysclk_status_t

Parameters

groupNum

Selects the PERI Group Number

Note

Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1<subcategory> /include/<series>_config.h) CAT1B/CAT1C - group number

Parameters

slaveCtl	Selects the Slave Control Register Number
value	Value to be written

Note

This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices.

Cy_SysClk_PeriGroupGetSlaveCtl()

uint32_t Cy_SysClk_PeriGroupGetSlaveCtl	(	uint32_t	groupNum,
		cy_en_peri_grp_sl_ctl_num_t	slaveCtl
	)

Gets the particular Slave Control value for a particular group.

Returns

Slave Control register value for a particular group

Parameters

groupNum

Selects the PERI Group Number

Note

Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1<subcategory> /include/<series>_config.h) CAT1B/CAT1C - group number

Parameters

slaveCtl

Selects the Slave Control Register Number

Note

This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices.

Cy_SysClk_IsPeriGroupSlaveCtlSet()

bool Cy_SysClk_IsPeriGroupSlaveCtlSet	(	uint32_t	groupNum,
		cy_en_peri_grp_sl_ctl_num_t	slaveCtl,
		uint32_t	slaveMsk
	)

Gets the mask value of particular slave control register for a particular group.

Returns

Divider value

Parameters

groupNum

Selects the PERI Group Number

Note

Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1<subcategory> /include/<series>_config.h) CAT1B/CAT1C - group number

Parameters

slaveCtl	Selects the Slave Control Register Number
slaveMsk	Selects the bit position(s) that needs to be obtained

Note

This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices.