Detailed Description

Core mmpkt data structure.

Note: The contents of this data structure should never need to be accessed directly. Rather the various functions provided as part of this API should be used.

 +----------------------------------------------------------+--------------+
 | RESERVED |              Data            |    RESERVED    |   METADATA   |
 +----------------------------------------------------------+--------------+
 ^          ^                              ^                ^
 |          |                              |                |
 |          |<-----------data_len--------->|                |
 |     start_offset                                         |
 |                                                          |
 |<-----------------------buf_len-------------------------->|
buf

Definition at line 78 of file mmpkt.h.

#include <mmpkt.h>

Data Fields
uint8_t *	buf
	The buffer where data is stored. More...

uint32_t	buf_len
	Length of the buffer. More...

uint32_t	start_offset
	Offset where actual data starts in the buffer. More...

uint32_t	data_len
	Length of actual data in the buffer. More...

union mmpkt_metadata_ptr	metadata
	Packet metadata used by driver (context dependent). More...

const struct mmpkt_ops *	ops
	Reference to operations data structure for this mmpkt. More...

struct mmpkt *volatile	next
	Pointer that can be used to construct linked lists. More...

Field Documentation

◆ buf

uint8_t* mmpkt::buf

The buffer where data is stored.

Definition at line 81 of file mmpkt.h.

◆ buf_len

uint32_t mmpkt::buf_len

Length of the buffer.

Definition at line 83 of file mmpkt.h.

◆ data_len

uint32_t mmpkt::data_len

Length of actual data in the buffer.

Definition at line 87 of file mmpkt.h.

◆ metadata

union mmpkt_metadata_ptr mmpkt::metadata

Packet metadata used by driver (context dependent).

Definition at line 89 of file mmpkt.h.

◆ next

struct mmpkt* volatile mmpkt::next

Pointer that can be used to construct linked lists.

Definition at line 93 of file mmpkt.h.

◆ ops

const struct mmpkt_ops* mmpkt::ops

Reference to operations data structure for this mmpkt.

Definition at line 91 of file mmpkt.h.

◆ start_offset

uint32_t mmpkt::start_offset

Offset where actual data starts in the buffer.

Definition at line 85 of file mmpkt.h.

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

mmpkt.h