I3C HDR DDR API

I3C HDR DDR API. More...

Functions
static int	i3c_hdr_ddr_write (struct i3c_device_desc *target, uint8_t cmd, uint8_t *buf, uint32_t num_bytes)
	Write a set amount of data to an I3C target device with HDR DDR.
static int	i3c_hdr_ddr_read (struct i3c_device_desc *target, uint8_t cmd, uint8_t *buf, uint32_t num_bytes)
	Read a set amount of data from an I3C target device with HDR DDR.
static int	i3c_hdr_ddr_write_read (struct i3c_device_desc *target, const void *write_buf, size_t num_write, uint8_t read_cmd, void *read_buf, size_t num_read, uint8_t write_cmd)
	Write then read data from an I3C target device with HDR DDR.

Detailed Description

I3C HDR DDR API.

Function Documentation

i3c_hdr_ddr_read()

static int i3c_hdr_ddr_read ( struct i3c_device_desc *  target, uint8_t  cmd, uint8_t *  buf, uint32_t  num_bytes  )

inlinestatic

#include <include/zephyr/drivers/i3c/hdr_ddr.h>

Read a set amount of data from an I3C target device with HDR DDR.

This routine reads a set amount of data synchronously.

Parameters

target	I3C target device descriptor.
cmd	7-bit command code
buf	Memory pool that stores the retrieved data.
num_bytes	Number of bytes to read.

Return values

0	If successful.
-EBUSY	Bus is busy.
-EIO	General input / output error.

i3c_hdr_ddr_write()

static int i3c_hdr_ddr_write ( struct i3c_device_desc *  target, uint8_t  cmd, uint8_t *  buf, uint32_t  num_bytes  )

inlinestatic

#include <include/zephyr/drivers/i3c/hdr_ddr.h>

Write a set amount of data to an I3C target device with HDR DDR.

This routine writes a set amount of data synchronously.

Parameters

target	I3C target device descriptor.
cmd	7-bit command code
buf	Memory pool from which the data is transferred.
num_bytes	Number of bytes to write.

Return values

0	If successful.
-EBUSY	Bus is busy.
-EIO	General input / output error.

i3c_hdr_ddr_write_read()

static int i3c_hdr_ddr_write_read ( struct i3c_device_desc *  target, const void *  write_buf, size_t  num_write, uint8_t  read_cmd, void *  read_buf, size_t  num_read, uint8_t  write_cmd  )

inlinestatic

#include <include/zephyr/drivers/i3c/hdr_ddr.h>

Write then read data from an I3C target device with HDR DDR.

This supports the common operation "this is what I want", "now give it to me" transaction pair through a combined write-then-read bus transaction.

Parameters

target	I3C target device descriptor.
write_buf	Pointer to the data to be written
num_write	Number of bytes to write
write_cmd	7-bit command code for write
read_buf	Pointer to storage for read data
num_read	Number of bytes to read
read_cmd	7-bit command code for read

Return values

0	if successful
-EBUSY	Bus is busy.
-EIO	General input / output error.