[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / linux / connector.h
blob95952cc1f525b509b365191738911c2d992d19ac
1 /*
2 * connector.h
3 *
4 * 2004-2005 Copyright (c) Evgeniy Polyakov <johnpol@2ka.mipt.ru>
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.
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.
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
22 #ifndef __CONNECTOR_H
23 #define __CONNECTOR_H
25 #include <asm/types.h>
27 #define CN_IDX_CONNECTOR 0xffffffff
28 #define CN_VAL_CONNECTOR 0xffffffff
30 #define CN_NETLINK_USERS 1
33 * Maximum connector's message size.
35 #define CONNECTOR_MAX_MSG_SIZE 1024
38 * idx and val are unique identifiers which
39 * are used for message routing and
40 * must be registered in connector.h for in-kernel usage.
43 struct cb_id {
44 __u32 idx;
45 __u32 val;
48 struct cn_msg {
49 struct cb_id id;
51 __u32 seq;
52 __u32 ack;
54 __u16 len; /* Length of the following data */
55 __u16 flags;
56 __u8 data[0];
60 * Notify structure - requests notification about
61 * registering/unregistering idx/val in range [first, first+range].
63 struct cn_notify_req {
64 __u32 first;
65 __u32 range;
69 * Main notification control message
70 * *_notify_num - number of appropriate cn_notify_req structures after
71 * this struct.
72 * group - notification receiver's idx.
73 * len - total length of the attached data.
75 struct cn_ctl_msg {
76 __u32 idx_notify_num;
77 __u32 val_notify_num;
78 __u32 group;
79 __u32 len;
80 __u8 data[0];
83 #ifdef __KERNEL__
85 #include <asm/atomic.h>
87 #include <linux/list.h>
88 #include <linux/workqueue.h>
90 #include <net/sock.h>
92 #define CN_CBQ_NAMELEN 32
94 struct cn_queue_dev {
95 atomic_t refcnt;
96 unsigned char name[CN_CBQ_NAMELEN];
98 struct workqueue_struct *cn_queue;
100 struct list_head queue_list;
101 spinlock_t queue_lock;
103 int netlink_groups;
104 struct sock *nls;
107 struct cn_callback_id {
108 unsigned char name[CN_CBQ_NAMELEN];
109 struct cb_id id;
112 struct cn_callback_data {
113 void (*destruct_data) (void *);
114 void *ddata;
116 void *callback_priv;
117 void (*callback) (void *);
119 void *free;
122 struct cn_callback_entry {
123 struct list_head callback_entry;
124 struct cn_callback *cb;
125 struct work_struct work;
126 struct cn_queue_dev *pdev;
128 struct cn_callback_id id;
129 struct cn_callback_data data;
131 int seq, group;
132 struct sock *nls;
135 struct cn_ctl_entry {
136 struct list_head notify_entry;
137 struct cn_ctl_msg *msg;
140 struct cn_dev {
141 struct cb_id id;
143 u32 seq, groups;
144 struct sock *nls;
145 void (*input) (struct sock * sk, int len);
147 struct cn_queue_dev *cbdev;
150 int cn_add_callback(struct cb_id *, char *, void (*callback) (void *));
151 void cn_del_callback(struct cb_id *);
152 int cn_netlink_send(struct cn_msg *, u32, gfp_t);
154 int cn_queue_add_callback(struct cn_queue_dev *dev, char *name, struct cb_id *id, void (*callback)(void *));
155 void cn_queue_del_callback(struct cn_queue_dev *dev, struct cb_id *id);
157 struct cn_queue_dev *cn_queue_alloc_dev(char *name, struct sock *);
158 void cn_queue_free_dev(struct cn_queue_dev *dev);
160 int cn_cb_equal(struct cb_id *, struct cb_id *);
162 void cn_queue_wrapper(void *data);
164 extern int cn_already_initialized;
166 #endif /* __KERNEL__ */
167 #endif /* __CONNECTOR_H */