firmware/arm_scmi/common.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * System Control and Management Interface (SCMI) Message Protocol
36  * struct scmi_msg_resp_prot_version - Response for a message
66  * struct scmi_msg_hdr - Message(Tx/Rx) header
68  * @id: The identifier of the message being sent
69  * @protocol_id: The identifier of the protocol used to send @id message
78 	u8 id;  member
86  * pack_scmi_header() - packs and returns 32-bit header
88  * @hdr: pointer to header containing all the information on message id,
89  *	protocol id and sequence id.
91  * Return: 32-bit packed message header to be sent to the platform.
95 	return FIELD_PREP(MSG_ID_MASK, hdr->id) |  in pack_scmi_header()
96 		FIELD_PREP(MSG_TOKEN_ID_MASK, hdr->seq) |  in pack_scmi_header()
97 		FIELD_PREP(MSG_PROTOCOL_ID_MASK, hdr->protocol_id);  in pack_scmi_header()
101  * unpack_scmi_header() - unpacks and records message and protocol id
103  * @msg_hdr: 32-bit packed message header sent from the platform
104  * @hdr: pointer to header to fetch message and protocol id.
108 	hdr->id = MSG_XTRACT_ID(msg_hdr);  in unpack_scmi_header()
109 	hdr->protocol_id = MSG_XTRACT_PROT_ID(msg_hdr);  in unpack_scmi_header()
113  * struct scmi_msg - Message(Tx/Rx) structure
124  * struct scmi_xfer - Structure representing a message flow
126  * @transfer_id: Unique ID for debug & profiling purpose
129  * @rx: Receive message, the buffer should be pre-allocated to store
130  *	message. If request-ACK protocol is used, we can reuse the same
155 int scmi_version_get(const struct scmi_handle *h, u8 protocol, u32 *version);
174 #define DEFINE_SCMI_PROTOCOL_REGISTER_UNREGISTER(id, name) \  argument
177 	return scmi_protocol_register((id), &scmi_##name##_protocol_init); \
182 	scmi_protocol_unregister((id)); \
187  * struct scmi_chan_info - Structure representing a SCMI channel information
201  * struct scmi_transport_ops - Structure representing a SCMI transport ops
217 	int (*chan_free)(int id, void *p, void *data);
230  * struct scmi_desc - Description of SoC integration
251 void scmi_free_channel(struct scmi_chan_info *cinfo, struct idr *idr, int id);