drivers/thunderbolt/tb.h

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