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