]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Bus/Usb/UsbMassStorageDxe/ComponentName.c
Change the ASSERT condition from “ASSERT (RowInfoArraySize == 1);” to “ASSERT (RowInf...
[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMassStorageDxe / ComponentName.c
CommitLineData
fb0b259e 1/** @file\r
2 UEFI Component Name(2) protocol implementation.\r
e237e7ae 3\r
4Copyright (c) 2004 - 2007, Intel Corporation\r
5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13Module Name:\r
14\r
15 ComponentName.c\r
16\r
17Abstract:\r
18\r
fb0b259e 19\r
20**/\r
e237e7ae 21\r
ed7748fe 22\r
e237e7ae 23#include <PiDxe.h>\r
24\r
ed7748fe 25\r
e237e7ae 26#include <Library/UefiLib.h>\r
27\r
28//\r
29// EFI Component Name Functions\r
30//\r
62b9bb55 31/**\r
32 Retrieves a Unicode string that is the user readable name of the driver.\r
33\r
34 This function retrieves the user readable name of a driver in the form of a\r
35 Unicode string. If the driver specified by This has a user readable name in\r
36 the language specified by Language, then a pointer to the driver name is\r
37 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
38 by This does not support the language specified by Language,\r
39 then EFI_UNSUPPORTED is returned.\r
40\r
41 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
42 EFI_COMPONENT_NAME_PROTOCOL instance.\r
43\r
44 @param Language[in] A pointer to a Null-terminated ASCII string\r
45 array indicating the language. This is the\r
46 language of the driver name that the caller is\r
47 requesting, and it must match one of the\r
48 languages specified in SupportedLanguages. The\r
49 number of languages supported by a driver is up\r
50 to the driver writer. Language is specified\r
51 in RFC 3066 or ISO 639-2 language code format.\r
52\r
53 @param DriverName[out] A pointer to the Unicode string to return.\r
54 This Unicode string is the name of the\r
55 driver specified by This in the language\r
56 specified by Language.\r
57\r
58 @retval EFI_SUCCESS The Unicode string for the Driver specified by\r
59 This and the language specified by Language was\r
60 returned in DriverName.\r
61\r
62 @retval EFI_INVALID_PARAMETER Language is NULL.\r
63\r
64 @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
65\r
66 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
67 the language specified by Language.\r
68\r
69**/\r
e237e7ae 70EFI_STATUS\r
71EFIAPI\r
72UsbMassStorageGetDriverName (\r
73 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
74 IN CHAR8 *Language,\r
75 OUT CHAR16 **DriverName\r
76 );\r
77\r
62b9bb55 78\r
79/**\r
80 Retrieves a Unicode string that is the user readable name of the controller\r
81 that is being managed by a driver.\r
82\r
83 This function retrieves the user readable name of the controller specified by\r
84 ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
85 driver specified by This has a user readable name in the language specified by\r
86 Language, then a pointer to the controller name is returned in ControllerName,\r
87 and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
88 managing the controller specified by ControllerHandle and ChildHandle,\r
89 then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
90 support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
91\r
92 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
93 EFI_COMPONENT_NAME_PROTOCOL instance.\r
94\r
95 @param ControllerHandle[in] The handle of a controller that the driver\r
96 specified by This is managing. This handle\r
97 specifies the controller whose name is to be\r
98 returned.\r
99\r
100 @param ChildHandle[in] The handle of the child controller to retrieve\r
101 the name of. This is an optional parameter that\r
102 may be NULL. It will be NULL for device\r
103 drivers. It will also be NULL for a bus drivers\r
104 that wish to retrieve the name of the bus\r
105 controller. It will not be NULL for a bus\r
106 driver that wishes to retrieve the name of a\r
107 child controller.\r
108\r
109 @param Language[in] A pointer to a Null-terminated ASCII string\r
110 array indicating the language. This is the\r
111 language of the driver name that the caller is\r
112 requesting, and it must match one of the\r
113 languages specified in SupportedLanguages. The\r
114 number of languages supported by a driver is up\r
115 to the driver writer. Language is specified in\r
116 RFC 3066 or ISO 639-2 language code format.\r
117\r
118 @param ControllerName[out] A pointer to the Unicode string to return.\r
119 This Unicode string is the name of the\r
120 controller specified by ControllerHandle and\r
121 ChildHandle in the language specified by\r
122 Language from the point of view of the driver\r
123 specified by This.\r
124\r
125 @retval EFI_SUCCESS The Unicode string for the user readable name in\r
126 the language specified by Language for the\r
127 driver specified by This was returned in\r
128 DriverName.\r
129\r
130 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
131\r
132 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
133 EFI_HANDLE.\r
134\r
135 @retval EFI_INVALID_PARAMETER Language is NULL.\r
136\r
137 @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
138\r
139 @retval EFI_UNSUPPORTED The driver specified by This is not currently\r
140 managing the controller specified by\r
141 ControllerHandle and ChildHandle.\r
142\r
143 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
144 the language specified by Language.\r
145\r
146**/\r
e237e7ae 147EFI_STATUS\r
148EFIAPI\r
149UsbMassStorageGetControllerName (\r
62b9bb55 150 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
151 IN EFI_HANDLE ControllerHandle,\r
152 IN EFI_HANDLE ChildHandle OPTIONAL,\r
153 IN CHAR8 *Language,\r
154 OUT CHAR16 **ControllerName\r
e237e7ae 155 );\r
156\r
62b9bb55 157\r
e237e7ae 158//\r
159// EFI Component Name Protocol\r
160//\r
1307dcd7 161GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUsbMassStorageComponentName = {\r
e237e7ae 162 UsbMassStorageGetDriverName,\r
163 UsbMassStorageGetControllerName,\r
164 "eng"\r
1307dcd7 165};\r
62b9bb55 166\r
167//\r
168// EFI Component Name 2 Protocol\r
169//\r
1307dcd7 170GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUsbMassStorageComponentName2 = {\r
62b9bb55 171 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) UsbMassStorageGetDriverName,\r
172 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) UsbMassStorageGetControllerName,\r
173 "en"\r
1307dcd7 174};\r
62b9bb55 175\r
e237e7ae 176\r
d1aeb0bd 177GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE\r
e237e7ae 178mUsbMassStorageDriverNameTable[] = {\r
62b9bb55 179 {"eng;en", L"Usb Mass Storage Driver"},\r
e237e7ae 180 {NULL, NULL}\r
181};\r
182\r
62b9bb55 183/**\r
184 Retrieves a Unicode string that is the user readable name of the driver.\r
185\r
186 This function retrieves the user readable name of a driver in the form of a\r
187 Unicode string. If the driver specified by This has a user readable name in\r
188 the language specified by Language, then a pointer to the driver name is\r
189 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
190 by This does not support the language specified by Language,\r
191 then EFI_UNSUPPORTED is returned.\r
192\r
193 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
194 EFI_COMPONENT_NAME_PROTOCOL instance.\r
195\r
196 @param Language[in] A pointer to a Null-terminated ASCII string\r
197 array indicating the language. This is the\r
198 language of the driver name that the caller is\r
199 requesting, and it must match one of the\r
200 languages specified in SupportedLanguages. The\r
201 number of languages supported by a driver is up\r
202 to the driver writer. Language is specified\r
203 in RFC 3066 or ISO 639-2 language code format.\r
204\r
205 @param DriverName[out] A pointer to the Unicode string to return.\r
206 This Unicode string is the name of the\r
207 driver specified by This in the language\r
208 specified by Language.\r
209\r
210 @retval EFI_SUCCESS The Unicode string for the Driver specified by\r
211 This and the language specified by Language was\r
212 returned in DriverName.\r
213\r
214 @retval EFI_INVALID_PARAMETER Language is NULL.\r
215\r
216 @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
217\r
218 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
219 the language specified by Language.\r
220\r
221**/\r
e237e7ae 222EFI_STATUS\r
223EFIAPI\r
224UsbMassStorageGetDriverName (\r
225 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
226 IN CHAR8 *Language,\r
227 OUT CHAR16 **DriverName\r
228 )\r
e237e7ae 229{\r
62b9bb55 230 return LookupUnicodeString2 (\r
e237e7ae 231 Language,\r
62b9bb55 232 This->SupportedLanguages,\r
e237e7ae 233 mUsbMassStorageDriverNameTable,\r
62b9bb55 234 DriverName,\r
235 (BOOLEAN)(This == &gUsbMassStorageComponentName)\r
e237e7ae 236 );\r
237}\r
238\r
62b9bb55 239/**\r
240 Retrieves a Unicode string that is the user readable name of the controller\r
241 that is being managed by a driver.\r
242\r
243 This function retrieves the user readable name of the controller specified by\r
244 ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
245 driver specified by This has a user readable name in the language specified by\r
246 Language, then a pointer to the controller name is returned in ControllerName,\r
247 and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
248 managing the controller specified by ControllerHandle and ChildHandle,\r
249 then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
250 support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
251\r
252 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
253 EFI_COMPONENT_NAME_PROTOCOL instance.\r
254\r
255 @param ControllerHandle[in] The handle of a controller that the driver\r
256 specified by This is managing. This handle\r
257 specifies the controller whose name is to be\r
258 returned.\r
259\r
260 @param ChildHandle[in] The handle of the child controller to retrieve\r
261 the name of. This is an optional parameter that\r
262 may be NULL. It will be NULL for device\r
263 drivers. It will also be NULL for a bus drivers\r
264 that wish to retrieve the name of the bus\r
265 controller. It will not be NULL for a bus\r
266 driver that wishes to retrieve the name of a\r
267 child controller.\r
268\r
269 @param Language[in] A pointer to a Null-terminated ASCII string\r
270 array indicating the language. This is the\r
271 language of the driver name that the caller is\r
272 requesting, and it must match one of the\r
273 languages specified in SupportedLanguages. The\r
274 number of languages supported by a driver is up\r
275 to the driver writer. Language is specified in\r
276 RFC 3066 or ISO 639-2 language code format.\r
277\r
278 @param ControllerName[out] A pointer to the Unicode string to return.\r
279 This Unicode string is the name of the\r
280 controller specified by ControllerHandle and\r
281 ChildHandle in the language specified by\r
282 Language from the point of view of the driver\r
283 specified by This.\r
284\r
285 @retval EFI_SUCCESS The Unicode string for the user readable name in\r
286 the language specified by Language for the\r
287 driver specified by This was returned in\r
288 DriverName.\r
289\r
290 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
291\r
292 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
293 EFI_HANDLE.\r
294\r
295 @retval EFI_INVALID_PARAMETER Language is NULL.\r
296\r
297 @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
298\r
299 @retval EFI_UNSUPPORTED The driver specified by This is not currently\r
300 managing the controller specified by\r
301 ControllerHandle and ChildHandle.\r
302\r
303 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
304 the language specified by Language.\r
305\r
306**/\r
e237e7ae 307EFI_STATUS\r
308EFIAPI\r
309UsbMassStorageGetControllerName (\r
62b9bb55 310 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
311 IN EFI_HANDLE ControllerHandle,\r
312 IN EFI_HANDLE ChildHandle OPTIONAL,\r
313 IN CHAR8 *Language,\r
314 OUT CHAR16 **ControllerName\r
e237e7ae 315 )\r
e237e7ae 316{\r
317 return EFI_UNSUPPORTED;\r
318}\r