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 enum tb_nvm_write_ops {
62 WRITE_AND_AUTHENTICATE = 1,
64 AUTHENTICATE_ONLY = 3,
67 #define TB_SWITCH_KEY_SIZE 32
68 #define TB_SWITCH_MAX_DEPTH 6
69 #define USB4_SWITCH_MAX_DEPTH 5
72 * enum tb_switch_tmu_rate - TMU refresh rate
73 * @TB_SWITCH_TMU_RATE_OFF: %0 (Disable Time Sync handshake)
74 * @TB_SWITCH_TMU_RATE_HIFI: %16 us time interval between successive
75 * transmission of the Delay Request TSNOS
76 * (Time Sync Notification Ordered Set) on a Link
77 * @TB_SWITCH_TMU_RATE_NORMAL: %1 ms time interval between successive
78 * transmission of the Delay Request TSNOS on
81 enum tb_switch_tmu_rate {
82 TB_SWITCH_TMU_RATE_OFF = 0,
83 TB_SWITCH_TMU_RATE_HIFI = 16,
84 TB_SWITCH_TMU_RATE_NORMAL = 1000,
88 * struct tb_switch_tmu - Structure holding switch TMU configuration
89 * @cap: Offset to the TMU capability (%0 if not found)
90 * @has_ucap: Does the switch support uni-directional mode
91 * @rate: TMU refresh rate related to upstream switch. In case of root
92 * switch this holds the domain rate.
93 * @unidirectional: Is the TMU in uni-directional or bi-directional mode
94 * related to upstream switch. Don't case for root switch.
96 struct tb_switch_tmu {
99 enum tb_switch_tmu_rate rate;
104 * struct tb_switch - a thunderbolt switch
105 * @dev: Device for the switch
106 * @config: Switch configuration
107 * @ports: Ports in this switch
108 * @dma_port: If the switch has port supporting DMA configuration based
109 * mailbox this will hold the pointer to that (%NULL
110 * otherwise). If set it also means the switch has
112 * @tmu: The switch TMU configuration
113 * @tb: Pointer to the domain the switch belongs to
114 * @uid: Unique ID of the switch
115 * @uuid: UUID of the switch (or %NULL if not supported)
116 * @vendor: Vendor ID of the switch
117 * @device: Device ID of the switch
118 * @vendor_name: Name of the vendor (or %NULL if not known)
119 * @device_name: Name of the device (or %NULL if not known)
120 * @link_speed: Speed of the link in Gb/s
121 * @link_width: Width of the link (1 or 2)
122 * @link_usb4: Upstream link is USB4
123 * @generation: Switch Thunderbolt generation
124 * @cap_plug_events: Offset to the plug events capability (%0 if not found)
125 * @cap_lc: Offset to the link controller capability (%0 if not found)
126 * @is_unplugged: The switch is going away
127 * @drom: DROM of the switch (%NULL if not found)
128 * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
129 * @no_nvm_upgrade: Prevent NVM upgrade of this switch
130 * @safe_mode: The switch is in safe-mode
131 * @boot: Whether the switch was already authorized on boot or not
132 * @rpm: The switch supports runtime PM
133 * @authorized: Whether the switch is authorized by user or policy
134 * @security_level: Switch supported security level
135 * @debugfs_dir: Pointer to the debugfs structure
136 * @key: Contains the key used to challenge the device or %NULL if not
137 * supported. Size of the key is %TB_SWITCH_KEY_SIZE.
138 * @connection_id: Connection ID used with ICM messaging
139 * @connection_key: Connection key used with ICM messaging
140 * @link: Root switch link this switch is connected (ICM only)
141 * @depth: Depth in the chain this switch is connected (ICM only)
142 * @rpm_complete: Completion used to wait for runtime resume to
143 * complete (ICM only)
144 * @quirks: Quirks used for this Thunderbolt switch
145 * @credit_allocation: Are the below buffer allocation parameters valid
146 * @max_usb3_credits: Router preferred number of buffers for USB 3.x
147 * @min_dp_aux_credits: Router preferred minimum number of buffers for DP AUX
148 * @min_dp_main_credits: Router preferred minimum number of buffers for DP MAIN
149 * @max_pcie_credits: Router preferred number of buffers for PCIe
150 * @max_dma_credits: Router preferred number of buffers for DMA/P2P
152 * When the switch is being added or removed to the domain (other
153 * switches) you need to have domain lock held.
155 * In USB4 terminology this structure represents a router.
159 struct tb_regs_switch_header config;
160 struct tb_port *ports;
161 struct tb_dma_port *dma_port;
162 struct tb_switch_tmu tmu;
168 const char *vendor_name;
169 const char *device_name;
170 unsigned int link_speed;
171 unsigned int link_width;
173 unsigned int generation;
183 unsigned int authorized;
184 enum tb_security_level security_level;
185 struct dentry *debugfs_dir;
191 struct completion rpm_complete;
192 unsigned long quirks;
193 bool credit_allocation;
194 unsigned int max_usb3_credits;
195 unsigned int min_dp_aux_credits;
196 unsigned int min_dp_main_credits;
197 unsigned int max_pcie_credits;
198 unsigned int max_dma_credits;
202 * struct tb_port - a thunderbolt port, part of a tb_switch
203 * @config: Cached port configuration read from registers
204 * @sw: Switch the port belongs to
205 * @remote: Remote port (%NULL if not connected)
206 * @xdomain: Remote host (%NULL if not connected)
207 * @cap_phy: Offset, zero if not found
208 * @cap_tmu: Offset of the adapter specific TMU capability (%0 if not present)
209 * @cap_adap: Offset of the adapter specific capability (%0 if not present)
210 * @cap_usb4: Offset to the USB4 port capability (%0 if not present)
211 * @usb4: Pointer to the USB4 port structure (only if @cap_usb4 is != %0)
212 * @port: Port number on switch
213 * @disabled: Disabled by eeprom or enabled but not implemented
214 * @bonded: true if the port is bonded (two lanes combined as one)
215 * @dual_link_port: If the switch is connected using two ports, points
217 * @link_nr: Is this primary or secondary port on the dual_link.
218 * @in_hopids: Currently allocated input HopIDs
219 * @out_hopids: Currently allocated output HopIDs
220 * @list: Used to link ports to DP resources list
221 * @total_credits: Total number of buffers available for this port
222 * @ctl_credits: Buffers reserved for control path
223 * @dma_credits: Number of credits allocated for DMA tunneling for all
224 * DMA paths through this port.
226 * In USB4 terminology this structure represents an adapter (protocol or
230 struct tb_regs_port_header config;
231 struct tb_switch *sw;
232 struct tb_port *remote;
233 struct tb_xdomain *xdomain;
238 struct usb4_port *usb4;
242 struct tb_port *dual_link_port;
244 struct ida in_hopids;
245 struct ida out_hopids;
246 struct list_head list;
247 unsigned int total_credits;
248 unsigned int ctl_credits;
249 unsigned int dma_credits;
253 * struct usb4_port - USB4 port device
254 * @dev: Device for the port
255 * @port: Pointer to the lane 0 adapter
256 * @can_offline: Does the port have necessary platform support to moved
257 * it into offline mode and back
258 * @offline: The port is currently in offline mode
262 struct tb_port *port;
268 * tb_retimer: Thunderbolt retimer
269 * @dev: Device for the retimer
270 * @tb: Pointer to the domain the retimer belongs to
271 * @index: Retimer index facing the router USB4 port
272 * @vendor: Vendor ID of the retimer
273 * @device: Device ID of the retimer
274 * @port: Pointer to the lane 0 adapter
275 * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise)
276 * @auth_status: Status of last NVM authentication
284 struct tb_port *port;
290 * struct tb_path_hop - routing information for a tb_path
291 * @in_port: Ingress port of a switch
292 * @out_port: Egress port of a switch where the packet is routed out
293 * (must be on the same switch than @in_port)
294 * @in_hop_index: HopID where the path configuration entry is placed in
295 * the path config space of @in_port.
296 * @in_counter_index: Used counter index (not used in the driver
297 * currently, %-1 to disable)
298 * @next_hop_index: HopID of the packet when it is routed out from @out_port
299 * @initial_credits: Number of initial flow control credits allocated for
301 * @nfc_credits: Number of non-flow controlled buffers allocated for the
304 * Hop configuration is always done on the IN port of a switch.
305 * in_port and out_port have to be on the same switch. Packets arriving on
306 * in_port with "hop" = in_hop_index will get routed to through out_port. The
307 * next hop to take (on out_port->remote) is determined by
308 * next_hop_index. When routing packet to another switch (out->remote is
309 * set) the @next_hop_index must match the @in_hop_index of that next
310 * hop to make routing possible.
312 * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
316 struct tb_port *in_port;
317 struct tb_port *out_port;
319 int in_counter_index;
321 unsigned int initial_credits;
322 unsigned int nfc_credits;
326 * enum tb_path_port - path options mask
327 * @TB_PATH_NONE: Do not activate on any hop on path
328 * @TB_PATH_SOURCE: Activate on the first hop (out of src)
329 * @TB_PATH_INTERNAL: Activate on the intermediate hops (not the first/last)
330 * @TB_PATH_DESTINATION: Activate on the last hop (into dst)
331 * @TB_PATH_ALL: Activate on all hops on the path
336 TB_PATH_INTERNAL = 2,
337 TB_PATH_DESTINATION = 4,
342 * struct tb_path - a unidirectional path between two ports
343 * @tb: Pointer to the domain structure
344 * @name: Name of the path (used for debugging)
345 * @ingress_shared_buffer: Shared buffering used for ingress ports on the path
346 * @egress_shared_buffer: Shared buffering used for egress ports on the path
347 * @ingress_fc_enable: Flow control for ingress ports on the path
348 * @egress_fc_enable: Flow control for egress ports on the path
349 * @priority: Priority group if the path
350 * @weight: Weight of the path inside the priority group
351 * @drop_packages: Drop packages from queue tail or head
352 * @activated: Is the path active
353 * @clear_fc: Clear all flow control from the path config space entries
354 * when deactivating this path
356 * @path_length: How many hops the path uses
357 * @alloc_hopid: Does this path consume port HopID
359 * A path consists of a number of hops (see &struct tb_path_hop). To
360 * establish a PCIe tunnel two paths have to be created between the two
366 enum tb_path_port ingress_shared_buffer;
367 enum tb_path_port egress_shared_buffer;
368 enum tb_path_port ingress_fc_enable;
369 enum tb_path_port egress_fc_enable;
371 unsigned int priority:3;
376 struct tb_path_hop *hops;
381 /* HopIDs 0-7 are reserved by the Thunderbolt protocol */
382 #define TB_PATH_MIN_HOPID 8
384 * Support paths from the farthest (depth 6) router to the host and back
385 * to the same level (not necessarily to the same router).
387 #define TB_PATH_MAX_HOPS (7 * 2)
389 /* Possible wake types */
390 #define TB_WAKE_ON_CONNECT BIT(0)
391 #define TB_WAKE_ON_DISCONNECT BIT(1)
392 #define TB_WAKE_ON_USB4 BIT(2)
393 #define TB_WAKE_ON_USB3 BIT(3)
394 #define TB_WAKE_ON_PCIE BIT(4)
395 #define TB_WAKE_ON_DP BIT(5)
398 * struct tb_cm_ops - Connection manager specific operations vector
399 * @driver_ready: Called right after control channel is started. Used by
400 * ICM to send driver ready message to the firmware.
401 * @start: Starts the domain
402 * @stop: Stops the domain
403 * @suspend_noirq: Connection manager specific suspend_noirq
404 * @resume_noirq: Connection manager specific resume_noirq
405 * @suspend: Connection manager specific suspend
406 * @freeze_noirq: Connection manager specific freeze_noirq
407 * @thaw_noirq: Connection manager specific thaw_noirq
408 * @complete: Connection manager specific complete
409 * @runtime_suspend: Connection manager specific runtime_suspend
410 * @runtime_resume: Connection manager specific runtime_resume
411 * @runtime_suspend_switch: Runtime suspend a switch
412 * @runtime_resume_switch: Runtime resume a switch
413 * @handle_event: Handle thunderbolt event
414 * @get_boot_acl: Get boot ACL list
415 * @set_boot_acl: Set boot ACL list
416 * @disapprove_switch: Disapprove switch (disconnect PCIe tunnel)
417 * @approve_switch: Approve switch
418 * @add_switch_key: Add key to switch
419 * @challenge_switch_key: Challenge switch using key
420 * @disconnect_pcie_paths: Disconnects PCIe paths before NVM update
421 * @approve_xdomain_paths: Approve (establish) XDomain DMA paths
422 * @disconnect_xdomain_paths: Disconnect XDomain DMA paths
423 * @usb4_switch_op: Optional proxy for USB4 router operations. If set
424 * this will be called whenever USB4 router operation is
425 * performed. If this returns %-EOPNOTSUPP then the
426 * native USB4 router operation is called.
427 * @usb4_switch_nvm_authenticate_status: Optional callback that the CM
428 * implementation can be used to
429 * return status of USB4 NVM_AUTH
433 int (*driver_ready)(struct tb *tb);
434 int (*start)(struct tb *tb);
435 void (*stop)(struct tb *tb);
436 int (*suspend_noirq)(struct tb *tb);
437 int (*resume_noirq)(struct tb *tb);
438 int (*suspend)(struct tb *tb);
439 int (*freeze_noirq)(struct tb *tb);
440 int (*thaw_noirq)(struct tb *tb);
441 void (*complete)(struct tb *tb);
442 int (*runtime_suspend)(struct tb *tb);
443 int (*runtime_resume)(struct tb *tb);
444 int (*runtime_suspend_switch)(struct tb_switch *sw);
445 int (*runtime_resume_switch)(struct tb_switch *sw);
446 void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type,
447 const void *buf, size_t size);
448 int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids);
449 int (*set_boot_acl)(struct tb *tb, const uuid_t *uuids, size_t nuuids);
450 int (*disapprove_switch)(struct tb *tb, struct tb_switch *sw);
451 int (*approve_switch)(struct tb *tb, struct tb_switch *sw);
452 int (*add_switch_key)(struct tb *tb, struct tb_switch *sw);
453 int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw,
454 const u8 *challenge, u8 *response);
455 int (*disconnect_pcie_paths)(struct tb *tb);
456 int (*approve_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd,
457 int transmit_path, int transmit_ring,
458 int receive_path, int receive_ring);
459 int (*disconnect_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd,
460 int transmit_path, int transmit_ring,
461 int receive_path, int receive_ring);
462 int (*usb4_switch_op)(struct tb_switch *sw, u16 opcode, u32 *metadata,
463 u8 *status, const void *tx_data, size_t tx_data_len,
464 void *rx_data, size_t rx_data_len);
465 int (*usb4_switch_nvm_authenticate_status)(struct tb_switch *sw,
469 static inline void *tb_priv(struct tb *tb)
471 return (void *)tb->privdata;
474 #define TB_AUTOSUSPEND_DELAY 15000 /* ms */
476 /* helper functions & macros */
479 * tb_upstream_port() - return the upstream port of a switch
481 * Every switch has an upstream port (for the root switch it is the NHI).
483 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for
484 * non root switches (on the NHI port remote is always NULL).
486 * Return: Returns the upstream port of the switch.
488 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw)
490 return &sw->ports[sw->config.upstream_port_number];
494 * tb_is_upstream_port() - Is the port upstream facing
495 * @port: Port to check
497 * Returns true if @port is upstream facing port. In case of dual link
498 * ports both return true.
500 static inline bool tb_is_upstream_port(const struct tb_port *port)
502 const struct tb_port *upstream_port = tb_upstream_port(port->sw);
503 return port == upstream_port || port->dual_link_port == upstream_port;
506 static inline u64 tb_route(const struct tb_switch *sw)
508 return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo;
511 static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw)
515 port = route >> (sw->config.depth * 8);
516 if (WARN_ON(port > sw->config.max_port_number))
518 return &sw->ports[port];
522 * tb_port_has_remote() - Does the port have switch connected downstream
523 * @port: Port to check
525 * Returns true only when the port is primary port and has remote set.
527 static inline bool tb_port_has_remote(const struct tb_port *port)
529 if (tb_is_upstream_port(port))
533 if (port->dual_link_port && port->link_nr)
539 static inline bool tb_port_is_null(const struct tb_port *port)
541 return port && port->port && port->config.type == TB_TYPE_PORT;
544 static inline bool tb_port_is_nhi(const struct tb_port *port)
546 return port && port->config.type == TB_TYPE_NHI;
549 static inline bool tb_port_is_pcie_down(const struct tb_port *port)
551 return port && port->config.type == TB_TYPE_PCIE_DOWN;
554 static inline bool tb_port_is_pcie_up(const struct tb_port *port)
556 return port && port->config.type == TB_TYPE_PCIE_UP;
559 static inline bool tb_port_is_dpin(const struct tb_port *port)
561 return port && port->config.type == TB_TYPE_DP_HDMI_IN;
564 static inline bool tb_port_is_dpout(const struct tb_port *port)
566 return port && port->config.type == TB_TYPE_DP_HDMI_OUT;
569 static inline bool tb_port_is_usb3_down(const struct tb_port *port)
571 return port && port->config.type == TB_TYPE_USB3_DOWN;
574 static inline bool tb_port_is_usb3_up(const struct tb_port *port)
576 return port && port->config.type == TB_TYPE_USB3_UP;
579 static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
580 enum tb_cfg_space space, u32 offset, u32 length)
582 if (sw->is_unplugged)
584 return tb_cfg_read(sw->tb->ctl,
593 static inline int tb_sw_write(struct tb_switch *sw, const void *buffer,
594 enum tb_cfg_space space, u32 offset, u32 length)
596 if (sw->is_unplugged)
598 return tb_cfg_write(sw->tb->ctl,
607 static inline int tb_port_read(struct tb_port *port, void *buffer,
608 enum tb_cfg_space space, u32 offset, u32 length)
610 if (port->sw->is_unplugged)
612 return tb_cfg_read(port->sw->tb->ctl,
621 static inline int tb_port_write(struct tb_port *port, const void *buffer,
622 enum tb_cfg_space space, u32 offset, u32 length)
624 if (port->sw->is_unplugged)
626 return tb_cfg_write(port->sw->tb->ctl,
635 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg)
636 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
637 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
638 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
639 #define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg)
641 #define __TB_SW_PRINT(level, sw, fmt, arg...) \
643 const struct tb_switch *__sw = (sw); \
644 level(__sw->tb, "%llx: " fmt, \
645 tb_route(__sw), ## arg); \
647 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
648 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
649 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
650 #define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg)
652 #define __TB_PORT_PRINT(level, _port, fmt, arg...) \
654 const struct tb_port *__port = (_port); \
655 level(__port->sw->tb, "%llx:%x: " fmt, \
656 tb_route(__port->sw), __port->port, ## arg); \
658 #define tb_port_WARN(port, fmt, arg...) \
659 __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg)
660 #define tb_port_warn(port, fmt, arg...) \
661 __TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
662 #define tb_port_info(port, fmt, arg...) \
663 __TB_PORT_PRINT(tb_info, port, fmt, ##arg)
664 #define tb_port_dbg(port, fmt, arg...) \
665 __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg)
667 struct tb *icm_probe(struct tb_nhi *nhi);
668 struct tb *tb_probe(struct tb_nhi *nhi);
670 extern struct device_type tb_domain_type;
671 extern struct device_type tb_retimer_type;
672 extern struct device_type tb_switch_type;
673 extern struct device_type usb4_port_device_type;
675 int tb_domain_init(void);
676 void tb_domain_exit(void);
677 int tb_xdomain_init(void);
678 void tb_xdomain_exit(void);
680 struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize);
681 int tb_domain_add(struct tb *tb);
682 void tb_domain_remove(struct tb *tb);
683 int tb_domain_suspend_noirq(struct tb *tb);
684 int tb_domain_resume_noirq(struct tb *tb);
685 int tb_domain_suspend(struct tb *tb);
686 int tb_domain_freeze_noirq(struct tb *tb);
687 int tb_domain_thaw_noirq(struct tb *tb);
688 void tb_domain_complete(struct tb *tb);
689 int tb_domain_runtime_suspend(struct tb *tb);
690 int tb_domain_runtime_resume(struct tb *tb);
691 int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw);
692 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw);
693 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw);
694 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw);
695 int tb_domain_disconnect_pcie_paths(struct tb *tb);
696 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
697 int transmit_path, int transmit_ring,
698 int receive_path, int receive_ring);
699 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
700 int transmit_path, int transmit_ring,
701 int receive_path, int receive_ring);
702 int tb_domain_disconnect_all_paths(struct tb *tb);
704 static inline struct tb *tb_domain_get(struct tb *tb)
707 get_device(&tb->dev);
711 static inline void tb_domain_put(struct tb *tb)
713 put_device(&tb->dev);
716 struct tb_nvm *tb_nvm_alloc(struct device *dev);
717 int tb_nvm_add_active(struct tb_nvm *nvm, size_t size, nvmem_reg_read_t reg_read);
718 int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val,
720 int tb_nvm_add_non_active(struct tb_nvm *nvm, size_t size,
721 nvmem_reg_write_t reg_write);
722 void tb_nvm_free(struct tb_nvm *nvm);
723 void tb_nvm_exit(void);
725 typedef int (*read_block_fn)(void *, unsigned int, void *, size_t);
726 typedef int (*write_block_fn)(void *, unsigned int, const void *, size_t);
728 int tb_nvm_read_data(unsigned int address, void *buf, size_t size,
729 unsigned int retries, read_block_fn read_block,
730 void *read_block_data);
731 int tb_nvm_write_data(unsigned int address, const void *buf, size_t size,
732 unsigned int retries, write_block_fn write_next_block,
733 void *write_block_data);
735 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
737 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb,
738 struct device *parent, u64 route);
739 int tb_switch_configure(struct tb_switch *sw);
740 int tb_switch_add(struct tb_switch *sw);
741 void tb_switch_remove(struct tb_switch *sw);
742 void tb_switch_suspend(struct tb_switch *sw, bool runtime);
743 int tb_switch_resume(struct tb_switch *sw);
744 int tb_switch_reset(struct tb_switch *sw);
745 void tb_sw_set_unplugged(struct tb_switch *sw);
746 struct tb_port *tb_switch_find_port(struct tb_switch *sw,
747 enum tb_port_type type);
748 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
750 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
751 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route);
754 * tb_switch_for_each_port() - Iterate over each switch port
755 * @sw: Switch whose ports to iterate
756 * @p: Port used as iterator
758 * Iterates over each switch port skipping the control port (port %0).
760 #define tb_switch_for_each_port(sw, p) \
761 for ((p) = &(sw)->ports[1]; \
762 (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++)
764 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw)
767 get_device(&sw->dev);
771 static inline void tb_switch_put(struct tb_switch *sw)
773 put_device(&sw->dev);
776 static inline bool tb_is_switch(const struct device *dev)
778 return dev->type == &tb_switch_type;
781 static inline struct tb_switch *tb_to_switch(struct device *dev)
783 if (tb_is_switch(dev))
784 return container_of(dev, struct tb_switch, dev);
788 static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw)
790 return tb_to_switch(sw->dev.parent);
793 static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw)
795 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
796 sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE;
799 static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw)
801 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
802 sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE;
805 static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw)
807 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
808 switch (sw->config.device_id) {
809 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
810 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
817 static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw)
819 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
820 switch (sw->config.device_id) {
821 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
822 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
829 static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw)
831 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
832 switch (sw->config.device_id) {
833 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
834 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
835 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
836 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
843 static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw)
845 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
846 switch (sw->config.device_id) {
847 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
848 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
849 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
857 * tb_switch_is_usb4() - Is the switch USB4 compliant
858 * @sw: Switch to check
860 * Returns true if the @sw is USB4 compliant router, false otherwise.
862 static inline bool tb_switch_is_usb4(const struct tb_switch *sw)
864 return sw->config.thunderbolt_version == USB4_VERSION_1_0;
868 * tb_switch_is_icm() - Is the switch handled by ICM firmware
869 * @sw: Switch to check
871 * In case there is a need to differentiate whether ICM firmware or SW CM
872 * is handling @sw this function can be called. It is valid to call this
873 * after tb_switch_alloc() and tb_switch_configure() has been called
874 * (latter only for SW CM case).
876 static inline bool tb_switch_is_icm(const struct tb_switch *sw)
878 return !sw->config.enabled;
881 int tb_switch_lane_bonding_enable(struct tb_switch *sw);
882 void tb_switch_lane_bonding_disable(struct tb_switch *sw);
883 int tb_switch_configure_link(struct tb_switch *sw);
884 void tb_switch_unconfigure_link(struct tb_switch *sw);
886 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
887 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
888 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
890 int tb_switch_tmu_init(struct tb_switch *sw);
891 int tb_switch_tmu_post_time(struct tb_switch *sw);
892 int tb_switch_tmu_disable(struct tb_switch *sw);
893 int tb_switch_tmu_enable(struct tb_switch *sw);
895 static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw)
897 return sw->tmu.rate == TB_SWITCH_TMU_RATE_HIFI &&
898 !sw->tmu.unidirectional;
901 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
902 int tb_port_add_nfc_credits(struct tb_port *port, int credits);
903 int tb_port_clear_counter(struct tb_port *port, int counter);
904 int tb_port_unlock(struct tb_port *port);
905 int tb_port_enable(struct tb_port *port);
906 int tb_port_disable(struct tb_port *port);
907 int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid);
908 void tb_port_release_in_hopid(struct tb_port *port, int hopid);
909 int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid);
910 void tb_port_release_out_hopid(struct tb_port *port, int hopid);
911 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
912 struct tb_port *prev);
914 static inline bool tb_port_use_credit_allocation(const struct tb_port *port)
916 return tb_port_is_null(port) && port->sw->credit_allocation;
920 * tb_for_each_port_on_path() - Iterate over each port on path
922 * @dst: Destination port
923 * @p: Port used as iterator
925 * Walks over each port on path from @src to @dst.
927 #define tb_for_each_port_on_path(src, dst, p) \
928 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \
929 (p) = tb_next_port_on_path((src), (dst), (p)))
931 int tb_port_get_link_speed(struct tb_port *port);
932 int tb_port_get_link_width(struct tb_port *port);
933 int tb_port_state(struct tb_port *port);
934 int tb_port_lane_bonding_enable(struct tb_port *port);
935 void tb_port_lane_bonding_disable(struct tb_port *port);
936 int tb_port_wait_for_link_width(struct tb_port *port, int width,
938 int tb_port_update_credits(struct tb_port *port);
940 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
941 int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap);
942 int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset);
943 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
944 int tb_port_next_cap(struct tb_port *port, unsigned int offset);
945 bool tb_port_is_enabled(struct tb_port *port);
947 bool tb_usb3_port_is_enabled(struct tb_port *port);
948 int tb_usb3_port_enable(struct tb_port *port, bool enable);
950 bool tb_pci_port_is_enabled(struct tb_port *port);
951 int tb_pci_port_enable(struct tb_port *port, bool enable);
953 int tb_dp_port_hpd_is_active(struct tb_port *port);
954 int tb_dp_port_hpd_clear(struct tb_port *port);
955 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
956 unsigned int aux_tx, unsigned int aux_rx);
957 bool tb_dp_port_is_enabled(struct tb_port *port);
958 int tb_dp_port_enable(struct tb_port *port, bool enable);
960 struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid,
961 struct tb_port *dst, int dst_hopid,
962 struct tb_port **last, const char *name,
964 struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid,
965 struct tb_port *dst, int dst_hopid, int link_nr,
967 void tb_path_free(struct tb_path *path);
968 int tb_path_activate(struct tb_path *path);
969 void tb_path_deactivate(struct tb_path *path);
970 bool tb_path_is_invalid(struct tb_path *path);
971 bool tb_path_port_on_path(const struct tb_path *path,
972 const struct tb_port *port);
975 * tb_path_for_each_hop() - Iterate over each hop on path
976 * @path: Path whose hops to iterate
977 * @hop: Hop used as iterator
979 * Iterates over each hop on path.
981 #define tb_path_for_each_hop(path, hop) \
982 for ((hop) = &(path)->hops[0]; \
983 (hop) <= &(path)->hops[(path)->path_length - 1]; (hop)++)
985 int tb_drom_read(struct tb_switch *sw);
986 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
988 int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid);
989 int tb_lc_configure_port(struct tb_port *port);
990 void tb_lc_unconfigure_port(struct tb_port *port);
991 int tb_lc_configure_xdomain(struct tb_port *port);
992 void tb_lc_unconfigure_xdomain(struct tb_port *port);
993 int tb_lc_start_lane_initialization(struct tb_port *port);
994 int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags);
995 int tb_lc_set_sleep(struct tb_switch *sw);
996 bool tb_lc_lane_bonding_possible(struct tb_switch *sw);
997 bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in);
998 int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in);
999 int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in);
1000 int tb_lc_force_power(struct tb_switch *sw);
1002 static inline int tb_route_length(u64 route)
1004 return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
1008 * tb_downstream_route() - get route to downstream switch
1010 * Port must not be the upstream port (otherwise a loop is created).
1012 * Return: Returns a route to the switch behind @port.
1014 static inline u64 tb_downstream_route(struct tb_port *port)
1016 return tb_route(port->sw)
1017 | ((u64) port->port << (port->sw->config.depth * 8));
1020 bool tb_is_xdomain_enabled(void);
1021 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
1022 const void *buf, size_t size);
1023 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
1024 u64 route, const uuid_t *local_uuid,
1025 const uuid_t *remote_uuid);
1026 void tb_xdomain_add(struct tb_xdomain *xd);
1027 void tb_xdomain_remove(struct tb_xdomain *xd);
1028 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
1031 int tb_retimer_scan(struct tb_port *port, bool add);
1032 void tb_retimer_remove_all(struct tb_port *port);
1034 static inline bool tb_is_retimer(const struct device *dev)
1036 return dev->type == &tb_retimer_type;
1039 static inline struct tb_retimer *tb_to_retimer(struct device *dev)
1041 if (tb_is_retimer(dev))
1042 return container_of(dev, struct tb_retimer, dev);
1046 int usb4_switch_setup(struct tb_switch *sw);
1047 int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid);
1048 int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf,
1050 bool usb4_switch_lane_bonding_possible(struct tb_switch *sw);
1051 int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags);
1052 int usb4_switch_set_sleep(struct tb_switch *sw);
1053 int usb4_switch_nvm_sector_size(struct tb_switch *sw);
1054 int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
1056 int usb4_switch_nvm_set_offset(struct tb_switch *sw, unsigned int address);
1057 int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address,
1058 const void *buf, size_t size);
1059 int usb4_switch_nvm_authenticate(struct tb_switch *sw);
1060 int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status);
1061 int usb4_switch_credits_init(struct tb_switch *sw);
1062 bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
1063 int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1064 int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1065 struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw,
1066 const struct tb_port *port);
1067 struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw,
1068 const struct tb_port *port);
1069 int usb4_switch_add_ports(struct tb_switch *sw);
1070 void usb4_switch_remove_ports(struct tb_switch *sw);
1072 int usb4_port_unlock(struct tb_port *port);
1073 int usb4_port_hotplug_enable(struct tb_port *port);
1074 int usb4_port_configure(struct tb_port *port);
1075 void usb4_port_unconfigure(struct tb_port *port);
1076 int usb4_port_configure_xdomain(struct tb_port *port);
1077 void usb4_port_unconfigure_xdomain(struct tb_port *port);
1078 int usb4_port_router_offline(struct tb_port *port);
1079 int usb4_port_router_online(struct tb_port *port);
1080 int usb4_port_enumerate_retimers(struct tb_port *port);
1082 int usb4_port_retimer_set_inbound_sbtx(struct tb_port *port, u8 index);
1083 int usb4_port_retimer_read(struct tb_port *port, u8 index, u8 reg, void *buf,
1085 int usb4_port_retimer_write(struct tb_port *port, u8 index, u8 reg,
1086 const void *buf, u8 size);
1087 int usb4_port_retimer_is_last(struct tb_port *port, u8 index);
1088 int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index);
1089 int usb4_port_retimer_nvm_set_offset(struct tb_port *port, u8 index,
1090 unsigned int address);
1091 int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index,
1092 unsigned int address, const void *buf,
1094 int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index);
1095 int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index,
1097 int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index,
1098 unsigned int address, void *buf, size_t size);
1100 int usb4_usb3_port_max_link_rate(struct tb_port *port);
1101 int usb4_usb3_port_actual_link_rate(struct tb_port *port);
1102 int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw,
1103 int *downstream_bw);
1104 int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw,
1105 int *downstream_bw);
1106 int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw,
1107 int *downstream_bw);
1109 static inline bool tb_is_usb4_port_device(const struct device *dev)
1111 return dev->type == &usb4_port_device_type;
1114 static inline struct usb4_port *tb_to_usb4_port_device(struct device *dev)
1116 if (tb_is_usb4_port_device(dev))
1117 return container_of(dev, struct usb4_port, dev);
1121 struct usb4_port *usb4_port_device_add(struct tb_port *port);
1122 void usb4_port_device_remove(struct usb4_port *usb4);
1123 int usb4_port_device_resume(struct usb4_port *usb4);
1125 /* Keep link controller awake during update */
1126 #define QUIRK_FORCE_POWER_LINK_CONTROLLER BIT(0)
1128 void tb_check_quirks(struct tb_switch *sw);
1131 void tb_acpi_add_links(struct tb_nhi *nhi);
1133 bool tb_acpi_is_native(void);
1134 bool tb_acpi_may_tunnel_usb3(void);
1135 bool tb_acpi_may_tunnel_dp(void);
1136 bool tb_acpi_may_tunnel_pcie(void);
1137 bool tb_acpi_is_xdomain_allowed(void);
1139 int tb_acpi_init(void);
1140 void tb_acpi_exit(void);
1141 int tb_acpi_power_on_retimers(struct tb_port *port);
1142 int tb_acpi_power_off_retimers(struct tb_port *port);
1144 static inline void tb_acpi_add_links(struct tb_nhi *nhi) { }
1146 static inline bool tb_acpi_is_native(void) { return true; }
1147 static inline bool tb_acpi_may_tunnel_usb3(void) { return true; }
1148 static inline bool tb_acpi_may_tunnel_dp(void) { return true; }
1149 static inline bool tb_acpi_may_tunnel_pcie(void) { return true; }
1150 static inline bool tb_acpi_is_xdomain_allowed(void) { return true; }
1152 static inline int tb_acpi_init(void) { return 0; }
1153 static inline void tb_acpi_exit(void) { }
1154 static inline int tb_acpi_power_on_retimers(struct tb_port *port) { return 0; }
1155 static inline int tb_acpi_power_off_retimers(struct tb_port *port) { return 0; }
1158 #ifdef CONFIG_DEBUG_FS
1159 void tb_debugfs_init(void);
1160 void tb_debugfs_exit(void);
1161 void tb_switch_debugfs_init(struct tb_switch *sw);
1162 void tb_switch_debugfs_remove(struct tb_switch *sw);
1163 void tb_service_debugfs_init(struct tb_service *svc);
1164 void tb_service_debugfs_remove(struct tb_service *svc);
1166 static inline void tb_debugfs_init(void) { }
1167 static inline void tb_debugfs_exit(void) { }
1168 static inline void tb_switch_debugfs_init(struct tb_switch *sw) { }
1169 static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { }
1170 static inline void tb_service_debugfs_init(struct tb_service *svc) { }
1171 static inline void tb_service_debugfs_remove(struct tb_service *svc) { }
1174 #ifdef CONFIG_USB4_KUNIT_TEST
1175 int tb_test_init(void);
1176 void tb_test_exit(void);
1178 static inline int tb_test_init(void) { return 0; }
1179 static inline void tb_test_exit(void) { }