mcuxClGlikey.h File Reference

Top-level include file for the Glikey driver. More...

#include <mcuxClConfig.h>
#include <stdint.h>
#include <stddef.h>
#include <mcuxCsslFlowProtection.h>
#include <mcuxClCore_FunctionIdentifiers.h>

Go to the source code of this file.

Macros
#define	MCUXCLGLIKEY_CODEWORD_STEP1
	Codeword for transition from STEP1 --> STEP2.
#define	MCUXCLGLIKEY_CODEWORD_STEP2
	Codeword for transition from STEP2 --> STEP3.
#define	MCUXCLGLIKEY_CODEWORD_STEP3
	Codeword for transition from STEP3 --> STEP4.
#define	MCUXCLGLIKEY_CODEWORD_STEP4
	Codeword for transition from STEP4 --> STEP5.
#define	MCUXCLGLIKEY_CODEWORD_STEP5
	Codeword for transition from STEP5 --> STEP6.
#define	MCUXCLGLIKEY_CODEWORD_STEP6
	Codeword for transition from STEP6 --> STEP7.
#define	MCUXCLGLIKEY_CODEWORD_STEP7
	Codeword for transition from STEP7 --> STEP8.
#define	MCUXCLGLIKEY_CODEWORD_STEP_EN
	Codeword for transition from STEP 4/8 --> WR_EN.
#define	MCUXCLGLIKEY_STATUS_OK
#define	MCUXCLGLIKEY_STATUS_NOT_LOCKED
#define	MCUXCLGLIKEY_STATUS_LOCKED
#define	MCUXCLGLIKEY_STATUS_VERSION_ERROR
#define	MCUXCLGLIKEY_STATUS_LOCKED_ERROR
#define	MCUXCLGLIKEY_FSM_WR_DIS
#define	MCUXCLGLIKEY_FSM_INIT
#define	MCUXCLGLIKEY_FSM_STEP1
#define	MCUXCLGLIKEY_FSM_STEP2
#define	MCUXCLGLIKEY_FSM_STEP3
#define	MCUXCLGLIKEY_FSM_STEP4
#define	MCUXCLGLIKEY_FSM_LOCKED
#define	MCUXCLGLIKEY_FSM_WR_EN
#define	MCUXCLGLIKEY_FSM_SSR_RESET

Typedefs
typedef uint32_t	mcuxClGlikey_BaseAddress_t
typedef uint32_t	mcuxClGlikey_Status_t
typedef uint32_t	mcuxClGlikey_IntEnable_t
typedef uint32_t	mcuxClGlikey_GlikeyStatus_t

Functions
mcuxClGlikey_Status_t	mcuxClGlikey_GetStatus (mcuxClGlikey_BaseAddress_t *base, mcuxClGlikey_GlikeyStatus_t *result)
	Retrieves the current status of Glikey.
mcuxClGlikey_Status_t	mcuxClGlikey_SyncReset (mcuxClGlikey_BaseAddress_t *base)
	Perform a synchronous reset of Glikey.
mcuxClGlikey_Status_t	mcuxClGlikey_SetIntEnable (mcuxClGlikey_BaseAddress_t *base, mcuxClGlikey_IntEnable_t value)
	Set interrupt enable flag of Glikey.
mcuxClGlikey_Status_t	mcuxClGlikey_GetIntEnable (mcuxClGlikey_BaseAddress_t *base, mcuxClGlikey_IntEnable_t *value)
	Get interrupt enable flag of Glikey.
mcuxClGlikey_Status_t	mcuxClGlikey_ClearIntStatus (mcuxClGlikey_BaseAddress_t *base)
	Clear the interrupt status flag of Glikey.
mcuxClGlikey_Status_t	mcuxClGlikey_SetIntStatus (mcuxClGlikey_BaseAddress_t *base)
	Set the interrupt status flag of Glikey.
mcuxClGlikey_Status_t	mcuxClGlikey_Lock (mcuxClGlikey_BaseAddress_t *base)
	Lock Glikey SFR interface.
mcuxClGlikey_Status_t	mcuxClGlikey_IsLocked (mcuxClGlikey_BaseAddress_t *base)
	Check if Glikey is locked.
mcuxClGlikey_Status_t	mcuxClGlikey_IsIndexLocked (mcuxClGlikey_BaseAddress_t *base, uint32_t index)
	Check if Glikey index is locked.
mcuxClGlikey_Status_t	mcuxClGlikey_StartEnable (mcuxClGlikey_BaseAddress_t *base, uint32_t index)
	Start Glikey enable.
mcuxClGlikey_Status_t	mcuxClGlikey_ContinueEnable (mcuxClGlikey_BaseAddress_t *base, uint32_t codeword)
	Continue Glikey enable.
mcuxClGlikey_Status_t	mcuxClGlikey_LockIndex (mcuxClGlikey_BaseAddress_t *base)
	Lock Glikey index.
mcuxClGlikey_Status_t	mcuxClGlikey_ResetIndex (mcuxClGlikey_BaseAddress_t *base, uint32_t index)
	Reset Glikey index.
mcuxClGlikey_Status_t	mcuxClGlikey_EndOperation (mcuxClGlikey_BaseAddress_t *base)
	End Glikey operation TODO: if we are in locked state we cannot exit(move to init) as curent index is locked.

Detailed Description

Top-level include file for the Glikey driver.

This header exposes functions that implement the driver interface for the Glikey IP.