Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org> Cc: Ruiyu Ni <ruiyu.ni@intel.com> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi <dandan.bi@intel.com> Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
		
			
				
	
	
		
			123 lines
		
	
	
		
			5.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			123 lines
		
	
	
		
			5.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /** @file
 | |
| 
 | |
|   Copyright (C) 2016, Linaro Ltd. All rights reserved.<BR>
 | |
| 
 | |
|   This program and the accompanying materials are licensed and made available
 | |
|   under the terms and conditions of the BSD License which accompanies this
 | |
|   distribution. The full text of the license may be found at
 | |
|   http://opensource.org/licenses/bsd-license.php
 | |
| 
 | |
|   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
 | |
|   WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 | |
| 
 | |
| **/
 | |
| 
 | |
| #include "NonDiscoverablePciDeviceIo.h"
 | |
| 
 | |
| //
 | |
| // The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and
 | |
| // EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name
 | |
| // in English, for display on standard console devices. This is recommended for
 | |
| // UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's
 | |
| // Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.
 | |
| //
 | |
| 
 | |
| STATIC
 | |
| EFI_UNICODE_STRING_TABLE mDriverNameTable[] = {
 | |
|   { "eng;en", L"PCI I/O protocol emulation driver for non-discoverable devices" },
 | |
|   { NULL,     NULL                   }
 | |
| };
 | |
| 
 | |
| EFI_COMPONENT_NAME_PROTOCOL gComponentName;
 | |
| 
 | |
| /**
 | |
|   Retrieves a Unicode string that is the user readable name of the UEFI Driver.
 | |
| 
 | |
|   @param This           A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
 | |
|   @param Language       A pointer to a three character ISO 639-2 language identifier.
 | |
|                         This is the language of the driver name that that the caller
 | |
|                         is requesting, and it must match one of the languages specified
 | |
|                         in SupportedLanguages.  The number of languages supported by a
 | |
|                         driver is up to the driver writer.
 | |
|   @param DriverName     A pointer to the Unicode string to return.  This Unicode string
 | |
|                         is the name of the driver specified by This in the language
 | |
|                         specified by Language.
 | |
| 
 | |
|   @retval EFI_SUCCESS           The Unicode string for the Driver specified by This
 | |
|                                 and the language specified by Language was returned
 | |
|                                 in DriverName.
 | |
|   @retval EFI_INVALID_PARAMETER Language is NULL.
 | |
|   @retval EFI_INVALID_PARAMETER DriverName is NULL.
 | |
|   @retval EFI_UNSUPPORTED       The driver specified by This does not support the
 | |
|                                 language specified by Language.
 | |
| **/
 | |
| STATIC
 | |
| EFI_STATUS
 | |
| EFIAPI
 | |
| NonDiscoverablePciGetDriverName (
 | |
|   IN  EFI_COMPONENT_NAME_PROTOCOL *This,
 | |
|   IN  CHAR8                       *Language,
 | |
|   OUT CHAR16                      **DriverName
 | |
|   )
 | |
| {
 | |
|   return LookupUnicodeString2 (
 | |
|            Language,
 | |
|            This->SupportedLanguages,
 | |
|            mDriverNameTable,
 | |
|            DriverName,
 | |
|            (BOOLEAN)(This == &gComponentName) // Iso639Language
 | |
|            );
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Retrieves a Unicode string that is the user readable name of the controller
 | |
|   that is being managed by an UEFI Driver.
 | |
| 
 | |
|   @param This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
 | |
|   @param DeviceHandle           The handle of a controller that the driver specified by
 | |
|                                 This is managing.  This handle specifies the controller
 | |
|                                 whose name is to be returned.
 | |
|   @param ChildHandle            The handle of the child controller to retrieve the name
 | |
|                                 of.  This is an optional parameter that may be NULL.  It
 | |
|                                 will be NULL for device drivers.  It will also be NULL
 | |
|                                 for a bus drivers that wish to retrieve the name of the
 | |
|                                 bus controller.  It will not be NULL for a bus driver
 | |
|                                 that wishes to retrieve the name of a child controller.
 | |
|   @param Language               A pointer to a three character ISO 639-2 language
 | |
|                                 identifier.  This is the language of the controller name
 | |
|                                 that that the caller is requesting, and it must match one
 | |
|                                 of the languages specified in SupportedLanguages.  The
 | |
|                                 number of languages supported by a driver is up to the
 | |
|                                 driver writer.
 | |
|   @param ControllerName         A pointer to the Unicode string to return.  This Unicode
 | |
|                                 string is the name of the controller specified by
 | |
|                                 ControllerHandle and ChildHandle in the language
 | |
|                                 specified by Language from the point of view of the
 | |
|                                 driver specified by This.
 | |
| **/
 | |
| STATIC
 | |
| EFI_STATUS
 | |
| EFIAPI
 | |
| NonDiscoverablePciGetDeviceName (
 | |
|   IN  EFI_COMPONENT_NAME_PROTOCOL *This,
 | |
|   IN  EFI_HANDLE                  DeviceHandle,
 | |
|   IN  EFI_HANDLE                  ChildHandle,
 | |
|   IN  CHAR8                       *Language,
 | |
|   OUT CHAR16                      **ControllerName
 | |
|   )
 | |
| {
 | |
|   return EFI_UNSUPPORTED;
 | |
| }
 | |
| 
 | |
| EFI_COMPONENT_NAME_PROTOCOL gComponentName = {
 | |
|   &NonDiscoverablePciGetDriverName,
 | |
|   &NonDiscoverablePciGetDeviceName,
 | |
|   "eng" // SupportedLanguages, ISO 639-2 language codes
 | |
| };
 | |
| 
 | |
| EFI_COMPONENT_NAME2_PROTOCOL gComponentName2 = {
 | |
|   (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)     &NonDiscoverablePciGetDriverName,
 | |
|   (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) &NonDiscoverablePciGetDeviceName,
 | |
|   "en" // SupportedLanguages, RFC 4646 language codes
 | |
| };
 |