]>
Commit | Line | Data |
---|---|---|
3db51098 | 1 | /**@file\r |
2 | \r | |
3 | Copyright (c) 2006, Intel Corporation \r | |
4 | All rights reserved. This program and the accompanying materials \r | |
5 | are licensed and made available under the terms and conditions of the BSD License \r | |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | **/\r | |
e081218d | 13 | \r |
14 | #include "VgaClass.h"\r | |
15 | \r | |
16 | //\r | |
17 | // EFI Component Name Protocol\r | |
18 | //\r | |
1307dcd7 | 19 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gVgaClassComponentName = {\r |
e081218d | 20 | VgaClassComponentNameGetDriverName,\r |
21 | VgaClassComponentNameGetControllerName,\r | |
22 | "eng"\r | |
1307dcd7 | 23 | };\r |
9d64ff86 | 24 | \r |
25 | //\r | |
26 | // EFI Component Name 2 Protocol\r | |
27 | //\r | |
1307dcd7 | 28 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gVgaClassComponentName2 = {\r |
9d64ff86 | 29 | (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) VgaClassComponentNameGetDriverName,\r |
30 | (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) VgaClassComponentNameGetControllerName,\r | |
31 | "en"\r | |
1307dcd7 | 32 | };\r |
9d64ff86 | 33 | \r |
e081218d | 34 | \r |
35 | STATIC EFI_UNICODE_STRING_TABLE mVgaClassDriverNameTable[] = {\r | |
36 | {\r | |
9d64ff86 | 37 | "eng;en",\r |
e081218d | 38 | L"VGA Class Driver"\r |
39 | },\r | |
40 | {\r | |
41 | NULL,\r | |
42 | NULL\r | |
43 | }\r | |
44 | };\r | |
45 | \r | |
9d64ff86 | 46 | /**\r |
47 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
48 | \r | |
49 | This function retrieves the user readable name of a driver in the form of a\r | |
50 | Unicode string. If the driver specified by This has a user readable name in\r | |
51 | the language specified by Language, then a pointer to the driver name is\r | |
52 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
53 | by This does not support the language specified by Language,\r | |
54 | then EFI_UNSUPPORTED is returned.\r | |
55 | \r | |
56 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
57 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
58 | \r | |
59 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
60 | array indicating the language. This is the\r | |
61 | language of the driver name that the caller is\r | |
62 | requesting, and it must match one of the\r | |
63 | languages specified in SupportedLanguages. The\r | |
64 | number of languages supported by a driver is up\r | |
65 | to the driver writer. Language is specified\r | |
66 | in RFC 3066 or ISO 639-2 language code format.\r | |
67 | \r | |
68 | @param DriverName[out] A pointer to the Unicode string to return.\r | |
69 | This Unicode string is the name of the\r | |
70 | driver specified by This in the language\r | |
71 | specified by Language.\r | |
72 | \r | |
73 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
74 | This and the language specified by Language was\r | |
75 | returned in DriverName.\r | |
76 | \r | |
77 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
78 | \r | |
79 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
80 | \r | |
81 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
82 | the language specified by Language.\r | |
83 | \r | |
84 | **/\r | |
e081218d | 85 | EFI_STATUS\r |
86 | EFIAPI\r | |
87 | VgaClassComponentNameGetDriverName (\r | |
88 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
89 | IN CHAR8 *Language,\r | |
90 | OUT CHAR16 **DriverName\r | |
91 | )\r | |
e081218d | 92 | {\r |
9d64ff86 | 93 | return LookupUnicodeString2 (\r |
94 | Language,\r | |
95 | This->SupportedLanguages,\r | |
96 | mVgaClassDriverNameTable,\r | |
97 | DriverName,\r | |
98 | (BOOLEAN)(This == &gVgaClassComponentName)\r | |
99 | );\r | |
e081218d | 100 | }\r |
101 | \r | |
9d64ff86 | 102 | /**\r |
103 | Retrieves a Unicode string that is the user readable name of the controller\r | |
104 | that is being managed by a driver.\r | |
105 | \r | |
106 | This function retrieves the user readable name of the controller specified by\r | |
107 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
108 | driver specified by This has a user readable name in the language specified by\r | |
109 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
110 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
111 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
112 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
113 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
114 | \r | |
115 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
116 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
117 | \r | |
118 | @param ControllerHandle[in] The handle of a controller that the driver\r | |
119 | specified by This is managing. This handle\r | |
120 | specifies the controller whose name is to be\r | |
121 | returned.\r | |
122 | \r | |
123 | @param ChildHandle[in] The handle of the child controller to retrieve\r | |
124 | the name of. This is an optional parameter that\r | |
125 | may be NULL. It will be NULL for device\r | |
126 | drivers. It will also be NULL for a bus drivers\r | |
127 | that wish to retrieve the name of the bus\r | |
128 | controller. It will not be NULL for a bus\r | |
129 | driver that wishes to retrieve the name of a\r | |
130 | child controller.\r | |
131 | \r | |
132 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
133 | array indicating the language. This is the\r | |
134 | language of the driver name that the caller is\r | |
135 | requesting, and it must match one of the\r | |
136 | languages specified in SupportedLanguages. The\r | |
137 | number of languages supported by a driver is up\r | |
138 | to the driver writer. Language is specified in\r | |
139 | RFC 3066 or ISO 639-2 language code format.\r | |
140 | \r | |
141 | @param ControllerName[out] A pointer to the Unicode string to return.\r | |
142 | This Unicode string is the name of the\r | |
143 | controller specified by ControllerHandle and\r | |
144 | ChildHandle in the language specified by\r | |
145 | Language from the point of view of the driver\r | |
146 | specified by This.\r | |
147 | \r | |
148 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
149 | the language specified by Language for the\r | |
150 | driver specified by This was returned in\r | |
151 | DriverName.\r | |
152 | \r | |
153 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r | |
154 | \r | |
155 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
156 | EFI_HANDLE.\r | |
157 | \r | |
158 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
159 | \r | |
160 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
161 | \r | |
162 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
163 | managing the controller specified by\r | |
164 | ControllerHandle and ChildHandle.\r | |
165 | \r | |
166 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
167 | the language specified by Language.\r | |
168 | \r | |
169 | **/\r | |
e081218d | 170 | EFI_STATUS\r |
171 | EFIAPI\r | |
172 | VgaClassComponentNameGetControllerName (\r | |
173 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
174 | IN EFI_HANDLE ControllerHandle,\r | |
175 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
176 | IN CHAR8 *Language,\r | |
177 | OUT CHAR16 **ControllerName\r | |
178 | )\r | |
e081218d | 179 | {\r |
180 | return EFI_UNSUPPORTED;\r | |
181 | }\r |