rose.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 *	Declarations of Rose type objects.
  4 *
  5 *	Jonathan Naylor G4KLX	25/8/96
  6 */
  7
  8#ifndef _ROSE_H
  9#define _ROSE_H 
 10
 11#include <linux/refcount.h>
 12#include <linux/rose.h>
 13#include <net/ax25.h>
 14#include <net/sock.h>
 15
 16#define	ROSE_ADDR_LEN			5
 17
 18#define	ROSE_MIN_LEN			3
 19
 20#define	ROSE_CALL_REQ_ADDR_LEN_OFF	3
 21#define	ROSE_CALL_REQ_ADDR_LEN_VAL	0xAA	/* each address is 10 digits */
 22#define	ROSE_CALL_REQ_DEST_ADDR_OFF	4
 23#define	ROSE_CALL_REQ_SRC_ADDR_OFF	9
 24#define	ROSE_CALL_REQ_FACILITIES_OFF	14
 25
 26#define	ROSE_GFI			0x10
 27#define	ROSE_Q_BIT			0x80
 28#define	ROSE_D_BIT			0x40
 29#define	ROSE_M_BIT			0x10
 30
 31#define	ROSE_CALL_REQUEST		0x0B
 32#define	ROSE_CALL_ACCEPTED		0x0F
 33#define	ROSE_CLEAR_REQUEST		0x13
 34#define	ROSE_CLEAR_CONFIRMATION		0x17
 35#define	ROSE_DATA			0x00
 36#define	ROSE_INTERRUPT			0x23
 37#define	ROSE_INTERRUPT_CONFIRMATION	0x27
 38#define	ROSE_RR				0x01
 39#define	ROSE_RNR			0x05
 40#define	ROSE_REJ			0x09
 41#define	ROSE_RESET_REQUEST		0x1B
 42#define	ROSE_RESET_CONFIRMATION		0x1F
 43#define	ROSE_REGISTRATION_REQUEST	0xF3
 44#define	ROSE_REGISTRATION_CONFIRMATION	0xF7
 45#define	ROSE_RESTART_REQUEST		0xFB
 46#define	ROSE_RESTART_CONFIRMATION	0xFF
 47#define	ROSE_DIAGNOSTIC			0xF1
 48#define	ROSE_ILLEGAL			0xFD
 49
 50/* Define Link State constants. */
 51
 52enum {
 53	ROSE_STATE_0,			/* Ready */
 54	ROSE_STATE_1,			/* Awaiting Call Accepted */
 55	ROSE_STATE_2,			/* Awaiting Clear Confirmation */
 56	ROSE_STATE_3,			/* Data Transfer */
 57	ROSE_STATE_4,			/* Awaiting Reset Confirmation */
 58	ROSE_STATE_5			/* Deferred Call Acceptance */
 59};
 60
 61#define ROSE_DEFAULT_T0			180000		/* Default T10 T20 value */
 62#define ROSE_DEFAULT_T1			200000		/* Default T11 T21 value */
 63#define ROSE_DEFAULT_T2			180000		/* Default T12 T22 value */
 64#define	ROSE_DEFAULT_T3			180000		/* Default T13 T23 value */
 65#define	ROSE_DEFAULT_HB			5000		/* Default Holdback value */
 66#define	ROSE_DEFAULT_IDLE		0		/* No Activity Timeout - none */
 67#define	ROSE_DEFAULT_ROUTING		1		/* Default routing flag */
 68#define	ROSE_DEFAULT_FAIL_TIMEOUT	120000		/* Time until link considered usable */
 69#define	ROSE_DEFAULT_MAXVC		50		/* Maximum number of VCs per neighbour */
 70#define	ROSE_DEFAULT_WINDOW_SIZE	7		/* Default window size */
 71
 72#define ROSE_MODULUS 			8
 73#define	ROSE_MAX_PACKET_SIZE		251		/* Maximum packet size */
 74
 75#define	ROSE_COND_ACK_PENDING		0x01
 76#define	ROSE_COND_PEER_RX_BUSY		0x02
 77#define	ROSE_COND_OWN_RX_BUSY		0x04
 78
 79#define	FAC_NATIONAL			0x00
 80#define	FAC_CCITT			0x0F
 81
 82#define	FAC_NATIONAL_RAND		0x7F
 83#define	FAC_NATIONAL_FLAGS		0x3F
 84#define	FAC_NATIONAL_DEST_DIGI		0xE9
 85#define	FAC_NATIONAL_SRC_DIGI		0xEB
 86#define	FAC_NATIONAL_FAIL_CALL		0xED
 87#define	FAC_NATIONAL_FAIL_ADD		0xEE
 88#define	FAC_NATIONAL_DIGIS			0xEF
 89
 90#define	FAC_CCITT_DEST_NSAP		0xC9
 91#define	FAC_CCITT_SRC_NSAP		0xCB
 92
 93struct rose_neigh {
 94	struct rose_neigh	*next;
 95	ax25_address		callsign;
 96	ax25_digi		*digipeat;
 97	ax25_cb			*ax25;
 98	struct net_device		*dev;
 99	unsigned short		count;
100	refcount_t		use;
101	unsigned int		number;
102	char			restarted;
103	char			dce_mode;
104	char			loopback;
105	struct sk_buff_head	queue;
106	struct timer_list	t0timer;
107	struct timer_list	ftimer;
108};
109
110struct rose_node {
111	struct rose_node	*next;
112	rose_address		address;
113	unsigned short		mask;
114	unsigned char		count;
115	char			loopback;
116	struct rose_neigh	*neighbour[3];
117};
118
119struct rose_route {
120	struct rose_route	*next;
121	unsigned int		lci1, lci2;
122	rose_address		src_addr, dest_addr;
123	ax25_address		src_call, dest_call;
124	struct rose_neigh 	*neigh1, *neigh2;
125	unsigned int		rand;
126};
127
128struct rose_sock {
129	struct sock		sock;
130	rose_address		source_addr,   dest_addr;
131	ax25_address		source_call,   dest_call;
132	unsigned char		source_ndigis, dest_ndigis;
133	ax25_address		source_digis[ROSE_MAX_DIGIS];
134	ax25_address		dest_digis[ROSE_MAX_DIGIS];
135	struct rose_neigh	*neighbour;
136	struct net_device	*device;
137	netdevice_tracker	dev_tracker;
138	unsigned int		lci, rand;
139	unsigned char		state, condition, qbitincl, defer;
140	unsigned char		cause, diagnostic;
141	unsigned short		vs, vr, va, vl;
142	unsigned long		t1, t2, t3, hb, idle;
143#ifdef M_BIT
144	unsigned short		fraglen;
145	struct sk_buff_head	frag_queue;
146#endif
147	struct sk_buff_head	ack_queue;
148	struct rose_facilities_struct facilities;
149	struct timer_list	timer;
150	struct timer_list	idletimer;
151};
152
153#define rose_sk(sk) ((struct rose_sock *)(sk))
154
155static inline void rose_neigh_hold(struct rose_neigh *rose_neigh)
156{
157	refcount_inc(&rose_neigh->use);
158}
159
160static inline void rose_neigh_put(struct rose_neigh *rose_neigh)
161{
162	if (refcount_dec_and_test(&rose_neigh->use)) {
163		if (rose_neigh->ax25)
164			ax25_cb_put(rose_neigh->ax25);
165		kfree(rose_neigh->digipeat);
166		kfree(rose_neigh);
167	}
168}
169
170/* af_rose.c */
171extern ax25_address rose_callsign;
172extern int  sysctl_rose_restart_request_timeout;
173extern int  sysctl_rose_call_request_timeout;
174extern int  sysctl_rose_reset_request_timeout;
175extern int  sysctl_rose_clear_request_timeout;
176extern int  sysctl_rose_no_activity_timeout;
177extern int  sysctl_rose_ack_hold_back_timeout;
178extern int  sysctl_rose_routing_control;
179extern int  sysctl_rose_link_fail_timeout;
180extern int  sysctl_rose_maximum_vcs;
181extern int  sysctl_rose_window_size;
182
183int rosecmp(const rose_address *, const rose_address *);
184int rosecmpm(const rose_address *, const rose_address *, unsigned short);
185char *rose2asc(char *buf, const rose_address *);
186struct sock *rose_find_socket(unsigned int, struct rose_neigh *);
187void rose_kill_by_neigh(struct rose_neigh *);
188unsigned int rose_new_lci(struct rose_neigh *);
189int rose_rx_call_request(struct sk_buff *, struct net_device *,
190			 struct rose_neigh *, unsigned int);
191void rose_destroy_socket(struct sock *);
192
193/* rose_dev.c */
194void rose_setup(struct net_device *);
195
196/* rose_in.c */
197int rose_process_rx_frame(struct sock *, struct sk_buff *);
198
199/* rose_link.c */
200void rose_start_ftimer(struct rose_neigh *);
201void rose_stop_ftimer(struct rose_neigh *);
202void rose_stop_t0timer(struct rose_neigh *);
203int rose_ftimer_running(struct rose_neigh *);
204void rose_link_rx_restart(struct sk_buff *, struct rose_neigh *,
205			  unsigned short);
206void rose_transmit_clear_request(struct rose_neigh *, unsigned int,
207				 unsigned char, unsigned char);
208void rose_transmit_link(struct sk_buff *, struct rose_neigh *);
209
210/* rose_loopback.c */
211void rose_loopback_init(void);
212void rose_loopback_clear(void);
213int rose_loopback_queue(struct sk_buff *, struct rose_neigh *);
214
215/* rose_out.c */
216void rose_kick(struct sock *);
217void rose_enquiry_response(struct sock *);
218
219/* rose_route.c */
220extern struct rose_neigh *rose_loopback_neigh;
221extern const struct seq_operations rose_neigh_seqops;
222extern const struct seq_operations rose_node_seqops;
223extern struct seq_operations rose_route_seqops;
224
225void rose_add_loopback_neigh(void);
226int __must_check rose_add_loopback_node(const rose_address *);
227void rose_del_loopback_node(const rose_address *);
228void rose_rt_device_down(struct net_device *);
229void rose_link_device_down(struct net_device *);
230struct net_device *rose_dev_first(void);
231struct net_device *rose_dev_get(rose_address *);
232struct rose_route *rose_route_free_lci(unsigned int, struct rose_neigh *);
233struct rose_neigh *rose_get_neigh(rose_address *, unsigned char *,
234				  unsigned char *, int);
235int rose_rt_ioctl(unsigned int, void __user *);
236void rose_link_failed(ax25_cb *, int);
237int rose_route_frame(struct sk_buff *, ax25_cb *);
238void rose_rt_free(void);
239
240/* rose_subr.c */
241void rose_clear_queues(struct sock *);
242void rose_frames_acked(struct sock *, unsigned short);
243void rose_requeue_frames(struct sock *);
244int rose_validate_nr(struct sock *, unsigned short);
245void rose_write_internal(struct sock *, int);
246int rose_decode(struct sk_buff *, int *, int *, int *, int *, int *);
247int rose_parse_facilities(unsigned char *, unsigned int,
248			  struct rose_facilities_struct *);
249void rose_disconnect(struct sock *, int, int, int);
250
251/* rose_timer.c */
252void rose_start_heartbeat(struct sock *);
253void rose_start_t1timer(struct sock *);
254void rose_start_t2timer(struct sock *);
255void rose_start_t3timer(struct sock *);
256void rose_start_hbtimer(struct sock *);
257void rose_start_idletimer(struct sock *);
258void rose_stop_heartbeat(struct sock *);
259void rose_stop_timer(struct sock *);
260void rose_stop_idletimer(struct sock *);
261
262/* sysctl_net_rose.c */
263void rose_register_sysctl(void);
264void rose_unregister_sysctl(void);
265
266#endif