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