1 // SPDX-License-Identifier: GPL-2.0
3 * Thunderbolt driver - switch/port utility functions
5 * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
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/sched/signal.h>
14 #include <linux/sizes.h>
15 #include <linux/slab.h>
19 /* Switch NVM support */
23 struct nvm_auth_status {
24 struct list_head list;
30 WRITE_AND_AUTHENTICATE = 1,
35 * Hold NVM authentication failure status per switch This information
36 * needs to stay around even when the switch gets power cycled so we
39 static LIST_HEAD(nvm_auth_status_cache);
40 static DEFINE_MUTEX(nvm_auth_status_lock);
42 static struct nvm_auth_status *__nvm_get_auth_status(const struct tb_switch *sw)
44 struct nvm_auth_status *st;
46 list_for_each_entry(st, &nvm_auth_status_cache, list) {
47 if (uuid_equal(&st->uuid, sw->uuid))
54 static void nvm_get_auth_status(const struct tb_switch *sw, u32 *status)
56 struct nvm_auth_status *st;
58 mutex_lock(&nvm_auth_status_lock);
59 st = __nvm_get_auth_status(sw);
60 mutex_unlock(&nvm_auth_status_lock);
62 *status = st ? st->status : 0;
65 static void nvm_set_auth_status(const struct tb_switch *sw, u32 status)
67 struct nvm_auth_status *st;
69 if (WARN_ON(!sw->uuid))
72 mutex_lock(&nvm_auth_status_lock);
73 st = __nvm_get_auth_status(sw);
76 st = kzalloc(sizeof(*st), GFP_KERNEL);
80 memcpy(&st->uuid, sw->uuid, sizeof(st->uuid));
81 INIT_LIST_HEAD(&st->list);
82 list_add_tail(&st->list, &nvm_auth_status_cache);
87 mutex_unlock(&nvm_auth_status_lock);
90 static void nvm_clear_auth_status(const struct tb_switch *sw)
92 struct nvm_auth_status *st;
94 mutex_lock(&nvm_auth_status_lock);
95 st = __nvm_get_auth_status(sw);
100 mutex_unlock(&nvm_auth_status_lock);
103 static int nvm_validate_and_write(struct tb_switch *sw)
105 unsigned int image_size, hdr_size;
106 const u8 *buf = sw->nvm->buf;
113 image_size = sw->nvm->buf_data_size;
114 if (image_size < NVM_MIN_SIZE || image_size > NVM_MAX_SIZE)
118 * FARB pointer must point inside the image and must at least
119 * contain parts of the digital section we will be reading here.
121 hdr_size = (*(u32 *)buf) & 0xffffff;
122 if (hdr_size + NVM_DEVID + 2 >= image_size)
125 /* Digital section start should be aligned to 4k page */
126 if (!IS_ALIGNED(hdr_size, SZ_4K))
130 * Read digital section size and check that it also fits inside
133 ds_size = *(u16 *)(buf + hdr_size);
134 if (ds_size >= image_size)
137 if (!sw->safe_mode) {
141 * Make sure the device ID in the image matches the one
142 * we read from the switch config space.
144 device_id = *(u16 *)(buf + hdr_size + NVM_DEVID);
145 if (device_id != sw->config.device_id)
148 if (sw->generation < 3) {
149 /* Write CSS headers first */
150 ret = dma_port_flash_write(sw->dma_port,
151 DMA_PORT_CSS_ADDRESS, buf + NVM_CSS,
152 DMA_PORT_CSS_MAX_SIZE);
157 /* Skip headers in the image */
159 image_size -= hdr_size;
162 if (tb_switch_is_usb4(sw))
163 ret = usb4_switch_nvm_write(sw, 0, buf, image_size);
165 ret = dma_port_flash_write(sw->dma_port, 0, buf, image_size);
167 sw->nvm->flushed = true;
171 static int nvm_authenticate_host_dma_port(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) {
183 ret = tb_domain_disconnect_all_paths(sw->tb);
187 * The host controller goes away pretty soon after this if
188 * everything goes well so getting timeout is expected.
190 ret = dma_port_flash_update_auth(sw->dma_port);
191 if (!ret || ret == -ETIMEDOUT)
195 * Any error from update auth operation requires power
196 * cycling of the host router.
198 tb_sw_warn(sw, "failed to authenticate NVM, power cycling\n");
199 if (dma_port_flash_update_auth_status(sw->dma_port, &status) > 0)
200 nvm_set_auth_status(sw, status);
204 * From safe mode we can get out by just power cycling the
207 dma_port_power_cycle(sw->dma_port);
211 static int nvm_authenticate_device_dma_port(struct tb_switch *sw)
213 int ret, retries = 10;
215 ret = dma_port_flash_update_auth(sw->dma_port);
221 /* Power cycle is required */
228 * Poll here for the authentication status. It takes some time
229 * for the device to respond (we get timeout for a while). Once
230 * we get response the device needs to be power cycled in order
231 * to the new NVM to be taken into use.
236 ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
237 if (ret < 0 && ret != -ETIMEDOUT)
241 tb_sw_warn(sw, "failed to authenticate NVM\n");
242 nvm_set_auth_status(sw, status);
245 tb_sw_info(sw, "power cycling the switch now\n");
246 dma_port_power_cycle(sw->dma_port);
256 static void nvm_authenticate_start_dma_port(struct tb_switch *sw)
258 struct pci_dev *root_port;
261 * During host router NVM upgrade we should not allow root port to
262 * go into D3cold because some root ports cannot trigger PME
263 * itself. To be on the safe side keep the root port in D0 during
264 * the whole upgrade process.
266 root_port = pcie_find_root_port(sw->tb->nhi->pdev);
268 pm_runtime_get_noresume(&root_port->dev);
271 static void nvm_authenticate_complete_dma_port(struct tb_switch *sw)
273 struct pci_dev *root_port;
275 root_port = pcie_find_root_port(sw->tb->nhi->pdev);
277 pm_runtime_put(&root_port->dev);
280 static inline bool nvm_readable(struct tb_switch *sw)
282 if (tb_switch_is_usb4(sw)) {
284 * USB4 devices must support NVM operations but it is
285 * optional for hosts. Therefore we query the NVM sector
286 * size here and if it is supported assume NVM
287 * operations are implemented.
289 return usb4_switch_nvm_sector_size(sw) > 0;
292 /* Thunderbolt 2 and 3 devices support NVM through DMA port */
293 return !!sw->dma_port;
296 static inline bool nvm_upgradeable(struct tb_switch *sw)
298 if (sw->no_nvm_upgrade)
300 return nvm_readable(sw);
303 static inline int nvm_read(struct tb_switch *sw, unsigned int address,
304 void *buf, size_t size)
306 if (tb_switch_is_usb4(sw))
307 return usb4_switch_nvm_read(sw, address, buf, size);
308 return dma_port_flash_read(sw->dma_port, address, buf, size);
311 static int nvm_authenticate(struct tb_switch *sw)
315 if (tb_switch_is_usb4(sw))
316 return usb4_switch_nvm_authenticate(sw);
319 nvm_authenticate_start_dma_port(sw);
320 ret = nvm_authenticate_host_dma_port(sw);
322 ret = nvm_authenticate_device_dma_port(sw);
328 static int tb_switch_nvm_read(void *priv, unsigned int offset, void *val,
331 struct tb_nvm *nvm = priv;
332 struct tb_switch *sw = tb_to_switch(nvm->dev);
335 pm_runtime_get_sync(&sw->dev);
337 if (!mutex_trylock(&sw->tb->lock)) {
338 ret = restart_syscall();
342 ret = nvm_read(sw, offset, val, bytes);
343 mutex_unlock(&sw->tb->lock);
346 pm_runtime_mark_last_busy(&sw->dev);
347 pm_runtime_put_autosuspend(&sw->dev);
352 static int tb_switch_nvm_write(void *priv, unsigned int offset, void *val,
355 struct tb_nvm *nvm = priv;
356 struct tb_switch *sw = tb_to_switch(nvm->dev);
359 if (!mutex_trylock(&sw->tb->lock))
360 return restart_syscall();
363 * Since writing the NVM image might require some special steps,
364 * for example when CSS headers are written, we cache the image
365 * locally here and handle the special cases when the user asks
366 * us to authenticate the image.
368 ret = tb_nvm_write_buf(nvm, offset, val, bytes);
369 mutex_unlock(&sw->tb->lock);
374 static int tb_switch_nvm_add(struct tb_switch *sw)
380 if (!nvm_readable(sw))
384 * The NVM format of non-Intel hardware is not known so
385 * currently restrict NVM upgrade for Intel hardware. We may
386 * relax this in the future when we learn other NVM formats.
388 if (sw->config.vendor_id != PCI_VENDOR_ID_INTEL &&
389 sw->config.vendor_id != 0x8087) {
391 "NVM format of vendor %#x is not known, disabling NVM upgrade\n",
392 sw->config.vendor_id);
396 nvm = tb_nvm_alloc(&sw->dev);
401 * If the switch is in safe-mode the only accessible portion of
402 * the NVM is the non-active one where userspace is expected to
403 * write new functional NVM.
405 if (!sw->safe_mode) {
406 u32 nvm_size, hdr_size;
408 ret = nvm_read(sw, NVM_FLASH_SIZE, &val, sizeof(val));
412 hdr_size = sw->generation < 3 ? SZ_8K : SZ_16K;
413 nvm_size = (SZ_1M << (val & 7)) / 8;
414 nvm_size = (nvm_size - hdr_size) / 2;
416 ret = nvm_read(sw, NVM_VERSION, &val, sizeof(val));
420 nvm->major = val >> 16;
421 nvm->minor = val >> 8;
423 ret = tb_nvm_add_active(nvm, nvm_size, tb_switch_nvm_read);
428 if (!sw->no_nvm_upgrade) {
429 ret = tb_nvm_add_non_active(nvm, NVM_MAX_SIZE,
430 tb_switch_nvm_write);
443 static void tb_switch_nvm_remove(struct tb_switch *sw)
453 /* Remove authentication status in case the switch is unplugged */
454 if (!nvm->authenticating)
455 nvm_clear_auth_status(sw);
460 /* port utility functions */
462 static const char *tb_port_type(struct tb_regs_port_header *port)
464 switch (port->type >> 16) {
466 switch ((u8) port->type) {
491 static void tb_dump_port(struct tb *tb, struct tb_regs_port_header *port)
494 " Port %d: %x:%x (Revision: %d, TB Version: %d, Type: %s (%#x))\n",
495 port->port_number, port->vendor_id, port->device_id,
496 port->revision, port->thunderbolt_version, tb_port_type(port),
498 tb_dbg(tb, " Max hop id (in/out): %d/%d\n",
499 port->max_in_hop_id, port->max_out_hop_id);
500 tb_dbg(tb, " Max counters: %d\n", port->max_counters);
501 tb_dbg(tb, " NFC Credits: %#x\n", port->nfc_credits);
505 * tb_port_state() - get connectedness state of a port
507 * The port must have a TB_CAP_PHY (i.e. it should be a real port).
509 * Return: Returns an enum tb_port_state on success or an error code on failure.
511 static int tb_port_state(struct tb_port *port)
513 struct tb_cap_phy phy;
515 if (port->cap_phy == 0) {
516 tb_port_WARN(port, "does not have a PHY\n");
519 res = tb_port_read(port, &phy, TB_CFG_PORT, port->cap_phy, 2);
526 * tb_wait_for_port() - wait for a port to become ready
528 * Wait up to 1 second for a port to reach state TB_PORT_UP. If
529 * wait_if_unplugged is set then we also wait if the port is in state
530 * TB_PORT_UNPLUGGED (it takes a while for the device to be registered after
531 * switch resume). Otherwise we only wait if a device is registered but the link
532 * has not yet been established.
534 * Return: Returns an error code on failure. Returns 0 if the port is not
535 * connected or failed to reach state TB_PORT_UP within one second. Returns 1
536 * if the port is connected and in state TB_PORT_UP.
538 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged)
542 if (!port->cap_phy) {
543 tb_port_WARN(port, "does not have PHY\n");
546 if (tb_is_upstream_port(port)) {
547 tb_port_WARN(port, "is the upstream port\n");
552 state = tb_port_state(port);
555 if (state == TB_PORT_DISABLED) {
556 tb_port_dbg(port, "is disabled (state: 0)\n");
559 if (state == TB_PORT_UNPLUGGED) {
560 if (wait_if_unplugged) {
561 /* used during resume */
563 "is unplugged (state: 7), retrying...\n");
567 tb_port_dbg(port, "is unplugged (state: 7)\n");
570 if (state == TB_PORT_UP) {
571 tb_port_dbg(port, "is connected, link is up (state: 2)\n");
576 * After plug-in the state is TB_PORT_CONNECTING. Give it some
580 "is connected, link is not up (state: %d), retrying...\n",
585 "failed to reach state TB_PORT_UP. Ignoring port...\n");
590 * tb_port_add_nfc_credits() - add/remove non flow controlled credits to port
592 * Change the number of NFC credits allocated to @port by @credits. To remove
593 * NFC credits pass a negative amount of credits.
595 * Return: Returns 0 on success or an error code on failure.
597 int tb_port_add_nfc_credits(struct tb_port *port, int credits)
601 if (credits == 0 || port->sw->is_unplugged)
604 nfc_credits = port->config.nfc_credits & ADP_CS_4_NFC_BUFFERS_MASK;
605 nfc_credits += credits;
607 tb_port_dbg(port, "adding %d NFC credits to %lu", credits,
608 port->config.nfc_credits & ADP_CS_4_NFC_BUFFERS_MASK);
610 port->config.nfc_credits &= ~ADP_CS_4_NFC_BUFFERS_MASK;
611 port->config.nfc_credits |= nfc_credits;
613 return tb_port_write(port, &port->config.nfc_credits,
614 TB_CFG_PORT, ADP_CS_4, 1);
618 * tb_port_set_initial_credits() - Set initial port link credits allocated
619 * @port: Port to set the initial credits
620 * @credits: Number of credits to to allocate
622 * Set initial credits value to be used for ingress shared buffering.
624 int tb_port_set_initial_credits(struct tb_port *port, u32 credits)
629 ret = tb_port_read(port, &data, TB_CFG_PORT, ADP_CS_5, 1);
633 data &= ~ADP_CS_5_LCA_MASK;
634 data |= (credits << ADP_CS_5_LCA_SHIFT) & ADP_CS_5_LCA_MASK;
636 return tb_port_write(port, &data, TB_CFG_PORT, ADP_CS_5, 1);
640 * tb_port_clear_counter() - clear a counter in TB_CFG_COUNTER
642 * Return: Returns 0 on success or an error code on failure.
644 int tb_port_clear_counter(struct tb_port *port, int counter)
646 u32 zero[3] = { 0, 0, 0 };
647 tb_port_dbg(port, "clearing counter %d\n", counter);
648 return tb_port_write(port, zero, TB_CFG_COUNTERS, 3 * counter, 3);
652 * tb_port_unlock() - Unlock downstream port
653 * @port: Port to unlock
655 * Needed for USB4 but can be called for any CIO/USB4 ports. Makes the
656 * downstream router accessible for CM.
658 int tb_port_unlock(struct tb_port *port)
660 if (tb_switch_is_icm(port->sw))
662 if (!tb_port_is_null(port))
664 if (tb_switch_is_usb4(port->sw))
665 return usb4_port_unlock(port);
670 * tb_init_port() - initialize a port
672 * This is a helper method for tb_switch_alloc. Does not check or initialize
673 * any downstream switches.
675 * Return: Returns 0 on success or an error code on failure.
677 static int tb_init_port(struct tb_port *port)
682 res = tb_port_read(port, &port->config, TB_CFG_PORT, 0, 8);
684 if (res == -ENODEV) {
685 tb_dbg(port->sw->tb, " Port %d: not implemented\n",
687 port->disabled = true;
693 /* Port 0 is the switch itself and has no PHY. */
694 if (port->config.type == TB_TYPE_PORT && port->port != 0) {
695 cap = tb_port_find_cap(port, TB_PORT_CAP_PHY);
700 tb_port_WARN(port, "non switch port without a PHY\n");
702 cap = tb_port_find_cap(port, TB_PORT_CAP_USB4);
704 port->cap_usb4 = cap;
705 } else if (port->port != 0) {
706 cap = tb_port_find_cap(port, TB_PORT_CAP_ADAP);
708 port->cap_adap = cap;
711 tb_dump_port(port->sw->tb, &port->config);
713 /* Control port does not need HopID allocation */
715 ida_init(&port->in_hopids);
716 ida_init(&port->out_hopids);
719 INIT_LIST_HEAD(&port->list);
724 static int tb_port_alloc_hopid(struct tb_port *port, bool in, int min_hopid,
731 port_max_hopid = port->config.max_in_hop_id;
732 ida = &port->in_hopids;
734 port_max_hopid = port->config.max_out_hop_id;
735 ida = &port->out_hopids;
739 * NHI can use HopIDs 1-max for other adapters HopIDs 0-7 are
742 if (port->config.type != TB_TYPE_NHI && min_hopid < TB_PATH_MIN_HOPID)
743 min_hopid = TB_PATH_MIN_HOPID;
745 if (max_hopid < 0 || max_hopid > port_max_hopid)
746 max_hopid = port_max_hopid;
748 return ida_simple_get(ida, min_hopid, max_hopid + 1, GFP_KERNEL);
752 * tb_port_alloc_in_hopid() - Allocate input HopID from port
753 * @port: Port to allocate HopID for
754 * @min_hopid: Minimum acceptable input HopID
755 * @max_hopid: Maximum acceptable input HopID
757 * Return: HopID between @min_hopid and @max_hopid or negative errno in
760 int tb_port_alloc_in_hopid(struct tb_port *port, int min_hopid, int max_hopid)
762 return tb_port_alloc_hopid(port, true, min_hopid, max_hopid);
766 * tb_port_alloc_out_hopid() - Allocate output HopID from port
767 * @port: Port to allocate HopID for
768 * @min_hopid: Minimum acceptable output HopID
769 * @max_hopid: Maximum acceptable output HopID
771 * Return: HopID between @min_hopid and @max_hopid or negative errno in
774 int tb_port_alloc_out_hopid(struct tb_port *port, int min_hopid, int max_hopid)
776 return tb_port_alloc_hopid(port, false, min_hopid, max_hopid);
780 * tb_port_release_in_hopid() - Release allocated input HopID from port
781 * @port: Port whose HopID to release
782 * @hopid: HopID to release
784 void tb_port_release_in_hopid(struct tb_port *port, int hopid)
786 ida_simple_remove(&port->in_hopids, hopid);
790 * tb_port_release_out_hopid() - Release allocated output HopID from port
791 * @port: Port whose HopID to release
792 * @hopid: HopID to release
794 void tb_port_release_out_hopid(struct tb_port *port, int hopid)
796 ida_simple_remove(&port->out_hopids, hopid);
799 static inline bool tb_switch_is_reachable(const struct tb_switch *parent,
800 const struct tb_switch *sw)
802 u64 mask = (1ULL << parent->config.depth * 8) - 1;
803 return (tb_route(parent) & mask) == (tb_route(sw) & mask);
807 * tb_next_port_on_path() - Return next port for given port on a path
808 * @start: Start port of the walk
809 * @end: End port of the walk
810 * @prev: Previous port (%NULL if this is the first)
812 * This function can be used to walk from one port to another if they
813 * are connected through zero or more switches. If the @prev is dual
814 * link port, the function follows that link and returns another end on
817 * If the @end port has been reached, return %NULL.
819 * Domain tb->lock must be held when this function is called.
821 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
822 struct tb_port *prev)
824 struct tb_port *next;
829 if (prev->sw == end->sw) {
835 if (tb_switch_is_reachable(prev->sw, end->sw)) {
836 next = tb_port_at(tb_route(end->sw), prev->sw);
837 /* Walk down the topology if next == prev */
839 (next == prev || next->dual_link_port == prev))
842 if (tb_is_upstream_port(prev)) {
845 next = tb_upstream_port(prev->sw);
847 * Keep the same link if prev and next are both
850 if (next->dual_link_port &&
851 next->link_nr != prev->link_nr) {
852 next = next->dual_link_port;
857 return next != prev ? next : NULL;
861 * tb_port_get_link_speed() - Get current link speed
862 * @port: Port to check (USB4 or CIO)
864 * Returns link speed in Gb/s or negative errno in case of failure.
866 int tb_port_get_link_speed(struct tb_port *port)
874 ret = tb_port_read(port, &val, TB_CFG_PORT,
875 port->cap_phy + LANE_ADP_CS_1, 1);
879 speed = (val & LANE_ADP_CS_1_CURRENT_SPEED_MASK) >>
880 LANE_ADP_CS_1_CURRENT_SPEED_SHIFT;
881 return speed == LANE_ADP_CS_1_CURRENT_SPEED_GEN3 ? 20 : 10;
884 static int tb_port_get_link_width(struct tb_port *port)
892 ret = tb_port_read(port, &val, TB_CFG_PORT,
893 port->cap_phy + LANE_ADP_CS_1, 1);
897 return (val & LANE_ADP_CS_1_CURRENT_WIDTH_MASK) >>
898 LANE_ADP_CS_1_CURRENT_WIDTH_SHIFT;
901 static bool tb_port_is_width_supported(struct tb_port *port, int width)
909 ret = tb_port_read(port, &phy, TB_CFG_PORT,
910 port->cap_phy + LANE_ADP_CS_0, 1);
914 widths = (phy & LANE_ADP_CS_0_SUPPORTED_WIDTH_MASK) >>
915 LANE_ADP_CS_0_SUPPORTED_WIDTH_SHIFT;
917 return !!(widths & width);
920 static int tb_port_set_link_width(struct tb_port *port, unsigned int width)
928 ret = tb_port_read(port, &val, TB_CFG_PORT,
929 port->cap_phy + LANE_ADP_CS_1, 1);
933 val &= ~LANE_ADP_CS_1_TARGET_WIDTH_MASK;
936 val |= LANE_ADP_CS_1_TARGET_WIDTH_SINGLE <<
937 LANE_ADP_CS_1_TARGET_WIDTH_SHIFT;
940 val |= LANE_ADP_CS_1_TARGET_WIDTH_DUAL <<
941 LANE_ADP_CS_1_TARGET_WIDTH_SHIFT;
947 val |= LANE_ADP_CS_1_LB;
949 return tb_port_write(port, &val, TB_CFG_PORT,
950 port->cap_phy + LANE_ADP_CS_1, 1);
953 static int tb_port_lane_bonding_enable(struct tb_port *port)
958 * Enable lane bonding for both links if not already enabled by
959 * for example the boot firmware.
961 ret = tb_port_get_link_width(port);
963 ret = tb_port_set_link_width(port, 2);
968 ret = tb_port_get_link_width(port->dual_link_port);
970 ret = tb_port_set_link_width(port->dual_link_port, 2);
972 tb_port_set_link_width(port, 1);
978 port->dual_link_port->bonded = true;
983 static void tb_port_lane_bonding_disable(struct tb_port *port)
985 port->dual_link_port->bonded = false;
986 port->bonded = false;
988 tb_port_set_link_width(port->dual_link_port, 1);
989 tb_port_set_link_width(port, 1);
993 * tb_port_is_enabled() - Is the adapter port enabled
994 * @port: Port to check
996 bool tb_port_is_enabled(struct tb_port *port)
998 switch (port->config.type) {
999 case TB_TYPE_PCIE_UP:
1000 case TB_TYPE_PCIE_DOWN:
1001 return tb_pci_port_is_enabled(port);
1003 case TB_TYPE_DP_HDMI_IN:
1004 case TB_TYPE_DP_HDMI_OUT:
1005 return tb_dp_port_is_enabled(port);
1007 case TB_TYPE_USB3_UP:
1008 case TB_TYPE_USB3_DOWN:
1009 return tb_usb3_port_is_enabled(port);
1017 * tb_usb3_port_is_enabled() - Is the USB3 adapter port enabled
1018 * @port: USB3 adapter port to check
1020 bool tb_usb3_port_is_enabled(struct tb_port *port)
1024 if (tb_port_read(port, &data, TB_CFG_PORT,
1025 port->cap_adap + ADP_USB3_CS_0, 1))
1028 return !!(data & ADP_USB3_CS_0_PE);
1032 * tb_usb3_port_enable() - Enable USB3 adapter port
1033 * @port: USB3 adapter port to enable
1034 * @enable: Enable/disable the USB3 adapter
1036 int tb_usb3_port_enable(struct tb_port *port, bool enable)
1038 u32 word = enable ? (ADP_USB3_CS_0_PE | ADP_USB3_CS_0_V)
1041 if (!port->cap_adap)
1043 return tb_port_write(port, &word, TB_CFG_PORT,
1044 port->cap_adap + ADP_USB3_CS_0, 1);
1048 * tb_pci_port_is_enabled() - Is the PCIe adapter port enabled
1049 * @port: PCIe port to check
1051 bool tb_pci_port_is_enabled(struct tb_port *port)
1055 if (tb_port_read(port, &data, TB_CFG_PORT,
1056 port->cap_adap + ADP_PCIE_CS_0, 1))
1059 return !!(data & ADP_PCIE_CS_0_PE);
1063 * tb_pci_port_enable() - Enable PCIe adapter port
1064 * @port: PCIe port to enable
1065 * @enable: Enable/disable the PCIe adapter
1067 int tb_pci_port_enable(struct tb_port *port, bool enable)
1069 u32 word = enable ? ADP_PCIE_CS_0_PE : 0x0;
1070 if (!port->cap_adap)
1072 return tb_port_write(port, &word, TB_CFG_PORT,
1073 port->cap_adap + ADP_PCIE_CS_0, 1);
1077 * tb_dp_port_hpd_is_active() - Is HPD already active
1078 * @port: DP out port to check
1080 * Checks if the DP OUT adapter port has HDP bit already set.
1082 int tb_dp_port_hpd_is_active(struct tb_port *port)
1087 ret = tb_port_read(port, &data, TB_CFG_PORT,
1088 port->cap_adap + ADP_DP_CS_2, 1);
1092 return !!(data & ADP_DP_CS_2_HDP);
1096 * tb_dp_port_hpd_clear() - Clear HPD from DP IN port
1097 * @port: Port to clear HPD
1099 * If the DP IN port has HDP set, this function can be used to clear it.
1101 int tb_dp_port_hpd_clear(struct tb_port *port)
1106 ret = tb_port_read(port, &data, TB_CFG_PORT,
1107 port->cap_adap + ADP_DP_CS_3, 1);
1111 data |= ADP_DP_CS_3_HDPC;
1112 return tb_port_write(port, &data, TB_CFG_PORT,
1113 port->cap_adap + ADP_DP_CS_3, 1);
1117 * tb_dp_port_set_hops() - Set video/aux Hop IDs for DP port
1118 * @port: DP IN/OUT port to set hops
1119 * @video: Video Hop ID
1120 * @aux_tx: AUX TX Hop ID
1121 * @aux_rx: AUX RX Hop ID
1123 * Programs specified Hop IDs for DP IN/OUT port.
1125 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
1126 unsigned int aux_tx, unsigned int aux_rx)
1131 ret = tb_port_read(port, data, TB_CFG_PORT,
1132 port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1136 data[0] &= ~ADP_DP_CS_0_VIDEO_HOPID_MASK;
1137 data[1] &= ~ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1138 data[1] &= ~ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1140 data[0] |= (video << ADP_DP_CS_0_VIDEO_HOPID_SHIFT) &
1141 ADP_DP_CS_0_VIDEO_HOPID_MASK;
1142 data[1] |= aux_tx & ADP_DP_CS_1_AUX_TX_HOPID_MASK;
1143 data[1] |= (aux_rx << ADP_DP_CS_1_AUX_RX_HOPID_SHIFT) &
1144 ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1146 return tb_port_write(port, data, TB_CFG_PORT,
1147 port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1151 * tb_dp_port_is_enabled() - Is DP adapter port enabled
1152 * @port: DP adapter port to check
1154 bool tb_dp_port_is_enabled(struct tb_port *port)
1158 if (tb_port_read(port, data, TB_CFG_PORT, port->cap_adap + ADP_DP_CS_0,
1162 return !!(data[0] & (ADP_DP_CS_0_VE | ADP_DP_CS_0_AE));
1166 * tb_dp_port_enable() - Enables/disables DP paths of a port
1167 * @port: DP IN/OUT port
1168 * @enable: Enable/disable DP path
1170 * Once Hop IDs are programmed DP paths can be enabled or disabled by
1171 * calling this function.
1173 int tb_dp_port_enable(struct tb_port *port, bool enable)
1178 ret = tb_port_read(port, data, TB_CFG_PORT,
1179 port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1184 data[0] |= ADP_DP_CS_0_VE | ADP_DP_CS_0_AE;
1186 data[0] &= ~(ADP_DP_CS_0_VE | ADP_DP_CS_0_AE);
1188 return tb_port_write(port, data, TB_CFG_PORT,
1189 port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1192 /* switch utility functions */
1194 static const char *tb_switch_generation_name(const struct tb_switch *sw)
1196 switch (sw->generation) {
1198 return "Thunderbolt 1";
1200 return "Thunderbolt 2";
1202 return "Thunderbolt 3";
1210 static void tb_dump_switch(const struct tb *tb, const struct tb_switch *sw)
1212 const struct tb_regs_switch_header *regs = &sw->config;
1214 tb_dbg(tb, " %s Switch: %x:%x (Revision: %d, TB Version: %d)\n",
1215 tb_switch_generation_name(sw), regs->vendor_id, regs->device_id,
1216 regs->revision, regs->thunderbolt_version);
1217 tb_dbg(tb, " Max Port Number: %d\n", regs->max_port_number);
1218 tb_dbg(tb, " Config:\n");
1220 " Upstream Port Number: %d Depth: %d Route String: %#llx Enabled: %d, PlugEventsDelay: %dms\n",
1221 regs->upstream_port_number, regs->depth,
1222 (((u64) regs->route_hi) << 32) | regs->route_lo,
1223 regs->enabled, regs->plug_events_delay);
1224 tb_dbg(tb, " unknown1: %#x unknown4: %#x\n",
1225 regs->__unknown1, regs->__unknown4);
1229 * reset_switch() - reconfigure route, enable and send TB_CFG_PKG_RESET
1231 * Return: Returns 0 on success or an error code on failure.
1233 int tb_switch_reset(struct tb *tb, u64 route)
1235 struct tb_cfg_result res;
1236 struct tb_regs_switch_header header = {
1237 header.route_hi = route >> 32,
1238 header.route_lo = route,
1239 header.enabled = true,
1241 tb_dbg(tb, "resetting switch at %llx\n", route);
1242 res.err = tb_cfg_write(tb->ctl, ((u32 *) &header) + 2, route,
1246 res = tb_cfg_reset(tb->ctl, route, TB_CFG_DEFAULT_TIMEOUT);
1253 * tb_plug_events_active() - enable/disable plug events on a switch
1255 * Also configures a sane plug_events_delay of 255ms.
1257 * Return: Returns 0 on success or an error code on failure.
1259 static int tb_plug_events_active(struct tb_switch *sw, bool active)
1264 if (tb_switch_is_icm(sw))
1267 sw->config.plug_events_delay = 0xff;
1268 res = tb_sw_write(sw, ((u32 *) &sw->config) + 4, TB_CFG_SWITCH, 4, 1);
1272 /* Plug events are always enabled in USB4 */
1273 if (tb_switch_is_usb4(sw))
1276 res = tb_sw_read(sw, &data, TB_CFG_SWITCH, sw->cap_plug_events + 1, 1);
1281 data = data & 0xFFFFFF83;
1282 switch (sw->config.device_id) {
1283 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
1284 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
1285 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
1293 return tb_sw_write(sw, &data, TB_CFG_SWITCH,
1294 sw->cap_plug_events + 1, 1);
1297 static ssize_t authorized_show(struct device *dev,
1298 struct device_attribute *attr,
1301 struct tb_switch *sw = tb_to_switch(dev);
1303 return sprintf(buf, "%u\n", sw->authorized);
1306 static int tb_switch_set_authorized(struct tb_switch *sw, unsigned int val)
1310 if (!mutex_trylock(&sw->tb->lock))
1311 return restart_syscall();
1317 /* Approve switch */
1320 ret = tb_domain_approve_switch_key(sw->tb, sw);
1322 ret = tb_domain_approve_switch(sw->tb, sw);
1325 /* Challenge switch */
1328 ret = tb_domain_challenge_switch_key(sw->tb, sw);
1336 sw->authorized = val;
1337 /* Notify status change to the userspace */
1338 kobject_uevent(&sw->dev.kobj, KOBJ_CHANGE);
1342 mutex_unlock(&sw->tb->lock);
1346 static ssize_t authorized_store(struct device *dev,
1347 struct device_attribute *attr,
1348 const char *buf, size_t count)
1350 struct tb_switch *sw = tb_to_switch(dev);
1354 ret = kstrtouint(buf, 0, &val);
1360 pm_runtime_get_sync(&sw->dev);
1361 ret = tb_switch_set_authorized(sw, val);
1362 pm_runtime_mark_last_busy(&sw->dev);
1363 pm_runtime_put_autosuspend(&sw->dev);
1365 return ret ? ret : count;
1367 static DEVICE_ATTR_RW(authorized);
1369 static ssize_t boot_show(struct device *dev, struct device_attribute *attr,
1372 struct tb_switch *sw = tb_to_switch(dev);
1374 return sprintf(buf, "%u\n", sw->boot);
1376 static DEVICE_ATTR_RO(boot);
1378 static ssize_t device_show(struct device *dev, struct device_attribute *attr,
1381 struct tb_switch *sw = tb_to_switch(dev);
1383 return sprintf(buf, "%#x\n", sw->device);
1385 static DEVICE_ATTR_RO(device);
1388 device_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1390 struct tb_switch *sw = tb_to_switch(dev);
1392 return sprintf(buf, "%s\n", sw->device_name ? sw->device_name : "");
1394 static DEVICE_ATTR_RO(device_name);
1397 generation_show(struct device *dev, struct device_attribute *attr, char *buf)
1399 struct tb_switch *sw = tb_to_switch(dev);
1401 return sprintf(buf, "%u\n", sw->generation);
1403 static DEVICE_ATTR_RO(generation);
1405 static ssize_t key_show(struct device *dev, struct device_attribute *attr,
1408 struct tb_switch *sw = tb_to_switch(dev);
1411 if (!mutex_trylock(&sw->tb->lock))
1412 return restart_syscall();
1415 ret = sprintf(buf, "%*phN\n", TB_SWITCH_KEY_SIZE, sw->key);
1417 ret = sprintf(buf, "\n");
1419 mutex_unlock(&sw->tb->lock);
1423 static ssize_t key_store(struct device *dev, struct device_attribute *attr,
1424 const char *buf, size_t count)
1426 struct tb_switch *sw = tb_to_switch(dev);
1427 u8 key[TB_SWITCH_KEY_SIZE];
1428 ssize_t ret = count;
1431 if (!strcmp(buf, "\n"))
1433 else if (hex2bin(key, buf, sizeof(key)))
1436 if (!mutex_trylock(&sw->tb->lock))
1437 return restart_syscall();
1439 if (sw->authorized) {
1446 sw->key = kmemdup(key, sizeof(key), GFP_KERNEL);
1452 mutex_unlock(&sw->tb->lock);
1455 static DEVICE_ATTR(key, 0600, key_show, key_store);
1457 static ssize_t speed_show(struct device *dev, struct device_attribute *attr,
1460 struct tb_switch *sw = tb_to_switch(dev);
1462 return sprintf(buf, "%u.0 Gb/s\n", sw->link_speed);
1466 * Currently all lanes must run at the same speed but we expose here
1467 * both directions to allow possible asymmetric links in the future.
1469 static DEVICE_ATTR(rx_speed, 0444, speed_show, NULL);
1470 static DEVICE_ATTR(tx_speed, 0444, speed_show, NULL);
1472 static ssize_t lanes_show(struct device *dev, struct device_attribute *attr,
1475 struct tb_switch *sw = tb_to_switch(dev);
1477 return sprintf(buf, "%u\n", sw->link_width);
1481 * Currently link has same amount of lanes both directions (1 or 2) but
1482 * expose them separately to allow possible asymmetric links in the future.
1484 static DEVICE_ATTR(rx_lanes, 0444, lanes_show, NULL);
1485 static DEVICE_ATTR(tx_lanes, 0444, lanes_show, NULL);
1487 static ssize_t nvm_authenticate_show(struct device *dev,
1488 struct device_attribute *attr, char *buf)
1490 struct tb_switch *sw = tb_to_switch(dev);
1493 nvm_get_auth_status(sw, &status);
1494 return sprintf(buf, "%#x\n", status);
1497 static ssize_t nvm_authenticate_sysfs(struct device *dev, const char *buf,
1500 struct tb_switch *sw = tb_to_switch(dev);
1504 pm_runtime_get_sync(&sw->dev);
1506 if (!mutex_trylock(&sw->tb->lock)) {
1507 ret = restart_syscall();
1511 /* If NVMem devices are not yet added */
1517 ret = kstrtoint(buf, 10, &val);
1521 /* Always clear the authentication status */
1522 nvm_clear_auth_status(sw);
1525 if (!sw->nvm->flushed) {
1526 if (!sw->nvm->buf) {
1531 ret = nvm_validate_and_write(sw);
1532 if (ret || val == WRITE_ONLY)
1535 if (val == WRITE_AND_AUTHENTICATE) {
1537 ret = tb_lc_force_power(sw);
1539 sw->nvm->authenticating = true;
1540 ret = nvm_authenticate(sw);
1546 mutex_unlock(&sw->tb->lock);
1548 pm_runtime_mark_last_busy(&sw->dev);
1549 pm_runtime_put_autosuspend(&sw->dev);
1554 static ssize_t nvm_authenticate_store(struct device *dev,
1555 struct device_attribute *attr, const char *buf, size_t count)
1557 int ret = nvm_authenticate_sysfs(dev, buf, false);
1562 static DEVICE_ATTR_RW(nvm_authenticate);
1564 static ssize_t nvm_authenticate_on_disconnect_show(struct device *dev,
1565 struct device_attribute *attr, char *buf)
1567 return nvm_authenticate_show(dev, attr, buf);
1570 static ssize_t nvm_authenticate_on_disconnect_store(struct device *dev,
1571 struct device_attribute *attr, const char *buf, size_t count)
1575 ret = nvm_authenticate_sysfs(dev, buf, true);
1576 return ret ? ret : count;
1578 static DEVICE_ATTR_RW(nvm_authenticate_on_disconnect);
1580 static ssize_t nvm_version_show(struct device *dev,
1581 struct device_attribute *attr, char *buf)
1583 struct tb_switch *sw = tb_to_switch(dev);
1586 if (!mutex_trylock(&sw->tb->lock))
1587 return restart_syscall();
1594 ret = sprintf(buf, "%x.%x\n", sw->nvm->major, sw->nvm->minor);
1596 mutex_unlock(&sw->tb->lock);
1600 static DEVICE_ATTR_RO(nvm_version);
1602 static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
1605 struct tb_switch *sw = tb_to_switch(dev);
1607 return sprintf(buf, "%#x\n", sw->vendor);
1609 static DEVICE_ATTR_RO(vendor);
1612 vendor_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1614 struct tb_switch *sw = tb_to_switch(dev);
1616 return sprintf(buf, "%s\n", sw->vendor_name ? sw->vendor_name : "");
1618 static DEVICE_ATTR_RO(vendor_name);
1620 static ssize_t unique_id_show(struct device *dev, struct device_attribute *attr,
1623 struct tb_switch *sw = tb_to_switch(dev);
1625 return sprintf(buf, "%pUb\n", sw->uuid);
1627 static DEVICE_ATTR_RO(unique_id);
1629 static struct attribute *switch_attrs[] = {
1630 &dev_attr_authorized.attr,
1631 &dev_attr_boot.attr,
1632 &dev_attr_device.attr,
1633 &dev_attr_device_name.attr,
1634 &dev_attr_generation.attr,
1636 &dev_attr_nvm_authenticate.attr,
1637 &dev_attr_nvm_authenticate_on_disconnect.attr,
1638 &dev_attr_nvm_version.attr,
1639 &dev_attr_rx_speed.attr,
1640 &dev_attr_rx_lanes.attr,
1641 &dev_attr_tx_speed.attr,
1642 &dev_attr_tx_lanes.attr,
1643 &dev_attr_vendor.attr,
1644 &dev_attr_vendor_name.attr,
1645 &dev_attr_unique_id.attr,
1649 static umode_t switch_attr_is_visible(struct kobject *kobj,
1650 struct attribute *attr, int n)
1652 struct device *dev = container_of(kobj, struct device, kobj);
1653 struct tb_switch *sw = tb_to_switch(dev);
1655 if (attr == &dev_attr_device.attr) {
1658 } else if (attr == &dev_attr_device_name.attr) {
1659 if (!sw->device_name)
1661 } else if (attr == &dev_attr_vendor.attr) {
1664 } else if (attr == &dev_attr_vendor_name.attr) {
1665 if (!sw->vendor_name)
1667 } else if (attr == &dev_attr_key.attr) {
1669 sw->tb->security_level == TB_SECURITY_SECURE &&
1670 sw->security_level == TB_SECURITY_SECURE)
1673 } else if (attr == &dev_attr_rx_speed.attr ||
1674 attr == &dev_attr_rx_lanes.attr ||
1675 attr == &dev_attr_tx_speed.attr ||
1676 attr == &dev_attr_tx_lanes.attr) {
1680 } else if (attr == &dev_attr_nvm_authenticate.attr) {
1681 if (nvm_upgradeable(sw))
1684 } else if (attr == &dev_attr_nvm_version.attr) {
1685 if (nvm_readable(sw))
1688 } else if (attr == &dev_attr_boot.attr) {
1692 } else if (attr == &dev_attr_nvm_authenticate_on_disconnect.attr) {
1693 if (sw->quirks & QUIRK_FORCE_POWER_LINK_CONTROLLER)
1698 return sw->safe_mode ? 0 : attr->mode;
1701 static struct attribute_group switch_group = {
1702 .is_visible = switch_attr_is_visible,
1703 .attrs = switch_attrs,
1706 static const struct attribute_group *switch_groups[] = {
1711 static void tb_switch_release(struct device *dev)
1713 struct tb_switch *sw = tb_to_switch(dev);
1714 struct tb_port *port;
1716 dma_port_free(sw->dma_port);
1718 tb_switch_for_each_port(sw, port) {
1719 if (!port->disabled) {
1720 ida_destroy(&port->in_hopids);
1721 ida_destroy(&port->out_hopids);
1726 kfree(sw->device_name);
1727 kfree(sw->vendor_name);
1735 * Currently only need to provide the callbacks. Everything else is handled
1736 * in the connection manager.
1738 static int __maybe_unused tb_switch_runtime_suspend(struct device *dev)
1740 struct tb_switch *sw = tb_to_switch(dev);
1741 const struct tb_cm_ops *cm_ops = sw->tb->cm_ops;
1743 if (cm_ops->runtime_suspend_switch)
1744 return cm_ops->runtime_suspend_switch(sw);
1749 static int __maybe_unused tb_switch_runtime_resume(struct device *dev)
1751 struct tb_switch *sw = tb_to_switch(dev);
1752 const struct tb_cm_ops *cm_ops = sw->tb->cm_ops;
1754 if (cm_ops->runtime_resume_switch)
1755 return cm_ops->runtime_resume_switch(sw);
1759 static const struct dev_pm_ops tb_switch_pm_ops = {
1760 SET_RUNTIME_PM_OPS(tb_switch_runtime_suspend, tb_switch_runtime_resume,
1764 struct device_type tb_switch_type = {
1765 .name = "thunderbolt_device",
1766 .release = tb_switch_release,
1767 .pm = &tb_switch_pm_ops,
1770 static int tb_switch_get_generation(struct tb_switch *sw)
1772 switch (sw->config.device_id) {
1773 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
1774 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
1775 case PCI_DEVICE_ID_INTEL_LIGHT_PEAK:
1776 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
1777 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
1778 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
1779 case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_2C_BRIDGE:
1780 case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_4C_BRIDGE:
1783 case PCI_DEVICE_ID_INTEL_WIN_RIDGE_2C_BRIDGE:
1784 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
1785 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
1788 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
1789 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
1790 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE:
1791 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
1792 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
1793 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
1794 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
1795 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
1796 case PCI_DEVICE_ID_INTEL_ICL_NHI0:
1797 case PCI_DEVICE_ID_INTEL_ICL_NHI1:
1801 if (tb_switch_is_usb4(sw))
1805 * For unknown switches assume generation to be 1 to be
1808 tb_sw_warn(sw, "unsupported switch device id %#x\n",
1809 sw->config.device_id);
1814 static bool tb_switch_exceeds_max_depth(const struct tb_switch *sw, int depth)
1818 if (tb_switch_is_usb4(sw) ||
1819 (sw->tb->root_switch && tb_switch_is_usb4(sw->tb->root_switch)))
1820 max_depth = USB4_SWITCH_MAX_DEPTH;
1822 max_depth = TB_SWITCH_MAX_DEPTH;
1824 return depth > max_depth;
1828 * tb_switch_alloc() - allocate a switch
1829 * @tb: Pointer to the owning domain
1830 * @parent: Parent device for this switch
1831 * @route: Route string for this switch
1833 * Allocates and initializes a switch. Will not upload configuration to
1834 * the switch. For that you need to call tb_switch_configure()
1835 * separately. The returned switch should be released by calling
1838 * Return: Pointer to the allocated switch or ERR_PTR() in case of
1841 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
1844 struct tb_switch *sw;
1848 /* Unlock the downstream port so we can access the switch below */
1850 struct tb_switch *parent_sw = tb_to_switch(parent);
1851 struct tb_port *down;
1853 down = tb_port_at(route, parent_sw);
1854 tb_port_unlock(down);
1857 depth = tb_route_length(route);
1859 upstream_port = tb_cfg_get_upstream_port(tb->ctl, route);
1860 if (upstream_port < 0)
1861 return ERR_PTR(upstream_port);
1863 sw = kzalloc(sizeof(*sw), GFP_KERNEL);
1865 return ERR_PTR(-ENOMEM);
1868 ret = tb_cfg_read(tb->ctl, &sw->config, route, 0, TB_CFG_SWITCH, 0, 5);
1870 goto err_free_sw_ports;
1872 sw->generation = tb_switch_get_generation(sw);
1874 tb_dbg(tb, "current switch config:\n");
1875 tb_dump_switch(tb, sw);
1877 /* configure switch */
1878 sw->config.upstream_port_number = upstream_port;
1879 sw->config.depth = depth;
1880 sw->config.route_hi = upper_32_bits(route);
1881 sw->config.route_lo = lower_32_bits(route);
1882 sw->config.enabled = 0;
1884 /* Make sure we do not exceed maximum topology limit */
1885 if (tb_switch_exceeds_max_depth(sw, depth)) {
1886 ret = -EADDRNOTAVAIL;
1887 goto err_free_sw_ports;
1890 /* initialize ports */
1891 sw->ports = kcalloc(sw->config.max_port_number + 1, sizeof(*sw->ports),
1895 goto err_free_sw_ports;
1898 for (i = 0; i <= sw->config.max_port_number; i++) {
1899 /* minimum setup for tb_find_cap and tb_drom_read to work */
1900 sw->ports[i].sw = sw;
1901 sw->ports[i].port = i;
1904 ret = tb_switch_find_vse_cap(sw, TB_VSE_CAP_PLUG_EVENTS);
1906 sw->cap_plug_events = ret;
1908 ret = tb_switch_find_vse_cap(sw, TB_VSE_CAP_LINK_CONTROLLER);
1912 /* Root switch is always authorized */
1914 sw->authorized = true;
1916 device_initialize(&sw->dev);
1917 sw->dev.parent = parent;
1918 sw->dev.bus = &tb_bus_type;
1919 sw->dev.type = &tb_switch_type;
1920 sw->dev.groups = switch_groups;
1921 dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
1929 return ERR_PTR(ret);
1933 * tb_switch_alloc_safe_mode() - allocate a switch that is in safe mode
1934 * @tb: Pointer to the owning domain
1935 * @parent: Parent device for this switch
1936 * @route: Route string for this switch
1938 * This creates a switch in safe mode. This means the switch pretty much
1939 * lacks all capabilities except DMA configuration port before it is
1940 * flashed with a valid NVM firmware.
1942 * The returned switch must be released by calling tb_switch_put().
1944 * Return: Pointer to the allocated switch or ERR_PTR() in case of failure
1947 tb_switch_alloc_safe_mode(struct tb *tb, struct device *parent, u64 route)
1949 struct tb_switch *sw;
1951 sw = kzalloc(sizeof(*sw), GFP_KERNEL);
1953 return ERR_PTR(-ENOMEM);
1956 sw->config.depth = tb_route_length(route);
1957 sw->config.route_hi = upper_32_bits(route);
1958 sw->config.route_lo = lower_32_bits(route);
1959 sw->safe_mode = true;
1961 device_initialize(&sw->dev);
1962 sw->dev.parent = parent;
1963 sw->dev.bus = &tb_bus_type;
1964 sw->dev.type = &tb_switch_type;
1965 sw->dev.groups = switch_groups;
1966 dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
1972 * tb_switch_configure() - Uploads configuration to the switch
1973 * @sw: Switch to configure
1975 * Call this function before the switch is added to the system. It will
1976 * upload configuration to the switch and makes it available for the
1977 * connection manager to use. Can be called to the switch again after
1978 * resume from low power states to re-initialize it.
1980 * Return: %0 in case of success and negative errno in case of failure
1982 int tb_switch_configure(struct tb_switch *sw)
1984 struct tb *tb = sw->tb;
1988 route = tb_route(sw);
1990 tb_dbg(tb, "%s Switch at %#llx (depth: %d, up port: %d)\n",
1991 sw->config.enabled ? "restoring " : "initializing", route,
1992 tb_route_length(route), sw->config.upstream_port_number);
1994 sw->config.enabled = 1;
1996 if (tb_switch_is_usb4(sw)) {
1998 * For USB4 devices, we need to program the CM version
1999 * accordingly so that it knows to expose all the
2000 * additional capabilities.
2002 sw->config.cmuv = USB4_VERSION_1_0;
2004 /* Enumerate the switch */
2005 ret = tb_sw_write(sw, (u32 *)&sw->config + 1, TB_CFG_SWITCH,
2010 ret = usb4_switch_setup(sw);
2014 ret = usb4_switch_configure_link(sw);
2016 if (sw->config.vendor_id != PCI_VENDOR_ID_INTEL)
2017 tb_sw_warn(sw, "unknown switch vendor id %#x\n",
2018 sw->config.vendor_id);
2020 if (!sw->cap_plug_events) {
2021 tb_sw_warn(sw, "cannot find TB_VSE_CAP_PLUG_EVENTS aborting\n");
2025 /* Enumerate the switch */
2026 ret = tb_sw_write(sw, (u32 *)&sw->config + 1, TB_CFG_SWITCH,
2031 ret = tb_lc_configure_link(sw);
2036 return tb_plug_events_active(sw, true);
2039 static int tb_switch_set_uuid(struct tb_switch *sw)
2048 if (tb_switch_is_usb4(sw)) {
2049 ret = usb4_switch_read_uid(sw, &sw->uid);
2055 * The newer controllers include fused UUID as part of
2056 * link controller specific registers
2058 ret = tb_lc_read_uuid(sw, uuid);
2068 * ICM generates UUID based on UID and fills the upper
2069 * two words with ones. This is not strictly following
2070 * UUID format but we want to be compatible with it so
2071 * we do the same here.
2073 uuid[0] = sw->uid & 0xffffffff;
2074 uuid[1] = (sw->uid >> 32) & 0xffffffff;
2075 uuid[2] = 0xffffffff;
2076 uuid[3] = 0xffffffff;
2079 sw->uuid = kmemdup(uuid, sizeof(uuid), GFP_KERNEL);
2085 static int tb_switch_add_dma_port(struct tb_switch *sw)
2090 switch (sw->generation) {
2092 /* Only root switch can be upgraded */
2098 ret = tb_switch_set_uuid(sw);
2105 * DMA port is the only thing available when the switch
2113 /* Root switch DMA port requires running firmware */
2114 if (!tb_route(sw) && !tb_switch_is_icm(sw))
2117 sw->dma_port = dma_port_alloc(sw);
2121 if (sw->no_nvm_upgrade)
2125 * If there is status already set then authentication failed
2126 * when the dma_port_flash_update_auth() returned. Power cycling
2127 * is not needed (it was done already) so only thing we do here
2128 * is to unblock runtime PM of the root port.
2130 nvm_get_auth_status(sw, &status);
2133 nvm_authenticate_complete_dma_port(sw);
2138 * Check status of the previous flash authentication. If there
2139 * is one we need to power cycle the switch in any case to make
2140 * it functional again.
2142 ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
2146 /* Now we can allow root port to suspend again */
2148 nvm_authenticate_complete_dma_port(sw);
2151 tb_sw_info(sw, "switch flash authentication failed\n");
2152 nvm_set_auth_status(sw, status);
2155 tb_sw_info(sw, "power cycling the switch now\n");
2156 dma_port_power_cycle(sw->dma_port);
2159 * We return error here which causes the switch adding failure.
2160 * It should appear back after power cycle is complete.
2165 static void tb_switch_default_link_ports(struct tb_switch *sw)
2169 for (i = 1; i <= sw->config.max_port_number; i += 2) {
2170 struct tb_port *port = &sw->ports[i];
2171 struct tb_port *subordinate;
2173 if (!tb_port_is_null(port))
2176 /* Check for the subordinate port */
2177 if (i == sw->config.max_port_number ||
2178 !tb_port_is_null(&sw->ports[i + 1]))
2181 /* Link them if not already done so (by DROM) */
2182 subordinate = &sw->ports[i + 1];
2183 if (!port->dual_link_port && !subordinate->dual_link_port) {
2185 port->dual_link_port = subordinate;
2186 subordinate->link_nr = 1;
2187 subordinate->dual_link_port = port;
2189 tb_sw_dbg(sw, "linked ports %d <-> %d\n",
2190 port->port, subordinate->port);
2195 static bool tb_switch_lane_bonding_possible(struct tb_switch *sw)
2197 const struct tb_port *up = tb_upstream_port(sw);
2199 if (!up->dual_link_port || !up->dual_link_port->remote)
2202 if (tb_switch_is_usb4(sw))
2203 return usb4_switch_lane_bonding_possible(sw);
2204 return tb_lc_lane_bonding_possible(sw);
2207 static int tb_switch_update_link_attributes(struct tb_switch *sw)
2210 bool change = false;
2213 if (!tb_route(sw) || tb_switch_is_icm(sw))
2216 up = tb_upstream_port(sw);
2218 ret = tb_port_get_link_speed(up);
2221 if (sw->link_speed != ret)
2223 sw->link_speed = ret;
2225 ret = tb_port_get_link_width(up);
2228 if (sw->link_width != ret)
2230 sw->link_width = ret;
2232 /* Notify userspace that there is possible link attribute change */
2233 if (device_is_registered(&sw->dev) && change)
2234 kobject_uevent(&sw->dev.kobj, KOBJ_CHANGE);
2240 * tb_switch_lane_bonding_enable() - Enable lane bonding
2241 * @sw: Switch to enable lane bonding
2243 * Connection manager can call this function to enable lane bonding of a
2244 * switch. If conditions are correct and both switches support the feature,
2245 * lanes are bonded. It is safe to call this to any switch.
2247 int tb_switch_lane_bonding_enable(struct tb_switch *sw)
2249 struct tb_switch *parent = tb_to_switch(sw->dev.parent);
2250 struct tb_port *up, *down;
2251 u64 route = tb_route(sw);
2257 if (!tb_switch_lane_bonding_possible(sw))
2260 up = tb_upstream_port(sw);
2261 down = tb_port_at(route, parent);
2263 if (!tb_port_is_width_supported(up, 2) ||
2264 !tb_port_is_width_supported(down, 2))
2267 ret = tb_port_lane_bonding_enable(up);
2269 tb_port_warn(up, "failed to enable lane bonding\n");
2273 ret = tb_port_lane_bonding_enable(down);
2275 tb_port_warn(down, "failed to enable lane bonding\n");
2276 tb_port_lane_bonding_disable(up);
2280 tb_switch_update_link_attributes(sw);
2282 tb_sw_dbg(sw, "lane bonding enabled\n");
2287 * tb_switch_lane_bonding_disable() - Disable lane bonding
2288 * @sw: Switch whose lane bonding to disable
2290 * Disables lane bonding between @sw and parent. This can be called even
2291 * if lanes were not bonded originally.
2293 void tb_switch_lane_bonding_disable(struct tb_switch *sw)
2295 struct tb_switch *parent = tb_to_switch(sw->dev.parent);
2296 struct tb_port *up, *down;
2301 up = tb_upstream_port(sw);
2305 down = tb_port_at(tb_route(sw), parent);
2307 tb_port_lane_bonding_disable(up);
2308 tb_port_lane_bonding_disable(down);
2310 tb_switch_update_link_attributes(sw);
2311 tb_sw_dbg(sw, "lane bonding disabled\n");
2315 * tb_switch_add() - Add a switch to the domain
2316 * @sw: Switch to add
2318 * This is the last step in adding switch to the domain. It will read
2319 * identification information from DROM and initializes ports so that
2320 * they can be used to connect other switches. The switch will be
2321 * exposed to the userspace when this function successfully returns. To
2322 * remove and release the switch, call tb_switch_remove().
2324 * Return: %0 in case of success and negative errno in case of failure
2326 int tb_switch_add(struct tb_switch *sw)
2331 * Initialize DMA control port now before we read DROM. Recent
2332 * host controllers have more complete DROM on NVM that includes
2333 * vendor and model identification strings which we then expose
2334 * to the userspace. NVM can be accessed through DMA
2335 * configuration based mailbox.
2337 ret = tb_switch_add_dma_port(sw);
2339 dev_err(&sw->dev, "failed to add DMA port\n");
2343 if (!sw->safe_mode) {
2345 ret = tb_drom_read(sw);
2347 dev_err(&sw->dev, "reading DROM failed\n");
2350 tb_sw_dbg(sw, "uid: %#llx\n", sw->uid);
2352 ret = tb_switch_set_uuid(sw);
2354 dev_err(&sw->dev, "failed to set UUID\n");
2358 for (i = 0; i <= sw->config.max_port_number; i++) {
2359 if (sw->ports[i].disabled) {
2360 tb_port_dbg(&sw->ports[i], "disabled by eeprom\n");
2363 ret = tb_init_port(&sw->ports[i]);
2365 dev_err(&sw->dev, "failed to initialize port %d\n", i);
2370 tb_switch_default_link_ports(sw);
2372 ret = tb_switch_update_link_attributes(sw);
2376 ret = tb_switch_tmu_init(sw);
2381 ret = device_add(&sw->dev);
2383 dev_err(&sw->dev, "failed to add device: %d\n", ret);
2388 dev_info(&sw->dev, "new device found, vendor=%#x device=%#x\n",
2389 sw->vendor, sw->device);
2390 if (sw->vendor_name && sw->device_name)
2391 dev_info(&sw->dev, "%s %s\n", sw->vendor_name,
2395 ret = tb_switch_nvm_add(sw);
2397 dev_err(&sw->dev, "failed to add NVM devices\n");
2398 device_del(&sw->dev);
2402 pm_runtime_set_active(&sw->dev);
2404 pm_runtime_set_autosuspend_delay(&sw->dev, TB_AUTOSUSPEND_DELAY);
2405 pm_runtime_use_autosuspend(&sw->dev);
2406 pm_runtime_mark_last_busy(&sw->dev);
2407 pm_runtime_enable(&sw->dev);
2408 pm_request_autosuspend(&sw->dev);
2415 * tb_switch_remove() - Remove and release a switch
2416 * @sw: Switch to remove
2418 * This will remove the switch from the domain and release it after last
2419 * reference count drops to zero. If there are switches connected below
2420 * this switch, they will be removed as well.
2422 void tb_switch_remove(struct tb_switch *sw)
2424 struct tb_port *port;
2427 pm_runtime_get_sync(&sw->dev);
2428 pm_runtime_disable(&sw->dev);
2431 /* port 0 is the switch itself and never has a remote */
2432 tb_switch_for_each_port(sw, port) {
2433 if (tb_port_has_remote(port)) {
2434 tb_switch_remove(port->remote->sw);
2435 port->remote = NULL;
2436 } else if (port->xdomain) {
2437 tb_xdomain_remove(port->xdomain);
2438 port->xdomain = NULL;
2441 /* Remove any downstream retimers */
2442 tb_retimer_remove_all(port);
2445 if (!sw->is_unplugged)
2446 tb_plug_events_active(sw, false);
2448 if (tb_switch_is_usb4(sw))
2449 usb4_switch_unconfigure_link(sw);
2451 tb_lc_unconfigure_link(sw);
2453 tb_switch_nvm_remove(sw);
2456 dev_info(&sw->dev, "device disconnected\n");
2457 device_unregister(&sw->dev);
2461 * tb_sw_set_unplugged() - set is_unplugged on switch and downstream switches
2463 void tb_sw_set_unplugged(struct tb_switch *sw)
2465 struct tb_port *port;
2467 if (sw == sw->tb->root_switch) {
2468 tb_sw_WARN(sw, "cannot unplug root switch\n");
2471 if (sw->is_unplugged) {
2472 tb_sw_WARN(sw, "is_unplugged already set\n");
2475 sw->is_unplugged = true;
2476 tb_switch_for_each_port(sw, port) {
2477 if (tb_port_has_remote(port))
2478 tb_sw_set_unplugged(port->remote->sw);
2479 else if (port->xdomain)
2480 port->xdomain->is_unplugged = true;
2484 int tb_switch_resume(struct tb_switch *sw)
2486 struct tb_port *port;
2489 tb_sw_dbg(sw, "resuming switch\n");
2492 * Check for UID of the connected switches except for root
2493 * switch which we assume cannot be removed.
2499 * Check first that we can still read the switch config
2500 * space. It may be that there is now another domain
2503 err = tb_cfg_get_upstream_port(sw->tb->ctl, tb_route(sw));
2505 tb_sw_info(sw, "switch not present anymore\n");
2509 if (tb_switch_is_usb4(sw))
2510 err = usb4_switch_read_uid(sw, &uid);
2512 err = tb_drom_read_uid_only(sw, &uid);
2514 tb_sw_warn(sw, "uid read failed\n");
2517 if (sw->uid != uid) {
2519 "changed while suspended (uid %#llx -> %#llx)\n",
2525 err = tb_switch_configure(sw);
2529 /* check for surviving downstream switches */
2530 tb_switch_for_each_port(sw, port) {
2531 if (!tb_port_has_remote(port) && !port->xdomain)
2534 if (tb_wait_for_port(port, true) <= 0) {
2536 "lost during suspend, disconnecting\n");
2537 if (tb_port_has_remote(port))
2538 tb_sw_set_unplugged(port->remote->sw);
2539 else if (port->xdomain)
2540 port->xdomain->is_unplugged = true;
2541 } else if (tb_port_has_remote(port) || port->xdomain) {
2543 * Always unlock the port so the downstream
2544 * switch/domain is accessible.
2546 if (tb_port_unlock(port))
2547 tb_port_warn(port, "failed to unlock port\n");
2548 if (port->remote && tb_switch_resume(port->remote->sw)) {
2550 "lost during suspend, disconnecting\n");
2551 tb_sw_set_unplugged(port->remote->sw);
2558 void tb_switch_suspend(struct tb_switch *sw)
2560 struct tb_port *port;
2563 err = tb_plug_events_active(sw, false);
2567 tb_switch_for_each_port(sw, port) {
2568 if (tb_port_has_remote(port))
2569 tb_switch_suspend(port->remote->sw);
2572 if (tb_switch_is_usb4(sw))
2573 usb4_switch_set_sleep(sw);
2575 tb_lc_set_sleep(sw);
2579 * tb_switch_query_dp_resource() - Query availability of DP resource
2580 * @sw: Switch whose DP resource is queried
2583 * Queries availability of DP resource for DP tunneling using switch
2584 * specific means. Returns %true if resource is available.
2586 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in)
2588 if (tb_switch_is_usb4(sw))
2589 return usb4_switch_query_dp_resource(sw, in);
2590 return tb_lc_dp_sink_query(sw, in);
2594 * tb_switch_alloc_dp_resource() - Allocate available DP resource
2595 * @sw: Switch whose DP resource is allocated
2598 * Allocates DP resource for DP tunneling. The resource must be
2599 * available for this to succeed (see tb_switch_query_dp_resource()).
2600 * Returns %0 in success and negative errno otherwise.
2602 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in)
2604 if (tb_switch_is_usb4(sw))
2605 return usb4_switch_alloc_dp_resource(sw, in);
2606 return tb_lc_dp_sink_alloc(sw, in);
2610 * tb_switch_dealloc_dp_resource() - De-allocate DP resource
2611 * @sw: Switch whose DP resource is de-allocated
2614 * De-allocates DP resource that was previously allocated for DP
2617 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in)
2621 if (tb_switch_is_usb4(sw))
2622 ret = usb4_switch_dealloc_dp_resource(sw, in);
2624 ret = tb_lc_dp_sink_dealloc(sw, in);
2627 tb_sw_warn(sw, "failed to de-allocate DP resource for port %d\n",
2631 struct tb_sw_lookup {
2639 static int tb_switch_match(struct device *dev, const void *data)
2641 struct tb_switch *sw = tb_to_switch(dev);
2642 const struct tb_sw_lookup *lookup = data;
2646 if (sw->tb != lookup->tb)
2650 return !memcmp(sw->uuid, lookup->uuid, sizeof(*lookup->uuid));
2652 if (lookup->route) {
2653 return sw->config.route_lo == lower_32_bits(lookup->route) &&
2654 sw->config.route_hi == upper_32_bits(lookup->route);
2657 /* Root switch is matched only by depth */
2661 return sw->link == lookup->link && sw->depth == lookup->depth;
2665 * tb_switch_find_by_link_depth() - Find switch by link and depth
2666 * @tb: Domain the switch belongs
2667 * @link: Link number the switch is connected
2668 * @depth: Depth of the switch in link
2670 * Returned switch has reference count increased so the caller needs to
2671 * call tb_switch_put() when done with the switch.
2673 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link, u8 depth)
2675 struct tb_sw_lookup lookup;
2678 memset(&lookup, 0, sizeof(lookup));
2681 lookup.depth = depth;
2683 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
2685 return tb_to_switch(dev);
2691 * tb_switch_find_by_uuid() - Find switch by UUID
2692 * @tb: Domain the switch belongs
2693 * @uuid: UUID to look for
2695 * Returned switch has reference count increased so the caller needs to
2696 * call tb_switch_put() when done with the switch.
2698 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid)
2700 struct tb_sw_lookup lookup;
2703 memset(&lookup, 0, sizeof(lookup));
2707 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
2709 return tb_to_switch(dev);
2715 * tb_switch_find_by_route() - Find switch by route string
2716 * @tb: Domain the switch belongs
2717 * @route: Route string to look for
2719 * Returned switch has reference count increased so the caller needs to
2720 * call tb_switch_put() when done with the switch.
2722 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route)
2724 struct tb_sw_lookup lookup;
2728 return tb_switch_get(tb->root_switch);
2730 memset(&lookup, 0, sizeof(lookup));
2732 lookup.route = route;
2734 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
2736 return tb_to_switch(dev);
2742 * tb_switch_find_port() - return the first port of @type on @sw or NULL
2743 * @sw: Switch to find the port from
2744 * @type: Port type to look for
2746 struct tb_port *tb_switch_find_port(struct tb_switch *sw,
2747 enum tb_port_type type)
2749 struct tb_port *port;
2751 tb_switch_for_each_port(sw, port) {
2752 if (port->config.type == type)