drivers/pc80: Add PS/2 mouse presence detect

On certain Winbond SuperIO devices, when a PS/2 mouse is not
present on the auxiliary channel both channels will cease to
function if the auxiliary channel is probed while the primary
channel is active.  Therefore, knowledge of mouse presence
must be gathered by coreboot during early boot, and used to
enable or disable the auxiliary PS/2 port before control is
passed to the operating system.

Add auxiliary channel PS/2 device presence detect, and update
the Winbond W83667HG-A driver to flag the auxiliary channel as
disabled if no device was detected.

Change-Id: I76274493dacc9016ac6d0dff8548d1dc931c6266
Signed-off-by: Timothy Pearson <tpearson@raptorengineeringinc.com>
Reviewed-on: https://review.coreboot.org/13165
Tested-by: build bot (Jenkins)
Tested-by: Raptor Engineering Automated Test Stand <noreply@raptorengineeringinc.com>
Reviewed-by: Martin Roth <martinroth@google.com>

src/superio/fintek/f71863fg/superio.c

@@ -34,7 +34,7 @@ static void f71863fg_init(struct device *dev)
 	/* TODO: Might potentially need code for HWM or FDC etc. */
 	case F71863FG_KBC:
 		res0 = find_resource(dev, PNP_IDX_IO0);
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/fintek/f71869ad/superio.c

