(8a1a5fe)

Clock Manager Device Interface Functions More...

#include <stdint.h>
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"
#include "sw/device/lib/dif/autogen/dif_clkmgr_autogen.h"

Go to the source code of this file.

Typedefs
typedef uint32_t	dif_clkmgr_gateable_clock_t
	An Index of a "Gateable" Clock. More...

typedef uint32_t	dif_clkmgr_hintable_clock_t
	An Index of a "Hintable" Clock. More...

typedef enum dif_clkmgr_measure_clock	dif_clkmgr_measure_clock_t

typedef enum dif_clkmgr_recov_err_type	dif_clkmgr_recov_err_type_t

typedef uint32_t	dif_clkmgr_recov_err_codes_t
	A set of recoverable errors. More...

typedef enum dif_clkmgr_fatal_err_type	dif_clkmgr_fatal_err_type_t

typedef uint32_t	dif_clkmgr_fatal_err_codes_t
	A set of fatal errors. More...

Enumerations
enum	dif_clkmgr_measure_clock { kDifClkmgrMeasureClockIo, kDifClkmgrMeasureClockIoDiv2, kDifClkmgrMeasureClockIoDiv4, kDifClkmgrMeasureClockMain, kDifClkmgrMeasureClockUsb }

enum	dif_clkmgr_recov_err_type { kDifClkmgrRecovErrTypeShadowUpdate = 1u << 0, kDifClkmgrRecovErrTypeIoMeas = 1u << 1, kDifClkmgrRecovErrTypeIoDiv2Meas = 1u << 2, kDifClkmgrRecovErrTypeIoDiv4Meas = 1u << 3, kDifClkmgrRecovErrTypeMainMeas = 1u << 4, kDifClkmgrRecovErrTypeUsbMeas = 1u << 5, kDifClkmgrRecovErrTypeIoTimeout = 1u << 6, kDifClkmgrRecovErrTypeIoDiv2Timeout = 1u << 7, kDifClkmgrRecovErrTypeIoDiv4Timeout = 1u << 8, kDifClkmgrRecovErrTypeMainTimeout = 1u << 9, kDifClkmgrRecovErrTypeUsbTimeout = 1u << 10 }

enum	dif_clkmgr_fatal_err_type { kDifClkmgrFatalErrTypeRegfileIntegrity = 1u << 0, kDifClkmgrFatalErrTypeIdleCount = 1u << 1, kDifClkmgrFatalErrTypeShadowStorage = 1u << 2 }

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_jitter_get_enabled (const dif_clkmgr_t clkmgr, dif_toggle_t state)
	Check if jitter is Enabled. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_jitter_set_enabled (const dif_clkmgr_t *clkmgr, dif_toggle_t new_state)
	Enable of Disable jitter. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_gateable_clock_get_enabled (const dif_clkmgr_t clkmgr, dif_clkmgr_gateable_clock_t clock, dif_toggle_t state)
	Check if a Gateable Clock is Enabled or Disabled. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_gateable_clock_set_enabled (const dif_clkmgr_t *clkmgr, dif_clkmgr_gateable_clock_t clock, dif_toggle_t new_state)
	Enable or Disable a Gateable Clock. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_hintable_clock_get_enabled (const dif_clkmgr_t clkmgr, dif_clkmgr_hintable_clock_t clock, dif_toggle_t state)
	Check if a Hintable Clock is Enabled or Disabled. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_hintable_clock_set_hint (const dif_clkmgr_t *clkmgr, dif_clkmgr_hintable_clock_t clock, dif_toggle_t new_state)
	Enable or Disable a Hintable Clock. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_hintable_clock_get_hint (const dif_clkmgr_t clkmgr, dif_clkmgr_hintable_clock_t clock, dif_toggle_t state)
	Read the current Hint for a Hintable Clock. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_external_clock_set_enabled (const dif_clkmgr_t *clkmgr, bool is_low_speed)
	Enable chip to use the external clock. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_external_clock_set_disabled (const dif_clkmgr_t *clkmgr)
	Disable chip to use the external clock. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_external_clock_is_settled (const dif_clkmgr_t clkmgr, bool status)
	Determine if the transition to using external clock is complete. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_measure_ctrl_disable (const dif_clkmgr_t *clkmgr)
	Disable measurement control updates. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_measure_ctrl_get_enable (const dif_clkmgr_t clkmgr, dif_toggle_t state)
	Get measurement control state. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_enable_measure_counts (const dif_clkmgr_t *clkmgr, dif_clkmgr_measure_clock_t clock, uint32_t min_threshold, uint32_t max_threshold)
	Configure count measurements. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_disable_measure_counts (const dif_clkmgr_t *clkmgr, dif_clkmgr_measure_clock_t clock)
	Disable count measurements. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_measure_counts_get_enable (const dif_clkmgr_t clkmgr, dif_clkmgr_measure_clock_t clock, dif_toggle_t state)
	Get the count measurement enable. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_measure_counts_get_thresholds (const dif_clkmgr_t clkmgr, dif_clkmgr_measure_clock_t clock, uint32_t min_threshold, uint32_t *max_threshold)
	Get the count measurement thresholds. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_recov_err_code_get_codes (const dif_clkmgr_t clkmgr, dif_clkmgr_recov_err_codes_t codes)
	Read the recoverable error codes. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_recov_err_code_clear_codes (const dif_clkmgr_t *clkmgr, dif_clkmgr_recov_err_codes_t codes)
	Clear selected recoverable error codes. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_fatal_err_code_get_codes (const dif_clkmgr_t clkmgr, dif_clkmgr_fatal_err_codes_t codes)
	Read the fatal error codes. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_clkmgr_wait_for_ext_clk_switch (const dif_clkmgr_t *clkmgr)
	Wait for external clock switch to finish. More...

