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