@@ -34,7 +34,7 @@ static void f71869ad_init(struct device *dev)
 	switch(dev->path.pnp.device) {
 	/* TODO: Might potentially need code for HWM or FDC etc. */
 	case F71869AD_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case F71869AD_HWM:
 		f71869ad_multifunc_init(dev);

src/superio/fintek/f71872/superio.c

@@ -32,7 +32,7 @@ static void f71872_init(struct device *dev)
 	switch(dev->path.pnp.device) {
 	/* TODO: Might potentially need code for HWM or FDC etc. */
 	case F71872_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/fintek/f81865f/superio.c

@@ -32,7 +32,7 @@ static void f81865f_init(struct device *dev)
 	switch (dev->path.pnp.device) {
 	/* TODO: Might potentially need code for HWM or FDC etc. */
 	case F81865F_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/fintek/f81866d/superio.c

@@ -34,7 +34,7 @@ static void f81866d_init(struct device *dev)
 	switch (dev->path.pnp.device) {
 	/* TODO: Might potentially need extra code for serial, wdt etc. */
 	case F81866D_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case F81866D_HWM:
 		// Fixing temp sensor read out and init Fan control

src/superio/ite/it8671f/superio.c

@@ -32,7 +32,7 @@ static void init(struct device *dev)
 	case IT8671F_PP: /* TODO. */
 		break;
 	case IT8671F_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case IT8671F_KBCM: /* TODO. */
 		break;

src/superio/ite/it8712f/superio.c

@@ -39,7 +39,7 @@ static void it8712f_init(struct device *dev)
 		break;
 	case IT8712F_KBCK:
 		set_kbc_ps2_mode();
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case IT8712F_KBCM: /* TODO. */
 		break;

src/superio/ite/it8716f/superio.c

@@ -60,7 +60,7 @@ static void it8716f_init(struct device *dev)
 		init_ec(res0->base + EC_INDEX_PORT);
 		break;
 	case IT8716F_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/ite/it8718f/superio.c

@@ -34,7 +34,7 @@ static void init(struct device *dev)
 	case IT8718F_EC: /* TODO. */
 		break;
 	case IT8718F_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case IT8718F_KBCM: /* TODO. */
 		break;

src/superio/ite/it8721f/superio.c

@@ -35,7 +35,7 @@ static void init(struct device *dev)
 	case IT8721F_EC: /* TODO. */
 		break;
 	case IT8721F_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case IT8721F_KBCM: /* TODO. */
 		break;

src/superio/ite/it8728f/superio.c

@@ -38,7 +38,7 @@ static void it8728f_init(struct device *dev)
 		break;
 	case IT8728F_KBCK:
 		set_kbc_ps2_mode();
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/ite/it8772f/superio.c

@@ -246,7 +246,7 @@ static void it8772f_init(struct device *dev)
 	case IT8772F_KBCK:
 		if (!conf->skip_keyboard) {
 			set_kbc_ps2_mode();
-			pc_keyboard_init();
+			pc_keyboard_init(NO_AUX_DEVICE);
 		}
 		break;
 	case IT8772F_KBCM:

src/superio/nsc/pc87309/superio.c

@@ -29,7 +29,7 @@ static void init(struct device *dev)
 
 	switch (dev->path.pnp.device) {
 	case PC87309_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/nsc/pc87360/superio.c

@@ -31,7 +31,7 @@ static void init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case PC87360_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/nsc/pc87366/superio.c

@@ -31,7 +31,7 @@ static void init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case PC87366_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/nsc/pc87417/superio.c

@@ -32,7 +32,7 @@ static void init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case PC87417_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/nsc/pc97317/superio.c

@@ -33,7 +33,7 @@ static void init(struct device *dev)
 		pnp_set_enable(dev, 0);		   /* Disable keyboard */
 		pnp_write_config(dev, 0xf0, 0x40); /* Set KBC clock to 8 MHz. */
 		pnp_set_enable(dev, 1);		   /* Enable keyboard */
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	default:
 		break;

src/superio/nuvoton/nct5572d/superio.c

@@ -45,7 +45,7 @@ static void nct5572d_init(struct device *dev)
 	switch(dev->path.pnp.device) {
 	/* TODO: Might potentially need code for HWM or FDC etc. */
 	case NCT5572D_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case NCT5572D_ACPI:
 		/* Set power state after power fail */

src/superio/nuvoton/nct6779d/superio.c

@@ -35,7 +35,7 @@ static void nct6779d_init(struct device *dev)
 	switch(dev->path.pnp.device) {
 	/* TODO: Might potentially need code for HWM or FDC etc. */
 	case NCT6779D_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/nuvoton/wpcm450/superio.c

@@ -31,7 +31,7 @@ static void init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case WPCM450_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/renesas/m3885x/superio.c

@@ -33,7 +33,7 @@ static void m3885x_init(struct device *dev)
 
 	printk(BIOS_DEBUG, "Renesas M3885x: Initializing keyboard.\n");
 	set_kbc_ps2_mode();
-	pc_keyboard_init();
+	pc_keyboard_init(NO_AUX_DEVICE);
 	m3885_configure_multikey();
 }
 

src/superio/smsc/dme1737/superio.c

@@ -35,7 +35,7 @@ static void dme1737_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case DME1737_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/smsc/fdc37n972/fdc37n972.c

@@ -31,7 +31,7 @@ static void init(struct device *dev)
 	case FDC37N972_PP: /* TODO. */
 		break;
 	case FDC37N972_KBDC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	// [..] The rest: TODO
 	}

src/superio/smsc/kbc1100/superio.c

@@ -68,7 +68,7 @@ static void kbc1100_init(struct device *dev)
   case KBC1100_KBC:
     res0 = find_resource(dev, PNP_IDX_IO0);
     res1 = find_resource(dev, PNP_IDX_IO1);
-    pc_keyboard_init();
+    pc_keyboard_init(NO_AUX_DEVICE);
     break;
   }
 }

src/superio/smsc/lpc47b272/superio.c

@@ -46,7 +46,7 @@ static void lpc47b272_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case LPC47B272_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/smsc/lpc47b397/superio.c

@@ -45,7 +45,7 @@ static void lpc47b397_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case LPC47B397_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/smsc/lpc47m10x/superio.c

@@ -44,7 +44,7 @@ static void lpc47m10x_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case LPC47M10X2_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/smsc/lpc47m15x/superio.c

@@ -66,7 +66,7 @@ static void lpc47m15x_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case LPC47M15X_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/smsc/lpc47n227/superio.c

@@ -131,7 +131,7 @@ static void lpc47n227_init(struct device *dev)
 	switch (dev->path.pnp.device) {
 	case LPC47N227_KBDC:
 		printk(BIOS_DEBUG, "LPC47N227: Initializing keyboard.\n");
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/smsc/mec1308/superio.c

@@ -34,7 +34,7 @@ static void mec1308_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case MEC1308_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/smsc/sch4037/superio.c

@@ -33,7 +33,7 @@ static void sch4037_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 		case SCH4037_KBC:
-			pc_keyboard_init();
+			pc_keyboard_init(NO_AUX_DEVICE);
 			break;
 	}
 }

src/superio/smsc/sio10n268/sio10n268.c

@@ -31,7 +31,7 @@ static void init(struct device *dev)
 		break;
 	case SIO10N268_KBDC:
 		/* TODO: This is still hardcoded. */
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	// [..] The rest: TODO
 	}

src/superio/smsc/smscsuperio/superio.c

@@ -163,7 +163,7 @@ static void smsc_init(struct device *dev)
 	/* A Super I/O was found, so initialize the respective device. */
 	ld = dev->path.pnp.device;
 	if (ld == logical_device_table[i].devs[LD_KBC]) {
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 	}
 }
 

src/superio/winbond/w83627dhg/superio.c

@@ -43,7 +43,7 @@ static void w83627dhg_init(struct device *dev)
 		w83627dhg_enable_UR2(dev);
 		break;
 	case W83627DHG_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/winbond/w83627ehg/superio.c

@@ -85,7 +85,7 @@ static void w83627ehg_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case W83627EHG_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case W83627EHG_HWM:
 		res0 = find_resource(dev, PNP_IDX_IO0);

src/superio/winbond/w83627hf/superio.c

@@ -92,7 +92,7 @@ static void w83627hf_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case W83627HF_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	case W83627HF_HWM:
 		res0 = find_resource(dev, PNP_IDX_IO0);

