#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/DevicePathLib.h>
#include <Library/HttpIoLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/NetLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/RestEx.h>
#include <Protocol/ServiceBinding.h>
#include <Protocol/HttpCallback.h>
#include <Protocol/Tls.h>

Data Structures
struct	_RESTEX_SERVICE

struct	_RESTEX_INSTANCE

struct	RESTEX_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT

Macros
#define	REDFISH_RESTEX_DRIVER_VERSION 0x0100

#define	RESTEX_SERVICE_SIGNATURE SIGNATURE_32 ('R', 'E', 'S', 'S')

#define	RESTEX_INSTANCE_SIGNATURE SIGNATURE_32 ('R', 'E', 'I', 'S')

#define	RESTEX_SERVICE_FROM_THIS(a) CR (a, RESTEX_SERVICE, ServiceBinding, RESTEX_SERVICE_SIGNATURE)

#define	RESTEX_INSTANCE_FROM_THIS(a) CR (a, RESTEX_INSTANCE, RestEx, RESTEX_INSTANCE_SIGNATURE)

#define	RESTEX_INSTANCE_FROM_HTTP_CALLBACK(a) CR (a, RESTEX_INSTANCE, HttpCallbakFunction, RESTEX_INSTANCE_SIGNATURE)

#define	RESTEX_STATE_UNCONFIGED 0

#define	RESTEX_STATE_CONFIGED 1

#define	RESTEX_INSTANCE_FLAGS_TLS_RETRY 0x00000001

#define	RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY 0x00000002

Typedefs
typedef struct _RESTEX_SERVICE	RESTEX_SERVICE

typedef struct _RESTEX_INSTANCE	RESTEX_INSTANCE

Functions
EFI_STATUS EFIAPI	RedfishRestExSendReceive (IN EFI_REST_EX_PROTOCOL This, IN EFI_HTTP_MESSAGE RequestMessage, OUT EFI_HTTP_MESSAGE *ResponseMessage)

EFI_STATUS EFIAPI	RedfishRestExGetServiceTime (IN EFI_REST_EX_PROTOCOL This, OUT EFI_TIME Time)

EFI_STATUS EFIAPI	RedfishRestExGetService (IN EFI_REST_EX_PROTOCOL This, OUT EFI_REST_EX_SERVICE_INFO *RestExServiceInfo)

EFI_STATUS EFIAPI	RedfishRestExGetModeData (IN EFI_REST_EX_PROTOCOL This, OUT EFI_REST_EX_CONFIG_DATA RestExConfigData)

EFI_STATUS EFIAPI	RedfishRestExConfigure (IN EFI_REST_EX_PROTOCOL *This, IN EFI_REST_EX_CONFIG_DATA RestExConfigData)

EFI_STATUS EFIAPI	RedfishRestExAyncSendReceive (IN EFI_REST_EX_PROTOCOL This, IN EFI_HTTP_MESSAGE RequestMessage OPTIONAL, IN EFI_REST_EX_TOKEN RestExToken, IN UINTN TimeOutInMilliSeconds OPTIONAL)

EFI_STATUS EFIAPI	RedfishRestExEventService (IN EFI_REST_EX_PROTOCOL This, IN EFI_HTTP_MESSAGE RequestMessage OPTIONAL, IN EFI_REST_EX_TOKEN *RestExToken)

EFI_STATUS	ResetHttpTslSession (IN RESTEX_INSTANCE *Instance)

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_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)

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_COMPONENT_NAME_PROTOCOL	gRedfishRestExComponentName

EFI_COMPONENT_NAME2_PROTOCOL	gRedfishRestExComponentName2

EFI_UNICODE_STRING_TABLE *	gRedfishRestExControllerNameTable

EFI_DRIVER_BINDING_PROTOCOL	gRedfishRestExDriverBinding

EFI_SERVICE_BINDING_PROTOCOL	mRedfishRestExServiceBinding

EFI_REST_EX_PROTOCOL	mRedfishRestExProtocol

Detailed Description

RedfishRestExDxe support functions definitions.