Detailed Description

Clock Manager Device Interface Functions

Definition in file dif_clkmgr.h.

Typedef Documentation

◆ dif_clkmgr_fatal_err_codes_t

typedef uint32_t dif_clkmgr_fatal_err_codes_t

A set of fatal errors.

This type is used to read the fatal error codes.

Definition at line 140 of file dif_clkmgr.h.

◆ dif_clkmgr_gateable_clock_t

typedef uint32_t dif_clkmgr_gateable_clock_t

An Index of a "Gateable" Clock.

"Gateable" clocks are under full software control: they can be enabled and disabled by software, which directly starts and stops the identified clock.

Definition at line 32 of file dif_clkmgr.h.

◆ dif_clkmgr_hintable_clock_t

typedef uint32_t dif_clkmgr_hintable_clock_t

An Index of a "Hintable" Clock.

"Hintable" clocks are under partial software control: software can suggest they are stopped, but the clock manager may delay stopping the peripheral, or may ignore the request altogether.

Definition at line 41 of file dif_clkmgr.h.

◆ dif_clkmgr_recov_err_codes_t

typedef uint32_t dif_clkmgr_recov_err_codes_t

A set of recoverable errors.

This type is used to clear and read the recoverable error codes.

Definition at line 118 of file dif_clkmgr.h.

Enumeration Type Documentation

◆ dif_clkmgr_fatal_err_type

enum dif_clkmgr_fatal_err_type

Enumerator
kDifClkmgrFatalErrTypeRegfileIntegrity	A fatal error for regfile integrity.
kDifClkmgrFatalErrTypeIdleCount	A fatal error for a duplicate idle counter.
kDifClkmgrFatalErrTypeShadowStorage	A fatal error for a shadow register storage.

Definition at line 120 of file dif_clkmgr.h.

◆ dif_clkmgr_measure_clock

enum dif_clkmgr_measure_clock

Enumerator
kDifClkmgrMeasureClockIo	The Io clock.
kDifClkmgrMeasureClockIoDiv2	The Io_div2 clock.
kDifClkmgrMeasureClockIoDiv4	The Io div4 clock.
kDifClkmgrMeasureClockMain	The Main clock.
kDifClkmgrMeasureClockUsb	The Usb clock.

Definition at line 43 of file dif_clkmgr.h.

◆ dif_clkmgr_recov_err_type

