Fix doxygen issue:

[mirror_edk2.git] / MdePkg / Include / Protocol / PlatformToDriverConfiguration.h

/** @file\r
  The file provides the protocol to retrieve configuration\r
  information for a device that a UEFI driver is about to start.\r
\r
  Copyright (c) 2006 - 2007, Intel Corporation\r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __PLATFORM_TO_DRIVER_CONFIGUARTION_H__\r
#define __PLATFORM_TO_DRIVER_CONFIGUARTION_H__\r
\r
#define EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL_GUID  \\r
  { 0x642cd590, 0x8059, 0x4c0a, { 0xa9, 0x58, 0xc5, 0xec, 0x7, 0xd2, 0x3c, 0x4b } }\r
\r
\r
typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL;\r
\r
\r
/**\r
  The UEFI driver must call Query early in the Start() function\r
  before any time consuming operations are performed. If\r
  ChildHandle is NULL the driver is requesting information from\r
  the platform about the ControllerHandle that is being started.\r
  Information returned from Query may lead to the drivers Start()\r
  function failing. If the UEFI driver is a bus driver and\r
  producing a ChildHandle the driver must call Query after the\r
  child handle has been created and an EFI_DEVICE_PATH_PROTOCOL\r
  has been placed on that handle, but before any time consuming\r
  operation is performed. If information return by Query may lead\r
  the driver to decide to not create the ChildHandle. The driver\r
  must then cleanup and remove the ChildHandle from the system.\r
  The UEFI driver repeatedly calls Query, processes the\r
  information returned by the platform, and calls Response passing\r
  in the arguments returned from Query. The Instance value passed\r
  into Response must be the same value returned from the\r
  corresponding call to Query. The UEFI driver must continuously\r
  call Query and Response until EFI_NOT_FOUND is returned by\r
  Query. The only value of Instance that has meaning to the UEFI\r
  driver is zero. An Instance value of zero means return the first\r
  ParameterBlock in the set of unprocessed parameter blocks. If a\r
  ParameterBlock has been processed via a Query and corresponding\r
  Response call it must not be returned again via a Query call.\r
\r
  @param This   A pointer to the\r
                EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL\r
                instance.\r
  \r
  @param ControllerHandle   The handle the platform will return\r
                            configuration information about.\r
  \r
  @param ChildHandle  The handle of the child controller to\r
                      return information on. This is an optional\r
                      parameter that may be NULL. It will be\r
                      NULL for device drivers, and for bus\r
                      drivers that attempt to get options for\r
                      the bus controller. It will not be NULL\r
                      for a bus driver that attempts to get\r
                      options for one of its child controllers.\r
  \r
  \r
  @param Instance   Pointer to the Instance value. On output the\r
                    instance associated with the parameter data\r
                    return. On input zero means return the first\r
                    query data or pass in a valid instance\r
                    number returned from a previous call to\r
                    Query.\r
\r
  @param ParameterTypeGuid  An EFI_GUID that defines the\r
                            contents of ParameterBlock. UEFI\r
                            drivers must use the\r
                            ParameterTypeGuid to determine how\r
                            to parser the ParameterBlock.\r
\r
  @param ParameterBlock   The platform returns a pointer to the\r
                          ParameterBlock structure which\r
                          contains details about the\r
                          configuration parameters specific to\r
                          the ParameterTypeGuid. This structure\r
                          is defined based on the protocol and\r
                          may be different for different\r
                          protocols. UEFI driver decodes this\r
                          structure and its contents based on\r
                          ProtocolGuid. ParameterBlock is\r
                          allocated by the platform and the\r
                          platform is responsible for freeing\r
                          the ParameterBlock after Result is\r
                          called.\r
\r
  @param ParameterBlockSize   The platform returns the size of\r
                              the ParameterBlock in bytes.\r
\r
\r
  @retval EFI_SUCCESS   The platform return parameter\r
                        information for ControllerHandle.\r
\r
  @retval EFI_NOT_FOUND No more unread Instance exists.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Instance is NULL.\r
\r
  @retval EFI_DEVICE_ERROR  A device error occurred while\r
                            attempting to return parameter block\r
                            information for the controller\r
                            specified by ControllerHandle and\r
                            ChildHandle.\r
\r
  @retval EFI_OUT_RESOURCES There are not enough resources\r
                            available to set the configuration\r
                            options for the controller specified\r
                            by ControllerHandle and ChildHandle.\r
\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PLATFORM_TO_DRIVER_CONFIGURATION_QUERY)(\r
  IN CONST  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL *This,\r
  IN CONST  EFI_HANDLE  ControllerHandle,\r
  IN CONST  EFI_HANDLE  ChildHandle OPTIONAL,\r
  IN OUT    UINTN       *Instance,\r
  IN OUT    EFI_GUID    **ParameterTypeGuid,\r
  IN OUT    VOID        **ParameterBlock,\r
  IN OUT    UINTN       *ParameterBlockSize\r
);\r
\r
/**\r
\r
  @param EfiPlatformConfigurationActionNone\r
          The controller specified by ControllerHandle is still\r
          in a usable state, it's configuration has been updated\r
          via parsing the ParameterBlock. If required by the\r
          parameter block and the module supports an NVRAM store\r
          the configuration information from PB was successfully\r
          saved to the NVRAM. No actions are required before\r
          this controller can be used again with the updated\r
          configuration settings.\r
\r
\r
  @param EfiPlatformConfigurationStopController \r
          The driver has detected that the controller specified\r
          by ControllerHandle  is not in a usable state, and it\r
          needs to be stopped. The calling agent can use the\r
          DisconnectControservice to perform this operation, and\r
          it should be performed as soon as possible.\r
\r
  @param EfiPlatformConfigurationRestartController\r
          This controller specified by ControllerHandle needs to\r
          be stopped and restarted before it can be used again.\r
          The calling agent can use the DisconnectController()\r
          and ConnectController() services to perform this\r
          operation. The restart operation can be delayed  until\r
          all of the configuratiooptions have been set.\r
\r
\r
  @param EfiPlatformConfigurationRestartPlatform\r
          A configuration change has been made that requires the\r
          platform to be restarted before the controller\r
          specified by ControllerHandle can be used again. The\r
          calling agent can use the ResetSystem() services to\r
          perform this operation. The restart operation can be\r
          delayed until all of the configuration options have\r
          been set.\r
\r
  @param EfiPlatformConfigurationActionNvramFailed \r
          The controller specified by ControllerHandle is still\r
          in a usable state; its configuration has been updated\r
          via parsing the ParameterBlock. The driver tried to\r
          update the driver's private NVRAM store with\r
          information from ParameterBlock and failed. No actions\r
          are required before this controller can be used again\r
          with the updated configuration settings, but these\r
          configuration settings are not guaranteed to persist\r
          after ControllerHandle is stopped.\r
\r
**/\r
typedef enum {\r
  EfiPlatformConfigurationActionNone              = 0,\r
  EfiPlatformConfigurationActionStopController    = 1,\r
  EfiPlatformConfigurationActionRestartController = 2,\r
  EfiPlatformConfigurationActionRestartPlatform   = 3,\r
  EfiPlatformConfigurationActionNvramFailed       = 4,\r
  EfiPlatformConfigurationActionMaximum\r
} EFI_PLATFORM_CONFIGURATION_ACTION;\r
\r
\r
/**\r
  The UEFI driver repeatedly calls Query, processes the\r
  information returned by the platform, and calls Response passing\r
  in the arguments returned from Query. The UEFI driver must\r
  continuously call Query until EFI_NOT_FOUND is returned. For\r
  every call to Query that returns EFI_SUCCESS a corrisponding\r
  call to Response is required passing in the same\r
  ContollerHandle, ChildHandle, Instance, ParameterTypeGuid,\r
  ParameterBlock, and ParameterBlockSize. The UEFI driver may\r
  update values in ParameterBlock based on rules defined by\r
  ParameterTypeGuid. The platform is responsible for freeing\r
  ParameterBlock and the UEFI driver must not try to free it\r
\r
  @param This   A pointer to the\r
                EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL\r
                instance.\r
\r
  @param ControllerHandle The handle the driver is returning\r
                          configuration information about.\r
\r
  @param ChildHandle  The handle of the child controller to\r
                      return information on. This is an optional\r
                      parameter that may be NULL. It will be\r
                      NULL for device drivers, and for bus\r
                      drivers that attempt to get options for\r
                      the bus controller. It will not be NULL\r
                      for a bus driver that attempts to get\r
                      options for one of its child controllers.\r
                      Instance Instance data returned from\r
                      Query().\r
\r
  @param ParameterTypeGuid ParameterTypeGuid returned from\r
                           Query.\r
\r
  @param ParameterBlock ParameterBlock returned from Query.\r
\r
  @param ParameterBlockSize The ParameterBlock size returned\r
                            from Query.\r
\r
  @param Configuration  ActionThe driver tells the platform what\r
                        action is required for ParameterBlock to\r
                        take effect.\r
  \r
  \r
  @retval EFI_SUCCESS The platform return parameter information\r
                      for ControllerHandle.\r
  \r
  @retval EFI_NOT_FOUND Instance was not found.\r
  \r
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid\r
                                EFI_HANDLE.\r
  \r
  @retval EFI_INVALID_PARAMETER Instance is zero.\r
  \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PLATFORM_TO_DRIVER_CONFIGURATION_RESPONSE)(\r
  IN CONST  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL *This,\r
  IN CONST  EFI_HANDLE  ControllerHandle,\r
  IN CONST  EFI_HANDLE  ChildHandle OPTIONAL,\r
  IN CONST  UINTN       *Instance,\r
  IN CONST  EFI_GUID    *ParameterTypeGuid,\r
  IN CONST  VOID        *ParameterBlock,\r
  IN CONST  UINTN       ParameterBlockSize ,\r
  IN CONST  EFI_PLATFORM_CONFIGURATION_ACTION ConfigurationAction\r
);\r
\r
\r
/**\r
  The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the\r
  UEFI driver to query the platform for configuration information.\r
  The UEFI driver calls Query() multiple times to get\r
  configuration information from the platform. For every call to\r
  Query() there must be a matching call to Response() so the\r
  UEFI driver can inform the platform how it used the\r
  information passed in from Query(). It's legal for a UEFI\r
  driver to use Response() to inform the platform it does not\r
  understand the data returned via Query() and thus no action was\r
  taken.\r
\r
  @param  Query   Called by the UEFI Driver Start() function to\r
                  get configuration information from the\r
                  platform.\r
  \r
  @param  Response  Called by the UEFI Driver Start() function\r
                    to let the platform know how UEFI driver\r
                    processed the data return from Query.\r
  \r
\r
**/\r
struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {\r
  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_QUERY    Query;\r
  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_RESPONSE Response;\r
};\r
\r
\r
\r
#define EFI_PLATFORM_TO_DRIVER_CONFIGURATION_CLP_GUID   \\r
  {0x345ecc0e, 0xcb6, 0x4b75, { 0xbb, 0x57, 0x1b, 0x12, 0x9c, 0x47, 0x33,0x3e } }\r
