mirror of
https://github.com/AsahiLinux/u-boot
synced 2024-09-20 22:52:00 +00:00
218b062e8f
Add MM communication support using FF-A transport This feature allows accessing MM partitions services through EFI MM communication protocol. MM partitions such as StandAlonneMM or smm-gateway secure partitions which reside in secure world. An MM shared buffer and a door bell event are used to exchange the data. The data is used by EFI services such as GetVariable()/SetVariable() and copied from the communication buffer to the MM shared buffer. The secure partition is notified about availability of data in the MM shared buffer by an FF-A message (door bell). On such event, MM SP can read the data and updates the MM shared buffer with the response data. The response data is copied back to the communication buffer and consumed by the EFI subsystem. MM communication protocol supports FF-A 64-bit direct messaging. We tested the FF-A MM communication on the Corstone-1000 platform. We ran the UEFI SCT test suite containing EFI setVariable, getVariable and getNextVariable tests which involve FF-A MM communication and all tests are passing with the current changes. We made the SCT test reports (part of the ACS results) public following the latest Corstone-1000 platform software release. Please find the test reports at [1]. [1]: https://gitlab.arm.com/arm-reference-solutions/arm-reference-solutions-test-report/-/tree/master/embedded-a/corstone1000/CORSTONE1000-2023.06/acs_results_fpga.zip Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com> Tested-by: Gowtham Suresh Kumar <gowtham.sureshkumar@arm.com> Reviewed-by: Simon Glass <sjg@chromium.org> Cc: Tom Rini <trini@konsulko.com> Cc: Ilias Apalodimas <ilias.apalodimas@linaro.org> Cc: Jens Wiklander <jens.wiklander@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Tom Rini <trini@konsulko.com>
268 lines
7.9 KiB
C
268 lines
7.9 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* Headers for EFI variable service via StandAloneMM, EDK2 application running
|
|
* in OP-TEE
|
|
*
|
|
* Copyright (c) 2017, Intel Corporation. All rights reserved.
|
|
* Copyright (C) 2020 Linaro Ltd. <sughosh.ganu@linaro.org>
|
|
* Copyright (C) 2020 Linaro Ltd. <ilias.apalodimas@linaro.org>
|
|
* Copyright 2022-2023 Arm Limited and/or its affiliates <open-source-office@arm.com>
|
|
* Authors:
|
|
* Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com>
|
|
*/
|
|
|
|
#ifndef _MM_COMMUNICATION_H_
|
|
#define _MM_COMMUNICATION_H_
|
|
|
|
#include <part_efi.h>
|
|
|
|
#if CONFIG_IS_ENABLED(ARM_FFA_TRANSPORT)
|
|
/* MM service UUID string (big-endian format). This UUID is common across all MM SPs */
|
|
#define MM_SP_UUID "33d532ed-e699-0942-c09c-a798d9cd722d"
|
|
#endif
|
|
|
|
/*
|
|
* Interface to the pseudo Trusted Application (TA), which provides a
|
|
* communication channel with the Standalone MM (Management Mode)
|
|
* Secure Partition running at Secure-EL0
|
|
*/
|
|
|
|
#define PTA_STMM_CMDID_COMMUNICATE 0
|
|
|
|
/* OP-TEE is using big endian GUIDs while UEFI uses little endian ones */
|
|
#define PTA_STMM_UUID { 0xed32d533, 0x99e6, 0x4209, {\
|
|
0x9c, 0xc0, 0x2d, 0x72, 0xcd, 0xd9, 0x98, 0xa7 } }
|
|
|
|
#define EFI_MM_VARIABLE_GUID \
|
|
EFI_GUID(0xed32d533, 0x99e6, 0x4209, \
|
|
0x9c, 0xc0, 0x2d, 0x72, 0xcd, 0xd9, 0x98, 0xa7)
|
|
|
|
/* Defined in EDK2 MdePkg/Include/Protocol/MmCommunication.h */
|
|
|
|
/**
|
|
* struct efi_mm_communicate_header - Header used for SMM variable communication
|
|
|
|
* @header_guid: header use for disambiguation of content
|
|
* @message_len: length of the message. Does not include the size of the
|
|
* header
|
|
* @data: payload of the message
|
|
*
|
|
* Defined in EDK2 as EFI_MM_COMMUNICATE_HEADER.
|
|
* To avoid confusion in interpreting frames, the communication buffer should
|
|
* always begin with efi_mm_communicate_header.
|
|
*/
|
|
struct __packed efi_mm_communicate_header {
|
|
efi_guid_t header_guid;
|
|
size_t message_len;
|
|
u8 data[];
|
|
};
|
|
|
|
#define MM_COMMUNICATE_HEADER_SIZE \
|
|
(sizeof(struct efi_mm_communicate_header))
|
|
|
|
/* Defined in EDK2 ArmPkg/Include/IndustryStandard/ArmMmSvc.h */
|
|
|
|
/* SPM return error codes */
|
|
#define ARM_SVC_SPM_RET_SUCCESS 0
|
|
#define ARM_SVC_SPM_RET_NOT_SUPPORTED -1
|
|
#define ARM_SVC_SPM_RET_INVALID_PARAMS -2
|
|
#define ARM_SVC_SPM_RET_DENIED -3
|
|
#define ARM_SVC_SPM_RET_NO_MEMORY -5
|
|
|
|
/* Defined in EDK2 MdeModulePkg/Include/Guid/SmmVariableCommon.h */
|
|
|
|
#define SMM_VARIABLE_FUNCTION_GET_VARIABLE 1
|
|
/*
|
|
* The payload for this function is
|
|
* SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME.
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_GET_NEXT_VARIABLE_NAME 2
|
|
/*
|
|
* The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_SET_VARIABLE 3
|
|
/*
|
|
* The payload for this function is
|
|
* SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO.
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_QUERY_VARIABLE_INFO 4
|
|
/*
|
|
* It is a notify event, no extra payload for this function.
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_READY_TO_BOOT 5
|
|
/*
|
|
* It is a notify event, no extra payload for this function.
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_EXIT_BOOT_SERVICE 6
|
|
/*
|
|
* The payload for this function is VARIABLE_INFO_ENTRY.
|
|
* The GUID in EFI_SMM_COMMUNICATE_HEADER is gEfiSmmVariableProtocolGuid.
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_GET_STATISTICS 7
|
|
/*
|
|
* The payload for this function is SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_LOCK_VARIABLE 8
|
|
|
|
#define SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_SET 9
|
|
|
|
#define SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_GET 10
|
|
|
|
#define SMM_VARIABLE_FUNCTION_GET_PAYLOAD_SIZE 11
|
|
/*
|
|
* The payload for this function is
|
|
* SMM_VARIABLE_COMMUNICATE_RUNTIME_VARIABLE_CACHE_CONTEXT
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_INIT_RUNTIME_VARIABLE_CACHE_CONTEXT 12
|
|
|
|
#define SMM_VARIABLE_FUNCTION_SYNC_RUNTIME_CACHE 13
|
|
/*
|
|
* The payload for this function is
|
|
* SMM_VARIABLE_COMMUNICATE_GET_RUNTIME_CACHE_INFO
|
|
*/
|
|
#define SMM_VARIABLE_FUNCTION_GET_RUNTIME_CACHE_INFO 14
|
|
|
|
/**
|
|
* struct smm_variable_communicate_header - Used for SMM variable communication
|
|
|
|
* @function: function to call in Smm.
|
|
* @ret_status: return status
|
|
* @data: payload
|
|
*
|
|
* Defined in EDK2 as SMM_VARIABLE_COMMUNICATE_HEADER.
|
|
*/
|
|
struct smm_variable_communicate_header {
|
|
efi_uintn_t function;
|
|
efi_status_t ret_status;
|
|
u8 data[];
|
|
};
|
|
|
|
#define MM_VARIABLE_COMMUNICATE_SIZE \
|
|
(sizeof(struct smm_variable_communicate_header))
|
|
|
|
/**
|
|
* struct smm_variable_access - Used to communicate with StMM by
|
|
* SetVariable and GetVariable.
|
|
|
|
* @guid: vendor GUID
|
|
* @data_size: size of EFI variable data
|
|
* @name_size: size of EFI name
|
|
* @attr: attributes
|
|
* @name: variable name
|
|
*
|
|
* Defined in EDK2 as SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.
|
|
*
|
|
*/
|
|
struct smm_variable_access {
|
|
efi_guid_t guid;
|
|
efi_uintn_t data_size;
|
|
efi_uintn_t name_size;
|
|
u32 attr;
|
|
u16 name[];
|
|
};
|
|
|
|
#define MM_VARIABLE_ACCESS_HEADER_SIZE \
|
|
(sizeof(struct smm_variable_access))
|
|
/**
|
|
* struct smm_variable_payload_size - Used to get the max allowed
|
|
* payload used in StMM.
|
|
*
|
|
* @size: size to fill in
|
|
*
|
|
* Defined in EDK2 as SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE.
|
|
*
|
|
*/
|
|
struct smm_variable_payload_size {
|
|
efi_uintn_t size;
|
|
};
|
|
|
|
/**
|
|
* struct smm_variable_getnext - Used to communicate with StMM for
|
|
* GetNextVariableName.
|
|
*
|
|
* @guid: vendor GUID
|
|
* @name_size: size of the name of the variable
|
|
* @name: variable name
|
|
*
|
|
* Defined in EDK2 as SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME.
|
|
*/
|
|
struct smm_variable_getnext {
|
|
efi_guid_t guid;
|
|
efi_uintn_t name_size;
|
|
u16 name[];
|
|
};
|
|
|
|
#define MM_VARIABLE_GET_NEXT_HEADER_SIZE \
|
|
(sizeof(struct smm_variable_getnext))
|
|
|
|
/**
|
|
* struct smm_variable_query_info - Used to communicate with StMM for
|
|
* QueryVariableInfo.
|
|
*
|
|
* @max_variable_storage: max available storage
|
|
* @remaining_variable_storage: remaining available storage
|
|
* @max_variable_size: max variable supported size
|
|
* @attr: attributes to query storage for
|
|
*
|
|
* Defined in EDK2 as SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO.
|
|
*/
|
|
struct smm_variable_query_info {
|
|
u64 max_variable_storage;
|
|
u64 remaining_variable_storage;
|
|
u64 max_variable_size;
|
|
u32 attr;
|
|
};
|
|
|
|
#define VAR_CHECK_VARIABLE_PROPERTY_REVISION 0x0001
|
|
#define VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY BIT(0)
|
|
/**
|
|
* struct var_check_property - Used to store variable properties in StMM
|
|
*
|
|
* @revision: magic revision number for variable property checking
|
|
* @property: properties mask for the variable used in StMM.
|
|
* Currently RO flag is supported
|
|
* @attributes: variable attributes used in StMM checking when properties
|
|
* for a variable are enabled
|
|
* @minsize: minimum allowed size for variable payload checked against
|
|
* smm_variable_access->datasize in StMM
|
|
* @maxsize: maximum allowed size for variable payload checked against
|
|
* smm_variable_access->datasize in StMM
|
|
*
|
|
* Defined in EDK2 as VAR_CHECK_VARIABLE_PROPERTY.
|
|
*/
|
|
struct var_check_property {
|
|
u16 revision;
|
|
u16 property;
|
|
u32 attributes;
|
|
efi_uintn_t minsize;
|
|
efi_uintn_t maxsize;
|
|
};
|
|
|
|
/**
|
|
* struct smm_variable_var_check_property - Used to communicate variable
|
|
* properties with StMM
|
|
*
|
|
* @guid: vendor GUID
|
|
* @name_size: size of EFI name
|
|
* @property: variable properties struct
|
|
* @name: variable name
|
|
*
|
|
* Defined in EDK2 as SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY.
|
|
*/
|
|
struct smm_variable_var_check_property {
|
|
efi_guid_t guid;
|
|
efi_uintn_t name_size;
|
|
struct var_check_property property;
|
|
u16 name[];
|
|
};
|
|
|
|
#if CONFIG_IS_ENABLED(ARM_FFA_TRANSPORT)
|
|
/* supported MM transports */
|
|
enum mm_comms_select {
|
|
MM_COMMS_UNDEFINED,
|
|
MM_COMMS_FFA,
|
|
MM_COMMS_OPTEE
|
|
};
|
|
#endif
|
|
|
|
#endif /* _MM_COMMUNICATION_H_ */
|