[coreboot-gerrit] New patch to review for coreboot: console/serialice: Add SerialICE
Patrick Rudolph (siro@das-labor.org)
gerrit at coreboot.org
Mon Apr 25 11:05:11 CEST 2016
Patrick Rudolph (siro at das-labor.org) just uploaded a new patch set to gerrit, which you can find at https://review.coreboot.org/14504
-gerrit
commit 6915e2bbbb75f27e71784981d4d6c1ce19b9577d
Author: Patrick Rudolph <siro at das-labor.org>
Date: Mon Apr 25 11:00:17 2016 +0200
console/serialice: Add SerialICE
Add Kconfig Option to build SerialICE shell into coreboot stages.
You can select between romstage and ramstage.
The SerialICE shell will be launched instead of coreboot console.
As minimal system initialization is already done in coreboot, it
should work on all boards.
Tested with EHCI Debug on Lenovo T520.
Needs tests:
* Ramstage
* Serial cable
* On other boards
Change-Id: I1fa6eb4f40e0f625c8c8302d1580bcd2664d670b
Signed-off-by: Patrick Rudolph <siro at das-labor.org>
---
src/Kconfig | 27 +++
src/console/Makefile.inc | 2 +
src/console/init.c | 13 +
src/console/serialice.c | 446 +++++++++++++++++++++++++++++++++++
src/include/console/serialice.h | 23 ++
src/include/console/serialice_priv.h | 103 ++++++++
src/include/console/uart.h | 2 +
src/include/console/usb.h | 2 +
8 files changed, 618 insertions(+)
diff --git a/src/Kconfig b/src/Kconfig
index f9bd661..31886af 100644
--- a/src/Kconfig
+++ b/src/Kconfig
@@ -1078,6 +1078,33 @@ config DEBUG_COVERAGE
If enabled, the code coverage hooks in coreboot will output some
information about the coverage data that is dumped.
+config DEBUG_SERIALICE
+ bool "Enable SerialICE instead normal boot"
+ depends on CONSOLE_SERIAL || CONSOLE_USB
+ default n
+ help
+ If enabled, SerialICE will be run instead of normal boot.
+ You need to connect a serial cable or EHCI debug dongle to
+ communicate with SerialICE shell.
+
+choice
+ prompt "SerialICE bootstage"
+ default DEBUG_SERIALICE_ROMSTAGE
+ help
+ Choose the stage SerialICE to start. You can choose between
+ ROMSTAGE and RAMSTAGE.
+
+config DEBUG_SERIALICE_ROMSTAGE
+ bool "Start SerialICE instead of Romstage"
+ help
+ Start SerialICE in romstage, right after minimal system initialization.
+
+config DEBUG_SERIALICE_RAMSTAGE
+ bool "Start SerialICE instead of Ramstage"
+ help
+ Start SerialICE in ramstage.
+endchoice
+
endmenu
# These probably belong somewhere else, but they are needed somewhere.
diff --git a/src/console/Makefile.inc b/src/console/Makefile.inc
index 0fee12a..ce0b01e 100644
--- a/src/console/Makefile.inc
+++ b/src/console/Makefile.inc
@@ -2,6 +2,7 @@ ramstage-y += vtxprintf.c printk.c vsprintf.c
ramstage-y += init.c console.c
ramstage-y += post.c
ramstage-y += die.c
+ramstage-y += serialice.c
smm-$(CONFIG_DEBUG_SMI) += init.c console.c vtxprintf.c printk.c
smm-$(CONFIG_SMM_TSEG) += die.c
@@ -17,6 +18,7 @@ romstage-y += vtxprintf.c printk.c
romstage-y += init.c console.c
romstage-y += post.c
romstage-y += die.c
+romstage-y += serialice.c
postcar-y += vtxprintf.c printk.c
postcar-y += init.c console.c
diff --git a/src/console/init.c b/src/console/init.c
index 8f40abb..3aee65a 100644
--- a/src/console/init.c
+++ b/src/console/init.c
@@ -16,6 +16,7 @@
#include <console/console.h>
#include <console/uart.h>
+#include <console/serialice.h>
#include <console/streams.h>
#include <device/pci.h>
#include <option.h>
@@ -43,6 +44,18 @@ void console_init(void)
console_hw_init();
+#if !defined(__PRE_RAM__)
+ if (IS_ENABLED(CONFIG_DEBUG_SERIALICE) &&
+ IS_ENABLED(CONFIG_DEBUG_SERIALICE_RAMSTAGE)) {
+ serialice_main();
+ }
+#else
+ if (IS_ENABLED(CONFIG_DEBUG_SERIALICE) &&
+ IS_ENABLED(CONFIG_DEBUG_SERIALICE_ROMSTAGE)) {
+ serialice_main();
+ }
+#endif
+
printk(BIOS_INFO, "\n\ncoreboot-%s%s %s " ENV_STRING " starting...\n",
coreboot_version, coreboot_extra_version, coreboot_build);
}
diff --git a/src/console/serialice.c b/src/console/serialice.c
new file mode 100644
index 0000000..0c9aa18
--- /dev/null
+++ b/src/console/serialice.c
@@ -0,0 +1,446 @@
+/*
+ * SerialICE
+ *
+ * Copyright (C) 2009 coresystems GmbH
+ * Copyright (C) 2016 Patrick Rudolph <siro at das-labor.org>
+ *
+ * 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.
+ *
+ */
+
+#include <console/console.h>
+#include <console/usb.h>
+#include <console/uart.h>
+#include <console/serialice.h>
+#include <console/serialice_priv.h>
+#include <arch/io.h>
+
+#define VERSION "1.6"
+
+/* Uart wrapper functions */
+
+static void sio_flush(void)
+{
+ if (IS_ENABLED(CONFIG_CONSOLE_USB))
+ __usb_tx_flush();
+ if (IS_ENABLED(CONFIG_CONSOLE_SERIAL))
+ __uart_tx_flush();
+}
+
+static void sio_putc(u8 byte)
+{
+ if (IS_ENABLED(CONFIG_CONSOLE_USB))
+ __usb_tx_byte(byte);
+ if (IS_ENABLED(CONFIG_CONSOLE_SERIAL))
+ __uart_tx_byte(byte);
+}
+
+static u8 sio_getc(void)
+{
+ u8 val = 0;
+
+ if (IS_ENABLED(CONFIG_CONSOLE_USB)) {
+ val = __usb_rx_byte();
+#ifdef ECHO_MODE
+ sio_putc(val);
+#endif
+ return val;
+ }
+ if (IS_ENABLED(CONFIG_CONSOLE_SERIAL)) {
+ val = __uart_rx_byte();
+#ifdef ECHO_MODE
+ sio_putc(val);
+#endif
+ return val;
+ }
+ return 0;
+}
+
+/* String functions */
+
+static void sio_putstring(const char *string)
+{
+ /* Very simple, no %d, %x etc. */
+ while (*string) {
+ if (*string == '\n')
+ sio_putc('\r');
+ sio_putc(*string);
+ string++;
+ }
+ sio_flush();
+}
+
+static void sio_put8(u8 data)
+{
+ u8 c;
+
+ c = (data >> 4) & 0xf;
+ sio_put_nibble(c);
+
+ c = data & 0xf;
+ sio_put_nibble(c);
+ sio_flush();
+}
+
+static void sio_put16(u16 data)
+{
+ int i;
+ u8 c;
+
+ for (i = 12; i >= 0; i -= 4) {
+ c = (data >> i) & 0xf;
+ sio_put_nibble(c);
+ }
+ sio_flush();
+}
+
+static void sio_put32(u32 data)
+{
+ int i;
+ u8 c;
+
+ for (i = 28; i >= 0; i -= 4) {
+ c = (data >> i) & 0xf;
+ sio_put_nibble(c);
+ }
+ sio_flush();
+}
+
+static u8 sio_get_nibble(void)
+{
+ u8 ret = 0;
+ u8 nibble = sio_getc();
+
+ if (nibble >= '0' && nibble <= '9') {
+ ret = (nibble - '0');
+ } else if (nibble >= 'a' && nibble <= 'f') {
+ ret = (nibble - 'a') + 0xa;
+ } else if (nibble >= 'A' && nibble <= 'F') {
+ ret = (nibble - 'A') + 0xa;
+ } else {
+ sio_putstring("ERROR: parsing number\n");
+ }
+ return ret;
+}
+
+static u8 sio_get8(void)
+{
+ u8 data;
+
+ data = sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ return data;
+}
+
+static u16 sio_get16(void)
+{
+ u16 data;
+
+ data = sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+
+ return data;
+}
+
+static u32 sio_get32(void)
+{
+ u32 data;
+
+ data = sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+ data = data << 4;
+ data |= sio_get_nibble();
+
+ return data;
+}
+
+/* SerialICE interface functions */
+
+static void serialice_read_memory(void)
+{
+ u8 width;
+ u32 *addr;
+
+ // Format:
+ // *rm00000000.w
+ addr = (u32 *)sio_get32();
+ sio_getc(); // skip .
+ width = sio_getc();
+
+ sio_putc('\r'); sio_putc('\n');
+
+ switch (width) {
+ case 'b':
+ sio_put8(read8(addr));
+ break;
+ case 'w':
+ sio_put16(read16(addr));
+ break;
+ case 'l':
+ sio_put32(read32(addr));
+ break;
+ }
+}
+
+static void serialice_write_memory(void)
+{
+ u8 width;
+ u32 *addr;
+ u32 data;
+
+ // Format:
+ // *wm00000000.w=0000
+ addr = (u32 *)sio_get32();
+ sio_getc(); // skip .
+ width = sio_getc();
+ sio_getc(); // skip =
+
+ switch (width) {
+ case 'b':
+ data = sio_get8();
+ write8(addr, (u8)data);
+ break;
+ case 'w':
+ data = sio_get16();
+ write16(addr, (u16)data);
+ break;
+ case 'l':
+ data = sio_get32();
+ write32(addr, (u32)data);
+ break;
+ }
+}
+
+static void serialice_read_io(void)
+{
+ u8 width;
+ u16 port;
+
+ // Format:
+ // *ri0000.w
+ port = sio_get16();
+ sio_getc(); // skip .
+ width = sio_getc();
+
+ sio_putc('\r'); sio_putc('\n');
+
+ switch (width) {
+ case 'b':
+ sio_put8(inb(port));
+ break;
+ case 'w':
+ sio_put16(inw(port));
+ break;
+ case 'l':
+ sio_put32(inl(port));
+ break;
+ }
+}
+
+static void serialice_write_io(void)
+{
+ u8 width;
+ u16 port;
+ u32 data;
+
+ // Format:
+ // *wi0000.w=0000
+ port = sio_get16();
+ sio_getc(); // skip .
+ width = sio_getc();
+ sio_getc(); // skip =
+
+ switch (width) {
+ case 'b':
+ data = sio_get8();
+ outb((u8)data, port);
+ break;
+ case 'w':
+ data = sio_get16();
+ outw((u16)data, port);
+ break;
+ case 'l':
+ data = sio_get32();
+ outl((u32)data, port);
+ break;
+ }
+}
+
+static void serialice_read_msr(void)
+{
+ u32 addr, key;
+ msr_t msr;
+
+ // Format:
+ // *rc00000000.9c5a203a
+ addr = sio_get32();
+ sio_getc(); // skip .
+ key = sio_get32(); // key in %edi
+
+ sio_putc('\r'); sio_putc('\n');
+
+ msr = rdmsr(addr, key);
+ sio_put32(msr.hi);
+ sio_putc('.');
+ sio_put32(msr.lo);
+}
+
+static void serialice_write_msr(void)
+{
+ u32 addr, key;
+ msr_t msr;
+
+ // Format:
+ // *wc00000000.9c5a203a=00000000.00000000
+ addr = sio_get32();
+ sio_getc(); // skip .
+ key = sio_get32(); // read key in %edi
+ sio_getc(); // skip =
+ msr.hi = sio_get32();
+ sio_getc(); // skip .
+ msr.lo = sio_get32();
+
+#ifdef __ROMCC__
+ /* Cheat to avoid register outage */
+ wrmsr(addr, msr, 0x9c5a203a);
+#else
+ wrmsr(addr, msr, key);
+#endif
+}
+
+static void serialice_cpuinfo(void)
+{
+ u32 eax, ecx;
+ u32 reg32;
+
+ // Format:
+ // --EAX--- --ECX---
+ // *ci00000000.00000000
+ eax = sio_get32();
+ sio_getc(); // skip .
+ ecx = sio_get32();
+
+ sio_putc('\r'); sio_putc('\n');
+
+ /* This code looks quite crappy but this way we don't
+ * have to worry about running out of registers if we
+ * occupy eax, ebx, ecx, edx at the same time
+ */
+ reg32 = cpuid_eax(eax, ecx);
+ sio_put32(reg32);
+ sio_putc('.');
+
+ reg32 = cpuid_ebx(eax, ecx);
+ sio_put32(reg32);
+ sio_putc('.');
+
+ reg32 = cpuid_ecx(eax, ecx);
+ sio_put32(reg32);
+ sio_putc('.');
+
+ reg32 = cpuid_edx(eax, ecx);
+ sio_put32(reg32);
+}
+
+static void serialice_mainboard(void)
+{
+ int i = 0;
+ const char mb_string[] = CONFIG_MAINBOARD_VENDOR" "
+ CONFIG_MAINBOARD_PART_NUMBER;
+
+ sio_putc('\r'); sio_putc('\n');
+
+ while (i < 32 && mb_string[i] > 0) {
+ sio_putc(mb_string[i]);
+ i++;
+ }
+ while (i < 32) {
+ sio_putc(' ');
+ i++;
+ }
+
+ sio_flush();
+}
+
+static void serialice_version(void)
+{
+ sio_putstring("\nSerialICE v" VERSION "\n");
+}
+
+int serialice_main(void)
+{
+ u16 c;
+
+ serialice_version();
+
+ while (1) {
+ sio_putstring("\n> ");
+
+ c = sio_getc();
+ if (c != '*')
+ continue;
+
+ c = sio_getc() << 8;
+ c |= sio_getc();
+
+ switch (c) {
+ case (('r' << 8)|'m'): // Read Memory *rm
+ serialice_read_memory();
+ break;
+ case (('w' << 8)|'m'): // Write Memory *wm
+ serialice_write_memory();
+ break;
+ case (('r' << 8)|'i'): // Read IO *ri
+ serialice_read_io();
+ break;
+ case (('w' << 8)|'i'): // Write IO *wi
+ serialice_write_io();
+ break;
+ case (('r' << 8)|'c'): // Read CPU MSR *rc
+ serialice_read_msr();
+ break;
+ case (('w' << 8)|'c'): // Write CPU MSR *wc
+ serialice_write_msr();
+ break;
+ case (('c' << 8)|'i'): // Read CPUID *ci
+ serialice_cpuinfo();
+ break;
+ case (('m' << 8)|'b'): // Read mainboard type *mb
+ serialice_mainboard();
+ break;
+ case (('v' << 8)|'i'): // Read version info *vi
+ serialice_version();
+ break;
+ default:
+ sio_putstring("ERROR\n");
+ break;
+ }
+ }
+
+ // Never get here:
+ return 0;
+}
diff --git a/src/include/console/serialice.h b/src/include/console/serialice.h
new file mode 100644
index 0000000..522906c
--- /dev/null
+++ b/src/include/console/serialice.h
@@ -0,0 +1,23 @@
+/*
+ * SerialICE
+ *
+ * Copyright (C) 2009 coresystems GmbH
+ * Copyright (C) 2016 Patrick Rudolph <siro at das-labor.org>
+ *
+ * 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.
+ *
+ */
+
+#ifndef CONSOLE_SERIALICE_H
+#define CONSOLE_SERIALICE_H
+
+int serialice_main(void);
+
+#endif
diff --git a/src/include/console/serialice_priv.h b/src/include/console/serialice_priv.h
new file mode 100644
index 0000000..078ef04
--- /dev/null
+++ b/src/include/console/serialice_priv.h
@@ -0,0 +1,103 @@
+/*
+ * SerialICE
+ *
+ * Copyright (C) 2009 coresystems GmbH
+ * Copyright (C) 2016 Patrick Rudolph <siro at das-labor.org>
+ *
+ * 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.
+ *
+ */
+
+#ifndef CONSOLE_SERIALICE_PRIV_H
+#define CONSOLE_SERIALICE_PRIV_H
+
+/* String functions */
+
+#define sio_put_nibble(nibble) \
+ do { \
+ if (nibble > 9) \
+ nibble += ('a' - 10); \
+ else \
+ nibble += '0'; \
+ sio_putc(nibble); \
+ } while (0)
+
+/* MSR functions */
+
+typedef struct { u32 lo, hi; } msr_t;
+
+static inline msr_t rdmsr(u32 index, u32 key)
+{
+ msr_t result;
+
+ __asm__ __volatile__ (
+ "rdmsr"
+ : "=a" (result.lo), "=d" (result.hi)
+ : "c" (index), "D" (key)
+ );
+ return result;
+}
+
+static inline void wrmsr(u32 index, msr_t msr, u32 key)
+{
+ __asm__ __volatile__ (
+ "wrmsr"
+ : /* No outputs */
+ : "c" (index), "a" (msr.lo), "d" (msr.hi), "D" (key)
+ );
+}
+
+/* CPUID functions */
+
+static inline u32 cpuid_eax(u32 op, u32 op2)
+{
+ u32 eax;
+
+ __asm__("cpuid"
+ : "=a" (eax)
+ : "a" (op), "c" (op2)
+ : "ebx", "edx");
+ return eax;
+}
+
+static inline u32 cpuid_ebx(u32 op, u32 op2)
+{
+ u32 ebx;
+
+ __asm__("cpuid"
+ : "=b" (ebx)
+ : "a" (op), "c" (op2)
+ : "edx");
+ return ebx;
+}
+
+static inline u32 cpuid_ecx(u32 op, u32 op2)
+{
+ u32 ecx;
+
+ __asm__("cpuid"
+ : "=c" (ecx)
+ : "a" (op), "c" (op2)
+ : "ebx", "edx");
+ return ecx;
+}
+
+static inline u32 cpuid_edx(u32 op, u32 op2)
+{
+ u32 edx;
+
+ __asm__("cpuid"
+ : "=d" (edx)
+ : "a" (op), "c" (op2)
+ : "ebx");
+ return edx;
+}
+
+#endif
diff --git a/src/include/console/uart.h b/src/include/console/uart.h
index 8458086..278e0e3 100644
--- a/src/include/console/uart.h
+++ b/src/include/console/uart.h
@@ -59,10 +59,12 @@ void oxford_remap(unsigned int new_base);
static inline void __uart_init(void) { uart_init(CONFIG_UART_FOR_CONSOLE); }
static inline void __uart_tx_byte(u8 data) { uart_tx_byte(CONFIG_UART_FOR_CONSOLE, data); }
static inline void __uart_tx_flush(void) { uart_tx_flush(CONFIG_UART_FOR_CONSOLE); }
+static inline u8 __uart_rx_byte(void) { return uart_rx_byte(CONFIG_UART_FOR_CONSOLE); }
#else
static inline void __uart_init(void) {}
static inline void __uart_tx_byte(u8 data) {}
static inline void __uart_tx_flush(void) {}
+static inline u8 __uart_rx_byte(void) { return 0; }
#endif
#if CONFIG_GDB_STUB && (ENV_ROMSTAGE || ENV_RAMSTAGE)
diff --git a/src/include/console/usb.h b/src/include/console/usb.h
index b758c03..2f7da49 100644
--- a/src/include/console/usb.h
+++ b/src/include/console/usb.h
@@ -37,10 +37,12 @@ int usb_can_rx_byte(int idx);
static inline void __usbdebug_init(void) { usbdebug_init(); }
static inline void __usb_tx_byte(u8 data) { usb_tx_byte(USB_PIPE_FOR_CONSOLE, data); }
static inline void __usb_tx_flush(void) { usb_tx_flush(USB_PIPE_FOR_CONSOLE); }
+static inline u8 __usb_rx_byte(void) { return usb_rx_byte(USB_PIPE_FOR_CONSOLE); }
#else
static inline void __usbdebug_init(void) {}
static inline void __usb_tx_byte(u8 data) {}
static inline void __usb_tx_flush(void) {}
+static inline u8 __usb_rx_byte(void) { return 0; }
#endif
/* */
More information about the coreboot-gerrit
mailing list