libpayload: Add minimal support for PL011 UART

This creates a new PL011 config variable which avoids the
infinite busy wait on serial_putchar() because the register
mapping is not compatible with current implementation.

BUG=None
BRANCH=none
TEST=printf() works on the PL011 based ARMv8 foundation model

Original-Change-Id: I9feda35a50a3488fc504d1561444161e0889deda
Original-Signed-off-by: Marcelo Povoa <marcelogp@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/187020
Original-Reviewed-by: David Hendricks <dhendrix@chromium.org>
(cherry picked from commit 85779a34a161c324cc8af995ada4393137275f20)
Signed-off-by: Marc Jones <marc.jones@se-eng.com>

Conflicts:
	payloads/libpayload/Config.in
	payloads/libpayload/drivers/serial.c

Change-Id: I23c8b3728cd7d2d7692b3e86a679e061e88f7bb5
Reviewed-on: http://review.coreboot.org/7422
Tested-by: build bot (Jenkins)
Reviewed-by: David Hendricks <dhendrix@chromium.org>

2 files changed, 255 insertions, 0 deletions

diff --git a/payloads/libpayload/Config.in b/payloads/libpayload/Config.in
index 466a4f2774..f317c180b8 100644
--- a/payloads/libpayload/Config.in
+++ b/payloads/libpayload/Config.in
@@ -178,6 +178,11 @@ config TEGRA_SERIAL_CONSOLE
 	depends on SERIAL_CONSOLE
 	default n
 
+config PL011_SERIAL_CONSOLE
+	bool "PL011 compatible serial port driver"
+	depends on 8250_SERIAL_CONSOLE
+	default n
+
 config SERIAL_IOBASE
 	## This default is currently not used on non-x86 systems.
 	hex "Default I/O base for the serial port (default 0x3f8)"
