Skip to content

Commit

Permalink
RedfishClientPkg: Introduce HiiToRedfishBiosDxe driver
Browse files Browse the repository at this point in the history 
Add HiiToRedfishBiosDxe driver with configure language defined in UNI
file in order to demonstrate the use of Redfish Platform Config
Protocol. Feature drivers under RedfishClientPkg will work with this
driver and provide the REST data to Redfish service.

Signed-off-by: Nickle Wang <[email protected]>
Cc: Abner Chang <[email protected]>
Cc: Igor Kulchytskyy <[email protected]>
Reviewed-by: Abner Chang <[email protected]>
  • Loading branch information
@nicklela
nicklela committed Jun 15, 2023
1 parent ddf5f7a commit 8baeae6
Show file tree
Hide file tree
Showing 10 changed files with 561 additions and 0 deletions.
47 changes: 47 additions & 0 deletions RedfishClientPkg/HiiToRedfishBiosDxe/HiiToRedfishBiosData.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/** @file
The header file of HII-to-Redfish BIOS example driver.
(C) Copyright 2022 Hewlett Packard Enterprise Development LP<BR>
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#ifndef HII_TO_REDFISH_BIOS_DATA_H_
#define HII_TO_REDFISH_BIOS_DATA_H_

#include <Uefi/UefiMultiPhase.h>
#include <Guid/HiiPlatformSetupFormset.h>

#define HII_TO_REDFISH_BIOS_FORMSET_GUID \
{ \
0xC2724AD1, 0x4049, 0x2404, { 0xF8, 0xCE, 0x01, 0xA7, 0x9C, 0xEC, 0x16, 0xF6 } \
}

extern EFI_GUID gHiiToRedfishBiosFormsetGuid;

#define FORM_ID 0x001
#define FROM_ID_BIOS_OPTION_1 0x002
#define FROM_ID_BIOS_OPTION_2 0x003
#define FROM_ID_BIOS_OPTION_3 0x004
#define FROM_ID_BIOS_OPTION_4 0x005

#define ID_STRING_MIN 0
#define ID_STRING_MAX 15
#define ID_STRING_MAX_WITH_TERMINATOR 16

#pragma pack()

//
// Definiton of HII_TO_REDFISH_BIOS_VARSTORE_DATA
//
typedef struct {
UINT8 RedfishBiosOption1Data;
CHAR16 RedfishBiosOption2Data[ID_STRING_MAX_WITH_TERMINATOR];
UINT8 RedfishBiosOption3Data;
UINT8 RedfishBiosOption4Data;
UINT8 Reserved;
} HII_TO_REDFISH_BIOS_EFI_VARSTORE_DATA;

#endif
290 changes: 290 additions & 0 deletions RedfishClientPkg/HiiToRedfishBiosDxe/HiiToRedfishBiosDxe.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,290 @@
/** @file
HII-to-Redfish Bios example driver.
(C) Copyright 2022 Hewlett Packard Enterprise Development LP<BR>
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#include "HiiToRedfishBiosDxe.h"

EFI_GUID mHiiToRedfishBiosGuid = HII_TO_REDFISH_BIOS_FORMSET_GUID;
EFI_HII_HANDLE mHiiHandle;
EFI_HANDLE DriverHandle;
CHAR16 HiiToRedfishEfiVar[] = L"HiiToRedfishBiosEfiVar";

///
/// HII specific Vendor Device Path definition.
///
HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath = {
{
{
HARDWARE_DEVICE_PATH,
HW_VENDOR_DP,
{
(UINT8)(sizeof (VENDOR_DEVICE_PATH)),
(UINT8)((sizeof (VENDOR_DEVICE_PATH)) >> 8)
}
},
HII_TO_REDFISH_BIOS_FORMSET_GUID
},
{
END_DEVICE_PATH_TYPE,
END_ENTIRE_DEVICE_PATH_SUBTYPE,
{
(UINT8)(END_DEVICE_PATH_LENGTH),
(UINT8)((END_DEVICE_PATH_LENGTH) >> 8)
}
}
};

/**
Initial HII variable if it does not exist.
@retval EFI_SUCCESS HII variable is initialized.
**/
EFI_STATUS
InitialHiiVariable (
VOID
)
{
EFI_STATUS Status;
UINTN BufferSize;
HII_TO_REDFISH_BIOS_EFI_VARSTORE_DATA HiiToRedfishBiosVar;

//
// Get Buffer Storage data from EFI variable.
// Try to get the current setting from variable.
//
BufferSize = sizeof (HII_TO_REDFISH_BIOS_EFI_VARSTORE_DATA);
Status = gRT->GetVariable (
HiiToRedfishEfiVar,
&gHiiToRedfishBiosFormsetGuid,
NULL,
&BufferSize,
&HiiToRedfishBiosVar
);
if (!EFI_ERROR (Status)) {
return EFI_SUCCESS;
}

//
// Initialization
//
HiiToRedfishBiosVar.RedfishBiosOption1Data = STR_BIOS_OPTION_1_ITEM_1;
StrCpyS (HiiToRedfishBiosVar.RedfishBiosOption2Data, ID_STRING_MAX_WITH_TERMINATOR, L"Default");
HiiToRedfishBiosVar.RedfishBiosOption3Data = 5;
HiiToRedfishBiosVar.RedfishBiosOption4Data = TRUE;

Status = gRT->SetVariable (
HiiToRedfishEfiVar,
&gHiiToRedfishBiosFormsetGuid,
VARIABLE_ATTRIBUTE_NV_BS,
BufferSize,
&HiiToRedfishBiosVar
);

return Status;
}

