#include "RedfishConfigHandlerDriver.h"

Functions
VOID	RedfishConfigStopRedfishDiscovery (VOID)

VOID EFIAPI	RedfishConfigHandlerInstalledCallback (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	RedfishConfigDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	RedfishConfigDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	RedfishConfigDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer OPTIONAL)

VOID EFIAPI	RedfishServiceDiscoveredCallback (IN EFI_EVENT Event, OUT VOID *Context)

VOID EFIAPI	AcquireRedfishServiceOnNetworkInterfaceCallback (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	RedfishDiscoverProtocolInstalled (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	RedfishConfigHandlerDriverUnload (IN EFI_HANDLE ImageHandle)

EFI_STATUS EFIAPI	RedfishConfigHandlerDriverEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Detailed Description

The UEFI driver model driver which is responsible for locating the Redfish service through Redfish host interface and executing EDKII Redfish feature drivers.

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

Definition in file RedfishConfigHandlerDriver.c.

Function Documentation

◆ AcquireRedfishServiceOnNetworkInterfaceCallback()

VOID EFIAPI AcquireRedfishServiceOnNetworkInterfaceCallback	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Callback function executed when the gEdkIIRedfishHostInterfaceReadyProtocolGuid protocol interface is installed.

Parameters

[in]	Event	Event whose notification function is being invoked.
[in]	Context	Pointer to the Context buffer

Definition at line 356 of file RedfishConfigHandlerDriver.c.

◆ RedfishConfigDriverBindingStart()

EFI_STATUS EFIAPI RedfishConfigDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath	OPTIONAL
	)

Starts a device controller or a bus controller.

The Start() function is designed to be invoked from the EFI boot service ConnectController(). As a result, much of the error checking on the parameters to Start() has been moved into this common boot service. It is legal to call Start() from other locations, but the following calling restrictions must be followed, or the system behavior will not be deterministic.

ControllerHandle must be a valid EFI_HANDLE.
If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL.
Prior to calling Start(), the Supported() function for the driver specified by This must have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to start. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]	RemainingDevicePath	A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For a bus driver, if this parameter is NULL, then handles for all the children of Controller are created by this driver. If this parameter is not NULL and the first Device Path Node is not the End of Device Path Node, then only the handle for the child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this driver.

Return values

EFI_SUCCESS	The driver is started.
EFI_ALREADY_STARTED	The driver was already started.

Definition at line 212 of file RedfishConfigHandlerDriver.c.

◆ RedfishConfigDriverBindingStop()

EFI_STATUS EFIAPI RedfishConfigDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *ChildHandleBuffer	OPTIONAL
	)

Stops a device controller or a bus controller.

The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). As a result, much of the error checking on the parameters to Stop() has been moved into this common boot service. It is legal to call Stop() from other locations, but the following calling restrictions must be followed, or the system behavior will not be deterministic.

ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this same driver's Start() function.
The first NumberOfChildren handles of ChildHandleBuffer must all be a valid EFI_HANDLE. In addition, all of these handles must have been created in this driver's Start() function, and the Start() function must have called OpenProtocol() on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	A handle to the device being stopped. The handle must support a bus specific I/O protocol for the driver to use to stop the device.
[in]	NumberOfChildren	The number of child device handles in ChildHandleBuffer.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Definition at line 262 of file RedfishConfigHandlerDriver.c.

◆ RedfishConfigDriverBindingSupported()

EFI_STATUS EFIAPI RedfishConfigDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath	OPTIONAL
	)

Tests to see if this driver supports a given controller. If a child device is provided, it further tests to see if this driver supports creating a handle for the specified child device.

This function checks to see if the driver specified by This supports the device specified by ControllerHandle. Drivers will typically use the device path attached to ControllerHandle and/or the services from the bus I/O abstraction attached to ControllerHandle to determine if the driver supports ControllerHandle. This function may be called many times during platform initialization. In order to reduce boot times, the tests performed by this function must be very small, and take as little time as possible to execute. This function must not change the state of any hardware devices, and this function must be aware that the device specified by ControllerHandle may already be managed by the same driver or a different driver. This function must match its calls to AllocatePages() with FreePages(), AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). Because ControllerHandle may have been previously started by the same driver, if a protocol is already in the opened state, then it must not be closed with CloseProtocol(). This is required to guarantee the state of ControllerHandle is not modified by this function.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to test. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]	RemainingDevicePath	A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For bus drivers, if this parameter is not NULL, then the bus driver must determine if the bus controller specified by ControllerHandle and the child controller specified by RemainingDevicePath are both supported by this bus driver.

Return values

EFI_SUCCESS	The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This.
EFI_UNSUPPORTED	The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 127 of file RedfishConfigHandlerDriver.c.

◆ RedfishConfigHandlerDriverEntryPoint()

EFI_STATUS EFIAPI RedfishConfigHandlerDriverEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

This is the declaration of an EFI image entry point. This entry point is the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including both device drivers and bus drivers.

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 558 of file RedfishConfigHandlerDriver.c.

◆ RedfishConfigHandlerDriverUnload()

EFI_STATUS EFIAPI RedfishConfigHandlerDriverUnload ( IN EFI_HANDLE ImageHandle )

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 534 of file RedfishConfigHandlerDriver.c.

◆ RedfishConfigHandlerInstalledCallback()

VOID EFIAPI RedfishConfigHandlerInstalledCallback	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Callback function executed when a Redfish Config Handler Protocol is installed.

Parameters

[in]	Event	Event whose notification function is being invoked.
[in]	Context	Pointer to the REDFISH_CONFIG_DRIVER_DATA buffer.

Definition at line 75 of file RedfishConfigHandlerDriver.c.

