blob: 9e9bf8771345831093e042b5931b65dc5f9a6586 [file] [log] [blame]
b.liue9582032025-04-17 19:18:16 +08001// SPDX-License-Identifier: GPL-2.0
2/*
3 * Thunderbolt XDomain discovery protocol support
4 *
5 * Copyright (C) 2017, Intel Corporation
6 * Authors: Michael Jamet <michael.jamet@intel.com>
7 * Mika Westerberg <mika.westerberg@linux.intel.com>
8 */
9
10#include <linux/device.h>
11#include <linux/kmod.h>
12#include <linux/module.h>
13#include <linux/pm_runtime.h>
14#include <linux/utsname.h>
15#include <linux/uuid.h>
16#include <linux/workqueue.h>
17
18#include "tb.h"
19
20#define XDOMAIN_DEFAULT_TIMEOUT 5000 /* ms */
21#define XDOMAIN_UUID_RETRIES 10
22#define XDOMAIN_PROPERTIES_RETRIES 60
23#define XDOMAIN_PROPERTIES_CHANGED_RETRIES 10
24
25struct xdomain_request_work {
26 struct work_struct work;
27 struct tb_xdp_header *pkg;
28 struct tb *tb;
29};
30
31/* Serializes access to the properties and protocol handlers below */
32static DEFINE_MUTEX(xdomain_lock);
33
34/* Properties exposed to the remote domains */
35static struct tb_property_dir *xdomain_property_dir;
36static u32 *xdomain_property_block;
37static u32 xdomain_property_block_len;
38static u32 xdomain_property_block_gen;
39
40/* Additional protocol handlers */
41static LIST_HEAD(protocol_handlers);
42
43/* UUID for XDomain discovery protocol: b638d70e-42ff-40bb-97c2-90e2c0b2ff07 */
44static const uuid_t tb_xdp_uuid =
45 UUID_INIT(0xb638d70e, 0x42ff, 0x40bb,
46 0x97, 0xc2, 0x90, 0xe2, 0xc0, 0xb2, 0xff, 0x07);
47
48static bool tb_xdomain_match(const struct tb_cfg_request *req,
49 const struct ctl_pkg *pkg)
50{
51 switch (pkg->frame.eof) {
52 case TB_CFG_PKG_ERROR:
53 return true;
54
55 case TB_CFG_PKG_XDOMAIN_RESP: {
56 const struct tb_xdp_header *res_hdr = pkg->buffer;
57 const struct tb_xdp_header *req_hdr = req->request;
58
59 if (pkg->frame.size < req->response_size / 4)
60 return false;
61
62 /* Make sure route matches */
63 if ((res_hdr->xd_hdr.route_hi & ~BIT(31)) !=
64 req_hdr->xd_hdr.route_hi)
65 return false;
66 if ((res_hdr->xd_hdr.route_lo) != req_hdr->xd_hdr.route_lo)
67 return false;
68
69 /* Check that the XDomain protocol matches */
70 if (!uuid_equal(&res_hdr->uuid, &req_hdr->uuid))
71 return false;
72
73 return true;
74 }
75
76 default:
77 return false;
78 }
79}
80
81static bool tb_xdomain_copy(struct tb_cfg_request *req,
82 const struct ctl_pkg *pkg)
83{
84 memcpy(req->response, pkg->buffer, req->response_size);
85 req->result.err = 0;
86 return true;
87}
88
89static void response_ready(void *data)
90{
91 tb_cfg_request_put(data);
92}
93
94static int __tb_xdomain_response(struct tb_ctl *ctl, const void *response,
95 size_t size, enum tb_cfg_pkg_type type)
96{
97 struct tb_cfg_request *req;
98
99 req = tb_cfg_request_alloc();
100 if (!req)
101 return -ENOMEM;
102
103 req->match = tb_xdomain_match;
104 req->copy = tb_xdomain_copy;
105 req->request = response;
106 req->request_size = size;
107 req->request_type = type;
108
109 return tb_cfg_request(ctl, req, response_ready, req);
110}
111
112/**
113 * tb_xdomain_response() - Send a XDomain response message
114 * @xd: XDomain to send the message
115 * @response: Response to send
116 * @size: Size of the response
117 * @type: PDF type of the response
118 *
119 * This can be used to send a XDomain response message to the other
120 * domain. No response for the message is expected.
121 *
122 * Return: %0 in case of success and negative errno in case of failure
123 */
124int tb_xdomain_response(struct tb_xdomain *xd, const void *response,
125 size_t size, enum tb_cfg_pkg_type type)
126{
127 return __tb_xdomain_response(xd->tb->ctl, response, size, type);
128}
129EXPORT_SYMBOL_GPL(tb_xdomain_response);
130
131static int __tb_xdomain_request(struct tb_ctl *ctl, const void *request,
132 size_t request_size, enum tb_cfg_pkg_type request_type, void *response,
133 size_t response_size, enum tb_cfg_pkg_type response_type,
134 unsigned int timeout_msec)
135{
136 struct tb_cfg_request *req;
137 struct tb_cfg_result res;
138
139 req = tb_cfg_request_alloc();
140 if (!req)
141 return -ENOMEM;
142
143 req->match = tb_xdomain_match;
144 req->copy = tb_xdomain_copy;
145 req->request = request;
146 req->request_size = request_size;
147 req->request_type = request_type;
148 req->response = response;
149 req->response_size = response_size;
150 req->response_type = response_type;
151
152 res = tb_cfg_request_sync(ctl, req, timeout_msec);
153
154 tb_cfg_request_put(req);
155
156 return res.err == 1 ? -EIO : res.err;
157}
158
159/**
160 * tb_xdomain_request() - Send a XDomain request
161 * @xd: XDomain to send the request
162 * @request: Request to send
163 * @request_size: Size of the request in bytes
164 * @request_type: PDF type of the request
165 * @response: Response is copied here
166 * @response_size: Expected size of the response in bytes
167 * @response_type: Expected PDF type of the response
168 * @timeout_msec: Timeout in milliseconds to wait for the response
169 *
170 * This function can be used to send XDomain control channel messages to
171 * the other domain. The function waits until the response is received
172 * or when timeout triggers. Whichever comes first.
173 *
174 * Return: %0 in case of success and negative errno in case of failure
175 */
176int tb_xdomain_request(struct tb_xdomain *xd, const void *request,
177 size_t request_size, enum tb_cfg_pkg_type request_type,
178 void *response, size_t response_size,
179 enum tb_cfg_pkg_type response_type, unsigned int timeout_msec)
180{
181 return __tb_xdomain_request(xd->tb->ctl, request, request_size,
182 request_type, response, response_size,
183 response_type, timeout_msec);
184}
185EXPORT_SYMBOL_GPL(tb_xdomain_request);
186
187static inline void tb_xdp_fill_header(struct tb_xdp_header *hdr, u64 route,
188 u8 sequence, enum tb_xdp_type type, size_t size)
189{
190 u32 length_sn;
191
192 length_sn = (size - sizeof(hdr->xd_hdr)) / 4;
193 length_sn |= (sequence << TB_XDOMAIN_SN_SHIFT) & TB_XDOMAIN_SN_MASK;
194
195 hdr->xd_hdr.route_hi = upper_32_bits(route);
196 hdr->xd_hdr.route_lo = lower_32_bits(route);
197 hdr->xd_hdr.length_sn = length_sn;
198 hdr->type = type;
199 memcpy(&hdr->uuid, &tb_xdp_uuid, sizeof(tb_xdp_uuid));
200}
201
202static int tb_xdp_handle_error(const struct tb_xdp_header *hdr)
203{
204 const struct tb_xdp_error_response *error;
205
206 if (hdr->type != ERROR_RESPONSE)
207 return 0;
208
209 error = (const struct tb_xdp_error_response *)hdr;
210
211 switch (error->error) {
212 case ERROR_UNKNOWN_PACKET:
213 case ERROR_UNKNOWN_DOMAIN:
214 return -EIO;
215 case ERROR_NOT_SUPPORTED:
216 return -ENOTSUPP;
217 case ERROR_NOT_READY:
218 return -EAGAIN;
219 default:
220 break;
221 }
222
223 return 0;
224}
225
226static int tb_xdp_uuid_request(struct tb_ctl *ctl, u64 route, int retry,
227 uuid_t *uuid)
228{
229 struct tb_xdp_uuid_response res;
230 struct tb_xdp_uuid req;
231 int ret;
232
233 memset(&req, 0, sizeof(req));
234 tb_xdp_fill_header(&req.hdr, route, retry % 4, UUID_REQUEST,
235 sizeof(req));
236
237 memset(&res, 0, sizeof(res));
238 ret = __tb_xdomain_request(ctl, &req, sizeof(req),
239 TB_CFG_PKG_XDOMAIN_REQ, &res, sizeof(res),
240 TB_CFG_PKG_XDOMAIN_RESP,
241 XDOMAIN_DEFAULT_TIMEOUT);
242 if (ret)
243 return ret;
244
245 ret = tb_xdp_handle_error(&res.hdr);
246 if (ret)
247 return ret;
248
249 uuid_copy(uuid, &res.src_uuid);
250 return 0;
251}
252
253static int tb_xdp_uuid_response(struct tb_ctl *ctl, u64 route, u8 sequence,
254 const uuid_t *uuid)
255{
256 struct tb_xdp_uuid_response res;
257
258 memset(&res, 0, sizeof(res));
259 tb_xdp_fill_header(&res.hdr, route, sequence, UUID_RESPONSE,
260 sizeof(res));
261
262 uuid_copy(&res.src_uuid, uuid);
263 res.src_route_hi = upper_32_bits(route);
264 res.src_route_lo = lower_32_bits(route);
265
266 return __tb_xdomain_response(ctl, &res, sizeof(res),
267 TB_CFG_PKG_XDOMAIN_RESP);
268}
269
270static int tb_xdp_error_response(struct tb_ctl *ctl, u64 route, u8 sequence,
271 enum tb_xdp_error error)
272{
273 struct tb_xdp_error_response res;
274
275 memset(&res, 0, sizeof(res));
276 tb_xdp_fill_header(&res.hdr, route, sequence, ERROR_RESPONSE,
277 sizeof(res));
278 res.error = error;
279
280 return __tb_xdomain_response(ctl, &res, sizeof(res),
281 TB_CFG_PKG_XDOMAIN_RESP);
282}
283
284static int tb_xdp_properties_request(struct tb_ctl *ctl, u64 route,
285 const uuid_t *src_uuid, const uuid_t *dst_uuid, int retry,
286 u32 **block, u32 *generation)
287{
288 struct tb_xdp_properties_response *res;
289 struct tb_xdp_properties req;
290 u16 data_len, len;
291 size_t total_size;
292 u32 *data = NULL;
293 int ret;
294
295 total_size = sizeof(*res) + TB_XDP_PROPERTIES_MAX_DATA_LENGTH * 4;
296 res = kzalloc(total_size, GFP_KERNEL);
297 if (!res)
298 return -ENOMEM;
299
300 memset(&req, 0, sizeof(req));
301 tb_xdp_fill_header(&req.hdr, route, retry % 4, PROPERTIES_REQUEST,
302 sizeof(req));
303 memcpy(&req.src_uuid, src_uuid, sizeof(*src_uuid));
304 memcpy(&req.dst_uuid, dst_uuid, sizeof(*dst_uuid));
305
306 len = 0;
307 data_len = 0;
308
309 do {
310 ret = __tb_xdomain_request(ctl, &req, sizeof(req),
311 TB_CFG_PKG_XDOMAIN_REQ, res,
312 total_size, TB_CFG_PKG_XDOMAIN_RESP,
313 XDOMAIN_DEFAULT_TIMEOUT);
314 if (ret)
315 goto err;
316
317 ret = tb_xdp_handle_error(&res->hdr);
318 if (ret)
319 goto err;
320
321 /*
322 * Package length includes the whole payload without the
323 * XDomain header. Validate first that the package is at
324 * least size of the response structure.
325 */
326 len = res->hdr.xd_hdr.length_sn & TB_XDOMAIN_LENGTH_MASK;
327 if (len < sizeof(*res) / 4) {
328 ret = -EINVAL;
329 goto err;
330 }
331
332 len += sizeof(res->hdr.xd_hdr) / 4;
333 len -= sizeof(*res) / 4;
334
335 if (res->offset != req.offset) {
336 ret = -EINVAL;
337 goto err;
338 }
339
340 /*
341 * First time allocate block that has enough space for
342 * the whole properties block.
343 */
344 if (!data) {
345 data_len = res->data_length;
346 if (data_len > TB_XDP_PROPERTIES_MAX_LENGTH) {
347 ret = -E2BIG;
348 goto err;
349 }
350
351 data = kcalloc(data_len, sizeof(u32), GFP_KERNEL);
352 if (!data) {
353 ret = -ENOMEM;
354 goto err;
355 }
356 }
357
358 memcpy(data + req.offset, res->data, len * 4);
359 req.offset += len;
360 } while (!data_len || req.offset < data_len);
361
362 *block = data;
363 *generation = res->generation;
364
365 kfree(res);
366
367 return data_len;
368
369err:
370 kfree(data);
371 kfree(res);
372
373 return ret;
374}
375
376static int tb_xdp_properties_response(struct tb *tb, struct tb_ctl *ctl,
377 u64 route, u8 sequence, const uuid_t *src_uuid,
378 const struct tb_xdp_properties *req)
379{
380 struct tb_xdp_properties_response *res;
381 size_t total_size;
382 u16 len;
383 int ret;
384
385 /*
386 * Currently we expect all requests to be directed to us. The
387 * protocol supports forwarding, though which we might add
388 * support later on.
389 */
390 if (!uuid_equal(src_uuid, &req->dst_uuid)) {
391 tb_xdp_error_response(ctl, route, sequence,
392 ERROR_UNKNOWN_DOMAIN);
393 return 0;
394 }
395
396 mutex_lock(&xdomain_lock);
397
398 if (req->offset >= xdomain_property_block_len) {
399 mutex_unlock(&xdomain_lock);
400 return -EINVAL;
401 }
402
403 len = xdomain_property_block_len - req->offset;
404 len = min_t(u16, len, TB_XDP_PROPERTIES_MAX_DATA_LENGTH);
405 total_size = sizeof(*res) + len * 4;
406
407 res = kzalloc(total_size, GFP_KERNEL);
408 if (!res) {
409 mutex_unlock(&xdomain_lock);
410 return -ENOMEM;
411 }
412
413 tb_xdp_fill_header(&res->hdr, route, sequence, PROPERTIES_RESPONSE,
414 total_size);
415 res->generation = xdomain_property_block_gen;
416 res->data_length = xdomain_property_block_len;
417 res->offset = req->offset;
418 uuid_copy(&res->src_uuid, src_uuid);
419 uuid_copy(&res->dst_uuid, &req->src_uuid);
420 memcpy(res->data, &xdomain_property_block[req->offset], len * 4);
421
422 mutex_unlock(&xdomain_lock);
423
424 ret = __tb_xdomain_response(ctl, res, total_size,
425 TB_CFG_PKG_XDOMAIN_RESP);
426
427 kfree(res);
428 return ret;
429}
430
431static int tb_xdp_properties_changed_request(struct tb_ctl *ctl, u64 route,
432 int retry, const uuid_t *uuid)
433{
434 struct tb_xdp_properties_changed_response res;
435 struct tb_xdp_properties_changed req;
436 int ret;
437
438 memset(&req, 0, sizeof(req));
439 tb_xdp_fill_header(&req.hdr, route, retry % 4,
440 PROPERTIES_CHANGED_REQUEST, sizeof(req));
441 uuid_copy(&req.src_uuid, uuid);
442
443 memset(&res, 0, sizeof(res));
444 ret = __tb_xdomain_request(ctl, &req, sizeof(req),
445 TB_CFG_PKG_XDOMAIN_REQ, &res, sizeof(res),
446 TB_CFG_PKG_XDOMAIN_RESP,
447 XDOMAIN_DEFAULT_TIMEOUT);
448 if (ret)
449 return ret;
450
451 return tb_xdp_handle_error(&res.hdr);
452}
453
454static int
455tb_xdp_properties_changed_response(struct tb_ctl *ctl, u64 route, u8 sequence)
456{
457 struct tb_xdp_properties_changed_response res;
458
459 memset(&res, 0, sizeof(res));
460 tb_xdp_fill_header(&res.hdr, route, sequence,
461 PROPERTIES_CHANGED_RESPONSE, sizeof(res));
462 return __tb_xdomain_response(ctl, &res, sizeof(res),
463 TB_CFG_PKG_XDOMAIN_RESP);
464}
465
466/**
467 * tb_register_protocol_handler() - Register protocol handler
468 * @handler: Handler to register
469 *
470 * This allows XDomain service drivers to hook into incoming XDomain
471 * messages. After this function is called the service driver needs to
472 * be able to handle calls to callback whenever a package with the
473 * registered protocol is received.
474 */
475int tb_register_protocol_handler(struct tb_protocol_handler *handler)
476{
477 if (!handler->uuid || !handler->callback)
478 return -EINVAL;
479 if (uuid_equal(handler->uuid, &tb_xdp_uuid))
480 return -EINVAL;
481
482 mutex_lock(&xdomain_lock);
483 list_add_tail(&handler->list, &protocol_handlers);
484 mutex_unlock(&xdomain_lock);
485
486 return 0;
487}
488EXPORT_SYMBOL_GPL(tb_register_protocol_handler);
489
490/**
491 * tb_unregister_protocol_handler() - Unregister protocol handler
492 * @handler: Handler to unregister
493 *
494 * Removes the previously registered protocol handler.
495 */
496void tb_unregister_protocol_handler(struct tb_protocol_handler *handler)
497{
498 mutex_lock(&xdomain_lock);
499 list_del_init(&handler->list);
500 mutex_unlock(&xdomain_lock);
501}
502EXPORT_SYMBOL_GPL(tb_unregister_protocol_handler);
503
504static void tb_xdp_handle_request(struct work_struct *work)
505{
506 struct xdomain_request_work *xw = container_of(work, typeof(*xw), work);
507 const struct tb_xdp_header *pkg = xw->pkg;
508 const struct tb_xdomain_header *xhdr = &pkg->xd_hdr;
509 struct tb *tb = xw->tb;
510 struct tb_ctl *ctl = tb->ctl;
511 const uuid_t *uuid;
512 int ret = 0;
513 u32 sequence;
514 u64 route;
515
516 route = ((u64)xhdr->route_hi << 32 | xhdr->route_lo) & ~BIT_ULL(63);
517 sequence = xhdr->length_sn & TB_XDOMAIN_SN_MASK;
518 sequence >>= TB_XDOMAIN_SN_SHIFT;
519
520 mutex_lock(&tb->lock);
521 if (tb->root_switch)
522 uuid = tb->root_switch->uuid;
523 else
524 uuid = NULL;
525 mutex_unlock(&tb->lock);
526
527 if (!uuid) {
528 tb_xdp_error_response(ctl, route, sequence, ERROR_NOT_READY);
529 goto out;
530 }
531
532 switch (pkg->type) {
533 case PROPERTIES_REQUEST:
534 ret = tb_xdp_properties_response(tb, ctl, route, sequence, uuid,
535 (const struct tb_xdp_properties *)pkg);
536 break;
537
538 case PROPERTIES_CHANGED_REQUEST: {
539 const struct tb_xdp_properties_changed *xchg =
540 (const struct tb_xdp_properties_changed *)pkg;
541 struct tb_xdomain *xd;
542
543 ret = tb_xdp_properties_changed_response(ctl, route, sequence);
544
545 /*
546 * Since the properties have been changed, let's update
547 * the xdomain related to this connection as well in
548 * case there is a change in services it offers.
549 */
550 xd = tb_xdomain_find_by_uuid_locked(tb, &xchg->src_uuid);
551 if (xd) {
552 queue_delayed_work(tb->wq, &xd->get_properties_work,
553 msecs_to_jiffies(50));
554 tb_xdomain_put(xd);
555 }
556
557 break;
558 }
559
560 case UUID_REQUEST_OLD:
561 case UUID_REQUEST:
562 ret = tb_xdp_uuid_response(ctl, route, sequence, uuid);
563 break;
564
565 default:
566 tb_xdp_error_response(ctl, route, sequence,
567 ERROR_NOT_SUPPORTED);
568 break;
569 }
570
571 if (ret) {
572 tb_warn(tb, "failed to send XDomain response for %#x\n",
573 pkg->type);
574 }
575
576out:
577 kfree(xw->pkg);
578 kfree(xw);
579
580 tb_domain_put(tb);
581}
582
583static bool
584tb_xdp_schedule_request(struct tb *tb, const struct tb_xdp_header *hdr,
585 size_t size)
586{
587 struct xdomain_request_work *xw;
588
589 xw = kmalloc(sizeof(*xw), GFP_KERNEL);
590 if (!xw)
591 return false;
592
593 INIT_WORK(&xw->work, tb_xdp_handle_request);
594 xw->pkg = kmemdup(hdr, size, GFP_KERNEL);
595 if (!xw->pkg) {
596 kfree(xw);
597 return false;
598 }
599 xw->tb = tb_domain_get(tb);
600
601 schedule_work(&xw->work);
602 return true;
603}
604
605/**
606 * tb_register_service_driver() - Register XDomain service driver
607 * @drv: Driver to register
608 *
609 * Registers new service driver from @drv to the bus.
610 */
611int tb_register_service_driver(struct tb_service_driver *drv)
612{
613 drv->driver.bus = &tb_bus_type;
614 return driver_register(&drv->driver);
615}
616EXPORT_SYMBOL_GPL(tb_register_service_driver);
617
618/**
619 * tb_unregister_service_driver() - Unregister XDomain service driver
620 * @xdrv: Driver to unregister
621 *
622 * Unregisters XDomain service driver from the bus.
623 */
624void tb_unregister_service_driver(struct tb_service_driver *drv)
625{
626 driver_unregister(&drv->driver);
627}
628EXPORT_SYMBOL_GPL(tb_unregister_service_driver);
629
630static ssize_t key_show(struct device *dev, struct device_attribute *attr,
631 char *buf)
632{
633 struct tb_service *svc = container_of(dev, struct tb_service, dev);
634
635 /*
636 * It should be null terminated but anything else is pretty much
637 * allowed.
638 */
639 return sprintf(buf, "%*pE\n", (int)strlen(svc->key), svc->key);
640}
641static DEVICE_ATTR_RO(key);
642
643static int get_modalias(struct tb_service *svc, char *buf, size_t size)
644{
645 return snprintf(buf, size, "tbsvc:k%sp%08Xv%08Xr%08X", svc->key,
646 svc->prtcid, svc->prtcvers, svc->prtcrevs);
647}
648
649static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
650 char *buf)
651{
652 struct tb_service *svc = container_of(dev, struct tb_service, dev);
653
654 /* Full buffer size except new line and null termination */
655 get_modalias(svc, buf, PAGE_SIZE - 2);
656 return sprintf(buf, "%s\n", buf);
657}
658static DEVICE_ATTR_RO(modalias);
659
660static ssize_t prtcid_show(struct device *dev, struct device_attribute *attr,
661 char *buf)
662{
663 struct tb_service *svc = container_of(dev, struct tb_service, dev);
664
665 return sprintf(buf, "%u\n", svc->prtcid);
666}
667static DEVICE_ATTR_RO(prtcid);
668
669static ssize_t prtcvers_show(struct device *dev, struct device_attribute *attr,
670 char *buf)
671{
672 struct tb_service *svc = container_of(dev, struct tb_service, dev);
673
674 return sprintf(buf, "%u\n", svc->prtcvers);
675}
676static DEVICE_ATTR_RO(prtcvers);
677
678static ssize_t prtcrevs_show(struct device *dev, struct device_attribute *attr,
679 char *buf)
680{
681 struct tb_service *svc = container_of(dev, struct tb_service, dev);
682
683 return sprintf(buf, "%u\n", svc->prtcrevs);
684}
685static DEVICE_ATTR_RO(prtcrevs);
686
687static ssize_t prtcstns_show(struct device *dev, struct device_attribute *attr,
688 char *buf)
689{
690 struct tb_service *svc = container_of(dev, struct tb_service, dev);
691
692 return sprintf(buf, "0x%08x\n", svc->prtcstns);
693}
694static DEVICE_ATTR_RO(prtcstns);
695
696static struct attribute *tb_service_attrs[] = {
697 &dev_attr_key.attr,
698 &dev_attr_modalias.attr,
699 &dev_attr_prtcid.attr,
700 &dev_attr_prtcvers.attr,
701 &dev_attr_prtcrevs.attr,
702 &dev_attr_prtcstns.attr,
703 NULL,
704};
705
706static struct attribute_group tb_service_attr_group = {
707 .attrs = tb_service_attrs,
708};
709
710static const struct attribute_group *tb_service_attr_groups[] = {
711 &tb_service_attr_group,
712 NULL,
713};
714
715static int tb_service_uevent(struct device *dev, struct kobj_uevent_env *env)
716{
717 struct tb_service *svc = container_of(dev, struct tb_service, dev);
718 char modalias[64];
719
720 get_modalias(svc, modalias, sizeof(modalias));
721 return add_uevent_var(env, "MODALIAS=%s", modalias);
722}
723
724static void tb_service_release(struct device *dev)
725{
726 struct tb_service *svc = container_of(dev, struct tb_service, dev);
727 struct tb_xdomain *xd = tb_service_parent(svc);
728
729 ida_simple_remove(&xd->service_ids, svc->id);
730 kfree(svc->key);
731 kfree(svc);
732}
733
734struct device_type tb_service_type = {
735 .name = "thunderbolt_service",
736 .groups = tb_service_attr_groups,
737 .uevent = tb_service_uevent,
738 .release = tb_service_release,
739};
740EXPORT_SYMBOL_GPL(tb_service_type);
741
742static int remove_missing_service(struct device *dev, void *data)
743{
744 struct tb_xdomain *xd = data;
745 struct tb_service *svc;
746
747 svc = tb_to_service(dev);
748 if (!svc)
749 return 0;
750
751 if (!tb_property_find(xd->properties, svc->key,
752 TB_PROPERTY_TYPE_DIRECTORY))
753 device_unregister(dev);
754
755 return 0;
756}
757
758static int find_service(struct device *dev, void *data)
759{
760 const struct tb_property *p = data;
761 struct tb_service *svc;
762
763 svc = tb_to_service(dev);
764 if (!svc)
765 return 0;
766
767 return !strcmp(svc->key, p->key);
768}
769
770static int populate_service(struct tb_service *svc,
771 struct tb_property *property)
772{
773 struct tb_property_dir *dir = property->value.dir;
774 struct tb_property *p;
775
776 /* Fill in standard properties */
777 p = tb_property_find(dir, "prtcid", TB_PROPERTY_TYPE_VALUE);
778 if (p)
779 svc->prtcid = p->value.immediate;
780 p = tb_property_find(dir, "prtcvers", TB_PROPERTY_TYPE_VALUE);
781 if (p)
782 svc->prtcvers = p->value.immediate;
783 p = tb_property_find(dir, "prtcrevs", TB_PROPERTY_TYPE_VALUE);
784 if (p)
785 svc->prtcrevs = p->value.immediate;
786 p = tb_property_find(dir, "prtcstns", TB_PROPERTY_TYPE_VALUE);
787 if (p)
788 svc->prtcstns = p->value.immediate;
789
790 svc->key = kstrdup(property->key, GFP_KERNEL);
791 if (!svc->key)
792 return -ENOMEM;
793
794 return 0;
795}
796
797static void enumerate_services(struct tb_xdomain *xd)
798{
799 struct tb_service *svc;
800 struct tb_property *p;
801 struct device *dev;
802 int id;
803
804 /*
805 * First remove all services that are not available anymore in
806 * the updated property block.
807 */
808 device_for_each_child_reverse(&xd->dev, xd, remove_missing_service);
809
810 /* Then re-enumerate properties creating new services as we go */
811 tb_property_for_each(xd->properties, p) {
812 if (p->type != TB_PROPERTY_TYPE_DIRECTORY)
813 continue;
814
815 /* If the service exists already we are fine */
816 dev = device_find_child(&xd->dev, p, find_service);
817 if (dev) {
818 put_device(dev);
819 continue;
820 }
821
822 svc = kzalloc(sizeof(*svc), GFP_KERNEL);
823 if (!svc)
824 break;
825
826 if (populate_service(svc, p)) {
827 kfree(svc);
828 break;
829 }
830
831 id = ida_simple_get(&xd->service_ids, 0, 0, GFP_KERNEL);
832 if (id < 0) {
833 kfree(svc->key);
834 kfree(svc);
835 break;
836 }
837 svc->id = id;
838 svc->dev.bus = &tb_bus_type;
839 svc->dev.type = &tb_service_type;
840 svc->dev.parent = &xd->dev;
841 dev_set_name(&svc->dev, "%s.%d", dev_name(&xd->dev), svc->id);
842
843 if (device_register(&svc->dev)) {
844 put_device(&svc->dev);
845 break;
846 }
847 }
848}
849
850static int populate_properties(struct tb_xdomain *xd,
851 struct tb_property_dir *dir)
852{
853 const struct tb_property *p;
854
855 /* Required properties */
856 p = tb_property_find(dir, "deviceid", TB_PROPERTY_TYPE_VALUE);
857 if (!p)
858 return -EINVAL;
859 xd->device = p->value.immediate;
860
861 p = tb_property_find(dir, "vendorid", TB_PROPERTY_TYPE_VALUE);
862 if (!p)
863 return -EINVAL;
864 xd->vendor = p->value.immediate;
865
866 kfree(xd->device_name);
867 xd->device_name = NULL;
868 kfree(xd->vendor_name);
869 xd->vendor_name = NULL;
870
871 /* Optional properties */
872 p = tb_property_find(dir, "deviceid", TB_PROPERTY_TYPE_TEXT);
873 if (p)
874 xd->device_name = kstrdup(p->value.text, GFP_KERNEL);
875 p = tb_property_find(dir, "vendorid", TB_PROPERTY_TYPE_TEXT);
876 if (p)
877 xd->vendor_name = kstrdup(p->value.text, GFP_KERNEL);
878
879 return 0;
880}
881
882/* Called with @xd->lock held */
883static void tb_xdomain_restore_paths(struct tb_xdomain *xd)
884{
885 if (!xd->resume)
886 return;
887
888 xd->resume = false;
889 if (xd->transmit_path) {
890 dev_dbg(&xd->dev, "re-establishing DMA path\n");
891 tb_domain_approve_xdomain_paths(xd->tb, xd);
892 }
893}
894
895static void tb_xdomain_get_uuid(struct work_struct *work)
896{
897 struct tb_xdomain *xd = container_of(work, typeof(*xd),
898 get_uuid_work.work);
899 struct tb *tb = xd->tb;
900 uuid_t uuid;
901 int ret;
902
903 ret = tb_xdp_uuid_request(tb->ctl, xd->route, xd->uuid_retries, &uuid);
904 if (ret < 0) {
905 if (xd->uuid_retries-- > 0) {
906 queue_delayed_work(xd->tb->wq, &xd->get_uuid_work,
907 msecs_to_jiffies(100));
908 } else {
909 dev_dbg(&xd->dev, "failed to read remote UUID\n");
910 }
911 return;
912 }
913
914 if (uuid_equal(&uuid, xd->local_uuid)) {
915 dev_dbg(&xd->dev, "intra-domain loop detected\n");
916 return;
917 }
918
919 /*
920 * If the UUID is different, there is another domain connected
921 * so mark this one unplugged and wait for the connection
922 * manager to replace it.
923 */
924 if (xd->remote_uuid && !uuid_equal(&uuid, xd->remote_uuid)) {
925 dev_dbg(&xd->dev, "remote UUID is different, unplugging\n");
926 xd->is_unplugged = true;
927 return;
928 }
929
930 /* First time fill in the missing UUID */
931 if (!xd->remote_uuid) {
932 xd->remote_uuid = kmemdup(&uuid, sizeof(uuid_t), GFP_KERNEL);
933 if (!xd->remote_uuid)
934 return;
935 }
936
937 /* Now we can start the normal properties exchange */
938 queue_delayed_work(xd->tb->wq, &xd->properties_changed_work,
939 msecs_to_jiffies(100));
940 queue_delayed_work(xd->tb->wq, &xd->get_properties_work,
941 msecs_to_jiffies(1000));
942}
943
944static void tb_xdomain_get_properties(struct work_struct *work)
945{
946 struct tb_xdomain *xd = container_of(work, typeof(*xd),
947 get_properties_work.work);
948 struct tb_property_dir *dir;
949 struct tb *tb = xd->tb;
950 bool update = false;
951 u32 *block = NULL;
952 u32 gen = 0;
953 int ret;
954
955 ret = tb_xdp_properties_request(tb->ctl, xd->route, xd->local_uuid,
956 xd->remote_uuid, xd->properties_retries,
957 &block, &gen);
958 if (ret < 0) {
959 if (xd->properties_retries-- > 0) {
960 queue_delayed_work(xd->tb->wq, &xd->get_properties_work,
961 msecs_to_jiffies(1000));
962 } else {
963 /* Give up now */
964 dev_err(&xd->dev,
965 "failed read XDomain properties from %pUb\n",
966 xd->remote_uuid);
967 }
968 return;
969 }
970
971 xd->properties_retries = XDOMAIN_PROPERTIES_RETRIES;
972
973 mutex_lock(&xd->lock);
974
975 /* Only accept newer generation properties */
976 if (xd->properties && gen <= xd->property_block_gen) {
977 /*
978 * On resume it is likely that the properties block is
979 * not changed (unless the other end added or removed
980 * services). However, we need to make sure the existing
981 * DMA paths are restored properly.
982 */
983 tb_xdomain_restore_paths(xd);
984 goto err_free_block;
985 }
986
987 dir = tb_property_parse_dir(block, ret);
988 if (!dir) {
989 dev_err(&xd->dev, "failed to parse XDomain properties\n");
990 goto err_free_block;
991 }
992
993 ret = populate_properties(xd, dir);
994 if (ret) {
995 dev_err(&xd->dev, "missing XDomain properties in response\n");
996 goto err_free_dir;
997 }
998
999 /* Release the existing one */
1000 if (xd->properties) {
1001 tb_property_free_dir(xd->properties);
1002 update = true;
1003 }
1004
1005 xd->properties = dir;
1006 xd->property_block_gen = gen;
1007
1008 tb_xdomain_restore_paths(xd);
1009
1010 mutex_unlock(&xd->lock);
1011
1012 kfree(block);
1013
1014 /*
1015 * Now the device should be ready enough so we can add it to the
1016 * bus and let userspace know about it. If the device is already
1017 * registered, we notify the userspace that it has changed.
1018 */
1019 if (!update) {
1020 if (device_add(&xd->dev)) {
1021 dev_err(&xd->dev, "failed to add XDomain device\n");
1022 return;
1023 }
1024 } else {
1025 kobject_uevent(&xd->dev.kobj, KOBJ_CHANGE);
1026 }
1027
1028 enumerate_services(xd);
1029 return;
1030
1031err_free_dir:
1032 tb_property_free_dir(dir);
1033err_free_block:
1034 kfree(block);
1035 mutex_unlock(&xd->lock);
1036}
1037
1038static void tb_xdomain_properties_changed(struct work_struct *work)
1039{
1040 struct tb_xdomain *xd = container_of(work, typeof(*xd),
1041 properties_changed_work.work);
1042 int ret;
1043
1044 ret = tb_xdp_properties_changed_request(xd->tb->ctl, xd->route,
1045 xd->properties_changed_retries, xd->local_uuid);
1046 if (ret) {
1047 if (xd->properties_changed_retries-- > 0)
1048 queue_delayed_work(xd->tb->wq,
1049 &xd->properties_changed_work,
1050 msecs_to_jiffies(1000));
1051 return;
1052 }
1053
1054 xd->properties_changed_retries = XDOMAIN_PROPERTIES_CHANGED_RETRIES;
1055}
1056
1057static ssize_t device_show(struct device *dev, struct device_attribute *attr,
1058 char *buf)
1059{
1060 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1061
1062 return sprintf(buf, "%#x\n", xd->device);
1063}
1064static DEVICE_ATTR_RO(device);
1065
1066static ssize_t
1067device_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1068{
1069 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1070 int ret;
1071
1072 if (mutex_lock_interruptible(&xd->lock))
1073 return -ERESTARTSYS;
1074 ret = sprintf(buf, "%s\n", xd->device_name ? xd->device_name : "");
1075 mutex_unlock(&xd->lock);
1076
1077 return ret;
1078}
1079static DEVICE_ATTR_RO(device_name);
1080
1081static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
1082 char *buf)
1083{
1084 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1085
1086 return sprintf(buf, "%#x\n", xd->vendor);
1087}
1088static DEVICE_ATTR_RO(vendor);
1089
1090static ssize_t
1091vendor_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1092{
1093 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1094 int ret;
1095
1096 if (mutex_lock_interruptible(&xd->lock))
1097 return -ERESTARTSYS;
1098 ret = sprintf(buf, "%s\n", xd->vendor_name ? xd->vendor_name : "");
1099 mutex_unlock(&xd->lock);
1100
1101 return ret;
1102}
1103static DEVICE_ATTR_RO(vendor_name);
1104
1105static ssize_t unique_id_show(struct device *dev, struct device_attribute *attr,
1106 char *buf)
1107{
1108 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1109
1110 return sprintf(buf, "%pUb\n", xd->remote_uuid);
1111}
1112static DEVICE_ATTR_RO(unique_id);
1113
1114static struct attribute *xdomain_attrs[] = {
1115 &dev_attr_device.attr,
1116 &dev_attr_device_name.attr,
1117 &dev_attr_unique_id.attr,
1118 &dev_attr_vendor.attr,
1119 &dev_attr_vendor_name.attr,
1120 NULL,
1121};
1122
1123static struct attribute_group xdomain_attr_group = {
1124 .attrs = xdomain_attrs,
1125};
1126
1127static const struct attribute_group *xdomain_attr_groups[] = {
1128 &xdomain_attr_group,
1129 NULL,
1130};
1131
1132static void tb_xdomain_release(struct device *dev)
1133{
1134 struct tb_xdomain *xd = container_of(dev, struct tb_xdomain, dev);
1135
1136 put_device(xd->dev.parent);
1137
1138 tb_property_free_dir(xd->properties);
1139 ida_destroy(&xd->service_ids);
1140
1141 kfree(xd->local_uuid);
1142 kfree(xd->remote_uuid);
1143 kfree(xd->device_name);
1144 kfree(xd->vendor_name);
1145 kfree(xd);
1146}
1147
1148static void start_handshake(struct tb_xdomain *xd)
1149{
1150 xd->uuid_retries = XDOMAIN_UUID_RETRIES;
1151 xd->properties_retries = XDOMAIN_PROPERTIES_RETRIES;
1152 xd->properties_changed_retries = XDOMAIN_PROPERTIES_CHANGED_RETRIES;
1153
1154 if (xd->needs_uuid) {
1155 queue_delayed_work(xd->tb->wq, &xd->get_uuid_work,
1156 msecs_to_jiffies(100));
1157 } else {
1158 /* Start exchanging properties with the other host */
1159 queue_delayed_work(xd->tb->wq, &xd->properties_changed_work,
1160 msecs_to_jiffies(100));
1161 queue_delayed_work(xd->tb->wq, &xd->get_properties_work,
1162 msecs_to_jiffies(1000));
1163 }
1164}
1165
1166static void stop_handshake(struct tb_xdomain *xd)
1167{
1168 xd->uuid_retries = 0;
1169 xd->properties_retries = 0;
1170 xd->properties_changed_retries = 0;
1171
1172 cancel_delayed_work_sync(&xd->get_uuid_work);
1173 cancel_delayed_work_sync(&xd->get_properties_work);
1174 cancel_delayed_work_sync(&xd->properties_changed_work);
1175}
1176
1177static int __maybe_unused tb_xdomain_suspend(struct device *dev)
1178{
1179 stop_handshake(tb_to_xdomain(dev));
1180 return 0;
1181}
1182
1183static int __maybe_unused tb_xdomain_resume(struct device *dev)
1184{
1185 struct tb_xdomain *xd = tb_to_xdomain(dev);
1186
1187 /*
1188 * Ask tb_xdomain_get_properties() restore any existing DMA
1189 * paths after properties are re-read.
1190 */
1191 xd->resume = true;
1192 start_handshake(xd);
1193
1194 return 0;
1195}
1196
1197static const struct dev_pm_ops tb_xdomain_pm_ops = {
1198 SET_SYSTEM_SLEEP_PM_OPS(tb_xdomain_suspend, tb_xdomain_resume)
1199};
1200
1201struct device_type tb_xdomain_type = {
1202 .name = "thunderbolt_xdomain",
1203 .release = tb_xdomain_release,
1204 .pm = &tb_xdomain_pm_ops,
1205};
1206EXPORT_SYMBOL_GPL(tb_xdomain_type);
1207
1208/**
1209 * tb_xdomain_alloc() - Allocate new XDomain object
1210 * @tb: Domain where the XDomain belongs
1211 * @parent: Parent device (the switch through the connection to the
1212 * other domain is reached).
1213 * @route: Route string used to reach the other domain
1214 * @local_uuid: Our local domain UUID
1215 * @remote_uuid: UUID of the other domain (optional)
1216 *
1217 * Allocates new XDomain structure and returns pointer to that. The
1218 * object must be released by calling tb_xdomain_put().
1219 */
1220struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
1221 u64 route, const uuid_t *local_uuid,
1222 const uuid_t *remote_uuid)
1223{
1224 struct tb_xdomain *xd;
1225
1226 xd = kzalloc(sizeof(*xd), GFP_KERNEL);
1227 if (!xd)
1228 return NULL;
1229
1230 xd->tb = tb;
1231 xd->route = route;
1232 ida_init(&xd->service_ids);
1233 mutex_init(&xd->lock);
1234 INIT_DELAYED_WORK(&xd->get_uuid_work, tb_xdomain_get_uuid);
1235 INIT_DELAYED_WORK(&xd->get_properties_work, tb_xdomain_get_properties);
1236 INIT_DELAYED_WORK(&xd->properties_changed_work,
1237 tb_xdomain_properties_changed);
1238
1239 xd->local_uuid = kmemdup(local_uuid, sizeof(uuid_t), GFP_KERNEL);
1240 if (!xd->local_uuid)
1241 goto err_free;
1242
1243 if (remote_uuid) {
1244 xd->remote_uuid = kmemdup(remote_uuid, sizeof(uuid_t),
1245 GFP_KERNEL);
1246 if (!xd->remote_uuid)
1247 goto err_free_local_uuid;
1248 } else {
1249 xd->needs_uuid = true;
1250 }
1251
1252 device_initialize(&xd->dev);
1253 xd->dev.parent = get_device(parent);
1254 xd->dev.bus = &tb_bus_type;
1255 xd->dev.type = &tb_xdomain_type;
1256 xd->dev.groups = xdomain_attr_groups;
1257 dev_set_name(&xd->dev, "%u-%llx", tb->index, route);
1258
1259 /*
1260 * This keeps the DMA powered on as long as we have active
1261 * connection to another host.
1262 */
1263 pm_runtime_set_active(&xd->dev);
1264 pm_runtime_get_noresume(&xd->dev);
1265 pm_runtime_enable(&xd->dev);
1266
1267 return xd;
1268
1269err_free_local_uuid:
1270 kfree(xd->local_uuid);
1271err_free:
1272 kfree(xd);
1273
1274 return NULL;
1275}
1276
1277/**
1278 * tb_xdomain_add() - Add XDomain to the bus
1279 * @xd: XDomain to add
1280 *
1281 * This function starts XDomain discovery protocol handshake and
1282 * eventually adds the XDomain to the bus. After calling this function
1283 * the caller needs to call tb_xdomain_remove() in order to remove and
1284 * release the object regardless whether the handshake succeeded or not.
1285 */
1286void tb_xdomain_add(struct tb_xdomain *xd)
1287{
1288 /* Start exchanging properties with the other host */
1289 start_handshake(xd);
1290}
1291
1292static int unregister_service(struct device *dev, void *data)
1293{
1294 device_unregister(dev);
1295 return 0;
1296}
1297
1298/**
1299 * tb_xdomain_remove() - Remove XDomain from the bus
1300 * @xd: XDomain to remove
1301 *
1302 * This will stop all ongoing configuration work and remove the XDomain
1303 * along with any services from the bus. When the last reference to @xd
1304 * is released the object will be released as well.
1305 */
1306void tb_xdomain_remove(struct tb_xdomain *xd)
1307{
1308 stop_handshake(xd);
1309
1310 device_for_each_child_reverse(&xd->dev, xd, unregister_service);
1311
1312 /*
1313 * Undo runtime PM here explicitly because it is possible that
1314 * the XDomain was never added to the bus and thus device_del()
1315 * is not called for it (device_del() would handle this otherwise).
1316 */
1317 pm_runtime_disable(&xd->dev);
1318 pm_runtime_put_noidle(&xd->dev);
1319 pm_runtime_set_suspended(&xd->dev);
1320
1321 if (!device_is_registered(&xd->dev))
1322 put_device(&xd->dev);
1323 else
1324 device_unregister(&xd->dev);
1325}
1326
1327/**
1328 * tb_xdomain_enable_paths() - Enable DMA paths for XDomain connection
1329 * @xd: XDomain connection
1330 * @transmit_path: HopID of the transmit path the other end is using to
1331 * send packets
1332 * @transmit_ring: DMA ring used to receive packets from the other end
1333 * @receive_path: HopID of the receive path the other end is using to
1334 * receive packets
1335 * @receive_ring: DMA ring used to send packets to the other end
1336 *
1337 * The function enables DMA paths accordingly so that after successful
1338 * return the caller can send and receive packets using high-speed DMA
1339 * path.
1340 *
1341 * Return: %0 in case of success and negative errno in case of error
1342 */
1343int tb_xdomain_enable_paths(struct tb_xdomain *xd, u16 transmit_path,
1344 u16 transmit_ring, u16 receive_path,
1345 u16 receive_ring)
1346{
1347 int ret;
1348
1349 mutex_lock(&xd->lock);
1350
1351 if (xd->transmit_path) {
1352 ret = xd->transmit_path == transmit_path ? 0 : -EBUSY;
1353 goto exit_unlock;
1354 }
1355
1356 xd->transmit_path = transmit_path;
1357 xd->transmit_ring = transmit_ring;
1358 xd->receive_path = receive_path;
1359 xd->receive_ring = receive_ring;
1360
1361 ret = tb_domain_approve_xdomain_paths(xd->tb, xd);
1362
1363exit_unlock:
1364 mutex_unlock(&xd->lock);
1365
1366 return ret;
1367}
1368EXPORT_SYMBOL_GPL(tb_xdomain_enable_paths);
1369
1370/**
1371 * tb_xdomain_disable_paths() - Disable DMA paths for XDomain connection
1372 * @xd: XDomain connection
1373 *
1374 * This does the opposite of tb_xdomain_enable_paths(). After call to
1375 * this the caller is not expected to use the rings anymore.
1376 *
1377 * Return: %0 in case of success and negative errno in case of error
1378 */
1379int tb_xdomain_disable_paths(struct tb_xdomain *xd)
1380{
1381 int ret = 0;
1382
1383 mutex_lock(&xd->lock);
1384 if (xd->transmit_path) {
1385 xd->transmit_path = 0;
1386 xd->transmit_ring = 0;
1387 xd->receive_path = 0;
1388 xd->receive_ring = 0;
1389
1390 ret = tb_domain_disconnect_xdomain_paths(xd->tb, xd);
1391 }
1392 mutex_unlock(&xd->lock);
1393
1394 return ret;
1395}
1396EXPORT_SYMBOL_GPL(tb_xdomain_disable_paths);
1397
1398struct tb_xdomain_lookup {
1399 const uuid_t *uuid;
1400 u8 link;
1401 u8 depth;
1402 u64 route;
1403};
1404
1405static struct tb_xdomain *switch_find_xdomain(struct tb_switch *sw,
1406 const struct tb_xdomain_lookup *lookup)
1407{
1408 int i;
1409
1410 for (i = 1; i <= sw->config.max_port_number; i++) {
1411 struct tb_port *port = &sw->ports[i];
1412 struct tb_xdomain *xd;
1413
1414 if (port->xdomain) {
1415 xd = port->xdomain;
1416
1417 if (lookup->uuid) {
1418 if (xd->remote_uuid &&
1419 uuid_equal(xd->remote_uuid, lookup->uuid))
1420 return xd;
1421 } else if (lookup->link &&
1422 lookup->link == xd->link &&
1423 lookup->depth == xd->depth) {
1424 return xd;
1425 } else if (lookup->route &&
1426 lookup->route == xd->route) {
1427 return xd;
1428 }
1429 } else if (tb_port_has_remote(port)) {
1430 xd = switch_find_xdomain(port->remote->sw, lookup);
1431 if (xd)
1432 return xd;
1433 }
1434 }
1435
1436 return NULL;
1437}
1438
1439/**
1440 * tb_xdomain_find_by_uuid() - Find an XDomain by UUID
1441 * @tb: Domain where the XDomain belongs to
1442 * @uuid: UUID to look for
1443 *
1444 * Finds XDomain by walking through the Thunderbolt topology below @tb.
1445 * The returned XDomain will have its reference count increased so the
1446 * caller needs to call tb_xdomain_put() when it is done with the
1447 * object.
1448 *
1449 * This will find all XDomains including the ones that are not yet added
1450 * to the bus (handshake is still in progress).
1451 *
1452 * The caller needs to hold @tb->lock.
1453 */
1454struct tb_xdomain *tb_xdomain_find_by_uuid(struct tb *tb, const uuid_t *uuid)
1455{
1456 struct tb_xdomain_lookup lookup;
1457 struct tb_xdomain *xd;
1458
1459 memset(&lookup, 0, sizeof(lookup));
1460 lookup.uuid = uuid;
1461
1462 xd = switch_find_xdomain(tb->root_switch, &lookup);
1463 return tb_xdomain_get(xd);
1464}
1465EXPORT_SYMBOL_GPL(tb_xdomain_find_by_uuid);
1466
1467/**
1468 * tb_xdomain_find_by_link_depth() - Find an XDomain by link and depth
1469 * @tb: Domain where the XDomain belongs to
1470 * @link: Root switch link number
1471 * @depth: Depth in the link
1472 *
1473 * Finds XDomain by walking through the Thunderbolt topology below @tb.
1474 * The returned XDomain will have its reference count increased so the
1475 * caller needs to call tb_xdomain_put() when it is done with the
1476 * object.
1477 *
1478 * This will find all XDomains including the ones that are not yet added
1479 * to the bus (handshake is still in progress).
1480 *
1481 * The caller needs to hold @tb->lock.
1482 */
1483struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
1484 u8 depth)
1485{
1486 struct tb_xdomain_lookup lookup;
1487 struct tb_xdomain *xd;
1488
1489 memset(&lookup, 0, sizeof(lookup));
1490 lookup.link = link;
1491 lookup.depth = depth;
1492
1493 xd = switch_find_xdomain(tb->root_switch, &lookup);
1494 return tb_xdomain_get(xd);
1495}
1496
1497/**
1498 * tb_xdomain_find_by_route() - Find an XDomain by route string
1499 * @tb: Domain where the XDomain belongs to
1500 * @route: XDomain route string
1501 *
1502 * Finds XDomain by walking through the Thunderbolt topology below @tb.
1503 * The returned XDomain will have its reference count increased so the
1504 * caller needs to call tb_xdomain_put() when it is done with the
1505 * object.
1506 *
1507 * This will find all XDomains including the ones that are not yet added
1508 * to the bus (handshake is still in progress).
1509 *
1510 * The caller needs to hold @tb->lock.
1511 */
1512struct tb_xdomain *tb_xdomain_find_by_route(struct tb *tb, u64 route)
1513{
1514 struct tb_xdomain_lookup lookup;
1515 struct tb_xdomain *xd;
1516
1517 memset(&lookup, 0, sizeof(lookup));
1518 lookup.route = route;
1519
1520 xd = switch_find_xdomain(tb->root_switch, &lookup);
1521 return tb_xdomain_get(xd);
1522}
1523EXPORT_SYMBOL_GPL(tb_xdomain_find_by_route);
1524
1525bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
1526 const void *buf, size_t size)
1527{
1528 const struct tb_protocol_handler *handler, *tmp;
1529 const struct tb_xdp_header *hdr = buf;
1530 unsigned int length;
1531 int ret = 0;
1532
1533 /* We expect the packet is at least size of the header */
1534 length = hdr->xd_hdr.length_sn & TB_XDOMAIN_LENGTH_MASK;
1535 if (length != size / 4 - sizeof(hdr->xd_hdr) / 4)
1536 return true;
1537 if (length < sizeof(*hdr) / 4 - sizeof(hdr->xd_hdr) / 4)
1538 return true;
1539
1540 /*
1541 * Handle XDomain discovery protocol packets directly here. For
1542 * other protocols (based on their UUID) we call registered
1543 * handlers in turn.
1544 */
1545 if (uuid_equal(&hdr->uuid, &tb_xdp_uuid)) {
1546 if (type == TB_CFG_PKG_XDOMAIN_REQ)
1547 return tb_xdp_schedule_request(tb, hdr, size);
1548 return false;
1549 }
1550
1551 mutex_lock(&xdomain_lock);
1552 list_for_each_entry_safe(handler, tmp, &protocol_handlers, list) {
1553 if (!uuid_equal(&hdr->uuid, handler->uuid))
1554 continue;
1555
1556 mutex_unlock(&xdomain_lock);
1557 ret = handler->callback(buf, size, handler->data);
1558 mutex_lock(&xdomain_lock);
1559
1560 if (ret)
1561 break;
1562 }
1563 mutex_unlock(&xdomain_lock);
1564
1565 return ret > 0;
1566}
1567
1568static int rebuild_property_block(void)
1569{
1570 u32 *block, len;
1571 int ret;
1572
1573 ret = tb_property_format_dir(xdomain_property_dir, NULL, 0);
1574 if (ret < 0)
1575 return ret;
1576
1577 len = ret;
1578
1579 block = kcalloc(len, sizeof(u32), GFP_KERNEL);
1580 if (!block)
1581 return -ENOMEM;
1582
1583 ret = tb_property_format_dir(xdomain_property_dir, block, len);
1584 if (ret) {
1585 kfree(block);
1586 return ret;
1587 }
1588
1589 kfree(xdomain_property_block);
1590 xdomain_property_block = block;
1591 xdomain_property_block_len = len;
1592 xdomain_property_block_gen++;
1593
1594 return 0;
1595}
1596
1597static int update_xdomain(struct device *dev, void *data)
1598{
1599 struct tb_xdomain *xd;
1600
1601 xd = tb_to_xdomain(dev);
1602 if (xd) {
1603 queue_delayed_work(xd->tb->wq, &xd->properties_changed_work,
1604 msecs_to_jiffies(50));
1605 }
1606
1607 return 0;
1608}
1609
1610static void update_all_xdomains(void)
1611{
1612 bus_for_each_dev(&tb_bus_type, NULL, NULL, update_xdomain);
1613}
1614
1615static bool remove_directory(const char *key, const struct tb_property_dir *dir)
1616{
1617 struct tb_property *p;
1618
1619 p = tb_property_find(xdomain_property_dir, key,
1620 TB_PROPERTY_TYPE_DIRECTORY);
1621 if (p && p->value.dir == dir) {
1622 tb_property_remove(p);
1623 return true;
1624 }
1625 return false;
1626}
1627
1628/**
1629 * tb_register_property_dir() - Register property directory to the host
1630 * @key: Key (name) of the directory to add
1631 * @dir: Directory to add
1632 *
1633 * Service drivers can use this function to add new property directory
1634 * to the host available properties. The other connected hosts are
1635 * notified so they can re-read properties of this host if they are
1636 * interested.
1637 *
1638 * Return: %0 on success and negative errno on failure
1639 */
1640int tb_register_property_dir(const char *key, struct tb_property_dir *dir)
1641{
1642 int ret;
1643
1644 if (WARN_ON(!xdomain_property_dir))
1645 return -EAGAIN;
1646
1647 if (!key || strlen(key) > 8)
1648 return -EINVAL;
1649
1650 mutex_lock(&xdomain_lock);
1651 if (tb_property_find(xdomain_property_dir, key,
1652 TB_PROPERTY_TYPE_DIRECTORY)) {
1653 ret = -EEXIST;
1654 goto err_unlock;
1655 }
1656
1657 ret = tb_property_add_dir(xdomain_property_dir, key, dir);
1658 if (ret)
1659 goto err_unlock;
1660
1661 ret = rebuild_property_block();
1662 if (ret) {
1663 remove_directory(key, dir);
1664 goto err_unlock;
1665 }
1666
1667 mutex_unlock(&xdomain_lock);
1668 update_all_xdomains();
1669 return 0;
1670
1671err_unlock:
1672 mutex_unlock(&xdomain_lock);
1673 return ret;
1674}
1675EXPORT_SYMBOL_GPL(tb_register_property_dir);
1676
1677/**
1678 * tb_unregister_property_dir() - Removes property directory from host
1679 * @key: Key (name) of the directory
1680 * @dir: Directory to remove
1681 *
1682 * This will remove the existing directory from this host and notify the
1683 * connected hosts about the change.
1684 */
1685void tb_unregister_property_dir(const char *key, struct tb_property_dir *dir)
1686{
1687 int ret = 0;
1688
1689 mutex_lock(&xdomain_lock);
1690 if (remove_directory(key, dir))
1691 ret = rebuild_property_block();
1692 mutex_unlock(&xdomain_lock);
1693
1694 if (!ret)
1695 update_all_xdomains();
1696}
1697EXPORT_SYMBOL_GPL(tb_unregister_property_dir);
1698
1699int tb_xdomain_init(void)
1700{
1701 int ret;
1702
1703 xdomain_property_dir = tb_property_create_dir(NULL);
1704 if (!xdomain_property_dir)
1705 return -ENOMEM;
1706
1707 /*
1708 * Initialize standard set of properties without any service
1709 * directories. Those will be added by service drivers
1710 * themselves when they are loaded.
1711 */
1712 tb_property_add_immediate(xdomain_property_dir, "vendorid",
1713 PCI_VENDOR_ID_INTEL);
1714 tb_property_add_text(xdomain_property_dir, "vendorid", "Intel Corp.");
1715 tb_property_add_immediate(xdomain_property_dir, "deviceid", 0x1);
1716 tb_property_add_text(xdomain_property_dir, "deviceid",
1717 utsname()->nodename);
1718 tb_property_add_immediate(xdomain_property_dir, "devicerv", 0x80000100);
1719
1720 ret = rebuild_property_block();
1721 if (ret) {
1722 tb_property_free_dir(xdomain_property_dir);
1723 xdomain_property_dir = NULL;
1724 }
1725
1726 return ret;
1727}
1728
1729void tb_xdomain_exit(void)
1730{
1731 kfree(xdomain_property_block);
1732 tb_property_free_dir(xdomain_property_dir);
1733}