| Message ID | 20181122172645.20819-2-ard.biesheuvel@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Platform/ARM: fix DevicePath mishandling in BdsLib | expand |
On 11/22/18 18:26, Ard Biesheuvel wrote: > The BdsLib library has been moved into Platform/ARM a while ago, > but the BdsLib.h header was left behind, and so all users in > Platform/ARM are still relying on it to be available in ArmPkg. > > So let's add a copy to Platform/ARM and wire it up, so we can > drop it from ArmPkg going forward. Note that the BdsLib > implementation included ArmLib.h from ArmPkg without using > anything it provides, so drop that false dependency as well. > > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org> > --- > Platform/ARM/ARM.dec | 3 + > Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf | 2 +- > Platform/ARM/Include/Library/BdsLib.h | 212 ++++++++++++++++++++ > Platform/ARM/Library/BdsLib/BdsInternal.h | 1 - > Platform/ARM/Library/BdsLib/BdsLib.inf | 2 +- > 5 files changed, 217 insertions(+), 3 deletions(-) > > diff --git a/Platform/ARM/ARM.dec b/Platform/ARM/ARM.dec > index f9bf3294a0ca..6a6eeb6559fd 100644 > --- a/Platform/ARM/ARM.dec > +++ b/Platform/ARM/ARM.dec > @@ -21,5 +21,8 @@ > [Includes] > Include # Root include for the package > > +[LibraryClasses] > + BdsLib|Include/Library/BdsLib.h > + > [Guids] > gArmBootMonFsFileInfoGuid = { 0x41e26b9c, 0xada6, 0x45b3, { 0x80, 0x8e, 0x23, 0x57, 0xa3, 0x5b, 0x60, 0xd6 } } > diff --git a/Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf b/Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf > index f9a5aee3596e..d4aef4bfce92 100644 > --- a/Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf > +++ b/Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf > @@ -28,10 +28,10 @@ > ShellSetFdt.c > > [Packages] > - ArmPkg/ArmPkg.dec > EmbeddedPkg/EmbeddedPkg.dec > MdeModulePkg/MdeModulePkg.dec > MdePkg/MdePkg.dec > + Platform/ARM/ARM.dec > Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.dec > ShellPkg/ShellPkg.dec > > diff --git a/Platform/ARM/Include/Library/BdsLib.h b/Platform/ARM/Include/Library/BdsLib.h > new file mode 100644 > index 000000000000..4528c2e8739b > --- /dev/null > +++ b/Platform/ARM/Include/Library/BdsLib.h > @@ -0,0 +1,212 @@ > +/** @file > +* > +* Copyright (c) 2013-2015, ARM Limited. All rights reserved. > +* > +* 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 __BDS_ENTRY_H__ > +#define __BDS_ENTRY_H__ > + > +#define IS_DEVICE_PATH_NODE(node,type,subtype) \ > + (((node)->Type == (type)) && ((node)->SubType == (subtype))) > + > +/** > + This is defined by the UEFI specs, don't change it > +**/ > +typedef struct { > + UINT16 LoadOptionIndex; > + EFI_LOAD_OPTION *LoadOption; > + UINTN LoadOptionSize; > + > + UINT32 Attributes; > + UINT16 FilePathListLength; > + CHAR16 *Description; > + EFI_DEVICE_PATH_PROTOCOL *FilePathList; > + > + VOID* OptionalData; > + UINTN OptionalDataSize; > +} BDS_LOAD_OPTION; > + > +/** > + Connect a Device Path and return the handle of the driver that support this DevicePath > + > + @param DevicePath Device Path of the File to connect > + @param Handle Handle of the driver that support this DevicePath > + @param RemainingDevicePath Remaining DevicePath nodes that do not match the driver DevicePath > + > + @retval EFI_SUCCESS A driver that matches the Device Path has been found > + @retval EFI_NOT_FOUND No handles match the search. > + @retval EFI_INVALID_PARAMETER DevicePath or Handle is NULL > + > +**/ > +EFI_STATUS > +BdsConnectDevicePath ( > + IN EFI_DEVICE_PATH_PROTOCOL* DevicePath, > + OUT EFI_HANDLE *Handle, > + OUT EFI_DEVICE_PATH_PROTOCOL **RemainingDevicePath > + ); > + > +/** > + Connect all DXE drivers > + > + @retval EFI_SUCCESS All drivers have been connected > + @retval EFI_NOT_FOUND No handles match the search. > + @retval EFI_OUT_OF_RESOURCES There is not resource pool memory to store the matching results. > + > +**/ > +EFI_STATUS > +BdsConnectAllDrivers ( > + VOID > + ); > + > +/** > + Return the value of a global variable defined by its VariableName. > + The variable must be defined with the VendorGuid gEfiGlobalVariableGuid. > + > + @param VariableName A Null-terminated string that is the name of the vendor's > + variable. > + @param DefaultValue Value returned by the function if the variable does not exist > + @param DataSize On input, the size in bytes of the return Data buffer. > + On output the size of data returned in Data. > + @param Value Value read from the UEFI Variable or copy of the default value > + if the UEFI Variable does not exist > + > + @retval EFI_SUCCESS All drivers have been connected > + @retval EFI_NOT_FOUND No handles match the search. > + @retval EFI_OUT_OF_RESOURCES There is not resource pool memory to store the matching results. > + > +**/ > +EFI_STATUS > +GetGlobalEnvironmentVariable ( > + IN CONST CHAR16* VariableName, > + IN VOID* DefaultValue, > + IN OUT UINTN* Size, > + OUT VOID** Value > + ); > + > +/** > + Return the value of the variable defined by its VariableName and VendorGuid > + > + @param VariableName A Null-terminated string that is the name of the vendor's > + variable. > + @param VendorGuid A unique identifier for the vendor. > + @param DefaultValue Value returned by the function if the variable does not exist > + @param DataSize On input, the size in bytes of the return Data buffer. > + On output the size of data returned in Data. > + @param Value Value read from the UEFI Variable or copy of the default value > + if the UEFI Variable does not exist > + > + @retval EFI_SUCCESS All drivers have been connected > + @retval EFI_NOT_FOUND No handles match the search. > + @retval EFI_OUT_OF_RESOURCES There is not resource pool memory to store the matching results. > + > +**/ > +EFI_STATUS > +GetEnvironmentVariable ( > + IN CONST CHAR16* VariableName, > + IN EFI_GUID* VendorGuid, > + IN VOID* DefaultValue, > + IN OUT UINTN* Size, > + OUT VOID** Value > + ); > + > +EFI_STATUS > +BootOptionFromLoadOptionIndex ( > + IN UINT16 LoadOptionIndex, > + OUT BDS_LOAD_OPTION** BdsLoadOption > + ); > + > +EFI_STATUS > +BootOptionFromLoadOptionVariable ( > + IN CHAR16* BootVariableName, > + OUT BDS_LOAD_OPTION** BdsLoadOption > + ); > + > +EFI_STATUS > +BootOptionToLoadOptionVariable ( > + IN BDS_LOAD_OPTION* BdsLoadOption > + ); > + > +UINT16 > +BootOptionAllocateBootIndex ( > + VOID > + ); > + > +/** > + Start an EFI Application from a Device Path > + > + @param ParentImageHandle Handle of the calling image > + @param DevicePath Location of the EFI Application > + > + @retval EFI_SUCCESS All drivers have been connected > + @retval EFI_NOT_FOUND The Linux kernel Device Path has not been found > + @retval EFI_OUT_OF_RESOURCES There is not enough resource memory to store the matching results. > + > +**/ > +EFI_STATUS > +BdsStartEfiApplication ( > + IN EFI_HANDLE ParentImageHandle, > + IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, > + IN UINTN LoadOptionsSize, > + IN VOID* LoadOptions > + ); > + > +EFI_STATUS > +BdsLoadImage ( > + IN EFI_DEVICE_PATH *DevicePath, > + IN EFI_ALLOCATE_TYPE Type, > + IN OUT EFI_PHYSICAL_ADDRESS* Image, > + OUT UINTN *FileSize > + ); > + > +/** > + * Call BS.ExitBootServices with the appropriate Memory Map information > + */ > +EFI_STATUS > +ShutdownUefiBootServices ( > + VOID > + ); > + > +/** > + Locate an EFI application in a the Firmware Volumes by its name > + > + @param EfiAppGuid Guid of the EFI Application into the Firmware Volume > + @param DevicePath EFI Device Path of the EFI application > + > + @return EFI_SUCCESS The function completed successfully. > + @return EFI_NOT_FOUND The protocol could not be located. > + @return EFI_OUT_OF_RESOURCES There are not enough resources to find the protocol. > + > +**/ > +EFI_STATUS > +LocateEfiApplicationInFvByName ( > + IN CONST CHAR16* EfiAppName, > + OUT EFI_DEVICE_PATH **DevicePath > + ); > + > +/** > + Locate an EFI application in a the Firmware Volumes by its GUID > + > + @param EfiAppGuid Guid of the EFI Application into the Firmware Volume > + @param DevicePath EFI Device Path of the EFI application > + > + @return EFI_SUCCESS The function completed successfully. > + @return EFI_NOT_FOUND The protocol could not be located. > + @return EFI_OUT_OF_RESOURCES There are not enough resources to find the protocol. > + > +**/ > +EFI_STATUS > +LocateEfiApplicationInFvByGuid ( > + IN CONST EFI_GUID *EfiAppGuid, > + OUT EFI_DEVICE_PATH **DevicePath > + ); > + > +#endif > diff --git a/Platform/ARM/Library/BdsLib/BdsInternal.h b/Platform/ARM/Library/BdsLib/BdsInternal.h > index f70aae603d69..bb4566e3a6c4 100644 > --- a/Platform/ARM/Library/BdsLib/BdsInternal.h > +++ b/Platform/ARM/Library/BdsLib/BdsInternal.h > @@ -16,7 +16,6 @@ > #define __BDS_INTERNAL_H__ > > #include <PiDxe.h> > -#include <Library/ArmLib.h> > #include <Library/BaseLib.h> > #include <Library/BaseMemoryLib.h> > #include <Library/DxeServicesTableLib.h> > diff --git a/Platform/ARM/Library/BdsLib/BdsLib.inf b/Platform/ARM/Library/BdsLib/BdsLib.inf > index 96c1d6e7e200..637ef5a08128 100644 > --- a/Platform/ARM/Library/BdsLib/BdsLib.inf > +++ b/Platform/ARM/Library/BdsLib/BdsLib.inf > @@ -27,10 +27,10 @@ > BdsLoadOption.c > > [Packages] > - ArmPkg/ArmPkg.dec > EmbeddedPkg/EmbeddedPkg.dec > MdeModulePkg/MdeModulePkg.dec > MdePkg/MdePkg.dec > + Platform/ARM/ARM.dec > > [LibraryClasses] > ArmLib > Seems OK to me. Acked-by: Laszlo Ersek <lersek@redhat.com> _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
diff --git a/Platform/ARM/ARM.dec b/Platform/ARM/ARM.dec index f9bf3294a0ca..6a6eeb6559fd 100644 --- a/Platform/ARM/ARM.dec +++ b/Platform/ARM/ARM.dec @@ -21,5 +21,8 @@ [Includes] Include # Root include for the package +[LibraryClasses] + BdsLib|Include/Library/BdsLib.h + [Guids] gArmBootMonFsFileInfoGuid = { 0x41e26b9c, 0xada6, 0x45b3, { 0x80, 0x8e, 0x23, 0x57, 0xa3, 0x5b, 0x60, 0xd6 } } diff --git a/Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf b/Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf index f9a5aee3596e..d4aef4bfce92 100644 --- a/Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf +++ b/Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf @@ -28,10 +28,10 @@ ShellSetFdt.c [Packages] - ArmPkg/ArmPkg.dec EmbeddedPkg/EmbeddedPkg.dec MdeModulePkg/MdeModulePkg.dec MdePkg/MdePkg.dec + Platform/ARM/ARM.dec Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.dec ShellPkg/ShellPkg.dec diff --git a/Platform/ARM/Include/Library/BdsLib.h b/Platform/ARM/Include/Library/BdsLib.h new file mode 100644 index 000000000000..4528c2e8739b --- /dev/null +++ b/Platform/ARM/Include/Library/BdsLib.h @@ -0,0 +1,212 @@ +/** @file +* +* Copyright (c) 2013-2015, ARM Limited. All rights reserved. +* +* 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 __BDS_ENTRY_H__ +#define __BDS_ENTRY_H__ + +#define IS_DEVICE_PATH_NODE(node,type,subtype) \ + (((node)->Type == (type)) && ((node)->SubType == (subtype))) + +/** + This is defined by the UEFI specs, don't change it +**/ +typedef struct { + UINT16 LoadOptionIndex; + EFI_LOAD_OPTION *LoadOption; + UINTN LoadOptionSize; + + UINT32 Attributes; + UINT16 FilePathListLength; + CHAR16 *Description; + EFI_DEVICE_PATH_PROTOCOL *FilePathList; + + VOID* OptionalData; + UINTN OptionalDataSize; +} BDS_LOAD_OPTION; + +/** + Connect a Device Path and return the handle of the driver that support this DevicePath + + @param DevicePath Device Path of the File to connect + @param Handle Handle of the driver that support this DevicePath + @param RemainingDevicePath Remaining DevicePath nodes that do not match the driver DevicePath + + @retval EFI_SUCCESS A driver that matches the Device Path has been found + @retval EFI_NOT_FOUND No handles match the search. + @retval EFI_INVALID_PARAMETER DevicePath or Handle is NULL + +**/ +EFI_STATUS +BdsConnectDevicePath ( + IN EFI_DEVICE_PATH_PROTOCOL* DevicePath, + OUT EFI_HANDLE *Handle, + OUT EFI_DEVICE_PATH_PROTOCOL **RemainingDevicePath + ); + +/** + Connect all DXE drivers + + @retval EFI_SUCCESS All drivers have been connected + @retval EFI_NOT_FOUND No handles match the search. + @retval EFI_OUT_OF_RESOURCES There is not resource pool memory to store the matching results. + +**/ +EFI_STATUS +BdsConnectAllDrivers ( + VOID + ); + +/** + Return the value of a global variable defined by its VariableName. + The variable must be defined with the VendorGuid gEfiGlobalVariableGuid. + + @param VariableName A Null-terminated string that is the name of the vendor's + variable. + @param DefaultValue Value returned by the function if the variable does not exist + @param DataSize On input, the size in bytes of the return Data buffer. + On output the size of data returned in Data. + @param Value Value read from the UEFI Variable or copy of the default value + if the UEFI Variable does not exist + + @retval EFI_SUCCESS All drivers have been connected + @retval EFI_NOT_FOUND No handles match the search. + @retval EFI_OUT_OF_RESOURCES There is not resource pool memory to store the matching results. + +**/ +EFI_STATUS +GetGlobalEnvironmentVariable ( + IN CONST CHAR16* VariableName, + IN VOID* DefaultValue, + IN OUT UINTN* Size, + OUT VOID** Value + ); + +/** + Return the value of the variable defined by its VariableName and VendorGuid + + @param VariableName A Null-terminated string that is the name of the vendor's + variable. + @param VendorGuid A unique identifier for the vendor. + @param DefaultValue Value returned by the function if the variable does not exist + @param DataSize On input, the size in bytes of the return Data buffer. + On output the size of data returned in Data. + @param Value Value read from the UEFI Variable or copy of the default value + if the UEFI Variable does not exist + + @retval EFI_SUCCESS All drivers have been connected + @retval EFI_NOT_FOUND No handles match the search. + @retval EFI_OUT_OF_RESOURCES There is not resource pool memory to store the matching results. + +**/ +EFI_STATUS +GetEnvironmentVariable ( + IN CONST CHAR16* VariableName, + IN EFI_GUID* VendorGuid, + IN VOID* DefaultValue, + IN OUT UINTN* Size, + OUT VOID** Value + ); + +EFI_STATUS +BootOptionFromLoadOptionIndex ( + IN UINT16 LoadOptionIndex, + OUT BDS_LOAD_OPTION** BdsLoadOption + ); + +EFI_STATUS +BootOptionFromLoadOptionVariable ( + IN CHAR16* BootVariableName, + OUT BDS_LOAD_OPTION** BdsLoadOption + ); + +EFI_STATUS +BootOptionToLoadOptionVariable ( + IN BDS_LOAD_OPTION* BdsLoadOption + ); + +UINT16 +BootOptionAllocateBootIndex ( + VOID + ); + +/** + Start an EFI Application from a Device Path + + @param ParentImageHandle Handle of the calling image + @param DevicePath Location of the EFI Application + + @retval EFI_SUCCESS All drivers have been connected + @retval EFI_NOT_FOUND The Linux kernel Device Path has not been found + @retval EFI_OUT_OF_RESOURCES There is not enough resource memory to store the matching results. + +**/ +EFI_STATUS +BdsStartEfiApplication ( + IN EFI_HANDLE ParentImageHandle, + IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, + IN UINTN LoadOptionsSize, + IN VOID* LoadOptions + ); + +EFI_STATUS +BdsLoadImage ( + IN EFI_DEVICE_PATH *DevicePath, + IN EFI_ALLOCATE_TYPE Type, + IN OUT EFI_PHYSICAL_ADDRESS* Image, + OUT UINTN *FileSize + ); + +/** + * Call BS.ExitBootServices with the appropriate Memory Map information + */ +EFI_STATUS +ShutdownUefiBootServices ( + VOID + ); + +/** + Locate an EFI application in a the Firmware Volumes by its name + + @param EfiAppGuid Guid of the EFI Application into the Firmware Volume + @param DevicePath EFI Device Path of the EFI application + + @return EFI_SUCCESS The function completed successfully. + @return EFI_NOT_FOUND The protocol could not be located. + @return EFI_OUT_OF_RESOURCES There are not enough resources to find the protocol. + +**/ +EFI_STATUS +LocateEfiApplicationInFvByName ( + IN CONST CHAR16* EfiAppName, + OUT EFI_DEVICE_PATH **DevicePath + ); + +/** + Locate an EFI application in a the Firmware Volumes by its GUID + + @param EfiAppGuid Guid of the EFI Application into the Firmware Volume + @param DevicePath EFI Device Path of the EFI application + + @return EFI_SUCCESS The function completed successfully. + @return EFI_NOT_FOUND The protocol could not be located. + @return EFI_OUT_OF_RESOURCES There are not enough resources to find the protocol. + +**/ +EFI_STATUS +LocateEfiApplicationInFvByGuid ( + IN CONST EFI_GUID *EfiAppGuid, + OUT EFI_DEVICE_PATH **DevicePath + ); + +#endif diff --git a/Platform/ARM/Library/BdsLib/BdsInternal.h b/Platform/ARM/Library/BdsLib/BdsInternal.h index f70aae603d69..bb4566e3a6c4 100644 --- a/Platform/ARM/Library/BdsLib/BdsInternal.h +++ b/Platform/ARM/Library/BdsLib/BdsInternal.h @@ -16,7 +16,6 @@ #define __BDS_INTERNAL_H__ #include <PiDxe.h> -#include <Library/ArmLib.h> #include <Library/BaseLib.h> #include <Library/BaseMemoryLib.h> #include <Library/DxeServicesTableLib.h> diff --git a/Platform/ARM/Library/BdsLib/BdsLib.inf b/Platform/ARM/Library/BdsLib/BdsLib.inf index 96c1d6e7e200..637ef5a08128 100644 --- a/Platform/ARM/Library/BdsLib/BdsLib.inf +++ b/Platform/ARM/Library/BdsLib/BdsLib.inf @@ -27,10 +27,10 @@ BdsLoadOption.c [Packages] - ArmPkg/ArmPkg.dec EmbeddedPkg/EmbeddedPkg.dec MdeModulePkg/MdeModulePkg.dec MdePkg/MdePkg.dec + Platform/ARM/ARM.dec [LibraryClasses] ArmLib
The BdsLib library has been moved into Platform/ARM a while ago, but the BdsLib.h header was left behind, and so all users in Platform/ARM are still relying on it to be available in ArmPkg. So let's add a copy to Platform/ARM and wire it up, so we can drop it from ArmPkg going forward. Note that the BdsLib implementation included ArmLib.h from ArmPkg without using anything it provides, so drop that false dependency as well. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org> --- Platform/ARM/ARM.dec | 3 + Platform/ARM/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf | 2 +- Platform/ARM/Include/Library/BdsLib.h | 212 ++++++++++++++++++++ Platform/ARM/Library/BdsLib/BdsInternal.h | 1 - Platform/ARM/Library/BdsLib/BdsLib.inf | 2 +- 5 files changed, 217 insertions(+), 3 deletions(-) -- 2.17.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel