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