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 17 #include "tb_regs.h" 18 #include "ctl.h" 19 #include "dma_port.h" 20 21 #define NVM_MIN_SIZE SZ_32K 22 #define NVM_MAX_SIZE SZ_512K 23 24 /* Intel specific NVM offsets */ 25 #define NVM_DEVID 0x05 26 #define NVM_VERSION 0x08 27 #define NVM_FLASH_SIZE 0x45 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 * @non_active: Non-active portion NVMem device 37 * @buf: Buffer where the NVM image is stored before it is written to 38 * the actual NVM flash device 39 * @buf_data_size: Number of bytes actually consumed by the new NVM 40 * image 41 * @authenticating: The device is authenticating the new NVM 42 * @flushed: The image has been flushed to the storage area 43 * 44 * The user of this structure needs to handle serialization of possible 45 * concurrent access. 46 */ 47 struct tb_nvm { 48 struct device *dev; 49 u8 major; 50 u8 minor; 51 int id; 52 struct nvmem_device *active; 53 struct nvmem_device *non_active; 54 void *buf; 55 size_t buf_data_size; 56 bool authenticating; 57 bool flushed; 58 }; 59 60 #define TB_SWITCH_KEY_SIZE 32 61 #define TB_SWITCH_MAX_DEPTH 6 62 #define USB4_SWITCH_MAX_DEPTH 5 63 64 /** 65 * enum tb_switch_tmu_rate - TMU refresh rate 66 * @TB_SWITCH_TMU_RATE_OFF: %0 (Disable Time Sync handshake) 67 * @TB_SWITCH_TMU_RATE_HIFI: %16 us time interval between successive 68 * transmission of the Delay Request TSNOS 69 * (Time Sync Notification Ordered Set) on a Link 70 * @TB_SWITCH_TMU_RATE_NORMAL: %1 ms time interval between successive 71 * transmission of the Delay Request TSNOS on 72 * a Link 73 */ 74 enum tb_switch_tmu_rate { 75 TB_SWITCH_TMU_RATE_OFF = 0, 76 TB_SWITCH_TMU_RATE_HIFI = 16, 77 TB_SWITCH_TMU_RATE_NORMAL = 1000, 78 }; 79 80 /** 81 * struct tb_switch_tmu - Structure holding switch TMU configuration 82 * @cap: Offset to the TMU capability (%0 if not found) 83 * @has_ucap: Does the switch support uni-directional mode 84 * @rate: TMU refresh rate related to upstream switch. In case of root 85 * switch this holds the domain rate. 86 * @unidirectional: Is the TMU in uni-directional or bi-directional mode 87 * related to upstream switch. Don't case for root switch. 88 */ 89 struct tb_switch_tmu { 90 int cap; 91 bool has_ucap; 92 enum tb_switch_tmu_rate rate; 93 bool unidirectional; 94 }; 95 96 /** 97 * struct tb_switch - a thunderbolt switch 98 * @dev: Device for the switch 99 * @config: Switch configuration 100 * @ports: Ports in this switch 101 * @dma_port: If the switch has port supporting DMA configuration based 102 * mailbox this will hold the pointer to that (%NULL 103 * otherwise). If set it also means the switch has 104 * upgradeable NVM. 105 * @tmu: The switch TMU configuration 106 * @tb: Pointer to the domain the switch belongs to 107 * @uid: Unique ID of the switch 108 * @uuid: UUID of the switch (or %NULL if not supported) 109 * @vendor: Vendor ID of the switch 110 * @device: Device ID of the switch 111 * @vendor_name: Name of the vendor (or %NULL if not known) 112 * @device_name: Name of the device (or %NULL if not known) 113 * @link_speed: Speed of the link in Gb/s 114 * @link_width: Width of the link (1 or 2) 115 * @link_usb4: Upstream link is USB4 116 * @generation: Switch Thunderbolt generation 117 * @cap_plug_events: Offset to the plug events capability (%0 if not found) 118 * @cap_lc: Offset to the link controller capability (%0 if not found) 119 * @is_unplugged: The switch is going away 120 * @drom: DROM of the switch (%NULL if not found) 121 * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise) 122 * @no_nvm_upgrade: Prevent NVM upgrade of this switch 123 * @safe_mode: The switch is in safe-mode 124 * @boot: Whether the switch was already authorized on boot or not 125 * @rpm: The switch supports runtime PM 126 * @authorized: Whether the switch is authorized by user or policy 127 * @security_level: Switch supported security level 128 * @debugfs_dir: Pointer to the debugfs structure 129 * @key: Contains the key used to challenge the device or %NULL if not 130 * supported. Size of the key is %TB_SWITCH_KEY_SIZE. 131 * @connection_id: Connection ID used with ICM messaging 132 * @connection_key: Connection key used with ICM messaging 133 * @link: Root switch link this switch is connected (ICM only) 134 * @depth: Depth in the chain this switch is connected (ICM only) 135 * @rpm_complete: Completion used to wait for runtime resume to 136 * complete (ICM only) 137 * @quirks: Quirks used for this Thunderbolt switch 138 * 139 * When the switch is being added or removed to the domain (other 140 * switches) you need to have domain lock held. 141 * 142 * In USB4 terminology this structure represents a router. 143 */ 144 struct tb_switch { 145 struct device dev; 146 struct tb_regs_switch_header config; 147 struct tb_port *ports; 148 struct tb_dma_port *dma_port; 149 struct tb_switch_tmu tmu; 150 struct tb *tb; 151 u64 uid; 152 uuid_t *uuid; 153 u16 vendor; 154 u16 device; 155 const char *vendor_name; 156 const char *device_name; 157 unsigned int link_speed; 158 unsigned int link_width; 159 bool link_usb4; 160 unsigned int generation; 161 int cap_plug_events; 162 int cap_lc; 163 bool is_unplugged; 164 u8 *drom; 165 struct tb_nvm *nvm; 166 bool no_nvm_upgrade; 167 bool safe_mode; 168 bool boot; 169 bool rpm; 170 unsigned int authorized; 171 enum tb_security_level security_level; 172 struct dentry *debugfs_dir; 173 u8 *key; 174 u8 connection_id; 175 u8 connection_key; 176 u8 link; 177 u8 depth; 178 struct completion rpm_complete; 179 unsigned long quirks; 180 }; 181 182 /** 183 * struct tb_port - a thunderbolt port, part of a tb_switch 184 * @config: Cached port configuration read from registers 185 * @sw: Switch the port belongs to 186 * @remote: Remote port (%NULL if not connected) 187 * @xdomain: Remote host (%NULL if not connected) 188 * @cap_phy: Offset, zero if not found 189 * @cap_tmu: Offset of the adapter specific TMU capability (%0 if not present) 190 * @cap_adap: Offset of the adapter specific capability (%0 if not present) 191 * @cap_usb4: Offset to the USB4 port capability (%0 if not present) 192 * @port: Port number on switch 193 * @disabled: Disabled by eeprom or enabled but not implemented 194 * @bonded: true if the port is bonded (two lanes combined as one) 195 * @dual_link_port: If the switch is connected using two ports, points 196 * to the other port. 197 * @link_nr: Is this primary or secondary port on the dual_link. 198 * @in_hopids: Currently allocated input HopIDs 199 * @out_hopids: Currently allocated output HopIDs 200 * @list: Used to link ports to DP resources list 201 * 202 * In USB4 terminology this structure represents an adapter (protocol or 203 * lane adapter). 204 */ 205 struct tb_port { 206 struct tb_regs_port_header config; 207 struct tb_switch *sw; 208 struct tb_port *remote; 209 struct tb_xdomain *xdomain; 210 int cap_phy; 211 int cap_tmu; 212 int cap_adap; 213 int cap_usb4; 214 u8 port; 215 bool disabled; 216 bool bonded; 217 struct tb_port *dual_link_port; 218 u8 link_nr:1; 219 struct ida in_hopids; 220 struct ida out_hopids; 221 struct list_head list; 222 }; 223 224 /** 225 * tb_retimer: Thunderbolt retimer 226 * @dev: Device for the retimer 227 * @tb: Pointer to the domain the retimer belongs to 228 * @index: Retimer index facing the router USB4 port 229 * @vendor: Vendor ID of the retimer 230 * @device: Device ID of the retimer 231 * @port: Pointer to the lane 0 adapter 232 * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise) 233 * @auth_status: Status of last NVM authentication 234 */ 235 struct tb_retimer { 236 struct device dev; 237 struct tb *tb; 238 u8 index; 239 u32 vendor; 240 u32 device; 241 struct tb_port *port; 242 struct tb_nvm *nvm; 243 u32 auth_status; 244 }; 245 246 /** 247 * struct tb_path_hop - routing information for a tb_path 248 * @in_port: Ingress port of a switch 249 * @out_port: Egress port of a switch where the packet is routed out 250 * (must be on the same switch than @in_port) 251 * @in_hop_index: HopID where the path configuration entry is placed in 252 * the path config space of @in_port. 253 * @in_counter_index: Used counter index (not used in the driver 254 * currently, %-1 to disable) 255 * @next_hop_index: HopID of the packet when it is routed out from @out_port 256 * @initial_credits: Number of initial flow control credits allocated for 257 * the path 258 * 259 * Hop configuration is always done on the IN port of a switch. 260 * in_port and out_port have to be on the same switch. Packets arriving on 261 * in_port with "hop" = in_hop_index will get routed to through out_port. The 262 * next hop to take (on out_port->remote) is determined by 263 * next_hop_index. When routing packet to another switch (out->remote is 264 * set) the @next_hop_index must match the @in_hop_index of that next 265 * hop to make routing possible. 266 * 267 * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in 268 * port. 269 */ 270 struct tb_path_hop { 271 struct tb_port *in_port; 272 struct tb_port *out_port; 273 int in_hop_index; 274 int in_counter_index; 275 int next_hop_index; 276 unsigned int initial_credits; 277 }; 278 279 /** 280 * enum tb_path_port - path options mask 281 * @TB_PATH_NONE: Do not activate on any hop on path 282 * @TB_PATH_SOURCE: Activate on the first hop (out of src) 283 * @TB_PATH_INTERNAL: Activate on the intermediate hops (not the first/last) 284 * @TB_PATH_DESTINATION: Activate on the last hop (into dst) 285 * @TB_PATH_ALL: Activate on all hops on the path 286 */ 287 enum tb_path_port { 288 TB_PATH_NONE = 0, 289 TB_PATH_SOURCE = 1, 290 TB_PATH_INTERNAL = 2, 291 TB_PATH_DESTINATION = 4, 292 TB_PATH_ALL = 7, 293 }; 294 295 /** 296 * struct tb_path - a unidirectional path between two ports 297 * @tb: Pointer to the domain structure 298 * @name: Name of the path (used for debugging) 299 * @nfc_credits: Number of non flow controlled credits allocated for the path 300 * @ingress_shared_buffer: Shared buffering used for ingress ports on the path 301 * @egress_shared_buffer: Shared buffering used for egress ports on the path 302 * @ingress_fc_enable: Flow control for ingress ports on the path 303 * @egress_fc_enable: Flow control for egress ports on the path 304 * @priority: Priority group if the path 305 * @weight: Weight of the path inside the priority group 306 * @drop_packages: Drop packages from queue tail or head 307 * @activated: Is the path active 308 * @clear_fc: Clear all flow control from the path config space entries 309 * when deactivating this path 310 * @hops: Path hops 311 * @path_length: How many hops the path uses 312 * 313 * A path consists of a number of hops (see &struct tb_path_hop). To 314 * establish a PCIe tunnel two paths have to be created between the two 315 * PCIe ports. 316 */ 317 struct tb_path { 318 struct tb *tb; 319 const char *name; 320 int nfc_credits; 321 enum tb_path_port ingress_shared_buffer; 322 enum tb_path_port egress_shared_buffer; 323 enum tb_path_port ingress_fc_enable; 324 enum tb_path_port egress_fc_enable; 325 326 unsigned int priority:3; 327 int weight:4; 328 bool drop_packages; 329 bool activated; 330 bool clear_fc; 331 struct tb_path_hop *hops; 332 int path_length; 333 }; 334 335 /* HopIDs 0-7 are reserved by the Thunderbolt protocol */ 336 #define TB_PATH_MIN_HOPID 8 337 /* 338 * Support paths from the farthest (depth 6) router to the host and back 339 * to the same level (not necessarily to the same router). 340 */ 341 #define TB_PATH_MAX_HOPS (7 * 2) 342 343 /* Possible wake types */ 344 #define TB_WAKE_ON_CONNECT BIT(0) 345 #define TB_WAKE_ON_DISCONNECT BIT(1) 346 #define TB_WAKE_ON_USB4 BIT(2) 347 #define TB_WAKE_ON_USB3 BIT(3) 348 #define TB_WAKE_ON_PCIE BIT(4) 349 350 /** 351 * struct tb_cm_ops - Connection manager specific operations vector 352 * @driver_ready: Called right after control channel is started. Used by 353 * ICM to send driver ready message to the firmware. 354 * @start: Starts the domain 355 * @stop: Stops the domain 356 * @suspend_noirq: Connection manager specific suspend_noirq 357 * @resume_noirq: Connection manager specific resume_noirq 358 * @suspend: Connection manager specific suspend 359 * @freeze_noirq: Connection manager specific freeze_noirq 360 * @thaw_noirq: Connection manager specific thaw_noirq 361 * @complete: Connection manager specific complete 362 * @runtime_suspend: Connection manager specific runtime_suspend 363 * @runtime_resume: Connection manager specific runtime_resume 364 * @runtime_suspend_switch: Runtime suspend a switch 365 * @runtime_resume_switch: Runtime resume a switch 366 * @handle_event: Handle thunderbolt event 367 * @get_boot_acl: Get boot ACL list 368 * @set_boot_acl: Set boot ACL list 369 * @disapprove_switch: Disapprove switch (disconnect PCIe tunnel) 370 * @approve_switch: Approve switch 371 * @add_switch_key: Add key to switch 372 * @challenge_switch_key: Challenge switch using key 373 * @disconnect_pcie_paths: Disconnects PCIe paths before NVM update 374 * @approve_xdomain_paths: Approve (establish) XDomain DMA paths 375 * @disconnect_xdomain_paths: Disconnect XDomain DMA paths 376 * @usb4_switch_op: Optional proxy for USB4 router operations. If set 377 * this will be called whenever USB4 router operation is 378 * performed. If this returns %-EOPNOTSUPP then the 379 * native USB4 router operation is called. 380 * @usb4_switch_nvm_authenticate_status: Optional callback that the CM 381 * implementation can be used to 382 * return status of USB4 NVM_AUTH 383 * router operation. 384 */ 385 struct tb_cm_ops { 386 int (*driver_ready)(struct tb *tb); 387 int (*start)(struct tb *tb); 388 void (*stop)(struct tb *tb); 389 int (*suspend_noirq)(struct tb *tb); 390 int (*resume_noirq)(struct tb *tb); 391 int (*suspend)(struct tb *tb); 392 int (*freeze_noirq)(struct tb *tb); 393 int (*thaw_noirq)(struct tb *tb); 394 void (*complete)(struct tb *tb); 395 int (*runtime_suspend)(struct tb *tb); 396 int (*runtime_resume)(struct tb *tb); 397 int (*runtime_suspend_switch)(struct tb_switch *sw); 398 int (*runtime_resume_switch)(struct tb_switch *sw); 399 void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type, 400 const void *buf, size_t size); 401 int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids); 402 int (*set_boot_acl)(struct tb *tb, const uuid_t *uuids, size_t nuuids); 403 int (*disapprove_switch)(struct tb *tb, struct tb_switch *sw); 404 int (*approve_switch)(struct tb *tb, struct tb_switch *sw); 405 int (*add_switch_key)(struct tb *tb, struct tb_switch *sw); 406 int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw, 407 const u8 *challenge, u8 *response); 408 int (*disconnect_pcie_paths)(struct tb *tb); 409 int (*approve_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd, 410 int transmit_path, int transmit_ring, 411 int receive_path, int receive_ring); 412 int (*disconnect_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd, 413 int transmit_path, int transmit_ring, 414 int receive_path, int receive_ring); 415 int (*usb4_switch_op)(struct tb_switch *sw, u16 opcode, u32 *metadata, 416 u8 *status, const void *tx_data, size_t tx_data_len, 417 void *rx_data, size_t rx_data_len); 418 int (*usb4_switch_nvm_authenticate_status)(struct tb_switch *sw, 419 u32 *status); 420 }; 421 422 static inline void *tb_priv(struct tb *tb) 423 { 424 return (void *)tb->privdata; 425 } 426 427 #define TB_AUTOSUSPEND_DELAY 15000 /* ms */ 428 429 /* helper functions & macros */ 430 431 /** 432 * tb_upstream_port() - return the upstream port of a switch 433 * 434 * Every switch has an upstream port (for the root switch it is the NHI). 435 * 436 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for 437 * non root switches (on the NHI port remote is always NULL). 438 * 439 * Return: Returns the upstream port of the switch. 440 */ 441 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw) 442 { 443 return &sw->ports[sw->config.upstream_port_number]; 444 } 445 446 /** 447 * tb_is_upstream_port() - Is the port upstream facing 448 * @port: Port to check 449 * 450 * Returns true if @port is upstream facing port. In case of dual link 451 * ports both return true. 452 */ 453 static inline bool tb_is_upstream_port(const struct tb_port *port) 454 { 455 const struct tb_port *upstream_port = tb_upstream_port(port->sw); 456 return port == upstream_port || port->dual_link_port == upstream_port; 457 } 458 459 static inline u64 tb_route(const struct tb_switch *sw) 460 { 461 return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo; 462 } 463 464 static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw) 465 { 466 u8 port; 467 468 port = route >> (sw->config.depth * 8); 469 if (WARN_ON(port > sw->config.max_port_number)) 470 return NULL; 471 return &sw->ports[port]; 472 } 473 474 /** 475 * tb_port_has_remote() - Does the port have switch connected downstream 476 * @port: Port to check 477 * 478 * Returns true only when the port is primary port and has remote set. 479 */ 480 static inline bool tb_port_has_remote(const struct tb_port *port) 481 { 482 if (tb_is_upstream_port(port)) 483 return false; 484 if (!port->remote) 485 return false; 486 if (port->dual_link_port && port->link_nr) 487 return false; 488 489 return true; 490 } 491 492 static inline bool tb_port_is_null(const struct tb_port *port) 493 { 494 return port && port->port && port->config.type == TB_TYPE_PORT; 495 } 496 497 static inline bool tb_port_is_nhi(const struct tb_port *port) 498 { 499 return port && port->config.type == TB_TYPE_NHI; 500 } 501 502 static inline bool tb_port_is_pcie_down(const struct tb_port *port) 503 { 504 return port && port->config.type == TB_TYPE_PCIE_DOWN; 505 } 506 507 static inline bool tb_port_is_pcie_up(const struct tb_port *port) 508 { 509 return port && port->config.type == TB_TYPE_PCIE_UP; 510 } 511 512 static inline bool tb_port_is_dpin(const struct tb_port *port) 513 { 514 return port && port->config.type == TB_TYPE_DP_HDMI_IN; 515 } 516 517 static inline bool tb_port_is_dpout(const struct tb_port *port) 518 { 519 return port && port->config.type == TB_TYPE_DP_HDMI_OUT; 520 } 521 522 static inline bool tb_port_is_usb3_down(const struct tb_port *port) 523 { 524 return port && port->config.type == TB_TYPE_USB3_DOWN; 525 } 526 527 static inline bool tb_port_is_usb3_up(const struct tb_port *port) 528 { 529 return port && port->config.type == TB_TYPE_USB3_UP; 530 } 531 532 static inline int tb_sw_read(struct tb_switch *sw, void *buffer, 533 enum tb_cfg_space space, u32 offset, u32 length) 534 { 535 if (sw->is_unplugged) 536 return -ENODEV; 537 return tb_cfg_read(sw->tb->ctl, 538 buffer, 539 tb_route(sw), 540 0, 541 space, 542 offset, 543 length); 544 } 545 546 static inline int tb_sw_write(struct tb_switch *sw, const void *buffer, 547 enum tb_cfg_space space, u32 offset, u32 length) 548 { 549 if (sw->is_unplugged) 550 return -ENODEV; 551 return tb_cfg_write(sw->tb->ctl, 552 buffer, 553 tb_route(sw), 554 0, 555 space, 556 offset, 557 length); 558 } 559 560 static inline int tb_port_read(struct tb_port *port, void *buffer, 561 enum tb_cfg_space space, u32 offset, u32 length) 562 { 563 if (port->sw->is_unplugged) 564 return -ENODEV; 565 return tb_cfg_read(port->sw->tb->ctl, 566 buffer, 567 tb_route(port->sw), 568 port->port, 569 space, 570 offset, 571 length); 572 } 573 574 static inline int tb_port_write(struct tb_port *port, const void *buffer, 575 enum tb_cfg_space space, u32 offset, u32 length) 576 { 577 if (port->sw->is_unplugged) 578 return -ENODEV; 579 return tb_cfg_write(port->sw->tb->ctl, 580 buffer, 581 tb_route(port->sw), 582 port->port, 583 space, 584 offset, 585 length); 586 } 587 588 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg) 589 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg) 590 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg) 591 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg) 592 #define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg) 593 594 #define __TB_SW_PRINT(level, sw, fmt, arg...) \ 595 do { \ 596 const struct tb_switch *__sw = (sw); \ 597 level(__sw->tb, "%llx: " fmt, \ 598 tb_route(__sw), ## arg); \ 599 } while (0) 600 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg) 601 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg) 602 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg) 603 #define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg) 604 605 #define __TB_PORT_PRINT(level, _port, fmt, arg...) \ 606 do { \ 607 const struct tb_port *__port = (_port); \ 608 level(__port->sw->tb, "%llx:%x: " fmt, \ 609 tb_route(__port->sw), __port->port, ## arg); \ 610 } while (0) 611 #define tb_port_WARN(port, fmt, arg...) \ 612 __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg) 613 #define tb_port_warn(port, fmt, arg...) \ 614 __TB_PORT_PRINT(tb_warn, port, fmt, ##arg) 615 #define tb_port_info(port, fmt, arg...) \ 616 __TB_PORT_PRINT(tb_info, port, fmt, ##arg) 617 #define tb_port_dbg(port, fmt, arg...) \ 618 __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg) 619 620 struct tb *icm_probe(struct tb_nhi *nhi); 621 struct tb *tb_probe(struct tb_nhi *nhi); 622 623 extern struct device_type tb_domain_type; 624 extern struct device_type tb_retimer_type; 625 extern struct device_type tb_switch_type; 626 627 int tb_domain_init(void); 628 void tb_domain_exit(void); 629 int tb_xdomain_init(void); 630 void tb_xdomain_exit(void); 631 632 struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize); 633 int tb_domain_add(struct tb *tb); 634 void tb_domain_remove(struct tb *tb); 635 int tb_domain_suspend_noirq(struct tb *tb); 636 int tb_domain_resume_noirq(struct tb *tb); 637 int tb_domain_suspend(struct tb *tb); 638 int tb_domain_freeze_noirq(struct tb *tb); 639 int tb_domain_thaw_noirq(struct tb *tb); 640 void tb_domain_complete(struct tb *tb); 641 int tb_domain_runtime_suspend(struct tb *tb); 642 int tb_domain_runtime_resume(struct tb *tb); 643 int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw); 644 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw); 645 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw); 646 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw); 647 int tb_domain_disconnect_pcie_paths(struct tb *tb); 648 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd, 649 int transmit_path, int transmit_ring, 650 int receive_path, int receive_ring); 651 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd, 652 int transmit_path, int transmit_ring, 653 int receive_path, int receive_ring); 654 int tb_domain_disconnect_all_paths(struct tb *tb); 655 656 static inline struct tb *tb_domain_get(struct tb *tb) 657 { 658 if (tb) 659 get_device(&tb->dev); 660 return tb; 661 } 662 663 static inline void tb_domain_put(struct tb *tb) 664 { 665 put_device(&tb->dev); 666 } 667 668 struct tb_nvm *tb_nvm_alloc(struct device *dev); 669 int tb_nvm_add_active(struct tb_nvm *nvm, size_t size, nvmem_reg_read_t reg_read); 670 int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val, 671 size_t bytes); 672 int tb_nvm_add_non_active(struct tb_nvm *nvm, size_t size, 673 nvmem_reg_write_t reg_write); 674 void tb_nvm_free(struct tb_nvm *nvm); 675 void tb_nvm_exit(void); 676 677 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent, 678 u64 route); 679 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb, 680 struct device *parent, u64 route); 681 int tb_switch_configure(struct tb_switch *sw); 682 int tb_switch_add(struct tb_switch *sw); 683 void tb_switch_remove(struct tb_switch *sw); 684 void tb_switch_suspend(struct tb_switch *sw, bool runtime); 685 int tb_switch_resume(struct tb_switch *sw); 686 int tb_switch_reset(struct tb_switch *sw); 687 void tb_sw_set_unplugged(struct tb_switch *sw); 688 struct tb_port *tb_switch_find_port(struct tb_switch *sw, 689 enum tb_port_type type); 690 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link, 691 u8 depth); 692 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid); 693 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route); 694 695 /** 696 * tb_switch_for_each_port() - Iterate over each switch port 697 * @sw: Switch whose ports to iterate 698 * @p: Port used as iterator 699 * 700 * Iterates over each switch port skipping the control port (port %0). 701 */ 702 #define tb_switch_for_each_port(sw, p) \ 703 for ((p) = &(sw)->ports[1]; \ 704 (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++) 705 706 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw) 707 { 708 if (sw) 709 get_device(&sw->dev); 710 return sw; 711 } 712 713 static inline void tb_switch_put(struct tb_switch *sw) 714 { 715 put_device(&sw->dev); 716 } 717 718 static inline bool tb_is_switch(const struct device *dev) 719 { 720 return dev->type == &tb_switch_type; 721 } 722 723 static inline struct tb_switch *tb_to_switch(struct device *dev) 724 { 725 if (tb_is_switch(dev)) 726 return container_of(dev, struct tb_switch, dev); 727 return NULL; 728 } 729 730 static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw) 731 { 732 return tb_to_switch(sw->dev.parent); 733 } 734 735 static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw) 736 { 737 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL && 738 sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE; 739 } 740 741 static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw) 742 { 743 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL && 744 sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE; 745 } 746 747 static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw) 748 { 749 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 750 switch (sw->config.device_id) { 751 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C: 752 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C: 753 return true; 754 } 755 } 756 return false; 757 } 758 759 static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw) 760 { 761 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 762 switch (sw->config.device_id) { 763 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE: 764 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE: 765 return true; 766 } 767 } 768 return false; 769 } 770 771 static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw) 772 { 773 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 774 switch (sw->config.device_id) { 775 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE: 776 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE: 777 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE: 778 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE: 779 return true; 780 } 781 } 782 return false; 783 } 784 785 static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw) 786 { 787 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) { 788 switch (sw->config.device_id) { 789 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE: 790 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE: 791 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE: 792 return true; 793 } 794 } 795 return false; 796 } 797 798 /** 799 * tb_switch_is_usb4() - Is the switch USB4 compliant 800 * @sw: Switch to check 801 * 802 * Returns true if the @sw is USB4 compliant router, false otherwise. 803 */ 804 static inline bool tb_switch_is_usb4(const struct tb_switch *sw) 805 { 806 return sw->config.thunderbolt_version == USB4_VERSION_1_0; 807 } 808 809 /** 810 * tb_switch_is_icm() - Is the switch handled by ICM firmware 811 * @sw: Switch to check 812 * 813 * In case there is a need to differentiate whether ICM firmware or SW CM 814 * is handling @sw this function can be called. It is valid to call this 815 * after tb_switch_alloc() and tb_switch_configure() has been called 816 * (latter only for SW CM case). 817 */ 818 static inline bool tb_switch_is_icm(const struct tb_switch *sw) 819 { 820 return !sw->config.enabled; 821 } 822 823 int tb_switch_lane_bonding_enable(struct tb_switch *sw); 824 void tb_switch_lane_bonding_disable(struct tb_switch *sw); 825 int tb_switch_configure_link(struct tb_switch *sw); 826 void tb_switch_unconfigure_link(struct tb_switch *sw); 827 828 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in); 829 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 830 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 831 832 int tb_switch_tmu_init(struct tb_switch *sw); 833 int tb_switch_tmu_post_time(struct tb_switch *sw); 834 int tb_switch_tmu_disable(struct tb_switch *sw); 835 int tb_switch_tmu_enable(struct tb_switch *sw); 836 837 static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw) 838 { 839 return sw->tmu.rate == TB_SWITCH_TMU_RATE_HIFI && 840 !sw->tmu.unidirectional; 841 } 842 843 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged); 844 int tb_port_add_nfc_credits(struct tb_port *port, int credits); 845 int tb_port_clear_counter(struct tb_port *port, int counter); 846 int tb_port_unlock(struct tb_port *port); 847 int tb_port_enable(struct tb_port *port); 848 int tb_port_disable(struct tb_port *port); 849 int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid); 850 void tb_port_release_in_hopid(struct tb_port *port, int hopid); 851 int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid); 852 void tb_port_release_out_hopid(struct tb_port *port, int hopid); 853 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end, 854 struct tb_port *prev); 855 856 /** 857 * tb_for_each_port_on_path() - Iterate over each port on path 858 * @src: Source port 859 * @dst: Destination port 860 * @p: Port used as iterator 861 * 862 * Walks over each port on path from @src to @dst. 863 */ 864 #define tb_for_each_port_on_path(src, dst, p) \ 865 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \ 866 (p) = tb_next_port_on_path((src), (dst), (p))) 867 868 int tb_port_get_link_speed(struct tb_port *port); 869 int tb_port_get_link_width(struct tb_port *port); 870 int tb_port_state(struct tb_port *port); 871 int tb_port_lane_bonding_enable(struct tb_port *port); 872 void tb_port_lane_bonding_disable(struct tb_port *port); 873 874 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec); 875 int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap); 876 int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset); 877 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap); 878 int tb_port_next_cap(struct tb_port *port, unsigned int offset); 879 bool tb_port_is_enabled(struct tb_port *port); 880 881 bool tb_usb3_port_is_enabled(struct tb_port *port); 882 int tb_usb3_port_enable(struct tb_port *port, bool enable); 883 884 bool tb_pci_port_is_enabled(struct tb_port *port); 885 int tb_pci_port_enable(struct tb_port *port, bool enable); 886 887 int tb_dp_port_hpd_is_active(struct tb_port *port); 888 int tb_dp_port_hpd_clear(struct tb_port *port); 889 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video, 890 unsigned int aux_tx, unsigned int aux_rx); 891 bool tb_dp_port_is_enabled(struct tb_port *port); 892 int tb_dp_port_enable(struct tb_port *port, bool enable); 893 894 struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid, 895 struct tb_port *dst, int dst_hopid, 896 struct tb_port **last, const char *name); 897 struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid, 898 struct tb_port *dst, int dst_hopid, int link_nr, 899 const char *name); 900 void tb_path_free(struct tb_path *path); 901 int tb_path_activate(struct tb_path *path); 902 void tb_path_deactivate(struct tb_path *path); 903 bool tb_path_is_invalid(struct tb_path *path); 904 bool tb_path_port_on_path(const struct tb_path *path, 905 const struct tb_port *port); 906 907 int tb_drom_read(struct tb_switch *sw); 908 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid); 909 910 int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid); 911 int tb_lc_configure_port(struct tb_port *port); 912 void tb_lc_unconfigure_port(struct tb_port *port); 913 int tb_lc_configure_xdomain(struct tb_port *port); 914 void tb_lc_unconfigure_xdomain(struct tb_port *port); 915 int tb_lc_start_lane_initialization(struct tb_port *port); 916 int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags); 917 int tb_lc_set_sleep(struct tb_switch *sw); 918 bool tb_lc_lane_bonding_possible(struct tb_switch *sw); 919 bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in); 920 int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in); 921 int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in); 922 int tb_lc_force_power(struct tb_switch *sw); 923 924 static inline int tb_route_length(u64 route) 925 { 926 return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT; 927 } 928 929 /** 930 * tb_downstream_route() - get route to downstream switch 931 * 932 * Port must not be the upstream port (otherwise a loop is created). 933 * 934 * Return: Returns a route to the switch behind @port. 935 */ 936 static inline u64 tb_downstream_route(struct tb_port *port) 937 { 938 return tb_route(port->sw) 939 | ((u64) port->port << (port->sw->config.depth * 8)); 940 } 941 942 bool tb_is_xdomain_enabled(void); 943 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type, 944 const void *buf, size_t size); 945 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent, 946 u64 route, const uuid_t *local_uuid, 947 const uuid_t *remote_uuid); 948 void tb_xdomain_add(struct tb_xdomain *xd); 949 void tb_xdomain_remove(struct tb_xdomain *xd); 950 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link, 951 u8 depth); 952 953 int tb_retimer_scan(struct tb_port *port); 954 void tb_retimer_remove_all(struct tb_port *port); 955 956 static inline bool tb_is_retimer(const struct device *dev) 957 { 958 return dev->type == &tb_retimer_type; 959 } 960 961 static inline struct tb_retimer *tb_to_retimer(struct device *dev) 962 { 963 if (tb_is_retimer(dev)) 964 return container_of(dev, struct tb_retimer, dev); 965 return NULL; 966 } 967 968 int usb4_switch_setup(struct tb_switch *sw); 969 int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid); 970 int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf, 971 size_t size); 972 bool usb4_switch_lane_bonding_possible(struct tb_switch *sw); 973 int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags); 974 int usb4_switch_set_sleep(struct tb_switch *sw); 975 int usb4_switch_nvm_sector_size(struct tb_switch *sw); 976 int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf, 977 size_t size); 978 int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address, 979 const void *buf, size_t size); 980 int usb4_switch_nvm_authenticate(struct tb_switch *sw); 981 int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status); 982 bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in); 983 int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 984 int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in); 985 struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw, 986 const struct tb_port *port); 987 struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw, 988 const struct tb_port *port); 989 990 int usb4_port_unlock(struct tb_port *port); 991 int usb4_port_configure(struct tb_port *port); 992 void usb4_port_unconfigure(struct tb_port *port); 993 int usb4_port_configure_xdomain(struct tb_port *port); 994 void usb4_port_unconfigure_xdomain(struct tb_port *port); 995 int usb4_port_enumerate_retimers(struct tb_port *port); 996 997 int usb4_port_retimer_read(struct tb_port *port, u8 index, u8 reg, void *buf, 998 u8 size); 999 int usb4_port_retimer_write(struct tb_port *port, u8 index, u8 reg, 1000 const void *buf, u8 size); 1001 int usb4_port_retimer_is_last(struct tb_port *port, u8 index); 1002 int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index); 1003 int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index, 1004 unsigned int address, const void *buf, 1005 size_t size); 1006 int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index); 1007 int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index, 1008 u32 *status); 1009 int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index, 1010 unsigned int address, void *buf, size_t size); 1011 1012 int usb4_usb3_port_max_link_rate(struct tb_port *port); 1013 int usb4_usb3_port_actual_link_rate(struct tb_port *port); 1014 int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw, 1015 int *downstream_bw); 1016 int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw, 1017 int *downstream_bw); 1018 int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw, 1019 int *downstream_bw); 1020 1021 /* Keep link controller awake during update */ 1022 #define QUIRK_FORCE_POWER_LINK_CONTROLLER BIT(0) 1023 1024 void tb_check_quirks(struct tb_switch *sw); 1025 1026 #ifdef CONFIG_ACPI 1027 void tb_acpi_add_links(struct tb_nhi *nhi); 1028 1029 bool tb_acpi_is_native(void); 1030 bool tb_acpi_may_tunnel_usb3(void); 1031 bool tb_acpi_may_tunnel_dp(void); 1032 bool tb_acpi_may_tunnel_pcie(void); 1033 bool tb_acpi_is_xdomain_allowed(void); 1034 #else 1035 static inline void tb_acpi_add_links(struct tb_nhi *nhi) { } 1036 1037 static inline bool tb_acpi_is_native(void) { return true; } 1038 static inline bool tb_acpi_may_tunnel_usb3(void) { return true; } 1039 static inline bool tb_acpi_may_tunnel_dp(void) { return true; } 1040 static inline bool tb_acpi_may_tunnel_pcie(void) { return true; } 1041 static inline bool tb_acpi_is_xdomain_allowed(void) { return true; } 1042 #endif 1043 1044 #ifdef CONFIG_DEBUG_FS 1045 void tb_debugfs_init(void); 1046 void tb_debugfs_exit(void); 1047 void tb_switch_debugfs_init(struct tb_switch *sw); 1048 void tb_switch_debugfs_remove(struct tb_switch *sw); 1049 void tb_service_debugfs_init(struct tb_service *svc); 1050 void tb_service_debugfs_remove(struct tb_service *svc); 1051 #else 1052 static inline void tb_debugfs_init(void) { } 1053 static inline void tb_debugfs_exit(void) { } 1054 static inline void tb_switch_debugfs_init(struct tb_switch *sw) { } 1055 static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { } 1056 static inline void tb_service_debugfs_init(struct tb_service *svc) { } 1057 static inline void tb_service_debugfs_remove(struct tb_service *svc) { } 1058 #endif 1059 1060 #ifdef CONFIG_USB4_KUNIT_TEST 1061 int tb_test_init(void); 1062 void tb_test_exit(void); 1063 #else 1064 static inline int tb_test_init(void) { return 0; } 1065 static inline void tb_test_exit(void) { } 1066 #endif 1067 1068 #endif 1069