1 /** @file 2 3 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR> 4 Copyright (c) 2017, Linaro Ltd. All rights reserved.<BR> 5 6 This program and the accompanying materials 7 are licensed and made available under the terms and conditions 8 of the BSD License which accompanies this distribution. The 9 full text of the license may be found at 10 http://opensource.org/licenses/bsd-license.php 11 12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 14 15 **/ 16 17 #include "VirtualKeyboard.h" 18 19 // 20 // EFI Component Name Protocol 21 // 22 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gVirtualKeyboardComponentName = { 23 VirtualKeyboardComponentNameGetDriverName, 24 VirtualKeyboardComponentNameGetControllerName, 25 "eng" 26 }; 27 28 // 29 // EFI Component Name 2 Protocol 30 // 31 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gVirtualKeyboardComponentName2 = { 32 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) VirtualKeyboardComponentNameGetDriverName, 33 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) VirtualKeyboardComponentNameGetControllerName, 34 "en" 35 }; 36 37 38 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mVirtualKeyboardDriverNameTable[] = { 39 { 40 "eng;en", 41 L"RAM Keyboard Driver" 42 }, 43 { 44 NULL, 45 NULL 46 } 47 }; 48 49 /** 50 Retrieves a Unicode string that is the user readable name of the driver. 51 52 This function retrieves the user readable name of a driver in the form of a 53 Unicode string. If the driver specified by This has a user readable name in 54 the language specified by Language, then a pointer to the driver name is 55 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified 56 by This does not support the language specified by Language, 57 then EFI_UNSUPPORTED is returned. 58 59 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 60 EFI_COMPONENT_NAME_PROTOCOL instance. 61 62 @param Language[in] A pointer to a Null-terminated ASCII string 63 array indicating the language. This is the 64 language of the driver name that the caller is 65 requesting, and it must match one of the 66 languages specified in SupportedLanguages. The 67 number of languages supported by a driver is up 68 to the driver writer. Language is specified 69 in RFC 4646 or ISO 639-2 language code format. 70 71 @param DriverName[out] A pointer to the Unicode string to return. 72 This Unicode string is the name of the 73 driver specified by This in the language 74 specified by Language. 75 76 @retval EFI_SUCCESS The Unicode string for the Driver specified by 77 This and the language specified by Language was 78 returned in DriverName. 79 80 @retval EFI_INVALID_PARAMETER Language is NULL. 81 82 @retval EFI_INVALID_PARAMETER DriverName is NULL. 83 84 @retval EFI_UNSUPPORTED The driver specified by This does not support 85 the language specified by Language. 86 87 **/ 88 EFI_STATUS 89 EFIAPI 90 VirtualKeyboardComponentNameGetDriverName ( 91 IN EFI_COMPONENT_NAME_PROTOCOL *This, 92 IN CHAR8 *Language, 93 OUT CHAR16 **DriverName 94 ) 95 { 96 return LookupUnicodeString2 ( 97 Language, 98 This->SupportedLanguages, 99 mVirtualKeyboardDriverNameTable, 100 DriverName, 101 (BOOLEAN)(This == &gVirtualKeyboardComponentName) 102 ); 103 } 104 105 /** 106 Retrieves a Unicode string that is the user readable name of the controller 107 that is being managed by a driver. 108 109 This function retrieves the user readable name of the controller specified by 110 ControllerHandle and ChildHandle in the form of a Unicode string. If the 111 driver specified by This has a user readable name in the language specified by 112 Language, then a pointer to the controller name is returned in ControllerName, 113 and EFI_SUCCESS is returned. If the driver specified by This is not currently 114 managing the controller specified by ControllerHandle and ChildHandle, 115 then EFI_UNSUPPORTED is returned. If the driver specified by This does not 116 support the language specified by Language, then EFI_UNSUPPORTED is returned. 117 118 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 119 EFI_COMPONENT_NAME_PROTOCOL instance. 120 121 @param ControllerHandle[in] The handle of a controller that the driver 122 specified by This is managing. This handle 123 specifies the controller whose name is to be 124 returned. 125 126 @param ChildHandle[in] The handle of the child controller to retrieve 127 the name of. This is an optional parameter that 128 may be NULL. It will be NULL for device 129 drivers. It will also be NULL for a bus drivers 130 that wish to retrieve the name of the bus 131 controller. It will not be NULL for a bus 132 driver that wishes to retrieve the name of a 133 child controller. 134 135 @param Language[in] A pointer to a Null-terminated ASCII string 136 array indicating the language. This is the 137 language of the driver name that the caller is 138 requesting, and it must match one of the 139 languages specified in SupportedLanguages. The 140 number of languages supported by a driver is up 141 to the driver writer. Language is specified in 142 RFC 4646 or ISO 639-2 language code format. 143 144 @param ControllerName[out] A pointer to the Unicode string to return. 145 This Unicode string is the name of the 146 controller specified by ControllerHandle and 147 ChildHandle in the language specified by 148 Language from the point of view of the driver 149 specified by This. 150 151 @retval EFI_SUCCESS The Unicode string for the user readable name in 152 the language specified by Language for the 153 driver specified by This was returned in 154 DriverName. 155 156 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. 157 158 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid 159 EFI_HANDLE. 160 161 @retval EFI_INVALID_PARAMETER Language is NULL. 162 163 @retval EFI_INVALID_PARAMETER ControllerName is NULL. 164 165 @retval EFI_UNSUPPORTED The driver specified by This is not currently 166 managing the controller specified by 167 ControllerHandle and ChildHandle. 168 169 @retval EFI_UNSUPPORTED The driver specified by This does not support 170 the language specified by Language. 171 172 **/ 173 EFI_STATUS 174 EFIAPI 175 VirtualKeyboardComponentNameGetControllerName ( 176 IN EFI_COMPONENT_NAME_PROTOCOL *This, 177 IN EFI_HANDLE ControllerHandle, 178 IN EFI_HANDLE ChildHandle OPTIONAL, 179 IN CHAR8 *Language, 180 OUT CHAR16 **ControllerName 181 ) 182 { 183 return EFI_UNSUPPORTED; 184 } 185
