Merge tag 'amd-drm-next-5.13-2021-03-23' of https://gitlab.freedesktop.org/agd5f...
[linux-2.6-microblaze.git] / drivers / thunderbolt / tb.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Thunderbolt driver - bus logic (NHI independent)
4  *
5  * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
6  * Copyright (C) 2018, Intel Corporation
7  */
8
9 #ifndef TB_H_
10 #define TB_H_
11
12 #include <linux/nvmem-provider.h>
13 #include <linux/pci.h>
14 #include <linux/thunderbolt.h>
15 #include <linux/uuid.h>
16
17 #include "tb_regs.h"
18 #include "ctl.h"
19 #include "dma_port.h"
20
21 #define NVM_MIN_SIZE            SZ_32K
22 #define NVM_MAX_SIZE            SZ_512K
23
24 /* Intel specific NVM offsets */
25 #define NVM_DEVID               0x05
26 #define NVM_VERSION             0x08
27 #define NVM_FLASH_SIZE          0x45
28
29 /**
30  * struct tb_nvm - Structure holding NVM information
31  * @dev: Owner of the NVM
32  * @major: Major version number of the active NVM portion
33  * @minor: Minor version number of the active NVM portion
34  * @id: Identifier used with both NVM portions
35  * @active: Active portion NVMem device
36  * @non_active: Non-active portion NVMem device
37  * @buf: Buffer where the NVM image is stored before it is written to
38  *       the actual NVM flash device
39  * @buf_data_size: Number of bytes actually consumed by the new NVM
40  *                 image
41  * @authenticating: The device is authenticating the new NVM
42  * @flushed: The image has been flushed to the storage area
43  *
44  * The user of this structure needs to handle serialization of possible
45  * concurrent access.
46  */
47 struct tb_nvm {
48         struct device *dev;
49         u8 major;
50         u8 minor;
51         int id;
52         struct nvmem_device *active;
53         struct nvmem_device *non_active;
54         void *buf;
55         size_t buf_data_size;
56         bool authenticating;
57         bool flushed;
58 };
59
60 #define TB_SWITCH_KEY_SIZE              32
61 #define TB_SWITCH_MAX_DEPTH             6
62 #define USB4_SWITCH_MAX_DEPTH           5
63
64 /**
65  * enum tb_switch_tmu_rate - TMU refresh rate
66  * @TB_SWITCH_TMU_RATE_OFF: %0 (Disable Time Sync handshake)
67  * @TB_SWITCH_TMU_RATE_HIFI: %16 us time interval between successive
68  *                           transmission of the Delay Request TSNOS
69  *                           (Time Sync Notification Ordered Set) on a Link
70  * @TB_SWITCH_TMU_RATE_NORMAL: %1 ms time interval between successive
71  *                             transmission of the Delay Request TSNOS on
72  *                             a Link
73  */
74 enum tb_switch_tmu_rate {
75         TB_SWITCH_TMU_RATE_OFF = 0,
76         TB_SWITCH_TMU_RATE_HIFI = 16,
77         TB_SWITCH_TMU_RATE_NORMAL = 1000,
78 };
79
80 /**
81  * struct tb_switch_tmu - Structure holding switch TMU configuration
82  * @cap: Offset to the TMU capability (%0 if not found)
83  * @has_ucap: Does the switch support uni-directional mode
84  * @rate: TMU refresh rate related to upstream switch. In case of root
85  *        switch this holds the domain rate.
86  * @unidirectional: Is the TMU in uni-directional or bi-directional mode
87  *                  related to upstream switch. Don't case for root switch.
88  */
89 struct tb_switch_tmu {
90         int cap;
91         bool has_ucap;
92         enum tb_switch_tmu_rate rate;
93         bool unidirectional;
94 };
95
96 /**
97  * struct tb_switch - a thunderbolt switch
98  * @dev: Device for the switch
99  * @config: Switch configuration
100  * @ports: Ports in this switch
101  * @dma_port: If the switch has port supporting DMA configuration based
102  *            mailbox this will hold the pointer to that (%NULL
103  *            otherwise). If set it also means the switch has
104  *            upgradeable NVM.
105  * @tmu: The switch TMU configuration
106  * @tb: Pointer to the domain the switch belongs to
107  * @uid: Unique ID of the switch
108  * @uuid: UUID of the switch (or %NULL if not supported)
109  * @vendor: Vendor ID of the switch
110  * @device: Device ID of the switch
111  * @vendor_name: Name of the vendor (or %NULL if not known)
112  * @device_name: Name of the device (or %NULL if not known)
113  * @link_speed: Speed of the link in Gb/s
114  * @link_width: Width of the link (1 or 2)
115  * @link_usb4: Upstream link is USB4
116  * @generation: Switch Thunderbolt generation
117  * @cap_plug_events: Offset to the plug events capability (%0 if not found)
118  * @cap_lc: Offset to the link controller capability (%0 if not found)
119  * @is_unplugged: The switch is going away
120  * @drom: DROM of the switch (%NULL if not found)
121  * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
122  * @no_nvm_upgrade: Prevent NVM upgrade of this switch
123  * @safe_mode: The switch is in safe-mode
124  * @boot: Whether the switch was already authorized on boot or not
125  * @rpm: The switch supports runtime PM
126  * @authorized: Whether the switch is authorized by user or policy
127  * @security_level: Switch supported security level
128  * @debugfs_dir: Pointer to the debugfs structure
129  * @key: Contains the key used to challenge the device or %NULL if not
130  *       supported. Size of the key is %TB_SWITCH_KEY_SIZE.
131  * @connection_id: Connection ID used with ICM messaging
132  * @connection_key: Connection key used with ICM messaging
133  * @link: Root switch link this switch is connected (ICM only)
134  * @depth: Depth in the chain this switch is connected (ICM only)
135  * @rpm_complete: Completion used to wait for runtime resume to
136  *                complete (ICM only)
137  * @quirks: Quirks used for this Thunderbolt switch
138  *
139  * When the switch is being added or removed to the domain (other
140  * switches) you need to have domain lock held.
141  *
142  * In USB4 terminology this structure represents a router.
143  */
144 struct tb_switch {
145         struct device dev;
146         struct tb_regs_switch_header config;
147         struct tb_port *ports;
148         struct tb_dma_port *dma_port;
149         struct tb_switch_tmu tmu;
150         struct tb *tb;
151         u64 uid;
152         uuid_t *uuid;
153         u16 vendor;
154         u16 device;
155         const char *vendor_name;
156         const char *device_name;
157         unsigned int link_speed;
158         unsigned int link_width;
159         bool link_usb4;
160         unsigned int generation;
161         int cap_plug_events;
162         int cap_lc;
163         bool is_unplugged;
164         u8 *drom;
165         struct tb_nvm *nvm;
166         bool no_nvm_upgrade;
167         bool safe_mode;
168         bool boot;
169         bool rpm;
170         unsigned int authorized;
171         enum tb_security_level security_level;
172         struct dentry *debugfs_dir;
173         u8 *key;
174         u8 connection_id;
175         u8 connection_key;
176         u8 link;
177         u8 depth;
178         struct completion rpm_complete;
179         unsigned long quirks;
180 };
181
182 /**
183  * struct tb_port - a thunderbolt port, part of a tb_switch
184  * @config: Cached port configuration read from registers
185  * @sw: Switch the port belongs to
186  * @remote: Remote port (%NULL if not connected)
187  * @xdomain: Remote host (%NULL if not connected)
188  * @cap_phy: Offset, zero if not found
189  * @cap_tmu: Offset of the adapter specific TMU capability (%0 if not present)
190  * @cap_adap: Offset of the adapter specific capability (%0 if not present)
191  * @cap_usb4: Offset to the USB4 port capability (%0 if not present)
192  * @port: Port number on switch
193  * @disabled: Disabled by eeprom or enabled but not implemented
194  * @bonded: true if the port is bonded (two lanes combined as one)
195  * @dual_link_port: If the switch is connected using two ports, points
196  *                  to the other port.
197  * @link_nr: Is this primary or secondary port on the dual_link.
198  * @in_hopids: Currently allocated input HopIDs
199  * @out_hopids: Currently allocated output HopIDs
200  * @list: Used to link ports to DP resources list
201  *
202  * In USB4 terminology this structure represents an adapter (protocol or
203  * lane adapter).
204  */
205 struct tb_port {
206         struct tb_regs_port_header config;
207         struct tb_switch *sw;
208         struct tb_port *remote;
209         struct tb_xdomain *xdomain;
210         int cap_phy;
211         int cap_tmu;
212         int cap_adap;
213         int cap_usb4;
214         u8 port;
215         bool disabled;
216         bool bonded;
217         struct tb_port *dual_link_port;
218         u8 link_nr:1;
219         struct ida in_hopids;
220         struct ida out_hopids;
221         struct list_head list;
222 };
223
224 /**
225  * tb_retimer: Thunderbolt retimer
226  * @dev: Device for the retimer
227  * @tb: Pointer to the domain the retimer belongs to
228  * @index: Retimer index facing the router USB4 port
229  * @vendor: Vendor ID of the retimer
230  * @device: Device ID of the retimer
231  * @port: Pointer to the lane 0 adapter
232  * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise)
233  * @auth_status: Status of last NVM authentication
234  */
235 struct tb_retimer {
236         struct device dev;
237         struct tb *tb;
238         u8 index;
239         u32 vendor;
240         u32 device;
241         struct tb_port *port;
242         struct tb_nvm *nvm;
243         u32 auth_status;
244 };
245
246 /**
247  * struct tb_path_hop - routing information for a tb_path
248  * @in_port: Ingress port of a switch
249  * @out_port: Egress port of a switch where the packet is routed out
250  *            (must be on the same switch than @in_port)
251  * @in_hop_index: HopID where the path configuration entry is placed in
252  *                the path config space of @in_port.
253  * @in_counter_index: Used counter index (not used in the driver
254  *                    currently, %-1 to disable)
255  * @next_hop_index: HopID of the packet when it is routed out from @out_port
256  * @initial_credits: Number of initial flow control credits allocated for
257  *                   the path
258  *
259  * Hop configuration is always done on the IN port of a switch.
260  * in_port and out_port have to be on the same switch. Packets arriving on
261  * in_port with "hop" = in_hop_index will get routed to through out_port. The
262  * next hop to take (on out_port->remote) is determined by
263  * next_hop_index. When routing packet to another switch (out->remote is
264  * set) the @next_hop_index must match the @in_hop_index of that next
265  * hop to make routing possible.
266  *
267  * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
268  * port.
269  */
270 struct tb_path_hop {
271         struct tb_port *in_port;
272         struct tb_port *out_port;
273         int in_hop_index;
274         int in_counter_index;
275         int next_hop_index;
276         unsigned int initial_credits;
277 };
278
279 /**
280  * enum tb_path_port - path options mask
281  * @TB_PATH_NONE: Do not activate on any hop on path
282  * @TB_PATH_SOURCE: Activate on the first hop (out of src)
283  * @TB_PATH_INTERNAL: Activate on the intermediate hops (not the first/last)
284  * @TB_PATH_DESTINATION: Activate on the last hop (into dst)
285  * @TB_PATH_ALL: Activate on all hops on the path
286  */
287 enum tb_path_port {
288         TB_PATH_NONE = 0,
289         TB_PATH_SOURCE = 1,
290         TB_PATH_INTERNAL = 2,
291         TB_PATH_DESTINATION = 4,
292         TB_PATH_ALL = 7,
293 };
294
295 /**
296  * struct tb_path - a unidirectional path between two ports
297  * @tb: Pointer to the domain structure
298  * @name: Name of the path (used for debugging)
299  * @nfc_credits: Number of non flow controlled credits allocated for the path
300  * @ingress_shared_buffer: Shared buffering used for ingress ports on the path
301  * @egress_shared_buffer: Shared buffering used for egress ports on the path
302  * @ingress_fc_enable: Flow control for ingress ports on the path
303  * @egress_fc_enable: Flow control for egress ports on the path
304  * @priority: Priority group if the path
305  * @weight: Weight of the path inside the priority group
306  * @drop_packages: Drop packages from queue tail or head
307  * @activated: Is the path active
308  * @clear_fc: Clear all flow control from the path config space entries
309  *            when deactivating this path
310  * @hops: Path hops
311  * @path_length: How many hops the path uses
312  *
313  * A path consists of a number of hops (see &struct tb_path_hop). To
314  * establish a PCIe tunnel two paths have to be created between the two
315  * PCIe ports.
316  */
317 struct tb_path {
318         struct tb *tb;
319         const char *name;
320         int nfc_credits;
321         enum tb_path_port ingress_shared_buffer;
322         enum tb_path_port egress_shared_buffer;
323         enum tb_path_port ingress_fc_enable;
324         enum tb_path_port egress_fc_enable;
325
326         unsigned int priority:3;
327         int weight:4;
328         bool drop_packages;
329         bool activated;
330         bool clear_fc;
331         struct tb_path_hop *hops;
332         int path_length;
333 };
334
335 /* HopIDs 0-7 are reserved by the Thunderbolt protocol */
336 #define TB_PATH_MIN_HOPID       8
337 /*
338  * Support paths from the farthest (depth 6) router to the host and back
339  * to the same level (not necessarily to the same router).
340  */
341 #define TB_PATH_MAX_HOPS        (7 * 2)
342
343 /* Possible wake types */
344 #define TB_WAKE_ON_CONNECT      BIT(0)
345 #define TB_WAKE_ON_DISCONNECT   BIT(1)
346 #define TB_WAKE_ON_USB4         BIT(2)
347 #define TB_WAKE_ON_USB3         BIT(3)
348 #define TB_WAKE_ON_PCIE         BIT(4)
349
350 /**
351  * struct tb_cm_ops - Connection manager specific operations vector
352  * @driver_ready: Called right after control channel is started. Used by
353  *                ICM to send driver ready message to the firmware.
354  * @start: Starts the domain
355  * @stop: Stops the domain
356  * @suspend_noirq: Connection manager specific suspend_noirq
357  * @resume_noirq: Connection manager specific resume_noirq
358  * @suspend: Connection manager specific suspend
359  * @freeze_noirq: Connection manager specific freeze_noirq
360  * @thaw_noirq: Connection manager specific thaw_noirq
361  * @complete: Connection manager specific complete
362  * @runtime_suspend: Connection manager specific runtime_suspend
363  * @runtime_resume: Connection manager specific runtime_resume
364  * @runtime_suspend_switch: Runtime suspend a switch
365  * @runtime_resume_switch: Runtime resume a switch
366  * @handle_event: Handle thunderbolt event
367  * @get_boot_acl: Get boot ACL list
368  * @set_boot_acl: Set boot ACL list
369  * @disapprove_switch: Disapprove switch (disconnect PCIe tunnel)
370  * @approve_switch: Approve switch
371  * @add_switch_key: Add key to switch
372  * @challenge_switch_key: Challenge switch using key
373  * @disconnect_pcie_paths: Disconnects PCIe paths before NVM update
374  * @approve_xdomain_paths: Approve (establish) XDomain DMA paths
375  * @disconnect_xdomain_paths: Disconnect XDomain DMA paths
376  * @usb4_switch_op: Optional proxy for USB4 router operations. If set
377  *                  this will be called whenever USB4 router operation is
378  *                  performed. If this returns %-EOPNOTSUPP then the
379  *                  native USB4 router operation is called.
380  * @usb4_switch_nvm_authenticate_status: Optional callback that the CM
381  *                                       implementation can be used to
382  *                                       return status of USB4 NVM_AUTH
383  *                                       router operation.
384  */
385 struct tb_cm_ops {
386         int (*driver_ready)(struct tb *tb);
387         int (*start)(struct tb *tb);
388         void (*stop)(struct tb *tb);
389         int (*suspend_noirq)(struct tb *tb);
390         int (*resume_noirq)(struct tb *tb);
391         int (*suspend)(struct tb *tb);
392         int (*freeze_noirq)(struct tb *tb);
393         int (*thaw_noirq)(struct tb *tb);
394         void (*complete)(struct tb *tb);
395         int (*runtime_suspend)(struct tb *tb);
396         int (*runtime_resume)(struct tb *tb);
397         int (*runtime_suspend_switch)(struct tb_switch *sw);
398         int (*runtime_resume_switch)(struct tb_switch *sw);
399         void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type,
400                              const void *buf, size_t size);
401         int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids);
402         int (*set_boot_acl)(struct tb *tb, const uuid_t *uuids, size_t nuuids);
403         int (*disapprove_switch)(struct tb *tb, struct tb_switch *sw);
404         int (*approve_switch)(struct tb *tb, struct tb_switch *sw);
405         int (*add_switch_key)(struct tb *tb, struct tb_switch *sw);
406         int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw,
407                                     const u8 *challenge, u8 *response);
408         int (*disconnect_pcie_paths)(struct tb *tb);
409         int (*approve_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd);
410         int (*disconnect_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd);
411         int (*usb4_switch_op)(struct tb_switch *sw, u16 opcode, u32 *metadata,
412                               u8 *status, const void *tx_data, size_t tx_data_len,
413                               void *rx_data, size_t rx_data_len);
414         int (*usb4_switch_nvm_authenticate_status)(struct tb_switch *sw,
415                                                    u32 *status);
416 };
417
418 static inline void *tb_priv(struct tb *tb)
419 {
420         return (void *)tb->privdata;
421 }
422
423 #define TB_AUTOSUSPEND_DELAY            15000 /* ms */
424
425 /* helper functions & macros */
426
427 /**
428  * tb_upstream_port() - return the upstream port of a switch
429  *
430  * Every switch has an upstream port (for the root switch it is the NHI).
431  *
432  * During switch alloc/init tb_upstream_port()->remote may be NULL, even for
433  * non root switches (on the NHI port remote is always NULL).
434  *
435  * Return: Returns the upstream port of the switch.
436  */
437 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw)
438 {
439         return &sw->ports[sw->config.upstream_port_number];
440 }
441
442 /**
443  * tb_is_upstream_port() - Is the port upstream facing
444  * @port: Port to check
445  *
446  * Returns true if @port is upstream facing port. In case of dual link
447  * ports both return true.
448  */
449 static inline bool tb_is_upstream_port(const struct tb_port *port)
450 {
451         const struct tb_port *upstream_port = tb_upstream_port(port->sw);
452         return port == upstream_port || port->dual_link_port == upstream_port;
453 }
454
455 static inline u64 tb_route(const struct tb_switch *sw)
456 {
457         return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo;
458 }
459
460 static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw)
461 {
462         u8 port;
463
464         port = route >> (sw->config.depth * 8);
465         if (WARN_ON(port > sw->config.max_port_number))
466                 return NULL;
467         return &sw->ports[port];
468 }
469
470 /**
471  * tb_port_has_remote() - Does the port have switch connected downstream
472  * @port: Port to check
473  *
474  * Returns true only when the port is primary port and has remote set.
475  */
476 static inline bool tb_port_has_remote(const struct tb_port *port)
477 {
478         if (tb_is_upstream_port(port))
479                 return false;
480         if (!port->remote)
481                 return false;
482         if (port->dual_link_port && port->link_nr)
483                 return false;
484
485         return true;
486 }
487
488 static inline bool tb_port_is_null(const struct tb_port *port)
489 {
490         return port && port->port && port->config.type == TB_TYPE_PORT;
491 }
492
493 static inline bool tb_port_is_nhi(const struct tb_port *port)
494 {
495         return port && port->config.type == TB_TYPE_NHI;
496 }
497
498 static inline bool tb_port_is_pcie_down(const struct tb_port *port)
499 {
500         return port && port->config.type == TB_TYPE_PCIE_DOWN;
501 }
502
503 static inline bool tb_port_is_pcie_up(const struct tb_port *port)
504 {
505         return port && port->config.type == TB_TYPE_PCIE_UP;
506 }
507
508 static inline bool tb_port_is_dpin(const struct tb_port *port)
509 {
510         return port && port->config.type == TB_TYPE_DP_HDMI_IN;
511 }
512
513 static inline bool tb_port_is_dpout(const struct tb_port *port)
514 {
515         return port && port->config.type == TB_TYPE_DP_HDMI_OUT;
516 }
517
518 static inline bool tb_port_is_usb3_down(const struct tb_port *port)
519 {
520         return port && port->config.type == TB_TYPE_USB3_DOWN;
521 }
522
523 static inline bool tb_port_is_usb3_up(const struct tb_port *port)
524 {
525         return port && port->config.type == TB_TYPE_USB3_UP;
526 }
527
528 static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
529                              enum tb_cfg_space space, u32 offset, u32 length)
530 {
531         if (sw->is_unplugged)
532                 return -ENODEV;
533         return tb_cfg_read(sw->tb->ctl,
534                            buffer,
535                            tb_route(sw),
536                            0,
537                            space,
538                            offset,
539                            length);
540 }
541
542 static inline int tb_sw_write(struct tb_switch *sw, const void *buffer,
543                               enum tb_cfg_space space, u32 offset, u32 length)
544 {
545         if (sw->is_unplugged)
546                 return -ENODEV;
547         return tb_cfg_write(sw->tb->ctl,
548                             buffer,
549                             tb_route(sw),
550                             0,
551                             space,
552                             offset,
553                             length);
554 }
555
556 static inline int tb_port_read(struct tb_port *port, void *buffer,
557                                enum tb_cfg_space space, u32 offset, u32 length)
558 {
559         if (port->sw->is_unplugged)
560                 return -ENODEV;
561         return tb_cfg_read(port->sw->tb->ctl,
562                            buffer,
563                            tb_route(port->sw),
564                            port->port,
565                            space,
566                            offset,
567                            length);
568 }
569
570 static inline int tb_port_write(struct tb_port *port, const void *buffer,
571                                 enum tb_cfg_space space, u32 offset, u32 length)
572 {
573         if (port->sw->is_unplugged)
574                 return -ENODEV;
575         return tb_cfg_write(port->sw->tb->ctl,
576                             buffer,
577                             tb_route(port->sw),
578                             port->port,
579                             space,
580                             offset,
581                             length);
582 }
583
584 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg)
585 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
586 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
587 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
588 #define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg)
589
590 #define __TB_SW_PRINT(level, sw, fmt, arg...)           \
591         do {                                            \
592                 const struct tb_switch *__sw = (sw);    \
593                 level(__sw->tb, "%llx: " fmt,           \
594                       tb_route(__sw), ## arg);          \
595         } while (0)
596 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
597 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
598 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
599 #define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg)
600
601 #define __TB_PORT_PRINT(level, _port, fmt, arg...)                      \
602         do {                                                            \
603                 const struct tb_port *__port = (_port);                 \
604                 level(__port->sw->tb, "%llx:%x: " fmt,                  \
605                       tb_route(__port->sw), __port->port, ## arg);      \
606         } while (0)
607 #define tb_port_WARN(port, fmt, arg...) \
608         __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg)
609 #define tb_port_warn(port, fmt, arg...) \
610         __TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
611 #define tb_port_info(port, fmt, arg...) \
612         __TB_PORT_PRINT(tb_info, port, fmt, ##arg)
613 #define tb_port_dbg(port, fmt, arg...) \
614         __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg)
615
616 struct tb *icm_probe(struct tb_nhi *nhi);
617 struct tb *tb_probe(struct tb_nhi *nhi);
618
619 extern struct device_type tb_domain_type;
620 extern struct device_type tb_retimer_type;
621 extern struct device_type tb_switch_type;
622
623 int tb_domain_init(void);
624 void tb_domain_exit(void);
625 int tb_xdomain_init(void);
626 void tb_xdomain_exit(void);
627
628 struct tb *tb_domain_alloc(struct tb_nhi *nhi, size_t privsize);
629 int tb_domain_add(struct tb *tb);
630 void tb_domain_remove(struct tb *tb);
631 int tb_domain_suspend_noirq(struct tb *tb);
632 int tb_domain_resume_noirq(struct tb *tb);
633 int tb_domain_suspend(struct tb *tb);
634 int tb_domain_freeze_noirq(struct tb *tb);
635 int tb_domain_thaw_noirq(struct tb *tb);
636 void tb_domain_complete(struct tb *tb);
637 int tb_domain_runtime_suspend(struct tb *tb);
638 int tb_domain_runtime_resume(struct tb *tb);
639 int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw);
640 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw);
641 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw);
642 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw);
643 int tb_domain_disconnect_pcie_paths(struct tb *tb);
644 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd);
645 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd);
646 int tb_domain_disconnect_all_paths(struct tb *tb);
647
648 static inline struct tb *tb_domain_get(struct tb *tb)
649 {
650         if (tb)
651                 get_device(&tb->dev);
652         return tb;
653 }
654
655 static inline void tb_domain_put(struct tb *tb)
656 {
657         put_device(&tb->dev);
658 }
659
660 struct tb_nvm *tb_nvm_alloc(struct device *dev);
661 int tb_nvm_add_active(struct tb_nvm *nvm, size_t size, nvmem_reg_read_t reg_read);
662 int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val,
663                      size_t bytes);
664 int tb_nvm_add_non_active(struct tb_nvm *nvm, size_t size,
665                           nvmem_reg_write_t reg_write);
666 void tb_nvm_free(struct tb_nvm *nvm);
667 void tb_nvm_exit(void);
668
669 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
670                                   u64 route);
671 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb,
672                         struct device *parent, u64 route);
673 int tb_switch_configure(struct tb_switch *sw);
674 int tb_switch_add(struct tb_switch *sw);
675 void tb_switch_remove(struct tb_switch *sw);
676 void tb_switch_suspend(struct tb_switch *sw, bool runtime);
677 int tb_switch_resume(struct tb_switch *sw);
678 int tb_switch_reset(struct tb_switch *sw);
679 void tb_sw_set_unplugged(struct tb_switch *sw);
680 struct tb_port *tb_switch_find_port(struct tb_switch *sw,
681                                     enum tb_port_type type);
682 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
683                                                u8 depth);
684 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
685 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route);
686
687 /**
688  * tb_switch_for_each_port() - Iterate over each switch port
689  * @sw: Switch whose ports to iterate
690  * @p: Port used as iterator
691  *
692  * Iterates over each switch port skipping the control port (port %0).
693  */
694 #define tb_switch_for_each_port(sw, p)                                  \
695         for ((p) = &(sw)->ports[1];                                     \
696              (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++)
697
698 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw)
699 {
700         if (sw)
701                 get_device(&sw->dev);
702         return sw;
703 }
704
705 static inline void tb_switch_put(struct tb_switch *sw)
706 {
707         put_device(&sw->dev);
708 }
709
710 static inline bool tb_is_switch(const struct device *dev)
711 {
712         return dev->type == &tb_switch_type;
713 }
714
715 static inline struct tb_switch *tb_to_switch(struct device *dev)
716 {
717         if (tb_is_switch(dev))
718                 return container_of(dev, struct tb_switch, dev);
719         return NULL;
720 }
721
722 static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw)
723 {
724         return tb_to_switch(sw->dev.parent);
725 }
726
727 static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw)
728 {
729         return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
730                sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE;
731 }
732
733 static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw)
734 {
735         return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
736                sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE;
737 }
738
739 static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw)
740 {
741         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
742                 switch (sw->config.device_id) {
743                 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
744                 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
745                         return true;
746                 }
747         }
748         return false;
749 }
750
751 static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw)
752 {
753         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
754                 switch (sw->config.device_id) {
755                 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
756                 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
757                         return true;
758                 }
759         }
760         return false;
761 }
762
763 static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw)
764 {
765         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
766                 switch (sw->config.device_id) {
767                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
768                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
769                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
770                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
771                         return true;
772                 }
773         }
774         return false;
775 }
776
777 static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw)
778 {
779         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
780                 switch (sw->config.device_id) {
781                 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
782                 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
783                 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
784                         return true;
785                 }
786         }
787         return false;
788 }
789
790 static inline bool tb_switch_is_ice_lake(const struct tb_switch *sw)
791 {
792         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
793                 switch (sw->config.device_id) {
794                 case PCI_DEVICE_ID_INTEL_ICL_NHI0:
795                 case PCI_DEVICE_ID_INTEL_ICL_NHI1:
796                         return true;
797                 }
798         }
799         return false;
800 }
801
802 static inline bool tb_switch_is_tiger_lake(const struct tb_switch *sw)
803 {
804         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
805                 switch (sw->config.device_id) {
806                 case PCI_DEVICE_ID_INTEL_TGL_NHI0:
807                 case PCI_DEVICE_ID_INTEL_TGL_NHI1:
808                 case PCI_DEVICE_ID_INTEL_TGL_H_NHI0:
809                 case PCI_DEVICE_ID_INTEL_TGL_H_NHI1:
810                         return true;
811                 }
812         }
813         return false;
814 }
815
816 /**
817  * tb_switch_is_usb4() - Is the switch USB4 compliant
818  * @sw: Switch to check
819  *
820  * Returns true if the @sw is USB4 compliant router, false otherwise.
821  */
822 static inline bool tb_switch_is_usb4(const struct tb_switch *sw)
823 {
824         return sw->config.thunderbolt_version == USB4_VERSION_1_0;
825 }
826
827 /**
828  * tb_switch_is_icm() - Is the switch handled by ICM firmware
829  * @sw: Switch to check
830  *
831  * In case there is a need to differentiate whether ICM firmware or SW CM
832  * is handling @sw this function can be called. It is valid to call this
833  * after tb_switch_alloc() and tb_switch_configure() has been called
834  * (latter only for SW CM case).
835  */
836 static inline bool tb_switch_is_icm(const struct tb_switch *sw)
837 {
838         return !sw->config.enabled;
839 }
840
841 int tb_switch_lane_bonding_enable(struct tb_switch *sw);
842 void tb_switch_lane_bonding_disable(struct tb_switch *sw);
843 int tb_switch_configure_link(struct tb_switch *sw);
844 void tb_switch_unconfigure_link(struct tb_switch *sw);
845
846 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
847 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
848 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
849
850 int tb_switch_tmu_init(struct tb_switch *sw);
851 int tb_switch_tmu_post_time(struct tb_switch *sw);
852 int tb_switch_tmu_disable(struct tb_switch *sw);
853 int tb_switch_tmu_enable(struct tb_switch *sw);
854
855 static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw)
856 {
857         return sw->tmu.rate == TB_SWITCH_TMU_RATE_HIFI &&
858                !sw->tmu.unidirectional;
859 }
860
861 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
862 int tb_port_add_nfc_credits(struct tb_port *port, int credits);
863 int tb_port_set_initial_credits(struct tb_port *port, u32 credits);
864 int tb_port_clear_counter(struct tb_port *port, int counter);
865 int tb_port_unlock(struct tb_port *port);
866 int tb_port_enable(struct tb_port *port);
867 int tb_port_disable(struct tb_port *port);
868 int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid);
869 void tb_port_release_in_hopid(struct tb_port *port, int hopid);
870 int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid);
871 void tb_port_release_out_hopid(struct tb_port *port, int hopid);
872 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
873                                      struct tb_port *prev);
874
875 /**
876  * tb_for_each_port_on_path() - Iterate over each port on path
877  * @src: Source port
878  * @dst: Destination port
879  * @p: Port used as iterator
880  *
881  * Walks over each port on path from @src to @dst.
882  */
883 #define tb_for_each_port_on_path(src, dst, p)                           \
884         for ((p) = tb_next_port_on_path((src), (dst), NULL); (p);       \
885              (p) = tb_next_port_on_path((src), (dst), (p)))
886
887 int tb_port_get_link_speed(struct tb_port *port);
888 int tb_port_get_link_width(struct tb_port *port);
889 int tb_port_state(struct tb_port *port);
890 int tb_port_lane_bonding_enable(struct tb_port *port);
891 void tb_port_lane_bonding_disable(struct tb_port *port);
892
893 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
894 int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap);
895 int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset);
896 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
897 int tb_port_next_cap(struct tb_port *port, unsigned int offset);
898 bool tb_port_is_enabled(struct tb_port *port);
899
900 bool tb_usb3_port_is_enabled(struct tb_port *port);
901 int tb_usb3_port_enable(struct tb_port *port, bool enable);
902
903 bool tb_pci_port_is_enabled(struct tb_port *port);
904 int tb_pci_port_enable(struct tb_port *port, bool enable);
905
906 int tb_dp_port_hpd_is_active(struct tb_port *port);
907 int tb_dp_port_hpd_clear(struct tb_port *port);
908 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
909                         unsigned int aux_tx, unsigned int aux_rx);
910 bool tb_dp_port_is_enabled(struct tb_port *port);
911 int tb_dp_port_enable(struct tb_port *port, bool enable);
912
913 struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid,
914                                  struct tb_port *dst, int dst_hopid,
915                                  struct tb_port **last, const char *name);
916 struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid,
917                               struct tb_port *dst, int dst_hopid, int link_nr,
918                               const char *name);
919 void tb_path_free(struct tb_path *path);
920 int tb_path_activate(struct tb_path *path);
921 void tb_path_deactivate(struct tb_path *path);
922 bool tb_path_is_invalid(struct tb_path *path);
923 bool tb_path_port_on_path(const struct tb_path *path,
924                           const struct tb_port *port);
925
926 int tb_drom_read(struct tb_switch *sw);
927 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
928
929 int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid);
930 int tb_lc_configure_port(struct tb_port *port);
931 void tb_lc_unconfigure_port(struct tb_port *port);
932 int tb_lc_configure_xdomain(struct tb_port *port);
933 void tb_lc_unconfigure_xdomain(struct tb_port *port);
934 int tb_lc_start_lane_initialization(struct tb_port *port);
935 int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags);
936 int tb_lc_set_sleep(struct tb_switch *sw);
937 bool tb_lc_lane_bonding_possible(struct tb_switch *sw);
938 bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in);
939 int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in);
940 int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in);
941 int tb_lc_force_power(struct tb_switch *sw);
942
943 static inline int tb_route_length(u64 route)
944 {
945         return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
946 }
947
948 /**
949  * tb_downstream_route() - get route to downstream switch
950  *
951  * Port must not be the upstream port (otherwise a loop is created).
952  *
953  * Return: Returns a route to the switch behind @port.
954  */
955 static inline u64 tb_downstream_route(struct tb_port *port)
956 {
957         return tb_route(port->sw)
958                | ((u64) port->port << (port->sw->config.depth * 8));
959 }
960
961 bool tb_is_xdomain_enabled(void);
962 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
963                                const void *buf, size_t size);
964 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
965                                     u64 route, const uuid_t *local_uuid,
966                                     const uuid_t *remote_uuid);
967 void tb_xdomain_add(struct tb_xdomain *xd);
968 void tb_xdomain_remove(struct tb_xdomain *xd);
969 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
970                                                  u8 depth);
971
972 int tb_retimer_scan(struct tb_port *port);
973 void tb_retimer_remove_all(struct tb_port *port);
974
975 static inline bool tb_is_retimer(const struct device *dev)
976 {
977         return dev->type == &tb_retimer_type;
978 }
979
980 static inline struct tb_retimer *tb_to_retimer(struct device *dev)
981 {
982         if (tb_is_retimer(dev))
983                 return container_of(dev, struct tb_retimer, dev);
984         return NULL;
985 }
986
987 int usb4_switch_setup(struct tb_switch *sw);
988 int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid);
989 int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf,
990                           size_t size);
991 bool usb4_switch_lane_bonding_possible(struct tb_switch *sw);
992 int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags);
993 int usb4_switch_set_sleep(struct tb_switch *sw);
994 int usb4_switch_nvm_sector_size(struct tb_switch *sw);
995 int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
996                          size_t size);
997 int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address,
998                           const void *buf, size_t size);
999 int usb4_switch_nvm_authenticate(struct tb_switch *sw);
1000 int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status);
1001 bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
1002 int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1003 int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1004 struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw,
1005                                           const struct tb_port *port);
1006 struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw,
1007                                           const struct tb_port *port);
1008
1009 int usb4_port_unlock(struct tb_port *port);
1010 int usb4_port_configure(struct tb_port *port);
1011 void usb4_port_unconfigure(struct tb_port *port);
1012 int usb4_port_configure_xdomain(struct tb_port *port);
1013 void usb4_port_unconfigure_xdomain(struct tb_port *port);
1014 int usb4_port_enumerate_retimers(struct tb_port *port);
1015
1016 int usb4_port_retimer_read(struct tb_port *port, u8 index, u8 reg, void *buf,
1017                            u8 size);
1018 int usb4_port_retimer_write(struct tb_port *port, u8 index, u8 reg,
1019                             const void *buf, u8 size);
1020 int usb4_port_retimer_is_last(struct tb_port *port, u8 index);
1021 int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index);
1022 int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index,
1023                                 unsigned int address, const void *buf,
1024                                 size_t size);
1025 int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index);
1026 int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index,
1027                                               u32 *status);
1028 int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index,
1029                                unsigned int address, void *buf, size_t size);
1030
1031 int usb4_usb3_port_max_link_rate(struct tb_port *port);
1032 int usb4_usb3_port_actual_link_rate(struct tb_port *port);
1033 int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw,
1034                                        int *downstream_bw);
1035 int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw,
1036                                       int *downstream_bw);
1037 int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw,
1038                                      int *downstream_bw);
1039
1040 /* Keep link controller awake during update */
1041 #define QUIRK_FORCE_POWER_LINK_CONTROLLER               BIT(0)
1042
1043 void tb_check_quirks(struct tb_switch *sw);
1044
1045 #ifdef CONFIG_ACPI
1046 void tb_acpi_add_links(struct tb_nhi *nhi);
1047
1048 bool tb_acpi_is_native(void);
1049 bool tb_acpi_may_tunnel_usb3(void);
1050 bool tb_acpi_may_tunnel_dp(void);
1051 bool tb_acpi_may_tunnel_pcie(void);
1052 bool tb_acpi_is_xdomain_allowed(void);
1053 #else
1054 static inline void tb_acpi_add_links(struct tb_nhi *nhi) { }
1055
1056 static inline bool tb_acpi_is_native(void) { return true; }
1057 static inline bool tb_acpi_may_tunnel_usb3(void) { return true; }
1058 static inline bool tb_acpi_may_tunnel_dp(void) { return true; }
1059 static inline bool tb_acpi_may_tunnel_pcie(void) { return true; }
1060 static inline bool tb_acpi_is_xdomain_allowed(void) { return true; }
1061 #endif
1062
1063 #ifdef CONFIG_DEBUG_FS
1064 void tb_debugfs_init(void);
1065 void tb_debugfs_exit(void);
1066 void tb_switch_debugfs_init(struct tb_switch *sw);
1067 void tb_switch_debugfs_remove(struct tb_switch *sw);
1068 void tb_service_debugfs_init(struct tb_service *svc);
1069 void tb_service_debugfs_remove(struct tb_service *svc);
1070 #else
1071 static inline void tb_debugfs_init(void) { }
1072 static inline void tb_debugfs_exit(void) { }
1073 static inline void tb_switch_debugfs_init(struct tb_switch *sw) { }
1074 static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { }
1075 static inline void tb_service_debugfs_init(struct tb_service *svc) { }
1076 static inline void tb_service_debugfs_remove(struct tb_service *svc) { }
1077 #endif
1078
1079 #ifdef CONFIG_USB4_KUNIT_TEST
1080 int tb_test_init(void);
1081 void tb_test_exit(void);
1082 #else
1083 static inline int tb_test_init(void) { return 0; }
1084 static inline void tb_test_exit(void) { }
1085 #endif
1086
1087 #endif