enum dif_clkmgr_recov_err_type

Enumerator
kDifClkmgrRecovErrTypeShadowUpdate	A recoverable update error for one of the clocks.
kDifClkmgrRecovErrTypeIoMeas	A recoverable measurement error for IO clock.
kDifClkmgrRecovErrTypeIoDiv2Meas	A recoverable measurement error for IO_DIV2 clock.
kDifClkmgrRecovErrTypeIoDiv4Meas	A recoverable measurement error for IO_DIV4 clock.
kDifClkmgrRecovErrTypeMainMeas	A recoverable measurement error for MAIN clock.
kDifClkmgrRecovErrTypeUsbMeas	A recoverable measurement error for USB clock.
kDifClkmgrRecovErrTypeIoTimeout	A recoverable timeout error for IO clock.
kDifClkmgrRecovErrTypeIoDiv2Timeout	A recoverable timeout error for IO_DIV2 clock.
kDifClkmgrRecovErrTypeIoDiv4Timeout	A recoverable timeout error for IO_DIV4 clock.
kDifClkmgrRecovErrTypeMainTimeout	A recoverable timeout error for MAIN clock.
kDifClkmgrRecovErrTypeUsbTimeout	A recoverable timeout error for USB clock.

Definition at line 66 of file dif_clkmgr.h.

Function Documentation

◆ dif_clkmgr_disable_measure_counts()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_disable_measure_counts	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_measure_clock_t	clock
	)

Disable count measurements.

Does not modify the thresholds.

Parameters

clkmgr	Clock Manager Handle.
clock	A clock to be measured.

Returns: The result of the operation.

Definition at line 328 of file dif_clkmgr.c.

◆ dif_clkmgr_enable_measure_counts()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_enable_measure_counts	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_measure_clock_t	clock,
		uint32_t	min_threshold,
		uint32_t	max_threshold
	)

Configure count measurements.

Parameters

clkmgr	Clock Manager Handle.
clock	A clock to be measured.
min_threshold	The smallest permissible cycle count.
max_threshold	The largest permissible cycle count.

Returns: The result of the operation.

Definition at line 269 of file dif_clkmgr.c.

◆ dif_clkmgr_external_clock_is_settled()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_external_clock_is_settled	(	const dif_clkmgr_t *	clkmgr,
		bool *	status
	)

Determine if the transition to using external clock is complete.

Parameters

	clkmgr	Clock Manager Handle.
[out]	status	Set to true if the transition is complete.

Returns: The result of the operation once it completes.

Definition at line 45 of file dif_clkmgr.c.

◆ dif_clkmgr_external_clock_set_disabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_external_clock_set_disabled ( const dif_clkmgr_t * clkmgr )

Disable chip to use the external clock.

Parameters

clkmgr Clock Manager Handle.

Returns: The result of the operation.

Definition at line 193 of file dif_clkmgr.c.

◆ dif_clkmgr_external_clock_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_external_clock_set_enabled	(	const dif_clkmgr_t *	clkmgr,
		bool	is_low_speed
	)

Enable chip to use the external clock.

Parameters

clkmgr	Clock Manager Handle.
is_low_speed	External clock is low speed or high speed.

Returns: The result of the operation. High speed - external clock is close to nominal speeds (e.g. external clock is 96MHz and nominal frequency is 96MHz-100MHz). Low speed - external clock is half of nominal speeds (e.g. external clock is 48MHz and nominal frequency is 96MHz-100MHz).

Definition at line 175 of file dif_clkmgr.c.

◆ dif_clkmgr_fatal_err_code_get_codes()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_fatal_err_code_get_codes	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_fatal_err_codes_t *	codes
	)

Read the fatal error codes.

Parameters

	clkmgr	Clock Manager Handle.
[out]	codes	The fatal error codes.

Returns: The result of the operation.

Definition at line 475 of file dif_clkmgr.c.

◆ dif_clkmgr_gateable_clock_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_gateable_clock_get_enabled	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_gateable_clock_t	clock,
		dif_toggle_t *	state
	)

Check if a Gateable Clock is Enabled or Disabled.

