RedfishRestExDriver.c File Reference

#include <Uefi.h>
#include "RedfishRestExDriver.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	RestExDestroyChildEntryInHandleBuffer (IN LIST_ENTRY *Entry, IN VOID *Context)
VOID	RestExDestroyInstance (IN RESTEX_INSTANCE *Instance)
EFI_STATUS	RestExCreateInstance (IN RESTEX_SERVICE *Service, OUT RESTEX_INSTANCE **Instance)
VOID	RestExDestroyService (IN RESTEX_SERVICE *RestExSb)
EFI_REST_EX_SERVICE_ACCESS_MODE	RestExServiceAccessMode (IN EFI_HANDLE Controller)
EFI_STATUS	RestExCreateService (IN EFI_HANDLE Controller, IN EFI_HANDLE Image, OUT RESTEX_SERVICE **Service)
EFI_STATUS EFIAPI	RedfishRestExDriverEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI	RedfishRestExDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
EFI_STATUS EFIAPI	RedfishRestExDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
EFI_STATUS EFIAPI	RedfishRestExDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer OPTIONAL)
VOID EFIAPI	RestExHttpCallback (IN EDKII_HTTP_CALLBACK_PROTOCOL *This, IN EDKII_HTTP_CALLBACK_EVENT Event, IN EFI_STATUS EventStatus)
EFI_STATUS EFIAPI	RedfishRestExServiceBindingCreateChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE *ChildHandle)
EFI_STATUS EFIAPI	RedfishRestExServiceBindingDestroyChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE ChildHandle)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gRedfishRestExDriverBinding
EFI_SERVICE_BINDING_PROTOCOL	mRedfishRestExServiceBinding

Detailed Description

The driver binding and service binding protocol for Redfish RestExDxe driver.

Copyright (c) 2019, Intel Corporation. All rights reserved.
(C) Copyright 2020 Hewlett Packard Enterprise Development LP
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved. Copyright (C) 2024 Advanced Micro Devices, Inc. All rights reserved.

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

Definition in file RedfishRestExDriver.c.

Function Documentation

RedfishRestExDriverBindingStart()

