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
  47 /**
  48  * struct tb_switch - a thunderbolt switch
  49  * @dev: Device for the switch
  50  * @config: Switch configuration
  51  * @ports: Ports in this switch
  52  * @dma_port: If the switch has port supporting DMA configuration based
  53  *            mailbox this will hold the pointer to that (%NULL
  54  *            otherwise). If set it also means the switch has
  55  *            upgradeable NVM.
  56  * @tb: Pointer to the domain the switch belongs to
  57  * @uid: Unique ID of the switch
  58  * @uuid: UUID of the switch (or %NULL if not supported)
  59  * @vendor: Vendor ID of the switch
  60  * @device: Device ID of the switch
  61  * @vendor_name: Name of the vendor (or %NULL if not known)
  62  * @device_name: Name of the device (or %NULL if not known)
  63  * @generation: Switch Thunderbolt generation
  64  * @cap_plug_events: Offset to the plug events capability (%0 if not found)
  65  * @is_unplugged: The switch is going away
  66  * @drom: DROM of the switch (%NULL if not found)
  67  * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
  68  * @no_nvm_upgrade: Prevent NVM upgrade of this switch
  69  * @safe_mode: The switch is in safe-mode
  70  * @boot: Whether the switch was already authorized on boot or not
  71  * @rpm: The switch supports runtime PM
  72  * @authorized: Whether the switch is authorized by user or policy
  73  * @work: Work used to automatically authorize a switch
  74  * @security_level: Switch supported security level
  75  * @key: Contains the key used to challenge the device or %NULL if not
  76  *       supported. Size of the key is %TB_SWITCH_KEY_SIZE.
  77  * @connection_id: Connection ID used with ICM messaging
  78  * @connection_key: Connection key used with ICM messaging
  79  * @link: Root switch link this switch is connected (ICM only)
  80  * @depth: Depth in the chain this switch is connected (ICM only)
  81  *
  82  * When the switch is being added or removed to the domain (other
  83  * switches) you need to have domain lock held. For switch authorization
  84  * internal switch_lock is enough.
  85  */
  86 struct tb_switch {
  87         struct device dev;
  88         struct tb_regs_switch_header config;
  89         struct tb_port *ports;
  90         struct tb_dma_port *dma_port;
  91         struct tb *tb;
  92         u64 uid;
  93         uuid_t *uuid;
  94         u16 vendor;
  95         u16 device;
  96         const char *vendor_name;
  97         const char *device_name;
  98         unsigned int generation;
  99         int cap_plug_events;
 100         bool is_unplugged;
 101         u8 *drom;
 102         struct tb_switch_nvm *nvm;
 103         bool no_nvm_upgrade;
 104         bool safe_mode;
 105         bool boot;
 106         bool rpm;
 107         unsigned int authorized;
 108         struct work_struct work;
 109         enum tb_security_level security_level;
 110         u8 *key;
 111         u8 connection_id;
 112         u8 connection_key;
 113         u8 link;
 114         u8 depth;
 115 };
 116
 117 /**
 118  * struct tb_port - a thunderbolt port, part of a tb_switch
 119  * @config: Cached port configuration read from registers
 120  * @sw: Switch the port belongs to
 121  * @remote: Remote port (%NULL if not connected)
 122  * @xdomain: Remote host (%NULL if not connected)
 123  * @cap_phy: Offset, zero if not found
 124  * @port: Port number on switch
 125  * @disabled: Disabled by eeprom
 126  * @dual_link_port: If the switch is connected using two ports, points
 127  *                  to the other port.
 128  * @link_nr: Is this primary or secondary port on the dual_link.
 129  */
 130 struct tb_port {
 131         struct tb_regs_port_header config;
 132         struct tb_switch *sw;
 133         struct tb_port *remote;
 134         struct tb_xdomain *xdomain;
 135         int cap_phy;
 136         u8 port;
 137         bool disabled;
 138         struct tb_port *dual_link_port;
 139         u8 link_nr:1;
 140 };
 141
 142 /**
 143  * struct tb_path_hop - routing information for a tb_path
 144  *
 145  * Hop configuration is always done on the IN port of a switch.
 146  * in_port and out_port have to be on the same switch. Packets arriving on
 147  * in_port with "hop" = in_hop_index will get routed to through out_port. The
 148  * next hop to take (on out_port->remote) is determined by next_hop_index.
 149  *
 150  * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
 151  * port.
 152  */
 153 struct tb_path_hop {
 154         struct tb_port *in_port;
 155         struct tb_port *out_port;
 156         int in_hop_index;
 157         int in_counter_index; /* write -1 to disable counters for this hop. */
 158         int next_hop_index;
 159 };
 160
 161 /**
 162  * enum tb_path_port - path options mask
 163  */
 164 enum tb_path_port {
 165         TB_PATH_NONE = 0,
 166         TB_PATH_SOURCE = 1, /* activate on the first hop (out of src) */
 167         TB_PATH_INTERNAL = 2, /* activate on other hops (not the first/last) */
 168         TB_PATH_DESTINATION = 4, /* activate on the last hop (into dst) */
 169         TB_PATH_ALL = 7,
 170 };
 171
 172 /**
 173  * struct tb_path - a unidirectional path between two ports
 174  *
 175  * A path consists of a number of hops (see tb_path_hop). To establish a PCIe
 176  * tunnel two paths have to be created between the two PCIe ports.
 177  *
 178  */
 179 struct tb_path {
 180         struct tb *tb;
 181         int nfc_credits; /* non flow controlled credits */
 182         enum tb_path_port ingress_shared_buffer;
 183         enum tb_path_port egress_shared_buffer;
 184         enum tb_path_port ingress_fc_enable;
 185         enum tb_path_port egress_fc_enable;
 186
 187         int priority:3;
 188         int weight:4;
 189         bool drop_packages;
 190         bool activated;
 191         struct tb_path_hop *hops;
 192         int path_length; /* number of hops */
 193 };
 194
 195 /**
 196  * struct tb_cm_ops - Connection manager specific operations vector
 197  * @driver_ready: Called right after control channel is started. Used by
 198  *                ICM to send driver ready message to the firmware.
 199  * @start: Starts the domain
 200  * @stop: Stops the domain
 201  * @suspend_noirq: Connection manager specific suspend_noirq
 202  * @resume_noirq: Connection manager specific resume_noirq
 203  * @suspend: Connection manager specific suspend
 204  * @complete: Connection manager specific complete
 205  * @runtime_suspend: Connection manager specific runtime_suspend
 206  * @runtime_resume: Connection manager specific runtime_resume
 207  * @handle_event: Handle thunderbolt event
 208  * @get_boot_acl: Get boot ACL list
 209  * @set_boot_acl: Set boot ACL list
 210  * @approve_switch: Approve switch
 211  * @add_switch_key: Add key to switch
 212  * @challenge_switch_key: Challenge switch using key
 213  * @disconnect_pcie_paths: Disconnects PCIe paths before NVM update
 214  * @approve_xdomain_paths: Approve (establish) XDomain DMA paths
 215  * @disconnect_xdomain_paths: Disconnect XDomain DMA paths
 216  */
 217 struct tb_cm_ops {
 218         int (*driver_ready)(struct tb *tb);
 219         int (*start)(struct tb *tb);
 220         void (*stop)(struct tb *tb);
 221         int (*suspend_noirq)(struct tb *tb);
 222         int (*resume_noirq)(struct tb *tb);
 223         int (*suspend)(struct tb *tb);
 224         void (*complete)(struct tb *tb);
 225         int (*runtime_suspend)(struct tb *tb);
 226         int (*runtime_resume)(struct tb *tb);
 227         void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type,
 228                              const void *buf, size_t size);
 229         int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids);
 230         int (*set_boot_acl)(struct tb *tb, const uuid_t *uuids, size_t nuuids);
 231         int (*approve_switch)(struct tb *tb, struct tb_switch *sw);
 232         int (*add_switch_key)(struct tb *tb, struct tb_switch *sw);
 233         int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw,
 234                                     const u8 *challenge, u8 *response);
 235         int (*disconnect_pcie_paths)(struct tb *tb);
 236         int (*approve_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd);
 237         int (*disconnect_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd);
 238 };
 239
 240 static inline void *tb_priv(struct tb *tb)
 241 {
 242         return (void *)tb->privdata;
 243 }
 244
 245 #define TB_AUTOSUSPEND_DELAY            15000 /* ms */
 246
 247 /* helper functions & macros */
 248
 249 /**
 250  * tb_upstream_port() - return the upstream port of a switch
 251  *
 252  * Every switch has an upstream port (for the root switch it is the NHI).
 253  *
 254  * During switch alloc/init tb_upstream_port()->remote may be NULL, even for
 255  * non root switches (on the NHI port remote is always NULL).
 256  *
 257  * Return: Returns the upstream port of the switch.
 258  */
 259 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw)
 260 {
 261         return &sw->ports[sw->config.upstream_port_number];
 262 }
 263
 264 static inline u64 tb_route(struct tb_switch *sw)
 265 {
 266         return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo;
 267 }
 268
 269 static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw)
 270 {
 271         u8 port;
 272
 273         port = route >> (sw->config.depth * 8);
 274         if (WARN_ON(port > sw->config.max_port_number))
 275                 return NULL;
 276         return &sw->ports[port];
 277 }
 278
 279 static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
 280                              enum tb_cfg_space space, u32 offset, u32 length)
 281 {
 282         return tb_cfg_read(sw->tb->ctl,
 283                            buffer,
 284                            tb_route(sw),
 285                            0,
 286                            space,
 287                            offset,
 288                            length);
 289 }
 290
 291 static inline int tb_sw_write(struct tb_switch *sw, void *buffer,
 292                               enum tb_cfg_space space, u32 offset, u32 length)
 293 {
 294         return tb_cfg_write(sw->tb->ctl,
 295                             buffer,
 296                             tb_route(sw),
 297                             0,
 298                             space,
 299                             offset,
 300                             length);
 301 }
 302
 303 static inline int tb_port_read(struct tb_port *port, void *buffer,
 304                                enum tb_cfg_space space, u32 offset, u32 length)
 305 {
 306         return tb_cfg_read(port->sw->tb->ctl,
 307                            buffer,
 308                            tb_route(port->sw),
 309                            port->port,
 310                            space,
 311                            offset,
 312                            length);
 313 }
 314
 315 static inline int tb_port_write(struct tb_port *port, const void *buffer,
 316                                 enum tb_cfg_space space, u32 offset, u32 length)
 317 {
 318         return tb_cfg_write(port->sw->tb->ctl,
 319                             buffer,
 320                             tb_route(port->sw),
 321                             port->port,
 322                             space,
 323                             offset,
 324                             length);
 325 }
 326
 327 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg)
 328 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
 329 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
 330 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
 331 #define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg)
 332
 333 #define __TB_SW_PRINT(level, sw, fmt, arg...)           \
 334         do {                                            \
 335                 struct tb_switch *__sw = (sw);          \
 336                 level(__sw->tb, "%llx: " fmt,           \
 337                       tb_route(__sw), ## arg);          \
 338         } while (0)
 339 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
 340 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
 341 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
 342 #define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg)
 343
 344 #define __TB_PORT_PRINT(level, _port, fmt, arg...)                      \
 345         do {                                                            \
 346                 struct tb_port *__port = (_port);                       \
 347                 level(__port->sw->tb, "%llx:%x: " fmt,                  \
 348                       tb_route(__port->sw), __port->port, ## arg);      \
 349         } while (0)
 350 #define tb_port_WARN(port, fmt, arg...) \
 351         __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg)
 352 #define tb_port_warn(port, fmt, arg...) \
 353         __TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
 354 #define tb_port_info(port, fmt, arg...) \
 355         __TB_PORT_PRINT(tb_info, port, fmt, ##arg)
 356 #define tb_port_dbg(port, fmt, arg...) \
 357         __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg)
 358
 359 struct tb *icm_probe(struct tb_nhi *nhi);
 360 struct tb *tb_probe(struct tb_nhi *nhi);
 361
 362 extern struct device_type tb_domain_type;
 363 extern struct device_type tb_switch_type;
 364
 365 int tb_domain_init(void);
 366 void tb_domain_exit(void);
 367 void tb_switch_exit(void);
 368 int tb_xdomain_init(void);
 369 void tb_xdomain_exit(void);
 370
 371 struct tb *tb_domain_alloc(struct tb_nhi *nhi, size_t privsize);
 372 int tb_domain_add(struct tb *tb);
 373 void tb_domain_remove(struct tb *tb);
 374 int tb_domain_suspend_noirq(struct tb *tb);
 375 int tb_domain_resume_noirq(struct tb *tb);
 376 int tb_domain_suspend(struct tb *tb);
 377 void tb_domain_complete(struct tb *tb);
 378 int tb_domain_runtime_suspend(struct tb *tb);
 379 int tb_domain_runtime_resume(struct tb *tb);
 380 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw);
 381 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw);
 382 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw);
 383 int tb_domain_disconnect_pcie_paths(struct tb *tb);
 384 int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd);
 385 int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd);
 386 int tb_domain_disconnect_all_paths(struct tb *tb);
 387
 388 static inline void tb_domain_put(struct tb *tb)
 389 {
 390         put_device(&tb->dev);
 391 }
 392
 393 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
 394                                   u64 route);
 395 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb,
 396                         struct device *parent, u64 route);
 397 int tb_switch_configure(struct tb_switch *sw);
 398 int tb_switch_add(struct tb_switch *sw);
 399 void tb_switch_remove(struct tb_switch *sw);
 400 void tb_switch_suspend(struct tb_switch *sw);
 401 int tb_switch_resume(struct tb_switch *sw);
 402 int tb_switch_reset(struct tb *tb, u64 route);
 403 void tb_sw_set_unplugged(struct tb_switch *sw);
 404 struct tb_switch *get_switch_at_route(struct tb_switch *sw, u64 route);
 405 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
 406                                                u8 depth);
 407 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
 408 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route);
 409
 410 static inline struct tb_switch *tb_switch_get(struct tb_switch *sw)
 411 {
 412         if (sw)
 413                 get_device(&sw->dev);
 414         return sw;
 415 }
 416
 417 static inline void tb_switch_put(struct tb_switch *sw)
 418 {
 419         put_device(&sw->dev);
 420 }
 421
 422 static inline bool tb_is_switch(const struct device *dev)
 423 {
 424         return dev->type == &tb_switch_type;
 425 }
 426
 427 static inline struct tb_switch *tb_to_switch(struct device *dev)
 428 {
 429         if (tb_is_switch(dev))
 430                 return container_of(dev, struct tb_switch, dev);
 431         return NULL;
 432 }
 433
 434 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
 435 int tb_port_add_nfc_credits(struct tb_port *port, int credits);
 436 int tb_port_clear_counter(struct tb_port *port, int counter);
 437
 438 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
 439 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
 440
 441 struct tb_path *tb_path_alloc(struct tb *tb, int num_hops);
 442 void tb_path_free(struct tb_path *path);
 443 int tb_path_activate(struct tb_path *path);
 444 void tb_path_deactivate(struct tb_path *path);
 445 bool tb_path_is_invalid(struct tb_path *path);
 446
 447 int tb_drom_read(struct tb_switch *sw);
 448 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
 449
 450
 451 static inline int tb_route_length(u64 route)
 452 {
 453         return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
 454 }
 455
 456 static inline bool tb_is_upstream_port(struct tb_port *port)
 457 {
 458         return port == tb_upstream_port(port->sw);
 459 }
 460
 461 /**
 462  * tb_downstream_route() - get route to downstream switch
 463  *
 464  * Port must not be the upstream port (otherwise a loop is created).
 465  *
 466  * Return: Returns a route to the switch behind @port.
 467  */
 468 static inline u64 tb_downstream_route(struct tb_port *port)
 469 {
 470         return tb_route(port->sw)
 471                | ((u64) port->port << (port->sw->config.depth * 8));
 472 }
 473
 474 bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
 475                                const void *buf, size_t size);
 476 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
 477                                     u64 route, const uuid_t *local_uuid,
 478                                     const uuid_t *remote_uuid);
 479 void tb_xdomain_add(struct tb_xdomain *xd);
 480 void tb_xdomain_remove(struct tb_xdomain *xd);
 481 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
 482                                                  u8 depth);
 483
 484 #endif