[thirdparty/linux.git] / include / net / netrom.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *	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>
#include <linux/seq_file.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 seq_operations nr_node_seqops;
extern const struct seq_operations nr_neigh_seqops;
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 */
int nr_register_sysctl(void);
void nr_unregister_sysctl(void);

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