]>
Commit | Line | Data |
---|---|---|
88f20127 | 1 | /*++ \r |
2 | \r | |
62409219 | 3 | Copyright (c) 2006 - 2007, Intel Corporation \r |
88f20127 | 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 | ConsoleControl.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
62409219 | 18 | Abstraction of a Text mode or GOP/UGA screen\r |
88f20127 | 19 | \r |
20 | --*/\r | |
21 | \r | |
22 | #ifndef __CONSOLE_CONTROL_H__\r | |
23 | #define __CONSOLE_CONTROL_H__\r | |
24 | \r | |
25 | #define EFI_CONSOLE_CONTROL_PROTOCOL_GUID \\r | |
26 | { 0xf42f7782, 0x12e, 0x4c12, {0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21 } }\r | |
27 | \r | |
28 | typedef struct _EFI_CONSOLE_CONTROL_PROTOCOL EFI_CONSOLE_CONTROL_PROTOCOL;\r | |
29 | \r | |
30 | \r | |
31 | typedef enum {\r | |
32 | EfiConsoleControlScreenText,\r | |
33 | EfiConsoleControlScreenGraphics,\r | |
34 | EfiConsoleControlScreenMaxValue\r | |
35 | } EFI_CONSOLE_CONTROL_SCREEN_MODE;\r | |
36 | \r | |
37 | \r | |
38 | typedef\r | |
39 | EFI_STATUS\r | |
40 | (EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE) (\r | |
41 | IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r | |
42 | OUT EFI_CONSOLE_CONTROL_SCREEN_MODE *Mode,\r | |
62409219 | 43 | OUT BOOLEAN *GopUgaExists, OPTIONAL \r |
44 | OUT BOOLEAN *StdInLocked OPTIONAL\r | |
88f20127 | 45 | )\r |
46 | /*++\r | |
47 | \r | |
48 | Routine Description:\r | |
49 | Return the current video mode information. Also returns info about existence\r | |
62409219 | 50 | of Graphics Output devices or UGA Draw devices in system, and if the Std In\r |
51 | device is locked. All the arguments are optional and only returned if a non\r | |
52 | NULL pointer is passed in.\r | |
88f20127 | 53 | \r |
54 | Arguments:\r | |
55 | This - Protocol instance pointer.\r | |
56 | Mode - Are we in text of grahics mode.\r | |
62409219 | 57 | GopUgaExists - TRUE if Console Spliter has found a GOP or UGA device\r |
88f20127 | 58 | StdInLocked - TRUE if StdIn device is keyboard locked\r |
59 | \r | |
60 | Returns:\r | |
61 | EFI_SUCCESS - Mode information returned.\r | |
62 | \r | |
63 | --*/\r | |
64 | ;\r | |
65 | \r | |
66 | \r | |
67 | typedef\r | |
68 | EFI_STATUS\r | |
69 | (EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE) (\r | |
70 | IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r | |
71 | OUT EFI_CONSOLE_CONTROL_SCREEN_MODE Mode\r | |
72 | )\r | |
73 | /*++\r | |
74 | \r | |
75 | Routine Description:\r | |
76 | Set the current mode to either text or graphics. Graphics is\r | |
77 | for Quiet Boot.\r | |
78 | \r | |
79 | Arguments:\r | |
80 | This - Protocol instance pointer.\r | |
81 | Mode - Mode to set the \r | |
82 | \r | |
83 | Returns:\r | |
84 | EFI_SUCCESS - Mode information returned.\r | |
85 | \r | |
86 | --*/\r | |
87 | ;\r | |
88 | \r | |
89 | \r | |
90 | typedef\r | |
91 | EFI_STATUS\r | |
92 | (EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN) (\r | |
93 | IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r | |
94 | IN CHAR16 *Password\r | |
95 | )\r | |
96 | /*++\r | |
97 | \r | |
98 | Routine Description:\r | |
99 | Lock Std In devices until Password is typed.\r | |
100 | \r | |
101 | Arguments:\r | |
102 | This - Protocol instance pointer.\r | |
103 | Password - Password needed to unlock screen. NULL means unlock keyboard\r | |
104 | \r | |
105 | Returns:\r | |
106 | EFI_SUCCESS - Mode information returned.\r | |
107 | EFI_DEVICE_ERROR - Std In not locked\r | |
108 | \r | |
109 | --*/\r | |
110 | ;\r | |
111 | \r | |
112 | \r | |
113 | \r | |
114 | struct _EFI_CONSOLE_CONTROL_PROTOCOL {\r | |
115 | EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE GetMode;\r | |
116 | EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE SetMode;\r | |
117 | EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN LockStdIn;\r | |
118 | };\r | |
119 | \r | |
120 | extern EFI_GUID gEfiConsoleControlProtocolGuid;\r | |
121 | \r | |
122 | #endif\r |