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