Copyright (c) 2019, Intel Corporation. All rights reserved.
(C) Copyright 2020 Hewlett Packard Enterprise Development LP
Copyright (c) 2023, Ampere Computing LLC. All rights reserved.
Copyright (C) 2024 Advanced Micro Devices, Inc. All rights reserved.

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

Definition in file RedfishRestExDriver.h.

Macro Definition Documentation

◆ REDFISH_RESTEX_DRIVER_VERSION

#define REDFISH_RESTEX_DRIVER_VERSION 0x0100

Driver Version

Definition at line 62 of file RedfishRestExDriver.h.

◆ RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY

#define RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY 0x00000002

Definition at line 100 of file RedfishRestExDriver.h.

◆ RESTEX_INSTANCE_FLAGS_TLS_RETRY

#define RESTEX_INSTANCE_FLAGS_TLS_RETRY 0x00000001

Definition at line 99 of file RedfishRestExDriver.h.

◆ RESTEX_INSTANCE_FROM_HTTP_CALLBACK

#define RESTEX_INSTANCE_FROM_HTTP_CALLBACK ( a ) CR (a, RESTEX_INSTANCE, HttpCallbakFunction, RESTEX_INSTANCE_SIGNATURE)

Definition at line 73 of file RedfishRestExDriver.h.

◆ RESTEX_INSTANCE_FROM_THIS

#define RESTEX_INSTANCE_FROM_THIS ( a ) CR (a, RESTEX_INSTANCE, RestEx, RESTEX_INSTANCE_SIGNATURE)

Definition at line 70 of file RedfishRestExDriver.h.

◆ RESTEX_INSTANCE_SIGNATURE

#define RESTEX_INSTANCE_SIGNATURE SIGNATURE_32 ('R', 'E', 'I', 'S')

Definition at line 65 of file RedfishRestExDriver.h.

◆ RESTEX_SERVICE_FROM_THIS

#define RESTEX_SERVICE_FROM_THIS ( a ) CR (a, RESTEX_SERVICE, ServiceBinding, RESTEX_SERVICE_SIGNATURE)

Definition at line 67 of file RedfishRestExDriver.h.

◆ RESTEX_SERVICE_SIGNATURE

#define RESTEX_SERVICE_SIGNATURE SIGNATURE_32 ('R', 'E', 'S', 'S')

Definition at line 64 of file RedfishRestExDriver.h.

◆ RESTEX_STATE_CONFIGED

#define RESTEX_STATE_CONFIGED 1

Definition at line 77 of file RedfishRestExDriver.h.

◆ RESTEX_STATE_UNCONFIGED

#define RESTEX_STATE_UNCONFIGED 0

Definition at line 76 of file RedfishRestExDriver.h.

Typedef Documentation

◆ RESTEX_INSTANCE

typedef struct _RESTEX_INSTANCE RESTEX_INSTANCE

RestEx instance block

Definition at line 57 of file RedfishRestExDriver.h.

◆ RESTEX_SERVICE

typedef struct _RESTEX_SERVICE RESTEX_SERVICE

RestEx service block

Definition at line 52 of file RedfishRestExDriver.h.

Function Documentation

◆ RedfishRestExAyncSendReceive()

EFI_STATUS EFIAPI RedfishRestExAyncSendReceive	(	IN EFI_REST_EX_PROTOCOL *	This,
		IN EFI_HTTP_MESSAGE *RequestMessage	OPTIONAL,
		IN EFI_REST_EX_TOKEN *	RestExToken,
		IN UINTN *TimeOutInMilliSeconds	OPTIONAL
	)

This function sends REST request to REST service and signal caller's event asynchronously when the final response is received by REST EX Protocol driver instance.

The essential design of this function is to handle asynchronous send/receive implicitly according to REST service asynchronous request mechanism. Caller will get the notification once the response is returned from REST service.

Parameters

[in]	This	This is the EFI_REST_EX_PROTOCOL instance.
[in]	RequestMessage	This is the HTTP request message sent to REST service. Set RequestMessage to NULL to cancel the previous asynchronous request associated with the corresponding RestExToken. See descriptions for the details.
[in]	RestExToken	REST EX token which REST EX Protocol instance uses to notify REST client the status of response of asynchronous REST request. See related definition of EFI_REST_EX_TOKEN.
[in]	TimeOutInMilliSeconds	The pointer to the timeout in milliseconds which REST EX Protocol driver instance refers as the duration to drop asynchronous REST request. NULL pointer means no timeout for this REST request. REST EX Protocol driver signals caller's event with EFI_STATUS set to EFI_TIMEOUT in RestExToken if REST EX Protocol can't get the response from REST service within TimeOutInMilliSeconds.

