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