[mirror_ubuntu-focal-kernel.git] / include / linux / connector.h

/*
 * 	connector.h
 * 
 * 2004-2005 Copyright (c) Evgeniy Polyakov <johnpol@2ka.mipt.ru>
 * All rights reserved.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __CONNECTOR_H
#define __CONNECTOR_H

#include <asm/types.h>

#define CN_IDX_CONNECTOR		0xffffffff
#define CN_VAL_CONNECTOR		0xffffffff

#define CN_NETLINK_USERS		1

/*
 * Maximum connector's message size.
 */
#define CONNECTOR_MAX_MSG_SIZE 	1024

/*
 * idx and val are unique identifiers which 
 * are used for message routing and 
 * must be registered in connector.h for in-kernel usage.
 */

struct cb_id {
	__u32 idx;
	__u32 val;
};

struct cn_msg {
	struct cb_id id;

	__u32 seq;
	__u32 ack;

	__u16 len;		/* Length of the following data */
	__u16 flags;
	__u8 data[0];
};

/*
 * Notify structure - requests notification about
 * registering/unregistering idx/val in range [first, first+range].
 */
struct cn_notify_req {
	__u32 first;
	__u32 range;
};

/*
 * Main notification control message
 * *_notify_num 	- number of appropriate cn_notify_req structures after 
 *				this struct.
 * group 		- notification receiver's idx.
 * len 			- total length of the attached data.
 */
struct cn_ctl_msg {
	__u32 idx_notify_num;
	__u32 val_notify_num;
	__u32 group;
	__u32 len;
	__u8 data[0];
};

#ifdef __KERNEL__

#include <asm/atomic.h>

#include <linux/list.h>
#include <linux/workqueue.h>

#include <net/sock.h>

#define CN_CBQ_NAMELEN		32

struct cn_queue_dev {
	atomic_t refcnt;
	unsigned char name[CN_CBQ_NAMELEN];

	struct workqueue_struct *cn_queue;

	struct list_head queue_list;
	spinlock_t queue_lock;

	int netlink_groups;
	struct sock *nls;
};

struct cn_callback {
	unsigned char name[CN_CBQ_NAMELEN];

	struct cb_id id;
	void (*callback) (void *);
	void *priv;
};

struct cn_callback_entry {
	struct list_head callback_entry;
	struct cn_callback *cb;
	struct work_struct work;
	struct cn_queue_dev *pdev;

	void (*destruct_data) (void *);
	void *ddata;

	int seq, group;
	struct sock *nls;
};

struct cn_ctl_entry {
	struct list_head notify_entry;
	struct cn_ctl_msg *msg;
};

struct cn_dev {
	struct cb_id id;

	u32 seq, groups;
	struct sock *nls;
	void (*input) (struct sock * sk, int len);

	struct cn_queue_dev *cbdev;
};

int cn_add_callback(struct cb_id *, char *, void (*callback) (void *));
void cn_del_callback(struct cb_id *);
int cn_netlink_send(struct cn_msg *, u32, int);

int cn_queue_add_callback(struct cn_queue_dev *dev, struct cn_callback *cb);
void cn_queue_del_callback(struct cn_queue_dev *dev, struct cb_id *id);

struct cn_queue_dev *cn_queue_alloc_dev(char *name, struct sock *);
void cn_queue_free_dev(struct cn_queue_dev *dev);

int cn_cb_equal(struct cb_id *, struct cb_id *);

extern int cn_already_initialized;

#endif				/* __KERNEL__ */
#endif				/* __CONNECTOR_H */
Commit	Line	Data
7672d0b5 EP	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	#define CN_NETLINK_USERS 1
	31
	32	/*
	33	* Maximum connector's message size.
	34	*/
	35	#define CONNECTOR_MAX_MSG_SIZE 1024
	36
	37	/*
	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.
	41	*/
	42
	43	struct cb_id {
	44	__u32 idx;
	45	__u32 val;
	46	};
	47
	48	struct cn_msg {
	49	struct cb_id id;
	50
	51	__u32 seq;
	52	__u32 ack;
	53
	54	__u16 len; /* Length of the following data */
	55	__u16 flags;
	56	__u8 data[0];
	57	};
	58
	59	/*
	60	* Notify structure - requests notification about
	61	* registering/unregistering idx/val in range [first, first+range].
	62	*/
	63	struct cn_notify_req {
	64	__u32 first;
65	__u32 range;
66	};
67
68	/*
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.
74	*/
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];
81	};
82
83	#ifdef __KERNEL__
84
85	#include <asm/atomic.h>
86
87	#include <linux/list.h>
88	#include <linux/workqueue.h>
89
90	#include <net/sock.h>
91
92	#define CN_CBQ_NAMELEN 32
93
94	struct cn_queue_dev {
95	atomic_t refcnt;
96	unsigned char name[CN_CBQ_NAMELEN];
97
98	struct workqueue_struct *cn_queue;
99
100	struct list_head queue_list;
101	spinlock_t queue_lock;
102
103	int netlink_groups;
104	struct sock *nls;
105	};
106
107	struct cn_callback {
108	unsigned char name[CN_CBQ_NAMELEN];
109
110	struct cb_id id;
111	void (callback) (void );
112	void *priv;
113	};
114
115	struct cn_callback_entry {
116	struct list_head callback_entry;
117	struct cn_callback *cb;
118	struct work_struct work;
119	struct cn_queue_dev *pdev;
120
121	void (destruct_data) (void );
122	void *ddata;
123
124	int seq, group;
125	struct sock *nls;
126	};
127
128	struct cn_ctl_entry {
129	struct list_head notify_entry;
130	struct cn_ctl_msg *msg;
131	};
132
133	struct cn_dev {
134	struct cb_id id;
135
136	u32 seq, groups;
137	struct sock *nls;
138	void (input) (struct sock sk, int len);
139
140	struct cn_queue_dev *cbdev;
141	};
142
143	int cn_add_callback(struct cb_id , char , void (callback) (void ));
144	void cn_del_callback(struct cb_id *);
145	int cn_netlink_send(struct cn_msg *, u32, int);
146
147	int cn_queue_add_callback(struct cn_queue_dev dev, struct cn_callback cb);
148	void cn_queue_del_callback(struct cn_queue_dev dev, struct cb_id id);
149
150	struct cn_queue_dev cn_queue_alloc_dev(char name, struct sock *);
151	void cn_queue_free_dev(struct cn_queue_dev *dev);
152
153	int cn_cb_equal(struct cb_id , struct cb_id );
154
155	extern int cn_already_initialized;
156
157	#endif /* __KERNEL__ */
158	#endif /* __CONNECTOR_H */