<p>Duncan Laurie has uploaded this change for <strong>review</strong>.</p><p><a href="https://review.coreboot.org/26173">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">drivers/usb/acpi: Add a driver for generating USB ACPI<br><br>Add a support for generating USB port descriptors for ACPI based<br>on their definition by the board in devicetree.cb.  This will<br>generate a _UPC and _PLD for each port, using a generic _PLD by<br>default.  The _PLD can also be customized for more accurate<br>descriptions if necessary.<br><br>This sample devictree.cb shows a USB 2.0 type-A port behind a root<br>hub connected to an xHCI controller:<br><br>device pci 14.0 on<br>  chip drivers/usb/acpi<br>    register "desc" = ""Root Hub""<br>    register "type" = "UPC_TYPE_HUB"<br>    device usb 0.0 on<br>      chip drivers/usb/acpi<br>        register "desc" = ""USB 2.0 Type-A""<br>        register "type" = "UPC_TYPE_A"<br>        device usb 2.0 on end<br>      end<br>    end<br>  end<br>end<br><br>It will generate the following ACPI code in the SSDT:<br><br>Scope (\_SB.PCI0.XHCI.RHUB.HS01)<br>{<br>  Name (_DDN, "USB 2.0 Type-A")<br>  Name (_UPC, Package (0x04)<br>  {<br>    0xFF,<br>    0x00,<br>    Zero,<br>    Zero<br>  })<br>  Name (_PLD, ToPLD (<br>    PLD_Revision           = 0x2,<br>    PLD_IgnoreColor        = 0x1,<br>    PLD_Red                = 0x0,<br>    PLD_Green              = 0x0,<br>    PLD_Blue               = 0x0,<br>    PLD_Width              = 0x0,<br>    PLD_Height             = 0x0,<br>    PLD_UserVisible        = 0x1,<br>    PLD_Dock               = 0x0,<br>    PLD_Lid                = 0x0,<br>    PLD_Panel              = "UNKNOWN",<br>    PLD_VerticalPosition   = "CENTER",<br>    PLD_HorizontalPosition = "CENTER",<br>    PLD_Shape              = "RECTANGLE",<br>    PLD_GroupOrientation   = 0x0,<br>    PLD_GroupToken         = 0x0,<br>    PLD_GroupPosition      = 0x0,<br>    PLD_Bay                = 0x0,<br>    PLD_Ejectable          = 0x0,<br>    PLD_EjectRequired      = 0x0,<br>    PLD_CabinetNumber      = 0x0,<br>    PLD_CardCageNumber     = 0x0,<br>    PLD_Reference          = 0x0,<br>    PLD_Rotation           = 0x0,<br>    PLD_Order              = 0x0,<br>    PLD_VerticalOffset     = 0x0,<br>    PLD_HorizontalOffset   = 0x0)<br>  )<br>}<br><br>Change-Id: I7024390e407fda4b195211bd4755bb5ca53b2b37<br>Signed-off-by: Duncan Laurie <dlaurie@google.com><br>---<br>A src/drivers/usb/acpi/Kconfig<br>A src/drivers/usb/acpi/Makefile.inc<br>A src/drivers/usb/acpi/chip.h<br>A src/drivers/usb/acpi/usb_acpi.c<br>4 files changed, 131 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://review.coreboot.org:29418/coreboot refs/changes/73/26173/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/drivers/usb/acpi/Kconfig b/src/drivers/usb/acpi/Kconfig</span><br><span>new file mode 100644</span><br><span>index 0000000..6650324</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/usb/acpi/Kconfig</span><br><span>@@ -0,0 +1,2 @@</span><br><span style="color: hsl(120, 100%, 40%);">+config DRIVERS_USB_ACPI</span><br><span style="color: hsl(120, 100%, 40%);">+        bool</span><br><span>diff --git a/src/drivers/usb/acpi/Makefile.inc b/src/drivers/usb/acpi/Makefile.inc</span><br><span>new file mode 100644</span><br><span>index 0000000..2e11107</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/usb/acpi/Makefile.inc</span><br><span>@@ -0,0 +1 @@</span><br><span style="color: hsl(120, 100%, 40%);">+ramstage-$(CONFIG_DRIVERS_USB_ACPI) += usb_acpi.c</span><br><span>diff --git a/src/drivers/usb/acpi/chip.h b/src/drivers/usb/acpi/chip.h</span><br><span>new file mode 100644</span><br><span>index 0000000..7e89bac</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/usb/acpi/chip.h</span><br><span>@@ -0,0 +1,53 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * This file is part of the coreboot project.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright 2018 Google LLC</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; version 2 of the License.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#ifndef __USB_ACPI_CHIP_H__</span><br><span style="color: hsl(120, 100%, 40%);">+#define __USB_ACPI_CHIP_H__</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <arch/acpi.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <arch/acpi_pld.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct drivers_usb_acpi_config {</span><br><span style="color: hsl(120, 100%, 40%);">+    const char *desc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+   /*</span><br><span style="color: hsl(120, 100%, 40%);">+     * Physical ports that are user visible</span><br><span style="color: hsl(120, 100%, 40%);">+        *</span><br><span style="color: hsl(120, 100%, 40%);">+     * UPC_TYPE_A</span><br><span style="color: hsl(120, 100%, 40%);">+  * UPC_TYPE_MINI_AB</span><br><span style="color: hsl(120, 100%, 40%);">+    * UPC_TYPE_EXPRESSCARD</span><br><span style="color: hsl(120, 100%, 40%);">+        * UPC_TYPE_USB3_A</span><br><span style="color: hsl(120, 100%, 40%);">+     * UPC_TYPE_USB3_B</span><br><span style="color: hsl(120, 100%, 40%);">+     * UPC_TYPE_USB3_MICRO_B</span><br><span style="color: hsl(120, 100%, 40%);">+       * UPC_TYPE_USB3_MICRO_AB</span><br><span style="color: hsl(120, 100%, 40%);">+      * UPC_TYPE_USB3_POWER_B</span><br><span style="color: hsl(120, 100%, 40%);">+       * UPC_TYPE_C_USB2_ONLY</span><br><span style="color: hsl(120, 100%, 40%);">+        * UPC_TYPE_C_USB2_SS_SWITCH</span><br><span style="color: hsl(120, 100%, 40%);">+   * UPC_TYPE_C_USB2_SS</span><br><span style="color: hsl(120, 100%, 40%);">+  *</span><br><span style="color: hsl(120, 100%, 40%);">+     * Non-visible ports or special devices</span><br><span style="color: hsl(120, 100%, 40%);">+        *</span><br><span style="color: hsl(120, 100%, 40%);">+     * UPC_TYPE_INTERNAL</span><br><span style="color: hsl(120, 100%, 40%);">+   * UPC_TYPE_UNUSED</span><br><span style="color: hsl(120, 100%, 40%);">+     * UPC_TYPE_HUB</span><br><span style="color: hsl(120, 100%, 40%);">+        */</span><br><span style="color: hsl(120, 100%, 40%);">+   enum acpi_upc_type type;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+    /* Define a custom physical location for the port */</span><br><span style="color: hsl(120, 100%, 40%);">+  int custom_pld;</span><br><span style="color: hsl(120, 100%, 40%);">+       struct acpi_pld pld;</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#endif /* __USB_ACPI_CHIP_H__ */</span><br><span>diff --git a/src/drivers/usb/acpi/usb_acpi.c b/src/drivers/usb/acpi/usb_acpi.c</span><br><span>new file mode 100644</span><br><span>index 0000000..60ebe93</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/usb/acpi/usb_acpi.c</span><br><span>@@ -0,0 +1,75 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * This file is part of the coreboot project.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright 2018 Google LLC</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; version 2 of the License.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <arch/acpi_device.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <arch/acpi_pld.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <arch/acpigen.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <console/console.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <device/device.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <device/path.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdint.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <string.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include "chip.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void usb_acpi_fill_ssdt_generator(struct device *dev)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+      struct drivers_usb_acpi_config *config = dev->chip_info;</span><br><span style="color: hsl(120, 100%, 40%);">+   const char *path = acpi_device_path(dev);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+   if (!dev->enabled || !path || !config)</span><br><span style="color: hsl(120, 100%, 40%);">+             return;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+     /* Don't generate output for hubs, only ports */</span><br><span style="color: hsl(120, 100%, 40%);">+  if (config->type == UPC_TYPE_HUB)</span><br><span style="color: hsl(120, 100%, 40%);">+          return;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+     acpigen_write_scope(path);</span><br><span style="color: hsl(120, 100%, 40%);">+    if (config->desc)</span><br><span style="color: hsl(120, 100%, 40%);">+          acpigen_write_name_string("_DDN", config->desc);</span><br><span style="color: hsl(120, 100%, 40%);">+ acpigen_write_upc(config->type);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (config->custom_pld) {</span><br><span style="color: hsl(120, 100%, 40%);">+          /* Use board defined PLD */</span><br><span style="color: hsl(120, 100%, 40%);">+           acpigen_write_pld(&config->pld);</span><br><span style="color: hsl(120, 100%, 40%);">+       } else {</span><br><span style="color: hsl(120, 100%, 40%);">+              /* Fill PLD strucutre based on port type */</span><br><span style="color: hsl(120, 100%, 40%);">+           struct acpi_pld pld;</span><br><span style="color: hsl(120, 100%, 40%);">+          acpi_pld_fill_usb(&pld, config->type);</span><br><span style="color: hsl(120, 100%, 40%);">+         acpigen_write_pld(&pld);</span><br><span style="color: hsl(120, 100%, 40%);">+  }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+   acpigen_pop_len();</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+  printk(BIOS_INFO, "%s: %s at %s\n", path,</span><br><span style="color: hsl(120, 100%, 40%);">+          config->desc ? : dev->chip_ops->name, dev_path(dev));</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static struct device_operations usb_acpi_ops = {</span><br><span style="color: hsl(120, 100%, 40%);">+  .read_resources           = DEVICE_NOOP,</span><br><span style="color: hsl(120, 100%, 40%);">+      .set_resources            = DEVICE_NOOP,</span><br><span style="color: hsl(120, 100%, 40%);">+      .enable_resources         = DEVICE_NOOP,</span><br><span style="color: hsl(120, 100%, 40%);">+      .scan_bus                 = &scan_usb_bus,</span><br><span style="color: hsl(120, 100%, 40%);">+        .acpi_fill_ssdt_generator = &usb_acpi_fill_ssdt_generator,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void usb_acpi_enable(struct device *dev)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+      dev->ops = &usb_acpi_ops;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct chip_operations drivers_usb_acpi_ops = {</span><br><span style="color: hsl(120, 100%, 40%);">+        CHIP_NAME("USB ACPI Device")</span><br><span style="color: hsl(120, 100%, 40%);">+        .enable_dev = &usb_acpi_enable</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/26173">change 26173</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://review.coreboot.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://review.coreboot.org/26173"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: coreboot </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I7024390e407fda4b195211bd4755bb5ca53b2b37 </div>
<div style="display:none"> Gerrit-Change-Number: 26173 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Duncan Laurie <dlaurie@chromium.org> </div>