FILE
tb.h
File preview with syntax highlighting.
linux-6.19.14/drivers/thunderbolt/tb.h
1/* SPDX-License-Identifier: GPL-2.0 */ 2/* 3 * Thunderbolt driver - bus logic (NHI independent) 4 * 5 * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com> 6 * Copyright (C) 2018, Intel Corporation 7 */ 8 9#ifndef TB_H_ 10#define TB_H_ 11 12#include <linux/debugfs.h> 13#include <linux/nvmem-provider.h> 14#include <linux/pci.h> 15#include <linux/thunderbolt.h> 16#include <linux/uuid.h> 17#include <linux/bitfield.h> 18 19#include "tb_regs.h" 20#include "ctl.h" 21#include "dma_port.h" 22 23/* Keep link controller awake during update */ 24#define QUIRK_FORCE_POWER_LINK_CONTROLLER BIT(0) 25/* Disable CLx if not supported */ 26#define QUIRK_NO_CLX BIT(1) 27/* Need to keep power on while USB4 port is in redrive mode */ 28#define QUIRK_KEEP_POWER_IN_DP_REDRIVE BIT(2) 29 30/** 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 * @active_size: Size in bytes of the active NVM 38 * @non_active: Non-active portion NVMem device 39 * @buf: Buffer where the NVM image is stored before it is written to 40 * the actual NVM flash device 41 * @buf_data_start: Where the actual image starts after skipping 42 * possible headers 43 * @buf_data_size: Number of bytes actually consumed by the new NVM 44 * image 45 * @authenticating: The device is authenticating the new NVM 46 * @flushed: The image has been flushed to the storage area 47 * @vops: Router vendor specific NVM operations (optional) 48 * 49 * The user of this structure needs to handle serialization of possible 50 * concurrent access. 51 */ 52struct tb_nvm { 53 struct device *dev; 54 u32 major; 55 u32 minor; 56 int id; 57 struct nvmem_device *active; 58 size_t active_size; 59 struct nvmem_device *non_active; 60 void *buf; 61 void *buf_data_start; 62 size_t buf_data_size; 63 bool authenticating; 64 bool flushed; 65 const struct tb_nvm_vendor_ops *vops; 66}; 67 68enum tb_nvm_write_ops { 69 WRITE_AND_AUTHENTICATE = 1, 70 WRITE_ONLY = 2, 71 AUTHENTICATE_ONLY = 3, 72}; 73 74#define TB_SWITCH_KEY_SIZE 32 75#define TB_SWITCH_MAX_DEPTH 6 76#define USB4_SWITCH_MAX_DEPTH 5 77 78/** 79 * enum tb_switch_tmu_mode - TMU mode 80 * @TB_SWITCH_TMU_MODE_OFF: TMU is off 81 * @TB_SWITCH_TMU_MODE_LOWRES: Uni-directional, normal mode 82 * @TB_SWITCH_TMU_MODE_HIFI_UNI: Uni-directional, HiFi mode 83 * @TB_SWITCH_TMU_MODE_HIFI_BI: Bi-directional, HiFi mode 84 * @TB_SWITCH_TMU_MODE_MEDRES_ENHANCED_UNI: Enhanced Uni-directional, MedRes mode 85 * 86 * Ordering is based on TMU accuracy level (highest last). 87 */ 88enum tb_switch_tmu_mode { 89 TB_SWITCH_TMU_MODE_OFF, 90 TB_SWITCH_TMU_MODE_LOWRES, 91 TB_SWITCH_TMU_MODE_HIFI_UNI, 92 TB_SWITCH_TMU_MODE_HIFI_BI, 93 TB_SWITCH_TMU_MODE_MEDRES_ENHANCED_UNI, 94}; 95 96/** 97 * struct tb_switch_tmu - Structure holding router TMU configuration 98 * @cap: Offset to the TMU capability (%0 if not found) 99 * @has_ucap: Does the switch support uni-directional mode 100 * @mode: TMU mode related to the upstream router. Reflects the HW 101 * setting. Don't care for host router. 102 * @mode_request: TMU mode requested to set. Related to upstream router. 103 * Don't care for host router. 104 */ 105struct tb_switch_tmu { 106 int cap; 107 bool has_ucap; 108 enum tb_switch_tmu_mode mode; 109 enum tb_switch_tmu_mode mode_request; 110}; 111 112/** 113 * struct tb_switch - a thunderbolt switch 114 * @dev: Device for the switch 115 * @config: Switch configuration 116 * @ports: Ports in this switch 117 * @dma_port: If the switch has port supporting DMA configuration based 118 * mailbox this will hold the pointer to that (%NULL 119 * otherwise). If set it also means the switch has 120 * upgradeable NVM. 121 * @tmu: The switch TMU configuration 122 * @tb: Pointer to the domain the switch belongs to 123 * @uid: Unique ID of the switch 124 * @uuid: UUID of the switch (or %NULL if not supported) 125 * @vendor: Vendor ID of the switch 126 * @device: Device ID of the switch 127 * @vendor_name: Name of the vendor (or %NULL if not known) 128 * @device_name: Name of the device (or %NULL if not known) 129 * @link_speed: Speed of the link in Gb/s 130 * @link_width: Width of the upstream facing link 131 * @preferred_link_width: Router preferred link width (only set for Gen 4 links) 132 * @link_usb4: Upstream link is USB4 133 * @generation: Switch Thunderbolt generation 134 * @cap_plug_events: Offset to the plug events capability (%0 if not found) 135 * @cap_vsec_tmu: Offset to the TMU vendor specific capability (%0 if not found) 136 * @cap_lc: Offset to the link controller capability (%0 if not found) 137 * @cap_lp: Offset to the low power (CLx for TBT) capability (%0 if not found) 138 * @is_unplugged: The switch is going away 139 * @drom: DROM of the switch (%NULL if not found) 140 * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise) 141 * @no_nvm_upgrade: Prevent NVM upgrade of this switch 142 * @safe_mode: The switch is in safe-mode 143 * @boot: Whether the switch was already authorized on boot or not 144 * @rpm: The switch supports runtime PM 145 * @authorized: Whether the switch is authorized by user or policy 146 * @security_level: Switch supported security level 147 * @debugfs_dir: Pointer to the debugfs structure 148 * @key: Contains the key used to challenge the device or %NULL if not 149 * supported. Size of the key is %TB_SWITCH_KEY_SIZE. 150 * @connection_id: Connection ID used with ICM messaging 151 * @connection_key: Connection key used with ICM messaging 152 * @link: Root switch link this switch is connected (ICM only) 153 * @depth: Depth in the chain this switch is connected (ICM only) 154 * @rpm_complete: Completion used to wait for runtime resume to 155 * complete (ICM only) 156 * @quirks: Quirks used for this Thunderbolt switch 157 * @credit_allocation: Are the below buffer allocation parameters valid 158 * @max_usb3_credits: Router preferred number of buffers for USB 3.x 159 * @min_dp_aux_credits: Router preferred minimum number of buffers for DP AUX 160 * @min_dp_main_credits: Router preferred minimum number of buffers for DP MAIN 161 * @max_pcie_credits: Router preferred number of buffers for PCIe 162 * @max_dma_credits: Router preferred number of buffers for DMA/P2P 163 * @clx: CLx states on the upstream link of the router 164 * @drom_blob: DROM debugfs blob wrapper 165 * 166 * When the switch is being added or removed to the domain (other 167 * switches) you need to have domain lock held. 168 * 169 * In USB4 terminology this structure represents a router. 170 */ 171struct tb_switch { 172 struct device dev; 173 struct tb_regs_switch_header config; 174 struct tb_port *ports; 175 struct tb_dma_port *dma_port; 176 struct tb_switch_tmu tmu; 177 struct tb *tb; 178 u64 uid; 179 uuid_t *uuid; 180 u16 vendor; 181 u16 device; 182 const char *vendor_name; 183 const char *device_name; 184 unsigned int link_speed; 185 enum tb_link_width link_width; 186 enum tb_link_width preferred_link_width; 187 bool link_usb4; 188 unsigned int generation; 189 int cap_plug_events; 190 int cap_vsec_tmu; 191 int cap_lc; 192 int cap_lp; 193 bool is_unplugged; 194 u8 *drom; 195 struct tb_nvm *nvm; 196 bool no_nvm_upgrade; 197 bool safe_mode; 198 bool boot; 199 bool rpm; 200 unsigned int authorized; 201 enum tb_security_level security_level; 202 struct dentry *debugfs_dir; 203 u8 *key; 204 u8 connection_id; 205 u8 connection_key; 206 u8 link; 207 u8 depth; 208 struct completion rpm_complete; 209 unsigned long quirks; 210 bool credit_allocation; 211 unsigned int max_usb3_credits; 212 unsigned int min_dp_aux_credits; 213 unsigned int min_dp_main_credits; 214 unsigned int max_pcie_credits; 215 unsigned int max_dma_credits; 216 unsigned int clx; 217#ifdef CONFIG_DEBUG_FS 218 struct debugfs_blob_wrapper drom_blob; 219#endif 220}; 221 222/** 223 * struct tb_bandwidth_group - Bandwidth management group 224 * @tb: Pointer to the domain the group belongs to 225 * @index: Index of the group (aka Group_ID). Valid values %1-%7 226 * @ports: DP IN adapters belonging to this group are linked here 227 * @reserved: Bandwidth released by one tunnel in the group, available 228 * to others. This is reported as part of estimated_bw for 229 * the group. 230 * @release_work: Worker to release the @reserved if it is not used by 231 * any of the tunnels. 232 * 233 * Any tunnel that requires isochronous bandwidth (that's DP for now) is 234 * attached to a bandwidth group. All tunnels going through the same 235 * USB4 links share the same group and can dynamically distribute the 236 * bandwidth within the group. 237 */ 238struct tb_bandwidth_group { 239 struct tb *tb; 240 int index; 241 struct list_head ports; 242 int reserved; 243 struct delayed_work release_work; 244}; 245 246/** 247 * struct tb_port - a thunderbolt port, part of a tb_switch 248 * @config: Cached port configuration read from registers 249 * @sw: Switch the port belongs to 250 * @remote: Remote port (%NULL if not connected) 251 * @xdomain: Remote host (%NULL if not connected) 252 * @cap_phy: Offset, zero if not found 253 * @cap_tmu: Offset of the adapter specific TMU capability (%0 if not present) 254 * @cap_adap: Offset of the adapter specific capability (%0 if not present) 255 * @cap_usb4: Offset to the USB4 port capability (%0 if not present) 256 * @usb4: Pointer to the USB4 port structure (only if @cap_usb4 is != %0) 257 * @port: Port number on switch 258 * @disabled: Disabled by eeprom or enabled but not implemented 259 * @bonded: true if the port is bonded (two lanes combined as one) 260 * @dual_link_port: If the switch is connected using two ports, points 261 * to the other port. 262 * @link_nr: Is this primary or secondary port on the dual_link. 263 * @in_hopids: Currently allocated input HopIDs 264 * @out_hopids: Currently allocated output HopIDs 265 * @list: Used to link ports to DP resources list 266 * @total_credits: Total number of buffers available for this port 267 * @ctl_credits: Buffers reserved for control path 268 * @dma_credits: Number of credits allocated for DMA tunneling for all 269 * DMA paths through this port. 270 * @group: Bandwidth allocation group the adapter is assigned to. Only 271 * used for DP IN adapters for now. 272 * @group_list: The adapter is linked to the group's list of ports through this 273 * @max_bw: Maximum possible bandwidth through this adapter if set to 274 * non-zero. 275 * @redrive: For DP IN, if true the adapter is in redrive mode. 276 * 277 * In USB4 terminology this structure represents an adapter (protocol or 278 * lane adapter). 279 */ 280struct tb_port { 281 struct tb_regs_port_header config; 282 struct tb_switch *sw; 283 struct tb_port *remote; 284 struct tb_xdomain *xdomain; 285 int cap_phy; 286 int cap_tmu; 287 int cap_adap; 288 int cap_usb4; 289 struct usb4_port *usb4; 290 u8 port; 291 bool disabled; 292 bool bonded; 293 struct tb_port *dual_link_port; 294 u8 link_nr:1; 295 struct ida in_hopids; 296 struct ida out_hopids; 297 struct list_head list; 298 unsigned int total_credits; 299 unsigned int ctl_credits; 300 unsigned int dma_credits; 301 struct tb_bandwidth_group *group; 302 struct list_head group_list; 303 unsigned int max_bw; 304 bool redrive; 305}; 306 307/** 308 * struct usb4_port - USB4 port device 309 * @dev: Device for the port 310 * @port: Pointer to the lane 0 adapter 311 * @can_offline: Does the port have necessary platform support to move 312 * it into offline mode and back 313 * @offline: The port is currently in offline mode 314 * @margining: Pointer to margining structure if enabled 315 */ 316struct usb4_port { 317 struct device dev; 318 struct tb_port *port; 319 bool can_offline; 320 bool offline; 321#ifdef CONFIG_USB4_DEBUGFS_MARGINING 322 struct tb_margining *margining; 323#endif 324}; 325 326/** 327 * struct tb_retimer - Thunderbolt retimer 328 * @dev: Device for the retimer 329 * @tb: Pointer to the domain the retimer belongs to 330 * @index: Retimer index facing the router USB4 port 331 * @vendor: Vendor ID of the retimer 332 * @device: Device ID of the retimer 333 * @port: Pointer to the lane 0 adapter 334 * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise) 335 * @no_nvm_upgrade: Prevent NVM upgrade of this retimer 336 * @auth_status: Status of last NVM authentication 337 * @margining: Pointer to margining structure if enabled 338 */ 339struct tb_retimer { 340 struct device dev; 341 struct tb *tb; 342 u8 index; 343 u32 vendor; 344 u32 device; 345 struct tb_port *port; 346 struct tb_nvm *nvm; 347 bool no_nvm_upgrade; 348 u32 auth_status; 349#ifdef CONFIG_USB4_DEBUGFS_MARGINING 350 struct tb_margining *margining; 351#endif 352}; 353 354/** 355 * struct tb_path_hop - routing information for a tb_path 356 * @in_port: Ingress port of a switch 357 * @out_port: Egress port of a switch where the packet is routed out 358 * (must be on the same switch as @in_port) 359 * @in_hop_index: HopID where the path configuration entry is placed in 360 * the path config space of @in_port. 361 * @in_counter_index: Used counter index (not used in the driver 362 * currently, %-1 to disable) 363 * @next_hop_index: HopID of the packet when it is routed out from @out_port 364 * @initial_credits: Number of initial flow control credits allocated for 365 * the path 366 * @nfc_credits: Number of non-flow controlled buffers allocated for the 367 * @in_port. 368 * @pm_support: Set path PM packet support bit to 1 (for USB4 v2 routers) 369 * 370 * Hop configuration is always done on the IN port of a switch. 371 * in_port and out_port have to be on the same switch. Packets arriving on 372 * in_port with "hop" = in_hop_index will get routed to through out_port. The 373 * next hop to take (on out_port->remote) is determined by 374 * next_hop_index. When routing packet to another switch (out->remote is 375 * set) the @next_hop_index must match the @in_hop_index of that next 376 * hop to make routing possible. 377 * 378 * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in 379 * port. 380 */ 381struct tb_path_hop { 382 struct tb_port *in_port; 383 struct tb_port *out_port; 384 int in_hop_index; 385 int in_counter_index; 386 int next_hop_index; 387 unsigned int initial_credits; 388 unsigned int nfc_credits; 389 bool pm_support; 390}; 391 392/** 393 * enum tb_path_port - path options mask 394 * @TB_PATH_NONE: Do not activate on any hop on path 395 * @TB_PATH_SOURCE: Activate on the first hop (out of src) 396 * @TB_PATH_INTERNAL: Activate on the intermediate hops (not the first/last) 397 * @TB_PATH_DESTINATION: Activate on the last hop (into dst) 398 * @TB_PATH_ALL: Activate on all hops on the path 399 */ 400enum tb_path_port { 401 TB_PATH_NONE = 0, 402 TB_PATH_SOURCE = 1, 403 TB_PATH_INTERNAL = 2, 404 TB_PATH_DESTINATION = 4, 405 TB_PATH_ALL = 7, 406}; 407 408/** 409 * struct tb_path - a unidirectional path between two ports 410 * @tb: Pointer to the domain structure 411 * @name: Name of the path (used for debugging) 412 * @ingress_shared_buffer: Shared buffering used for ingress ports on the path 413 * @egress_shared_buffer: Shared buffering used for egress ports on the path 414 * @ingress_fc_enable: Flow control for ingress ports on the path 415 * @egress_fc_enable: Flow control for egress ports on the path 416 * @priority: Priority group if the path 417 * @weight: Weight of the path inside the priority group 418 * @drop_packages: Drop packages from queue tail or head 419 * @activated: Is the path active 420 * @clear_fc: Clear all flow control from the path config space entries 421 * when deactivating this path 422 * @hops: Path hops 423 * @path_length: How many hops the path uses 424 * @alloc_hopid: Does this path consume port HopID 425 * 426 * A path consists of a number of hops (see &struct tb_path_hop). To 427 * establish a PCIe tunnel two paths have to be created between the two 428 * PCIe ports. 429 */ 430struct tb_path { 431 struct tb *tb; 432 const char *name; 433 enum tb_path_port ingress_shared_buffer; 434 enum tb_path_port egress_shared_buffer; 435 enum tb_path_port ingress_fc_enable; 436 enum tb_path_port egress_fc_enable; 437 438 unsigned int priority:3; 439 int weight:4; 440 bool drop_packages; 441 bool activated; 442 bool clear_fc; 443 struct tb_path_hop *hops; 444 int path_length; 445 bool alloc_hopid; 446}; 447 448/* HopIDs 0-7 are reserved by the Thunderbolt protocol */ 449#define TB_PATH_MIN_HOPID 8 450/* 451 * Support paths from the farthest (depth 6) router to the host and back 452 * to the same level (not necessarily to the same router). 453 */ 454#define TB_PATH_MAX_HOPS (7 * 2) 455 456/* Possible wake types */ 457#define TB_WAKE_ON_CONNECT BIT(0) 458#define TB_WAKE_ON_DISCONNECT BIT(1) 459#define TB_WAKE_ON_USB4 BIT(2) 460#define TB_WAKE_ON_USB3 BIT(3) 461#define TB_WAKE_ON_PCIE BIT(4) 462#define TB_WAKE_ON_DP BIT(5) 463 464/* CL states */ 465#define TB_CL0S BIT(0) 466#define TB_CL1 BIT(1) 467#define TB_CL2 BIT(2) 468 469/** 470 * struct tb_cm_ops - Connection manager specific operations vector 471 * @driver_ready: Called right after control channel is started. Used by 472 * ICM to send driver ready message to the firmware. 473 * @start: Starts the domain 474 * @stop: Stops the domain 475 * @deinit: Perform any cleanup after the domain is stopped but before 476 * it is unregistered. Called without @tb->lock taken. Optional. 477 * @suspend_noirq: Connection manager specific suspend_noirq 478 * @resume_noirq: Connection manager specific resume_noirq 479 * @suspend: Connection manager specific suspend 480 * @freeze_noirq: Connection manager specific freeze_noirq 481 * @thaw_noirq: Connection manager specific thaw_noirq 482 * @complete: Connection manager specific complete 483 * @runtime_suspend: Connection manager specific runtime_suspend 484 * @runtime_resume: Connection manager specific runtime_resume 485 * @runtime_suspend_switch: Runtime suspend a switch 486 * @runtime_resume_switch: Runtime resume a switch 487 * @handle_event: Handle thunderbolt event 488 * @get_boot_acl: Get boot ACL list 489 * @set_boot_acl: Set boot ACL list 490 * @disapprove_switch: Disapprove switch (disconnect PCIe tunnel) 491 * @approve_switch: Approve switch 492 * @add_switch_key: Add key to switch 493 * @challenge_switch_key: Challenge switch using key 494 * @disconnect_pcie_paths: Disconnects PCIe paths before NVM update 495 * @approve_xdomain_paths: Approve (establish) XDomain DMA paths 496 * @disconnect_xdomain_paths: Disconnect XDomain DMA paths 497 * @usb4_switch_op: Optional proxy for USB4 router operations. If set 498 * this will be called whenever USB4 router operation is 499 * performed. If this returns %-EOPNOTSUPP then the 500 * native USB4 router operation is called. 501 * @usb4_switch_nvm_authenticate_status: Optional callback that the CM 502 * implementation can use to return 503 * status of USB4 NVM_AUTH router 504 * operation. 505 */ 506struct tb_cm_ops { 507 int (*driver_ready)(struct tb *tb); 508 int (*start)(struct tb *tb, bool reset); 509 void (*stop)(struct tb *tb); 510 void (*deinit)(struct tb *tb); 511 int (*suspend_noirq)(struct tb *tb); 512 int (*resume_noirq)(struct tb *tb); 513 int (*suspend)(struct tb *tb); 514 int (*freeze_noirq)(struct tb *tb); 515 int (*thaw_noirq)(struct tb *tb); 516 void (*complete)(struct tb *tb); 517 int (*runtime_suspend)(struct tb *tb); 518 int (*runtime_resume)(struct tb *tb); 519 int (*runtime_suspend_switch)(struct tb_switch *sw); 520 int (*runtime_resume_switch)(struct tb_switch *sw); 521 void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type, 522 const void *buf, size_t size); 523 int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids); 524 int (*set_boot_acl)(struct tb *tb, const uuid_t *uuids, size_t nuuids); 525 int (*disapprove_switch)(struct tb *tb, struct tb_switch *sw); 526 int (*approve_switch)(struct tb *tb, struct tb_switch *sw); 527 int (*add_switch_key)(struct tb *tb, struct tb_switch *sw); 528 int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw, 529 const u8 *challenge, u8 *response); 530 int (*disconnect_pcie_paths)(struct tb *tb); 531 int (*approve_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd, 532 int transmit_path, int transmit_ring, 533 int receive_path, int receive_ring); 534 int (*disconnect_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd, 535 int transmit_path, int transmit_ring, 536 int receive_path, int receive_ring); 537 int (*usb4_switch_op)(struct tb_switch *sw, u16 opcode, u32 *metadata, 538 u8 *status, const void *tx_data, size_t tx_data_len, 539 void *rx_data, size_t rx_data_len); 540 int (*usb4_switch_nvm_authenticate_status)(struct tb_switch *sw, 541 u32 *status); 542}; 543 544static inline void *tb_priv(struct tb *tb) 545{ 546 return (void *)tb->privdata; 547} 548 549#define TB_AUTOSUSPEND_DELAY 15000 /* ms */ 550 551/* helper functions & macros */ 552 553/** 554 * tb_upstream_port() - return the upstream port of a switch 555 * @sw: Router 556 * 557 * Every switch has an upstream port (for the root switch it is the NHI). 558 * 559 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for 560 * non root switches (on the NHI port remote is always NULL). 561 * 562 * Return: Pointer to &struct tb_port. 563 */ 564static inline struct tb_port *tb_upstream_port(struct tb_switch *sw) 565{ 566 return &sw->ports[sw->config.upstream_port_number]; 567} 568 569/** 570 * tb_is_upstream_port() - Is the port upstream facing 571 * @port: Port to check 572 * 573 * Return: %true if @port is upstream facing port. In case of dual link 574 * ports, both return %true. 575 */ 576static inline bool tb_is_upstream_port(const struct tb_port *port) 577{ 578 const struct tb_port *upstream_port = tb_upstream_port(port->sw); 579 return port == upstream_port || port->dual_link_port == upstream_port; 580} 581 582static inline u64 tb_route(const struct tb_switch *sw) 583{ 584 return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo; 585} 586 587static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw) 588{ 589 u8 port; 590 591 port = route >> (sw->config.depth * 8); 592 if (WARN_ON(port > sw->config.max_port_number)) 593 return NULL; 594 return &sw->ports[port]; 595} 596 597static inline const char *tb_width_name(enum tb_link_width width) 598{ 599 switch (width) { 600 case TB_LINK_WIDTH_SINGLE: 601 return "symmetric, single lane"; 602 case TB_LINK_WIDTH_DUAL: 603 return "symmetric, dual lanes"; 604 case TB_LINK_WIDTH_ASYM_TX: 605 return "asymmetric, 3 transmitters, 1 receiver"; 606 case TB_LINK_WIDTH_ASYM_RX: 607 return "asymmetric, 3 receivers, 1 transmitter"; 608 default: 609 return "unknown"; 610 } 611} 612 613/** 614 * tb_port_has_remote() - Does the port have switch connected downstream 615 * @port: Port to check 616 * 617 * Return: %true only when the port is primary port and has remote set. 618 */ 619static inline bool tb_port_has_remote(const struct tb_port *port) 620{ 621 if (tb_is_upstream_port(port)) 622 return false; 623 if (!port->remote) 624 return false; 625 if (port->dual_link_port && port->link_nr) 626 return false; 627 628 return true; 629} 630 631static inline bool tb_port_is_null(const struct tb_port *port) 632{ 633 return port && port->port && port->config.type == TB_TYPE_PORT; 634} 635 636static inline bool tb_port_is_nhi(const struct tb_port *port) 637{ 638 return port && port->config.type == TB_TYPE_NHI; 639} 640 641static inline bool tb_port_is_pcie_down(const struct tb_port *port) 642{ 643 return port && port->config.type == TB_TYPE_PCIE_DOWN; 644} 645 646static inline bool tb_port_is_pcie_up(const struct tb_port *port) 647{ 648 return port && port->config.type == TB_TYPE_PCIE_UP; 649} 650 651static inline bool tb_port_is_dpin(const struct tb_port *port) 652{ 653 return port && port->config.type == TB_TYPE_DP_HDMI_IN; 654} 655 656static inline bool tb_port_is_dpout(const struct tb_port *port) 657{ 658 return port && port->config.type == TB_TYPE_DP_HDMI_OUT; 659} 660 661static inline bool tb_port_is_usb3_down(const struct tb_port *port) 662{ 663 return port && port->config.type == TB_TYPE_USB3_DOWN; 664} 665 666static inline bool tb_port_is_usb3_up(const struct tb_port *port) 667{ 668 return port && port->config.type == TB_TYPE_USB3_UP; 669} 670 671static inline int tb_sw_read(struct tb_switch *sw, void *buffer, 672 enum tb_cfg_space space, u32 offset, u32 length) 673{ 674 if (sw->is_unplugged) 675 return -ENODEV; 676 return tb_cfg_read(sw->tb->ctl, 677 buffer, 678 tb_route(sw), 679 0, 680 space, 681 offset, 682 length); 683} 684 685static inline int tb_sw_write(struct tb_switch *sw, const void *buffer, 686 enum tb_cfg_space space, u32 offset, u32 length) 687{ 688 if (sw->is_unplugged) 689 return -ENODEV; 690 return tb_cfg_write(sw->tb->ctl, 691 buffer, 692 tb_route(sw), 693 0, 694 space, 695 offset, 696 length); 697} 698 699static inline int tb_port_read(struct tb_port *port, void *buffer, 700 enum tb_cfg_space space, u32 offset, u32 length) 701{ 702 if (port->sw->is_unplugged) 703 return -ENODEV; 704 return tb_cfg_read(port->sw->tb->ctl, 705 buffer, 706 tb_route(port->sw), 707 port->port, 708 space, 709 offset, 710 length); 711} 712 713static inline int tb_port_write(struct tb_port *port, const void *buffer, 714 enum tb_cfg_space space, u32 offset, u32 length) 715{ 716 if (port->sw->is_unplugged) 717 return -ENODEV; 718 return tb_cfg_write(port->sw->tb->ctl, 719 buffer, 720 tb_route(port->sw), 721 port->port, 722 space, 723 offset, 724 length); 725} 726 727#define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg) 728#define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg) 729#define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg) 730#define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg) 731#define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg) 732 733#define __TB_SW_PRINT(level, sw, fmt, arg...) \ 734 do { \ 735 const struct tb_switch *__sw = (sw); \ 736 level(__sw->tb, "%llx: " fmt, \ 737 tb_route(__sw), ## arg); \ 738 } while (0) 739#define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg) 740#define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg) 741#define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg) 742#define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg) 743 744#define __TB_PORT_PRINT(level, _port, fmt, arg...) \ 745 do { \ 746 const struct tb_port *__port = (_port); \ 747 level(__port->sw->tb, "%llx:%u: " fmt, \ 748 tb_route(__port->sw), __port->port, ## arg); \ 749 } while (0) 750#define tb_port_WARN(port, fmt, arg...) \ 751 __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg) 752#define tb_port_warn(port, fmt, arg...) \ 753 __TB_PORT_PRINT(tb_warn, port, fmt, ##arg) 754#define tb_port_info(port, fmt, arg...) \ 755 __TB_PORT_PRINT(tb_info, port, fmt, ##arg) 756#define tb_port_dbg(port, fmt, arg...) \ 757 __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg) 758 759struct tb *icm_probe(struct tb_nhi *nhi); 760struct tb *tb_probe(struct tb_nhi *nhi); 761 762extern const struct device_type tb_domain_type; 763extern const struct device_type tb_retimer_type; 764extern const struct device_type tb_switch_type; 765extern const struct device_type usb4_port_device_type; 766 767int tb_domain_init(void); 768void tb_domain_exit(void); 769int tb_xdomain_init(void); 770void tb_xdomain_exit(void); 771 772struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize); 773int tb_domain_add(struct tb *tb, bool reset); 774void tb_domain_remove(struct tb *tb); 775int tb_domain_suspend_noirq(struct tb *tb); 776int tb_domain_resume_noirq(struct tb *tb); 777int tb_domain_suspend(struct tb *tb); 778int tb_domain_freeze_noirq(struct tb *tb); 779int tb_domain_thaw_noirq(struct tb *tb); 780void tb_domain_complete(struct tb *tb); 781int tb_domain_runtime_suspend(struct tb *tb); 782int tb_domain_runtime_resume(struct tb *tb); 783int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw); 784int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw); 785int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw); 786int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw); 787int tb_domain_disconnect_pcie_paths(struct tb *tb); 788int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd, 789 int transmit_path, int transmit_ring, 790 int receive_path, int receive_ring); 791int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd, 792 int transmit_path, int transmit_ring, 793 int receive_path, int receive_ring); 794int tb_domain_disconnect_all_paths(struct tb *tb); 795 796static inline struct tb *tb_domain_get(struct tb *tb) 797{ 798 if (tb) 799 get_device(&tb->dev); 800 return tb; 801} 802 803static inline void tb_domain_put(struct tb *tb) 804{ 805 put_device(&tb->dev); 806} 807 808/** 809 * tb_domain_event() - Notify userspace about an event in domain 810 * @tb: Domain where event occurred 811 * @envp: Array of uevent environment strings (can be %NULL) 812 * 813 * This function provides a way to notify userspace about any events 814 * that take place in the domain. 815 */ 816static inline void tb_domain_event(struct tb *tb, char *envp[]) 817{ 818 kobject_uevent_env(&tb->dev.kobj, KOBJ_CHANGE, envp); 819} 820 821struct tb_nvm *tb_nvm_alloc(struct device *dev); 822int tb_nvm_read_version(struct tb_nvm *nvm); 823int tb_nvm_validate(struct tb_nvm *nvm); 824int tb_nvm_write_headers(struct tb_nvm *nvm); 825int tb_nvm_add_active(struct tb_nvm *nvm, nvmem_reg_read_t reg_read); 826int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val, 827 size_t bytes); 828int tb_nvm_add_non_active(struct tb_nvm *nvm, nvmem_reg_write_t reg_write); 829void tb_nvm_free(struct tb_nvm *nvm); 830void tb_nvm_exit(void); 831 832typedef int (*read_block_fn)(void *, unsigned int, void *, size_t); 833typedef int (*write_block_fn)(void *, unsigned int, const void *, size_t); 834 835int tb_nvm_read_data(unsigned int address, void *buf, size_t size, 836 unsigned int retries, read_block_fn read_block, 837 void *read_block_data); 838int tb_nvm_write_data(unsigned int address, const void *buf, size_t size, 839 unsigned int retries, write_block_fn write_next_block, 840 void *write_block_data); 841 842int tb_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf, 843 size_t size); 844struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent, 845 u64 route); 846struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb, 847 struct device *parent, u64 route); 848int tb_switch_configure(struct tb_switch *sw); 849int tb_switch_configuration_valid(struct tb_switch *sw); 850int tb_switch_add(struct tb_switch *sw); 851void tb_switch_remove(struct tb_switch *sw); 852void tb_switch_suspend(struct tb_switch *sw, bool runtime); 853int tb_switch_resume(struct tb_switch *sw, bool runtime); 854int tb_switch_reset(struct tb_switch *sw); 855int tb_switch_wait_for_bit(struct tb_switch *sw, u32 offset, u32 bit, 856 u32 value, int timeout_msec); 857void tb_sw_set_unplugged(struct tb_switch *sw); 858struct tb_port *tb_switch_find_port(struct tb_switch *sw, 859 enum tb_port_type type); 860struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link, 861 u8 depth); 862struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid); 863struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route); 864 865/** 866 * tb_switch_for_each_port() - Iterate over each switch port 867 * @sw: Switch whose ports to iterate 868 * @p: Port used as iterator 869 * 870 * Iterates over each switch port skipping the control port (port %0). 871 */ 872#define tb_switch_for_each_port(sw, p) \ 873 for ((p) = &(sw)->ports[1]; \ 874 (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++) 875 876static inline struct tb_switch *tb_switch_get(struct tb_switch *sw) 877{ 878 if (sw) 879 get_device(&sw->dev); 880 return sw; 881} 882 883static inline void tb_switch_put(struct tb_switch *sw) 884{ 885 put_device(&sw->dev); 886} 887 888static inline bool tb_is_switch(const struct device *dev) 889{ 890 return dev->type == &tb_switch_type; 891} 892 893static inline struct tb_switch *tb_to_switch(const struct device *dev) 894{ 895 if (tb_is_switch(dev)) 896 return container_of(dev, struct tb_switch, dev); 897 return NULL; 898} 899 900static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw) 901{ 902 return tb_to_switch(sw->dev.parent); 903} 904 905/** 906 * tb_switch_downstream_port() - Return downstream facing port of parent router 907 * @sw: Device router pointer 908 * 909 * Call only for device routers. 910 * 911 * Return: Pointer to &struct tb_port or %NULL in case of failure. 912 */ 913static inline struct tb_port *tb_switch_downstream_port(struct tb_switch *sw) 914{ 915 if (WARN_ON(!tb_route(sw))) 916 return NULL; 917 return tb_port_at(tb_route(sw), tb_switch_parent(sw)); 918} 919 920/** 921 * tb_switch_depth() - Returns depth of the connected router 922 * @sw: Router 923 * 924 * Return: Router depth level as a number. 925 */ 926static inline int tb_switch_depth(const struct tb_switch *sw) 927{ 928 return sw->config.depth; 929} 930 931static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw) 932{ 933 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL && 934 sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE; 935} 936 937static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw) 938{ 939 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL && 940 sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE; 941} 942 943static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw) 944{ 945 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 946 switch (sw->config.device_id) { 947 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C: 948 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C: 949 return true; 950 } 951 } 952 return false; 953} 954 955static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw) 956{ 957 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 958 switch (sw->config.device_id) { 959 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE: 960 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE: 961 return true; 962 } 963 } 964 return false; 965} 966 967static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw) 968{ 969 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 970 switch (sw->config.device_id) { 971 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE: 972 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE: 973 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE: 974 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE: 975 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE: 976 return true; 977 } 978 } 979 return false; 980} 981 982static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw) 983{ 984 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 985 switch (sw->config.device_id) { 986 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE: 987 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE: 988 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE: 989 return true; 990 } 991 } 992 return false; 993} 994 995static inline bool tb_switch_is_tiger_lake(const struct tb_switch *sw) 996{ 997 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 998 switch (sw->config.device_id) { 999 case PCI_DEVICE_ID_INTEL_TGL_NHI0: 1000 case PCI_DEVICE_ID_INTEL_TGL_NHI1: 1001 case PCI_DEVICE_ID_INTEL_TGL_H_NHI0: 1002 case PCI_DEVICE_ID_INTEL_TGL_H_NHI1: 1003 return true; 1004 } 1005 } 1006 return false; 1007} 1008 1009/** 1010 * tb_switch_is_icm() - Is the switch handled by ICM firmware 1011 * @sw: Switch to check 1012 * 1013 * In case there is a need to differentiate whether ICM firmware or SW CM 1014 * is handling @sw this function can be called. It is valid to call this 1015 * after tb_switch_alloc() and tb_switch_configure() has been called 1016 * (latter only for SW CM case). 1017 * 1018 * Return: %true if switch is handled by ICM, %false if handled by 1019 * software CM. 1020 */ 1021static inline bool tb_switch_is_icm(const struct tb_switch *sw) 1022{ 1023 return !sw->config.enabled; 1024} 1025 1026int tb_switch_set_link_width(struct tb_switch *sw, enum tb_link_width width); 1027int tb_switch_configure_link(struct tb_switch *sw); 1028void tb_switch_unconfigure_link(struct tb_switch *sw); 1029 1030bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in); 1031int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 1032void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 1033 1034int tb_switch_tmu_init(struct tb_switch *sw); 1035int tb_switch_tmu_post_time(struct tb_switch *sw); 1036int tb_switch_tmu_disable(struct tb_switch *sw); 1037int tb_switch_tmu_enable(struct tb_switch *sw); 1038int tb_switch_tmu_configure(struct tb_switch *sw, enum tb_switch_tmu_mode mode); 1039 1040/** 1041 * tb_switch_tmu_is_configured() - Is given TMU mode configured 1042 * @sw: Router whose mode to check 1043 * @mode: Mode to check 1044 * 1045 * Checks if given router TMU mode is configured to @mode. Note the 1046 * router TMU might not be enabled to this mode. 1047 * 1048 * Return: %true if TMU mode is equal to @mode, %false otherwise. 1049 */ 1050static inline bool tb_switch_tmu_is_configured(const struct tb_switch *sw, 1051 enum tb_switch_tmu_mode mode) 1052{ 1053 return sw->tmu.mode_request == mode; 1054} 1055 1056/** 1057 * tb_switch_tmu_is_enabled() - Checks if the specified TMU mode is enabled 1058 * @sw: Router whose TMU mode to check 1059 * 1060 * Return: %true if hardware TMU configuration matches the requested 1061 * configuration (and is not %TB_SWITCH_TMU_MODE_OFF), %false otherwise. 1062 */ 1063static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw) 1064{ 1065 return sw->tmu.mode != TB_SWITCH_TMU_MODE_OFF && 1066 sw->tmu.mode == sw->tmu.mode_request; 1067} 1068 1069bool tb_port_clx_is_enabled(struct tb_port *port, unsigned int clx); 1070 1071int tb_switch_clx_init(struct tb_switch *sw); 1072int tb_switch_clx_enable(struct tb_switch *sw, unsigned int clx); 1073int tb_switch_clx_disable(struct tb_switch *sw); 1074 1075/** 1076 * tb_switch_clx_is_enabled() - Checks if the CLx is enabled 1077 * @sw: Router to check for the CLx 1078 * @clx: The CLx states to check for 1079 * 1080 * Checks if the specified CLx is enabled on the router upstream link. 1081 * 1082 * Not applicable for a host router. 1083 * 1084 * Return: %true if any of the given states is enabled, %false otherwise. 1085 */ 1086static inline bool tb_switch_clx_is_enabled(const struct tb_switch *sw, 1087 unsigned int clx) 1088{ 1089 return sw->clx & clx; 1090} 1091 1092int tb_switch_pcie_l1_enable(struct tb_switch *sw); 1093 1094int tb_switch_xhci_connect(struct tb_switch *sw); 1095void tb_switch_xhci_disconnect(struct tb_switch *sw); 1096 1097int tb_port_state(struct tb_port *port); 1098int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged); 1099int tb_port_add_nfc_credits(struct tb_port *port, int credits); 1100int tb_port_clear_counter(struct tb_port *port, int counter); 1101int tb_port_unlock(struct tb_port *port); 1102int tb_port_enable(struct tb_port *port); 1103int tb_port_disable(struct tb_port *port); 1104int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid); 1105void tb_port_release_in_hopid(struct tb_port *port, int hopid); 1106int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid); 1107void tb_port_release_out_hopid(struct tb_port *port, int hopid); 1108struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end, 1109 struct tb_port *prev); 1110 1111/** 1112 * tb_port_path_direction_downstream() - Checks if path is directed downstream 1113 * @src: Source adapter 1114 * @dst: Destination adapter 1115 * 1116 * Return: %true only if the specified path from source adapter (@src) 1117 * to destination adapter (@dst) is directed downstream. 1118 */ 1119static inline bool 1120tb_port_path_direction_downstream(const struct tb_port *src, 1121 const struct tb_port *dst) 1122{ 1123 return src->sw->config.depth < dst->sw->config.depth; 1124} 1125 1126static inline bool tb_port_use_credit_allocation(const struct tb_port *port) 1127{ 1128 return tb_port_is_null(port) && port->sw->credit_allocation; 1129} 1130 1131/** 1132 * tb_for_each_port_on_path() - Iterate over each port on path 1133 * @src: Source port 1134 * @dst: Destination port 1135 * @p: Port used as iterator 1136 * 1137 * Walks over each port on path from @src to @dst. 1138 */ 1139#define tb_for_each_port_on_path(src, dst, p) \ 1140 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \ 1141 (p) = tb_next_port_on_path((src), (dst), (p))) 1142 1143/** 1144 * tb_for_each_upstream_port_on_path() - Iterate over each upstream port on path 1145 * @src: Source port 1146 * @dst: Destination port 1147 * @p: Port used as iterator 1148 * 1149 * Walks over each upstream lane adapter on path from @src to @dst. 1150 */ 1151#define tb_for_each_upstream_port_on_path(src, dst, p) \ 1152 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \ 1153 (p) = tb_next_port_on_path((src), (dst), (p))) \ 1154 if (!tb_port_is_null((p)) || !tb_is_upstream_port((p))) {\ 1155 continue; \ 1156 } else 1157 1158int tb_port_get_link_speed(struct tb_port *port); 1159int tb_port_get_link_generation(struct tb_port *port); 1160int tb_port_get_link_width(struct tb_port *port); 1161bool tb_port_width_supported(struct tb_port *port, unsigned int width); 1162int tb_port_set_link_width(struct tb_port *port, enum tb_link_width width); 1163int tb_port_lane_bonding_enable(struct tb_port *port); 1164void tb_port_lane_bonding_disable(struct tb_port *port); 1165int tb_port_wait_for_link_width(struct tb_port *port, unsigned int width, 1166 int timeout_msec); 1167int tb_port_update_credits(struct tb_port *port); 1168 1169int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec); 1170int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap); 1171int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset); 1172int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap); 1173int tb_port_next_cap(struct tb_port *port, unsigned int offset); 1174bool tb_port_is_enabled(struct tb_port *port); 1175 1176bool tb_usb3_port_is_enabled(struct tb_port *port); 1177int tb_usb3_port_enable(struct tb_port *port, bool enable); 1178 1179bool tb_pci_port_is_enabled(struct tb_port *port); 1180int tb_pci_port_enable(struct tb_port *port, bool enable); 1181 1182int tb_dp_port_hpd_is_active(struct tb_port *port); 1183int tb_dp_port_hpd_clear(struct tb_port *port); 1184int tb_dp_port_set_hops(struct tb_port *port, unsigned int video, 1185 unsigned int aux_tx, unsigned int aux_rx); 1186bool tb_dp_port_is_enabled(struct tb_port *port); 1187int tb_dp_port_enable(struct tb_port *port, bool enable); 1188 1189struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid, 1190 struct tb_port *dst, int dst_hopid, 1191 struct tb_port **last, const char *name, 1192 bool alloc_hopid); 1193struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid, 1194 struct tb_port *dst, int dst_hopid, int link_nr, 1195 const char *name); 1196void tb_path_free(struct tb_path *path); 1197int tb_path_activate(struct tb_path *path); 1198void tb_path_deactivate(struct tb_path *path); 1199int tb_path_deactivate_hop(struct tb_port *port, int hop_index); 1200bool tb_path_is_invalid(struct tb_path *path); 1201bool tb_path_port_on_path(const struct tb_path *path, 1202 const struct tb_port *port); 1203 1204/** 1205 * tb_path_for_each_hop() - Iterate over each hop on path 1206 * @path: Path whose hops to iterate 1207 * @hop: Hop used as iterator 1208 * 1209 * Iterates over each hop on path. 1210 */ 1211#define tb_path_for_each_hop(path, hop) \ 1212 for ((hop) = &(path)->hops[0]; \ 1213 (hop) <= &(path)->hops[(path)->path_length - 1]; (hop)++) 1214 1215int tb_drom_read(struct tb_switch *sw); 1216int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid); 1217 1218int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid); 1219int tb_lc_reset_port(struct tb_port *port); 1220int tb_lc_configure_port(struct tb_port *port); 1221void tb_lc_unconfigure_port(struct tb_port *port); 1222int tb_lc_configure_xdomain(struct tb_port *port); 1223void tb_lc_unconfigure_xdomain(struct tb_port *port); 1224int tb_lc_start_lane_initialization(struct tb_port *port); 1225bool tb_lc_is_clx_supported(struct tb_port *port); 1226bool tb_lc_is_usb_plugged(struct tb_port *port); 1227bool tb_lc_is_xhci_connected(struct tb_port *port); 1228int tb_lc_xhci_connect(struct tb_port *port); 1229void tb_lc_xhci_disconnect(struct tb_port *port); 1230int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags); 1231int tb_lc_set_sleep(struct tb_switch *sw); 1232bool tb_lc_lane_bonding_possible(struct tb_switch *sw); 1233bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in); 1234int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in); 1235int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in); 1236int tb_lc_force_power(struct tb_switch *sw); 1237 1238static inline int tb_route_length(u64 route) 1239{ 1240 return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT; 1241} 1242 1243/** 1244 * tb_downstream_route() - get route to downstream switch 1245 * @port: Port to check 1246 * 1247 * Port must not be the upstream port (otherwise a loop is created). 1248 * 1249 * Return: Route to the switch behind @port. 1250 */ 1251static inline u64 tb_downstream_route(struct tb_port *port) 1252{ 1253 return tb_route(port->sw) 1254 | ((u64) port->port << (port->sw->config.depth * 8)); 1255} 1256 1257bool tb_is_xdomain_enabled(void); 1258bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type, 1259 const void *buf, size_t size); 1260struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent, 1261 u64 route, const uuid_t *local_uuid, 1262 const uuid_t *remote_uuid); 1263void tb_xdomain_add(struct tb_xdomain *xd); 1264void tb_xdomain_remove(struct tb_xdomain *xd); 1265struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link, 1266 u8 depth); 1267 1268static inline struct tb_switch *tb_xdomain_parent(struct tb_xdomain *xd) 1269{ 1270 return tb_to_switch(xd->dev.parent); 1271} 1272 1273/** 1274 * tb_xdomain_downstream_port() - Return downstream facing port of parent router 1275 * @xd: Xdomain pointer 1276 * 1277 * Return: Pointer to &struct tb_port or %NULL in case of failure. 1278 */ 1279static inline struct tb_port *tb_xdomain_downstream_port(struct tb_xdomain *xd) 1280{ 1281 return tb_port_at(xd->route, tb_xdomain_parent(xd)); 1282} 1283 1284int tb_retimer_nvm_read(struct tb_retimer *rt, unsigned int address, void *buf, 1285 size_t size); 1286int tb_retimer_scan(struct tb_port *port, bool add); 1287void tb_retimer_remove_all(struct tb_port *port); 1288 1289static inline bool tb_is_retimer(const struct device *dev) 1290{ 1291 return dev->type == &tb_retimer_type; 1292} 1293 1294static inline struct tb_retimer *tb_to_retimer(struct device *dev) 1295{ 1296 if (tb_is_retimer(dev)) 1297 return container_of(dev, struct tb_retimer, dev); 1298 return NULL; 1299} 1300 1301/** 1302 * usb4_switch_version() - Returns USB4 version of the router 1303 * @sw: Router to check 1304 * 1305 * Return: Major version of USB4 router (%1 for v1, %2 for v2 and so 1306 * on). Can be called to pre-USB4 router too and in that case returns %0. 1307 */ 1308static inline unsigned int usb4_switch_version(const struct tb_switch *sw) 1309{ 1310 return FIELD_GET(USB4_VERSION_MAJOR_MASK, sw->config.thunderbolt_version); 1311} 1312 1313/** 1314 * tb_switch_is_usb4() - Is the switch USB4 compliant 1315 * @sw: Switch to check 1316 * 1317 * Return: %true if the @sw is USB4 compliant router, %false otherwise. 1318 */ 1319static inline bool tb_switch_is_usb4(const struct tb_switch *sw) 1320{ 1321 return usb4_switch_version(sw) > 0; 1322} 1323 1324void usb4_switch_check_wakes(struct tb_switch *sw); 1325int usb4_switch_setup(struct tb_switch *sw); 1326int usb4_switch_configuration_valid(struct tb_switch *sw); 1327int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid); 1328int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf, 1329 size_t size); 1330bool usb4_switch_lane_bonding_possible(struct tb_switch *sw); 1331int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags, bool runtime); 1332int usb4_switch_set_sleep(struct tb_switch *sw); 1333int usb4_switch_nvm_sector_size(struct tb_switch *sw); 1334int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf, 1335 size_t size); 1336int usb4_switch_nvm_set_offset(struct tb_switch *sw, unsigned int address); 1337int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address, 1338 const void *buf, size_t size); 1339int usb4_switch_nvm_authenticate(struct tb_switch *sw); 1340int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status); 1341int usb4_switch_credits_init(struct tb_switch *sw); 1342bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in); 1343int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 1344int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 1345struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw, 1346 const struct tb_port *port); 1347struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw, 1348 const struct tb_port *port); 1349int usb4_switch_add_ports(struct tb_switch *sw); 1350void usb4_switch_remove_ports(struct tb_switch *sw); 1351 1352int usb4_port_unlock(struct tb_port *port); 1353int usb4_port_hotplug_enable(struct tb_port *port); 1354int usb4_port_reset(struct tb_port *port); 1355int usb4_port_configure(struct tb_port *port); 1356void usb4_port_unconfigure(struct tb_port *port); 1357int usb4_port_configure_xdomain(struct tb_port *port, struct tb_xdomain *xd); 1358void usb4_port_unconfigure_xdomain(struct tb_port *port); 1359int usb4_port_router_offline(struct tb_port *port); 1360int usb4_port_router_online(struct tb_port *port); 1361int usb4_port_enumerate_retimers(struct tb_port *port); 1362bool usb4_port_clx_supported(struct tb_port *port); 1363 1364bool usb4_port_asym_supported(struct tb_port *port); 1365int usb4_port_asym_set_link_width(struct tb_port *port, enum tb_link_width width); 1366int usb4_port_asym_start(struct tb_port *port); 1367 1368/** 1369 * enum usb4_sb_target - Sideband transaction target 1370 * @USB4_SB_TARGET_ROUTER: Target is the router itself 1371 * @USB4_SB_TARGET_PARTNER: Target is partner 1372 * @USB4_SB_TARGET_RETIMER: Target is retimer 1373 */ 1374enum usb4_sb_target { 1375 USB4_SB_TARGET_ROUTER, 1376 USB4_SB_TARGET_PARTNER, 1377 USB4_SB_TARGET_RETIMER, 1378}; 1379 1380int usb4_port_sb_read(struct tb_port *port, enum usb4_sb_target target, u8 index, 1381 u8 reg, void *buf, u8 size); 1382int usb4_port_sb_write(struct tb_port *port, enum usb4_sb_target target, 1383 u8 index, u8 reg, const void *buf, u8 size); 1384 1385/** 1386 * enum usb4_margin_sw_error_counter - Software margining error counter operation 1387 * @USB4_MARGIN_SW_ERROR_COUNTER_NOP: No change in counter setup 1388 * @USB4_MARGIN_SW_ERROR_COUNTER_CLEAR: Set the error counter to 0, enable counter 1389 * @USB4_MARGIN_SW_ERROR_COUNTER_START: Start counter, count from last value 1390 * @USB4_MARGIN_SW_ERROR_COUNTER_STOP: Stop counter, do not clear value 1391 */ 1392enum usb4_margin_sw_error_counter { 1393 USB4_MARGIN_SW_ERROR_COUNTER_NOP, 1394 USB4_MARGIN_SW_ERROR_COUNTER_CLEAR, 1395 USB4_MARGIN_SW_ERROR_COUNTER_START, 1396 USB4_MARGIN_SW_ERROR_COUNTER_STOP, 1397}; 1398 1399enum usb4_margining_lane { 1400 USB4_MARGINING_LANE_RX0 = 0, 1401 USB4_MARGINING_LANE_RX1 = 1, 1402 USB4_MARGINING_LANE_RX2 = 2, 1403 USB4_MARGINING_LANE_ALL = 7, 1404}; 1405 1406/** 1407 * struct usb4_port_margining_params - USB4 margining parameters 1408 * @error_counter: Error counter operation for software margining 1409 * @ber_level: Current BER level contour value 1410 * @lanes: Lanes to enable for the margining operation 1411 * @voltage_time_offset: Offset for voltage / time for software margining 1412 * @optional_voltage_offset_range: Enable optional extended voltage range 1413 * @right_high: %false if left/low margin test is performed, %true if right/high 1414 * @upper_eye: %true if margin test is done on upper eye, %false if done on 1415 * lower eye 1416 * @time: %true if time margining is used instead of voltage 1417 */ 1418struct usb4_port_margining_params { 1419 enum usb4_margin_sw_error_counter error_counter; 1420 u32 ber_level; 1421 enum usb4_margining_lane lanes; 1422 u32 voltage_time_offset; 1423 bool optional_voltage_offset_range; 1424 bool right_high; 1425 bool upper_eye; 1426 bool time; 1427}; 1428 1429int usb4_port_margining_caps(struct tb_port *port, enum usb4_sb_target target, 1430 u8 index, u32 *caps, size_t ncaps); 1431int usb4_port_hw_margin(struct tb_port *port, enum usb4_sb_target target, 1432 u8 index, const struct usb4_port_margining_params *params, 1433 u32 *results, size_t nresults); 1434int usb4_port_sw_margin(struct tb_port *port, enum usb4_sb_target target, 1435 u8 index, const struct usb4_port_margining_params *params, 1436 u32 *results); 1437int usb4_port_sw_margin_errors(struct tb_port *port, enum usb4_sb_target target, 1438 u8 index, u32 *errors); 1439 1440int usb4_port_retimer_set_inbound_sbtx(struct tb_port *port, u8 index); 1441int usb4_port_retimer_unset_inbound_sbtx(struct tb_port *port, u8 index); 1442int usb4_port_retimer_is_last(struct tb_port *port, u8 index); 1443int usb4_port_retimer_is_cable(struct tb_port *port, u8 index); 1444int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index); 1445int usb4_port_retimer_nvm_set_offset(struct tb_port *port, u8 index, 1446 unsigned int address); 1447int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index, 1448 unsigned int address, const void *buf, 1449 size_t size); 1450int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index); 1451int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index, 1452 u32 *status); 1453int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index, 1454 unsigned int address, void *buf, size_t size); 1455 1456int usb4_usb3_port_max_link_rate(struct tb_port *port); 1457int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw, 1458 int *downstream_bw); 1459int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw, 1460 int *downstream_bw); 1461int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw, 1462 int *downstream_bw); 1463 1464int usb4_dp_port_set_cm_id(struct tb_port *port, int cm_id); 1465bool usb4_dp_port_bandwidth_mode_supported(struct tb_port *port); 1466bool usb4_dp_port_bandwidth_mode_enabled(struct tb_port *port); 1467int usb4_dp_port_set_cm_bandwidth_mode_supported(struct tb_port *port, 1468 bool supported); 1469int usb4_dp_port_group_id(struct tb_port *port); 1470int usb4_dp_port_set_group_id(struct tb_port *port, int group_id); 1471int usb4_dp_port_nrd(struct tb_port *port, int *rate, int *lanes); 1472int usb4_dp_port_set_nrd(struct tb_port *port, int rate, int lanes); 1473int usb4_dp_port_granularity(struct tb_port *port); 1474int usb4_dp_port_set_granularity(struct tb_port *port, int granularity); 1475int usb4_dp_port_set_estimated_bandwidth(struct tb_port *port, int bw); 1476int usb4_dp_port_allocated_bandwidth(struct tb_port *port); 1477int usb4_dp_port_allocate_bandwidth(struct tb_port *port, int bw); 1478int usb4_dp_port_requested_bandwidth(struct tb_port *port); 1479 1480int usb4_pci_port_set_ext_encapsulation(struct tb_port *port, bool enable); 1481 1482static inline bool tb_is_usb4_port_device(const struct device *dev) 1483{ 1484 return dev->type == &usb4_port_device_type; 1485} 1486 1487static inline struct usb4_port *tb_to_usb4_port_device(struct device *dev) 1488{ 1489 if (tb_is_usb4_port_device(dev)) 1490 return container_of(dev, struct usb4_port, dev); 1491 return NULL; 1492} 1493 1494struct usb4_port *usb4_port_device_add(struct tb_port *port); 1495void usb4_port_device_remove(struct usb4_port *usb4); 1496int usb4_port_device_resume(struct usb4_port *usb4); 1497int usb4_port_index(const struct tb_switch *sw, const struct tb_port *port); 1498 1499static inline bool usb4_port_device_is_offline(const struct usb4_port *usb4) 1500{ 1501 return usb4->offline; 1502} 1503 1504void tb_check_quirks(struct tb_switch *sw); 1505 1506#ifdef CONFIG_ACPI 1507bool tb_acpi_add_links(struct tb_nhi *nhi); 1508 1509bool tb_acpi_is_native(void); 1510bool tb_acpi_may_tunnel_usb3(void); 1511bool tb_acpi_may_tunnel_dp(void); 1512bool tb_acpi_may_tunnel_pcie(void); 1513bool tb_acpi_is_xdomain_allowed(void); 1514 1515int tb_acpi_init(void); 1516void tb_acpi_exit(void); 1517int tb_acpi_power_on_retimers(struct tb_port *port); 1518int tb_acpi_power_off_retimers(struct tb_port *port); 1519#else 1520static inline bool tb_acpi_add_links(struct tb_nhi *nhi) { return false; } 1521 1522static inline bool tb_acpi_is_native(void) { return true; } 1523static inline bool tb_acpi_may_tunnel_usb3(void) { return true; } 1524static inline bool tb_acpi_may_tunnel_dp(void) { return true; } 1525static inline bool tb_acpi_may_tunnel_pcie(void) { return true; } 1526static inline bool tb_acpi_is_xdomain_allowed(void) { return true; } 1527 1528static inline int tb_acpi_init(void) { return 0; } 1529static inline void tb_acpi_exit(void) { } 1530static inline int tb_acpi_power_on_retimers(struct tb_port *port) { return 0; } 1531static inline int tb_acpi_power_off_retimers(struct tb_port *port) { return 0; } 1532#endif 1533 1534#ifdef CONFIG_DEBUG_FS 1535void tb_debugfs_init(void); 1536void tb_debugfs_exit(void); 1537void tb_switch_debugfs_init(struct tb_switch *sw); 1538void tb_switch_debugfs_remove(struct tb_switch *sw); 1539void tb_xdomain_debugfs_init(struct tb_xdomain *xd); 1540void tb_xdomain_debugfs_remove(struct tb_xdomain *xd); 1541void tb_service_debugfs_init(struct tb_service *svc); 1542void tb_service_debugfs_remove(struct tb_service *svc); 1543void tb_retimer_debugfs_init(struct tb_retimer *rt); 1544void tb_retimer_debugfs_remove(struct tb_retimer *rt); 1545#else 1546static inline void tb_debugfs_init(void) { } 1547static inline void tb_debugfs_exit(void) { } 1548static inline void tb_switch_debugfs_init(struct tb_switch *sw) { } 1549static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { } 1550static inline void tb_xdomain_debugfs_init(struct tb_xdomain *xd) { } 1551static inline void tb_xdomain_debugfs_remove(struct tb_xdomain *xd) { } 1552static inline void tb_service_debugfs_init(struct tb_service *svc) { } 1553static inline void tb_service_debugfs_remove(struct tb_service *svc) { } 1554static inline void tb_retimer_debugfs_init(struct tb_retimer *rt) { } 1555static inline void tb_retimer_debugfs_remove(struct tb_retimer *rt) { } 1556#endif 1557 1558#endif
~/
Read-only file preview.