Reviewed-by: Samer El-Haj-Mahmoud <el...@hpe.com>
Ray, Feng, Star,
Can you please help review and commit this change?
-----Original Message-----
From: Palmer, Thomas
Sent: Monday, April 4, 2016 2:52 PM
To: edk2-devel@lists.01.org
Cc: El-Haj-Mahmoud, Samer <samer.el-haj-mahm...@hpe.com>; feng.t...@intel.com;
star.z...@intel.com; ruiyu...@intel.com; Palmer, Thomas <thomas.pal...@hpe.com>
Subject: [PATCH] MdeModulePkg/UefiBootManagerLib: API
BmIsValidLoadOptionVariableName
Redfine the BmIsValidLoadOptionVariableName function to allow public use.
Change name to EfiBootManagerIsValidLoadOptionVariableName to match naming
scheme. Check that VariableName is never NULL and allow OptionType and
OptionNumber to be optional.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Thomas Palmer <thomas.pal...@hpe.com>
---
MdeModulePkg/Include/Library/UefiBootManagerLib.h | 23 ++++++++++++-
.../Library/UefiBootManagerLib/BmLoadOption.c | 38 ++++++++++++++--------
2 files changed, 46 insertions(+), 15 deletions(-)
diff --git a/MdeModulePkg/Include/Library/UefiBootManagerLib.h
b/MdeModulePkg/Include/Library/UefiBootManagerLib.h
index afb4271..e3555b5 100644
--- a/MdeModulePkg/Include/Library/UefiBootManagerLib.h
+++ b/MdeModulePkg/Include/Library/UefiBootManagerLib.h
@@ -2,7 +2,7 @@
Provide Boot Manager related library APIs.
Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>
-(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
+(C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<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 @@ -731,4 +731,25
@@ EFIAPI EfiBootManagerProcessLoadOption (
EFI_BOOT_MANAGER_LOAD_OPTION *LoadOption
);
+
+/**
+ Check whether the VariableName is a valid load option variable name
+ and return the load option type and option number.
+
+ @param VariableName The name of the load option variable.
+ @param OptionType Return the load option type.
+ @param OptionNumber Return the load option number.
+
+ @retval TRUE The variable name is valid; The load option type and
+ load option number is returned.
+ @retval FALSE The variable name is NOT valid.
+**/
+BOOLEAN
+EFIAPI
+EfiBootManagerIsValidLoadOptionVariableName (
+ IN CHAR16 *VariableName,
+ OUT EFI_BOOT_MANAGER_LOAD_OPTION_TYPE *OptionType OPTIONAL,
+ OUT UINT16 *OptionNumber OPTIONAL
+ );
+
#endif
diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
index 696e995..8201255 100644
--- a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
+++ b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
@@ -2,7 +2,7 @@
Load option library functions which relate with creating and processing load
options.
Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR>
-(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
+(C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<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 @@ -775,16 +775,21
@@ BmValidateOption (
@retval FALSE The variable name is NOT valid.
**/
BOOLEAN
-BmIsValidLoadOptionVariableName (
+EFIAPI
+EfiBootManagerIsValidLoadOptionVariableName (
IN CHAR16 *VariableName,
- OUT EFI_BOOT_MANAGER_LOAD_OPTION_TYPE *OptionType,
- OUT UINT16 *OptionNumber
+ OUT EFI_BOOT_MANAGER_LOAD_OPTION_TYPE *OptionType OPTIONAL,
+ OUT UINT16 *OptionNumber OPTIONAL
)
{
UINTN VariableNameLen;
UINTN Index;
UINTN Uint;
+ if (VariableName == NULL) {
+ return FALSE;
+ }
+
VariableNameLen = StrLen (VariableName);
if (VariableNameLen <= 4) {
@@ -803,14 +808,19 @@ BmIsValidLoadOptionVariableName (
return FALSE;
}
- *OptionType = (EFI_BOOT_MANAGER_LOAD_OPTION_TYPE) Index;
- *OptionNumber = 0;
- for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {
- Uint = BmCharToUint (VariableName[Index]);
- if (Uint == -1) {
- break;
- } else {
- *OptionNumber = (UINT16) Uint + *OptionNumber * 0x10;
+ if (OptionType != NULL) {
+ *OptionType = (EFI_BOOT_MANAGER_LOAD_OPTION_TYPE) Index; }
+
+ if (OptionNumber != NULL) {
+ *OptionNumber = 0;
+ for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {
+ Uint = BmCharToUint (VariableName[Index]);
+ if (Uint == -1) {
+ break;
+ } else {
+ *OptionNumber = (UINT16) Uint + *OptionNumber * 0x10;
+ }
}
}
@@ -853,7 +863,7 @@ EfiBootManagerVariableToLoadOptionEx (
return EFI_INVALID_PARAMETER;
}
- if (!BmIsValidLoadOptionVariableName (VariableName, &OptionType,
&OptionNumber)) {
+ if (!EfiBootManagerIsValidLoadOptionVariableName (VariableName,
+ &OptionType, &OptionNumber)) {
return EFI_INVALID_PARAMETER;
}
@@ -979,7 +989,7 @@ BmCollectLoadOptions (
if (CompareGuid (Guid, Param->Guid) && (
Param->OptionType == LoadOptionTypePlatformRecovery &&
- BmIsValidLoadOptionVariableName (Name, &OptionType, &OptionNumber) &&
+ EfiBootManagerIsValidLoadOptionVariableName (Name, &OptionType,
+ &OptionNumber) &&
OptionType == LoadOptionTypePlatformRecovery
)) {
Status = EfiBootManagerVariableToLoadOptionEx (Name, Guid, &Option);
--
1.9.1
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
