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 */ 52 struct 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 68 enum 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 */ 88 enum 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 */ 105 struct 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 */ 171 struct 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 */ 238 struct 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 */ 280 struct 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 moved 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 */ 316 struct 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 * 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 */ 339 struct 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 than @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 */ 381 struct 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 */ 400 enum 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 */ 430 struct 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 be used to 503 * return status of USB4 NVM_AUTH 504 * router operation. 505 */ 506 struct 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 544 static 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 * 556 * Every switch has an upstream port (for the root switch it is the NHI). 557 * 558 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for 559 * non root switches (on the NHI port remote is always NULL). 560 * 561 * Return: Returns the upstream port of the switch. 562 */ 563 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw) 564 { 565 return &sw->ports[sw->config.upstream_port_number]; 566 } 567 568 /** 569 * tb_is_upstream_port() - Is the port upstream facing 570 * @port: Port to check 571 * 572 * Returns true if @port is upstream facing port. In case of dual link 573 * ports both return true. 574 */ 575 static inline bool tb_is_upstream_port(const struct tb_port *port) 576 { 577 const struct tb_port *upstream_port = tb_upstream_port(port->sw); 578 return port == upstream_port || port->dual_link_port == upstream_port; 579 } 580 581 static inline u64 tb_route(const struct tb_switch *sw) 582 { 583 return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo; 584 } 585 586 static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw) 587 { 588 u8 port; 589 590 port = route >> (sw->config.depth * 8); 591 if (WARN_ON(port > sw->config.max_port_number)) 592 return NULL; 593 return &sw->ports[port]; 594 } 595 596 static inline const char *tb_width_name(enum tb_link_width width) 597 { 598 switch (width) { 599 case TB_LINK_WIDTH_SINGLE: 600 return "symmetric, single lane"; 601 case TB_LINK_WIDTH_DUAL: 602 return "symmetric, dual lanes"; 603 case TB_LINK_WIDTH_ASYM_TX: 604 return "asymmetric, 3 transmitters, 1 receiver"; 605 case TB_LINK_WIDTH_ASYM_RX: 606 return "asymmetric, 3 receivers, 1 transmitter"; 607 default: 608 return "unknown"; 609 } 610 } 611 612 /** 613 * tb_port_has_remote() - Does the port have switch connected downstream 614 * @port: Port to check 615 * 616 * Returns true only when the port is primary port and has remote set. 617 */ 618 static inline bool tb_port_has_remote(const struct tb_port *port) 619 { 620 if (tb_is_upstream_port(port)) 621 return false; 622 if (!port->remote) 623 return false; 624 if (port->dual_link_port && port->link_nr) 625 return false; 626 627 return true; 628 } 629 630 static inline bool tb_port_is_null(const struct tb_port *port) 631 { 632 return port && port->port && port->config.type == TB_TYPE_PORT; 633 } 634 635 static inline bool tb_port_is_nhi(const struct tb_port *port) 636 { 637 return port && port->config.type == TB_TYPE_NHI; 638 } 639 640 static inline bool tb_port_is_pcie_down(const struct tb_port *port) 641 { 642 return port && port->config.type == TB_TYPE_PCIE_DOWN; 643 } 644 645 static inline bool tb_port_is_pcie_up(const struct tb_port *port) 646 { 647 return port && port->config.type == TB_TYPE_PCIE_UP; 648 } 649 650 static inline bool tb_port_is_dpin(const struct tb_port *port) 651 { 652 return port && port->config.type == TB_TYPE_DP_HDMI_IN; 653 } 654 655 static inline bool tb_port_is_dpout(const struct tb_port *port) 656 { 657 return port && port->config.type == TB_TYPE_DP_HDMI_OUT; 658 } 659 660 static inline bool tb_port_is_usb3_down(const struct tb_port *port) 661 { 662 return port && port->config.type == TB_TYPE_USB3_DOWN; 663 } 664 665 static inline bool tb_port_is_usb3_up(const struct tb_port *port) 666 { 667 return port && port->config.type == TB_TYPE_USB3_UP; 668 } 669 670 static inline int tb_sw_read(struct tb_switch *sw, void *buffer, 671 enum tb_cfg_space space, u32 offset, u32 length) 672 { 673 if (sw->is_unplugged) 674 return -ENODEV; 675 return tb_cfg_read(sw->tb->ctl, 676 buffer, 677 tb_route(sw), 678 0, 679 space, 680 offset, 681 length); 682 } 683 684 static inline int tb_sw_write(struct tb_switch *sw, const void *buffer, 685 enum tb_cfg_space space, u32 offset, u32 length) 686 { 687 if (sw->is_unplugged) 688 return -ENODEV; 689 return tb_cfg_write(sw->tb->ctl, 690 buffer, 691 tb_route(sw), 692 0, 693 space, 694 offset, 695 length); 696 } 697 698 static inline int tb_port_read(struct tb_port *port, void *buffer, 699 enum tb_cfg_space space, u32 offset, u32 length) 700 { 701 if (port->sw->is_unplugged) 702 return -ENODEV; 703 return tb_cfg_read(port->sw->tb->ctl, 704 buffer, 705 tb_route(port->sw), 706 port->port, 707 space, 708 offset, 709 length); 710 } 711 712 static inline int tb_port_write(struct tb_port *port, const void *buffer, 713 enum tb_cfg_space space, u32 offset, u32 length) 714 { 715 if (port->sw->is_unplugged) 716 return -ENODEV; 717 return tb_cfg_write(port->sw->tb->ctl, 718 buffer, 719 tb_route(port->sw), 720 port->port, 721 space, 722 offset, 723 length); 724 } 725 726 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg) 727 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg) 728 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg) 729 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg) 730 #define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg) 731 732 #define __TB_SW_PRINT(level, sw, fmt, arg...) \ 733 do { \ 734 const struct tb_switch *__sw = (sw); \ 735 level(__sw->tb, "%llx: " fmt, \ 736 tb_route(__sw), ## arg); \ 737 } while (0) 738 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg) 739 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg) 740 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg) 741 #define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg) 742 743 #define __TB_PORT_PRINT(level, _port, fmt, arg...) \ 744 do { \ 745 const struct tb_port *__port = (_port); \ 746 level(__port->sw->tb, "%llx:%u: " fmt, \ 747 tb_route(__port->sw), __port->port, ## arg); \ 748 } while (0) 749 #define tb_port_WARN(port, fmt, arg...) \ 750 __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg) 751 #define tb_port_warn(port, fmt, arg...) \ 752 __TB_PORT_PRINT(tb_warn, port, fmt, ##arg) 753 #define tb_port_info(port, fmt, arg...) \ 754 __TB_PORT_PRINT(tb_info, port, fmt, ##arg) 755 #define tb_port_dbg(port, fmt, arg...) \ 756 __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg) 757 758 struct tb *icm_probe(struct tb_nhi *nhi); 759 struct tb *tb_probe(struct tb_nhi *nhi); 760 761 extern const struct device_type tb_domain_type; 762 extern const struct device_type tb_retimer_type; 763 extern const struct device_type tb_switch_type; 764 extern const struct device_type usb4_port_device_type; 765 766 int tb_domain_init(void); 767 void tb_domain_exit(void); 768 int tb_xdomain_init(void); 769 void tb_xdomain_exit(void); 770 771 struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize); 772 int tb_domain_add(struct tb *tb, bool reset); 773 void tb_domain_remove(struct tb *tb); 774 int tb_domain_suspend_noirq(struct tb *tb); 775 int tb_domain_resume_noirq(struct tb *tb); 776 int tb_domain_suspend(struct tb *tb); 777 int tb_domain_freeze_noirq(struct tb *tb); 778 int tb_domain_thaw_noirq(struct tb *tb); 779 void tb_domain_complete(struct tb *tb); 780 int tb_domain_runtime_suspend(struct tb *tb); 781 int tb_domain_runtime_resume(struct tb *tb); 782 int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw); 783 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw); 784 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw); 785 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw); 786 int tb_domain_disconnect_pcie_paths(struct tb *tb); 787 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd, 788 int transmit_path, int transmit_ring, 789 int receive_path, int receive_ring); 790 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd, 791 int transmit_path, int transmit_ring, 792 int receive_path, int receive_ring); 793 int tb_domain_disconnect_all_paths(struct tb *tb); 794 795 static inline struct tb *tb_domain_get(struct tb *tb) 796 { 797 if (tb) 798 get_device(&tb->dev); 799 return tb; 800 } 801 802 static inline void tb_domain_put(struct tb *tb) 803 { 804 put_device(&tb->dev); 805 } 806 807 /** 808 * tb_domain_event() - Notify userspace about an event in domain 809 * @tb: Domain where event occurred 810 * @envp: Array of uevent environment strings (can be %NULL) 811 * 812 * This function provides a way to notify userspace about any events 813 * that take place in the domain. 814 */ 815 static inline void tb_domain_event(struct tb *tb, char *envp[]) 816 { 817 kobject_uevent_env(&tb->dev.kobj, KOBJ_CHANGE, envp); 818 } 819 820 struct tb_nvm *tb_nvm_alloc(struct device *dev); 821 int tb_nvm_read_version(struct tb_nvm *nvm); 822 int tb_nvm_validate(struct tb_nvm *nvm); 823 int tb_nvm_write_headers(struct tb_nvm *nvm); 824 int tb_nvm_add_active(struct tb_nvm *nvm, nvmem_reg_read_t reg_read); 825 int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val, 826 size_t bytes); 827 int tb_nvm_add_non_active(struct tb_nvm *nvm, nvmem_reg_write_t reg_write); 828 void tb_nvm_free(struct tb_nvm *nvm); 829 void tb_nvm_exit(void); 830 831 typedef int (*read_block_fn)(void *, unsigned int, void *, size_t); 832 typedef int (*write_block_fn)(void *, unsigned int, const void *, size_t); 833 834 int tb_nvm_read_data(unsigned int address, void *buf, size_t size, 835 unsigned int retries, read_block_fn read_block, 836 void *read_block_data); 837 int tb_nvm_write_data(unsigned int address, const void *buf, size_t size, 838 unsigned int retries, write_block_fn write_next_block, 839 void *write_block_data); 840 841 int tb_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf, 842 size_t size); 843 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent, 844 u64 route); 845 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb, 846 struct device *parent, u64 route); 847 int tb_switch_configure(struct tb_switch *sw); 848 int tb_switch_configuration_valid(struct tb_switch *sw); 849 int tb_switch_add(struct tb_switch *sw); 850 void tb_switch_remove(struct tb_switch *sw); 851 void tb_switch_suspend(struct tb_switch *sw, bool runtime); 852 int tb_switch_resume(struct tb_switch *sw, bool runtime); 853 int tb_switch_reset(struct tb_switch *sw); 854 int tb_switch_wait_for_bit(struct tb_switch *sw, u32 offset, u32 bit, 855 u32 value, int timeout_msec); 856 void tb_sw_set_unplugged(struct tb_switch *sw); 857 struct tb_port *tb_switch_find_port(struct tb_switch *sw, 858 enum tb_port_type type); 859 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link, 860 u8 depth); 861 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid); 862 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route); 863 864 /** 865 * tb_switch_for_each_port() - Iterate over each switch port 866 * @sw: Switch whose ports to iterate 867 * @p: Port used as iterator 868 * 869 * Iterates over each switch port skipping the control port (port %0). 870 */ 871 #define tb_switch_for_each_port(sw, p) \ 872 for ((p) = &(sw)->ports[1]; \ 873 (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++) 874 875 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw) 876 { 877 if (sw) 878 get_device(&sw->dev); 879 return sw; 880 } 881 882 static inline void tb_switch_put(struct tb_switch *sw) 883 { 884 put_device(&sw->dev); 885 } 886 887 static inline bool tb_is_switch(const struct device *dev) 888 { 889 return dev->type == &tb_switch_type; 890 } 891 892 static inline struct tb_switch *tb_to_switch(const struct device *dev) 893 { 894 if (tb_is_switch(dev)) 895 return container_of(dev, struct tb_switch, dev); 896 return NULL; 897 } 898 899 static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw) 900 { 901 return tb_to_switch(sw->dev.parent); 902 } 903 904 /** 905 * tb_switch_downstream_port() - Return downstream facing port of parent router 906 * @sw: Device router pointer 907 * 908 * Only call for device routers. Returns the downstream facing port of 909 * the parent router. 910 */ 911 static inline struct tb_port *tb_switch_downstream_port(struct tb_switch *sw) 912 { 913 if (WARN_ON(!tb_route(sw))) 914 return NULL; 915 return tb_port_at(tb_route(sw), tb_switch_parent(sw)); 916 } 917 918 /** 919 * tb_switch_depth() - Returns depth of the connected router 920 * @sw: Router 921 */ 922 static inline int tb_switch_depth(const struct tb_switch *sw) 923 { 924 return sw->config.depth; 925 } 926 927 static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw) 928 { 929 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL && 930 sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE; 931 } 932 933 static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw) 934 { 935 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL && 936 sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE; 937 } 938 939 static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw) 940 { 941 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 942 switch (sw->config.device_id) { 943 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C: 944 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C: 945 return true; 946 } 947 } 948 return false; 949 } 950 951 static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw) 952 { 953 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 954 switch (sw->config.device_id) { 955 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE: 956 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE: 957 return true; 958 } 959 } 960 return false; 961 } 962 963 static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw) 964 { 965 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 966 switch (sw->config.device_id) { 967 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE: 968 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE: 969 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE: 970 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE: 971 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE: 972 return true; 973 } 974 } 975 return false; 976 } 977 978 static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw) 979 { 980 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 981 switch (sw->config.device_id) { 982 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE: 983 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE: 984 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE: 985 return true; 986 } 987 } 988 return false; 989 } 990 991 static inline bool tb_switch_is_tiger_lake(const struct tb_switch *sw) 992 { 993 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 994 switch (sw->config.device_id) { 995 case PCI_DEVICE_ID_INTEL_TGL_NHI0: 996 case PCI_DEVICE_ID_INTEL_TGL_NHI1: 997 case PCI_DEVICE_ID_INTEL_TGL_H_NHI0: 998 case PCI_DEVICE_ID_INTEL_TGL_H_NHI1: 999 return true; 1000 } 1001 } 1002 return false; 1003 } 1004 1005 /** 1006 * tb_switch_is_icm() - Is the switch handled by ICM firmware 1007 * @sw: Switch to check 1008 * 1009 * In case there is a need to differentiate whether ICM firmware or SW CM 1010 * is handling @sw this function can be called. It is valid to call this 1011 * after tb_switch_alloc() and tb_switch_configure() has been called 1012 * (latter only for SW CM case). 1013 */ 1014 static inline bool tb_switch_is_icm(const struct tb_switch *sw) 1015 { 1016 return !sw->config.enabled; 1017 } 1018 1019 int tb_switch_set_link_width(struct tb_switch *sw, enum tb_link_width width); 1020 int tb_switch_configure_link(struct tb_switch *sw); 1021 void tb_switch_unconfigure_link(struct tb_switch *sw); 1022 1023 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in); 1024 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 1025 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 1026 1027 int tb_switch_tmu_init(struct tb_switch *sw); 1028 int tb_switch_tmu_post_time(struct tb_switch *sw); 1029 int tb_switch_tmu_disable(struct tb_switch *sw); 1030 int tb_switch_tmu_enable(struct tb_switch *sw); 1031 int tb_switch_tmu_configure(struct tb_switch *sw, enum tb_switch_tmu_mode mode); 1032 1033 /** 1034 * tb_switch_tmu_is_configured() - Is given TMU mode configured 1035 * @sw: Router whose mode to check 1036 * @mode: Mode to check 1037 * 1038 * Checks if given router TMU mode is configured to @mode. Note the 1039 * router TMU might not be enabled to this mode. 1040 */ 1041 static inline bool tb_switch_tmu_is_configured(const struct tb_switch *sw, 1042 enum tb_switch_tmu_mode mode) 1043 { 1044 return sw->tmu.mode_request == mode; 1045 } 1046 1047 /** 1048 * tb_switch_tmu_is_enabled() - Checks if the specified TMU mode is enabled 1049 * @sw: Router whose TMU mode to check 1050 * 1051 * Return true if hardware TMU configuration matches the requested 1052 * configuration (and is not %TB_SWITCH_TMU_MODE_OFF). 1053 */ 1054 static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw) 1055 { 1056 return sw->tmu.mode != TB_SWITCH_TMU_MODE_OFF && 1057 sw->tmu.mode == sw->tmu.mode_request; 1058 } 1059 1060 bool tb_port_clx_is_enabled(struct tb_port *port, unsigned int clx); 1061 1062 int tb_switch_clx_init(struct tb_switch *sw); 1063 int tb_switch_clx_enable(struct tb_switch *sw, unsigned int clx); 1064 int tb_switch_clx_disable(struct tb_switch *sw); 1065 1066 /** 1067 * tb_switch_clx_is_enabled() - Checks if the CLx is enabled 1068 * @sw: Router to check for the CLx 1069 * @clx: The CLx states to check for 1070 * 1071 * Checks if the specified CLx is enabled on the router upstream link. 1072 * Returns true if any of the given states is enabled. 1073 * 1074 * Not applicable for a host router. 1075 */ 1076 static inline bool tb_switch_clx_is_enabled(const struct tb_switch *sw, 1077 unsigned int clx) 1078 { 1079 return sw->clx & clx; 1080 } 1081 1082 int tb_switch_pcie_l1_enable(struct tb_switch *sw); 1083 1084 int tb_switch_xhci_connect(struct tb_switch *sw); 1085 void tb_switch_xhci_disconnect(struct tb_switch *sw); 1086 1087 int tb_port_state(struct tb_port *port); 1088 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged); 1089 int tb_port_add_nfc_credits(struct tb_port *port, int credits); 1090 int tb_port_clear_counter(struct tb_port *port, int counter); 1091 int tb_port_unlock(struct tb_port *port); 1092 int tb_port_enable(struct tb_port *port); 1093 int tb_port_disable(struct tb_port *port); 1094 int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid); 1095 void tb_port_release_in_hopid(struct tb_port *port, int hopid); 1096 int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid); 1097 void tb_port_release_out_hopid(struct tb_port *port, int hopid); 1098 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end, 1099 struct tb_port *prev); 1100 1101 /** 1102 * tb_port_path_direction_downstream() - Checks if path directed downstream 1103 * @src: Source adapter 1104 * @dst: Destination adapter 1105 * 1106 * Returns %true only if the specified path from source adapter (@src) 1107 * to destination adapter (@dst) is directed downstream. 1108 */ 1109 static inline bool 1110 tb_port_path_direction_downstream(const struct tb_port *src, 1111 const struct tb_port *dst) 1112 { 1113 return src->sw->config.depth < dst->sw->config.depth; 1114 } 1115 1116 static inline bool tb_port_use_credit_allocation(const struct tb_port *port) 1117 { 1118 return tb_port_is_null(port) && port->sw->credit_allocation; 1119 } 1120 1121 /** 1122 * tb_for_each_port_on_path() - Iterate over each port on path 1123 * @src: Source port 1124 * @dst: Destination port 1125 * @p: Port used as iterator 1126 * 1127 * Walks over each port on path from @src to @dst. 1128 */ 1129 #define tb_for_each_port_on_path(src, dst, p) \ 1130 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \ 1131 (p) = tb_next_port_on_path((src), (dst), (p))) 1132 1133 /** 1134 * tb_for_each_upstream_port_on_path() - Iterate over each upstreamm port on path 1135 * @src: Source port 1136 * @dst: Destination port 1137 * @p: Port used as iterator 1138 * 1139 * Walks over each upstream lane adapter on path from @src to @dst. 1140 */ 1141 #define tb_for_each_upstream_port_on_path(src, dst, p) \ 1142 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \ 1143 (p) = tb_next_port_on_path((src), (dst), (p))) \ 1144 if (!tb_port_is_null((p)) || !tb_is_upstream_port((p))) {\ 1145 continue; \ 1146 } else 1147 1148 int tb_port_get_link_speed(struct tb_port *port); 1149 int tb_port_get_link_generation(struct tb_port *port); 1150 int tb_port_get_link_width(struct tb_port *port); 1151 bool tb_port_width_supported(struct tb_port *port, unsigned int width); 1152 int tb_port_set_link_width(struct tb_port *port, enum tb_link_width width); 1153 int tb_port_lane_bonding_enable(struct tb_port *port); 1154 void tb_port_lane_bonding_disable(struct tb_port *port); 1155 int tb_port_wait_for_link_width(struct tb_port *port, unsigned int width, 1156 int timeout_msec); 1157 int tb_port_update_credits(struct tb_port *port); 1158 1159 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec); 1160 int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap); 1161 int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset); 1162 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap); 1163 int tb_port_next_cap(struct tb_port *port, unsigned int offset); 1164 bool tb_port_is_enabled(struct tb_port *port); 1165 1166 bool tb_usb3_port_is_enabled(struct tb_port *port); 1167 int tb_usb3_port_enable(struct tb_port *port, bool enable); 1168 1169 bool tb_pci_port_is_enabled(struct tb_port *port); 1170 int tb_pci_port_enable(struct tb_port *port, bool enable); 1171 1172 int tb_dp_port_hpd_is_active(struct tb_port *port); 1173 int tb_dp_port_hpd_clear(struct tb_port *port); 1174 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video, 1175 unsigned int aux_tx, unsigned int aux_rx); 1176 bool tb_dp_port_is_enabled(struct tb_port *port); 1177 int tb_dp_port_enable(struct tb_port *port, bool enable); 1178 1179 struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid, 1180 struct tb_port *dst, int dst_hopid, 1181 struct tb_port **last, const char *name, 1182 bool alloc_hopid); 1183 struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid, 1184 struct tb_port *dst, int dst_hopid, int link_nr, 1185 const char *name); 1186 void tb_path_free(struct tb_path *path); 1187 int tb_path_activate(struct tb_path *path); 1188 void tb_path_deactivate(struct tb_path *path); 1189 int tb_path_deactivate_hop(struct tb_port *port, int hop_index); 1190 bool tb_path_is_invalid(struct tb_path *path); 1191 bool tb_path_port_on_path(const struct tb_path *path, 1192 const struct tb_port *port); 1193 1194 /** 1195 * tb_path_for_each_hop() - Iterate over each hop on path 1196 * @path: Path whose hops to iterate 1197 * @hop: Hop used as iterator 1198 * 1199 * Iterates over each hop on path. 1200 */ 1201 #define tb_path_for_each_hop(path, hop) \ 1202 for ((hop) = &(path)->hops[0]; \ 1203 (hop) <= &(path)->hops[(path)->path_length - 1]; (hop)++) 1204 1205 int tb_drom_read(struct tb_switch *sw); 1206 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid); 1207 1208 int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid); 1209 int tb_lc_reset_port(struct tb_port *port); 1210 int tb_lc_configure_port(struct tb_port *port); 1211 void tb_lc_unconfigure_port(struct tb_port *port); 1212 int tb_lc_configure_xdomain(struct tb_port *port); 1213 void tb_lc_unconfigure_xdomain(struct tb_port *port); 1214 int tb_lc_start_lane_initialization(struct tb_port *port); 1215 bool tb_lc_is_clx_supported(struct tb_port *port); 1216 bool tb_lc_is_usb_plugged(struct tb_port *port); 1217 bool tb_lc_is_xhci_connected(struct tb_port *port); 1218 int tb_lc_xhci_connect(struct tb_port *port); 1219 void tb_lc_xhci_disconnect(struct tb_port *port); 1220 int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags); 1221 int tb_lc_set_sleep(struct tb_switch *sw); 1222 bool tb_lc_lane_bonding_possible(struct tb_switch *sw); 1223 bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in); 1224 int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in); 1225 int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in); 1226 int tb_lc_force_power(struct tb_switch *sw); 1227 1228 static inline int tb_route_length(u64 route) 1229 { 1230 return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT; 1231 } 1232 1233 /** 1234 * tb_downstream_route() - get route to downstream switch 1235 * 1236 * Port must not be the upstream port (otherwise a loop is created). 1237 * 1238 * Return: Returns a route to the switch behind @port. 1239 */ 1240 static inline u64 tb_downstream_route(struct tb_port *port) 1241 { 1242 return tb_route(port->sw) 1243 | ((u64) port->port << (port->sw->config.depth * 8)); 1244 } 1245 1246 bool tb_is_xdomain_enabled(void); 1247 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type, 1248 const void *buf, size_t size); 1249 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent, 1250 u64 route, const uuid_t *local_uuid, 1251 const uuid_t *remote_uuid); 1252 void tb_xdomain_add(struct tb_xdomain *xd); 1253 void tb_xdomain_remove(struct tb_xdomain *xd); 1254 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link, 1255 u8 depth); 1256 1257 static inline struct tb_switch *tb_xdomain_parent(struct tb_xdomain *xd) 1258 { 1259 return tb_to_switch(xd->dev.parent); 1260 } 1261 1262 /** 1263 * tb_xdomain_downstream_port() - Return downstream facing port of parent router 1264 * @xd: Xdomain pointer 1265 * 1266 * Returns the downstream port the XDomain is connected to. 1267 */ 1268 static inline struct tb_port *tb_xdomain_downstream_port(struct tb_xdomain *xd) 1269 { 1270 return tb_port_at(xd->route, tb_xdomain_parent(xd)); 1271 } 1272 1273 int tb_retimer_nvm_read(struct tb_retimer *rt, unsigned int address, void *buf, 1274 size_t size); 1275 int tb_retimer_scan(struct tb_port *port, bool add); 1276 void tb_retimer_remove_all(struct tb_port *port); 1277 1278 static inline bool tb_is_retimer(const struct device *dev) 1279 { 1280 return dev->type == &tb_retimer_type; 1281 } 1282 1283 static inline struct tb_retimer *tb_to_retimer(struct device *dev) 1284 { 1285 if (tb_is_retimer(dev)) 1286 return container_of(dev, struct tb_retimer, dev); 1287 return NULL; 1288 } 1289 1290 /** 1291 * usb4_switch_version() - Returns USB4 version of the router 1292 * @sw: Router to check 1293 * 1294 * Returns major version of USB4 router (%1 for v1, %2 for v2 and so 1295 * on). Can be called to pre-USB4 router too and in that case returns %0. 1296 */ 1297 static inline unsigned int usb4_switch_version(const struct tb_switch *sw) 1298 { 1299 return FIELD_GET(USB4_VERSION_MAJOR_MASK, sw->config.thunderbolt_version); 1300 } 1301 1302 /** 1303 * tb_switch_is_usb4() - Is the switch USB4 compliant 1304 * @sw: Switch to check 1305 * 1306 * Returns true if the @sw is USB4 compliant router, false otherwise. 1307 */ 1308 static inline bool tb_switch_is_usb4(const struct tb_switch *sw) 1309 { 1310 return usb4_switch_version(sw) > 0; 1311 } 1312 1313 void usb4_switch_check_wakes(struct tb_switch *sw); 1314 int usb4_switch_setup(struct tb_switch *sw); 1315 int usb4_switch_configuration_valid(struct tb_switch *sw); 1316 int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid); 1317 int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf, 1318 size_t size); 1319 bool usb4_switch_lane_bonding_possible(struct tb_switch *sw); 1320 int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags); 1321 int usb4_switch_set_sleep(struct tb_switch *sw); 1322 int usb4_switch_nvm_sector_size(struct tb_switch *sw); 1323 int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf, 1324 size_t size); 1325 int usb4_switch_nvm_set_offset(struct tb_switch *sw, unsigned int address); 1326 int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address, 1327 const void *buf, size_t size); 1328 int usb4_switch_nvm_authenticate(struct tb_switch *sw); 1329 int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status); 1330 int usb4_switch_credits_init(struct tb_switch *sw); 1331 bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in); 1332 int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 1333 int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 1334 struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw, 1335 const struct tb_port *port); 1336 struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw, 1337 const struct tb_port *port); 1338 int usb4_switch_add_ports(struct tb_switch *sw); 1339 void usb4_switch_remove_ports(struct tb_switch *sw); 1340 1341 int usb4_port_unlock(struct tb_port *port); 1342 int usb4_port_hotplug_enable(struct tb_port *port); 1343 int usb4_port_reset(struct tb_port *port); 1344 int usb4_port_configure(struct tb_port *port); 1345 void usb4_port_unconfigure(struct tb_port *port); 1346 int usb4_port_configure_xdomain(struct tb_port *port, struct tb_xdomain *xd); 1347 void usb4_port_unconfigure_xdomain(struct tb_port *port); 1348 int usb4_port_router_offline(struct tb_port *port); 1349 int usb4_port_router_online(struct tb_port *port); 1350 int usb4_port_enumerate_retimers(struct tb_port *port); 1351 bool usb4_port_clx_supported(struct tb_port *port); 1352 1353 bool usb4_port_asym_supported(struct tb_port *port); 1354 int usb4_port_asym_set_link_width(struct tb_port *port, enum tb_link_width width); 1355 int usb4_port_asym_start(struct tb_port *port); 1356 1357 /** 1358 * enum tb_sb_target - Sideband transaction target 1359 * @USB4_SB_TARGET_ROUTER: Target is the router itself 1360 * @USB4_SB_TARGET_PARTNER: Target is partner 1361 * @USB4_SB_TARGET_RETIMER: Target is retimer 1362 */ 1363 enum usb4_sb_target { 1364 USB4_SB_TARGET_ROUTER, 1365 USB4_SB_TARGET_PARTNER, 1366 USB4_SB_TARGET_RETIMER, 1367 }; 1368 1369 int usb4_port_sb_read(struct tb_port *port, enum usb4_sb_target target, u8 index, 1370 u8 reg, void *buf, u8 size); 1371 int usb4_port_sb_write(struct tb_port *port, enum usb4_sb_target target, 1372 u8 index, u8 reg, const void *buf, u8 size); 1373 1374 /** 1375 * enum usb4_margin_sw_error_counter - Software margining error counter operation 1376 * @USB4_MARGIN_SW_ERROR_COUNTER_NOP: No change in counter setup 1377 * @USB4_MARGIN_SW_ERROR_COUNTER_CLEAR: Set the error counter to 0, enable counter 1378 * @USB4_MARGIN_SW_ERROR_COUNTER_START: Start counter, count from last value 1379 * @USB4_MARGIN_SW_ERROR_COUNTER_STOP: Stop counter, do not clear value 1380 */ 1381 enum usb4_margin_sw_error_counter { 1382 USB4_MARGIN_SW_ERROR_COUNTER_NOP, 1383 USB4_MARGIN_SW_ERROR_COUNTER_CLEAR, 1384 USB4_MARGIN_SW_ERROR_COUNTER_START, 1385 USB4_MARGIN_SW_ERROR_COUNTER_STOP, 1386 }; 1387 1388 enum usb4_margining_lane { 1389 USB4_MARGINING_LANE_RX0 = 0, 1390 USB4_MARGINING_LANE_RX1 = 1, 1391 USB4_MARGINING_LANE_RX2 = 2, 1392 USB4_MARGINING_LANE_ALL = 7, 1393 }; 1394 1395 /** 1396 * struct usb4_port_margining_params - USB4 margining parameters 1397 * @error_counter: Error counter operation for software margining 1398 * @ber_level: Current BER level contour value 1399 * @lanes: Lanes to enable for the margining operation 1400 * @voltage_time_offset: Offset for voltage / time for software margining 1401 * @optional_voltage_offset_range: Enable optional extended voltage range 1402 * @right_high: %false if left/low margin test is performed, %true if right/high 1403 * @time: %true if time margining is used instead of voltage 1404 */ 1405 struct usb4_port_margining_params { 1406 enum usb4_margin_sw_error_counter error_counter; 1407 u32 ber_level; 1408 enum usb4_margining_lane lanes; 1409 u32 voltage_time_offset; 1410 bool optional_voltage_offset_range; 1411 bool right_high; 1412 bool upper_eye; 1413 bool time; 1414 }; 1415 1416 int usb4_port_margining_caps(struct tb_port *port, enum usb4_sb_target target, 1417 u8 index, u32 *caps, size_t ncaps); 1418 int usb4_port_hw_margin(struct tb_port *port, enum usb4_sb_target target, 1419 u8 index, const struct usb4_port_margining_params *params, 1420 u32 *results, size_t nresults); 1421 int usb4_port_sw_margin(struct tb_port *port, enum usb4_sb_target target, 1422 u8 index, const struct usb4_port_margining_params *params, 1423 u32 *results); 1424 int usb4_port_sw_margin_errors(struct tb_port *port, enum usb4_sb_target target, 1425 u8 index, u32 *errors); 1426 1427 int usb4_port_retimer_set_inbound_sbtx(struct tb_port *port, u8 index); 1428 int usb4_port_retimer_unset_inbound_sbtx(struct tb_port *port, u8 index); 1429 int usb4_port_retimer_is_last(struct tb_port *port, u8 index); 1430 int usb4_port_retimer_is_cable(struct tb_port *port, u8 index); 1431 int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index); 1432 int usb4_port_retimer_nvm_set_offset(struct tb_port *port, u8 index, 1433 unsigned int address); 1434 int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index, 1435 unsigned int address, const void *buf, 1436 size_t size); 1437 int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index); 1438 int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index, 1439 u32 *status); 1440 int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index, 1441 unsigned int address, void *buf, size_t size); 1442 1443 int usb4_usb3_port_max_link_rate(struct tb_port *port); 1444 int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw, 1445 int *downstream_bw); 1446 int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw, 1447 int *downstream_bw); 1448 int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw, 1449 int *downstream_bw); 1450 1451 int usb4_dp_port_set_cm_id(struct tb_port *port, int cm_id); 1452 bool usb4_dp_port_bandwidth_mode_supported(struct tb_port *port); 1453 bool usb4_dp_port_bandwidth_mode_enabled(struct tb_port *port); 1454 int usb4_dp_port_set_cm_bandwidth_mode_supported(struct tb_port *port, 1455 bool supported); 1456 int usb4_dp_port_group_id(struct tb_port *port); 1457 int usb4_dp_port_set_group_id(struct tb_port *port, int group_id); 1458 int usb4_dp_port_nrd(struct tb_port *port, int *rate, int *lanes); 1459 int usb4_dp_port_set_nrd(struct tb_port *port, int rate, int lanes); 1460 int usb4_dp_port_granularity(struct tb_port *port); 1461 int usb4_dp_port_set_granularity(struct tb_port *port, int granularity); 1462 int usb4_dp_port_set_estimated_bandwidth(struct tb_port *port, int bw); 1463 int usb4_dp_port_allocated_bandwidth(struct tb_port *port); 1464 int usb4_dp_port_allocate_bandwidth(struct tb_port *port, int bw); 1465 int usb4_dp_port_requested_bandwidth(struct tb_port *port); 1466 1467 int usb4_pci_port_set_ext_encapsulation(struct tb_port *port, bool enable); 1468 1469 static inline bool tb_is_usb4_port_device(const struct device *dev) 1470 { 1471 return dev->type == &usb4_port_device_type; 1472 } 1473 1474 static inline struct usb4_port *tb_to_usb4_port_device(struct device *dev) 1475 { 1476 if (tb_is_usb4_port_device(dev)) 1477 return container_of(dev, struct usb4_port, dev); 1478 return NULL; 1479 } 1480 1481 struct usb4_port *usb4_port_device_add(struct tb_port *port); 1482 void usb4_port_device_remove(struct usb4_port *usb4); 1483 int usb4_port_device_resume(struct usb4_port *usb4); 1484 int usb4_port_index(const struct tb_switch *sw, const struct tb_port *port); 1485 1486 static inline bool usb4_port_device_is_offline(const struct usb4_port *usb4) 1487 { 1488 return usb4->offline; 1489 } 1490 1491 void tb_check_quirks(struct tb_switch *sw); 1492 1493 #ifdef CONFIG_ACPI 1494 bool tb_acpi_add_links(struct tb_nhi *nhi); 1495 1496 bool tb_acpi_is_native(void); 1497 bool tb_acpi_may_tunnel_usb3(void); 1498 bool tb_acpi_may_tunnel_dp(void); 1499 bool tb_acpi_may_tunnel_pcie(void); 1500 bool tb_acpi_is_xdomain_allowed(void); 1501 1502 int tb_acpi_init(void); 1503 void tb_acpi_exit(void); 1504 int tb_acpi_power_on_retimers(struct tb_port *port); 1505 int tb_acpi_power_off_retimers(struct tb_port *port); 1506 #else 1507 static inline bool tb_acpi_add_links(struct tb_nhi *nhi) { return false; } 1508 1509 static inline bool tb_acpi_is_native(void) { return true; } 1510 static inline bool tb_acpi_may_tunnel_usb3(void) { return true; } 1511 static inline bool tb_acpi_may_tunnel_dp(void) { return true; } 1512 static inline bool tb_acpi_may_tunnel_pcie(void) { return true; } 1513 static inline bool tb_acpi_is_xdomain_allowed(void) { return true; } 1514 1515 static inline int tb_acpi_init(void) { return 0; } 1516 static inline void tb_acpi_exit(void) { } 1517 static inline int tb_acpi_power_on_retimers(struct tb_port *port) { return 0; } 1518 static inline int tb_acpi_power_off_retimers(struct tb_port *port) { return 0; } 1519 #endif 1520 1521 #ifdef CONFIG_DEBUG_FS 1522 void tb_debugfs_init(void); 1523 void tb_debugfs_exit(void); 1524 void tb_switch_debugfs_init(struct tb_switch *sw); 1525 void tb_switch_debugfs_remove(struct tb_switch *sw); 1526 void tb_xdomain_debugfs_init(struct tb_xdomain *xd); 1527 void tb_xdomain_debugfs_remove(struct tb_xdomain *xd); 1528 void tb_service_debugfs_init(struct tb_service *svc); 1529 void tb_service_debugfs_remove(struct tb_service *svc); 1530 void tb_retimer_debugfs_init(struct tb_retimer *rt); 1531 void tb_retimer_debugfs_remove(struct tb_retimer *rt); 1532 #else 1533 static inline void tb_debugfs_init(void) { } 1534 static inline void tb_debugfs_exit(void) { } 1535 static inline void tb_switch_debugfs_init(struct tb_switch *sw) { } 1536 static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { } 1537 static inline void tb_xdomain_debugfs_init(struct tb_xdomain *xd) { } 1538 static inline void tb_xdomain_debugfs_remove(struct tb_xdomain *xd) { } 1539 static inline void tb_service_debugfs_init(struct tb_service *svc) { } 1540 static inline void tb_service_debugfs_remove(struct tb_service *svc) { } 1541 static inline void tb_retimer_debugfs_init(struct tb_retimer *rt) { } 1542 static inline void tb_retimer_debugfs_remove(struct tb_retimer *rt) { } 1543 #endif 1544 1545 #endif 1546