3 Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>
4 This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 // EFI Component Name Functions
27 UnixConsoleComponentNameGetDriverName (
28 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
30 OUT CHAR16
**DriverName
35 UnixConsoleComponentNameGetControllerName (
36 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
37 IN EFI_HANDLE ControllerHandle
,
38 IN EFI_HANDLE ChildHandle OPTIONAL
,
40 OUT CHAR16
**ControllerName
44 // EFI Component Name Protocol
46 EFI_COMPONENT_NAME_PROTOCOL gUnixConsoleComponentName
= {
47 UnixConsoleComponentNameGetDriverName
,
48 UnixConsoleComponentNameGetControllerName
,
52 EFI_UNICODE_STRING_TABLE mUnixConsoleDriverNameTable
[] = {
53 { "eng", L
"Unix Text Console Driver" },
59 UnixConsoleComponentNameGetDriverName (
60 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
62 OUT CHAR16
**DriverName
67 Retrieves a Unicode string that is the user readable name of the EFI Driver.
70 This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
71 Language - A pointer to a three character ISO 639-2 language identifier.
72 This is the language of the driver name that that the caller
73 is requesting, and it must match one of the languages specified
74 in SupportedLanguages. The number of languages supported by a
75 driver is up to the driver writer.
76 DriverName - A pointer to the Unicode string to return. This Unicode string
77 is the name of the driver specified by This in the language
78 specified by Language.
81 EFI_SUCCESS - The Unicode string for the Driver specified by This
82 and the language specified by Language was returned
84 EFI_INVALID_PARAMETER - Language is NULL.
85 EFI_INVALID_PARAMETER - DriverName is NULL.
86 EFI_UNSUPPORTED - The driver specified by This does not support the
87 language specified by Language.
91 return LookupUnicodeString (
93 gUnixConsoleComponentName
.SupportedLanguages
,
94 mUnixConsoleDriverNameTable
,
101 UnixConsoleComponentNameGetControllerName (
102 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
103 IN EFI_HANDLE ControllerHandle
,
104 IN EFI_HANDLE ChildHandle OPTIONAL
,
106 OUT CHAR16
**ControllerName
111 Retrieves a Unicode string that is the user readable name of the controller
112 that is being managed by an EFI Driver.
115 This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
116 ControllerHandle - The handle of a controller that the driver specified by
117 This is managing. This handle specifies the controller
118 whose name is to be returned.
119 ChildHandle - The handle of the child controller to retrieve the name
120 of. This is an optional parameter that may be NULL. It
121 will be NULL for device drivers. It will also be NULL
122 for a bus drivers that wish to retrieve the name of the
123 bus controller. It will not be NULL for a bus driver
124 that wishes to retrieve the name of a child controller.
125 Language - A pointer to a three character ISO 639-2 language
126 identifier. This is the language of the controller name
127 that that the caller is requesting, and it must match one
128 of the languages specified in SupportedLanguages. The
129 number of languages supported by a driver is up to the
131 ControllerName - A pointer to the Unicode string to return. This Unicode
132 string is the name of the controller specified by
133 ControllerHandle and ChildHandle in the language specified
134 by Language from the point of view of the driver specified
138 EFI_SUCCESS - The Unicode string for the user readable name in the
139 language specified by Language for the driver
140 specified by This was returned in DriverName.
141 EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
142 EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.
143 EFI_INVALID_PARAMETER - Language is NULL.
144 EFI_INVALID_PARAMETER - ControllerName is NULL.
145 EFI_UNSUPPORTED - The driver specified by This is not currently managing
146 the controller specified by ControllerHandle and
148 EFI_UNSUPPORTED - The driver specified by This does not support the
149 language specified by Language.
154 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*SimpleTextOut
;
155 UNIX_SIMPLE_TEXT_PRIVATE_DATA
*Private
;
158 // This is a device driver, so ChildHandle must be NULL.
160 if (ChildHandle
!= NULL
) {
161 return EFI_UNSUPPORTED
;
164 // Make sure this driver is currently managing ControllerHandle
166 Status
= EfiTestManagedDevice (
168 gUnixConsoleDriverBinding
.DriverBindingHandle
,
169 &gEfiUnixIoProtocolGuid
171 if (EFI_ERROR (Status
)) {
172 return EFI_UNSUPPORTED
;
175 // Get out context back
177 Status
= gBS
->OpenProtocol (
179 &gEfiSimpleTextOutProtocolGuid
,
180 (void *)&SimpleTextOut
,
181 gUnixConsoleDriverBinding
.DriverBindingHandle
,
183 EFI_OPEN_PROTOCOL_GET_PROTOCOL
185 if (EFI_ERROR (Status
)) {
186 return EFI_UNSUPPORTED
;
189 Private
= UNIX_SIMPLE_TEXT_OUT_PRIVATE_DATA_FROM_THIS (SimpleTextOut
);
191 return LookupUnicodeString (
193 gUnixConsoleComponentName
.SupportedLanguages
,
194 Private
->ControllerNameTable
,