src/include/console/console.h

   1 /*
   2  * This file is part of the coreboot project.
   3  *
   4  * Copyright (C) 2003 Eric Biederman
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; version 2 of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef CONSOLE_CONSOLE_H_
  21 #define CONSOLE_CONSOLE_H_
  22
  23 #include <console/loglevel.h>
  24
  25 #ifndef __PRE_RAM__
  26 void console_tx_byte(unsigned char byte);
  27 void console_tx_flush(void);
  28 unsigned char console_rx_byte(void);
  29 int console_tst_byte(void);
  30 #if CONFIG_CONSOLE_VGA == 1
  31 void vga_console_init(void);
  32 #endif
  33 #if CONFIG_USBDEBUG
  34 #include <usbdebug.h>
  35 #endif
  36
  37 struct console_driver {
  38         void (*init)(void);
  39         void (*tx_byte)(unsigned char byte);
  40         void (*tx_flush)(void);
  41         unsigned char (*rx_byte)(void);
  42         int (*tst_byte)(void);
  43 };
  44
  45 #define __console       __attribute__((used, __section__ (".rodata.console_drivers")))
  46
  47 /* Defined by the linker... */
  48 extern struct console_driver console_drivers[];
  49 extern struct console_driver econsole_drivers[];
  50
  51 extern int console_loglevel;
  52 #else
  53 /* __PRE_RAM__ */
  54 /* Using a global varible can cause problems when we reset the stack
  55  * from cache as ram to ram. If we make this a define USE_SHARED_STACK
  56  * we could use the same code on all architectures.
  57  */
  58 #define console_loglevel CONFIG_DEFAULT_CONSOLE_LOGLEVEL
  59 #endif
  60
  61 #ifndef __ROMCC__
  62 void console_init(void);
  63 void post_code(u8 value);
  64 void __attribute__ ((noreturn)) die(const char *msg);
  65 int do_printk(int msg_level, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
  66
  67 #undef WE_CLEANED_UP_ALL_SIDE_EFFECTS
  68 /* We saw some strange effects in the past like coreboot crashing while
  69  * disabling cache as ram for a maximum console log level of 6 and above while
  70  * it worked fine without. In order to catch such issues reliably we are
  71  * always doing a function call to do_printk with the full number of arguments.
  72  * Our favorite reason to do it this way was:
  73  *   disable_car();
  74  *   printk(BIOS_DEBUG, "CAR disabled\n"); // oops, garbage stack pointer
  75  *   move_stack();
  76  * This slightly increases the code size and some unprinted strings will end
  77  * up in the final coreboot binary (most of them compressed). If you want to
  78  * avoid this, do a
  79  * #define WE_CLEANED_UP_ALL_SIDE_EFFECTS
  80  */
  81 #ifdef WE_CLEANED_UP_ALL_SIDE_EFFECTS
  82
  83 #define printk(LEVEL, fmt, args...)                             \
  84         do {                                                    \
  85                 if (CONFIG_MAXIMUM_CONSOLE_LOGLEVEL >= LEVEL) { \
  86                         do_printk(LEVEL, fmt, ##args);          \
  87                 }                                               \
  88         } while(0)
  89
  90 #else
  91
  92 #define printk(LEVEL, fmt, args...)                             \
  93         do {                                                    \
  94                 if (CONFIG_MAXIMUM_CONSOLE_LOGLEVEL >= LEVEL) { \
  95                         do_printk(LEVEL, fmt, ##args);          \
  96                 } else {                                        \
  97                         do_printk(BIOS_NEVER, fmt, ##args);     \
  98                 }                                               \
  99         } while(0)
 100 #endif
 101
 102 #define print_emerg(STR)         printk(BIOS_EMERG,  "%s", (STR))
 103 #define print_alert(STR)         printk(BIOS_ALERT,  "%s", (STR))
 104 #define print_crit(STR)          printk(BIOS_CRIT,   "%s", (STR))
 105 #define print_err(STR)           printk(BIOS_ERR,    "%s", (STR))
 106 #define print_warning(STR)       printk(BIOS_WARNING,"%s", (STR))
 107 #define print_notice(STR)        printk(BIOS_NOTICE, "%s", (STR))
 108 #define print_info(STR)          printk(BIOS_INFO,   "%s", (STR))
 109 #define print_debug(STR)         printk(BIOS_DEBUG,  "%s", (STR))
 110 #define print_spew(STR)          printk(BIOS_SPEW,   "%s", (STR))
 111
 112 #define print_emerg_char(CH)     printk(BIOS_EMERG,  "%c", (CH))
 113 #define print_alert_char(CH)     printk(BIOS_ALERT,  "%c", (CH))
 114 #define print_crit_char(CH)      printk(BIOS_CRIT,   "%c", (CH))
 115 #define print_err_char(CH)       printk(BIOS_ERR,    "%c", (CH))
 116 #define print_warning_char(CH)   printk(BIOS_WARNING,"%c", (CH))
 117 #define print_notice_char(CH)    printk(BIOS_NOTICE, "%c", (CH))
 118 #define print_info_char(CH)      printk(BIOS_INFO,   "%c", (CH))
 119 #define print_debug_char(CH)     printk(BIOS_DEBUG,  "%c", (CH))
 120 #define print_spew_char(CH)      printk(BIOS_SPEW,   "%c", (CH))
 121
 122 #define print_emerg_hex8(HEX)    printk(BIOS_EMERG,  "%02x",  (HEX))
 123 #define print_alert_hex8(HEX)    printk(BIOS_ALERT,  "%02x",  (HEX))
 124 #define print_crit_hex8(HEX)     printk(BIOS_CRIT,   "%02x",  (HEX))
 125 #define print_err_hex8(HEX)      printk(BIOS_ERR,    "%02x",  (HEX))
 126 #define print_warning_hex8(HEX)  printk(BIOS_WARNING,"%02x",  (HEX))
 127 #define print_notice_hex8(HEX)   printk(BIOS_NOTICE, "%02x",  (HEX))
 128 #define print_info_hex8(HEX)     printk(BIOS_INFO,   "%02x",  (HEX))
 129 #define print_debug_hex8(HEX)    printk(BIOS_DEBUG,  "%02x",  (HEX))
 130 #define print_spew_hex8(HEX)     printk(BIOS_SPEW,   "%02x",  (HEX))
 131
 132 #define print_emerg_hex16(HEX)   printk(BIOS_EMERG,  "%04x", (HEX))
 133 #define print_alert_hex16(HEX)   printk(BIOS_ALERT,  "%04x", (HEX))
 134 #define print_crit_hex16(HEX)    printk(BIOS_CRIT,   "%04x", (HEX))
 135 #define print_err_hex16(HEX)     printk(BIOS_ERR,    "%04x", (HEX))
 136 #define print_warning_hex16(HEX) printk(BIOS_WARNING,"%04x", (HEX))
 137 #define print_notice_hex16(HEX)  printk(BIOS_NOTICE, "%04x", (HEX))
 138 #define print_info_hex16(HEX)    printk(BIOS_INFO,   "%04x", (HEX))
 139 #define print_debug_hex16(HEX)   printk(BIOS_DEBUG,  "%04x", (HEX))
 140 #define print_spew_hex16(HEX)    printk(BIOS_SPEW,   "%04x", (HEX))
 141
 142 #define print_emerg_hex32(HEX)   printk(BIOS_EMERG,  "%08x", (HEX))
 143 #define print_alert_hex32(HEX)   printk(BIOS_ALERT,  "%08x", (HEX))
 144 #define print_crit_hex32(HEX)    printk(BIOS_CRIT,   "%08x", (HEX))
 145 #define print_err_hex32(HEX)     printk(BIOS_ERR,    "%08x", (HEX))
 146 #define print_warning_hex32(HEX) printk(BIOS_WARNING,"%08x", (HEX))
 147 #define print_notice_hex32(HEX)  printk(BIOS_NOTICE, "%08x", (HEX))
 148 #define print_info_hex32(HEX)    printk(BIOS_INFO,   "%08x", (HEX))
 149 #define print_debug_hex32(HEX)   printk(BIOS_DEBUG,  "%08x", (HEX))
 150 #define print_spew_hex32(HEX)    printk(BIOS_SPEW,   "%08x", (HEX))
 151 #else
 152
 153 #include <pc80/serial.c>
 154
 155 #if CONFIG_CONSOLE_NE2K
 156 #include "lib/ne2k.c"
 157 #endif
 158
 159 /* __ROMCC__ */
 160 static void __console_tx_byte(unsigned char byte)
 161 {
 162         uart_tx_byte(byte);
 163 #if CONFIG_CONSOLE_NE2K
 164         ne2k_append_data_byte(byte, CONFIG_CONSOLE_NE2K_IO_PORT);
 165 #endif
 166 }
 167
 168 static void __console_tx_nibble(unsigned nibble)
 169 {
 170         unsigned char digit;
 171         digit = nibble + '0';
 172         if (digit > '9') {
 173                 digit += 39;
 174         }
 175         __console_tx_byte(digit);
 176 }
 177
 178 static void __console_tx_char(int loglevel, unsigned char byte)
 179 {
 180         if (console_loglevel >= loglevel) {
 181                 uart_tx_byte(byte);
 182 #if CONFIG_CONSOLE_NE2K
 183         ne2k_append_data_byte(byte, CONFIG_CONSOLE_NE2K_IO_PORT);
 184         ne2k_transmit(CONFIG_CONSOLE_NE2K_IO_PORT);
 185 #endif
 186         }
 187 }
 188
 189 static void __console_tx_hex8(int loglevel, unsigned char value)
 190 {
 191         if (console_loglevel >= loglevel) {
 192                 __console_tx_nibble((value >>  4U) & 0x0fU);
 193                 __console_tx_nibble(value & 0x0fU);
 194         }
 195 #if CONFIG_CONSOLE_NE2K
 196                 ne2k_transmit(CONFIG_CONSOLE_NE2K_IO_PORT);
 197 #endif
 198 }
 199
 200 static void __console_tx_hex16(int loglevel, unsigned short value)
 201 {
 202         if (console_loglevel >= loglevel) {
 203                 __console_tx_nibble((value >> 12U) & 0x0fU);
 204                 __console_tx_nibble((value >>  8U) & 0x0fU);
 205                 __console_tx_nibble((value >>  4U) & 0x0fU);
 206                 __console_tx_nibble(value & 0x0fU);
 207         }
 208 #if CONFIG_CONSOLE_NE2K
 209                 ne2k_transmit(CONFIG_CONSOLE_NE2K_IO_PORT);
 210 #endif
 211 }
 212
 213 static void __console_tx_hex32(int loglevel, unsigned int value)
 214 {
 215         if (console_loglevel >= loglevel) {
 216                 __console_tx_nibble((value >> 28U) & 0x0fU);
 217                 __console_tx_nibble((value >> 24U) & 0x0fU);
 218                 __console_tx_nibble((value >> 20U) & 0x0fU);
 219                 __console_tx_nibble((value >> 16U) & 0x0fU);
 220                 __console_tx_nibble((value >> 12U) & 0x0fU);
 221                 __console_tx_nibble((value >>  8U) & 0x0fU);
 222                 __console_tx_nibble((value >>  4U) & 0x0fU);
 223                 __console_tx_nibble(value & 0x0fU);
 224         }
 225 #if CONFIG_CONSOLE_NE2K
 226                 ne2k_transmit(CONFIG_CONSOLE_NE2K_IO_PORT);
 227 #endif
 228 }
 229
 230 static void __console_tx_string(int loglevel, const char *str)
 231 {
 232         if (console_loglevel >= loglevel) {
 233                 unsigned char ch;
 234                 while((ch = *str++) != '\0') {
 235                         if (ch == '\n')
 236                                 __console_tx_byte('\r');
 237                         __console_tx_byte(ch);
 238                 }
 239 #if CONFIG_CONSOLE_NE2K
 240                 ne2k_transmit(CONFIG_CONSOLE_NE2K_IO_PORT);
 241 #endif
 242         }
 243 }
 244
 245 #define FUNCTIONS_FOR_PRINT
 246 #ifdef  FUNCTIONS_FOR_PRINT
 247 static void print_emerg_char(unsigned char byte) { __console_tx_char(BIOS_EMERG, byte); }
 248 static void print_emerg_hex8(unsigned char value){ __console_tx_hex8(BIOS_EMERG, value); }
 249 static void print_emerg_hex16(unsigned short value){ __console_tx_hex16(BIOS_EMERG, value); }
 250 static void print_emerg_hex32(unsigned int value) { __console_tx_hex32(BIOS_EMERG, value); }
 251 static void print_emerg(const char *str) { __console_tx_string(BIOS_EMERG, str); }
 252
 253 static void print_alert_char(unsigned char byte) { __console_tx_char(BIOS_ALERT, byte); }
 254 static void print_alert_hex8(unsigned char value) { __console_tx_hex8(BIOS_ALERT, value); }
 255 static void print_alert_hex16(unsigned short value){ __console_tx_hex16(BIOS_ALERT, value); }
 256 static void print_alert_hex32(unsigned int value) { __console_tx_hex32(BIOS_ALERT, value); }
 257 static void print_alert(const char *str) { __console_tx_string(BIOS_ALERT, str); }
 258
 259 static void print_crit_char(unsigned char byte) { __console_tx_char(BIOS_CRIT, byte); }
 260 static void print_crit_hex8(unsigned char value) { __console_tx_hex8(BIOS_CRIT, value); }
 261 static void print_crit_hex16(unsigned short value){ __console_tx_hex16(BIOS_CRIT, value); }
 262 static void print_crit_hex32(unsigned int value) { __console_tx_hex32(BIOS_CRIT, value); }
 263 static void print_crit(const char *str) { __console_tx_string(BIOS_CRIT, str); }
 264
 265 static void print_err_char(unsigned char byte) { __console_tx_char(BIOS_ERR, byte); }
 266 static void print_err_hex8(unsigned char value) { __console_tx_hex8(BIOS_ERR, value); }
 267 static void print_err_hex16(unsigned short value){ __console_tx_hex16(BIOS_ERR, value); }
 268 static void print_err_hex32(unsigned int value) { __console_tx_hex32(BIOS_ERR, value); }
 269 static void print_err(const char *str) { __console_tx_string(BIOS_ERR, str); }
 270
 271 static void print_warning_char(unsigned char byte) { __console_tx_char(BIOS_WARNING, byte); }
 272 static void print_warning_hex8(unsigned char value) { __console_tx_hex8(BIOS_WARNING, value); }
 273 static void print_warning_hex16(unsigned short value){ __console_tx_hex16(BIOS_WARNING, value); }
 274 static void print_warning_hex32(unsigned int value) { __console_tx_hex32(BIOS_WARNING, value); }
 275 static void print_warning(const char *str) { __console_tx_string(BIOS_WARNING, str); }
 276
 277 static void print_notice_char(unsigned char byte) { __console_tx_char(BIOS_NOTICE, byte); }
 278 static void print_notice_hex8(unsigned char value) { __console_tx_hex8(BIOS_NOTICE, value); }
 279 static void print_notice_hex16(unsigned short value){ __console_tx_hex16(BIOS_NOTICE, value); }
 280 static void print_notice_hex32(unsigned int value) { __console_tx_hex32(BIOS_NOTICE, value); }
 281 static void print_notice(const char *str) { __console_tx_string(BIOS_NOTICE, str); }
 282
 283 static void print_info_char(unsigned char byte) { __console_tx_char(BIOS_INFO, byte); }
 284 static void print_info_hex8(unsigned char value) { __console_tx_hex8(BIOS_INFO, value); }
 285 static void print_info_hex16(unsigned short value){ __console_tx_hex16(BIOS_INFO, value); }
 286 static void print_info_hex32(unsigned int value) { __console_tx_hex32(BIOS_INFO, value); }
 287 static void print_info(const char *str) { __console_tx_string(BIOS_INFO, str); }
 288
 289 static void print_debug_char(unsigned char byte) { __console_tx_char(BIOS_DEBUG, byte); }
 290 static void print_debug_hex8(unsigned char value) { __console_tx_hex8(BIOS_DEBUG, value); }
 291 static void print_debug_hex16(unsigned short value){ __console_tx_hex16(BIOS_DEBUG, value); }
 292 static void print_debug_hex32(unsigned int value) { __console_tx_hex32(BIOS_DEBUG, value); }
 293 static void print_debug(const char *str) { __console_tx_string(BIOS_DEBUG, str); }
 294
 295 static void print_spew_char(unsigned char byte) { __console_tx_char(BIOS_SPEW, byte); }
 296 static void print_spew_hex8(unsigned char value) { __console_tx_hex8(BIOS_SPEW, value); }
 297 static void print_spew_hex16(unsigned short value){ __console_tx_hex16(BIOS_SPEW, value); }
 298 static void print_spew_hex32(unsigned int value) { __console_tx_hex32(BIOS_SPEW, value); }
 299 static void print_spew(const char *str) { __console_tx_string(BIOS_SPEW, str); }
 300
 301 #else
 302 #define print_emerg(STR)         __console_tx_string(BIOS_EMERG, STR)
 303 #define print_alert(STR)         __console_tx_string(BIOS_ALERT, STR)
 304 #define print_crit(STR)          __console_tx_string(BIOS_CRIT, STR)
 305 #define print_err(STR)           __console_tx_string(BIOS_ERR, STR)
 306 #define print_warning(STR)       __console_tx_string(BIOS_WARNING, STR)
 307 #define print_notice(STR)        __console_tx_string(BIOS_NOTICE, STR)
 308 #define print_info(STR)          __console_tx_string(BIOS_INFO, STR)
 309 #define print_debug(STR)         __console_tx_string(BIOS_DEBUG, STR)
 310 #define print_spew(STR)          __console_tx_string(BIOS_SPEW, STR)
 311
 312 #define print_emerg_char(CH)     __console_tx_char(BIOS_EMERG, CH)
 313 #define print_alert_char(CH)     __console_tx_char(BIOS_ALERT, CH)
 314 #define print_crit_char(CH)      __console_tx_char(BIOS_CRIT, CH)
 315 #define print_err_char(CH)       __console_tx_char(BIOS_ERR, CH)
 316 #define print_warning_char(CH)   __console_tx_char(BIOS_WARNING, CH)
 317 #define print_notice_char(CH)    __console_tx_char(BIOS_NOTICE, CH)
 318 #define print_info_char(CH)      __console_tx_char(BIOS_INFO, CH)
 319 #define print_debug_char(CH)     __console_tx_char(BIOS_DEBUG, CH)
 320 #define print_spew_char(CH)      __console_tx_char(BIOS_SPEW, CH)
 321
 322 #define print_emerg_hex8(HEX)    __console_tx_hex8(BIOS_EMERG, HEX)
 323 #define print_alert_hex8(HEX)    __console_tx_hex8(BIOS_ALERT, HEX)
 324 #define print_crit_hex8(HEX)     __console_tx_hex8(BIOS_CRIT, HEX)
 325 #define print_err_hex8(HEX)      __console_tx_hex8(BIOS_ERR, HEX)
 326 #define print_warning_hex8(HEX)  __console_tx_hex8(BIOS_WARNING, HEX)
 327 #define print_notice_hex8(HEX)   __console_tx_hex8(BIOS_NOTICE, HEX)
 328 #define print_info_hex8(HEX)     __console_tx_hex8(BIOS_INFO, HEX)
 329 #define print_debug_hex8(HEX)    __console_tx_hex8(BIOS_DEBUG, HEX)
 330 #define print_spew_hex8(HEX)     __console_tx_hex8(BIOS_SPEW, HEX)
 331
 332 #define print_emerg_hex16(HEX)   __console_tx_hex16(BIOS_EMERG, HEX)
 333 #define print_alert_hex16(HEX)   __console_tx_hex16(BIOS_ALERT, HEX)
 334 #define print_crit_hex16(HEX)    __console_tx_hex16(BIOS_CRIT, HEX)
 335 #define print_err_hex16(HEX)     __console_tx_hex16(BIOS_ERR, HEX)
 336 #define print_warning_hex16(HEX) __console_tx_hex16(BIOS_WARNING, HEX)
 337 #define print_notice_hex16(HEX)  __console_tx_hex16(BIOS_NOTICE, HEX)
 338 #define print_info_hex16(HEX)    __console_tx_hex16(BIOS_INFO, HEX)
 339 #define print_debug_hex16(HEX)   __console_tx_hex16(BIOS_DEBUG, HEX)
 340 #define print_spew_hex16(HEX)    __console_tx_hex16(BIOS_SPEW, HEX)
 341
 342 #define print_emerg_hex32(HEX)   __console_tx_hex32(BIOS_EMERG, HEX)
 343 #define print_alert_hex32(HEX)   __console_tx_hex32(BIOS_ALERT, HEX)
 344 #define print_crit_hex32(HEX)    __console_tx_hex32(BIOS_CRIT, HEX)
 345 #define print_err_hex32(HEX)     __console_tx_hex32(BIOS_ERR, HEX)
 346 #define print_warning_hex32(HEX) __console_tx_hex32(BIOS_WARNING, HEX)
 347 #define print_notice_hex32(HEX)  __console_tx_hex32(BIOS_NOTICE, HEX)
 348 #define print_info_hex32(HEX)    __console_tx_hex32(BIOS_INFO, HEX)
 349 #define print_debug_hex32(HEX)   __console_tx_hex32(BIOS_DEBUG, HEX)
 350 #define print_spew_hex32(HEX)    __console_tx_hex32(BIOS_SPEW, HEX)
 351 #endif
 352
 353 #endif
 354
 355 #ifdef __ROMCC__
 356 /* if included by romcc, include the sources, too. romcc can't use prototypes */
 357 #include <console/console.c>
 358 #endif
 359
 360 #endif /* CONSOLE_CONSOLE_H_ */