Hi Leif,
On Thu, 18 Oct 2018 at 11:53, Leif Lindholm <leif.lindh...@linaro.org> wrote:
>
> Hi Sumit,
>
> I have some further comments/suggestions on UUID/GUID handling below.
>
> On Wed, Oct 10, 2018 at 10:48:53AM +0530, Sumit Garg wrote:
> > Add following APIs to communicate with OP-TEE pseudo/early TAs:
> > 1. OpteeInit
> > 2. OpteeOpenSession
> > 3. OpteeCloseSession
> > 4. OpteeInvokeFunc
> >
> > Cc: Ard Biesheuvel <ard.biesheu...@linaro.org>
> > Cc: Leif Lindholm <leif.lindh...@linaro.org>
> > Cc: Michael D Kinney <michael.d.kin...@intel.com>
> > Contributed-under: TianoCore Contribution Agreement 1.1
> > Signed-off-by: Sumit Garg <sumit.g...@linaro.org>
> > ---
> > ArmPkg/Library/OpteeLib/OpteeLib.inf | 2 +
> > ArmPkg/Include/Library/OpteeLib.h | 88 +++++
> > ArmPkg/Library/OpteeLib/OpteeSmc.h | 43 +++
> > ArmPkg/Library/OpteeLib/Optee.c | 397 ++++++++++++++++++++
> > 4 files changed, 530 insertions(+)
> >
> > diff --git a/ArmPkg/Library/OpteeLib/OpteeLib.inf
> > b/ArmPkg/Library/OpteeLib/OpteeLib.inf
> > index 5abd427379cc..e03054a7167d 100644
> > --- a/ArmPkg/Library/OpteeLib/OpteeLib.inf
> > +++ b/ArmPkg/Library/OpteeLib/OpteeLib.inf
> > @@ -23,11 +23,13 @@ [Defines]
> >
> > [Sources]
> > Optee.c
> > + OpteeSmc.h
> >
> > [Packages]
> > ArmPkg/ArmPkg.dec
> > MdePkg/MdePkg.dec
> >
> > [LibraryClasses]
> > + ArmMmuLib
> > ArmSmcLib
> > BaseLib
> > diff --git a/ArmPkg/Include/Library/OpteeLib.h
> > b/ArmPkg/Include/Library/OpteeLib.h
> > index f65d8674d9b8..6884d5681831 100644
> > --- a/ArmPkg/Include/Library/OpteeLib.h
> > +++ b/ArmPkg/Include/Library/OpteeLib.h
> > @@ -25,10 +25,98 @@
> > #define OPTEE_OS_UID2 0xaf630002
> > #define OPTEE_OS_UID3 0xa5d5c51b
> >
> > +#define OPTEE_MESSAGE_ATTRIBUTE_TYPE_NONE 0x0
> > +#define OPTEE_MESSAGE_ATTRIBUTE_TYPE_VALUE_INPUT 0x1
> > +#define OPTEE_MESSAGE_ATTRIBUTE_TYPE_VALUE_OUTPUT 0x2
> > +#define OPTEE_MESSAGE_ATTRIBUTE_TYPE_VALUE_INOUT 0x3
> > +#define OPTEE_MESSAGE_ATTRIBUTE_TYPE_MEMORY_INPUT 0x9
> > +#define OPTEE_MESSAGE_ATTRIBUTE_TYPE_MEMORY_OUTPUT 0xa
> > +#define OPTEE_MESSAGE_ATTRIBUTE_TYPE_MEMORY_INOUT 0xb
> > +
> > +#define OPTEE_MESSAGE_ATTRIBUTE_TYPE_MASK 0xff
> > +
> > +#define OPTEE_ORIGIN_COMMUNICATION 0x00000002
> > +#define OPTEE_ERROR_COMMUNICATION 0xFFFF000E
> > +
> > +typedef struct {
> > + UINT64 BufferAddress;
> > + UINT64 Size;
> > + UINT64 SharedMemoryReference;
> > +} OPTEE_MESSAGE_PARAM_MEMORY;
> > +
> > +typedef struct {
> > + UINT64 A;
> > + UINT64 B;
> > + UINT64 C;
> > +} OPTEE_MESSAGE_PARAM_VALUE;
> > +
> > +typedef struct {
> > + UINT64 Attribute;
> > + union {
> > + OPTEE_MESSAGE_PARAM_MEMORY Memory;
> > + OPTEE_MESSAGE_PARAM_VALUE Value;
> > + } Union;
> > +} OPTEE_MESSAGE_PARAM;
> > +
> > +#define OPTEE_MAX_CALL_PARAMS 4
> > +
> > +typedef struct {
> > + UINT32 Command;
> > + UINT32 Function;
> > + UINT32 Session;
> > + UINT32 CancelId;
> > + UINT32 Pad;
> > + UINT32 Return;
> > + UINT32 ReturnOrigin;
> > + UINT32 NumParams;
> > +
> > + // NumParams tells the actual number of element in Params
> > + OPTEE_MESSAGE_PARAM Params[OPTEE_MAX_CALL_PARAMS];
> > +} OPTEE_MESSAGE_ARG;
> > +
> > +typedef struct {
> > + EFI_GUID Uuid; // [in] GUID/UUID of the Trusted Application
>
> Forward reference: I have a longer comment on UUID/GUID struct usage
> below. I believe this field describes a UUID held in the TEE_UUID
> struct format on the OpTee side. If so, can we change this to an
> OPTEE_UUID (mentioned below).
>
> > + UINT32 Session; // [out] Session id
> > + UINT32 Return; // [out] Return value
> > + UINT32 ReturnOrigin; // [out] Origin of the return value
> > +} OPTEE_OPEN_SESSION_ARG;
> > +
> > +typedef struct {
> > + UINT32 Function; // [in] Trusted Application function, specific
> > to the TA
> > + UINT32 Session; // [in] Session id
> > + UINT32 Return; // [out] Return value
> > + UINT32 ReturnOrigin; // [out] Origin of the return value
> > + OPTEE_MESSAGE_PARAM Params[OPTEE_MAX_CALL_PARAMS]; // Params for
> > function to be invoked
> > +} OPTEE_INVOKE_FUNCTION_ARG;
> > +
> > BOOLEAN
> > EFIAPI
> > IsOpteePresent (
> > VOID
> > );
> >
> > +EFI_STATUS
> > +EFIAPI
> > +OpteeInit (
> > + VOID
> > + );
> > +
> > +EFI_STATUS
> > +EFIAPI
> > +OpteeOpenSession (
> > + IN OUT OPTEE_OPEN_SESSION_ARG *OpenSessionArg
> > + );
> > +
> > +EFI_STATUS
> > +EFIAPI
> > +OpteeCloseSession (
> > + IN UINT32 Session
> > + );
> > +
> > +EFI_STATUS
> > +EFIAPI
> > +OpteeInvokeFunction (
> > + IN OUT OPTEE_INVOKE_FUNCTION_ARG *InvokeFunctionArg
> > + );
> > +
> > #endif
> > diff --git a/ArmPkg/Library/OpteeLib/OpteeSmc.h
> > b/ArmPkg/Library/OpteeLib/OpteeSmc.h
> > new file mode 100644
> > index 000000000000..21ff4b22ab92
> > --- /dev/null
> > +++ b/ArmPkg/Library/OpteeLib/OpteeSmc.h
> > @@ -0,0 +1,43 @@
> > +/** @file
> > + OP-TEE SMC header file.
> > +
> > + Copyright (c) 2018, Linaro Ltd. All rights reserved.<BR>
> > +
> > + This program and the accompanying materials
> > + are licensed and made available under the terms and conditions of the
> > BSD License
> > + which accompanies this distribution. The full text of the license may
> > be found at
> > + http://opensource.org/licenses/bsd-license.php
> > +
> > + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> > + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
> > IMPLIED.
> > +
> > +**/
> > +
> > +#ifndef _OPTEE_SMC_H_
> > +#define _OPTEE_SMC_H_
> > +
> > +/* Returned in Arg0 only from Trusted OS functions */
> > +#define OPTEE_SMC_RETURN_OK 0x0
> > +
> > +#define OPTEE_SMC_RETURN_FROM_RPC 0x32000003
> > +#define OPTEE_SMC_CALL_WITH_ARG 0x32000004
> > +#define OPTEE_SMC_GET_SHARED_MEMORY_CONFIG 0xb2000007
> > +
> > +#define OPTEE_SMC_SHARED_MEMORY_CACHED 1
> > +
> > +#define OPTEE_SMC_RETURN_RPC_FOREIGN_INTERRUPT 0xffff0004
> > +
> > +#define OPTEE_MESSAGE_COMMAND_OPEN_SESSION 0
> > +#define OPTEE_MESSAGE_COMMAND_INVOKE_FUNCTION 1
> > +#define OPTEE_MESSAGE_COMMAND_CLOSE_SESSION 2
> > +
> > +#define OPTEE_MESSAGE_ATTRIBUTE_META 0x100
> > +
> > +#define OPTEE_LOGIN_PUBLIC 0x0
> > +
> > +typedef struct {
> > + UINTN Base;
> > + UINTN Size;
> > +} OPTEE_SHARED_MEMORY_INFORMATION;
> > +
> > +#endif
> > diff --git a/ArmPkg/Library/OpteeLib/Optee.c
> > b/ArmPkg/Library/OpteeLib/Optee.c
> > index 574527f8b5ea..6617126e8bdb 100644
> > --- a/ArmPkg/Library/OpteeLib/Optee.c
> > +++ b/ArmPkg/Library/OpteeLib/Optee.c
> > @@ -14,11 +14,18 @@
> >
> > **/
> >
> > +#include <Library/ArmMmuLib.h>
> > #include <Library/ArmSmcLib.h>
> > +#include <Library/BaseMemoryLib.h>
> > #include <Library/BaseLib.h>
> > +#include <Library/DebugLib.h>
> > #include <Library/OpteeLib.h>
> >
> > #include <IndustryStandard/ArmStdSmc.h>
> > +#include <OpteeSmc.h>
> > +#include <Uefi.h>
> > +
> > +STATIC OPTEE_SHARED_MEMORY_INFORMATION OpteeSharedMemoryInformation = { 0
> > };
> >
> > /**
> > Check for OP-TEE presence.
> > @@ -31,6 +38,7 @@ IsOpteePresent (
> > {
> > ARM_SMC_ARGS ArmSmcArgs;
> >
> > + ZeroMem (&ArmSmcArgs, sizeof (ARM_SMC_ARGS));
> > // Send a Trusted OS Calls UID command
> > ArmSmcArgs.Arg0 = ARM_SMC_ID_TOS_UID;
> > ArmCallSmc (&ArmSmcArgs);
> > @@ -44,3 +52,392 @@ IsOpteePresent (
> > return FALSE;
> > }
> > }
> > +
> > +STATIC
> > +EFI_STATUS
> > +OpteeSharedMemoryRemap (
> > + VOID
> > + )
> > +{
> > + ARM_SMC_ARGS ArmSmcArgs;
> > + EFI_PHYSICAL_ADDRESS PhysicalAddress;
> > + EFI_PHYSICAL_ADDRESS Start;
> > + EFI_PHYSICAL_ADDRESS End;
> > + EFI_STATUS Status;
> > + UINTN Size;
> > +
> > + ZeroMem (&ArmSmcArgs, sizeof (ARM_SMC_ARGS));
> > + ArmSmcArgs.Arg0 = OPTEE_SMC_GET_SHARED_MEMORY_CONFIG;
> > +
> > + ArmCallSmc (&ArmSmcArgs);
> > + if (ArmSmcArgs.Arg0 != OPTEE_SMC_RETURN_OK) {
> > + DEBUG ((DEBUG_WARN, "OP-TEE shared memory not supported\n"));
> > + return EFI_UNSUPPORTED;
> > + }
> > +
> > + if (ArmSmcArgs.Arg3 != OPTEE_SMC_SHARED_MEMORY_CACHED) {
> > + DEBUG ((DEBUG_WARN, "OP-TEE: Only normal cached shared memory
> > supported\n"));
> > + return EFI_UNSUPPORTED;
> > + }
> > +
> > + Start = (ArmSmcArgs.Arg1 + SIZE_4KB - 1) & ~(SIZE_4KB - 1);
> > + End = (ArmSmcArgs.Arg1 + ArmSmcArgs.Arg2) & ~(SIZE_4KB - 1);
> > + PhysicalAddress = Start;
> > + Size = End - Start;
> > +
> > + if (Size < SIZE_4KB) {
> > + DEBUG ((DEBUG_WARN, "OP-TEE shared memory too small\n"));
> > + return EFI_BUFFER_TOO_SMALL;
> > + }
> > +
> > + Status = ArmSetMemoryAttributes (PhysicalAddress, Size, EFI_MEMORY_WB);
> > + if (EFI_ERROR (Status)) {
> > + return Status;
> > + }
> > +
> > + OpteeSharedMemoryInformation.Base = (UINTN)PhysicalAddress;
> > + OpteeSharedMemoryInformation.Size = Size;
> > +
> > + return EFI_SUCCESS;
> > +}
> > +
> > +EFI_STATUS
> > +EFIAPI
> > +OpteeInit (
> > + VOID
> > + )
> > +{
> > + EFI_STATUS Status;
> > +
> > + if (!IsOpteePresent ()) {
> > + DEBUG ((DEBUG_WARN, "OP-TEE not present\n"));
> > + return EFI_UNSUPPORTED;
> > + }
> > +
> > + Status = OpteeSharedMemoryRemap ();
> > + if (EFI_ERROR (Status)) {
> > + DEBUG ((DEBUG_WARN, "OP-TEE shared memory remap failed\n"));
> > + return Status;
> > + }
> > +
> > + return EFI_SUCCESS;
> > +}
> > +
> > +/**
> > + Does Standard SMC to OP-TEE in secure world.
> > +
> > + @param[in] PhysicalArg Physical address of message to pass to secure
> > world
> > +
> > + @return 0 on success, secure world return code
> > otherwise
> > +
> > +**/
> > +STATIC
> > +UINT32
> > +OpteeCallWithArg (
> > + IN EFI_PHYSICAL_ADDRESS PhysicalArg
> > + )
> > +{
> > + ARM_SMC_ARGS ArmSmcArgs;
> > +
> > + ZeroMem (&ArmSmcArgs, sizeof (ARM_SMC_ARGS));
> > + ArmSmcArgs.Arg0 = OPTEE_SMC_CALL_WITH_ARG;
> > + ArmSmcArgs.Arg1 = (UINT32)(PhysicalArg >> 32);
> > + ArmSmcArgs.Arg2 = (UINT32)PhysicalArg;
> > +
> > + while (TRUE) {
> > + ArmCallSmc (&ArmSmcArgs);
> > +
> > + if (ArmSmcArgs.Arg0 == OPTEE_SMC_RETURN_RPC_FOREIGN_INTERRUPT) {
> > + //
> > + // A foreign interrupt was raised while secure world was
> > + // executing, since they are handled in UEFI a dummy RPC is
> > + // performed to let UEFI take the interrupt through the normal
> > + // vector.
> > + //
> > + ArmSmcArgs.Arg0 = OPTEE_SMC_RETURN_FROM_RPC;
> > + } else {
> > + break;
> > + }
> > + }
> > +
> > + return ArmSmcArgs.Arg0;
> > +}
> > +
>
> So, looking at the OpTee sources, TEE_UUID is defined as a struct, to
> exactly the same layout as the EFI_GUID type (which is a typedef of
> the GUID struct). Could we add a OPTEE_UUID typedef for the same
> struct in OpteeLib.h?
>
> Since it comes in as an OPTEE_MESSAGE_PARAM_VALUE, alignment is
> already guaranteed to be 64-bit.
>
> (This also deserves a comment explaining how EFI_GUID basically
> follows rfc4122, but uses little-endian for the timestamp fields.)
>
Actually, OP-TEE also uses little-endian format for timestamp fields.
You can refer to [1] for conversion from network byte order (octets)
to little-endian and vice-versa.
So for communications among secure world and non-secure world it uses
network byte order for UUID/GUID to comply with rfc4122.
[1] https://github.com/OP-TEE/optee_os/blob/master/core/tee/uuid.c
-Sumit
> > +STATIC
> > +VOID
> > +UuidToOctets (
>
> EfiGuidToOpteeUuid would be a better.
>
> > + OUT UINT8 *UuidOctet,
>
> Rename Uuid?
>
> > + IN EFI_GUID *Uuid
>
> Guid?
>
> > + )
> > +{
> > + UuidOctet[0] = Uuid->Data1 >> 24;
> > + UuidOctet[1] = Uuid->Data1 >> 16;
> > + UuidOctet[2] = Uuid->Data1 >> 8;
> > + UuidOctet[3] = Uuid->Data1;
>
> Then we could do
> Uuid->Data1 = SwapBytes32 (Guid->Data1);
>
> > + UuidOctet[4] = Uuid->Data2 >> 8;
> > + UuidOctet[5] = Uuid->Data2;
>
> Uuid->Data2 = SwapBytes16 (Guid->Data2);
>
> > + UuidOctet[6] = Uuid->Data3 >> 8;
> > + UuidOctet[7] = Uuid->Data3;
>
> Uuid->Data3 = SwapBytes16 (Guid->Data3);
>
> > + CopyMem (UuidOctet + 8, Uuid->Data4, sizeof (Uuid->Data4));
>
> CopyMem (Uuid->Data4, Guid->Data4, sizeof (Uuid->Data4));
>
> /
> Leif
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
