1 // SPDX-License-Identifier: GPL-2.0
3 * Thunderbolt driver - bus logic (NHI independent)
5 * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
6 * Copyright (C) 2019, Intel Corporation
9 #include <linux/slab.h>
10 #include <linux/errno.h>
11 #include <linux/delay.h>
12 #include <linux/platform_data/x86/apple.h>
19 * struct tb_cm - Simple Thunderbolt connection manager
20 * @tunnel_list: List of active tunnels
21 * @hotplug_active: tb_handle_hotplug will stop progressing plug
22 * events and exit if this is not set (it needs to
23 * acquire the lock one more time). Used to drain wq
24 * after cfg has been paused.
27 struct list_head tunnel_list;
31 struct tb_hotplug_event {
32 struct work_struct work;
39 static void tb_handle_hotplug(struct work_struct *work);
41 static void tb_queue_hotplug(struct tb *tb, u64 route, u8 port, bool unplug)
43 struct tb_hotplug_event *ev;
45 ev = kmalloc(sizeof(*ev), GFP_KERNEL);
53 INIT_WORK(&ev->work, tb_handle_hotplug);
54 queue_work(tb->wq, &ev->work);
57 /* enumeration & hot plug handling */
59 static void tb_discover_tunnels(struct tb_switch *sw)
61 struct tb *tb = sw->tb;
62 struct tb_cm *tcm = tb_priv(tb);
65 tb_switch_for_each_port(sw, port) {
66 struct tb_tunnel *tunnel = NULL;
68 switch (port->config.type) {
69 case TB_TYPE_DP_HDMI_IN:
70 tunnel = tb_tunnel_discover_dp(tb, port);
73 case TB_TYPE_PCIE_DOWN:
74 tunnel = tb_tunnel_discover_pci(tb, port);
84 if (tb_tunnel_is_pci(tunnel)) {
85 struct tb_switch *parent = tunnel->dst_port->sw;
87 while (parent != tunnel->src_port->sw) {
89 parent = tb_switch_parent(parent);
93 list_add_tail(&tunnel->list, &tcm->tunnel_list);
96 tb_switch_for_each_port(sw, port) {
97 if (tb_port_has_remote(port))
98 tb_discover_tunnels(port->remote->sw);
102 static void tb_scan_xdomain(struct tb_port *port)
104 struct tb_switch *sw = port->sw;
105 struct tb *tb = sw->tb;
106 struct tb_xdomain *xd;
109 route = tb_downstream_route(port);
110 xd = tb_xdomain_find_by_route(tb, route);
116 xd = tb_xdomain_alloc(tb, &sw->dev, route, tb->root_switch->uuid,
119 tb_port_at(route, sw)->xdomain = xd;
124 static void tb_scan_port(struct tb_port *port);
127 * tb_scan_switch() - scan for and initialize downstream switches
129 static void tb_scan_switch(struct tb_switch *sw)
131 struct tb_port *port;
133 tb_switch_for_each_port(sw, port)
138 * tb_scan_port() - check for and initialize switches below port
140 static void tb_scan_port(struct tb_port *port)
142 struct tb_cm *tcm = tb_priv(port->sw->tb);
143 struct tb_port *upstream_port;
144 struct tb_switch *sw;
146 if (tb_is_upstream_port(port))
149 if (tb_port_is_dpout(port) && tb_dp_port_hpd_is_active(port) == 1 &&
150 !tb_dp_port_is_enabled(port)) {
151 tb_port_dbg(port, "DP adapter HPD set, queuing hotplug\n");
152 tb_queue_hotplug(port->sw->tb, tb_route(port->sw), port->port,
157 if (port->config.type != TB_TYPE_PORT)
159 if (port->dual_link_port && port->link_nr)
161 * Downstream switch is reachable through two ports.
162 * Only scan on the primary port (link_nr == 0).
164 if (tb_wait_for_port(port, false) <= 0)
167 tb_port_dbg(port, "port already has a remote\n");
170 sw = tb_switch_alloc(port->sw->tb, &port->sw->dev,
171 tb_downstream_route(port));
174 * If there is an error accessing the connected switch
175 * it may be connected to another domain. Also we allow
176 * the other domain to be connected to a max depth switch.
178 if (PTR_ERR(sw) == -EIO || PTR_ERR(sw) == -EADDRNOTAVAIL)
179 tb_scan_xdomain(port);
183 if (tb_switch_configure(sw)) {
189 * If there was previously another domain connected remove it
193 tb_xdomain_remove(port->xdomain);
194 port->xdomain = NULL;
198 * Do not send uevents until we have discovered all existing
199 * tunnels and know which switches were authorized already by
202 if (!tcm->hotplug_active)
203 dev_set_uevent_suppress(&sw->dev, true);
205 if (tb_switch_add(sw)) {
210 /* Link the switches using both links if available */
211 upstream_port = tb_upstream_port(sw);
212 port->remote = upstream_port;
213 upstream_port->remote = port;
214 if (port->dual_link_port && upstream_port->dual_link_port) {
215 port->dual_link_port->remote = upstream_port->dual_link_port;
216 upstream_port->dual_link_port->remote = port->dual_link_port;
222 static int tb_free_tunnel(struct tb *tb, enum tb_tunnel_type type,
223 struct tb_port *src_port, struct tb_port *dst_port)
225 struct tb_cm *tcm = tb_priv(tb);
226 struct tb_tunnel *tunnel;
228 list_for_each_entry(tunnel, &tcm->tunnel_list, list) {
229 if (tunnel->type == type &&
230 ((src_port && src_port == tunnel->src_port) ||
231 (dst_port && dst_port == tunnel->dst_port))) {
232 tb_tunnel_deactivate(tunnel);
233 list_del(&tunnel->list);
234 tb_tunnel_free(tunnel);
243 * tb_free_invalid_tunnels() - destroy tunnels of devices that have gone away
245 static void tb_free_invalid_tunnels(struct tb *tb)
247 struct tb_cm *tcm = tb_priv(tb);
248 struct tb_tunnel *tunnel;
251 list_for_each_entry_safe(tunnel, n, &tcm->tunnel_list, list) {
252 if (tb_tunnel_is_invalid(tunnel)) {
253 tb_tunnel_deactivate(tunnel);
254 list_del(&tunnel->list);
255 tb_tunnel_free(tunnel);
261 * tb_free_unplugged_children() - traverse hierarchy and free unplugged switches
263 static void tb_free_unplugged_children(struct tb_switch *sw)
265 struct tb_port *port;
267 tb_switch_for_each_port(sw, port) {
268 if (!tb_port_has_remote(port))
271 if (port->remote->sw->is_unplugged) {
272 tb_switch_remove(port->remote->sw);
274 if (port->dual_link_port)
275 port->dual_link_port->remote = NULL;
277 tb_free_unplugged_children(port->remote->sw);
283 * tb_find_port() - return the first port of @type on @sw or NULL
284 * @sw: Switch to find the port from
285 * @type: Port type to look for
287 static struct tb_port *tb_find_port(struct tb_switch *sw,
288 enum tb_port_type type)
290 struct tb_port *port;
292 tb_switch_for_each_port(sw, port) {
293 if (port->config.type == type)
301 * tb_find_unused_port() - return the first inactive port on @sw
302 * @sw: Switch to find the port on
303 * @type: Port type to look for
305 static struct tb_port *tb_find_unused_port(struct tb_switch *sw,
306 enum tb_port_type type)
308 struct tb_port *port;
310 tb_switch_for_each_port(sw, port) {
311 if (tb_is_upstream_port(port))
313 if (port->config.type != type)
317 if (tb_port_is_enabled(port))
324 static struct tb_port *tb_find_pcie_down(struct tb_switch *sw,
325 const struct tb_port *port)
328 * To keep plugging devices consistently in the same PCIe
329 * hierarchy, do mapping here for root switch downstream PCIe
333 int phy_port = tb_phy_port_from_link(port->port);
337 * Hard-coded Thunderbolt port to PCIe down port mapping
340 if (tb_switch_is_cr(sw))
341 index = !phy_port ? 6 : 7;
342 else if (tb_switch_is_fr(sw))
343 index = !phy_port ? 6 : 8;
347 /* Validate the hard-coding */
348 if (WARN_ON(index > sw->config.max_port_number))
350 if (WARN_ON(!tb_port_is_pcie_down(&sw->ports[index])))
352 if (WARN_ON(tb_pci_port_is_enabled(&sw->ports[index])))
355 return &sw->ports[index];
359 return tb_find_unused_port(sw, TB_TYPE_PCIE_DOWN);
362 static int tb_tunnel_dp(struct tb *tb, struct tb_port *out)
364 struct tb_cm *tcm = tb_priv(tb);
365 struct tb_switch *sw = out->sw;
366 struct tb_tunnel *tunnel;
369 if (tb_port_is_enabled(out))
373 sw = tb_to_switch(sw->dev.parent);
376 in = tb_find_unused_port(sw, TB_TYPE_DP_HDMI_IN);
379 tunnel = tb_tunnel_alloc_dp(tb, in, out);
381 tb_port_dbg(out, "DP tunnel allocation failed\n");
385 if (tb_tunnel_activate(tunnel)) {
386 tb_port_info(out, "DP tunnel activation failed, aborting\n");
387 tb_tunnel_free(tunnel);
391 list_add_tail(&tunnel->list, &tcm->tunnel_list);
395 static void tb_teardown_dp(struct tb *tb, struct tb_port *out)
397 tb_free_tunnel(tb, TB_TUNNEL_DP, NULL, out);
400 static int tb_tunnel_pci(struct tb *tb, struct tb_switch *sw)
402 struct tb_port *up, *down, *port;
403 struct tb_cm *tcm = tb_priv(tb);
404 struct tb_switch *parent_sw;
405 struct tb_tunnel *tunnel;
407 up = tb_find_port(sw, TB_TYPE_PCIE_UP);
412 * Look up available down port. Since we are chaining it should
413 * be found right above this switch.
415 parent_sw = tb_to_switch(sw->dev.parent);
416 port = tb_port_at(tb_route(sw), parent_sw);
417 down = tb_find_pcie_down(parent_sw, port);
421 tunnel = tb_tunnel_alloc_pci(tb, up, down);
425 if (tb_tunnel_activate(tunnel)) {
427 "PCIe tunnel activation failed, aborting\n");
428 tb_tunnel_free(tunnel);
432 list_add_tail(&tunnel->list, &tcm->tunnel_list);
436 static int tb_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd)
438 struct tb_cm *tcm = tb_priv(tb);
439 struct tb_port *nhi_port, *dst_port;
440 struct tb_tunnel *tunnel;
441 struct tb_switch *sw;
443 sw = tb_to_switch(xd->dev.parent);
444 dst_port = tb_port_at(xd->route, sw);
445 nhi_port = tb_find_port(tb->root_switch, TB_TYPE_NHI);
447 mutex_lock(&tb->lock);
448 tunnel = tb_tunnel_alloc_dma(tb, nhi_port, dst_port, xd->transmit_ring,
449 xd->transmit_path, xd->receive_ring,
452 mutex_unlock(&tb->lock);
456 if (tb_tunnel_activate(tunnel)) {
457 tb_port_info(nhi_port,
458 "DMA tunnel activation failed, aborting\n");
459 tb_tunnel_free(tunnel);
460 mutex_unlock(&tb->lock);
464 list_add_tail(&tunnel->list, &tcm->tunnel_list);
465 mutex_unlock(&tb->lock);
469 static void __tb_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd)
471 struct tb_port *dst_port;
472 struct tb_switch *sw;
474 sw = tb_to_switch(xd->dev.parent);
475 dst_port = tb_port_at(xd->route, sw);
478 * It is possible that the tunnel was already teared down (in
479 * case of cable disconnect) so it is fine if we cannot find it
482 tb_free_tunnel(tb, TB_TUNNEL_DMA, NULL, dst_port);
485 static int tb_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd)
487 if (!xd->is_unplugged) {
488 mutex_lock(&tb->lock);
489 __tb_disconnect_xdomain_paths(tb, xd);
490 mutex_unlock(&tb->lock);
495 /* hotplug handling */
498 * tb_handle_hotplug() - handle hotplug event
500 * Executes on tb->wq.
502 static void tb_handle_hotplug(struct work_struct *work)
504 struct tb_hotplug_event *ev = container_of(work, typeof(*ev), work);
505 struct tb *tb = ev->tb;
506 struct tb_cm *tcm = tb_priv(tb);
507 struct tb_switch *sw;
508 struct tb_port *port;
509 mutex_lock(&tb->lock);
510 if (!tcm->hotplug_active)
511 goto out; /* during init, suspend or shutdown */
513 sw = tb_switch_find_by_route(tb, ev->route);
516 "hotplug event from non existent switch %llx:%x (unplug: %d)\n",
517 ev->route, ev->port, ev->unplug);
520 if (ev->port > sw->config.max_port_number) {
522 "hotplug event from non existent port %llx:%x (unplug: %d)\n",
523 ev->route, ev->port, ev->unplug);
526 port = &sw->ports[ev->port];
527 if (tb_is_upstream_port(port)) {
528 tb_dbg(tb, "hotplug event for upstream port %llx:%x (unplug: %d)\n",
529 ev->route, ev->port, ev->unplug);
533 if (tb_port_has_remote(port)) {
534 tb_port_dbg(port, "switch unplugged\n");
535 tb_sw_set_unplugged(port->remote->sw);
536 tb_free_invalid_tunnels(tb);
537 tb_switch_remove(port->remote->sw);
539 if (port->dual_link_port)
540 port->dual_link_port->remote = NULL;
541 } else if (port->xdomain) {
542 struct tb_xdomain *xd = tb_xdomain_get(port->xdomain);
544 tb_port_dbg(port, "xdomain unplugged\n");
546 * Service drivers are unbound during
547 * tb_xdomain_remove() so setting XDomain as
548 * unplugged here prevents deadlock if they call
549 * tb_xdomain_disable_paths(). We will tear down
552 xd->is_unplugged = true;
553 tb_xdomain_remove(xd);
554 port->xdomain = NULL;
555 __tb_disconnect_xdomain_paths(tb, xd);
557 } else if (tb_port_is_dpout(port)) {
558 tb_teardown_dp(tb, port);
561 "got unplug event for disconnected port, ignoring\n");
563 } else if (port->remote) {
564 tb_port_dbg(port, "got plug event for connected port, ignoring\n");
566 if (tb_port_is_null(port)) {
567 tb_port_dbg(port, "hotplug: scanning\n");
570 tb_port_dbg(port, "hotplug: no switch found\n");
571 } else if (tb_port_is_dpout(port)) {
572 tb_tunnel_dp(tb, port);
579 mutex_unlock(&tb->lock);
584 * tb_schedule_hotplug_handler() - callback function for the control channel
586 * Delegates to tb_handle_hotplug.
588 static void tb_handle_event(struct tb *tb, enum tb_cfg_pkg_type type,
589 const void *buf, size_t size)
591 const struct cfg_event_pkg *pkg = buf;
594 if (type != TB_CFG_PKG_EVENT) {
595 tb_warn(tb, "unexpected event %#x, ignoring\n", type);
599 route = tb_cfg_get_route(&pkg->header);
601 if (tb_cfg_error(tb->ctl, route, pkg->port,
602 TB_CFG_ERROR_ACK_PLUG_EVENT)) {
603 tb_warn(tb, "could not ack plug event on %llx:%x\n", route,
607 tb_queue_hotplug(tb, route, pkg->port, pkg->unplug);
610 static void tb_stop(struct tb *tb)
612 struct tb_cm *tcm = tb_priv(tb);
613 struct tb_tunnel *tunnel;
616 /* tunnels are only present after everything has been initialized */
617 list_for_each_entry_safe(tunnel, n, &tcm->tunnel_list, list) {
619 * DMA tunnels require the driver to be functional so we
620 * tear them down. Other protocol tunnels can be left
623 if (tb_tunnel_is_dma(tunnel))
624 tb_tunnel_deactivate(tunnel);
625 tb_tunnel_free(tunnel);
627 tb_switch_remove(tb->root_switch);
628 tcm->hotplug_active = false; /* signal tb_handle_hotplug to quit */
631 static int tb_scan_finalize_switch(struct device *dev, void *data)
633 if (tb_is_switch(dev)) {
634 struct tb_switch *sw = tb_to_switch(dev);
637 * If we found that the switch was already setup by the
638 * boot firmware, mark it as authorized now before we
639 * send uevent to userspace.
644 dev_set_uevent_suppress(dev, false);
645 kobject_uevent(&dev->kobj, KOBJ_ADD);
646 device_for_each_child(dev, NULL, tb_scan_finalize_switch);
652 static int tb_start(struct tb *tb)
654 struct tb_cm *tcm = tb_priv(tb);
657 tb->root_switch = tb_switch_alloc(tb, &tb->dev, 0);
658 if (IS_ERR(tb->root_switch))
659 return PTR_ERR(tb->root_switch);
662 * ICM firmware upgrade needs running firmware and in native
663 * mode that is not available so disable firmware upgrade of the
666 tb->root_switch->no_nvm_upgrade = true;
668 ret = tb_switch_configure(tb->root_switch);
670 tb_switch_put(tb->root_switch);
674 /* Announce the switch to the world */
675 ret = tb_switch_add(tb->root_switch);
677 tb_switch_put(tb->root_switch);
681 /* Full scan to discover devices added before the driver was loaded. */
682 tb_scan_switch(tb->root_switch);
683 /* Find out tunnels created by the boot firmware */
684 tb_discover_tunnels(tb->root_switch);
685 /* Make the discovered switches available to the userspace */
686 device_for_each_child(&tb->root_switch->dev, NULL,
687 tb_scan_finalize_switch);
689 /* Allow tb_handle_hotplug to progress events */
690 tcm->hotplug_active = true;
694 static int tb_suspend_noirq(struct tb *tb)
696 struct tb_cm *tcm = tb_priv(tb);
698 tb_dbg(tb, "suspending...\n");
699 tb_switch_suspend(tb->root_switch);
700 tcm->hotplug_active = false; /* signal tb_handle_hotplug to quit */
701 tb_dbg(tb, "suspend finished\n");
706 static int tb_resume_noirq(struct tb *tb)
708 struct tb_cm *tcm = tb_priv(tb);
709 struct tb_tunnel *tunnel, *n;
711 tb_dbg(tb, "resuming...\n");
713 /* remove any pci devices the firmware might have setup */
714 tb_switch_reset(tb, 0);
716 tb_switch_resume(tb->root_switch);
717 tb_free_invalid_tunnels(tb);
718 tb_free_unplugged_children(tb->root_switch);
719 list_for_each_entry_safe(tunnel, n, &tcm->tunnel_list, list)
720 tb_tunnel_restart(tunnel);
721 if (!list_empty(&tcm->tunnel_list)) {
723 * the pcie links need some time to get going.
724 * 100ms works for me...
726 tb_dbg(tb, "tunnels restarted, sleeping for 100ms\n");
729 /* Allow tb_handle_hotplug to progress events */
730 tcm->hotplug_active = true;
731 tb_dbg(tb, "resume finished\n");
736 static int tb_free_unplugged_xdomains(struct tb_switch *sw)
738 struct tb_port *port;
741 tb_switch_for_each_port(sw, port) {
742 if (tb_is_upstream_port(port))
744 if (port->xdomain && port->xdomain->is_unplugged) {
745 tb_xdomain_remove(port->xdomain);
746 port->xdomain = NULL;
748 } else if (port->remote) {
749 ret += tb_free_unplugged_xdomains(port->remote->sw);
756 static void tb_complete(struct tb *tb)
759 * Release any unplugged XDomains and if there is a case where
760 * another domain is swapped in place of unplugged XDomain we
761 * need to run another rescan.
763 mutex_lock(&tb->lock);
764 if (tb_free_unplugged_xdomains(tb->root_switch))
765 tb_scan_switch(tb->root_switch);
766 mutex_unlock(&tb->lock);
769 static const struct tb_cm_ops tb_cm_ops = {
772 .suspend_noirq = tb_suspend_noirq,
773 .resume_noirq = tb_resume_noirq,
774 .complete = tb_complete,
775 .handle_event = tb_handle_event,
776 .approve_switch = tb_tunnel_pci,
777 .approve_xdomain_paths = tb_approve_xdomain_paths,
778 .disconnect_xdomain_paths = tb_disconnect_xdomain_paths,
781 struct tb *tb_probe(struct tb_nhi *nhi)
786 if (!x86_apple_machine)
789 tb = tb_domain_alloc(nhi, sizeof(*tcm));
793 tb->security_level = TB_SECURITY_USER;
794 tb->cm_ops = &tb_cm_ops;
797 INIT_LIST_HEAD(&tcm->tunnel_list);