\r
/**\r
   \r
  ParameterTypeGuid provides the support for parameters\r
  communicated through the DMTF SM CLP Specification 1.0 Final\r
  Standard to be used to configure the UEFI driver. In this\r
  section the producer of the\r
  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is platform\r
  firmware and the consumer is the UEFI driver. Note: if future\r
  versions of the DMTF SM CLP Specification require changes to the\r
  parameter block definition, newer ParameterTypeGuid will be\r
  used.\r
\r
  @param CLPCommand   A pointer to the DMTF SM CLP command line\r
                      null-terminated string that the driver is\r
                      required to parse and process when this\r
                      EFI_SUCCESS The platform return parameter\r
                      information for ControllerHandle.\r
                      EFI_NOT_FOUND Instance was not found.\r
                      EFI_INVALID_PARAMETER ControllerHandle is\r
                      not a valid EFI_HANDLE.\r
                      EFI_INVALID_PARAMETER Instance is zero.\r
                      function is called. See the DMTF SM CLP\r
                      Specification 1.0 Final Standard for\r
                      details on the format and syntax of the\r
                      CLP command line string. CLPCommand buffer\r
                      is allocated by the producer of the\r
                      EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
\r
  @param CLPCommandLength   The length of the CLP Command in\r
                            bytes.\r
\r
  @param CLPReturnString  A pointer to the CLP return status\r
                          string that the driver is required to\r
                          provide to the calling agent. The\r
                          calling agent may parse and/ or pass\r
                          this for processing and user feedback.\r
                          The SM CLP Command Response string\r
                          buffer is filled in by the UEFI driver\r
                          in the "keyword=value" format\r
                          described in the SM CLP Specification,\r
                          unless otherwise requested via the SM\r
                          CLP Coutput option in the Command Line\r
                          string buffer. UEFI driver's support\r
                          for this default "keyword=value"\r
                          output format is required if the UEFI\r
                          driver supports this protocol, while\r
                          support for other SM CLP output\r
                          formats is optional (the UEFI Driver\r
                          should return an EFI_UNSUPPORTED if\r
                          the SM CLP Coutput option requested by\r
                          the caller is not supported by the\r
                          UEFI Driver). CLPReturnString buffer\r
                          is allocated by the consumer of the\r
                          EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC\r
                          OL and undefined prior to the call to\r
                          Response().\r
\r
  @param CLPReturnStringLength  The length of the CLP return\r
                                status string in bytes.\r
\r
  @param CLPReturnStatus  SM CLP Command Status (see DMTF SM CLP\r
                          Specification 1.0 Final Standard -\r
                          Table 4) CLPErrorValue SM CLP\r
                          Processing Error Value (see DMTF SM\r
                          CLP Specification 1.0 Final Standard -\r
                          Table 6). This field is filled in by\r
                          the consumer of the\r
                          EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC \r
                          OL and undefined prior to the call to\r
                          Response().\r
\r
  @param CLPMessageCode   Bit 15: OEM Message Code Flag 0 =\r
                          Message Code is an SM CLP Probable\r
                          Cause Value. (see SM CLP Specification\r
                          Table 11) 1 = Message Code is OEM\r
                          Specific Bits 14-0: Message Code This\r
                          field is filled in by the consumer of\r
                          the\r
                          EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC\r
                          OL and undefined prior to the call to\r
                          Response().\r
\r
**/\r
typedef struct {\r
  CHAR8   *CLPCommand;\r
  UINT32  CLPCommandLength;\r
  CHAR8   *CLPReturnString;\r
  UINT32  CLPReturnStringLength;\r
  UINT8   CLPCmdStatus;\r
  UINT8   CLPErrorValue;\r
  UINT16  CLPMsgCode;\r
} EFI_CONFIGURE_CLP_PARAMETER_BLK;\r
\r
\r
\r
extern EFI_GUID gEfiPlatformToDriverConfigurationClpGuid;\r
\r
extern EFI_GUID gEfiPlatformToDriverConfigurationProtocolGuid;\r
\r
#endif\r