342fff8f2146ef01ae9898d0f3cddf564bb83898
[mirror_edk2.git] / MdeModulePkg / Universal / Console / GraphicsConsoleDxe / GraphicsConsole.h
1 /** @file
2 Header file for GraphicsConsole driver.
3
4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
5 All rights reserved. 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
9
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.
12
13 **/
14
15 #ifndef _GRAPHICS_CONSOLE_H_
16 #define _GRAPHICS_CONSOLE_H_
17
18 #include <Uefi.h>
19 #include <Protocol/SimpleTextOut.h>
20 #include <Protocol/GraphicsOutput.h>
21 #include <Protocol/UgaDraw.h>
22 #include <Protocol/DevicePath.h>
23 #include <Library/DebugLib.h>
24 #include <Library/UefiDriverEntryPoint.h>
25 #include <Library/UefiLib.h>
26 #include <Library/BaseMemoryLib.h>
27 #include <Library/MemoryAllocationLib.h>
28 #include <Library/UefiBootServicesTableLib.h>
29 #include <Library/HiiLib.h>
30 #include <Library/BaseLib.h>
31 #include <Library/PcdLib.h>
32
33 #include <MdeModuleHii.h>
34
35 #include <Protocol/HiiFont.h>
36 #include <Protocol/HiiDatabase.h>
37
38
39 extern EFI_COMPONENT_NAME_PROTOCOL gGraphicsConsoleComponentName;
40 extern EFI_COMPONENT_NAME2_PROTOCOL gGraphicsConsoleComponentName2;
41 extern EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding;
42 extern EFI_NARROW_GLYPH gUsStdNarrowGlyphData[];
43
44
45 //
46 // User can define valid graphic resolution here
47 // e.g. 640x480, 800x600, 1024x768...
48 //
49 #define CURRENT_HORIZONTAL_RESOLUTION 800
50 #define CURRENT_VERTICAL_RESOLUTION 600
51
52 typedef union {
53 EFI_NARROW_GLYPH NarrowGlyph;
54 EFI_WIDE_GLYPH WideGlyph;
55 } GLYPH_UNION;
56
57 //
58 // Device Structure
59 //
60 #define GRAPHICS_CONSOLE_DEV_SIGNATURE SIGNATURE_32 ('g', 's', 't', 'o')
61
62 typedef struct {
63 UINTN Columns;
64 UINTN Rows;
65 INTN DeltaX;
66 INTN DeltaY;
67 UINT32 GopWidth;
68 UINT32 GopHeight;
69 UINT32 GopModeNumber;
70 } GRAPHICS_CONSOLE_MODE_DATA;
71
72 #define GRAPHICS_MAX_MODE 4
73
74 typedef struct {
75 UINTN Signature;
76 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
77 EFI_UGA_DRAW_PROTOCOL *UgaDraw;
78 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput;
79 EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;
80 GRAPHICS_CONSOLE_MODE_DATA ModeData[GRAPHICS_MAX_MODE];
81 EFI_GRAPHICS_OUTPUT_BLT_PIXEL *LineBuffer;
82 EFI_HII_HANDLE HiiHandle;
83 } GRAPHICS_CONSOLE_DEV;
84
85 #define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \
86 CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)
87
88
89 //
90 // EFI Component Name Functions
91 //
92 /**
93 Retrieves a Unicode string that is the user readable name of the driver.
94
95 This function retrieves the user readable name of a driver in the form of a
96 Unicode string. If the driver specified by This has a user readable name in
97 the language specified by Language, then a pointer to the driver name is
98 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
99 by This does not support the language specified by Language,
100 then EFI_UNSUPPORTED is returned.
101
102 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
103 EFI_COMPONENT_NAME_PROTOCOL instance.
104
105 @param Language[in] A pointer to a Null-terminated ASCII string
106 array indicating the language. This is the
107 language of the driver name that the caller is
108 requesting, and it must match one of the
109 languages specified in SupportedLanguages. The
110 number of languages supported by a driver is up
111 to the driver writer. Language is specified
112 in RFC 3066 or ISO 639-2 language code format.
113
114 @param DriverName[out] A pointer to the Unicode string to return.
115 This Unicode string is the name of the
116 driver specified by This in the language
117 specified by Language.
118
119 @retval EFI_SUCCESS The Unicode string for the Driver specified by
120 This and the language specified by Language was
121 returned in DriverName.
122
123 @retval EFI_INVALID_PARAMETER Language is NULL.
124
125 @retval EFI_INVALID_PARAMETER DriverName is NULL.
126
127 @retval EFI_UNSUPPORTED The driver specified by This does not support
128 the language specified by Language.
129
130 **/
131 EFI_STATUS
132 EFIAPI
133 GraphicsConsoleComponentNameGetDriverName (
134 IN EFI_COMPONENT_NAME_PROTOCOL *This,
135 IN CHAR8 *Language,
136 OUT CHAR16 **DriverName
137 );
138
139
140 /**
141 Retrieves a Unicode string that is the user readable name of the controller
142 that is being managed by a driver.
143
144 This function retrieves the user readable name of the controller specified by
145 ControllerHandle and ChildHandle in the form of a Unicode string. If the
146 driver specified by This has a user readable name in the language specified by
147 Language, then a pointer to the controller name is returned in ControllerName,
148 and EFI_SUCCESS is returned. If the driver specified by This is not currently
149 managing the controller specified by ControllerHandle and ChildHandle,
150 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
151 support the language specified by Language, then EFI_UNSUPPORTED is returned.
152
153 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
154 EFI_COMPONENT_NAME_PROTOCOL instance.
155
156 @param ControllerHandle[in] The handle of a controller that the driver
157 specified by This is managing. This handle
158 specifies the controller whose name is to be
159 returned.
160
161 @param ChildHandle[in] The handle of the child controller to retrieve
162 the name of. This is an optional parameter that
163 may be NULL. It will be NULL for device
164 drivers. It will also be NULL for a bus drivers
165 that wish to retrieve the name of the bus
166 controller. It will not be NULL for a bus
167 driver that wishes to retrieve the name of a
168 child controller.
169
170 @param Language[in] A pointer to a Null-terminated ASCII string
171 array indicating the language. This is the
172 language of the driver name that the caller is
173 requesting, and it must match one of the
174 languages specified in SupportedLanguages. The
175 number of languages supported by a driver is up
176 to the driver writer. Language is specified in
177 RFC 3066 or ISO 639-2 language code format.
178
179 @param ControllerName[out] A pointer to the Unicode string to return.
180 This Unicode string is the name of the
181 controller specified by ControllerHandle and
182 ChildHandle in the language specified by
183 Language from the point of view of the driver
184 specified by This.
185
186 @retval EFI_SUCCESS The Unicode string for the user readable name in
187 the language specified by Language for the
188 driver specified by This was returned in
189 DriverName.
190
191 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
192
193 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
194 EFI_HANDLE.
195
196 @retval EFI_INVALID_PARAMETER Language is NULL.
197
198 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
199
200 @retval EFI_UNSUPPORTED The driver specified by This is not currently
201 managing the controller specified by
202 ControllerHandle and ChildHandle.
203
204 @retval EFI_UNSUPPORTED The driver specified by This does not support
205 the language specified by Language.
206
207 **/
208 EFI_STATUS
209 EFIAPI
210 GraphicsConsoleComponentNameGetControllerName (
211 IN EFI_COMPONENT_NAME_PROTOCOL *This,
212 IN EFI_HANDLE ControllerHandle,
213 IN EFI_HANDLE ChildHandle OPTIONAL,
214 IN CHAR8 *Language,
215 OUT CHAR16 **ControllerName
216 );
217
218
219
220
221 /**
222 Returns available Unicode glyphs narrow fonts(8*19 pixels) size.
223
224 @return Narrow font size.
225
226 **/
227 UINT32
228 ReturnNarrowFontSize (
229 VOID
230 );
231
232 /**
233 Reset the text output device hardware and optionally run diagnostics.
234
235 Implements SIMPLE_TEXT_OUTPUT.Reset().
236 If ExtendeVerification is TRUE, then perform dependent Graphics Console
237 device reset, and set display mode to mode 0.
238 If ExtendedVerification is FALSE, only set display mode to mode 0.
239
240 @param This Protocol instance pointer.
241 @param ExtendedVerification Indicates that the driver may perform a more
242 exhaustive verification operation of the device
243 during reset.
244
245 @retval EFI_SUCCESS The text output device was reset.
246 @retval EFI_DEVICE_ERROR The text output device is not functioning correctly and
247 could not be reset.
248
249 **/
250 EFI_STATUS
251 EFIAPI
252 GraphicsConsoleConOutReset (
253 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
254 IN BOOLEAN ExtendedVerification
255 );
256
257 /**
258 Write a Unicode string to the output device.
259
260 Implements SIMPLE_TEXT_OUTPUT.OutputString().
261 The Unicode string will be converted to Glyphs and will be
262 sent to the Graphics Console.
263
264 @param This Protocol instance pointer.
265 @param WString The NULL-terminated Unicode string to be displayed
266 on the output device(s). All output devices must
267 also support the Unicode drawing defined in this file.
268
269 @retval EFI_SUCCESS The string was output to the device.
270 @retval EFI_DEVICE_ERROR The device reported an error while attempting to output
271 the text.
272 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
273 defined text mode.
274 @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the
275 characters in the Unicode string could not be
276 rendered and were skipped.
277
278 **/
279 EFI_STATUS
280 EFIAPI
281 GraphicsConsoleConOutOutputString (
282 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
283 IN CHAR16 *WString
284 );
285
286 /**
287 Implements SIMPLE_TEXT_OUTPUT.TestString().
288 If one of the characters in the *Wstring is
289 neither valid valid Unicode drawing characters,
290 not ASCII code, then this function will return
291 EFI_UNSUPPORTED.
292
293 @param This Indicates the calling context.
294 @param WString The Null-terminated Unicode string to be tested.
295
296 @return EFI_SUCCESS
297 @return The Graphics Console is capable of rendering the output string.
298 @return EFI_UNSUPPORTED
299 @return Some of the characters in the Unicode string cannot be rendered.
300
301 **/
302 EFI_STATUS
303 EFIAPI
304 GraphicsConsoleConOutTestString (
305 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
306 IN CHAR16 *WString
307 );
308
309 /**
310 Returns information for an available text mode that the output device(s)
311 supports
312
313 Implements SIMPLE_TEXT_OUTPUT.QueryMode().
314 It returnes information for an available text mode that the Graphics Console supports.
315 In this driver,we only support text mode 80x25, which is defined as mode 0.
316
317 @param This Protocol instance pointer.
318 @param ModeNumber The mode number to return information on.
319 @param Columns The returned columns of the requested mode.
320 @param Rows The returned rows of the requested mode.
321
322 @retval EFI_SUCCESS The requested mode information is returned.
323 @retval EFI_UNSUPPORTED The mode number is not valid.
324
325 **/
326 EFI_STATUS
327 EFIAPI
328 GraphicsConsoleConOutQueryMode (
329 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
330 IN UINTN ModeNumber,
331 OUT UINTN *Columns,
332 OUT UINTN *Rows
333 );
334
335
336 /**
337 Sets the output device(s) to a specified mode.
338
339 Implements SIMPLE_TEXT_OUTPUT.SetMode().
340 Set the Graphics Console to a specified mode. In this driver, we only support mode 0.
341
342 @param This Protocol instance pointer.
343 @param ModeNumber The text mode to set.
344
345 @retval EFI_SUCCESS The requested text mode is set.
346 @retval EFI_DEVICE_ERROR The requested text mode cannot be set because of
347 Graphics Console device error.
348 @retval EFI_UNSUPPORTED The text mode number is not valid.
349
350 **/
351 EFI_STATUS
352 EFIAPI
353 GraphicsConsoleConOutSetMode (
354 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
355 IN UINTN ModeNumber
356 );
357
358 /**
359 Implements SIMPLE_TEXT_OUTPUT.SetAttribute().
360
361 @param This Indicates the calling context.
362 @param Attribute The attribute to set. Only bit0..6 are valid, all
363 other bits are undefined and must be zero.
364
365 @return EFI_SUCCESS The requested attribute is set.
366 @return EFI_DEVICE_ERROR The requested attribute cannot be set due to Graphics Console port error.
367 @return EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.
368
369 **/
370 EFI_STATUS
371 EFIAPI
372 GraphicsConsoleConOutSetAttribute (
373 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
374 IN UINTN Attribute
375 );
376
377 /**
378 Clears the output device(s) display to the currently selected background
379 color.
380
381 Implements SIMPLE_TEXT_OUTPUT.ClearScreen().
382
383 @param This Protocol instance pointer.
384
385 @retval EFI_SUCCESS The operation completed successfully.
386 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
387 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
388
389 **/
390 EFI_STATUS
391 EFIAPI
392 GraphicsConsoleConOutClearScreen (
393 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This
394 );
395
396 /**
397 Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition().
398
399 @param This Indicates the calling context.
400 @param Column The row to set cursor to.
401 @param Row The column to set cursor to.
402
403 @return EFI_SUCCESS
404 @return The operation completed successfully.
405 @return EFI_DEVICE_ERROR
406 @return The request fails due to Graphics Console device error.
407 @return EFI_UNSUPPORTED
408 @return The Graphics Console is not in a valid text mode, or the cursor position
409 @return is invalid for current mode.
410
411 **/
412 EFI_STATUS
413 EFIAPI
414 GraphicsConsoleConOutSetCursorPosition (
415 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
416 IN UINTN Column,
417 IN UINTN Row
418 );
419
420
421 /**
422 Makes the cursor visible or invisible.
423
424 Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
425
426 @param This Protocol instance pointer.
427 @param Visible If TRUE, the cursor is set to be visible, If FALSE,
428 the cursor is set to be invisible.
429
430 @retval EFI_SUCCESS The operation completed successfully.
431
432 **/
433 EFI_STATUS
434 EFIAPI
435 GraphicsConsoleConOutEnableCursor (
436 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
437 IN BOOLEAN Visible
438 );
439
440 /**
441 Test to see if Graphics Console could be supported on the Controller.
442
443 Graphics Console could be supported if Graphics Output Protocol or UGA Draw
444 Protocol exists on the Controller. (UGA Draw Protocol could be skipped
445 if PcdUgaConsumeSupport is set to FALSE.)
446
447 @param This Protocol instance pointer.
448 @param Controller Handle of device to test.
449 @param RemainingDevicePath Optional parameter use to pick a specific child
450 device to start.
451
452 @retval EFI_SUCCESS This driver supports this device.
453 @retval other This driver does not support this device.
454
455 **/
456 EFI_STATUS
457 EFIAPI
458 GraphicsConsoleControllerDriverSupported (
459 IN EFI_DRIVER_BINDING_PROTOCOL *This,
460 IN EFI_HANDLE Controller,
461 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
462 );
463
464
465 /**
466 Start this driver on Controller by opening Graphics Output protocol or
467 UGA Draw protocol, and installing Simple Text Out protocol on Controller.
468 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
469
470 @param This Protocol instance pointer.
471 @param Controller Handle of device to bind driver to
472 @param RemainingDevicePath Optional parameter use to pick a specific child
473 device to start.
474
475 @retval EFI_SUCCESS This driver is added to Controller.
476 @retval other This driver does not support this device.
477
478 **/
479 EFI_STATUS
480 EFIAPI
481 GraphicsConsoleControllerDriverStart (
482 IN EFI_DRIVER_BINDING_PROTOCOL *This,
483 IN EFI_HANDLE Controller,
484 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
485 );
486
487 /**
488 Stop this driver on Controller by removing Simple Text Out protocol
489 and closing the Graphics Output Protocol or UGA Draw protocol on Controller.
490 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
491
492
493 @param This Protocol instance pointer.
494 @param Controller Handle of device to stop driver on
495 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
496 children is zero stop the entire bus driver.
497 @param ChildHandleBuffer List of Child Handles to Stop.
498
499 @retval EFI_SUCCESS This driver is removed Controller.
500 @retval EFI_NOT_STARTED Simple Text Out protocol could not be found the
501 Controller.
502 @retval other This driver was not removed from this device.
503
504 **/
505 EFI_STATUS
506 EFIAPI
507 GraphicsConsoleControllerDriverStop (
508 IN EFI_DRIVER_BINDING_PROTOCOL *This,
509 IN EFI_HANDLE Controller,
510 IN UINTN NumberOfChildren,
511 IN EFI_HANDLE *ChildHandleBuffer
512 );
513
514
515 /**
516 Locate HII Database protocol and HII Font protocol.
517
518 @retval EFI_SUCCESS HII Database protocol and HII Font protocol
519 are located successfully.
520 @return other Failed to locate HII Database protocol or
521 HII Font protocol.
522
523 **/
524 EFI_STATUS
525 EfiLocateHiiProtocol (
526 VOID
527 );
528
529
530 #endif