diff --git a/payloads/libpayload/drivers/serial.c b/payloads/libpayload/drivers/serial.c
new file mode 100644
index 0000000000..6ecc5d2100
--- /dev/null
+++ b/payloads/libpayload/drivers/serial.c
@@ -0,0 +1,250 @@
+/*
+ * This file is part of the libpayload project.
+ *
+ * Copyright (C) 2008 Advanced Micro Devices, Inc.
+ * Copyright (C) 2008 Ulf Jordan <jordan@chalmers.se>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#include <libpayload-config.h>
+#include <libpayload.h>
+
+#define IOBASE lib_sysinfo.serial->baseaddr
+#define MEMBASE (phys_to_virt(IOBASE))
+
+static int serial_hardware_is_present = 0;
+static int serial_is_mem_mapped = 0;
+
+static uint8_t serial_read_reg(int offset)
+{
+#ifdef CONFIG_LP_IO_ADDRESS_SPACE
+	if (!serial_is_mem_mapped)
+		return inb(IOBASE + offset);
+	else
+#endif
+		return readb(MEMBASE + offset);
+}
+
+static void serial_write_reg(uint8_t val, int offset)
+{
+#ifdef CONFIG_LP_IO_ADDRESS_SPACE
+	if (!serial_is_mem_mapped)
+		outb(val, IOBASE + offset);
+	else
+#endif
+		writeb(val, MEMBASE + offset);
+}
+
+#ifdef CONFIG_LP_SERIAL_SET_SPEED
+static void serial_hardware_init(int speed, int word_bits,
+				 int parity, int stop_bits)
+{
+	unsigned char reg;
+
+#ifndef PL011_SERIAL_CONSOLE
+	/* Disable interrupts. */
+	serial_write_reg(0, 0x01);
+
+	/* Assert RTS and DTR. */
+	serial_write_reg(3, 0x04);
+
+	/* Set the divisor latch. */
+	reg = serial_read_reg(0x03);
+	serial_write_reg(reg | 0x80, 0x03);
+
+	/* Write the divisor. */
+	uint16_t divisor = 115200 / speed;
+	serial_write_reg(divisor & 0xFF, 0x00);
+	serial_write_reg(divisor >> 8, 0x01);
+
+	/* Restore the previous value of the divisor.
+	 * And set 8 bits per character */
+	serial_write_reg((reg & ~0x80) | 3, 0x03);
+#endif
+}
+#endif
+
+static struct console_input_driver consin = {
+	.havekey = &serial_havechar,
+	.getchar = &serial_getchar
+};
+
+static struct console_output_driver consout = {
+	.putchar = &serial_putchar
+};
+
+void serial_init(void)
+{
+	if (!lib_sysinfo.serial)
+		return;
+
+	serial_is_mem_mapped =
+		(lib_sysinfo.serial->type == CB_SERIAL_TYPE_MEMORY_MAPPED);
+
+	if (!serial_is_mem_mapped) {
+#ifdef CONFIG_LP_IO_ADDRESS_SPACE
+		if ((inb(IOBASE + 0x05) == 0xFF) &&
+				(inb(IOBASE + 0x06) == 0xFF)) {
+			return;
+		}
+#else
+		printf("IO space mapped serial not supported.");
+		return;
+#endif
+	}
+
+
+	serial_hardware_is_present = 1;
+
+#ifdef CONFIG_LP_SERIAL_SET_SPEED
+	serial_hardware_init(CONFIG_LP_SERIAL_BAUD_RATE, 8, 0, 1);
+#endif
+}
+
+void serial_console_init(void)
+{
+	if (!lib_sysinfo.serial)
+		return;
+
+	serial_init();
+
+	console_add_input_driver(&consin);
+	console_add_output_driver(&consout);
+}
+
+void serial_putchar(unsigned int c)
+{
+	if (!serial_hardware_is_present)
+		return;
+#ifndef CONFIG_LP_PL011_SERIAL_CONSOLE
+	while ((serial_read_reg(0x05) & 0x20) == 0) ;
+#endif
+	serial_write_reg(c, 0x00);
+}
+
+int serial_havechar(void)
+{
+	if (!serial_hardware_is_present)
+		return 0;
+	return serial_read_reg(0x05) & 0x01;
+}
+
+int serial_getchar(void)
+{
+	if (!serial_hardware_is_present)
+		return -1;
+	while (!serial_havechar()) ;
+	return serial_read_reg(0x00);
+}
+
+/*  These are thinly veiled vt100 functions used by curses */
+
+#define VT100_CLEAR       "\e[H\e[J"
+/* These defines will fail if you use bold and reverse at the same time.
+ * Switching off one of them will switch off both. tinycurses knows about
+ * this and does the right thing.
+ */
+#define VT100_SBOLD       "\e[1m"
+#define VT100_EBOLD       "\e[m"
+#define VT100_SREVERSE    "\e[7m"
+#define VT100_EREVERSE    "\e[m"
+#define VT100_CURSOR_ADDR "\e[%d;%dH"
+#define VT100_CURSOR_ON   "\e[?25l"
+#define VT100_CURSOR_OFF  "\e[?25h"
+/* The following smacs/rmacs are actually for xterm; a real vt100 has
+   enacs=\E(B\E)0, smacs=^N, rmacs=^O.  */
+#define VT100_SMACS       "\e(0"
+#define VT100_RMACS       "\e(B"
+/* A vt100 doesn't do color, setaf/setab below are from xterm-color. */
+#define VT100_SET_COLOR   "\e[3%d;4%dm"
+
+static void serial_putcmd(const char *str)
+{
+	while (*str)
+		serial_putchar(*(str++));
+}
+
+void serial_clear(void)
+{
+	serial_putcmd(VT100_CLEAR);
+}
+
+void serial_start_bold(void)
+{
+	serial_putcmd(VT100_SBOLD);
+}
+
+void serial_end_bold(void)
+{
+	serial_putcmd(VT100_EBOLD);
+}
+
+void serial_start_reverse(void)
+{
+	serial_putcmd(VT100_SREVERSE);
+}
+
+void serial_end_reverse(void)
+{
+	serial_putcmd(VT100_EREVERSE);
+}
+
+void serial_start_altcharset(void)
+{
+	serial_putcmd(VT100_SMACS);
+}
+
+void serial_end_altcharset(void)
+{
+	serial_putcmd(VT100_RMACS);
+}
+
+/**
+ * Set the foreground and background colors on the serial console.
+ *
+ * @param fg Foreground color number.
+ * @param bg Background color number.
+ */
+void serial_set_color(short fg, short bg)
+{
+	char buffer[32];
+	snprintf(buffer, sizeof(buffer), VT100_SET_COLOR, fg, bg);
+	serial_putcmd(buffer);
+}
+
+void serial_set_cursor(int y, int x)
+{
+	char buffer[32];
+	snprintf(buffer, sizeof(buffer), VT100_CURSOR_ADDR, y + 1, x + 1);
+	serial_putcmd(buffer);
+}
+
+void serial_cursor_enable(int state)
+{
+	if (state)
+		serial_putcmd(VT100_CURSOR_ON);
+	else
+		serial_putcmd(VT100_CURSOR_OFF);
+}