occp.h File Reference

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

Go to the source code of this file.

Data Structures
struct	occp_backend
	Open Chiplet Configuration Protocol (OCCP) definitions. More...
struct	occp_backend_i3c

Functions
int	occp_backend_i3c_init (struct occp_backend_i3c *backend, struct i3c_device_desc *i3c_dev)
	Initialize I3C backend.
int	occp_get_version (const struct occp_backend *backend, uint8_t *major, uint8_t *minor, uint8_t *patch)
	Get OCCP protocol version.
int	occp_write_data (const struct occp_backend *backend, uint64_t address, const uint8_t *data, size_t length)
	Write data to OCCP device.
int	occp_read_data (const struct occp_backend *backend, uint64_t address, uint8_t *data, size_t length)
	Read data from OCCP device.
int	occp_execute_image (const struct occp_backend *backend, uint64_t execution_address, uint8_t cpu_id)
	Execute image at specified address.

Function Documentation

occp_backend_i3c_init()

int occp_backend_i3c_init	(	struct occp_backend_i3c *	backend,
		struct i3c_device_desc *	i3c_dev )

Initialize I3C backend.

Parameters

backend	Pointer to I3C backend structure
i3c_dev	Pointer to I3C device descriptor

Returns

0 on success, negative error code on failure

occp_execute_image()

int occp_execute_image	(	const struct occp_backend *	backend,
		uint64_t	execution_address,
		uint8_t	cpu_id )

Execute image at specified address.

Parameters

backend	OCCP backend to use
execution_address	Address to execute image from
cpu_id	CPU ID to execute on

Returns

0 on success, negative error code on failure

occp_get_version()

int occp_get_version	(	const struct occp_backend *	backend,
		uint8_t *	major,
		uint8_t *	minor,
		uint8_t *	patch )

Get OCCP protocol version.

Parameters

backend	OCCP backend to use
major	Pointer to store major version
minor	Pointer to store minor version
patch	Pointer to store patch version

Returns

0 on success, negative error code on failure

occp_read_data()

int occp_read_data	(	const struct occp_backend *	backend,
		uint64_t	address,
		uint8_t *	data,
		size_t	length )

Read data from OCCP device.

Parameters

backend	OCCP backend to use
address	Address to read from
data	Pointer to buffer to store read data
length	Length of data to read

Returns

0 on success, negative error code on failure

occp_write_data()

int occp_write_data	(	const struct occp_backend *	backend,
		uint64_t	address,
		const uint8_t *	data,
		size_t	length )

Write data to OCCP device.

Parameters

backend	OCCP backend to use
address	Address to write to
data	Pointer to data to write
length	Length of data to write

Returns

0 on success, negative error code on failure