[mirror_ubuntu-artful-kernel.git] / include / net / netrom.h

/*
 *	Declarations of NET/ROM type objects.
 *
 *	Jonathan Naylor G4KLX	9/4/95
 */

#ifndef _NETROM_H
#define _NETROM_H 

#include <linux/netrom.h>
#include <linux/list.h>
#include <linux/slab.h>
#include <net/sock.h>
#include <linux/refcount.h>

#define	NR_NETWORK_LEN			15
#define	NR_TRANSPORT_LEN		5

#define	NR_PROTO_IP			0x0C

#define	NR_PROTOEXT			0x00
#define	NR_CONNREQ			0x01
#define	NR_CONNACK			0x02
#define	NR_DISCREQ			0x03
#define	NR_DISCACK			0x04
#define	NR_INFO				0x05
#define	NR_INFOACK			0x06
#define	NR_RESET			0x07

#define	NR_CHOKE_FLAG			0x80
#define	NR_NAK_FLAG			0x40
#define	NR_MORE_FLAG			0x20

/* Define Link State constants. */
enum {
	NR_STATE_0,
	NR_STATE_1,
	NR_STATE_2,
	NR_STATE_3
};

#define	NR_COND_ACK_PENDING		0x01
#define	NR_COND_REJECT			0x02
#define	NR_COND_PEER_RX_BUSY		0x04
#define	NR_COND_OWN_RX_BUSY		0x08

#define NR_DEFAULT_T1			120000		/* Outstanding frames - 120 seconds */
#define NR_DEFAULT_T2			5000		/* Response delay     - 5 seconds */
#define NR_DEFAULT_N2			3		/* Number of Retries - 3 */
#define	NR_DEFAULT_T4			180000		/* Busy Delay - 180 seconds */
#define	NR_DEFAULT_IDLE			0		/* No Activity Timeout - none */
#define	NR_DEFAULT_WINDOW		4		/* Default Window Size - 4 */
#define	NR_DEFAULT_OBS			6		/* Default Obsolescence Count - 6 */
#define	NR_DEFAULT_QUAL			10		/* Default Neighbour Quality - 10 */
#define	NR_DEFAULT_TTL			16		/* Default Time To Live - 16 */
#define	NR_DEFAULT_ROUTING		1		/* Is routing enabled ? */
#define	NR_DEFAULT_FAILS		2		/* Link fails until route fails */
#define	NR_DEFAULT_RESET		0		/* Sent / accept reset cmds? */

#define NR_MODULUS 			256
#define NR_MAX_WINDOW_SIZE		127			/* Maximum Window Allowable - 127 */
#define	NR_MAX_PACKET_SIZE		236			/* Maximum Packet Length - 236 */

struct nr_sock {
	struct sock		sock;
	ax25_address		user_addr, source_addr, dest_addr;
	struct net_device		*device;
	unsigned char		my_index,   my_id;
	unsigned char		your_index, your_id;
	unsigned char		state, condition, bpqext, window;
	unsigned short		vs, vr, va, vl;
	unsigned char		n2, n2count;
	unsigned long		t1, t2, t4, idle;
	unsigned short		fraglen;
	struct timer_list	t1timer;
	struct timer_list	t2timer;
	struct timer_list	t4timer;
	struct timer_list	idletimer;
	struct sk_buff_head	ack_queue;
	struct sk_buff_head	reseq_queue;
	struct sk_buff_head	frag_queue;
};

#define nr_sk(sk) ((struct nr_sock *)(sk))

struct nr_neigh {
	struct hlist_node	neigh_node;
	ax25_address		callsign;
	ax25_digi		*digipeat;
	ax25_cb			*ax25;
	struct net_device	*dev;
	unsigned char		quality;
	unsigned char		locked;
	unsigned short		count;
	unsigned int		number;
	unsigned char		failed;
	refcount_t		refcount;
};

struct nr_route {
	unsigned char   quality;
	unsigned char   obs_count;
	struct nr_neigh *neighbour;
};

struct nr_node {
	struct hlist_node	node_node;
	ax25_address		callsign;
	char			mnemonic[7];
	unsigned char		which;
	unsigned char		count;
	struct nr_route		routes[3];
	refcount_t		refcount;
	spinlock_t		node_lock;
};

/*********************************************************************
 *	nr_node & nr_neigh lists, refcounting and locking
 *********************************************************************/

#define nr_node_hold(__nr_node) \
	refcount_inc(&((__nr_node)->refcount))

static __inline__ void nr_node_put(struct nr_node *nr_node)
{
	if (refcount_dec_and_test(&nr_node->refcount)) {
		kfree(nr_node);
	}
}

