xref: /linux-6.15/include/linux/connector.h (revision a1e58bbd)
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 <asm/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 
42 #define CN_NETLINK_USERS		5
43 
44 /*
45  * Maximum connector's message size.
46  */
47 #define CONNECTOR_MAX_MSG_SIZE		16384
48 
49 /*
50  * idx and val are unique identifiers which
51  * are used for message routing and
52  * must be registered in connector.h for in-kernel usage.
53  */
54 
55 struct cb_id {
56 	__u32 idx;
57 	__u32 val;
58 };
59 
60 struct cn_msg {
61 	struct cb_id id;
62 
63 	__u32 seq;
64 	__u32 ack;
65 
66 	__u16 len;		/* Length of the following data */
67 	__u16 flags;
68 	__u8 data[0];
69 };
70 
71 /*
72  * Notify structure - requests notification about
73  * registering/unregistering idx/val in range [first, first+range].
74  */
75 struct cn_notify_req {
76 	__u32 first;
77 	__u32 range;
78 };
79 
80 /*
81  * Main notification control message
82  * *_notify_num 	- number of appropriate cn_notify_req structures after
83  *				this struct.
84  * group 		- notification receiver's idx.
85  * len 			- total length of the attached data.
86  */
87 struct cn_ctl_msg {
88 	__u32 idx_notify_num;
89 	__u32 val_notify_num;
90 	__u32 group;
91 	__u32 len;
92 	__u8 data[0];
93 };
94 
95 #ifdef __KERNEL__
96 
97 #include <asm/atomic.h>
98 
99 #include <linux/list.h>
100 #include <linux/workqueue.h>
101 
102 #include <net/sock.h>
103 
104 #define CN_CBQ_NAMELEN		32
105 
106 struct cn_queue_dev {
107 	atomic_t refcnt;
108 	unsigned char name[CN_CBQ_NAMELEN];
109 
110 	struct workqueue_struct *cn_queue;
111 
112 	struct list_head queue_list;
113 	spinlock_t queue_lock;
114 
115 	struct sock *nls;
116 };
117 
118 struct cn_callback_id {
119 	unsigned char name[CN_CBQ_NAMELEN];
120 	struct cb_id id;
121 };
122 
123 struct cn_callback_data {
124 	void (*destruct_data) (void *);
125 	void *ddata;
126 
127 	void *callback_priv;
128 	void (*callback) (void *);
129 
130 	void *free;
131 };
132 
133 struct cn_callback_entry {
134 	struct list_head callback_entry;
135 	struct work_struct work;
136 	struct cn_queue_dev *pdev;
137 
138 	struct cn_callback_id id;
139 	struct cn_callback_data data;
140 
141 	u32 seq, group;
142 };
143 
144 struct cn_ctl_entry {
145 	struct list_head notify_entry;
146 	struct cn_ctl_msg *msg;
147 };
148 
149 struct cn_dev {
150 	struct cb_id id;
151 
152 	u32 seq, groups;
153 	struct sock *nls;
154 	void (*input) (struct sk_buff *skb);
155 
156 	struct cn_queue_dev *cbdev;
157 };
158 
159 int cn_add_callback(struct cb_id *, char *, void (*callback) (void *));
160 void cn_del_callback(struct cb_id *);
161 int cn_netlink_send(struct cn_msg *, u32, gfp_t);
162 
163 int cn_queue_add_callback(struct cn_queue_dev *dev, char *name, struct cb_id *id, void (*callback)(void *));
164 void cn_queue_del_callback(struct cn_queue_dev *dev, struct cb_id *id);
165 
166 struct cn_queue_dev *cn_queue_alloc_dev(char *name, struct sock *);
167 void cn_queue_free_dev(struct cn_queue_dev *dev);
168 
169 int cn_cb_equal(struct cb_id *, struct cb_id *);
170 
171 void cn_queue_wrapper(struct work_struct *work);
172 
173 #endif				/* __KERNEL__ */
174 #endif				/* __CONNECTOR_H */
175