2 Header file for GraphicsConsole driver.
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
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.
15 #ifndef _GRAPHICS_CONSOLE_H_
16 #define _GRAPHICS_CONSOLE_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>
33 #include <MdeModuleHii.h>
35 #include <Protocol/HiiFont.h>
36 #include <Protocol/HiiDatabase.h>
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
[];
46 // User can define valid graphic resolution here
47 // e.g. 640x480, 800x600, 1024x768...
49 #define CURRENT_HORIZONTAL_RESOLUTION 800
50 #define CURRENT_VERTICAL_RESOLUTION 600
53 EFI_NARROW_GLYPH NarrowGlyph
;
54 EFI_WIDE_GLYPH WideGlyph
;
60 #define GRAPHICS_CONSOLE_DEV_SIGNATURE SIGNATURE_32 ('g', 's', 't', 'o')
70 } GRAPHICS_CONSOLE_MODE_DATA
;
72 #define GRAPHICS_MAX_MODE 4
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
;
85 #define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \
86 CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)
90 // EFI Component Name Functions
93 Retrieves a Unicode string that is the user readable name of the driver.
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.
102 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
103 EFI_COMPONENT_NAME_PROTOCOL instance.
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.
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.
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.
123 @retval EFI_INVALID_PARAMETER Language is NULL.
125 @retval EFI_INVALID_PARAMETER DriverName is NULL.
127 @retval EFI_UNSUPPORTED The driver specified by This does not support
128 the language specified by Language.
133 GraphicsConsoleComponentNameGetDriverName (
134 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
136 OUT CHAR16
**DriverName
141 Retrieves a Unicode string that is the user readable name of the controller
142 that is being managed by a driver.
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.
153 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
154 EFI_COMPONENT_NAME_PROTOCOL instance.
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
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
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.
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
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
191 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
193 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
196 @retval EFI_INVALID_PARAMETER Language is NULL.
198 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
200 @retval EFI_UNSUPPORTED The driver specified by This is not currently
201 managing the controller specified by
202 ControllerHandle and ChildHandle.
204 @retval EFI_UNSUPPORTED The driver specified by This does not support
205 the language specified by Language.
210 GraphicsConsoleComponentNameGetControllerName (
211 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
212 IN EFI_HANDLE ControllerHandle
,
213 IN EFI_HANDLE ChildHandle OPTIONAL
,
215 OUT CHAR16
**ControllerName
222 Returns available Unicode glyphs narrow fonts(8*19 pixels) size.
224 @return Narrow font size.
228 ReturnNarrowFontSize (
233 Reset the text output device hardware and optionally run diagnostics.
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.
240 @param This Protocol instance pointer.
241 @param ExtendedVerification Indicates that the driver may perform a more
242 exhaustive verification operation of the device
245 @retval EFI_SUCCESS The text output device was reset.
246 @retval EFI_DEVICE_ERROR The text output device is not functioning correctly and
252 GraphicsConsoleConOutReset (
253 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
254 IN BOOLEAN ExtendedVerification
258 Write a Unicode string to the output device.
260 Implements SIMPLE_TEXT_OUTPUT.OutputString().
261 The Unicode string will be converted to Glyphs and will be
262 sent to the Graphics Console.
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.
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
272 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
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.
281 GraphicsConsoleConOutOutputString (
282 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
287 Verifies that all characters in a Unicode string can be output to the
290 Implements SIMPLE_TEXT_OUTPUT.TestString().
291 If one of the characters in the *Wstring is neither valid valid Unicode
292 drawing characters, not ASCII code, then this function will return
295 @param This Protocol instance pointer.
296 @param WString The NULL-terminated Unicode string to be examined for the output
299 @retval EFI_SUCCESS The device(s) are capable of rendering the output string.
300 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be
301 rendered by one or more of the output devices mapped
307 GraphicsConsoleConOutTestString (
308 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
313 Returns information for an available text mode that the output device(s)
316 Implements SIMPLE_TEXT_OUTPUT.QueryMode().
317 It returnes information for an available text mode that the Graphics Console supports.
318 In this driver,we only support text mode 80x25, which is defined as mode 0.
320 @param This Protocol instance pointer.
321 @param ModeNumber The mode number to return information on.
322 @param Columns The returned columns of the requested mode.
323 @param Rows The returned rows of the requested mode.
325 @retval EFI_SUCCESS The requested mode information is returned.
326 @retval EFI_UNSUPPORTED The mode number is not valid.
331 GraphicsConsoleConOutQueryMode (
332 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
340 Sets the output device(s) to a specified mode.
342 Implements SIMPLE_TEXT_OUTPUT.SetMode().
343 Set the Graphics Console to a specified mode. In this driver, we only support mode 0.
345 @param This Protocol instance pointer.
346 @param ModeNumber The text mode to set.
348 @retval EFI_SUCCESS The requested text mode is set.
349 @retval EFI_DEVICE_ERROR The requested text mode cannot be set because of
350 Graphics Console device error.
351 @retval EFI_UNSUPPORTED The text mode number is not valid.
356 GraphicsConsoleConOutSetMode (
357 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
362 Sets the background and foreground colors for the OutputString () and
363 ClearScreen () functions.
365 Implements SIMPLE_TEXT_OUTPUT.SetAttribute().
367 @param This Protocol instance pointer.
368 @param Attribute The attribute to set. Bits 0..3 are the foreground
369 color, and bits 4..6 are the background color.
370 All other bits are undefined and must be zero.
372 @retval EFI_SUCCESS The requested attribute is set.
373 @retval EFI_DEVICE_ERROR The requested attribute cannot be set due to Graphics Console port error.
374 @retval EFI_UNSUPPORTED The attribute requested is not defined.
379 GraphicsConsoleConOutSetAttribute (
380 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
385 Clears the output device(s) display to the currently selected background
388 Implements SIMPLE_TEXT_OUTPUT.ClearScreen().
390 @param This Protocol instance pointer.
392 @retval EFI_SUCCESS The operation completed successfully.
393 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
394 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
399 GraphicsConsoleConOutClearScreen (
400 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
404 Sets the current coordinates of the cursor position.
406 Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition().
408 @param This Protocol instance pointer.
409 @param Column The position to set the cursor to. Must be greater than or
410 equal to zero and less than the number of columns and rows
412 @param Row The position to set the cursor to. Must be greater than or
413 equal to zero and less than the number of columns and rows
416 @retval EFI_SUCCESS The operation completed successfully.
417 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
418 @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or the
419 cursor position is invalid for the current mode.
424 GraphicsConsoleConOutSetCursorPosition (
425 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
432 Makes the cursor visible or invisible.
434 Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
436 @param This Protocol instance pointer.
437 @param Visible If TRUE, the cursor is set to be visible, If FALSE,
438 the cursor is set to be invisible.
440 @retval EFI_SUCCESS The operation completed successfully.
445 GraphicsConsoleConOutEnableCursor (
446 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
451 Test to see if Graphics Console could be supported on the Controller.
453 Graphics Console could be supported if Graphics Output Protocol or UGA Draw
454 Protocol exists on the Controller. (UGA Draw Protocol could be skipped
455 if PcdUgaConsumeSupport is set to FALSE.)
457 @param This Protocol instance pointer.
458 @param Controller Handle of device to test.
459 @param RemainingDevicePath Optional parameter use to pick a specific child
462 @retval EFI_SUCCESS This driver supports this device.
463 @retval other This driver does not support this device.
468 GraphicsConsoleControllerDriverSupported (
469 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
470 IN EFI_HANDLE Controller
,
471 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
476 Start this driver on Controller by opening Graphics Output protocol or
477 UGA Draw protocol, and installing Simple Text Out protocol on Controller.
478 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
480 @param This Protocol instance pointer.
481 @param Controller Handle of device to bind driver to
482 @param RemainingDevicePath Optional parameter use to pick a specific child
485 @retval EFI_SUCCESS This driver is added to Controller.
486 @retval other This driver does not support this device.
491 GraphicsConsoleControllerDriverStart (
492 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
493 IN EFI_HANDLE Controller
,
494 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
498 Stop this driver on Controller by removing Simple Text Out protocol
499 and closing the Graphics Output Protocol or UGA Draw protocol on Controller.
500 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
503 @param This Protocol instance pointer.
504 @param Controller Handle of device to stop driver on
505 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
506 children is zero stop the entire bus driver.
507 @param ChildHandleBuffer List of Child Handles to Stop.
509 @retval EFI_SUCCESS This driver is removed Controller.
510 @retval EFI_NOT_STARTED Simple Text Out protocol could not be found the
512 @retval other This driver was not removed from this device.
517 GraphicsConsoleControllerDriverStop (
518 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
519 IN EFI_HANDLE Controller
,
520 IN UINTN NumberOfChildren
,
521 IN EFI_HANDLE
*ChildHandleBuffer
526 Locate HII Database protocol and HII Font protocol.
528 @retval EFI_SUCCESS HII Database protocol and HII Font protocol
529 are located successfully.
530 @return other Failed to locate HII Database protocol or
535 EfiLocateHiiProtocol (
541 Gets Graphics Console devcie's foreground color and background color.
543 @param This Protocol instance pointer.
544 @param Foreground Returned text foreground color.
545 @param Background Returned text background color.
547 @retval EFI_SUCCESS It returned always.
552 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
553 OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Foreground
,
554 OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Background
558 Draw Unicode string on the Graphics Console device's screen.
560 @param This Protocol instance pointer.
561 @param UnicodeWeight One Unicode string to be displayed.
562 @param Count The count of Unicode string.
564 @retval EFI_OUT_OF_RESOURCES If no memory resource to use.
565 @retval EFI_UNSUPPORTED If no Graphics Output protocol and UGA Draw
567 @retval EFI_SUCCESS Drawing Unicode string implemented successfully.
571 DrawUnicodeWeightAtCursorN (
572 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
573 IN CHAR16
*UnicodeWeight
,
578 Erase the cursor on the screen.
580 @param This Protocol instance pointer.
582 @retval EFI_SUCCESS The cursor is erased successfully.
587 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
591 Check if the current specific mode supported the user defined resolution
592 for the Graphics Console device based on Graphics Output Protocol.
594 If yes, set the graphic device's current mode to this specific mode.
596 @param GraphicsOutput Graphics Output Protocol instance pointer.
597 @param HorizontalResolution User defined horizontal resolution
598 @param VerticalResolution User defined vertical resolution.
599 @param CurrentModeNumber Current specific mode to be check.
601 @retval EFI_SUCCESS The mode is supported.
602 @retval EFI_UNSUPPORTED The specific mode is out of range of graphics
604 @retval other The specific mode does not support user defined
605 resolution or failed to set the current mode to the
606 specific mode on graphics device.
611 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
612 IN UINT32 HorizontalResolution
,
613 IN UINT32 VerticalResolution
,
614 OUT UINT32
*CurrentModeNumber