[mirror_edk2.git] / RedfishPkg / RedfishRestExDxe / RedfishRestExDriver.c

/** @file\r
  The driver binding and service binding protocol for Redfish RestExDxe driver.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Uefi.h>\r
#include "RedfishRestExDriver.h"\r
\r
EFI_DRIVER_BINDING_PROTOCOL  gRedfishRestExDriverBinding = {\r
  RedfishRestExDriverBindingSupported,\r
  RedfishRestExDriverBindingStart,\r
  RedfishRestExDriverBindingStop,\r
  REDFISH_RESTEX_DRIVER_VERSION,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_SERVICE_BINDING_PROTOCOL  mRedfishRestExServiceBinding = {\r
  RedfishRestExServiceBindingCreateChild,\r
  RedfishRestExServiceBindingDestroyChild\r
};\r
\r
/**\r
  Callback function which provided by user to remove one node in NetDestroyLinkList process.\r
\r
  @param[in]    Entry           The entry to be removed.\r
  @param[in]    Context         Pointer to the callback context corresponds to the Context in NetDestroyLinkList.\r
\r
  @retval EFI_SUCCESS           The entry has been removed successfully.\r
  @retval Others                Fail to remove the entry.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RestExDestroyChildEntryInHandleBuffer (\r
  IN LIST_ENTRY  *Entry,\r
  IN VOID        *Context\r
  )\r
{\r
  RESTEX_INSTANCE               *Instance;\r
  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;\r
  UINTN                         NumberOfChildren;\r
  EFI_HANDLE                    *ChildHandleBuffer;\r
\r
  if ((Entry == NULL) || (Context == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Instance          = NET_LIST_USER_STRUCT_S (Entry, RESTEX_INSTANCE, Link, RESTEX_INSTANCE_SIGNATURE);\r
  ServiceBinding    = ((RESTEX_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ServiceBinding;\r
  NumberOfChildren  = ((RESTEX_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->NumberOfChildren;\r
  ChildHandleBuffer = ((RESTEX_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ChildHandleBuffer;\r
\r
  if (!NetIsInHandleBuffer (Instance->ChildHandle, NumberOfChildren, ChildHandleBuffer)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  return ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle);\r
}\r
\r
/**\r
  Destroy the RestEx instance and recycle the resources.\r
\r
  @param[in]  Instance        The pointer to the RestEx instance.\r
\r
**/\r
VOID\r
RestExDestroyInstance (\r
  IN RESTEX_INSTANCE  *Instance\r
  )\r
{\r
  HttpIoDestroyIo (&(Instance->HttpIo));\r
\r
  FreePool (Instance);\r
}\r
\r
/**\r
  Create the RestEx instance and initialize it.\r
\r
  @param[in]  Service              The pointer to the RestEx service.\r
  @param[out] Instance             The pointer to the RestEx instance.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources.\r
  @retval EFI_SUCCESS            The RestEx instance is created.\r
\r
**/\r
EFI_STATUS\r
RestExCreateInstance (\r
  IN  RESTEX_SERVICE   *Service,\r
  OUT RESTEX_INSTANCE  **Instance\r
  )\r
{\r
  RESTEX_INSTANCE  *RestExIns;\r
  EFI_STATUS       Status;\r
\r
  *Instance = NULL;\r
  Status    = EFI_SUCCESS;\r
\r
  RestExIns = AllocateZeroPool (sizeof (RESTEX_INSTANCE));\r
  if (RestExIns == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  RestExIns->Signature = RESTEX_INSTANCE_SIGNATURE;\r
  InitializeListHead (&RestExIns->Link);\r
  RestExIns->InDestroy = FALSE;\r
  RestExIns->Service   = Service;\r
\r
  CopyMem (&RestExIns->RestEx, &mRedfishRestExProtocol, sizeof (RestExIns->RestEx));\r
\r
  //\r
  // Create a HTTP_IO to access the HTTP service.\r
  //\r
  Status = HttpIoCreateIo (\r
             RestExIns->Service->ImageHandle,\r
             RestExIns->Service->ControllerHandle,\r
             IP_VERSION_4,\r
             NULL,\r
             NULL,\r
             NULL,\r
             &(RestExIns->HttpIo)\r
             );\r
  if (EFI_ERROR (Status)) {\r
    FreePool (RestExIns);\r
    return Status;\r
  }\r
\r
  *Instance = RestExIns;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Release all the resource used the RestEx service binding instance.\r
\r
  @param[in]  RestExSb                The RestEx service binding instance.\r
\r
**/\r
VOID\r
RestExDestroyService (\r
  IN RESTEX_SERVICE  *RestExSb\r
  )\r
{\r
  if (RestExSb->HttpChildHandle != NULL) {\r
    gBS->CloseProtocol (\r
           RestExSb->HttpChildHandle,\r
           &gEfiHttpProtocolGuid,\r
           RestExSb->ImageHandle,\r
           RestExSb->ControllerHandle\r
           );\r
\r
    NetLibDestroyServiceChild (\r
      RestExSb->ControllerHandle,\r
      RestExSb->ImageHandle,\r
      &gEfiHttpServiceBindingProtocolGuid,\r
      RestExSb->HttpChildHandle\r
      );\r
\r
    RestExSb->HttpChildHandle = NULL;\r
  }\r
\r
  gBS->UninstallProtocolInterface (\r
         RestExSb->ControllerHandle,\r
         &gEfiCallerIdGuid,\r
         &RestExSb->Id\r
         );\r
\r
  FreePool (RestExSb);\r
}\r
\r
/**\r
  Check the NIC controller handle represents an in-band or out-of-band Redfish host\r
  interface device. If not in-band, treat it as out-of-band interface device.\r
\r
  @param[in]   Controller       The NIC controller handle needs to be checked.\r
\r
  @return     EFI_REST_EX_SERVICE_ACCESS_MODE of the device.\r
\r
**/\r
EFI_REST_EX_SERVICE_ACCESS_MODE\r
RestExServiceAccessMode (\r
  IN     EFI_HANDLE  Controller\r
  )\r
{\r
  //\r
  // This is EFI REST EX driver instance to connect\r
  // to Redfish service using HTTP in out of band.\r
  //\r
  if (FixedPcdGetBool (PcdRedfishRestExServiceAccessModeInBand)) {\r
    return EfiRestExServiceInBandAccess;\r
  } else {\r
    return EfiRestExServiceOutOfBandAccess;\r
  }\r
}\r
\r
/**\r
  Create then initialize a RestEx service binding instance.\r
\r
  @param[in]   Controller       The controller to install the RestEx service\r
                                binding on.\r
  @param[in]   Image            The driver binding image of the RestEx driver.\r
  @param[out]  Service          The variable to receive the created service\r
                                binding instance.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to create the instance.\r
  @retval EFI_SUCCESS           The service instance is created for the controller.\r
\r
**/\r
EFI_STATUS\r
RestExCreateService (\r
  IN     EFI_HANDLE      Controller,\r
  IN     EFI_HANDLE      Image,\r
  OUT    RESTEX_SERVICE  **Service\r
  )\r
{\r
  EFI_STATUS      Status;\r
  RESTEX_SERVICE  *RestExSb;\r
\r
  Status   = EFI_SUCCESS;\r
  RestExSb = NULL;\r
\r
  *Service = NULL;\r
\r
  RestExSb = AllocateZeroPool (sizeof (RESTEX_SERVICE));\r
  if (RestExSb == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  RestExSb->Signature = RESTEX_SERVICE_SIGNATURE;\r
\r
  RestExSb->ServiceBinding = mRedfishRestExServiceBinding;\r
\r
  RestExSb->RestExChildrenNum = 0;\r
  InitializeListHead (&RestExSb->RestExChildrenList);\r
\r
  RestExSb->ControllerHandle = Controller;\r
  RestExSb->ImageHandle      = Image;\r
\r
  RestExSb->RestExServiceInfo.EfiRestExServiceInfoV10.EfiRestExServiceInfoHeader.Length                   = sizeof (EFI_REST_EX_SERVICE_INFO);\r
  RestExSb->RestExServiceInfo.EfiRestExServiceInfoV10.EfiRestExServiceInfoHeader.RestServiceInfoVer.Major = 1;\r
  RestExSb->RestExServiceInfo.EfiRestExServiceInfoV10.EfiRestExServiceInfoHeader.RestServiceInfoVer.Minor = 0;\r
  RestExSb->RestExServiceInfo.EfiRestExServiceInfoV10.RestServiceType                                     = EfiRestExServiceRedfish;\r
  RestExSb->RestExServiceInfo.EfiRestExServiceInfoV10.RestServiceAccessMode                               = RestExServiceAccessMode (Controller);\r
  RestExSb->RestExServiceInfo.EfiRestExServiceInfoV10.RestExConfigType                                    = EfiRestExConfigHttp;\r
  RestExSb->RestExServiceInfo.EfiRestExServiceInfoV10.RestExConfigDataLength                              = sizeof (EFI_REST_EX_HTTP_CONFIG_DATA);\r
\r
  Status = gBS->InstallProtocolInterface (\r
                  &Controller,\r
                  &gEfiCallerIdGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  &RestExSb->Id\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    FreePool (RestExSb);\r
    RestExSb = NULL;\r
  }\r
\r
  *Service = RestExSb;\r
  return Status;\r
}\r
\r
/**\r
  This is the declaration of an EFI image entry point. This entry point is\r
  the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r
  both device drivers and bus drivers.\r
\r
  @param[in]   ImageHandle     The firmware allocated handle for the UEFI image.\r
  @param[in]   SystemTable     A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS          The operation completed successfully.\r
  @retval Others               An unexpected error occurred.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishRestExDriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = EFI_SUCCESS;\r
\r
  //\r
  // Install the RestEx Driver Binding Protocol.\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gRedfishRestExDriverBinding,\r
             ImageHandle,\r
             &gRedfishRestExComponentName,\r
             &gRedfishRestExComponentName2\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Tests to see if this driver supports a given controller. If a child device is provided,\r
  it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
  This function checks to see if the driver specified by This supports the device specified by\r
  ControllerHandle. Drivers will typically use the device path attached to\r
  ControllerHandle and/or the services from the bus I/O abstraction attached to\r
  ControllerHandle to determine if the driver supports ControllerHandle. This function\r
  may be called many times during platform initialization. In order to reduce boot times, the tests\r
  performed by this function must be very small, and take as little time as possible to execute. This\r
  function must not change the state of any hardware devices, and this function must be aware that the\r
  device specified by ControllerHandle may already be managed by the same driver or a\r
  different driver. This function must match its calls to AllocatePages() with FreePages(),\r
  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r
  Because ControllerHandle may have been previously started by the same driver, if a protocol is\r
  already in the opened state, then it must not be closed with CloseProtocol(). This is required\r
  to guarantee the state of ControllerHandle is not modified by this function.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to test. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This\r
                                   parameter is ignored by device drivers, and is optional for bus\r
                                   drivers. For bus drivers, if this parameter is not NULL, then\r
                                   the bus driver must determine if the bus controller specified\r
                                   by ControllerHandle and the child controller specified\r
                                   by RemainingDevicePath are both supported by this\r
                                   bus driver.\r
\r
  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
                                   RemainingDevicePath is supported by the driver specified by This.\r
  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by the driver\r
                                   specified by This.\r
  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by a different\r
                                   driver or an application that requires exclusive access.\r
                                   Currently not implemented.\r
  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                   RemainingDevicePath is not supported by the driver specified by This.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishRestExDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  //\r
  // Test for the HttpServiceBinding Protocol.\r
  //\r
  return gBS->OpenProtocol (\r
                ControllerHandle,\r
                &gEfiHttpServiceBindingProtocolGuid,\r
                NULL,\r
                This->DriverBindingHandle,\r
                ControllerHandle,\r
                EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                );\r
}\r
\r
/**\r
  Starts a device controller or a bus controller.\r
\r
  The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
  As a result, much of the error checking on the parameters to Start() has been moved into this\r
  common boot service. It is legal to call Start() from other locations,\r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE.\r
  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
     EFI_DEVICE_PATH_PROTOCOL.\r
  3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This\r
                                   parameter is ignored by device drivers, and is optional for bus\r
                                   drivers. For a bus driver, if this parameter is NULL, then handles\r
                                   for all the children of Controller are created by this driver.\r
                                   If this parameter is not NULL and the first Device Path Node is\r
                                   not the End of Device Path Node, then only the handle for the\r
                                   child device specified by the first Device Path Node of\r
                                   RemainingDevicePath is created by this driver.\r
                                   If the first Device Path Node of RemainingDevicePath is\r
                                   the End of Device Path Node, no child handle is created by this\r
                                   driver.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failded to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishRestExDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  RESTEX_SERVICE  *RestExSb;\r
  EFI_STATUS      Status;\r
  UINT32          *Id;\r
  VOID            *Interface;\r
\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiCallerIdGuid,\r
                  (VOID **)&Id,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  Status = RestExCreateService (ControllerHandle, This->DriverBindingHandle, &RestExSb);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ASSERT (RestExSb != NULL);\r
\r
  //\r
  // Create a Http child instance, but do not configure it.\r
  // This will establish the parent-child relationship.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiHttpServiceBindingProtocolGuid,\r
             &RestExSb->HttpChildHandle\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  RestExSb->HttpChildHandle,\r
                  &gEfiHttpProtocolGuid,\r
                  &Interface,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Install the RestEx ServiceBinding Protocol onto ControllerHandle.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &ControllerHandle,\r
                  &gEfiRestExServiceBindingProtocolGuid,\r
                  &RestExSb->ServiceBinding,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  RestExDestroyService (RestExSb);\r
\r
  return Status;\r
}\r
\r
/**\r
  Stops a device controller or a bus controller.\r
\r
  The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r
  As a result, much of the error checking on the parameters to Stop() has been moved\r
  into this common boot service. It is legal to call Stop() from other locations,\r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
     same driver's Start() function.\r
  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
     Start() function, and the Start() function must have called OpenProtocol() on\r
     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must\r
                                support a bus specific I/O protocol for the driver\r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishRestExDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  )\r
{\r
  EFI_SERVICE_BINDING_PROTOCOL                *ServiceBinding;\r
  RESTEX_SERVICE                              *RestExSb;\r
  EFI_HANDLE                                  NicHandle;\r
  EFI_STATUS                                  Status;\r
  LIST_ENTRY                                  *List;\r
  RESTEX_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT  Context;\r
\r
  //\r
  // RestEx driver opens HTTP child, So, Controller is a HTTP\r
  // child handle. Locate the Nic handle first. Then get the\r
  // RestEx private data back.\r
  //\r
  NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiHttpProtocolGuid);\r
  if (NicHandle == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  NicHandle,\r
                  &gEfiRestExServiceBindingProtocolGuid,\r
                  (VOID **)&ServiceBinding,\r
                  This->DriverBindingHandle,\r
                  NicHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  RestExSb = RESTEX_SERVICE_FROM_THIS (ServiceBinding);\r
\r
  if (!IsListEmpty (&RestExSb->RestExChildrenList)) {\r
    //\r
    // Destroy the RestEx child instance in ChildHandleBuffer.\r
    //\r
    List                      = &RestExSb->RestExChildrenList;\r
    Context.ServiceBinding    = ServiceBinding;\r
    Context.NumberOfChildren  = NumberOfChildren;\r
    Context.ChildHandleBuffer = ChildHandleBuffer;\r
    Status                    = NetDestroyLinkList (\r
                                  List,\r
                                  RestExDestroyChildEntryInHandleBuffer,\r
                                  &Context,\r
                                  NULL\r
                                  );\r
  }\r
\r
  if ((NumberOfChildren == 0) && IsListEmpty (&RestExSb->RestExChildrenList)) {\r
    gBS->UninstallProtocolInterface (\r
           NicHandle,\r
           &gEfiRestExServiceBindingProtocolGuid,\r
           ServiceBinding\r
           );\r
\r
    RestExDestroyService (RestExSb);\r
\r
    if (gRedfishRestExControllerNameTable != NULL) {\r
      FreeUnicodeStringTable (gRedfishRestExControllerNameTable);\r
      gRedfishRestExControllerNameTable = NULL;\r
    }\r
\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Creates a child handle and installs a protocol.\r
\r
  The CreateChild() function installs a protocol on ChildHandle.\r
  If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.\r
  If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
  @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
                         then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                         then the protocol is added to the existing UEFI handle.\r
\r
  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
  @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                the child\r
  @retval other                 The child handle was not created\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishRestExServiceBindingCreateChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    *ChildHandle\r
  )\r
{\r
  RESTEX_SERVICE   *RestExSb;\r
  RESTEX_INSTANCE  *Instance;\r
  EFI_STATUS       Status;\r
  EFI_TPL          OldTpl;\r
  VOID             *Http;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  RestExSb = RESTEX_SERVICE_FROM_THIS (This);\r
\r
  Status = RestExCreateInstance (RestExSb, &Instance);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ASSERT (Instance != NULL);\r
\r
  //\r
  // Install the RestEx protocol onto ChildHandle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiRestExProtocolGuid,\r
                  &Instance->RestEx,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Instance->ChildHandle = *ChildHandle;\r
\r
  //\r
  // Open the Http protocol BY_CHILD.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  RestExSb->HttpChildHandle,\r
                  &gEfiHttpProtocolGuid,\r
                  (VOID **)&Http,\r
                  gRedfishRestExDriverBinding.DriverBindingHandle,\r
                  Instance->ChildHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           Instance->ChildHandle,\r
           &gEfiRestExProtocolGuid,\r
           &Instance->RestEx,\r
           NULL\r
           );\r
\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Open the Http protocol by child.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Instance->HttpIo.Handle,\r
                  &gEfiHttpProtocolGuid,\r
                  (VOID **)&Http,\r
                  gRedfishRestExDriverBinding.DriverBindingHandle,\r
                  Instance->ChildHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Close the Http protocol.\r
    //\r
    gBS->CloseProtocol (\r
           RestExSb->HttpChildHandle,\r
           &gEfiHttpProtocolGuid,\r
           gRedfishRestExDriverBinding.DriverBindingHandle,\r
           ChildHandle\r
           );\r
\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           Instance->ChildHandle,\r
           &gEfiRestExProtocolGuid,\r
           &Instance->RestEx,\r
           NULL\r
           );\r
\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Add it to the parent's child list.\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  InsertTailList (&RestExSb->RestExChildrenList, &Instance->Link);\r
  RestExSb->RestExChildrenNum++;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
\r
  RestExDestroyInstance (Instance);\r
  return Status;\r
}\r
\r
/**\r
  Destroys a child handle with a protocol installed on it.\r
\r
  The DestroyChild() function does the opposite of CreateChild(). It removes a protocol\r
  that was installed by CreateChild() from ChildHandle. If the removed protocol is the\r
  last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
  @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in] ChildHandle Handle of the child to destroy\r
\r
  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
  @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
  @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
  @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
                                because its services are being used.\r
  @retval other                 The child handle was not destroyed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedfishRestExServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    ChildHandle\r
  )\r
{\r
  RESTEX_SERVICE   *RestExSb;\r
  RESTEX_INSTANCE  *Instance;\r
\r
  EFI_REST_EX_PROTOCOL  *RestEx;\r
  EFI_STATUS            Status;\r
  EFI_TPL               OldTpl;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Retrieve the private context data structures\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ChildHandle,\r
                  &gEfiRestExProtocolGuid,\r
                  (VOID **)&RestEx,\r
                  NULL,\r
                  NULL,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Instance = RESTEX_INSTANCE_FROM_THIS (RestEx);\r
  RestExSb = RESTEX_SERVICE_FROM_THIS (This);\r
\r
  if (Instance->Service != RestExSb) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (Instance->InDestroy) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  Instance->InDestroy = TRUE;\r
\r
  //\r
  // Close the Http protocol.\r
  //\r
  gBS->CloseProtocol (\r
         RestExSb->HttpChildHandle,\r
         &gEfiHttpProtocolGuid,\r
         gRedfishRestExDriverBinding.DriverBindingHandle,\r
         ChildHandle\r
         );\r
\r
  gBS->CloseProtocol (\r
         Instance->HttpIo.Handle,\r
         &gEfiHttpProtocolGuid,\r
         gRedfishRestExDriverBinding.DriverBindingHandle,\r
         ChildHandle\r
         );\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  //\r
  // Uninstall the RestEx protocol first to enable a top down destruction.\r
  //\r
  Status = gBS->UninstallProtocolInterface (\r
                  ChildHandle,\r
                  &gEfiRestExProtocolGuid,\r
                  RestEx\r
                  );\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  if (EFI_ERROR (Status)) {\r
    Instance->InDestroy = FALSE;\r
    gBS->RestoreTPL (OldTpl);\r
    return Status;\r
  }\r
\r
  RemoveEntryList (&Instance->Link);\r
  RestExSb->RestExChildrenNum--;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  RestExDestroyInstance (Instance);\r
  return EFI_SUCCESS;\r
}\r