Return values

EFI_SUCCESS	Asynchronous REST request is established.
EFI_UNSUPPORTED	This REST EX Protocol driver instance doesn't support asynchronous request.
EFI_TIMEOUT	Asynchronous REST request is not established and timeout is expired.
EFI_ABORT	Previous asynchronous REST request has been canceled.
EFI_DEVICE_ERROR	Otherwise, returns EFI_DEVICE_ERROR for other errors according to HTTP Status Code.
EFI_NOT_READY	The configuration of this instance is not set yet. Configure() must be executed and returns successfully prior to invoke this function.

Definition at line 750 of file RedfishRestExProtocol.c.

◆ RedfishRestExConfigure()

EFI_STATUS EFIAPI RedfishRestExConfigure	(	IN EFI_REST_EX_PROTOCOL *	This,
		IN EFI_REST_EX_CONFIG_DATA	RestExConfigData
	)

This function is used to configure EFI REST EX child instance.

This function is used to configure the setting of underlying protocol of REST EX child instance. The type of configuration is according to the implementation of EFI REST EX driver instance. For example, HTTP-aware EFI REST EX driver instance uses EFI HTTP protocol as the undying protocol to communicate with REST service. The type of configuration is EFI_REST_EX_CONFIG_TYPE_HTTP and RestExConfigData is the same format with EFI_HTTP_CONFIG_DATA. Akin to HTTP configuration, REST EX child instance can be configure to use different HTTP local access point for the data transmission. Multiple REST clients may use different configuration of HTTP to distinguish themselves, such as to use the different TCP port. For those non HTTP-aware REST EX driver instance, the type of configuration is EFI_REST_EX_CONFIG_TYPE_UNSPECIFIC. RestExConfigData refers to the non industrial standard. Instead, the format of configuration data is system/platform specific definition such as BMC. In this case, EFI REST client and EFI REST EX driver instance have to refer to the specific system/platform spec which is out of the UEFI scope. Besides GetService()function, no other EFI REST EX functions can be executed by this instance until Configure()is executed and returns successfully. All other functions must returns EFI_NOT_READY if this instance is not configured yet. Set RestExConfigData to NULL means to put EFI REST EX child instance into the unconfigured state.

Parameters

[in]	This	This is the EFI_REST_EX_PROTOCOL instance.
[in]	RestExConfigData	Pointer to EFI_REST_EX_CONFIG_DATA. See Related Definitions in GetModeData() protocol interface.

Return values

EFI_SUCCESS	EFI_REST_EX_CONFIG_DATA is set in successfully.
EFI_DEVICE_ERROR	Configuration for this REST EX child instance is failed with the given EFI_REST_EX_CONFIG_DATA.
EFI_UNSUPPORTED	This function is not supported in this REST EX Protocol driver instance.

Definition at line 629 of file RedfishRestExProtocol.c.

◆ 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.

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 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.

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 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.

◆ RedfishRestExEventService()

EFI_STATUS EFIAPI RedfishRestExEventService	(	IN EFI_REST_EX_PROTOCOL *	This,
		IN EFI_HTTP_MESSAGE *RequestMessage	OPTIONAL,
		IN EFI_REST_EX_TOKEN *	RestExToken
	)

This function sends REST request to a REST Event service and signals caller's event token asynchronously when the URI resource change event is received by REST EX Protocol driver instance.

The essential design of this function is to monitor event implicitly according to REST service event service mechanism. Caller will get the notification if certain resource is changed.

Parameters

[in]	This	This is the EFI_REST_EX_PROTOCOL instance.
[in]	RequestMessage	This is the HTTP request message sent to REST service. Set RequestMessage to NULL to cancel the previous event service associated with the corresponding RestExToken. See descriptions for the details.
[in]	RestExToken	REST EX token which REST EX Protocol driver instance uses to notify REST client the URI resource which monitored by REST client has been changed. See the related definition of EFI_REST_EX_TOKEN in EFI_REST_EX_PROTOCOL.AsyncSendReceive().

