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