EFI_STATUS EFIAPI RedfishRestExDriverBindingStart	(	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.

1. ControllerHandle must be a valid EFI_HANDLE.
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL.
3. 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 device was started.
EFI_DEVICE_ERROR	The device could not be started due to a device error.Currently not implemented.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
Others	The driver failded to start the device.

Definition at line 425 of file RedfishRestExDriver.c.

RedfishRestExDriverBindingStop()

EFI_STATUS EFIAPI RedfishRestExDriverBindingStop	(	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.

1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this same driver's Start() function.
2. 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 530 of file RedfishRestExDriver.c.

RedfishRestExDriverBindingSupported()

EFI_STATUS EFIAPI RedfishRestExDriverBindingSupported	(	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_ALREADY_STARTED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
EFI_ACCESS_DENIED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by a different driver or an application that requires exclusive access. Currently not implemented.
EFI_UNSUPPORTED	The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 354 of file RedfishRestExDriver.c.

RedfishRestExDriverEntryPoint()

EFI_STATUS EFIAPI RedfishRestExDriverEntryPoint	(	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 283 of file RedfishRestExDriver.c.

RedfishRestExServiceBindingCreateChild()

EFI_STATUS EFIAPI RedfishRestExServiceBindingCreateChild	(	IN EFI_SERVICE_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE *	ChildHandle
	)

Creates a child handle and installs a protocol.

The CreateChild() function installs a protocol on ChildHandle. If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.

Parameters

[in]	This	Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
[in]	ChildHandle	Pointer to the handle of the child to create. If it is NULL, then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle.

Return values

EFI_SUCCESS	The protocol was added to ChildHandle.
EFI_INVALID_PARAMETER	ChildHandle is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources available to create the child
other	The child handle was not created

Definition at line 672 of file RedfishRestExDriver.c.

RedfishRestExServiceBindingDestroyChild()

EFI_STATUS EFIAPI RedfishRestExServiceBindingDestroyChild	(	IN EFI_SERVICE_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ChildHandle
	)

Destroys a child handle with a protocol installed on it.

The DestroyChild() function does the opposite of CreateChild(). It removes a protocol that was installed by CreateChild() from ChildHandle. If the removed protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.

Parameters

[in]	This	Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
[in]	ChildHandle	Handle of the child to destroy

Return values

EFI_SUCCESS	The protocol was removed from ChildHandle.
EFI_UNSUPPORTED	ChildHandle does not support the protocol that is being removed.
EFI_INVALID_PARAMETER	Child handle is NULL.
EFI_ACCESS_DENIED	The protocol could not be removed from the ChildHandle because its services are being used.
other	The child handle was not destroyed

Definition at line 816 of file RedfishRestExDriver.c.

RestExCreateInstance()

EFI_STATUS RestExCreateInstance	(	IN RESTEX_SERVICE *	Service,
		OUT RESTEX_INSTANCE **	Instance
	)

Create the RestEx instance and initialize it.

Parameters

[in]	Service	The pointer to the RestEx service.
[out]	Instance	The pointer to the RestEx instance.

Return values

EFI_OUT_OF_RESOURCES	Failed to allocate resources.
EFI_SUCCESS	The RestEx instance is created.

Definition at line 96 of file RedfishRestExDriver.c.

RestExCreateService()

EFI_STATUS RestExCreateService	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	Image,
		OUT RESTEX_SERVICE **	Service
	)

Create then initialize a RestEx service binding instance.

Parameters

[in]	Controller	The controller to install the RestEx service binding on.
[in]	Image	The driver binding image of the RestEx driver.
[out]	Service	The variable to receive the created service binding instance.

Return values

EFI_OUT_OF_RESOURCES	Failed to allocate resource to create the instance.
EFI_SUCCESS	The service instance is created for the controller.

Definition at line 218 of file RedfishRestExDriver.c.

RestExDestroyChildEntryInHandleBuffer()

EFI_STATUS EFIAPI RestExDestroyChildEntryInHandleBuffer	(	IN LIST_ENTRY *	Entry,
		IN VOID *	Context
	)

Callback function which provided by user to remove one node in NetDestroyLinkList process.

Parameters

[in]	Entry	The entry to be removed.
[in]	Context	Pointer to the callback context corresponds to the Context in NetDestroyLinkList.

Return values

EFI_SUCCESS	The entry has been removed successfully.
Others	Fail to remove the entry.

Definition at line 42 of file RedfishRestExDriver.c.

RestExDestroyInstance()

VOID RestExDestroyInstance

(

IN RESTEX_INSTANCE *

Instance

)

Destroy the RestEx instance and recycle the resources.

Parameters

[in]

Instance

The pointer to the RestEx instance.

Definition at line 76 of file RedfishRestExDriver.c.

RestExDestroyService()

VOID RestExDestroyService

(

IN RESTEX_SERVICE *

RestExSb

)

Release all the resource used the RestEx service binding instance.

Parameters

[in]

RestExSb

The RestEx service binding instance.

Definition at line 148 of file RedfishRestExDriver.c.

RestExHttpCallback()

VOID EFIAPI RestExHttpCallback	(	IN EDKII_HTTP_CALLBACK_PROTOCOL *	This,
		IN EDKII_HTTP_CALLBACK_EVENT	Event,
		IN EFI_STATUS	EventStatus
	)

Callback function that is invoked when HTTP event occurs.

Parameters

[in]	This	Pointer to the EDKII_HTTP_CALLBACK_PROTOCOL instance.
[in]	Event	The event that occurs in the current state.
[in]	EventStatus	The Status of Event, EFI_SUCCESS or other errors.

Definition at line 613 of file RedfishRestExDriver.c.

RestExServiceAccessMode()

EFI_REST_EX_SERVICE_ACCESS_MODE RestExServiceAccessMode

(

IN EFI_HANDLE

Controller

)

Check the NIC controller handle represents an in-band or out-of-band Redfish host interface device. If not in-band, treat it as out-of-band interface device.

Parameters

[in]

Controller

The NIC controller handle needs to be checked.

Returns

EFI_REST_EX_SERVICE_ACCESS_MODE of the device.

Definition at line 189 of file RedfishRestExDriver.c.

Variable Documentation

gRedfishRestExDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gRedfishRestExDriverBinding

Initial value:

= {
  RedfishRestExDriverBindingSupported,
  RedfishRestExDriverBindingStart,
  RedfishRestExDriverBindingStop,
  REDFISH_RESTEX_DRIVER_VERSION,
  NULL,
  NULL
}

Definition at line 16 of file RedfishRestExDriver.c.

mRedfishRestExServiceBinding

EFI_SERVICE_BINDING_PROTOCOL mRedfishRestExServiceBinding

Initial value:

= {
  RedfishRestExServiceBindingCreateChild,
  RedfishRestExServiceBindingDestroyChild
}

Definition at line 25 of file RedfishRestExDriver.c.