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",
692 /* Port 0 is the switch itself and has no PHY. */
693 if (port->config.type == TB_TYPE_PORT && port->port != 0) {
694 cap = tb_port_find_cap(port, TB_PORT_CAP_PHY);
699 tb_port_WARN(port, "non switch port without a PHY\n");
701 cap = tb_port_find_cap(port, TB_PORT_CAP_USB4);
703 port->cap_usb4 = cap;
704 } else if (port->port != 0) {
705 cap = tb_port_find_cap(port, TB_PORT_CAP_ADAP);
707 port->cap_adap = cap;
710 tb_dump_port(port->sw->tb, &port->config);
712 /* Control port does not need HopID allocation */
714 ida_init(&port->in_hopids);
715 ida_init(&port->out_hopids);
718 INIT_LIST_HEAD(&port->list);
723 static int tb_port_alloc_hopid(struct tb_port *port, bool in, int min_hopid,
730 port_max_hopid = port->config.max_in_hop_id;
731 ida = &port->in_hopids;
733 port_max_hopid = port->config.max_out_hop_id;
734 ida = &port->out_hopids;
738 * NHI can use HopIDs 1-max for other adapters HopIDs 0-7 are
741 if (port->config.type != TB_TYPE_NHI && min_hopid < TB_PATH_MIN_HOPID)
742 min_hopid = TB_PATH_MIN_HOPID;
744 if (max_hopid < 0 || max_hopid > port_max_hopid)
745 max_hopid = port_max_hopid;
747 return ida_simple_get(ida, min_hopid, max_hopid + 1, GFP_KERNEL);
751 * tb_port_alloc_in_hopid() - Allocate input HopID from port
752 * @port: Port to allocate HopID for
753 * @min_hopid: Minimum acceptable input HopID
754 * @max_hopid: Maximum acceptable input HopID
756 * Return: HopID between @min_hopid and @max_hopid or negative errno in
759 int tb_port_alloc_in_hopid(struct tb_port *port, int min_hopid, int max_hopid)
761 return tb_port_alloc_hopid(port, true, min_hopid, max_hopid);
765 * tb_port_alloc_out_hopid() - Allocate output HopID from port
766 * @port: Port to allocate HopID for
767 * @min_hopid: Minimum acceptable output HopID
768 * @max_hopid: Maximum acceptable output HopID
770 * Return: HopID between @min_hopid and @max_hopid or negative errno in
773 int tb_port_alloc_out_hopid(struct tb_port *port, int min_hopid, int max_hopid)
775 return tb_port_alloc_hopid(port, false, min_hopid, max_hopid);
779 * tb_port_release_in_hopid() - Release allocated input HopID from port
780 * @port: Port whose HopID to release
781 * @hopid: HopID to release
783 void tb_port_release_in_hopid(struct tb_port *port, int hopid)
785 ida_simple_remove(&port->in_hopids, hopid);
789 * tb_port_release_out_hopid() - Release allocated output HopID from port
790 * @port: Port whose HopID to release
791 * @hopid: HopID to release
793 void tb_port_release_out_hopid(struct tb_port *port, int hopid)
795 ida_simple_remove(&port->out_hopids, hopid);
798 static inline bool tb_switch_is_reachable(const struct tb_switch *parent,
799 const struct tb_switch *sw)
801 u64 mask = (1ULL << parent->config.depth * 8) - 1;
802 return (tb_route(parent) & mask) == (tb_route(sw) & mask);
806 * tb_next_port_on_path() - Return next port for given port on a path
807 * @start: Start port of the walk
808 * @end: End port of the walk
809 * @prev: Previous port (%NULL if this is the first)
811 * This function can be used to walk from one port to another if they
812 * are connected through zero or more switches. If the @prev is dual
813 * link port, the function follows that link and returns another end on
816 * If the @end port has been reached, return %NULL.
818 * Domain tb->lock must be held when this function is called.
820 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
821 struct tb_port *prev)
823 struct tb_port *next;
828 if (prev->sw == end->sw) {
834 if (tb_switch_is_reachable(prev->sw, end->sw)) {
835 next = tb_port_at(tb_route(end->sw), prev->sw);
836 /* Walk down the topology if next == prev */
838 (next == prev || next->dual_link_port == prev))
841 if (tb_is_upstream_port(prev)) {
844 next = tb_upstream_port(prev->sw);
846 * Keep the same link if prev and next are both
849 if (next->dual_link_port &&
850 next->link_nr != prev->link_nr) {
851 next = next->dual_link_port;
856 return next != prev ? next : NULL;
860 * tb_port_get_link_speed() - Get current link speed
861 * @port: Port to check (USB4 or CIO)
863 * Returns link speed in Gb/s or negative errno in case of failure.
865 int tb_port_get_link_speed(struct tb_port *port)
873 ret = tb_port_read(port, &val, TB_CFG_PORT,
874 port->cap_phy + LANE_ADP_CS_1, 1);
878 speed = (val & LANE_ADP_CS_1_CURRENT_SPEED_MASK) >>
879 LANE_ADP_CS_1_CURRENT_SPEED_SHIFT;
880 return speed == LANE_ADP_CS_1_CURRENT_SPEED_GEN3 ? 20 : 10;
883 static int tb_port_get_link_width(struct tb_port *port)
891 ret = tb_port_read(port, &val, TB_CFG_PORT,
892 port->cap_phy + LANE_ADP_CS_1, 1);
896 return (val & LANE_ADP_CS_1_CURRENT_WIDTH_MASK) >>
897 LANE_ADP_CS_1_CURRENT_WIDTH_SHIFT;
900 static bool tb_port_is_width_supported(struct tb_port *port, int width)
908 ret = tb_port_read(port, &phy, TB_CFG_PORT,
909 port->cap_phy + LANE_ADP_CS_0, 1);
913 widths = (phy & LANE_ADP_CS_0_SUPPORTED_WIDTH_MASK) >>
914 LANE_ADP_CS_0_SUPPORTED_WIDTH_SHIFT;
916 return !!(widths & width);
919 static int tb_port_set_link_width(struct tb_port *port, unsigned int width)
927 ret = tb_port_read(port, &val, TB_CFG_PORT,
928 port->cap_phy + LANE_ADP_CS_1, 1);
932 val &= ~LANE_ADP_CS_1_TARGET_WIDTH_MASK;
935 val |= LANE_ADP_CS_1_TARGET_WIDTH_SINGLE <<
936 LANE_ADP_CS_1_TARGET_WIDTH_SHIFT;
939 val |= LANE_ADP_CS_1_TARGET_WIDTH_DUAL <<
940 LANE_ADP_CS_1_TARGET_WIDTH_SHIFT;
946 val |= LANE_ADP_CS_1_LB;
948 return tb_port_write(port, &val, TB_CFG_PORT,
949 port->cap_phy + LANE_ADP_CS_1, 1);
952 static int tb_port_lane_bonding_enable(struct tb_port *port)
957 * Enable lane bonding for both links if not already enabled by
958 * for example the boot firmware.
960 ret = tb_port_get_link_width(port);
962 ret = tb_port_set_link_width(port, 2);
967 ret = tb_port_get_link_width(port->dual_link_port);
969 ret = tb_port_set_link_width(port->dual_link_port, 2);
971 tb_port_set_link_width(port, 1);
977 port->dual_link_port->bonded = true;
982 static void tb_port_lane_bonding_disable(struct tb_port *port)
984 port->dual_link_port->bonded = false;
985 port->bonded = false;
987 tb_port_set_link_width(port->dual_link_port, 1);
988 tb_port_set_link_width(port, 1);
992 * tb_port_is_enabled() - Is the adapter port enabled
993 * @port: Port to check
995 bool tb_port_is_enabled(struct tb_port *port)
997 switch (port->config.type) {
998 case TB_TYPE_PCIE_UP:
999 case TB_TYPE_PCIE_DOWN:
1000 return tb_pci_port_is_enabled(port);
1002 case TB_TYPE_DP_HDMI_IN:
1003 case TB_TYPE_DP_HDMI_OUT:
1004 return tb_dp_port_is_enabled(port);
1006 case TB_TYPE_USB3_UP:
1007 case TB_TYPE_USB3_DOWN:
1008 return tb_usb3_port_is_enabled(port);
1016 * tb_usb3_port_is_enabled() - Is the USB3 adapter port enabled
1017 * @port: USB3 adapter port to check
1019 bool tb_usb3_port_is_enabled(struct tb_port *port)
1023 if (tb_port_read(port, &data, TB_CFG_PORT,
1024 port->cap_adap + ADP_USB3_CS_0, 1))
1027 return !!(data & ADP_USB3_CS_0_PE);
1031 * tb_usb3_port_enable() - Enable USB3 adapter port
1032 * @port: USB3 adapter port to enable
1033 * @enable: Enable/disable the USB3 adapter
1035 int tb_usb3_port_enable(struct tb_port *port, bool enable)
1037 u32 word = enable ? (ADP_USB3_CS_0_PE | ADP_USB3_CS_0_V)
1040 if (!port->cap_adap)
1042 return tb_port_write(port, &word, TB_CFG_PORT,
1043 port->cap_adap + ADP_USB3_CS_0, 1);
1047 * tb_pci_port_is_enabled() - Is the PCIe adapter port enabled
1048 * @port: PCIe port to check
1050 bool tb_pci_port_is_enabled(struct tb_port *port)
1054 if (tb_port_read(port, &data, TB_CFG_PORT,
1055 port->cap_adap + ADP_PCIE_CS_0, 1))
1058 return !!(data & ADP_PCIE_CS_0_PE);
1062 * tb_pci_port_enable() - Enable PCIe adapter port
1063 * @port: PCIe port to enable
1064 * @enable: Enable/disable the PCIe adapter
1066 int tb_pci_port_enable(struct tb_port *port, bool enable)
1068 u32 word = enable ? ADP_PCIE_CS_0_PE : 0x0;
1069 if (!port->cap_adap)
1071 return tb_port_write(port, &word, TB_CFG_PORT,
1072 port->cap_adap + ADP_PCIE_CS_0, 1);
1076 * tb_dp_port_hpd_is_active() - Is HPD already active
1077 * @port: DP out port to check
1079 * Checks if the DP OUT adapter port has HDP bit already set.
1081 int tb_dp_port_hpd_is_active(struct tb_port *port)
1086 ret = tb_port_read(port, &data, TB_CFG_PORT,
1087 port->cap_adap + ADP_DP_CS_2, 1);
1091 return !!(data & ADP_DP_CS_2_HDP);
1095 * tb_dp_port_hpd_clear() - Clear HPD from DP IN port
1096 * @port: Port to clear HPD
1098 * If the DP IN port has HDP set, this function can be used to clear it.
1100 int tb_dp_port_hpd_clear(struct tb_port *port)
1105 ret = tb_port_read(port, &data, TB_CFG_PORT,
1106 port->cap_adap + ADP_DP_CS_3, 1);
1110 data |= ADP_DP_CS_3_HDPC;
1111 return tb_port_write(port, &data, TB_CFG_PORT,
1112 port->cap_adap + ADP_DP_CS_3, 1);
1116 * tb_dp_port_set_hops() - Set video/aux Hop IDs for DP port
1117 * @port: DP IN/OUT port to set hops
1118 * @video: Video Hop ID
1119 * @aux_tx: AUX TX Hop ID
1120 * @aux_rx: AUX RX Hop ID
1122 * Programs specified Hop IDs for DP IN/OUT port.
1124 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
1125 unsigned int aux_tx, unsigned int aux_rx)
1130 ret = tb_port_read(port, data, TB_CFG_PORT,
1131 port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1135 data[0] &= ~ADP_DP_CS_0_VIDEO_HOPID_MASK;
1136 data[1] &= ~ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1137 data[1] &= ~ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1139 data[0] |= (video << ADP_DP_CS_0_VIDEO_HOPID_SHIFT) &
1140 ADP_DP_CS_0_VIDEO_HOPID_MASK;
1141 data[1] |= aux_tx & ADP_DP_CS_1_AUX_TX_HOPID_MASK;
1142 data[1] |= (aux_rx << ADP_DP_CS_1_AUX_RX_HOPID_SHIFT) &
1143 ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1145 return tb_port_write(port, data, TB_CFG_PORT,
1146 port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1150 * tb_dp_port_is_enabled() - Is DP adapter port enabled
1151 * @port: DP adapter port to check
1153 bool tb_dp_port_is_enabled(struct tb_port *port)
1157 if (tb_port_read(port, data, TB_CFG_PORT, port->cap_adap + ADP_DP_CS_0,
1161 return !!(data[0] & (ADP_DP_CS_0_VE | ADP_DP_CS_0_AE));
1165 * tb_dp_port_enable() - Enables/disables DP paths of a port
1166 * @port: DP IN/OUT port
1167 * @enable: Enable/disable DP path
1169 * Once Hop IDs are programmed DP paths can be enabled or disabled by
1170 * calling this function.
1172 int tb_dp_port_enable(struct tb_port *port, bool enable)
1177 ret = tb_port_read(port, data, TB_CFG_PORT,
1178 port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1183 data[0] |= ADP_DP_CS_0_VE | ADP_DP_CS_0_AE;
1185 data[0] &= ~(ADP_DP_CS_0_VE | ADP_DP_CS_0_AE);
1187 return tb_port_write(port, data, TB_CFG_PORT,
1188 port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1191 /* switch utility functions */
1193 static const char *tb_switch_generation_name(const struct tb_switch *sw)
1195 switch (sw->generation) {
1197 return "Thunderbolt 1";
1199 return "Thunderbolt 2";
1201 return "Thunderbolt 3";
1209 static void tb_dump_switch(const struct tb *tb, const struct tb_switch *sw)
1211 const struct tb_regs_switch_header *regs = &sw->config;
1213 tb_dbg(tb, " %s Switch: %x:%x (Revision: %d, TB Version: %d)\n",
1214 tb_switch_generation_name(sw), regs->vendor_id, regs->device_id,
1215 regs->revision, regs->thunderbolt_version);
1216 tb_dbg(tb, " Max Port Number: %d\n", regs->max_port_number);
1217 tb_dbg(tb, " Config:\n");
1219 " Upstream Port Number: %d Depth: %d Route String: %#llx Enabled: %d, PlugEventsDelay: %dms\n",
1220 regs->upstream_port_number, regs->depth,
1221 (((u64) regs->route_hi) << 32) | regs->route_lo,
1222 regs->enabled, regs->plug_events_delay);
1223 tb_dbg(tb, " unknown1: %#x unknown4: %#x\n",
1224 regs->__unknown1, regs->__unknown4);
1228 * reset_switch() - reconfigure route, enable and send TB_CFG_PKG_RESET
1230 * Return: Returns 0 on success or an error code on failure.
1232 int tb_switch_reset(struct tb *tb, u64 route)
1234 struct tb_cfg_result res;
1235 struct tb_regs_switch_header header = {
1236 header.route_hi = route >> 32,
1237 header.route_lo = route,
1238 header.enabled = true,
1240 tb_dbg(tb, "resetting switch at %llx\n", route);
1241 res.err = tb_cfg_write(tb->ctl, ((u32 *) &header) + 2, route,
1245 res = tb_cfg_reset(tb->ctl, route, TB_CFG_DEFAULT_TIMEOUT);
1252 * tb_plug_events_active() - enable/disable plug events on a switch
1254 * Also configures a sane plug_events_delay of 255ms.
1256 * Return: Returns 0 on success or an error code on failure.
1258 static int tb_plug_events_active(struct tb_switch *sw, bool active)
1263 if (tb_switch_is_icm(sw))
1266 sw->config.plug_events_delay = 0xff;
1267 res = tb_sw_write(sw, ((u32 *) &sw->config) + 4, TB_CFG_SWITCH, 4, 1);
1271 /* Plug events are always enabled in USB4 */
1272 if (tb_switch_is_usb4(sw))
1275 res = tb_sw_read(sw, &data, TB_CFG_SWITCH, sw->cap_plug_events + 1, 1);
1280 data = data & 0xFFFFFF83;
1281 switch (sw->config.device_id) {
1282 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
1283 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
1284 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
1292 return tb_sw_write(sw, &data, TB_CFG_SWITCH,
1293 sw->cap_plug_events + 1, 1);
1296 static ssize_t authorized_show(struct device *dev,
1297 struct device_attribute *attr,
1300 struct tb_switch *sw = tb_to_switch(dev);
1302 return sprintf(buf, "%u\n", sw->authorized);
1305 static int tb_switch_set_authorized(struct tb_switch *sw, unsigned int val)
1309 if (!mutex_trylock(&sw->tb->lock))
1310 return restart_syscall();
1316 /* Approve switch */
1319 ret = tb_domain_approve_switch_key(sw->tb, sw);
1321 ret = tb_domain_approve_switch(sw->tb, sw);
1324 /* Challenge switch */
1327 ret = tb_domain_challenge_switch_key(sw->tb, sw);
1335 sw->authorized = val;
1336 /* Notify status change to the userspace */
1337 kobject_uevent(&sw->dev.kobj, KOBJ_CHANGE);
1341 mutex_unlock(&sw->tb->lock);
1345 static ssize_t authorized_store(struct device *dev,
1346 struct device_attribute *attr,
1347 const char *buf, size_t count)
1349 struct tb_switch *sw = tb_to_switch(dev);
1353 ret = kstrtouint(buf, 0, &val);
1359 pm_runtime_get_sync(&sw->dev);
1360 ret = tb_switch_set_authorized(sw, val);
1361 pm_runtime_mark_last_busy(&sw->dev);
1362 pm_runtime_put_autosuspend(&sw->dev);
1364 return ret ? ret : count;
1366 static DEVICE_ATTR_RW(authorized);
1368 static ssize_t boot_show(struct device *dev, struct device_attribute *attr,
1371 struct tb_switch *sw = tb_to_switch(dev);
1373 return sprintf(buf, "%u\n", sw->boot);
1375 static DEVICE_ATTR_RO(boot);
1377 static ssize_t device_show(struct device *dev, struct device_attribute *attr,
1380 struct tb_switch *sw = tb_to_switch(dev);
1382 return sprintf(buf, "%#x\n", sw->device);
1384 static DEVICE_ATTR_RO(device);
1387 device_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1389 struct tb_switch *sw = tb_to_switch(dev);
1391 return sprintf(buf, "%s\n", sw->device_name ? sw->device_name : "");
1393 static DEVICE_ATTR_RO(device_name);
1396 generation_show(struct device *dev, struct device_attribute *attr, char *buf)
1398 struct tb_switch *sw = tb_to_switch(dev);
1400 return sprintf(buf, "%u\n", sw->generation);
1402 static DEVICE_ATTR_RO(generation);
1404 static ssize_t key_show(struct device *dev, struct device_attribute *attr,
1407 struct tb_switch *sw = tb_to_switch(dev);
1410 if (!mutex_trylock(&sw->tb->lock))
1411 return restart_syscall();
1414 ret = sprintf(buf, "%*phN\n", TB_SWITCH_KEY_SIZE, sw->key);
1416 ret = sprintf(buf, "\n");
1418 mutex_unlock(&sw->tb->lock);
1422 static ssize_t key_store(struct device *dev, struct device_attribute *attr,
1423 const char *buf, size_t count)
1425 struct tb_switch *sw = tb_to_switch(dev);
1426 u8 key[TB_SWITCH_KEY_SIZE];
1427 ssize_t ret = count;
1430 if (!strcmp(buf, "\n"))
1432 else if (hex2bin(key, buf, sizeof(key)))
1435 if (!mutex_trylock(&sw->tb->lock))
1436 return restart_syscall();
1438 if (sw->authorized) {
1445 sw->key = kmemdup(key, sizeof(key), GFP_KERNEL);
1451 mutex_unlock(&sw->tb->lock);
1454 static DEVICE_ATTR(key, 0600, key_show, key_store);
1456 static ssize_t speed_show(struct device *dev, struct device_attribute *attr,
1459 struct tb_switch *sw = tb_to_switch(dev);
1461 return sprintf(buf, "%u.0 Gb/s\n", sw->link_speed);
1465 * Currently all lanes must run at the same speed but we expose here
1466 * both directions to allow possible asymmetric links in the future.
1468 static DEVICE_ATTR(rx_speed, 0444, speed_show, NULL);
1469 static DEVICE_ATTR(tx_speed, 0444, speed_show, NULL);
1471 static ssize_t lanes_show(struct device *dev, struct device_attribute *attr,
1474 struct tb_switch *sw = tb_to_switch(dev);
1476 return sprintf(buf, "%u\n", sw->link_width);
1480 * Currently link has same amount of lanes both directions (1 or 2) but
1481 * expose them separately to allow possible asymmetric links in the future.
1483 static DEVICE_ATTR(rx_lanes, 0444, lanes_show, NULL);
1484 static DEVICE_ATTR(tx_lanes, 0444, lanes_show, NULL);
1486 static ssize_t nvm_authenticate_show(struct device *dev,
1487 struct device_attribute *attr, char *buf)
1489 struct tb_switch *sw = tb_to_switch(dev);
1492 nvm_get_auth_status(sw, &status);
1493 return sprintf(buf, "%#x\n", status);
1496 static ssize_t nvm_authenticate_sysfs(struct device *dev, const char *buf,
1499 struct tb_switch *sw = tb_to_switch(dev);
1503 pm_runtime_get_sync(&sw->dev);
1505 if (!mutex_trylock(&sw->tb->lock)) {
1506 ret = restart_syscall();
1510 /* If NVMem devices are not yet added */
1516 ret = kstrtoint(buf, 10, &val);
1520 /* Always clear the authentication status */
1521 nvm_clear_auth_status(sw);
1524 if (!sw->nvm->flushed) {
1525 if (!sw->nvm->buf) {
1530 ret = nvm_validate_and_write(sw);
1531 if (ret || val == WRITE_ONLY)
1534 if (val == WRITE_AND_AUTHENTICATE) {
1536 ret = tb_lc_force_power(sw);
1538 sw->nvm->authenticating = true;
1539 ret = nvm_authenticate(sw);
1545 mutex_unlock(&sw->tb->lock);
1547 pm_runtime_mark_last_busy(&sw->dev);
1548 pm_runtime_put_autosuspend(&sw->dev);
1553 static ssize_t nvm_authenticate_store(struct device *dev,
1554 struct device_attribute *attr, const char *buf, size_t count)
1556 int ret = nvm_authenticate_sysfs(dev, buf, false);
1561 static DEVICE_ATTR_RW(nvm_authenticate);
1563 static ssize_t nvm_authenticate_on_disconnect_show(struct device *dev,
1564 struct device_attribute *attr, char *buf)
1566 return nvm_authenticate_show(dev, attr, buf);
1569 static ssize_t nvm_authenticate_on_disconnect_store(struct device *dev,
1570 struct device_attribute *attr, const char *buf, size_t count)
1574 ret = nvm_authenticate_sysfs(dev, buf, true);
1575 return ret ? ret : count;
1577 static DEVICE_ATTR_RW(nvm_authenticate_on_disconnect);
1579 static ssize_t nvm_version_show(struct device *dev,
1580 struct device_attribute *attr, char *buf)
1582 struct tb_switch *sw = tb_to_switch(dev);
1585 if (!mutex_trylock(&sw->tb->lock))
1586 return restart_syscall();
1593 ret = sprintf(buf, "%x.%x\n", sw->nvm->major, sw->nvm->minor);
1595 mutex_unlock(&sw->tb->lock);
1599 static DEVICE_ATTR_RO(nvm_version);
1601 static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
1604 struct tb_switch *sw = tb_to_switch(dev);
1606 return sprintf(buf, "%#x\n", sw->vendor);
1608 static DEVICE_ATTR_RO(vendor);
1611 vendor_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1613 struct tb_switch *sw = tb_to_switch(dev);
1615 return sprintf(buf, "%s\n", sw->vendor_name ? sw->vendor_name : "");
1617 static DEVICE_ATTR_RO(vendor_name);
1619 static ssize_t unique_id_show(struct device *dev, struct device_attribute *attr,
1622 struct tb_switch *sw = tb_to_switch(dev);
1624 return sprintf(buf, "%pUb\n", sw->uuid);
1626 static DEVICE_ATTR_RO(unique_id);
1628 static struct attribute *switch_attrs[] = {
1629 &dev_attr_authorized.attr,
1630 &dev_attr_boot.attr,
1631 &dev_attr_device.attr,
1632 &dev_attr_device_name.attr,
1633 &dev_attr_generation.attr,
1635 &dev_attr_nvm_authenticate.attr,
1636 &dev_attr_nvm_authenticate_on_disconnect.attr,
1637 &dev_attr_nvm_version.attr,
1638 &dev_attr_rx_speed.attr,
1639 &dev_attr_rx_lanes.attr,
1640 &dev_attr_tx_speed.attr,
1641 &dev_attr_tx_lanes.attr,
1642 &dev_attr_vendor.attr,
1643 &dev_attr_vendor_name.attr,
1644 &dev_attr_unique_id.attr,
1648 static umode_t switch_attr_is_visible(struct kobject *kobj,
1649 struct attribute *attr, int n)
1651 struct device *dev = container_of(kobj, struct device, kobj);
1652 struct tb_switch *sw = tb_to_switch(dev);
1654 if (attr == &dev_attr_device.attr) {
1657 } else if (attr == &dev_attr_device_name.attr) {
1658 if (!sw->device_name)
1660 } else if (attr == &dev_attr_vendor.attr) {
1663 } else if (attr == &dev_attr_vendor_name.attr) {
1664 if (!sw->vendor_name)
1666 } else if (attr == &dev_attr_key.attr) {
1668 sw->tb->security_level == TB_SECURITY_SECURE &&
1669 sw->security_level == TB_SECURITY_SECURE)
1672 } else if (attr == &dev_attr_rx_speed.attr ||
1673 attr == &dev_attr_rx_lanes.attr ||
1674 attr == &dev_attr_tx_speed.attr ||
1675 attr == &dev_attr_tx_lanes.attr) {
1679 } else if (attr == &dev_attr_nvm_authenticate.attr) {
1680 if (nvm_upgradeable(sw))
1683 } else if (attr == &dev_attr_nvm_version.attr) {
1684 if (nvm_readable(sw))
1687 } else if (attr == &dev_attr_boot.attr) {
1691 } else if (attr == &dev_attr_nvm_authenticate_on_disconnect.attr) {
1692 if (sw->quirks & QUIRK_FORCE_POWER_LINK_CONTROLLER)
1697 return sw->safe_mode ? 0 : attr->mode;
1700 static struct attribute_group switch_group = {
1701 .is_visible = switch_attr_is_visible,
1702 .attrs = switch_attrs,
1705 static const struct attribute_group *switch_groups[] = {
1710 static void tb_switch_release(struct device *dev)
1712 struct tb_switch *sw = tb_to_switch(dev);
1713 struct tb_port *port;
1715 dma_port_free(sw->dma_port);
1717 tb_switch_for_each_port(sw, port) {
1718 if (!port->disabled) {
1719 ida_destroy(&port->in_hopids);
1720 ida_destroy(&port->out_hopids);
1725 kfree(sw->device_name);
1726 kfree(sw->vendor_name);
1734 * Currently only need to provide the callbacks. Everything else is handled
1735 * in the connection manager.
1737 static int __maybe_unused tb_switch_runtime_suspend(struct device *dev)
1739 struct tb_switch *sw = tb_to_switch(dev);
1740 const struct tb_cm_ops *cm_ops = sw->tb->cm_ops;
1742 if (cm_ops->runtime_suspend_switch)
1743 return cm_ops->runtime_suspend_switch(sw);
1748 static int __maybe_unused tb_switch_runtime_resume(struct device *dev)
1750 struct tb_switch *sw = tb_to_switch(dev);
1751 const struct tb_cm_ops *cm_ops = sw->tb->cm_ops;
1753 if (cm_ops->runtime_resume_switch)
1754 return cm_ops->runtime_resume_switch(sw);
1758 static const struct dev_pm_ops tb_switch_pm_ops = {
1759 SET_RUNTIME_PM_OPS(tb_switch_runtime_suspend, tb_switch_runtime_resume,
1763 struct device_type tb_switch_type = {
1764 .name = "thunderbolt_device",
1765 .release = tb_switch_release,
1766 .pm = &tb_switch_pm_ops,
1769 static int tb_switch_get_generation(struct tb_switch *sw)
1771 switch (sw->config.device_id) {
1772 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
1773 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
1774 case PCI_DEVICE_ID_INTEL_LIGHT_PEAK:
1775 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
1776 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
1777 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
1778 case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_2C_BRIDGE:
1779 case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_4C_BRIDGE:
1782 case PCI_DEVICE_ID_INTEL_WIN_RIDGE_2C_BRIDGE:
1783 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
1784 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
1787 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
1788 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
1789 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE:
1790 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
1791 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
1792 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
1793 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
1794 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
1795 case PCI_DEVICE_ID_INTEL_ICL_NHI0:
1796 case PCI_DEVICE_ID_INTEL_ICL_NHI1:
1800 if (tb_switch_is_usb4(sw))
1804 * For unknown switches assume generation to be 1 to be
1807 tb_sw_warn(sw, "unsupported switch device id %#x\n",
1808 sw->config.device_id);
1813 static bool tb_switch_exceeds_max_depth(const struct tb_switch *sw, int depth)
1817 if (tb_switch_is_usb4(sw) ||
1818 (sw->tb->root_switch && tb_switch_is_usb4(sw->tb->root_switch)))
1819 max_depth = USB4_SWITCH_MAX_DEPTH;
1821 max_depth = TB_SWITCH_MAX_DEPTH;
1823 return depth > max_depth;
1827 * tb_switch_alloc() - allocate a switch
1828 * @tb: Pointer to the owning domain
1829 * @parent: Parent device for this switch
1830 * @route: Route string for this switch
1832 * Allocates and initializes a switch. Will not upload configuration to
1833 * the switch. For that you need to call tb_switch_configure()
1834 * separately. The returned switch should be released by calling
1837 * Return: Pointer to the allocated switch or ERR_PTR() in case of
1840 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
1843 struct tb_switch *sw;
1847 /* Unlock the downstream port so we can access the switch below */
1849 struct tb_switch *parent_sw = tb_to_switch(parent);
1850 struct tb_port *down;
1852 down = tb_port_at(route, parent_sw);
1853 tb_port_unlock(down);
1856 depth = tb_route_length(route);
1858 upstream_port = tb_cfg_get_upstream_port(tb->ctl, route);
1859 if (upstream_port < 0)
1860 return ERR_PTR(upstream_port);
1862 sw = kzalloc(sizeof(*sw), GFP_KERNEL);
1864 return ERR_PTR(-ENOMEM);
1867 ret = tb_cfg_read(tb->ctl, &sw->config, route, 0, TB_CFG_SWITCH, 0, 5);
1869 goto err_free_sw_ports;
1871 sw->generation = tb_switch_get_generation(sw);
1873 tb_dbg(tb, "current switch config:\n");
1874 tb_dump_switch(tb, sw);
1876 /* configure switch */
1877 sw->config.upstream_port_number = upstream_port;
1878 sw->config.depth = depth;
1879 sw->config.route_hi = upper_32_bits(route);
1880 sw->config.route_lo = lower_32_bits(route);
1881 sw->config.enabled = 0;
1883 /* Make sure we do not exceed maximum topology limit */
1884 if (tb_switch_exceeds_max_depth(sw, depth)) {
1885 ret = -EADDRNOTAVAIL;
1886 goto err_free_sw_ports;
1889 /* initialize ports */
1890 sw->ports = kcalloc(sw->config.max_port_number + 1, sizeof(*sw->ports),
1894 goto err_free_sw_ports;
1897 for (i = 0; i <= sw->config.max_port_number; i++) {
1898 /* minimum setup for tb_find_cap and tb_drom_read to work */
1899 sw->ports[i].sw = sw;
1900 sw->ports[i].port = i;
1903 ret = tb_switch_find_vse_cap(sw, TB_VSE_CAP_PLUG_EVENTS);
1905 sw->cap_plug_events = ret;
1907 ret = tb_switch_find_vse_cap(sw, TB_VSE_CAP_LINK_CONTROLLER);
1911 /* Root switch is always authorized */
1913 sw->authorized = true;
1915 device_initialize(&sw->dev);
1916 sw->dev.parent = parent;
1917 sw->dev.bus = &tb_bus_type;
1918 sw->dev.type = &tb_switch_type;
1919 sw->dev.groups = switch_groups;
1920 dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
1928 return ERR_PTR(ret);
1932 * tb_switch_alloc_safe_mode() - allocate a switch that is in safe mode
1933 * @tb: Pointer to the owning domain
1934 * @parent: Parent device for this switch
1935 * @route: Route string for this switch
1937 * This creates a switch in safe mode. This means the switch pretty much
1938 * lacks all capabilities except DMA configuration port before it is
1939 * flashed with a valid NVM firmware.
1941 * The returned switch must be released by calling tb_switch_put().
1943 * Return: Pointer to the allocated switch or ERR_PTR() in case of failure
1946 tb_switch_alloc_safe_mode(struct tb *tb, struct device *parent, u64 route)
1948 struct tb_switch *sw;
1950 sw = kzalloc(sizeof(*sw), GFP_KERNEL);
1952 return ERR_PTR(-ENOMEM);
1955 sw->config.depth = tb_route_length(route);
1956 sw->config.route_hi = upper_32_bits(route);
1957 sw->config.route_lo = lower_32_bits(route);
1958 sw->safe_mode = true;
1960 device_initialize(&sw->dev);
1961 sw->dev.parent = parent;
1962 sw->dev.bus = &tb_bus_type;
1963 sw->dev.type = &tb_switch_type;
1964 sw->dev.groups = switch_groups;
1965 dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
1971 * tb_switch_configure() - Uploads configuration to the switch
1972 * @sw: Switch to configure
1974 * Call this function before the switch is added to the system. It will
1975 * upload configuration to the switch and makes it available for the
1976 * connection manager to use. Can be called to the switch again after
1977 * resume from low power states to re-initialize it.
1979 * Return: %0 in case of success and negative errno in case of failure
1981 int tb_switch_configure(struct tb_switch *sw)
1983 struct tb *tb = sw->tb;
1987 route = tb_route(sw);
1989 tb_dbg(tb, "%s Switch at %#llx (depth: %d, up port: %d)\n",
1990 sw->config.enabled ? "restoring " : "initializing", route,
1991 tb_route_length(route), sw->config.upstream_port_number);
1993 sw->config.enabled = 1;
1995 if (tb_switch_is_usb4(sw)) {
1997 * For USB4 devices, we need to program the CM version
1998 * accordingly so that it knows to expose all the
1999 * additional capabilities.
2001 sw->config.cmuv = USB4_VERSION_1_0;
2003 /* Enumerate the switch */
2004 ret = tb_sw_write(sw, (u32 *)&sw->config + 1, TB_CFG_SWITCH,
2009 ret = usb4_switch_setup(sw);
2013 ret = usb4_switch_configure_link(sw);
2015 if (sw->config.vendor_id != PCI_VENDOR_ID_INTEL)
2016 tb_sw_warn(sw, "unknown switch vendor id %#x\n",
2017 sw->config.vendor_id);
2019 if (!sw->cap_plug_events) {
2020 tb_sw_warn(sw, "cannot find TB_VSE_CAP_PLUG_EVENTS aborting\n");
2024 /* Enumerate the switch */
2025 ret = tb_sw_write(sw, (u32 *)&sw->config + 1, TB_CFG_SWITCH,
2030 ret = tb_lc_configure_link(sw);
2035 return tb_plug_events_active(sw, true);
2038 static int tb_switch_set_uuid(struct tb_switch *sw)
2047 if (tb_switch_is_usb4(sw)) {
2048 ret = usb4_switch_read_uid(sw, &sw->uid);
2054 * The newer controllers include fused UUID as part of
2055 * link controller specific registers
2057 ret = tb_lc_read_uuid(sw, uuid);
2067 * ICM generates UUID based on UID and fills the upper
2068 * two words with ones. This is not strictly following
2069 * UUID format but we want to be compatible with it so
2070 * we do the same here.
2072 uuid[0] = sw->uid & 0xffffffff;
2073 uuid[1] = (sw->uid >> 32) & 0xffffffff;
2074 uuid[2] = 0xffffffff;
2075 uuid[3] = 0xffffffff;
2078 sw->uuid = kmemdup(uuid, sizeof(uuid), GFP_KERNEL);
2084 static int tb_switch_add_dma_port(struct tb_switch *sw)
2089 switch (sw->generation) {
2091 /* Only root switch can be upgraded */
2097 ret = tb_switch_set_uuid(sw);
2104 * DMA port is the only thing available when the switch
2112 /* Root switch DMA port requires running firmware */
2113 if (!tb_route(sw) && !tb_switch_is_icm(sw))
2116 sw->dma_port = dma_port_alloc(sw);
2120 if (sw->no_nvm_upgrade)
2124 * If there is status already set then authentication failed
2125 * when the dma_port_flash_update_auth() returned. Power cycling
2126 * is not needed (it was done already) so only thing we do here
2127 * is to unblock runtime PM of the root port.
2129 nvm_get_auth_status(sw, &status);
2132 nvm_authenticate_complete_dma_port(sw);
2137 * Check status of the previous flash authentication. If there
2138 * is one we need to power cycle the switch in any case to make
2139 * it functional again.
2141 ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
2145 /* Now we can allow root port to suspend again */
2147 nvm_authenticate_complete_dma_port(sw);
2150 tb_sw_info(sw, "switch flash authentication failed\n");
2151 nvm_set_auth_status(sw, status);
2154 tb_sw_info(sw, "power cycling the switch now\n");
2155 dma_port_power_cycle(sw->dma_port);
2158 * We return error here which causes the switch adding failure.
2159 * It should appear back after power cycle is complete.
2164 static void tb_switch_default_link_ports(struct tb_switch *sw)
2168 for (i = 1; i <= sw->config.max_port_number; i += 2) {
2169 struct tb_port *port = &sw->ports[i];
2170 struct tb_port *subordinate;
2172 if (!tb_port_is_null(port))
2175 /* Check for the subordinate port */
2176 if (i == sw->config.max_port_number ||
2177 !tb_port_is_null(&sw->ports[i + 1]))
2180 /* Link them if not already done so (by DROM) */
2181 subordinate = &sw->ports[i + 1];
2182 if (!port->dual_link_port && !subordinate->dual_link_port) {
2184 port->dual_link_port = subordinate;
2185 subordinate->link_nr = 1;
2186 subordinate->dual_link_port = port;
2188 tb_sw_dbg(sw, "linked ports %d <-> %d\n",
2189 port->port, subordinate->port);
2194 static bool tb_switch_lane_bonding_possible(struct tb_switch *sw)
2196 const struct tb_port *up = tb_upstream_port(sw);
2198 if (!up->dual_link_port || !up->dual_link_port->remote)
2201 if (tb_switch_is_usb4(sw))
2202 return usb4_switch_lane_bonding_possible(sw);
2203 return tb_lc_lane_bonding_possible(sw);
2206 static int tb_switch_update_link_attributes(struct tb_switch *sw)
2209 bool change = false;
2212 if (!tb_route(sw) || tb_switch_is_icm(sw))
2215 up = tb_upstream_port(sw);
2217 ret = tb_port_get_link_speed(up);
2220 if (sw->link_speed != ret)
2222 sw->link_speed = ret;
2224 ret = tb_port_get_link_width(up);
2227 if (sw->link_width != ret)
2229 sw->link_width = ret;
2231 /* Notify userspace that there is possible link attribute change */
2232 if (device_is_registered(&sw->dev) && change)
2233 kobject_uevent(&sw->dev.kobj, KOBJ_CHANGE);
2239 * tb_switch_lane_bonding_enable() - Enable lane bonding
2240 * @sw: Switch to enable lane bonding
2242 * Connection manager can call this function to enable lane bonding of a
2243 * switch. If conditions are correct and both switches support the feature,
2244 * lanes are bonded. It is safe to call this to any switch.
2246 int tb_switch_lane_bonding_enable(struct tb_switch *sw)
2248 struct tb_switch *parent = tb_to_switch(sw->dev.parent);
2249 struct tb_port *up, *down;
2250 u64 route = tb_route(sw);
2256 if (!tb_switch_lane_bonding_possible(sw))
2259 up = tb_upstream_port(sw);
2260 down = tb_port_at(route, parent);
2262 if (!tb_port_is_width_supported(up, 2) ||
2263 !tb_port_is_width_supported(down, 2))
2266 ret = tb_port_lane_bonding_enable(up);
2268 tb_port_warn(up, "failed to enable lane bonding\n");
2272 ret = tb_port_lane_bonding_enable(down);
2274 tb_port_warn(down, "failed to enable lane bonding\n");
2275 tb_port_lane_bonding_disable(up);
2279 tb_switch_update_link_attributes(sw);
2281 tb_sw_dbg(sw, "lane bonding enabled\n");
2286 * tb_switch_lane_bonding_disable() - Disable lane bonding
2287 * @sw: Switch whose lane bonding to disable
2289 * Disables lane bonding between @sw and parent. This can be called even
2290 * if lanes were not bonded originally.
2292 void tb_switch_lane_bonding_disable(struct tb_switch *sw)
2294 struct tb_switch *parent = tb_to_switch(sw->dev.parent);
2295 struct tb_port *up, *down;
2300 up = tb_upstream_port(sw);
2304 down = tb_port_at(tb_route(sw), parent);
2306 tb_port_lane_bonding_disable(up);
2307 tb_port_lane_bonding_disable(down);
2309 tb_switch_update_link_attributes(sw);
2310 tb_sw_dbg(sw, "lane bonding disabled\n");
2314 * tb_switch_add() - Add a switch to the domain
2315 * @sw: Switch to add
2317 * This is the last step in adding switch to the domain. It will read
2318 * identification information from DROM and initializes ports so that
2319 * they can be used to connect other switches. The switch will be
2320 * exposed to the userspace when this function successfully returns. To
2321 * remove and release the switch, call tb_switch_remove().
2323 * Return: %0 in case of success and negative errno in case of failure
2325 int tb_switch_add(struct tb_switch *sw)
2330 * Initialize DMA control port now before we read DROM. Recent
2331 * host controllers have more complete DROM on NVM that includes
2332 * vendor and model identification strings which we then expose
2333 * to the userspace. NVM can be accessed through DMA
2334 * configuration based mailbox.
2336 ret = tb_switch_add_dma_port(sw);
2338 dev_err(&sw->dev, "failed to add DMA port\n");
2342 if (!sw->safe_mode) {
2344 ret = tb_drom_read(sw);
2346 dev_err(&sw->dev, "reading DROM failed\n");
2349 tb_sw_dbg(sw, "uid: %#llx\n", sw->uid);
2351 ret = tb_switch_set_uuid(sw);
2353 dev_err(&sw->dev, "failed to set UUID\n");
2357 for (i = 0; i <= sw->config.max_port_number; i++) {
2358 if (sw->ports[i].disabled) {
2359 tb_port_dbg(&sw->ports[i], "disabled by eeprom\n");
2362 ret = tb_init_port(&sw->ports[i]);
2364 dev_err(&sw->dev, "failed to initialize port %d\n", i);
2369 tb_switch_default_link_ports(sw);
2371 ret = tb_switch_update_link_attributes(sw);
2375 ret = tb_switch_tmu_init(sw);
2380 ret = device_add(&sw->dev);
2382 dev_err(&sw->dev, "failed to add device: %d\n", ret);
2387 dev_info(&sw->dev, "new device found, vendor=%#x device=%#x\n",
2388 sw->vendor, sw->device);
2389 if (sw->vendor_name && sw->device_name)
2390 dev_info(&sw->dev, "%s %s\n", sw->vendor_name,
2394 ret = tb_switch_nvm_add(sw);
2396 dev_err(&sw->dev, "failed to add NVM devices\n");
2397 device_del(&sw->dev);
2401 pm_runtime_set_active(&sw->dev);
2403 pm_runtime_set_autosuspend_delay(&sw->dev, TB_AUTOSUSPEND_DELAY);
2404 pm_runtime_use_autosuspend(&sw->dev);
2405 pm_runtime_mark_last_busy(&sw->dev);
2406 pm_runtime_enable(&sw->dev);
2407 pm_request_autosuspend(&sw->dev);
2414 * tb_switch_remove() - Remove and release a switch
2415 * @sw: Switch to remove
2417 * This will remove the switch from the domain and release it after last
2418 * reference count drops to zero. If there are switches connected below
2419 * this switch, they will be removed as well.
2421 void tb_switch_remove(struct tb_switch *sw)
2423 struct tb_port *port;
2426 pm_runtime_get_sync(&sw->dev);
2427 pm_runtime_disable(&sw->dev);
2430 /* port 0 is the switch itself and never has a remote */
2431 tb_switch_for_each_port(sw, port) {
2432 if (tb_port_has_remote(port)) {
2433 tb_switch_remove(port->remote->sw);
2434 port->remote = NULL;
2435 } else if (port->xdomain) {
2436 tb_xdomain_remove(port->xdomain);
2437 port->xdomain = NULL;
2440 /* Remove any downstream retimers */
2441 tb_retimer_remove_all(port);
2444 if (!sw->is_unplugged)
2445 tb_plug_events_active(sw, false);
2447 if (tb_switch_is_usb4(sw))
2448 usb4_switch_unconfigure_link(sw);
2450 tb_lc_unconfigure_link(sw);
2452 tb_switch_nvm_remove(sw);
2455 dev_info(&sw->dev, "device disconnected\n");
2456 device_unregister(&sw->dev);
2460 * tb_sw_set_unplugged() - set is_unplugged on switch and downstream switches
2462 void tb_sw_set_unplugged(struct tb_switch *sw)
2464 struct tb_port *port;
2466 if (sw == sw->tb->root_switch) {
2467 tb_sw_WARN(sw, "cannot unplug root switch\n");
2470 if (sw->is_unplugged) {
2471 tb_sw_WARN(sw, "is_unplugged already set\n");
2474 sw->is_unplugged = true;
2475 tb_switch_for_each_port(sw, port) {
2476 if (tb_port_has_remote(port))
2477 tb_sw_set_unplugged(port->remote->sw);
2478 else if (port->xdomain)
2479 port->xdomain->is_unplugged = true;
2483 int tb_switch_resume(struct tb_switch *sw)
2485 struct tb_port *port;
2488 tb_sw_dbg(sw, "resuming switch\n");
2491 * Check for UID of the connected switches except for root
2492 * switch which we assume cannot be removed.
2498 * Check first that we can still read the switch config
2499 * space. It may be that there is now another domain
2502 err = tb_cfg_get_upstream_port(sw->tb->ctl, tb_route(sw));
2504 tb_sw_info(sw, "switch not present anymore\n");
2508 if (tb_switch_is_usb4(sw))
2509 err = usb4_switch_read_uid(sw, &uid);
2511 err = tb_drom_read_uid_only(sw, &uid);
2513 tb_sw_warn(sw, "uid read failed\n");
2516 if (sw->uid != uid) {
2518 "changed while suspended (uid %#llx -> %#llx)\n",
2524 err = tb_switch_configure(sw);
2528 /* check for surviving downstream switches */
2529 tb_switch_for_each_port(sw, port) {
2530 if (!tb_port_has_remote(port) && !port->xdomain)
2533 if (tb_wait_for_port(port, true) <= 0) {
2535 "lost during suspend, disconnecting\n");
2536 if (tb_port_has_remote(port))
2537 tb_sw_set_unplugged(port->remote->sw);
2538 else if (port->xdomain)
2539 port->xdomain->is_unplugged = true;
2540 } else if (tb_port_has_remote(port) || port->xdomain) {
2542 * Always unlock the port so the downstream
2543 * switch/domain is accessible.
2545 if (tb_port_unlock(port))
2546 tb_port_warn(port, "failed to unlock port\n");
2547 if (port->remote && tb_switch_resume(port->remote->sw)) {
2549 "lost during suspend, disconnecting\n");
2550 tb_sw_set_unplugged(port->remote->sw);
2557 void tb_switch_suspend(struct tb_switch *sw)
2559 struct tb_port *port;
2562 err = tb_plug_events_active(sw, false);
2566 tb_switch_for_each_port(sw, port) {
2567 if (tb_port_has_remote(port))
2568 tb_switch_suspend(port->remote->sw);
2571 if (tb_switch_is_usb4(sw))
2572 usb4_switch_set_sleep(sw);
2574 tb_lc_set_sleep(sw);
2578 * tb_switch_query_dp_resource() - Query availability of DP resource
2579 * @sw: Switch whose DP resource is queried
2582 * Queries availability of DP resource for DP tunneling using switch
2583 * specific means. Returns %true if resource is available.
2585 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in)
2587 if (tb_switch_is_usb4(sw))
2588 return usb4_switch_query_dp_resource(sw, in);
2589 return tb_lc_dp_sink_query(sw, in);
2593 * tb_switch_alloc_dp_resource() - Allocate available DP resource
2594 * @sw: Switch whose DP resource is allocated
2597 * Allocates DP resource for DP tunneling. The resource must be
2598 * available for this to succeed (see tb_switch_query_dp_resource()).
2599 * Returns %0 in success and negative errno otherwise.
2601 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in)
2603 if (tb_switch_is_usb4(sw))
2604 return usb4_switch_alloc_dp_resource(sw, in);
2605 return tb_lc_dp_sink_alloc(sw, in);
2609 * tb_switch_dealloc_dp_resource() - De-allocate DP resource
2610 * @sw: Switch whose DP resource is de-allocated
2613 * De-allocates DP resource that was previously allocated for DP
2616 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in)
2620 if (tb_switch_is_usb4(sw))
2621 ret = usb4_switch_dealloc_dp_resource(sw, in);
2623 ret = tb_lc_dp_sink_dealloc(sw, in);
2626 tb_sw_warn(sw, "failed to de-allocate DP resource for port %d\n",
2630 struct tb_sw_lookup {
2638 static int tb_switch_match(struct device *dev, const void *data)
2640 struct tb_switch *sw = tb_to_switch(dev);
2641 const struct tb_sw_lookup *lookup = data;
2645 if (sw->tb != lookup->tb)
2649 return !memcmp(sw->uuid, lookup->uuid, sizeof(*lookup->uuid));
2651 if (lookup->route) {
2652 return sw->config.route_lo == lower_32_bits(lookup->route) &&
2653 sw->config.route_hi == upper_32_bits(lookup->route);
2656 /* Root switch is matched only by depth */
2660 return sw->link == lookup->link && sw->depth == lookup->depth;
2664 * tb_switch_find_by_link_depth() - Find switch by link and depth
2665 * @tb: Domain the switch belongs
2666 * @link: Link number the switch is connected
2667 * @depth: Depth of the switch in link
2669 * Returned switch has reference count increased so the caller needs to
2670 * call tb_switch_put() when done with the switch.
2672 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link, u8 depth)
2674 struct tb_sw_lookup lookup;
2677 memset(&lookup, 0, sizeof(lookup));
2680 lookup.depth = depth;
2682 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
2684 return tb_to_switch(dev);
2690 * tb_switch_find_by_uuid() - Find switch by UUID
2691 * @tb: Domain the switch belongs
2692 * @uuid: UUID to look for
2694 * Returned switch has reference count increased so the caller needs to
2695 * call tb_switch_put() when done with the switch.
2697 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid)
2699 struct tb_sw_lookup lookup;
2702 memset(&lookup, 0, sizeof(lookup));
2706 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
2708 return tb_to_switch(dev);
2714 * tb_switch_find_by_route() - Find switch by route string
2715 * @tb: Domain the switch belongs
2716 * @route: Route string to look for
2718 * Returned switch has reference count increased so the caller needs to
2719 * call tb_switch_put() when done with the switch.
2721 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route)
2723 struct tb_sw_lookup lookup;
2727 return tb_switch_get(tb->root_switch);
2729 memset(&lookup, 0, sizeof(lookup));
2731 lookup.route = route;
2733 dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
2735 return tb_to_switch(dev);
2741 * tb_switch_find_port() - return the first port of @type on @sw or NULL
2742 * @sw: Switch to find the port from
2743 * @type: Port type to look for
2745 struct tb_port *tb_switch_find_port(struct tb_switch *sw,
2746 enum tb_port_type type)
2748 struct tb_port *port;
2750 tb_switch_for_each_port(sw, port) {
2751 if (port->config.type == type)