Lines Matching +full:multi +full:- +full:protocol

1 /* SPDX-License-Identifier: GPL-2.0 */
3 * System Control and Management Interface (SCMI) Message Protocol
42 * struct scmi_msg_resp_prot_version - Response for a message
59 * struct scmi_msg - Message(Tx/Rx) structure
70 * struct scmi_msg_hdr - Message(Tx/Rx) header
73 * @protocol_id: The identifier of the protocol used to send @id message
92 * struct scmi_xfer - Structure representing a message flow
97 * @rx: Receive message, the buffer should be pre-allocated to store
98 * message. If request-ACK protocol is used, we can reuse the same
111 * though the timed-out transaction will anyway cause the command
112 * request to be reported as failed by time-out, the underlying xfer
118 * - SCMI_XFER_SENT_OK -> SCMI_XFER_RESP_OK [ -> SCMI_XFER_DRESP_OK ]
119 * - SCMI_XFER_SENT_OK -> SCMI_XFER_DRESP_OK
143 #define SCMI_XFER_IS_RAW(x) ((x)->flags & SCMI_XFER_FLAG_IS_RAW)
146 ((x)->flags & SCMI_XFER_FLAG_CHAN_SET)
157 * struct scmi_protocol_handle - Reference to an initialized protocol instance
159 * @dev: A reference to the associated SCMI instance device (handle->dev).
161 * can be used by the protocol implementation to generate SCMI messages.
162 * @set_priv: A method to set protocol private data for this instance.
163 * @get_priv: A method to get protocol private data previously set.
165 * This structure represents a protocol initialized against specific SCMI
167 * - as a parameter fed from the core to the protocol initialization code so
169 * messages exclusively for the specific underlying protocol instance.
170 * - as an opaque handle fed by an SCMI driver user when it tries to access
171 * this protocol through its own protocol operations.
173 * with the related protocol operations when the SCMI driver tries to access
174 * the protocol.
186 * struct scmi_iterator_state - Iterator current state descriptor
187 * @desc_index: Starting index for the current mulit-part request.
188 * @num_returned: Number of returned items in the last multi-part reply.
189 * @num_remaining: Number of remaining items in the multi-part message.
192 * @loop_idx: The iterator loop index in the current multi-part reply.
195 * @priv: Optional pointer to some additional state-related private data setup
209 * struct scmi_iterator_ops - Custom iterator operations
212 * a reference to the next index to use in the multi-part
217 * each chunk of the multi-part message.
244 * struct scmi_proto_helpers_ops - References to common protocol helpers
248 * pre-allocated area pointed to by @name with maximum
251 * parse multi-message responses: when run the iterator
254 * multi-part responses using the custom operations
258 * @protocol_msg_check: A common helper to check is a specific protocol message
287 * struct scmi_xfer_ops - References to the core SCMI xfer operations.
288 * @version_get: Get this version protocol.
295 * Note that all this operations expect a protocol handle as first parameter;
296 * they then internally use it to infer the underlying protocol number: this
297 * way is not possible for a protocol implementation to forge messages for
298 * another protocol.
318 * struct scmi_protocol - Protocol descriptor
319 * @id: Protocol ID.
321 * @instance_init: Mandatory protocol initialization function.
322 * @instance_deinit: Optional protocol de-initialization function.
323 * @ops: Optional reference to the operations provided by the protocol and
325 * @events: An optional reference to the events supported by this protocol.
327 * protocol by the agent. Each protocol implementation
329 * protocol version supported by the platform.
331 * Ignored when @id identifies a standard protocol, cannot be NULL
334 * Ignored if NULL or when @id identifies a standard protocol.
336 * Ignored if zero or if @id identifies a standard protocol.