Zephyr API Documentation 4.4.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
CRC Driver Backend API

Data Structures

struct  crc_driver_api
  Driver Operations CRC driver operations More...

Typedefs

typedef int(* crc_api_begin) (const struct device *dev, struct crc_ctx *ctx)
 Callback API to configure the CRC unit for calculation.
typedef int(* crc_api_update) (const struct device *dev, struct crc_ctx *ctx, const void *buffer, size_t bufsize)
 Callback API to feed data into an in-progress CRC calculation.
typedef int(* crc_api_finish) (const struct device *dev, struct crc_ctx *ctx)
 Callback API to finalize CRC calculation.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a CRC driver.

Typedef Documentation

◆ crc_api_begin

typedef int(* crc_api_begin) (const struct device *dev, struct crc_ctx *ctx)

#include <zephyr/drivers/crc.h>

Callback API to configure the CRC unit for calculation.

See crc_begin() for argument description.

◆ crc_api_finish

typedef int(* crc_api_finish) (const struct device *dev, struct crc_ctx *ctx)

#include <zephyr/drivers/crc.h>

Callback API to finalize CRC calculation.

See crc_finish() for argument description.

◆ crc_api_update

typedef int(* crc_api_update) (const struct device *dev, struct crc_ctx *ctx, const void *buffer, size_t bufsize)

#include <zephyr/drivers/crc.h>

Callback API to feed data into an in-progress CRC calculation.

See crc_update() for argument description.