Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
| 2 | |
| 3 | #include "pci_xhci.h" |
| 4 | #include <acpi/acpigen.h> |
Tim Wawrzynczak | d40a4c2 | 2021-02-25 13:14:49 -0700 | [diff] [blame] | 5 | #include <acpi/acpigen_pci.h> |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 6 | #include <console/console.h> |
| 7 | #include <device/pci.h> |
| 8 | #include <device/pci_ids.h> |
| 9 | #include <device/xhci.h> |
| 10 | #include <stdlib.h> |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 11 | |
| 12 | #define PCI_XHCI_CLASSCODE 0x0c0330 /* USB3.0 xHCI controller */ |
| 13 | |
| 14 | static unsigned int controller_count; |
Eric Lai | 9a070dc | 2023-06-06 15:01:02 +0800 | [diff] [blame] | 15 | const struct device_operations xhci_pci_ops; |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 16 | |
| 17 | struct port_counts { |
| 18 | unsigned int high_speed; |
| 19 | unsigned int super_speed; |
| 20 | }; |
| 21 | |
| 22 | __weak enum cb_err pci_xhci_get_wake_gpe(const struct device *dev, int *gpe) |
| 23 | { |
| 24 | *gpe = -1; |
| 25 | return CB_SUCCESS; |
| 26 | } |
| 27 | |
Raul E Rangel | d8bc5c1 | 2020-07-10 14:30:54 -0600 | [diff] [blame] | 28 | static void xhci_count_ports(void *context, const struct xhci_supported_protocol *data) |
| 29 | { |
| 30 | struct port_counts *counts = context; |
| 31 | |
| 32 | switch (data->major_rev) { |
| 33 | case 3: |
| 34 | counts->super_speed += data->port_count; |
| 35 | return; |
| 36 | case 2: |
| 37 | counts->high_speed += data->port_count; |
| 38 | return; |
| 39 | default: |
| 40 | printk(BIOS_INFO, "%s: Unknown USB Version: %#x\n", __func__, data->major_rev); |
| 41 | return; |
| 42 | } |
| 43 | } |
| 44 | |
| 45 | static bool xhci_port_exists(const struct device *dev, const struct usb_path *path) |
| 46 | { |
| 47 | /* Cache the counts so we don't have to iterate on each invocation. */ |
| 48 | static struct { |
| 49 | const struct device *dev; |
| 50 | struct port_counts counts; |
| 51 | } cache; |
| 52 | |
| 53 | if (cache.dev != dev) { |
| 54 | cache.counts.high_speed = 0; |
| 55 | cache.counts.super_speed = 0; |
| 56 | cache.dev = dev; |
| 57 | |
| 58 | xhci_for_each_supported_usb_cap(dev, &cache.counts, xhci_count_ports); |
| 59 | } |
| 60 | |
| 61 | /* port_ids are 0 based */ |
| 62 | switch (path->port_type) { |
| 63 | case 3: |
| 64 | return path->port_id < cache.counts.super_speed; |
| 65 | case 2: |
| 66 | return path->port_id < cache.counts.high_speed; |
| 67 | default: |
| 68 | printk(BIOS_INFO, "%s: Unknown USB Version: %#x\n", __func__, path->port_type); |
| 69 | return false; |
| 70 | } |
| 71 | } |
| 72 | |
| 73 | static const struct device *get_xhci_dev(const struct device *dev) |
| 74 | { |
| 75 | while (dev && dev->ops != &xhci_pci_ops) { |
Patrick Rudolph | f95dbce | 2024-01-22 15:39:46 +0100 | [diff] [blame^] | 76 | if (is_root_device(dev)) |
Raul E Rangel | d8bc5c1 | 2020-07-10 14:30:54 -0600 | [diff] [blame] | 77 | return NULL; |
| 78 | |
| 79 | dev = dev->bus->dev; |
| 80 | } |
| 81 | |
| 82 | return dev; |
| 83 | } |
| 84 | |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 85 | static const char *xhci_acpi_name(const struct device *dev) |
| 86 | { |
| 87 | char *name; |
| 88 | unsigned int port_id; |
Raul E Rangel | d8bc5c1 | 2020-07-10 14:30:54 -0600 | [diff] [blame] | 89 | const char *pattern; |
| 90 | const struct device *xhci_dev; |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 91 | |
Raul E Rangel | d8bc5c1 | 2020-07-10 14:30:54 -0600 | [diff] [blame] | 92 | /* Generate ACPI names for the usb_acpi driver */ |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 93 | if (dev->path.type == DEVICE_PATH_USB) { |
| 94 | /* Ports index start at 1 */ |
| 95 | port_id = dev->path.usb.port_id + 1; |
| 96 | |
| 97 | switch (dev->path.usb.port_type) { |
| 98 | case 0: |
| 99 | return "RHUB"; |
| 100 | case 2: |
Raul E Rangel | d8bc5c1 | 2020-07-10 14:30:54 -0600 | [diff] [blame] | 101 | pattern = "HS%02d"; |
| 102 | break; |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 103 | case 3: |
Raul E Rangel | d8bc5c1 | 2020-07-10 14:30:54 -0600 | [diff] [blame] | 104 | pattern = "SS%02d"; |
| 105 | break; |
| 106 | default: |
| 107 | printk(BIOS_INFO, "%s: Unknown USB Version: %#x\n", __func__, |
| 108 | dev->path.usb.port_type); |
| 109 | return NULL; |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 110 | } |
Raul E Rangel | d8bc5c1 | 2020-07-10 14:30:54 -0600 | [diff] [blame] | 111 | |
| 112 | xhci_dev = get_xhci_dev(dev); |
| 113 | if (!xhci_dev) |
| 114 | die("%s: xHCI controller not found for %s\n", __func__, dev_path(dev)); |
| 115 | |
| 116 | /* |
| 117 | * We only want to return an ACPI name for a USB port if the controller |
| 118 | * physically has the port. This has the desired side effect of making the |
| 119 | * usb_acpi driver skip generating an ACPI node for a device which has |
| 120 | * no port. This prevents writing an invalid SSDT table which the OS then |
| 121 | * complains about. |
| 122 | */ |
| 123 | if (!xhci_port_exists(xhci_dev, &dev->path.usb)) { |
| 124 | printk(BIOS_WARNING, "%s: %s does not exist on xHC ", __func__, |
| 125 | dev_path(dev)); |
| 126 | /* dev_path uses a static buffer :( */ |
| 127 | printk(BIOS_WARNING, "%s\n", dev_path(xhci_dev)); |
| 128 | |
| 129 | return NULL; |
| 130 | } |
| 131 | |
| 132 | name = malloc(ACPI_NAME_BUFFER_SIZE); |
| 133 | snprintf(name, ACPI_NAME_BUFFER_SIZE, pattern, port_id); |
| 134 | name[4] = '\0'; |
| 135 | |
| 136 | return name; |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 137 | } else if (dev->ops == &xhci_pci_ops) { |
| 138 | return dev->name; |
| 139 | } |
| 140 | |
| 141 | printk(BIOS_ERR, "%s: Unknown device %s\n", __func__, dev_path(dev)); |
Raul E Rangel | d8bc5c1 | 2020-07-10 14:30:54 -0600 | [diff] [blame] | 142 | |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 143 | return NULL; |
| 144 | } |
| 145 | |
Raul E Rangel | 9d017d2 | 2020-07-10 14:09:03 -0600 | [diff] [blame] | 146 | static void xhci_generate_port_acpi(void *context, const struct xhci_supported_protocol *data) |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 147 | { |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 148 | const char *format; |
| 149 | char buf[16]; |
| 150 | struct port_counts *counts = context; |
| 151 | unsigned int *dev_num; |
| 152 | |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 153 | xhci_print_supported_protocol(data); |
| 154 | |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 155 | if (data->major_rev == 3) { |
| 156 | format = "SS%02d"; |
| 157 | dev_num = &counts->super_speed; |
| 158 | } else if (data->major_rev == 2) { |
| 159 | format = "HS%02d"; |
| 160 | dev_num = &counts->high_speed; |
| 161 | } else { |
| 162 | printk(BIOS_INFO, "%s: Unknown USB Version: %#x\n", __func__, data->major_rev); |
| 163 | return; |
| 164 | } |
| 165 | |
| 166 | for (unsigned int i = 0; i < data->port_count; ++i) { |
| 167 | snprintf(buf, sizeof(buf), format, ++(*dev_num)); |
| 168 | acpigen_write_device(buf); |
| 169 | acpigen_write_name_byte("_ADR", data->port_offset + i); |
| 170 | acpigen_pop_len(); |
| 171 | } |
| 172 | } |
| 173 | |
| 174 | static void xhci_add_devices(const struct device *dev) |
| 175 | { |
| 176 | /* Used by the callback to track how many ports have been seen. */ |
| 177 | struct port_counts counts = {0, 0}; |
| 178 | |
| 179 | acpigen_write_device("RHUB"); |
| 180 | acpigen_write_name_integer("_ADR", 0x00000000); |
| 181 | |
Raul E Rangel | 9d017d2 | 2020-07-10 14:09:03 -0600 | [diff] [blame] | 182 | xhci_for_each_supported_usb_cap(dev, &counts, xhci_generate_port_acpi); |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 183 | |
| 184 | acpigen_pop_len(); |
| 185 | } |
| 186 | |
| 187 | static void xhci_fill_ssdt(const struct device *dev) |
| 188 | { |
| 189 | int gpe; |
John Zhao | acdf5fd | 2020-07-14 09:07:48 -0700 | [diff] [blame] | 190 | const char *scope = acpi_device_scope(dev); |
| 191 | const char *name = acpi_device_name(dev); |
| 192 | |
| 193 | if (!scope || !name) |
| 194 | return; |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 195 | |
| 196 | printk(BIOS_DEBUG, "xHCI SSDT generation\n"); |
| 197 | |
John Zhao | acdf5fd | 2020-07-14 09:07:48 -0700 | [diff] [blame] | 198 | acpigen_write_scope(scope); |
| 199 | acpigen_write_device(name); |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 200 | |
| 201 | acpigen_write_ADR_pci_device(dev); |
| 202 | acpigen_write_name_string("_DDN", "xHC - Extensible Host Controller"); |
| 203 | acpigen_write_STA(acpi_device_status(dev)); |
| 204 | |
| 205 | if (pci_xhci_get_wake_gpe(dev, &gpe) == CB_SUCCESS) { |
| 206 | printk(BIOS_DEBUG, "%s: Got GPE %d for %s\n", __func__, gpe, dev_path(dev)); |
| 207 | } else { |
| 208 | printk(BIOS_ERR, "%s: Error getting GPE for : %s\n", __func__, dev_path(dev)); |
| 209 | gpe = -1; |
| 210 | } |
| 211 | |
| 212 | if (gpe > 0) { |
| 213 | acpigen_write_PRW(gpe, SLP_TYP_S3); |
| 214 | acpigen_write_name_integer("_S0W", ACPI_DEVICE_SLEEP_D0); |
| 215 | acpigen_write_name_integer("_S3W", ACPI_DEVICE_SLEEP_D3_COLD); |
| 216 | acpigen_write_name_integer("_S4W", ACPI_DEVICE_SLEEP_D3_COLD); |
| 217 | } |
| 218 | |
| 219 | xhci_add_devices(dev); |
| 220 | |
| 221 | acpigen_pop_len(); |
| 222 | acpigen_pop_len(); |
| 223 | } |
| 224 | |
| 225 | static void xhci_enable(struct device *dev) |
| 226 | { |
| 227 | char *name; |
| 228 | uint32_t class = pci_read_config32(dev, PCI_CLASS_REVISION); |
| 229 | /* Class code, the upper 3 bytes of PCI_CLASS_REVISION. */ |
| 230 | class >>= 8; |
| 231 | |
| 232 | if (class != PCI_XHCI_CLASSCODE) { |
| 233 | printk(BIOS_ERR, "Incorrect xHCI class code: %#x\n", class); |
| 234 | dev->enabled = 0; |
| 235 | return; |
| 236 | } |
| 237 | |
| 238 | name = malloc(ACPI_NAME_BUFFER_SIZE); |
| 239 | snprintf(name, ACPI_NAME_BUFFER_SIZE, "XHC%d", controller_count++); |
| 240 | dev->name = name; |
| 241 | } |
| 242 | |
Eric Lai | 9a070dc | 2023-06-06 15:01:02 +0800 | [diff] [blame] | 243 | const struct device_operations xhci_pci_ops = { |
Raul E Rangel | 1a31b10 | 2020-05-29 17:18:12 -0600 | [diff] [blame] | 244 | .read_resources = pci_dev_read_resources, |
| 245 | .set_resources = pci_dev_set_resources, |
| 246 | .enable_resources = pci_dev_enable_resources, |
| 247 | .init = pci_dev_init, |
| 248 | .scan_bus = scan_static_bus, |
| 249 | .enable = xhci_enable, |
| 250 | .ops_pci = &pci_dev_ops_pci, |
| 251 | .acpi_fill_ssdt = xhci_fill_ssdt, |
| 252 | .acpi_name = xhci_acpi_name, |
| 253 | }; |