1 /** @file 2 EFI Component Name Protocol as defined in the EFI 1.1 specification. 3 This protocol is used to retrieve user readable names of EFI Drivers 4 and controllers managed by EFI Drivers. 5 6 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> 7 SPDX-License-Identifier: BSD-2-Clause-Patent 8 9 **/ 10 11 #ifndef __EFI_COMPONENT_NAME_H__ 12 #define __EFI_COMPONENT_NAME_H__ 13 14 /// 15 /// The global ID for the Component Name Protocol. 16 /// 17 #define EFI_COMPONENT_NAME_PROTOCOL_GUID \ 18 { \ 19 0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \ 20 } 21 22 typedef struct _EFI_COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME_PROTOCOL; 23 24 /** 25 Retrieves a Unicode string that is the user-readable name of the EFI Driver. 26 27 @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance. 28 @param Language A pointer to a three-character ISO 639-2 language identifier. 29 This is the language of the driver name that that the caller 30 is requesting, and it must match one of the languages specified 31 in SupportedLanguages. The number of languages supported by a 32 driver is up to the driver writer. 33 @param DriverName A pointer to the Unicode string to return. This Unicode string 34 is the name of the driver specified by This in the language 35 specified by Language. 36 37 @retval EFI_SUCCESS The Unicode string for the Driver specified by This 38 and the language specified by Language was returned 39 in DriverName. 40 @retval EFI_INVALID_PARAMETER Language is NULL. 41 @retval EFI_INVALID_PARAMETER DriverName is NULL. 42 @retval EFI_UNSUPPORTED The driver specified by This does not support the 43 language specified by Language. 44 45 **/ 46 typedef 47 EFI_STATUS 48 (EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME)( 49 IN EFI_COMPONENT_NAME_PROTOCOL *This, 50 IN CHAR8 *Language, 51 OUT CHAR16 **DriverName 52 ); 53 54 /** 55 Retrieves a Unicode string that is the user readable name of the controller 56 that is being managed by an EFI Driver. 57 58 @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance. 59 @param ControllerHandle The handle of a controller that the driver specified by 60 This is managing. This handle specifies the controller 61 whose name is to be returned. 62 @param ChildHandle The handle of the child controller to retrieve the name 63 of. This is an optional parameter that may be NULL. It 64 will be NULL for device drivers. It will also be NULL 65 for a bus drivers that wish to retrieve the name of the 66 bus controller. It will not be NULL for a bus driver 67 that wishes to retrieve the name of a child controller. 68 @param Language A pointer to a three character ISO 639-2 language 69 identifier. This is the language of the controller name 70 that the caller is requesting, and it must match one 71 of the languages specified in SupportedLanguages. The 72 number of languages supported by a driver is up to the 73 driver writer. 74 @param ControllerName A pointer to the Unicode string to return. This Unicode 75 string is the name of the controller specified by 76 ControllerHandle and ChildHandle in the language specified 77 by Language, from the point of view of the driver specified 78 by This. 79 80 @retval EFI_SUCCESS The Unicode string for the user-readable name in the 81 language specified by Language for the driver 82 specified by This was returned in DriverName. 83 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. 84 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE. 85 @retval EFI_INVALID_PARAMETER Language is NULL. 86 @retval EFI_INVALID_PARAMETER ControllerName is NULL. 87 @retval EFI_UNSUPPORTED The driver specified by This is not currently managing 88 the controller specified by ControllerHandle and 89 ChildHandle. 90 @retval EFI_UNSUPPORTED The driver specified by This does not support the 91 language specified by Language. 92 93 **/ 94 typedef 95 EFI_STATUS 96 (EFIAPI *EFI_COMPONENT_NAME_GET_CONTROLLER_NAME)( 97 IN EFI_COMPONENT_NAME_PROTOCOL *This, 98 IN EFI_HANDLE ControllerHandle, 99 IN EFI_HANDLE ChildHandle OPTIONAL, 100 IN CHAR8 *Language, 101 OUT CHAR16 **ControllerName 102 ); 103 104 /// 105 /// This protocol is used to retrieve user readable names of drivers 106 /// and controllers managed by UEFI Drivers. 107 /// 108 struct _EFI_COMPONENT_NAME_PROTOCOL { 109 EFI_COMPONENT_NAME_GET_DRIVER_NAME GetDriverName; 110 EFI_COMPONENT_NAME_GET_CONTROLLER_NAME GetControllerName; 111 /// 112 /// A Null-terminated ASCII string that contains one or more 113 /// ISO 639-2 language codes. This is the list of language codes 114 /// that this protocol supports. 115 /// 116 CHAR8 *SupportedLanguages; 117 }; 118 119 extern EFI_GUID gEfiComponentNameProtocolGuid; 120 121 #endif 122