CBMEM CONSOLE: Add CBMEM console driver implementation.
[coreboot.git] / src / include / console / console.h
index ffb17d4c9b420dd5b2bedff4cbd4e41daac2ea2e..56e202d99be62d7df1fdfafd977619a3167402d4 100644 (file)
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2003 Eric Biederman
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
 #ifndef CONSOLE_CONSOLE_H_
 #define CONSOLE_CONSOLE_H_
 
 #include <stdint.h>
 #include <console/loglevel.h>
+#include <console/post_codes.h>
 
-void console_init(void);
+#if CONFIG_CONSOLE_SERIAL8250 || CONFIG_CONSOLE_SERIAL8250MEM
+#include <uart8250.h>
+#endif
+#if CONFIG_USBDEBUG
+#include <usbdebug.h>
+#endif
+#if CONFIG_CONSOLE_NE2K
+#include <console/ne2k.h>
+#endif
+#if CONFIG_CONSOLE_CBMEM
+#include <console/cbmem_console.h>
+#endif
+
+#ifndef __PRE_RAM__
 void console_tx_byte(unsigned char byte);
 void console_tx_flush(void);
-void post_code(uint8_t value);
-void die(char *msg);
-
+unsigned char console_rx_byte(void);
+int console_tst_byte(void);
 struct console_driver {
        void (*init)(void);
        void (*tx_byte)(unsigned char byte);
        void (*tx_flush)(void);
+       unsigned char (*rx_byte)(void);
+       int (*tst_byte)(void);
 };
 
-#define __console      __attribute__((unused, __section__ (".rodata.console_drivers")))
+#define __console      __attribute__((used, __section__ (".rodata.console_drivers")))
 
 /* Defined by the linker... */
 extern struct console_driver console_drivers[];
 extern struct console_driver econsole_drivers[];
 
 extern int console_loglevel;