src/superio/winbond/w83627thg/superio.c

@@ -33,7 +33,7 @@ static void w83627thg_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case W83627THG_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/winbond/w83627uhg/superio.c

@@ -79,7 +79,7 @@ static void w83627uhg_init(struct device *dev)
 		set_uart_clock_source(dev, 0);
 		break;
 	case W83627UHG_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/winbond/w83667hg-a/ps2_controller.asl

@@ -0,0 +1,78 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (c) 2013 Vladimir Serbinenko
+ * Copyright (c) 2015 Raptor Engineering
+ *
+ * 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.
+ */
+
+	/* SuperIO control port */
+	Name (SPIO, 0x2E)
+
+	/* SuperIO control map */
+	OperationRegion (SPIM, SystemIO, SPIO, 0x02)
+		Field (SPIM, ByteAcc, NoLock, Preserve) {
+		SIOI, 8,
+		SIOD, 8
+	}
+
+	/* SuperIO control registers */
+	IndexField (SIOI, SIOD, ByteAcc, NoLock, Preserve) {
+		Offset (0x2A),
+		CR2A, 8,		/* Pin function selection */
+	}
+
+	Device (PS2K)		// Keyboard
+	{
+		Name(_HID, EISAID("PNP0303"))
+		Name(_CID, EISAID("PNP030B"))
+
+		Name(_CRS, ResourceTemplate()
+		{
+			IO (Decode16, 0x60, 0x60, 0x01, 0x01)
+			IO (Decode16, 0x64, 0x64, 0x01, 0x01)
+			IRQ (Edge, ActiveHigh, Exclusive) { 0x01 } // IRQ 1
+		})
+
+		Method (_STA, 0)
+		{
+			Return (0xf)
+		}
+	}
+
+	Device (PS2M)		// Mouse
+	{
+		Name(_HID, EISAID("PNP0F13"))
+		Name(_CRS, ResourceTemplate()
+		{
+			IRQ (Edge, ActiveHigh, Exclusive) { 0x0c } // IRQ 12
+		})
+
+		Method(_STA, 0)
+		{
+			/* Access SuperIO ACPI device */
+			Store(0x87, SIOI)
+			Store(0x87, SIOI)
+
+			/* Read Pin56 function select */
+			And(CR2A, 0x2, Local0)
+
+			/* Restore default SuperIO access */
+			Store(0xAA, SIOI)
+
+			if (LEqual(Local0, 0x0)) {
+				/* Mouse function selected */
+				Return (0xf)
+			}
+			Return (0x0)
+		}
+	}

src/superio/winbond/w83667hg-a/superio.c

@@ -23,6 +23,7 @@
 #include <pc80/keyboard.h>
 #include <pc80/mc146818rtc.h>
 #include <stdlib.h>
+#include <arch/acpi.h>
 #include <superio/conf_mode.h>
 
 #include "w83667hg-a.h"
@@ -38,6 +39,7 @@ static void w83667hg_a_init(struct device *dev)
 {
 	uint8_t byte;
 	uint8_t power_status;
+	uint8_t mouse_detected;
 
 	if (!dev->enabled)
 		return;
@@ -45,7 +47,23 @@ static void w83667hg_a_init(struct device *dev)
 	switch(dev->path.pnp.device) {
 	/* TODO: Might potentially need code for HWM or FDC etc. */
 	case W83667HG_A_KBC:
-		pc_keyboard_init();
+		/* Enable mouse controller */
+		pnp_enter_conf_mode_8787(dev);
+		byte = pnp_read_config(dev, 0x2a);
+		byte &= ~(0x1 << 1);
+		pnp_write_config(dev, 0x2a, byte);
+		pnp_exit_conf_mode_aa(dev);
+
+		mouse_detected = pc_keyboard_init(PROBE_AUX_DEVICE);
+
+		if (!mouse_detected && !acpi_is_wakeup_s3()) {
+			/* Disable mouse controller */
+			pnp_enter_conf_mode_8787(dev);
+			byte = pnp_read_config(dev, 0x2a);
+			byte |= 0x1 << 1;
+			pnp_write_config(dev, 0x2a, byte);
+			pnp_exit_conf_mode_aa(dev);
+		}
 		break;
 	case W83667HG_A_ACPI:
 		/* Set power state after power fail */

src/superio/winbond/w83977tf/superio.c

@@ -34,7 +34,7 @@ static void w83977tf_init(struct device *dev)
 
 	switch(dev->path.pnp.device) {
 	case W83977TF_KBC:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }

src/superio/winbond/wpcd376i/superio.c

@@ -41,7 +41,7 @@ static void init(device_t dev)
 		break;
 
 	case WPCD376I_KBCK:
-		pc_keyboard_init();
+		pc_keyboard_init(NO_AUX_DEVICE);
 		break;
 	}
 }