soc/intel/common: Move support to log XHCI wake events

The policy to identify and log the XHCI wake events is similar between
skylake and apollolake. Hence move the similar parts to a common
location.

BUG=b:123429132
BRANCH=None
TEST=Ensure that the system boots to ChromeOS. Ensure that the wake up
events due to USB are logged into the event logs.
6 | 2019-03-21 09:22:18 | S0ix Enter
7 | 2019-03-21 09:22:22 | S0ix Exit
8 | 2019-03-21 09:22:22 | Wake Source | PME - XHCI (USB 2.0 port) | 9
9 | 2019-03-21 09:22:22 | Wake Source | GPE # | 13
10 | 2019-03-21 09:23:20 | ACPI Enter | S3
11 | 2019-03-21 09:23:30 | Wake Source | PME - XHCI (USB 2.0 port) | 9
12 | 2019-03-21 09:23:30 | ACPI Wake | S3
13 | 2019-03-21 09:23:30 | Wake Source | GPE # | 13

Change-Id: Ia6643342e3292984e422ff3c3fcd4bc0d99f947e
Signed-off-by: Karthikeyan Ramasubramanian <kramasub@google.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/31999
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Furquan Shaikh <furquan@google.com>

src/soc/intel/common/block/include/intelblocks/xhci.h

@@ -16,6 +16,34 @@
 #ifndef SOC_INTEL_COMMON_BLOCK_XHCI_H
 #define SOC_INTEL_COMMON_BLOCK_XHCI_H
 
+#include <device/device.h>
+
+/**
+ * struct xhci_usb_info - Data containing number of USB ports & offset.
+ * @usb2_port_status_reg: Offset to USB2 port status register.
+ * @num_usb2_ports: Number of USB2 ports.
+ * @usb3_port_status_reg: Offset to USB3 port status register.
+ * @num_usb3_ports: Number of USB3 ports.
+ */
+struct xhci_usb_info {
+	uint32_t usb2_port_status_reg;
+	uint32_t num_usb2_ports;
+	uint32_t usb3_port_status_reg;
+	uint32_t num_usb3_ports;
+};
+
+/**
+ * pch_xhci_update_wake_event() - Identify and log XHCI wake events.
+ * @info: Information about number of USB ports and their status reg offset.
+ *
+ * This function goes through individual USB port status registers within the
+ * XHCI block and identifies if any of those USB ports triggered a wake-up and
+ * log information about those ports to the event log.
+ *
+ * Return: True if any port is identified as a wake source, false if none.
+ */
+bool pch_xhci_update_wake_event(const struct xhci_usb_info *info);
+
 void soc_xhci_init(struct device *dev);
 
 #endif	/* SOC_INTEL_COMMON_BLOCK_XHCI_H */

src/soc/intel/common/block/xhci/Kconfig

@@ -2,3 +2,11 @@ config SOC_INTEL_COMMON_BLOCK_XHCI
 	bool
 	help
 	  Intel Processor common XHCI support
+
+config SOC_INTEL_COMMON_BLOCK_XHCI_ELOG
+	bool
+	default n
+	depends on SOC_INTEL_COMMON_BLOCK_XHCI
+	help
+	  Set this option to identify if XHCI caused a wake up and log that
+	  information into the event log.

src/soc/intel/common/block/xhci/Makefile.inc

@@ -1 +1,4 @@
 ramstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_XHCI) += xhci.c
+ramstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_XHCI_ELOG) += elog.c
+
+smm-$(CONFIG_SOC_INTEL_COMMON_BLOCK_XHCI_ELOG) += elog.c

src/soc/intel/common/block/xhci/elog.c

