Commit c4eb8366 authored by Viresh Kumar's avatar Viresh Kumar Committed by Sudeep Holla
Browse files

firmware: arm_scmi: Move macros and helpers to common.h 



Move message header specific macros and helper routines to common.h as
they will be used outside of driver.c in a later commit.

Signed-off-by: default avatarViresh Kumar <viresh.kumar@linaro.org>
Link: https://lore.kernel.org/r/6615db480370719b0a0241447a5f3feb8eea421f.1580448239.git.viresh.kumar@linaro.org


Signed-off-by: default avatarSudeep Holla <sudeep.holla@arm.com>
parent 71af05a7

drivers/firmware/arm_scmi/common.h

+40 −0
Original line number Diff line number Diff line
@@ -47,6 +47,19 @@ struct scmi_msg_resp_prot_version { 
	__le16 major_version;

};



#define MSG_ID_MASK		GENMASK(7, 0)

#define MSG_XTRACT_ID(hdr)	FIELD_GET(MSG_ID_MASK, (hdr))

#define MSG_TYPE_MASK		GENMASK(9, 8)

#define MSG_XTRACT_TYPE(hdr)	FIELD_GET(MSG_TYPE_MASK, (hdr))

#define MSG_TYPE_COMMAND	0

#define MSG_TYPE_DELAYED_RESP	2

#define MSG_TYPE_NOTIFICATION	3

#define MSG_PROTOCOL_ID_MASK	GENMASK(17, 10)

#define MSG_XTRACT_PROT_ID(hdr)	FIELD_GET(MSG_PROTOCOL_ID_MASK, (hdr))

#define MSG_TOKEN_ID_MASK	GENMASK(27, 18)

#define MSG_XTRACT_TOKEN(hdr)	FIELD_GET(MSG_TOKEN_ID_MASK, (hdr))

#define MSG_TOKEN_MAX		(MSG_XTRACT_TOKEN(MSG_TOKEN_ID_MASK) + 1)



/**

 * struct scmi_msg_hdr - Message(Tx/Rx) header

 *
@@ -67,6 +80,33 @@ struct scmi_msg_hdr { 
	bool poll_completion;

};



/**

 * pack_scmi_header() - packs and returns 32-bit header

 *

 * @hdr: pointer to header containing all the information on message id,

 *	protocol id and sequence id.

 *

 * Return: 32-bit packed message header to be sent to the platform.

 */

static inline u32 pack_scmi_header(struct scmi_msg_hdr *hdr)

{

	return FIELD_PREP(MSG_ID_MASK, hdr->id) |

		FIELD_PREP(MSG_TOKEN_ID_MASK, hdr->seq) |

		FIELD_PREP(MSG_PROTOCOL_ID_MASK, hdr->protocol_id);

}



/**

 * unpack_scmi_header() - unpacks and records message and protocol id

 *

 * @msg_hdr: 32-bit packed message header sent from the platform

 * @hdr: pointer to header to fetch message and protocol id.

 */

static inline void unpack_scmi_header(u32 msg_hdr, struct scmi_msg_hdr *hdr)

{

	hdr->id = MSG_XTRACT_ID(msg_hdr);

	hdr->protocol_id = MSG_XTRACT_PROT_ID(msg_hdr);

}



/**

 * struct scmi_msg - Message(Tx/Rx) structure

 *

drivers/firmware/arm_scmi/driver.c

+0 −40
Original line number Diff line number Diff line
@@ -32,19 +32,6 @@ 
#define CREATE_TRACE_POINTS

#include <trace/events/scmi.h>



#define MSG_ID_MASK		GENMASK(7, 0)

#define MSG_XTRACT_ID(hdr)	FIELD_GET(MSG_ID_MASK, (hdr))

#define MSG_TYPE_MASK		GENMASK(9, 8)

#define MSG_XTRACT_TYPE(hdr)	FIELD_GET(MSG_TYPE_MASK, (hdr))

#define MSG_TYPE_COMMAND	0

#define MSG_TYPE_DELAYED_RESP	2

#define MSG_TYPE_NOTIFICATION	3

#define MSG_PROTOCOL_ID_MASK	GENMASK(17, 10)

#define MSG_XTRACT_PROT_ID(hdr)	FIELD_GET(MSG_PROTOCOL_ID_MASK, (hdr))

#define MSG_TOKEN_ID_MASK	GENMASK(27, 18)

#define MSG_XTRACT_TOKEN(hdr)	FIELD_GET(MSG_TOKEN_ID_MASK, (hdr))

#define MSG_TOKEN_MAX		(MSG_XTRACT_TOKEN(MSG_TOKEN_ID_MASK) + 1)



enum scmi_error_codes {

	SCMI_SUCCESS = 0,	/* Success */

	SCMI_ERR_SUPPORT = -1,	/* Not supported */
@@ -210,33 +197,6 @@ static void scmi_fetch_response(struct scmi_xfer *xfer, 
	memcpy_fromio(xfer->rx.buf, mem->msg_payload + 4, xfer->rx.len);

}



/**

 * pack_scmi_header() - packs and returns 32-bit header

 *

 * @hdr: pointer to header containing all the information on message id,

 *	protocol id and sequence id.

 *

 * Return: 32-bit packed message header to be sent to the platform.

 */

static inline u32 pack_scmi_header(struct scmi_msg_hdr *hdr)

{

	return FIELD_PREP(MSG_ID_MASK, hdr->id) |

		FIELD_PREP(MSG_TOKEN_ID_MASK, hdr->seq) |

		FIELD_PREP(MSG_PROTOCOL_ID_MASK, hdr->protocol_id);

}



/**

 * unpack_scmi_header() - unpacks and records message and protocol id

 *

 * @msg_hdr: 32-bit packed message header sent from the platform

 * @hdr: pointer to header to fetch message and protocol id.

 */

static inline void unpack_scmi_header(u32 msg_hdr, struct scmi_msg_hdr *hdr)

{

	hdr->id = MSG_XTRACT_ID(msg_hdr);

	hdr->protocol_id = MSG_XTRACT_PROT_ID(msg_hdr);

}



/**

 * scmi_tx_prepare() - mailbox client callback to prepare for the transfer

 *

CRA Git | Maintained and supported by SUSTech CRA and CCSE