Cyclic Redundancy Check#

sl_crc_params_t#

typedef RSI_CRC_PARAMS_T sl_crc_params_t

Renamed CRC param structure.

sl_si91x_crc_set_gen_control#

sl_status_t sl_si91x_crc_set_gen_control (void )

Clears the FIFO and resets all state machines.

This API clears the FIFO and resets all state machines. It ensures that the CRC module is in a known state before starting a new operation.

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Invalid parameter.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_get_general_status#

sl_status_t sl_si91x_crc_get_general_status (uint32_t * reg_status)

To retrieve the general status of the CRC signals.

This API retrieves the general status of the CRC signals and stores it in the provided pointer.

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_NULL_POINTER (0x0021) - Invalid null pointer received as an argument.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_polynomial#

sl_status_t sl_si91x_crc_polynomial (sl_crc_params_t * pCRCParams)

To load the polynomial value into the polynomial register.

This API loads the polynomial value into the polynomial register using the provided CRC parameters.

• Pre-conditions:

  • sl_si91x_crc_enable

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_NULL_POINTER (0x0021) - Invalid null pointer received as an argument.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_polynomial_width#

sl_status_t sl_si91x_crc_polynomial_width (sl_crc_params_t * pCRCParams, uint32_t * reg_status)

To set the width of the polynomial for CRC computation.

This API sets the width of the polynomial for CRC computation. If a new width needs to be configured, clear the existing length first by writing 0x1F to the polynomial_ctrl_reset register.

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Invalid parameters.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_lfsr_init#

sl_status_t sl_si91x_crc_lfsr_init (sl_crc_params_t * pCRCParams)

To initialize the LFSR value for CRC computation.

This API initializes the Linear Feedback Shift Register (LFSR) value for CRC computation. The LFSR needs to be initialized with the init value whenever required.

• Pre-conditions:

  • sl_si91x_crc_enable

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Invalid parameters

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_use_swapped_init#

sl_status_t sl_si91x_crc_use_swapped_init (sl_crc_params_t * pCRCParams, uint32_t * reg_status)

To load a swapped version of the LFSR init value into the LFSR state.

This API loads a swapped version of the Linear Feedback Shift Register (LFSR) init value into the LFSR state. It is used to initialize the LFSR with a swapped init value for CRC computation.

• Pre-conditions:

  • sl_si91x_crc_enable

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_set_data_width_type#

sl_status_t sl_si91x_crc_set_data_width_type (sl_crc_params_t * pCRCParams, uint32_t * oper_status)

To set and control the data width types for CRC computation.

This API sets and controls the data width types for CRC computation using the provided CRC parameters.

Returns

• Status code:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_set_fifo_thresholds#

sl_status_t sl_si91x_crc_set_fifo_thresholds (sl_crc_params_t * pCRCParams, uint32_t * oper_status)

To set the FIFO threshold levels for CRC computation.

This API sets the FIFO threshold levels for CRC computation. The maximum value for both thresholds is 15.

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_write_data#

sl_status_t sl_si91x_crc_write_data (sl_crc_params_t * pCRCParams, uint32_t data, uint32_t * oper_status)

To set the input data for CRC calculation.

This API sets the input data for CRC calculation using the provided CRC parameters.

• Pre-conditions:

  • sl_si91x_crc_enable

  • sl_si91x_crc_polynomial

  • sl_si91x_crc_polynomial_width

  • sl_si91x_crc_lfsr_init

  • sl_si91x_crc_set_data_width_type

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_monitor_crc_calc#

sl_status_t sl_si91x_crc_monitor_crc_calc (sl_crc_params_t * pCRCParams, uint32_t * crc)

To monitor the CRC calculation status and return the CRC value.

This API monitors the CRC calculation status and returns the calculated CRC value.

• Pre-conditions:

  • sl_si91x_crc_enable

  • sl_si91x_crc_polynomial

  • sl_si91x_crc_polynomial_width

  • sl_si91x_crc_lfsr_init

  • sl_si91x_crc_set_data_width_type

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_lfsr_dynamic_write#

sl_status_t sl_si91x_crc_lfsr_dynamic_write (sl_crc_params_t * pCRCParams)

To write the LFSR state directly for dynamic operation.

This API writes the Linear Feedback Shift Register (LFSR) state directly for dynamic operation.

• Pre-conditions:

  • sl_si91x_crc_enable

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_reset_fifo#

sl_status_t sl_si91x_crc_reset_fifo (void )

To reset the FIFO pointer and clear the FIFO.

This API resets the FIFO pointer and clears the FIFO, ensuring that the FIFO is empty and ready for new data.

• Pre-conditions:

  • sl_si91x_crc_enable

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success

  • SL_STATUS_FAIL (0x0001) - Function failed

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_get_fifo_status#

sl_status_t sl_si91x_crc_get_fifo_status (uint32_t * reg_status)

To retrieve the FIFO status of the CRC occupancy.

This API retrieves the FIFO status of the CRC occupancy and stores the status in the provided register.

• Pre-conditions:

  • sl_si91x_crc_enable

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_enable#

sl_status_t sl_si91x_crc_enable (void )

To enable the CRC peripheral by enabling its clock.

This API enables the CRC peripheral by enabling its clock, allowing CRC operations to be performed.

Returns

• Status code indicating the result::

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_FAIL (0x0001) - Function failed.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_crc_disable#

sl_status_t sl_si91x_crc_disable (void )

To disable the CRC peripheral by disabling its clock.

This API disables the CRC peripheral by disabling its clock, preventing any further CRC operations.

• Pre-conditions:

  • sl_si91x_crc_enable

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_FAIL (0x0001) - Function failed.

For more information on status codes, see SL STATUS DOCUMENTATION.

SL_CRC_POLYNOMIAL#

#define SL_CRC_POLYNOMIAL

0x04C11DB7

Polynomial used for CRC calculation.

SL_CRC_POLY_WIDTH#

#define SL_CRC_POLY_WIDTH

31

Width of the polynomial.

SL_CRC_LFSR_VAL#

#define SL_CRC_LFSR_VAL

0x0000

Initial LFSR value.

SL_CRC_WIDTH_TYPE#

#define SL_CRC_WIDTH_TYPE

0

Type of CRC.

SL_CRC_DIN_WIDTH#

#define SL_CRC_DIN_WIDTH

31

Width of the input data.

SL_CRC_NUM_BYTES#

#define SL_CRC_NUM_BYTES

3

Number of bytes to be written to the CRC.

SL_CRC_AEMPTY#

#define SL_CRC_AEMPTY

6

Empty threshold level.

SL_CRC_AFULL#

#define SL_CRC_AFULL

2

Full threshold level.

SL_CRC_SWAP_DIN#

#define SL_CRC_SWAP_DIN

0

Swap the input data.

SL_CRC_USE_UDMA#

#define SL_CRC_USE_UDMA

1

Use uDMA for CRC calculation.

SL_CRC_SWAP_LFSR#

#define SL_CRC_SWAP_LFSR

1

Swap the LFSR value.