@@ -0,0 +1,155 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright 2019 Google LLC
+ *
+ * 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 <device/mmio.h>
+#include <device/pci_ops.h>
+#include <elog.h>
+#include <intelblocks/xhci.h>
+#include <soc/pci_devs.h>
+#include <stdint.h>
+
+/* Wake on disconnect enable */
+#define XHCI_STATUS_WDE			(1 << 26)
+/* Wake on connect enable */
+#define XHCI_STATUS_WCE			(1 << 25)
+/* Port link status change */
+#define XHCI_STATUS_PLC			(1 << 22)
+/* Connect status change */
+#define XHCI_STATUS_CSC			(1 << 17)
+/* Port link status */
+#define XHCI_STATUS_PLS_SHIFT		(5)
+#define XHCI_STATUS_PLS_MASK		(0xF << XHCI_STATUS_PLS_SHIFT)
+#define XHCI_STATUS_PLS_RESUME		(15 << XHCI_STATUS_PLS_SHIFT)
+
+static bool pch_xhci_csc_set(uint32_t port_status)
+{
+	return !!(port_status & XHCI_STATUS_CSC);
+}
+
+static bool pch_xhci_wake_capable(uint32_t port_status)
+{
+	return !!((port_status & XHCI_STATUS_WCE) |
+		  (port_status & XHCI_STATUS_WDE));
+}
+
+static bool pch_xhci_plc_set(uint32_t port_status)
+{
+	return !!(port_status & XHCI_STATUS_PLC);
+}
+
+static bool pch_xhci_resume(uint32_t port_status)
+{
+	return (port_status & XHCI_STATUS_PLS_MASK) == XHCI_STATUS_PLS_RESUME;
+}
+
+/*
+ * Check if a particular USB port caused wake by:
+ * 1. Change in connect/disconnect status (if enabled)
+ * 2. USB device activity
+ *
+ * Params:
+ * base  : MMIO address of first port.
+ * num   : Number of ports.
+ * event : Event that needs to be added in case wake source is found.
+ *
+ * Return value:
+ * true  : Wake source was found.
+ * false : Wake source was not found.
+ */
+static bool pch_xhci_port_wake_check(uintptr_t base, uint8_t num, uint8_t event)
+{
+	uint32_t i, port_status;
+	bool found = false;
+
+	for (i = 0; i < num; i++, base += 0x10) {
+		/* Read port status and control register for the port. */
+		port_status = read32((void *)base);
+
+		/* Ensure that the status is not all 1s. */
+		if (port_status == 0xffffffff)
+			continue;
+
+		/*
+		 * Check if CSC bit is set and port is capable of wake on
+		 * connect/disconnect to identify if the port caused wake
+		 * event for usb attach/detach.
+		 */
+		if (pch_xhci_csc_set(port_status) &&
+		    pch_xhci_wake_capable(port_status)) {
+			elog_add_event_wake(event, i + 1);
+			found = true;
+			continue;
+		}
+
+		/*
+		 * Check if PLC is set and PLS indicates resume to identify if
+		 * the port caused wake event for usb activity.
+		 */
+		if (pch_xhci_plc_set(port_status) &&
+		    pch_xhci_resume(port_status)) {
+			elog_add_event_wake(event, i + 1);
+			found = true;
+		}
+	}
+	return found;
+}
+
+/*
+ * Update elog event and instance depending upon the USB2 port that caused
+ * the wake event.
+ *
+ * Return value:
+ * true = Indicates that USB2 wake event was found.
+ * false = Indicates that USB2 wake event was not found.
+ */
+static inline bool pch_xhci_usb2_update_wake_event(uintptr_t mmio_base,
+					const struct xhci_usb_info *info)
+{
+	return pch_xhci_port_wake_check(mmio_base + info->usb2_port_status_reg,
+					info->num_usb2_ports,
+					ELOG_WAKE_SOURCE_PME_XHCI_USB_2);
+}
+
+/*
+ * Update elog event and instance depending upon the USB3 port that caused
+ * the wake event.
+ *
+ * Return value:
+ * true = Indicates that USB3 wake event was found.
+ * false = Indicates that USB3 wake event was not found.
+ */
+static inline bool pch_xhci_usb3_update_wake_event(uintptr_t mmio_base,
+					const struct xhci_usb_info *info)
+{
+	return pch_xhci_port_wake_check(mmio_base + info->usb3_port_status_reg,
+					info->num_usb3_ports,
+					ELOG_WAKE_SOURCE_PME_XHCI_USB_3);
+}
+
+bool pch_xhci_update_wake_event(const struct xhci_usb_info *info)
+{
+	uintptr_t mmio_base;
+	bool event_found = false;
+	mmio_base = ALIGN_DOWN(pci_read_config32(PCH_DEV_XHCI,
+					PCI_BASE_ADDRESS_0), 16);
+
+	if (pch_xhci_usb2_update_wake_event(mmio_base, info))
+		event_found = true;
+
+	if (pch_xhci_usb3_update_wake_event(mmio_base, info))
+		event_found = true;
+
+	return event_found;
+}