#define nr_neigh_hold(__nr_neigh) \
	refcount_inc(&((__nr_neigh)->refcount))

static __inline__ void nr_neigh_put(struct nr_neigh *nr_neigh)
{
	if (refcount_dec_and_test(&nr_neigh->refcount)) {
		if (nr_neigh->ax25)
			ax25_cb_put(nr_neigh->ax25);
		kfree(nr_neigh->digipeat);
		kfree(nr_neigh);
	}
}

/* nr_node_lock and nr_node_unlock also hold/put the node's refcounter.
 */
static __inline__ void nr_node_lock(struct nr_node *nr_node)
{
	nr_node_hold(nr_node);
	spin_lock_bh(&nr_node->node_lock);
}

static __inline__ void nr_node_unlock(struct nr_node *nr_node)
{
	spin_unlock_bh(&nr_node->node_lock);
	nr_node_put(nr_node);
}

#define nr_neigh_for_each(__nr_neigh, list) \
	hlist_for_each_entry(__nr_neigh, list, neigh_node)

#define nr_neigh_for_each_safe(__nr_neigh, node2, list) \
	hlist_for_each_entry_safe(__nr_neigh, node2, list, neigh_node)

#define nr_node_for_each(__nr_node, list) \
	hlist_for_each_entry(__nr_node, list, node_node)

#define nr_node_for_each_safe(__nr_node, node2, list) \
	hlist_for_each_entry_safe(__nr_node, node2, list, node_node)


/*********************************************************************/

/* af_netrom.c */
extern int  sysctl_netrom_default_path_quality;
extern int  sysctl_netrom_obsolescence_count_initialiser;
extern int  sysctl_netrom_network_ttl_initialiser;
extern int  sysctl_netrom_transport_timeout;
extern int  sysctl_netrom_transport_maximum_tries;
extern int  sysctl_netrom_transport_acknowledge_delay;
extern int  sysctl_netrom_transport_busy_delay;
extern int  sysctl_netrom_transport_requested_window_size;
extern int  sysctl_netrom_transport_no_activity_timeout;
extern int  sysctl_netrom_routing_control;
extern int  sysctl_netrom_link_fails_count;
extern int  sysctl_netrom_reset_circuit;

int nr_rx_frame(struct sk_buff *, struct net_device *);
void nr_destroy_socket(struct sock *);

/* nr_dev.c */
int nr_rx_ip(struct sk_buff *, struct net_device *);
void nr_setup(struct net_device *);

/* nr_in.c */
int nr_process_rx_frame(struct sock *, struct sk_buff *);

/* nr_loopback.c */
void nr_loopback_init(void);
void nr_loopback_clear(void);
int nr_loopback_queue(struct sk_buff *);

/* nr_out.c */
void nr_output(struct sock *, struct sk_buff *);
void nr_send_nak_frame(struct sock *);
void nr_kick(struct sock *);
void nr_transmit_buffer(struct sock *, struct sk_buff *);
void nr_establish_data_link(struct sock *);
void nr_enquiry_response(struct sock *);
void nr_check_iframes_acked(struct sock *, unsigned short);

/* nr_route.c */
void nr_rt_device_down(struct net_device *);
struct net_device *nr_dev_first(void);
struct net_device *nr_dev_get(ax25_address *);
int nr_rt_ioctl(unsigned int, void __user *);
void nr_link_failed(ax25_cb *, int);
int nr_route_frame(struct sk_buff *, ax25_cb *);
extern const struct file_operations nr_nodes_fops;
extern const struct file_operations nr_neigh_fops;
void nr_rt_free(void);

/* nr_subr.c */
void nr_clear_queues(struct sock *);
void nr_frames_acked(struct sock *, unsigned short);
void nr_requeue_frames(struct sock *);
int nr_validate_nr(struct sock *, unsigned short);
int nr_in_rx_window(struct sock *, unsigned short);
void nr_write_internal(struct sock *, int);

void __nr_transmit_reply(struct sk_buff *skb, int mine, unsigned char cmdflags);

/*
 * This routine is called when a Connect Acknowledge with the Choke Flag
 * set is needed to refuse a connection.
 */
#define nr_transmit_refusal(skb, mine)					\
do {									\
	__nr_transmit_reply((skb), (mine), NR_CONNACK | NR_CHOKE_FLAG);	\
} while (0)

/*
 * This routine is called when we don't have a circuit matching an incoming
 * NET/ROM packet.  This is an G8PZT Xrouter extension.
 */
#define nr_transmit_reset(skb, mine)					\
do {									\
	__nr_transmit_reply((skb), (mine), NR_RESET);			\
} while (0)

