src/include/console/console.h

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