src/soc/intel/skylake/Kconfig

@@ -66,6 +66,7 @@ config CPU_SPECIFIC_OPTIONS
 	select SOC_INTEL_COMMON_BLOCK_SMM
 	select SOC_INTEL_COMMON_BLOCK_SMM_IO_TRAP
 	select SOC_INTEL_COMMON_BLOCK_UART
+	select SOC_INTEL_COMMON_BLOCK_XHCI_ELOG
 	select SOC_INTEL_COMMON_PCH_BASE
 	select SOC_INTEL_COMMON_NHLT
 	select SOC_INTEL_COMMON_RESET

src/soc/intel/skylake/elog.c

@@ -22,6 +22,7 @@
 #include <stdint.h>
 #include <elog.h>
 #include <intelblocks/pmclib.h>
+#include <intelblocks/xhci.h>
 #include <soc/pci_devs.h>
 #include <soc/pm.h>
 #include <soc/smbus.h>
@@ -42,142 +43,13 @@ static void pch_log_gpio_gpe(u32 gpe0_sts, u32 gpe0_en, int start)
 #define XHCI_USB3_PORT_STATUS_REG	0x540
 #define XHCI_USB2_PORT_NUM		10
 #define XHCI_USB3_PORT_NUM		6
-/* Wake on disconnect enable */
-#define XHCI_STATUS_WDE			(1 << 26)
-/* Wake on connect enable */
-#define XHCI_STATUS_WCE			(1 << 25)
-/* Port link status change */
-#define XHCI_STATUS_PLC			(1 << 22)
-/* Connect status change */
-#define XHCI_STATUS_CSC			(1 << 17)
-/* Port link status */
-#define XHCI_STATUS_PLS_SHIFT		(5)
-#define XHCI_STATUS_PLS_MASK		(0xF << XHCI_STATUS_PLS_SHIFT)
-#define XHCI_STATUS_PLS_RESUME		(15 << XHCI_STATUS_PLS_SHIFT)
 
