1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Thunderbolt driver - bus logic (NHI independent)
5 * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
6 * Copyright (C) 2018, Intel Corporation
12 #include <linux/nvmem-provider.h>
13 #include <linux/pci.h>
14 #include <linux/thunderbolt.h>
15 #include <linux/uuid.h>
21 #define NVM_MIN_SIZE SZ_32K
22 #define NVM_MAX_SIZE SZ_512K
23 #define NVM_DATA_DWORDS 16
25 /* Intel specific NVM offsets */
26 #define NVM_DEVID 0x05
27 #define NVM_VERSION 0x08
28 #define NVM_FLASH_SIZE 0x45
31 * struct tb_nvm - Structure holding NVM information
32 * @dev: Owner of the NVM
33 * @major: Major version number of the active NVM portion
34 * @minor: Minor version number of the active NVM portion
35 * @id: Identifier used with both NVM portions
36 * @active: Active portion NVMem device
37 * @non_active: Non-active portion NVMem device
38 * @buf: Buffer where the NVM image is stored before it is written to
39 * the actual NVM flash device
40 * @buf_data_size: Number of bytes actually consumed by the new NVM
42 * @authenticating: The device is authenticating the new NVM
43 * @flushed: The image has been flushed to the storage area
45 * The user of this structure needs to handle serialization of possible
53 struct nvmem_device *active;
54 struct nvmem_device *non_active;
61 #define TB_SWITCH_KEY_SIZE 32
62 #define TB_SWITCH_MAX_DEPTH 6
63 #define USB4_SWITCH_MAX_DEPTH 5
66 * enum tb_switch_tmu_rate - TMU refresh rate
67 * @TB_SWITCH_TMU_RATE_OFF: %0 (Disable Time Sync handshake)
68 * @TB_SWITCH_TMU_RATE_HIFI: %16 us time interval between successive
69 * transmission of the Delay Request TSNOS
70 * (Time Sync Notification Ordered Set) on a Link
71 * @TB_SWITCH_TMU_RATE_NORMAL: %1 ms time interval between successive
72 * transmission of the Delay Request TSNOS on
75 enum tb_switch_tmu_rate {
76 TB_SWITCH_TMU_RATE_OFF = 0,
77 TB_SWITCH_TMU_RATE_HIFI = 16,
78 TB_SWITCH_TMU_RATE_NORMAL = 1000,
82 * struct tb_switch_tmu - Structure holding switch TMU configuration
83 * @cap: Offset to the TMU capability (%0 if not found)
84 * @has_ucap: Does the switch support uni-directional mode
85 * @rate: TMU refresh rate related to upstream switch. In case of root
86 * switch this holds the domain rate.
87 * @unidirectional: Is the TMU in uni-directional or bi-directional mode
88 * related to upstream switch. Don't case for root switch.
90 struct tb_switch_tmu {
93 enum tb_switch_tmu_rate rate;
98 * struct tb_switch - a thunderbolt switch
99 * @dev: Device for the switch
100 * @config: Switch configuration
101 * @ports: Ports in this switch
102 * @dma_port: If the switch has port supporting DMA configuration based
103 * mailbox this will hold the pointer to that (%NULL
104 * otherwise). If set it also means the switch has
106 * @tmu: The switch TMU configuration
107 * @tb: Pointer to the domain the switch belongs to
108 * @uid: Unique ID of the switch
109 * @uuid: UUID of the switch (or %NULL if not supported)
110 * @vendor: Vendor ID of the switch
111 * @device: Device ID of the switch
112 * @vendor_name: Name of the vendor (or %NULL if not known)
113 * @device_name: Name of the device (or %NULL if not known)
114 * @link_speed: Speed of the link in Gb/s
115 * @link_width: Width of the link (1 or 2)
116 * @link_usb4: Upstream link is USB4
117 * @generation: Switch Thunderbolt generation
118 * @cap_plug_events: Offset to the plug events capability (%0 if not found)
119 * @cap_lc: Offset to the link controller capability (%0 if not found)
120 * @is_unplugged: The switch is going away
121 * @drom: DROM of the switch (%NULL if not found)
122 * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
123 * @no_nvm_upgrade: Prevent NVM upgrade of this switch
124 * @safe_mode: The switch is in safe-mode
125 * @boot: Whether the switch was already authorized on boot or not
126 * @rpm: The switch supports runtime PM
127 * @authorized: Whether the switch is authorized by user or policy
128 * @security_level: Switch supported security level
129 * @debugfs_dir: Pointer to the debugfs structure
130 * @key: Contains the key used to challenge the device or %NULL if not
131 * supported. Size of the key is %TB_SWITCH_KEY_SIZE.
132 * @connection_id: Connection ID used with ICM messaging
133 * @connection_key: Connection key used with ICM messaging
134 * @link: Root switch link this switch is connected (ICM only)
135 * @depth: Depth in the chain this switch is connected (ICM only)
136 * @rpm_complete: Completion used to wait for runtime resume to
137 * complete (ICM only)
138 * @quirks: Quirks used for this Thunderbolt switch
140 * When the switch is being added or removed to the domain (other
141 * switches) you need to have domain lock held.
143 * In USB4 terminology this structure represents a router.
147 struct tb_regs_switch_header config;
148 struct tb_port *ports;
149 struct tb_dma_port *dma_port;
150 struct tb_switch_tmu tmu;
156 const char *vendor_name;
157 const char *device_name;
158 unsigned int link_speed;
159 unsigned int link_width;
161 unsigned int generation;
171 unsigned int authorized;
172 enum tb_security_level security_level;
173 struct dentry *debugfs_dir;
179 struct completion rpm_complete;
180 unsigned long quirks;
184 * struct tb_port - a thunderbolt port, part of a tb_switch
185 * @config: Cached port configuration read from registers
186 * @sw: Switch the port belongs to
187 * @remote: Remote port (%NULL if not connected)
188 * @xdomain: Remote host (%NULL if not connected)
189 * @cap_phy: Offset, zero if not found
190 * @cap_tmu: Offset of the adapter specific TMU capability (%0 if not present)
191 * @cap_adap: Offset of the adapter specific capability (%0 if not present)
192 * @cap_usb4: Offset to the USB4 port capability (%0 if not present)
193 * @port: Port number on switch
194 * @disabled: Disabled by eeprom or enabled but not implemented
195 * @bonded: true if the port is bonded (two lanes combined as one)
196 * @dual_link_port: If the switch is connected using two ports, points
198 * @link_nr: Is this primary or secondary port on the dual_link.
199 * @in_hopids: Currently allocated input HopIDs
200 * @out_hopids: Currently allocated output HopIDs
201 * @list: Used to link ports to DP resources list
203 * In USB4 terminology this structure represents an adapter (protocol or
207 struct tb_regs_port_header config;
208 struct tb_switch *sw;
209 struct tb_port *remote;
210 struct tb_xdomain *xdomain;
218 struct tb_port *dual_link_port;
220 struct ida in_hopids;
221 struct ida out_hopids;
222 struct list_head list;
226 * tb_retimer: Thunderbolt retimer
227 * @dev: Device for the retimer
228 * @tb: Pointer to the domain the retimer belongs to
229 * @index: Retimer index facing the router USB4 port
230 * @vendor: Vendor ID of the retimer
231 * @device: Device ID of the retimer
232 * @port: Pointer to the lane 0 adapter
233 * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise)
234 * @auth_status: Status of last NVM authentication
242 struct tb_port *port;
248 * struct tb_path_hop - routing information for a tb_path
249 * @in_port: Ingress port of a switch
250 * @out_port: Egress port of a switch where the packet is routed out
251 * (must be on the same switch than @in_port)
252 * @in_hop_index: HopID where the path configuration entry is placed in
253 * the path config space of @in_port.
254 * @in_counter_index: Used counter index (not used in the driver
255 * currently, %-1 to disable)
256 * @next_hop_index: HopID of the packet when it is routed out from @out_port
257 * @initial_credits: Number of initial flow control credits allocated for
259 * @nfc_credits: Number of non-flow controlled buffers allocated for the
262 * Hop configuration is always done on the IN port of a switch.
263 * in_port and out_port have to be on the same switch. Packets arriving on
264 * in_port with "hop" = in_hop_index will get routed to through out_port. The
265 * next hop to take (on out_port->remote) is determined by
266 * next_hop_index. When routing packet to another switch (out->remote is
267 * set) the @next_hop_index must match the @in_hop_index of that next
268 * hop to make routing possible.
270 * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
274 struct tb_port *in_port;
275 struct tb_port *out_port;
277 int in_counter_index;
279 unsigned int initial_credits;
280 unsigned int nfc_credits;
284 * enum tb_path_port - path options mask
285 * @TB_PATH_NONE: Do not activate on any hop on path
286 * @TB_PATH_SOURCE: Activate on the first hop (out of src)
287 * @TB_PATH_INTERNAL: Activate on the intermediate hops (not the first/last)
288 * @TB_PATH_DESTINATION: Activate on the last hop (into dst)
289 * @TB_PATH_ALL: Activate on all hops on the path
294 TB_PATH_INTERNAL = 2,
295 TB_PATH_DESTINATION = 4,
300 * struct tb_path - a unidirectional path between two ports
301 * @tb: Pointer to the domain structure
302 * @name: Name of the path (used for debugging)
303 * @ingress_shared_buffer: Shared buffering used for ingress ports on the path
304 * @egress_shared_buffer: Shared buffering used for egress ports on the path
305 * @ingress_fc_enable: Flow control for ingress ports on the path
306 * @egress_fc_enable: Flow control for egress ports on the path
307 * @priority: Priority group if the path
308 * @weight: Weight of the path inside the priority group
309 * @drop_packages: Drop packages from queue tail or head
310 * @activated: Is the path active
311 * @clear_fc: Clear all flow control from the path config space entries
312 * when deactivating this path
314 * @path_length: How many hops the path uses
316 * A path consists of a number of hops (see &struct tb_path_hop). To
317 * establish a PCIe tunnel two paths have to be created between the two
323 enum tb_path_port ingress_shared_buffer;
324 enum tb_path_port egress_shared_buffer;
325 enum tb_path_port ingress_fc_enable;
326 enum tb_path_port egress_fc_enable;
328 unsigned int priority:3;
333 struct tb_path_hop *hops;
337 /* HopIDs 0-7 are reserved by the Thunderbolt protocol */
338 #define TB_PATH_MIN_HOPID 8
340 * Support paths from the farthest (depth 6) router to the host and back
341 * to the same level (not necessarily to the same router).
343 #define TB_PATH_MAX_HOPS (7 * 2)
345 /* Possible wake types */
346 #define TB_WAKE_ON_CONNECT BIT(0)
347 #define TB_WAKE_ON_DISCONNECT BIT(1)
348 #define TB_WAKE_ON_USB4 BIT(2)
349 #define TB_WAKE_ON_USB3 BIT(3)
350 #define TB_WAKE_ON_PCIE BIT(4)
351 #define TB_WAKE_ON_DP BIT(5)
354 * struct tb_cm_ops - Connection manager specific operations vector
355 * @driver_ready: Called right after control channel is started. Used by
356 * ICM to send driver ready message to the firmware.
357 * @start: Starts the domain
358 * @stop: Stops the domain
359 * @suspend_noirq: Connection manager specific suspend_noirq
360 * @resume_noirq: Connection manager specific resume_noirq
361 * @suspend: Connection manager specific suspend
362 * @freeze_noirq: Connection manager specific freeze_noirq
363 * @thaw_noirq: Connection manager specific thaw_noirq
364 * @complete: Connection manager specific complete
365 * @runtime_suspend: Connection manager specific runtime_suspend
366 * @runtime_resume: Connection manager specific runtime_resume
367 * @runtime_suspend_switch: Runtime suspend a switch
368 * @runtime_resume_switch: Runtime resume a switch
369 * @handle_event: Handle thunderbolt event
370 * @get_boot_acl: Get boot ACL list
371 * @set_boot_acl: Set boot ACL list
372 * @disapprove_switch: Disapprove switch (disconnect PCIe tunnel)
373 * @approve_switch: Approve switch
374 * @add_switch_key: Add key to switch
375 * @challenge_switch_key: Challenge switch using key
376 * @disconnect_pcie_paths: Disconnects PCIe paths before NVM update
377 * @approve_xdomain_paths: Approve (establish) XDomain DMA paths
378 * @disconnect_xdomain_paths: Disconnect XDomain DMA paths
379 * @usb4_switch_op: Optional proxy for USB4 router operations. If set
380 * this will be called whenever USB4 router operation is
381 * performed. If this returns %-EOPNOTSUPP then the
382 * native USB4 router operation is called.
383 * @usb4_switch_nvm_authenticate_status: Optional callback that the CM
384 * implementation can be used to
385 * return status of USB4 NVM_AUTH
389 int (*driver_ready)(struct tb *tb);
390 int (*start)(struct tb *tb);
391 void (*stop)(struct tb *tb);
392 int (*suspend_noirq)(struct tb *tb);
393 int (*resume_noirq)(struct tb *tb);
394 int (*suspend)(struct tb *tb);
395 int (*freeze_noirq)(struct tb *tb);
396 int (*thaw_noirq)(struct tb *tb);
397 void (*complete)(struct tb *tb);
398 int (*runtime_suspend)(struct tb *tb);
399 int (*runtime_resume)(struct tb *tb);
400 int (*runtime_suspend_switch)(struct tb_switch *sw);
401 int (*runtime_resume_switch)(struct tb_switch *sw);
402 void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type,
403 const void *buf, size_t size);
404 int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids);
405 int (*set_boot_acl)(struct tb *tb, const uuid_t *uuids, size_t nuuids);
406 int (*disapprove_switch)(struct tb *tb, struct tb_switch *sw);
407 int (*approve_switch)(struct tb *tb, struct tb_switch *sw);
408 int (*add_switch_key)(struct tb *tb, struct tb_switch *sw);
409 int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw,
410 const u8 *challenge, u8 *response);
411 int (*disconnect_pcie_paths)(struct tb *tb);
412 int (*approve_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd,
413 int transmit_path, int transmit_ring,
414 int receive_path, int receive_ring);
415 int (*disconnect_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd,
416 int transmit_path, int transmit_ring,
417 int receive_path, int receive_ring);
418 int (*usb4_switch_op)(struct tb_switch *sw, u16 opcode, u32 *metadata,
419 u8 *status, const void *tx_data, size_t tx_data_len,
420 void *rx_data, size_t rx_data_len);
421 int (*usb4_switch_nvm_authenticate_status)(struct tb_switch *sw,
425 static inline void *tb_priv(struct tb *tb)
427 return (void *)tb->privdata;
430 #define TB_AUTOSUSPEND_DELAY 15000 /* ms */
432 /* helper functions & macros */
435 * tb_upstream_port() - return the upstream port of a switch
437 * Every switch has an upstream port (for the root switch it is the NHI).
439 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for
440 * non root switches (on the NHI port remote is always NULL).
442 * Return: Returns the upstream port of the switch.
444 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw)
446 return &sw->ports[sw->config.upstream_port_number];
450 * tb_is_upstream_port() - Is the port upstream facing
451 * @port: Port to check
453 * Returns true if @port is upstream facing port. In case of dual link
454 * ports both return true.
456 static inline bool tb_is_upstream_port(const struct tb_port *port)
458 const struct tb_port *upstream_port = tb_upstream_port(port->sw);
459 return port == upstream_port || port->dual_link_port == upstream_port;
462 static inline u64 tb_route(const struct tb_switch *sw)
464 return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo;
467 static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw)
471 port = route >> (sw->config.depth * 8);
472 if (WARN_ON(port > sw->config.max_port_number))
474 return &sw->ports[port];
478 * tb_port_has_remote() - Does the port have switch connected downstream
479 * @port: Port to check
481 * Returns true only when the port is primary port and has remote set.
483 static inline bool tb_port_has_remote(const struct tb_port *port)
485 if (tb_is_upstream_port(port))
489 if (port->dual_link_port && port->link_nr)
495 static inline bool tb_port_is_null(const struct tb_port *port)
497 return port && port->port && port->config.type == TB_TYPE_PORT;
500 static inline bool tb_port_is_nhi(const struct tb_port *port)
502 return port && port->config.type == TB_TYPE_NHI;
505 static inline bool tb_port_is_pcie_down(const struct tb_port *port)
507 return port && port->config.type == TB_TYPE_PCIE_DOWN;
510 static inline bool tb_port_is_pcie_up(const struct tb_port *port)
512 return port && port->config.type == TB_TYPE_PCIE_UP;
515 static inline bool tb_port_is_dpin(const struct tb_port *port)
517 return port && port->config.type == TB_TYPE_DP_HDMI_IN;
520 static inline bool tb_port_is_dpout(const struct tb_port *port)
522 return port && port->config.type == TB_TYPE_DP_HDMI_OUT;
525 static inline bool tb_port_is_usb3_down(const struct tb_port *port)
527 return port && port->config.type == TB_TYPE_USB3_DOWN;
530 static inline bool tb_port_is_usb3_up(const struct tb_port *port)
532 return port && port->config.type == TB_TYPE_USB3_UP;
535 static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
536 enum tb_cfg_space space, u32 offset, u32 length)
538 if (sw->is_unplugged)
540 return tb_cfg_read(sw->tb->ctl,
549 static inline int tb_sw_write(struct tb_switch *sw, const void *buffer,
550 enum tb_cfg_space space, u32 offset, u32 length)
552 if (sw->is_unplugged)
554 return tb_cfg_write(sw->tb->ctl,
563 static inline int tb_port_read(struct tb_port *port, void *buffer,
564 enum tb_cfg_space space, u32 offset, u32 length)
566 if (port->sw->is_unplugged)
568 return tb_cfg_read(port->sw->tb->ctl,
577 static inline int tb_port_write(struct tb_port *port, const void *buffer,
578 enum tb_cfg_space space, u32 offset, u32 length)
580 if (port->sw->is_unplugged)
582 return tb_cfg_write(port->sw->tb->ctl,
591 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg)
592 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
593 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
594 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
595 #define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg)
597 #define __TB_SW_PRINT(level, sw, fmt, arg...) \
599 const struct tb_switch *__sw = (sw); \
600 level(__sw->tb, "%llx: " fmt, \
601 tb_route(__sw), ## arg); \
603 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
604 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
605 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
606 #define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg)
608 #define __TB_PORT_PRINT(level, _port, fmt, arg...) \
610 const struct tb_port *__port = (_port); \
611 level(__port->sw->tb, "%llx:%x: " fmt, \
612 tb_route(__port->sw), __port->port, ## arg); \
614 #define tb_port_WARN(port, fmt, arg...) \
615 __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg)
616 #define tb_port_warn(port, fmt, arg...) \
617 __TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
618 #define tb_port_info(port, fmt, arg...) \
619 __TB_PORT_PRINT(tb_info, port, fmt, ##arg)
620 #define tb_port_dbg(port, fmt, arg...) \
621 __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg)
623 struct tb *icm_probe(struct tb_nhi *nhi);
624 struct tb *tb_probe(struct tb_nhi *nhi);
626 extern struct device_type tb_domain_type;
627 extern struct device_type tb_retimer_type;
628 extern struct device_type tb_switch_type;
630 int tb_domain_init(void);
631 void tb_domain_exit(void);
632 int tb_xdomain_init(void);
633 void tb_xdomain_exit(void);
635 struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize);
636 int tb_domain_add(struct tb *tb);
637 void tb_domain_remove(struct tb *tb);
638 int tb_domain_suspend_noirq(struct tb *tb);
639 int tb_domain_resume_noirq(struct tb *tb);
640 int tb_domain_suspend(struct tb *tb);
641 int tb_domain_freeze_noirq(struct tb *tb);
642 int tb_domain_thaw_noirq(struct tb *tb);
643 void tb_domain_complete(struct tb *tb);
644 int tb_domain_runtime_suspend(struct tb *tb);
645 int tb_domain_runtime_resume(struct tb *tb);
646 int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw);
647 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw);
648 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw);
649 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw);
650 int tb_domain_disconnect_pcie_paths(struct tb *tb);
651 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
652 int transmit_path, int transmit_ring,
653 int receive_path, int receive_ring);
654 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
655 int transmit_path, int transmit_ring,
656 int receive_path, int receive_ring);
657 int tb_domain_disconnect_all_paths(struct tb *tb);
659 static inline struct tb *tb_domain_get(struct tb *tb)
662 get_device(&tb->dev);
666 static inline void tb_domain_put(struct tb *tb)
668 put_device(&tb->dev);
671 struct tb_nvm *tb_nvm_alloc(struct device *dev);
672 int tb_nvm_add_active(struct tb_nvm *nvm, size_t size, nvmem_reg_read_t reg_read);
673 int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val,
675 int tb_nvm_add_non_active(struct tb_nvm *nvm, size_t size,
676 nvmem_reg_write_t reg_write);
677 void tb_nvm_free(struct tb_nvm *nvm);
678 void tb_nvm_exit(void);
680 typedef int (*read_block_fn)(void *, unsigned int, void *, size_t);
681 typedef int (*write_block_fn)(void *, unsigned int, const void *, size_t);
683 int tb_nvm_read_data(unsigned int address, void *buf, size_t size,
684 unsigned int retries, read_block_fn read_block,
685 void *read_block_data);
686 int tb_nvm_write_data(unsigned int address, const void *buf, size_t size,
687 unsigned int retries, write_block_fn write_next_block,
688 void *write_block_data);
690 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
692 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb,
693 struct device *parent, u64 route);
694 int tb_switch_configure(struct tb_switch *sw);
695 int tb_switch_add(struct tb_switch *sw);
696 void tb_switch_remove(struct tb_switch *sw);
697 void tb_switch_suspend(struct tb_switch *sw, bool runtime);
698 int tb_switch_resume(struct tb_switch *sw);
699 int tb_switch_reset(struct tb_switch *sw);
700 void tb_sw_set_unplugged(struct tb_switch *sw);
701 struct tb_port *tb_switch_find_port(struct tb_switch *sw,
702 enum tb_port_type type);
703 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
705 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
706 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route);
709 * tb_switch_for_each_port() - Iterate over each switch port
710 * @sw: Switch whose ports to iterate
711 * @p: Port used as iterator
713 * Iterates over each switch port skipping the control port (port %0).
715 #define tb_switch_for_each_port(sw, p) \
716 for ((p) = &(sw)->ports[1]; \
717 (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++)
719 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw)
722 get_device(&sw->dev);
726 static inline void tb_switch_put(struct tb_switch *sw)
728 put_device(&sw->dev);
731 static inline bool tb_is_switch(const struct device *dev)
733 return dev->type == &tb_switch_type;
736 static inline struct tb_switch *tb_to_switch(struct device *dev)
738 if (tb_is_switch(dev))
739 return container_of(dev, struct tb_switch, dev);
743 static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw)
745 return tb_to_switch(sw->dev.parent);
748 static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw)
750 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
751 sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE;
754 static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw)
756 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
757 sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE;
760 static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw)
762 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
763 switch (sw->config.device_id) {
764 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
765 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
772 static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw)
774 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
775 switch (sw->config.device_id) {
776 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
777 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
784 static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw)
786 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
787 switch (sw->config.device_id) {
788 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
789 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
790 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
791 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
798 static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw)
800 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
801 switch (sw->config.device_id) {
802 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
803 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
804 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
812 * tb_switch_is_usb4() - Is the switch USB4 compliant
813 * @sw: Switch to check
815 * Returns true if the @sw is USB4 compliant router, false otherwise.
817 static inline bool tb_switch_is_usb4(const struct tb_switch *sw)
819 return sw->config.thunderbolt_version == USB4_VERSION_1_0;
823 * tb_switch_is_icm() - Is the switch handled by ICM firmware
824 * @sw: Switch to check
826 * In case there is a need to differentiate whether ICM firmware or SW CM
827 * is handling @sw this function can be called. It is valid to call this
828 * after tb_switch_alloc() and tb_switch_configure() has been called
829 * (latter only for SW CM case).
831 static inline bool tb_switch_is_icm(const struct tb_switch *sw)
833 return !sw->config.enabled;
836 int tb_switch_lane_bonding_enable(struct tb_switch *sw);
837 void tb_switch_lane_bonding_disable(struct tb_switch *sw);
838 int tb_switch_configure_link(struct tb_switch *sw);
839 void tb_switch_unconfigure_link(struct tb_switch *sw);
841 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
842 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
843 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
845 int tb_switch_tmu_init(struct tb_switch *sw);
846 int tb_switch_tmu_post_time(struct tb_switch *sw);
847 int tb_switch_tmu_disable(struct tb_switch *sw);
848 int tb_switch_tmu_enable(struct tb_switch *sw);
850 static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw)
852 return sw->tmu.rate == TB_SWITCH_TMU_RATE_HIFI &&
853 !sw->tmu.unidirectional;
856 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
857 int tb_port_add_nfc_credits(struct tb_port *port, int credits);
858 int tb_port_clear_counter(struct tb_port *port, int counter);
859 int tb_port_unlock(struct tb_port *port);
860 int tb_port_enable(struct tb_port *port);
861 int tb_port_disable(struct tb_port *port);
862 int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid);
863 void tb_port_release_in_hopid(struct tb_port *port, int hopid);
864 int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid);
865 void tb_port_release_out_hopid(struct tb_port *port, int hopid);
866 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
867 struct tb_port *prev);
870 * tb_for_each_port_on_path() - Iterate over each port on path
872 * @dst: Destination port
873 * @p: Port used as iterator
875 * Walks over each port on path from @src to @dst.
877 #define tb_for_each_port_on_path(src, dst, p) \
878 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \
879 (p) = tb_next_port_on_path((src), (dst), (p)))
881 int tb_port_get_link_speed(struct tb_port *port);
882 int tb_port_get_link_width(struct tb_port *port);
883 int tb_port_state(struct tb_port *port);
884 int tb_port_lane_bonding_enable(struct tb_port *port);
885 void tb_port_lane_bonding_disable(struct tb_port *port);
887 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
888 int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap);
889 int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset);
890 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
891 int tb_port_next_cap(struct tb_port *port, unsigned int offset);
892 bool tb_port_is_enabled(struct tb_port *port);
894 bool tb_usb3_port_is_enabled(struct tb_port *port);
895 int tb_usb3_port_enable(struct tb_port *port, bool enable);
897 bool tb_pci_port_is_enabled(struct tb_port *port);
898 int tb_pci_port_enable(struct tb_port *port, bool enable);
900 int tb_dp_port_hpd_is_active(struct tb_port *port);
901 int tb_dp_port_hpd_clear(struct tb_port *port);
902 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
903 unsigned int aux_tx, unsigned int aux_rx);
904 bool tb_dp_port_is_enabled(struct tb_port *port);
905 int tb_dp_port_enable(struct tb_port *port, bool enable);
907 struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid,
908 struct tb_port *dst, int dst_hopid,
909 struct tb_port **last, const char *name);
910 struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid,
911 struct tb_port *dst, int dst_hopid, int link_nr,
913 void tb_path_free(struct tb_path *path);
914 int tb_path_activate(struct tb_path *path);
915 void tb_path_deactivate(struct tb_path *path);
916 bool tb_path_is_invalid(struct tb_path *path);
917 bool tb_path_port_on_path(const struct tb_path *path,
918 const struct tb_port *port);
920 int tb_drom_read(struct tb_switch *sw);
921 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
923 int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid);
924 int tb_lc_configure_port(struct tb_port *port);
925 void tb_lc_unconfigure_port(struct tb_port *port);
926 int tb_lc_configure_xdomain(struct tb_port *port);
927 void tb_lc_unconfigure_xdomain(struct tb_port *port);
928 int tb_lc_start_lane_initialization(struct tb_port *port);
929 int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags);
930 int tb_lc_set_sleep(struct tb_switch *sw);
931 bool tb_lc_lane_bonding_possible(struct tb_switch *sw);
932 bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in);
933 int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in);
934 int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in);
935 int tb_lc_force_power(struct tb_switch *sw);
937 static inline int tb_route_length(u64 route)
939 return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
943 * tb_downstream_route() - get route to downstream switch
945 * Port must not be the upstream port (otherwise a loop is created).
947 * Return: Returns a route to the switch behind @port.
949 static inline u64 tb_downstream_route(struct tb_port *port)
951 return tb_route(port->sw)
952 | ((u64) port->port << (port->sw->config.depth * 8));
955 bool tb_is_xdomain_enabled(void);
956 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
957 const void *buf, size_t size);
958 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
959 u64 route, const uuid_t *local_uuid,
960 const uuid_t *remote_uuid);
961 void tb_xdomain_add(struct tb_xdomain *xd);
962 void tb_xdomain_remove(struct tb_xdomain *xd);
963 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
966 int tb_retimer_scan(struct tb_port *port);
967 void tb_retimer_remove_all(struct tb_port *port);
969 static inline bool tb_is_retimer(const struct device *dev)
971 return dev->type == &tb_retimer_type;
974 static inline struct tb_retimer *tb_to_retimer(struct device *dev)
976 if (tb_is_retimer(dev))
977 return container_of(dev, struct tb_retimer, dev);
981 int usb4_switch_setup(struct tb_switch *sw);
982 int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid);
983 int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf,
985 bool usb4_switch_lane_bonding_possible(struct tb_switch *sw);
986 int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags);
987 int usb4_switch_set_sleep(struct tb_switch *sw);
988 int usb4_switch_nvm_sector_size(struct tb_switch *sw);
989 int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
991 int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address,
992 const void *buf, size_t size);
993 int usb4_switch_nvm_authenticate(struct tb_switch *sw);
994 int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status);
995 bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
996 int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
997 int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
998 struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw,
999 const struct tb_port *port);
1000 struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw,
1001 const struct tb_port *port);
1003 int usb4_port_unlock(struct tb_port *port);
1004 int usb4_port_configure(struct tb_port *port);
1005 void usb4_port_unconfigure(struct tb_port *port);
1006 int usb4_port_configure_xdomain(struct tb_port *port);
1007 void usb4_port_unconfigure_xdomain(struct tb_port *port);
1008 int usb4_port_enumerate_retimers(struct tb_port *port);
1010 int usb4_port_retimer_read(struct tb_port *port, u8 index, u8 reg, void *buf,
1012 int usb4_port_retimer_write(struct tb_port *port, u8 index, u8 reg,
1013 const void *buf, u8 size);
1014 int usb4_port_retimer_is_last(struct tb_port *port, u8 index);
1015 int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index);
1016 int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index,
1017 unsigned int address, const void *buf,
1019 int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index);
1020 int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index,
1022 int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index,
1023 unsigned int address, void *buf, size_t size);
1025 int usb4_usb3_port_max_link_rate(struct tb_port *port);
1026 int usb4_usb3_port_actual_link_rate(struct tb_port *port);
1027 int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw,
1028 int *downstream_bw);
1029 int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw,
1030 int *downstream_bw);
1031 int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw,
1032 int *downstream_bw);
1034 /* Keep link controller awake during update */
1035 #define QUIRK_FORCE_POWER_LINK_CONTROLLER BIT(0)
1037 void tb_check_quirks(struct tb_switch *sw);
1040 void tb_acpi_add_links(struct tb_nhi *nhi);
1042 bool tb_acpi_is_native(void);
1043 bool tb_acpi_may_tunnel_usb3(void);
1044 bool tb_acpi_may_tunnel_dp(void);
1045 bool tb_acpi_may_tunnel_pcie(void);
1046 bool tb_acpi_is_xdomain_allowed(void);
1048 static inline void tb_acpi_add_links(struct tb_nhi *nhi) { }
1050 static inline bool tb_acpi_is_native(void) { return true; }
1051 static inline bool tb_acpi_may_tunnel_usb3(void) { return true; }
1052 static inline bool tb_acpi_may_tunnel_dp(void) { return true; }
1053 static inline bool tb_acpi_may_tunnel_pcie(void) { return true; }
1054 static inline bool tb_acpi_is_xdomain_allowed(void) { return true; }
1057 #ifdef CONFIG_DEBUG_FS
1058 void tb_debugfs_init(void);
1059 void tb_debugfs_exit(void);
1060 void tb_switch_debugfs_init(struct tb_switch *sw);
1061 void tb_switch_debugfs_remove(struct tb_switch *sw);
1062 void tb_service_debugfs_init(struct tb_service *svc);
1063 void tb_service_debugfs_remove(struct tb_service *svc);
1065 static inline void tb_debugfs_init(void) { }
1066 static inline void tb_debugfs_exit(void) { }
1067 static inline void tb_switch_debugfs_init(struct tb_switch *sw) { }
1068 static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { }
1069 static inline void tb_service_debugfs_init(struct tb_service *svc) { }
1070 static inline void tb_service_debugfs_remove(struct tb_service *svc) { }
1073 #ifdef CONFIG_USB4_KUNIT_TEST
1074 int tb_test_init(void);
1075 void tb_test_exit(void);
1077 static inline int tb_test_init(void) { return 0; }
1078 static inline void tb_test_exit(void) { }