From nobody Mon Apr 29 09:47:27 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+90450+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+90450+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1654896027; cv=none; d=zohomail.com; s=zohoarc; b=BjP/+yGAnE6d2bo4hzSMWLEN2D75k8/CoQjaRm6YhsaZ8XuE0dGUUFhCA61tH6zwHh8pUWuevvTCbKP7z3xmcDBxAYFOpxL4Volr5Xh639MndxUNJWapTr+/rZZE93nJWGwV1fYj7sAx+5k/RNKSttmo4cQwmI0gBS+Jrwi2Hbo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1654896027; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=5IRlIOIK/MVIfDVWBlFHYVVIZ/i8o6C2QC2j/ubxM4A=; b=PO0RbvrAlgbXrJ4hBCZuKJ5vWyQDlEYytWxx9Zu3dD7/yDpedQXlvAL5MdRZrevLdHgHFrMKGF8an7IO73Jz0P7fLHm0shbCBdJY8IeZ3p6tIkvnyYbyytUIsOD2dRFE1U3jZFaj7AykuoHRt1e+3R85YhQklRSiIoikjGID0ag= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+90450+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1654896027767198.74194152265704; Fri, 10 Jun 2022 14:20:27 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id vrsMYY1788612xaVGROBqN8J; Fri, 10 Jun 2022 14:20:27 -0700 X-Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by mx.groups.io with SMTP id smtpd.web11.32457.1654896024421653587 for ; Fri, 10 Jun 2022 14:20:26 -0700 X-IronPort-AV: E=McAfee;i="6400,9594,10374"; a="258186701" X-IronPort-AV: E=Sophos;i="5.91,291,1647327600"; d="scan'208";a="258186701" X-Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Jun 2022 14:20:23 -0700 X-IronPort-AV: E=Sophos;i="5.91,291,1647327600"; d="scan'208";a="760670594" X-Received: from nldesimo-desk1.amr.corp.intel.com ([10.7.159.54]) by orsmga005-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Jun 2022 14:20:23 -0700 From: "Nate DeSimone" To: devel@edk2.groups.io Cc: Jian J Wang , Liming Gao , Michael D Kinney , Isaac Oram , Chasel Chiu , Gao Cheng , Di Zhang , Daocheng Bu , Michael Kubacki Subject: [edk2-devel] [PATCH V2 1/1] MdeModulePkg: Add Definition of EDKII_PEI_VARIABLE_PPI Date: Fri, 10 Jun 2022 14:20:10 -0700 Message-Id: <20220610212010.5283-2-nathaniel.l.desimone@intel.com> In-Reply-To: <20220610212010.5283-1-nathaniel.l.desimone@intel.com> References: <20220610212010.5283-1-nathaniel.l.desimone@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,nathaniel.l.desimone@intel.com X-Gm-Message-State: Bb4pUW9s4mj8RIyfMeyzxDFPx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1654896027; bh=y/DMgkn8r//CNJYOjrlXSPhNNt6k+/DiVLjROkm84UQ=; h=Cc:Date:From:Reply-To:Subject:To; b=wJi2iV3AEKU8JfthcODHmqYTnmAzhnf3n86SInw6YfMqBQts5f6/gtcX5HXsZWpURCv 2H6v+S6EuNmaK+qhHm4jiHfZXRlAcQimgwjkVEjEPUaH891nuhd9Pe3mV/WP3txGUL6f8 HfwwJ7eUx+ov1Hj+D1UUigWn4Fr8ypjwzJU= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1654896028766100009 Content-Type: text/plain; charset="utf-8" Adds definition of EDKII_PEI_VARIABLE_PPI, a pre-cursor to enabling variable writes in the PEI environment. Cc: Jian J Wang Cc: Liming Gao Cc: Michael D Kinney Cc: Isaac Oram Cc: Chasel Chiu Cc: Gao Cheng Cc: Di Zhang Cc: Daocheng Bu Cc: Michael Kubacki Signed-off-by: Nate DeSimone Acked-by: Michael Kubacki --- MdeModulePkg/Include/Ppi/Variable.h | 195 ++++++++++++++++++++++++++++ MdeModulePkg/MdeModulePkg.dec | 3 + 2 files changed, 198 insertions(+) create mode 100644 MdeModulePkg/Include/Ppi/Variable.h diff --git a/MdeModulePkg/Include/Ppi/Variable.h b/MdeModulePkg/Include/Ppi= /Variable.h new file mode 100644 index 0000000000..b4b120d2ba --- /dev/null +++ b/MdeModulePkg/Include/Ppi/Variable.h @@ -0,0 +1,195 @@ +/** @file + EDKII PEI Variable PPI provides an implementation of variables + intended for use as a means to store data in the PEI environment. + + Copyright (c) 2022, Intel Corporation. All rights reserved.
+ SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef PEI_VARIABLE_PPI_H_ +#define PEI_VARIABLE_PPI_H_ + +#define EDKII_PEI_VARIABLE_PPI_GUID \ + { \ + 0xe7b2cd04, 0x4b14, 0x44c2, { 0xb7, 0x48, 0xce, 0xaf, 0x2b, 0x66, 0x4a= , 0xb0 } \ + } + +typedef struct _EDKII_PEI_VARIABLE_PPI EDKII_PEI_VARIABLE_PPI; + +/** + This service retrieves a variable's value using its name and GUID. + + Read the specified variable from the UEFI variable store. If the Data + buffer is too small to hold the contents of the variable, + the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the + required buffer size to obtain the data. + + @param[in] This A pointer to this instance of the ED= KII_PEI_VARIABLE_PPI. + @param[in] VariableName A pointer to a null-terminated strin= g that is the variable's name. + @param[in] VariableGuid A pointer to an EFI_GUID that is the= variable's GUID. The combination of + VariableGuid and VariableName must b= e unique. + @param[out] Attributes If non-NULL, on return, points to th= e variable's attributes. + @param[in, out] DataSize On entry, points to the size in byte= s of the Data buffer. + On return, points to the size of the= data returned in Data. + @param[out] Data Points to the buffer which will hold= the returned variable value. + May be NULL with a zero DataSize in = order to determine the size of the + buffer needed. + + @retval EFI_SUCCESS The variable was read successfully. + @retval EFI_NOT_FOUND The variable was not found. + @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the re= sulting data. + DataSize is updated with the size re= quired for + the specified variable. + @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize= or Data is NULL. + @retval EFI_DEVICE_ERROR The variable could not be retrieved = because of a device error. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_PEI_GET_VARIABLE)( + IN CONST EDKII_PEI_VARIABLE_PPI *This, + IN CONST CHAR16 *VariableName, + IN CONST EFI_GUID *VariableGuid, + OUT UINT32 *Attributes OPTIONAL, + IN OUT UINTN *DataSize, + OUT VOID *Data OPTIONAL + ); + +/** + Return the next variable name and GUID. + + This function is called multiple times to retrieve the VariableName + and VariableGuid of all variables currently available in the system. + On each call, the previous results are passed into the interface, + and, on return, the interface returns the data for the next + interface. To get started, VariableName should initially contain L"\0" + and VariableNameSize should be sizeof(CHAR16). When the entire + variable list has been returned, EFI_NOT_FOUND is returned. + + @param[in] This A pointer to this instance of the ED= KII_PEI_VARIABLE_PPI. + @param[in, out] VariableNameSize On entry, points to the size of the = buffer pointed to by VariableName. + On return, the size of the variable = name buffer. + @param[in, out] VariableName On entry, a pointer to a null-termin= ated string that is the variable's name. + On return, points to the next variab= le's null-terminated name string. + @param[in, out] VariableGuid On entry, a pointer to an EFI_GUID t= hat is the variable's GUID. + On return, a pointer to the next var= iable's GUID. + + @retval EFI_SUCCESS The variable was read successfully. + @retval EFI_NOT_FOUND The variable could not be found. + @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small fo= r the resulting + data. VariableNameSize is updated wi= th the size + required for the specified variable. + @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or + VariableNameSize is NULL. + @retval EFI_DEVICE_ERROR The variable could not be retrieved = because of a device error. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_PEI_GET_NEXT_VARIABLE_NAME)( + IN CONST EDKII_PEI_VARIABLE_PPI *This, + IN OUT UINTN *VariableNameSize, + IN OUT CHAR16 *VariableName, + IN OUT EFI_GUID *VariableGuid + ); + +/** + Sets the value of a variable. + + @param[in] This A pointer to this instance of the ED= KII_PEI_VARIABLE_PPI. + @param[in] VariableName A Null-terminated string that is the= name of the vendor's variable. + Each VariableName is unique for each= VendorGuid. VariableName must + contain 1 or more characters. If Var= iableName is an empty string, + then EFI_INVALID_PARAMETER is return= ed. + @param[in] VendorGuid A unique identifier for the vendor. + @param[in] Attributes Attributes bitmask to set for the va= riable. + @param[in] DataSize The size in bytes of the Data buffer= . Unless the EFI_VARIABLE_APPEND_WRITE + attribute is set, a size of zero cau= ses the variable to be deleted. When the + EFI_VARIABLE_APPEND_WRITE attribute = is set, then a SetVariable() call with a + DataSize of zero will not cause any = change to the variable value. + @param[in] Data The contents for the variable. + + @retval EFI_SUCCESS The firmware has successfully stored= the variable and its data as + defined by the Attributes. + @retval EFI_INVALID_PARAMETER An invalid combination of attribute = bits, name, and GUID was supplied, or the + DataSize exceeds the maximum allowed. + @retval EFI_INVALID_PARAMETER VariableName is an empty string. + @retval EFI_OUT_OF_RESOURCES Not enough storage is available to h= old the variable and its data. + @retval EFI_DEVICE_ERROR The variable could not be retrieved = due to a hardware error. + @retval EFI_WRITE_PROTECTED The variable in question is read-onl= y. + @retval EFI_WRITE_PROTECTED The variable in question cannot be d= eleted. + @retval EFI_SECURITY_VIOLATION The variable could not be written du= e to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, + or EFI_VARIABLE_TIME_BASED_AUTHENTIC= ATED_WRITE_ACCESS, or + EFI_VARIABLE_ENHANCED_AUTHENTICATED_= ACCESS being set. Writing to authenticated + variables is not supported in the PE= I environment. Updates to authenticated + variables can be requested during PE= I via the EFI_AUTHENTICATED_VARIABLE_HOB, but + these updates won't be written to no= n-volatile storage until later in DXE. + The EFI_AUTHENTICATED_VARIABLE_HOB i= s a HOB with the GUID + gEfiAuthenticatedVariableGuid. This = HOB contains a VARIABLE_STORE_HEADER followed + by one or more UEFI variables, which= are stored as DWORD aligned tuples of + (VARIABLE_HEADER + CHAR16 VariableNa= me + VariableData). + See MdeModulePkg/Include/Guid/Variab= leFormat.h for these data structure + definitions and MdeModulePkg/Univers= al/Variable/RuntimeDxe/VariableParsing.c for + an example of how to parse these dat= a structures. + @retval EFI_NOT_FOUND The variable trying to be updated or= deleted was not found. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_PEI_SET_VARIABLE)( + IN CONST EDKII_PEI_VARIABLE_PPI *This, + IN CHAR16 *VariableName, + IN EFI_GUID *VendorGuid, + IN UINT32 Attributes, + IN UINTN DataSize, + IN VOID *Data + ); + +/** + Returns information about the UEFI variables. + + @param[in] This A pointer to this instan= ce of the EDKII_PEI_VARIABLE_PPI. + @param[in] Attributes Attributes bitmask to sp= ecify the type of variables on + which to return informat= ion. + @param[out] MaximumVariableStorageSize On output the maximum si= ze of the storage space + available for the EFI va= riables associated with the + attributes specified. + @param[out] RemainingVariableStorageSize Returns the remaining si= ze of the storage space + available for the EFI va= riables associated with the + attributes specified. + @param[out] MaximumVariableSize Returns the maximum size= of the individual EFI + variables associated wit= h the attributes specified. + + @retval EFI_SUCCESS Valid answer returned. + @retval EFI_INVALID_PARAMETER An invalid combination o= f attribute bits was supplied + @retval EFI_UNSUPPORTED The attribute is not sup= ported on this platform, and the + MaximumVariableStorageSi= ze, + RemainingVariableStorage= Size, MaximumVariableSize + are undefined. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_PEI_QUERY_VARIABLE_INFO)( + IN CONST EDKII_PEI_VARIABLE_PPI *This, + IN UINT32 Attributes, + OUT UINT64 *MaximumVariableStorageSize, + OUT UINT64 *RemainingVariableStorageSize, + OUT UINT64 *MaximumVariableSize + ); + +/// +/// PEI Variable PPI is intended for use as a means +/// to store data in the PEI environment. +/// +struct _EDKII_PEI_VARIABLE_PPI { + EDKII_PEI_GET_VARIABLE GetVariable; + EDKII_PEI_GET_NEXT_VARIABLE_NAME GetNextVariableName; + EDKII_PEI_SET_VARIABLE SetVariable; + EDKII_PEI_QUERY_VARIABLE_INFO QueryVariableInfo; +}; + +extern EFI_GUID gEdkiiPeiVariablePpiGuid; + +#endif diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec index 2bcb9f9453..4f4c48b81f 100644 --- a/MdeModulePkg/MdeModulePkg.dec +++ b/MdeModulePkg/MdeModulePkg.dec @@ -513,6 +513,9 @@ gEdkiiPeiCapsuleOnDiskPpiGuid =3D { 0x71a9ea61, 0x5a35, 0x4a= 5d, { 0xac, 0xef, 0x9c, 0xf8, 0x6d, 0x6d, 0x67, 0xe0 } } gEdkiiPeiBootInCapsuleOnDiskModePpiGuid =3D { 0xb08a11e4, 0xe2b7, 0x4b= 75, { 0xb5, 0x15, 0xaf, 0x61, 0x6, 0x68, 0xbf, 0xd1 } } =20 + ## Include/Ppi/Variable.h + gEdkiiPeiVariablePpiGuid =3D { 0xe7b2cd04, 0x4b14, 0x44= c2, { 0xb7, 0x48, 0xce, 0xaf, 0x2b, 0x66, 0x4a, 0xb0 } } + [Protocols] ## Load File protocol provides capability to load and unload EFI image i= nto memory and execute it. # Include/Protocol/LoadPe32Image.h --=20 2.27.0.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#90450): https://edk2.groups.io/g/devel/message/90450 Mute This Topic: https://groups.io/mt/91678222/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-