RedfishConfigHandlerCommon.h File Reference

#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/NetLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiLib.h>
#include <Protocol/EdkIIRedfishCredential.h>
#include <Protocol/EdkIIRedfishConfigHandler.h>

Go to the source code of this file.

Data Structures
struct	REDFISH_CONFIG_DRIVER_DATA

Macros
#define	REDFISH_CONFIG_VERSION   0x00000001

Functions
EFI_STATUS	RedfishConfigDriverCommonUnload (IN EFI_HANDLE ImageHandle)
EFI_STATUS	RedfishConfigCommonInit (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS	RedfishConfigCommonStop (VOID)
VOID	RedfishConfigHandlerInitialization (VOID)

Detailed Description

Common Header file for Redfish Configuration Handler UEFI driver and DXE driver.

(C) Copyright 2021 Hewlett Packard Enterprise Development LP

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file RedfishConfigHandlerCommon.h.

Macro Definition Documentation

REDFISH_CONFIG_VERSION

#define REDFISH_CONFIG_VERSION   0x00000001

Definition at line 37 of file RedfishConfigHandlerCommon.h.

Function Documentation

RedfishConfigCommonInit()

EFI_STATUS RedfishConfigCommonInit	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

This is the common code for Redfish configuration UEFI and DXE driver initialization.

Parameters

[in]	ImageHandle	The firmware allocated handle for the UEFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The operation completed successfully.
Others	An unexpected error occurred.

Definition at line 112 of file RedfishConfigHandlerCommon.c.

RedfishConfigCommonStop()

EFI_STATUS RedfishConfigCommonStop

(

VOID

)

This is the common code to stop EDK2 Redfish feature driver.

Return values

EFI_SUCCESS	All EDK2 Redfish feature drivers are stopped.
Others	An unexpected error occurred.

Definition at line 174 of file RedfishConfigHandlerCommon.c.

RedfishConfigDriverCommonUnload()

EFI_STATUS RedfishConfigDriverCommonUnload

(

IN EFI_HANDLE

ImageHandle

)

Common code of unloading image for both UEFI/DXE Redfish Configuration drivers.

Parameters

[in]

ImageHandle

Handle that identifies the image to be unloaded.

Return values

EFI_SUCCESS

The image has been unloaded.

Unloads an image.

Parameters

[in]

ImageHandle

Handle that identifies the image to be unloaded.

Return values

EFI_SUCCESS

The image has been unloaded.

Definition at line 79 of file RedfishConfigHandlerCommon.c.

RedfishConfigHandlerInitialization()

VOID RedfishConfigHandlerInitialization

(

VOID

)

Callback function executed when a Redfish Config Handler Protocol is installed by EDK2 Redfish Feature Drivers.

Definition at line 220 of file RedfishConfigHandlerCommon.c.