cipher_pkt Struct Reference

Structure encoding IO parameters of one cryptographic operation like encrypt/decrypt. More...

#include <cipher.h>

Data Fields
uint8_t *	in_buf
	Start address of input buffer.
int	in_len
	Bytes to be operated upon.
uint8_t *	out_buf
	Start of the output buffer, to be allocated by the application.
int	out_buf_max
	Size of the out_buf area allocated by the application.
int	out_len
	To be populated by driver on return from cipher_xxx_op() and holds the size of the actual result.
struct cipher_ctx *	ctx
	Context this packet relates to.

Detailed Description

Structure encoding IO parameters of one cryptographic operation like encrypt/decrypt.

The fields which has not been explicitly called out has to be filled up by the app before making the cipher_xxx_op() call.

Field Documentation

ctx

struct cipher_ctx* cipher_pkt::ctx

Context this packet relates to.

This can be useful to get the session details, especially for async ops. Will be populated by the cipher_xxx_op() API based on the ctx parameter.

in_buf

uint8_t* cipher_pkt::in_buf

Start address of input buffer.

in_len

int cipher_pkt::in_len

Bytes to be operated upon.

out_buf

uint8_t* cipher_pkt::out_buf

Start of the output buffer, to be allocated by the application.

Can be NULL for in-place ops. To be populated with contents by the driver on return from op / async callback.

out_buf_max

int cipher_pkt::out_buf_max

Size of the out_buf area allocated by the application.

Drivers should not write past the size of output buffer.

out_len

int cipher_pkt::out_len

To be populated by driver on return from cipher_xxx_op() and holds the size of the actual result.

---

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

• include/zephyr/crypto/cipher.h