1 // SPDX-License-Identifier: GPL-2.0
3 * Thunderbolt bus support
5 * Copyright (C) 2017, Intel Corporation
6 * Author: Mika Westerberg <mika.westerberg@linux.intel.com>
9 #include <linux/device.h>
10 #include <linux/idr.h>
11 #include <linux/module.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/slab.h>
14 #include <linux/random.h>
15 #include <crypto/hash.h>
19 static DEFINE_IDA(tb_domain_ida);
21 static bool match_service_id(const struct tb_service_id *id,
22 const struct tb_service *svc)
24 if (id->match_flags & TBSVC_MATCH_PROTOCOL_KEY) {
25 if (strcmp(id->protocol_key, svc->key))
29 if (id->match_flags & TBSVC_MATCH_PROTOCOL_ID) {
30 if (id->protocol_id != svc->prtcid)
34 if (id->match_flags & TBSVC_MATCH_PROTOCOL_VERSION) {
35 if (id->protocol_version != svc->prtcvers)
39 if (id->match_flags & TBSVC_MATCH_PROTOCOL_VERSION) {
40 if (id->protocol_revision != svc->prtcrevs)
47 static const struct tb_service_id *__tb_service_match(struct device *dev,
48 struct device_driver *drv)
50 struct tb_service_driver *driver;
51 const struct tb_service_id *ids;
52 struct tb_service *svc;
54 svc = tb_to_service(dev);
58 driver = container_of(drv, struct tb_service_driver, driver);
59 if (!driver->id_table)
62 for (ids = driver->id_table; ids->match_flags != 0; ids++) {
63 if (match_service_id(ids, svc))
70 static int tb_service_match(struct device *dev, struct device_driver *drv)
72 return !!__tb_service_match(dev, drv);
75 static int tb_service_probe(struct device *dev)
77 struct tb_service *svc = tb_to_service(dev);
78 struct tb_service_driver *driver;
79 const struct tb_service_id *id;
81 driver = container_of(dev->driver, struct tb_service_driver, driver);
82 id = __tb_service_match(dev, &driver->driver);
84 return driver->probe(svc, id);
87 static void tb_service_remove(struct device *dev)
89 struct tb_service *svc = tb_to_service(dev);
90 struct tb_service_driver *driver;
92 driver = container_of(dev->driver, struct tb_service_driver, driver);
97 static void tb_service_shutdown(struct device *dev)
99 struct tb_service_driver *driver;
100 struct tb_service *svc;
102 svc = tb_to_service(dev);
103 if (!svc || !dev->driver)
106 driver = container_of(dev->driver, struct tb_service_driver, driver);
107 if (driver->shutdown)
108 driver->shutdown(svc);
111 static const char * const tb_security_names[] = {
112 [TB_SECURITY_NONE] = "none",
113 [TB_SECURITY_USER] = "user",
114 [TB_SECURITY_SECURE] = "secure",
115 [TB_SECURITY_DPONLY] = "dponly",
116 [TB_SECURITY_USBONLY] = "usbonly",
117 [TB_SECURITY_NOPCIE] = "nopcie",
120 static ssize_t boot_acl_show(struct device *dev, struct device_attribute *attr,
123 struct tb *tb = container_of(dev, struct tb, dev);
128 uuids = kcalloc(tb->nboot_acl, sizeof(uuid_t), GFP_KERNEL);
132 pm_runtime_get_sync(&tb->dev);
134 if (mutex_lock_interruptible(&tb->lock)) {
138 ret = tb->cm_ops->get_boot_acl(tb, uuids, tb->nboot_acl);
140 mutex_unlock(&tb->lock);
143 mutex_unlock(&tb->lock);
145 for (ret = 0, i = 0; i < tb->nboot_acl; i++) {
146 if (!uuid_is_null(&uuids[i]))
147 ret += sysfs_emit_at(buf, ret, "%pUb", &uuids[i]);
149 ret += sysfs_emit_at(buf, ret, "%s", i < tb->nboot_acl - 1 ? "," : "\n");
153 pm_runtime_mark_last_busy(&tb->dev);
154 pm_runtime_put_autosuspend(&tb->dev);
160 static ssize_t boot_acl_store(struct device *dev, struct device_attribute *attr,
161 const char *buf, size_t count)
163 struct tb *tb = container_of(dev, struct tb, dev);
164 char *str, *s, *uuid_str;
170 * Make sure the value is not bigger than tb->nboot_acl * UUID
171 * length + commas and optional "\n". Also the smallest allowable
172 * string is tb->nboot_acl * ",".
174 if (count > (UUID_STRING_LEN + 1) * tb->nboot_acl + 1)
176 if (count < tb->nboot_acl - 1)
179 str = kstrdup(buf, GFP_KERNEL);
183 acl = kcalloc(tb->nboot_acl, sizeof(uuid_t), GFP_KERNEL);
189 uuid_str = strim(str);
190 while ((s = strsep(&uuid_str, ",")) != NULL && i < tb->nboot_acl) {
191 size_t len = strlen(s);
194 if (len != UUID_STRING_LEN) {
198 ret = uuid_parse(s, &acl[i]);
206 if (s || i < tb->nboot_acl) {
211 pm_runtime_get_sync(&tb->dev);
213 if (mutex_lock_interruptible(&tb->lock)) {
217 ret = tb->cm_ops->set_boot_acl(tb, acl, tb->nboot_acl);
219 /* Notify userspace about the change */
220 kobject_uevent(&tb->dev.kobj, KOBJ_CHANGE);
222 mutex_unlock(&tb->lock);
225 pm_runtime_mark_last_busy(&tb->dev);
226 pm_runtime_put_autosuspend(&tb->dev);
234 static DEVICE_ATTR_RW(boot_acl);
236 static ssize_t deauthorization_show(struct device *dev,
237 struct device_attribute *attr,
240 const struct tb *tb = container_of(dev, struct tb, dev);
241 bool deauthorization = false;
243 /* Only meaningful if authorization is supported */
244 if (tb->security_level == TB_SECURITY_USER ||
245 tb->security_level == TB_SECURITY_SECURE)
246 deauthorization = !!tb->cm_ops->disapprove_switch;
248 return sysfs_emit(buf, "%d\n", deauthorization);
250 static DEVICE_ATTR_RO(deauthorization);
252 static ssize_t iommu_dma_protection_show(struct device *dev,
253 struct device_attribute *attr,
256 struct tb *tb = container_of(dev, struct tb, dev);
258 return sysfs_emit(buf, "%d\n", tb->nhi->iommu_dma_protection);
260 static DEVICE_ATTR_RO(iommu_dma_protection);
262 static ssize_t security_show(struct device *dev, struct device_attribute *attr,
265 struct tb *tb = container_of(dev, struct tb, dev);
266 const char *name = "unknown";
268 if (tb->security_level < ARRAY_SIZE(tb_security_names))
269 name = tb_security_names[tb->security_level];
271 return sysfs_emit(buf, "%s\n", name);
273 static DEVICE_ATTR_RO(security);
275 static struct attribute *domain_attrs[] = {
276 &dev_attr_boot_acl.attr,
277 &dev_attr_deauthorization.attr,
278 &dev_attr_iommu_dma_protection.attr,
279 &dev_attr_security.attr,
283 static umode_t domain_attr_is_visible(struct kobject *kobj,
284 struct attribute *attr, int n)
286 struct device *dev = kobj_to_dev(kobj);
287 struct tb *tb = container_of(dev, struct tb, dev);
289 if (attr == &dev_attr_boot_acl.attr) {
291 tb->cm_ops->get_boot_acl &&
292 tb->cm_ops->set_boot_acl)
300 static const struct attribute_group domain_attr_group = {
301 .is_visible = domain_attr_is_visible,
302 .attrs = domain_attrs,
305 static const struct attribute_group *domain_attr_groups[] = {
310 struct bus_type tb_bus_type = {
311 .name = "thunderbolt",
312 .match = tb_service_match,
313 .probe = tb_service_probe,
314 .remove = tb_service_remove,
315 .shutdown = tb_service_shutdown,
318 static void tb_domain_release(struct device *dev)
320 struct tb *tb = container_of(dev, struct tb, dev);
322 tb_ctl_free(tb->ctl);
323 destroy_workqueue(tb->wq);
324 ida_simple_remove(&tb_domain_ida, tb->index);
325 mutex_destroy(&tb->lock);
329 struct device_type tb_domain_type = {
330 .name = "thunderbolt_domain",
331 .release = tb_domain_release,
334 static bool tb_domain_event_cb(void *data, enum tb_cfg_pkg_type type,
335 const void *buf, size_t size)
337 struct tb *tb = data;
339 if (!tb->cm_ops->handle_event) {
340 tb_warn(tb, "domain does not have event handler\n");
345 case TB_CFG_PKG_XDOMAIN_REQ:
346 case TB_CFG_PKG_XDOMAIN_RESP:
347 if (tb_is_xdomain_enabled())
348 return tb_xdomain_handle_request(tb, type, buf, size);
352 tb->cm_ops->handle_event(tb, type, buf, size);
359 * tb_domain_alloc() - Allocate a domain
360 * @nhi: Pointer to the host controller
361 * @timeout_msec: Control channel timeout for non-raw messages
362 * @privsize: Size of the connection manager private data
364 * Allocates and initializes a new Thunderbolt domain. Connection
365 * managers are expected to call this and then fill in @cm_ops
368 * Call tb_domain_put() to release the domain before it has been added
371 * Return: allocated domain structure on %NULL in case of error
373 struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize)
378 * Make sure the structure sizes map with that the hardware
379 * expects because bit-fields are being used.
381 BUILD_BUG_ON(sizeof(struct tb_regs_switch_header) != 5 * 4);
382 BUILD_BUG_ON(sizeof(struct tb_regs_port_header) != 8 * 4);
383 BUILD_BUG_ON(sizeof(struct tb_regs_hop) != 2 * 4);
385 tb = kzalloc(sizeof(*tb) + privsize, GFP_KERNEL);
390 mutex_init(&tb->lock);
392 tb->index = ida_simple_get(&tb_domain_ida, 0, 0, GFP_KERNEL);
396 tb->wq = alloc_ordered_workqueue("thunderbolt%d", 0, tb->index);
400 tb->ctl = tb_ctl_alloc(nhi, timeout_msec, tb_domain_event_cb, tb);
404 tb->dev.parent = &nhi->pdev->dev;
405 tb->dev.bus = &tb_bus_type;
406 tb->dev.type = &tb_domain_type;
407 tb->dev.groups = domain_attr_groups;
408 dev_set_name(&tb->dev, "domain%d", tb->index);
409 device_initialize(&tb->dev);
414 destroy_workqueue(tb->wq);
416 ida_simple_remove(&tb_domain_ida, tb->index);
424 * tb_domain_add() - Add domain to the system
427 * Starts the domain and adds it to the system. Hotplugging devices will
428 * work after this has been returned successfully. In order to remove
429 * and release the domain after this function has been called, call
430 * tb_domain_remove().
432 * Return: %0 in case of success and negative errno in case of error
434 int tb_domain_add(struct tb *tb)
438 if (WARN_ON(!tb->cm_ops))
441 mutex_lock(&tb->lock);
443 * tb_schedule_hotplug_handler may be called as soon as the config
444 * channel is started. Thats why we have to hold the lock here.
446 tb_ctl_start(tb->ctl);
448 if (tb->cm_ops->driver_ready) {
449 ret = tb->cm_ops->driver_ready(tb);
454 tb_dbg(tb, "security level set to %s\n",
455 tb_security_names[tb->security_level]);
457 ret = device_add(&tb->dev);
461 /* Start the domain */
462 if (tb->cm_ops->start) {
463 ret = tb->cm_ops->start(tb);
468 /* This starts event processing */
469 mutex_unlock(&tb->lock);
471 device_init_wakeup(&tb->dev, true);
473 pm_runtime_no_callbacks(&tb->dev);
474 pm_runtime_set_active(&tb->dev);
475 pm_runtime_enable(&tb->dev);
476 pm_runtime_set_autosuspend_delay(&tb->dev, TB_AUTOSUSPEND_DELAY);
477 pm_runtime_mark_last_busy(&tb->dev);
478 pm_runtime_use_autosuspend(&tb->dev);
483 device_del(&tb->dev);
485 tb_ctl_stop(tb->ctl);
486 mutex_unlock(&tb->lock);
492 * tb_domain_remove() - Removes and releases a domain
493 * @tb: Domain to remove
495 * Stops the domain, removes it from the system and releases all
496 * resources once the last reference has been released.
498 void tb_domain_remove(struct tb *tb)
500 mutex_lock(&tb->lock);
501 if (tb->cm_ops->stop)
502 tb->cm_ops->stop(tb);
503 /* Stop the domain control traffic */
504 tb_ctl_stop(tb->ctl);
505 mutex_unlock(&tb->lock);
507 flush_workqueue(tb->wq);
508 device_unregister(&tb->dev);
512 * tb_domain_suspend_noirq() - Suspend a domain
513 * @tb: Domain to suspend
515 * Suspends all devices in the domain and stops the control channel.
517 int tb_domain_suspend_noirq(struct tb *tb)
522 * The control channel interrupt is left enabled during suspend
523 * and taking the lock here prevents any events happening before
524 * we actually have stopped the domain and the control channel.
526 mutex_lock(&tb->lock);
527 if (tb->cm_ops->suspend_noirq)
528 ret = tb->cm_ops->suspend_noirq(tb);
530 tb_ctl_stop(tb->ctl);
531 mutex_unlock(&tb->lock);
537 * tb_domain_resume_noirq() - Resume a domain
538 * @tb: Domain to resume
540 * Re-starts the control channel, and resumes all devices connected to
543 int tb_domain_resume_noirq(struct tb *tb)
547 mutex_lock(&tb->lock);
548 tb_ctl_start(tb->ctl);
549 if (tb->cm_ops->resume_noirq)
550 ret = tb->cm_ops->resume_noirq(tb);
551 mutex_unlock(&tb->lock);
556 int tb_domain_suspend(struct tb *tb)
558 return tb->cm_ops->suspend ? tb->cm_ops->suspend(tb) : 0;
561 int tb_domain_freeze_noirq(struct tb *tb)
565 mutex_lock(&tb->lock);
566 if (tb->cm_ops->freeze_noirq)
567 ret = tb->cm_ops->freeze_noirq(tb);
569 tb_ctl_stop(tb->ctl);
570 mutex_unlock(&tb->lock);
575 int tb_domain_thaw_noirq(struct tb *tb)
579 mutex_lock(&tb->lock);
580 tb_ctl_start(tb->ctl);
581 if (tb->cm_ops->thaw_noirq)
582 ret = tb->cm_ops->thaw_noirq(tb);
583 mutex_unlock(&tb->lock);
588 void tb_domain_complete(struct tb *tb)
590 if (tb->cm_ops->complete)
591 tb->cm_ops->complete(tb);
594 int tb_domain_runtime_suspend(struct tb *tb)
596 if (tb->cm_ops->runtime_suspend) {
597 int ret = tb->cm_ops->runtime_suspend(tb);
601 tb_ctl_stop(tb->ctl);
605 int tb_domain_runtime_resume(struct tb *tb)
607 tb_ctl_start(tb->ctl);
608 if (tb->cm_ops->runtime_resume) {
609 int ret = tb->cm_ops->runtime_resume(tb);
617 * tb_domain_disapprove_switch() - Disapprove switch
618 * @tb: Domain the switch belongs to
619 * @sw: Switch to disapprove
621 * This will disconnect PCIe tunnel from parent to this @sw.
623 * Return: %0 on success and negative errno in case of failure.
625 int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw)
627 if (!tb->cm_ops->disapprove_switch)
630 return tb->cm_ops->disapprove_switch(tb, sw);
634 * tb_domain_approve_switch() - Approve switch
635 * @tb: Domain the switch belongs to
636 * @sw: Switch to approve
638 * This will approve switch by connection manager specific means. In
639 * case of success the connection manager will create PCIe tunnel from
642 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw)
644 struct tb_switch *parent_sw;
646 if (!tb->cm_ops->approve_switch)
649 /* The parent switch must be authorized before this one */
650 parent_sw = tb_to_switch(sw->dev.parent);
651 if (!parent_sw || !parent_sw->authorized)
654 return tb->cm_ops->approve_switch(tb, sw);
658 * tb_domain_approve_switch_key() - Approve switch and add key
659 * @tb: Domain the switch belongs to
660 * @sw: Switch to approve
662 * For switches that support secure connect, this function first adds
663 * key to the switch NVM using connection manager specific means. If
664 * adding the key is successful, the switch is approved and connected.
666 * Return: %0 on success and negative errno in case of failure.
668 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw)
670 struct tb_switch *parent_sw;
673 if (!tb->cm_ops->approve_switch || !tb->cm_ops->add_switch_key)
676 /* The parent switch must be authorized before this one */
677 parent_sw = tb_to_switch(sw->dev.parent);
678 if (!parent_sw || !parent_sw->authorized)
681 ret = tb->cm_ops->add_switch_key(tb, sw);
685 return tb->cm_ops->approve_switch(tb, sw);
689 * tb_domain_challenge_switch_key() - Challenge and approve switch
690 * @tb: Domain the switch belongs to
691 * @sw: Switch to approve
693 * For switches that support secure connect, this function generates
694 * random challenge and sends it to the switch. The switch responds to
695 * this and if the response matches our random challenge, the switch is
696 * approved and connected.
698 * Return: %0 on success and negative errno in case of failure.
700 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw)
702 u8 challenge[TB_SWITCH_KEY_SIZE];
703 u8 response[TB_SWITCH_KEY_SIZE];
704 u8 hmac[TB_SWITCH_KEY_SIZE];
705 struct tb_switch *parent_sw;
706 struct crypto_shash *tfm;
707 struct shash_desc *shash;
710 if (!tb->cm_ops->approve_switch || !tb->cm_ops->challenge_switch_key)
713 /* The parent switch must be authorized before this one */
714 parent_sw = tb_to_switch(sw->dev.parent);
715 if (!parent_sw || !parent_sw->authorized)
718 get_random_bytes(challenge, sizeof(challenge));
719 ret = tb->cm_ops->challenge_switch_key(tb, sw, challenge, response);
723 tfm = crypto_alloc_shash("hmac(sha256)", 0, 0);
727 ret = crypto_shash_setkey(tfm, sw->key, TB_SWITCH_KEY_SIZE);
731 shash = kzalloc(sizeof(*shash) + crypto_shash_descsize(tfm),
740 memset(hmac, 0, sizeof(hmac));
741 ret = crypto_shash_digest(shash, challenge, sizeof(hmac), hmac);
745 /* The returned HMAC must match the one we calculated */
746 if (memcmp(response, hmac, sizeof(hmac))) {
751 crypto_free_shash(tfm);
754 return tb->cm_ops->approve_switch(tb, sw);
759 crypto_free_shash(tfm);
765 * tb_domain_disconnect_pcie_paths() - Disconnect all PCIe paths
766 * @tb: Domain whose PCIe paths to disconnect
768 * This needs to be called in preparation for NVM upgrade of the host
769 * controller. Makes sure all PCIe paths are disconnected.
771 * Return %0 on success and negative errno in case of error.
773 int tb_domain_disconnect_pcie_paths(struct tb *tb)
775 if (!tb->cm_ops->disconnect_pcie_paths)
778 return tb->cm_ops->disconnect_pcie_paths(tb);
782 * tb_domain_approve_xdomain_paths() - Enable DMA paths for XDomain
783 * @tb: Domain enabling the DMA paths
784 * @xd: XDomain DMA paths are created to
785 * @transmit_path: HopID we are using to send out packets
786 * @transmit_ring: DMA ring used to send out packets
787 * @receive_path: HopID the other end is using to send packets to us
788 * @receive_ring: DMA ring used to receive packets from @receive_path
790 * Calls connection manager specific method to enable DMA paths to the
791 * XDomain in question.
793 * Return: 0% in case of success and negative errno otherwise. In
794 * particular returns %-ENOTSUPP if the connection manager
795 * implementation does not support XDomains.
797 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
798 int transmit_path, int transmit_ring,
799 int receive_path, int receive_ring)
801 if (!tb->cm_ops->approve_xdomain_paths)
804 return tb->cm_ops->approve_xdomain_paths(tb, xd, transmit_path,
805 transmit_ring, receive_path, receive_ring);
809 * tb_domain_disconnect_xdomain_paths() - Disable DMA paths for XDomain
810 * @tb: Domain disabling the DMA paths
811 * @xd: XDomain whose DMA paths are disconnected
812 * @transmit_path: HopID we are using to send out packets
813 * @transmit_ring: DMA ring used to send out packets
814 * @receive_path: HopID the other end is using to send packets to us
815 * @receive_ring: DMA ring used to receive packets from @receive_path
817 * Calls connection manager specific method to disconnect DMA paths to
818 * the XDomain in question.
820 * Return: 0% in case of success and negative errno otherwise. In
821 * particular returns %-ENOTSUPP if the connection manager
822 * implementation does not support XDomains.
824 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
825 int transmit_path, int transmit_ring,
826 int receive_path, int receive_ring)
828 if (!tb->cm_ops->disconnect_xdomain_paths)
831 return tb->cm_ops->disconnect_xdomain_paths(tb, xd, transmit_path,
832 transmit_ring, receive_path, receive_ring);
835 static int disconnect_xdomain(struct device *dev, void *data)
837 struct tb_xdomain *xd;
838 struct tb *tb = data;
841 xd = tb_to_xdomain(dev);
842 if (xd && xd->tb == tb)
843 ret = tb_xdomain_disable_all_paths(xd);
849 * tb_domain_disconnect_all_paths() - Disconnect all paths for the domain
850 * @tb: Domain whose paths are disconnected
852 * This function can be used to disconnect all paths (PCIe, XDomain) for
853 * example in preparation for host NVM firmware upgrade. After this is
854 * called the paths cannot be established without resetting the switch.
856 * Return: %0 in case of success and negative errno otherwise.
858 int tb_domain_disconnect_all_paths(struct tb *tb)
862 ret = tb_domain_disconnect_pcie_paths(tb);
866 return bus_for_each_dev(&tb_bus_type, NULL, tb, disconnect_xdomain);
869 int tb_domain_init(void)
876 ret = tb_xdomain_init();
879 ret = bus_register(&tb_bus_type);
894 void tb_domain_exit(void)
896 bus_unregister(&tb_bus_type);
897 ida_destroy(&tb_domain_ida);