-static bool pch_xhci_csc_set(uint32_t port_status)
+static const struct xhci_usb_info usb_info = {
-{
+	.usb2_port_status_reg = XHCI_USB2_PORT_STATUS_REG,
-	return !!(port_status & XHCI_STATUS_CSC);
+	.num_usb2_ports = XHCI_USB2_PORT_NUM,
-}
+	.usb3_port_status_reg = XHCI_USB3_PORT_STATUS_REG,
-
+	.num_usb3_ports = XHCI_USB3_PORT_NUM,
-static bool pch_xhci_wake_capable(uint32_t port_status)
+};
-{
-	return !!((port_status & XHCI_STATUS_WCE) |
-		  (port_status & XHCI_STATUS_WDE));
-}
-
-static bool pch_xhci_plc_set(uint32_t port_status)
-{
-	return !!(port_status & XHCI_STATUS_PLC);
-}
-
-static bool pch_xhci_resume(uint32_t port_status)
-{
-	return (port_status & XHCI_STATUS_PLS_MASK) == XHCI_STATUS_PLS_RESUME;
-}
-
-/*
- * Check if a particular USB port caused wake by:
- * 1. Change in connect/disconnect status (if enabled)
- * 2. USB device activity
- *
- * Params:
- * base  : MMIO address of first port.
- * num   : Number of ports.
- * event : Event that needs to be added in case wake source is found.
- *
- * Return value:
- * true  : Wake source was found.
- * false : Wake source was not found.
- */
-static bool pch_xhci_port_wake_check(uintptr_t base, uint8_t num,
-					uint32_t event)
-{
-	uint8_t i;
-	uint32_t port_status;
-	bool found = false;
-
-	for (i = 0; i < num; i++, base += 0x10) {
-		/* Read port status and control register for the port. */
-		port_status = read32((void *)base);
-
-		/* Ensure that the status is not all 1s. */
-		if (port_status == 0xffffffff)
-			continue;
-
-		/*
-		 * Check if CSC bit is set and port is capable of wake on
-		 * connect/disconnect to identify if the port caused wake
-		 * event for usb attach/detach.
-		 */
-		if (pch_xhci_csc_set(port_status) &&
-		    pch_xhci_wake_capable(port_status)) {
-			elog_add_event_wake(event, i + 1);
-			found = true;
-			continue;
-		}
-
-		/*
-		 * Check if PLC is set and PLS indicates resume to identify if
-		 * the port caused wake event for usb activity.
-		 */
-		if (pch_xhci_plc_set(port_status) &&
-		    pch_xhci_resume(port_status)) {
-			elog_add_event_wake(event, i + 1);
-			found = true;
-		}
-	}
-	return found;
-}
-
-/*
- * Update elog event and instance depending upon the USB2 port that caused
- * the wake event.
- *
- * Return value:
- * true = Indicates that USB2 wake event was found.
- * false = Indicates that USB2 wake event was not found.
- */
-static inline bool pch_xhci_usb2_update_wake_event(uintptr_t mmio_base)
-{
-	return pch_xhci_port_wake_check(mmio_base + XHCI_USB2_PORT_STATUS_REG,
-					XHCI_USB2_PORT_NUM,
-					ELOG_WAKE_SOURCE_PME_XHCI_USB_2);
-}
-
-/*
- * Update elog event and instance depending upon the USB3 port that caused
- * the wake event.
- *
- * Return value:
- * true = Indicates that USB3 wake event was found.
- * false = Indicates that USB3 wake event was not found.
- */
-static inline bool pch_xhci_usb3_update_wake_event(uintptr_t mmio_base)
-{
-	return pch_xhci_port_wake_check(mmio_base + XHCI_USB3_PORT_STATUS_REG,
-					XHCI_USB3_PORT_NUM,
-					ELOG_WAKE_SOURCE_PME_XHCI_USB_3);
-}
-
-#ifdef __SIMPLE_DEVICE__
-static bool pch_xhci_update_wake_event(pci_devfn_t dev)
-#else
-static bool pch_xhci_update_wake_event(struct device *dev)
-#endif
-{
-	uintptr_t mmio_base;
-	bool event_found = false;
-	mmio_base = ALIGN_DOWN(pci_read_config32(dev, PCI_BASE_ADDRESS_0), 16);
-
-	if (pch_xhci_usb2_update_wake_event(mmio_base))
-		event_found = true;
-
-	if (pch_xhci_usb3_update_wake_event(mmio_base))
-		event_found = true;
-
-	return event_found;
-}
 
 struct pme_status_info {
 #ifdef __SIMPLE_DEVICE__
@@ -203,7 +75,8 @@ static void pch_log_add_elog_event(const struct pme_status_info *info,
 	 * If wake source is XHCI, check for detailed wake source events on
 	 * USB2/3 ports.
 	 */
-	if ((info->dev == PCH_DEV_XHCI) && pch_xhci_update_wake_event(dev))
+	if ((info->dev == PCH_DEV_XHCI) &&
+			pch_xhci_update_wake_event(&usb_info))
 		return;
 
 	elog_add_event_wake(info->elog_event, 0);
@@ -251,7 +124,7 @@ static void pch_log_pme_internal_wake_source(void)
 	 * PME_STS_BIT in controller register.
 	 */
 	if (!dev_found)
-		dev_found = pch_xhci_update_wake_event(PCH_DEV_XHCI);
+		dev_found = pch_xhci_update_wake_event(&usb_info);
 
 	if (!dev_found)
 		elog_add_event_wake(ELOG_WAKE_SOURCE_PME_INTERNAL, 0);