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