xref: /linux-6.15/include/linux/thunderbolt.h (revision c936e287)
1fd3b339cSMika Westerberg /* SPDX-License-Identifier: GPL-2.0 */
2cdae7c07SMika Westerberg /*
3cdae7c07SMika Westerberg  * Thunderbolt service API
4cdae7c07SMika Westerberg  *
5eaf8ff35SMika Westerberg  * Copyright (C) 2014 Andreas Noever <[email protected]>
6cdae7c07SMika Westerberg  * Copyright (C) 2017, Intel Corporation
7cdae7c07SMika Westerberg  * Authors: Michael Jamet <[email protected]>
8cdae7c07SMika Westerberg  *          Mika Westerberg <[email protected]>
9cdae7c07SMika Westerberg  */
10cdae7c07SMika Westerberg 
11cdae7c07SMika Westerberg #ifndef THUNDERBOLT_H_
12cdae7c07SMika Westerberg #define THUNDERBOLT_H_
13cdae7c07SMika Westerberg 
149e99b9f4SMika Westerberg #include <linux/device.h>
153b3d9f4dSMika Westerberg #include <linux/idr.h>
16cdae7c07SMika Westerberg #include <linux/list.h>
179e99b9f4SMika Westerberg #include <linux/mutex.h>
18d1ff7024SMika Westerberg #include <linux/mod_devicetable.h>
193304559eSMika Westerberg #include <linux/pci.h>
20cdae7c07SMika Westerberg #include <linux/uuid.h>
213b3d9f4dSMika Westerberg #include <linux/workqueue.h>
22cdae7c07SMika Westerberg 
23eaf8ff35SMika Westerberg enum tb_cfg_pkg_type {
24eaf8ff35SMika Westerberg 	TB_CFG_PKG_READ = 1,
25eaf8ff35SMika Westerberg 	TB_CFG_PKG_WRITE = 2,
26eaf8ff35SMika Westerberg 	TB_CFG_PKG_ERROR = 3,
27eaf8ff35SMika Westerberg 	TB_CFG_PKG_NOTIFY_ACK = 4,
28eaf8ff35SMika Westerberg 	TB_CFG_PKG_EVENT = 5,
29eaf8ff35SMika Westerberg 	TB_CFG_PKG_XDOMAIN_REQ = 6,
30eaf8ff35SMika Westerberg 	TB_CFG_PKG_XDOMAIN_RESP = 7,
31eaf8ff35SMika Westerberg 	TB_CFG_PKG_OVERRIDE = 8,
32eaf8ff35SMika Westerberg 	TB_CFG_PKG_RESET = 9,
33eaf8ff35SMika Westerberg 	TB_CFG_PKG_ICM_EVENT = 10,
34eaf8ff35SMika Westerberg 	TB_CFG_PKG_ICM_CMD = 11,
35eaf8ff35SMika Westerberg 	TB_CFG_PKG_ICM_RESP = 12,
36eaf8ff35SMika Westerberg };
37eaf8ff35SMika Westerberg 
38cdae7c07SMika Westerberg /**
399e99b9f4SMika Westerberg  * enum tb_security_level - Thunderbolt security level
409e99b9f4SMika Westerberg  * @TB_SECURITY_NONE: No security, legacy mode
419e99b9f4SMika Westerberg  * @TB_SECURITY_USER: User approval required at minimum
429e99b9f4SMika Westerberg  * @TB_SECURITY_SECURE: One time saved key required at minimum
439e99b9f4SMika Westerberg  * @TB_SECURITY_DPONLY: Only tunnel Display port (and USB)
446fc14e1aSMika Westerberg  * @TB_SECURITY_USBONLY: Only tunnel USB controller of the connected
456fc14e1aSMika Westerberg  *			 Thunderbolt dock (and Display Port). All PCIe
466fc14e1aSMika Westerberg  *			 links downstream of the dock are removed.
473cd542e6SMika Westerberg  * @TB_SECURITY_NOPCIE: For USB4 systems this level is used when the
483cd542e6SMika Westerberg  *			PCIe tunneling is disabled from the BIOS.
499e99b9f4SMika Westerberg  */
509e99b9f4SMika Westerberg enum tb_security_level {
519e99b9f4SMika Westerberg 	TB_SECURITY_NONE,
529e99b9f4SMika Westerberg 	TB_SECURITY_USER,
539e99b9f4SMika Westerberg 	TB_SECURITY_SECURE,
549e99b9f4SMika Westerberg 	TB_SECURITY_DPONLY,
556fc14e1aSMika Westerberg 	TB_SECURITY_USBONLY,
563cd542e6SMika Westerberg 	TB_SECURITY_NOPCIE,
579e99b9f4SMika Westerberg };
589e99b9f4SMika Westerberg 
599e99b9f4SMika Westerberg /**
609e99b9f4SMika Westerberg  * struct tb - main thunderbolt bus structure
619e99b9f4SMika Westerberg  * @dev: Domain device
629e99b9f4SMika Westerberg  * @lock: Big lock. Must be held when accessing any struct
639e99b9f4SMika Westerberg  *	  tb_switch / struct tb_port.
649e99b9f4SMika Westerberg  * @nhi: Pointer to the NHI structure
659e99b9f4SMika Westerberg  * @ctl: Control channel for this domain
669e99b9f4SMika Westerberg  * @wq: Ordered workqueue for all domain specific work
679e99b9f4SMika Westerberg  * @root_switch: Root switch of this domain
689e99b9f4SMika Westerberg  * @cm_ops: Connection manager specific operations vector
699e99b9f4SMika Westerberg  * @index: Linux assigned domain number
709e99b9f4SMika Westerberg  * @security_level: Current security level
719aaa3b8bSMika Westerberg  * @nboot_acl: Number of boot ACLs the domain supports
729e99b9f4SMika Westerberg  * @privdata: Private connection manager specific data
739e99b9f4SMika Westerberg  */
749e99b9f4SMika Westerberg struct tb {
759e99b9f4SMika Westerberg 	struct device dev;
769e99b9f4SMika Westerberg 	struct mutex lock;
779e99b9f4SMika Westerberg 	struct tb_nhi *nhi;
789e99b9f4SMika Westerberg 	struct tb_ctl *ctl;
799e99b9f4SMika Westerberg 	struct workqueue_struct *wq;
809e99b9f4SMika Westerberg 	struct tb_switch *root_switch;
819e99b9f4SMika Westerberg 	const struct tb_cm_ops *cm_ops;
829e99b9f4SMika Westerberg 	int index;
839e99b9f4SMika Westerberg 	enum tb_security_level security_level;
849aaa3b8bSMika Westerberg 	size_t nboot_acl;
85913b99f7SGustavo A. R. Silva 	unsigned long privdata[];
869e99b9f4SMika Westerberg };
879e99b9f4SMika Westerberg 
888be0c877SGreg Kroah-Hartman extern const struct bus_type tb_bus_type;
89*b8a73083SRicardo B. Marliere extern const struct device_type tb_service_type;
90*b8a73083SRicardo B. Marliere extern const struct device_type tb_xdomain_type;
919e99b9f4SMika Westerberg 
92e69b71f8SMika Westerberg #define TB_LINKS_PER_PHY_PORT	2
93e69b71f8SMika Westerberg 
tb_phy_port_from_link(unsigned int link)94e69b71f8SMika Westerberg static inline unsigned int tb_phy_port_from_link(unsigned int link)
95e69b71f8SMika Westerberg {
96e69b71f8SMika Westerberg 	return (link - 1) / TB_LINKS_PER_PHY_PORT;
97e69b71f8SMika Westerberg }
98e69b71f8SMika Westerberg 
999e99b9f4SMika Westerberg /**
100cdae7c07SMika Westerberg  * struct tb_property_dir - XDomain property directory
101cdae7c07SMika Westerberg  * @uuid: Directory UUID or %NULL if root directory
102cdae7c07SMika Westerberg  * @properties: List of properties in this directory
103cdae7c07SMika Westerberg  *
104cdae7c07SMika Westerberg  * User needs to provide serialization if needed.
105cdae7c07SMika Westerberg  */
106cdae7c07SMika Westerberg struct tb_property_dir {
107cdae7c07SMika Westerberg 	const uuid_t *uuid;
108cdae7c07SMika Westerberg 	struct list_head properties;
109cdae7c07SMika Westerberg };
110cdae7c07SMika Westerberg 
111cdae7c07SMika Westerberg enum tb_property_type {
112cdae7c07SMika Westerberg 	TB_PROPERTY_TYPE_UNKNOWN = 0x00,
113cdae7c07SMika Westerberg 	TB_PROPERTY_TYPE_DIRECTORY = 0x44,
114cdae7c07SMika Westerberg 	TB_PROPERTY_TYPE_DATA = 0x64,
115cdae7c07SMika Westerberg 	TB_PROPERTY_TYPE_TEXT = 0x74,
116cdae7c07SMika Westerberg 	TB_PROPERTY_TYPE_VALUE = 0x76,
117cdae7c07SMika Westerberg };
118cdae7c07SMika Westerberg 
119cdae7c07SMika Westerberg #define TB_PROPERTY_KEY_SIZE	8
120cdae7c07SMika Westerberg 
121cdae7c07SMika Westerberg /**
122cdae7c07SMika Westerberg  * struct tb_property - XDomain property
123cdae7c07SMika Westerberg  * @list: Used to link properties together in a directory
124cdae7c07SMika Westerberg  * @key: Key for the property (always terminated).
125cdae7c07SMika Westerberg  * @type: Type of the property
126cdae7c07SMika Westerberg  * @length: Length of the property data in dwords
127cdae7c07SMika Westerberg  * @value: Property value
128cdae7c07SMika Westerberg  *
129cdae7c07SMika Westerberg  * Users use @type to determine which field in @value is filled.
130cdae7c07SMika Westerberg  */
131cdae7c07SMika Westerberg struct tb_property {
132cdae7c07SMika Westerberg 	struct list_head list;
133cdae7c07SMika Westerberg 	char key[TB_PROPERTY_KEY_SIZE + 1];
134cdae7c07SMika Westerberg 	enum tb_property_type type;
135cdae7c07SMika Westerberg 	size_t length;
136cdae7c07SMika Westerberg 	union {
137cdae7c07SMika Westerberg 		struct tb_property_dir *dir;
138cdae7c07SMika Westerberg 		u8 *data;
139cdae7c07SMika Westerberg 		char *text;
140cdae7c07SMika Westerberg 		u32 immediate;
141cdae7c07SMika Westerberg 	} value;
142cdae7c07SMika Westerberg };
143cdae7c07SMika Westerberg 
144cdae7c07SMika Westerberg struct tb_property_dir *tb_property_parse_dir(const u32 *block,
145cdae7c07SMika Westerberg 					      size_t block_len);
146cdae7c07SMika Westerberg ssize_t tb_property_format_dir(const struct tb_property_dir *dir, u32 *block,
147cdae7c07SMika Westerberg 			       size_t block_len);
1487d3084c0SMika Westerberg struct tb_property_dir *tb_property_copy_dir(const struct tb_property_dir *dir);
149cdae7c07SMika Westerberg struct tb_property_dir *tb_property_create_dir(const uuid_t *uuid);
150cdae7c07SMika Westerberg void tb_property_free_dir(struct tb_property_dir *dir);
151cdae7c07SMika Westerberg int tb_property_add_immediate(struct tb_property_dir *parent, const char *key,
152cdae7c07SMika Westerberg 			      u32 value);
153cdae7c07SMika Westerberg int tb_property_add_data(struct tb_property_dir *parent, const char *key,
154cdae7c07SMika Westerberg 			 const void *buf, size_t buflen);
155cdae7c07SMika Westerberg int tb_property_add_text(struct tb_property_dir *parent, const char *key,
156cdae7c07SMika Westerberg 			 const char *text);
157cdae7c07SMika Westerberg int tb_property_add_dir(struct tb_property_dir *parent, const char *key,
158cdae7c07SMika Westerberg 			struct tb_property_dir *dir);
159cdae7c07SMika Westerberg void tb_property_remove(struct tb_property *tb_property);
160cdae7c07SMika Westerberg struct tb_property *tb_property_find(struct tb_property_dir *dir,
161cdae7c07SMika Westerberg 			const char *key, enum tb_property_type type);
162cdae7c07SMika Westerberg struct tb_property *tb_property_get_next(struct tb_property_dir *dir,
163cdae7c07SMika Westerberg 					 struct tb_property *prev);
164cdae7c07SMika Westerberg 
165cdae7c07SMika Westerberg #define tb_property_for_each(dir, property)			\
166cdae7c07SMika Westerberg 	for (property = tb_property_get_next(dir, NULL);	\
167cdae7c07SMika Westerberg 	     property;						\
168cdae7c07SMika Westerberg 	     property = tb_property_get_next(dir, property))
169cdae7c07SMika Westerberg 
170d1ff7024SMika Westerberg int tb_register_property_dir(const char *key, struct tb_property_dir *dir);
171d1ff7024SMika Westerberg void tb_unregister_property_dir(const char *key, struct tb_property_dir *dir);
172d1ff7024SMika Westerberg 
173d1ff7024SMika Westerberg /**
174e111fb92SGil Fine  * enum tb_link_width - Thunderbolt/USB4 link width
175e111fb92SGil Fine  * @TB_LINK_WIDTH_SINGLE: Single lane link
176e111fb92SGil Fine  * @TB_LINK_WIDTH_DUAL: Dual lane symmetric link
1777cbabed1SMika Westerberg  * @TB_LINK_WIDTH_ASYM_TX: Dual lane asymmetric Gen 4 link with 3 transmitters
178e111fb92SGil Fine  * @TB_LINK_WIDTH_ASYM_RX: Dual lane asymmetric Gen 4 link with 3 receivers
179e111fb92SGil Fine  */
180e111fb92SGil Fine enum tb_link_width {
181e111fb92SGil Fine 	TB_LINK_WIDTH_SINGLE = BIT(0),
182e111fb92SGil Fine 	TB_LINK_WIDTH_DUAL = BIT(1),
183e111fb92SGil Fine 	TB_LINK_WIDTH_ASYM_TX = BIT(2),
184e111fb92SGil Fine 	TB_LINK_WIDTH_ASYM_RX = BIT(3),
185e111fb92SGil Fine };
186e111fb92SGil Fine 
187e111fb92SGil Fine /**
188d1ff7024SMika Westerberg  * struct tb_xdomain - Cross-domain (XDomain) connection
189d1ff7024SMika Westerberg  * @dev: XDomain device
190d1ff7024SMika Westerberg  * @tb: Pointer to the domain
191d1ff7024SMika Westerberg  * @remote_uuid: UUID of the remote domain (host)
192d1ff7024SMika Westerberg  * @local_uuid: Cached local UUID
193d1ff7024SMika Westerberg  * @route: Route string the other domain can be reached
194d1ff7024SMika Westerberg  * @vendor: Vendor ID of the remote domain
195d1ff7024SMika Westerberg  * @device: Device ID of the demote domain
19646b494f2SMika Westerberg  * @local_max_hopid: Maximum input HopID of this host
19746b494f2SMika Westerberg  * @remote_max_hopid: Maximum input HopID of the remote host
198d1ff7024SMika Westerberg  * @lock: Lock to serialize access to the following fields of this structure
199d1ff7024SMika Westerberg  * @vendor_name: Name of the vendor (or %NULL if not known)
200d1ff7024SMika Westerberg  * @device_name: Name of the device (or %NULL if not known)
2014210d50fSIsaac Hazan  * @link_speed: Speed of the link in Gb/s
202e111fb92SGil Fine  * @link_width: Width of the downstream facing link
203f9cad07bSMika Westerberg  * @link_usb4: Downstream link is USB4
204d1ff7024SMika Westerberg  * @is_unplugged: The XDomain is unplugged
2053b4b3235SMika Westerberg  * @needs_uuid: If the XDomain does not have @remote_uuid it will be
2063b4b3235SMika Westerberg  *		queried first
207d1ff7024SMika Westerberg  * @service_ids: Used to generate IDs for the services
208180b0689SMika Westerberg  * @in_hopids: Input HopIDs for DMA tunneling
209180b0689SMika Westerberg  * @out_hopids; Output HopIDs for DMA tunneling
21046b494f2SMika Westerberg  * @local_property_block: Local block of properties
21146b494f2SMika Westerberg  * @local_property_block_gen: Generation of @local_property_block
21246b494f2SMika Westerberg  * @local_property_block_len: Length of the @local_property_block in dwords
21346b494f2SMika Westerberg  * @remote_properties: Properties exported by the remote domain
21446b494f2SMika Westerberg  * @remote_property_block_gen: Generation of @remote_properties
2158e1de704SMika Westerberg  * @state: Next XDomain discovery state to run
2168e1de704SMika Westerberg  * @state_work: Work used to run the next state
2178e1de704SMika Westerberg  * @state_retries: Number of retries remain for the state
218d1ff7024SMika Westerberg  * @properties_changed_work: Work used to notify the remote domain that
219d1ff7024SMika Westerberg  *			     our properties have changed
220d1ff7024SMika Westerberg  * @properties_changed_retries: Number of times left to send properties
221d1ff7024SMika Westerberg  *				changed notification
2228e1de704SMika Westerberg  * @bonding_possible: True if lane bonding is possible on local side
2238e1de704SMika Westerberg  * @target_link_width: Target link width from the remote host
224d1ff7024SMika Westerberg  * @link: Root switch link the remote domain is connected (ICM only)
225d1ff7024SMika Westerberg  * @depth: Depth in the chain the remote domain is connected (ICM only)
226d1ff7024SMika Westerberg  *
227d1ff7024SMika Westerberg  * This structure represents connection across two domains (hosts).
228d1ff7024SMika Westerberg  * Each XDomain contains zero or more services which are exposed as
229d1ff7024SMika Westerberg  * &struct tb_service objects.
230d1ff7024SMika Westerberg  *
231d1ff7024SMika Westerberg  * Service drivers may access this structure if they need to enumerate
232d1ff7024SMika Westerberg  * non-standard properties but they need hold @lock when doing so
233d1ff7024SMika Westerberg  * because properties can be changed asynchronously in response to
234d1ff7024SMika Westerberg  * changes in the remote domain.
235d1ff7024SMika Westerberg  */
236d1ff7024SMika Westerberg struct tb_xdomain {
237d1ff7024SMika Westerberg 	struct device dev;
238d1ff7024SMika Westerberg 	struct tb *tb;
239d1ff7024SMika Westerberg 	uuid_t *remote_uuid;
240d1ff7024SMika Westerberg 	const uuid_t *local_uuid;
241d1ff7024SMika Westerberg 	u64 route;
242d1ff7024SMika Westerberg 	u16 vendor;
243d1ff7024SMika Westerberg 	u16 device;
24446b494f2SMika Westerberg 	unsigned int local_max_hopid;
24546b494f2SMika Westerberg 	unsigned int remote_max_hopid;
246d1ff7024SMika Westerberg 	struct mutex lock;
247d1ff7024SMika Westerberg 	const char *vendor_name;
248d1ff7024SMika Westerberg 	const char *device_name;
2494210d50fSIsaac Hazan 	unsigned int link_speed;
250e111fb92SGil Fine 	enum tb_link_width link_width;
251f9cad07bSMika Westerberg 	bool link_usb4;
252d1ff7024SMika Westerberg 	bool is_unplugged;
2533b4b3235SMika Westerberg 	bool needs_uuid;
254d1ff7024SMika Westerberg 	struct ida service_ids;
255180b0689SMika Westerberg 	struct ida in_hopids;
256180b0689SMika Westerberg 	struct ida out_hopids;
25746b494f2SMika Westerberg 	u32 *local_property_block;
25846b494f2SMika Westerberg 	u32 local_property_block_gen;
25946b494f2SMika Westerberg 	u32 local_property_block_len;
26046b494f2SMika Westerberg 	struct tb_property_dir *remote_properties;
26146b494f2SMika Westerberg 	u32 remote_property_block_gen;
2628e1de704SMika Westerberg 	int state;
2638e1de704SMika Westerberg 	struct delayed_work state_work;
2648e1de704SMika Westerberg 	int state_retries;
265d1ff7024SMika Westerberg 	struct delayed_work properties_changed_work;
266d1ff7024SMika Westerberg 	int properties_changed_retries;
2678e1de704SMika Westerberg 	bool bonding_possible;
2688e1de704SMika Westerberg 	u8 target_link_width;
269d1ff7024SMika Westerberg 	u8 link;
270d1ff7024SMika Westerberg 	u8 depth;
271d1ff7024SMika Westerberg };
272d1ff7024SMika Westerberg 
2735cc0df9cSIsaac Hazan int tb_xdomain_lane_bonding_enable(struct tb_xdomain *xd);
2745cc0df9cSIsaac Hazan void tb_xdomain_lane_bonding_disable(struct tb_xdomain *xd);
275180b0689SMika Westerberg int tb_xdomain_alloc_in_hopid(struct tb_xdomain *xd, int hopid);
276180b0689SMika Westerberg void tb_xdomain_release_in_hopid(struct tb_xdomain *xd, int hopid);
277180b0689SMika Westerberg int tb_xdomain_alloc_out_hopid(struct tb_xdomain *xd, int hopid);
278180b0689SMika Westerberg void tb_xdomain_release_out_hopid(struct tb_xdomain *xd, int hopid);
279180b0689SMika Westerberg int tb_xdomain_enable_paths(struct tb_xdomain *xd, int transmit_path,
280180b0689SMika Westerberg 			    int transmit_ring, int receive_path,
281180b0689SMika Westerberg 			    int receive_ring);
282180b0689SMika Westerberg int tb_xdomain_disable_paths(struct tb_xdomain *xd, int transmit_path,
283180b0689SMika Westerberg 			     int transmit_ring, int receive_path,
284180b0689SMika Westerberg 			     int receive_ring);
285180b0689SMika Westerberg 
tb_xdomain_disable_all_paths(struct tb_xdomain * xd)286180b0689SMika Westerberg static inline int tb_xdomain_disable_all_paths(struct tb_xdomain *xd)
287180b0689SMika Westerberg {
288180b0689SMika Westerberg 	return tb_xdomain_disable_paths(xd, -1, -1, -1, -1);
289180b0689SMika Westerberg }
290180b0689SMika Westerberg 
291d1ff7024SMika Westerberg struct tb_xdomain *tb_xdomain_find_by_uuid(struct tb *tb, const uuid_t *uuid);
292484cb153SRadion Mirchevsky struct tb_xdomain *tb_xdomain_find_by_route(struct tb *tb, u64 route);
293d1ff7024SMika Westerberg 
294d1ff7024SMika Westerberg static inline struct tb_xdomain *
tb_xdomain_find_by_uuid_locked(struct tb * tb,const uuid_t * uuid)295d1ff7024SMika Westerberg tb_xdomain_find_by_uuid_locked(struct tb *tb, const uuid_t *uuid)
296d1ff7024SMika Westerberg {
297d1ff7024SMika Westerberg 	struct tb_xdomain *xd;
298d1ff7024SMika Westerberg 
299d1ff7024SMika Westerberg 	mutex_lock(&tb->lock);
300d1ff7024SMika Westerberg 	xd = tb_xdomain_find_by_uuid(tb, uuid);
301d1ff7024SMika Westerberg 	mutex_unlock(&tb->lock);
302d1ff7024SMika Westerberg 
303d1ff7024SMika Westerberg 	return xd;
304d1ff7024SMika Westerberg }
305d1ff7024SMika Westerberg 
306484cb153SRadion Mirchevsky static inline struct tb_xdomain *
tb_xdomain_find_by_route_locked(struct tb * tb,u64 route)307484cb153SRadion Mirchevsky tb_xdomain_find_by_route_locked(struct tb *tb, u64 route)
308484cb153SRadion Mirchevsky {
309484cb153SRadion Mirchevsky 	struct tb_xdomain *xd;
310484cb153SRadion Mirchevsky 
311484cb153SRadion Mirchevsky 	mutex_lock(&tb->lock);
312484cb153SRadion Mirchevsky 	xd = tb_xdomain_find_by_route(tb, route);
313484cb153SRadion Mirchevsky 	mutex_unlock(&tb->lock);
314484cb153SRadion Mirchevsky 
315484cb153SRadion Mirchevsky 	return xd;
316484cb153SRadion Mirchevsky }
317484cb153SRadion Mirchevsky 
tb_xdomain_get(struct tb_xdomain * xd)318d1ff7024SMika Westerberg static inline struct tb_xdomain *tb_xdomain_get(struct tb_xdomain *xd)
319d1ff7024SMika Westerberg {
320d1ff7024SMika Westerberg 	if (xd)
321d1ff7024SMika Westerberg 		get_device(&xd->dev);
322d1ff7024SMika Westerberg 	return xd;
323d1ff7024SMika Westerberg }
324d1ff7024SMika Westerberg 
tb_xdomain_put(struct tb_xdomain * xd)325d1ff7024SMika Westerberg static inline void tb_xdomain_put(struct tb_xdomain *xd)
326d1ff7024SMika Westerberg {
327d1ff7024SMika Westerberg 	if (xd)
328d1ff7024SMika Westerberg 		put_device(&xd->dev);
329d1ff7024SMika Westerberg }
330d1ff7024SMika Westerberg 
tb_is_xdomain(const struct device * dev)331d1ff7024SMika Westerberg static inline bool tb_is_xdomain(const struct device *dev)
332d1ff7024SMika Westerberg {
333d1ff7024SMika Westerberg 	return dev->type == &tb_xdomain_type;
334d1ff7024SMika Westerberg }
335d1ff7024SMika Westerberg 
tb_to_xdomain(struct device * dev)336d1ff7024SMika Westerberg static inline struct tb_xdomain *tb_to_xdomain(struct device *dev)
337d1ff7024SMika Westerberg {
338d1ff7024SMika Westerberg 	if (tb_is_xdomain(dev))
339d1ff7024SMika Westerberg 		return container_of(dev, struct tb_xdomain, dev);
340d1ff7024SMika Westerberg 	return NULL;
341d1ff7024SMika Westerberg }
342d1ff7024SMika Westerberg 
343d1ff7024SMika Westerberg int tb_xdomain_response(struct tb_xdomain *xd, const void *response,
344d1ff7024SMika Westerberg 			size_t size, enum tb_cfg_pkg_type type);
345d1ff7024SMika Westerberg int tb_xdomain_request(struct tb_xdomain *xd, const void *request,
346d1ff7024SMika Westerberg 		       size_t request_size, enum tb_cfg_pkg_type request_type,
347d1ff7024SMika Westerberg 		       void *response, size_t response_size,
348d1ff7024SMika Westerberg 		       enum tb_cfg_pkg_type response_type,
349d1ff7024SMika Westerberg 		       unsigned int timeout_msec);
350d1ff7024SMika Westerberg 
351d1ff7024SMika Westerberg /**
352d1ff7024SMika Westerberg  * tb_protocol_handler - Protocol specific handler
353d1ff7024SMika Westerberg  * @uuid: XDomain messages with this UUID are dispatched to this handler
354d1ff7024SMika Westerberg  * @callback: Callback called with the XDomain message. Returning %1
355d1ff7024SMika Westerberg  *	      here tells the XDomain core that the message was handled
356d1ff7024SMika Westerberg  *	      by this handler and should not be forwared to other
357d1ff7024SMika Westerberg  *	      handlers.
358d1ff7024SMika Westerberg  * @data: Data passed with the callback
359d1ff7024SMika Westerberg  * @list: Handlers are linked using this
360d1ff7024SMika Westerberg  *
361d1ff7024SMika Westerberg  * Thunderbolt services can hook into incoming XDomain requests by
362d1ff7024SMika Westerberg  * registering protocol handler. Only limitation is that the XDomain
363d1ff7024SMika Westerberg  * discovery protocol UUID cannot be registered since it is handled by
364d1ff7024SMika Westerberg  * the core XDomain code.
365d1ff7024SMika Westerberg  *
366d1ff7024SMika Westerberg  * The @callback must check that the message is really directed to the
367d1ff7024SMika Westerberg  * service the driver implements.
368d1ff7024SMika Westerberg  */
369d1ff7024SMika Westerberg struct tb_protocol_handler {
370d1ff7024SMika Westerberg 	const uuid_t *uuid;
371d1ff7024SMika Westerberg 	int (*callback)(const void *buf, size_t size, void *data);
372d1ff7024SMika Westerberg 	void *data;
373d1ff7024SMika Westerberg 	struct list_head list;
374d1ff7024SMika Westerberg };
375d1ff7024SMika Westerberg 
376d1ff7024SMika Westerberg int tb_register_protocol_handler(struct tb_protocol_handler *handler);
377d1ff7024SMika Westerberg void tb_unregister_protocol_handler(struct tb_protocol_handler *handler);
378d1ff7024SMika Westerberg 
379d1ff7024SMika Westerberg /**
380d1ff7024SMika Westerberg  * struct tb_service - Thunderbolt service
381d1ff7024SMika Westerberg  * @dev: XDomain device
382d1ff7024SMika Westerberg  * @id: ID of the service (shown in sysfs)
383d1ff7024SMika Westerberg  * @key: Protocol key from the properties directory
384d1ff7024SMika Westerberg  * @prtcid: Protocol ID from the properties directory
385d1ff7024SMika Westerberg  * @prtcvers: Protocol version from the properties directory
386d1ff7024SMika Westerberg  * @prtcrevs: Protocol software revision from the properties directory
387d1ff7024SMika Westerberg  * @prtcstns: Protocol settings mask from the properties directory
388407ac931SMika Westerberg  * @debugfs_dir: Pointer to the service debugfs directory. Always created
389407ac931SMika Westerberg  *		 when debugfs is enabled. Can be used by service drivers to
390407ac931SMika Westerberg  *		 add their own entries under the service.
391d1ff7024SMika Westerberg  *
392d1ff7024SMika Westerberg  * Each domain exposes set of services it supports as collection of
393d1ff7024SMika Westerberg  * properties. For each service there will be one corresponding
394d1ff7024SMika Westerberg  * &struct tb_service. Service drivers are bound to these.
395d1ff7024SMika Westerberg  */
396d1ff7024SMika Westerberg struct tb_service {
397d1ff7024SMika Westerberg 	struct device dev;
398d1ff7024SMika Westerberg 	int id;
399d1ff7024SMika Westerberg 	const char *key;
400d1ff7024SMika Westerberg 	u32 prtcid;
401d1ff7024SMika Westerberg 	u32 prtcvers;
402d1ff7024SMika Westerberg 	u32 prtcrevs;
403d1ff7024SMika Westerberg 	u32 prtcstns;
404407ac931SMika Westerberg 	struct dentry *debugfs_dir;
405d1ff7024SMika Westerberg };
406d1ff7024SMika Westerberg 
tb_service_get(struct tb_service * svc)407d1ff7024SMika Westerberg static inline struct tb_service *tb_service_get(struct tb_service *svc)
408d1ff7024SMika Westerberg {
409d1ff7024SMika Westerberg 	if (svc)
410d1ff7024SMika Westerberg 		get_device(&svc->dev);
411d1ff7024SMika Westerberg 	return svc;
412d1ff7024SMika Westerberg }
413d1ff7024SMika Westerberg 
tb_service_put(struct tb_service * svc)414d1ff7024SMika Westerberg static inline void tb_service_put(struct tb_service *svc)
415d1ff7024SMika Westerberg {
416d1ff7024SMika Westerberg 	if (svc)
417d1ff7024SMika Westerberg 		put_device(&svc->dev);
418d1ff7024SMika Westerberg }
419d1ff7024SMika Westerberg 
tb_is_service(const struct device * dev)420d1ff7024SMika Westerberg static inline bool tb_is_service(const struct device *dev)
421d1ff7024SMika Westerberg {
422d1ff7024SMika Westerberg 	return dev->type == &tb_service_type;
423d1ff7024SMika Westerberg }
424d1ff7024SMika Westerberg 
tb_to_service(struct device * dev)425d1ff7024SMika Westerberg static inline struct tb_service *tb_to_service(struct device *dev)
426d1ff7024SMika Westerberg {
427d1ff7024SMika Westerberg 	if (tb_is_service(dev))
428d1ff7024SMika Westerberg 		return container_of(dev, struct tb_service, dev);
429d1ff7024SMika Westerberg 	return NULL;
430d1ff7024SMika Westerberg }
431d1ff7024SMika Westerberg 
432d1ff7024SMika Westerberg /**
433d1ff7024SMika Westerberg  * tb_service_driver - Thunderbolt service driver
434d1ff7024SMika Westerberg  * @driver: Driver structure
435d1ff7024SMika Westerberg  * @probe: Called when the driver is probed
436d1ff7024SMika Westerberg  * @remove: Called when the driver is removed (optional)
437d1ff7024SMika Westerberg  * @shutdown: Called at shutdown time to stop the service (optional)
438d1ff7024SMika Westerberg  * @id_table: Table of service identifiers the driver supports
439d1ff7024SMika Westerberg  */
440d1ff7024SMika Westerberg struct tb_service_driver {
441d1ff7024SMika Westerberg 	struct device_driver driver;
442d1ff7024SMika Westerberg 	int (*probe)(struct tb_service *svc, const struct tb_service_id *id);
443d1ff7024SMika Westerberg 	void (*remove)(struct tb_service *svc);
444d1ff7024SMika Westerberg 	void (*shutdown)(struct tb_service *svc);
445d1ff7024SMika Westerberg 	const struct tb_service_id *id_table;
446d1ff7024SMika Westerberg };
447d1ff7024SMika Westerberg 
448d1ff7024SMika Westerberg #define TB_SERVICE(key, id)				\
449d1ff7024SMika Westerberg 	.match_flags = TBSVC_MATCH_PROTOCOL_KEY |	\
450d1ff7024SMika Westerberg 		       TBSVC_MATCH_PROTOCOL_ID,		\
451d1ff7024SMika Westerberg 	.protocol_key = (key),				\
452d1ff7024SMika Westerberg 	.protocol_id = (id)
453d1ff7024SMika Westerberg 
454d1ff7024SMika Westerberg int tb_register_service_driver(struct tb_service_driver *drv);
455d1ff7024SMika Westerberg void tb_unregister_service_driver(struct tb_service_driver *drv);
456d1ff7024SMika Westerberg 
tb_service_get_drvdata(const struct tb_service * svc)457d1ff7024SMika Westerberg static inline void *tb_service_get_drvdata(const struct tb_service *svc)
458d1ff7024SMika Westerberg {
459d1ff7024SMika Westerberg 	return dev_get_drvdata(&svc->dev);
460d1ff7024SMika Westerberg }
461d1ff7024SMika Westerberg 
tb_service_set_drvdata(struct tb_service * svc,void * data)462d1ff7024SMika Westerberg static inline void tb_service_set_drvdata(struct tb_service *svc, void *data)
463d1ff7024SMika Westerberg {
464d1ff7024SMika Westerberg 	dev_set_drvdata(&svc->dev, data);
465d1ff7024SMika Westerberg }
466d1ff7024SMika Westerberg 
tb_service_parent(struct tb_service * svc)467d1ff7024SMika Westerberg static inline struct tb_xdomain *tb_service_parent(struct tb_service *svc)
468d1ff7024SMika Westerberg {
469d1ff7024SMika Westerberg 	return tb_to_xdomain(svc->dev.parent);
470d1ff7024SMika Westerberg }
471d1ff7024SMika Westerberg 
4723b3d9f4dSMika Westerberg /**
4733b3d9f4dSMika Westerberg  * struct tb_nhi - thunderbolt native host interface
4743b3d9f4dSMika Westerberg  * @lock: Must be held during ring creation/destruction. Is acquired by
4753b3d9f4dSMika Westerberg  *	  interrupt_work when dispatching interrupts to individual rings.
4763b3d9f4dSMika Westerberg  * @pdev: Pointer to the PCI device
4773cdb9446SMika Westerberg  * @ops: NHI specific optional ops
4783b3d9f4dSMika Westerberg  * @iobase: MMIO space of the NHI
4793b3d9f4dSMika Westerberg  * @tx_rings: All Tx rings available on this host controller
4803b3d9f4dSMika Westerberg  * @rx_rings: All Rx rings available on this host controller
4813b3d9f4dSMika Westerberg  * @msix_ida: Used to allocate MSI-X vectors for rings
4823b3d9f4dSMika Westerberg  * @going_away: The host controller device is about to disappear so when
4833b3d9f4dSMika Westerberg  *		this flag is set, avoid touching the hardware anymore.
48486eaf4a5SRobin Murphy  * @iommu_dma_protection: An IOMMU will isolate external-facing ports.
4853b3d9f4dSMika Westerberg  * @interrupt_work: Work scheduled to handle ring interrupt when no
4863b3d9f4dSMika Westerberg  *		    MSI-X is used.
4873b3d9f4dSMika Westerberg  * @hop_count: Number of rings (end point hops) supported by NHI.
488e390909aSSanjay R Mehta  * @quirks: NHI specific quirks if any
4893b3d9f4dSMika Westerberg  */
4903b3d9f4dSMika Westerberg struct tb_nhi {
49159120e06SMika Westerberg 	spinlock_t lock;
4923b3d9f4dSMika Westerberg 	struct pci_dev *pdev;
4933cdb9446SMika Westerberg 	const struct tb_nhi_ops *ops;
4943b3d9f4dSMika Westerberg 	void __iomem *iobase;
4953b3d9f4dSMika Westerberg 	struct tb_ring **tx_rings;
4963b3d9f4dSMika Westerberg 	struct tb_ring **rx_rings;
4973b3d9f4dSMika Westerberg 	struct ida msix_ida;
4983b3d9f4dSMika Westerberg 	bool going_away;
49986eaf4a5SRobin Murphy 	bool iommu_dma_protection;
5003b3d9f4dSMika Westerberg 	struct work_struct interrupt_work;
5013b3d9f4dSMika Westerberg 	u32 hop_count;
502e390909aSSanjay R Mehta 	unsigned long quirks;
5033b3d9f4dSMika Westerberg };
5043b3d9f4dSMika Westerberg 
5053b3d9f4dSMika Westerberg /**
5063b3d9f4dSMika Westerberg  * struct tb_ring - thunderbolt TX or RX ring associated with a NHI
5073b3d9f4dSMika Westerberg  * @lock: Lock serializing actions to this ring. Must be acquired after
5083b3d9f4dSMika Westerberg  *	  nhi->lock.
5093b3d9f4dSMika Westerberg  * @nhi: Pointer to the native host controller interface
5103b3d9f4dSMika Westerberg  * @size: Size of the ring
5113b3d9f4dSMika Westerberg  * @hop: Hop (DMA channel) associated with this ring
5123b3d9f4dSMika Westerberg  * @head: Head of the ring (write next descriptor here)
5133b3d9f4dSMika Westerberg  * @tail: Tail of the ring (complete next descriptor here)
5143b3d9f4dSMika Westerberg  * @descriptors: Allocated descriptors for this ring
5153b3d9f4dSMika Westerberg  * @queue: Queue holding frames to be transferred over this ring
5163b3d9f4dSMika Westerberg  * @in_flight: Queue holding frames that are currently in flight
5173b3d9f4dSMika Westerberg  * @work: Interrupt work structure
5183b3d9f4dSMika Westerberg  * @is_tx: Is the ring Tx or Rx
5193b3d9f4dSMika Westerberg  * @running: Is the ring running
5203b3d9f4dSMika Westerberg  * @irq: MSI-X irq number if the ring uses MSI-X. %0 otherwise.
5213b3d9f4dSMika Westerberg  * @vector: MSI-X vector number the ring uses (only set if @irq is > 0)
5223b3d9f4dSMika Westerberg  * @flags: Ring specific flags
523afe704a2SMika Westerberg  * @e2e_tx_hop: Transmit HopID when E2E is enabled. Only applicable to
524afe704a2SMika Westerberg  *		RX ring. For TX ring this should be set to %0.
5253b3d9f4dSMika Westerberg  * @sof_mask: Bit mask used to detect start of frame PDF
5263b3d9f4dSMika Westerberg  * @eof_mask: Bit mask used to detect end of frame PDF
5274ffe722eSMika Westerberg  * @start_poll: Called when ring interrupt is triggered to start
5284ffe722eSMika Westerberg  *		polling. Passing %NULL keeps the ring in interrupt mode.
5294ffe722eSMika Westerberg  * @poll_data: Data passed to @start_poll
5303b3d9f4dSMika Westerberg  */
5313b3d9f4dSMika Westerberg struct tb_ring {
53222b7de10SMika Westerberg 	spinlock_t lock;
5333b3d9f4dSMika Westerberg 	struct tb_nhi *nhi;
5343b3d9f4dSMika Westerberg 	int size;
5353b3d9f4dSMika Westerberg 	int hop;
5363b3d9f4dSMika Westerberg 	int head;
5373b3d9f4dSMika Westerberg 	int tail;
5383b3d9f4dSMika Westerberg 	struct ring_desc *descriptors;
5393b3d9f4dSMika Westerberg 	dma_addr_t descriptors_dma;
5403b3d9f4dSMika Westerberg 	struct list_head queue;
5413b3d9f4dSMika Westerberg 	struct list_head in_flight;
5423b3d9f4dSMika Westerberg 	struct work_struct work;
5433b3d9f4dSMika Westerberg 	bool is_tx:1;
5443b3d9f4dSMika Westerberg 	bool running:1;
5453b3d9f4dSMika Westerberg 	int irq;
5463b3d9f4dSMika Westerberg 	u8 vector;
5473b3d9f4dSMika Westerberg 	unsigned int flags;
548afe704a2SMika Westerberg 	int e2e_tx_hop;
5493b3d9f4dSMika Westerberg 	u16 sof_mask;
5503b3d9f4dSMika Westerberg 	u16 eof_mask;
5514ffe722eSMika Westerberg 	void (*start_poll)(void *data);
5524ffe722eSMika Westerberg 	void *poll_data;
5533b3d9f4dSMika Westerberg };
5543b3d9f4dSMika Westerberg 
5553b3d9f4dSMika Westerberg /* Leave ring interrupt enabled on suspend */
5563b3d9f4dSMika Westerberg #define RING_FLAG_NO_SUSPEND	BIT(0)
5573b3d9f4dSMika Westerberg /* Configure the ring to be in frame mode */
5583b3d9f4dSMika Westerberg #define RING_FLAG_FRAME		BIT(1)
559afe704a2SMika Westerberg /* Enable end-to-end flow control */
560afe704a2SMika Westerberg #define RING_FLAG_E2E		BIT(2)
5613b3d9f4dSMika Westerberg 
5623b3d9f4dSMika Westerberg struct ring_frame;
5633b3d9f4dSMika Westerberg typedef void (*ring_cb)(struct tb_ring *, struct ring_frame *, bool canceled);
5643b3d9f4dSMika Westerberg 
5653b3d9f4dSMika Westerberg /**
5662a91ec63SMika Westerberg  * enum ring_desc_flags - Flags for DMA ring descriptor
5672a91ec63SMika Westerberg  * %RING_DESC_ISOCH: Enable isonchronous DMA (Tx only)
5682a91ec63SMika Westerberg  * %RING_DESC_CRC_ERROR: In frame mode CRC check failed for the frame (Rx only)
5692a91ec63SMika Westerberg  * %RING_DESC_COMPLETED: Descriptor completed (set by NHI)
5702a91ec63SMika Westerberg  * %RING_DESC_POSTED: Always set this
5712a91ec63SMika Westerberg  * %RING_DESC_BUFFER_OVERRUN: RX buffer overrun
5722a91ec63SMika Westerberg  * %RING_DESC_INTERRUPT: Request an interrupt on completion
5732a91ec63SMika Westerberg  */
5742a91ec63SMika Westerberg enum ring_desc_flags {
5752a91ec63SMika Westerberg 	RING_DESC_ISOCH = 0x1,
5762a91ec63SMika Westerberg 	RING_DESC_CRC_ERROR = 0x1,
5772a91ec63SMika Westerberg 	RING_DESC_COMPLETED = 0x2,
5782a91ec63SMika Westerberg 	RING_DESC_POSTED = 0x4,
5792a91ec63SMika Westerberg 	RING_DESC_BUFFER_OVERRUN = 0x04,
5802a91ec63SMika Westerberg 	RING_DESC_INTERRUPT = 0x8,
5812a91ec63SMika Westerberg };
5822a91ec63SMika Westerberg 
5832a91ec63SMika Westerberg /**
5843b3d9f4dSMika Westerberg  * struct ring_frame - For use with ring_rx/ring_tx
5853b3d9f4dSMika Westerberg  * @buffer_phy: DMA mapped address of the frame
5864ffe722eSMika Westerberg  * @callback: Callback called when the frame is finished (optional)
5873b3d9f4dSMika Westerberg  * @list: Frame is linked to a queue using this
5883b3d9f4dSMika Westerberg  * @size: Size of the frame in bytes (%0 means %4096)
5893b3d9f4dSMika Westerberg  * @flags: Flags for the frame (see &enum ring_desc_flags)
5903b3d9f4dSMika Westerberg  * @eof: End of frame protocol defined field
5913b3d9f4dSMika Westerberg  * @sof: Start of frame protocol defined field
5923b3d9f4dSMika Westerberg  */
5933b3d9f4dSMika Westerberg struct ring_frame {
5943b3d9f4dSMika Westerberg 	dma_addr_t buffer_phy;
5953b3d9f4dSMika Westerberg 	ring_cb callback;
5963b3d9f4dSMika Westerberg 	struct list_head list;
5973b3d9f4dSMika Westerberg 	u32 size:12;
5983b3d9f4dSMika Westerberg 	u32 flags:12;
5993b3d9f4dSMika Westerberg 	u32 eof:4;
6003b3d9f4dSMika Westerberg 	u32 sof:4;
6013b3d9f4dSMika Westerberg };
6023b3d9f4dSMika Westerberg 
6033b3d9f4dSMika Westerberg /* Minimum size for ring_rx */
6043b3d9f4dSMika Westerberg #define TB_FRAME_SIZE		0x100
6053b3d9f4dSMika Westerberg 
6063b3d9f4dSMika Westerberg struct tb_ring *tb_ring_alloc_tx(struct tb_nhi *nhi, int hop, int size,
6073b3d9f4dSMika Westerberg 				 unsigned int flags);
6083b3d9f4dSMika Westerberg struct tb_ring *tb_ring_alloc_rx(struct tb_nhi *nhi, int hop, int size,
609afe704a2SMika Westerberg 				 unsigned int flags, int e2e_tx_hop,
610afe704a2SMika Westerberg 				 u16 sof_mask, u16 eof_mask,
6114ffe722eSMika Westerberg 				 void (*start_poll)(void *), void *poll_data);
6123b3d9f4dSMika Westerberg void tb_ring_start(struct tb_ring *ring);
6133b3d9f4dSMika Westerberg void tb_ring_stop(struct tb_ring *ring);
6143b3d9f4dSMika Westerberg void tb_ring_free(struct tb_ring *ring);
6153b3d9f4dSMika Westerberg 
6163b3d9f4dSMika Westerberg int __tb_ring_enqueue(struct tb_ring *ring, struct ring_frame *frame);
6173b3d9f4dSMika Westerberg 
6183b3d9f4dSMika Westerberg /**
6193b3d9f4dSMika Westerberg  * tb_ring_rx() - enqueue a frame on an RX ring
6203b3d9f4dSMika Westerberg  * @ring: Ring to enqueue the frame
6213b3d9f4dSMika Westerberg  * @frame: Frame to enqueue
6223b3d9f4dSMika Westerberg  *
6234ffe722eSMika Westerberg  * @frame->buffer, @frame->buffer_phy have to be set. The buffer must
6244ffe722eSMika Westerberg  * contain at least %TB_FRAME_SIZE bytes.
6253b3d9f4dSMika Westerberg  *
6263b3d9f4dSMika Westerberg  * @frame->callback will be invoked with @frame->size, @frame->flags,
6273b3d9f4dSMika Westerberg  * @frame->eof, @frame->sof set once the frame has been received.
6283b3d9f4dSMika Westerberg  *
6293b3d9f4dSMika Westerberg  * If ring_stop() is called after the packet has been enqueued
6303b3d9f4dSMika Westerberg  * @frame->callback will be called with canceled set to true.
6313b3d9f4dSMika Westerberg  *
6323b3d9f4dSMika Westerberg  * Return: Returns %-ESHUTDOWN if ring_stop has been called. Zero otherwise.
6333b3d9f4dSMika Westerberg  */
tb_ring_rx(struct tb_ring * ring,struct ring_frame * frame)6343b3d9f4dSMika Westerberg static inline int tb_ring_rx(struct tb_ring *ring, struct ring_frame *frame)
6353b3d9f4dSMika Westerberg {
6363b3d9f4dSMika Westerberg 	WARN_ON(ring->is_tx);
6373b3d9f4dSMika Westerberg 	return __tb_ring_enqueue(ring, frame);
6383b3d9f4dSMika Westerberg }
6393b3d9f4dSMika Westerberg 
6403b3d9f4dSMika Westerberg /**
6413b3d9f4dSMika Westerberg  * tb_ring_tx() - enqueue a frame on an TX ring
6423b3d9f4dSMika Westerberg  * @ring: Ring the enqueue the frame
6433b3d9f4dSMika Westerberg  * @frame: Frame to enqueue
6443b3d9f4dSMika Westerberg  *
6454ffe722eSMika Westerberg  * @frame->buffer, @frame->buffer_phy, @frame->size, @frame->eof and
6464ffe722eSMika Westerberg  * @frame->sof have to be set.
6473b3d9f4dSMika Westerberg  *
6483b3d9f4dSMika Westerberg  * @frame->callback will be invoked with once the frame has been transmitted.
6493b3d9f4dSMika Westerberg  *
6503b3d9f4dSMika Westerberg  * If ring_stop() is called after the packet has been enqueued @frame->callback
6513b3d9f4dSMika Westerberg  * will be called with canceled set to true.
6523b3d9f4dSMika Westerberg  *
6533b3d9f4dSMika Westerberg  * Return: Returns %-ESHUTDOWN if ring_stop has been called. Zero otherwise.
6543b3d9f4dSMika Westerberg  */
tb_ring_tx(struct tb_ring * ring,struct ring_frame * frame)6553b3d9f4dSMika Westerberg static inline int tb_ring_tx(struct tb_ring *ring, struct ring_frame *frame)
6563b3d9f4dSMika Westerberg {
6573b3d9f4dSMika Westerberg 	WARN_ON(!ring->is_tx);
6583b3d9f4dSMika Westerberg 	return __tb_ring_enqueue(ring, frame);
6593b3d9f4dSMika Westerberg }
6603b3d9f4dSMika Westerberg 
6614ffe722eSMika Westerberg /* Used only when the ring is in polling mode */
6624ffe722eSMika Westerberg struct ring_frame *tb_ring_poll(struct tb_ring *ring);
6634ffe722eSMika Westerberg void tb_ring_poll_complete(struct tb_ring *ring);
6644ffe722eSMika Westerberg 
6653304559eSMika Westerberg /**
6663304559eSMika Westerberg  * tb_ring_dma_device() - Return device used for DMA mapping
6673304559eSMika Westerberg  * @ring: Ring whose DMA device is retrieved
6683304559eSMika Westerberg  *
6693304559eSMika Westerberg  * Use this function when you are mapping DMA for buffers that are
6703304559eSMika Westerberg  * passed to the ring for sending/receiving.
6713304559eSMika Westerberg  */
tb_ring_dma_device(struct tb_ring * ring)6723304559eSMika Westerberg static inline struct device *tb_ring_dma_device(struct tb_ring *ring)
6733304559eSMika Westerberg {
6743304559eSMika Westerberg 	return &ring->nhi->pdev->dev;
6753304559eSMika Westerberg }
6763304559eSMika Westerberg 
677cdae7c07SMika Westerberg #endif /* THUNDERBOLT_H_ */
678