RedfishRestExDriver.h

Go to the documentation of this file.

 
#ifndef EFI_REDFISH_RESTEX_DRIVER_H_
#define EFI_REDFISH_RESTEX_DRIVER_H_
 
#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>
 
extern EFI_COMPONENT_NAME_PROTOCOL   gRedfishRestExComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gRedfishRestExComponentName2;
extern EFI_UNICODE_STRING_TABLE      *gRedfishRestExControllerNameTable;
 
extern EFI_DRIVER_BINDING_PROTOCOL   gRedfishRestExDriverBinding;
extern EFI_SERVICE_BINDING_PROTOCOL  mRedfishRestExServiceBinding;
extern EFI_REST_EX_PROTOCOL          mRedfishRestExProtocol;
typedef struct _RESTEX_SERVICE RESTEX_SERVICE;
 
typedef struct _RESTEX_INSTANCE RESTEX_INSTANCE;
 
#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
 
struct _RESTEX_SERVICE {
  UINT32                          Signature;
  EFI_SERVICE_BINDING_PROTOCOL    ServiceBinding;
 
  UINT16                          RestExChildrenNum;
  LIST_ENTRY                      RestExChildrenList;
 
  EFI_HANDLE                      ControllerHandle;
  EFI_HANDLE                      ImageHandle;
 
  //
  // Use to establish the parent-child relationship.
  //
  EFI_HANDLE                      HttpChildHandle;
 
  UINT32                          *Id;
 
  EFI_REST_EX_SERVICE_INFO        RestExServiceInfo;
};
 
#define RESTEX_INSTANCE_FLAGS_TLS_RETRY        0x00000001
#define RESTEX_INSTANCE_FLAGS_TCP_ERROR_RETRY  0x00000002
 
struct _RESTEX_INSTANCE {
  UINT32                          Signature;
  LIST_ENTRY                      Link;
 
  EFI_REST_EX_PROTOCOL            RestEx;
 
  INTN                            State;
  BOOLEAN                         InDestroy;
 
  RESTEX_SERVICE                  *Service;
  EFI_HANDLE                      ChildHandle;
 
  EFI_REST_EX_CONFIG_DATA         ConfigData;
 
  //
  // HTTP_IO to access the HTTP service
  //
  HTTP_IO                         HttpIo;
 
  //
  // EDKII_HTTP_CALLBACK_PROTOCOL that listens to
  // HttpEventInitSession event.
  //
  EDKII_HTTP_CALLBACK_PROTOCOL    HttpCallbakFunction;
 
  UINT32                          Flags;
};
 
typedef struct {
  EFI_SERVICE_BINDING_PROTOCOL    *ServiceBinding;
  UINTN                           NumberOfChildren;
  EFI_HANDLE                      *ChildHandleBuffer;
} RESTEX_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;
 
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
  );
 
#endif