1 // SPDX-License-Identifier: GPL-2.0
3 * Thunderbolt Cactus Ridge driver - switch/port utility functions
5 * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
8 #include <linux/delay.h>
10 #include <linux/nvmem-provider.h>
11 #include <linux/sizes.h>
12 #include <linux/slab.h>
13 #include <linux/vmalloc.h>
17 /* Switch authorization from userspace is serialized by this lock */
18 static DEFINE_MUTEX(switch_lock);
20 /* Switch NVM support */
22 #define NVM_DEVID 0x05
23 #define NVM_VERSION 0x08
25 #define NVM_FLASH_SIZE 0x45
27 #define NVM_MIN_SIZE SZ_32K
28 #define NVM_MAX_SIZE SZ_512K
30 static DEFINE_IDA(nvm_ida);
32 struct nvm_auth_status {
33 struct list_head list;
39 * Hold NVM authentication failure status per switch This information
40 * needs to stay around even when the switch gets power cycled so we
43 static LIST_HEAD(nvm_auth_status_cache);
44 static DEFINE_MUTEX(nvm_auth_status_lock);
46 static struct nvm_auth_status *__nvm_get_auth_status(const struct tb_switch *sw)
48 struct nvm_auth_status *st;
50 list_for_each_entry(st, &nvm_auth_status_cache, list) {
51 if (uuid_equal(&st->uuid, sw->uuid))
58 static void nvm_get_auth_status(const struct tb_switch *sw, u32 *status)
60 struct nvm_auth_status *st;
62 mutex_lock(&nvm_auth_status_lock);
63 st = __nvm_get_auth_status(sw);
64 mutex_unlock(&nvm_auth_status_lock);
66 *status = st ? st->status : 0;
69 static void nvm_set_auth_status(const struct tb_switch *sw, u32 status)
71 struct nvm_auth_status *st;
73 if (WARN_ON(!sw->uuid))
76 mutex_lock(&nvm_auth_status_lock);
77 st = __nvm_get_auth_status(sw);
80 st = kzalloc(sizeof(*st), GFP_KERNEL);
84 memcpy(&st->uuid, sw->uuid, sizeof(st->uuid));
85 INIT_LIST_HEAD(&st->list);
86 list_add_tail(&st->list, &nvm_auth_status_cache);
91 mutex_unlock(&nvm_auth_status_lock);
94 static void nvm_clear_auth_status(const struct tb_switch *sw)
96 struct nvm_auth_status *st;
98 mutex_lock(&nvm_auth_status_lock);
99 st = __nvm_get_auth_status(sw);
104 mutex_unlock(&nvm_auth_status_lock);
107 static int nvm_validate_and_write(struct tb_switch *sw)
109 unsigned int image_size, hdr_size;
110 const u8 *buf = sw->nvm->buf;
117 image_size = sw->nvm->buf_data_size;
118 if (image_size < NVM_MIN_SIZE || image_size > NVM_MAX_SIZE)
122 * FARB pointer must point inside the image and must at least
123 * contain parts of the digital section we will be reading here.
125 hdr_size = (*(u32 *)buf) & 0xffffff;
126 if (hdr_size + NVM_DEVID + 2 >= image_size)
129 /* Digital section start should be aligned to 4k page */
130 if (!IS_ALIGNED(hdr_size, SZ_4K))
134 * Read digital section size and check that it also fits inside
137 ds_size = *(u16 *)(buf + hdr_size);
138 if (ds_size >= image_size)
141 if (!sw->safe_mode) {
145 * Make sure the device ID in the image matches the one
146 * we read from the switch config space.
148 device_id = *(u16 *)(buf + hdr_size + NVM_DEVID);
149 if (device_id != sw->config.device_id)
152 if (sw->generation < 3) {
153 /* Write CSS headers first */
154 ret = dma_port_flash_write(sw->dma_port,
155 DMA_PORT_CSS_ADDRESS, buf + NVM_CSS,
156 DMA_PORT_CSS_MAX_SIZE);
161 /* Skip headers in the image */
163 image_size -= hdr_size;
166 return dma_port_flash_write(sw->dma_port, 0, buf, image_size);
169 static int nvm_authenticate_host(struct tb_switch *sw)
174 * Root switch NVM upgrade requires that we disconnect the
175 * existing PCIe paths first (in case it is not in safe mode
178 if (!sw->safe_mode) {
179 ret = tb_domain_disconnect_pcie_paths(sw->tb);
183 * The host controller goes away pretty soon after this if
184 * everything goes well so getting timeout is expected.
186 ret = dma_port_flash_update_auth(sw->dma_port);
187 return ret == -ETIMEDOUT ? 0 : ret;
191 * From safe mode we can get out by just power cycling the
194 dma_port_power_cycle(sw->dma_port);
198 static int nvm_authenticate_device(struct tb_switch *sw)
200 int ret, retries = 10;
202 ret = dma_port_flash_update_auth(sw->dma_port);
203 if (ret && ret != -ETIMEDOUT)
207 * Poll here for the authentication status. It takes some time
208 * for the device to respond (we get timeout for a while). Once
209 * we get response the device needs to be power cycled in order
210 * to the new NVM to be taken into use.
215 ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
216 if (ret < 0 && ret != -ETIMEDOUT)
220 tb_sw_warn(sw, "failed to authenticate NVM\n");
221 nvm_set_auth_status(sw, status);
224 tb_sw_info(sw, "power cycling the switch now\n");
225 dma_port_power_cycle(sw->dma_port);
235 static int tb_switch_nvm_read(void *priv, unsigned int offset, void *val,
238 struct tb_switch *sw = priv;
240 return dma_port_flash_read(sw->dma_port, offset, val, bytes);
243 static int tb_switch_nvm_no_read(void *priv, unsigned int offset, void *val,
249 static int tb_switch_nvm_write(void *priv, unsigned int offset, void *val,
252 struct tb_switch *sw = priv;
255 if (mutex_lock_interruptible(&switch_lock))
259 * Since writing the NVM image might require some special steps,
260 * for example when CSS headers are written, we cache the image
261 * locally here and handle the special cases when the user asks
262 * us to authenticate the image.
265 sw->nvm->buf = vmalloc(NVM_MAX_SIZE);
272 sw->nvm->buf_data_size = offset + bytes;
273 memcpy(sw->nvm->buf + offset, val, bytes);
276 mutex_unlock(&switch_lock);
281 static struct nvmem_device *register_nvmem(struct tb_switch *sw, int id,
282 size_t size, bool active)
284 struct nvmem_config config;
286 memset(&config, 0, sizeof(config));
289 config.name = "nvm_active";
290 config.reg_read = tb_switch_nvm_read;
291 config.read_only = true;
293 config.name = "nvm_non_active";
294 config.reg_read = tb_switch_nvm_no_read;
295 config.reg_write = tb_switch_nvm_write;
296 config.root_only = true;
301 config.word_size = 4;
303 config.dev = &sw->dev;
304 config.owner = THIS_MODULE;
307 return nvmem_register(&config);
310 static int tb_switch_nvm_add(struct tb_switch *sw)
312 struct nvmem_device *nvm_dev;
313 struct tb_switch_nvm *nvm;
320 nvm = kzalloc(sizeof(*nvm), GFP_KERNEL);
324 nvm->id = ida_simple_get(&nvm_ida, 0, 0, GFP_KERNEL);
327 * If the switch is in safe-mode the only accessible portion of
328 * the NVM is the non-active one where userspace is expected to
329 * write new functional NVM.
331 if (!sw->safe_mode) {
332 u32 nvm_size, hdr_size;
334 ret = dma_port_flash_read(sw->dma_port, NVM_FLASH_SIZE, &val,
339 hdr_size = sw->generation < 3 ? SZ_8K : SZ_16K;
340 nvm_size = (SZ_1M << (val & 7)) / 8;
341 nvm_size = (nvm_size - hdr_size) / 2;
343 ret = dma_port_flash_read(sw->dma_port, NVM_VERSION, &val,
348 nvm->major = val >> 16;
349 nvm->minor = val >> 8;
351 nvm_dev = register_nvmem(sw, nvm->id, nvm_size, true);
352 if (IS_ERR(nvm_dev)) {
353 ret = PTR_ERR(nvm_dev);
356 nvm->active = nvm_dev;
359 nvm_dev = register_nvmem(sw, nvm->id, NVM_MAX_SIZE, false);
360 if (IS_ERR(nvm_dev)) {
361 ret = PTR_ERR(nvm_dev);
364 nvm->non_active = nvm_dev;
366 mutex_lock(&switch_lock);
368 mutex_unlock(&switch_lock);
374 nvmem_unregister(nvm->active);
376 ida_simple_remove(&nvm_ida, nvm->id);
382 static void tb_switch_nvm_remove(struct tb_switch *sw)
384 struct tb_switch_nvm *nvm;
386 mutex_lock(&switch_lock);
389 mutex_unlock(&switch_lock);
394 /* Remove authentication status in case the switch is unplugged */
395 if (!nvm->authenticating)
396 nvm_clear_auth_status(sw);
398 nvmem_unregister(nvm->non_active);
400 nvmem_unregister(nvm->active);
401 ida_simple_remove(&nvm_ida, nvm->id);
406 /* port utility functions */
408 static const char *tb_port_type(struct tb_regs_port_header *port)
410 switch (port->type >> 16) {
412 switch ((u8) port->type) {
437 static void tb_dump_port(struct tb *tb, struct tb_regs_port_header *port)
440 " Port %d: %x:%x (Revision: %d, TB Version: %d, Type: %s (%#x))\n",
441 port->port_number, port->vendor_id, port->device_id,
442 port->revision, port->thunderbolt_version, tb_port_type(port),
444 tb_info(tb, " Max hop id (in/out): %d/%d\n",
445 port->max_in_hop_id, port->max_out_hop_id);
446 tb_info(tb, " Max counters: %d\n", port->max_counters);
447 tb_info(tb, " NFC Credits: %#x\n", port->nfc_credits);
451 * tb_port_state() - get connectedness state of a port
453 * The port must have a TB_CAP_PHY (i.e. it should be a real port).
455 * Return: Returns an enum tb_port_state on success or an error code on failure.
457 static int tb_port_state(struct tb_port *port)
459 struct tb_cap_phy phy;
461 if (port->cap_phy == 0) {
462 tb_port_WARN(port, "does not have a PHY\n");
465 res = tb_port_read(port, &phy, TB_CFG_PORT, port->cap_phy, 2);
472 * tb_wait_for_port() - wait for a port to become ready
474 * Wait up to 1 second for a port to reach state TB_PORT_UP. If
475 * wait_if_unplugged is set then we also wait if the port is in state
476 * TB_PORT_UNPLUGGED (it takes a while for the device to be registered after
477 * switch resume). Otherwise we only wait if a device is registered but the link
478 * has not yet been established.
480 * Return: Returns an error code on failure. Returns 0 if the port is not
481 * connected or failed to reach state TB_PORT_UP within one second. Returns 1
482 * if the port is connected and in state TB_PORT_UP.
484 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged)
488 if (!port->cap_phy) {
489 tb_port_WARN(port, "does not have PHY\n");
492 if (tb_is_upstream_port(port)) {
493 tb_port_WARN(port, "is the upstream port\n");
498 state = tb_port_state(port);
501 if (state == TB_PORT_DISABLED) {
502 tb_port_info(port, "is disabled (state: 0)\n");
505 if (state == TB_PORT_UNPLUGGED) {
506 if (wait_if_unplugged) {
507 /* used during resume */
509 "is unplugged (state: 7), retrying...\n");
513 tb_port_info(port, "is unplugged (state: 7)\n");
516 if (state == TB_PORT_UP) {
518 "is connected, link is up (state: 2)\n");
523 * After plug-in the state is TB_PORT_CONNECTING. Give it some
527 "is connected, link is not up (state: %d), retrying...\n",
532 "failed to reach state TB_PORT_UP. Ignoring port...\n");
537 * tb_port_add_nfc_credits() - add/remove non flow controlled credits to port
539 * Change the number of NFC credits allocated to @port by @credits. To remove
540 * NFC credits pass a negative amount of credits.
542 * Return: Returns 0 on success or an error code on failure.
544 int tb_port_add_nfc_credits(struct tb_port *port, int credits)
549 "adding %#x NFC credits (%#x -> %#x)",
551 port->config.nfc_credits,
552 port->config.nfc_credits + credits);
553 port->config.nfc_credits += credits;
554 return tb_port_write(port, &port->config.nfc_credits,
559 * tb_port_clear_counter() - clear a counter in TB_CFG_COUNTER
561 * Return: Returns 0 on success or an error code on failure.
563 int tb_port_clear_counter(struct tb_port *port, int counter)
565 u32 zero[3] = { 0, 0, 0 };
566 tb_port_info(port, "clearing counter %d\n", counter);
567 return tb_port_write(port, zero, TB_CFG_COUNTERS, 3 * counter, 3);
571 * tb_init_port() - initialize a port
573 * This is a helper method for tb_switch_alloc. Does not check or initialize
574 * any downstream switches.
576 * Return: Returns 0 on success or an error code on failure.
578 static int tb_init_port(struct tb_port *port)
583 res = tb_port_read(port, &port->config, TB_CFG_PORT, 0, 8);
587 /* Port 0 is the switch itself and has no PHY. */
588 if (port->config.type == TB_TYPE_PORT && port->port != 0) {
589 cap = tb_port_find_cap(port, TB_PORT_CAP_PHY);
594 tb_port_WARN(port, "non switch port without a PHY\n");
597 tb_dump_port(port->sw->tb, &port->config);
599 /* TODO: Read dual link port, DP port and more from EEPROM. */
604 /* switch utility functions */
606 static void tb_dump_switch(struct tb *tb, struct tb_regs_switch_header *sw)
609 " Switch: %x:%x (Revision: %d, TB Version: %d)\n",
610 sw->vendor_id, sw->device_id, sw->revision,
611 sw->thunderbolt_version);
612 tb_info(tb, " Max Port Number: %d\n", sw->max_port_number);
613 tb_info(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);
620 " unknown1: %#x unknown4: %#x\n",
621 sw->__unknown1, sw->__unknown4);
625 * reset_switch() - reconfigure route, enable and send TB_CFG_PKG_RESET
627 * Return: Returns 0 on success or an error code on failure.
629 int tb_switch_reset(struct tb *tb, u64 route)
631 struct tb_cfg_result res;
632 struct tb_regs_switch_header header = {
633 header.route_hi = route >> 32,
634 header.route_lo = route,
635 header.enabled = true,
637 tb_info(tb, "resetting switch at %llx\n", route);
638 res.err = tb_cfg_write(tb->ctl, ((u32 *) &header) + 2, route,
642 res = tb_cfg_reset(tb->ctl, route, TB_CFG_DEFAULT_TIMEOUT);
648 struct tb_switch *get_switch_at_route(struct tb_switch *sw, u64 route)
650 u8 next_port = route; /*
651 * Routes use a stride of 8 bits,
652 * eventhough a port index has 6 bits at most.
656 if (next_port > sw->config.max_port_number)
658 if (tb_is_upstream_port(&sw->ports[next_port]))
660 if (!sw->ports[next_port].remote)
662 return get_switch_at_route(sw->ports[next_port].remote->sw,
663 route >> TB_ROUTE_SHIFT);
667 * tb_plug_events_active() - enable/disable plug events on a switch
669 * Also configures a sane plug_events_delay of 255ms.
671 * Return: Returns 0 on success or an error code on failure.
673 static int tb_plug_events_active(struct tb_switch *sw, bool active)
678 if (!sw->config.enabled)
681 sw->config.plug_events_delay = 0xff;
682 res = tb_sw_write(sw, ((u32 *) &sw->config) + 4, TB_CFG_SWITCH, 4, 1);
686 res = tb_sw_read(sw, &data, TB_CFG_SWITCH, sw->cap_plug_events + 1, 1);
691 data = data & 0xFFFFFF83;
692 switch (sw->config.device_id) {
693 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
694 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
695 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
703 return tb_sw_write(sw, &data, TB_CFG_SWITCH,
704 sw->cap_plug_events + 1, 1);
707 static ssize_t authorized_show(struct device *dev,
708 struct device_attribute *attr,
711 struct tb_switch *sw = tb_to_switch(dev);
713 return sprintf(buf, "%u\n", sw->authorized);
716 static int tb_switch_set_authorized(struct tb_switch *sw, unsigned int val)
720 if (mutex_lock_interruptible(&switch_lock))
727 * Make sure there is no PCIe rescan ongoing when a new PCIe
728 * tunnel is created. Otherwise the PCIe rescan code might find
729 * the new tunnel too early.
731 pci_lock_rescan_remove();
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 pci_unlock_rescan_remove();
755 sw->authorized = val;
756 /* Notify status change to the userspace */
757 kobject_uevent(&sw->dev.kobj, KOBJ_CHANGE);
761 mutex_unlock(&switch_lock);
765 static ssize_t authorized_store(struct device *dev,
766 struct device_attribute *attr,
767 const char *buf, size_t count)
769 struct tb_switch *sw = tb_to_switch(dev);
773 ret = kstrtouint(buf, 0, &val);
779 ret = tb_switch_set_authorized(sw, val);
781 return ret ? ret : count;
783 static DEVICE_ATTR_RW(authorized);
785 static ssize_t device_show(struct device *dev, struct device_attribute *attr,
788 struct tb_switch *sw = tb_to_switch(dev);
790 return sprintf(buf, "%#x\n", sw->device);
792 static DEVICE_ATTR_RO(device);
795 device_name_show(struct device *dev, struct device_attribute *attr, char *buf)
797 struct tb_switch *sw = tb_to_switch(dev);
799 return sprintf(buf, "%s\n", sw->device_name ? sw->device_name : "");
801 static DEVICE_ATTR_RO(device_name);
803 static ssize_t key_show(struct device *dev, struct device_attribute *attr,
806 struct tb_switch *sw = tb_to_switch(dev);
809 if (mutex_lock_interruptible(&switch_lock))
813 ret = sprintf(buf, "%*phN\n", TB_SWITCH_KEY_SIZE, sw->key);
815 ret = sprintf(buf, "\n");
817 mutex_unlock(&switch_lock);
821 static ssize_t key_store(struct device *dev, struct device_attribute *attr,
822 const char *buf, size_t count)
824 struct tb_switch *sw = tb_to_switch(dev);
825 u8 key[TB_SWITCH_KEY_SIZE];
829 if (!strcmp(buf, "\n"))
831 else if (hex2bin(key, buf, sizeof(key)))
834 if (mutex_lock_interruptible(&switch_lock))
837 if (sw->authorized) {
844 sw->key = kmemdup(key, sizeof(key), GFP_KERNEL);
850 mutex_unlock(&switch_lock);
853 static DEVICE_ATTR(key, 0600, key_show, key_store);
855 static ssize_t nvm_authenticate_show(struct device *dev,
856 struct device_attribute *attr, char *buf)
858 struct tb_switch *sw = tb_to_switch(dev);
861 nvm_get_auth_status(sw, &status);
862 return sprintf(buf, "%#x\n", status);
865 static ssize_t nvm_authenticate_store(struct device *dev,
866 struct device_attribute *attr, const char *buf, size_t count)
868 struct tb_switch *sw = tb_to_switch(dev);
872 if (mutex_lock_interruptible(&switch_lock))
875 /* If NVMem devices are not yet added */
881 ret = kstrtobool(buf, &val);
885 /* Always clear the authentication status */
886 nvm_clear_auth_status(sw);
889 ret = nvm_validate_and_write(sw);
893 sw->nvm->authenticating = true;
896 ret = nvm_authenticate_host(sw);
898 ret = nvm_authenticate_device(sw);
902 mutex_unlock(&switch_lock);
908 static DEVICE_ATTR_RW(nvm_authenticate);
910 static ssize_t nvm_version_show(struct device *dev,
911 struct device_attribute *attr, char *buf)
913 struct tb_switch *sw = tb_to_switch(dev);
916 if (mutex_lock_interruptible(&switch_lock))
924 ret = sprintf(buf, "%x.%x\n", sw->nvm->major, sw->nvm->minor);
926 mutex_unlock(&switch_lock);
930 static DEVICE_ATTR_RO(nvm_version);
932 static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
935 struct tb_switch *sw = tb_to_switch(dev);
937 return sprintf(buf, "%#x\n", sw->vendor);
939 static DEVICE_ATTR_RO(vendor);
942 vendor_name_show(struct device *dev, struct device_attribute *attr, char *buf)
944 struct tb_switch *sw = tb_to_switch(dev);
946 return sprintf(buf, "%s\n", sw->vendor_name ? sw->vendor_name : "");
948 static DEVICE_ATTR_RO(vendor_name);
950 static ssize_t unique_id_show(struct device *dev, struct device_attribute *attr,
953 struct tb_switch *sw = tb_to_switch(dev);
955 return sprintf(buf, "%pUb\n", sw->uuid);
957 static DEVICE_ATTR_RO(unique_id);
959 static struct attribute *switch_attrs[] = {
960 &dev_attr_authorized.attr,
961 &dev_attr_device.attr,
962 &dev_attr_device_name.attr,
964 &dev_attr_nvm_authenticate.attr,
965 &dev_attr_nvm_version.attr,
966 &dev_attr_vendor.attr,
967 &dev_attr_vendor_name.attr,
968 &dev_attr_unique_id.attr,
972 static umode_t switch_attr_is_visible(struct kobject *kobj,
973 struct attribute *attr, int n)
975 struct device *dev = container_of(kobj, struct device, kobj);
976 struct tb_switch *sw = tb_to_switch(dev);
978 if (attr == &dev_attr_key.attr) {
980 sw->tb->security_level == TB_SECURITY_SECURE &&
981 sw->security_level == TB_SECURITY_SECURE)
984 } else if (attr == &dev_attr_nvm_authenticate.attr ||
985 attr == &dev_attr_nvm_version.attr) {
991 return sw->safe_mode ? 0 : attr->mode;
994 static struct attribute_group switch_group = {
995 .is_visible = switch_attr_is_visible,
996 .attrs = switch_attrs,
999 static const struct attribute_group *switch_groups[] = {
1004 static void tb_switch_release(struct device *dev)
1006 struct tb_switch *sw = tb_to_switch(dev);
1008 dma_port_free(sw->dma_port);
1011 kfree(sw->device_name);
1012 kfree(sw->vendor_name);
1019 struct device_type tb_switch_type = {
1020 .name = "thunderbolt_device",
1021 .release = tb_switch_release,
1024 static int tb_switch_get_generation(struct tb_switch *sw)
1026 switch (sw->config.device_id) {
1027 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
1028 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
1029 case PCI_DEVICE_ID_INTEL_LIGHT_PEAK:
1030 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
1031 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
1032 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
1033 case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_2C_BRIDGE:
1034 case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_4C_BRIDGE:
1037 case PCI_DEVICE_ID_INTEL_WIN_RIDGE_2C_BRIDGE:
1038 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
1039 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
1042 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
1043 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
1044 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE:
1045 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
1046 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
1051 * For unknown switches assume generation to be 1 to be
1054 tb_sw_warn(sw, "unsupported switch device id %#x\n",
1055 sw->config.device_id);
1061 * tb_switch_alloc() - allocate a switch
1062 * @tb: Pointer to the owning domain
1063 * @parent: Parent device for this switch
1064 * @route: Route string for this switch
1066 * Allocates and initializes a switch. Will not upload configuration to
1067 * the switch. For that you need to call tb_switch_configure()
1068 * separately. The returned switch should be released by calling
1071 * Return: Pointer to the allocated switch or %NULL in case of failure
1073 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
1078 struct tb_switch *sw;
1079 int upstream_port = tb_cfg_get_upstream_port(tb->ctl, route);
1080 if (upstream_port < 0)
1083 sw = kzalloc(sizeof(*sw), GFP_KERNEL);
1088 if (tb_cfg_read(tb->ctl, &sw->config, route, 0, TB_CFG_SWITCH, 0, 5))
1089 goto err_free_sw_ports;
1091 tb_info(tb, "current switch config:\n");
1092 tb_dump_switch(tb, &sw->config);
1094 /* configure switch */
1095 sw->config.upstream_port_number = upstream_port;
1096 sw->config.depth = tb_route_length(route);
1097 sw->config.route_lo = route;
1098 sw->config.route_hi = route >> 32;
1099 sw->config.enabled = 0;
1101 /* initialize ports */
1102 sw->ports = kcalloc(sw->config.max_port_number + 1, sizeof(*sw->ports),
1105 goto err_free_sw_ports;
1107 for (i = 0; i <= sw->config.max_port_number; i++) {
1108 /* minimum setup for tb_find_cap and tb_drom_read to work */
1109 sw->ports[i].sw = sw;
1110 sw->ports[i].port = i;
1113 sw->generation = tb_switch_get_generation(sw);
1115 cap = tb_switch_find_vse_cap(sw, TB_VSE_CAP_PLUG_EVENTS);
1117 tb_sw_warn(sw, "cannot find TB_VSE_CAP_PLUG_EVENTS aborting\n");
1118 goto err_free_sw_ports;
1120 sw->cap_plug_events = cap;
1122 /* Root switch is always authorized */
1124 sw->authorized = true;
1126 device_initialize(&sw->dev);
1127 sw->dev.parent = parent;
1128 sw->dev.bus = &tb_bus_type;
1129 sw->dev.type = &tb_switch_type;
1130 sw->dev.groups = switch_groups;
1131 dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
1143 * tb_switch_alloc_safe_mode() - allocate a switch that is in safe mode
1144 * @tb: Pointer to the owning domain
1145 * @parent: Parent device for this switch
1146 * @route: Route string for this switch
1148 * This creates a switch in safe mode. This means the switch pretty much
1149 * lacks all capabilities except DMA configuration port before it is
1150 * flashed with a valid NVM firmware.
1152 * The returned switch must be released by calling tb_switch_put().
1154 * Return: Pointer to the allocated switch or %NULL in case of failure
1157 tb_switch_alloc_safe_mode(struct tb *tb, struct device *parent, u64 route)
1159 struct tb_switch *sw;
1161 sw = kzalloc(sizeof(*sw), GFP_KERNEL);
1166 sw->config.depth = tb_route_length(route);
1167 sw->config.route_hi = upper_32_bits(route);
1168 sw->config.route_lo = lower_32_bits(route);
1169 sw->safe_mode = true;
1171 device_initialize(&sw->dev);
1172 sw->dev.parent = parent;
1173 sw->dev.bus = &tb_bus_type;
1174 sw->dev.type = &tb_switch_type;
1175 sw->dev.groups = switch_groups;
1176 dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
1182 * tb_switch_configure() - Uploads configuration to the switch
1183 * @sw: Switch to configure
1185 * Call this function before the switch is added to the system. It will
1186 * upload configuration to the switch and makes it available for the
1187 * connection manager to use.
1189 * Return: %0 in case of success and negative errno in case of failure
1191 int tb_switch_configure(struct tb_switch *sw)
1193 struct tb *tb = sw->tb;
1197 route = tb_route(sw);
1199 "initializing Switch at %#llx (depth: %d, up port: %d)\n",
1200 route, tb_route_length(route), sw->config.upstream_port_number);
1202 if (sw->config.vendor_id != PCI_VENDOR_ID_INTEL)
1203 tb_sw_warn(sw, "unknown switch vendor id %#x\n",
1204 sw->config.vendor_id);
1206 sw->config.enabled = 1;
1208 /* upload configuration */
1209 ret = tb_sw_write(sw, 1 + (u32 *)&sw->config, TB_CFG_SWITCH, 1, 3);
1213 return tb_plug_events_active(sw, true);
1216 static int tb_switch_set_uuid(struct tb_switch *sw)
1226 * The newer controllers include fused UUID as part of link
1227 * controller specific registers
1229 cap = tb_switch_find_vse_cap(sw, TB_VSE_CAP_LINK_CONTROLLER);
1231 ret = tb_sw_read(sw, uuid, TB_CFG_SWITCH, cap + 3, 4);
1236 * ICM generates UUID based on UID and fills the upper
1237 * two words with ones. This is not strictly following
1238 * UUID format but we want to be compatible with it so
1239 * we do the same here.
1241 uuid[0] = sw->uid & 0xffffffff;
1242 uuid[1] = (sw->uid >> 32) & 0xffffffff;
1243 uuid[2] = 0xffffffff;
1244 uuid[3] = 0xffffffff;
1247 sw->uuid = kmemdup(uuid, sizeof(uuid), GFP_KERNEL);
1253 static int tb_switch_add_dma_port(struct tb_switch *sw)
1258 switch (sw->generation) {
1263 /* Only root switch can be upgraded */
1270 * DMA port is the only thing available when the switch
1278 if (sw->no_nvm_upgrade)
1281 sw->dma_port = dma_port_alloc(sw);
1286 * Check status of the previous flash authentication. If there
1287 * is one we need to power cycle the switch in any case to make
1288 * it functional again.
1290 ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
1295 tb_sw_info(sw, "switch flash authentication failed\n");
1296 ret = tb_switch_set_uuid(sw);
1299 nvm_set_auth_status(sw, status);
1302 tb_sw_info(sw, "power cycling the switch now\n");
1303 dma_port_power_cycle(sw->dma_port);
1306 * We return error here which causes the switch adding failure.
1307 * It should appear back after power cycle is complete.
1313 * tb_switch_add() - Add a switch to the domain
1314 * @sw: Switch to add
1316 * This is the last step in adding switch to the domain. It will read
1317 * identification information from DROM and initializes ports so that
1318 * they can be used to connect other switches. The switch will be
1319 * exposed to the userspace when this function successfully returns. To
1320 * remove and release the switch, call tb_switch_remove().
1322 * Return: %0 in case of success and negative errno in case of failure
1324 int tb_switch_add(struct tb_switch *sw)
1329 * Initialize DMA control port now before we read DROM. Recent
1330 * host controllers have more complete DROM on NVM that includes
1331 * vendor and model identification strings which we then expose
1332 * to the userspace. NVM can be accessed through DMA
1333 * configuration based mailbox.
1335 ret = tb_switch_add_dma_port(sw);
1339 if (!sw->safe_mode) {
1341 ret = tb_drom_read(sw);
1343 tb_sw_warn(sw, "tb_eeprom_read_rom failed\n");
1346 tb_sw_info(sw, "uid: %#llx\n", sw->uid);
1348 ret = tb_switch_set_uuid(sw);
1352 for (i = 0; i <= sw->config.max_port_number; i++) {
1353 if (sw->ports[i].disabled) {
1354 tb_port_info(&sw->ports[i], "disabled by eeprom\n");
1357 ret = tb_init_port(&sw->ports[i]);
1363 ret = device_add(&sw->dev);
1367 ret = tb_switch_nvm_add(sw);
1369 device_del(&sw->dev);
1375 * tb_switch_remove() - Remove and release a switch
1376 * @sw: Switch to remove
1378 * This will remove the switch from the domain and release it after last
1379 * reference count drops to zero. If there are switches connected below
1380 * this switch, they will be removed as well.
1382 void tb_switch_remove(struct tb_switch *sw)
1386 /* port 0 is the switch itself and never has a remote */
1387 for (i = 1; i <= sw->config.max_port_number; i++) {
1388 if (tb_is_upstream_port(&sw->ports[i]))
1390 if (sw->ports[i].remote)
1391 tb_switch_remove(sw->ports[i].remote->sw);
1392 sw->ports[i].remote = NULL;
1395 if (!sw->is_unplugged)
1396 tb_plug_events_active(sw, false);
1398 tb_switch_nvm_remove(sw);
1399 device_unregister(&sw->dev);
1403 * tb_sw_set_unplugged() - set is_unplugged on switch and downstream switches
1405 void tb_sw_set_unplugged(struct tb_switch *sw)
1408 if (sw == sw->tb->root_switch) {
1409 tb_sw_WARN(sw, "cannot unplug root switch\n");
1412 if (sw->is_unplugged) {
1413 tb_sw_WARN(sw, "is_unplugged already set\n");
1416 sw->is_unplugged = true;
1417 for (i = 0; i <= sw->config.max_port_number; i++) {
1418 if (!tb_is_upstream_port(&sw->ports[i]) && sw->ports[i].remote)
1419 tb_sw_set_unplugged(sw->ports[i].remote->sw);
1423 int tb_switch_resume(struct tb_switch *sw)
1426 tb_sw_info(sw, "resuming switch\n");
1429 * Check for UID of the connected switches except for root
1430 * switch which we assume cannot be removed.
1435 err = tb_drom_read_uid_only(sw, &uid);
1437 tb_sw_warn(sw, "uid read failed\n");
1440 if (sw->uid != uid) {
1442 "changed while suspended (uid %#llx -> %#llx)\n",
1448 /* upload configuration */
1449 err = tb_sw_write(sw, 1 + (u32 *) &sw->config, TB_CFG_SWITCH, 1, 3);
1453 err = tb_plug_events_active(sw, true);
1457 /* check for surviving downstream switches */
1458 for (i = 1; i <= sw->config.max_port_number; i++) {
1459 struct tb_port *port = &sw->ports[i];
1460 if (tb_is_upstream_port(port))
1464 if (tb_wait_for_port(port, true) <= 0
1465 || tb_switch_resume(port->remote->sw)) {
1467 "lost during suspend, disconnecting\n");
1468 tb_sw_set_unplugged(port->remote->sw);
1474 void tb_switch_suspend(struct tb_switch *sw)
1477 err = tb_plug_events_active(sw, false);
1481 for (i = 1; i <= sw->config.max_port_number; i++) {
1482 if (!tb_is_upstream_port(&sw->ports[i]) && sw->ports[i].remote)
1483 tb_switch_suspend(sw->ports[i].remote->sw);
1486 * TODO: invoke tb_cfg_prepare_to_sleep here? does not seem to have any
1491 struct tb_sw_lookup {
1498 static int tb_switch_match(struct device *dev, void *data)
1500 struct tb_switch *sw = tb_to_switch(dev);
1501 struct tb_sw_lookup *lookup = data;
1505 if (sw->tb != lookup->tb)
1509 return !memcmp(sw->uuid, lookup->uuid, sizeof(*lookup->uuid));
1511 /* Root switch is matched only by depth */
1515 return sw->link == lookup->link && sw->depth == lookup->depth;
1519 * tb_switch_find_by_link_depth() - Find switch by link and depth
1520 * @tb: Domain the switch belongs
1521 * @link: Link number the switch is connected
1522 * @depth: Depth of the switch in link
1524 * Returned switch has reference count increased so the caller needs to
1525 * call tb_switch_put() when done with the switch.
1527 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link, u8 depth)
1529 struct tb_sw_lookup lookup;
1532 memset(&lookup, 0, sizeof(lookup));
1535 lookup.depth = depth;
1537 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
1539 return tb_to_switch(dev);
1545 * tb_switch_find_by_link_depth() - Find switch by UUID
1546 * @tb: Domain the switch belongs
1547 * @uuid: UUID to look for
1549 * Returned switch has reference count increased so the caller needs to
1550 * call tb_switch_put() when done with the switch.
1552 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid)
1554 struct tb_sw_lookup lookup;
1557 memset(&lookup, 0, sizeof(lookup));
1561 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
1563 return tb_to_switch(dev);
1568 void tb_switch_exit(void)
1570 ida_destroy(&nvm_ida);