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