Return values

EFI_SUCCESS	Asynchronous REST request is established.
EFI_UNSUPPORTED	This REST EX Protocol driver instance doesn't support asynchronous request.
EFI_ABORT	Previous asynchronous REST request has been canceled or event subscription has been delete from service.
EFI_DEVICE_ERROR	Otherwise, returns EFI_DEVICE_ERROR for other errors according to HTTP Status Code.
EFI_NOT_READY	The configuration of this instance is not set yet. Configure() must be executed and returns successfully prior to invoke this function.

Definition at line 788 of file RedfishRestExProtocol.c.

◆ RedfishRestExGetModeData()

EFI_STATUS EFIAPI RedfishRestExGetModeData	(	IN EFI_REST_EX_PROTOCOL *	This,
		OUT EFI_REST_EX_CONFIG_DATA *	RestExConfigData
	)

This function returns operational configuration of current EFI REST EX child instance.

This function returns the current configuration of EFI REST EX child instance. The format of operational configuration depends on the implementation of EFI REST EX driver instance. For example, HTTP-aware EFI REST EX driver instance uses EFI HTTP protocol as the undying protocol to communicate with REST service. In this case, the type of configuration is EFI_REST_EX_CONFIG_TYPE_HTTP returned from GetService(). EFI_HTTP_CONFIG_DATA is used as EFI REST EX configuration format and returned to EFI REST client. User has to type cast RestExConfigData to EFI_HTTP_CONFIG_DATA. For those non HTTP-aware REST EX driver instances, the type of configuration is EFI_REST_EX_CONFIG_TYPE_UNSPECIFIC returned from GetService(). In this case, the format of returning data could be non industrial. Instead, the format of configuration data is system/platform specific definition such as BMC mechanism used in EFI REST EX driver instance. EFI REST client and EFI REST EX driver instance have to refer to the specific system /platform spec which is out of UEFI scope.

Parameters

[in]	This	This is the EFI_REST_EX_PROTOCOL instance.
[out]	RestExConfigData	Pointer to receive a pointer to EFI_REST_EX_CONFIG_DATA. The memory allocated for configuration data should be freed by caller. See Related Definitions for the details.

Return values

EFI_SUCCESS	EFI_REST_EX_CONFIG_DATA is returned in successfully.
EFI_UNSUPPORTED	This function is not supported in this REST EX Protocol driver instance.
EFI_NOT_READY	The configuration of this instance is not set yet. Configure() must be executed and returns successfully prior to invoke this function.

Definition at line 588 of file RedfishRestExProtocol.c.

◆ RedfishRestExGetService()

EFI_STATUS EFIAPI RedfishRestExGetService	(	IN EFI_REST_EX_PROTOCOL *	This,
		OUT EFI_REST_EX_SERVICE_INFO **	RestExServiceInfo
	)

This function returns the information of REST service provided by this EFI REST EX driver instance.

The information such as the type of REST service and the access mode of REST EX driver instance (In-band or Out-of-band) are described in EFI_REST_EX_SERVICE_INFO structure. For the vendor-specific REST service, vendor-specific REST service information is returned in VendorSpecifcData. REST EX driver designer is well know what REST service this REST EX driver instance intends to communicate with. The designer also well know this driver instance is used to talk to BMC through specific platform mechanism or talk to REST server through UEFI HTTP protocol. REST EX driver is responsible to fill up the correct information in EFI_REST_EX_SERVICE_INFO. EFI_REST_EX_SERVICE_INFO is referred by EFI REST clients to pickup the proper EFI REST EX driver instance to get and set resource. GetService() is a basic and mandatory function which must be able to use even Configure() is not invoked in previously.

Parameters

