crc_api_t Struct Reference

#include <r_crc_api.h>

Data Fields
ssp_err_t(*	open )(crc_ctrl_t *const p_ctrl, crc_cfg_t const *const p_cfg)
ssp_err_t(*	close )(crc_ctrl_t *const p_ctrl)
ssp_err_t(*	crcResultGet )(crc_ctrl_t *const p_ctrl, uint32_t *crc_result)
ssp_err_t(*	snoopEnable )(crc_ctrl_t *const p_ctrl, uint32_t crc_seed)
ssp_err_t(*	snoopDisable )(crc_ctrl_t *const p_ctrl)
ssp_err_t(*	snoopCfg )(crc_ctrl_t *const p_ctrl, crc_snoop_cfg_t *const p_snoop_cfg)
ssp_err_t(*	calculate )(crc_ctrl_t *const p_ctrl, void *p_input_buffer, uint32_t num_bytes, uint32_t crc_seed, uint32_t *p_crc_result)
ssp_err_t(*	versionGet )(ssp_version_t *version)

Detailed Description

CRC driver structure. General CRC functions implemented at the HAL layer will follow this API.

Field Documentation

calculate

ssp_err_t(* crc_api_t::calculate) (crc_ctrl_t *const p_ctrl, void *p_input_buffer, uint32_t num_bytes, uint32_t crc_seed, uint32_t *p_crc_result)

Perform a CRC calculation on a block of data.

Implemented as

• R_CRC_Calculate()

Parameters

[in]	p_ctrl	Pointer to crc device handle.
[in]	input_buffer	A pointer to an array of data values.
[in]	num_bytes	The number of bytes (not elements) in the array.
[in]	crc_seed	The seeded value for crc calculations.
[out]	crc_result	The calculated value of the CRC calculation.

close

ssp_err_t(* crc_api_t::close) (crc_ctrl_t *const p_ctrl)

Close the CRC module driver

Implemented as

• R_CRC_Close()

Parameters

[in]

p_ctrl

Pointer to crc device handle

Return values

SSP_SUCCESS

Configuration was successful.

crcResultGet

ssp_err_t(* crc_api_t::crcResultGet) (crc_ctrl_t *const p_ctrl, uint32_t *crc_result)

Return the current calculated value.

Implemented as

• R_CRC_CalculatedValueGet()

Parameters

[in]	p_ctrl	Pointer to CRC device handle.
[out]	crc_result	The calculated value from the last CRC calculation.

open

ssp_err_t(* crc_api_t::open) (crc_ctrl_t *const p_ctrl, crc_cfg_t const *const p_cfg)

Open the CRC driver module.

Implemented as

• R_CRC_Open()

Parameters

[in]	p_ctrl	Pointer to CRC device handle.
[in]	p_cfg	Pointer to a configuration structure.

snoopCfg

ssp_err_t(* crc_api_t::snoopCfg) (crc_ctrl_t *const p_ctrl, crc_snoop_cfg_t *const p_snoop_cfg)

Configure the snoop channel and direction.

Implemented as

• R_CRC_SnoopCfg()

Parameters

[in]	p_ctrl	Pointer to crc device handle.
[in]	p_snoopCfg	Snoop configuration.

snoopDisable

ssp_err_t(* crc_api_t::snoopDisable) (crc_ctrl_t *const p_ctrl)

Disable snooping.

Implemented as

• R_CRC_SnoopDisable()

Parameters

[in]

p_ctrl

Pointer to crc device handle.

snoopEnable

ssp_err_t(* crc_api_t::snoopEnable) (crc_ctrl_t *const p_ctrl, uint32_t crc_seed)

Enable snooping.

Implemented as

• R_CRC_SnoopEnable()

Parameters

[in]	p_ctrl	Pointer to CRC device handle.
[in]	crc_seed	CRC seed.

versionGet

ssp_err_t(* crc_api_t::versionGet) (ssp_version_t *version)

Get the driver version based on compile time macros.

Implemented as

• R_CRC_VersionGet()

---

The documentation for this struct was generated from the following file:

• r_crc_api.h