--- /dev/null
+/** @file\r
+\r
+ Copyright (c) 2017-2018, Arm Limited. All rights reserved.\r
+\r
+ This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+ System Control and Management Interface V1.0\r
+ http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/\r
+ DEN0056A_System_Control_and_Management_Interface.pdf\r
+**/\r
+\r
+#ifndef ARM_SCMI_BASE_PROTOCOL_H_\r
+#define ARM_SCMI_BASE_PROTOCOL_H_\r
+\r
+#include <Protocol/ArmScmi.h>\r
+\r
+#define BASE_PROTOCOL_VERSION 0x10000\r
+\r
+#define NUM_PROTOCOL_MASK 0xFFU\r
+#define NUM_AGENT_MASK 0xFFU\r
+\r
+#define NUM_AGENT_SHIFT 0x8\r
+\r
+/** Returns total number of protocols that are\r
+ implemented (excluding the Base protocol)\r
+*/\r
+#define SCMI_TOTAL_PROTOCOLS(Attr) (Attr & NUM_PROTOCOL_MASK)\r
+\r
+// Returns total number of agents in the system.\r
+#define SCMI_TOTAL_AGENTS(Attr) ((Attr >> NUM_AGENT_SHIFT) & NUM_AGENT_MASK)\r
+\r
+#define ARM_SCMI_BASE_PROTOCOL_GUID { \\r
+ 0xd7e5abe9, 0x33ab, 0x418e, {0x9f, 0x91, 0x72, 0xda, 0xe2, 0xba, 0x8e, 0x2f} \\r
+ }\r
+\r
+extern EFI_GUID gArmScmiBaseProtocolGuid;\r
+\r
+typedef struct _SCMI_BASE_PROTOCOL SCMI_BASE_PROTOCOL;\r
+\r
+/** Return version of the Base protocol supported by SCP firmware.\r
+\r
+ @param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.\r
+\r
+ @param[out] Version Version of the supported SCMI Base protocol.\r
+\r
+ @retval EFI_SUCCESS The version of the protocol is returned.\r
+ @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r
+ @retval !(EFI_SUCCESS) Other errors.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *SCMI_BASE_GET_VERSION) (\r
+ IN SCMI_BASE_PROTOCOL *This,\r
+ OUT UINT32 *Version\r
+ );\r
+\r
+/** Return total number of SCMI protocols supported by the SCP firmware.\r
+\r
+ @param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.\r
+\r
+ @param[out] TotalProtocols Total number of SCMI protocols supported.\r
+\r
+ @retval EFI_SUCCESS Total number of protocols supported are returned.\r
+ @retval EFI_DEVICE_ERROR SCP returns a SCMI error.\r
+ @retval !(EFI_SUCCESS) Other errors.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *SCMI_BASE_GET_TOTAL_PROTOCOLS) (\r
+ IN SCMI_BASE_PROTOCOL *This,\r
+ OUT UINT32 *TotalProtocols\r
+ );\r
+\r
+/** Return vendor name.\r
+\r
+ @param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.\r
+\r
+ @param[out] VendorIdentifier Null terminated ASCII string of up to\r
+ 16 bytes with a vendor name.\r
+\r
+ @retval EFI_SUCCESS VendorIdentifier is returned.\r
+ @retval EFI_DEVICE_ERROR SCP returns a SCMI error.\r
+ @retval !(EFI_SUCCESS) Other errors.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *SCMI_BASE_DISCOVER_VENDOR) (\r
+ IN SCMI_BASE_PROTOCOL *This,\r
+ OUT UINT8 VendorIdentifier[SCMI_MAX_STR_LEN]\r
+ );\r
+\r
+/** Return sub vendor name.\r
+\r
+ @param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.\r
+\r
+ @param[out] VendorIdentifier Null terminated ASCII string of up to\r
+ 16 bytes with a vendor name.\r
+\r
+ @retval EFI_SUCCESS VendorIdentifier is returned.\r
+ @retval EFI_DEVICE_ERROR SCP returns a SCMI error.\r
+ @retval !(EFI_SUCCESS) Other errors.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *SCMI_BASE_DISCOVER_SUB_VENDOR) (\r
+ IN SCMI_BASE_PROTOCOL *This,\r
+ OUT UINT8 VendorIdentifier[SCMI_MAX_STR_LEN]\r
+ );\r
+\r
+/** Return implementation version.\r
+\r
+ @param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.\r
+\r
+ @param[out] ImplementationVersion Vendor specific implementation version.\r
+\r
+ @retval EFI_SUCCESS Implementation version is returned.\r
+ @retval EFI_DEVICE_ERROR SCP returns a SCMI error.\r
+ @retval !(EFI_SUCCESS) Other errors.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *SCMI_BASE_DISCOVER_IMPLEMENTATION_VERSION) (\r
+ IN SCMI_BASE_PROTOCOL *This,\r
+ OUT UINT32 *ImplementationVersion\r
+ );\r
+\r
+/** Return list of protocols.\r
+\r
+ @param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.\r
+\r
+ @param[out] ProtocolListSize Size of the ProtocolList.\r
+\r
+ @param[out] ProtocolList Protocol list.\r
+\r
+ @retval EFI_SUCCESS List of protocols is returned.\r
+ @retval EFI_BUFFER_TOO_SMALL ProtocolListSize is too small for the result.\r
+ It has been updated to the size needed.\r
+ @retval EFI_DEVICE_ERROR SCP returns a SCMI error.\r
+ @retval !(EFI_SUCCESS) Other errors.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *SCMI_BASE_DISCOVER_LIST_PROTOCOLS) (\r
+ IN SCMI_BASE_PROTOCOL *This,\r
+ IN OUT UINT32 *ProtocolListSize,\r
+ OUT UINT8 *ProtocolList\r
+ );\r
+\r
+// Base protocol.\r
+typedef struct _SCMI_BASE_PROTOCOL {\r
+ SCMI_BASE_GET_VERSION GetVersion;\r
+ SCMI_BASE_GET_TOTAL_PROTOCOLS GetTotalProtocols;\r
+ SCMI_BASE_DISCOVER_VENDOR DiscoverVendor;\r
+ SCMI_BASE_DISCOVER_SUB_VENDOR DiscoverSubVendor;\r
+ SCMI_BASE_DISCOVER_IMPLEMENTATION_VERSION DiscoverImplementationVersion;\r
+ SCMI_BASE_DISCOVER_LIST_PROTOCOLS DiscoverListProtocols;\r
+} SCMI_BASE_PROTOCOL;\r
+\r
+// SCMI Message IDs for Base protocol.\r
+typedef enum {\r
+ SCMI_MESSAGE_ID_BASE_DISCOVER_VENDOR = 0x3,\r
+ SCMI_MESSAGE_ID_BASE_DISCOVER_SUB_VENDOR = 0x4,\r
+ SCMI_MESSAGE_ID_BASE_DISCOVER_IMPLEMENTATION_VERSION = 0x5,\r
+ SCMI_MESSAGE_ID_BASE_DISCOVER_LIST_PROTOCOLS = 0x6\r
+} SCMI_MESSAGE_ID_BASE;\r
+\r
+#endif /* ARM_SCMI_BASE_PROTOCOL_H_ */\r
+\r