void nr_disconnect(struct sock *, int);

/* nr_timer.c */
void nr_init_timers(struct sock *sk);
void nr_start_heartbeat(struct sock *);
void nr_start_t1timer(struct sock *);
void nr_start_t2timer(struct sock *);
void nr_start_t4timer(struct sock *);
void nr_start_idletimer(struct sock *);
void nr_stop_heartbeat(struct sock *);
void nr_stop_t1timer(struct sock *);
void nr_stop_t2timer(struct sock *);
void nr_stop_t4timer(struct sock *);
void nr_stop_idletimer(struct sock *);
int nr_t1timer_running(struct sock *);

/* sysctl_net_netrom.c */
void nr_register_sysctl(void);
void nr_unregister_sysctl(void);

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Declarations of NET/ROM type objects.
	3	*
	4	* Jonathan Naylor G4KLX 9/4/95
	5	*/
	6
	7	#ifndef _NETROM_H
	8	#define _NETROM_H
b88a762b	9
1da177e4 LT	10	#include <linux/netrom.h>
1da177e4 LT	11	#include <linux/list.h>
5a0e3ad6	12	#include <linux/slab.h>
1da177e4	13	#include <net/sock.h>
af420749	14	#include <linux/refcount.h>
1da177e4 LT	15
	16	#define NR_NETWORK_LEN 15
	17	#define NR_TRANSPORT_LEN 5
	18
	19	#define NR_PROTO_IP 0x0C
	20
	21	#define NR_PROTOEXT 0x00
	22	#define NR_CONNREQ 0x01
	23	#define NR_CONNACK 0x02
	24	#define NR_DISCREQ 0x03
	25	#define NR_DISCACK 0x04
	26	#define NR_INFO 0x05
	27	#define NR_INFOACK 0x06
e21ce8c7	28	#define NR_RESET 0x07
1da177e4 LT	29
	30	#define NR_CHOKE_FLAG 0x80
	31	#define NR_NAK_FLAG 0x40
	32	#define NR_MORE_FLAG 0x20
	33
	34	/* Define Link State constants. */
	35	enum {
	36	NR_STATE_0,
	37	NR_STATE_1,
	38	NR_STATE_2,
	39	NR_STATE_3
	40	};
	41
	42	#define NR_COND_ACK_PENDING 0x01
	43	#define NR_COND_REJECT 0x02
	44	#define NR_COND_PEER_RX_BUSY 0x04
	45	#define NR_COND_OWN_RX_BUSY 0x08
	46
4d8937d0 RB	47	#define NR_DEFAULT_T1 120000 /* Outstanding frames - 120 seconds */
4d8937d0 RB	48	#define NR_DEFAULT_T2 5000 /* Response delay - 5 seconds */
1da177e4	49	#define NR_DEFAULT_N2 3 /* Number of Retries - 3 */
4d8937d0 RB	50	#define NR_DEFAULT_T4 180000 /* Busy Delay - 180 seconds */
4d8937d0 RB	51	#define NR_DEFAULT_IDLE 0 /* No Activity Timeout - none */
1da177e4 LT	52	#define NR_DEFAULT_WINDOW 4 /* Default Window Size - 4 */
	53	#define NR_DEFAULT_OBS 6 /* Default Obsolescence Count - 6 */
	54	#define NR_DEFAULT_QUAL 10 /* Default Neighbour Quality - 10 */
	55	#define NR_DEFAULT_TTL 16 /* Default Time To Live - 16 */
	56	#define NR_DEFAULT_ROUTING 1 /* Is routing enabled ? */
	57	#define NR_DEFAULT_FAILS 2 /* Link fails until route fails */
