include/linux/connector.h

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