[in]	This	Pointer to EFI_REST_EX_PROTOCOL instance for a particular REST service.
[out]	RestExServiceInfo	Pointer to receive a pointer to EFI_REST_EX_SERVICE_INFO structure. The format of EFI_REST_EX_SERVICE_INFO is version controlled for the future extension. The version of EFI_REST_EX_SERVICE_INFO structure is returned in the header within this structure. EFI REST client refers to the correct format of structure according to the version number. The pointer to EFI_REST_EX_SERVICE_INFO is a memory block allocated by EFI REST EX driver instance. That is caller's responsibility to free this memory when this structure is no longer needed. Refer to Related Definitions below for the definitions of EFI_REST_EX_SERVICE_INFO structure.

Return values

EFI_SUCCESS	EFI_REST_EX_SERVICE_INFO is returned in RestExServiceInfo. This function is not supported in this REST EX Protocol driver instance.
EFI_UNSUPPORTED	This function is not supported in this REST EX Protocol driver instance.

Definition at line 527 of file RedfishRestExProtocol.c.

◆ RedfishRestExGetServiceTime()

EFI_STATUS EFIAPI RedfishRestExGetServiceTime	(	IN EFI_REST_EX_PROTOCOL *	This,
		OUT EFI_TIME *	Time
	)

Obtain the current time from this REST service instance.

The GetServiceTime() function is an optional interface to obtain the current time from this REST service instance. If this REST service does not support to retrieve the time, this function returns EFI_UNSUPPORTED. This function must returns EFI_UNSUPPORTED if EFI_REST_EX_SERVICE_TYPE returned in EFI_REST_EX_SERVICE_INFO from GetService() is EFI_REST_EX_SERVICE_UNSPECIFIC.

Parameters

[in]	This	Pointer to EFI_REST_EX_PROTOCOL instance for a particular REST service.
[out]	Time	A pointer to storage to receive a snapshot of the current time of the REST service.

Return values

EFI_SUCCESS	operation succeeded.
EFI_INVALID_PARAMETER	This or Time are NULL.
EFI_UNSUPPORTED	The RESTful service does not support returning the time.
EFI_DEVICE_ERROR	An unexpected system or network error occurred.
EFI_NOT_READY	The configuration of this instance is not set yet. Configure() must be executed and returns successfully prior to invoke this function.

Definition at line 486 of file RedfishRestExProtocol.c.

◆ RedfishRestExSendReceive()

EFI_STATUS EFIAPI RedfishRestExSendReceive	(	IN EFI_REST_EX_PROTOCOL *	This,
		IN EFI_HTTP_MESSAGE *	RequestMessage,
		OUT EFI_HTTP_MESSAGE *	ResponseMessage
	)

Provides a simple HTTP-like interface to send and receive resources from a REST service.

The SendReceive() function sends an HTTP request to this REST service, and returns a response when the data is retrieved from the service. RequestMessage contains the HTTP request to the REST resource identified by RequestMessage.Request.Url. The ResponseMessage is the returned HTTP response for that request, including any HTTP status.

Parameters

[in]	This	Pointer to EFI_REST_EX_PROTOCOL instance for a particular REST service.
[in]	RequestMessage	Pointer to the HTTP request data for this resource
[out]	ResponseMessage	Pointer to the HTTP response data obtained for this requested.

Return values

EFI_SUCCESS	operation succeeded.
EFI_INVALID_PARAMETER	This, RequestMessage, or ResponseMessage are NULL.
EFI_DEVICE_ERROR	An unexpected system or network error occurred.

Provides a simple HTTP-like interface to send and receive resources from a REST service.

The SendReceive() function sends an HTTP request to this REST service, and returns a response when the data is retrieved from the service. RequestMessage contains the HTTP request to the REST resource identified by RequestMessage.Request.Url. The ResponseMessage is the returned HTTP response for that request, including any HTTP status. It's caller's responsibility to free this ResponseMessage using FreePool(). RestConfigFreeHttpMessage() in RedfishLib is an example to release ResponseMessage structure.

Parameters

[in]	This	Pointer to EFI_REST_EX_PROTOCOL instance for a particular REST service.
[in]	RequestMessage	Pointer to the HTTP request data for this resource
[out]	ResponseMessage	Pointer to the HTTP response data obtained for this requested.

Return values