◆ RedfishConfigStopRedfishDiscovery()

VOID RedfishConfigStopRedfishDiscovery ( VOID )

Stop acquiring Redfish service.

Definition at line 47 of file RedfishConfigHandlerDriver.c.

◆ RedfishDiscoverProtocolInstalled()

VOID EFIAPI RedfishDiscoverProtocolInstalled	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Callback function executed when the EFI_REDFISH_DISCOVER_PROTOCOL protocol interface is installed.

Parameters

[in]	Event	Event whose notification function is being invoked.
[in]	Context	Pointer to the Context buffer

Definition at line 433 of file RedfishConfigHandlerDriver.c.

◆ RedfishServiceDiscoveredCallback()

VOID EFIAPI RedfishServiceDiscoveredCallback	(	IN EFI_EVENT	Event,
		OUT VOID *	Context
	)

Callback function when Redfish service is discovered.

Parameters

[in]	Event	Event whose notification function is being invoked.
[out]	Context	Pointer to the Context buffer

Definition at line 304 of file RedfishConfigHandlerDriver.c.

Variable Documentation

◆ gEfiRedfishDiscoverControllerHandle

EFI_HANDLE gEfiRedfishDiscoverControllerHandle = NULL

Definition at line 21 of file RedfishConfigHandlerDriver.c.

◆ gEfiRedfishDiscoverProtocol

EFI_REDFISH_DISCOVER_PROTOCOL* gEfiRedfishDiscoverProtocol = NULL

Definition at line 22 of file RedfishConfigHandlerDriver.c.

◆ gEfiRedfishDiscoverProtocolEvent

EFI_EVENT gEfiRedfishDiscoverProtocolEvent = NULL

Definition at line 15 of file RedfishConfigHandlerDriver.c.

◆ gEfiRedfishDiscoverRegistration

VOID* gEfiRedfishDiscoverRegistration

Definition at line 20 of file RedfishConfigHandlerDriver.c.

◆ gRedfishConfigDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gRedfishConfigDriverBinding

Initial value:

= {
  RedfishConfigDriverBindingSupported,
  RedfishConfigDriverBindingStart,
  RedfishConfigDriverBindingStop,
  REDFISH_CONFIG_VERSION,
  NULL,
  NULL
}

Driver Binding Protocol instance

Definition at line 33 of file RedfishConfigHandlerDriver.c.

◆ gRedfishDiscoverActivated

BOOLEAN gRedfishDiscoverActivated = FALSE

Definition at line 23 of file RedfishConfigHandlerDriver.c.

◆ gRedfishServiceDiscovered

BOOLEAN gRedfishServiceDiscovered = FALSE

Definition at line 24 of file RedfishConfigHandlerDriver.c.

◆ mEdkIIRedfishHostInterfaceReadyEvent

EFI_EVENT mEdkIIRedfishHostInterfaceReadyEvent

Definition at line 27 of file RedfishConfigHandlerDriver.c.

◆ mEdkIIRedfishHostInterfaceRegistration

VOID* mEdkIIRedfishHostInterfaceRegistration

Definition at line 28 of file RedfishConfigHandlerDriver.c.

◆ mNetworkInterfaces

EFI_REDFISH_DISCOVER_NETWORK_INTERFACE* mNetworkInterfaces = NULL

Definition at line 25 of file RedfishConfigHandlerDriver.c.

◆ mNumberOfNetworkInterfaces

UINTN mNumberOfNetworkInterfaces

Definition at line 26 of file RedfishConfigHandlerDriver.c.

Variables
EFI_EVENT	gEfiRedfishDiscoverProtocolEvent = NULL

VOID *	gEfiRedfishDiscoverRegistration

EFI_HANDLE	gEfiRedfishDiscoverControllerHandle = NULL

EFI_REDFISH_DISCOVER_PROTOCOL *	gEfiRedfishDiscoverProtocol = NULL

BOOLEAN	gRedfishDiscoverActivated = FALSE

BOOLEAN	gRedfishServiceDiscovered = FALSE

EFI_REDFISH_DISCOVER_NETWORK_INTERFACE *	mNetworkInterfaces = NULL

UINTN	mNumberOfNetworkInterfaces

EFI_EVENT	mEdkIIRedfishHostInterfaceReadyEvent

VOID *	mEdkIIRedfishHostInterfaceRegistration

EFI_DRIVER_BINDING_PROTOCOL	gRedfishConfigDriverBinding

Functions

Variables

Detailed Description

Function Documentation

◆ AcquireRedfishServiceOnNetworkInterfaceCallback()

◆ RedfishConfigDriverBindingStart()

◆ RedfishConfigDriverBindingStop()

◆ RedfishConfigDriverBindingSupported()

◆ RedfishConfigHandlerDriverEntryPoint()

◆ RedfishConfigHandlerDriverUnload()

◆ RedfishConfigHandlerInstalledCallback()

◆ RedfishConfigStopRedfishDiscovery()

◆ RedfishDiscoverProtocolInstalled()

◆ RedfishServiceDiscoveredCallback()

Variable Documentation

◆ gEfiRedfishDiscoverControllerHandle

◆ gEfiRedfishDiscoverProtocol

◆ gEfiRedfishDiscoverProtocolEvent

◆ gEfiRedfishDiscoverRegistration

◆ gRedfishConfigDriverBinding

◆ gRedfishDiscoverActivated

◆ gRedfishServiceDiscovered

◆ mEdkIIRedfishHostInterfaceReadyEvent

◆ mEdkIIRedfishHostInterfaceRegistration

◆ mNetworkInterfaces

◆ mNumberOfNetworkInterfaces