Add support for the SMSC LPC47n227 SuperI/O chip

Signed-off-by: Stefan Reinauer <stepan@coresystems.de>
Acked-by: Ronald G. Minnich <rminnich@gmail.com>
Acked-by: Peter Stuge <peter@stuge.se>



git-svn-id: svn://svn.coreboot.org/coreboot/trunk@5027 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

6 files changed, 601 insertions, 0 deletions

diff --git a/src/superio/smsc/lpc47n227/Config.lb b/src/superio/smsc/lpc47n227/Config.lb
new file mode 100644
index 0000000000..f439b9a6e3
--- /dev/null
+++ b/src/superio/smsc/lpc47n227/Config.lb
@@ -0,0 +1,21 @@
+## 
+## This file is part of the coreboot project.
+## 
+## Copyright (C) 2008 coresystems GmbH
+## 
+## 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
+## 
+
+config chip.h
+object superio.o
diff --git a/src/superio/smsc/lpc47n227/Makefile.inc b/src/superio/smsc/lpc47n227/Makefile.inc
new file mode 100644
index 0000000000..88f0177de1
--- /dev/null
+++ b/src/superio/smsc/lpc47n227/Makefile.inc
@@ -0,0 +1,20 @@
+##
+## This file is part of the coreboot project.
+##
+## Copyright (C) 2009 coresystems GmbH
+##
+## 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
+##
+
+obj-$(CONFIG_SUPERIO_SMSC_LPC47N227) += superio.o
diff --git a/src/superio/smsc/lpc47n227/chip.h b/src/superio/smsc/lpc47n227/chip.h
new file mode 100644
index 0000000000..ef1030751e
--- /dev/null
+++ b/src/superio/smsc/lpc47n227/chip.h
@@ -0,0 +1,29 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2008-2009 coresystems GmbH
+ *
+ * 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
+ */
+
+#include <device/device.h>
+#include <pc80/keyboard.h>
+#include <uart8250.h>
+
+extern struct chip_operations superio_smsc_lpc47n227_ops;
+
+struct superio_smsc_lpc47n227_config {
+	struct uart8250 com1, com2;
+	struct pc_keyboard keyboard;
+};
diff --git a/src/superio/smsc/lpc47n227/lpc47n227.h b/src/superio/smsc/lpc47n227/lpc47n227.h
new file mode 100644
index 0000000000..10b47736b1
--- /dev/null
+++ b/src/superio/smsc/lpc47n227/lpc47n227.h
@@ -0,0 +1,29 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2008-2009 coresystems GmbH
+ *
+ * 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
+ */
+
+/* Since the LPC47N227 does not have logical devices but a flat configuration
+ * space, these are arbitrary, but must match declarations in the mainboard
+ * devicetree.cb
+ */
+#define LPC47N227_PP               1	/* Parallel Port */
+#define LPC47N227_SP1              2	/* COM1 */
+#define LPC47N227_SP2              3	/* COM2 */
+#define LPC47N227_KBDC             5	/* Keyboard */
+
+#define LPC47N227_MAX_CONFIG_REGISTER	0x39
diff --git a/src/superio/smsc/lpc47n227/lpc47n227_early_serial.c b/src/superio/smsc/lpc47n227/lpc47n227_early_serial.c
new file mode 100644
index 0000000000..40de4e0007
--- /dev/null
+++ b/src/superio/smsc/lpc47n227/lpc47n227_early_serial.c
@@ -0,0 +1,150 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2005 Digital Design Corporation
+ * Copyright (C) 2008-2009 coresystems GmbH
+ *
+ * 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
+ */
+
+/* Pre-RAM driver for SMSC LPC47N227 Super I/O chip. */
+
+#include <arch/romcc_io.h>
+#include "lpc47n227.h"
+
+//----------------------------------------------------------------------------------
+// Function:            pnp_enter_conf_state
+// Parameters:          dev - high 8 bits = Super I/O port
+// Return Value:        None
+// Description:         Enable access to the LPC47N227's configuration registers.
+//
+static inline void pnp_enter_conf_state(device_t dev)
+{
+	unsigned port = dev >> 8;
+	outb(0x55, port);
+}
+
+//----------------------------------------------------------------------------------
+// Function:            pnp_exit_conf_state
+// Parameters:          dev - high 8 bits = Super I/O port
+// Return Value:        None
+// Description:         Disable access to the LPC47N227's configuration registers.
+//
+static void pnp_exit_conf_state(device_t dev)
+{
+	unsigned port = dev >> 8;
+	outb(0xaa, port);
+}
+
+//----------------------------------------------------------------------------------
+// Function:            lpc47n227_pnp_set_iobase
+// Parameters:          dev - high 8 bits = Super I/O port, 
+//                            low 8 bits = logical device number (per lpc47n227.h)
+//                      iobase - base I/O port for the logical device
+// Return Value:        None
+// Description:         Program the base I/O port for the specified logical device.
+//
+void lpc47n227_pnp_set_iobase(device_t dev, unsigned iobase)
+{
+	// LPC47N227 requires base ports to be a multiple of 4
+	ASSERT(!(iobase & 0x3));
+
+	switch (dev & 0xFF) {
+	case LPC47N227_PP:
+		pnp_write_config(dev, 0x23, (iobase >> 2) & 0xff);
+		break;
+
+	case LPC47N227_SP1:
+		pnp_write_config(dev, 0x24, (iobase >> 2) & 0xff);
+		break;
+
+	case LPC47N227_SP2:
+		pnp_write_config(dev, 0x25, (iobase >> 2) & 0xff);
+		break;
+
+	default:
+		break;
+	}
+}
+
+//----------------------------------------------------------------------------------
+// Function:            lpc47n227_pnp_set_enable
+// Parameters:          dev - high 8 bits = Super I/O port, 
+//                      low 8 bits = logical device number (per lpc47n227.h)
+//                      enable - 0 to disable, anythig else to enable
+// Return Value:        None
+// Description:         Enable or disable the specified logical device.
+//                      Technically, a full disable requires setting the device's base
+//                      I/O port below 0x100. We don't do that here, because we don't
+//                      have access to a data structure that specifies what the 'real'
+//                      base port is (when asked to enable the device). Also the function
+//                      is used only to disable the device while its true base port is
+//                      programmed (see lpc47n227_enable_serial() below).
+//
+void lpc47n227_pnp_set_enable(device_t dev, int enable)
+{
+	uint8_t power_register = 0;
+	uint8_t power_mask = 0;
+	uint8_t current_power;
+	uint8_t new_power;
+
+	switch (dev & 0xFF) {
+	case LPC47N227_PP:
+		power_register = 0x01;
+		power_mask = 0x04;
+		break;
+
+	case LPC47N227_SP1:
+		power_register = 0x02;
+		power_mask = 0x08;
+		break;
+
+	case LPC47N227_SP2:
+		power_register = 0x02;
+		power_mask = 0x80;
+		break;
+
+	default:
+		return;
+	}
+
+	current_power = pnp_read_config(dev, power_register);
+	new_power = current_power & ~power_mask;	// disable by default
+
+	if (enable)
+		new_power |= power_mask;	// Enable
+
+	pnp_write_config(dev, power_register, new_power);
+}
+
+//----------------------------------------------------------------------------------
+// Function:            lpc47n227_enable_serial
+// Parameters:          dev - high 8 bits = Super I/O port, 
+//                            low 8 bits = logical device number (per lpc47n227.h)
+//                      iobase - processor I/O port address to assign to this serial device
+// Return Value:        bool
+// Description:         Configure the base I/O port of the specified serial device
+//                      and enable the serial device.
+//
+static void lpc47n227_enable_serial(device_t dev, unsigned iobase)
+{
+	// NOTE: Cannot use pnp_set_XXX() here because they assume chip
+	// support for logical devices, which the LPC47N227 doesn't have
+
+	pnp_enter_conf_state(dev);
+	lpc47n227_pnp_set_enable(dev, 0);
+	lpc47n227_pnp_set_iobase(dev, iobase);
+	lpc47n227_pnp_set_enable(dev, 1);
+	pnp_exit_conf_state(dev);
+}
diff --git a/src/superio/smsc/lpc47n227/superio.c b/src/superio/smsc/lpc47n227/superio.c
new file mode 100644
index 0000000000..26f507b695
--- /dev/null
+++ b/src/superio/smsc/lpc47n227/superio.c
@@ -0,0 +1,352 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2005 Digital Design Corporation
+ * Copyright (C) 2008-2009 coresystems GmbH
+ *
+ * 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
+ */
+
+/* RAM-based driver for SMSC LPC47N227 Super I/O chip. */
+
+#include <arch/io.h>
+#include <device/device.h>
+#include <device/pnp.h>
+#include <console/console.h>
+#include <device/smbus.h>
+#include <string.h>
+#include <bitops.h>
+#include <uart8250.h>
+#include <assert.h>
+#include <stdlib.h>
+#include "chip.h"
+#include "lpc47n227.h"
+
+// Forward declarations
+static void enable_dev(device_t dev);
+void lpc47n227_pnp_set_resources(device_t dev);
+void lpc47n227_pnp_enable_resources(device_t dev);
+void lpc47n227_pnp_enable(device_t dev);
+static void lpc47n227_init(device_t dev);
+
+static void lpc47n227_pnp_set_resource(device_t dev, struct resource *resource);
+void lpc47n227_pnp_set_iobase(device_t dev, unsigned iobase);
+void lpc47n227_pnp_set_drq(device_t dev, unsigned drq);
+void lpc47n227_pnp_set_irq(device_t dev, unsigned irq);
+void lpc47n227_pnp_set_enable(device_t dev, int enable);
+
+static void pnp_enter_conf_state(device_t dev);
+static void pnp_exit_conf_state(device_t dev);
+
+struct chip_operations superio_smsc_lpc47n227_ops = {
+	CHIP_NAME("SMSC LPC47N227 Super I/O")
+	    .enable_dev = enable_dev,
+};
+
+static struct device_operations ops = {
+	.read_resources = pnp_read_resources,
+	.set_resources = lpc47n227_pnp_set_resources,
+	.enable_resources = lpc47n227_pnp_enable_resources,
+	.enable = lpc47n227_pnp_enable,
+	.init = lpc47n227_init,
+};
+
+static struct pnp_info pnp_dev_info[] = {
+	{&ops, LPC47N227_PP, PNP_IO0 | PNP_IRQ0 | PNP_DRQ0, {0x07f8, 0},},
+	{&ops, LPC47N227_SP1, PNP_IO0 | PNP_IRQ0, {0x7f8, 0},},
+	{&ops, LPC47N227_SP2, PNP_IO0 | PNP_IRQ0, {0x7f8, 0},},
+	{&ops, LPC47N227_KBDC, PNP_IO0 | PNP_IO1 | PNP_IRQ0, {0x7f8, 0},
+	 {0x7f8, 0x4},}
+};
+
+/**********************************************************************************/
+/*                             PUBLIC INTERFACE	                                  */
+/**********************************************************************************/
+
+//----------------------------------------------------------------------------------
+// Function:            enable_dev
+// Parameters:          dev - pointer to structure describing a Super I/O device 
+// Return Value:        None
+// Description:         Create device structures and allocate resources to devices 
+//                      specified in the pnp_dev_info array (above).
+//
+static void enable_dev(device_t dev)
+{
+	pnp_enable_devices(dev, &pnp_ops,
+			   ARRAY_SIZE(pnp_dev_info), pnp_dev_info);
+}
+
+//----------------------------------------------------------------------------------
+// Function:            lpc47n227_pnp_set_resources
+// Parameters:          dev - pointer to structure describing a Super I/O device 
+// Return Value:        None
+// Description:         Configure the specified Super I/O device with the resources
+//                      (I/O space, etc.) that have been allocate for it.
+//
+void lpc47n227_pnp_set_resources(device_t dev)
+{
+	int i;
+
+	pnp_enter_conf_state(dev);
+
+	// NOTE: Cannot use pnp_set_resources() here because it assumes chip
+	// support for logical devices, which the LPC47N227 doesn't have
+	for (i = 0; i < dev->resources; i++)
+		lpc47n227_pnp_set_resource(dev, &dev->resource[i]);
+
+	pnp_exit_conf_state(dev);
+}
+
+void lpc47n227_pnp_enable_resources(device_t dev)
+{
+	pnp_enter_conf_state(dev);
+
+	// NOTE: Cannot use pnp_enable_resources() here because it assumes chip
+	// support for logical devices, which the LPC47N227 doesn't have
+	lpc47n227_pnp_set_enable(dev, 1);
+
+	pnp_exit_conf_state(dev);
+}
+
+void lpc47n227_pnp_enable(device_t dev)
+{
+	pnp_enter_conf_state(dev);
+
+	// NOTE: Cannot use pnp_set_enable() here because it assumes chip
+	// support for logical devices, which the LPC47N227 doesn't have
+
+	if (dev->enabled) {
+		lpc47n227_pnp_set_enable(dev, 1);
+	} else {
+		lpc47n227_pnp_set_enable(dev, 0);
+	}
+
+	pnp_exit_conf_state(dev);
+}
+
+//----------------------------------------------------------------------------------
+// Function:            lpc47n227_init
+// Parameters:          dev - pointer to structure describing a Super I/O device 
+// Return Value:        None
+// Description:         Initialize the specified Super I/O device.
+//                      Devices other than COM ports and keyboard controller are ignored.
+//                      For COM ports, we configure the baud rate. 
+//
+static void lpc47n227_init(device_t dev)
+{
+	struct superio_smsc_lpc47n227_config *conf = dev->chip_info;
+	struct resource *res0;
+
+	if (!dev->enabled)
+		return;
+
+	switch (dev->path.pnp.device) {
+	case LPC47N227_SP1:
+		res0 = find_resource(dev, PNP_IDX_IO0);
+		init_uart8250(res0->base, &conf->com1);
+		break;
+
+	case LPC47N227_SP2:
+		res0 = find_resource(dev, PNP_IDX_IO0);
+		init_uart8250(res0->base, &conf->com2);
+		break;
+
+	case LPC47N227_KBDC:
+		printk_debug("LPC47N227: Initializing keyboard.\n");
+		init_pc_keyboard(0x60, 0x64, &conf->keyboard);
+		break;
+	}
+}
+
+/**********************************************************************************/
+/*                              PRIVATE FUNCTIONS                                 */
+/**********************************************************************************/
+
+static void lpc47n227_pnp_set_resource(device_t dev, struct resource *resource)
+{
+	if (!(resource->flags & IORESOURCE_ASSIGNED)) {
+		printk_err("ERROR: %s %02lx not allocated\n",
+			   dev_path(dev), resource->index);
+		return;
+	}
+
+	/* Now store the resource */
+	// NOTE: Cannot use pnp_set_XXX() here because they assume chip
+	// support for logical devices, which the LPC47N227 doesn't have
+
+	if (resource->flags & IORESOURCE_IO) {
+		lpc47n227_pnp_set_iobase(dev, resource->base);
+	} else if (resource->flags & IORESOURCE_DRQ) {
+		lpc47n227_pnp_set_drq(dev, resource->base);
+	} else if (resource->flags & IORESOURCE_IRQ) {
+		lpc47n227_pnp_set_irq(dev, resource->base);
+	} else {
+		printk_err("ERROR: %s %02lx unknown resource type\n",
+			   dev_path(dev), resource->index);
+		return;
+	}
+	resource->flags |= IORESOURCE_STORED;
+
+	report_resource_stored(dev, resource, "");
+}
+
+void lpc47n227_pnp_set_iobase(device_t dev, unsigned iobase)
+{
+	ASSERT(!(iobase & 0x3));
+
+	switch (dev->path.pnp.device) {
+	case LPC47N227_PP:
+		pnp_write_config(dev, 0x23, (iobase >> 2) & 0xff);
+		break;
+
+	case LPC47N227_SP1:
+		pnp_write_config(dev, 0x24, (iobase >> 2) & 0xff);
+		break;
+
+	case LPC47N227_SP2:
+		pnp_write_config(dev, 0x25, (iobase >> 2) & 0xff);
+		break;
+
+	case LPC47N227_KBDC:
+		break;
+
+	default:
+		BUG();
+		break;
+	}
+}
+
+void lpc47n227_pnp_set_drq(device_t dev, unsigned drq)
+{
+	if (dev->path.pnp.device == LPC47N227_PP) {
+		const uint8_t PP_DMA_MASK = 0x0F;
+		const uint8_t PP_DMA_SELECTION_REGISTER = 0x26;
+		uint8_t current_config =
+		    pnp_read_config(dev, PP_DMA_SELECTION_REGISTER);
+		uint8_t new_config;
+
+		ASSERT(!(drq & ~PP_DMA_MASK));	// DRQ out of range??           
+		new_config = (current_config & ~PP_DMA_MASK) | drq;
+		pnp_write_config(dev, PP_DMA_SELECTION_REGISTER, new_config);
+	} else {
+		BUG();
+	}
+}
+
+void lpc47n227_pnp_set_irq(device_t dev, unsigned irq)
+{
+	uint8_t irq_config_register = 0;
+	uint8_t irq_config_mask = 0;
+	uint8_t current_config;
+	uint8_t new_config;
+
+	switch (dev->path.pnp.device) {
+	case LPC47N227_PP:
+		irq_config_register = 0x27;
+		irq_config_mask = 0x0F;
+		break;
+
+	case LPC47N227_SP1:
+		irq_config_register = 0x28;
+		irq_config_mask = 0xF0;
+		irq <<= 4;
+		break;
+
+	case LPC47N227_SP2:
+		irq_config_register = 0x28;
+		irq_config_mask = 0x0F;
+		break;
+
+	case LPC47N227_KBDC:
+		break;
+
+	default:
+		BUG();
+		return;
+	}
+
+	current_config = pnp_read_config(dev, irq_config_register);
+	new_config = (current_config & ~irq_config_mask) | irq;
+	pnp_write_config(dev, irq_config_register, new_config);
+}
+
+void lpc47n227_pnp_set_enable(device_t dev, int enable)
+{
+	uint8_t power_register = 0;
+	uint8_t power_mask = 0;
+	uint8_t current_power;
+	uint8_t new_power;
+
+	switch (dev->path.pnp.device) {
+	case LPC47N227_PP:
+		power_register = 0x01;
+		power_mask = 0x04;
+		break;
+
+	case LPC47N227_SP1:
+		power_register = 0x02;
+		power_mask = 0x08;
+		break;
+
+	case LPC47N227_SP2:
+		power_register = 0x02;
+		power_mask = 0x80;
+		break;
+
+	case LPC47N227_KBDC:
+		break;
+
+	default:
+		BUG();
+		return;
+	}
+
+	current_power = pnp_read_config(dev, power_register);
+	new_power = current_power & ~power_mask;	// disable by default
+
+	if (enable) {
+		struct resource *ioport_resource =
+		    find_resource(dev, PNP_IDX_IO0);
+		lpc47n227_pnp_set_iobase(dev, ioport_resource->base);
+
+		new_power |= power_mask;	// Enable
+
+	} else {
+		lpc47n227_pnp_set_iobase(dev, 0);
+	}
+	pnp_write_config(dev, power_register, new_power);
+}
+
+//----------------------------------------------------------------------------------
+// Function:            pnp_enter_conf_state
+// Parameters:          dev - pointer to structure describing a Super I/O device 
+// Return Value:        None
+// Description:         Enable access to the LPC47N227's configuration registers.
+//
+static void pnp_enter_conf_state(device_t dev)
+{
+	outb(0x55, dev->path.pnp.port);
+}
+
+//----------------------------------------------------------------------------------
+// Function:            pnp_exit_conf_state
+// Parameters:          dev - pointer to structure describing a Super I/O device 
+// Return Value:        None
+// Description:         Disable access to the LPC47N227's configuration registers.
+//
+static void pnp_exit_conf_state(device_t dev)
+{
+	outb(0xaa, dev->path.pnp.port);
+}
+