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 #ifndef _VIRTUAL_KEYBOARD_COMPONENT_NAME_H_ 18 #define _VIRTUAL_KEYBOARD_COMPONENT_NAME_H_ 19 20 21 extern EFI_COMPONENT_NAME_PROTOCOL gVirtualKeyboardComponentName; 22 extern EFI_COMPONENT_NAME2_PROTOCOL gVirtualKeyboardComponentName2; 23 24 // 25 // EFI Component Name Functions 26 // 27 /** 28 Retrieves a Unicode string that is the user readable name of the driver. 29 30 This function retrieves the user readable name of a driver in the form of a 31 Unicode string. If the driver specified by This has a user readable name in 32 the language specified by Language, then a pointer to the driver name is 33 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified 34 by This does not support the language specified by Language, 35 then EFI_UNSUPPORTED is returned. 36 37 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 38 EFI_COMPONENT_NAME_PROTOCOL instance. 39 40 @param Language[in] A pointer to a Null-terminated ASCII string 41 array indicating the language. This is the 42 language of the driver name that the caller is 43 requesting, and it must match one of the 44 languages specified in SupportedLanguages. The 45 number of languages supported by a driver is up 46 to the driver writer. Language is specified 47 in RFC 4646 or ISO 639-2 language code format. 48 49 @param DriverName[out] A pointer to the Unicode string to return. 50 This Unicode string is the name of the 51 driver specified by This in the language 52 specified by Language. 53 54 @retval EFI_SUCCESS The Unicode string for the Driver specified by 55 This and the language specified by Language was 56 returned in DriverName. 57 58 @retval EFI_INVALID_PARAMETER Language is NULL. 59 60 @retval EFI_INVALID_PARAMETER DriverName is NULL. 61 62 @retval EFI_UNSUPPORTED The driver specified by This does not support 63 the language specified by Language. 64 65 **/ 66 EFI_STATUS 67 EFIAPI 68 VirtualKeyboardComponentNameGetDriverName ( 69 IN EFI_COMPONENT_NAME_PROTOCOL *This, 70 IN CHAR8 *Language, 71 OUT CHAR16 **DriverName 72 ); 73 74 75 /** 76 Retrieves a Unicode string that is the user readable name of the controller 77 that is being managed by a driver. 78 79 This function retrieves the user readable name of the controller specified by 80 ControllerHandle and ChildHandle in the form of a Unicode string. If the 81 driver specified by This has a user readable name in the language specified by 82 Language, then a pointer to the controller name is returned in ControllerName, 83 and EFI_SUCCESS is returned. If the driver specified by This is not currently 84 managing the controller specified by ControllerHandle and ChildHandle, 85 then EFI_UNSUPPORTED is returned. If the driver specified by This does not 86 support the language specified by Language, then EFI_UNSUPPORTED is returned. 87 88 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 89 EFI_COMPONENT_NAME_PROTOCOL instance. 90 91 @param ControllerHandle[in] The handle of a controller that the driver 92 specified by This is managing. This handle 93 specifies the controller whose name is to be 94 returned. 95 96 @param ChildHandle[in] The handle of the child controller to retrieve 97 the name of. This is an optional parameter that 98 may be NULL. It will be NULL for device 99 drivers. It will also be NULL for a bus drivers 100 that wish to retrieve the name of the bus 101 controller. It will not be NULL for a bus 102 driver that wishes to retrieve the name of a 103 child controller. 104 105 @param Language[in] A pointer to a Null-terminated ASCII string 106 array indicating the language. This is the 107 language of the driver name that the caller is 108 requesting, and it must match one of the 109 languages specified in SupportedLanguages. The 110 number of languages supported by a driver is up 111 to the driver writer. Language is specified in 112 RFC 4646 or ISO 639-2 language code format. 113 114 @param ControllerName[out] A pointer to the Unicode string to return. 115 This Unicode string is the name of the 116 controller specified by ControllerHandle and 117 ChildHandle in the language specified by 118 Language from the point of view of the driver 119 specified by This. 120 121 @retval EFI_SUCCESS The Unicode string for the user readable name in 122 the language specified by Language for the 123 driver specified by This was returned in 124 DriverName. 125 126 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. 127 128 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid 129 EFI_HANDLE. 130 131 @retval EFI_INVALID_PARAMETER Language is NULL. 132 133 @retval EFI_INVALID_PARAMETER ControllerName is NULL. 134 135 @retval EFI_UNSUPPORTED The driver specified by This is not currently 136 managing the controller specified by 137 ControllerHandle and ChildHandle. 138 139 @retval EFI_UNSUPPORTED The driver specified by This does not support 140 the language specified by Language. 141 142 **/ 143 EFI_STATUS 144 EFIAPI 145 VirtualKeyboardComponentNameGetControllerName ( 146 IN EFI_COMPONENT_NAME_PROTOCOL *This, 147 IN EFI_HANDLE ControllerHandle, 148 IN EFI_HANDLE ChildHandle OPTIONAL, 149 IN CHAR8 *Language, 150 OUT CHAR16 **ControllerName 151 ); 152 153 154 #endif 155