xref: /linux/include/net/ax25.h (revision 13abf8130139c2ccd4962a7e5a8902be5e6cb5a7)
1 /*
2  *	Declarations of AX.25 type objects.
3  *
4  *	Alan Cox (GW4PTS) 	10/11/93
5  */
6 #ifndef _AX25_H
7 #define _AX25_H
8 
9 #include <linux/config.h>
10 #include <linux/ax25.h>
11 #include <linux/spinlock.h>
12 #include <linux/timer.h>
13 #include <linux/list.h>
14 #include <asm/atomic.h>
15 
16 #define	AX25_T1CLAMPLO  		1
17 #define	AX25_T1CLAMPHI 			(30 * HZ)
18 
19 #define	AX25_BPQ_HEADER_LEN		16
20 #define	AX25_KISS_HEADER_LEN		1
21 
22 #define	AX25_HEADER_LEN			17
23 #define	AX25_ADDR_LEN			7
24 #define	AX25_DIGI_HEADER_LEN		(AX25_MAX_DIGIS * AX25_ADDR_LEN)
25 #define	AX25_MAX_HEADER_LEN		(AX25_HEADER_LEN + AX25_DIGI_HEADER_LEN)
26 
27 /* AX.25 Protocol IDs */
28 #define AX25_P_ROSE			0x01
29 #define AX25_P_IP			0xCC
30 #define AX25_P_ARP			0xCD
31 #define AX25_P_TEXT 			0xF0
32 #define AX25_P_NETROM 			0xCF
33 #define	AX25_P_SEGMENT			0x08
34 
35 /* AX.25 Segment control values */
36 #define	AX25_SEG_REM			0x7F
37 #define	AX25_SEG_FIRST			0x80
38 
39 #define AX25_CBIT			0x80	/* Command/Response bit */
40 #define AX25_EBIT			0x01	/* HDLC Address Extension bit */
41 #define AX25_HBIT			0x80	/* Has been repeated bit */
42 
43 #define AX25_SSSID_SPARE		0x60	/* Unused bits in SSID for standard AX.25 */
44 #define AX25_ESSID_SPARE		0x20	/* Unused bits in SSID for extended AX.25 */
45 #define AX25_DAMA_FLAG			0x20	/* Well, it is *NOT* unused! (dl1bke 951121 */
46 
47 #define	AX25_COND_ACK_PENDING		0x01
48 #define	AX25_COND_REJECT		0x02
49 #define	AX25_COND_PEER_RX_BUSY		0x04
50 #define	AX25_COND_OWN_RX_BUSY		0x08
51 #define	AX25_COND_DAMA_MODE		0x10
52 
53 #ifndef _LINUX_NETDEVICE_H
54 #include <linux/netdevice.h>
55 #endif
56 
57 /* Upper sub-layer (LAPB) definitions */
58 
59 /* Control field templates */
60 #define	AX25_I			0x00	/* Information frames */
61 #define	AX25_S			0x01	/* Supervisory frames */
62 #define	AX25_RR			0x01	/* Receiver ready */
63 #define	AX25_RNR		0x05	/* Receiver not ready */
64 #define	AX25_REJ		0x09	/* Reject */
65 #define	AX25_U			0x03	/* Unnumbered frames */
66 #define	AX25_SABM		0x2f	/* Set Asynchronous Balanced Mode */
67 #define	AX25_SABME		0x6f	/* Set Asynchronous Balanced Mode Extended */
68 #define	AX25_DISC		0x43	/* Disconnect */
69 #define	AX25_DM			0x0f	/* Disconnected mode */
70 #define	AX25_UA			0x63	/* Unnumbered acknowledge */
71 #define	AX25_FRMR		0x87	/* Frame reject */
72 #define	AX25_UI			0x03	/* Unnumbered information */
73 #define	AX25_XID		0xaf	/* Exchange information */
74 #define	AX25_TEST		0xe3	/* Test */
75 
76 #define	AX25_PF			0x10	/* Poll/final bit for standard AX.25 */
77 #define	AX25_EPF		0x01	/* Poll/final bit for extended AX.25 */
78 
79 #define AX25_ILLEGAL		0x100	/* Impossible to be a real frame type */
80 
81 #define	AX25_POLLOFF		0
82 #define	AX25_POLLON		1
83 
84 /* AX25 L2 C-bit */
85 #define AX25_COMMAND		1
86 #define AX25_RESPONSE		2
87 
88 /* Define Link State constants. */
89 
90 enum {
91 	AX25_STATE_0,
92 	AX25_STATE_1,
93 	AX25_STATE_2,
94 	AX25_STATE_3,
95 	AX25_STATE_4
96 };
97 
98 #define AX25_MODULUS 		8	/*  Standard AX.25 modulus */
99 #define	AX25_EMODULUS		128	/*  Extended AX.25 modulus */
100 
101 enum {
102 	AX25_PROTO_STD_SIMPLEX,
103 	AX25_PROTO_STD_DUPLEX,
104 	AX25_PROTO_DAMA_SLAVE,
105 	AX25_PROTO_DAMA_MASTER
106 };
107 
108 enum {
109 	AX25_VALUES_IPDEFMODE,	/* 0=DG 1=VC */
110 	AX25_VALUES_AXDEFMODE,	/* 0=Normal 1=Extended Seq Nos */
111 	AX25_VALUES_BACKOFF,	/* 0=None 1=Linear 2=Exponential */
112 	AX25_VALUES_CONMODE,	/* Allow connected modes - 0=No 1=no "PID text" 2=all PIDs */
113 	AX25_VALUES_WINDOW,	/* Default window size for standard AX.25 */
114 	AX25_VALUES_EWINDOW,	/* Default window size for extended AX.25 */
115 	AX25_VALUES_T1,		/* Default T1 timeout value */
116 	AX25_VALUES_T2,		/* Default T2 timeout value */
117 	AX25_VALUES_T3,		/* Default T3 timeout value */
118 	AX25_VALUES_IDLE,	/* Connected mode idle timer */
119 	AX25_VALUES_N2,		/* Default N2 value */
120 	AX25_VALUES_PACLEN,	/* AX.25 MTU */
121 	AX25_VALUES_PROTOCOL,	/* Std AX.25, DAMA Slave, DAMA Master */
122 	AX25_VALUES_DS_TIMEOUT,	/* DAMA Slave timeout */
123 	AX25_MAX_VALUES		/* THIS MUST REMAIN THE LAST ENTRY OF THIS LIST */
124 };
125 
126 #define	AX25_DEF_IPDEFMODE	0			/* Datagram */
127 #define	AX25_DEF_AXDEFMODE	0			/* Normal */
128 #define	AX25_DEF_BACKOFF	1			/* Linear backoff */
129 #define	AX25_DEF_CONMODE	2			/* Connected mode allowed */
130 #define	AX25_DEF_WINDOW		2			/* Window=2 */
131 #define	AX25_DEF_EWINDOW	32			/* Module-128 Window=32 */
132 #define	AX25_DEF_T1		(10 * HZ)		/* T1=10s */
133 #define	AX25_DEF_T2		(3 * HZ)		/* T2=3s  */
134 #define	AX25_DEF_T3		(300 * HZ)		/* T3=300s */
135 #define	AX25_DEF_N2		10			/* N2=10 */
136 #define AX25_DEF_IDLE		(0 * 60 * HZ)		/* Idle=None */
137 #define AX25_DEF_PACLEN		256			/* Paclen=256 */
138 #define	AX25_DEF_PROTOCOL	AX25_PROTO_STD_SIMPLEX	/* Standard AX.25 */
139 #define AX25_DEF_DS_TIMEOUT	(3 * 60 * HZ)		/* DAMA timeout 3 minutes */
140 
141 typedef struct ax25_uid_assoc {
142 	struct hlist_node	uid_node;
143 	atomic_t		refcount;
144 	uid_t			uid;
145 	ax25_address		call;
146 } ax25_uid_assoc;
147 
148 #define ax25_uid_for_each(__ax25, node, list) \
149 	hlist_for_each_entry(__ax25, node, list, uid_node)
150 
151 #define ax25_uid_hold(ax25) \
152 	atomic_inc(&((ax25)->refcount))
153 
154 static inline void ax25_uid_put(ax25_uid_assoc *assoc)
155 {
156 	if (atomic_dec_and_test(&assoc->refcount)) {
157 		kfree(assoc);
158 	}
159 }
160 
161 typedef struct {
162 	ax25_address		calls[AX25_MAX_DIGIS];
163 	unsigned char		repeated[AX25_MAX_DIGIS];
164 	unsigned char		ndigi;
165 	char			lastrepeat;
166 } ax25_digi;
167 
168 typedef struct ax25_route {
169 	struct ax25_route	*next;
170 	atomic_t		ref;
171 	ax25_address		callsign;
172 	struct net_device	*dev;
173 	ax25_digi		*digipeat;
174 	char			ip_mode;
175 	struct timer_list	timer;
176 } ax25_route;
177 
178 typedef struct {
179 	char			slave;			/* slave_mode?   */
180 	struct timer_list	slave_timer;		/* timeout timer */
181 	unsigned short		slave_timeout;		/* when? */
182 } ax25_dama_info;
183 
184 struct ctl_table;
185 
186 typedef struct ax25_dev {
187 	struct ax25_dev		*next;
188 	struct net_device	*dev;
189 	struct net_device	*forward;
190 	struct ctl_table	*systable;
191 	int			values[AX25_MAX_VALUES];
192 #if defined(CONFIG_AX25_DAMA_SLAVE) || defined(CONFIG_AX25_DAMA_MASTER)
193 	ax25_dama_info		dama;
194 #endif
195 } ax25_dev;
196 
197 typedef struct ax25_cb {
198 	struct hlist_node	ax25_node;
199 	ax25_address		source_addr, dest_addr;
200 	ax25_digi		*digipeat;
201 	ax25_dev		*ax25_dev;
202 	unsigned char		iamdigi;
203 	unsigned char		state, modulus, pidincl;
204 	unsigned short		vs, vr, va;
205 	unsigned char		condition, backoff;
206 	unsigned char		n2, n2count;
207 	struct timer_list	t1timer, t2timer, t3timer, idletimer;
208 	unsigned long		t1, t2, t3, idle, rtt;
209 	unsigned short		paclen, fragno, fraglen;
210 	struct sk_buff_head	write_queue;
211 	struct sk_buff_head	reseq_queue;
212 	struct sk_buff_head	ack_queue;
213 	struct sk_buff_head	frag_queue;
214 	unsigned char		window;
215 	struct timer_list	timer, dtimer;
216 	struct sock		*sk;		/* Backlink to socket */
217 	atomic_t		refcount;
218 } ax25_cb;
219 
220 #define ax25_sk(__sk) ((ax25_cb *)(__sk)->sk_protinfo)
221 
222 #define ax25_for_each(__ax25, node, list) \
223 	hlist_for_each_entry(__ax25, node, list, ax25_node)
224 
225 #define ax25_cb_hold(__ax25) \
226 	atomic_inc(&((__ax25)->refcount))
227 
228 static __inline__ void ax25_cb_put(ax25_cb *ax25)
229 {
230 	if (atomic_dec_and_test(&ax25->refcount)) {
231 		if (ax25->digipeat)
232 			kfree(ax25->digipeat);
233 		kfree(ax25);
234 	}
235 }
236 
237 static inline __be16 ax25_type_trans(struct sk_buff *skb, struct net_device *dev)
238 {
239 	skb->dev      = dev;
240 	skb->pkt_type = PACKET_HOST;
241 	skb->mac.raw  = skb->data;
242 	return htons(ETH_P_AX25);
243 }
244 
245 /* af_ax25.c */
246 extern struct hlist_head ax25_list;
247 extern spinlock_t ax25_list_lock;
248 extern void ax25_cb_add(ax25_cb *);
249 struct sock *ax25_find_listener(ax25_address *, int, struct net_device *, int);
250 struct sock *ax25_get_socket(ax25_address *, ax25_address *, int);
251 extern ax25_cb *ax25_find_cb(ax25_address *, ax25_address *, ax25_digi *, struct net_device *);
252 extern void ax25_send_to_raw(ax25_address *, struct sk_buff *, int);
253 extern void ax25_destroy_socket(ax25_cb *);
254 extern ax25_cb *ax25_create_cb(void);
255 extern void ax25_fillin_cb(ax25_cb *, ax25_dev *);
256 extern struct sock *ax25_make_new(struct sock *, struct ax25_dev *);
257 
258 /* ax25_addr.c */
259 extern ax25_address null_ax25_address;
260 extern char *ax2asc(ax25_address *);
261 extern ax25_address *asc2ax(char *);
262 extern int  ax25cmp(ax25_address *, ax25_address *);
263 extern int  ax25digicmp(ax25_digi *, ax25_digi *);
264 extern unsigned char *ax25_addr_parse(unsigned char *, int, ax25_address *, ax25_address *, ax25_digi *, int *, int *);
265 extern int  ax25_addr_build(unsigned char *, ax25_address *, ax25_address *, ax25_digi *, int, int);
266 extern int  ax25_addr_size(ax25_digi *);
267 extern void ax25_digi_invert(ax25_digi *, ax25_digi *);
268 
269 /* ax25_dev.c */
270 extern ax25_dev *ax25_dev_list;
271 extern spinlock_t ax25_dev_lock;
272 
273 static inline ax25_dev *ax25_dev_ax25dev(struct net_device *dev)
274 {
275 	return dev->ax25_ptr;
276 }
277 
278 extern ax25_dev *ax25_addr_ax25dev(ax25_address *);
279 extern void ax25_dev_device_up(struct net_device *);
280 extern void ax25_dev_device_down(struct net_device *);
281 extern int  ax25_fwd_ioctl(unsigned int, struct ax25_fwd_struct *);
282 extern struct net_device *ax25_fwd_dev(struct net_device *);
283 extern void ax25_dev_free(void);
284 
285 /* ax25_ds_in.c */
286 extern int  ax25_ds_frame_in(ax25_cb *, struct sk_buff *, int);
287 
288 /* ax25_ds_subr.c */
289 extern void ax25_ds_nr_error_recovery(ax25_cb *);
290 extern void ax25_ds_enquiry_response(ax25_cb *);
291 extern void ax25_ds_establish_data_link(ax25_cb *);
292 extern void ax25_dev_dama_off(ax25_dev *);
293 extern void ax25_dama_on(ax25_cb *);
294 extern void ax25_dama_off(ax25_cb *);
295 
296 /* ax25_ds_timer.c */
297 extern void ax25_ds_set_timer(ax25_dev *);
298 extern void ax25_ds_del_timer(ax25_dev *);
299 extern void ax25_ds_timer(ax25_cb *);
300 extern void ax25_ds_t1_timeout(ax25_cb *);
301 extern void ax25_ds_heartbeat_expiry(ax25_cb *);
302 extern void ax25_ds_t3timer_expiry(ax25_cb *);
303 extern void ax25_ds_idletimer_expiry(ax25_cb *);
304 
305 /* ax25_iface.c */
306 extern int  ax25_protocol_register(unsigned int, int (*)(struct sk_buff *, ax25_cb *));
307 extern void ax25_protocol_release(unsigned int);
308 extern int  ax25_linkfail_register(void (*)(ax25_cb *, int));
309 extern void ax25_linkfail_release(void (*)(ax25_cb *, int));
310 extern int  ax25_listen_register(ax25_address *, struct net_device *);
311 extern void ax25_listen_release(ax25_address *, struct net_device *);
312 extern int  (*ax25_protocol_function(unsigned int))(struct sk_buff *, ax25_cb *);
313 extern int  ax25_listen_mine(ax25_address *, struct net_device *);
314 extern void ax25_link_failed(ax25_cb *, int);
315 extern int  ax25_protocol_is_registered(unsigned int);
316 
317 /* ax25_in.c */
318 extern int  ax25_rx_iframe(ax25_cb *, struct sk_buff *);
319 extern int  ax25_kiss_rcv(struct sk_buff *, struct net_device *, struct packet_type *, struct net_device *);
320 
321 /* ax25_ip.c */
322 extern int  ax25_encapsulate(struct sk_buff *, struct net_device *, unsigned short, void *, void *, unsigned int);
323 extern int  ax25_rebuild_header(struct sk_buff *);
324 
325 /* ax25_out.c */
326 extern ax25_cb *ax25_send_frame(struct sk_buff *, int, ax25_address *, ax25_address *, ax25_digi *, struct net_device *);
327 extern void ax25_output(ax25_cb *, int, struct sk_buff *);
328 extern void ax25_kick(ax25_cb *);
329 extern void ax25_transmit_buffer(ax25_cb *, struct sk_buff *, int);
330 extern void ax25_queue_xmit(struct sk_buff *skb, struct net_device *dev);
331 extern int  ax25_check_iframes_acked(ax25_cb *, unsigned short);
332 
333 /* ax25_route.c */
334 extern void ax25_rt_device_down(struct net_device *);
335 extern int  ax25_rt_ioctl(unsigned int, void __user *);
336 extern struct file_operations ax25_route_fops;
337 extern int  ax25_rt_autobind(ax25_cb *, ax25_address *);
338 extern ax25_route *ax25_rt_find_route(ax25_route *, ax25_address *,
339 	struct net_device *);
340 extern struct sk_buff *ax25_rt_build_path(struct sk_buff *, ax25_address *, ax25_address *, ax25_digi *);
341 extern void ax25_rt_free(void);
342 
343 static inline void ax25_put_route(ax25_route *ax25_rt)
344 {
345 	atomic_dec(&ax25_rt->ref);
346 }
347 
348 /* ax25_std_in.c */
349 extern int  ax25_std_frame_in(ax25_cb *, struct sk_buff *, int);
350 
351 /* ax25_std_subr.c */
352 extern void ax25_std_nr_error_recovery(ax25_cb *);
353 extern void ax25_std_establish_data_link(ax25_cb *);
354 extern void ax25_std_transmit_enquiry(ax25_cb *);
355 extern void ax25_std_enquiry_response(ax25_cb *);
356 extern void ax25_std_timeout_response(ax25_cb *);
357 
358 /* ax25_std_timer.c */
359 extern void ax25_std_heartbeat_expiry(ax25_cb *);
360 extern void ax25_std_t1timer_expiry(ax25_cb *);
361 extern void ax25_std_t2timer_expiry(ax25_cb *);
362 extern void ax25_std_t3timer_expiry(ax25_cb *);
363 extern void ax25_std_idletimer_expiry(ax25_cb *);
364 
365 /* ax25_subr.c */
366 extern void ax25_clear_queues(ax25_cb *);
367 extern void ax25_frames_acked(ax25_cb *, unsigned short);
368 extern void ax25_requeue_frames(ax25_cb *);
369 extern int  ax25_validate_nr(ax25_cb *, unsigned short);
370 extern int  ax25_decode(ax25_cb *, struct sk_buff *, int *, int *, int *);
371 extern void ax25_send_control(ax25_cb *, int, int, int);
372 extern void ax25_return_dm(struct net_device *, ax25_address *, ax25_address *, ax25_digi *);
373 extern void ax25_calculate_t1(ax25_cb *);
374 extern void ax25_calculate_rtt(ax25_cb *);
375 extern void ax25_disconnect(ax25_cb *, int);
376 
377 /* ax25_timer.c */
378 extern void ax25_start_heartbeat(ax25_cb *);
379 extern void ax25_start_t1timer(ax25_cb *);
380 extern void ax25_start_t2timer(ax25_cb *);
381 extern void ax25_start_t3timer(ax25_cb *);
382 extern void ax25_start_idletimer(ax25_cb *);
383 extern void ax25_stop_heartbeat(ax25_cb *);
384 extern void ax25_stop_t1timer(ax25_cb *);
385 extern void ax25_stop_t2timer(ax25_cb *);
386 extern void ax25_stop_t3timer(ax25_cb *);
387 extern void ax25_stop_idletimer(ax25_cb *);
388 extern int  ax25_t1timer_running(ax25_cb *);
389 extern unsigned long ax25_display_timer(struct timer_list *);
390 
391 /* ax25_uid.c */
392 extern int  ax25_uid_policy;
393 extern ax25_uid_assoc *ax25_findbyuid(uid_t);
394 extern int  ax25_uid_ioctl(int, struct sockaddr_ax25 *);
395 extern struct file_operations ax25_uid_fops;
396 extern void ax25_uid_free(void);
397 
398 /* sysctl_net_ax25.c */
399 #ifdef CONFIG_SYSCTL
400 extern void ax25_register_sysctl(void);
401 extern void ax25_unregister_sysctl(void);
402 #else
403 static inline void ax25_register_sysctl(void) {};
404 static inline void ax25_unregister_sysctl(void) {};
405 #endif /* CONFIG_SYSCTL */
406 
407 #endif
408