/**
This function allows a caller to extract the current configuration for one
or more named elements from the target driver.
@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
@param[in] Request A null-terminated Unicode string in
<ConfigRequest> format.
@param[out] Progress On return, points to a character in the Request
string. Points to the string's null terminator if
request was successful. Points to the most recent
'&' before the first failing name/value pair (or
the beginning of the string if the failure is in
the first name/value pair) if the request was not
successful.
@param[out] Results A null-terminated Unicode string in
<ConfigAltResp> format which has all values filled
in for the names in the Request string. String to
be allocated by the called function.
@retval EFI_SUCCESS The Results is filled with the requested values.
@retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
@retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
@retval EFI_NOT_FOUND Routing data doesn't match any storage in this
driver.
**/
EFI_STATUS
EFIAPI
HiiToRedfishBiosExtractConfig (
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
IN CONST EFI_STRING Request,
OUT EFI_STRING *Progress,
OUT EFI_STRING *Results
)
{
if ((Progress == NULL) || (Results == NULL)) {
return EFI_INVALID_PARAMETER;
}

if (Request == NULL) {
return EFI_UNSUPPORTED;
}

//
// Check whether request for EFI Varstore. EFI varstore get data
// through hii database, not support in this path.
//
if (HiiIsConfigHdrMatch (Request, &gHiiToRedfishBiosFormsetGuid, L"HiiToRedfishBiosEfiVar")) {
return EFI_UNSUPPORTED;
}

return EFI_NOT_FOUND;
}

/**
This function processes the results of changes in configuration.
@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
@param[in] Configuration A null-terminated Unicode string in <ConfigResp>
format.
@param[out] Progress A pointer to a string filled in with the offset of
the most recent '&' before the first failing
name/value pair (or the beginning of the string if
the failure is in the first name/value pair) or
the terminating NULL if all was successful.
@retval EFI_SUCCESS The Results is processed successfully.
@retval EFI_INVALID_PARAMETER Configuration is NULL.
@retval EFI_NOT_FOUND Routing data doesn't match any storage in this
driver.
**/
EFI_STATUS
EFIAPI
HiiToRedfishBiosRouteConfig (
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
IN CONST EFI_STRING Configuration,
OUT EFI_STRING *Progress
)
{
DEBUG ((DEBUG_INFO, "%a, unsupported\n", __func__));

return EFI_UNSUPPORTED;
}

