forked from ~ljy/RK356X_SDK_RELEASE

blame | history | patch | commit | commitdiff
hc
2024-05-16 8d2a02b24d66aa359e83eebc1ed3c0f85367a1cb 
 kernel/drivers/thunderbolt/tb.h
....@@ -1,8 +1,9 @@
11 /* SPDX-License-Identifier: GPL-2.0 */
22 /*
3
- * Thunderbolt Cactus Ridge driver - bus logic (NHI independent)
3
+ * Thunderbolt driver - bus logic (NHI independent)
44  *
55  * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
6
+ * Copyright (C) 2018, Intel Corporation
67  */
78 
89 #ifndef TB_H_
....@@ -17,8 +18,17 @@
1718 #include "ctl.h"
1819 #include "dma_port.h"
1920 
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
+
2029 /**
21
- * struct tb_switch_nvm - Structure holding switch NVM information
30
+ * struct tb_nvm - Structure holding NVM information
31
+ * @dev: Owner of the NVM
2232  * @major: Major version number of the active NVM portion
2333  * @minor: Minor version number of the active NVM portion
2434  * @id: Identifier used with both NVM portions
....@@ -28,9 +38,14 @@
2838  *	 the actual NVM flash device
2939  * @buf_data_size: Number of bytes actually consumed by the new NVM
3040  *		   image
31
- * @authenticating: The switch is authenticating the new NVM
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.
3246  */
33
-struct tb_switch_nvm {
47
+struct tb_nvm {
48
+	struct device *dev;
3449 	u8 major;
3550 	u8 minor;
3651 	int id;
....@@ -39,9 +54,44 @@
3954 	void *buf;
4055 	size_t buf_data_size;
4156 	bool authenticating;
57
+	bool flushed;
4258 };
4359 
4460 #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
+};
4595 
4696 /**
4797  * struct tb_switch - a thunderbolt switch
....@@ -52,6 +102,7 @@
52102  *	      mailbox this will hold the pointer to that (%NULL
53103  *	      otherwise). If set it also means the switch has
54104  *	      upgradeable NVM.
105
+ * @tmu: The switch TMU configuration
55106  * @tb: Pointer to the domain the switch belongs to
56107  * @uid: Unique ID of the switch
57108  * @uuid: UUID of the switch (or %NULL if not supported)
....@@ -59,8 +110,12 @@
59110  * @device: Device ID of the switch
60111  * @vendor_name: Name of the vendor (or %NULL if not known)
61112  * @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
62116  * @generation: Switch Thunderbolt generation
63117  * @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)
64119  * @is_unplugged: The switch is going away
65120  * @drom: DROM of the switch (%NULL if not found)
66121  * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
....@@ -69,14 +124,17 @@
69124  * @boot: Whether the switch was already authorized on boot or not
70125  * @rpm: The switch supports runtime PM
71126  * @authorized: Whether the switch is authorized by user or policy
72
- * @work: Work used to automatically authorize a switch
73127  * @security_level: Switch supported security level
128
+ * @debugfs_dir: Pointer to the debugfs structure
74129  * @key: Contains the key used to challenge the device or %NULL if not
75130  *	 supported. Size of the key is %TB_SWITCH_KEY_SIZE.
76131  * @connection_id: Connection ID used with ICM messaging
77132  * @connection_key: Connection key used with ICM messaging
78133  * @link: Root switch link this switch is connected (ICM only)
79134  * @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
80138  *
81139  * When the switch is being added or removed to the domain (other
82140  * switches) you need to have domain lock held.
....@@ -86,6 +144,7 @@
86144 	struct tb_regs_switch_header config;
87145 	struct tb_port *ports;
88146 	struct tb_dma_port *dma_port;
147
+	struct tb_switch_tmu tmu;
89148 	struct tb *tb;
90149 	u64 uid;
91150 	uuid_t *uuid;
....@@ -93,23 +152,29 @@
93152 	u16 device;
94153 	const char *vendor_name;
95154 	const char *device_name;
155
+	unsigned int link_speed;
156
+	unsigned int link_width;
157
+	bool link_usb4;
96158 	unsigned int generation;
97159 	int cap_plug_events;
160
+	int cap_lc;
98161 	bool is_unplugged;
99162 	u8 *drom;
100
-	struct tb_switch_nvm *nvm;
163
+	struct tb_nvm *nvm;
101164 	bool no_nvm_upgrade;
102165 	bool safe_mode;
103166 	bool boot;
104167 	bool rpm;
105168 	unsigned int authorized;
106
-	struct work_struct work;
107169 	enum tb_security_level security_level;
170
+	struct dentry *debugfs_dir;
108171 	u8 *key;
109172 	u8 connection_id;
110173 	u8 connection_key;
111174 	u8 link;
112175 	u8 depth;
176
+	struct completion rpm_complete;
177
+	unsigned long quirks;
113178 };
114179 
115180 /**
....@@ -119,11 +184,18 @@
119184  * @remote: Remote port (%NULL if not connected)
120185  * @xdomain: Remote host (%NULL if not connected)
121186  * @cap_phy: Offset, zero if not found
187
+ * @cap_tmu: Offset of the adapter specific TMU capability (%0 if not present)
188
+ * @cap_adap: Offset of the adapter specific capability (%0 if not present)
189
+ * @cap_usb4: Offset to the USB4 port capability (%0 if not present)
122190  * @port: Port number on switch
123
- * @disabled: Disabled by eeprom
191
+ * @disabled: Disabled by eeprom or enabled but not implemented
192
+ * @bonded: true if the port is bonded (two lanes combined as one)
124193  * @dual_link_port: If the switch is connected using two ports, points
125194  *		    to the other port.
126195  * @link_nr: Is this primary or secondary port on the dual_link.
196
+ * @in_hopids: Currently allocated input HopIDs
197
+ * @out_hopids: Currently allocated output HopIDs
198
+ * @list: Used to link ports to DP resources list
127199  */
128200 struct tb_port {
129201 	struct tb_regs_port_header config;
....@@ -131,19 +203,61 @@
131203 	struct tb_port *remote;
132204 	struct tb_xdomain *xdomain;
133205 	int cap_phy;
206
+	int cap_tmu;
207
+	int cap_adap;
208
+	int cap_usb4;
134209 	u8 port;
135210 	bool disabled;
211
+	bool bonded;
136212 	struct tb_port *dual_link_port;
137213 	u8 link_nr:1;
214
+	struct ida in_hopids;
215
+	struct ida out_hopids;
216
+	struct list_head list;
217
+};
218
+
219
+/**
220
+ * tb_retimer: Thunderbolt retimer
221
+ * @dev: Device for the retimer
222
+ * @tb: Pointer to the domain the retimer belongs to
223
+ * @index: Retimer index facing the router USB4 port
224
+ * @vendor: Vendor ID of the retimer
225
+ * @device: Device ID of the retimer
226
+ * @port: Pointer to the lane 0 adapter
227
+ * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise)
228
+ * @auth_status: Status of last NVM authentication
229
+ */
230
+struct tb_retimer {
231
+	struct device dev;
232
+	struct tb *tb;
233
+	u8 index;
234
+	u32 vendor;
235
+	u32 device;
236
+	struct tb_port *port;
237
+	struct tb_nvm *nvm;
238
+	u32 auth_status;
138239 };
139240 
140241 /**
141242  * struct tb_path_hop - routing information for a tb_path
243
+ * @in_port: Ingress port of a switch
244
+ * @out_port: Egress port of a switch where the packet is routed out
245
+ *	      (must be on the same switch than @in_port)
246
+ * @in_hop_index: HopID where the path configuration entry is placed in
247
+ *		  the path config space of @in_port.
248
+ * @in_counter_index: Used counter index (not used in the driver
249
+ *		      currently, %-1 to disable)
250
+ * @next_hop_index: HopID of the packet when it is routed out from @out_port
251
+ * @initial_credits: Number of initial flow control credits allocated for
252
+ *		     the path
142253  *
143254  * Hop configuration is always done on the IN port of a switch.
144255  * in_port and out_port have to be on the same switch. Packets arriving on
145256  * in_port with "hop" = in_hop_index will get routed to through out_port. The
146
- * next hop to take (on out_port->remote) is determined by next_hop_index.
257
+ * next hop to take (on out_port->remote) is determined by
258
+ * next_hop_index. When routing packet to another switch (out->remote is
259
+ * set) the @next_hop_index must match the @in_hop_index of that next
260
+ * hop to make routing possible.
147261  *
148262  * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
149263  * port.
....@@ -152,43 +266,81 @@
152266 	struct tb_port *in_port;
153267 	struct tb_port *out_port;
154268 	int in_hop_index;
155
-	int in_counter_index; /* write -1 to disable counters for this hop. */
269
+	int in_counter_index;
156270 	int next_hop_index;
271
+	unsigned int initial_credits;
157272 };
158273 
159274 /**
160275  * enum tb_path_port - path options mask
276
+ * @TB_PATH_NONE: Do not activate on any hop on path
277
+ * @TB_PATH_SOURCE: Activate on the first hop (out of src)
278
+ * @TB_PATH_INTERNAL: Activate on the intermediate hops (not the first/last)
279
+ * @TB_PATH_DESTINATION: Activate on the last hop (into dst)
280
+ * @TB_PATH_ALL: Activate on all hops on the path
161281  */
162282 enum tb_path_port {
163283 	TB_PATH_NONE = 0,
164
-	TB_PATH_SOURCE = 1, /* activate on the first hop (out of src) */
165
-	TB_PATH_INTERNAL = 2, /* activate on other hops (not the first/last) */
166
-	TB_PATH_DESTINATION = 4, /* activate on the last hop (into dst) */
284
+	TB_PATH_SOURCE = 1,
285
+	TB_PATH_INTERNAL = 2,
286
+	TB_PATH_DESTINATION = 4,
167287 	TB_PATH_ALL = 7,
168288 };
169289 
170290 /**
171291  * struct tb_path - a unidirectional path between two ports
292
+ * @tb: Pointer to the domain structure
293
+ * @name: Name of the path (used for debugging)
294
+ * @nfc_credits: Number of non flow controlled credits allocated for the path
295
+ * @ingress_shared_buffer: Shared buffering used for ingress ports on the path
296
+ * @egress_shared_buffer: Shared buffering used for egress ports on the path
297
+ * @ingress_fc_enable: Flow control for ingress ports on the path
298
+ * @egress_fc_enable: Flow control for egress ports on the path
299
+ * @priority: Priority group if the path
300
+ * @weight: Weight of the path inside the priority group
301
+ * @drop_packages: Drop packages from queue tail or head
302
+ * @activated: Is the path active
303
+ * @clear_fc: Clear all flow control from the path config space entries
304
+ *	      when deactivating this path
305
+ * @hops: Path hops
306
+ * @path_length: How many hops the path uses
172307  *
173
- * A path consists of a number of hops (see tb_path_hop). To establish a PCIe
174
- * tunnel two paths have to be created between the two PCIe ports.
175
- *
308
+ * A path consists of a number of hops (see &struct tb_path_hop). To
309
+ * establish a PCIe tunnel two paths have to be created between the two
310
+ * PCIe ports.
176311  */
177312 struct tb_path {
178313 	struct tb *tb;
179
-	int nfc_credits; /* non flow controlled credits */
314
+	const char *name;
315
+	int nfc_credits;
180316 	enum tb_path_port ingress_shared_buffer;
181317 	enum tb_path_port egress_shared_buffer;
182318 	enum tb_path_port ingress_fc_enable;
183319 	enum tb_path_port egress_fc_enable;
184320 
185
-	int priority:3;
321
+	unsigned int priority:3;
186322 	int weight:4;
187323 	bool drop_packages;
188324 	bool activated;
325
+	bool clear_fc;
189326 	struct tb_path_hop *hops;
190
-	int path_length; /* number of hops */
327
+	int path_length;
191328 };
329
+
330
+/* HopIDs 0-7 are reserved by the Thunderbolt protocol */
331
+#define TB_PATH_MIN_HOPID	8
332
+/*
333
+ * Support paths from the farthest (depth 6) router to the host and back
334
+ * to the same level (not necessarily to the same router).
335
+ */
336
+#define TB_PATH_MAX_HOPS	(7 * 2)
337
+
338
+/* Possible wake types */
339
+#define TB_WAKE_ON_CONNECT	BIT(0)
340
+#define TB_WAKE_ON_DISCONNECT	BIT(1)
341
+#define TB_WAKE_ON_USB4		BIT(2)
342
+#define TB_WAKE_ON_USB3		BIT(3)
343
+#define TB_WAKE_ON_PCIE		BIT(4)
192344 
193345 /**
194346  * struct tb_cm_ops - Connection manager specific operations vector
....@@ -199,9 +351,13 @@
199351  * @suspend_noirq: Connection manager specific suspend_noirq
200352  * @resume_noirq: Connection manager specific resume_noirq
201353  * @suspend: Connection manager specific suspend
354
+ * @freeze_noirq: Connection manager specific freeze_noirq
355
+ * @thaw_noirq: Connection manager specific thaw_noirq
202356  * @complete: Connection manager specific complete
203357  * @runtime_suspend: Connection manager specific runtime_suspend
204358  * @runtime_resume: Connection manager specific runtime_resume
359
+ * @runtime_suspend_switch: Runtime suspend a switch
360
+ * @runtime_resume_switch: Runtime resume a switch
205361  * @handle_event: Handle thunderbolt event
206362  * @get_boot_acl: Get boot ACL list
207363  * @set_boot_acl: Set boot ACL list
....@@ -219,9 +375,13 @@
219375 	int (*suspend_noirq)(struct tb *tb);
220376 	int (*resume_noirq)(struct tb *tb);
221377 	int (*suspend)(struct tb *tb);
378
+	int (*freeze_noirq)(struct tb *tb);
379
+	int (*thaw_noirq)(struct tb *tb);
222380 	void (*complete)(struct tb *tb);
223381 	int (*runtime_suspend)(struct tb *tb);
224382 	int (*runtime_resume)(struct tb *tb);
383
+	int (*runtime_suspend_switch)(struct tb_switch *sw);
384
+	int (*runtime_resume_switch)(struct tb_switch *sw);
225385 	void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type,
226386 			     const void *buf, size_t size);
227387 	int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids);
....@@ -259,7 +419,20 @@
259419 	return &sw->ports[sw->config.upstream_port_number];
260420 }
261421 
262
-static inline u64 tb_route(struct tb_switch *sw)
422
+/**
423
+ * tb_is_upstream_port() - Is the port upstream facing
424
+ * @port: Port to check
425
+ *
426
+ * Returns true if @port is upstream facing port. In case of dual link
427
+ * ports both return true.
428
+ */
429
+static inline bool tb_is_upstream_port(const struct tb_port *port)
430
+{
431
+	const struct tb_port *upstream_port = tb_upstream_port(port->sw);
432
+	return port == upstream_port || port->dual_link_port == upstream_port;
433
+}
434
+
435
+static inline u64 tb_route(const struct tb_switch *sw)
263436 {
264437 	return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo;
265438 }
....@@ -274,9 +447,69 @@
274447 	return &sw->ports[port];
275448 }
276449 
450
+/**
451
+ * tb_port_has_remote() - Does the port have switch connected downstream
452
+ * @port: Port to check
453
+ *
454
+ * Returns true only when the port is primary port and has remote set.
455
+ */
456
+static inline bool tb_port_has_remote(const struct tb_port *port)
457
+{
458
+	if (tb_is_upstream_port(port))
459
+		return false;
460
+	if (!port->remote)
461
+		return false;
462
+	if (port->dual_link_port && port->link_nr)
463
+		return false;
464
+
465
+	return true;
466
+}
467
+
468
+static inline bool tb_port_is_null(const struct tb_port *port)
469
+{
470
+	return port && port->port && port->config.type == TB_TYPE_PORT;
471
+}
472
+
473
+static inline bool tb_port_is_nhi(const struct tb_port *port)
474
+{
475
+	return port && port->config.type == TB_TYPE_NHI;
476
+}
477
+
478
+static inline bool tb_port_is_pcie_down(const struct tb_port *port)
479
+{
480
+	return port && port->config.type == TB_TYPE_PCIE_DOWN;
481
+}
482
+
483
+static inline bool tb_port_is_pcie_up(const struct tb_port *port)
484
+{
485
+	return port && port->config.type == TB_TYPE_PCIE_UP;
486
+}
487
+
488
+static inline bool tb_port_is_dpin(const struct tb_port *port)
489
+{
490
+	return port && port->config.type == TB_TYPE_DP_HDMI_IN;
491
+}
492
+
493
+static inline bool tb_port_is_dpout(const struct tb_port *port)
494
+{
495
+	return port && port->config.type == TB_TYPE_DP_HDMI_OUT;
496
+}
497
+
498
+static inline bool tb_port_is_usb3_down(const struct tb_port *port)
499
+{
500
+	return port && port->config.type == TB_TYPE_USB3_DOWN;
501
+}
502
+
503
+static inline bool tb_port_is_usb3_up(const struct tb_port *port)
504
+{
505
+	return port && port->config.type == TB_TYPE_USB3_UP;
506
+}
507
+
277508 static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
278509 			     enum tb_cfg_space space, u32 offset, u32 length)
279510 {
511
+	if (sw->is_unplugged)
512
+		return -ENODEV;
280513 	return tb_cfg_read(sw->tb->ctl,
281514 			   buffer,
282515 			   tb_route(sw),
....@@ -286,9 +519,11 @@
286519 			   length);
287520 }
288521 
289
-static inline int tb_sw_write(struct tb_switch *sw, void *buffer,
522
+static inline int tb_sw_write(struct tb_switch *sw, const void *buffer,
290523 			      enum tb_cfg_space space, u32 offset, u32 length)
291524 {
525
+	if (sw->is_unplugged)
526
+		return -ENODEV;
292527 	return tb_cfg_write(sw->tb->ctl,
293528 			    buffer,
294529 			    tb_route(sw),
....@@ -301,6 +536,8 @@
301536 static inline int tb_port_read(struct tb_port *port, void *buffer,
302537 			       enum tb_cfg_space space, u32 offset, u32 length)
303538 {
539
+	if (port->sw->is_unplugged)
540
+		return -ENODEV;
304541 	return tb_cfg_read(port->sw->tb->ctl,
305542 			   buffer,
306543 			   tb_route(port->sw),
....@@ -313,6 +550,8 @@
313550 static inline int tb_port_write(struct tb_port *port, const void *buffer,
314551 				enum tb_cfg_space space, u32 offset, u32 length)
315552 {
553
+	if (port->sw->is_unplugged)
554
+		return -ENODEV;
316555 	return tb_cfg_write(port->sw->tb->ctl,
317556 			    buffer,
318557 			    tb_route(port->sw),
....@@ -326,22 +565,22 @@
326565 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
327566 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
328567 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
329
-
568
+#define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg)
330569 
331570 #define __TB_SW_PRINT(level, sw, fmt, arg...)           \
332571 	do {                                            \
333
-		struct tb_switch *__sw = (sw);          \
572
+		const struct tb_switch *__sw = (sw);    \
334573 		level(__sw->tb, "%llx: " fmt,           \
335574 		      tb_route(__sw), ## arg);          \
336575 	} while (0)
337576 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
338577 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
339578 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
340
-
579
+#define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg)
341580 
342581 #define __TB_PORT_PRINT(level, _port, fmt, arg...)                      \
343582 	do {                                                            \
344
-		struct tb_port *__port = (_port);                       \
583
+		const struct tb_port *__port = (_port);                 \
345584 		level(__port->sw->tb, "%llx:%x: " fmt,                  \
346585 		      tb_route(__port->sw), __port->port, ## arg);      \
347586 	} while (0)
....@@ -351,16 +590,18 @@
351590 	__TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
352591 #define tb_port_info(port, fmt, arg...) \
353592 	__TB_PORT_PRINT(tb_info, port, fmt, ##arg)
593
+#define tb_port_dbg(port, fmt, arg...) \
594
+	__TB_PORT_PRINT(tb_dbg, port, fmt, ##arg)
354595 
355596 struct tb *icm_probe(struct tb_nhi *nhi);
356597 struct tb *tb_probe(struct tb_nhi *nhi);
357598 
358599 extern struct device_type tb_domain_type;
600
+extern struct device_type tb_retimer_type;
359601 extern struct device_type tb_switch_type;
360602 
361603 int tb_domain_init(void);
362604 void tb_domain_exit(void);
363
-void tb_switch_exit(void);
364605 int tb_xdomain_init(void);
365606 void tb_xdomain_exit(void);
366607 
....@@ -370,6 +611,8 @@
370611 int tb_domain_suspend_noirq(struct tb *tb);
371612 int tb_domain_resume_noirq(struct tb *tb);
372613 int tb_domain_suspend(struct tb *tb);
614
+int tb_domain_freeze_noirq(struct tb *tb);
615
+int tb_domain_thaw_noirq(struct tb *tb);
373616 void tb_domain_complete(struct tb *tb);
374617 int tb_domain_runtime_suspend(struct tb *tb);
375618 int tb_domain_runtime_resume(struct tb *tb);
....@@ -381,10 +624,26 @@
381624 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd);
382625 int tb_domain_disconnect_all_paths(struct tb *tb);
383626 
627
+static inline struct tb *tb_domain_get(struct tb *tb)
628
+{
629
+	if (tb)
630
+		get_device(&tb->dev);
631
+	return tb;
632
+}
633
+
384634 static inline void tb_domain_put(struct tb *tb)
385635 {
386636 	put_device(&tb->dev);
387637 }
638
+
639
+struct tb_nvm *tb_nvm_alloc(struct device *dev);
640
+int tb_nvm_add_active(struct tb_nvm *nvm, size_t size, nvmem_reg_read_t reg_read);
641
+int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val,
642
+		     size_t bytes);
643
+int tb_nvm_add_non_active(struct tb_nvm *nvm, size_t size,
644
+			  nvmem_reg_write_t reg_write);
645
+void tb_nvm_free(struct tb_nvm *nvm);
646
+void tb_nvm_exit(void);
388647 
389648 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
390649 				  u64 route);
....@@ -393,14 +652,27 @@
393652 int tb_switch_configure(struct tb_switch *sw);
394653 int tb_switch_add(struct tb_switch *sw);
395654 void tb_switch_remove(struct tb_switch *sw);
396
-void tb_switch_suspend(struct tb_switch *sw);
655
+void tb_switch_suspend(struct tb_switch *sw, bool runtime);
397656 int tb_switch_resume(struct tb_switch *sw);
398
-int tb_switch_reset(struct tb *tb, u64 route);
657
+int tb_switch_reset(struct tb_switch *sw);
399658 void tb_sw_set_unplugged(struct tb_switch *sw);
659
+struct tb_port *tb_switch_find_port(struct tb_switch *sw,
660
+				    enum tb_port_type type);
400661 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
401662 					       u8 depth);
402663 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
403664 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route);
665
+
666
+/**
667
+ * tb_switch_for_each_port() - Iterate over each switch port
668
+ * @sw: Switch whose ports to iterate
669
+ * @p: Port used as iterator
670
+ *
671
+ * Iterates over each switch port skipping the control port (port %0).
672
+ */
673
+#define tb_switch_for_each_port(sw, p)					\
674
+	for ((p) = &(sw)->ports[1];					\
675
+	     (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++)
404676 
405677 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw)
406678 {
....@@ -426,31 +698,225 @@
426698 	return NULL;
427699 }
428700 
701
+static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw)
702
+{
703
+	return tb_to_switch(sw->dev.parent);
704
+}
705
+
706
+static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw)
707
+{
708
+	return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
709
+	       sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE;
710
+}
711
+
712
+static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw)
713
+{
714
+	return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
715
+	       sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE;
716
+}
717
+
718
+static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw)
719
+{
720
+	if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
721
+		switch (sw->config.device_id) {
722
+		case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
723
+		case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
724
+			return true;
725
+		}
726
+	}
727
+	return false;
728
+}
729
+
730
+static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw)
731
+{
732
+	if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
733
+		switch (sw->config.device_id) {
734
+		case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
735
+		case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
736
+			return true;
737
+		}
738
+	}
739
+	return false;
740
+}
741
+
742
+static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw)
743
+{
744
+	if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
745
+		switch (sw->config.device_id) {
746
+		case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
747
+		case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
748
+		case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
749
+		case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
750
+			return true;
751
+		}
752
+	}
753
+	return false;
754
+}
755
+
756
+static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw)
757
+{
758
+	if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
759
+		switch (sw->config.device_id) {
760
+		case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
761
+		case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
762
+		case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
763
+			return true;
764
+		}
765
+	}
766
+	return false;
767
+}
768
+
769
+static inline bool tb_switch_is_ice_lake(const struct tb_switch *sw)
770
+{
771
+	if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
772
+		switch (sw->config.device_id) {
773
+		case PCI_DEVICE_ID_INTEL_ICL_NHI0:
774
+		case PCI_DEVICE_ID_INTEL_ICL_NHI1:
775
+			return true;
776
+		}
777
+	}
778
+	return false;
779
+}
780
+
781
+static inline bool tb_switch_is_tiger_lake(const struct tb_switch *sw)
782
+{
783
+	if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
784
+		switch (sw->config.device_id) {
785
+		case PCI_DEVICE_ID_INTEL_TGL_NHI0:
786
+		case PCI_DEVICE_ID_INTEL_TGL_NHI1:
787
+		case PCI_DEVICE_ID_INTEL_TGL_H_NHI0:
788
+		case PCI_DEVICE_ID_INTEL_TGL_H_NHI1:
789
+			return true;
790
+		}
791
+	}
792
+	return false;
793
+}
794
+
795
+/**
796
+ * tb_switch_is_usb4() - Is the switch USB4 compliant
797
+ * @sw: Switch to check
798
+ *
799
+ * Returns true if the @sw is USB4 compliant router, false otherwise.
800
+ */
801
+static inline bool tb_switch_is_usb4(const struct tb_switch *sw)
802
+{
803
+	return sw->config.thunderbolt_version == USB4_VERSION_1_0;
804
+}
805
+
806
+/**
807
+ * tb_switch_is_icm() - Is the switch handled by ICM firmware
808
+ * @sw: Switch to check
809
+ *
810
+ * In case there is a need to differentiate whether ICM firmware or SW CM
811
+ * is handling @sw this function can be called. It is valid to call this
812
+ * after tb_switch_alloc() and tb_switch_configure() has been called
813
+ * (latter only for SW CM case).
814
+ */
815
+static inline bool tb_switch_is_icm(const struct tb_switch *sw)
816
+{
817
+	return !sw->config.enabled;
818
+}
819
+
820
+int tb_switch_lane_bonding_enable(struct tb_switch *sw);
821
+void tb_switch_lane_bonding_disable(struct tb_switch *sw);
822
+int tb_switch_configure_link(struct tb_switch *sw);
823
+void tb_switch_unconfigure_link(struct tb_switch *sw);
824
+
825
+bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
826
+int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
827
+void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
828
+
829
+int tb_switch_tmu_init(struct tb_switch *sw);
830
+int tb_switch_tmu_post_time(struct tb_switch *sw);
831
+int tb_switch_tmu_disable(struct tb_switch *sw);
832
+int tb_switch_tmu_enable(struct tb_switch *sw);
833
+
834
+static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw)
835
+{
836
+	return sw->tmu.rate == TB_SWITCH_TMU_RATE_HIFI &&
837
+	       !sw->tmu.unidirectional;
838
+}
839
+
429840 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
430841 int tb_port_add_nfc_credits(struct tb_port *port, int credits);
842
+int tb_port_set_initial_credits(struct tb_port *port, u32 credits);
431843 int tb_port_clear_counter(struct tb_port *port, int counter);
844
+int tb_port_unlock(struct tb_port *port);
845
+int tb_port_enable(struct tb_port *port);
846
+int tb_port_disable(struct tb_port *port);
847
+int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid);
848
+void tb_port_release_in_hopid(struct tb_port *port, int hopid);
849
+int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid);
850
+void tb_port_release_out_hopid(struct tb_port *port, int hopid);
851
+struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
852
+				     struct tb_port *prev);
853
+
854
+/**
855
+ * tb_for_each_port_on_path() - Iterate over each port on path
856
+ * @src: Source port
857
+ * @dst: Destination port
858
+ * @p: Port used as iterator
859
+ *
860
+ * Walks over each port on path from @src to @dst.
861
+ */
862
+#define tb_for_each_port_on_path(src, dst, p)				\
863
+	for ((p) = tb_next_port_on_path((src), (dst), NULL); (p);	\
864
+	     (p) = tb_next_port_on_path((src), (dst), (p)))
865
+
866
+int tb_port_get_link_speed(struct tb_port *port);
432867 
433868 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
869
+int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap);
870
+int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset);
434871 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
872
+int tb_port_next_cap(struct tb_port *port, unsigned int offset);
873
+bool tb_port_is_enabled(struct tb_port *port);
435874 
436
-struct tb_path *tb_path_alloc(struct tb *tb, int num_hops);
875
+bool tb_usb3_port_is_enabled(struct tb_port *port);
876
+int tb_usb3_port_enable(struct tb_port *port, bool enable);
877
+
878
+bool tb_pci_port_is_enabled(struct tb_port *port);
879
+int tb_pci_port_enable(struct tb_port *port, bool enable);
880
+
881
+int tb_dp_port_hpd_is_active(struct tb_port *port);
882
+int tb_dp_port_hpd_clear(struct tb_port *port);
883
+int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
884
+			unsigned int aux_tx, unsigned int aux_rx);
885
+bool tb_dp_port_is_enabled(struct tb_port *port);
886
+int tb_dp_port_enable(struct tb_port *port, bool enable);
887
+
888
+struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid,
889
+				 struct tb_port *dst, int dst_hopid,
890
+				 struct tb_port **last, const char *name);
891
+struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid,
892
+			      struct tb_port *dst, int dst_hopid, int link_nr,
893
+			      const char *name);
437894 void tb_path_free(struct tb_path *path);
438895 int tb_path_activate(struct tb_path *path);
439896 void tb_path_deactivate(struct tb_path *path);
440897 bool tb_path_is_invalid(struct tb_path *path);
898
+bool tb_path_port_on_path(const struct tb_path *path,
899
+			  const struct tb_port *port);
441900 
442901 int tb_drom_read(struct tb_switch *sw);
443902 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
444903 
904
+int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid);
905
+int tb_lc_configure_port(struct tb_port *port);
906
+void tb_lc_unconfigure_port(struct tb_port *port);
907
+int tb_lc_configure_xdomain(struct tb_port *port);
908
+void tb_lc_unconfigure_xdomain(struct tb_port *port);
909
+int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags);
910
+int tb_lc_set_sleep(struct tb_switch *sw);
911
+bool tb_lc_lane_bonding_possible(struct tb_switch *sw);
912
+bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in);
913
+int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in);
914
+int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in);
915
+int tb_lc_force_power(struct tb_switch *sw);
445916 
446917 static inline int tb_route_length(u64 route)
447918 {
448919 	return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
449
-}
450
-
451
-static inline bool tb_is_upstream_port(struct tb_port *port)
452
-{
453
-	return port == tb_upstream_port(port->sw);
454920 }
455921 
456922 /**
....@@ -476,4 +942,103 @@
476942 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
477943 						 u8 depth);
478944 
945
+int tb_retimer_scan(struct tb_port *port);
946
+void tb_retimer_remove_all(struct tb_port *port);
947
+
948
+static inline bool tb_is_retimer(const struct device *dev)
949
+{
950
+	return dev->type == &tb_retimer_type;
951
+}
952
+
953
+static inline struct tb_retimer *tb_to_retimer(struct device *dev)
954
+{
955
+	if (tb_is_retimer(dev))
956
+		return container_of(dev, struct tb_retimer, dev);
957
+	return NULL;
958
+}
959
+
960
+int usb4_switch_setup(struct tb_switch *sw);
961
+int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid);
962
+int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf,
963
+			  size_t size);
964
+bool usb4_switch_lane_bonding_possible(struct tb_switch *sw);
965
+int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags);
966
+int usb4_switch_set_sleep(struct tb_switch *sw);
967
+int usb4_switch_nvm_sector_size(struct tb_switch *sw);
968
+int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
969
+			 size_t size);
970
+int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address,
971
+			  const void *buf, size_t size);
972
+int usb4_switch_nvm_authenticate(struct tb_switch *sw);
973
+bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
974
+int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
975
+int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
976
+struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw,
977
+					  const struct tb_port *port);
978
+struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw,
979
+					  const struct tb_port *port);
980
+
981
+int usb4_port_unlock(struct tb_port *port);
982
+int usb4_port_hotplug_enable(struct tb_port *port);
983
+int usb4_port_configure(struct tb_port *port);
984
+void usb4_port_unconfigure(struct tb_port *port);
985
+int usb4_port_configure_xdomain(struct tb_port *port);
986
+void usb4_port_unconfigure_xdomain(struct tb_port *port);
987
+int usb4_port_enumerate_retimers(struct tb_port *port);
988
+
989
+int usb4_port_retimer_read(struct tb_port *port, u8 index, u8 reg, void *buf,
990
+			   u8 size);
991
+int usb4_port_retimer_write(struct tb_port *port, u8 index, u8 reg,
992
+			    const void *buf, u8 size);
993
+int usb4_port_retimer_is_last(struct tb_port *port, u8 index);
994
+int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index);
995
+int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index,
996
+				unsigned int address, const void *buf,
997
+				size_t size);
998
+int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index);
999
+int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index,
1000
+					      u32 *status);
1001
+int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index,
1002
+			       unsigned int address, void *buf, size_t size);
1003
+
1004
+int usb4_usb3_port_max_link_rate(struct tb_port *port);
1005
+int usb4_usb3_port_actual_link_rate(struct tb_port *port);
1006
+int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw,
1007
+				       int *downstream_bw);
1008
+int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw,
1009
+				      int *downstream_bw);
1010
+int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw,
1011
+				     int *downstream_bw);
1012
+
1013
+/* Keep link controller awake during update */
1014
+#define QUIRK_FORCE_POWER_LINK_CONTROLLER		BIT(0)
1015
+
1016
+void tb_check_quirks(struct tb_switch *sw);
1017
+
1018
+#ifdef CONFIG_ACPI
1019
+void tb_acpi_add_links(struct tb_nhi *nhi);
1020
+#else
1021
+static inline void tb_acpi_add_links(struct tb_nhi *nhi) { }
1022
+#endif
1023
+
1024
+#ifdef CONFIG_DEBUG_FS
1025
+void tb_debugfs_init(void);
1026
+void tb_debugfs_exit(void);
1027
+void tb_switch_debugfs_init(struct tb_switch *sw);
1028
+void tb_switch_debugfs_remove(struct tb_switch *sw);
1029
+#else
1030
+static inline void tb_debugfs_init(void) { }
1031
+static inline void tb_debugfs_exit(void) { }
1032
+static inline void tb_switch_debugfs_init(struct tb_switch *sw) { }
1033
+static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { }
1034
+#endif
1035
+
1036
+#ifdef CONFIG_USB4_KUNIT_TEST
1037
+int tb_test_init(void);
1038
+void tb_test_exit(void);
1039
+#else
1040
+static inline int tb_test_init(void) { return 0; }
1041
+static inline void tb_test_exit(void) { }
1042
+#endif
1043
+
4791044 #endif