drivers: firmware: scmi: add SCMI_FIELD_TAKE macro

Add SCMI_FIELD_TAKE macro, This will be called at the driver level

Signed-off-by: Yongxu Wang <[email protected]>

Author: yongxu-wang15

include/zephyr/drivers/firmware/scmi/protocol.h

@@ -17,6 +17,19 @@
 #include <stdint.h>
 #include <errno.h>
 
+/* The composition and offset of scmi messages */
+#define SCMI_MSGID_SHIFT       0
+#define SCMI_MSGID_MASK        GENMASK(7, 0)
+
+#define SCMI_TYPE_SHIFT        8
+#define SCMI_TYPE_MASK         GENMASK(1, 0)
+
+#define SCMI_PROTOCOL_SHIFT    10
+#define SCMI_PROTOCOL_MASK     GENMASK(7, 0)
+
+#define SCMI_TOKEN_SHIFT       18
+#define SCMI_TOKEN_MASK        GENMASK(9, 0)
+
 /**
  * @brief Build an SCMI message header
  *
@@ -28,11 +41,24 @@
  * @param proto protocol ID
  * @param token message token
  */
-#define SCMI_MESSAGE_HDR_MAKE(id, type, proto, token)	\
-	(SCMI_FIELD_MAKE(id, GENMASK(7, 0), 0)     |	\
-	 SCMI_FIELD_MAKE(type, GENMASK(1, 0), 8)   |	\
-	 SCMI_FIELD_MAKE(proto, GENMASK(7, 0), 10) |	\
-	 SCMI_FIELD_MAKE(token, GENMASK(9, 0), 18))
+#define SCMI_MESSAGE_HDR_MAKE(id, type, proto, token)						\
+	(SCMI_FIELD_MAKE((id),          SCMI_MSGID_MASK,    SCMI_MSGID_SHIFT)           |       \
+	SCMI_FIELD_MAKE((type),         SCMI_TYPE_MASK,     SCMI_TYPE_SHIFT)            |       \
+	SCMI_FIELD_MAKE((proto),        SCMI_PROTOCOL_MASK, SCMI_PROTOCOL_SHIFT)        |       \
+	SCMI_FIELD_MAKE((token),        SCMI_TOKEN_MASK,    SCMI_TOKEN_SHIFT))
+
+/**
+ * @brief Extract a field from SCMI message header
+ * @param hdr   the 32-bit SCMI message header
+ * @param FIELD one of: MSGID, TYPE, PROTOCOL, TOKEN
+ */
+#define SCMI_MESSAGE_HDR_TAKE(hdr, FIELD) \
+	SCMI_FIELD_TAKE((hdr), SCMI_##FIELD##_MASK, SCMI_##FIELD##_SHIFT)
+
+#define SCMI_MESSAGE_HDR_TAKE_MSGID(hdr)    SCMI_MESSAGE_HDR_TAKE(hdr, MSGID)
+#define SCMI_MESSAGE_HDR_TAKE_TYPE(hdr)     SCMI_MESSAGE_HDR_TAKE(hdr, TYPE)
+#define SCMI_MESSAGE_HDR_TAKE_PROTOCOL(hdr) SCMI_MESSAGE_HDR_TAKE(hdr, PROTOCOL)
+#define SCMI_MESSAGE_HDR_TAKE_TOKEN(hdr)    SCMI_MESSAGE_HDR_TAKE(hdr, TOKEN)
 
 struct scmi_channel;
 

include/zephyr/drivers/firmware/scmi/util.h

@@ -305,6 +305,16 @@
 #define SCMI_FIELD_MAKE(x, mask, shift)\
 	(((uint32_t)(x) & (mask)) << (shift))
 
+/**
+ * @brief Extract an SCMI message field
+ *
+ * @param x value to encode
+ * @param mask value to perform bitwise-and with `x`
+ * @param shift value to left-shift masked `x`
+ */
+#define SCMI_FIELD_TAKE(x, mask, shift) \
+	((((uint32_t)(x)) >> (shift)) & (uint32_t)(mask))
+
 /**
  * @brief SCMI protocol IDs
  *