]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/thunderbolt/switch.c
thunderbolt: Add new Thunderbolt PCI IDs
[karo-tx-linux.git] / drivers / thunderbolt / switch.c
1 /*
2  * Thunderbolt Cactus Ridge driver - switch/port utility functions
3  *
4  * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
5  */
6
7 #include <linux/delay.h>
8 #include <linux/slab.h>
9
10 #include "tb.h"
11
12 /* port utility functions */
13
14 static const char *tb_port_type(struct tb_regs_port_header *port)
15 {
16         switch (port->type >> 16) {
17         case 0:
18                 switch ((u8) port->type) {
19                 case 0:
20                         return "Inactive";
21                 case 1:
22                         return "Port";
23                 case 2:
24                         return "NHI";
25                 default:
26                         return "unknown";
27                 }
28         case 0x2:
29                 return "Ethernet";
30         case 0x8:
31                 return "SATA";
32         case 0xe:
33                 return "DP/HDMI";
34         case 0x10:
35                 return "PCIe";
36         case 0x20:
37                 return "USB";
38         default:
39                 return "unknown";
40         }
41 }
42
43 static void tb_dump_port(struct tb *tb, struct tb_regs_port_header *port)
44 {
45         tb_info(tb,
46                 " Port %d: %x:%x (Revision: %d, TB Version: %d, Type: %s (%#x))\n",
47                 port->port_number, port->vendor_id, port->device_id,
48                 port->revision, port->thunderbolt_version, tb_port_type(port),
49                 port->type);
50         tb_info(tb, "  Max hop id (in/out): %d/%d\n",
51                 port->max_in_hop_id, port->max_out_hop_id);
52         tb_info(tb, "  Max counters: %d\n", port->max_counters);
53         tb_info(tb, "  NFC Credits: %#x\n", port->nfc_credits);
54 }
55
56 /**
57  * tb_port_state() - get connectedness state of a port
58  *
59  * The port must have a TB_CAP_PHY (i.e. it should be a real port).
60  *
61  * Return: Returns an enum tb_port_state on success or an error code on failure.
62  */
63 static int tb_port_state(struct tb_port *port)
64 {
65         struct tb_cap_phy phy;
66         int res;
67         if (port->cap_phy == 0) {
68                 tb_port_WARN(port, "does not have a PHY\n");
69                 return -EINVAL;
70         }
71         res = tb_port_read(port, &phy, TB_CFG_PORT, port->cap_phy, 2);
72         if (res)
73                 return res;
74         return phy.state;
75 }
76
77 /**
78  * tb_wait_for_port() - wait for a port to become ready
79  *
80  * Wait up to 1 second for a port to reach state TB_PORT_UP. If
81  * wait_if_unplugged is set then we also wait if the port is in state
82  * TB_PORT_UNPLUGGED (it takes a while for the device to be registered after
83  * switch resume). Otherwise we only wait if a device is registered but the link
84  * has not yet been established.
85  *
86  * Return: Returns an error code on failure. Returns 0 if the port is not
87  * connected or failed to reach state TB_PORT_UP within one second. Returns 1
88  * if the port is connected and in state TB_PORT_UP.
89  */
90 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged)
91 {
92         int retries = 10;
93         int state;
94         if (!port->cap_phy) {
95                 tb_port_WARN(port, "does not have PHY\n");
96                 return -EINVAL;
97         }
98         if (tb_is_upstream_port(port)) {
99                 tb_port_WARN(port, "is the upstream port\n");
100                 return -EINVAL;
101         }
102
103         while (retries--) {
104                 state = tb_port_state(port);
105                 if (state < 0)
106                         return state;
107                 if (state == TB_PORT_DISABLED) {
108                         tb_port_info(port, "is disabled (state: 0)\n");
109                         return 0;
110                 }
111                 if (state == TB_PORT_UNPLUGGED) {
112                         if (wait_if_unplugged) {
113                                 /* used during resume */
114                                 tb_port_info(port,
115                                              "is unplugged (state: 7), retrying...\n");
116                                 msleep(100);
117                                 continue;
118                         }
119                         tb_port_info(port, "is unplugged (state: 7)\n");
120                         return 0;
121                 }
122                 if (state == TB_PORT_UP) {
123                         tb_port_info(port,
124                                      "is connected, link is up (state: 2)\n");
125                         return 1;
126                 }
127
128                 /*
129                  * After plug-in the state is TB_PORT_CONNECTING. Give it some
130                  * time.
131                  */
132                 tb_port_info(port,
133                              "is connected, link is not up (state: %d), retrying...\n",
134                              state);
135                 msleep(100);
136         }
137         tb_port_warn(port,
138                      "failed to reach state TB_PORT_UP. Ignoring port...\n");
139         return 0;
140 }
141
142 /**
143  * tb_port_add_nfc_credits() - add/remove non flow controlled credits to port
144  *
145  * Change the number of NFC credits allocated to @port by @credits. To remove
146  * NFC credits pass a negative amount of credits.
147  *
148  * Return: Returns 0 on success or an error code on failure.
149  */
150 int tb_port_add_nfc_credits(struct tb_port *port, int credits)
151 {
152         if (credits == 0)
153                 return 0;
154         tb_port_info(port,
155                      "adding %#x NFC credits (%#x -> %#x)",
156                      credits,
157                      port->config.nfc_credits,
158                      port->config.nfc_credits + credits);
159         port->config.nfc_credits += credits;
160         return tb_port_write(port, &port->config.nfc_credits,
161                              TB_CFG_PORT, 4, 1);
162 }
163
164 /**
165  * tb_port_clear_counter() - clear a counter in TB_CFG_COUNTER
166  *
167  * Return: Returns 0 on success or an error code on failure.
168  */
169 int tb_port_clear_counter(struct tb_port *port, int counter)
170 {
171         u32 zero[3] = { 0, 0, 0 };
172         tb_port_info(port, "clearing counter %d\n", counter);
173         return tb_port_write(port, zero, TB_CFG_COUNTERS, 3 * counter, 3);
174 }
175
176 /**
177  * tb_init_port() - initialize a port
178  *
179  * This is a helper method for tb_switch_alloc. Does not check or initialize
180  * any downstream switches.
181  *
182  * Return: Returns 0 on success or an error code on failure.
183  */
184 static int tb_init_port(struct tb_port *port)
185 {
186         int res;
187         int cap;
188
189         res = tb_port_read(port, &port->config, TB_CFG_PORT, 0, 8);
190         if (res)
191                 return res;
192
193         /* Port 0 is the switch itself and has no PHY. */
194         if (port->config.type == TB_TYPE_PORT && port->port != 0) {
195                 cap = tb_port_find_cap(port, TB_PORT_CAP_PHY);
196
197                 if (cap > 0)
198                         port->cap_phy = cap;
199                 else
200                         tb_port_WARN(port, "non switch port without a PHY\n");
201         }
202
203         tb_dump_port(port->sw->tb, &port->config);
204
205         /* TODO: Read dual link port, DP port and more from EEPROM. */
206         return 0;
207
208 }
209
210 /* switch utility functions */
211
212 static void tb_dump_switch(struct tb *tb, struct tb_regs_switch_header *sw)
213 {
214         tb_info(tb,
215                 " Switch: %x:%x (Revision: %d, TB Version: %d)\n",
216                 sw->vendor_id, sw->device_id, sw->revision,
217                 sw->thunderbolt_version);
218         tb_info(tb, "  Max Port Number: %d\n", sw->max_port_number);
219         tb_info(tb, "  Config:\n");
220         tb_info(tb,
221                 "   Upstream Port Number: %d Depth: %d Route String: %#llx Enabled: %d, PlugEventsDelay: %dms\n",
222                 sw->upstream_port_number, sw->depth,
223                 (((u64) sw->route_hi) << 32) | sw->route_lo,
224                 sw->enabled, sw->plug_events_delay);
225         tb_info(tb,
226                 "   unknown1: %#x unknown4: %#x\n",
227                 sw->__unknown1, sw->__unknown4);
228 }
229
230 /**
231  * reset_switch() - reconfigure route, enable and send TB_CFG_PKG_RESET
232  *
233  * Return: Returns 0 on success or an error code on failure.
234  */
235 int tb_switch_reset(struct tb *tb, u64 route)
236 {
237         struct tb_cfg_result res;
238         struct tb_regs_switch_header header = {
239                 header.route_hi = route >> 32,
240                 header.route_lo = route,
241                 header.enabled = true,
242         };
243         tb_info(tb, "resetting switch at %llx\n", route);
244         res.err = tb_cfg_write(tb->ctl, ((u32 *) &header) + 2, route,
245                         0, 2, 2, 2);
246         if (res.err)
247                 return res.err;
248         res = tb_cfg_reset(tb->ctl, route, TB_CFG_DEFAULT_TIMEOUT);
249         if (res.err > 0)
250                 return -EIO;
251         return res.err;
252 }
253
254 struct tb_switch *get_switch_at_route(struct tb_switch *sw, u64 route)
255 {
256         u8 next_port = route; /*
257                                * Routes use a stride of 8 bits,
258                                * eventhough a port index has 6 bits at most.
259                                * */
260         if (route == 0)
261                 return sw;
262         if (next_port > sw->config.max_port_number)
263                 return NULL;
264         if (tb_is_upstream_port(&sw->ports[next_port]))
265                 return NULL;
266         if (!sw->ports[next_port].remote)
267                 return NULL;
268         return get_switch_at_route(sw->ports[next_port].remote->sw,
269                                    route >> TB_ROUTE_SHIFT);
270 }
271
272 /**
273  * tb_plug_events_active() - enable/disable plug events on a switch
274  *
275  * Also configures a sane plug_events_delay of 255ms.
276  *
277  * Return: Returns 0 on success or an error code on failure.
278  */
279 static int tb_plug_events_active(struct tb_switch *sw, bool active)
280 {
281         u32 data;
282         int res;
283
284         if (!sw->config.enabled)
285                 return 0;
286
287         sw->config.plug_events_delay = 0xff;
288         res = tb_sw_write(sw, ((u32 *) &sw->config) + 4, TB_CFG_SWITCH, 4, 1);
289         if (res)
290                 return res;
291
292         res = tb_sw_read(sw, &data, TB_CFG_SWITCH, sw->cap_plug_events + 1, 1);
293         if (res)
294                 return res;
295
296         if (active) {
297                 data = data & 0xFFFFFF83;
298                 switch (sw->config.device_id) {
299                 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
300                 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
301                 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
302                         break;
303                 default:
304                         data |= 4;
305                 }
306         } else {
307                 data = data | 0x7c;
308         }
309         return tb_sw_write(sw, &data, TB_CFG_SWITCH,
310                            sw->cap_plug_events + 1, 1);
311 }
312
313 static ssize_t device_show(struct device *dev, struct device_attribute *attr,
314                            char *buf)
315 {
316         struct tb_switch *sw = tb_to_switch(dev);
317
318         return sprintf(buf, "%#x\n", sw->device);
319 }
320 static DEVICE_ATTR_RO(device);
321
322 static ssize_t
323 device_name_show(struct device *dev, struct device_attribute *attr, char *buf)
324 {
325         struct tb_switch *sw = tb_to_switch(dev);
326
327         return sprintf(buf, "%s\n", sw->device_name ? sw->device_name : "");
328 }
329 static DEVICE_ATTR_RO(device_name);
330
331 static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
332                            char *buf)
333 {
334         struct tb_switch *sw = tb_to_switch(dev);
335
336         return sprintf(buf, "%#x\n", sw->vendor);
337 }
338 static DEVICE_ATTR_RO(vendor);
339
340 static ssize_t
341 vendor_name_show(struct device *dev, struct device_attribute *attr, char *buf)
342 {
343         struct tb_switch *sw = tb_to_switch(dev);
344
345         return sprintf(buf, "%s\n", sw->vendor_name ? sw->vendor_name : "");
346 }
347 static DEVICE_ATTR_RO(vendor_name);
348
349 static ssize_t unique_id_show(struct device *dev, struct device_attribute *attr,
350                               char *buf)
351 {
352         struct tb_switch *sw = tb_to_switch(dev);
353
354         return sprintf(buf, "%pUb\n", sw->uuid);
355 }
356 static DEVICE_ATTR_RO(unique_id);
357
358 static struct attribute *switch_attrs[] = {
359         &dev_attr_device.attr,
360         &dev_attr_device_name.attr,
361         &dev_attr_vendor.attr,
362         &dev_attr_vendor_name.attr,
363         &dev_attr_unique_id.attr,
364         NULL,
365 };
366
367 static struct attribute_group switch_group = {
368         .attrs = switch_attrs,
369 };
370
371 static const struct attribute_group *switch_groups[] = {
372         &switch_group,
373         NULL,
374 };
375
376 static void tb_switch_release(struct device *dev)
377 {
378         struct tb_switch *sw = tb_to_switch(dev);
379
380         kfree(sw->uuid);
381         kfree(sw->device_name);
382         kfree(sw->vendor_name);
383         kfree(sw->ports);
384         kfree(sw->drom);
385         kfree(sw);
386 }
387
388 struct device_type tb_switch_type = {
389         .name = "thunderbolt_device",
390         .release = tb_switch_release,
391 };
392
393 /**
394  * tb_switch_alloc() - allocate a switch
395  * @tb: Pointer to the owning domain
396  * @parent: Parent device for this switch
397  * @route: Route string for this switch
398  *
399  * Allocates and initializes a switch. Will not upload configuration to
400  * the switch. For that you need to call tb_switch_configure()
401  * separately. The returned switch should be released by calling
402  * tb_switch_put().
403  *
404  * Return: Pointer to the allocated switch or %NULL in case of failure
405  */
406 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
407                                   u64 route)
408 {
409         int i;
410         int cap;
411         struct tb_switch *sw;
412         int upstream_port = tb_cfg_get_upstream_port(tb->ctl, route);
413         if (upstream_port < 0)
414                 return NULL;
415
416         sw = kzalloc(sizeof(*sw), GFP_KERNEL);
417         if (!sw)
418                 return NULL;
419
420         sw->tb = tb;
421         if (tb_cfg_read(tb->ctl, &sw->config, route, 0, TB_CFG_SWITCH, 0, 5))
422                 goto err_free_sw_ports;
423
424         tb_info(tb, "current switch config:\n");
425         tb_dump_switch(tb, &sw->config);
426
427         /* configure switch */
428         sw->config.upstream_port_number = upstream_port;
429         sw->config.depth = tb_route_length(route);
430         sw->config.route_lo = route;
431         sw->config.route_hi = route >> 32;
432         sw->config.enabled = 0;
433
434         /* initialize ports */
435         sw->ports = kcalloc(sw->config.max_port_number + 1, sizeof(*sw->ports),
436                                 GFP_KERNEL);
437         if (!sw->ports)
438                 goto err_free_sw_ports;
439
440         for (i = 0; i <= sw->config.max_port_number; i++) {
441                 /* minimum setup for tb_find_cap and tb_drom_read to work */
442                 sw->ports[i].sw = sw;
443                 sw->ports[i].port = i;
444         }
445
446         cap = tb_switch_find_vse_cap(sw, TB_VSE_CAP_PLUG_EVENTS);
447         if (cap < 0) {
448                 tb_sw_warn(sw, "cannot find TB_VSE_CAP_PLUG_EVENTS aborting\n");
449                 goto err_free_sw_ports;
450         }
451         sw->cap_plug_events = cap;
452
453         device_initialize(&sw->dev);
454         sw->dev.parent = parent;
455         sw->dev.bus = &tb_bus_type;
456         sw->dev.type = &tb_switch_type;
457         sw->dev.groups = switch_groups;
458         dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
459
460         return sw;
461
462 err_free_sw_ports:
463         kfree(sw->ports);
464         kfree(sw);
465
466         return NULL;
467 }
468
469 /**
470  * tb_switch_configure() - Uploads configuration to the switch
471  * @sw: Switch to configure
472  *
473  * Call this function before the switch is added to the system. It will
474  * upload configuration to the switch and makes it available for the
475  * connection manager to use.
476  *
477  * Return: %0 in case of success and negative errno in case of failure
478  */
479 int tb_switch_configure(struct tb_switch *sw)
480 {
481         struct tb *tb = sw->tb;
482         u64 route;
483         int ret;
484
485         route = tb_route(sw);
486         tb_info(tb,
487                 "initializing Switch at %#llx (depth: %d, up port: %d)\n",
488                 route, tb_route_length(route), sw->config.upstream_port_number);
489
490         if (sw->config.vendor_id != PCI_VENDOR_ID_INTEL)
491                 tb_sw_warn(sw, "unknown switch vendor id %#x\n",
492                            sw->config.vendor_id);
493
494         switch (sw->config.device_id) {
495         case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
496         case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
497         case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
498         case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
499         case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
500         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
501         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE:
502         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
503         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
504                 break;
505
506         default:
507                 tb_sw_warn(sw, "unsupported switch device id %#x\n",
508                            sw->config.device_id);
509         }
510
511         sw->config.enabled = 1;
512
513         /* upload configuration */
514         ret = tb_sw_write(sw, 1 + (u32 *)&sw->config, TB_CFG_SWITCH, 1, 3);
515         if (ret)
516                 return ret;
517
518         return tb_plug_events_active(sw, true);
519 }
520
521 static void tb_switch_set_uuid(struct tb_switch *sw)
522 {
523         u32 uuid[4];
524         int cap;
525
526         if (sw->uuid)
527                 return;
528
529         /*
530          * The newer controllers include fused UUID as part of link
531          * controller specific registers
532          */
533         cap = tb_switch_find_vse_cap(sw, TB_VSE_CAP_LINK_CONTROLLER);
534         if (cap > 0) {
535                 tb_sw_read(sw, uuid, TB_CFG_SWITCH, cap + 3, 4);
536         } else {
537                 /*
538                  * ICM generates UUID based on UID and fills the upper
539                  * two words with ones. This is not strictly following
540                  * UUID format but we want to be compatible with it so
541                  * we do the same here.
542                  */
543                 uuid[0] = sw->uid & 0xffffffff;
544                 uuid[1] = (sw->uid >> 32) & 0xffffffff;
545                 uuid[2] = 0xffffffff;
546                 uuid[3] = 0xffffffff;
547         }
548
549         sw->uuid = kmemdup(uuid, sizeof(uuid), GFP_KERNEL);
550 }
551
552 /**
553  * tb_switch_add() - Add a switch to the domain
554  * @sw: Switch to add
555  *
556  * This is the last step in adding switch to the domain. It will read
557  * identification information from DROM and initializes ports so that
558  * they can be used to connect other switches. The switch will be
559  * exposed to the userspace when this function successfully returns. To
560  * remove and release the switch, call tb_switch_remove().
561  *
562  * Return: %0 in case of success and negative errno in case of failure
563  */
564 int tb_switch_add(struct tb_switch *sw)
565 {
566         int i, ret;
567
568         /* read drom */
569         ret = tb_drom_read(sw);
570         if (ret) {
571                 tb_sw_warn(sw, "tb_eeprom_read_rom failed\n");
572                 return ret;
573         }
574         tb_sw_info(sw, "uid: %#llx\n", sw->uid);
575
576         tb_switch_set_uuid(sw);
577
578         for (i = 0; i <= sw->config.max_port_number; i++) {
579                 if (sw->ports[i].disabled) {
580                         tb_port_info(&sw->ports[i], "disabled by eeprom\n");
581                         continue;
582                 }
583                 ret = tb_init_port(&sw->ports[i]);
584                 if (ret)
585                         return ret;
586         }
587
588         return device_add(&sw->dev);
589 }
590
591 /**
592  * tb_switch_remove() - Remove and release a switch
593  * @sw: Switch to remove
594  *
595  * This will remove the switch from the domain and release it after last
596  * reference count drops to zero. If there are switches connected below
597  * this switch, they will be removed as well.
598  */
599 void tb_switch_remove(struct tb_switch *sw)
600 {
601         int i;
602
603         /* port 0 is the switch itself and never has a remote */
604         for (i = 1; i <= sw->config.max_port_number; i++) {
605                 if (tb_is_upstream_port(&sw->ports[i]))
606                         continue;
607                 if (sw->ports[i].remote)
608                         tb_switch_remove(sw->ports[i].remote->sw);
609                 sw->ports[i].remote = NULL;
610         }
611
612         if (!sw->is_unplugged)
613                 tb_plug_events_active(sw, false);
614
615         device_unregister(&sw->dev);
616 }
617
618 /**
619  * tb_sw_set_unplugged() - set is_unplugged on switch and downstream switches
620  */
621 void tb_sw_set_unplugged(struct tb_switch *sw)
622 {
623         int i;
624         if (sw == sw->tb->root_switch) {
625                 tb_sw_WARN(sw, "cannot unplug root switch\n");
626                 return;
627         }
628         if (sw->is_unplugged) {
629                 tb_sw_WARN(sw, "is_unplugged already set\n");
630                 return;
631         }
632         sw->is_unplugged = true;
633         for (i = 0; i <= sw->config.max_port_number; i++) {
634                 if (!tb_is_upstream_port(&sw->ports[i]) && sw->ports[i].remote)
635                         tb_sw_set_unplugged(sw->ports[i].remote->sw);
636         }
637 }
638
639 int tb_switch_resume(struct tb_switch *sw)
640 {
641         int i, err;
642         tb_sw_info(sw, "resuming switch\n");
643
644         /*
645          * Check for UID of the connected switches except for root
646          * switch which we assume cannot be removed.
647          */
648         if (tb_route(sw)) {
649                 u64 uid;
650
651                 err = tb_drom_read_uid_only(sw, &uid);
652                 if (err) {
653                         tb_sw_warn(sw, "uid read failed\n");
654                         return err;
655                 }
656                 if (sw->uid != uid) {
657                         tb_sw_info(sw,
658                                 "changed while suspended (uid %#llx -> %#llx)\n",
659                                 sw->uid, uid);
660                         return -ENODEV;
661                 }
662         }
663
664         /* upload configuration */
665         err = tb_sw_write(sw, 1 + (u32 *) &sw->config, TB_CFG_SWITCH, 1, 3);
666         if (err)
667                 return err;
668
669         err = tb_plug_events_active(sw, true);
670         if (err)
671                 return err;
672
673         /* check for surviving downstream switches */
674         for (i = 1; i <= sw->config.max_port_number; i++) {
675                 struct tb_port *port = &sw->ports[i];
676                 if (tb_is_upstream_port(port))
677                         continue;
678                 if (!port->remote)
679                         continue;
680                 if (tb_wait_for_port(port, true) <= 0
681                         || tb_switch_resume(port->remote->sw)) {
682                         tb_port_warn(port,
683                                      "lost during suspend, disconnecting\n");
684                         tb_sw_set_unplugged(port->remote->sw);
685                 }
686         }
687         return 0;
688 }
689
690 void tb_switch_suspend(struct tb_switch *sw)
691 {
692         int i, err;
693         err = tb_plug_events_active(sw, false);
694         if (err)
695                 return;
696
697         for (i = 1; i <= sw->config.max_port_number; i++) {
698                 if (!tb_is_upstream_port(&sw->ports[i]) && sw->ports[i].remote)
699                         tb_switch_suspend(sw->ports[i].remote->sw);
700         }
701         /*
702          * TODO: invoke tb_cfg_prepare_to_sleep here? does not seem to have any
703          * effect?
704          */
705 }