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