-int do_printk(int msg_level, const char *fmt, ...);
-
-#define printk_emerg(fmt, arg...)   do_printk(BIOS_EMERG   ,fmt, ##arg)
-#define printk_alert(fmt, arg...)   do_printk(BIOS_ALERT   ,fmt, ##arg)
-#define printk_crit(fmt, arg...)    do_printk(BIOS_CRIT    ,fmt, ##arg)
-#define printk_err(fmt, arg...)     do_printk(BIOS_ERR     ,fmt, ##arg)
-#define printk_warning(fmt, arg...) do_printk(BIOS_WARNING ,fmt, ##arg)
-#define printk_notice(fmt, arg...)  do_printk(BIOS_NOTICE  ,fmt, ##arg)
-#define printk_info(fmt, arg...)    do_printk(BIOS_INFO    ,fmt, ##arg)
-#define printk_debug(fmt, arg...)   do_printk(BIOS_DEBUG   ,fmt, ##arg)
-#define printk_spew(fmt, arg...)    do_printk(BIOS_SPEW    ,fmt, ##arg)
-
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_EMERG
-#undef  printk_emerg
-#define printk_emerg(fmt, arg...)   do {} while(0)
-#endif
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_ALERT
-#undef  printk_alert
-#define printk_alart(fmt, arg...)   do {} while(0)
+#else
+/* __PRE_RAM__ */
+/* Using a global varible can cause problems when we reset the stack
+ * from cache as ram to ram. If we make this a define USE_SHARED_STACK
+ * we could use the same code on all architectures.
+ */
+#define console_loglevel CONFIG_DEFAULT_CONSOLE_LOGLEVEL
 #endif
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_CRIT
-#undef  printk_crit
-#define printk_crit(fmt, arg...)    do {} while(0)
-#endif
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_ERR
-#undef  printk_err
-#define printk_err(fmt, arg...)     do {} while(0)
-#endif
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_WARNING
-#undef  printk_warning
-#define printk_warning(fmt, arg...) do {} while(0)
-#endif
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_NOTICE
-#undef  printk_notice
-#define printk_notice(fmt, arg...)  do {} while(0)
-#endif
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_INFO
-#undef  printk_info
-#define printk_info(fmt, arg...)    do {} while(0)
-#endif
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_DEBUG
-#undef  printk_debug
-#define printk_debug(fmt, arg...)   do {} while(0)
-#endif
-#if MAXIMUM_CONSOLE_LOGLEVEL <= BIOS_SPEW
-#undef  printk_spew
-#define printk_spew(fmt, arg...)    do {} while(0)
+
+#ifndef __ROMCC__
+void console_init(void);
+void post_code(u8 value);
+void __attribute__ ((noreturn)) die(const char *msg);
+int do_printk(int msg_level, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
+
+#undef WE_CLEANED_UP_ALL_SIDE_EFFECTS
+/* We saw some strange effects in the past like coreboot crashing while
+ * disabling cache as ram for a maximum console log level of 6 and above while
+ * it worked fine without. In order to catch such issues reliably we are
+ * always doing a function call to do_printk with the full number of arguments.
+ * Our favorite reason to do it this way was:
+ *   disable_car();
+ *   printk(BIOS_DEBUG, "CAR disabled\n"); // oops, garbage stack pointer
+ *   move_stack();
+ * This slightly increases the code size and some unprinted strings will end
+ * up in the final coreboot binary (most of them compressed). If you want to
+ * avoid this, do a
+ * #define WE_CLEANED_UP_ALL_SIDE_EFFECTS
+ */
+#ifdef WE_CLEANED_UP_ALL_SIDE_EFFECTS
+
+#define printk(LEVEL, fmt, args...)                            \
+       do {                                                    \
+               if (CONFIG_MAXIMUM_CONSOLE_LOGLEVEL >= LEVEL) { \
+                       do_printk(LEVEL, fmt, ##args);          \
+               }                                               \
+       } while(0)
+
+#else
+
+#define printk(LEVEL, fmt, args...)                            \
+       do {                                                    \
+               if (CONFIG_MAXIMUM_CONSOLE_LOGLEVEL >= LEVEL) { \
+                       do_printk(LEVEL, fmt, ##args);          \
+               } else {                                        \
+                       do_printk(BIOS_NEVER, fmt, ##args);     \
+               }                                               \
+       } while(0)
 #endif
 
-#define print_emerg(STR)   printk_emerg  ("%s", (STR))
-#define print_alert(STR)   printk_alert  ("%s", (STR))
-#define print_crit(STR)    printk_crit   ("%s", (STR))
-#define print_err(STR)     printk_err    ("%s", (STR))
-#define print_warning(STR) printk_warning("%s", (STR))
-#define print_notice(STR)  printk_notice ("%s", (STR))
-#define print_info(STR)    printk_info   ("%s", (STR))
-#define print_debug(STR)   printk_debug  ("%s", (STR))
-#define print_spew(STR)    printk_spew   ("%s", (STR))
-
-#define print_emerg_char(CH)   printk_emerg  ("%c", (CH))
-#define print_alert_char(CH)   printk_alert  ("%c", (CH))
-#define print_crit_char(CH)    printk_crit   ("%c", (CH))
-#define print_err_char(CH)     printk_err    ("%c", (CH))
-#define print_warning_char(CH) printk_warning("%c", (CH))
-#define print_notice_char(CH)  printk_notice ("%c", (CH))
-#define print_info_char(CH)    printk_info   ("%c", (CH))
-#define print_debug_char(CH)   printk_debug  ("%c", (CH))
-#define print_spew_char(CH)    printk_spew   ("%c", (CH))
-
-#define print_emerg_hex8(HEX)   printk_emerg  ("%02x",  (HEX))
-#define print_alert_hex8(HEX)   printk_alert  ("%02x",  (HEX))
-#define print_crit_hex8(HEX)    printk_crit   ("%02x",  (HEX))
-#define print_err_hex8(HEX)     printk_err    ("%02x",  (HEX))
-#define print_warning_hex8(HEX) printk_warning("%02x",  (HEX))
-#define print_notice_hex8(HEX)  printk_notice ("%02x",  (HEX))
-#define print_info_hex8(HEX)    printk_info   ("%02x",  (HEX))
-#define print_debug_hex8(HEX)   printk_debug  ("%02x",  (HEX))
-#define print_spew_hex8(HEX)    printk_spew   ("%02x",  (HEX))
-
-#define print_emerg_hex16(HEX)   printk_emerg  ("%04x", (HEX))
-#define print_alert_hex16(HEX)   printk_alert  ("%04x", (HEX))
-#define print_crit_hex16(HEX)    printk_crit   ("%04x", (HEX))
-#define print_err_hex16(HEX)     printk_err    ("%04x", (HEX))
-#define print_warning_hex16(HEX) printk_warning("%04x", (HEX))
-#define print_notice_hex16(HEX)  printk_notice ("%04x", (HEX))
-#define print_info_hex16(HEX)    printk_info   ("%04x", (HEX))
-#define print_debug_hex16(HEX)   printk_debug  ("%04x", (HEX))
-#define print_spew_hex16(HEX)    printk_spew   ("%04x", (HEX))
-
-#define print_emerg_hex32(HEX)   printk_emerg  ("%08x", (HEX))
-#define print_alert_hex32(HEX)   printk_alert  ("%08x", (HEX))
-#define print_crit_hex32(HEX)    printk_crit   ("%08x", (HEX))
-#define print_err_hex32(HEX)     printk_err    ("%08x", (HEX))
-#define print_warning_hex32(HEX) printk_warning("%08x", (HEX))
-#define print_notice_hex32(HEX)  printk_notice ("%08x", (HEX))
-#define print_info_hex32(HEX)    printk_info   ("%08x", (HEX))
-#define print_debug_hex32(HEX)   printk_debug  ("%08x", (HEX))
-#define print_spew_hex32(HEX)    printk_spew   ("%08x", (HEX))
+#define print_emerg(STR)         printk(BIOS_EMERG,  "%s", (STR))
+#define print_alert(STR)         printk(BIOS_ALERT,  "%s", (STR))
+#define print_crit(STR)          printk(BIOS_CRIT,   "%s", (STR))
+#define print_err(STR)           printk(BIOS_ERR,    "%s", (STR))
+#define print_warning(STR)       printk(BIOS_WARNING,"%s", (STR))
+#define print_notice(STR)        printk(BIOS_NOTICE, "%s", (STR))
+#define print_info(STR)          printk(BIOS_INFO,   "%s", (STR))
+#define print_debug(STR)         printk(BIOS_DEBUG,  "%s", (STR))
+#define print_spew(STR)          printk(BIOS_SPEW,   "%s", (STR))
+
+#define print_emerg_char(CH)     printk(BIOS_EMERG,  "%c", (CH))
+#define print_alert_char(CH)     printk(BIOS_ALERT,  "%c", (CH))
+#define print_crit_char(CH)      printk(BIOS_CRIT,   "%c", (CH))
+#define print_err_char(CH)       printk(BIOS_ERR,    "%c", (CH))
+#define print_warning_char(CH)   printk(BIOS_WARNING,"%c", (CH))
+#define print_notice_char(CH)    printk(BIOS_NOTICE, "%c", (CH))
+#define print_info_char(CH)      printk(BIOS_INFO,   "%c", (CH))
+#define print_debug_char(CH)     printk(BIOS_DEBUG,  "%c", (CH))
+#define print_spew_char(CH)      printk(BIOS_SPEW,   "%c", (CH))
+
+#define print_emerg_hex8(HEX)    printk(BIOS_EMERG,  "%02x",  (HEX))
+#define print_alert_hex8(HEX)    printk(BIOS_ALERT,  "%02x",  (HEX))
+#define print_crit_hex8(HEX)     printk(BIOS_CRIT,   "%02x",  (HEX))
+#define print_err_hex8(HEX)      printk(BIOS_ERR,    "%02x",  (HEX))
+#define print_warning_hex8(HEX)  printk(BIOS_WARNING,"%02x",  (HEX))
+#define print_notice_hex8(HEX)   printk(BIOS_NOTICE, "%02x",  (HEX))
+#define print_info_hex8(HEX)     printk(BIOS_INFO,   "%02x",  (HEX))
+#define print_debug_hex8(HEX)    printk(BIOS_DEBUG,  "%02x",  (HEX))
+#define print_spew_hex8(HEX)     printk(BIOS_SPEW,   "%02x",  (HEX))
+
+#define print_emerg_hex16(HEX)   printk(BIOS_EMERG,  "%04x", (HEX))
+#define print_alert_hex16(HEX)   printk(BIOS_ALERT,  "%04x", (HEX))
+#define print_crit_hex16(HEX)    printk(BIOS_CRIT,   "%04x", (HEX))
+#define print_err_hex16(HEX)     printk(BIOS_ERR,    "%04x", (HEX))
+#define print_warning_hex16(HEX) printk(BIOS_WARNING,"%04x", (HEX))
+#define print_notice_hex16(HEX)  printk(BIOS_NOTICE, "%04x", (HEX))
+#define print_info_hex16(HEX)    printk(BIOS_INFO,   "%04x", (HEX))
+#define print_debug_hex16(HEX)   printk(BIOS_DEBUG,  "%04x", (HEX))
+#define print_spew_hex16(HEX)    printk(BIOS_SPEW,   "%04x", (HEX))
+
+#define print_emerg_hex32(HEX)   printk(BIOS_EMERG,  "%08x", (HEX))
+#define print_alert_hex32(HEX)   printk(BIOS_ALERT,  "%08x", (HEX))
+#define print_crit_hex32(HEX)    printk(BIOS_CRIT,   "%08x", (HEX))
+#define print_err_hex32(HEX)     printk(BIOS_ERR,    "%08x", (HEX))
+#define print_warning_hex32(HEX) printk(BIOS_WARNING,"%08x", (HEX))
+#define print_notice_hex32(HEX)  printk(BIOS_NOTICE, "%08x", (HEX))
+#define print_info_hex32(HEX)    printk(BIOS_INFO,   "%08x", (HEX))
+#define print_debug_hex32(HEX)   printk(BIOS_DEBUG,  "%08x", (HEX))
+#define print_spew_hex32(HEX)    printk(BIOS_SPEW,   "%08x", (HEX))
+
+#else
+
+/* __ROMCC__ */
+
+#define print_emerg(STR)         __console_tx_string(BIOS_EMERG, STR)
+#define print_alert(STR)         __console_tx_string(BIOS_ALERT, STR)
+#define print_crit(STR)          __console_tx_string(BIOS_CRIT, STR)
+#define print_err(STR)           __console_tx_string(BIOS_ERR, STR)
+#define print_warning(STR)       __console_tx_string(BIOS_WARNING, STR)
+#define print_notice(STR)        __console_tx_string(BIOS_NOTICE, STR)
+#define print_info(STR)          __console_tx_string(BIOS_INFO, STR)
+#define print_debug(STR)         __console_tx_string(BIOS_DEBUG, STR)
+#define print_spew(STR)          __console_tx_string(BIOS_SPEW, STR)
+
+#define print_emerg_char(CH)     __console_tx_char(BIOS_EMERG, CH)
+#define print_alert_char(CH)     __console_tx_char(BIOS_ALERT, CH)
+#define print_crit_char(CH)      __console_tx_char(BIOS_CRIT, CH)
+#define print_err_char(CH)       __console_tx_char(BIOS_ERR, CH)
+#define print_warning_char(CH)   __console_tx_char(BIOS_WARNING, CH)
+#define print_notice_char(CH)    __console_tx_char(BIOS_NOTICE, CH)
+#define print_info_char(CH)      __console_tx_char(BIOS_INFO, CH)
+#define print_debug_char(CH)     __console_tx_char(BIOS_DEBUG, CH)
+#define print_spew_char(CH)      __console_tx_char(BIOS_SPEW, CH)
+
+#define print_emerg_hex8(HEX)    __console_tx_hex8(BIOS_EMERG, HEX)
+#define print_alert_hex8(HEX)    __console_tx_hex8(BIOS_ALERT, HEX)
+#define print_crit_hex8(HEX)     __console_tx_hex8(BIOS_CRIT, HEX)
+#define print_err_hex8(HEX)      __console_tx_hex8(BIOS_ERR, HEX)
+#define print_warning_hex8(HEX)  __console_tx_hex8(BIOS_WARNING, HEX)
+#define print_notice_hex8(HEX)   __console_tx_hex8(BIOS_NOTICE, HEX)
+#define print_info_hex8(HEX)     __console_tx_hex8(BIOS_INFO, HEX)
+#define print_debug_hex8(HEX)    __console_tx_hex8(BIOS_DEBUG, HEX)
+#define print_spew_hex8(HEX)     __console_tx_hex8(BIOS_SPEW, HEX)
+
+#define print_emerg_hex16(HEX)   __console_tx_hex16(BIOS_EMERG, HEX)
+#define print_alert_hex16(HEX)   __console_tx_hex16(BIOS_ALERT, HEX)
+#define print_crit_hex16(HEX)    __console_tx_hex16(BIOS_CRIT, HEX)
+#define print_err_hex16(HEX)     __console_tx_hex16(BIOS_ERR, HEX)
+#define print_warning_hex16(HEX) __console_tx_hex16(BIOS_WARNING, HEX)
+#define print_notice_hex16(HEX)  __console_tx_hex16(BIOS_NOTICE, HEX)
+#define print_info_hex16(HEX)    __console_tx_hex16(BIOS_INFO, HEX)
+#define print_debug_hex16(HEX)   __console_tx_hex16(BIOS_DEBUG, HEX)
+#define print_spew_hex16(HEX)    __console_tx_hex16(BIOS_SPEW, HEX)
+
+#define print_emerg_hex32(HEX)   __console_tx_hex32(BIOS_EMERG, HEX)
+#define print_alert_hex32(HEX)   __console_tx_hex32(BIOS_ALERT, HEX)
+#define print_crit_hex32(HEX)    __console_tx_hex32(BIOS_CRIT, HEX)
+#define print_err_hex32(HEX)     __console_tx_hex32(BIOS_ERR, HEX)
+#define print_warning_hex32(HEX) __console_tx_hex32(BIOS_WARNING, HEX)
+#define print_notice_hex32(HEX)  __console_tx_hex32(BIOS_NOTICE, HEX)
+#define print_info_hex32(HEX)    __console_tx_hex32(BIOS_INFO, HEX)
+#define print_debug_hex32(HEX)   __console_tx_hex32(BIOS_DEBUG, HEX)
+#define print_spew_hex32(HEX)    __console_tx_hex32(BIOS_SPEW, HEX)
+
+#include "arch/x86/lib/romcc_console.c"
+
+#endif /* __ROMCC__ */
 
 #endif /* CONSOLE_CONSOLE_H_ */