Parameters

	clkmgr	Clock Manager Handle.
	clock	Gateable Clock ID.
[out]	is_enabled	whether the clock is enabled or not.

Returns: The result of the operation.

Definition at line 96 of file dif_clkmgr.c.

◆ dif_clkmgr_gateable_clock_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_gateable_clock_set_enabled	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_gateable_clock_t	clock,
		dif_toggle_t	new_state
	)

Enable or Disable a Gateable Clock.

Parameters

clkmgr	Clock Manager Handle.
clock	Gateable Clock ID.
new_state	whether to enable or disable the clock.

Returns: The result of the operation.

Definition at line 110 of file dif_clkmgr.c.

◆ dif_clkmgr_hintable_clock_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_hintable_clock_get_enabled	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_hintable_clock_t	clock,
		dif_toggle_t *	state
	)

Check if a Hintable Clock is Enabled or Disabled.

Hintable clocks are not under full software control, but this operation accurately reflects the state of the current clock, regardless of any hint requests made by software.

To read what hint the software has given the hardware, use dif_clkmgr_hintable_clock_get_hint.

Parameters

	clkmgr	Clock Manager Handle.
	clock	Hintable Clock ID.
[out]	is_enabled	whether the clock is enabled or not.

Returns: The result of the operation.

Definition at line 129 of file dif_clkmgr.c.

◆ dif_clkmgr_hintable_clock_get_hint()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_hintable_clock_get_hint	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_hintable_clock_t	clock,
		dif_toggle_t *	state
	)

Read the current Hint for a Hintable Clock.

Hintable clocks are not under full software control; this operation accurately reflects the current software hint, not the current state of the clock.

To read whether the clock is currently enabled or disabled, use dif_clkmgr_hintable_clock_get_enabled.

Parameters

	clkmgr	Clock Manager Handle.
	clock	Hintable Clock ID.
[out]	hinted_is_enabled	the current software request (hint) for this clock.

Returns: The result of the operation.

Definition at line 161 of file dif_clkmgr.c.

◆ dif_clkmgr_hintable_clock_set_hint()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_hintable_clock_set_hint	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_hintable_clock_t	clock,
		dif_toggle_t	new_state
	)

Enable or Disable a Hintable Clock.

This only sets a hint that the clock should be enabled or disabled. The clock manager is in control of whether the clock should actually be enabled or disabled.

To read what hint the software has given the hardware, use dif_clkmgr_hintable_clock_get_hint. To read whether the clock is currently enabled or disabled, use dif_clkmgr_hintable_clock_get_enabled.

Parameters

clkmgr	Clock Manager Handle.
clock	Hintable Clock ID.
new_state	whether to enable or disable the clock.

Returns: The result of the operation.

Definition at line 143 of file dif_clkmgr.c.

◆ dif_clkmgr_jitter_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_jitter_get_enabled	(	const dif_clkmgr_t *	clkmgr,
		dif_toggle_t *	state
	)

Check if jitter is Enabled.

Parameters

	clkmgr	Clock Manager Handle.
[out]	is_enabled	whether jitter is enabled or not.

Returns: The result of the operation.

Definition at line 59 of file dif_clkmgr.c.

◆ dif_clkmgr_jitter_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_jitter_set_enabled	(	const dif_clkmgr_t *	clkmgr,
		dif_toggle_t	new_state
	)

Enable of Disable jitter.

Parameters

clkmgr	Clock Manager Handle.
new_state	whether to enable or disable jitter.

Returns: The result of the operation.

Definition at line 74 of file dif_clkmgr.c.

◆ dif_clkmgr_measure_counts_get_enable()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_measure_counts_get_enable	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_measure_clock_t	clock,
		dif_toggle_t *	state
	)

Get the count measurement enable.

Parameters

	clkmgr	Clock Manager Handle.
	clock	A clock to be measured.
[out]	state	The state of control enable.

Returns: The result of the operation.

Definition at line 368 of file dif_clkmgr.c.

