Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
i3c_ccc_payload Struct Reference

Payload structure for one CCC transaction. More...

#include <ccc.h>

Data Fields

struct { 
 
   uint8_t   id 
 The CCC ID (I3C_CCC_*). More...
 
   uint8_t *   data 
 Pointer to byte array of data for this CCC. More...
 
   size_t   data_len 
 Length in bytes for optional data array. More...
 
   size_t   num_xfer 
 Total number of bytes transferred. More...
 
ccc 
 
struct { 
 
   struct i3c_ccc_target_payload *   payloads 
 Array of struct i3c_ccc_target_payload. More...
 
   size_t   num_targets 
 Number of targets. More...
 
targets 
 

Detailed Description

Payload structure for one CCC transaction.

Field Documentation

◆ [struct]

struct { ... } i3c_ccc_payload::ccc

◆ data

uint8_t* i3c_ccc_payload::data

Pointer to byte array of data for this CCC.

This is the bytes following the CCC command in CCC frame. Set to NULL if no associated data.

◆ data_len

size_t i3c_ccc_payload::data_len

Length in bytes for optional data array.

◆ id

uint8_t i3c_ccc_payload::id

The CCC ID (I3C_CCC_*).

◆ num_targets

size_t i3c_ccc_payload::num_targets

Number of targets.

◆ num_xfer

size_t i3c_ccc_payload::num_xfer

Total number of bytes transferred.

A Controller can abort a transfer before the length of the buffer. It is expected for the driver to write to this after the transfer.

◆ payloads

struct i3c_ccc_target_payload* i3c_ccc_payload::payloads

Array of struct i3c_ccc_target_payload.

Each element describes the target and associated payloads for this CCC.

Use with Direct CCC.

◆ [struct]

struct { ... } i3c_ccc_payload::targets

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