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