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