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