OvmfPkg/XenPvBlkDxe/ComponentName.h

   1 /** @file
   2   Component Name functions declaration for XenPvBlk driver.
   3
   4   Copyright (C) 2014, Citrix Ltd.
   5
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 /**
  17   Retrieves a Unicode string that is the user-readable name of the EFI Driver.
  18
  19   @param  This       A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  20   @param  Language   A pointer to a three-character ISO 639-2 language identifier.
  21                      This is the language of the driver name that that the caller
  22                      is requesting, and it must match one of the languages specified
  23                      in SupportedLanguages.  The number of languages supported by a
  24                      driver is up to the driver writer.
  25   @param  DriverName A pointer to the Unicode string to return.  This Unicode string
  26                      is the name of the driver specified by This in the language
  27                      specified by Language.
  28
  29   @retval EFI_SUCCESS           The Unicode string for the Driver specified by This
  30                                 and the language specified by Language was returned
  31                                 in DriverName.
  32   @retval EFI_INVALID_PARAMETER Language is NULL.
  33   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  34   @retval EFI_UNSUPPORTED       The driver specified by This does not support the
  35                                 language specified by Language.
  36
  37 **/
  38 EFI_STATUS
  39 EFIAPI
  40 XenPvBlkDxeComponentNameGetDriverName (
  41   IN EFI_COMPONENT_NAME2_PROTOCOL  *This,
  42   IN  CHAR8                        *Language,
  43   OUT CHAR16                       **DriverName
  44   );
  45
  46 /**
  47   Retrieves a Unicode string that is the user readable name of the controller
  48   that is being managed by an EFI Driver.
  49
  50   @param  This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  51   @param  ControllerHandle The handle of a controller that the driver specified by
  52                            This is managing.  This handle specifies the controller
  53                            whose name is to be returned.
  54   @param  ChildHandle      The handle of the child controller to retrieve the name
  55                            of.  This is an optional parameter that may be NULL.  It
  56                            will be NULL for device drivers.  It will also be NULL
  57                            for a bus drivers that wish to retrieve the name of the
  58                            bus controller.  It will not be NULL for a bus driver
  59                            that wishes to retrieve the name of a child controller.
  60   @param  Language         A pointer to a three character ISO 639-2 language
  61                            identifier.  This is the language of the controller name
  62                            that the caller is requesting, and it must match one
  63                            of the languages specified in SupportedLanguages.  The
  64                            number of languages supported by a driver is up to the
  65                            driver writer.
  66   @param  ControllerName   A pointer to the Unicode string to return.  This Unicode
  67                            string is the name of the controller specified by
  68                            ControllerHandle and ChildHandle in the language specified
  69                            by Language, from the point of view of the driver specified
  70                            by This.
  71
  72   @retval EFI_SUCCESS           The Unicode string for the user-readable name in the
  73                                 language specified by Language for the driver
  74                                 specified by This was returned in DriverName.
  75   @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
  76   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
  77   @retval EFI_INVALID_PARAMETER Language is NULL.
  78   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
  79   @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing
  80                                 the controller specified by ControllerHandle and
  81                                 ChildHandle.
  82   @retval EFI_UNSUPPORTED       The driver specified by This does not support the
  83                                 language specified by Language.
  84
  85 **/
  86 EFI_STATUS
  87 EFIAPI
  88 XenPvBlkDxeComponentNameGetControllerName (
  89   IN  EFI_COMPONENT_NAME2_PROTOCOL  *This,
  90   IN  EFI_HANDLE                    ControllerHandle,
  91   IN  EFI_HANDLE                    ChildHandle        OPTIONAL,
  92   IN  CHAR8                         *Language,
  93   OUT CHAR16                        **ControllerName
  94   );