e21ce8c7	58	#define NR_DEFAULT_RESET 0 /* Sent / accept reset cmds? */
1da177e4 LT	59
	60	#define NR_MODULUS 256
	61	#define NR_MAX_WINDOW_SIZE 127 /* Maximum Window Allowable - 127 */
	62	#define NR_MAX_PACKET_SIZE 236 /* Maximum Packet Length - 236 */
	63
	64	struct nr_sock {
	65	struct sock sock;
	66	ax25_address user_addr, source_addr, dest_addr;
	67	struct net_device *device;
	68	unsigned char my_index, my_id;
	69	unsigned char your_index, your_id;
	70	unsigned char state, condition, bpqext, window;
	71	unsigned short vs, vr, va, vl;
	72	unsigned char n2, n2count;
	73	unsigned long t1, t2, t4, idle;
	74	unsigned short fraglen;
	75	struct timer_list t1timer;
	76	struct timer_list t2timer;
	77	struct timer_list t4timer;
	78	struct timer_list idletimer;
	79	struct sk_buff_head ack_queue;
	80	struct sk_buff_head reseq_queue;
	81	struct sk_buff_head frag_queue;
	82	};
	83
	84	#define nr_sk(sk) ((struct nr_sock *)(sk))
	85
	86	struct nr_neigh {
	87	struct hlist_node neigh_node;
	88	ax25_address callsign;
	89	ax25_digi *digipeat;
	90	ax25_cb *ax25;
	91	struct net_device *dev;
	92	unsigned char quality;
	93	unsigned char locked;
	94	unsigned short count;
	95	unsigned int number;
	96	unsigned char failed;
af420749	97	refcount_t refcount;
1da177e4 LT	98	};
	99
	100	struct nr_route {
	101	unsigned char quality;
	102	unsigned char obs_count;
	103	struct nr_neigh *neighbour;
	104	};
	105
	106	struct nr_node {
	107	struct hlist_node node_node;
	108	ax25_address callsign;
	109	char mnemonic[7];
	110	unsigned char which;
	111	unsigned char count;
	112	struct nr_route routes[3];
156be7ed	113	refcount_t refcount;
1da177e4 LT	114	spinlock_t node_lock;
	115	};
	116
	117	/*********************************************************************
	118	* nr_node & nr_neigh lists, refcounting and locking
	119	*********************************************************************/
	120
	121	#define nr_node_hold(__nr_node) \
156be7ed	122	refcount_inc(&((__nr_node)->refcount))
1da177e4 LT	123
	124	static __inline__ void nr_node_put(struct nr_node *nr_node)
	125	{
156be7ed	126	if (refcount_dec_and_test(&nr_node->refcount)) {
1da177e4 LT	127	kfree(nr_node);
	128	}
	129	}
	130
	131	#define nr_neigh_hold(__nr_neigh) \
af420749	132	refcount_inc(&((__nr_neigh)->refcount))
1da177e4 LT	133
	134	static __inline__ void nr_neigh_put(struct nr_neigh *nr_neigh)
	135	{
af420749	136	if (refcount_dec_and_test(&nr_neigh->refcount)) {
d00c362f JP	137	if (nr_neigh->ax25)
d00c362f JP	138	ax25_cb_put(nr_neigh->ax25);
b4558ea9	139	kfree(nr_neigh->digipeat);
1da177e4 LT	140	kfree(nr_neigh);
	141	}
	142	}
	143
	144	/* nr_node_lock and nr_node_unlock also hold/put the node's refcounter.
	145	*/
	146	static __inline__ void nr_node_lock(struct nr_node *nr_node)
	147	{
	148	nr_node_hold(nr_node);
	149	spin_lock_bh(&nr_node->node_lock);
	150	}
	151
	152	static __inline__ void nr_node_unlock(struct nr_node *nr_node)
	153	{
	154	spin_unlock_bh(&nr_node->node_lock);
	155	nr_node_put(nr_node);
	156	}
	157
b67bfe0d SL	158	#define nr_neigh_for_each(__nr_neigh, list) \
b67bfe0d SL	159	hlist_for_each_entry(__nr_neigh, list, neigh_node)
1da177e4	160
b67bfe0d SL	161	#define nr_neigh_for_each_safe(__nr_neigh, node2, list) \
b67bfe0d SL	162	hlist_for_each_entry_safe(__nr_neigh, node2, list, neigh_node)
1da177e4	163
b67bfe0d SL	164	#define nr_node_for_each(__nr_node, list) \
b67bfe0d SL	165	hlist_for_each_entry(__nr_node, list, node_node)
1da177e4	166
b67bfe0d SL	167	#define nr_node_for_each_safe(__nr_node, node2, list) \
b67bfe0d SL	168	hlist_for_each_entry_safe(__nr_node, node2, list, node_node)
1da177e4 LT	169
	170
	171	/*********************************************************************/
	172
	173	/* af_netrom.c */
	174	extern int sysctl_netrom_default_path_quality;
	175	extern int sysctl_netrom_obsolescence_count_initialiser;
	176	extern int sysctl_netrom_network_ttl_initialiser;
	177	extern int sysctl_netrom_transport_timeout;
	178	extern int sysctl_netrom_transport_maximum_tries;
	179	extern int sysctl_netrom_transport_acknowledge_delay;
	180	extern int sysctl_netrom_transport_busy_delay;
	181	extern int sysctl_netrom_transport_requested_window_size;
	182	extern int sysctl_netrom_transport_no_activity_timeout;
	183	extern int sysctl_netrom_routing_control;
	184	extern int sysctl_netrom_link_fails_count;
