]>
Commit | Line | Data |
---|---|---|
1 | /*++\r | |
2 | \r | |
3 | Copyright (c) 2006 - 2008, 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 | Module Name:\r | |
13 | \r | |
14 | GraphicsConsole.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | \r | |
19 | Revision History\r | |
20 | \r | |
21 | --*/\r | |
22 | \r | |
23 | #ifndef _GRAPHICS_CONSOLE_H\r | |
24 | #define _GRAPHICS_CONSOLE_H\r | |
25 | \r | |
26 | #include <PiDxe.h>\r | |
27 | #include <Protocol/FrameworkHii.h>\r | |
28 | #include <Protocol/SimpleTextOut.h>\r | |
29 | #include <Protocol/GraphicsOutput.h>\r | |
30 | #include <Protocol/UgaDraw.h>\r | |
31 | #include <Protocol/DevicePath.h>\r | |
32 | #include <Library/DebugLib.h>\r | |
33 | #include <Library/UefiDriverEntryPoint.h>\r | |
34 | #include <Library/UefiLib.h>\r | |
35 | #include <Library/FrameworkHiiLib.h>\r | |
36 | #include <Library/BaseMemoryLib.h>\r | |
37 | #include <Library/MemoryAllocationLib.h>\r | |
38 | #include <Library/UefiBootServicesTableLib.h>\r | |
39 | \r | |
40 | \r | |
41 | extern EFI_COMPONENT_NAME_PROTOCOL gGraphicsConsoleComponentName;\r | |
42 | extern EFI_COMPONENT_NAME2_PROTOCOL gGraphicsConsoleComponentName2;\r | |
43 | \r | |
44 | //\r | |
45 | // EFI Component Name Functions\r | |
46 | //\r | |
47 | /**\r | |
48 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
49 | \r | |
50 | This function retrieves the user readable name of a driver in the form of a\r | |
51 | Unicode string. If the driver specified by This has a user readable name in\r | |
52 | the language specified by Language, then a pointer to the driver name is\r | |
53 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
54 | by This does not support the language specified by Language,\r | |
55 | then EFI_UNSUPPORTED is returned.\r | |
56 | \r | |
57 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
58 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
59 | \r | |
60 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
61 | array indicating the language. This is the\r | |
62 | language of the driver name that the caller is\r | |
63 | requesting, and it must match one of the\r | |
64 | languages specified in SupportedLanguages. The\r | |
65 | number of languages supported by a driver is up\r | |
66 | to the driver writer. Language is specified\r | |
67 | in RFC 3066 or ISO 639-2 language code format.\r | |
68 | \r | |
69 | @param DriverName[out] A pointer to the Unicode string to return.\r | |
70 | This Unicode string is the name of the\r | |
71 | driver specified by This in the language\r | |
72 | specified by Language.\r | |
73 | \r | |
74 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
75 | This and the language specified by Language was\r | |
76 | returned in DriverName.\r | |
77 | \r | |
78 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
79 | \r | |
80 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
81 | \r | |
82 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
83 | the language specified by Language.\r | |
84 | \r | |
85 | **/\r | |
86 | EFI_STATUS\r | |
87 | EFIAPI\r | |
88 | GraphicsConsoleComponentNameGetDriverName (\r | |
89 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
90 | IN CHAR8 *Language,\r | |
91 | OUT CHAR16 **DriverName\r | |
92 | );\r | |
93 | \r | |
94 | \r | |
95 | /**\r | |
96 | Retrieves a Unicode string that is the user readable name of the controller\r | |
97 | that is being managed by a driver.\r | |
98 | \r | |
99 | This function retrieves the user readable name of the controller specified by\r | |
100 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
101 | driver specified by This has a user readable name in the language specified by\r | |
102 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
103 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
104 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
105 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
106 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
107 | \r | |
108 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
109 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
110 | \r | |
111 | @param ControllerHandle[in] The handle of a controller that the driver\r | |
112 | specified by This is managing. This handle\r | |
113 | specifies the controller whose name is to be\r | |
114 | returned.\r | |
115 | \r | |
116 | @param ChildHandle[in] The handle of the child controller to retrieve\r | |
117 | the name of. This is an optional parameter that\r | |
118 | may be NULL. It will be NULL for device\r | |
119 | drivers. It will also be NULL for a bus drivers\r | |
120 | that wish to retrieve the name of the bus\r | |
121 | controller. It will not be NULL for a bus\r | |
122 | driver that wishes to retrieve the name of a\r | |
123 | child controller.\r | |
124 | \r | |
125 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
126 | array indicating the language. This is the\r | |
127 | language of the driver name that the caller is\r | |
128 | requesting, and it must match one of the\r | |
129 | languages specified in SupportedLanguages. The\r | |
130 | number of languages supported by a driver is up\r | |
131 | to the driver writer. Language is specified in\r | |
132 | RFC 3066 or ISO 639-2 language code format.\r | |
133 | \r | |
134 | @param ControllerName[out] A pointer to the Unicode string to return.\r | |
135 | This Unicode string is the name of the\r | |
136 | controller specified by ControllerHandle and\r | |
137 | ChildHandle in the language specified by\r | |
138 | Language from the point of view of the driver\r | |
139 | specified by This.\r | |
140 | \r | |
141 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
142 | the language specified by Language for the\r | |
143 | driver specified by This was returned in\r | |
144 | DriverName.\r | |
145 | \r | |
146 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r | |
147 | \r | |
148 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
149 | EFI_HANDLE.\r | |
150 | \r | |
151 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
152 | \r | |
153 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
154 | \r | |
155 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
156 | managing the controller specified by\r | |
157 | ControllerHandle and ChildHandle.\r | |
158 | \r | |
159 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
160 | the language specified by Language.\r | |
161 | \r | |
162 | **/\r | |
163 | EFI_STATUS\r | |
164 | EFIAPI\r | |
165 | GraphicsConsoleComponentNameGetControllerName (\r | |
166 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
167 | IN EFI_HANDLE ControllerHandle,\r | |
168 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
169 | IN CHAR8 *Language,\r | |
170 | OUT CHAR16 **ControllerName\r | |
171 | );\r | |
172 | \r | |
173 | \r | |
174 | //\r | |
175 | // Glyph database\r | |
176 | //\r | |
177 | #define GLYPH_WIDTH 8\r | |
178 | #define GLYPH_HEIGHT 19\r | |
179 | \r | |
180 | //\r | |
181 | // User can define valid graphic resolution here\r | |
182 | // e.g. 640x480, 800x600, 1024x768...\r | |
183 | //\r | |
184 | #define CURRENT_HORIZONTAL_RESOLUTION 800\r | |
185 | #define CURRENT_VERTICAL_RESOLUTION 600\r | |
186 | \r | |
187 | typedef union {\r | |
188 | EFI_NARROW_GLYPH NarrowGlyph;\r | |
189 | EFI_WIDE_GLYPH WideGlyph;\r | |
190 | } GLYPH_UNION;\r | |
191 | \r | |
192 | extern EFI_NARROW_GLYPH UsStdNarrowGlyphData[];\r | |
193 | extern EFI_WIDE_GLYPH UsStdWideGlyphData[];\r | |
194 | \r | |
195 | //\r | |
196 | // Device Structure\r | |
197 | //\r | |
198 | #define GRAPHICS_CONSOLE_DEV_SIGNATURE EFI_SIGNATURE_32 ('g', 's', 't', 'o')\r | |
199 | \r | |
200 | typedef struct {\r | |
201 | UINTN Columns;\r | |
202 | UINTN Rows;\r | |
203 | INTN DeltaX;\r | |
204 | INTN DeltaY;\r | |
205 | UINT32 GopWidth;\r | |
206 | UINT32 GopHeight;\r | |
207 | UINT32 GopModeNumber;\r | |
208 | } GRAPHICS_CONSOLE_MODE_DATA;\r | |
209 | \r | |
210 | #define GRAPHICS_MAX_MODE 4\r | |
211 | \r | |
212 | typedef struct {\r | |
213 | UINTN Signature;\r | |
214 | EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r | |
215 | EFI_UGA_DRAW_PROTOCOL *UgaDraw;\r | |
216 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput;\r | |
217 | EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;\r | |
218 | GRAPHICS_CONSOLE_MODE_DATA ModeData[GRAPHICS_MAX_MODE];\r | |
219 | EFI_GRAPHICS_OUTPUT_BLT_PIXEL *LineBuffer;\r | |
220 | EFI_HII_HANDLE HiiHandle;\r | |
221 | } GRAPHICS_CONSOLE_DEV;\r | |
222 | \r | |
223 | #define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \\r | |
224 | CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)\r | |
225 | \r | |
226 | //\r | |
227 | // Global Variables\r | |
228 | //\r | |
229 | extern EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding;\r | |
230 | \r | |
231 | //\r | |
232 | // Prototypes\r | |
233 | //\r | |
234 | UINTN\r | |
235 | ReturnNarrowFontSize (\r | |
236 | VOID\r | |
237 | );\r | |
238 | \r | |
239 | UINTN\r | |
240 | ReturnWideFontSize (\r | |
241 | VOID\r | |
242 | );\r | |
243 | \r | |
244 | EFI_STATUS\r | |
245 | EFIAPI\r | |
246 | GraphicsConsoleConOutReset (\r | |
247 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
248 | IN BOOLEAN ExtendedVerification\r | |
249 | );\r | |
250 | \r | |
251 | EFI_STATUS\r | |
252 | EFIAPI\r | |
253 | GraphicsConsoleConOutOutputString (\r | |
254 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
255 | IN CHAR16 *WString\r | |
256 | );\r | |
257 | \r | |
258 | EFI_STATUS\r | |
259 | EFIAPI\r | |
260 | GraphicsConsoleConOutTestString (\r | |
261 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
262 | IN CHAR16 *WString\r | |
263 | );\r | |
264 | \r | |
265 | EFI_STATUS\r | |
266 | EFIAPI\r | |
267 | GraphicsConsoleConOutQueryMode (\r | |
268 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
269 | IN UINTN ModeNumber,\r | |
270 | OUT UINTN *Columns,\r | |
271 | OUT UINTN *Rows\r | |
272 | );\r | |
273 | \r | |
274 | EFI_STATUS\r | |
275 | EFIAPI\r | |
276 | GraphicsConsoleConOutSetMode (\r | |
277 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
278 | IN UINTN ModeNumber\r | |
279 | );\r | |
280 | \r | |
281 | EFI_STATUS\r | |
282 | EFIAPI\r | |
283 | GraphicsConsoleConOutSetAttribute (\r | |
284 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
285 | IN UINTN Attribute\r | |
286 | );\r | |
287 | \r | |
288 | EFI_STATUS\r | |
289 | EFIAPI\r | |
290 | GraphicsConsoleConOutClearScreen (\r | |
291 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r | |
292 | );\r | |
293 | \r | |
294 | EFI_STATUS\r | |
295 | EFIAPI\r | |
296 | GraphicsConsoleConOutSetCursorPosition (\r | |
297 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
298 | IN UINTN Column,\r | |
299 | IN UINTN Row\r | |
300 | );\r | |
301 | \r | |
302 | EFI_STATUS\r | |
303 | EFIAPI\r | |
304 | GraphicsConsoleConOutEnableCursor (\r | |
305 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
306 | IN BOOLEAN Visible\r | |
307 | );\r | |
308 | \r | |
309 | EFI_STATUS\r | |
310 | EfiLocateHiiProtocol (\r | |
311 | VOID\r | |
312 | );\r | |
313 | \r | |
314 | EFI_STATUS\r | |
315 | EFIAPI\r | |
316 | GraphicsConsoleControllerDriverSupported (\r | |
317 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
318 | IN EFI_HANDLE Controller,\r | |
319 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
320 | );\r | |
321 | \r | |
322 | EFI_STATUS\r | |
323 | EFIAPI\r | |
324 | GraphicsConsoleControllerDriverStart (\r | |
325 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
326 | IN EFI_HANDLE Controller,\r | |
327 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
328 | );\r | |
329 | \r | |
330 | EFI_STATUS\r | |
331 | EFIAPI\r | |
332 | GraphicsConsoleControllerDriverStop (\r | |
333 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
334 | IN EFI_HANDLE Controller,\r | |
335 | IN UINTN NumberOfChildren,\r | |
336 | IN EFI_HANDLE *ChildHandleBuffer\r | |
337 | );\r | |
338 | \r | |
339 | #endif\r |