Crypto Driver Backend API

Data Structures
struct	crypto_driver_api
	Driver Operations Crypto driver operations More...

Typedefs
typedef int(*	crypto_api_query_hw_caps) (const struct device *dev)
	Query crypto hardware capabilities.
typedef int(*	crypto_api_cipher_begin_session) (const struct device *dev, struct cipher_ctx *ctx, enum cipher_algo algo, enum cipher_mode mode, enum cipher_op op_type)
	Setup a crypto cipher session.
typedef int(*	crypto_api_cipher_free_session) (const struct device *dev, struct cipher_ctx *ctx)
	Cleanup a crypto cipher session.
typedef int(*	crypto_api_cipher_async_callback_set) (const struct device *dev, cipher_completion_cb cb)
	Register an asynchronous crypto cipher callback.
typedef int(*	crypto_api_hash_begin_session) (const struct device *dev, struct hash_ctx *ctx, enum hash_algo algo)
	Setup a crypto hash session.
typedef int(*	crypto_api_hash_free_session) (const struct device *dev, struct hash_ctx *ctx)
	Cleanup a crypto hash session.
typedef int(*	crypto_api_hash_async_callback_set) (const struct device *dev, hash_completion_cb cb)
	Register an asynchronous crypto hash callback.

Detailed Description

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

Typedef Documentation

crypto_api_cipher_async_callback_set

typedef int(* crypto_api_cipher_async_callback_set) (const struct device *dev, cipher_completion_cb cb)

#include <zephyr/crypto/crypto.h>

Register an asynchronous crypto cipher callback.

See cipher_callback_set() for argument description.

crypto_api_cipher_begin_session

typedef int(* crypto_api_cipher_begin_session) (const struct device *dev, struct cipher_ctx *ctx, enum cipher_algo algo, enum cipher_mode mode, enum cipher_op op_type)

#include <zephyr/crypto/crypto.h>

Setup a crypto cipher session.

See cipher_begin_session() for argument description.

crypto_api_cipher_free_session

typedef int(* crypto_api_cipher_free_session) (const struct device *dev, struct cipher_ctx *ctx)

#include <zephyr/crypto/crypto.h>

Cleanup a crypto cipher session.

See cipher_free_session() for argument description.

crypto_api_hash_async_callback_set

typedef int(* crypto_api_hash_async_callback_set) (const struct device *dev, hash_completion_cb cb)

#include <zephyr/crypto/crypto.h>

Register an asynchronous crypto hash callback.

See hash_callback_set() for argument description.

crypto_api_hash_begin_session

typedef int(* crypto_api_hash_begin_session) (const struct device *dev, struct hash_ctx *ctx, enum hash_algo algo)

#include <zephyr/crypto/crypto.h>

Setup a crypto hash session.

See hash_begin_session() for argument description.

crypto_api_hash_free_session

typedef int(* crypto_api_hash_free_session) (const struct device *dev, struct hash_ctx *ctx)

#include <zephyr/crypto/crypto.h>

Cleanup a crypto hash session.

See hash_free_session() for argument description.

crypto_api_query_hw_caps

typedef int(* crypto_api_query_hw_caps) (const struct device *dev)

#include <zephyr/crypto/crypto.h>

Query crypto hardware capabilities.

See crypto_query_hwcaps() for argument description.