firmware/arm_scmi/protocols.h

1 /* SPDX-License-Identifier: GPL-2.0 */
39  * struct scmi_msg_resp_prot_version - Response for a message
56  * struct scmi_msg - Message(Tx/Rx) structure
67  * struct scmi_msg_hdr - Message(Tx/Rx) header
89  * struct scmi_xfer - Structure representing a message flow
94  * @rx: Receive message, the buffer should be pre-allocated to store
95  *	message. If request-ACK protocol is used, we can reuse the same
108  *	   though the timed-out transaction will anyway cause the command
109  *	   request to be reported as failed by time-out, the underlying xfer
115  *	    - SCMI_XFER_SENT_OK -> SCMI_XFER_RESP_OK [ -> SCMI_XFER_DRESP_OK ]
116  *	    - SCMI_XFER_SENT_OK -> SCMI_XFER_DRESP_OK
140 #define SCMI_XFER_IS_RAW(x)	((x)->flags & SCMI_XFER_FLAG_IS_RAW)
143 	((x)->flags & SCMI_XFER_FLAG_CHAN_SET)
154  * struct scmi_protocol_handle  - Reference to an initialized protocol instance
156  * @dev: A reference to the associated SCMI instance device (handle->dev).
157  * @xops: A reference to a struct holding refs to the core xfer operations that
164  * - as a parameter fed from the core to the protocol initialization code so
165  *   that it can access the core xfer operations to build and generate SCMI
167  * - as an opaque handle fed by an SCMI driver user when it tries to access
182  * struct scmi_iterator_state  - Iterator current state descriptor
183  * @desc_index: Starting index for the current mulit-part request.
184  * @num_returned: Number of returned items in the last multi-part reply.
185  * @num_remaining: Number of remaining items in the multi-part message.
188  * @loop_idx: The iterator loop index in the current multi-part reply.
191  * @priv: Optional pointer to some additional state-related private data setup
205  * struct scmi_iterator_ops  - Custom iterator operations
208  *		     a reference to the next index to use in the multi-part
213  *		      each chunk of the multi-part message.
239  * struct scmi_proto_helpers_ops  - References to common protocol helpers
243  *		       pre-allocated area pointed to by @name with maximum
246  *			parse multi-message responses: when run the iterator
249  *			multi-part responses using the custom operations
274  * struct scmi_xfer_ops  - References to the core SCMI xfer operations.
305  * struct scmi_protocol  - Protocol descriptor
309  * @instance_deinit: Optional protocol de-initialization function.