◆ dif_clkmgr_measure_counts_get_thresholds()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_measure_counts_get_thresholds	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_measure_clock_t	clock,
		uint32_t *	min_threshold,
		uint32_t *	max_threshold
	)

Get the count measurement thresholds.

Parameters

	clkmgr	Clock Manager Handle.
	clock	A clock to be measured.
[out]	min_threshold	The minumum threshold.
[out]	max_threshold	The maximum threshold.

Returns: The result of the operation.

Definition at line 403 of file dif_clkmgr.c.

◆ dif_clkmgr_measure_ctrl_disable()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_measure_ctrl_disable ( const dif_clkmgr_t * clkmgr )

Disable measurement control updates.

This can only be disabled, and stays disabled until the next POR.

Parameters

clkmgr Clock Manager Handle.

Returns: The result of the operation.

Definition at line 212 of file dif_clkmgr.c.

◆ dif_clkmgr_measure_ctrl_get_enable()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_measure_ctrl_get_enable	(	const dif_clkmgr_t *	clkmgr,
		dif_toggle_t *	state
	)

Get measurement control state.

Parameters

	clkmgr	Clock Manager Handle.
[out]	state	The state of control enable.

Returns: The result of the operation.

Definition at line 221 of file dif_clkmgr.c.

◆ dif_clkmgr_recov_err_code_clear_codes()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_recov_err_code_clear_codes	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_recov_err_codes_t	codes
	)

Clear selected recoverable error codes.

Parameters

clkmgr	Clock Manager Handle.
codes	The recoverable error codes to be cleared.

Returns: The result of the operation.

Definition at line 465 of file dif_clkmgr.c.

◆ dif_clkmgr_recov_err_code_get_codes()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_recov_err_code_get_codes	(	const dif_clkmgr_t *	clkmgr,
		dif_clkmgr_recov_err_codes_t *	codes
	)

Read the recoverable error codes.

Parameters

	clkmgr	Clock Manager Handle.
[out]	codes	The recoverable error codes.

Returns: The result of the operation.

Definition at line 455 of file dif_clkmgr.c.

◆ dif_clkmgr_wait_for_ext_clk_switch()

OT_WARN_UNUSED_RESULT dif_result_t dif_clkmgr_wait_for_ext_clk_switch ( const dif_clkmgr_t * clkmgr )

Wait for external clock switch to finish.

Parameters

clkmgr Clock Manager Handle.

Returns: The result of the operation.

Definition at line 485 of file dif_clkmgr.c.

(8a1a5fe)

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ dif_clkmgr_fatal_err_codes_t

◆ dif_clkmgr_gateable_clock_t

◆ dif_clkmgr_hintable_clock_t

◆ dif_clkmgr_recov_err_codes_t

Enumeration Type Documentation

◆ dif_clkmgr_fatal_err_type

◆ dif_clkmgr_measure_clock

◆ dif_clkmgr_recov_err_type

Function Documentation

◆ dif_clkmgr_disable_measure_counts()

◆ dif_clkmgr_enable_measure_counts()

◆ dif_clkmgr_external_clock_is_settled()

◆ dif_clkmgr_external_clock_set_disabled()

◆ dif_clkmgr_external_clock_set_enabled()

◆ dif_clkmgr_fatal_err_code_get_codes()

◆ dif_clkmgr_gateable_clock_get_enabled()

◆ dif_clkmgr_gateable_clock_set_enabled()

◆ dif_clkmgr_hintable_clock_get_enabled()

◆ dif_clkmgr_hintable_clock_get_hint()

◆ dif_clkmgr_hintable_clock_set_hint()

◆ dif_clkmgr_jitter_get_enabled()

◆ dif_clkmgr_jitter_set_enabled()

◆ dif_clkmgr_measure_counts_get_enable()

◆ dif_clkmgr_measure_counts_get_thresholds()

◆ dif_clkmgr_measure_ctrl_disable()

◆ dif_clkmgr_measure_ctrl_get_enable()

◆ dif_clkmgr_recov_err_code_clear_codes()

◆ dif_clkmgr_recov_err_code_get_codes()

◆ dif_clkmgr_wait_for_ext_clk_switch()