OvmfPkg/XenBusDxe/ComponentName.h

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