e21ce8c7 RB	185	extern int sysctl_netrom_reset_circuit;
e21ce8c7 RB	186
96496127 JP	187	int nr_rx_frame(struct sk_buff , struct net_device );
96496127 JP	188	void nr_destroy_socket(struct sock *);
1da177e4 LT	189
1da177e4 LT	190	/* nr_dev.c */
96496127 JP	191	int nr_rx_ip(struct sk_buff , struct net_device );
96496127 JP	192	void nr_setup(struct net_device *);
1da177e4 LT	193
1da177e4 LT	194	/* nr_in.c */
96496127	195	int nr_process_rx_frame(struct sock , struct sk_buff );
1da177e4 LT	196
1da177e4 LT	197	/* nr_loopback.c */
96496127 JP	198	void nr_loopback_init(void);
	199	void nr_loopback_clear(void);
	200	int nr_loopback_queue(struct sk_buff *);
1da177e4 LT	201
1da177e4 LT	202	/* nr_out.c */
96496127 JP	203	void nr_output(struct sock , struct sk_buff );
	204	void nr_send_nak_frame(struct sock *);
	205	void nr_kick(struct sock *);
	206	void nr_transmit_buffer(struct sock , struct sk_buff );
	207	void nr_establish_data_link(struct sock *);
	208	void nr_enquiry_response(struct sock *);
	209	void nr_check_iframes_acked(struct sock *, unsigned short);
1da177e4 LT	210
1da177e4 LT	211	/* nr_route.c */
96496127 JP	212	void nr_rt_device_down(struct net_device *);
	213	struct net_device *nr_dev_first(void);
	214	struct net_device nr_dev_get(ax25_address );
	215	int nr_rt_ioctl(unsigned int, void __user *);
	216	void nr_link_failed(ax25_cb *, int);
	217	int nr_route_frame(struct sk_buff , ax25_cb );
54047320 AV	218	extern const struct file_operations nr_nodes_fops;
54047320 AV	219	extern const struct file_operations nr_neigh_fops;
96496127	220	void nr_rt_free(void);
1da177e4 LT	221
1da177e4 LT	222	/* nr_subr.c */
96496127 JP	223	void nr_clear_queues(struct sock *);
	224	void nr_frames_acked(struct sock *, unsigned short);
	225	void nr_requeue_frames(struct sock *);
	226	int nr_validate_nr(struct sock *, unsigned short);
	227	int nr_in_rx_window(struct sock *, unsigned short);
	228	void nr_write_internal(struct sock *, int);
e21ce8c7	229
96496127	230	void __nr_transmit_reply(struct sk_buff *skb, int mine, unsigned char cmdflags);
e21ce8c7 RB	231
	232	/*
	233	* This routine is called when a Connect Acknowledge with the Choke Flag
	234	* set is needed to refuse a connection.
	235	*/
	236	#define nr_transmit_refusal(skb, mine) \
	237	do { \
	238	__nr_transmit_reply((skb), (mine), NR_CONNACK \| NR_CHOKE_FLAG); \
	239	} while (0)
	240
	241	/*
	242	* This routine is called when we don't have a circuit matching an incoming
	243	* NET/ROM packet. This is an G8PZT Xrouter extension.
	244	*/
	245	#define nr_transmit_reset(skb, mine) \
	246	do { \
	247	__nr_transmit_reply((skb), (mine), NR_RESET); \
	248	} while (0)
	249
96496127	250	void nr_disconnect(struct sock *, int);
1da177e4 LT	251
1da177e4 LT	252	/* nr_timer.c */
96496127 JP	253	void nr_init_timers(struct sock *sk);
	254	void nr_start_heartbeat(struct sock *);
	255	void nr_start_t1timer(struct sock *);
	256	void nr_start_t2timer(struct sock *);
	257	void nr_start_t4timer(struct sock *);
	258	void nr_start_idletimer(struct sock *);
	259	void nr_stop_heartbeat(struct sock *);
	260	void nr_stop_t1timer(struct sock *);
	261	void nr_stop_t2timer(struct sock *);
	262	void nr_stop_t4timer(struct sock *);
	263	void nr_stop_idletimer(struct sock *);
	264	int nr_t1timer_running(struct sock *);
1da177e4 LT	265
1da177e4 LT	266	/* sysctl_net_netrom.c */
96496127 JP	267	void nr_register_sysctl(void);
96496127 JP	268	void nr_unregister_sysctl(void);
1da177e4 LT	269
1da177e4 LT	270	#endif