3 Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>
4 SPDX-License-Identifier: BSD-2-Clause-Patent
14 #include "WinNtSerialIo.h"
17 // EFI Component Name Functions
20 Retrieves a Unicode string that is the user readable name of the driver.
22 This function retrieves the user readable name of a driver in the form of a
23 Unicode string. If the driver specified by This has a user readable name in
24 the language specified by Language, then a pointer to the driver name is
25 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
26 by This does not support the language specified by Language,
27 then EFI_UNSUPPORTED is returned.
29 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
30 EFI_COMPONENT_NAME_PROTOCOL instance.
32 @param Language[in] A pointer to a Null-terminated ASCII string
33 array indicating the language. This is the
34 language of the driver name that the caller is
35 requesting, and it must match one of the
36 languages specified in SupportedLanguages. The
37 number of languages supported by a driver is up
38 to the driver writer. Language is specified
39 in RFC 4646 or ISO 639-2 language code format.
41 @param DriverName[out] A pointer to the Unicode string to return.
42 This Unicode string is the name of the
43 driver specified by This in the language
44 specified by Language.
46 @retval EFI_SUCCESS The Unicode string for the Driver specified by
47 This and the language specified by Language was
48 returned in DriverName.
50 @retval EFI_INVALID_PARAMETER Language is NULL.
52 @retval EFI_INVALID_PARAMETER DriverName is NULL.
54 @retval EFI_UNSUPPORTED The driver specified by This does not support
55 the language specified by Language.
60 WinNtSerialIoComponentNameGetDriverName (
61 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
63 OUT CHAR16
**DriverName
68 Retrieves a Unicode string that is the user readable name of the controller
69 that is being managed by a driver.
71 This function retrieves the user readable name of the controller specified by
72 ControllerHandle and ChildHandle in the form of a Unicode string. If the
73 driver specified by This has a user readable name in the language specified by
74 Language, then a pointer to the controller name is returned in ControllerName,
75 and EFI_SUCCESS is returned. If the driver specified by This is not currently
76 managing the controller specified by ControllerHandle and ChildHandle,
77 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
78 support the language specified by Language, then EFI_UNSUPPORTED is returned.
80 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
81 EFI_COMPONENT_NAME_PROTOCOL instance.
83 @param ControllerHandle[in] The handle of a controller that the driver
84 specified by This is managing. This handle
85 specifies the controller whose name is to be
88 @param ChildHandle[in] The handle of the child controller to retrieve
89 the name of. This is an optional parameter that
90 may be NULL. It will be NULL for device
91 drivers. It will also be NULL for a bus drivers
92 that wish to retrieve the name of the bus
93 controller. It will not be NULL for a bus
94 driver that wishes to retrieve the name of a
97 @param Language[in] A pointer to a Null-terminated ASCII string
98 array indicating the language. This is the
99 language of the driver name that the caller is
100 requesting, and it must match one of the
101 languages specified in SupportedLanguages. The
102 number of languages supported by a driver is up
103 to the driver writer. Language is specified in
104 RFC 4646 or ISO 639-2 language code format.
106 @param ControllerName[out] A pointer to the Unicode string to return.
107 This Unicode string is the name of the
108 controller specified by ControllerHandle and
109 ChildHandle in the language specified by
110 Language from the point of view of the driver
113 @retval EFI_SUCCESS The Unicode string for the user readable name in
114 the language specified by Language for the
115 driver specified by This was returned in
118 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
120 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
123 @retval EFI_INVALID_PARAMETER Language is NULL.
125 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
127 @retval EFI_UNSUPPORTED The driver specified by This is not currently
128 managing the controller specified by
129 ControllerHandle and ChildHandle.
131 @retval EFI_UNSUPPORTED The driver specified by This does not support
132 the language specified by Language.
137 WinNtSerialIoComponentNameGetControllerName (
138 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
139 IN EFI_HANDLE ControllerHandle
,
140 IN EFI_HANDLE ChildHandle OPTIONAL
,
142 OUT CHAR16
**ControllerName
147 // EFI Component Name Protocol
149 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gWinNtSerialIoComponentName
= {
150 WinNtSerialIoComponentNameGetDriverName
,
151 WinNtSerialIoComponentNameGetControllerName
,
156 // EFI Component Name 2 Protocol
158 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gWinNtSerialIoComponentName2
= {
159 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME
) WinNtSerialIoComponentNameGetDriverName
,
160 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME
) WinNtSerialIoComponentNameGetControllerName
,
165 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mWinNtSerialIoDriverNameTable
[] = {
166 { "eng;en", L
"Windows Serial I/O Driver" },
171 Retrieves a Unicode string that is the user readable name of the driver.
173 This function retrieves the user readable name of a driver in the form of a
174 Unicode string. If the driver specified by This has a user readable name in
175 the language specified by Language, then a pointer to the driver name is
176 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
177 by This does not support the language specified by Language,
178 then EFI_UNSUPPORTED is returned.
180 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
181 EFI_COMPONENT_NAME_PROTOCOL instance.
183 @param Language[in] A pointer to a Null-terminated ASCII string
184 array indicating the language. This is the
185 language of the driver name that the caller is
186 requesting, and it must match one of the
187 languages specified in SupportedLanguages. The
188 number of languages supported by a driver is up
189 to the driver writer. Language is specified
190 in RFC 4646 or ISO 639-2 language code format.
192 @param DriverName[out] A pointer to the Unicode string to return.
193 This Unicode string is the name of the
194 driver specified by This in the language
195 specified by Language.
197 @retval EFI_SUCCESS The Unicode string for the Driver specified by
198 This and the language specified by Language was
199 returned in DriverName.
201 @retval EFI_INVALID_PARAMETER Language is NULL.
203 @retval EFI_INVALID_PARAMETER DriverName is NULL.
205 @retval EFI_UNSUPPORTED The driver specified by This does not support
206 the language specified by Language.
211 WinNtSerialIoComponentNameGetDriverName (
212 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
214 OUT CHAR16
**DriverName
217 return LookupUnicodeString2 (
219 This
->SupportedLanguages
,
220 mWinNtSerialIoDriverNameTable
,
222 (BOOLEAN
)(This
== &gWinNtSerialIoComponentName
)
227 Retrieves a Unicode string that is the user readable name of the controller
228 that is being managed by a driver.
230 This function retrieves the user readable name of the controller specified by
231 ControllerHandle and ChildHandle in the form of a Unicode string. If the
232 driver specified by This has a user readable name in the language specified by
233 Language, then a pointer to the controller name is returned in ControllerName,
234 and EFI_SUCCESS is returned. If the driver specified by This is not currently
235 managing the controller specified by ControllerHandle and ChildHandle,
236 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
237 support the language specified by Language, then EFI_UNSUPPORTED is returned.
239 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
240 EFI_COMPONENT_NAME_PROTOCOL instance.
242 @param ControllerHandle[in] The handle of a controller that the driver
243 specified by This is managing. This handle
244 specifies the controller whose name is to be
247 @param ChildHandle[in] The handle of the child controller to retrieve
248 the name of. This is an optional parameter that
249 may be NULL. It will be NULL for device
250 drivers. It will also be NULL for a bus drivers
251 that wish to retrieve the name of the bus
252 controller. It will not be NULL for a bus
253 driver that wishes to retrieve the name of a
256 @param Language[in] A pointer to a Null-terminated ASCII string
257 array indicating the language. This is the
258 language of the driver name that the caller is
259 requesting, and it must match one of the
260 languages specified in SupportedLanguages. The
261 number of languages supported by a driver is up
262 to the driver writer. Language is specified in
263 RFC 4646 or ISO 639-2 language code format.
265 @param ControllerName[out] A pointer to the Unicode string to return.
266 This Unicode string is the name of the
267 controller specified by ControllerHandle and
268 ChildHandle in the language specified by
269 Language from the point of view of the driver
272 @retval EFI_SUCCESS The Unicode string for the user readable name in
273 the language specified by Language for the
274 driver specified by This was returned in
277 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
279 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
282 @retval EFI_INVALID_PARAMETER Language is NULL.
284 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
286 @retval EFI_UNSUPPORTED The driver specified by This is not currently
287 managing the controller specified by
288 ControllerHandle and ChildHandle.
290 @retval EFI_UNSUPPORTED The driver specified by This does not support
291 the language specified by Language.
296 WinNtSerialIoComponentNameGetControllerName (
297 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
298 IN EFI_HANDLE ControllerHandle
,
299 IN EFI_HANDLE ChildHandle OPTIONAL
,
301 OUT CHAR16
**ControllerName
305 EFI_SERIAL_IO_PROTOCOL
*SerialIo
;
306 WIN_NT_SERIAL_IO_PRIVATE_DATA
*Private
;
309 // Make sure this driver is currently managing ControllHandle
311 Status
= EfiTestManagedDevice (
313 gWinNtSerialIoDriverBinding
.DriverBindingHandle
,
314 &gEfiWinNtIoProtocolGuid
316 if (EFI_ERROR (Status
)) {
321 // This is a bus driver, so ChildHandle must not be NULL.
323 if (ChildHandle
== NULL
) {
324 return EFI_UNSUPPORTED
;
327 Status
= EfiTestChildHandle (
330 &gEfiWinNtIoProtocolGuid
332 if (EFI_ERROR (Status
)) {
337 // Get our context back
339 Status
= gBS
->OpenProtocol (
341 &gEfiSerialIoProtocolGuid
,
343 gWinNtSerialIoDriverBinding
.DriverBindingHandle
,
345 EFI_OPEN_PROTOCOL_GET_PROTOCOL
347 if (EFI_ERROR (Status
)) {
348 return EFI_UNSUPPORTED
;
351 Private
= WIN_NT_SERIAL_IO_PRIVATE_DATA_FROM_THIS (SerialIo
);
353 return LookupUnicodeString2 (
355 This
->SupportedLanguages
,
356 Private
->ControllerNameTable
,
358 (BOOLEAN
)(This
== &gWinNtSerialIoComponentName
)