Clock

Defines a driver to facilitate interfacing with the CPU clock. More...

Enumerations
enum	wiced_cpu_clk_freq_t { WICED_CPU_CLK_24MHZ, WICED_CPU_CLK_32MHZ, WICED_CPU_CLK_48MHZ, WICED_CPU_CLK_96MHZ }
	Clock Frequency. More...

Functions
wiced_bool_t	wiced_update_cpu_clock (wiced_bool_t enable, wiced_cpu_clk_freq_t freq)
	Function wiced_update_cpu_clock. More...
void	wiced_hal_cpu_clk_ldo_voltage_force_high (void)
	Function wiced_hal_cpu_clk_ldo_voltage_force_high. More...
void	wiced_hal_cpu_clk_ldo_voltage_release (void)
	Function wiced_hal_cpu_clk_ldo_voltage_release. More...

Detailed Description

Defines a driver to facilitate interfacing with the CPU clock.

Use this to update the CPU clock frequency. Care should be taken by an App that it doesn't disable a frequency not set by it.

Enumeration Type Documentation

enum wiced_cpu_clk_freq_t

Clock Frequency.

Enumerator
WICED_CPU_CLK_24MHZ	24Mhz clock frequency
WICED_CPU_CLK_32MHZ	32Mhz clock frequency
WICED_CPU_CLK_48MHZ	48Mhz clock frequency
WICED_CPU_CLK_96MHZ	96Mhz clock frequency

Function Documentation

void wiced_hal_cpu_clk_ldo_voltage_force_high

(

void

)

Function wiced_hal_cpu_clk_ldo_voltage_force_high.

Force LDO voltage to higher one to prevent the I/O corruption. If application is using a mechanism to increase CPU clock to 96 MHz dynamically, user shall force the LDO voltage to higher one before start the mechanism. Or the background I/O (baseband TX/RX, HCI UART) might be corrupted.

Note

This function will set LDO voltage. User shall guarantee no background I/O is executing or it might be corrupted as well. For example, user needs to flow HCI UART off before calling this function then flow it on.

void wiced_hal_cpu_clk_ldo_voltage_release

(

void

)

Function wiced_hal_cpu_clk_ldo_voltage_release.

Release the force of LDO voltage by wiced_hal_cpu_clk_ldo_voltage_force_high. User shall release the LDO voltage after the mechanism to increase CPU clock is finished.

Note

This function will set LDO voltage. User shall guarantee no background I/O is executing or it might be corrupted as well. For example, user needs to flow HCI UART off before calling this function then flow it on.

wiced_bool_t wiced_update_cpu_clock	(	wiced_bool_t	enable,
		wiced_cpu_clk_freq_t	freq
	)

Function wiced_update_cpu_clock.

Enables/Disables the given cpu clock frequency. the actual clock frequency is selected appropriately within the driver.

Parameters

[in]	enable	:enable or disable clock frequency.
[in]	freq	:clock frequency to enable/disable.

Usage:The application should call the API with argument enable set to WICED_TRUE to request the FW to set the clock speed to the desired value. When the application is done with its work at this clock speed and wants to return to the previous speed, it shall call the API with the argument enable set to WICED_FALSE and set the argument freq to the same frequency that it earlier requested to be set.

Returns

: wiced_bool_t