NetworkPkg/HttpDxe/ComponentName.h

   1 /** @file
   2   Header file for implementation of UEFI Component Name(2) protocol.
   3
   4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __EFI_HTTP_COMPONENT_NAME_H__
  10 #define __EFI_HTTP_COMPONENT_NAME_H__
  11
  12 /**
  13   Retrieves a Unicode string that is the user-readable name of the EFI Driver.
  14
  15   @param  This       A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  16   @param  Language   A pointer to a three-character ISO 639-2 language identifier.
  17                      This is the language of the driver name that that the caller
  18                      is requesting, and it must match one of the languages specified
  19                      in SupportedLanguages.  The number of languages supported by a
  20                      driver is up to the driver writer.
  21   @param  DriverName A pointer to the Unicode string to return.  This Unicode string
  22                      is the name of the driver specified by This in the language
  23                      specified by Language.
  24
  25   @retval EFI_SUCCESS           The Unicode string for the Driver specified by This
  26                                 and the language specified by Language was returned
  27                                 in DriverName.
  28   @retval EFI_INVALID_PARAMETER Language is NULL.
  29   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  30   @retval EFI_UNSUPPORTED       The driver specified by This does not support the
  31                                 language specified by Language.
  32
  33 **/
  34 EFI_STATUS
  35 EFIAPI
  36 HttpDxeComponentNameGetDriverName (
  37   IN EFI_COMPONENT_NAME2_PROTOCOL  *This,
  38   IN  CHAR8                        *Language,
  39   OUT CHAR16                       **DriverName
  40   );
  41
  42 /**
  43   Retrieves a Unicode string that is the user readable name of the controller
  44   that is being managed by an EFI Driver.
  45
  46   @param  This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  47   @param  ControllerHandle The handle of a controller that the driver specified by
  48                            This is managing.  This handle specifies the controller
  49                            whose name is to be returned.
  50   @param  ChildHandle      The handle of the child controller to retrieve the name
  51                            of.  This is an optional parameter that may be NULL.  It
  52                            will be NULL for device drivers.  It will also be NULL
  53                            for a bus drivers that wish to retrieve the name of the
  54                            bus controller.  It will not be NULL for a bus driver
  55                            that wishes to retrieve the name of a child controller.
  56   @param  Language         A pointer to a three character ISO 639-2 language
  57                            identifier.  This is the language of the controller name
  58                            that the caller is requesting, and it must match one
  59                            of the languages specified in SupportedLanguages.  The
  60                            number of languages supported by a driver is up to the
  61                            driver writer.
  62   @param  ControllerName   A pointer to the Unicode string to return.  This Unicode
  63                            string is the name of the controller specified by
  64                            ControllerHandle and ChildHandle in the language specified
  65                            by Language, from the point of view of the driver specified
  66                            by This.
  67
  68   @retval EFI_SUCCESS           The Unicode string for the user-readable name in the
  69                                 language specified by Language for the driver
  70                                 specified by This was returned in DriverName.
  71   @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
  72   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
  73   @retval EFI_INVALID_PARAMETER Language is NULL.
  74   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
  75   @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing
  76                                 the controller specified by ControllerHandle and
  77                                 ChildHandle.
  78   @retval EFI_UNSUPPORTED       The driver specified by This does not support the
  79                                 language specified by Language.
  80
  81 **/
  82 EFI_STATUS
  83 EFIAPI
  84 HttpDxeComponentNameGetControllerName (
  85   IN  EFI_COMPONENT_NAME2_PROTOCOL  *This,
  86   IN  EFI_HANDLE                    ControllerHandle,
  87   IN  EFI_HANDLE                    ChildHandle        OPTIONAL,
  88   IN  CHAR8                         *Language,
  89   OUT CHAR16                        **ControllerName
  90   );
  91
  92 #endif