xref: /linux-6.15/include/linux/connector.h (revision ee665ecc)
1 /*
2  * 	connector.h
3  *
4  * 2004-2005 Copyright (c) Evgeniy Polyakov <[email protected]>
5  * All rights reserved.
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21 
22 #ifndef __CONNECTOR_H
23 #define __CONNECTOR_H
24 
25 #include <linux/types.h>
26 
27 #define CN_IDX_CONNECTOR		0xffffffff
28 #define CN_VAL_CONNECTOR		0xffffffff
29 
30 /*
31  * Process Events connector unique ids -- used for message routing
32  */
33 #define CN_IDX_PROC			0x1
34 #define CN_VAL_PROC			0x1
35 #define CN_IDX_CIFS			0x2
36 #define CN_VAL_CIFS                     0x1
37 #define CN_W1_IDX			0x3	/* w1 communication */
38 #define CN_W1_VAL			0x1
39 #define CN_IDX_V86D			0x4
40 #define CN_VAL_V86D_UVESAFB		0x1
41 #define CN_IDX_BB			0x5	/* BlackBoard, from the TSP GPL sampling framework */
42 
43 #define CN_NETLINK_USERS		6
44 
45 /*
46  * Maximum connector's message size.
47  */
48 #define CONNECTOR_MAX_MSG_SIZE		16384
49 
50 /*
51  * idx and val are unique identifiers which
52  * are used for message routing and
53  * must be registered in connector.h for in-kernel usage.
54  */
55 
56 struct cb_id {
57 	__u32 idx;
58 	__u32 val;
59 };
60 
61 struct cn_msg {
62 	struct cb_id id;
63 
64 	__u32 seq;
65 	__u32 ack;
66 
67 	__u16 len;		/* Length of the following data */
68 	__u16 flags;
69 	__u8 data[0];
70 };
71 
72 /*
73  * Notify structure - requests notification about
74  * registering/unregistering idx/val in range [first, first+range].
75  */
76 struct cn_notify_req {
77 	__u32 first;
78 	__u32 range;
79 };
80 
81 /*
82  * Main notification control message
83  * *_notify_num 	- number of appropriate cn_notify_req structures after
84  *				this struct.
85  * group 		- notification receiver's idx.
86  * len 			- total length of the attached data.
87  */
88 struct cn_ctl_msg {
89 	__u32 idx_notify_num;
90 	__u32 val_notify_num;
91 	__u32 group;
92 	__u32 len;
93 	__u8 data[0];
94 };
95 
96 #ifdef __KERNEL__
97 
98 #include <asm/atomic.h>
99 
100 #include <linux/list.h>
101 #include <linux/workqueue.h>
102 
103 #include <net/sock.h>
104 
105 #define CN_CBQ_NAMELEN		32
106 
107 struct cn_queue_dev {
108 	atomic_t refcnt;
109 	unsigned char name[CN_CBQ_NAMELEN];
110 
111 	struct workqueue_struct *cn_queue;
112 	/* Sent to kevent to create cn_queue only when needed */
113 	struct work_struct wq_creation;
114 	/* Tell if the wq_creation job is pending/completed */
115 	atomic_t wq_requested;
116 	/* Wait for cn_queue to be created */
117 	wait_queue_head_t wq_created;
118 
119 	struct list_head queue_list;
120 	spinlock_t queue_lock;
121 
122 	struct sock *nls;
123 };
124 
125 struct cn_callback_id {
126 	unsigned char name[CN_CBQ_NAMELEN];
127 	struct cb_id id;
128 };
129 
130 struct cn_callback_data {
131 	void (*destruct_data) (void *);
132 	void *ddata;
133 
134 	void *callback_priv;
135 	void (*callback) (void *);
136 
137 	void *free;
138 };
139 
140 struct cn_callback_entry {
141 	struct list_head callback_entry;
142 	struct work_struct work;
143 	struct cn_queue_dev *pdev;
144 
145 	struct cn_callback_id id;
146 	struct cn_callback_data data;
147 
148 	u32 seq, group;
149 };
150 
151 struct cn_ctl_entry {
152 	struct list_head notify_entry;
153 	struct cn_ctl_msg *msg;
154 };
155 
156 struct cn_dev {
157 	struct cb_id id;
158 
159 	u32 seq, groups;
160 	struct sock *nls;
161 	void (*input) (struct sk_buff *skb);
162 
163 	struct cn_queue_dev *cbdev;
164 };
165 
166 int cn_add_callback(struct cb_id *, char *, void (*callback) (void *));
167 void cn_del_callback(struct cb_id *);
168 int cn_netlink_send(struct cn_msg *, u32, gfp_t);
169 
170 int cn_queue_add_callback(struct cn_queue_dev *dev, char *name, struct cb_id *id, void (*callback)(void *));
171 void cn_queue_del_callback(struct cn_queue_dev *dev, struct cb_id *id);
172 
173 int queue_cn_work(struct cn_callback_entry *cbq, struct work_struct *work);
174 
175 struct cn_queue_dev *cn_queue_alloc_dev(char *name, struct sock *);
176 void cn_queue_free_dev(struct cn_queue_dev *dev);
177 
178 int cn_cb_equal(struct cb_id *, struct cb_id *);
179 
180 void cn_queue_wrapper(struct work_struct *work);
181 
182 #endif				/* __KERNEL__ */
183 #endif				/* __CONNECTOR_H */
184