firmware/arm_scmi/protocols.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * System Control and Management Interface (SCMI) Message Protocol
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
69  * @id: The identifier of the message being sent
70  * @protocol_id: The identifier of the protocol used to send @id message
80 	u8 id;  member
89  * struct scmi_xfer - Structure representing a message flow
91  * @transfer_id: Unique ID for debug & profiling purpose
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).
158  *	  can be used by the protocol implementation to generate SCMI messages.
159  * @set_priv: A method to set protocol private data for this instance.
160  * @get_priv: A method to get protocol private data previously set.
162  * This structure represents a protocol initialized against specific SCMI
164  * - as a parameter fed from the core to the protocol initialization code so
166  *   messages exclusively for the specific underlying protocol instance.
167  * - as an opaque handle fed by an SCMI driver user when it tries to access
168  *   this protocol through its own protocol operations.
170  *   with the related protocol operations when the SCMI driver tries to access
171  *   the protocol.
183  * struct scmi_iterator_state  - Iterator current state descriptor
184  * @desc_index: Starting index for the current mulit-part request.
185  * @num_returned: Number of returned items in the last multi-part reply.
186  * @num_remaining: Number of remaining items in the multi-part message.
189  * @loop_idx: The iterator loop index in the current multi-part reply.
192  * @priv: Optional pointer to some additional state-related private data setup
206  * struct scmi_iterator_ops  - Custom iterator operations
209  *		     a reference to the next index to use in the multi-part
214  *		      each chunk of the multi-part message.
240  * struct scmi_proto_helpers_ops  - References to common protocol helpers
244  *		       pre-allocated area pointed to by @name with maximum
247  *			parse multi-message responses: when run the iterator
250  *			multi-part responses using the custom operations
276  * struct scmi_xfer_ops  - References to the core SCMI xfer operations.
277  * @version_get: Get this version protocol.
284  * Note that all this operations expect a protocol handle as first parameter;
285  * they then internally use it to infer the underlying protocol number: this
286  * way is not possible for a protocol implementation to forge messages for
287  * another protocol.
307  * struct scmi_protocol  - Protocol descriptor
308  * @id: Protocol ID.
310  * @instance_init: Mandatory protocol initialization function.
311  * @instance_deinit: Optional protocol de-initialization function.
312  * @ops: Optional reference to the operations provided by the protocol and
314  * @events: An optional reference to the events supported by this protocol.
316  *		       protocol by the agent. Each protocol implementation
318  *		       protocol version supported by the platform.
321 	const u8				id;  member