drivers/thunderbolt/tb.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Thunderbolt driver - bus logic (NHI independent)
   4  *
   5  * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
   6  * Copyright (C) 2018, Intel Corporation
   7  */
   8
   9 #ifndef TB_H_
  10 #define TB_H_
  11
  12 #include <linux/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
  27 /**
  28  * struct tb_nvm - Structure holding NVM information
  29  * @dev: Owner of the NVM
  30  * @major: Major version number of the active NVM portion
  31  * @minor: Minor version number of the active NVM portion
  32  * @id: Identifier used with both NVM portions
  33  * @active: Active portion NVMem device
  34  * @active_size: Size in bytes of the active NVM
  35  * @non_active: Non-active portion NVMem device
  36  * @buf: Buffer where the NVM image is stored before it is written to
  37  *       the actual NVM flash device
  38  * @buf_data_start: Where the actual image starts after skipping
  39  *                  possible headers
  40  * @buf_data_size: Number of bytes actually consumed by the new NVM
  41  *                 image
  42  * @authenticating: The device is authenticating the new NVM
  43  * @flushed: The image has been flushed to the storage area
  44  * @vops: Router vendor specific NVM operations (optional)
  45  *
  46  * The user of this structure needs to handle serialization of possible
  47  * concurrent access.
  48  */
  49 struct tb_nvm {
  50         struct device *dev;
  51         u32 major;
  52         u32 minor;
  53         int id;
  54         struct nvmem_device *active;
  55         size_t active_size;
  56         struct nvmem_device *non_active;
  57         void *buf;
  58         void *buf_data_start;
  59         size_t buf_data_size;
  60         bool authenticating;
  61         bool flushed;
  62         const struct tb_nvm_vendor_ops *vops;
  63 };
  64
  65 enum tb_nvm_write_ops {
  66         WRITE_AND_AUTHENTICATE = 1,
  67         WRITE_ONLY = 2,
  68         AUTHENTICATE_ONLY = 3,
  69 };
  70
  71 #define TB_SWITCH_KEY_SIZE              32
  72 #define TB_SWITCH_MAX_DEPTH             6
  73 #define USB4_SWITCH_MAX_DEPTH           5
  74
  75 /**
  76  * enum tb_switch_tmu_mode - TMU mode
  77  * @TB_SWITCH_TMU_MODE_OFF: TMU is off
  78  * @TB_SWITCH_TMU_MODE_LOWRES: Uni-directional, normal mode
  79  * @TB_SWITCH_TMU_MODE_HIFI_UNI: Uni-directional, HiFi mode
  80  * @TB_SWITCH_TMU_MODE_HIFI_BI: Bi-directional, HiFi mode
  81  * @TB_SWITCH_TMU_MODE_MEDRES_ENHANCED_UNI: Enhanced Uni-directional, MedRes mode
  82  *
  83  * Ordering is based on TMU accuracy level (highest last).
  84  */
  85 enum tb_switch_tmu_mode {
  86         TB_SWITCH_TMU_MODE_OFF,
  87         TB_SWITCH_TMU_MODE_LOWRES,
  88         TB_SWITCH_TMU_MODE_HIFI_UNI,
  89         TB_SWITCH_TMU_MODE_HIFI_BI,
  90         TB_SWITCH_TMU_MODE_MEDRES_ENHANCED_UNI,
  91 };
  92
  93 /**
  94  * struct tb_switch_tmu - Structure holding router TMU configuration
  95  * @cap: Offset to the TMU capability (%0 if not found)
  96  * @has_ucap: Does the switch support uni-directional mode
  97  * @mode: TMU mode related to the upstream router. Reflects the HW
  98  *        setting. Don't care for host router.
  99  * @mode_request: TMU mode requested to set. Related to upstream router.
 100  *                 Don't care for host router.
 101  */
 102 struct tb_switch_tmu {
 103         int cap;
 104         bool has_ucap;
 105         enum tb_switch_tmu_mode mode;
 106         enum tb_switch_tmu_mode mode_request;
 107 };
 108
 109 /**
 110  * struct tb_switch - a thunderbolt switch
 111  * @dev: Device for the switch
 112  * @config: Switch configuration
 113  * @ports: Ports in this switch
 114  * @dma_port: If the switch has port supporting DMA configuration based
 115  *            mailbox this will hold the pointer to that (%NULL
 116  *            otherwise). If set it also means the switch has
 117  *            upgradeable NVM.
 118  * @tmu: The switch TMU configuration
 119  * @tb: Pointer to the domain the switch belongs to
 120  * @uid: Unique ID of the switch
 121  * @uuid: UUID of the switch (or %NULL if not supported)
 122  * @vendor: Vendor ID of the switch
 123  * @device: Device ID of the switch
 124  * @vendor_name: Name of the vendor (or %NULL if not known)
 125  * @device_name: Name of the device (or %NULL if not known)
 126  * @link_speed: Speed of the link in Gb/s
 127  * @link_width: Width of the upstream facing link
 128  * @preferred_link_width: Router preferred link width (only set for Gen 4 links)
 129  * @link_usb4: Upstream link is USB4
 130  * @generation: Switch Thunderbolt generation
 131  * @cap_plug_events: Offset to the plug events capability (%0 if not found)
 132  * @cap_vsec_tmu: Offset to the TMU vendor specific capability (%0 if not found)
 133  * @cap_lc: Offset to the link controller capability (%0 if not found)
 134  * @cap_lp: Offset to the low power (CLx for TBT) capability (%0 if not found)
 135  * @is_unplugged: The switch is going away
 136  * @drom: DROM of the switch (%NULL if not found)
 137  * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
 138  * @no_nvm_upgrade: Prevent NVM upgrade of this switch
 139  * @safe_mode: The switch is in safe-mode
 140  * @boot: Whether the switch was already authorized on boot or not
 141  * @rpm: The switch supports runtime PM
 142  * @authorized: Whether the switch is authorized by user or policy
 143  * @security_level: Switch supported security level
 144  * @debugfs_dir: Pointer to the debugfs structure
 145  * @key: Contains the key used to challenge the device or %NULL if not
 146  *       supported. Size of the key is %TB_SWITCH_KEY_SIZE.
 147  * @connection_id: Connection ID used with ICM messaging
 148  * @connection_key: Connection key used with ICM messaging
 149  * @link: Root switch link this switch is connected (ICM only)
 150  * @depth: Depth in the chain this switch is connected (ICM only)
 151  * @rpm_complete: Completion used to wait for runtime resume to
 152  *                complete (ICM only)
 153  * @quirks: Quirks used for this Thunderbolt switch
 154  * @credit_allocation: Are the below buffer allocation parameters valid
 155  * @max_usb3_credits: Router preferred number of buffers for USB 3.x
 156  * @min_dp_aux_credits: Router preferred minimum number of buffers for DP AUX
 157  * @min_dp_main_credits: Router preferred minimum number of buffers for DP MAIN
 158  * @max_pcie_credits: Router preferred number of buffers for PCIe
 159  * @max_dma_credits: Router preferred number of buffers for DMA/P2P
 160  * @clx: CLx states on the upstream link of the router
 161  *
 162  * When the switch is being added or removed to the domain (other
 163  * switches) you need to have domain lock held.
 164  *
 165  * In USB4 terminology this structure represents a router.
 166  */
 167 struct tb_switch {
 168         struct device dev;
 169         struct tb_regs_switch_header config;
 170         struct tb_port *ports;
 171         struct tb_dma_port *dma_port;
 172         struct tb_switch_tmu tmu;
 173         struct tb *tb;
 174         u64 uid;
 175         uuid_t *uuid;
 176         u16 vendor;
 177         u16 device;
 178         const char *vendor_name;
 179         const char *device_name;
 180         unsigned int link_speed;
 181         enum tb_link_width link_width;
 182         enum tb_link_width preferred_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  *
 262  * In USB4 terminology this structure represents an adapter (protocol or
 263  * lane adapter).
 264  */
 265 struct tb_port {
 266         struct tb_regs_port_header config;
 267         struct tb_switch *sw;
 268         struct tb_port *remote;
 269         struct tb_xdomain *xdomain;
 270         int cap_phy;
 271         int cap_tmu;
 272         int cap_adap;
 273         int cap_usb4;
 274         struct usb4_port *usb4;
 275         u8 port;
 276         bool disabled;
 277         bool bonded;
 278         struct tb_port *dual_link_port;
 279         u8 link_nr:1;
 280         struct ida in_hopids;
 281         struct ida out_hopids;
 282         struct list_head list;
 283         unsigned int total_credits;
 284         unsigned int ctl_credits;
 285         unsigned int dma_credits;
 286         struct tb_bandwidth_group *group;
 287         struct list_head group_list;
 288         unsigned int max_bw;
 289 };
 290
 291 /**
 292  * struct usb4_port - USB4 port device
 293  * @dev: Device for the port
 294  * @port: Pointer to the lane 0 adapter
 295  * @can_offline: Does the port have necessary platform support to moved
 296  *               it into offline mode and back
 297  * @offline: The port is currently in offline mode
 298  * @margining: Pointer to margining structure if enabled
 299  */
 300 struct usb4_port {
 301         struct device dev;
 302         struct tb_port *port;
 303         bool can_offline;
 304         bool offline;
 305 #ifdef CONFIG_USB4_DEBUGFS_MARGINING
 306         struct tb_margining *margining;
 307 #endif
 308 };
 309
 310 /**
 311  * tb_retimer: Thunderbolt retimer
 312  * @dev: Device for the retimer
 313  * @tb: Pointer to the domain the retimer belongs to
 314  * @index: Retimer index facing the router USB4 port
 315  * @vendor: Vendor ID of the retimer
 316  * @device: Device ID of the retimer
 317  * @port: Pointer to the lane 0 adapter
 318  * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise)
 319  * @no_nvm_upgrade: Prevent NVM upgrade of this retimer
 320  * @auth_status: Status of last NVM authentication
 321  */
 322 struct tb_retimer {
 323         struct device dev;
 324         struct tb *tb;
 325         u8 index;
 326         u32 vendor;
 327         u32 device;
 328         struct tb_port *port;
 329         struct tb_nvm *nvm;
 330         bool no_nvm_upgrade;
 331         u32 auth_status;
 332 };
 333
 334 /**
 335  * struct tb_path_hop - routing information for a tb_path
 336  * @in_port: Ingress port of a switch
 337  * @out_port: Egress port of a switch where the packet is routed out
 338  *            (must be on the same switch than @in_port)
 339  * @in_hop_index: HopID where the path configuration entry is placed in
 340  *                the path config space of @in_port.
 341  * @in_counter_index: Used counter index (not used in the driver
 342  *                    currently, %-1 to disable)
 343  * @next_hop_index: HopID of the packet when it is routed out from @out_port
 344  * @initial_credits: Number of initial flow control credits allocated for
 345  *                   the path
 346  * @nfc_credits: Number of non-flow controlled buffers allocated for the
 347  *               @in_port.
 348  * @pm_support: Set path PM packet support bit to 1 (for USB4 v2 routers)
 349  *
 350  * Hop configuration is always done on the IN port of a switch.
 351  * in_port and out_port have to be on the same switch. Packets arriving on
 352  * in_port with "hop" = in_hop_index will get routed to through out_port. The
 353  * next hop to take (on out_port->remote) is determined by
 354  * next_hop_index. When routing packet to another switch (out->remote is
 355  * set) the @next_hop_index must match the @in_hop_index of that next
 356  * hop to make routing possible.
 357  *
 358  * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
 359  * port.
 360  */
 361 struct tb_path_hop {
 362         struct tb_port *in_port;
 363         struct tb_port *out_port;
 364         int in_hop_index;
 365         int in_counter_index;
 366         int next_hop_index;
 367         unsigned int initial_credits;
 368         unsigned int nfc_credits;
 369         bool pm_support;
 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);
 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 static inline const char *tb_width_name(enum tb_link_width width)
 574 {
 575         switch (width) {
 576         case TB_LINK_WIDTH_SINGLE:
 577                 return "symmetric, single lane";
 578         case TB_LINK_WIDTH_DUAL:
 579                 return "symmetric, dual lanes";
 580         case TB_LINK_WIDTH_ASYM_TX:
 581                 return "asymmetric, 3 transmitters, 1 receiver";
 582         case TB_LINK_WIDTH_ASYM_RX:
 583                 return "asymmetric, 3 receivers, 1 transmitter";
 584         default:
 585                 return "unknown";
 586         }
 587 }
 588
 589 /**
 590  * tb_port_has_remote() - Does the port have switch connected downstream
 591  * @port: Port to check
 592  *
 593  * Returns true only when the port is primary port and has remote set.
 594  */
 595 static inline bool tb_port_has_remote(const struct tb_port *port)
 596 {
 597         if (tb_is_upstream_port(port))
 598                 return false;
 599         if (!port->remote)
 600                 return false;
 601         if (port->dual_link_port && port->link_nr)
 602                 return false;
 603
 604         return true;
 605 }
 606
 607 static inline bool tb_port_is_null(const struct tb_port *port)
 608 {
 609         return port && port->port && port->config.type == TB_TYPE_PORT;
 610 }
 611
 612 static inline bool tb_port_is_nhi(const struct tb_port *port)
 613 {
 614         return port && port->config.type == TB_TYPE_NHI;
 615 }
 616
 617 static inline bool tb_port_is_pcie_down(const struct tb_port *port)
 618 {
 619         return port && port->config.type == TB_TYPE_PCIE_DOWN;
 620 }
 621
 622 static inline bool tb_port_is_pcie_up(const struct tb_port *port)
 623 {
 624         return port && port->config.type == TB_TYPE_PCIE_UP;
 625 }
 626
 627 static inline bool tb_port_is_dpin(const struct tb_port *port)
 628 {
 629         return port && port->config.type == TB_TYPE_DP_HDMI_IN;
 630 }
 631
 632 static inline bool tb_port_is_dpout(const struct tb_port *port)
 633 {
 634         return port && port->config.type == TB_TYPE_DP_HDMI_OUT;
 635 }
 636
 637 static inline bool tb_port_is_usb3_down(const struct tb_port *port)
 638 {
 639         return port && port->config.type == TB_TYPE_USB3_DOWN;
 640 }
 641
 642 static inline bool tb_port_is_usb3_up(const struct tb_port *port)
 643 {
 644         return port && port->config.type == TB_TYPE_USB3_UP;
 645 }
 646
 647 static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
 648                              enum tb_cfg_space space, u32 offset, u32 length)
 649 {
 650         if (sw->is_unplugged)
 651                 return -ENODEV;
 652         return tb_cfg_read(sw->tb->ctl,
 653                            buffer,
 654                            tb_route(sw),
 655                            0,
 656                            space,
 657                            offset,
 658                            length);
 659 }
 660
 661 static inline int tb_sw_write(struct tb_switch *sw, const void *buffer,
 662                               enum tb_cfg_space space, u32 offset, u32 length)
 663 {
 664         if (sw->is_unplugged)
 665                 return -ENODEV;
 666         return tb_cfg_write(sw->tb->ctl,
 667                             buffer,
 668                             tb_route(sw),
 669                             0,
 670                             space,
 671                             offset,
 672                             length);
 673 }
 674
 675 static inline int tb_port_read(struct tb_port *port, void *buffer,
 676                                enum tb_cfg_space space, u32 offset, u32 length)
 677 {
 678         if (port->sw->is_unplugged)
 679                 return -ENODEV;
 680         return tb_cfg_read(port->sw->tb->ctl,
 681                            buffer,
 682                            tb_route(port->sw),
 683                            port->port,
 684                            space,
 685                            offset,
 686                            length);
 687 }
 688
 689 static inline int tb_port_write(struct tb_port *port, const void *buffer,
 690                                 enum tb_cfg_space space, u32 offset, u32 length)
 691 {
 692         if (port->sw->is_unplugged)
 693                 return -ENODEV;
 694         return tb_cfg_write(port->sw->tb->ctl,
 695                             buffer,
 696                             tb_route(port->sw),
 697                             port->port,
 698                             space,
 699                             offset,
 700                             length);
 701 }
 702
 703 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg)
 704 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
 705 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
 706 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
 707 #define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg)
 708
 709 #define __TB_SW_PRINT(level, sw, fmt, arg...)           \
 710         do {                                            \
 711                 const struct tb_switch *__sw = (sw);    \
 712                 level(__sw->tb, "%llx: " fmt,           \
 713                       tb_route(__sw), ## arg);          \
 714         } while (0)
 715 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
 716 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
 717 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
 718 #define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg)
 719
 720 #define __TB_PORT_PRINT(level, _port, fmt, arg...)                      \
 721         do {                                                            \
 722                 const struct tb_port *__port = (_port);                 \
 723                 level(__port->sw->tb, "%llx:%u: " fmt,                  \
 724                       tb_route(__port->sw), __port->port, ## arg);      \
 725         } while (0)
 726 #define tb_port_WARN(port, fmt, arg...) \
 727         __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg)
 728 #define tb_port_warn(port, fmt, arg...) \
 729         __TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
 730 #define tb_port_info(port, fmt, arg...) \
 731         __TB_PORT_PRINT(tb_info, port, fmt, ##arg)
 732 #define tb_port_dbg(port, fmt, arg...) \
 733         __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg)
 734
 735 struct tb *icm_probe(struct tb_nhi *nhi);
 736 struct tb *tb_probe(struct tb_nhi *nhi);
 737
 738 extern struct device_type tb_domain_type;
 739 extern struct device_type tb_retimer_type;
 740 extern struct device_type tb_switch_type;
 741 extern struct device_type usb4_port_device_type;
 742
 743 int tb_domain_init(void);
 744 void tb_domain_exit(void);
 745 int tb_xdomain_init(void);
 746 void tb_xdomain_exit(void);
 747
 748 struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize);
 749 int tb_domain_add(struct tb *tb);
 750 void tb_domain_remove(struct tb *tb);
 751 int tb_domain_suspend_noirq(struct tb *tb);
 752 int tb_domain_resume_noirq(struct tb *tb);
 753 int tb_domain_suspend(struct tb *tb);
 754 int tb_domain_freeze_noirq(struct tb *tb);
 755 int tb_domain_thaw_noirq(struct tb *tb);
 756 void tb_domain_complete(struct tb *tb);
 757 int tb_domain_runtime_suspend(struct tb *tb);
 758 int tb_domain_runtime_resume(struct tb *tb);
 759 int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw);
 760 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw);
 761 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw);
 762 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw);
 763 int tb_domain_disconnect_pcie_paths(struct tb *tb);
 764 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
 765                                     int transmit_path, int transmit_ring,
 766                                     int receive_path, int receive_ring);
 767 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
 768                                        int transmit_path, int transmit_ring,
 769                                        int receive_path, int receive_ring);
 770 int tb_domain_disconnect_all_paths(struct tb *tb);
 771
 772 static inline struct tb *tb_domain_get(struct tb *tb)
 773 {
 774         if (tb)
 775                 get_device(&tb->dev);
 776         return tb;
 777 }
 778
 779 static inline void tb_domain_put(struct tb *tb)
 780 {
 781         put_device(&tb->dev);
 782 }
 783
 784 struct tb_nvm *tb_nvm_alloc(struct device *dev);
 785 int tb_nvm_read_version(struct tb_nvm *nvm);
 786 int tb_nvm_validate(struct tb_nvm *nvm);
 787 int tb_nvm_write_headers(struct tb_nvm *nvm);
 788 int tb_nvm_add_active(struct tb_nvm *nvm, nvmem_reg_read_t reg_read);
 789 int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val,
 790                      size_t bytes);
 791 int tb_nvm_add_non_active(struct tb_nvm *nvm, nvmem_reg_write_t reg_write);
 792 void tb_nvm_free(struct tb_nvm *nvm);
 793 void tb_nvm_exit(void);
 794
 795 typedef int (*read_block_fn)(void *, unsigned int, void *, size_t);
 796 typedef int (*write_block_fn)(void *, unsigned int, const void *, size_t);
 797
 798 int tb_nvm_read_data(unsigned int address, void *buf, size_t size,
 799                      unsigned int retries, read_block_fn read_block,
 800                      void *read_block_data);
 801 int tb_nvm_write_data(unsigned int address, const void *buf, size_t size,
 802                       unsigned int retries, write_block_fn write_next_block,
 803                       void *write_block_data);
 804
 805 int tb_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
 806                        size_t size);
 807 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
 808                                   u64 route);
 809 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb,
 810                         struct device *parent, u64 route);
 811 int tb_switch_configure(struct tb_switch *sw);
 812 int tb_switch_configuration_valid(struct tb_switch *sw);
 813 int tb_switch_add(struct tb_switch *sw);
 814 void tb_switch_remove(struct tb_switch *sw);
 815 void tb_switch_suspend(struct tb_switch *sw, bool runtime);
 816 int tb_switch_resume(struct tb_switch *sw);
 817 int tb_switch_reset(struct tb_switch *sw);
 818 int tb_switch_wait_for_bit(struct tb_switch *sw, u32 offset, u32 bit,
 819                            u32 value, int timeout_msec);
 820 void tb_sw_set_unplugged(struct tb_switch *sw);
 821 struct tb_port *tb_switch_find_port(struct tb_switch *sw,
 822                                     enum tb_port_type type);
 823 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
 824                                                u8 depth);
 825 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
 826 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route);
 827
 828 /**
 829  * tb_switch_for_each_port() - Iterate over each switch port
 830  * @sw: Switch whose ports to iterate
 831  * @p: Port used as iterator
 832  *
 833  * Iterates over each switch port skipping the control port (port %0).
 834  */
 835 #define tb_switch_for_each_port(sw, p)                                  \
 836         for ((p) = &(sw)->ports[1];                                     \
 837              (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++)
 838
 839 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw)
 840 {
 841         if (sw)
 842                 get_device(&sw->dev);
 843         return sw;
 844 }
 845
 846 static inline void tb_switch_put(struct tb_switch *sw)
 847 {
 848         put_device(&sw->dev);
 849 }
 850
 851 static inline bool tb_is_switch(const struct device *dev)
 852 {
 853         return dev->type == &tb_switch_type;
 854 }
 855
 856 static inline struct tb_switch *tb_to_switch(const struct device *dev)
 857 {
 858         if (tb_is_switch(dev))
 859                 return container_of(dev, struct tb_switch, dev);
 860         return NULL;
 861 }
 862
 863 static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw)
 864 {
 865         return tb_to_switch(sw->dev.parent);
 866 }
 867
 868 /**
 869  * tb_switch_downstream_port() - Return downstream facing port of parent router
 870  * @sw: Device router pointer
 871  *
 872  * Only call for device routers. Returns the downstream facing port of
 873  * the parent router.
 874  */
 875 static inline struct tb_port *tb_switch_downstream_port(struct tb_switch *sw)
 876 {
 877         if (WARN_ON(!tb_route(sw)))
 878                 return NULL;
 879         return tb_port_at(tb_route(sw), tb_switch_parent(sw));
 880 }
 881
 882 /**
 883  * tb_switch_depth() - Returns depth of the connected router
 884  * @sw: Router
 885  */
 886 static inline int tb_switch_depth(const struct tb_switch *sw)
 887 {
 888         return sw->config.depth;
 889 }
 890
 891 static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw)
 892 {
 893         return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
 894                sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE;
 895 }
 896
 897 static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw)
 898 {
 899         return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
 900                sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE;
 901 }
 902
 903 static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw)
 904 {
 905         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
 906                 switch (sw->config.device_id) {
 907                 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
 908                 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
 909                         return true;
 910                 }
 911         }
 912         return false;
 913 }
 914
 915 static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw)
 916 {
 917         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
 918                 switch (sw->config.device_id) {
 919                 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
 920                 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
 921                         return true;
 922                 }
 923         }
 924         return false;
 925 }
 926
 927 static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw)
 928 {
 929         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
 930                 switch (sw->config.device_id) {
 931                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
 932                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE:
 933                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
 934                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
 935                 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
 936                         return true;
 937                 }
 938         }
 939         return false;
 940 }
 941
 942 static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw)
 943 {
 944         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
 945                 switch (sw->config.device_id) {
 946                 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
 947                 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
 948                 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
 949                         return true;
 950                 }
 951         }
 952         return false;
 953 }
 954
 955 static inline bool tb_switch_is_tiger_lake(const struct tb_switch *sw)
 956 {
 957         if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
 958                 switch (sw->config.device_id) {
 959                 case PCI_DEVICE_ID_INTEL_TGL_NHI0:
 960                 case PCI_DEVICE_ID_INTEL_TGL_NHI1:
 961                 case PCI_DEVICE_ID_INTEL_TGL_H_NHI0:
 962                 case PCI_DEVICE_ID_INTEL_TGL_H_NHI1:
 963                         return true;
 964                 }
 965         }
 966         return false;
 967 }
 968
 969 /**
 970  * tb_switch_is_icm() - Is the switch handled by ICM firmware
 971  * @sw: Switch to check
 972  *
 973  * In case there is a need to differentiate whether ICM firmware or SW CM
 974  * is handling @sw this function can be called. It is valid to call this
 975  * after tb_switch_alloc() and tb_switch_configure() has been called
 976  * (latter only for SW CM case).
 977  */
 978 static inline bool tb_switch_is_icm(const struct tb_switch *sw)
 979 {
 980         return !sw->config.enabled;
 981 }
 982
 983 int tb_switch_set_link_width(struct tb_switch *sw, enum tb_link_width width);
 984 int tb_switch_configure_link(struct tb_switch *sw);
 985 void tb_switch_unconfigure_link(struct tb_switch *sw);
 986
 987 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
 988 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
 989 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
 990
 991 int tb_switch_tmu_init(struct tb_switch *sw);
 992 int tb_switch_tmu_post_time(struct tb_switch *sw);
 993 int tb_switch_tmu_disable(struct tb_switch *sw);
 994 int tb_switch_tmu_enable(struct tb_switch *sw);
 995 int tb_switch_tmu_configure(struct tb_switch *sw, enum tb_switch_tmu_mode mode);
 996
 997 /**
 998  * tb_switch_tmu_is_configured() - Is given TMU mode configured
 999  * @sw: Router whose mode to check
1000  * @mode: Mode to check
1001  *
1002  * Checks if given router TMU mode is configured to @mode. Note the
1003  * router TMU might not be enabled to this mode.
1004  */
1005 static inline bool tb_switch_tmu_is_configured(const struct tb_switch *sw,
1006                                                enum tb_switch_tmu_mode mode)
1007 {
1008         return sw->tmu.mode_request == mode;
1009 }
1010
1011 /**
1012  * tb_switch_tmu_is_enabled() - Checks if the specified TMU mode is enabled
1013  * @sw: Router whose TMU mode to check
1014  *
1015  * Return true if hardware TMU configuration matches the requested
1016  * configuration (and is not %TB_SWITCH_TMU_MODE_OFF).
1017  */
1018 static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw)
1019 {
1020         return sw->tmu.mode != TB_SWITCH_TMU_MODE_OFF &&
1021                sw->tmu.mode == sw->tmu.mode_request;
1022 }
1023
1024 bool tb_port_clx_is_enabled(struct tb_port *port, unsigned int clx);
1025
1026 int tb_switch_clx_init(struct tb_switch *sw);
1027 int tb_switch_clx_enable(struct tb_switch *sw, unsigned int clx);
1028 int tb_switch_clx_disable(struct tb_switch *sw);
1029
1030 /**
1031  * tb_switch_clx_is_enabled() - Checks if the CLx is enabled
1032  * @sw: Router to check for the CLx
1033  * @clx: The CLx states to check for
1034  *
1035  * Checks if the specified CLx is enabled on the router upstream link.
1036  * Returns true if any of the given states is enabled.
1037  *
1038  * Not applicable for a host router.
1039  */
1040 static inline bool tb_switch_clx_is_enabled(const struct tb_switch *sw,
1041                                             unsigned int clx)
1042 {
1043         return sw->clx & clx;
1044 }
1045
1046 int tb_switch_pcie_l1_enable(struct tb_switch *sw);
1047
1048 int tb_switch_xhci_connect(struct tb_switch *sw);
1049 void tb_switch_xhci_disconnect(struct tb_switch *sw);
1050
1051 int tb_port_state(struct tb_port *port);
1052 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
1053 int tb_port_add_nfc_credits(struct tb_port *port, int credits);
1054 int tb_port_clear_counter(struct tb_port *port, int counter);
1055 int tb_port_unlock(struct tb_port *port);
1056 int tb_port_enable(struct tb_port *port);
1057 int tb_port_disable(struct tb_port *port);
1058 int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid);
1059 void tb_port_release_in_hopid(struct tb_port *port, int hopid);
1060 int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid);
1061 void tb_port_release_out_hopid(struct tb_port *port, int hopid);
1062 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
1063                                      struct tb_port *prev);
1064
1065 /**
1066  * tb_port_path_direction_downstream() - Checks if path directed downstream
1067  * @src: Source adapter
1068  * @dst: Destination adapter
1069  *
1070  * Returns %true only if the specified path from source adapter (@src)
1071  * to destination adapter (@dst) is directed downstream.
1072  */
1073 static inline bool
1074 tb_port_path_direction_downstream(const struct tb_port *src,
1075                                   const struct tb_port *dst)
1076 {
1077         return src->sw->config.depth < dst->sw->config.depth;
1078 }
1079
1080 static inline bool tb_port_use_credit_allocation(const struct tb_port *port)
1081 {
1082         return tb_port_is_null(port) && port->sw->credit_allocation;
1083 }
1084
1085 /**
1086  * tb_for_each_port_on_path() - Iterate over each port on path
1087  * @src: Source port
1088  * @dst: Destination port
1089  * @p: Port used as iterator
1090  *
1091  * Walks over each port on path from @src to @dst.
1092  */
1093 #define tb_for_each_port_on_path(src, dst, p)                           \
1094         for ((p) = tb_next_port_on_path((src), (dst), NULL); (p);       \
1095              (p) = tb_next_port_on_path((src), (dst), (p)))
1096
1097 /**
1098  * tb_for_each_upstream_port_on_path() - Iterate over each upstreamm port on path
1099  * @src: Source port
1100  * @dst: Destination port
1101  * @p: Port used as iterator
1102  *
1103  * Walks over each upstream lane adapter on path from @src to @dst.
1104  */
1105 #define tb_for_each_upstream_port_on_path(src, dst, p)                  \
1106         for ((p) = tb_next_port_on_path((src), (dst), NULL); (p);       \
1107              (p) = tb_next_port_on_path((src), (dst), (p)))             \
1108                 if (!tb_port_is_null((p)) || !tb_is_upstream_port((p))) {\
1109                         continue;                                       \
1110                 } else
1111
1112 int tb_port_get_link_speed(struct tb_port *port);
1113 int tb_port_get_link_generation(struct tb_port *port);
1114 int tb_port_get_link_width(struct tb_port *port);
1115 bool tb_port_width_supported(struct tb_port *port, unsigned int width);
1116 int tb_port_set_link_width(struct tb_port *port, enum tb_link_width width);
1117 int tb_port_lane_bonding_enable(struct tb_port *port);
1118 void tb_port_lane_bonding_disable(struct tb_port *port);
1119 int tb_port_wait_for_link_width(struct tb_port *port, unsigned int width,
1120                                 int timeout_msec);
1121 int tb_port_update_credits(struct tb_port *port);
1122
1123 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
1124 int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap);
1125 int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset);
1126 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
1127 int tb_port_next_cap(struct tb_port *port, unsigned int offset);
1128 bool tb_port_is_enabled(struct tb_port *port);
1129
1130 bool tb_usb3_port_is_enabled(struct tb_port *port);
1131 int tb_usb3_port_enable(struct tb_port *port, bool enable);
1132
1133 bool tb_pci_port_is_enabled(struct tb_port *port);
1134 int tb_pci_port_enable(struct tb_port *port, bool enable);
1135
1136 int tb_dp_port_hpd_is_active(struct tb_port *port);
1137 int tb_dp_port_hpd_clear(struct tb_port *port);
1138 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
1139                         unsigned int aux_tx, unsigned int aux_rx);
1140 bool tb_dp_port_is_enabled(struct tb_port *port);
1141 int tb_dp_port_enable(struct tb_port *port, bool enable);
1142
1143 struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid,
1144                                  struct tb_port *dst, int dst_hopid,
1145                                  struct tb_port **last, const char *name,
1146                                  bool alloc_hopid);
1147 struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid,
1148                               struct tb_port *dst, int dst_hopid, int link_nr,
1149                               const char *name);
1150 void tb_path_free(struct tb_path *path);
1151 int tb_path_activate(struct tb_path *path);
1152 void tb_path_deactivate(struct tb_path *path);
1153 bool tb_path_is_invalid(struct tb_path *path);
1154 bool tb_path_port_on_path(const struct tb_path *path,
1155                           const struct tb_port *port);
1156
1157 /**
1158  * tb_path_for_each_hop() - Iterate over each hop on path
1159  * @path: Path whose hops to iterate
1160  * @hop: Hop used as iterator
1161  *
1162  * Iterates over each hop on path.
1163  */
1164 #define tb_path_for_each_hop(path, hop)                                 \
1165         for ((hop) = &(path)->hops[0];                                  \
1166              (hop) <= &(path)->hops[(path)->path_length - 1]; (hop)++)
1167
1168 int tb_drom_read(struct tb_switch *sw);
1169 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
1170
1171 int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid);
1172 int tb_lc_configure_port(struct tb_port *port);
1173 void tb_lc_unconfigure_port(struct tb_port *port);
1174 int tb_lc_configure_xdomain(struct tb_port *port);
1175 void tb_lc_unconfigure_xdomain(struct tb_port *port);
1176 int tb_lc_start_lane_initialization(struct tb_port *port);
1177 bool tb_lc_is_clx_supported(struct tb_port *port);
1178 bool tb_lc_is_usb_plugged(struct tb_port *port);
1179 bool tb_lc_is_xhci_connected(struct tb_port *port);
1180 int tb_lc_xhci_connect(struct tb_port *port);
1181 void tb_lc_xhci_disconnect(struct tb_port *port);
1182 int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags);
1183 int tb_lc_set_sleep(struct tb_switch *sw);
1184 bool tb_lc_lane_bonding_possible(struct tb_switch *sw);
1185 bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in);
1186 int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in);
1187 int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in);
1188 int tb_lc_force_power(struct tb_switch *sw);
1189
1190 static inline int tb_route_length(u64 route)
1191 {
1192         return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
1193 }
1194
1195 /**
1196  * tb_downstream_route() - get route to downstream switch
1197  *
1198  * Port must not be the upstream port (otherwise a loop is created).
1199  *
1200  * Return: Returns a route to the switch behind @port.
1201  */
1202 static inline u64 tb_downstream_route(struct tb_port *port)
1203 {
1204         return tb_route(port->sw)
1205                | ((u64) port->port << (port->sw->config.depth * 8));
1206 }
1207
1208 bool tb_is_xdomain_enabled(void);
1209 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
1210                                const void *buf, size_t size);
1211 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
1212                                     u64 route, const uuid_t *local_uuid,
1213                                     const uuid_t *remote_uuid);
1214 void tb_xdomain_add(struct tb_xdomain *xd);
1215 void tb_xdomain_remove(struct tb_xdomain *xd);
1216 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
1217                                                  u8 depth);
1218
1219 static inline struct tb_switch *tb_xdomain_parent(struct tb_xdomain *xd)
1220 {
1221         return tb_to_switch(xd->dev.parent);
1222 }
1223
1224 /**
1225  * tb_xdomain_downstream_port() - Return downstream facing port of parent router
1226  * @xd: Xdomain pointer
1227  *
1228  * Returns the downstream port the XDomain is connected to.
1229  */
1230 static inline struct tb_port *tb_xdomain_downstream_port(struct tb_xdomain *xd)
1231 {
1232         return tb_port_at(xd->route, tb_xdomain_parent(xd));
1233 }
1234
1235 int tb_retimer_nvm_read(struct tb_retimer *rt, unsigned int address, void *buf,
1236                         size_t size);
1237 int tb_retimer_scan(struct tb_port *port, bool add);
1238 void tb_retimer_remove_all(struct tb_port *port);
1239
1240 static inline bool tb_is_retimer(const struct device *dev)
1241 {
1242         return dev->type == &tb_retimer_type;
1243 }
1244
1245 static inline struct tb_retimer *tb_to_retimer(struct device *dev)
1246 {
1247         if (tb_is_retimer(dev))
1248                 return container_of(dev, struct tb_retimer, dev);
1249         return NULL;
1250 }
1251
1252 /**
1253  * usb4_switch_version() - Returns USB4 version of the router
1254  * @sw: Router to check
1255  *
1256  * Returns major version of USB4 router (%1 for v1, %2 for v2 and so
1257  * on). Can be called to pre-USB4 router too and in that case returns %0.
1258  */
1259 static inline unsigned int usb4_switch_version(const struct tb_switch *sw)
1260 {
1261         return FIELD_GET(USB4_VERSION_MAJOR_MASK, sw->config.thunderbolt_version);
1262 }
1263
1264 /**
1265  * tb_switch_is_usb4() - Is the switch USB4 compliant
1266  * @sw: Switch to check
1267  *
1268  * Returns true if the @sw is USB4 compliant router, false otherwise.
1269  */
1270 static inline bool tb_switch_is_usb4(const struct tb_switch *sw)
1271 {
1272         return usb4_switch_version(sw) > 0;
1273 }
1274
1275 int usb4_switch_setup(struct tb_switch *sw);
1276 int usb4_switch_configuration_valid(struct tb_switch *sw);
1277 int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid);
1278 int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf,
1279                           size_t size);
1280 bool usb4_switch_lane_bonding_possible(struct tb_switch *sw);
1281 int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags);
1282 int usb4_switch_set_sleep(struct tb_switch *sw);
1283 int usb4_switch_nvm_sector_size(struct tb_switch *sw);
1284 int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
1285                          size_t size);
1286 int usb4_switch_nvm_set_offset(struct tb_switch *sw, unsigned int address);
1287 int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address,
1288                           const void *buf, size_t size);
1289 int usb4_switch_nvm_authenticate(struct tb_switch *sw);
1290 int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status);
1291 int usb4_switch_credits_init(struct tb_switch *sw);
1292 bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
1293 int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1294 int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1295 struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw,
1296                                           const struct tb_port *port);
1297 struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw,
1298                                           const struct tb_port *port);
1299 int usb4_switch_add_ports(struct tb_switch *sw);
1300 void usb4_switch_remove_ports(struct tb_switch *sw);
1301
1302 int usb4_port_unlock(struct tb_port *port);
1303 int usb4_port_hotplug_enable(struct tb_port *port);
1304 int usb4_port_configure(struct tb_port *port);
1305 void usb4_port_unconfigure(struct tb_port *port);
1306 int usb4_port_configure_xdomain(struct tb_port *port, struct tb_xdomain *xd);
1307 void usb4_port_unconfigure_xdomain(struct tb_port *port);
1308 int usb4_port_router_offline(struct tb_port *port);
1309 int usb4_port_router_online(struct tb_port *port);
1310 int usb4_port_enumerate_retimers(struct tb_port *port);
1311 bool usb4_port_clx_supported(struct tb_port *port);
1312 int usb4_port_margining_caps(struct tb_port *port, u32 *caps);
1313
1314 bool usb4_port_asym_supported(struct tb_port *port);
1315 int usb4_port_asym_set_link_width(struct tb_port *port, enum tb_link_width width);
1316 int usb4_port_asym_start(struct tb_port *port);
1317
1318 int usb4_port_hw_margin(struct tb_port *port, unsigned int lanes,
1319                         unsigned int ber_level, bool timing, bool right_high,
1320                         u32 *results);
1321 int usb4_port_sw_margin(struct tb_port *port, unsigned int lanes, bool timing,
1322                         bool right_high, u32 counter);
1323 int usb4_port_sw_margin_errors(struct tb_port *port, u32 *errors);
1324
1325 int usb4_port_retimer_set_inbound_sbtx(struct tb_port *port, u8 index);
1326 int usb4_port_retimer_unset_inbound_sbtx(struct tb_port *port, u8 index);
1327 int usb4_port_retimer_read(struct tb_port *port, u8 index, u8 reg, void *buf,
1328                            u8 size);
1329 int usb4_port_retimer_write(struct tb_port *port, u8 index, u8 reg,
1330                             const void *buf, u8 size);
1331 int usb4_port_retimer_is_last(struct tb_port *port, u8 index);
1332 int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index);
1333 int usb4_port_retimer_nvm_set_offset(struct tb_port *port, u8 index,
1334                                      unsigned int address);
1335 int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index,
1336                                 unsigned int address, const void *buf,
1337                                 size_t size);
1338 int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index);
1339 int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index,
1340                                               u32 *status);
1341 int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index,
1342                                unsigned int address, void *buf, size_t size);
1343
1344 int usb4_usb3_port_max_link_rate(struct tb_port *port);
1345 int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw,
1346                                        int *downstream_bw);
1347 int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw,
1348                                       int *downstream_bw);
1349 int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw,
1350                                      int *downstream_bw);
1351
1352 int usb4_dp_port_set_cm_id(struct tb_port *port, int cm_id);
1353 bool usb4_dp_port_bandwidth_mode_supported(struct tb_port *port);
1354 bool usb4_dp_port_bandwidth_mode_enabled(struct tb_port *port);
1355 int usb4_dp_port_set_cm_bandwidth_mode_supported(struct tb_port *port,
1356                                                  bool supported);
1357 int usb4_dp_port_group_id(struct tb_port *port);
1358 int usb4_dp_port_set_group_id(struct tb_port *port, int group_id);
1359 int usb4_dp_port_nrd(struct tb_port *port, int *rate, int *lanes);
1360 int usb4_dp_port_set_nrd(struct tb_port *port, int rate, int lanes);
1361 int usb4_dp_port_granularity(struct tb_port *port);
1362 int usb4_dp_port_set_granularity(struct tb_port *port, int granularity);
1363 int usb4_dp_port_set_estimated_bandwidth(struct tb_port *port, int bw);
1364 int usb4_dp_port_allocated_bandwidth(struct tb_port *port);
1365 int usb4_dp_port_allocate_bandwidth(struct tb_port *port, int bw);
1366 int usb4_dp_port_requested_bandwidth(struct tb_port *port);
1367
1368 int usb4_pci_port_set_ext_encapsulation(struct tb_port *port, bool enable);
1369
1370 static inline bool tb_is_usb4_port_device(const struct device *dev)
1371 {
1372         return dev->type == &usb4_port_device_type;
1373 }
1374
1375 static inline struct usb4_port *tb_to_usb4_port_device(struct device *dev)
1376 {
1377         if (tb_is_usb4_port_device(dev))
1378                 return container_of(dev, struct usb4_port, dev);
1379         return NULL;
1380 }
1381
1382 struct usb4_port *usb4_port_device_add(struct tb_port *port);
1383 void usb4_port_device_remove(struct usb4_port *usb4);
1384 int usb4_port_device_resume(struct usb4_port *usb4);
1385
1386 static inline bool usb4_port_device_is_offline(const struct usb4_port *usb4)
1387 {
1388         return usb4->offline;
1389 }
1390
1391 void tb_check_quirks(struct tb_switch *sw);
1392
1393 #ifdef CONFIG_ACPI
1394 bool tb_acpi_add_links(struct tb_nhi *nhi);
1395
1396 bool tb_acpi_is_native(void);
1397 bool tb_acpi_may_tunnel_usb3(void);
1398 bool tb_acpi_may_tunnel_dp(void);
1399 bool tb_acpi_may_tunnel_pcie(void);
1400 bool tb_acpi_is_xdomain_allowed(void);
1401
1402 int tb_acpi_init(void);
1403 void tb_acpi_exit(void);
1404 int tb_acpi_power_on_retimers(struct tb_port *port);
1405 int tb_acpi_power_off_retimers(struct tb_port *port);
1406 #else
1407 static inline bool tb_acpi_add_links(struct tb_nhi *nhi) { return false; }
1408
1409 static inline bool tb_acpi_is_native(void) { return true; }
1410 static inline bool tb_acpi_may_tunnel_usb3(void) { return true; }
1411 static inline bool tb_acpi_may_tunnel_dp(void) { return true; }
1412 static inline bool tb_acpi_may_tunnel_pcie(void) { return true; }
1413 static inline bool tb_acpi_is_xdomain_allowed(void) { return true; }
1414
1415 static inline int tb_acpi_init(void) { return 0; }
1416 static inline void tb_acpi_exit(void) { }
1417 static inline int tb_acpi_power_on_retimers(struct tb_port *port) { return 0; }
1418 static inline int tb_acpi_power_off_retimers(struct tb_port *port) { return 0; }
1419 #endif
1420
1421 #ifdef CONFIG_DEBUG_FS
1422 void tb_debugfs_init(void);
1423 void tb_debugfs_exit(void);
1424 void tb_switch_debugfs_init(struct tb_switch *sw);
1425 void tb_switch_debugfs_remove(struct tb_switch *sw);
1426 void tb_xdomain_debugfs_init(struct tb_xdomain *xd);
1427 void tb_xdomain_debugfs_remove(struct tb_xdomain *xd);
1428 void tb_service_debugfs_init(struct tb_service *svc);
1429 void tb_service_debugfs_remove(struct tb_service *svc);
1430 #else
1431 static inline void tb_debugfs_init(void) { }
1432 static inline void tb_debugfs_exit(void) { }
1433 static inline void tb_switch_debugfs_init(struct tb_switch *sw) { }
1434 static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { }
1435 static inline void tb_xdomain_debugfs_init(struct tb_xdomain *xd) { }
1436 static inline void tb_xdomain_debugfs_remove(struct tb_xdomain *xd) { }
1437 static inline void tb_service_debugfs_init(struct tb_service *svc) { }
1438 static inline void tb_service_debugfs_remove(struct tb_service *svc) { }
1439 #endif
1440
1441 #endif