1 // SPDX-License-Identifier: GPL-2.0
3 * Thunderbolt XDomain discovery protocol support
5 * Copyright (C) 2017, Intel Corporation
6 * Authors: Michael Jamet <michael.jamet@intel.com>
7 * Mika Westerberg <mika.westerberg@linux.intel.com>
10 #include <linux/device.h>
11 #include <linux/delay.h>
12 #include <linux/kmod.h>
13 #include <linux/module.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/prandom.h>
16 #include <linux/string_helpers.h>
17 #include <linux/utsname.h>
18 #include <linux/uuid.h>
19 #include <linux/workqueue.h>
23 #define XDOMAIN_SHORT_TIMEOUT 100 /* ms */
24 #define XDOMAIN_DEFAULT_TIMEOUT 1000 /* ms */
25 #define XDOMAIN_BONDING_TIMEOUT 10000 /* ms */
26 #define XDOMAIN_RETRIES 10
27 #define XDOMAIN_DEFAULT_MAX_HOPID 15
32 XDOMAIN_STATE_LINK_STATUS,
33 XDOMAIN_STATE_LINK_STATE_CHANGE,
34 XDOMAIN_STATE_LINK_STATUS2,
35 XDOMAIN_STATE_BONDING_UUID_LOW,
36 XDOMAIN_STATE_BONDING_UUID_HIGH,
37 XDOMAIN_STATE_PROPERTIES,
38 XDOMAIN_STATE_ENUMERATED,
42 static const char * const state_names[] = {
43 [XDOMAIN_STATE_INIT] = "INIT",
44 [XDOMAIN_STATE_UUID] = "UUID",
45 [XDOMAIN_STATE_LINK_STATUS] = "LINK_STATUS",
46 [XDOMAIN_STATE_LINK_STATE_CHANGE] = "LINK_STATE_CHANGE",
47 [XDOMAIN_STATE_LINK_STATUS2] = "LINK_STATUS2",
48 [XDOMAIN_STATE_BONDING_UUID_LOW] = "BONDING_UUID_LOW",
49 [XDOMAIN_STATE_BONDING_UUID_HIGH] = "BONDING_UUID_HIGH",
50 [XDOMAIN_STATE_PROPERTIES] = "PROPERTIES",
51 [XDOMAIN_STATE_ENUMERATED] = "ENUMERATED",
52 [XDOMAIN_STATE_ERROR] = "ERROR",
55 struct xdomain_request_work {
56 struct work_struct work;
57 struct tb_xdp_header *pkg;
61 static bool tb_xdomain_enabled = true;
62 module_param_named(xdomain, tb_xdomain_enabled, bool, 0444);
63 MODULE_PARM_DESC(xdomain, "allow XDomain protocol (default: true)");
66 * Serializes access to the properties and protocol handlers below. If
67 * you need to take both this lock and the struct tb_xdomain lock, take
70 static DEFINE_MUTEX(xdomain_lock);
72 /* Properties exposed to the remote domains */
73 static struct tb_property_dir *xdomain_property_dir;
74 static u32 xdomain_property_block_gen;
76 /* Additional protocol handlers */
77 static LIST_HEAD(protocol_handlers);
79 /* UUID for XDomain discovery protocol: b638d70e-42ff-40bb-97c2-90e2c0b2ff07 */
80 static const uuid_t tb_xdp_uuid =
81 UUID_INIT(0xb638d70e, 0x42ff, 0x40bb,
82 0x97, 0xc2, 0x90, 0xe2, 0xc0, 0xb2, 0xff, 0x07);
84 bool tb_is_xdomain_enabled(void)
86 return tb_xdomain_enabled && tb_acpi_is_xdomain_allowed();
89 static bool tb_xdomain_match(const struct tb_cfg_request *req,
90 const struct ctl_pkg *pkg)
92 switch (pkg->frame.eof) {
93 case TB_CFG_PKG_ERROR:
96 case TB_CFG_PKG_XDOMAIN_RESP: {
97 const struct tb_xdp_header *res_hdr = pkg->buffer;
98 const struct tb_xdp_header *req_hdr = req->request;
100 if (pkg->frame.size < req->response_size / 4)
103 /* Make sure route matches */
104 if ((res_hdr->xd_hdr.route_hi & ~BIT(31)) !=
105 req_hdr->xd_hdr.route_hi)
107 if ((res_hdr->xd_hdr.route_lo) != req_hdr->xd_hdr.route_lo)
110 /* Check that the XDomain protocol matches */
111 if (!uuid_equal(&res_hdr->uuid, &req_hdr->uuid))
122 static bool tb_xdomain_copy(struct tb_cfg_request *req,
123 const struct ctl_pkg *pkg)
125 memcpy(req->response, pkg->buffer, req->response_size);
130 static void response_ready(void *data)
132 tb_cfg_request_put(data);
135 static int __tb_xdomain_response(struct tb_ctl *ctl, const void *response,
136 size_t size, enum tb_cfg_pkg_type type)
138 struct tb_cfg_request *req;
140 req = tb_cfg_request_alloc();
144 req->match = tb_xdomain_match;
145 req->copy = tb_xdomain_copy;
146 req->request = response;
147 req->request_size = size;
148 req->request_type = type;
150 return tb_cfg_request(ctl, req, response_ready, req);
154 * tb_xdomain_response() - Send a XDomain response message
155 * @xd: XDomain to send the message
156 * @response: Response to send
157 * @size: Size of the response
158 * @type: PDF type of the response
160 * This can be used to send a XDomain response message to the other
161 * domain. No response for the message is expected.
163 * Return: %0 in case of success and negative errno in case of failure
165 int tb_xdomain_response(struct tb_xdomain *xd, const void *response,
166 size_t size, enum tb_cfg_pkg_type type)
168 return __tb_xdomain_response(xd->tb->ctl, response, size, type);
170 EXPORT_SYMBOL_GPL(tb_xdomain_response);
172 static int __tb_xdomain_request(struct tb_ctl *ctl, const void *request,
173 size_t request_size, enum tb_cfg_pkg_type request_type, void *response,
174 size_t response_size, enum tb_cfg_pkg_type response_type,
175 unsigned int timeout_msec)
177 struct tb_cfg_request *req;
178 struct tb_cfg_result res;
180 req = tb_cfg_request_alloc();
184 req->match = tb_xdomain_match;
185 req->copy = tb_xdomain_copy;
186 req->request = request;
187 req->request_size = request_size;
188 req->request_type = request_type;
189 req->response = response;
190 req->response_size = response_size;
191 req->response_type = response_type;
193 res = tb_cfg_request_sync(ctl, req, timeout_msec);
195 tb_cfg_request_put(req);
197 return res.err == 1 ? -EIO : res.err;
201 * tb_xdomain_request() - Send a XDomain request
202 * @xd: XDomain to send the request
203 * @request: Request to send
204 * @request_size: Size of the request in bytes
205 * @request_type: PDF type of the request
206 * @response: Response is copied here
207 * @response_size: Expected size of the response in bytes
208 * @response_type: Expected PDF type of the response
209 * @timeout_msec: Timeout in milliseconds to wait for the response
211 * This function can be used to send XDomain control channel messages to
212 * the other domain. The function waits until the response is received
213 * or when timeout triggers. Whichever comes first.
215 * Return: %0 in case of success and negative errno in case of failure
217 int tb_xdomain_request(struct tb_xdomain *xd, const void *request,
218 size_t request_size, enum tb_cfg_pkg_type request_type,
219 void *response, size_t response_size,
220 enum tb_cfg_pkg_type response_type, unsigned int timeout_msec)
222 return __tb_xdomain_request(xd->tb->ctl, request, request_size,
223 request_type, response, response_size,
224 response_type, timeout_msec);
226 EXPORT_SYMBOL_GPL(tb_xdomain_request);
228 static inline void tb_xdp_fill_header(struct tb_xdp_header *hdr, u64 route,
229 u8 sequence, enum tb_xdp_type type, size_t size)
233 length_sn = (size - sizeof(hdr->xd_hdr)) / 4;
234 length_sn |= (sequence << TB_XDOMAIN_SN_SHIFT) & TB_XDOMAIN_SN_MASK;
236 hdr->xd_hdr.route_hi = upper_32_bits(route);
237 hdr->xd_hdr.route_lo = lower_32_bits(route);
238 hdr->xd_hdr.length_sn = length_sn;
240 memcpy(&hdr->uuid, &tb_xdp_uuid, sizeof(tb_xdp_uuid));
243 static int tb_xdp_handle_error(const struct tb_xdp_error_response *res)
245 if (res->hdr.type != ERROR_RESPONSE)
248 switch (res->error) {
249 case ERROR_UNKNOWN_PACKET:
250 case ERROR_UNKNOWN_DOMAIN:
252 case ERROR_NOT_SUPPORTED:
254 case ERROR_NOT_READY:
263 static int tb_xdp_uuid_request(struct tb_ctl *ctl, u64 route, int retry,
264 uuid_t *uuid, u64 *remote_route)
266 struct tb_xdp_uuid_response res;
267 struct tb_xdp_uuid req;
270 memset(&req, 0, sizeof(req));
271 tb_xdp_fill_header(&req.hdr, route, retry % 4, UUID_REQUEST,
274 memset(&res, 0, sizeof(res));
275 ret = __tb_xdomain_request(ctl, &req, sizeof(req),
276 TB_CFG_PKG_XDOMAIN_REQ, &res, sizeof(res),
277 TB_CFG_PKG_XDOMAIN_RESP,
278 XDOMAIN_DEFAULT_TIMEOUT);
282 ret = tb_xdp_handle_error(&res.err);
286 uuid_copy(uuid, &res.src_uuid);
287 *remote_route = (u64)res.src_route_hi << 32 | res.src_route_lo;
292 static int tb_xdp_uuid_response(struct tb_ctl *ctl, u64 route, u8 sequence,
295 struct tb_xdp_uuid_response res;
297 memset(&res, 0, sizeof(res));
298 tb_xdp_fill_header(&res.hdr, route, sequence, UUID_RESPONSE,
301 uuid_copy(&res.src_uuid, uuid);
302 res.src_route_hi = upper_32_bits(route);
303 res.src_route_lo = lower_32_bits(route);
305 return __tb_xdomain_response(ctl, &res, sizeof(res),
306 TB_CFG_PKG_XDOMAIN_RESP);
309 static int tb_xdp_error_response(struct tb_ctl *ctl, u64 route, u8 sequence,
310 enum tb_xdp_error error)
312 struct tb_xdp_error_response res;
314 memset(&res, 0, sizeof(res));
315 tb_xdp_fill_header(&res.hdr, route, sequence, ERROR_RESPONSE,
319 return __tb_xdomain_response(ctl, &res, sizeof(res),
320 TB_CFG_PKG_XDOMAIN_RESP);
323 static int tb_xdp_properties_request(struct tb_ctl *ctl, u64 route,
324 const uuid_t *src_uuid, const uuid_t *dst_uuid, int retry,
325 u32 **block, u32 *generation)
327 struct tb_xdp_properties_response *res;
328 struct tb_xdp_properties req;
334 total_size = sizeof(*res) + TB_XDP_PROPERTIES_MAX_DATA_LENGTH * 4;
335 res = kzalloc(total_size, GFP_KERNEL);
339 memset(&req, 0, sizeof(req));
340 tb_xdp_fill_header(&req.hdr, route, retry % 4, PROPERTIES_REQUEST,
342 memcpy(&req.src_uuid, src_uuid, sizeof(*src_uuid));
343 memcpy(&req.dst_uuid, dst_uuid, sizeof(*dst_uuid));
348 ret = __tb_xdomain_request(ctl, &req, sizeof(req),
349 TB_CFG_PKG_XDOMAIN_REQ, res,
350 total_size, TB_CFG_PKG_XDOMAIN_RESP,
351 XDOMAIN_DEFAULT_TIMEOUT);
355 ret = tb_xdp_handle_error(&res->err);
360 * Package length includes the whole payload without the
361 * XDomain header. Validate first that the package is at
362 * least size of the response structure.
364 len = res->hdr.xd_hdr.length_sn & TB_XDOMAIN_LENGTH_MASK;
365 if (len < sizeof(*res) / 4) {
370 len += sizeof(res->hdr.xd_hdr) / 4;
371 len -= sizeof(*res) / 4;
373 if (res->offset != req.offset) {
379 * First time allocate block that has enough space for
380 * the whole properties block.
383 data_len = res->data_length;
384 if (data_len > TB_XDP_PROPERTIES_MAX_LENGTH) {
389 data = kcalloc(data_len, sizeof(u32), GFP_KERNEL);
396 memcpy(data + req.offset, res->data, len * 4);
398 } while (!data_len || req.offset < data_len);
401 *generation = res->generation;
414 static int tb_xdp_properties_response(struct tb *tb, struct tb_ctl *ctl,
415 struct tb_xdomain *xd, u8 sequence, const struct tb_xdp_properties *req)
417 struct tb_xdp_properties_response *res;
423 * Currently we expect all requests to be directed to us. The
424 * protocol supports forwarding, though which we might add
427 if (!uuid_equal(xd->local_uuid, &req->dst_uuid)) {
428 tb_xdp_error_response(ctl, xd->route, sequence,
429 ERROR_UNKNOWN_DOMAIN);
433 mutex_lock(&xd->lock);
435 if (req->offset >= xd->local_property_block_len) {
436 mutex_unlock(&xd->lock);
440 len = xd->local_property_block_len - req->offset;
441 len = min_t(u16, len, TB_XDP_PROPERTIES_MAX_DATA_LENGTH);
442 total_size = sizeof(*res) + len * 4;
444 res = kzalloc(total_size, GFP_KERNEL);
446 mutex_unlock(&xd->lock);
450 tb_xdp_fill_header(&res->hdr, xd->route, sequence, PROPERTIES_RESPONSE,
452 res->generation = xd->local_property_block_gen;
453 res->data_length = xd->local_property_block_len;
454 res->offset = req->offset;
455 uuid_copy(&res->src_uuid, xd->local_uuid);
456 uuid_copy(&res->dst_uuid, &req->src_uuid);
457 memcpy(res->data, &xd->local_property_block[req->offset], len * 4);
459 mutex_unlock(&xd->lock);
461 ret = __tb_xdomain_response(ctl, res, total_size,
462 TB_CFG_PKG_XDOMAIN_RESP);
468 static int tb_xdp_properties_changed_request(struct tb_ctl *ctl, u64 route,
469 int retry, const uuid_t *uuid)
471 struct tb_xdp_properties_changed_response res;
472 struct tb_xdp_properties_changed req;
475 memset(&req, 0, sizeof(req));
476 tb_xdp_fill_header(&req.hdr, route, retry % 4,
477 PROPERTIES_CHANGED_REQUEST, sizeof(req));
478 uuid_copy(&req.src_uuid, uuid);
480 memset(&res, 0, sizeof(res));
481 ret = __tb_xdomain_request(ctl, &req, sizeof(req),
482 TB_CFG_PKG_XDOMAIN_REQ, &res, sizeof(res),
483 TB_CFG_PKG_XDOMAIN_RESP,
484 XDOMAIN_DEFAULT_TIMEOUT);
488 return tb_xdp_handle_error(&res.err);
492 tb_xdp_properties_changed_response(struct tb_ctl *ctl, u64 route, u8 sequence)
494 struct tb_xdp_properties_changed_response res;
496 memset(&res, 0, sizeof(res));
497 tb_xdp_fill_header(&res.hdr, route, sequence,
498 PROPERTIES_CHANGED_RESPONSE, sizeof(res));
499 return __tb_xdomain_response(ctl, &res, sizeof(res),
500 TB_CFG_PKG_XDOMAIN_RESP);
503 static int tb_xdp_link_state_status_request(struct tb_ctl *ctl, u64 route,
504 u8 sequence, u8 *slw, u8 *tlw,
507 struct tb_xdp_link_state_status_response res;
508 struct tb_xdp_link_state_status req;
511 memset(&req, 0, sizeof(req));
512 tb_xdp_fill_header(&req.hdr, route, sequence, LINK_STATE_STATUS_REQUEST,
515 memset(&res, 0, sizeof(res));
516 ret = __tb_xdomain_request(ctl, &req, sizeof(req), TB_CFG_PKG_XDOMAIN_REQ,
517 &res, sizeof(res), TB_CFG_PKG_XDOMAIN_RESP,
518 XDOMAIN_DEFAULT_TIMEOUT);
522 ret = tb_xdp_handle_error(&res.err);
537 static int tb_xdp_link_state_status_response(struct tb *tb, struct tb_ctl *ctl,
538 struct tb_xdomain *xd, u8 sequence)
540 struct tb_switch *sw = tb_to_switch(xd->dev.parent);
541 struct tb_xdp_link_state_status_response res;
542 struct tb_port *port = tb_port_at(xd->route, sw);
546 memset(&res, 0, sizeof(res));
547 tb_xdp_fill_header(&res.hdr, xd->route, sequence,
548 LINK_STATE_STATUS_RESPONSE, sizeof(res));
550 ret = tb_port_read(port, val, TB_CFG_PORT,
551 port->cap_phy + LANE_ADP_CS_0, ARRAY_SIZE(val));
555 res.slw = (val[0] & LANE_ADP_CS_0_SUPPORTED_WIDTH_MASK) >>
556 LANE_ADP_CS_0_SUPPORTED_WIDTH_SHIFT;
557 res.sls = (val[0] & LANE_ADP_CS_0_SUPPORTED_SPEED_MASK) >>
558 LANE_ADP_CS_0_SUPPORTED_SPEED_SHIFT;
559 res.tls = val[1] & LANE_ADP_CS_1_TARGET_SPEED_MASK;
560 res.tlw = (val[1] & LANE_ADP_CS_1_TARGET_WIDTH_MASK) >>
561 LANE_ADP_CS_1_TARGET_WIDTH_SHIFT;
563 return __tb_xdomain_response(ctl, &res, sizeof(res),
564 TB_CFG_PKG_XDOMAIN_RESP);
567 static int tb_xdp_link_state_change_request(struct tb_ctl *ctl, u64 route,
568 u8 sequence, u8 tlw, u8 tls)
570 struct tb_xdp_link_state_change_response res;
571 struct tb_xdp_link_state_change req;
574 memset(&req, 0, sizeof(req));
575 tb_xdp_fill_header(&req.hdr, route, sequence, LINK_STATE_CHANGE_REQUEST,
580 memset(&res, 0, sizeof(res));
581 ret = __tb_xdomain_request(ctl, &req, sizeof(req), TB_CFG_PKG_XDOMAIN_REQ,
582 &res, sizeof(res), TB_CFG_PKG_XDOMAIN_RESP,
583 XDOMAIN_DEFAULT_TIMEOUT);
587 ret = tb_xdp_handle_error(&res.err);
591 return res.status != 0 ? -EREMOTEIO : 0;
594 static int tb_xdp_link_state_change_response(struct tb_ctl *ctl, u64 route,
595 u8 sequence, u32 status)
597 struct tb_xdp_link_state_change_response res;
599 memset(&res, 0, sizeof(res));
600 tb_xdp_fill_header(&res.hdr, route, sequence, LINK_STATE_CHANGE_RESPONSE,
605 return __tb_xdomain_response(ctl, &res, sizeof(res),
606 TB_CFG_PKG_XDOMAIN_RESP);
610 * tb_register_protocol_handler() - Register protocol handler
611 * @handler: Handler to register
613 * This allows XDomain service drivers to hook into incoming XDomain
614 * messages. After this function is called the service driver needs to
615 * be able to handle calls to callback whenever a package with the
616 * registered protocol is received.
618 int tb_register_protocol_handler(struct tb_protocol_handler *handler)
620 if (!handler->uuid || !handler->callback)
622 if (uuid_equal(handler->uuid, &tb_xdp_uuid))
625 mutex_lock(&xdomain_lock);
626 list_add_tail(&handler->list, &protocol_handlers);
627 mutex_unlock(&xdomain_lock);
631 EXPORT_SYMBOL_GPL(tb_register_protocol_handler);
634 * tb_unregister_protocol_handler() - Unregister protocol handler
635 * @handler: Handler to unregister
637 * Removes the previously registered protocol handler.
639 void tb_unregister_protocol_handler(struct tb_protocol_handler *handler)
641 mutex_lock(&xdomain_lock);
642 list_del_init(&handler->list);
643 mutex_unlock(&xdomain_lock);
645 EXPORT_SYMBOL_GPL(tb_unregister_protocol_handler);
647 static void update_property_block(struct tb_xdomain *xd)
649 mutex_lock(&xdomain_lock);
650 mutex_lock(&xd->lock);
652 * If the local property block is not up-to-date, rebuild it now
653 * based on the global property template.
655 if (!xd->local_property_block ||
656 xd->local_property_block_gen < xdomain_property_block_gen) {
657 struct tb_property_dir *dir;
661 dir = tb_property_copy_dir(xdomain_property_dir);
663 dev_warn(&xd->dev, "failed to copy properties\n");
667 /* Fill in non-static properties now */
668 tb_property_add_text(dir, "deviceid", utsname()->nodename);
669 tb_property_add_immediate(dir, "maxhopid", xd->local_max_hopid);
671 ret = tb_property_format_dir(dir, NULL, 0);
673 dev_warn(&xd->dev, "local property block creation failed\n");
674 tb_property_free_dir(dir);
679 block = kcalloc(block_len, sizeof(*block), GFP_KERNEL);
681 tb_property_free_dir(dir);
685 ret = tb_property_format_dir(dir, block, block_len);
687 dev_warn(&xd->dev, "property block generation failed\n");
688 tb_property_free_dir(dir);
693 tb_property_free_dir(dir);
694 /* Release the previous block */
695 kfree(xd->local_property_block);
697 xd->local_property_block = block;
698 xd->local_property_block_len = block_len;
699 xd->local_property_block_gen = xdomain_property_block_gen;
703 mutex_unlock(&xd->lock);
704 mutex_unlock(&xdomain_lock);
707 static void tb_xdp_handle_request(struct work_struct *work)
709 struct xdomain_request_work *xw = container_of(work, typeof(*xw), work);
710 const struct tb_xdp_header *pkg = xw->pkg;
711 const struct tb_xdomain_header *xhdr = &pkg->xd_hdr;
712 struct tb *tb = xw->tb;
713 struct tb_ctl *ctl = tb->ctl;
714 struct tb_xdomain *xd;
720 route = ((u64)xhdr->route_hi << 32 | xhdr->route_lo) & ~BIT_ULL(63);
721 sequence = xhdr->length_sn & TB_XDOMAIN_SN_MASK;
722 sequence >>= TB_XDOMAIN_SN_SHIFT;
724 mutex_lock(&tb->lock);
726 uuid = tb->root_switch->uuid;
729 mutex_unlock(&tb->lock);
732 tb_xdp_error_response(ctl, route, sequence, ERROR_NOT_READY);
736 xd = tb_xdomain_find_by_route_locked(tb, route);
738 update_property_block(xd);
741 case PROPERTIES_REQUEST:
742 tb_dbg(tb, "%llx: received XDomain properties request\n", route);
744 ret = tb_xdp_properties_response(tb, ctl, xd, sequence,
745 (const struct tb_xdp_properties *)pkg);
749 case PROPERTIES_CHANGED_REQUEST:
750 tb_dbg(tb, "%llx: received XDomain properties changed request\n",
753 ret = tb_xdp_properties_changed_response(ctl, route, sequence);
756 * Since the properties have been changed, let's update
757 * the xdomain related to this connection as well in
758 * case there is a change in services it offers.
760 if (xd && device_is_registered(&xd->dev))
761 queue_delayed_work(tb->wq, &xd->state_work,
762 msecs_to_jiffies(XDOMAIN_SHORT_TIMEOUT));
765 case UUID_REQUEST_OLD:
767 tb_dbg(tb, "%llx: received XDomain UUID request\n", route);
768 ret = tb_xdp_uuid_response(ctl, route, sequence, uuid);
771 case LINK_STATE_STATUS_REQUEST:
772 tb_dbg(tb, "%llx: received XDomain link state status request\n",
776 ret = tb_xdp_link_state_status_response(tb, ctl, xd,
779 tb_xdp_error_response(ctl, route, sequence,
784 case LINK_STATE_CHANGE_REQUEST:
785 tb_dbg(tb, "%llx: received XDomain link state change request\n",
788 if (xd && xd->state == XDOMAIN_STATE_BONDING_UUID_HIGH) {
789 const struct tb_xdp_link_state_change *lsc =
790 (const struct tb_xdp_link_state_change *)pkg;
792 ret = tb_xdp_link_state_change_response(ctl, route,
794 xd->target_link_width = lsc->tlw;
795 queue_delayed_work(tb->wq, &xd->state_work,
796 msecs_to_jiffies(XDOMAIN_SHORT_TIMEOUT));
798 tb_xdp_error_response(ctl, route, sequence,
804 tb_dbg(tb, "%llx: unknown XDomain request %#x\n", route, pkg->type);
805 tb_xdp_error_response(ctl, route, sequence,
806 ERROR_NOT_SUPPORTED);
813 tb_warn(tb, "failed to send XDomain response for %#x\n",
825 tb_xdp_schedule_request(struct tb *tb, const struct tb_xdp_header *hdr,
828 struct xdomain_request_work *xw;
830 xw = kmalloc(sizeof(*xw), GFP_KERNEL);
834 INIT_WORK(&xw->work, tb_xdp_handle_request);
835 xw->pkg = kmemdup(hdr, size, GFP_KERNEL);
840 xw->tb = tb_domain_get(tb);
842 schedule_work(&xw->work);
847 * tb_register_service_driver() - Register XDomain service driver
848 * @drv: Driver to register
850 * Registers new service driver from @drv to the bus.
852 int tb_register_service_driver(struct tb_service_driver *drv)
854 drv->driver.bus = &tb_bus_type;
855 return driver_register(&drv->driver);
857 EXPORT_SYMBOL_GPL(tb_register_service_driver);
860 * tb_unregister_service_driver() - Unregister XDomain service driver
861 * @drv: Driver to unregister
863 * Unregisters XDomain service driver from the bus.
865 void tb_unregister_service_driver(struct tb_service_driver *drv)
867 driver_unregister(&drv->driver);
869 EXPORT_SYMBOL_GPL(tb_unregister_service_driver);
871 static ssize_t key_show(struct device *dev, struct device_attribute *attr,
874 struct tb_service *svc = container_of(dev, struct tb_service, dev);
877 * It should be null terminated but anything else is pretty much
880 return sysfs_emit(buf, "%*pE\n", (int)strlen(svc->key), svc->key);
882 static DEVICE_ATTR_RO(key);
884 static int get_modalias(const struct tb_service *svc, char *buf, size_t size)
886 return snprintf(buf, size, "tbsvc:k%sp%08Xv%08Xr%08X", svc->key,
887 svc->prtcid, svc->prtcvers, svc->prtcrevs);
890 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
893 struct tb_service *svc = container_of(dev, struct tb_service, dev);
895 /* Full buffer size except new line and null termination */
896 get_modalias(svc, buf, PAGE_SIZE - 2);
897 return strlen(strcat(buf, "\n"));
899 static DEVICE_ATTR_RO(modalias);
901 static ssize_t prtcid_show(struct device *dev, struct device_attribute *attr,
904 struct tb_service *svc = container_of(dev, struct tb_service, dev);
906 return sysfs_emit(buf, "%u\n", svc->prtcid);
908 static DEVICE_ATTR_RO(prtcid);
910 static ssize_t prtcvers_show(struct device *dev, struct device_attribute *attr,
913 struct tb_service *svc = container_of(dev, struct tb_service, dev);
915 return sysfs_emit(buf, "%u\n", svc->prtcvers);
917 static DEVICE_ATTR_RO(prtcvers);
919 static ssize_t prtcrevs_show(struct device *dev, struct device_attribute *attr,
922 struct tb_service *svc = container_of(dev, struct tb_service, dev);
924 return sysfs_emit(buf, "%u\n", svc->prtcrevs);
926 static DEVICE_ATTR_RO(prtcrevs);
928 static ssize_t prtcstns_show(struct device *dev, struct device_attribute *attr,
931 struct tb_service *svc = container_of(dev, struct tb_service, dev);
933 return sysfs_emit(buf, "0x%08x\n", svc->prtcstns);
935 static DEVICE_ATTR_RO(prtcstns);
937 static struct attribute *tb_service_attrs[] = {
939 &dev_attr_modalias.attr,
940 &dev_attr_prtcid.attr,
941 &dev_attr_prtcvers.attr,
942 &dev_attr_prtcrevs.attr,
943 &dev_attr_prtcstns.attr,
947 static const struct attribute_group tb_service_attr_group = {
948 .attrs = tb_service_attrs,
951 static const struct attribute_group *tb_service_attr_groups[] = {
952 &tb_service_attr_group,
956 static int tb_service_uevent(const struct device *dev, struct kobj_uevent_env *env)
958 const struct tb_service *svc = container_of_const(dev, struct tb_service, dev);
961 get_modalias(svc, modalias, sizeof(modalias));
962 return add_uevent_var(env, "MODALIAS=%s", modalias);
965 static void tb_service_release(struct device *dev)
967 struct tb_service *svc = container_of(dev, struct tb_service, dev);
968 struct tb_xdomain *xd = tb_service_parent(svc);
970 tb_service_debugfs_remove(svc);
971 ida_simple_remove(&xd->service_ids, svc->id);
976 struct device_type tb_service_type = {
977 .name = "thunderbolt_service",
978 .groups = tb_service_attr_groups,
979 .uevent = tb_service_uevent,
980 .release = tb_service_release,
982 EXPORT_SYMBOL_GPL(tb_service_type);
984 static int remove_missing_service(struct device *dev, void *data)
986 struct tb_xdomain *xd = data;
987 struct tb_service *svc;
989 svc = tb_to_service(dev);
993 if (!tb_property_find(xd->remote_properties, svc->key,
994 TB_PROPERTY_TYPE_DIRECTORY))
995 device_unregister(dev);
1000 static int find_service(struct device *dev, void *data)
1002 const struct tb_property *p = data;
1003 struct tb_service *svc;
1005 svc = tb_to_service(dev);
1009 return !strcmp(svc->key, p->key);
1012 static int populate_service(struct tb_service *svc,
1013 struct tb_property *property)
1015 struct tb_property_dir *dir = property->value.dir;
1016 struct tb_property *p;
1018 /* Fill in standard properties */
1019 p = tb_property_find(dir, "prtcid", TB_PROPERTY_TYPE_VALUE);
1021 svc->prtcid = p->value.immediate;
1022 p = tb_property_find(dir, "prtcvers", TB_PROPERTY_TYPE_VALUE);
1024 svc->prtcvers = p->value.immediate;
1025 p = tb_property_find(dir, "prtcrevs", TB_PROPERTY_TYPE_VALUE);
1027 svc->prtcrevs = p->value.immediate;
1028 p = tb_property_find(dir, "prtcstns", TB_PROPERTY_TYPE_VALUE);
1030 svc->prtcstns = p->value.immediate;
1032 svc->key = kstrdup(property->key, GFP_KERNEL);
1039 static void enumerate_services(struct tb_xdomain *xd)
1041 struct tb_service *svc;
1042 struct tb_property *p;
1047 * First remove all services that are not available anymore in
1048 * the updated property block.
1050 device_for_each_child_reverse(&xd->dev, xd, remove_missing_service);
1052 /* Then re-enumerate properties creating new services as we go */
1053 tb_property_for_each(xd->remote_properties, p) {
1054 if (p->type != TB_PROPERTY_TYPE_DIRECTORY)
1057 /* If the service exists already we are fine */
1058 dev = device_find_child(&xd->dev, p, find_service);
1064 svc = kzalloc(sizeof(*svc), GFP_KERNEL);
1068 if (populate_service(svc, p)) {
1073 id = ida_simple_get(&xd->service_ids, 0, 0, GFP_KERNEL);
1080 svc->dev.bus = &tb_bus_type;
1081 svc->dev.type = &tb_service_type;
1082 svc->dev.parent = &xd->dev;
1083 dev_set_name(&svc->dev, "%s.%d", dev_name(&xd->dev), svc->id);
1085 tb_service_debugfs_init(svc);
1087 if (device_register(&svc->dev)) {
1088 put_device(&svc->dev);
1094 static int populate_properties(struct tb_xdomain *xd,
1095 struct tb_property_dir *dir)
1097 const struct tb_property *p;
1099 /* Required properties */
1100 p = tb_property_find(dir, "deviceid", TB_PROPERTY_TYPE_VALUE);
1103 xd->device = p->value.immediate;
1105 p = tb_property_find(dir, "vendorid", TB_PROPERTY_TYPE_VALUE);
1108 xd->vendor = p->value.immediate;
1110 p = tb_property_find(dir, "maxhopid", TB_PROPERTY_TYPE_VALUE);
1112 * USB4 inter-domain spec suggests using 15 as HopID if the
1113 * other end does not announce it in a property. This is for
1114 * TBT3 compatibility.
1116 xd->remote_max_hopid = p ? p->value.immediate : XDOMAIN_DEFAULT_MAX_HOPID;
1118 kfree(xd->device_name);
1119 xd->device_name = NULL;
1120 kfree(xd->vendor_name);
1121 xd->vendor_name = NULL;
1123 /* Optional properties */
1124 p = tb_property_find(dir, "deviceid", TB_PROPERTY_TYPE_TEXT);
1126 xd->device_name = kstrdup(p->value.text, GFP_KERNEL);
1127 p = tb_property_find(dir, "vendorid", TB_PROPERTY_TYPE_TEXT);
1129 xd->vendor_name = kstrdup(p->value.text, GFP_KERNEL);
1134 static int tb_xdomain_update_link_attributes(struct tb_xdomain *xd)
1136 bool change = false;
1137 struct tb_port *port;
1140 port = tb_port_at(xd->route, tb_xdomain_parent(xd));
1142 ret = tb_port_get_link_speed(port);
1146 if (xd->link_speed != ret)
1149 xd->link_speed = ret;
1151 ret = tb_port_get_link_width(port);
1155 if (xd->link_width != ret)
1158 xd->link_width = ret;
1161 kobject_uevent(&xd->dev.kobj, KOBJ_CHANGE);
1166 static int tb_xdomain_get_uuid(struct tb_xdomain *xd)
1168 struct tb *tb = xd->tb;
1173 dev_dbg(&xd->dev, "requesting remote UUID\n");
1175 ret = tb_xdp_uuid_request(tb->ctl, xd->route, xd->state_retries, &uuid,
1178 if (xd->state_retries-- > 0) {
1179 dev_dbg(&xd->dev, "failed to request UUID, retrying\n");
1182 dev_dbg(&xd->dev, "failed to read remote UUID\n");
1187 dev_dbg(&xd->dev, "got remote UUID %pUb\n", &uuid);
1189 if (uuid_equal(&uuid, xd->local_uuid)) {
1190 if (route == xd->route)
1191 dev_dbg(&xd->dev, "loop back detected\n");
1193 dev_dbg(&xd->dev, "intra-domain loop detected\n");
1195 /* Don't bond lanes automatically for loops */
1196 xd->bonding_possible = false;
1200 * If the UUID is different, there is another domain connected
1201 * so mark this one unplugged and wait for the connection
1202 * manager to replace it.
1204 if (xd->remote_uuid && !uuid_equal(&uuid, xd->remote_uuid)) {
1205 dev_dbg(&xd->dev, "remote UUID is different, unplugging\n");
1206 xd->is_unplugged = true;
1210 /* First time fill in the missing UUID */
1211 if (!xd->remote_uuid) {
1212 xd->remote_uuid = kmemdup(&uuid, sizeof(uuid_t), GFP_KERNEL);
1213 if (!xd->remote_uuid)
1220 static int tb_xdomain_get_link_status(struct tb_xdomain *xd)
1222 struct tb *tb = xd->tb;
1223 u8 slw, tlw, sls, tls;
1226 dev_dbg(&xd->dev, "sending link state status request to %pUb\n",
1229 ret = tb_xdp_link_state_status_request(tb->ctl, xd->route,
1230 xd->state_retries, &slw, &tlw, &sls,
1233 if (ret != -EOPNOTSUPP && xd->state_retries-- > 0) {
1235 "failed to request remote link status, retrying\n");
1238 dev_dbg(&xd->dev, "failed to receive remote link status\n");
1242 dev_dbg(&xd->dev, "remote link supports width %#x speed %#x\n", slw, sls);
1244 if (slw < LANE_ADP_CS_0_SUPPORTED_WIDTH_DUAL) {
1245 dev_dbg(&xd->dev, "remote adapter is single lane only\n");
1252 static int tb_xdomain_link_state_change(struct tb_xdomain *xd,
1255 struct tb_switch *sw = tb_to_switch(xd->dev.parent);
1256 struct tb_port *port = tb_port_at(xd->route, sw);
1257 struct tb *tb = xd->tb;
1263 tlw = LANE_ADP_CS_1_TARGET_WIDTH_DUAL;
1264 else if (width == 1)
1265 tlw = LANE_ADP_CS_1_TARGET_WIDTH_SINGLE;
1269 /* Use the current target speed */
1270 ret = tb_port_read(port, &val, TB_CFG_PORT, port->cap_phy + LANE_ADP_CS_1, 1);
1273 tls = val & LANE_ADP_CS_1_TARGET_SPEED_MASK;
1275 dev_dbg(&xd->dev, "sending link state change request with width %#x speed %#x\n",
1278 ret = tb_xdp_link_state_change_request(tb->ctl, xd->route,
1279 xd->state_retries, tlw, tls);
1281 if (ret != -EOPNOTSUPP && xd->state_retries-- > 0) {
1283 "failed to change remote link state, retrying\n");
1286 dev_err(&xd->dev, "failed request link state change, aborting\n");
1290 dev_dbg(&xd->dev, "received link state change response\n");
1294 static int tb_xdomain_bond_lanes_uuid_high(struct tb_xdomain *xd)
1296 struct tb_port *port;
1299 if (xd->target_link_width == LANE_ADP_CS_1_TARGET_WIDTH_SINGLE) {
1301 } else if (xd->target_link_width == LANE_ADP_CS_1_TARGET_WIDTH_DUAL) {
1304 if (xd->state_retries-- > 0) {
1306 "link state change request not received yet, retrying\n");
1309 dev_dbg(&xd->dev, "timeout waiting for link change request\n");
1313 port = tb_port_at(xd->route, tb_xdomain_parent(xd));
1316 * We can't use tb_xdomain_lane_bonding_enable() here because it
1317 * is the other side that initiates lane bonding. So here we
1318 * just set the width to both lane adapters and wait for the
1319 * link to transition bonded.
1321 ret = tb_port_set_link_width(port->dual_link_port, width);
1323 tb_port_warn(port->dual_link_port,
1324 "failed to set link width to %d\n", width);
1328 ret = tb_port_set_link_width(port, width);
1330 tb_port_warn(port, "failed to set link width to %d\n", width);
1334 ret = tb_port_wait_for_link_width(port, width, XDOMAIN_BONDING_TIMEOUT);
1336 dev_warn(&xd->dev, "error waiting for link width to become %d\n",
1341 port->bonded = width == 2;
1342 port->dual_link_port->bonded = width == 2;
1344 tb_port_update_credits(port);
1345 tb_xdomain_update_link_attributes(xd);
1347 dev_dbg(&xd->dev, "lane bonding %s\n", str_enabled_disabled(width == 2));
1351 static int tb_xdomain_get_properties(struct tb_xdomain *xd)
1353 struct tb_property_dir *dir;
1354 struct tb *tb = xd->tb;
1355 bool update = false;
1360 dev_dbg(&xd->dev, "requesting remote properties\n");
1362 ret = tb_xdp_properties_request(tb->ctl, xd->route, xd->local_uuid,
1363 xd->remote_uuid, xd->state_retries,
1366 if (xd->state_retries-- > 0) {
1368 "failed to request remote properties, retrying\n");
1373 "failed read XDomain properties from %pUb\n",
1380 mutex_lock(&xd->lock);
1382 /* Only accept newer generation properties */
1383 if (xd->remote_properties && gen <= xd->remote_property_block_gen) {
1385 goto err_free_block;
1388 dir = tb_property_parse_dir(block, ret);
1390 dev_err(&xd->dev, "failed to parse XDomain properties\n");
1392 goto err_free_block;
1395 ret = populate_properties(xd, dir);
1397 dev_err(&xd->dev, "missing XDomain properties in response\n");
1401 /* Release the existing one */
1402 if (xd->remote_properties) {
1403 tb_property_free_dir(xd->remote_properties);
1407 xd->remote_properties = dir;
1408 xd->remote_property_block_gen = gen;
1410 tb_xdomain_update_link_attributes(xd);
1412 mutex_unlock(&xd->lock);
1417 * Now the device should be ready enough so we can add it to the
1418 * bus and let userspace know about it. If the device is already
1419 * registered, we notify the userspace that it has changed.
1423 * Now disable lane 1 if bonding was not enabled. Do
1424 * this only if bonding was possible at the beginning
1425 * (that is we are the connection manager and there are
1428 if (xd->bonding_possible) {
1429 struct tb_port *port;
1431 port = tb_port_at(xd->route, tb_xdomain_parent(xd));
1433 tb_port_disable(port->dual_link_port);
1436 if (device_add(&xd->dev)) {
1437 dev_err(&xd->dev, "failed to add XDomain device\n");
1440 dev_info(&xd->dev, "new host found, vendor=%#x device=%#x\n",
1441 xd->vendor, xd->device);
1442 if (xd->vendor_name && xd->device_name)
1443 dev_info(&xd->dev, "%s %s\n", xd->vendor_name,
1446 tb_xdomain_debugfs_init(xd);
1448 kobject_uevent(&xd->dev.kobj, KOBJ_CHANGE);
1451 enumerate_services(xd);
1455 tb_property_free_dir(dir);
1458 mutex_unlock(&xd->lock);
1463 static void tb_xdomain_queue_uuid(struct tb_xdomain *xd)
1465 xd->state = XDOMAIN_STATE_UUID;
1466 xd->state_retries = XDOMAIN_RETRIES;
1467 queue_delayed_work(xd->tb->wq, &xd->state_work,
1468 msecs_to_jiffies(XDOMAIN_SHORT_TIMEOUT));
1471 static void tb_xdomain_queue_link_status(struct tb_xdomain *xd)
1473 xd->state = XDOMAIN_STATE_LINK_STATUS;
1474 xd->state_retries = XDOMAIN_RETRIES;
1475 queue_delayed_work(xd->tb->wq, &xd->state_work,
1476 msecs_to_jiffies(XDOMAIN_DEFAULT_TIMEOUT));
1479 static void tb_xdomain_queue_link_status2(struct tb_xdomain *xd)
1481 xd->state = XDOMAIN_STATE_LINK_STATUS2;
1482 xd->state_retries = XDOMAIN_RETRIES;
1483 queue_delayed_work(xd->tb->wq, &xd->state_work,
1484 msecs_to_jiffies(XDOMAIN_DEFAULT_TIMEOUT));
1487 static void tb_xdomain_queue_bonding(struct tb_xdomain *xd)
1489 if (memcmp(xd->local_uuid, xd->remote_uuid, UUID_SIZE) > 0) {
1490 dev_dbg(&xd->dev, "we have higher UUID, other side bonds the lanes\n");
1491 xd->state = XDOMAIN_STATE_BONDING_UUID_HIGH;
1493 dev_dbg(&xd->dev, "we have lower UUID, bonding lanes\n");
1494 xd->state = XDOMAIN_STATE_LINK_STATE_CHANGE;
1497 xd->state_retries = XDOMAIN_RETRIES;
1498 queue_delayed_work(xd->tb->wq, &xd->state_work,
1499 msecs_to_jiffies(XDOMAIN_DEFAULT_TIMEOUT));
1502 static void tb_xdomain_queue_bonding_uuid_low(struct tb_xdomain *xd)
1504 xd->state = XDOMAIN_STATE_BONDING_UUID_LOW;
1505 xd->state_retries = XDOMAIN_RETRIES;
1506 queue_delayed_work(xd->tb->wq, &xd->state_work,
1507 msecs_to_jiffies(XDOMAIN_DEFAULT_TIMEOUT));
1510 static void tb_xdomain_queue_properties(struct tb_xdomain *xd)
1512 xd->state = XDOMAIN_STATE_PROPERTIES;
1513 xd->state_retries = XDOMAIN_RETRIES;
1514 queue_delayed_work(xd->tb->wq, &xd->state_work,
1515 msecs_to_jiffies(XDOMAIN_DEFAULT_TIMEOUT));
1518 static void tb_xdomain_queue_properties_changed(struct tb_xdomain *xd)
1520 xd->properties_changed_retries = XDOMAIN_RETRIES;
1521 queue_delayed_work(xd->tb->wq, &xd->properties_changed_work,
1522 msecs_to_jiffies(XDOMAIN_SHORT_TIMEOUT));
1525 static void tb_xdomain_state_work(struct work_struct *work)
1527 struct tb_xdomain *xd = container_of(work, typeof(*xd), state_work.work);
1528 int ret, state = xd->state;
1530 if (WARN_ON_ONCE(state < XDOMAIN_STATE_INIT ||
1531 state > XDOMAIN_STATE_ERROR))
1534 dev_dbg(&xd->dev, "running state %s\n", state_names[state]);
1537 case XDOMAIN_STATE_INIT:
1538 if (xd->needs_uuid) {
1539 tb_xdomain_queue_uuid(xd);
1541 tb_xdomain_queue_properties_changed(xd);
1542 tb_xdomain_queue_properties(xd);
1546 case XDOMAIN_STATE_UUID:
1547 ret = tb_xdomain_get_uuid(xd);
1551 xd->state = XDOMAIN_STATE_ERROR;
1553 tb_xdomain_queue_properties_changed(xd);
1554 if (xd->bonding_possible)
1555 tb_xdomain_queue_link_status(xd);
1557 tb_xdomain_queue_properties(xd);
1561 case XDOMAIN_STATE_LINK_STATUS:
1562 ret = tb_xdomain_get_link_status(xd);
1568 * If any of the lane bonding states fail we skip
1569 * bonding completely and try to continue from
1570 * reading properties.
1572 tb_xdomain_queue_properties(xd);
1574 tb_xdomain_queue_bonding(xd);
1578 case XDOMAIN_STATE_LINK_STATE_CHANGE:
1579 ret = tb_xdomain_link_state_change(xd, 2);
1583 tb_xdomain_queue_properties(xd);
1585 tb_xdomain_queue_link_status2(xd);
1589 case XDOMAIN_STATE_LINK_STATUS2:
1590 ret = tb_xdomain_get_link_status(xd);
1594 tb_xdomain_queue_properties(xd);
1596 tb_xdomain_queue_bonding_uuid_low(xd);
1600 case XDOMAIN_STATE_BONDING_UUID_LOW:
1601 tb_xdomain_lane_bonding_enable(xd);
1602 tb_xdomain_queue_properties(xd);
1605 case XDOMAIN_STATE_BONDING_UUID_HIGH:
1606 if (tb_xdomain_bond_lanes_uuid_high(xd) == -EAGAIN)
1608 tb_xdomain_queue_properties(xd);
1611 case XDOMAIN_STATE_PROPERTIES:
1612 ret = tb_xdomain_get_properties(xd);
1616 xd->state = XDOMAIN_STATE_ERROR;
1618 xd->state = XDOMAIN_STATE_ENUMERATED;
1622 case XDOMAIN_STATE_ENUMERATED:
1623 tb_xdomain_queue_properties(xd);
1626 case XDOMAIN_STATE_ERROR:
1630 dev_warn(&xd->dev, "unexpected state %d\n", state);
1637 queue_delayed_work(xd->tb->wq, &xd->state_work,
1638 msecs_to_jiffies(XDOMAIN_DEFAULT_TIMEOUT));
1641 static void tb_xdomain_properties_changed(struct work_struct *work)
1643 struct tb_xdomain *xd = container_of(work, typeof(*xd),
1644 properties_changed_work.work);
1647 dev_dbg(&xd->dev, "sending properties changed notification\n");
1649 ret = tb_xdp_properties_changed_request(xd->tb->ctl, xd->route,
1650 xd->properties_changed_retries, xd->local_uuid);
1652 if (xd->properties_changed_retries-- > 0) {
1654 "failed to send properties changed notification, retrying\n");
1655 queue_delayed_work(xd->tb->wq,
1656 &xd->properties_changed_work,
1657 msecs_to_jiffies(XDOMAIN_DEFAULT_TIMEOUT));
1659 dev_err(&xd->dev, "failed to send properties changed notification\n");
1663 xd->properties_changed_retries = XDOMAIN_RETRIES;
1666 static ssize_t device_show(struct device *dev, struct device_attribute *attr,
1669 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1671 return sysfs_emit(buf, "%#x\n", xd->device);
1673 static DEVICE_ATTR_RO(device);
1676 device_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1678 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1681 if (mutex_lock_interruptible(&xd->lock))
1682 return -ERESTARTSYS;
1683 ret = sysfs_emit(buf, "%s\n", xd->device_name ?: "");
1684 mutex_unlock(&xd->lock);
1688 static DEVICE_ATTR_RO(device_name);
1690 static ssize_t maxhopid_show(struct device *dev, struct device_attribute *attr,
1693 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1695 return sysfs_emit(buf, "%d\n", xd->remote_max_hopid);
1697 static DEVICE_ATTR_RO(maxhopid);
1699 static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
1702 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1704 return sysfs_emit(buf, "%#x\n", xd->vendor);
1706 static DEVICE_ATTR_RO(vendor);
1709 vendor_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1711 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1714 if (mutex_lock_interruptible(&xd->lock))
1715 return -ERESTARTSYS;
1716 ret = sysfs_emit(buf, "%s\n", xd->vendor_name ?: "");
1717 mutex_unlock(&xd->lock);
1721 static DEVICE_ATTR_RO(vendor_name);
1723 static ssize_t unique_id_show(struct device *dev, struct device_attribute *attr,
1726 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1728 return sysfs_emit(buf, "%pUb\n", xd->remote_uuid);
1730 static DEVICE_ATTR_RO(unique_id);
1732 static ssize_t speed_show(struct device *dev, struct device_attribute *attr,
1735 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1737 return sysfs_emit(buf, "%u.0 Gb/s\n", xd->link_speed);
1740 static DEVICE_ATTR(rx_speed, 0444, speed_show, NULL);
1741 static DEVICE_ATTR(tx_speed, 0444, speed_show, NULL);
1743 static ssize_t lanes_show(struct device *dev, struct device_attribute *attr,
1746 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1748 return sysfs_emit(buf, "%u\n", xd->link_width);
1751 static DEVICE_ATTR(rx_lanes, 0444, lanes_show, NULL);
1752 static DEVICE_ATTR(tx_lanes, 0444, lanes_show, NULL);
1754 static struct attribute *xdomain_attrs[] = {
1755 &dev_attr_device.attr,
1756 &dev_attr_device_name.attr,
1757 &dev_attr_maxhopid.attr,
1758 &dev_attr_rx_lanes.attr,
1759 &dev_attr_rx_speed.attr,
1760 &dev_attr_tx_lanes.attr,
1761 &dev_attr_tx_speed.attr,
1762 &dev_attr_unique_id.attr,
1763 &dev_attr_vendor.attr,
1764 &dev_attr_vendor_name.attr,
1768 static const struct attribute_group xdomain_attr_group = {
1769 .attrs = xdomain_attrs,
1772 static const struct attribute_group *xdomain_attr_groups[] = {
1773 &xdomain_attr_group,
1777 static void tb_xdomain_release(struct device *dev)
1779 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1781 put_device(xd->dev.parent);
1783 kfree(xd->local_property_block);
1784 tb_property_free_dir(xd->remote_properties);
1785 ida_destroy(&xd->out_hopids);
1786 ida_destroy(&xd->in_hopids);
1787 ida_destroy(&xd->service_ids);
1789 kfree(xd->local_uuid);
1790 kfree(xd->remote_uuid);
1791 kfree(xd->device_name);
1792 kfree(xd->vendor_name);
1796 static void start_handshake(struct tb_xdomain *xd)
1798 xd->state = XDOMAIN_STATE_INIT;
1799 queue_delayed_work(xd->tb->wq, &xd->state_work,
1800 msecs_to_jiffies(XDOMAIN_SHORT_TIMEOUT));
1803 static void stop_handshake(struct tb_xdomain *xd)
1805 cancel_delayed_work_sync(&xd->properties_changed_work);
1806 cancel_delayed_work_sync(&xd->state_work);
1807 xd->properties_changed_retries = 0;
1808 xd->state_retries = 0;
1811 static int __maybe_unused tb_xdomain_suspend(struct device *dev)
1813 stop_handshake(tb_to_xdomain(dev));
1817 static int __maybe_unused tb_xdomain_resume(struct device *dev)
1819 start_handshake(tb_to_xdomain(dev));
1823 static const struct dev_pm_ops tb_xdomain_pm_ops = {
1824 SET_SYSTEM_SLEEP_PM_OPS(tb_xdomain_suspend, tb_xdomain_resume)
1827 struct device_type tb_xdomain_type = {
1828 .name = "thunderbolt_xdomain",
1829 .release = tb_xdomain_release,
1830 .pm = &tb_xdomain_pm_ops,
1832 EXPORT_SYMBOL_GPL(tb_xdomain_type);
1835 * tb_xdomain_alloc() - Allocate new XDomain object
1836 * @tb: Domain where the XDomain belongs
1837 * @parent: Parent device (the switch through the connection to the
1838 * other domain is reached).
1839 * @route: Route string used to reach the other domain
1840 * @local_uuid: Our local domain UUID
1841 * @remote_uuid: UUID of the other domain (optional)
1843 * Allocates new XDomain structure and returns pointer to that. The
1844 * object must be released by calling tb_xdomain_put().
1846 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
1847 u64 route, const uuid_t *local_uuid,
1848 const uuid_t *remote_uuid)
1850 struct tb_switch *parent_sw = tb_to_switch(parent);
1851 struct tb_xdomain *xd;
1852 struct tb_port *down;
1854 /* Make sure the downstream domain is accessible */
1855 down = tb_port_at(route, parent_sw);
1856 tb_port_unlock(down);
1858 xd = kzalloc(sizeof(*xd), GFP_KERNEL);
1864 xd->local_max_hopid = down->config.max_in_hop_id;
1865 ida_init(&xd->service_ids);
1866 ida_init(&xd->in_hopids);
1867 ida_init(&xd->out_hopids);
1868 mutex_init(&xd->lock);
1869 INIT_DELAYED_WORK(&xd->state_work, tb_xdomain_state_work);
1870 INIT_DELAYED_WORK(&xd->properties_changed_work,
1871 tb_xdomain_properties_changed);
1873 xd->local_uuid = kmemdup(local_uuid, sizeof(uuid_t), GFP_KERNEL);
1874 if (!xd->local_uuid)
1878 xd->remote_uuid = kmemdup(remote_uuid, sizeof(uuid_t),
1880 if (!xd->remote_uuid)
1881 goto err_free_local_uuid;
1883 xd->needs_uuid = true;
1884 xd->bonding_possible = !!down->dual_link_port;
1887 device_initialize(&xd->dev);
1888 xd->dev.parent = get_device(parent);
1889 xd->dev.bus = &tb_bus_type;
1890 xd->dev.type = &tb_xdomain_type;
1891 xd->dev.groups = xdomain_attr_groups;
1892 dev_set_name(&xd->dev, "%u-%llx", tb->index, route);
1894 dev_dbg(&xd->dev, "local UUID %pUb\n", local_uuid);
1896 dev_dbg(&xd->dev, "remote UUID %pUb\n", remote_uuid);
1899 * This keeps the DMA powered on as long as we have active
1900 * connection to another host.
1902 pm_runtime_set_active(&xd->dev);
1903 pm_runtime_get_noresume(&xd->dev);
1904 pm_runtime_enable(&xd->dev);
1908 err_free_local_uuid:
1909 kfree(xd->local_uuid);
1917 * tb_xdomain_add() - Add XDomain to the bus
1918 * @xd: XDomain to add
1920 * This function starts XDomain discovery protocol handshake and
1921 * eventually adds the XDomain to the bus. After calling this function
1922 * the caller needs to call tb_xdomain_remove() in order to remove and
1923 * release the object regardless whether the handshake succeeded or not.
1925 void tb_xdomain_add(struct tb_xdomain *xd)
1927 /* Start exchanging properties with the other host */
1928 start_handshake(xd);
1931 static int unregister_service(struct device *dev, void *data)
1933 device_unregister(dev);
1938 * tb_xdomain_remove() - Remove XDomain from the bus
1939 * @xd: XDomain to remove
1941 * This will stop all ongoing configuration work and remove the XDomain
1942 * along with any services from the bus. When the last reference to @xd
1943 * is released the object will be released as well.
1945 void tb_xdomain_remove(struct tb_xdomain *xd)
1947 tb_xdomain_debugfs_remove(xd);
1951 device_for_each_child_reverse(&xd->dev, xd, unregister_service);
1954 * Undo runtime PM here explicitly because it is possible that
1955 * the XDomain was never added to the bus and thus device_del()
1956 * is not called for it (device_del() would handle this otherwise).
1958 pm_runtime_disable(&xd->dev);
1959 pm_runtime_put_noidle(&xd->dev);
1960 pm_runtime_set_suspended(&xd->dev);
1962 if (!device_is_registered(&xd->dev)) {
1963 put_device(&xd->dev);
1965 dev_info(&xd->dev, "host disconnected\n");
1966 device_unregister(&xd->dev);
1971 * tb_xdomain_lane_bonding_enable() - Enable lane bonding on XDomain
1972 * @xd: XDomain connection
1974 * Lane bonding is disabled by default for XDomains. This function tries
1975 * to enable bonding by first enabling the port and waiting for the CL0
1978 * Return: %0 in case of success and negative errno in case of error.
1980 int tb_xdomain_lane_bonding_enable(struct tb_xdomain *xd)
1982 struct tb_port *port;
1985 port = tb_port_at(xd->route, tb_xdomain_parent(xd));
1986 if (!port->dual_link_port)
1989 ret = tb_port_enable(port->dual_link_port);
1993 ret = tb_wait_for_port(port->dual_link_port, true);
1999 ret = tb_port_lane_bonding_enable(port);
2001 tb_port_warn(port, "failed to enable lane bonding\n");
2005 ret = tb_port_wait_for_link_width(port, 2, XDOMAIN_BONDING_TIMEOUT);
2007 tb_port_warn(port, "failed to enable lane bonding\n");
2011 tb_port_update_credits(port);
2012 tb_xdomain_update_link_attributes(xd);
2014 dev_dbg(&xd->dev, "lane bonding enabled\n");
2017 EXPORT_SYMBOL_GPL(tb_xdomain_lane_bonding_enable);
2020 * tb_xdomain_lane_bonding_disable() - Disable lane bonding
2021 * @xd: XDomain connection
2023 * Lane bonding is disabled by default for XDomains. If bonding has been
2024 * enabled, this function can be used to disable it.
2026 void tb_xdomain_lane_bonding_disable(struct tb_xdomain *xd)
2028 struct tb_port *port;
2030 port = tb_port_at(xd->route, tb_xdomain_parent(xd));
2031 if (port->dual_link_port) {
2032 tb_port_lane_bonding_disable(port);
2033 if (tb_port_wait_for_link_width(port, 1, 100) == -ETIMEDOUT)
2034 tb_port_warn(port, "timeout disabling lane bonding\n");
2035 tb_port_disable(port->dual_link_port);
2036 tb_port_update_credits(port);
2037 tb_xdomain_update_link_attributes(xd);
2039 dev_dbg(&xd->dev, "lane bonding disabled\n");
2042 EXPORT_SYMBOL_GPL(tb_xdomain_lane_bonding_disable);
2045 * tb_xdomain_alloc_in_hopid() - Allocate input HopID for tunneling
2046 * @xd: XDomain connection
2047 * @hopid: Preferred HopID or %-1 for next available
2049 * Returns allocated HopID or negative errno. Specifically returns
2050 * %-ENOSPC if there are no more available HopIDs. Returned HopID is
2051 * guaranteed to be within range supported by the input lane adapter.
2052 * Call tb_xdomain_release_in_hopid() to release the allocated HopID.
2054 int tb_xdomain_alloc_in_hopid(struct tb_xdomain *xd, int hopid)
2057 hopid = TB_PATH_MIN_HOPID;
2058 if (hopid < TB_PATH_MIN_HOPID || hopid > xd->local_max_hopid)
2061 return ida_alloc_range(&xd->in_hopids, hopid, xd->local_max_hopid,
2064 EXPORT_SYMBOL_GPL(tb_xdomain_alloc_in_hopid);
2067 * tb_xdomain_alloc_out_hopid() - Allocate output HopID for tunneling
2068 * @xd: XDomain connection
2069 * @hopid: Preferred HopID or %-1 for next available
2071 * Returns allocated HopID or negative errno. Specifically returns
2072 * %-ENOSPC if there are no more available HopIDs. Returned HopID is
2073 * guaranteed to be within range supported by the output lane adapter.
2074 * Call tb_xdomain_release_in_hopid() to release the allocated HopID.
2076 int tb_xdomain_alloc_out_hopid(struct tb_xdomain *xd, int hopid)
2079 hopid = TB_PATH_MIN_HOPID;
2080 if (hopid < TB_PATH_MIN_HOPID || hopid > xd->remote_max_hopid)
2083 return ida_alloc_range(&xd->out_hopids, hopid, xd->remote_max_hopid,
2086 EXPORT_SYMBOL_GPL(tb_xdomain_alloc_out_hopid);
2089 * tb_xdomain_release_in_hopid() - Release input HopID
2090 * @xd: XDomain connection
2091 * @hopid: HopID to release
2093 void tb_xdomain_release_in_hopid(struct tb_xdomain *xd, int hopid)
2095 ida_free(&xd->in_hopids, hopid);
2097 EXPORT_SYMBOL_GPL(tb_xdomain_release_in_hopid);
2100 * tb_xdomain_release_out_hopid() - Release output HopID
2101 * @xd: XDomain connection
2102 * @hopid: HopID to release
2104 void tb_xdomain_release_out_hopid(struct tb_xdomain *xd, int hopid)
2106 ida_free(&xd->out_hopids, hopid);
2108 EXPORT_SYMBOL_GPL(tb_xdomain_release_out_hopid);
2111 * tb_xdomain_enable_paths() - Enable DMA paths for XDomain connection
2112 * @xd: XDomain connection
2113 * @transmit_path: HopID we are using to send out packets
2114 * @transmit_ring: DMA ring used to send out packets
2115 * @receive_path: HopID the other end is using to send packets to us
2116 * @receive_ring: DMA ring used to receive packets from @receive_path
2118 * The function enables DMA paths accordingly so that after successful
2119 * return the caller can send and receive packets using high-speed DMA
2120 * path. If a transmit or receive path is not needed, pass %-1 for those
2123 * Return: %0 in case of success and negative errno in case of error
2125 int tb_xdomain_enable_paths(struct tb_xdomain *xd, int transmit_path,
2126 int transmit_ring, int receive_path,
2129 return tb_domain_approve_xdomain_paths(xd->tb, xd, transmit_path,
2130 transmit_ring, receive_path,
2133 EXPORT_SYMBOL_GPL(tb_xdomain_enable_paths);
2136 * tb_xdomain_disable_paths() - Disable DMA paths for XDomain connection
2137 * @xd: XDomain connection
2138 * @transmit_path: HopID we are using to send out packets
2139 * @transmit_ring: DMA ring used to send out packets
2140 * @receive_path: HopID the other end is using to send packets to us
2141 * @receive_ring: DMA ring used to receive packets from @receive_path
2143 * This does the opposite of tb_xdomain_enable_paths(). After call to
2144 * this the caller is not expected to use the rings anymore. Passing %-1
2145 * as path/ring parameter means don't care. Normally the callers should
2146 * pass the same values here as they do when paths are enabled.
2148 * Return: %0 in case of success and negative errno in case of error
2150 int tb_xdomain_disable_paths(struct tb_xdomain *xd, int transmit_path,
2151 int transmit_ring, int receive_path,
2154 return tb_domain_disconnect_xdomain_paths(xd->tb, xd, transmit_path,
2155 transmit_ring, receive_path,
2158 EXPORT_SYMBOL_GPL(tb_xdomain_disable_paths);
2160 struct tb_xdomain_lookup {
2167 static struct tb_xdomain *switch_find_xdomain(struct tb_switch *sw,
2168 const struct tb_xdomain_lookup *lookup)
2170 struct tb_port *port;
2172 tb_switch_for_each_port(sw, port) {
2173 struct tb_xdomain *xd;
2175 if (port->xdomain) {
2179 if (xd->remote_uuid &&
2180 uuid_equal(xd->remote_uuid, lookup->uuid))
2182 } else if (lookup->link &&
2183 lookup->link == xd->link &&
2184 lookup->depth == xd->depth) {
2186 } else if (lookup->route &&
2187 lookup->route == xd->route) {
2190 } else if (tb_port_has_remote(port)) {
2191 xd = switch_find_xdomain(port->remote->sw, lookup);
2201 * tb_xdomain_find_by_uuid() - Find an XDomain by UUID
2202 * @tb: Domain where the XDomain belongs to
2203 * @uuid: UUID to look for
2205 * Finds XDomain by walking through the Thunderbolt topology below @tb.
2206 * The returned XDomain will have its reference count increased so the
2207 * caller needs to call tb_xdomain_put() when it is done with the
2210 * This will find all XDomains including the ones that are not yet added
2211 * to the bus (handshake is still in progress).
2213 * The caller needs to hold @tb->lock.
2215 struct tb_xdomain *tb_xdomain_find_by_uuid(struct tb *tb, const uuid_t *uuid)
2217 struct tb_xdomain_lookup lookup;
2218 struct tb_xdomain *xd;
2220 memset(&lookup, 0, sizeof(lookup));
2223 xd = switch_find_xdomain(tb->root_switch, &lookup);
2224 return tb_xdomain_get(xd);
2226 EXPORT_SYMBOL_GPL(tb_xdomain_find_by_uuid);
2229 * tb_xdomain_find_by_link_depth() - Find an XDomain by link and depth
2230 * @tb: Domain where the XDomain belongs to
2231 * @link: Root switch link number
2232 * @depth: Depth in the link
2234 * Finds XDomain by walking through the Thunderbolt topology below @tb.
2235 * The returned XDomain will have its reference count increased so the
2236 * caller needs to call tb_xdomain_put() when it is done with the
2239 * This will find all XDomains including the ones that are not yet added
2240 * to the bus (handshake is still in progress).
2242 * The caller needs to hold @tb->lock.
2244 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
2247 struct tb_xdomain_lookup lookup;
2248 struct tb_xdomain *xd;
2250 memset(&lookup, 0, sizeof(lookup));
2252 lookup.depth = depth;
2254 xd = switch_find_xdomain(tb->root_switch, &lookup);
2255 return tb_xdomain_get(xd);
2259 * tb_xdomain_find_by_route() - Find an XDomain by route string
2260 * @tb: Domain where the XDomain belongs to
2261 * @route: XDomain route string
2263 * Finds XDomain by walking through the Thunderbolt topology below @tb.
2264 * The returned XDomain will have its reference count increased so the
2265 * caller needs to call tb_xdomain_put() when it is done with the
2268 * This will find all XDomains including the ones that are not yet added
2269 * to the bus (handshake is still in progress).
2271 * The caller needs to hold @tb->lock.
2273 struct tb_xdomain *tb_xdomain_find_by_route(struct tb *tb, u64 route)
2275 struct tb_xdomain_lookup lookup;
2276 struct tb_xdomain *xd;
2278 memset(&lookup, 0, sizeof(lookup));
2279 lookup.route = route;
2281 xd = switch_find_xdomain(tb->root_switch, &lookup);
2282 return tb_xdomain_get(xd);
2284 EXPORT_SYMBOL_GPL(tb_xdomain_find_by_route);
2286 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
2287 const void *buf, size_t size)
2289 const struct tb_protocol_handler *handler, *tmp;
2290 const struct tb_xdp_header *hdr = buf;
2291 unsigned int length;
2294 /* We expect the packet is at least size of the header */
2295 length = hdr->xd_hdr.length_sn & TB_XDOMAIN_LENGTH_MASK;
2296 if (length != size / 4 - sizeof(hdr->xd_hdr) / 4)
2298 if (length < sizeof(*hdr) / 4 - sizeof(hdr->xd_hdr) / 4)
2302 * Handle XDomain discovery protocol packets directly here. For
2303 * other protocols (based on their UUID) we call registered
2306 if (uuid_equal(&hdr->uuid, &tb_xdp_uuid)) {
2307 if (type == TB_CFG_PKG_XDOMAIN_REQ)
2308 return tb_xdp_schedule_request(tb, hdr, size);
2312 mutex_lock(&xdomain_lock);
2313 list_for_each_entry_safe(handler, tmp, &protocol_handlers, list) {
2314 if (!uuid_equal(&hdr->uuid, handler->uuid))
2317 mutex_unlock(&xdomain_lock);
2318 ret = handler->callback(buf, size, handler->data);
2319 mutex_lock(&xdomain_lock);
2324 mutex_unlock(&xdomain_lock);
2329 static int update_xdomain(struct device *dev, void *data)
2331 struct tb_xdomain *xd;
2333 xd = tb_to_xdomain(dev);
2335 queue_delayed_work(xd->tb->wq, &xd->properties_changed_work,
2336 msecs_to_jiffies(50));
2342 static void update_all_xdomains(void)
2344 bus_for_each_dev(&tb_bus_type, NULL, NULL, update_xdomain);
2347 static bool remove_directory(const char *key, const struct tb_property_dir *dir)
2349 struct tb_property *p;
2351 p = tb_property_find(xdomain_property_dir, key,
2352 TB_PROPERTY_TYPE_DIRECTORY);
2353 if (p && p->value.dir == dir) {
2354 tb_property_remove(p);
2361 * tb_register_property_dir() - Register property directory to the host
2362 * @key: Key (name) of the directory to add
2363 * @dir: Directory to add
2365 * Service drivers can use this function to add new property directory
2366 * to the host available properties. The other connected hosts are
2367 * notified so they can re-read properties of this host if they are
2370 * Return: %0 on success and negative errno on failure
2372 int tb_register_property_dir(const char *key, struct tb_property_dir *dir)
2376 if (WARN_ON(!xdomain_property_dir))
2379 if (!key || strlen(key) > 8)
2382 mutex_lock(&xdomain_lock);
2383 if (tb_property_find(xdomain_property_dir, key,
2384 TB_PROPERTY_TYPE_DIRECTORY)) {
2389 ret = tb_property_add_dir(xdomain_property_dir, key, dir);
2393 xdomain_property_block_gen++;
2395 mutex_unlock(&xdomain_lock);
2396 update_all_xdomains();
2400 mutex_unlock(&xdomain_lock);
2403 EXPORT_SYMBOL_GPL(tb_register_property_dir);
2406 * tb_unregister_property_dir() - Removes property directory from host
2407 * @key: Key (name) of the directory
2408 * @dir: Directory to remove
2410 * This will remove the existing directory from this host and notify the
2411 * connected hosts about the change.
2413 void tb_unregister_property_dir(const char *key, struct tb_property_dir *dir)
2417 mutex_lock(&xdomain_lock);
2418 if (remove_directory(key, dir))
2419 xdomain_property_block_gen++;
2420 mutex_unlock(&xdomain_lock);
2423 update_all_xdomains();
2425 EXPORT_SYMBOL_GPL(tb_unregister_property_dir);
2427 int tb_xdomain_init(void)
2429 xdomain_property_dir = tb_property_create_dir(NULL);
2430 if (!xdomain_property_dir)
2434 * Initialize standard set of properties without any service
2435 * directories. Those will be added by service drivers
2436 * themselves when they are loaded.
2438 * Rest of the properties are filled dynamically based on these
2439 * when the P2P connection is made.
2441 tb_property_add_immediate(xdomain_property_dir, "vendorid",
2442 PCI_VENDOR_ID_INTEL);
2443 tb_property_add_text(xdomain_property_dir, "vendorid", "Intel Corp.");
2444 tb_property_add_immediate(xdomain_property_dir, "deviceid", 0x1);
2445 tb_property_add_immediate(xdomain_property_dir, "devicerv", 0x80000100);
2447 xdomain_property_block_gen = get_random_u32();
2451 void tb_xdomain_exit(void)
2453 tb_property_free_dir(xdomain_property_dir);