Xecc

Data Structures
struct	_xecc_config
	XECC user configuration. More...
struct	_xecc_single_error_info
	XECC single error information, including single error address, ECC code, error data, error bit position and error bit field. More...
struct	_xecc_multi_error_info
	XECC multiple error information, including multiple error address, ECC code, error data and error bit field. More...

Driver version
enum	{ kXECC_SingleErrorInterruptEnable = XECC_ERR_SIG_EN_SINGLE_ERR_SIG_EN_MASK , kXECC_MultiErrorInterruptEnable = XECC_ERR_SIG_EN_MULTI_ERR_SIG_EN_MASK , kXECC_AllInterruptsEnable }
	XECC interrupt configuration structure, , xecc_interrupt_enable_t. More...
enum	{ kXECC_SingleErrorInterruptStatusEnable , kXECC_MultiErrorInterruptStatusEnable , kXECC_AllInterruptsStatusEnable }
	XECC interrupt status configuration structure, xecc_interrupt_status_enable_t. More...
enum	{ kXECC_SingleErrorInterruptFlag , kXECC_MultiErrorInterruptFlag , kXECC_AllInterruptsFlag }
	XECC status flags, xecc_interrupt_status_t. More...
typedef struct _xecc_config	xecc_config_t
	XECC user configuration.
typedef struct _xecc_single_error_info	xecc_single_error_info_t
	XECC single error information, including single error address, ECC code, error data, error bit position and error bit field.
typedef struct _xecc_multi_error_info	xecc_multi_error_info_t
	XECC multiple error information, including multiple error address, ECC code, error data and error bit field.
#define	FSL_XECC_DRIVER_VERSION   (MAKE_VERSION(2U, 0U, 0U))
	Driver version 2.0.0.

Initialization and deinitialization
void	XECC_Init (XECC_Type *base, const xecc_config_t *config)
	XECC module initialization function.
void	XECC_Deinit (XECC_Type *base)
	Deinitializes the XECC.
void	XECC_GetDefaultConfig (xecc_config_t *config)
	Sets the XECC configuration structure to default values.

functional
status_t	XECC_ErrorInjection (XECC_Type *base, uint32_t errordata, uint8_t erroreccdata)
	XECC module error injection.
void	XECC_GetSingleErrorInfo (XECC_Type *base, xecc_single_error_info_t *info)
	XECC module get single error information.
void	XECC_GetMultiErrorInfo (XECC_Type *base, xecc_multi_error_info_t *info)
	XECC module get multiple error information.

Detailed Description

Enumeration Type Documentation

anonymous enum

anonymous enum

XECC interrupt configuration structure, , xecc_interrupt_enable_t.

This structure contains the settings for all of the XECC interrupt configurations.

Enumerator
kXECC_SingleErrorInterruptEnable	Single bit error interrupt enable
kXECC_MultiErrorInterruptEnable	Multiple bit error interrupt enable
kXECC_AllInterruptsEnable	all interrupts enable

anonymous enum

anonymous enum

XECC interrupt status configuration structure, xecc_interrupt_status_enable_t.

This structure contains the settings for all of the XECC interrupt status configurations.

Enumerator
kXECC_SingleErrorInterruptStatusEnable	Single bit error interrupt status enable
kXECC_MultiErrorInterruptStatusEnable	Multiple bits error interrupt status enable
kXECC_AllInterruptsStatusEnable	all interrupts enable

anonymous enum

anonymous enum

XECC status flags, xecc_interrupt_status_t.

This provides constants for the XECC status flags for use in the XECC functions.

Enumerator
kXECC_SingleErrorInterruptFlag	Single bit error interrupt happens on read data
kXECC_MultiErrorInterruptFlag	Multiple bits error interrupt happens on read data
kXECC_AllInterruptsFlag	all interrupts happens on read data

Function Documentation

XECC_Deinit()

void XECC_Deinit

(

XECC_Type *

base

)

Deinitializes the XECC.

Parameters

base	XECC base address.

brief Deinitializes the XECC.

XECC_ErrorInjection()

status_t XECC_ErrorInjection	(	XECC_Type *	base,
		uint32_t	errordata,
		uint8_t	erroreccdata
	)

XECC module error injection.

Parameters

base	XECC base address.
errordata	error data.
erroreccdata	ecc code.

Return values

kStatus_Success.

XECC_GetDefaultConfig()

void XECC_GetDefaultConfig

(

xecc_config_t *

config

)

Sets the XECC configuration structure to default values.

Parameters

config

pointer to the XECC configuration structure.

XECC_GetMultiErrorInfo()

void XECC_GetMultiErrorInfo	(	XECC_Type *	base,
		xecc_multi_error_info_t *	info
	)

XECC module get multiple error information.

Parameters

base	XECC base address.
info	multiple error information.

XECC_GetSingleErrorInfo()

void XECC_GetSingleErrorInfo	(	XECC_Type *	base,
		xecc_single_error_info_t *	info
	)

XECC module get single error information.

Parameters

base	XECC base address.
info	single error information.

XECC_Init()

void XECC_Init	(	XECC_Type *	base,
		const xecc_config_t *	config
	)

XECC module initialization function.

Parameters

base	XECC base address.
config	pointer to the XECC configuration structure.

brief XECC module initialization function.

param base XECC base address.