[efi] Add EFI image format and basic runtime environment
[people/sha0/gpxe.git] / src / interface / efi / efi_console.c
1 /*
2  * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stddef.h>
20 #include <assert.h>
21 #include <gpxe/efi/efi.h>
22 #include <gpxe/ansiesc.h>
23 #include <console.h>
24
25 #define ATTR_BOLD               0x08
26
27 #define ATTR_FCOL_MASK          0x07
28 #define ATTR_FCOL_BLACK         0x00
29 #define ATTR_FCOL_BLUE          0x01
30 #define ATTR_FCOL_GREEN         0x02
31 #define ATTR_FCOL_CYAN          0x03
32 #define ATTR_FCOL_RED           0x04
33 #define ATTR_FCOL_MAGENTA       0x05
34 #define ATTR_FCOL_YELLOW        0x06
35 #define ATTR_FCOL_WHITE         0x07
36
37 #define ATTR_BCOL_MASK          0x70
38 #define ATTR_BCOL_BLACK         0x00
39 #define ATTR_BCOL_BLUE          0x10
40 #define ATTR_BCOL_GREEN         0x20
41 #define ATTR_BCOL_CYAN          0x30
42 #define ATTR_BCOL_RED           0x40
43 #define ATTR_BCOL_MAGENTA       0x50
44 #define ATTR_BCOL_YELLOW        0x60
45 #define ATTR_BCOL_WHITE         0x70
46
47 #define ATTR_DEFAULT            ATTR_FCOL_WHITE
48
49 /** Current character attribute */
50 static unsigned int efi_attr = ATTR_DEFAULT;
51
52 /**
53  * Handle ANSI CUP (cursor position)
54  *
55  * @v count             Parameter count
56  * @v params[0]         Row (1 is top)
57  * @v params[1]         Column (1 is left)
58  */
59 static void efi_handle_cup ( unsigned int count __unused, int params[] ) {
60         EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
61         int cx = ( params[1] - 1 );
62         int cy = ( params[0] - 1 );
63
64         if ( cx < 0 )
65                 cx = 0;
66         if ( cy < 0 )
67                 cy = 0;
68
69         conout->SetCursorPosition ( conout, cx, cy );
70 }
71
72 /**
73  * Handle ANSI ED (erase in page)
74  *
75  * @v count             Parameter count
76  * @v params[0]         Region to erase
77  */
78 static void efi_handle_ed ( unsigned int count __unused,
79                              int params[] __unused ) {
80         EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
81
82         /* We assume that we always clear the whole screen */
83         assert ( params[0] == ANSIESC_ED_ALL );
84
85         conout->ClearScreen ( conout );
86 }
87
88 /**
89  * Handle ANSI SGR (set graphics rendition)
90  *
91  * @v count             Parameter count
92  * @v params            List of graphic rendition aspects
93  */
94 static void efi_handle_sgr ( unsigned int count, int params[] ) {
95         EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
96         static const uint8_t efi_attr_fcols[10] = {
97                 ATTR_FCOL_BLACK, ATTR_FCOL_RED, ATTR_FCOL_GREEN,
98                 ATTR_FCOL_YELLOW, ATTR_FCOL_BLUE, ATTR_FCOL_MAGENTA,
99                 ATTR_FCOL_CYAN, ATTR_FCOL_WHITE,
100                 ATTR_FCOL_WHITE, ATTR_FCOL_WHITE /* defaults */
101         };
102         static const uint8_t efi_attr_bcols[10] = {
103                 ATTR_BCOL_BLACK, ATTR_BCOL_RED, ATTR_BCOL_GREEN,
104                 ATTR_BCOL_YELLOW, ATTR_BCOL_BLUE, ATTR_BCOL_MAGENTA,
105                 ATTR_BCOL_CYAN, ATTR_BCOL_WHITE,
106                 ATTR_BCOL_BLACK, ATTR_BCOL_BLACK /* defaults */
107         };
108         unsigned int i;
109         int aspect;
110
111         for ( i = 0 ; i < count ; i++ ) {
112                 aspect = params[i];
113                 if ( aspect == 0 ) {
114                         efi_attr = ATTR_DEFAULT;
115                 } else if ( aspect == 1 ) {
116                         efi_attr |= ATTR_BOLD;
117                 } else if ( aspect == 22 ) {
118                         efi_attr &= ~ATTR_BOLD;
119                 } else if ( ( aspect >= 30 ) && ( aspect <= 39 ) ) {
120                         efi_attr &= ~ATTR_FCOL_MASK;
121                         efi_attr |= efi_attr_fcols[ aspect - 30 ];
122                 } else if ( ( aspect >= 40 ) && ( aspect <= 49 ) ) {
123                         efi_attr &= ~ATTR_BCOL_MASK;
124                         efi_attr |= efi_attr_bcols[ aspect - 40 ];
125                 }
126         }
127
128         conout->SetAttribute ( conout, efi_attr );
129 }
130
131 /** EFI console ANSI escape sequence handlers */
132 static struct ansiesc_handler efi_ansiesc_handlers[] = {
133         { ANSIESC_CUP, efi_handle_cup },
134         { ANSIESC_ED, efi_handle_ed },
135         { ANSIESC_SGR, efi_handle_sgr },
136         { 0, NULL }
137 };
138
139 /** EFI console ANSI escape sequence context */
140 static struct ansiesc_context efi_ansiesc_ctx = {
141         .handlers = efi_ansiesc_handlers,
142 };
143
144 /**
145  * Print a character to EFI console
146  *
147  * @v character         Character to be printed
148  */
149 static void efi_putchar ( int character ) {
150         EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
151         wchar_t wstr[] = { character, 0 };
152
153         /* Intercept ANSI escape sequences */
154         character = ansiesc_process ( &efi_ansiesc_ctx, character );
155         if ( character < 0 )
156                 return;
157
158         conout->OutputString ( conout, wstr );
159 }
160
161 /**
162  * Pointer to current ANSI output sequence
163  *
164  * While we are in the middle of returning an ANSI sequence for a
165  * special key, this will point to the next character to return.  When
166  * not in the middle of such a sequence, this will point to a NUL
167  * (note: not "will be NULL").
168  */
169 static const char *ansi_input = "";
170
171 /** Mapping from EFI scan codes to ANSI escape sequences */
172 static const char *ansi_sequences[] = {
173         [SCAN_UP] = "[A",
174         [SCAN_DOWN] = "[B",
175         [SCAN_RIGHT] = "[C",
176         [SCAN_LEFT] = "[D",
177         [SCAN_HOME] = "[H",
178         [SCAN_END] = "[F",
179         [SCAN_INSERT] = "[2~",
180         /* EFI translates an incoming backspace via the serial console
181          * into a SCAN_DELETE.  There's not much we can do about this.
182          */
183         [SCAN_DELETE] = "[3~",
184         [SCAN_PAGE_UP] = "[5~",
185         [SCAN_PAGE_DOWN] = "[6~",
186         /* EFI translates some (but not all) incoming escape sequences
187          * via the serial console into equivalent scancodes.  When it
188          * doesn't recognise a sequence, it helpfully(!) translates
189          * the initial ESC and passes the remainder through verbatim.
190          * Treating SCAN_ESC as equivalent to an empty escape sequence
191          * works around this bug.
192          */
193         [SCAN_ESC] = "",
194 };
195
196 /**
197  * Get ANSI escape sequence corresponding to EFI scancode
198  *
199  * @v scancode          EFI scancode
200  * @ret ansi_seq        ANSI escape sequence, if any, otherwise NULL
201  */
202 static const char * scancode_to_ansi_seq ( unsigned int scancode ) {
203         if ( scancode < ( sizeof ( ansi_sequences ) /
204                           sizeof ( ansi_sequences[0] ) ) ) {
205                 return ansi_sequences[scancode];
206         }
207         return NULL;
208 }
209
210 /**
211  * Get character from EFI console
212  *
213  * @ret character       Character read from console
214  */
215 static int efi_getchar ( void ) {
216         EFI_SIMPLE_TEXT_INPUT_PROTOCOL *conin = efi_systab->ConIn;
217         const char *ansi_seq;
218         EFI_INPUT_KEY key;
219         EFI_STATUS efirc;
220
221         /* If we are mid-sequence, pass out the next byte */
222         if ( *ansi_input )
223                 return *(ansi_input++);
224
225         /* Read key from real EFI console */
226         if ( ( efirc = conin->ReadKeyStroke ( conin, &key ) ) != 0 ) {
227                 DBG ( "EFI could not read keystroke: %lx\n", efirc );
228                 return 0;
229         }
230         DBG2 ( "EFI read key stroke with unicode %04x scancode %04x\n",
231                key.UnicodeChar, key.ScanCode );
232
233         /* If key has a Unicode representation, return it */
234         if ( key.UnicodeChar )
235                 return key.UnicodeChar;
236
237         /* Otherwise, check for a special key that we know about */
238         if ( ( ansi_seq = scancode_to_ansi_seq ( key.ScanCode ) ) ) {
239                 /* Start of escape sequence: return ESC (0x1b) */
240                 ansi_input = ansi_seq;
241                 return 0x1b;
242         }
243
244         return 0;
245 }
246
247 /**
248  * Check for character ready to read from EFI console
249  *
250  * @ret True            Character available to read
251  * @ret False           No character available to read
252  */
253 static int efi_iskey ( void ) {
254         EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
255         EFI_SIMPLE_TEXT_INPUT_PROTOCOL *conin = efi_systab->ConIn;
256         EFI_STATUS efirc;
257
258         /* If we are mid-sequence, we are always ready */
259         if ( *ansi_input )
260                 return 1;
261
262         /* Check to see if the WaitForKey event has fired */
263         if ( ( efirc = bs->CheckEvent ( conin->WaitForKey ) ) == 0 )
264                 return 1;
265
266         return 0;
267 }
268
269 struct console_driver efi_console __console_driver = {
270         .putchar = efi_putchar,
271         .getchar = efi_getchar,
272         .iskey = efi_iskey,
273 };