3 Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>
4 Portions copyright (c) 2010,Apple Inc. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
18 // EFI Component Name Functions
22 EmuGopComponentNameGetDriverName (
23 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
25 OUT CHAR16
**DriverName
30 EmuGopComponentNameGetControllerName (
31 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
32 IN EFI_HANDLE ControllerHandle
,
33 IN EFI_HANDLE ChildHandle OPTIONAL
,
35 OUT CHAR16
**ControllerName
39 // EFI Component Name Protocol
41 EFI_COMPONENT_NAME_PROTOCOL gEmuGopComponentName
= {
42 EmuGopComponentNameGetDriverName
,
43 EmuGopComponentNameGetControllerName
,
48 // EFI Component Name 2 Protocol
50 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gEmuGopComponentName2
= {
51 (EFI_COMPONENT_NAME2_GET_DRIVER_NAME
) EmuGopComponentNameGetDriverName
,
52 (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME
) EmuGopComponentNameGetControllerName
,
57 EFI_UNICODE_STRING_TABLE mEmuGopDriverNameTable
[] = {
58 { "eng", L
"Emulator GOP Driver" },
64 Retrieves a Unicode string that is the user readable name of the driver.
66 This function retrieves the user readable name of a driver in the form of a
67 Unicode string. If the driver specified by This has a user readable name in
68 the language specified by Language, then a pointer to the driver name is
69 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
70 by This does not support the language specified by Language,
71 then EFI_UNSUPPORTED is returned.
73 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
74 EFI_COMPONENT_NAME_PROTOCOL instance.
76 @param Language[in] A pointer to a Null-terminated ASCII string
77 array indicating the language. This is the
78 language of the driver name that the caller is
79 requesting, and it must match one of the
80 languages specified in SupportedLanguages. The
81 number of languages supported by a driver is up
82 to the driver writer. Language is specified
83 in RFC 4646 or ISO 639-2 language code format.
85 @param DriverName[out] A pointer to the Unicode string to return.
86 This Unicode string is the name of the
87 driver specified by This in the language
88 specified by Language.
90 @retval EFI_SUCCESS The Unicode string for the Driver specified by
91 This and the language specified by Language was
92 returned in DriverName.
94 @retval EFI_INVALID_PARAMETER Language is NULL.
96 @retval EFI_INVALID_PARAMETER DriverName is NULL.
98 @retval EFI_UNSUPPORTED The driver specified by This does not support
99 the language specified by Language.
104 EmuGopComponentNameGetDriverName (
105 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
107 OUT CHAR16
**DriverName
110 return LookupUnicodeString2 (
112 This
->SupportedLanguages
,
113 mEmuGopDriverNameTable
,
115 (BOOLEAN
)(This
== &gEmuGopComponentName
)
121 Retrieves a Unicode string that is the user readable name of the controller
122 that is being managed by a driver.
124 This function retrieves the user readable name of the controller specified by
125 ControllerHandle and ChildHandle in the form of a Unicode string. If the
126 driver specified by This has a user readable name in the language specified by
127 Language, then a pointer to the controller name is returned in ControllerName,
128 and EFI_SUCCESS is returned. If the driver specified by This is not currently
129 managing the controller specified by ControllerHandle and ChildHandle,
130 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
131 support the language specified by Language, then EFI_UNSUPPORTED is returned.
133 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
134 EFI_COMPONENT_NAME_PROTOCOL instance.
136 @param ControllerHandle[in] The handle of a controller that the driver
137 specified by This is managing. This handle
138 specifies the controller whose name is to be
141 @param ChildHandle[in] The handle of the child controller to retrieve
142 the name of. This is an optional parameter that
143 may be NULL. It will be NULL for device
144 drivers. It will also be NULL for a bus drivers
145 that wish to retrieve the name of the bus
146 controller. It will not be NULL for a bus
147 driver that wishes to retrieve the name of a
150 @param Language[in] A pointer to a Null-terminated ASCII string
151 array indicating the language. This is the
152 language of the driver name that the caller is
153 requesting, and it must match one of the
154 languages specified in SupportedLanguages. The
155 number of languages supported by a driver is up
156 to the driver writer. Language is specified in
157 RFC 4646 or ISO 639-2 language code format.
159 @param ControllerName[out] A pointer to the Unicode string to return.
160 This Unicode string is the name of the
161 controller specified by ControllerHandle and
162 ChildHandle in the language specified by
163 Language from the point of view of the driver
166 @retval EFI_SUCCESS The Unicode string for the user readable name in
167 the language specified by Language for the
168 driver specified by This was returned in
171 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
173 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
176 @retval EFI_INVALID_PARAMETER Language is NULL.
178 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
180 @retval EFI_UNSUPPORTED The driver specified by This is not currently
181 managing the controller specified by
182 ControllerHandle and ChildHandle.
184 @retval EFI_UNSUPPORTED The driver specified by This does not support
185 the language specified by Language.
190 EmuGopComponentNameGetControllerName (
191 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
192 IN EFI_HANDLE ControllerHandle
,
193 IN EFI_HANDLE ChildHandle OPTIONAL
,
195 OUT CHAR16
**ControllerName
199 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
200 GOP_PRIVATE_DATA
*Private
;
203 // This is a device driver, so ChildHandle must be NULL.
205 if (ChildHandle
!= NULL
) {
206 return EFI_UNSUPPORTED
;
210 // Make sure this driver is currently managing ControllerHandle
212 Status
= EfiTestManagedDevice (
214 gEmuGopDriverBinding
.DriverBindingHandle
,
215 &gEmuIoThunkProtocolGuid
217 if (EFI_ERROR (Status
)) {
218 return EFI_UNSUPPORTED
;
221 // Get our context back
223 Status
= gBS
->OpenProtocol (
225 &gEfiGraphicsOutputProtocolGuid
,
226 (VOID
**)&GraphicsOutput
,
227 gEmuGopDriverBinding
.DriverBindingHandle
,
229 EFI_OPEN_PROTOCOL_GET_PROTOCOL
231 if (EFI_ERROR (Status
)) {
232 return EFI_UNSUPPORTED
;
235 Private
= GOP_PRIVATE_DATA_FROM_THIS (GraphicsOutput
);
237 return LookupUnicodeString2 (
239 This
->SupportedLanguages
,
240 Private
->ControllerNameTable
,
242 (BOOLEAN
)(This
== &gEmuGopComponentName
)