Example how simple it is to use printk instead of printk_something in
[coreboot.git] / 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 void console_init(void);
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 void post_code(uint8_t value);
13 void __attribute__ ((noreturn)) die(const char *msg);
14
15 struct console_driver {
16         void (*init)(void);
17         void (*tx_byte)(unsigned char byte);
18         void (*tx_flush)(void);
19         unsigned char (*rx_byte)(void);
20         int (*tst_byte)(void);
21 };
22
23 #define __console       __attribute__((used, __section__ (".rodata.console_drivers")))
24
25 /* Defined by the linker... */
26 extern struct console_driver console_drivers[];
27 extern struct console_driver econsole_drivers[];
28
29 extern int console_loglevel;
30 int do_printk(int msg_level, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
31
32 #define printk(x...) do_printk(x)
33
34 #define printk_emerg(fmt, arg...)   do_printk(BIOS_EMERG   ,fmt, ##arg)
35 #define printk_alert(fmt, arg...)   do_printk(BIOS_ALERT   ,fmt, ##arg)
36 #define printk_crit(fmt, arg...)    do_printk(BIOS_CRIT    ,fmt, ##arg)
37 #define printk_err(fmt, arg...)     do_printk(BIOS_ERR     ,fmt, ##arg)
38 #define printk_warning(fmt, arg...) do_printk(BIOS_WARNING ,fmt, ##arg)
39 #define printk_notice(fmt, arg...)  do_printk(BIOS_NOTICE  ,fmt, ##arg)
40 #define printk_info(fmt, arg...)    do_printk(BIOS_INFO    ,fmt, ##arg)
41 #define printk_debug(fmt, arg...)   do_printk(BIOS_DEBUG   ,fmt, ##arg)
42 #define printk_spew(fmt, arg...)    do_printk(BIOS_SPEW    ,fmt, ##arg)
43
44 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_EMERG
45 #undef  printk_emerg
46 #define printk_emerg(fmt, arg...)   do {} while(0)
47 #endif
48 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_ALERT
49 #undef  printk_alert
50 #define printk_alert(fmt, arg...)   do {} while(0)
51 #endif
52 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_CRIT
53 #undef  printk_crit
54 #define printk_crit(fmt, arg...)    do {} while(0)
55 #endif
56 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_ERR
57 #undef  printk_err
58 #define printk_err(fmt, arg...)     do {} while(0)
59 #endif
60 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_WARNING
61 #undef  printk_warning
62 #define printk_warning(fmt, arg...) do {} while(0)
63 #endif
64 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_NOTICE
65 #undef  printk_notice
66 #define printk_notice(fmt, arg...)  do {} while(0)
67 #endif
68 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_INFO
69 #undef  printk_info
70 #define printk_info(fmt, arg...)    do {} while(0)
71 #endif
72 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_DEBUG
73 #undef  printk_debug
74 #define printk_debug(fmt, arg...)   do {} while(0)
75 #endif
76 #if CONFIG_MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_SPEW
77 #undef  printk_spew
78 #define printk_spew(fmt, arg...)    do {} while(0)
79 #endif
80
81 #define print_emerg(STR)   printk_emerg  ("%s", (STR))
82 #define print_alert(STR)   printk_alert  ("%s", (STR))
83 #define print_crit(STR)    printk_crit   ("%s", (STR))
84 #define print_err(STR)     printk_err    ("%s", (STR))
85 #define print_warning(STR) printk_warning("%s", (STR))
86 #define print_notice(STR)  printk_notice ("%s", (STR))
87 #define print_info(STR)    printk_info   ("%s", (STR))
88 #define print_debug(STR)   printk_debug  ("%s", (STR))
89 #define print_spew(STR)    printk_spew   ("%s", (STR))
90
91 #define print_emerg_char(CH)   printk_emerg  ("%c", (CH))
92 #define print_alert_char(CH)   printk_alert  ("%c", (CH))
93 #define print_crit_char(CH)    printk_crit   ("%c", (CH))
94 #define print_err_char(CH)     printk_err    ("%c", (CH))
95 #define print_warning_char(CH) printk_warning("%c", (CH))
96 #define print_notice_char(CH)  printk_notice ("%c", (CH))
97 #define print_info_char(CH)    printk_info   ("%c", (CH))
98 #define print_debug_char(CH)   printk_debug  ("%c", (CH))
99 #define print_spew_char(CH)    printk_spew   ("%c", (CH))
100
101 #define print_emerg_hex8(HEX)   printk_emerg  ("%02x",  (HEX))
102 #define print_alert_hex8(HEX)   printk_alert  ("%02x",  (HEX))
103 #define print_crit_hex8(HEX)    printk_crit   ("%02x",  (HEX))
104 #define print_err_hex8(HEX)     printk_err    ("%02x",  (HEX))
105 #define print_warning_hex8(HEX) printk_warning("%02x",  (HEX))
106 #define print_notice_hex8(HEX)  printk_notice ("%02x",  (HEX))
107 #define print_info_hex8(HEX)    printk_info   ("%02x",  (HEX))
108 #define print_debug_hex8(HEX)   printk_debug  ("%02x",  (HEX))
109 #define print_spew_hex8(HEX)    printk_spew   ("%02x",  (HEX))
110
111 #define print_emerg_hex16(HEX)   printk_emerg  ("%04x", (HEX))
112 #define print_alert_hex16(HEX)   printk_alert  ("%04x", (HEX))
113 #define print_crit_hex16(HEX)    printk_crit   ("%04x", (HEX))
114 #define print_err_hex16(HEX)     printk_err    ("%04x", (HEX))
115 #define print_warning_hex16(HEX) printk_warning("%04x", (HEX))
116 #define print_notice_hex16(HEX)  printk_notice ("%04x", (HEX))
117 #define print_info_hex16(HEX)    printk_info   ("%04x", (HEX))
118 #define print_debug_hex16(HEX)   printk_debug  ("%04x", (HEX))
119 #define print_spew_hex16(HEX)    printk_spew   ("%04x", (HEX))
120
121 #define print_emerg_hex32(HEX)   printk_emerg  ("%08x", (HEX))
122 #define print_alert_hex32(HEX)   printk_alert  ("%08x", (HEX))
123 #define print_crit_hex32(HEX)    printk_crit   ("%08x", (HEX))
124 #define print_err_hex32(HEX)     printk_err    ("%08x", (HEX))
125 #define print_warning_hex32(HEX) printk_warning("%08x", (HEX))
126 #define print_notice_hex32(HEX)  printk_notice ("%08x", (HEX))
127 #define print_info_hex32(HEX)    printk_info   ("%08x", (HEX))
128 #define print_debug_hex32(HEX)   printk_debug  ("%08x", (HEX))
129 #define print_spew_hex32(HEX)    printk_spew   ("%08x", (HEX))
130
131 #if CONFIG_CONSOLE_VGA == 1
132 void vga_console_init(void);
133 #endif
134
135 #endif /* CONSOLE_CONSOLE_H_ */