SCMI channel structure. More...

#include <zephyr/drivers/firmware/scmi/transport.h>

Data Fields
struct k_mutex	lock
	channel lock.
struct k_sem	sem
	binary semaphore.
void *	data
	channel private data
scmi_channel_cb	cb
	callback function.
bool	ready
	is the channel ready to be used by a protocol?

Detailed Description

SCMI channel structure.

An SCMI channel is a medium through which a protocol is able to transmit/receive messages. Each of the SCMI channels is represented by a struct scmi_channel.

Field Documentation

◆ cb

scmi_channel_cb scmi_channel::cb

callback function.

This is meant to be set by the SCMI core and should be called by the SCMI transport layer driver whenever a reply has been received.

◆ data

void* scmi_channel::data

channel private data

◆ lock

struct k_mutex scmi_channel::lock

channel lock.

This is meant to be initialized and used only by the SCMI core to assure that only one protocol can send/receive messages through a channel at a given moment.

◆ ready

bool scmi_channel::ready

is the channel ready to be used by a protocol?

◆ sem

struct k_sem scmi_channel::sem

binary semaphore.

This is meant to be initialized and used only by the SCMI core. Its purpose is to signal that a reply has been received.

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

zephyr/drivers/firmware/scmi/transport.h