/**
This function processes the results of changes in configuration.
@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
@param[in] Action Specifies the type of action taken by the browser.
@param[in] QuestionId A unique value which is sent to the original
exporting driver so that it can identify the type
of data to expect.
@param[in] Type The type of value for the question.
@param[in] Value A pointer to the data being sent to the original
exporting driver.
@param[out] ActionRequest On return, points to the action requested by the
callback function.
@retval EFI_SUCCESS The callback successfully handled the action.
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
variable and its data.
@retval EFI_DEVICE_ERROR The variable could not be saved.
@retval EFI_UNSUPPORTED The specified Action is not supported by the
callback.
**/
EFI_STATUS
EFIAPI
HiiToRedfishBiosDriverCallback (
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
IN EFI_BROWSER_ACTION Action,
IN EFI_QUESTION_ID QuestionId,
IN UINT8 Type,
IN EFI_IFR_TYPE_VALUE *Value,
OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
)
{
DEBUG ((DEBUG_INFO, "%a, action: 0x%x QID: 0x%x\n", __func__, Action, QuestionId));

return EFI_UNSUPPORTED;
}

EFI_HII_CONFIG_ACCESS_PROTOCOL mHiiToRedfishConfigAccess = {
HiiToRedfishBiosExtractConfig,
HiiToRedfishBiosRouteConfig,
HiiToRedfishBiosDriverCallback
};

/**
Main entry for this driver.
@param[in] ImageHandle Image handle this driver.
@param[in] SystemTable Pointer to SystemTable.
@retval EFI_SUCCESS This function always complete successfully.
**/
EFI_STATUS
EFIAPI
HiiToRedfishBiosDxeDriverEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;

DriverHandle = NULL;
Status = gBS->InstallMultipleProtocolInterfaces (
&DriverHandle,
&gEfiDevicePathProtocolGuid,
&mHiiVendorDevicePath,
&gEfiHiiConfigAccessProtocolGuid,
&mHiiToRedfishConfigAccess,
NULL
);

//
// Publish our HII data
//
mHiiHandle = HiiAddPackages (
&mHiiToRedfishBiosGuid,
DriverHandle,
HiiToRedfishBiosDxeStrings,
HiiToRedfishBiosVfrBin,
NULL
);
if (mHiiHandle == NULL) {
return EFI_OUT_OF_RESOURCES;
}

Status = InitialHiiVariable ();
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "%a, failed to initial variable: %r\n", __func__, Status));
}

return EFI_SUCCESS;
}

/**
Unloads the application and its installed protocol.
@param[in] ImageHandle Handle that identifies the image to be unloaded.
@retval EFI_SUCCESS The image has been unloaded.
**/
EFI_STATUS
EFIAPI
HiiToRedfishBiosDxeDriverUnload (
IN EFI_HANDLE ImageHandle
)
{
if (mHiiHandle != NULL) {
HiiRemovePackages (mHiiHandle);
}

return EFI_SUCCESS;
}
45 changes: 45 additions & 0 deletions RedfishClientPkg/HiiToRedfishBiosDxe/HiiToRedfishBiosDxe.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/** @file
HII-to-Redfish BIOS example driver header file.
(C) Copyright 2022 Hewlett Packard Enterprise Development LP<BR>
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#ifndef HII_TO_REDFISH_BIOS_DXE_H_
#define HII_TO_REDFISH_BIOS_DXE_H_

#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/PrintLib.h>
#include <Library/HiiLib.h>
#include <Library/DevicePathLib.h>

#include <Protocol/HiiConfigAccess.h>
#include <Guid/VariableFormat.h>

#include "HiiToRedfishBiosData.h"

extern UINT8 HiiToRedfishBiosVfrBin[];

#pragma pack(1)

///
/// HII specific Vendor Device Path definition.
///
typedef struct {
VENDOR_DEVICE_PATH VendorDevicePath;
EFI_DEVICE_PATH_PROTOCOL End;
} HII_VENDOR_DEVICE_PATH;

#pragma pack()

#endif
Loading

0 comments on commit 8baeae6

Please sign in to comment.