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>
16 #include <linux/bitfield.h>
22 /* Keep link controller awake during update */
23 #define QUIRK_FORCE_POWER_LINK_CONTROLLER BIT(0)
24 /* Disable CLx if not supported */
25 #define QUIRK_NO_CLX BIT(1)
26 /* Need to keep power on while USB4 port is in redrive mode */
27 #define QUIRK_KEEP_POWER_IN_DP_REDRIVE BIT(2)
30 * struct tb_nvm - Structure holding NVM information
31 * @dev: Owner of the NVM
32 * @major: Major version number of the active NVM portion
33 * @minor: Minor version number of the active NVM portion
34 * @id: Identifier used with both NVM portions
35 * @active: Active portion NVMem device
36 * @active_size: Size in bytes of the active NVM
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_start: Where the actual image starts after skipping
42 * @buf_data_size: Number of bytes actually consumed by the new NVM
44 * @authenticating: The device is authenticating the new NVM
45 * @flushed: The image has been flushed to the storage area
46 * @vops: Router vendor specific NVM operations (optional)
48 * The user of this structure needs to handle serialization of possible
56 struct nvmem_device *active;
58 struct nvmem_device *non_active;
64 const struct tb_nvm_vendor_ops *vops;
67 enum tb_nvm_write_ops {
68 WRITE_AND_AUTHENTICATE = 1,
70 AUTHENTICATE_ONLY = 3,
73 #define TB_SWITCH_KEY_SIZE 32
74 #define TB_SWITCH_MAX_DEPTH 6
75 #define USB4_SWITCH_MAX_DEPTH 5
78 * enum tb_switch_tmu_mode - TMU mode
79 * @TB_SWITCH_TMU_MODE_OFF: TMU is off
80 * @TB_SWITCH_TMU_MODE_LOWRES: Uni-directional, normal mode
81 * @TB_SWITCH_TMU_MODE_HIFI_UNI: Uni-directional, HiFi mode
82 * @TB_SWITCH_TMU_MODE_HIFI_BI: Bi-directional, HiFi mode
83 * @TB_SWITCH_TMU_MODE_MEDRES_ENHANCED_UNI: Enhanced Uni-directional, MedRes mode
85 * Ordering is based on TMU accuracy level (highest last).
87 enum tb_switch_tmu_mode {
88 TB_SWITCH_TMU_MODE_OFF,
89 TB_SWITCH_TMU_MODE_LOWRES,
90 TB_SWITCH_TMU_MODE_HIFI_UNI,
91 TB_SWITCH_TMU_MODE_HIFI_BI,
92 TB_SWITCH_TMU_MODE_MEDRES_ENHANCED_UNI,
96 * struct tb_switch_tmu - Structure holding router TMU configuration
97 * @cap: Offset to the TMU capability (%0 if not found)
98 * @has_ucap: Does the switch support uni-directional mode
99 * @mode: TMU mode related to the upstream router. Reflects the HW
100 * setting. Don't care for host router.
101 * @mode_request: TMU mode requested to set. Related to upstream router.
102 * Don't care for host router.
104 struct tb_switch_tmu {
107 enum tb_switch_tmu_mode mode;
108 enum tb_switch_tmu_mode mode_request;
112 * struct tb_switch - a thunderbolt switch
113 * @dev: Device for the switch
114 * @config: Switch configuration
115 * @ports: Ports in this switch
116 * @dma_port: If the switch has port supporting DMA configuration based
117 * mailbox this will hold the pointer to that (%NULL
118 * otherwise). If set it also means the switch has
120 * @tmu: The switch TMU configuration
121 * @tb: Pointer to the domain the switch belongs to
122 * @uid: Unique ID of the switch
123 * @uuid: UUID of the switch (or %NULL if not supported)
124 * @vendor: Vendor ID of the switch
125 * @device: Device ID of the switch
126 * @vendor_name: Name of the vendor (or %NULL if not known)
127 * @device_name: Name of the device (or %NULL if not known)
128 * @link_speed: Speed of the link in Gb/s
129 * @link_width: Width of the upstream facing link
130 * @preferred_link_width: Router preferred link width (only set for Gen 4 links)
131 * @link_usb4: Upstream link is USB4
132 * @generation: Switch Thunderbolt generation
133 * @cap_plug_events: Offset to the plug events capability (%0 if not found)
134 * @cap_vsec_tmu: Offset to the TMU vendor specific capability (%0 if not found)
135 * @cap_lc: Offset to the link controller capability (%0 if not found)
136 * @cap_lp: Offset to the low power (CLx for TBT) capability (%0 if not found)
137 * @is_unplugged: The switch is going away
138 * @drom: DROM of the switch (%NULL if not found)
139 * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
140 * @no_nvm_upgrade: Prevent NVM upgrade of this switch
141 * @safe_mode: The switch is in safe-mode
142 * @boot: Whether the switch was already authorized on boot or not
143 * @rpm: The switch supports runtime PM
144 * @authorized: Whether the switch is authorized by user or policy
145 * @security_level: Switch supported security level
146 * @debugfs_dir: Pointer to the debugfs structure
147 * @key: Contains the key used to challenge the device or %NULL if not
148 * supported. Size of the key is %TB_SWITCH_KEY_SIZE.
149 * @connection_id: Connection ID used with ICM messaging
150 * @connection_key: Connection key used with ICM messaging
151 * @link: Root switch link this switch is connected (ICM only)
152 * @depth: Depth in the chain this switch is connected (ICM only)
153 * @rpm_complete: Completion used to wait for runtime resume to
154 * complete (ICM only)
155 * @quirks: Quirks used for this Thunderbolt switch
156 * @credit_allocation: Are the below buffer allocation parameters valid
157 * @max_usb3_credits: Router preferred number of buffers for USB 3.x
158 * @min_dp_aux_credits: Router preferred minimum number of buffers for DP AUX
159 * @min_dp_main_credits: Router preferred minimum number of buffers for DP MAIN
160 * @max_pcie_credits: Router preferred number of buffers for PCIe
161 * @max_dma_credits: Router preferred number of buffers for DMA/P2P
162 * @clx: CLx states on the upstream link of the router
164 * When the switch is being added or removed to the domain (other
165 * switches) you need to have domain lock held.
167 * In USB4 terminology this structure represents a router.
171 struct tb_regs_switch_header config;
172 struct tb_port *ports;
173 struct tb_dma_port *dma_port;
174 struct tb_switch_tmu tmu;
180 const char *vendor_name;
181 const char *device_name;
182 unsigned int link_speed;
183 enum tb_link_width link_width;
184 enum tb_link_width preferred_link_width;
186 unsigned int generation;
198 unsigned int authorized;
199 enum tb_security_level security_level;
200 struct dentry *debugfs_dir;
206 struct completion rpm_complete;
207 unsigned long quirks;
208 bool credit_allocation;
209 unsigned int max_usb3_credits;
210 unsigned int min_dp_aux_credits;
211 unsigned int min_dp_main_credits;
212 unsigned int max_pcie_credits;
213 unsigned int max_dma_credits;
218 * struct tb_bandwidth_group - Bandwidth management group
219 * @tb: Pointer to the domain the group belongs to
220 * @index: Index of the group (aka Group_ID). Valid values %1-%7
221 * @ports: DP IN adapters belonging to this group are linked here
223 * Any tunnel that requires isochronous bandwidth (that's DP for now) is
224 * attached to a bandwidth group. All tunnels going through the same
225 * USB4 links share the same group and can dynamically distribute the
226 * bandwidth within the group.
228 struct tb_bandwidth_group {
231 struct list_head ports;
235 * struct tb_port - a thunderbolt port, part of a tb_switch
236 * @config: Cached port configuration read from registers
237 * @sw: Switch the port belongs to
238 * @remote: Remote port (%NULL if not connected)
239 * @xdomain: Remote host (%NULL if not connected)
240 * @cap_phy: Offset, zero if not found
241 * @cap_tmu: Offset of the adapter specific TMU capability (%0 if not present)
242 * @cap_adap: Offset of the adapter specific capability (%0 if not present)
243 * @cap_usb4: Offset to the USB4 port capability (%0 if not present)
244 * @usb4: Pointer to the USB4 port structure (only if @cap_usb4 is != %0)
245 * @port: Port number on switch
246 * @disabled: Disabled by eeprom or enabled but not implemented
247 * @bonded: true if the port is bonded (two lanes combined as one)
248 * @dual_link_port: If the switch is connected using two ports, points
250 * @link_nr: Is this primary or secondary port on the dual_link.
251 * @in_hopids: Currently allocated input HopIDs
252 * @out_hopids: Currently allocated output HopIDs
253 * @list: Used to link ports to DP resources list
254 * @total_credits: Total number of buffers available for this port
255 * @ctl_credits: Buffers reserved for control path
256 * @dma_credits: Number of credits allocated for DMA tunneling for all
257 * DMA paths through this port.
258 * @group: Bandwidth allocation group the adapter is assigned to. Only
259 * used for DP IN adapters for now.
260 * @group_list: The adapter is linked to the group's list of ports through this
261 * @max_bw: Maximum possible bandwidth through this adapter if set to
263 * @redrive: For DP IN, if true the adapter is in redrive mode.
265 * In USB4 terminology this structure represents an adapter (protocol or
269 struct tb_regs_port_header config;
270 struct tb_switch *sw;
271 struct tb_port *remote;
272 struct tb_xdomain *xdomain;
277 struct usb4_port *usb4;
281 struct tb_port *dual_link_port;
283 struct ida in_hopids;
284 struct ida out_hopids;
285 struct list_head list;
286 unsigned int total_credits;
287 unsigned int ctl_credits;
288 unsigned int dma_credits;
289 struct tb_bandwidth_group *group;
290 struct list_head group_list;
296 * struct usb4_port - USB4 port device
297 * @dev: Device for the port
298 * @port: Pointer to the lane 0 adapter
299 * @can_offline: Does the port have necessary platform support to moved
300 * it into offline mode and back
301 * @offline: The port is currently in offline mode
302 * @margining: Pointer to margining structure if enabled
306 struct tb_port *port;
309 #ifdef CONFIG_USB4_DEBUGFS_MARGINING
310 struct tb_margining *margining;
315 * tb_retimer: Thunderbolt retimer
316 * @dev: Device for the retimer
317 * @tb: Pointer to the domain the retimer belongs to
318 * @index: Retimer index facing the router USB4 port
319 * @vendor: Vendor ID of the retimer
320 * @device: Device ID of the retimer
321 * @port: Pointer to the lane 0 adapter
322 * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise)
323 * @no_nvm_upgrade: Prevent NVM upgrade of this retimer
324 * @auth_status: Status of last NVM authentication
332 struct tb_port *port;
339 * struct tb_path_hop - routing information for a tb_path
340 * @in_port: Ingress port of a switch
341 * @out_port: Egress port of a switch where the packet is routed out
342 * (must be on the same switch than @in_port)
343 * @in_hop_index: HopID where the path configuration entry is placed in
344 * the path config space of @in_port.
345 * @in_counter_index: Used counter index (not used in the driver
346 * currently, %-1 to disable)
347 * @next_hop_index: HopID of the packet when it is routed out from @out_port
348 * @initial_credits: Number of initial flow control credits allocated for
350 * @nfc_credits: Number of non-flow controlled buffers allocated for the
352 * @pm_support: Set path PM packet support bit to 1 (for USB4 v2 routers)
354 * Hop configuration is always done on the IN port of a switch.
355 * in_port and out_port have to be on the same switch. Packets arriving on
356 * in_port with "hop" = in_hop_index will get routed to through out_port. The
357 * next hop to take (on out_port->remote) is determined by
358 * next_hop_index. When routing packet to another switch (out->remote is
359 * set) the @next_hop_index must match the @in_hop_index of that next
360 * hop to make routing possible.
362 * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
366 struct tb_port *in_port;
367 struct tb_port *out_port;
369 int in_counter_index;
371 unsigned int initial_credits;
372 unsigned int nfc_credits;
377 * enum tb_path_port - path options mask
378 * @TB_PATH_NONE: Do not activate on any hop on path
379 * @TB_PATH_SOURCE: Activate on the first hop (out of src)
380 * @TB_PATH_INTERNAL: Activate on the intermediate hops (not the first/last)
381 * @TB_PATH_DESTINATION: Activate on the last hop (into dst)
382 * @TB_PATH_ALL: Activate on all hops on the path
387 TB_PATH_INTERNAL = 2,
388 TB_PATH_DESTINATION = 4,
393 * struct tb_path - a unidirectional path between two ports
394 * @tb: Pointer to the domain structure
395 * @name: Name of the path (used for debugging)
396 * @ingress_shared_buffer: Shared buffering used for ingress ports on the path
397 * @egress_shared_buffer: Shared buffering used for egress ports on the path
398 * @ingress_fc_enable: Flow control for ingress ports on the path
399 * @egress_fc_enable: Flow control for egress ports on the path
400 * @priority: Priority group if the path
401 * @weight: Weight of the path inside the priority group
402 * @drop_packages: Drop packages from queue tail or head
403 * @activated: Is the path active
404 * @clear_fc: Clear all flow control from the path config space entries
405 * when deactivating this path
407 * @path_length: How many hops the path uses
408 * @alloc_hopid: Does this path consume port HopID
410 * A path consists of a number of hops (see &struct tb_path_hop). To
411 * establish a PCIe tunnel two paths have to be created between the two
417 enum tb_path_port ingress_shared_buffer;
418 enum tb_path_port egress_shared_buffer;
419 enum tb_path_port ingress_fc_enable;
420 enum tb_path_port egress_fc_enable;
422 unsigned int priority:3;
427 struct tb_path_hop *hops;
432 /* HopIDs 0-7 are reserved by the Thunderbolt protocol */
433 #define TB_PATH_MIN_HOPID 8
435 * Support paths from the farthest (depth 6) router to the host and back
436 * to the same level (not necessarily to the same router).
438 #define TB_PATH_MAX_HOPS (7 * 2)
440 /* Possible wake types */
441 #define TB_WAKE_ON_CONNECT BIT(0)
442 #define TB_WAKE_ON_DISCONNECT BIT(1)
443 #define TB_WAKE_ON_USB4 BIT(2)
444 #define TB_WAKE_ON_USB3 BIT(3)
445 #define TB_WAKE_ON_PCIE BIT(4)
446 #define TB_WAKE_ON_DP BIT(5)
449 #define TB_CL0S BIT(0)
450 #define TB_CL1 BIT(1)
451 #define TB_CL2 BIT(2)
454 * struct tb_cm_ops - Connection manager specific operations vector
455 * @driver_ready: Called right after control channel is started. Used by
456 * ICM to send driver ready message to the firmware.
457 * @start: Starts the domain
458 * @stop: Stops the domain
459 * @suspend_noirq: Connection manager specific suspend_noirq
460 * @resume_noirq: Connection manager specific resume_noirq
461 * @suspend: Connection manager specific suspend
462 * @freeze_noirq: Connection manager specific freeze_noirq
463 * @thaw_noirq: Connection manager specific thaw_noirq
464 * @complete: Connection manager specific complete
465 * @runtime_suspend: Connection manager specific runtime_suspend
466 * @runtime_resume: Connection manager specific runtime_resume
467 * @runtime_suspend_switch: Runtime suspend a switch
468 * @runtime_resume_switch: Runtime resume a switch
469 * @handle_event: Handle thunderbolt event
470 * @get_boot_acl: Get boot ACL list
471 * @set_boot_acl: Set boot ACL list
472 * @disapprove_switch: Disapprove switch (disconnect PCIe tunnel)
473 * @approve_switch: Approve switch
474 * @add_switch_key: Add key to switch
475 * @challenge_switch_key: Challenge switch using key
476 * @disconnect_pcie_paths: Disconnects PCIe paths before NVM update
477 * @approve_xdomain_paths: Approve (establish) XDomain DMA paths
478 * @disconnect_xdomain_paths: Disconnect XDomain DMA paths
479 * @usb4_switch_op: Optional proxy for USB4 router operations. If set
480 * this will be called whenever USB4 router operation is
481 * performed. If this returns %-EOPNOTSUPP then the
482 * native USB4 router operation is called.
483 * @usb4_switch_nvm_authenticate_status: Optional callback that the CM
484 * implementation can be used to
485 * return status of USB4 NVM_AUTH
489 int (*driver_ready)(struct tb *tb);
490 int (*start)(struct tb *tb);
491 void (*stop)(struct tb *tb);
492 int (*suspend_noirq)(struct tb *tb);
493 int (*resume_noirq)(struct tb *tb);
494 int (*suspend)(struct tb *tb);
495 int (*freeze_noirq)(struct tb *tb);
496 int (*thaw_noirq)(struct tb *tb);
497 void (*complete)(struct tb *tb);
498 int (*runtime_suspend)(struct tb *tb);
499 int (*runtime_resume)(struct tb *tb);
500 int (*runtime_suspend_switch)(struct tb_switch *sw);
501 int (*runtime_resume_switch)(struct tb_switch *sw);
502 void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type,
503 const void *buf, size_t size);
504 int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids);
505 int (*set_boot_acl)(struct tb *tb, const uuid_t *uuids, size_t nuuids);
506 int (*disapprove_switch)(struct tb *tb, struct tb_switch *sw);
507 int (*approve_switch)(struct tb *tb, struct tb_switch *sw);
508 int (*add_switch_key)(struct tb *tb, struct tb_switch *sw);
509 int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw,
510 const u8 *challenge, u8 *response);
511 int (*disconnect_pcie_paths)(struct tb *tb);
512 int (*approve_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd,
513 int transmit_path, int transmit_ring,
514 int receive_path, int receive_ring);
515 int (*disconnect_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd,
516 int transmit_path, int transmit_ring,
517 int receive_path, int receive_ring);
518 int (*usb4_switch_op)(struct tb_switch *sw, u16 opcode, u32 *metadata,
519 u8 *status, const void *tx_data, size_t tx_data_len,
520 void *rx_data, size_t rx_data_len);
521 int (*usb4_switch_nvm_authenticate_status)(struct tb_switch *sw,
525 static inline void *tb_priv(struct tb *tb)
527 return (void *)tb->privdata;
530 #define TB_AUTOSUSPEND_DELAY 15000 /* ms */
532 /* helper functions & macros */
535 * tb_upstream_port() - return the upstream port of a switch
537 * Every switch has an upstream port (for the root switch it is the NHI).
539 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for
540 * non root switches (on the NHI port remote is always NULL).
542 * Return: Returns the upstream port of the switch.
544 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw)
546 return &sw->ports[sw->config.upstream_port_number];
550 * tb_is_upstream_port() - Is the port upstream facing
551 * @port: Port to check
553 * Returns true if @port is upstream facing port. In case of dual link
554 * ports both return true.
556 static inline bool tb_is_upstream_port(const struct tb_port *port)
558 const struct tb_port *upstream_port = tb_upstream_port(port->sw);
559 return port == upstream_port || port->dual_link_port == upstream_port;
562 static inline u64 tb_route(const struct tb_switch *sw)
564 return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo;
567 static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw)
571 port = route >> (sw->config.depth * 8);
572 if (WARN_ON(port > sw->config.max_port_number))
574 return &sw->ports[port];
577 static inline const char *tb_width_name(enum tb_link_width width)
580 case TB_LINK_WIDTH_SINGLE:
581 return "symmetric, single lane";
582 case TB_LINK_WIDTH_DUAL:
583 return "symmetric, dual lanes";
584 case TB_LINK_WIDTH_ASYM_TX:
585 return "asymmetric, 3 transmitters, 1 receiver";
586 case TB_LINK_WIDTH_ASYM_RX:
587 return "asymmetric, 3 receivers, 1 transmitter";
594 * tb_port_has_remote() - Does the port have switch connected downstream
595 * @port: Port to check
597 * Returns true only when the port is primary port and has remote set.
599 static inline bool tb_port_has_remote(const struct tb_port *port)
601 if (tb_is_upstream_port(port))
605 if (port->dual_link_port && port->link_nr)
611 static inline bool tb_port_is_null(const struct tb_port *port)
613 return port && port->port && port->config.type == TB_TYPE_PORT;
616 static inline bool tb_port_is_nhi(const struct tb_port *port)
618 return port && port->config.type == TB_TYPE_NHI;
621 static inline bool tb_port_is_pcie_down(const struct tb_port *port)
623 return port && port->config.type == TB_TYPE_PCIE_DOWN;
626 static inline bool tb_port_is_pcie_up(const struct tb_port *port)
628 return port && port->config.type == TB_TYPE_PCIE_UP;
631 static inline bool tb_port_is_dpin(const struct tb_port *port)
633 return port && port->config.type == TB_TYPE_DP_HDMI_IN;
636 static inline bool tb_port_is_dpout(const struct tb_port *port)
638 return port && port->config.type == TB_TYPE_DP_HDMI_OUT;
641 static inline bool tb_port_is_usb3_down(const struct tb_port *port)
643 return port && port->config.type == TB_TYPE_USB3_DOWN;
646 static inline bool tb_port_is_usb3_up(const struct tb_port *port)
648 return port && port->config.type == TB_TYPE_USB3_UP;
651 static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
652 enum tb_cfg_space space, u32 offset, u32 length)
654 if (sw->is_unplugged)
656 return tb_cfg_read(sw->tb->ctl,
665 static inline int tb_sw_write(struct tb_switch *sw, const void *buffer,
666 enum tb_cfg_space space, u32 offset, u32 length)
668 if (sw->is_unplugged)
670 return tb_cfg_write(sw->tb->ctl,
679 static inline int tb_port_read(struct tb_port *port, void *buffer,
680 enum tb_cfg_space space, u32 offset, u32 length)
682 if (port->sw->is_unplugged)
684 return tb_cfg_read(port->sw->tb->ctl,
693 static inline int tb_port_write(struct tb_port *port, const void *buffer,
694 enum tb_cfg_space space, u32 offset, u32 length)
696 if (port->sw->is_unplugged)
698 return tb_cfg_write(port->sw->tb->ctl,
707 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg)
708 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
709 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
710 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
711 #define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg)
713 #define __TB_SW_PRINT(level, sw, fmt, arg...) \
715 const struct tb_switch *__sw = (sw); \
716 level(__sw->tb, "%llx: " fmt, \
717 tb_route(__sw), ## arg); \
719 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
720 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
721 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
722 #define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg)
724 #define __TB_PORT_PRINT(level, _port, fmt, arg...) \
726 const struct tb_port *__port = (_port); \
727 level(__port->sw->tb, "%llx:%u: " fmt, \
728 tb_route(__port->sw), __port->port, ## arg); \
730 #define tb_port_WARN(port, fmt, arg...) \
731 __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg)
732 #define tb_port_warn(port, fmt, arg...) \
733 __TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
734 #define tb_port_info(port, fmt, arg...) \
735 __TB_PORT_PRINT(tb_info, port, fmt, ##arg)
736 #define tb_port_dbg(port, fmt, arg...) \
737 __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg)
739 struct tb *icm_probe(struct tb_nhi *nhi);
740 struct tb *tb_probe(struct tb_nhi *nhi);
742 extern struct device_type tb_domain_type;
743 extern struct device_type tb_retimer_type;
744 extern struct device_type tb_switch_type;
745 extern struct device_type usb4_port_device_type;
747 int tb_domain_init(void);
748 void tb_domain_exit(void);
749 int tb_xdomain_init(void);
750 void tb_xdomain_exit(void);
752 struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize);
753 int tb_domain_add(struct tb *tb);
754 void tb_domain_remove(struct tb *tb);
755 int tb_domain_suspend_noirq(struct tb *tb);
756 int tb_domain_resume_noirq(struct tb *tb);
757 int tb_domain_suspend(struct tb *tb);
758 int tb_domain_freeze_noirq(struct tb *tb);
759 int tb_domain_thaw_noirq(struct tb *tb);
760 void tb_domain_complete(struct tb *tb);
761 int tb_domain_runtime_suspend(struct tb *tb);
762 int tb_domain_runtime_resume(struct tb *tb);
763 int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw);
764 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw);
765 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw);
766 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw);
767 int tb_domain_disconnect_pcie_paths(struct tb *tb);
768 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
769 int transmit_path, int transmit_ring,
770 int receive_path, int receive_ring);
771 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
772 int transmit_path, int transmit_ring,
773 int receive_path, int receive_ring);
774 int tb_domain_disconnect_all_paths(struct tb *tb);
776 static inline struct tb *tb_domain_get(struct tb *tb)
779 get_device(&tb->dev);
783 static inline void tb_domain_put(struct tb *tb)
785 put_device(&tb->dev);
788 struct tb_nvm *tb_nvm_alloc(struct device *dev);
789 int tb_nvm_read_version(struct tb_nvm *nvm);
790 int tb_nvm_validate(struct tb_nvm *nvm);
791 int tb_nvm_write_headers(struct tb_nvm *nvm);
792 int tb_nvm_add_active(struct tb_nvm *nvm, nvmem_reg_read_t reg_read);
793 int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val,
795 int tb_nvm_add_non_active(struct tb_nvm *nvm, nvmem_reg_write_t reg_write);
796 void tb_nvm_free(struct tb_nvm *nvm);
797 void tb_nvm_exit(void);
799 typedef int (*read_block_fn)(void *, unsigned int, void *, size_t);
800 typedef int (*write_block_fn)(void *, unsigned int, const void *, size_t);
802 int tb_nvm_read_data(unsigned int address, void *buf, size_t size,
803 unsigned int retries, read_block_fn read_block,
804 void *read_block_data);
805 int tb_nvm_write_data(unsigned int address, const void *buf, size_t size,
806 unsigned int retries, write_block_fn write_next_block,
807 void *write_block_data);
809 int tb_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
811 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
813 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb,
814 struct device *parent, u64 route);
815 int tb_switch_configure(struct tb_switch *sw);
816 int tb_switch_configuration_valid(struct tb_switch *sw);
817 int tb_switch_add(struct tb_switch *sw);
818 void tb_switch_remove(struct tb_switch *sw);
819 void tb_switch_suspend(struct tb_switch *sw, bool runtime);
820 int tb_switch_resume(struct tb_switch *sw);
821 int tb_switch_reset(struct tb_switch *sw);
822 int tb_switch_wait_for_bit(struct tb_switch *sw, u32 offset, u32 bit,
823 u32 value, int timeout_msec);
824 void tb_sw_set_unplugged(struct tb_switch *sw);
825 struct tb_port *tb_switch_find_port(struct tb_switch *sw,
826 enum tb_port_type type);
827 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
829 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
830 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route);
833 * tb_switch_for_each_port() - Iterate over each switch port
834 * @sw: Switch whose ports to iterate
835 * @p: Port used as iterator
837 * Iterates over each switch port skipping the control port (port %0).
839 #define tb_switch_for_each_port(sw, p) \
840 for ((p) = &(sw)->ports[1]; \
841 (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++)
843 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw)
846 get_device(&sw->dev);
850 static inline void tb_switch_put(struct tb_switch *sw)
852 put_device(&sw->dev);
855 static inline bool tb_is_switch(const struct device *dev)
857 return dev->type == &tb_switch_type;
860 static inline struct tb_switch *tb_to_switch(const struct device *dev)
862 if (tb_is_switch(dev))
863 return container_of(dev, struct tb_switch, dev);
867 static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw)
869 return tb_to_switch(sw->dev.parent);
873 * tb_switch_downstream_port() - Return downstream facing port of parent router
874 * @sw: Device router pointer
876 * Only call for device routers. Returns the downstream facing port of
879 static inline struct tb_port *tb_switch_downstream_port(struct tb_switch *sw)
881 if (WARN_ON(!tb_route(sw)))
883 return tb_port_at(tb_route(sw), tb_switch_parent(sw));
887 * tb_switch_depth() - Returns depth of the connected router
890 static inline int tb_switch_depth(const struct tb_switch *sw)
892 return sw->config.depth;
895 static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw)
897 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
898 sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE;
901 static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw)
903 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
904 sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE;
907 static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw)
909 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
910 switch (sw->config.device_id) {
911 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
912 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
919 static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw)
921 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
922 switch (sw->config.device_id) {
923 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
924 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
931 static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw)
933 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
934 switch (sw->config.device_id) {
935 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
936 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE:
937 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
938 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
939 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
946 static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw)
948 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
949 switch (sw->config.device_id) {
950 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
951 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
952 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
959 static inline bool tb_switch_is_tiger_lake(const struct tb_switch *sw)
961 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
962 switch (sw->config.device_id) {
963 case PCI_DEVICE_ID_INTEL_TGL_NHI0:
964 case PCI_DEVICE_ID_INTEL_TGL_NHI1:
965 case PCI_DEVICE_ID_INTEL_TGL_H_NHI0:
966 case PCI_DEVICE_ID_INTEL_TGL_H_NHI1:
974 * tb_switch_is_icm() - Is the switch handled by ICM firmware
975 * @sw: Switch to check
977 * In case there is a need to differentiate whether ICM firmware or SW CM
978 * is handling @sw this function can be called. It is valid to call this
979 * after tb_switch_alloc() and tb_switch_configure() has been called
980 * (latter only for SW CM case).
982 static inline bool tb_switch_is_icm(const struct tb_switch *sw)
984 return !sw->config.enabled;
987 int tb_switch_set_link_width(struct tb_switch *sw, enum tb_link_width width);
988 int tb_switch_configure_link(struct tb_switch *sw);
989 void tb_switch_unconfigure_link(struct tb_switch *sw);
991 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
992 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
993 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
995 int tb_switch_tmu_init(struct tb_switch *sw);
996 int tb_switch_tmu_post_time(struct tb_switch *sw);
997 int tb_switch_tmu_disable(struct tb_switch *sw);
998 int tb_switch_tmu_enable(struct tb_switch *sw);
999 int tb_switch_tmu_configure(struct tb_switch *sw, enum tb_switch_tmu_mode mode);
1002 * tb_switch_tmu_is_configured() - Is given TMU mode configured
1003 * @sw: Router whose mode to check
1004 * @mode: Mode to check
1006 * Checks if given router TMU mode is configured to @mode. Note the
1007 * router TMU might not be enabled to this mode.
1009 static inline bool tb_switch_tmu_is_configured(const struct tb_switch *sw,
1010 enum tb_switch_tmu_mode mode)
1012 return sw->tmu.mode_request == mode;
1016 * tb_switch_tmu_is_enabled() - Checks if the specified TMU mode is enabled
1017 * @sw: Router whose TMU mode to check
1019 * Return true if hardware TMU configuration matches the requested
1020 * configuration (and is not %TB_SWITCH_TMU_MODE_OFF).
1022 static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw)
1024 return sw->tmu.mode != TB_SWITCH_TMU_MODE_OFF &&
1025 sw->tmu.mode == sw->tmu.mode_request;
1028 bool tb_port_clx_is_enabled(struct tb_port *port, unsigned int clx);
1030 int tb_switch_clx_init(struct tb_switch *sw);
1031 int tb_switch_clx_enable(struct tb_switch *sw, unsigned int clx);
1032 int tb_switch_clx_disable(struct tb_switch *sw);
1035 * tb_switch_clx_is_enabled() - Checks if the CLx is enabled
1036 * @sw: Router to check for the CLx
1037 * @clx: The CLx states to check for
1039 * Checks if the specified CLx is enabled on the router upstream link.
1040 * Returns true if any of the given states is enabled.
1042 * Not applicable for a host router.
1044 static inline bool tb_switch_clx_is_enabled(const struct tb_switch *sw,
1047 return sw->clx & clx;
1050 int tb_switch_pcie_l1_enable(struct tb_switch *sw);
1052 int tb_switch_xhci_connect(struct tb_switch *sw);
1053 void tb_switch_xhci_disconnect(struct tb_switch *sw);
1055 int tb_port_state(struct tb_port *port);
1056 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
1057 int tb_port_add_nfc_credits(struct tb_port *port, int credits);
1058 int tb_port_clear_counter(struct tb_port *port, int counter);
1059 int tb_port_unlock(struct tb_port *port);
1060 int tb_port_enable(struct tb_port *port);
1061 int tb_port_disable(struct tb_port *port);
1062 int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid);
1063 void tb_port_release_in_hopid(struct tb_port *port, int hopid);
1064 int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid);
1065 void tb_port_release_out_hopid(struct tb_port *port, int hopid);
1066 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
1067 struct tb_port *prev);
1070 * tb_port_path_direction_downstream() - Checks if path directed downstream
1071 * @src: Source adapter
1072 * @dst: Destination adapter
1074 * Returns %true only if the specified path from source adapter (@src)
1075 * to destination adapter (@dst) is directed downstream.
1078 tb_port_path_direction_downstream(const struct tb_port *src,
1079 const struct tb_port *dst)
1081 return src->sw->config.depth < dst->sw->config.depth;
1084 static inline bool tb_port_use_credit_allocation(const struct tb_port *port)
1086 return tb_port_is_null(port) && port->sw->credit_allocation;
1090 * tb_for_each_port_on_path() - Iterate over each port on path
1092 * @dst: Destination port
1093 * @p: Port used as iterator
1095 * Walks over each port on path from @src to @dst.
1097 #define tb_for_each_port_on_path(src, dst, p) \
1098 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \
1099 (p) = tb_next_port_on_path((src), (dst), (p)))
1102 * tb_for_each_upstream_port_on_path() - Iterate over each upstreamm port on path
1104 * @dst: Destination port
1105 * @p: Port used as iterator
1107 * Walks over each upstream lane adapter on path from @src to @dst.
1109 #define tb_for_each_upstream_port_on_path(src, dst, p) \
1110 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \
1111 (p) = tb_next_port_on_path((src), (dst), (p))) \
1112 if (!tb_port_is_null((p)) || !tb_is_upstream_port((p))) {\
1116 int tb_port_get_link_speed(struct tb_port *port);
1117 int tb_port_get_link_generation(struct tb_port *port);
1118 int tb_port_get_link_width(struct tb_port *port);
1119 bool tb_port_width_supported(struct tb_port *port, unsigned int width);
1120 int tb_port_set_link_width(struct tb_port *port, enum tb_link_width width);
1121 int tb_port_lane_bonding_enable(struct tb_port *port);
1122 void tb_port_lane_bonding_disable(struct tb_port *port);
1123 int tb_port_wait_for_link_width(struct tb_port *port, unsigned int width,
1125 int tb_port_update_credits(struct tb_port *port);
1127 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
1128 int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap);
1129 int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset);
1130 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
1131 int tb_port_next_cap(struct tb_port *port, unsigned int offset);
1132 bool tb_port_is_enabled(struct tb_port *port);
1134 bool tb_usb3_port_is_enabled(struct tb_port *port);
1135 int tb_usb3_port_enable(struct tb_port *port, bool enable);
1137 bool tb_pci_port_is_enabled(struct tb_port *port);
1138 int tb_pci_port_enable(struct tb_port *port, bool enable);
1140 int tb_dp_port_hpd_is_active(struct tb_port *port);
1141 int tb_dp_port_hpd_clear(struct tb_port *port);
1142 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
1143 unsigned int aux_tx, unsigned int aux_rx);
1144 bool tb_dp_port_is_enabled(struct tb_port *port);
1145 int tb_dp_port_enable(struct tb_port *port, bool enable);
1147 struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid,
1148 struct tb_port *dst, int dst_hopid,
1149 struct tb_port **last, const char *name,
1151 struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid,
1152 struct tb_port *dst, int dst_hopid, int link_nr,
1154 void tb_path_free(struct tb_path *path);
1155 int tb_path_activate(struct tb_path *path);
1156 void tb_path_deactivate(struct tb_path *path);
1157 bool tb_path_is_invalid(struct tb_path *path);
1158 bool tb_path_port_on_path(const struct tb_path *path,
1159 const struct tb_port *port);
1162 * tb_path_for_each_hop() - Iterate over each hop on path
1163 * @path: Path whose hops to iterate
1164 * @hop: Hop used as iterator
1166 * Iterates over each hop on path.
1168 #define tb_path_for_each_hop(path, hop) \
1169 for ((hop) = &(path)->hops[0]; \
1170 (hop) <= &(path)->hops[(path)->path_length - 1]; (hop)++)
1172 int tb_drom_read(struct tb_switch *sw);
1173 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
1175 int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid);
1176 int tb_lc_configure_port(struct tb_port *port);
1177 void tb_lc_unconfigure_port(struct tb_port *port);
1178 int tb_lc_configure_xdomain(struct tb_port *port);
1179 void tb_lc_unconfigure_xdomain(struct tb_port *port);
1180 int tb_lc_start_lane_initialization(struct tb_port *port);
1181 bool tb_lc_is_clx_supported(struct tb_port *port);
1182 bool tb_lc_is_usb_plugged(struct tb_port *port);
1183 bool tb_lc_is_xhci_connected(struct tb_port *port);
1184 int tb_lc_xhci_connect(struct tb_port *port);
1185 void tb_lc_xhci_disconnect(struct tb_port *port);
1186 int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags);
1187 int tb_lc_set_sleep(struct tb_switch *sw);
1188 bool tb_lc_lane_bonding_possible(struct tb_switch *sw);
1189 bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in);
1190 int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in);
1191 int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in);
1192 int tb_lc_force_power(struct tb_switch *sw);
1194 static inline int tb_route_length(u64 route)
1196 return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
1200 * tb_downstream_route() - get route to downstream switch
1202 * Port must not be the upstream port (otherwise a loop is created).
1204 * Return: Returns a route to the switch behind @port.
1206 static inline u64 tb_downstream_route(struct tb_port *port)
1208 return tb_route(port->sw)
1209 | ((u64) port->port << (port->sw->config.depth * 8));
1212 bool tb_is_xdomain_enabled(void);
1213 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
1214 const void *buf, size_t size);
1215 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
1216 u64 route, const uuid_t *local_uuid,
1217 const uuid_t *remote_uuid);
1218 void tb_xdomain_add(struct tb_xdomain *xd);
1219 void tb_xdomain_remove(struct tb_xdomain *xd);
1220 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
1223 static inline struct tb_switch *tb_xdomain_parent(struct tb_xdomain *xd)
1225 return tb_to_switch(xd->dev.parent);
1229 * tb_xdomain_downstream_port() - Return downstream facing port of parent router
1230 * @xd: Xdomain pointer
1232 * Returns the downstream port the XDomain is connected to.
1234 static inline struct tb_port *tb_xdomain_downstream_port(struct tb_xdomain *xd)
1236 return tb_port_at(xd->route, tb_xdomain_parent(xd));
1239 int tb_retimer_nvm_read(struct tb_retimer *rt, unsigned int address, void *buf,
1241 int tb_retimer_scan(struct tb_port *port, bool add);
1242 void tb_retimer_remove_all(struct tb_port *port);
1244 static inline bool tb_is_retimer(const struct device *dev)
1246 return dev->type == &tb_retimer_type;
1249 static inline struct tb_retimer *tb_to_retimer(struct device *dev)
1251 if (tb_is_retimer(dev))
1252 return container_of(dev, struct tb_retimer, dev);
1257 * usb4_switch_version() - Returns USB4 version of the router
1258 * @sw: Router to check
1260 * Returns major version of USB4 router (%1 for v1, %2 for v2 and so
1261 * on). Can be called to pre-USB4 router too and in that case returns %0.
1263 static inline unsigned int usb4_switch_version(const struct tb_switch *sw)
1265 return FIELD_GET(USB4_VERSION_MAJOR_MASK, sw->config.thunderbolt_version);
1269 * tb_switch_is_usb4() - Is the switch USB4 compliant
1270 * @sw: Switch to check
1272 * Returns true if the @sw is USB4 compliant router, false otherwise.
1274 static inline bool tb_switch_is_usb4(const struct tb_switch *sw)
1276 return usb4_switch_version(sw) > 0;
1279 int usb4_switch_setup(struct tb_switch *sw);
1280 int usb4_switch_configuration_valid(struct tb_switch *sw);
1281 int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid);
1282 int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf,
1284 bool usb4_switch_lane_bonding_possible(struct tb_switch *sw);
1285 int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags);
1286 int usb4_switch_set_sleep(struct tb_switch *sw);
1287 int usb4_switch_nvm_sector_size(struct tb_switch *sw);
1288 int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
1290 int usb4_switch_nvm_set_offset(struct tb_switch *sw, unsigned int address);
1291 int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address,
1292 const void *buf, size_t size);
1293 int usb4_switch_nvm_authenticate(struct tb_switch *sw);
1294 int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status);
1295 int usb4_switch_credits_init(struct tb_switch *sw);
1296 bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
1297 int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1298 int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1299 struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw,
1300 const struct tb_port *port);
1301 struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw,
1302 const struct tb_port *port);
1303 int usb4_switch_add_ports(struct tb_switch *sw);
1304 void usb4_switch_remove_ports(struct tb_switch *sw);
1306 int usb4_port_unlock(struct tb_port *port);
1307 int usb4_port_hotplug_enable(struct tb_port *port);
1308 int usb4_port_configure(struct tb_port *port);
1309 void usb4_port_unconfigure(struct tb_port *port);
1310 int usb4_port_configure_xdomain(struct tb_port *port, struct tb_xdomain *xd);
1311 void usb4_port_unconfigure_xdomain(struct tb_port *port);
1312 int usb4_port_router_offline(struct tb_port *port);
1313 int usb4_port_router_online(struct tb_port *port);
1314 int usb4_port_enumerate_retimers(struct tb_port *port);
1315 bool usb4_port_clx_supported(struct tb_port *port);
1316 int usb4_port_margining_caps(struct tb_port *port, u32 *caps);
1318 bool usb4_port_asym_supported(struct tb_port *port);
1319 int usb4_port_asym_set_link_width(struct tb_port *port, enum tb_link_width width);
1320 int usb4_port_asym_start(struct tb_port *port);
1322 int usb4_port_hw_margin(struct tb_port *port, unsigned int lanes,
1323 unsigned int ber_level, bool timing, bool right_high,
1325 int usb4_port_sw_margin(struct tb_port *port, unsigned int lanes, bool timing,
1326 bool right_high, u32 counter);
1327 int usb4_port_sw_margin_errors(struct tb_port *port, u32 *errors);
1329 int usb4_port_retimer_set_inbound_sbtx(struct tb_port *port, u8 index);
1330 int usb4_port_retimer_unset_inbound_sbtx(struct tb_port *port, u8 index);
1331 int usb4_port_retimer_read(struct tb_port *port, u8 index, u8 reg, void *buf,
1333 int usb4_port_retimer_write(struct tb_port *port, u8 index, u8 reg,
1334 const void *buf, u8 size);
1335 int usb4_port_retimer_is_last(struct tb_port *port, u8 index);
1336 int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index);
1337 int usb4_port_retimer_nvm_set_offset(struct tb_port *port, u8 index,
1338 unsigned int address);
1339 int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index,
1340 unsigned int address, const void *buf,
1342 int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index);
1343 int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index,
1345 int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index,
1346 unsigned int address, void *buf, size_t size);
1348 int usb4_usb3_port_max_link_rate(struct tb_port *port);
1349 int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw,
1350 int *downstream_bw);
1351 int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw,
1352 int *downstream_bw);
1353 int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw,
1354 int *downstream_bw);
1356 int usb4_dp_port_set_cm_id(struct tb_port *port, int cm_id);
1357 bool usb4_dp_port_bandwidth_mode_supported(struct tb_port *port);
1358 bool usb4_dp_port_bandwidth_mode_enabled(struct tb_port *port);
1359 int usb4_dp_port_set_cm_bandwidth_mode_supported(struct tb_port *port,
1361 int usb4_dp_port_group_id(struct tb_port *port);
1362 int usb4_dp_port_set_group_id(struct tb_port *port, int group_id);
1363 int usb4_dp_port_nrd(struct tb_port *port, int *rate, int *lanes);
1364 int usb4_dp_port_set_nrd(struct tb_port *port, int rate, int lanes);
1365 int usb4_dp_port_granularity(struct tb_port *port);
1366 int usb4_dp_port_set_granularity(struct tb_port *port, int granularity);
1367 int usb4_dp_port_set_estimated_bandwidth(struct tb_port *port, int bw);
1368 int usb4_dp_port_allocated_bandwidth(struct tb_port *port);
1369 int usb4_dp_port_allocate_bandwidth(struct tb_port *port, int bw);
1370 int usb4_dp_port_requested_bandwidth(struct tb_port *port);
1372 int usb4_pci_port_set_ext_encapsulation(struct tb_port *port, bool enable);
1374 static inline bool tb_is_usb4_port_device(const struct device *dev)
1376 return dev->type == &usb4_port_device_type;
1379 static inline struct usb4_port *tb_to_usb4_port_device(struct device *dev)
1381 if (tb_is_usb4_port_device(dev))
1382 return container_of(dev, struct usb4_port, dev);
1386 struct usb4_port *usb4_port_device_add(struct tb_port *port);
1387 void usb4_port_device_remove(struct usb4_port *usb4);
1388 int usb4_port_device_resume(struct usb4_port *usb4);
1390 static inline bool usb4_port_device_is_offline(const struct usb4_port *usb4)
1392 return usb4->offline;
1395 void tb_check_quirks(struct tb_switch *sw);
1398 bool tb_acpi_add_links(struct tb_nhi *nhi);
1400 bool tb_acpi_is_native(void);
1401 bool tb_acpi_may_tunnel_usb3(void);
1402 bool tb_acpi_may_tunnel_dp(void);
1403 bool tb_acpi_may_tunnel_pcie(void);
1404 bool tb_acpi_is_xdomain_allowed(void);
1406 int tb_acpi_init(void);
1407 void tb_acpi_exit(void);
1408 int tb_acpi_power_on_retimers(struct tb_port *port);
1409 int tb_acpi_power_off_retimers(struct tb_port *port);
1411 static inline bool tb_acpi_add_links(struct tb_nhi *nhi) { return false; }
1413 static inline bool tb_acpi_is_native(void) { return true; }
1414 static inline bool tb_acpi_may_tunnel_usb3(void) { return true; }
1415 static inline bool tb_acpi_may_tunnel_dp(void) { return true; }
1416 static inline bool tb_acpi_may_tunnel_pcie(void) { return true; }
1417 static inline bool tb_acpi_is_xdomain_allowed(void) { return true; }
1419 static inline int tb_acpi_init(void) { return 0; }
1420 static inline void tb_acpi_exit(void) { }
1421 static inline int tb_acpi_power_on_retimers(struct tb_port *port) { return 0; }
1422 static inline int tb_acpi_power_off_retimers(struct tb_port *port) { return 0; }
1425 #ifdef CONFIG_DEBUG_FS
1426 void tb_debugfs_init(void);
1427 void tb_debugfs_exit(void);
1428 void tb_switch_debugfs_init(struct tb_switch *sw);
1429 void tb_switch_debugfs_remove(struct tb_switch *sw);
1430 void tb_xdomain_debugfs_init(struct tb_xdomain *xd);
1431 void tb_xdomain_debugfs_remove(struct tb_xdomain *xd);
1432 void tb_service_debugfs_init(struct tb_service *svc);
1433 void tb_service_debugfs_remove(struct tb_service *svc);
1435 static inline void tb_debugfs_init(void) { }
1436 static inline void tb_debugfs_exit(void) { }
1437 static inline void tb_switch_debugfs_init(struct tb_switch *sw) { }
1438 static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { }
1439 static inline void tb_xdomain_debugfs_init(struct tb_xdomain *xd) { }
1440 static inline void tb_xdomain_debugfs_remove(struct tb_xdomain *xd) { }
1441 static inline void tb_service_debugfs_init(struct tb_service *svc) { }
1442 static inline void tb_service_debugfs_remove(struct tb_service *svc) { }