xref: /OK3568_Linux_fs/kernel/include/linux/greybus/connection.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Greybus connections
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright 2014 Google Inc.
6*4882a593Smuzhiyun  * Copyright 2014 Linaro Ltd.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef __CONNECTION_H
10*4882a593Smuzhiyun #define __CONNECTION_H
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <linux/bits.h>
13*4882a593Smuzhiyun #include <linux/list.h>
14*4882a593Smuzhiyun #include <linux/kfifo.h>
15*4882a593Smuzhiyun #include <linux/kref.h>
16*4882a593Smuzhiyun #include <linux/workqueue.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #define GB_CONNECTION_FLAG_CSD		BIT(0)
19*4882a593Smuzhiyun #define GB_CONNECTION_FLAG_NO_FLOWCTRL	BIT(1)
20*4882a593Smuzhiyun #define GB_CONNECTION_FLAG_OFFLOADED	BIT(2)
21*4882a593Smuzhiyun #define GB_CONNECTION_FLAG_CDSI1	BIT(3)
22*4882a593Smuzhiyun #define GB_CONNECTION_FLAG_CONTROL	BIT(4)
23*4882a593Smuzhiyun #define GB_CONNECTION_FLAG_HIGH_PRIO	BIT(5)
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #define GB_CONNECTION_FLAG_CORE_MASK	GB_CONNECTION_FLAG_CONTROL
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun enum gb_connection_state {
28*4882a593Smuzhiyun 	GB_CONNECTION_STATE_DISABLED		= 0,
29*4882a593Smuzhiyun 	GB_CONNECTION_STATE_ENABLED_TX		= 1,
30*4882a593Smuzhiyun 	GB_CONNECTION_STATE_ENABLED		= 2,
31*4882a593Smuzhiyun 	GB_CONNECTION_STATE_DISCONNECTING	= 3,
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun struct gb_operation;
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun typedef int (*gb_request_handler_t)(struct gb_operation *);
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun struct gb_connection {
39*4882a593Smuzhiyun 	struct gb_host_device		*hd;
40*4882a593Smuzhiyun 	struct gb_interface		*intf;
41*4882a593Smuzhiyun 	struct gb_bundle		*bundle;
42*4882a593Smuzhiyun 	struct kref			kref;
43*4882a593Smuzhiyun 	u16				hd_cport_id;
44*4882a593Smuzhiyun 	u16				intf_cport_id;
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	struct list_head		hd_links;
47*4882a593Smuzhiyun 	struct list_head		bundle_links;
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	gb_request_handler_t		handler;
50*4882a593Smuzhiyun 	unsigned long			flags;
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 	struct mutex			mutex;
53*4882a593Smuzhiyun 	spinlock_t			lock;
54*4882a593Smuzhiyun 	enum gb_connection_state	state;
55*4882a593Smuzhiyun 	struct list_head		operations;
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	char				name[16];
58*4882a593Smuzhiyun 	struct workqueue_struct		*wq;
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	atomic_t			op_cycle;
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	void				*private;
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	bool				mode_switch;
65*4882a593Smuzhiyun };
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun struct gb_connection *gb_connection_create_static(struct gb_host_device *hd,
68*4882a593Smuzhiyun 				u16 hd_cport_id, gb_request_handler_t handler);
69*4882a593Smuzhiyun struct gb_connection *gb_connection_create_control(struct gb_interface *intf);
70*4882a593Smuzhiyun struct gb_connection *gb_connection_create(struct gb_bundle *bundle,
71*4882a593Smuzhiyun 				u16 cport_id, gb_request_handler_t handler);
72*4882a593Smuzhiyun struct gb_connection *gb_connection_create_flags(struct gb_bundle *bundle,
73*4882a593Smuzhiyun 				u16 cport_id, gb_request_handler_t handler,
74*4882a593Smuzhiyun 				unsigned long flags);
75*4882a593Smuzhiyun struct gb_connection *gb_connection_create_offloaded(struct gb_bundle *bundle,
76*4882a593Smuzhiyun 				u16 cport_id, unsigned long flags);
77*4882a593Smuzhiyun void gb_connection_destroy(struct gb_connection *connection);
78*4882a593Smuzhiyun 
gb_connection_is_static(struct gb_connection * connection)79*4882a593Smuzhiyun static inline bool gb_connection_is_static(struct gb_connection *connection)
80*4882a593Smuzhiyun {
81*4882a593Smuzhiyun 	return !connection->intf;
82*4882a593Smuzhiyun }
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun int gb_connection_enable(struct gb_connection *connection);
85*4882a593Smuzhiyun int gb_connection_enable_tx(struct gb_connection *connection);
86*4882a593Smuzhiyun void gb_connection_disable_rx(struct gb_connection *connection);
87*4882a593Smuzhiyun void gb_connection_disable(struct gb_connection *connection);
88*4882a593Smuzhiyun void gb_connection_disable_forced(struct gb_connection *connection);
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun void gb_connection_mode_switch_prepare(struct gb_connection *connection);
91*4882a593Smuzhiyun void gb_connection_mode_switch_complete(struct gb_connection *connection);
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun void greybus_data_rcvd(struct gb_host_device *hd, u16 cport_id,
94*4882a593Smuzhiyun 		       u8 *data, size_t length);
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun void gb_connection_latency_tag_enable(struct gb_connection *connection);
97*4882a593Smuzhiyun void gb_connection_latency_tag_disable(struct gb_connection *connection);
98*4882a593Smuzhiyun 
gb_connection_e2efc_enabled(struct gb_connection * connection)99*4882a593Smuzhiyun static inline bool gb_connection_e2efc_enabled(struct gb_connection *connection)
100*4882a593Smuzhiyun {
101*4882a593Smuzhiyun 	return !(connection->flags & GB_CONNECTION_FLAG_CSD);
102*4882a593Smuzhiyun }
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun static inline bool
gb_connection_flow_control_disabled(struct gb_connection * connection)105*4882a593Smuzhiyun gb_connection_flow_control_disabled(struct gb_connection *connection)
106*4882a593Smuzhiyun {
107*4882a593Smuzhiyun 	return connection->flags & GB_CONNECTION_FLAG_NO_FLOWCTRL;
108*4882a593Smuzhiyun }
109*4882a593Smuzhiyun 
gb_connection_is_offloaded(struct gb_connection * connection)110*4882a593Smuzhiyun static inline bool gb_connection_is_offloaded(struct gb_connection *connection)
111*4882a593Smuzhiyun {
112*4882a593Smuzhiyun 	return connection->flags & GB_CONNECTION_FLAG_OFFLOADED;
113*4882a593Smuzhiyun }
114*4882a593Smuzhiyun 
gb_connection_is_control(struct gb_connection * connection)115*4882a593Smuzhiyun static inline bool gb_connection_is_control(struct gb_connection *connection)
116*4882a593Smuzhiyun {
117*4882a593Smuzhiyun 	return connection->flags & GB_CONNECTION_FLAG_CONTROL;
118*4882a593Smuzhiyun }
119*4882a593Smuzhiyun 
gb_connection_get_data(struct gb_connection * connection)120*4882a593Smuzhiyun static inline void *gb_connection_get_data(struct gb_connection *connection)
121*4882a593Smuzhiyun {
122*4882a593Smuzhiyun 	return connection->private;
123*4882a593Smuzhiyun }
124*4882a593Smuzhiyun 
gb_connection_set_data(struct gb_connection * connection,void * data)125*4882a593Smuzhiyun static inline void gb_connection_set_data(struct gb_connection *connection,
126*4882a593Smuzhiyun 					  void *data)
127*4882a593Smuzhiyun {
128*4882a593Smuzhiyun 	connection->private = data;
129*4882a593Smuzhiyun }
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun #endif /* __CONNECTION_H */
132