2 UEFI Component Name and Name2 protocol for Isa serial driver.
4 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 // EFI Component Name Protocol
20 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gPciSioSerialComponentName
= {
21 SerialComponentNameGetDriverName
,
22 SerialComponentNameGetControllerName
,
27 // EFI Component Name 2 Protocol
29 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gPciSioSerialComponentName2
= {
30 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME
) SerialComponentNameGetDriverName
,
31 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME
) SerialComponentNameGetControllerName
,
36 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSerialDriverNameTable
[] = {
39 L
"PCI SIO Serial Driver"
48 Retrieves a Unicode string that is the user readable name of the driver.
50 This function retrieves the user readable name of a driver in the form of a
51 Unicode string. If the driver specified by This has a user readable name in
52 the language specified by Language, then a pointer to the driver name is
53 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
54 by This does not support the language specified by Language,
55 then EFI_UNSUPPORTED is returned.
57 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
58 EFI_COMPONENT_NAME_PROTOCOL instance.
60 @param Language[in] A pointer to a Null-terminated ASCII string
61 array indicating the language. This is the
62 language of the driver name that the caller is
63 requesting, and it must match one of the
64 languages specified in SupportedLanguages. The
65 number of languages supported by a driver is up
66 to the driver writer. Language is specified
67 in RFC 4646 or ISO 639-2 language code format.
69 @param DriverName[out] A pointer to the Unicode string to return.
70 This Unicode string is the name of the
71 driver specified by This in the language
72 specified by Language.
74 @retval EFI_SUCCESS The Unicode string for the Driver specified by
75 This and the language specified by Language was
76 returned in DriverName.
78 @retval EFI_INVALID_PARAMETER Language is NULL.
80 @retval EFI_INVALID_PARAMETER DriverName is NULL.
82 @retval EFI_UNSUPPORTED The driver specified by This does not support
83 the language specified by Language.
88 SerialComponentNameGetDriverName (
89 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
91 OUT CHAR16
**DriverName
94 return LookupUnicodeString2 (
96 This
->SupportedLanguages
,
97 mSerialDriverNameTable
,
99 (BOOLEAN
)(This
== &gPciSioSerialComponentName
)
104 Retrieves a Unicode string that is the user readable name of the controller
105 that is being managed by a driver.
107 This function retrieves the user readable name of the controller specified by
108 ControllerHandle and ChildHandle in the form of a Unicode string. If the
109 driver specified by This has a user readable name in the language specified by
110 Language, then a pointer to the controller name is returned in ControllerName,
111 and EFI_SUCCESS is returned. If the driver specified by This is not currently
112 managing the controller specified by ControllerHandle and ChildHandle,
113 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
114 support the language specified by Language, then EFI_UNSUPPORTED is returned.
116 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
117 EFI_COMPONENT_NAME_PROTOCOL instance.
119 @param ControllerHandle[in] The handle of a controller that the driver
120 specified by This is managing. This handle
121 specifies the controller whose name is to be
124 @param ChildHandle[in] The handle of the child controller to retrieve
125 the name of. This is an optional parameter that
126 may be NULL. It will be NULL for device
127 drivers. It will also be NULL for a bus drivers
128 that wish to retrieve the name of the bus
129 controller. It will not be NULL for a bus
130 driver that wishes to retrieve the name of a
133 @param Language[in] A pointer to a Null-terminated ASCII string
134 array indicating the language. This is the
135 language of the driver name that the caller is
136 requesting, and it must match one of the
137 languages specified in SupportedLanguages. The
138 number of languages supported by a driver is up
139 to the driver writer. Language is specified in
140 RFC 4646 or ISO 639-2 language code format.
142 @param ControllerName[out] A pointer to the Unicode string to return.
143 This Unicode string is the name of the
144 controller specified by ControllerHandle and
145 ChildHandle in the language specified by
146 Language from the point of view of the driver
149 @retval EFI_SUCCESS The Unicode string for the user readable name in
150 the language specified by Language for the
151 driver specified by This was returned in
154 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
156 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
159 @retval EFI_INVALID_PARAMETER Language is NULL.
161 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
163 @retval EFI_UNSUPPORTED The driver specified by This is not currently
164 managing the controller specified by
165 ControllerHandle and ChildHandle.
167 @retval EFI_UNSUPPORTED The driver specified by This does not support
168 the language specified by Language.
173 SerialComponentNameGetControllerName (
174 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
175 IN EFI_HANDLE ControllerHandle
,
176 IN EFI_HANDLE ChildHandle OPTIONAL
,
178 OUT CHAR16
**ControllerName
182 EFI_SERIAL_IO_PROTOCOL
*SerialIo
;
183 SERIAL_DEV
*SerialDevice
;
184 EFI_UNICODE_STRING_TABLE
*ControllerNameTable
;
185 EFI_GUID
*IoProtocolGuid
;
188 // Make sure this driver is currently managing ControllerHandle
190 IoProtocolGuid
= &gEfiSioProtocolGuid
;
191 Status
= EfiTestManagedDevice (
193 gSerialControllerDriver
.DriverBindingHandle
,
196 if (EFI_ERROR (Status
)) {
197 IoProtocolGuid
= &gEfiPciIoProtocolGuid
;
198 Status
= EfiTestManagedDevice (
200 gSerialControllerDriver
.DriverBindingHandle
,
205 if (EFI_ERROR (Status
)) {
209 ControllerNameTable
= NULL
;
210 if (ChildHandle
!= NULL
) {
211 Status
= EfiTestChildHandle (
216 if (EFI_ERROR (Status
)) {
221 // Get the Serial I/O Protocol from the child handle
223 Status
= gBS
->OpenProtocol (
225 &gEfiSerialIoProtocolGuid
,
227 gSerialControllerDriver
.DriverBindingHandle
,
229 EFI_OPEN_PROTOCOL_GET_PROTOCOL
231 if (EFI_ERROR (Status
)) {
236 // Get the Serial Controller's Device structure
238 SerialDevice
= SERIAL_DEV_FROM_THIS (SerialIo
);
239 ControllerNameTable
= SerialDevice
->ControllerNameTable
;
242 return LookupUnicodeString2 (
244 This
->SupportedLanguages
,
247 (BOOLEAN
)(This
== &gPciSioSerialComponentName
)
252 Add the ISO639-2 and RFC4646 component name both for the Serial IO device
254 @param SerialDevice A pointer to the SERIAL_DEV instance.
255 @param Instance Instance ID for the serial device.
259 IN SERIAL_DEV
*SerialDevice
,
263 CHAR16 SerialPortName
[SERIAL_PORT_NAME_LEN
];
266 sizeof (SerialPortName
),
267 (SerialDevice
->PciDeviceInfo
!= NULL
) ? PCI_SERIAL_PORT_NAME
: SIO_SERIAL_PORT_NAME
,
272 gPciSioSerialComponentName
.SupportedLanguages
,
273 &SerialDevice
->ControllerNameTable
,
279 gPciSioSerialComponentName2
.SupportedLanguages
,
280 &SerialDevice
->ControllerNameTable
,