Zephyr API Documentation 4.4.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
crc_driver_api Struct Reference

Driver Operations CRC driver operations More...

#include <zephyr/drivers/crc.h>

Data Fields

crc_api_begin begin
  OPT Configure CRC unit for calculation.
crc_api_update update
  OPT Perform CRC calculation on the provided data buffer and retrieve result.
crc_api_finish finish
  OPT Finalize CRC calculation.

Detailed Description

Driver Operations CRC driver operations

This is the driver API structure any CRC driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also
DEVICE_DT_INST_DEFINE()
DEVICE_DT_DEFINE()
DEVICE_API()

Field Documentation

◆ begin

crc_api_begin crc_driver_api::begin

OPT Configure CRC unit for calculation.

◆ finish

crc_api_finish crc_driver_api::finish

OPT Finalize CRC calculation.

◆ update

crc_api_update crc_driver_api::update

OPT Perform CRC calculation on the provided data buffer and retrieve result.


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