1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Thunderbolt Cactus Ridge driver - bus logic (NHI independent)
5 * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
11 #include <linux/nvmem-provider.h>
12 #include <linux/pci.h>
13 #include <linux/uuid.h>
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
30 * @authenticating: The switch is authenticating the new NVM
32 struct tb_switch_nvm {
36 struct nvmem_device *active;
37 struct nvmem_device *non_active;
44 * enum tb_security_level - Thunderbolt security level
45 * @TB_SECURITY_NONE: No security, legacy mode
46 * @TB_SECURITY_USER: User approval required at minimum
47 * @TB_SECURITY_SECURE: One time saved key required at minimum
48 * @TB_SECURITY_DPONLY: Only tunnel Display port (and USB)
50 enum tb_security_level {
57 #define TB_SWITCH_KEY_SIZE 32
58 /* Each physical port contains 2 links on modern controllers */
59 #define TB_SWITCH_LINKS_PER_PHY_PORT 2
62 * struct tb_switch - a thunderbolt switch
63 * @dev: Device for the switch
64 * @config: Switch configuration
65 * @ports: Ports in this switch
66 * @dma_port: If the switch has port supporting DMA configuration based
67 * mailbox this will hold the pointer to that (%NULL
68 * otherwise). If set it also means the switch has
70 * @tb: Pointer to the domain the switch belongs to
71 * @uid: Unique ID of the switch
72 * @uuid: UUID of the switch (or %NULL if not supported)
73 * @vendor: Vendor ID of the switch
74 * @device: Device ID of the switch
75 * @vendor_name: Name of the vendor (or %NULL if not known)
76 * @device_name: Name of the device (or %NULL if not known)
77 * @generation: Switch Thunderbolt generation
78 * @cap_plug_events: Offset to the plug events capability (%0 if not found)
79 * @is_unplugged: The switch is going away
80 * @drom: DROM of the switch (%NULL if not found)
81 * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
82 * @no_nvm_upgrade: Prevent NVM upgrade of this switch
83 * @safe_mode: The switch is in safe-mode
84 * @authorized: Whether the switch is authorized by user or policy
85 * @work: Work used to automatically authorize a switch
86 * @security_level: Switch supported security level
87 * @key: Contains the key used to challenge the device or %NULL if not
88 * supported. Size of the key is %TB_SWITCH_KEY_SIZE.
89 * @connection_id: Connection ID used with ICM messaging
90 * @connection_key: Connection key used with ICM messaging
91 * @link: Root switch link this switch is connected (ICM only)
92 * @depth: Depth in the chain this switch is connected (ICM only)
94 * When the switch is being added or removed to the domain (other
95 * switches) you need to have domain lock held. For switch authorization
96 * internal switch_lock is enough.
100 struct tb_regs_switch_header config;
101 struct tb_port *ports;
102 struct tb_dma_port *dma_port;
108 const char *vendor_name;
109 const char *device_name;
110 unsigned int generation;
114 struct tb_switch_nvm *nvm;
117 unsigned int authorized;
118 struct work_struct work;
119 enum tb_security_level security_level;
128 * struct tb_port - a thunderbolt port, part of a tb_switch
131 struct tb_regs_port_header config;
132 struct tb_switch *sw;
133 struct tb_port *remote; /* remote port, NULL if not connected */
134 int cap_phy; /* offset, zero if not found */
135 u8 port; /* port number on switch */
136 bool disabled; /* disabled by eeprom */
137 struct tb_port *dual_link_port;
142 * struct tb_path_hop - routing information for a tb_path
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.
149 * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
153 struct tb_port *in_port;
154 struct tb_port *out_port;
156 int in_counter_index; /* write -1 to disable counters for this hop. */
161 * enum tb_path_port - path options mask
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) */
172 * struct tb_path - a unidirectional path between two ports
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.
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;
190 struct tb_path_hop *hops;
191 int path_length; /* number of hops */
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 * @handle_event: Handle thunderbolt event
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
211 int (*driver_ready)(struct tb *tb);
212 int (*start)(struct tb *tb);
213 void (*stop)(struct tb *tb);
214 int (*suspend_noirq)(struct tb *tb);
215 int (*resume_noirq)(struct tb *tb);
216 int (*suspend)(struct tb *tb);
217 void (*complete)(struct tb *tb);
218 void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type,
219 const void *buf, size_t size);
220 int (*approve_switch)(struct tb *tb, struct tb_switch *sw);
221 int (*add_switch_key)(struct tb *tb, struct tb_switch *sw);
222 int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw,
223 const u8 *challenge, u8 *response);
224 int (*disconnect_pcie_paths)(struct tb *tb);
228 * struct tb - main thunderbolt bus structure
229 * @dev: Domain device
230 * @lock: Big lock. Must be held when accessing any struct
231 * tb_switch / struct tb_port.
232 * @nhi: Pointer to the NHI structure
233 * @ctl: Control channel for this domain
234 * @wq: Ordered workqueue for all domain specific work
235 * @root_switch: Root switch of this domain
236 * @cm_ops: Connection manager specific operations vector
237 * @index: Linux assigned domain number
238 * @security_level: Current security level
239 * @privdata: Private connection manager specific data
246 struct workqueue_struct *wq;
247 struct tb_switch *root_switch;
248 const struct tb_cm_ops *cm_ops;
250 enum tb_security_level security_level;
251 unsigned long privdata[0];
254 static inline void *tb_priv(struct tb *tb)
256 return (void *)tb->privdata;
259 /* helper functions & macros */
262 * tb_upstream_port() - return the upstream port of a switch
264 * Every switch has an upstream port (for the root switch it is the NHI).
266 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for
267 * non root switches (on the NHI port remote is always NULL).
269 * Return: Returns the upstream port of the switch.
271 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw)
273 return &sw->ports[sw->config.upstream_port_number];
276 static inline u64 tb_route(struct tb_switch *sw)
278 return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo;
281 static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw)
285 port = route >> (sw->config.depth * 8);
286 if (WARN_ON(port > sw->config.max_port_number))
288 return &sw->ports[port];
291 static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
292 enum tb_cfg_space space, u32 offset, u32 length)
294 return tb_cfg_read(sw->tb->ctl,
303 static inline int tb_sw_write(struct tb_switch *sw, void *buffer,
304 enum tb_cfg_space space, u32 offset, u32 length)
306 return tb_cfg_write(sw->tb->ctl,
315 static inline int tb_port_read(struct tb_port *port, void *buffer,
316 enum tb_cfg_space space, u32 offset, u32 length)
318 return tb_cfg_read(port->sw->tb->ctl,
327 static inline int tb_port_write(struct tb_port *port, const void *buffer,
328 enum tb_cfg_space space, u32 offset, u32 length)
330 return tb_cfg_write(port->sw->tb->ctl,
339 #define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg)
340 #define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
341 #define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
342 #define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
345 #define __TB_SW_PRINT(level, sw, fmt, arg...) \
347 struct tb_switch *__sw = (sw); \
348 level(__sw->tb, "%llx: " fmt, \
349 tb_route(__sw), ## arg); \
351 #define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
352 #define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
353 #define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
356 #define __TB_PORT_PRINT(level, _port, fmt, arg...) \
358 struct tb_port *__port = (_port); \
359 level(__port->sw->tb, "%llx:%x: " fmt, \
360 tb_route(__port->sw), __port->port, ## arg); \
362 #define tb_port_WARN(port, fmt, arg...) \
363 __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg)
364 #define tb_port_warn(port, fmt, arg...) \
365 __TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
366 #define tb_port_info(port, fmt, arg...) \
367 __TB_PORT_PRINT(tb_info, port, fmt, ##arg)
369 struct tb *icm_probe(struct tb_nhi *nhi);
370 struct tb *tb_probe(struct tb_nhi *nhi);
372 extern struct bus_type tb_bus_type;
373 extern struct device_type tb_domain_type;
374 extern struct device_type tb_switch_type;
376 int tb_domain_init(void);
377 void tb_domain_exit(void);
378 void tb_switch_exit(void);
380 struct tb *tb_domain_alloc(struct tb_nhi *nhi, size_t privsize);
381 int tb_domain_add(struct tb *tb);
382 void tb_domain_remove(struct tb *tb);
383 int tb_domain_suspend_noirq(struct tb *tb);
384 int tb_domain_resume_noirq(struct tb *tb);
385 int tb_domain_suspend(struct tb *tb);
386 void tb_domain_complete(struct tb *tb);
387 int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw);
388 int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw);
389 int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw);
390 int tb_domain_disconnect_pcie_paths(struct tb *tb);
392 static inline void tb_domain_put(struct tb *tb)
394 put_device(&tb->dev);
397 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
399 struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb,
400 struct device *parent, u64 route);
401 int tb_switch_configure(struct tb_switch *sw);
402 int tb_switch_add(struct tb_switch *sw);
403 void tb_switch_remove(struct tb_switch *sw);
404 void tb_switch_suspend(struct tb_switch *sw);
405 int tb_switch_resume(struct tb_switch *sw);
406 int tb_switch_reset(struct tb *tb, u64 route);
407 void tb_sw_set_unplugged(struct tb_switch *sw);
408 struct tb_switch *get_switch_at_route(struct tb_switch *sw, u64 route);
409 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
411 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
413 static inline unsigned int tb_switch_phy_port_from_link(unsigned int link)
415 return (link - 1) / TB_SWITCH_LINKS_PER_PHY_PORT;
418 static inline void tb_switch_put(struct tb_switch *sw)
420 put_device(&sw->dev);
423 static inline bool tb_is_switch(const struct device *dev)
425 return dev->type == &tb_switch_type;
428 static inline struct tb_switch *tb_to_switch(struct device *dev)
430 if (tb_is_switch(dev))
431 return container_of(dev, struct tb_switch, dev);
435 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
436 int tb_port_add_nfc_credits(struct tb_port *port, int credits);
437 int tb_port_clear_counter(struct tb_port *port, int counter);
439 int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
440 int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
442 struct tb_path *tb_path_alloc(struct tb *tb, int num_hops);
443 void tb_path_free(struct tb_path *path);
444 int tb_path_activate(struct tb_path *path);
445 void tb_path_deactivate(struct tb_path *path);
446 bool tb_path_is_invalid(struct tb_path *path);
448 int tb_drom_read(struct tb_switch *sw);
449 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
452 static inline int tb_route_length(u64 route)
454 return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
457 static inline bool tb_is_upstream_port(struct tb_port *port)
459 return port == tb_upstream_port(port->sw);
463 * tb_downstream_route() - get route to downstream switch
465 * Port must not be the upstream port (otherwise a loop is created).
467 * Return: Returns a route to the switch behind @port.
469 static inline u64 tb_downstream_route(struct tb_port *port)
471 return tb_route(port->sw)
472 | ((u64) port->port << (port->sw->config.depth * 8));