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