MdeModulePkg/Bus/Usb/UsbMassStorageDxe/ComponentName.c

   1  /*++
   2
   3 Copyright (c) 2004 - 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   ComponentName.c
  15
  16 Abstract:
  17
  18 --*/
  19
  20
  21 #include <PiDxe.h>
  22
  23
  24 #include <Library/UefiLib.h>
  25
  26 //
  27 // EFI Component Name Functions
  28 //
  29 EFI_STATUS
  30 EFIAPI
  31 UsbMassStorageGetDriverName (
  32   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  33   IN  CHAR8                        *Language,
  34   OUT CHAR16                       **DriverName
  35   );
  36
  37 EFI_STATUS
  38 EFIAPI
  39 UsbMassStorageGetControllerName (
  40   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  41   IN  EFI_HANDLE                   ControllerHandle,
  42   IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  43   IN  CHAR8                        *Language,
  44   OUT CHAR16                       **ControllerName
  45   );
  46
  47 //
  48 // EFI Component Name Protocol
  49 //
  50 EFI_COMPONENT_NAME_PROTOCOL gUsbMassStorageComponentName = {
  51   UsbMassStorageGetDriverName,
  52   UsbMassStorageGetControllerName,
  53   "eng"
  54 };
  55
  56 STATIC EFI_UNICODE_STRING_TABLE
  57 mUsbMassStorageDriverNameTable[] = {
  58   {"eng", L"Usb Mass Storage Driver"},
  59   {NULL,  NULL}
  60 };
  61
  62 EFI_STATUS
  63 EFIAPI
  64 UsbMassStorageGetDriverName (
  65   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  66   IN  CHAR8                        *Language,
  67   OUT CHAR16                       **DriverName
  68   )
  69 /*++
  70
  71   Routine Description:
  72     Retrieves a Unicode string that is the user readable name of the EFI Driver.
  73
  74   Arguments:
  75     This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  76     Language   - A pointer to a three character ISO 639-2 language identifier.
  77                  This is the language of the driver name that that the caller
  78                  is requesting, and it must match one of the languages specified
  79                  in SupportedLanguages.  The number of languages supported by a
  80                  driver is up to the driver writer.
  81     DriverName - A pointer to the Unicode string to return.  This Unicode string
  82                  is the name of the driver specified by This in the language
  83                  specified by Language.
  84
  85   Returns:
  86     EFI_SUCCESS           - The Unicode string for the Driver specified by This
  87                             and the language specified by Language was returned
  88                             in DriverName.
  89     EFI_INVALID_PARAMETER - Language is NULL.
  90     EFI_INVALID_PARAMETER - DriverName is NULL.
  91     EFI_UNSUPPORTED       - The driver specified by This does not support the
  92                             language specified by Language.
  93
  94 --*/
  95 {
  96   return LookupUnicodeString (
  97            Language,
  98            gUsbMassStorageComponentName.SupportedLanguages,
  99            mUsbMassStorageDriverNameTable,
 100            DriverName
 101            );
 102 }
 103
 104 EFI_STATUS
 105 EFIAPI
 106 UsbMassStorageGetControllerName (
 107   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 108   IN  EFI_HANDLE                  ControllerHandle,
 109   IN  EFI_HANDLE                  ChildHandle        OPTIONAL,
 110   IN  CHAR8                       *Language,
 111   OUT CHAR16                      **ControllerName
 112   )
 113 /*++
 114
 115   Routine Description:
 116     Retrieves a Unicode string that is the user readable name of the controller
 117     that is being managed by an EFI Driver.
 118
 119   Arguments:
 120     This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
 121     ControllerHandle - The handle of a controller that the driver specified by
 122                        This is managing.  This handle specifies the controller
 123                        whose name is to be returned.
 124     ChildHandle      - The handle of the child controller to retrieve the name
 125                        of.  This is an optional parameter that may be NULL.  It
 126                       will be NULL for device drivers.  It will also be NULL
 127                        for a bus drivers that wish to retrieve the name of the
 128                        bus controller.  It will not be NULL for a bus driver
 129                        that wishes to retrieve the name of a child controller.
 130     Language         - A pointer to a three character ISO 639-2 language
 131                        identifier.  This is the language of the controller name
 132                        that that the caller is requesting, and it must match one
 133                        of the languages specified in SupportedLanguages.  The
 134                        number of languages supported by a driver is up to the
 135                        driver writer.
 136     ControllerName   - A pointer to the Unicode string to return.  This Unicode
 137                        string is the name of the controller specified by
 138                        ControllerHandle and ChildHandle in the language specified
 139                        by Language from the point of view of the driver specified
 140                        by This.
 141
 142   Returns:
 143     EFI_UNSUPPORTED  - The driver specified by This does not support the
 144                        language specified by Language.
 145
 146 --*/
 147 {
 148   return EFI_UNSUPPORTED;
 149 }