EFI_SUCCESS	operation succeeded.
EFI_INVALID_PARAMETER	This, RequestMessage, or ResponseMessage are NULL.
EFI_DEVICE_ERROR	An unexpected system or network error occurred.
EFI_ACCESS_DENIED	HTTP method is not allowed on this URL.
EFI_BAD_BUFFER_SIZE	The payload is to large to be handled on server side.
EFI_UNSUPPORTED	Unsupported HTTP response.

Definition at line 50 of file RedfishRestExProtocol.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_SUCCES	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

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_SUCCES	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

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.

◆ ResetHttpTslSession()

EFI_STATUS ResetHttpTslSession ( IN RESTEX_INSTANCE * Instance )

Create a new TLS session becuase the previous on is closed. status.

Parameters

[in] Instance Pointer to EFI_REST_EX_PROTOCOL instance for a particular REST service.

Return values

EFI_SUCCESS	operation succeeded.
EFI	Errors Other errors.

Create a new TLS session because the previous one is closed.

Parameters

[in] Instance Pointer to EFI_REST_EX_PROTOCOL instance for a particular REST service.

Return values

EFI_SUCCESS	operation succeeded.
EFI_ERROR	Other errors.

Definition at line 25 of file RedfishRestExImpl.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

RestExSb The RestEx service binding instance.

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.

Variable Documentation

◆ gRedfishRestExComponentName

EFI_COMPONENT_NAME_PROTOCOL gRedfishRestExComponentName

extern

Libraries classes UEFI Driver Model Protocols Protocol instances

Component Name Protocol instance

Definition at line 106 of file ComponentName.c.

◆ gRedfishRestExComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gRedfishRestExComponentName2

extern

Component Name 2 Protocol instance

Definition at line 116 of file ComponentName.c.

◆ gRedfishRestExControllerNameTable

EFI_UNICODE_STRING_TABLE* gRedfishRestExControllerNameTable

extern

Definition at line 131 of file ComponentName.c.

◆ gRedfishRestExDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gRedfishRestExDriverBinding

extern

Definition at line 16 of file RedfishRestExDriver.c.

◆ mRedfishRestExProtocol

EFI_REST_EX_PROTOCOL mRedfishRestExProtocol

extern

Definition at line 15 of file RedfishRestExProtocol.c.

◆ mRedfishRestExServiceBinding

EFI_SERVICE_BINDING_PROTOCOL mRedfishRestExServiceBinding

extern

Definition at line 25 of file RedfishRestExDriver.c.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ REDFISH_RESTEX_DRIVER_VERSION

◆ RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY

◆ RESTEX_INSTANCE_FLAGS_TLS_RETRY

◆ RESTEX_INSTANCE_FROM_HTTP_CALLBACK

◆ RESTEX_INSTANCE_FROM_THIS

◆ RESTEX_INSTANCE_SIGNATURE

◆ RESTEX_SERVICE_FROM_THIS

◆ RESTEX_SERVICE_SIGNATURE

◆ RESTEX_STATE_CONFIGED

◆ RESTEX_STATE_UNCONFIGED

Typedef Documentation

◆ RESTEX_INSTANCE

◆ RESTEX_SERVICE

Function Documentation

◆ RedfishRestExAyncSendReceive()

◆ RedfishRestExConfigure()

◆ RedfishRestExDriverBindingStart()

◆ RedfishRestExDriverBindingStop()

◆ RedfishRestExDriverBindingSupported()

◆ RedfishRestExDriverEntryPoint()

◆ RedfishRestExEventService()

◆ RedfishRestExGetModeData()

◆ RedfishRestExGetService()

◆ RedfishRestExGetServiceTime()

◆ RedfishRestExSendReceive()

◆ RedfishRestExServiceBindingCreateChild()

◆ RedfishRestExServiceBindingDestroyChild()

◆ ResetHttpTslSession()

◆ RestExCreateInstance()

◆ RestExCreateService()

◆ RestExDestroyChildEntryInHandleBuffer()

◆ RestExDestroyInstance()

◆ RestExDestroyService()

Variable Documentation

◆ gRedfishRestExComponentName

◆ gRedfishRestExComponentName2

◆ gRedfishRestExControllerNameTable

◆ gRedfishRestExDriverBinding

◆ mRedfishRestExProtocol

◆ mRedfishRestExServiceBinding