MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / NonDiscoverablePciDeviceDxe / ComponentName.c

/** @file\r
\r
  Copyright (C) 2016, Linaro Ltd. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "NonDiscoverablePciDeviceIo.h"\r
\r
//\r
// The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and\r
// EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name\r
// in English, for display on standard console devices. This is recommended for\r
// UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's\r
// Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.\r
//\r
\r
STATIC\r
EFI_UNICODE_STRING_TABLE mDriverNameTable[] = {\r
  { "eng;en", L"PCI I/O protocol emulation driver for non-discoverable devices" },\r
  { NULL,     NULL                   }\r
};\r
\r
EFI_COMPONENT_NAME_PROTOCOL gComponentName;\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the UEFI Driver.\r
\r
  @param This           A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
  @param Language       A pointer to a three character ISO 639-2 language identifier.\r
                        This is the language of the driver name that that the caller\r
                        is requesting, and it must match one of the languages specified\r
                        in SupportedLanguages.  The number of languages supported by a\r
                        driver is up to the driver writer.\r
  @param DriverName     A pointer to the Unicode string to return.  This Unicode string\r
                        is the name of the driver specified by This in the language\r
                        specified by Language.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by This\r
                                and the language specified by Language was returned\r
                                in DriverName.\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the\r
                                language specified by Language.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
NonDiscoverablePciGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL *This,\r
  IN  CHAR8                       *Language,\r
  OUT CHAR16                      **DriverName\r
  )\r
{\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           mDriverNameTable,\r
           DriverName,\r
           (BOOLEAN)(This == &gComponentName) // Iso639Language\r
           );\r
}\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the controller\r
  that is being managed by an UEFI Driver.\r
\r
  @param This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
  @param DeviceHandle           The handle of a controller that the driver specified by\r
                                This is managing.  This handle specifies the controller\r
                                whose name is to be returned.\r
  @param ChildHandle            The handle of the child controller to retrieve the name\r
                                of.  This is an optional parameter that may be NULL.  It\r
                                will be NULL for device drivers.  It will also be NULL\r
                                for a bus drivers that wish to retrieve the name of the\r
                                bus controller.  It will not be NULL for a bus driver\r
                                that wishes to retrieve the name of a child controller.\r
  @param Language               A pointer to a three character ISO 639-2 language\r
                                identifier.  This is the language of the controller name\r
                                that that the caller is requesting, and it must match one\r
                                of the languages specified in SupportedLanguages.  The\r
                                number of languages supported by a driver is up to the\r
                                driver writer.\r
  @param ControllerName         A pointer to the Unicode string to return.  This Unicode\r
                                string is the name of the controller specified by\r
                                ControllerHandle and ChildHandle in the language\r
                                specified by Language from the point of view of the\r
                                driver specified by This.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
NonDiscoverablePciGetDeviceName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL *This,\r
  IN  EFI_HANDLE                  DeviceHandle,\r
  IN  EFI_HANDLE                  ChildHandle,\r
  IN  CHAR8                       *Language,\r
  OUT CHAR16                      **ControllerName\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
EFI_COMPONENT_NAME_PROTOCOL gComponentName = {\r
  &NonDiscoverablePciGetDriverName,\r
  &NonDiscoverablePciGetDeviceName,\r
  "eng" // SupportedLanguages, ISO 639-2 language codes\r
};\r
\r
EFI_COMPONENT_NAME2_PROTOCOL gComponentName2 = {\r
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)     &NonDiscoverablePciGetDriverName,\r
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) &NonDiscoverablePciGetDeviceName,\r
  "en" // SupportedLanguages, RFC 4646 language codes\r
};\r