1 // SPDX-License-Identifier: GPL-2.0
3 * Thunderbolt driver - switch/port utility functions
6 * Copyright (C) 2018, Intel Corporation
9 #include <linux/delay.h>
10 #include <linux/idr.h>
11 #include <linux/nvmem-provider.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/sizes.h>
14 #include <linux/slab.h>
15 #include <linux/vmalloc.h>
19 /* Switch authorization from userspace is serialized by this lock */
20 static DEFINE_MUTEX(switch_lock);
22 /* Switch NVM support */
24 #define NVM_DEVID 0x05
25 #define NVM_VERSION 0x08
27 #define NVM_FLASH_SIZE 0x45
29 #define NVM_MIN_SIZE SZ_32K
30 #define NVM_MAX_SIZE SZ_512K
32 static DEFINE_IDA(nvm_ida);
34 struct nvm_auth_status {
35 struct list_head list;
41 * Hold NVM authentication failure status per switch This information
42 * needs to stay around even when the switch gets power cycled so we
45 static LIST_HEAD(nvm_auth_status_cache);
46 static DEFINE_MUTEX(nvm_auth_status_lock);
48 static struct nvm_auth_status *__nvm_get_auth_status(const struct tb_switch *sw)
50 struct nvm_auth_status *st;
52 list_for_each_entry(st, &nvm_auth_status_cache, list) {
53 if (uuid_equal(&st->uuid, sw->uuid))
60 static void nvm_get_auth_status(const struct tb_switch *sw, u32 *status)
62 struct nvm_auth_status *st;
64 mutex_lock(&nvm_auth_status_lock);
65 st = __nvm_get_auth_status(sw);
66 mutex_unlock(&nvm_auth_status_lock);
68 *status = st ? st->status : 0;
71 static void nvm_set_auth_status(const struct tb_switch *sw, u32 status)
73 struct nvm_auth_status *st;
75 if (WARN_ON(!sw->uuid))
78 mutex_lock(&nvm_auth_status_lock);
79 st = __nvm_get_auth_status(sw);
82 st = kzalloc(sizeof(*st), GFP_KERNEL);
86 memcpy(&st->uuid, sw->uuid, sizeof(st->uuid));
87 INIT_LIST_HEAD(&st->list);
88 list_add_tail(&st->list, &nvm_auth_status_cache);
93 mutex_unlock(&nvm_auth_status_lock);
96 static void nvm_clear_auth_status(const struct tb_switch *sw)
98 struct nvm_auth_status *st;
100 mutex_lock(&nvm_auth_status_lock);
101 st = __nvm_get_auth_status(sw);
106 mutex_unlock(&nvm_auth_status_lock);
109 static int nvm_validate_and_write(struct tb_switch *sw)
111 unsigned int image_size, hdr_size;
112 const u8 *buf = sw->nvm->buf;
119 image_size = sw->nvm->buf_data_size;
120 if (image_size < NVM_MIN_SIZE || image_size > NVM_MAX_SIZE)
124 * FARB pointer must point inside the image and must at least
125 * contain parts of the digital section we will be reading here.
127 hdr_size = (*(u32 *)buf) & 0xffffff;
128 if (hdr_size + NVM_DEVID + 2 >= image_size)
131 /* Digital section start should be aligned to 4k page */
132 if (!IS_ALIGNED(hdr_size, SZ_4K))
136 * Read digital section size and check that it also fits inside
139 ds_size = *(u16 *)(buf + hdr_size);
140 if (ds_size >= image_size)
143 if (!sw->safe_mode) {
147 * Make sure the device ID in the image matches the one
148 * we read from the switch config space.
150 device_id = *(u16 *)(buf + hdr_size + NVM_DEVID);
151 if (device_id != sw->config.device_id)
154 if (sw->generation < 3) {
155 /* Write CSS headers first */
156 ret = dma_port_flash_write(sw->dma_port,
157 DMA_PORT_CSS_ADDRESS, buf + NVM_CSS,
158 DMA_PORT_CSS_MAX_SIZE);
163 /* Skip headers in the image */
165 image_size -= hdr_size;
168 return dma_port_flash_write(sw->dma_port, 0, buf, image_size);
171 static int nvm_authenticate_host(struct tb_switch *sw)
176 * Root switch NVM upgrade requires that we disconnect the
177 * existing paths first (in case it is not in safe mode
180 if (!sw->safe_mode) {
181 ret = tb_domain_disconnect_all_paths(sw->tb);
185 * The host controller goes away pretty soon after this if
186 * everything goes well so getting timeout is expected.
188 ret = dma_port_flash_update_auth(sw->dma_port);
189 return ret == -ETIMEDOUT ? 0 : ret;
193 * From safe mode we can get out by just power cycling the
196 dma_port_power_cycle(sw->dma_port);
200 static int nvm_authenticate_device(struct tb_switch *sw)
202 int ret, retries = 10;
204 ret = dma_port_flash_update_auth(sw->dma_port);
205 if (ret && ret != -ETIMEDOUT)
209 * Poll here for the authentication status. It takes some time
210 * for the device to respond (we get timeout for a while). Once
211 * we get response the device needs to be power cycled in order
212 * to the new NVM to be taken into use.
217 ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
218 if (ret < 0 && ret != -ETIMEDOUT)
222 tb_sw_warn(sw, "failed to authenticate NVM\n");
223 nvm_set_auth_status(sw, status);
226 tb_sw_info(sw, "power cycling the switch now\n");
227 dma_port_power_cycle(sw->dma_port);
237 static int tb_switch_nvm_read(void *priv, unsigned int offset, void *val,
240 struct tb_switch *sw = priv;
243 pm_runtime_get_sync(&sw->dev);
244 ret = dma_port_flash_read(sw->dma_port, offset, val, bytes);
245 pm_runtime_mark_last_busy(&sw->dev);
246 pm_runtime_put_autosuspend(&sw->dev);
251 static int tb_switch_nvm_write(void *priv, unsigned int offset, void *val,
254 struct tb_switch *sw = priv;
257 if (mutex_lock_interruptible(&switch_lock))
261 * Since writing the NVM image might require some special steps,
262 * for example when CSS headers are written, we cache the image
263 * locally here and handle the special cases when the user asks
264 * us to authenticate the image.
267 sw->nvm->buf = vmalloc(NVM_MAX_SIZE);
274 sw->nvm->buf_data_size = offset + bytes;
275 memcpy(sw->nvm->buf + offset, val, bytes);
278 mutex_unlock(&switch_lock);
283 static struct nvmem_device *register_nvmem(struct tb_switch *sw, int id,
284 size_t size, bool active)
286 struct nvmem_config config;
288 memset(&config, 0, sizeof(config));
291 config.name = "nvm_active";
292 config.reg_read = tb_switch_nvm_read;
293 config.read_only = true;
295 config.name = "nvm_non_active";
296 config.reg_write = tb_switch_nvm_write;
297 config.root_only = true;
302 config.word_size = 4;
304 config.dev = &sw->dev;
305 config.owner = THIS_MODULE;
308 return nvmem_register(&config);
311 static int tb_switch_nvm_add(struct tb_switch *sw)
313 struct nvmem_device *nvm_dev;
314 struct tb_switch_nvm *nvm;
321 nvm = kzalloc(sizeof(*nvm), GFP_KERNEL);
325 nvm->id = ida_simple_get(&nvm_ida, 0, 0, GFP_KERNEL);
328 * If the switch is in safe-mode the only accessible portion of
329 * the NVM is the non-active one where userspace is expected to
330 * write new functional NVM.
332 if (!sw->safe_mode) {
333 u32 nvm_size, hdr_size;
335 ret = dma_port_flash_read(sw->dma_port, NVM_FLASH_SIZE, &val,
340 hdr_size = sw->generation < 3 ? SZ_8K : SZ_16K;
341 nvm_size = (SZ_1M << (val & 7)) / 8;
342 nvm_size = (nvm_size - hdr_size) / 2;
344 ret = dma_port_flash_read(sw->dma_port, NVM_VERSION, &val,
349 nvm->major = val >> 16;
350 nvm->minor = val >> 8;
352 nvm_dev = register_nvmem(sw, nvm->id, nvm_size, true);
353 if (IS_ERR(nvm_dev)) {
354 ret = PTR_ERR(nvm_dev);
357 nvm->active = nvm_dev;
360 nvm_dev = register_nvmem(sw, nvm->id, NVM_MAX_SIZE, false);
361 if (IS_ERR(nvm_dev)) {
362 ret = PTR_ERR(nvm_dev);
365 nvm->non_active = nvm_dev;
367 mutex_lock(&switch_lock);
369 mutex_unlock(&switch_lock);
375 nvmem_unregister(nvm->active);
377 ida_simple_remove(&nvm_ida, nvm->id);
383 static void tb_switch_nvm_remove(struct tb_switch *sw)
385 struct tb_switch_nvm *nvm;
387 mutex_lock(&switch_lock);
390 mutex_unlock(&switch_lock);
395 /* Remove authentication status in case the switch is unplugged */
396 if (!nvm->authenticating)
397 nvm_clear_auth_status(sw);
399 nvmem_unregister(nvm->non_active);
401 nvmem_unregister(nvm->active);
402 ida_simple_remove(&nvm_ida, nvm->id);
407 /* port utility functions */
409 static const char *tb_port_type(struct tb_regs_port_header *port)
411 switch (port->type >> 16) {
413 switch ((u8) port->type) {
438 static void tb_dump_port(struct tb *tb, struct tb_regs_port_header *port)
441 " Port %d: %x:%x (Revision: %d, TB Version: %d, Type: %s (%#x))\n",
442 port->port_number, port->vendor_id, port->device_id,
443 port->revision, port->thunderbolt_version, tb_port_type(port),
445 tb_dbg(tb, " Max hop id (in/out): %d/%d\n",
446 port->max_in_hop_id, port->max_out_hop_id);
447 tb_dbg(tb, " Max counters: %d\n", port->max_counters);
448 tb_dbg(tb, " NFC Credits: %#x\n", port->nfc_credits);
452 * tb_port_state() - get connectedness state of a port
454 * The port must have a TB_CAP_PHY (i.e. it should be a real port).
456 * Return: Returns an enum tb_port_state on success or an error code on failure.
458 static int tb_port_state(struct tb_port *port)
460 struct tb_cap_phy phy;
462 if (port->cap_phy == 0) {
463 tb_port_WARN(port, "does not have a PHY\n");
466 res = tb_port_read(port, &phy, TB_CFG_PORT, port->cap_phy, 2);
473 * tb_wait_for_port() - wait for a port to become ready
475 * Wait up to 1 second for a port to reach state TB_PORT_UP. If
476 * wait_if_unplugged is set then we also wait if the port is in state
477 * TB_PORT_UNPLUGGED (it takes a while for the device to be registered after
478 * switch resume). Otherwise we only wait if a device is registered but the link
479 * has not yet been established.
481 * Return: Returns an error code on failure. Returns 0 if the port is not
482 * connected or failed to reach state TB_PORT_UP within one second. Returns 1
483 * if the port is connected and in state TB_PORT_UP.
485 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged)
489 if (!port->cap_phy) {
490 tb_port_WARN(port, "does not have PHY\n");
493 if (tb_is_upstream_port(port)) {
494 tb_port_WARN(port, "is the upstream port\n");
499 state = tb_port_state(port);
502 if (state == TB_PORT_DISABLED) {
503 tb_port_info(port, "is disabled (state: 0)\n");
506 if (state == TB_PORT_UNPLUGGED) {
507 if (wait_if_unplugged) {
508 /* used during resume */
510 "is unplugged (state: 7), retrying...\n");
514 tb_port_info(port, "is unplugged (state: 7)\n");
517 if (state == TB_PORT_UP) {
519 "is connected, link is up (state: 2)\n");
524 * After plug-in the state is TB_PORT_CONNECTING. Give it some
528 "is connected, link is not up (state: %d), retrying...\n",
533 "failed to reach state TB_PORT_UP. Ignoring port...\n");
538 * tb_port_add_nfc_credits() - add/remove non flow controlled credits to port
540 * Change the number of NFC credits allocated to @port by @credits. To remove
541 * NFC credits pass a negative amount of credits.
543 * Return: Returns 0 on success or an error code on failure.
545 int tb_port_add_nfc_credits(struct tb_port *port, int credits)
550 "adding %#x NFC credits (%#x -> %#x)",
552 port->config.nfc_credits,
553 port->config.nfc_credits + credits);
554 port->config.nfc_credits += credits;
555 return tb_port_write(port, &port->config.nfc_credits,
560 * tb_port_clear_counter() - clear a counter in TB_CFG_COUNTER
562 * Return: Returns 0 on success or an error code on failure.
564 int tb_port_clear_counter(struct tb_port *port, int counter)
566 u32 zero[3] = { 0, 0, 0 };
567 tb_port_info(port, "clearing counter %d\n", counter);
568 return tb_port_write(port, zero, TB_CFG_COUNTERS, 3 * counter, 3);
572 * tb_init_port() - initialize a port
574 * This is a helper method for tb_switch_alloc. Does not check or initialize
575 * any downstream switches.
577 * Return: Returns 0 on success or an error code on failure.
579 static int tb_init_port(struct tb_port *port)
584 res = tb_port_read(port, &port->config, TB_CFG_PORT, 0, 8);
588 /* Port 0 is the switch itself and has no PHY. */
589 if (port->config.type == TB_TYPE_PORT && port->port != 0) {
590 cap = tb_port_find_cap(port, TB_PORT_CAP_PHY);
595 tb_port_WARN(port, "non switch port without a PHY\n");
598 tb_dump_port(port->sw->tb, &port->config);
600 /* TODO: Read dual link port, DP port and more from EEPROM. */
605 /* switch utility functions */
607 static void tb_dump_switch(struct tb *tb, struct tb_regs_switch_header *sw)
609 tb_dbg(tb, " Switch: %x:%x (Revision: %d, TB Version: %d)\n",
610 sw->vendor_id, sw->device_id, sw->revision,
611 sw->thunderbolt_version);
612 tb_dbg(tb, " Max Port Number: %d\n", sw->max_port_number);
613 tb_dbg(tb, " Config:\n");
615 " Upstream Port Number: %d Depth: %d Route String: %#llx Enabled: %d, PlugEventsDelay: %dms\n",
616 sw->upstream_port_number, sw->depth,
617 (((u64) sw->route_hi) << 32) | sw->route_lo,
618 sw->enabled, sw->plug_events_delay);
619 tb_dbg(tb, " unknown1: %#x unknown4: %#x\n",
620 sw->__unknown1, sw->__unknown4);
624 * reset_switch() - reconfigure route, enable and send TB_CFG_PKG_RESET
626 * Return: Returns 0 on success or an error code on failure.
628 int tb_switch_reset(struct tb *tb, u64 route)
630 struct tb_cfg_result res;
631 struct tb_regs_switch_header header = {
632 header.route_hi = route >> 32,
633 header.route_lo = route,
634 header.enabled = true,
636 tb_dbg(tb, "resetting switch at %llx\n", route);
637 res.err = tb_cfg_write(tb->ctl, ((u32 *) &header) + 2, route,
641 res = tb_cfg_reset(tb->ctl, route, TB_CFG_DEFAULT_TIMEOUT);
647 struct tb_switch *get_switch_at_route(struct tb_switch *sw, u64 route)
649 u8 next_port = route; /*
650 * Routes use a stride of 8 bits,
651 * eventhough a port index has 6 bits at most.
655 if (next_port > sw->config.max_port_number)
657 if (tb_is_upstream_port(&sw->ports[next_port]))
659 if (!sw->ports[next_port].remote)
661 return get_switch_at_route(sw->ports[next_port].remote->sw,
662 route >> TB_ROUTE_SHIFT);
666 * tb_plug_events_active() - enable/disable plug events on a switch
668 * Also configures a sane plug_events_delay of 255ms.
670 * Return: Returns 0 on success or an error code on failure.
672 static int tb_plug_events_active(struct tb_switch *sw, bool active)
677 if (!sw->config.enabled)
680 sw->config.plug_events_delay = 0xff;
681 res = tb_sw_write(sw, ((u32 *) &sw->config) + 4, TB_CFG_SWITCH, 4, 1);
685 res = tb_sw_read(sw, &data, TB_CFG_SWITCH, sw->cap_plug_events + 1, 1);
690 data = data & 0xFFFFFF83;
691 switch (sw->config.device_id) {
692 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
693 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
694 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
702 return tb_sw_write(sw, &data, TB_CFG_SWITCH,
703 sw->cap_plug_events + 1, 1);
706 static ssize_t authorized_show(struct device *dev,
707 struct device_attribute *attr,
710 struct tb_switch *sw = tb_to_switch(dev);
712 return sprintf(buf, "%u\n", sw->authorized);
715 static int tb_switch_set_authorized(struct tb_switch *sw, unsigned int val)
719 if (mutex_lock_interruptible(&switch_lock))
726 * Make sure there is no PCIe rescan ongoing when a new PCIe
727 * tunnel is created. Otherwise the PCIe rescan code might find
728 * the new tunnel too early.
730 pci_lock_rescan_remove();
731 pm_runtime_get_sync(&sw->dev);
737 ret = tb_domain_approve_switch_key(sw->tb, sw);
739 ret = tb_domain_approve_switch(sw->tb, sw);
742 /* Challenge switch */
745 ret = tb_domain_challenge_switch_key(sw->tb, sw);
752 pm_runtime_mark_last_busy(&sw->dev);
753 pm_runtime_put_autosuspend(&sw->dev);
754 pci_unlock_rescan_remove();
757 sw->authorized = val;
758 /* Notify status change to the userspace */
759 kobject_uevent(&sw->dev.kobj, KOBJ_CHANGE);
763 mutex_unlock(&switch_lock);
767 static ssize_t authorized_store(struct device *dev,
768 struct device_attribute *attr,
769 const char *buf, size_t count)
771 struct tb_switch *sw = tb_to_switch(dev);
775 ret = kstrtouint(buf, 0, &val);
781 ret = tb_switch_set_authorized(sw, val);
783 return ret ? ret : count;
785 static DEVICE_ATTR_RW(authorized);
787 static ssize_t boot_show(struct device *dev, struct device_attribute *attr,
790 struct tb_switch *sw = tb_to_switch(dev);
792 return sprintf(buf, "%u\n", sw->boot);
794 static DEVICE_ATTR_RO(boot);
796 static ssize_t device_show(struct device *dev, struct device_attribute *attr,
799 struct tb_switch *sw = tb_to_switch(dev);
801 return sprintf(buf, "%#x\n", sw->device);
803 static DEVICE_ATTR_RO(device);
806 device_name_show(struct device *dev, struct device_attribute *attr, char *buf)
808 struct tb_switch *sw = tb_to_switch(dev);
810 return sprintf(buf, "%s\n", sw->device_name ? sw->device_name : "");
812 static DEVICE_ATTR_RO(device_name);
814 static ssize_t key_show(struct device *dev, struct device_attribute *attr,
817 struct tb_switch *sw = tb_to_switch(dev);
820 if (mutex_lock_interruptible(&switch_lock))
824 ret = sprintf(buf, "%*phN\n", TB_SWITCH_KEY_SIZE, sw->key);
826 ret = sprintf(buf, "\n");
828 mutex_unlock(&switch_lock);
832 static ssize_t key_store(struct device *dev, struct device_attribute *attr,
833 const char *buf, size_t count)
835 struct tb_switch *sw = tb_to_switch(dev);
836 u8 key[TB_SWITCH_KEY_SIZE];
840 if (!strcmp(buf, "\n"))
842 else if (hex2bin(key, buf, sizeof(key)))
845 if (mutex_lock_interruptible(&switch_lock))
848 if (sw->authorized) {
855 sw->key = kmemdup(key, sizeof(key), GFP_KERNEL);
861 mutex_unlock(&switch_lock);
864 static DEVICE_ATTR(key, 0600, key_show, key_store);
866 static ssize_t nvm_authenticate_show(struct device *dev,
867 struct device_attribute *attr, char *buf)
869 struct tb_switch *sw = tb_to_switch(dev);
872 nvm_get_auth_status(sw, &status);
873 return sprintf(buf, "%#x\n", status);
876 static ssize_t nvm_authenticate_store(struct device *dev,
877 struct device_attribute *attr, const char *buf, size_t count)
879 struct tb_switch *sw = tb_to_switch(dev);
883 if (mutex_lock_interruptible(&switch_lock))
886 /* If NVMem devices are not yet added */
892 ret = kstrtobool(buf, &val);
896 /* Always clear the authentication status */
897 nvm_clear_auth_status(sw);
905 pm_runtime_get_sync(&sw->dev);
906 ret = nvm_validate_and_write(sw);
908 pm_runtime_mark_last_busy(&sw->dev);
909 pm_runtime_put_autosuspend(&sw->dev);
913 sw->nvm->authenticating = true;
916 ret = nvm_authenticate_host(sw);
918 ret = nvm_authenticate_device(sw);
919 pm_runtime_mark_last_busy(&sw->dev);
920 pm_runtime_put_autosuspend(&sw->dev);
924 mutex_unlock(&switch_lock);
930 static DEVICE_ATTR_RW(nvm_authenticate);
932 static ssize_t nvm_version_show(struct device *dev,
933 struct device_attribute *attr, char *buf)
935 struct tb_switch *sw = tb_to_switch(dev);
938 if (mutex_lock_interruptible(&switch_lock))
946 ret = sprintf(buf, "%x.%x\n", sw->nvm->major, sw->nvm->minor);
948 mutex_unlock(&switch_lock);
952 static DEVICE_ATTR_RO(nvm_version);
954 static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
957 struct tb_switch *sw = tb_to_switch(dev);
959 return sprintf(buf, "%#x\n", sw->vendor);
961 static DEVICE_ATTR_RO(vendor);
964 vendor_name_show(struct device *dev, struct device_attribute *attr, char *buf)
966 struct tb_switch *sw = tb_to_switch(dev);
968 return sprintf(buf, "%s\n", sw->vendor_name ? sw->vendor_name : "");
970 static DEVICE_ATTR_RO(vendor_name);
972 static ssize_t unique_id_show(struct device *dev, struct device_attribute *attr,
975 struct tb_switch *sw = tb_to_switch(dev);
977 return sprintf(buf, "%pUb\n", sw->uuid);
979 static DEVICE_ATTR_RO(unique_id);
981 static struct attribute *switch_attrs[] = {
982 &dev_attr_authorized.attr,
984 &dev_attr_device.attr,
985 &dev_attr_device_name.attr,
987 &dev_attr_nvm_authenticate.attr,
988 &dev_attr_nvm_version.attr,
989 &dev_attr_vendor.attr,
990 &dev_attr_vendor_name.attr,
991 &dev_attr_unique_id.attr,
995 static umode_t switch_attr_is_visible(struct kobject *kobj,
996 struct attribute *attr, int n)
998 struct device *dev = container_of(kobj, struct device, kobj);
999 struct tb_switch *sw = tb_to_switch(dev);
1001 if (attr == &dev_attr_key.attr) {
1003 sw->tb->security_level == TB_SECURITY_SECURE &&
1004 sw->security_level == TB_SECURITY_SECURE)
1007 } else if (attr == &dev_attr_nvm_authenticate.attr ||
1008 attr == &dev_attr_nvm_version.attr) {
1012 } else if (attr == &dev_attr_boot.attr) {
1018 return sw->safe_mode ? 0 : attr->mode;
1021 static struct attribute_group switch_group = {
1022 .is_visible = switch_attr_is_visible,
1023 .attrs = switch_attrs,
1026 static const struct attribute_group *switch_groups[] = {
1031 static void tb_switch_release(struct device *dev)
1033 struct tb_switch *sw = tb_to_switch(dev);
1035 dma_port_free(sw->dma_port);
1038 kfree(sw->device_name);
1039 kfree(sw->vendor_name);
1047 * Currently only need to provide the callbacks. Everything else is handled
1048 * in the connection manager.
1050 static int __maybe_unused tb_switch_runtime_suspend(struct device *dev)
1055 static int __maybe_unused tb_switch_runtime_resume(struct device *dev)
1060 static const struct dev_pm_ops tb_switch_pm_ops = {
1061 SET_RUNTIME_PM_OPS(tb_switch_runtime_suspend, tb_switch_runtime_resume,
1065 struct device_type tb_switch_type = {
1066 .name = "thunderbolt_device",
1067 .release = tb_switch_release,
1068 .pm = &tb_switch_pm_ops,
1071 static int tb_switch_get_generation(struct tb_switch *sw)
1073 switch (sw->config.device_id) {
1074 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
1075 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
1076 case PCI_DEVICE_ID_INTEL_LIGHT_PEAK:
1077 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
1078 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
1079 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
1080 case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_2C_BRIDGE:
1081 case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_4C_BRIDGE:
1084 case PCI_DEVICE_ID_INTEL_WIN_RIDGE_2C_BRIDGE:
1085 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
1086 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
1089 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
1090 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
1091 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE:
1092 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
1093 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
1094 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
1095 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
1096 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
1101 * For unknown switches assume generation to be 1 to be
1104 tb_sw_warn(sw, "unsupported switch device id %#x\n",
1105 sw->config.device_id);
1111 * tb_switch_alloc() - allocate a switch
1112 * @tb: Pointer to the owning domain
1113 * @parent: Parent device for this switch
1114 * @route: Route string for this switch
1116 * Allocates and initializes a switch. Will not upload configuration to
1117 * the switch. For that you need to call tb_switch_configure()
1118 * separately. The returned switch should be released by calling
1121 * Return: Pointer to the allocated switch or %NULL in case of failure
1123 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
1128 struct tb_switch *sw;
1129 int upstream_port = tb_cfg_get_upstream_port(tb->ctl, route);
1130 if (upstream_port < 0)
1133 sw = kzalloc(sizeof(*sw), GFP_KERNEL);
1138 if (tb_cfg_read(tb->ctl, &sw->config, route, 0, TB_CFG_SWITCH, 0, 5))
1139 goto err_free_sw_ports;
1141 tb_dbg(tb, "current switch config:\n");
1142 tb_dump_switch(tb, &sw->config);
1144 /* configure switch */
1145 sw->config.upstream_port_number = upstream_port;
1146 sw->config.depth = tb_route_length(route);
1147 sw->config.route_lo = route;
1148 sw->config.route_hi = route >> 32;
1149 sw->config.enabled = 0;
1151 /* initialize ports */
1152 sw->ports = kcalloc(sw->config.max_port_number + 1, sizeof(*sw->ports),
1155 goto err_free_sw_ports;
1157 for (i = 0; i <= sw->config.max_port_number; i++) {
1158 /* minimum setup for tb_find_cap and tb_drom_read to work */
1159 sw->ports[i].sw = sw;
1160 sw->ports[i].port = i;
1163 sw->generation = tb_switch_get_generation(sw);
1165 cap = tb_switch_find_vse_cap(sw, TB_VSE_CAP_PLUG_EVENTS);
1167 tb_sw_warn(sw, "cannot find TB_VSE_CAP_PLUG_EVENTS aborting\n");
1168 goto err_free_sw_ports;
1170 sw->cap_plug_events = cap;
1172 /* Root switch is always authorized */
1174 sw->authorized = true;
1176 device_initialize(&sw->dev);
1177 sw->dev.parent = parent;
1178 sw->dev.bus = &tb_bus_type;
1179 sw->dev.type = &tb_switch_type;
1180 sw->dev.groups = switch_groups;
1181 dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
1193 * tb_switch_alloc_safe_mode() - allocate a switch that is in safe mode
1194 * @tb: Pointer to the owning domain
1195 * @parent: Parent device for this switch
1196 * @route: Route string for this switch
1198 * This creates a switch in safe mode. This means the switch pretty much
1199 * lacks all capabilities except DMA configuration port before it is
1200 * flashed with a valid NVM firmware.
1202 * The returned switch must be released by calling tb_switch_put().
1204 * Return: Pointer to the allocated switch or %NULL in case of failure
1207 tb_switch_alloc_safe_mode(struct tb *tb, struct device *parent, u64 route)
1209 struct tb_switch *sw;
1211 sw = kzalloc(sizeof(*sw), GFP_KERNEL);
1216 sw->config.depth = tb_route_length(route);
1217 sw->config.route_hi = upper_32_bits(route);
1218 sw->config.route_lo = lower_32_bits(route);
1219 sw->safe_mode = true;
1221 device_initialize(&sw->dev);
1222 sw->dev.parent = parent;
1223 sw->dev.bus = &tb_bus_type;
1224 sw->dev.type = &tb_switch_type;
1225 sw->dev.groups = switch_groups;
1226 dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
1232 * tb_switch_configure() - Uploads configuration to the switch
1233 * @sw: Switch to configure
1235 * Call this function before the switch is added to the system. It will
1236 * upload configuration to the switch and makes it available for the
1237 * connection manager to use.
1239 * Return: %0 in case of success and negative errno in case of failure
1241 int tb_switch_configure(struct tb_switch *sw)
1243 struct tb *tb = sw->tb;
1247 route = tb_route(sw);
1248 tb_dbg(tb, "initializing Switch at %#llx (depth: %d, up port: %d)\n",
1249 route, tb_route_length(route), sw->config.upstream_port_number);
1251 if (sw->config.vendor_id != PCI_VENDOR_ID_INTEL)
1252 tb_sw_warn(sw, "unknown switch vendor id %#x\n",
1253 sw->config.vendor_id);
1255 sw->config.enabled = 1;
1257 /* upload configuration */
1258 ret = tb_sw_write(sw, 1 + (u32 *)&sw->config, TB_CFG_SWITCH, 1, 3);
1262 return tb_plug_events_active(sw, true);
1265 static void tb_switch_set_uuid(struct tb_switch *sw)
1274 * The newer controllers include fused UUID as part of link
1275 * controller specific registers
1277 cap = tb_switch_find_vse_cap(sw, TB_VSE_CAP_LINK_CONTROLLER);
1279 tb_sw_read(sw, uuid, TB_CFG_SWITCH, cap + 3, 4);
1282 * ICM generates UUID based on UID and fills the upper
1283 * two words with ones. This is not strictly following
1284 * UUID format but we want to be compatible with it so
1285 * we do the same here.
1287 uuid[0] = sw->uid & 0xffffffff;
1288 uuid[1] = (sw->uid >> 32) & 0xffffffff;
1289 uuid[2] = 0xffffffff;
1290 uuid[3] = 0xffffffff;
1293 sw->uuid = kmemdup(uuid, sizeof(uuid), GFP_KERNEL);
1296 static int tb_switch_add_dma_port(struct tb_switch *sw)
1301 switch (sw->generation) {
1306 /* Only root switch can be upgraded */
1313 * DMA port is the only thing available when the switch
1321 if (sw->no_nvm_upgrade)
1324 sw->dma_port = dma_port_alloc(sw);
1329 * Check status of the previous flash authentication. If there
1330 * is one we need to power cycle the switch in any case to make
1331 * it functional again.
1333 ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
1338 tb_sw_info(sw, "switch flash authentication failed\n");
1339 tb_switch_set_uuid(sw);
1340 nvm_set_auth_status(sw, status);
1343 tb_sw_info(sw, "power cycling the switch now\n");
1344 dma_port_power_cycle(sw->dma_port);
1347 * We return error here which causes the switch adding failure.
1348 * It should appear back after power cycle is complete.
1354 * tb_switch_add() - Add a switch to the domain
1355 * @sw: Switch to add
1357 * This is the last step in adding switch to the domain. It will read
1358 * identification information from DROM and initializes ports so that
1359 * they can be used to connect other switches. The switch will be
1360 * exposed to the userspace when this function successfully returns. To
1361 * remove and release the switch, call tb_switch_remove().
1363 * Return: %0 in case of success and negative errno in case of failure
1365 int tb_switch_add(struct tb_switch *sw)
1370 * Initialize DMA control port now before we read DROM. Recent
1371 * host controllers have more complete DROM on NVM that includes
1372 * vendor and model identification strings which we then expose
1373 * to the userspace. NVM can be accessed through DMA
1374 * configuration based mailbox.
1376 ret = tb_switch_add_dma_port(sw);
1380 if (!sw->safe_mode) {
1382 ret = tb_drom_read(sw);
1384 tb_sw_warn(sw, "tb_eeprom_read_rom failed\n");
1387 tb_sw_dbg(sw, "uid: %#llx\n", sw->uid);
1389 tb_switch_set_uuid(sw);
1391 for (i = 0; i <= sw->config.max_port_number; i++) {
1392 if (sw->ports[i].disabled) {
1393 tb_port_dbg(&sw->ports[i], "disabled by eeprom\n");
1396 ret = tb_init_port(&sw->ports[i]);
1402 ret = device_add(&sw->dev);
1407 dev_info(&sw->dev, "new device found, vendor=%#x device=%#x\n",
1408 sw->vendor, sw->device);
1409 if (sw->vendor_name && sw->device_name)
1410 dev_info(&sw->dev, "%s %s\n", sw->vendor_name,
1414 ret = tb_switch_nvm_add(sw);
1416 device_del(&sw->dev);
1420 pm_runtime_set_active(&sw->dev);
1422 pm_runtime_set_autosuspend_delay(&sw->dev, TB_AUTOSUSPEND_DELAY);
1423 pm_runtime_use_autosuspend(&sw->dev);
1424 pm_runtime_mark_last_busy(&sw->dev);
1425 pm_runtime_enable(&sw->dev);
1426 pm_request_autosuspend(&sw->dev);
1433 * tb_switch_remove() - Remove and release a switch
1434 * @sw: Switch to remove
1436 * This will remove the switch from the domain and release it after last
1437 * reference count drops to zero. If there are switches connected below
1438 * this switch, they will be removed as well.
1440 void tb_switch_remove(struct tb_switch *sw)
1445 pm_runtime_get_sync(&sw->dev);
1446 pm_runtime_disable(&sw->dev);
1449 /* port 0 is the switch itself and never has a remote */
1450 for (i = 1; i <= sw->config.max_port_number; i++) {
1451 if (tb_is_upstream_port(&sw->ports[i]))
1453 if (sw->ports[i].remote)
1454 tb_switch_remove(sw->ports[i].remote->sw);
1455 sw->ports[i].remote = NULL;
1456 if (sw->ports[i].xdomain)
1457 tb_xdomain_remove(sw->ports[i].xdomain);
1458 sw->ports[i].xdomain = NULL;
1461 if (!sw->is_unplugged)
1462 tb_plug_events_active(sw, false);
1464 tb_switch_nvm_remove(sw);
1467 dev_info(&sw->dev, "device disconnected\n");
1468 device_unregister(&sw->dev);
1472 * tb_sw_set_unplugged() - set is_unplugged on switch and downstream switches
1474 void tb_sw_set_unplugged(struct tb_switch *sw)
1477 if (sw == sw->tb->root_switch) {
1478 tb_sw_WARN(sw, "cannot unplug root switch\n");
1481 if (sw->is_unplugged) {
1482 tb_sw_WARN(sw, "is_unplugged already set\n");
1485 sw->is_unplugged = true;
1486 for (i = 0; i <= sw->config.max_port_number; i++) {
1487 if (!tb_is_upstream_port(&sw->ports[i]) && sw->ports[i].remote)
1488 tb_sw_set_unplugged(sw->ports[i].remote->sw);
1492 int tb_switch_resume(struct tb_switch *sw)
1495 tb_sw_dbg(sw, "resuming switch\n");
1498 * Check for UID of the connected switches except for root
1499 * switch which we assume cannot be removed.
1504 err = tb_drom_read_uid_only(sw, &uid);
1506 tb_sw_warn(sw, "uid read failed\n");
1509 if (sw->uid != uid) {
1511 "changed while suspended (uid %#llx -> %#llx)\n",
1517 /* upload configuration */
1518 err = tb_sw_write(sw, 1 + (u32 *) &sw->config, TB_CFG_SWITCH, 1, 3);
1522 err = tb_plug_events_active(sw, true);
1526 /* check for surviving downstream switches */
1527 for (i = 1; i <= sw->config.max_port_number; i++) {
1528 struct tb_port *port = &sw->ports[i];
1529 if (tb_is_upstream_port(port))
1533 if (tb_wait_for_port(port, true) <= 0
1534 || tb_switch_resume(port->remote->sw)) {
1536 "lost during suspend, disconnecting\n");
1537 tb_sw_set_unplugged(port->remote->sw);
1543 void tb_switch_suspend(struct tb_switch *sw)
1546 err = tb_plug_events_active(sw, false);
1550 for (i = 1; i <= sw->config.max_port_number; i++) {
1551 if (!tb_is_upstream_port(&sw->ports[i]) && sw->ports[i].remote)
1552 tb_switch_suspend(sw->ports[i].remote->sw);
1555 * TODO: invoke tb_cfg_prepare_to_sleep here? does not seem to have any
1560 struct tb_sw_lookup {
1568 static int tb_switch_match(struct device *dev, void *data)
1570 struct tb_switch *sw = tb_to_switch(dev);
1571 struct tb_sw_lookup *lookup = data;
1575 if (sw->tb != lookup->tb)
1579 return !memcmp(sw->uuid, lookup->uuid, sizeof(*lookup->uuid));
1581 if (lookup->route) {
1582 return sw->config.route_lo == lower_32_bits(lookup->route) &&
1583 sw->config.route_hi == upper_32_bits(lookup->route);
1586 /* Root switch is matched only by depth */
1590 return sw->link == lookup->link && sw->depth == lookup->depth;
1594 * tb_switch_find_by_link_depth() - Find switch by link and depth
1595 * @tb: Domain the switch belongs
1596 * @link: Link number the switch is connected
1597 * @depth: Depth of the switch in link
1599 * Returned switch has reference count increased so the caller needs to
1600 * call tb_switch_put() when done with the switch.
1602 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link, u8 depth)
1604 struct tb_sw_lookup lookup;
1607 memset(&lookup, 0, sizeof(lookup));
1610 lookup.depth = depth;
1612 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
1614 return tb_to_switch(dev);
1620 * tb_switch_find_by_uuid() - Find switch by UUID
1621 * @tb: Domain the switch belongs
1622 * @uuid: UUID to look for
1624 * Returned switch has reference count increased so the caller needs to
1625 * call tb_switch_put() when done with the switch.
1627 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid)
1629 struct tb_sw_lookup lookup;
1632 memset(&lookup, 0, sizeof(lookup));
1636 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
1638 return tb_to_switch(dev);
1644 * tb_switch_find_by_route() - Find switch by route string
1645 * @tb: Domain the switch belongs
1646 * @route: Route string to look for
1648 * Returned switch has reference count increased so the caller needs to
1649 * call tb_switch_put() when done with the switch.
1651 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route)
1653 struct tb_sw_lookup lookup;
1657 return tb_switch_get(tb->root_switch);
1659 memset(&lookup, 0, sizeof(lookup));
1661 lookup.route = route;
1663 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
1665 return tb_to_switch(dev);
1670 void tb_switch_exit(void)
1672 ida_destroy(&nvm_ida);