Functions

General Description

Functions
cy_en_hppass_status_t	Cy_HPPASS_AC_UpdateStateTransitionTable (uint8_t numEntries, const cy_stc_hppass_ac_stt_t *stateTransitionTable, uint8_t startState)
	Used for adding or replacing state into State Transition Table - useful for multiple applications accessing the High Performance Programmable Analog Sub-System. More...
__STATIC_INLINE cy_en_hppass_status_t	Cy_HPPASS_AC_LoadStateTransitionTable (uint8_t numEntries, const cy_stc_hppass_ac_stt_t *stateTransitionTable)
	Configuring the State Transition Table of the the Autonomous Controller according to the provided settings. More...
__STATIC_INLINE bool	Cy_HPPASS_AC_IsRunning (void)
	Returns the running/stopped status of the Autonomous Controller. More...
cy_en_hppass_status_t	Cy_HPPASS_AC_Start (uint8_t startState, uint16_t timeoutUs)
	Starts the Autonomous Controller from the specified STT state. More...
cy_en_hppass_status_t	Cy_HPPASS_AC_GetState (cy_stc_hppass_state_t *state)
	Provides status of operation for the Autonomous Controller. More...
__STATIC_INLINE bool	Cy_HPPASS_AC_IsBlockReady (void)
	Returns the AC block ready status. More...

Function Documentation

Cy_HPPASS_AC_UpdateStateTransitionTable()

cy_en_hppass_status_t Cy_HPPASS_AC_UpdateStateTransitionTable	(	uint8_t	numEntries,
		const cy_stc_hppass_ac_stt_t *	stateTransitionTable,
		uint8_t	startState
	)

Used for adding or replacing state into State Transition Table - useful for multiple applications accessing the High Performance Programmable Analog Sub-System.

Parameters

numEntries	Number of entries of the State Transition Table for replace. Valid range: 1...CY_HPPASS_AC_STT_SIZE.
stateTransitionTable	Pointer to array containing new set of configuration data for State Transition Table, which must be replaced or added. The pointer cannot be NULL.
startState	Defines state in the State Transition Table from which update of the content begins. Valid range: 0...CY_HPPASS_AC_STT_SIZE - 1.

Returns

Combined value of all the subsystem statuses, cy_en_hppass_status_t.

Cy_HPPASS_AC_LoadStateTransitionTable()

__STATIC_INLINE cy_en_hppass_status_t Cy_HPPASS_AC_LoadStateTransitionTable	(	uint8_t	numEntries,
		const cy_stc_hppass_ac_stt_t *	stateTransitionTable
	)

Configuring the State Transition Table of the the Autonomous Controller according to the provided settings.

Parameters

numEntries	Number of entries in the State Transition Table. Valid range: 1...CY_HPPASS_AC_STT_SIZE.
stateTransitionTable	Pointer to array containing configuration data for entire State Transition Table, cy_stc_hppass_ac_stt_t. The pointer cannot be NULL.

Returns

Combined value of all the subsystem statuses, cy_en_hppass_status_t.

Cy_HPPASS_AC_IsRunning()

__STATIC_INLINE bool Cy_HPPASS_AC_IsRunning

(

void

)

Returns the running/stopped status of the Autonomous Controller.

Returns

Running status: true - running, false - stopped.

Cy_HPPASS_AC_Start()

cy_en_hppass_status_t Cy_HPPASS_AC_Start	(	uint8_t	startState,
		uint16_t	timeoutUs
	)

Starts the Autonomous Controller from the specified STT state.

Note

The AC, in case of emergency hanging up, can be forcibly stopped by the Cy_HPPASS_DeInit only.

Parameters

startState	Starting state index in the State Transition Table.
timeoutUs	The startup timeout in microseconds. When non-zero - the function waits for the BLOCK_READY status and check the timeout. When zero - the function just triggers AC start command and returns immediately.

Returns

Status of execution:

• CY_HPPASS_SUCCESS - the AC is started successfully.
• CY_HPPASS_AC_INVALID_STATE - the AC is already running.
• CY_HPPASS_AC_BAD_PARAM - input parameter is invalid.
• CY_HPPASS_VDDA_FAIL - VDDA is out of range.
• CY_HPPASS_TIMEOUT - the timeout timer has expired before BLOCK_READY condition.

Cy_HPPASS_AC_GetState()

cy_en_hppass_status_t Cy_HPPASS_AC_GetState

(

cy_stc_hppass_state_t *

state

)

Provides status of operation for the Autonomous Controller.

Parameters

state

Pointer to structure for receiving state regarding operation conditions of the Autonomous Controller, cy_stc_hppass_state_t. The pointer cannot be NULL.

Returns

Status of execution, cy_en_hppass_status_t.

Cy_HPPASS_AC_IsBlockReady()

__STATIC_INLINE bool Cy_HPPASS_AC_IsBlockReady

(

void

)

Returns the AC block ready status.

Returns

Running status: true - ready for use, false - not ready.