MdePkg/Include/Protocol/RestEx.h

   1 /** @file
   2   This file defines the EFI REST EX Protocol interface. It is
   3   split into the following two main sections.
   4
   5   - REST EX Service Binding Protocol
   6   - REST EX Protocol
   7
   8    Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
   9   (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
  10
  11   SPDX-License-Identifier: BSD-2-Clause-Patent
  12
  13   @par Revision Reference:
  14   This Protocol is introduced in UEFI Specification 2.8
  15
  16 **/
  17
  18 #ifndef EFI_REST_EX_PROTOCOL_H_
  19 #define EFI_REST_EX_PROTOCOL_H_
  20
  21 #include <Protocol/Http.h>
  22
  23 //
  24 // GUID definitions
  25 //
  26 #define EFI_REST_EX_SERVICE_BINDING_PROTOCOL_GUID \
  27   { \
  28     0x456bbe01, 0x99d0, 0x45ea, {0xbb, 0x5f, 0x16, 0xd8, 0x4b, 0xed, 0xc5, 0x59 } \
  29   }
  30
  31 #define EFI_REST_EX_PROTOCOL_GUID \
  32   { \
  33     0x55648b91, 0xe7d, 0x40a3, {0xa9, 0xb3, 0xa8, 0x15, 0xd7, 0xea, 0xdf, 0x97 } \
  34   }
  35
  36 typedef struct _EFI_REST_EX_PROTOCOL EFI_REST_EX_PROTOCOL;
  37
  38 // *******************************************************
  39 // EFI_REST_EX_SERVICE_INFO_VER
  40 // *******************************************************
  41 typedef struct {
  42   UINT8    Major;
  43   UINT8    Minor;
  44 } EFI_REST_EX_SERVICE_INFO_VER;
  45
  46 // *******************************************************
  47 // EFI_REST_EX_SERVICE_INFO_HEADER
  48 // *******************************************************
  49 typedef struct {
  50   UINT32                          Length;
  51   EFI_REST_EX_SERVICE_INFO_VER    RestServiceInfoVer;
  52 } EFI_REST_EX_SERVICE_INFO_HEADER;
  53
  54 // *******************************************************
  55 // EFI_REST_EX_SERVICE_TYPE
  56 // *******************************************************
  57 typedef enum {
  58   EfiRestExServiceUnspecific = 1,
  59   EfiRestExServiceRedfish,
  60   EfiRestExServiceOdata,
  61   EfiRestExServiceVendorSpecific = 0xff,
  62   EfiRestExServiceTypeMax
  63 } EFI_REST_EX_SERVICE_TYPE;
  64
  65 // *******************************************************
  66 // EFI_REST_EX_SERVICE_ACCESS_MODE
  67 // *******************************************************
  68 typedef enum {
  69   EfiRestExServiceInBandAccess    = 1,
  70   EfiRestExServiceOutOfBandAccess = 2,
  71   EfiRestExServiceModeMax
  72 } EFI_REST_EX_SERVICE_ACCESS_MODE;
  73
  74 // *******************************************************
  75 // EFI_REST_EX_CONFIG_TYPE
  76 // *******************************************************
  77 typedef enum {
  78   EfiRestExConfigHttp,
  79   EfiRestExConfigUnspecific,
  80   EfiRestExConfigTypeMax
  81 } EFI_REST_EX_CONFIG_TYPE;
  82
  83 // *******************************************************
  84 // EFI_REST_EX_SERVICE_INFO v1.0
  85 // *******************************************************
  86 typedef struct {
  87   EFI_REST_EX_SERVICE_INFO_HEADER    EfiRestExServiceInfoHeader;
  88   EFI_REST_EX_SERVICE_TYPE           RestServiceType;
  89   EFI_REST_EX_SERVICE_ACCESS_MODE    RestServiceAccessMode;
  90   EFI_GUID                           VendorRestServiceName;
  91   UINT32                             VendorSpecificDataLength;
  92   UINT8                              *VendorSpecifcData;
  93   EFI_REST_EX_CONFIG_TYPE            RestExConfigType;
  94   UINT8                              RestExConfigDataLength;
  95 } EFI_REST_EX_SERVICE_INFO_V_1_0;
  96
  97 // *******************************************************
  98 // EFI_REST_EX_SERVICE_INFO
  99 // *******************************************************
 100 typedef union {
 101   EFI_REST_EX_SERVICE_INFO_HEADER    EfiRestExServiceInfoHeader;
 102   EFI_REST_EX_SERVICE_INFO_V_1_0     EfiRestExServiceInfoV10;
 103 } EFI_REST_EX_SERVICE_INFO;
 104
 105 // *******************************************************
 106 // EFI_REST_EX_HTTP_CONFIG_DATA
 107 // *******************************************************
 108 typedef struct {
 109   EFI_HTTP_CONFIG_DATA    HttpConfigData;
 110   UINT32                  SendReceiveTimeout;
 111 } EFI_REST_EX_HTTP_CONFIG_DATA;
 112
 113 // *******************************************************
 114 // EFI_REST_EX_CONFIG_DATA
 115 // *******************************************************
 116 typedef UINT8 *EFI_REST_EX_CONFIG_DATA;
 117
 118 // *******************************************************
 119 // EFI_REST_EX_TOKEN
 120 // *******************************************************
 121 typedef struct {
 122   EFI_EVENT           Event;
 123   EFI_STATUS          Status;
 124   EFI_HTTP_MESSAGE    *ResponseMessage;
 125 } EFI_REST_EX_TOKEN;
 126
 127 /**
 128   Provides a simple HTTP-like interface to send and receive resources from a REST service.
 129
 130   The SendReceive() function sends an HTTP request to this REST service, and returns a
 131   response when the data is retrieved from the service. RequestMessage contains the HTTP
 132   request to the REST resource identified by RequestMessage.Request.Url. The
 133   ResponseMessage is the returned HTTP response for that request, including any HTTP
 134   status.
 135
 136   @param[in]  This                Pointer to EFI_REST_EX_PROTOCOL instance for a particular
 137                                   REST service.
 138   @param[in]  RequestMessage      Pointer to the HTTP request data for this resource
 139   @param[out] ResponseMessage     Pointer to the HTTP response data obtained for this requested.
 140
 141   @retval EFI_SUCCESS             operation succeeded.
 142   @retval EFI_INVALID_PARAMETER   This, RequestMessage, or ResponseMessage are NULL.
 143   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.
 144
 145 **/
 146 typedef
 147 EFI_STATUS
 148 (EFIAPI *EFI_REST_SEND_RECEIVE)(
 149   IN      EFI_REST_EX_PROTOCOL   *This,
 150   IN      EFI_HTTP_MESSAGE       *RequestMessage,
 151   OUT     EFI_HTTP_MESSAGE       *ResponseMessage
 152   );
 153
 154 /**
 155   Obtain the current time from this REST service instance.
 156
 157   The GetServiceTime() function is an optional interface to obtain the current time from
 158   this REST service instance. If this REST service does not support to retrieve the time,
 159   this function returns EFI_UNSUPPORTED. This function must returns EFI_UNSUPPORTED if
 160   EFI_REST_EX_SERVICE_TYPE returned in EFI_REST_EX_SERVICE_INFO from GetService() is
 161   EFI_REST_EX_SERVICE_UNSPECIFIC.
 162
 163   @param[in]  This                Pointer to EFI_REST_EX_PROTOCOL instance for a particular
 164                                   REST service.
 165   @param[out] Time                A pointer to storage to receive a snapshot of the current time of
 166                                   the REST service.
 167
 168   @retval EFI_SUCCESS             operation succeeded.
 169   @retval EFI_INVALID_PARAMETER   This or Time are NULL.
 170   @retval EFI_UNSUPPORTED         The RESTful service does not support returning the time.
 171   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.
 172   @retval EFI_NOT_READY           The configuration of this instance is not set yet. Configure() must
 173                                   be executed and returns successfully prior to invoke this function.
 174
 175 **/
 176 typedef
 177 EFI_STATUS
 178 (EFIAPI *EFI_REST_GET_TIME)(
 179   IN      EFI_REST_EX_PROTOCOL   *This,
 180   OUT     EFI_TIME               *Time
 181   );
 182
 183 /**
 184   This function returns the information of REST service provided by this EFI REST EX driver instance.
 185
 186   The information such as the type of REST service and the access mode of REST EX driver instance
 187   (In-band or Out-of-band) are described in EFI_REST_EX_SERVICE_INFO structure. For the vendor-specific
 188   REST service, vendor-specific REST service information is returned in VendorSpecifcData.
 189   REST EX driver designer is well know what REST service this REST EX driver instance intends to
 190   communicate with. The designer also well know this driver instance is used to talk to BMC through
 191   specific platform mechanism or talk to REST server through UEFI HTTP protocol. REST EX driver is
 192   responsible to fill up the correct information in EFI_REST_EX_SERVICE_INFO. EFI_REST_EX_SERVICE_INFO
 193   is referred by EFI REST clients to pickup the proper EFI REST EX driver instance to get and set resource.
 194   GetService() is a basic and mandatory function which must be able to use even Configure() is not invoked
 195   in previously.
 196
 197   @param[in]  This                Pointer to EFI_REST_EX_PROTOCOL instance for a particular
 198                                   REST service.
 199   @param[out] RestExServiceInfo   Pointer to receive a pointer to EFI_REST_EX_SERVICE_INFO structure. The
 200                                   format of EFI_REST_EX_SERVICE_INFO is version controlled for the future
 201                                   extension. The version of EFI_REST_EX_SERVICE_INFO structure is returned
 202                                   in the header within this structure. EFI REST client refers to the correct
 203                                   format of structure according to the version number. The pointer to
 204                                   EFI_REST_EX_SERVICE_INFO is a memory block allocated by EFI REST EX driver
 205                                   instance. That is caller's responsibility to free this memory when this
 206                                   structure is no longer needed. Refer to Related Definitions below for the
 207                                   definitions of EFI_REST_EX_SERVICE_INFO structure.
 208
 209   @retval EFI_SUCCESS             EFI_REST_EX_SERVICE_INFO is returned in RestExServiceInfo. This function
 210                                   is not supported in this REST EX Protocol driver instance.
 211   @retval EFI_UNSUPPORTED         This function is not supported in this REST EX Protocol driver instance.
 212
 213 **/
 214 typedef
 215 EFI_STATUS
 216 (EFIAPI *EFI_REST_EX_GET_SERVICE)(
 217   IN   EFI_REST_EX_PROTOCOL      *This,
 218   OUT  EFI_REST_EX_SERVICE_INFO  **RestExServiceInfo
 219   );
 220
 221 /**
 222   This function returns operational configuration of current EFI REST EX child instance.
 223
 224   This function returns the current configuration of EFI REST EX child instance. The format of
 225   operational configuration depends on the implementation of EFI REST EX driver instance. For
 226   example, HTTP-aware EFI REST EX driver instance uses EFI HTTP protocol as the undying protocol
 227   to communicate with REST service. In this case, the type of configuration is
 228   EFI_REST_EX_CONFIG_TYPE_HTTP returned from GetService(). EFI_HTTP_CONFIG_DATA is used as EFI REST
 229   EX configuration format and returned to EFI REST client. User has to type cast RestExConfigData
 230   to EFI_HTTP_CONFIG_DATA. For those non HTTP-aware REST EX driver instances, the type of configuration
 231   is EFI_REST_EX_CONFIG_TYPE_UNSPECIFIC returned from GetService(). In this case, the format of
 232   returning data could be non industrial. Instead, the format of configuration data is system/platform
 233   specific definition such as BMC mechanism used in EFI REST EX driver instance. EFI REST client and
 234   EFI REST EX driver instance have to refer to the specific system /platform spec which is out of UEFI scope.
 235
 236   @param[in]  This                This is the EFI_REST_EX_PROTOCOL instance.
 237   @param[out] RestExConfigData    Pointer to receive a pointer to EFI_REST_EX_CONFIG_DATA.
 238                                   The memory allocated for configuration data should be freed
 239                                   by caller. See Related Definitions for the details.
 240
 241   @retval EFI_SUCCESS             EFI_REST_EX_CONFIG_DATA is returned in successfully.
 242   @retval EFI_UNSUPPORTED         This function is not supported in this REST EX Protocol driver instance.
 243   @retval EFI_NOT_READY           The configuration of this instance is not set yet. Configure() must be
 244                                   executed and returns successfully prior to invoke this function.
 245
 246 **/
 247 typedef
 248 EFI_STATUS
 249 (EFIAPI *EFI_REST_EX_GET_MODE_DATA)(
 250   IN  EFI_REST_EX_PROTOCOL  *This,
 251   OUT EFI_REST_EX_CONFIG_DATA *RestExConfigData
 252   );
 253
 254 /**
 255   This function is used to configure EFI REST EX child instance.
 256
 257   This function is used to configure the setting of underlying protocol of REST EX child
 258   instance. The type of configuration is according to the implementation of EFI REST EX
 259   driver instance. For example, HTTP-aware EFI REST EX driver instance uses EFI HTTP protocol
 260   as the undying protocol to communicate with REST service. The type of configuration is
 261   EFI_REST_EX_CONFIG_TYPE_HTTP and RestExConfigData is the same format with EFI_HTTP_CONFIG_DATA.
 262   Akin to HTTP configuration, REST EX child instance can be configure to use different HTTP
 263   local access point for the data transmission. Multiple REST clients may use different
 264   configuration of HTTP to distinguish themselves, such as to use the different TCP port.
 265   For those non HTTP-aware REST EX driver instance, the type of configuration is
 266   EFI_REST_EX_CONFIG_TYPE_UNSPECIFIC. RestExConfigData refers to the non industrial standard.
 267   Instead, the format of configuration data is system/platform specific definition such as BMC.
 268   In this case, EFI REST client and EFI REST EX driver instance have to refer to the specific
 269   system/platform spec which is out of the UEFI scope. Besides GetService()function, no other
 270   EFI REST EX functions can be executed by this instance until Configure()is executed and returns
 271   successfully. All other functions must returns EFI_NOT_READY if this instance is not configured
 272   yet. Set RestExConfigData to NULL means to put EFI REST EX child instance into the unconfigured
 273   state.
 274
 275   @param[in]  This                This is the EFI_REST_EX_PROTOCOL instance.
 276   @param[in]  RestExConfigData    Pointer to EFI_REST_EX_CONFIG_DATA. See Related Definitions in
 277                                   GetModeData() protocol interface.
 278
 279   @retval EFI_SUCCESS             EFI_REST_EX_CONFIG_DATA is set in successfully.
 280   @retval EFI_DEVICE_ERROR        Configuration for this REST EX child instance is failed with the given
 281                                   EFI_REST_EX_CONFIG_DATA.
 282   @retval EFI_UNSUPPORTED         This function is not supported in this REST EX Protocol driver instance.
 283
 284 **/
 285 typedef
 286 EFI_STATUS
 287 (EFIAPI *EFI_REST_EX_CONFIGURE)(
 288   IN  EFI_REST_EX_PROTOCOL  *This,
 289   IN  EFI_REST_EX_CONFIG_DATA RestExConfigData
 290   );
 291
 292 /**
 293   This function sends REST request to REST service and signal caller's event asynchronously when
 294   the final response is received by REST EX Protocol driver instance.
 295
 296   The essential design of this function is to handle asynchronous send/receive implicitly according
 297   to REST service asynchronous request mechanism. Caller will get the notification once the response
 298   is returned from REST service.
 299
 300   @param[in]  This                  This is the EFI_REST_EX_PROTOCOL instance.
 301   @param[in]  RequestMessage        This is the HTTP request message sent to REST service. Set RequestMessage
 302                                     to NULL to cancel the previous asynchronous request associated with the
 303                                     corresponding RestExToken. See descriptions for the details.
 304   @param[in]  RestExToken           REST EX token which REST EX Protocol instance uses to notify REST client
 305                                     the status of response of asynchronous REST request. See related definition
 306                                     of EFI_REST_EX_TOKEN.
 307   @param[in]  TimeOutInMilliSeconds The pointer to the timeout in milliseconds which REST EX Protocol driver
 308                                     instance refers as the duration to drop asynchronous REST request. NULL
 309                                     pointer means no timeout for this REST request. REST EX Protocol driver
 310                                     signals caller's event with EFI_STATUS set to EFI_TIMEOUT in RestExToken
 311                                     if REST EX Protocol can't get the response from REST service within
 312                                     TimeOutInMilliSeconds.
 313
 314   @retval EFI_SUCCESS               Asynchronous REST request is established.
 315   @retval EFI_UNSUPPORTED           This REST EX Protocol driver instance doesn't support asynchronous request.
 316   @retval EFI_TIMEOUT               Asynchronous REST request is not established and timeout is expired.
 317   @retval EFI_ABORT                 Previous asynchronous REST request has been canceled.
 318   @retval EFI_DEVICE_ERROR          Otherwise, returns EFI_DEVICE_ERROR for other errors according to HTTP Status Code.
 319   @retval EFI_NOT_READY             The configuration of this instance is not set yet. Configure() must be executed
 320                                     and returns successfully prior to invoke this function.
 321
 322 **/
 323 typedef
 324 EFI_STATUS
 325 (EFIAPI *EFI_REST_EX_ASYNC_SEND_RECEIVE)(
 326   IN      EFI_REST_EX_PROTOCOL   *This,
 327   IN      EFI_HTTP_MESSAGE       *RequestMessage OPTIONAL,
 328   IN      EFI_REST_EX_TOKEN      *RestExToken,
 329   IN      UINTN                  *TimeOutInMilliSeconds OPTIONAL
 330   );
 331
 332 /**
 333   This function sends REST request to a REST Event service and signals caller's event
 334   token asynchronously when the URI resource change event is received by REST EX
 335   Protocol driver instance.
 336
 337   The essential design of this function is to monitor event implicitly according to
 338   REST service event service mechanism. Caller will get the notification if certain
 339   resource is changed.
 340
 341   @param[in]  This                  This is the EFI_REST_EX_PROTOCOL instance.
 342   @param[in]  RequestMessage        This is the HTTP request message sent to REST service. Set RequestMessage
 343                                     to NULL to cancel the previous event service associated with the corresponding
 344                                     RestExToken. See descriptions for the details.
 345   @param[in]  RestExToken           REST EX token which REST EX Protocol driver instance uses to notify REST client
 346                                     the URI resource which monitored by REST client has been changed. See the related
 347                                     definition of EFI_REST_EX_TOKEN in EFI_REST_EX_PROTOCOL.AsyncSendReceive().
 348
 349   @retval EFI_SUCCESS               Asynchronous REST request is established.
 350   @retval EFI_UNSUPPORTED           This REST EX Protocol driver instance doesn't support asynchronous request.
 351   @retval EFI_ABORT                 Previous asynchronous REST request has been canceled or event subscription has been
 352                                     delete from service.
 353   @retval EFI_DEVICE_ERROR          Otherwise, returns EFI_DEVICE_ERROR for other errors according to HTTP Status Code.
 354   @retval EFI_NOT_READY             The configuration of this instance is not set yet. Configure() must be executed
 355                                     and returns successfully prior to invoke this function.
 356
 357 **/
 358 typedef
 359 EFI_STATUS
 360 (EFIAPI *EFI_REST_EX_EVENT_SERVICE)(
 361   IN      EFI_REST_EX_PROTOCOL   *This,
 362   IN      EFI_HTTP_MESSAGE       *RequestMessage OPTIONAL,
 363   IN      EFI_REST_EX_TOKEN      *RestExToken
 364   );
 365
 366 ///
 367 /// EFI REST(EX) protocols are designed to support REST communication between EFI REST client
 368 /// applications/drivers and REST services. EFI REST client tool uses EFI REST(EX) protocols
 369 /// to send/receive resources to/from REST service to manage systems, configure systems or
 370 /// manipulate resources on REST service. Due to HTTP protocol is commonly used to communicate
 371 /// with REST service in practice, EFI REST(EX) protocols adopt HTTP as the message format to
 372 /// send and receive REST service resource. EFI REST(EX) driver instance abstracts EFI REST
 373 /// client functionality and provides underlying interface to communicate with REST service.
 374 /// EFI REST(EX) driver instance knows how to communicate with REST service through certain
 375 /// interface after the corresponding configuration is initialized.
 376 ///
 377 struct _EFI_REST_EX_PROTOCOL {
 378   EFI_REST_SEND_RECEIVE             SendReceive;
 379   EFI_REST_GET_TIME                 GetServiceTime;
 380   EFI_REST_EX_GET_SERVICE           GetService;
 381   EFI_REST_EX_GET_MODE_DATA         GetModeData;
 382   EFI_REST_EX_CONFIGURE             Configure;
 383   EFI_REST_EX_ASYNC_SEND_RECEIVE    AyncSendReceive;
 384   EFI_REST_EX_EVENT_SERVICE         EventService;
 385 };
 386
 387 extern EFI_GUID  gEfiRestExServiceBindingProtocolGuid;
 388 extern EFI_GUID  gEfiRestExProtocolGuid;
 389
 390 #endif