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