828a3a93dda10e07ce851476894296f5b7e4a68f
[linux-2.6.git] / include / net / ax25.h
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 ax25_uid_assoc   *next;
143         uid_t                   uid;
144         ax25_address            call;
145 } ax25_uid_assoc;
146
147 typedef struct {
148         ax25_address            calls[AX25_MAX_DIGIS];
149         unsigned char           repeated[AX25_MAX_DIGIS];
150         unsigned char           ndigi;
151         char                    lastrepeat;
152 } ax25_digi;
153
154 typedef struct ax25_route {
155         struct ax25_route       *next;
156         atomic_t                ref;
157         ax25_address            callsign;
158         struct net_device       *dev;
159         ax25_digi               *digipeat;
160         char                    ip_mode;
161         struct timer_list       timer;
162 } ax25_route;
163
164 typedef struct {
165         char                    slave;                  /* slave_mode?   */
166         struct timer_list       slave_timer;            /* timeout timer */
167         unsigned short          slave_timeout;          /* when? */
168 } ax25_dama_info;
169
170 struct ctl_table;
171
172 typedef struct ax25_dev {
173         struct ax25_dev         *next;
174         struct net_device       *dev;
175         struct net_device       *forward;
176         struct ctl_table        *systable;
177         int                     values[AX25_MAX_VALUES];
178 #if defined(CONFIG_AX25_DAMA_SLAVE) || defined(CONFIG_AX25_DAMA_MASTER)
179         ax25_dama_info          dama;
180 #endif
181 } ax25_dev;
182
183 typedef struct ax25_cb {
184         struct hlist_node       ax25_node;
185         ax25_address            source_addr, dest_addr;
186         ax25_digi               *digipeat;
187         ax25_dev                *ax25_dev;
188         unsigned char           iamdigi;
189         unsigned char           state, modulus, pidincl;
190         unsigned short          vs, vr, va;
191         unsigned char           condition, backoff;
192         unsigned char           n2, n2count;
193         struct timer_list       t1timer, t2timer, t3timer, idletimer;
194         unsigned long           t1, t2, t3, idle, rtt;
195         unsigned short          paclen, fragno, fraglen;
196         struct sk_buff_head     write_queue;
197         struct sk_buff_head     reseq_queue;
198         struct sk_buff_head     ack_queue;
199         struct sk_buff_head     frag_queue;
200         unsigned char           window;
201         struct timer_list       timer, dtimer;
202         struct sock             *sk;            /* Backlink to socket */
203         atomic_t                refcount;
204 } ax25_cb;
205
206 #define ax25_sk(__sk) ((ax25_cb *)(__sk)->sk_protinfo)
207
208 #define ax25_for_each(__ax25, node, list) \
209         hlist_for_each_entry(__ax25, node, list, ax25_node)
210
211 #define ax25_cb_hold(__ax25) \
212         atomic_inc(&((__ax25)->refcount))
213
214 static __inline__ void ax25_cb_put(ax25_cb *ax25)
215 {
216         if (atomic_dec_and_test(&ax25->refcount)) {
217                 if (ax25->digipeat)
218                         kfree(ax25->digipeat);
219                 kfree(ax25);
220         }
221 }
222
223 static inline __be16 ax25_type_trans(struct sk_buff *skb, struct net_device *dev)
224 {
225         skb->dev      = dev;
226         skb->pkt_type = PACKET_HOST;
227         skb->mac.raw  = skb->data;
228         return htons(ETH_P_AX25);
229 }
230
231 /* af_ax25.c */
232 extern struct hlist_head ax25_list;
233 extern spinlock_t ax25_list_lock;
234 extern void ax25_cb_add(ax25_cb *);
235 struct sock *ax25_find_listener(ax25_address *, int, struct net_device *, int);
236 struct sock *ax25_get_socket(ax25_address *, ax25_address *, int);
237 extern ax25_cb *ax25_find_cb(ax25_address *, ax25_address *, ax25_digi *, struct net_device *);
238 extern void ax25_send_to_raw(ax25_address *, struct sk_buff *, int);
239 extern void ax25_destroy_socket(ax25_cb *);
240 extern ax25_cb *ax25_create_cb(void);
241 extern void ax25_fillin_cb(ax25_cb *, ax25_dev *);
242 extern struct sock *ax25_make_new(struct sock *, struct ax25_dev *);
243
244 /* ax25_addr.c */
245 extern ax25_address null_ax25_address;
246 extern char *ax2asc(ax25_address *);
247 extern ax25_address *asc2ax(char *);
248 extern int  ax25cmp(ax25_address *, ax25_address *);
249 extern int  ax25digicmp(ax25_digi *, ax25_digi *);
250 extern unsigned char *ax25_addr_parse(unsigned char *, int, ax25_address *, ax25_address *, ax25_digi *, int *, int *);
251 extern int  ax25_addr_build(unsigned char *, ax25_address *, ax25_address *, ax25_digi *, int, int);
252 extern int  ax25_addr_size(ax25_digi *);
253 extern void ax25_digi_invert(ax25_digi *, ax25_digi *);
254
255 /* ax25_dev.c */
256 extern ax25_dev *ax25_dev_list;
257 extern spinlock_t ax25_dev_lock;
258
259 static inline ax25_dev *ax25_dev_ax25dev(struct net_device *dev)
260 {
261         return dev->ax25_ptr;
262 }
263
264 extern ax25_dev *ax25_addr_ax25dev(ax25_address *);
265 extern void ax25_dev_device_up(struct net_device *);
266 extern void ax25_dev_device_down(struct net_device *);
267 extern int  ax25_fwd_ioctl(unsigned int, struct ax25_fwd_struct *);
268 extern struct net_device *ax25_fwd_dev(struct net_device *);
269 extern void ax25_dev_free(void);
270
271 /* ax25_ds_in.c */
272 extern int  ax25_ds_frame_in(ax25_cb *, struct sk_buff *, int);
273
274 /* ax25_ds_subr.c */
275 extern void ax25_ds_nr_error_recovery(ax25_cb *);
276 extern void ax25_ds_enquiry_response(ax25_cb *);
277 extern void ax25_ds_establish_data_link(ax25_cb *);
278 extern void ax25_dev_dama_off(ax25_dev *);
279 extern void ax25_dama_on(ax25_cb *);
280 extern void ax25_dama_off(ax25_cb *);
281
282 /* ax25_ds_timer.c */
283 extern void ax25_ds_set_timer(ax25_dev *);
284 extern void ax25_ds_del_timer(ax25_dev *);
285 extern void ax25_ds_timer(ax25_cb *);
286 extern void ax25_ds_t1_timeout(ax25_cb *);
287 extern void ax25_ds_heartbeat_expiry(ax25_cb *);
288 extern void ax25_ds_t3timer_expiry(ax25_cb *);
289 extern void ax25_ds_idletimer_expiry(ax25_cb *);
290
291 /* ax25_iface.c */
292 extern int  ax25_protocol_register(unsigned int, int (*)(struct sk_buff *, ax25_cb *));
293 extern void ax25_protocol_release(unsigned int);
294 extern int  ax25_linkfail_register(void (*)(ax25_cb *, int));
295 extern void ax25_linkfail_release(void (*)(ax25_cb *, int));
296 extern int  ax25_listen_register(ax25_address *, struct net_device *);
297 extern void ax25_listen_release(ax25_address *, struct net_device *);
298 extern int  (*ax25_protocol_function(unsigned int))(struct sk_buff *, ax25_cb *);
299 extern int  ax25_listen_mine(ax25_address *, struct net_device *);
300 extern void ax25_link_failed(ax25_cb *, int);
301 extern int  ax25_protocol_is_registered(unsigned int);
302
303 /* ax25_in.c */
304 extern int  ax25_rx_iframe(ax25_cb *, struct sk_buff *);
305 extern int  ax25_kiss_rcv(struct sk_buff *, struct net_device *, struct packet_type *);
306
307 /* ax25_ip.c */
308 extern int  ax25_encapsulate(struct sk_buff *, struct net_device *, unsigned short, void *, void *, unsigned int);
309 extern int  ax25_rebuild_header(struct sk_buff *);
310
311 /* ax25_out.c */
312 extern ax25_cb *ax25_send_frame(struct sk_buff *, int, ax25_address *, ax25_address *, ax25_digi *, struct net_device *);
313 extern void ax25_output(ax25_cb *, int, struct sk_buff *);
314 extern void ax25_kick(ax25_cb *);
315 extern void ax25_transmit_buffer(ax25_cb *, struct sk_buff *, int);
316 extern void ax25_queue_xmit(struct sk_buff *skb, struct net_device *dev);
317 extern int  ax25_check_iframes_acked(ax25_cb *, unsigned short);
318
319 /* ax25_route.c */
320 extern void ax25_rt_device_down(struct net_device *);
321 extern int  ax25_rt_ioctl(unsigned int, void __user *);
322 extern struct file_operations ax25_route_fops;
323 extern int  ax25_rt_autobind(ax25_cb *, ax25_address *);
324 extern ax25_route *ax25_rt_find_route(ax25_route *, ax25_address *,
325         struct net_device *);
326 extern struct sk_buff *ax25_rt_build_path(struct sk_buff *, ax25_address *, ax25_address *, ax25_digi *);
327 extern void ax25_rt_free(void);
328
329 static inline void ax25_put_route(ax25_route *ax25_rt)
330 {
331         atomic_dec(&ax25_rt->ref);
332 }
333
334 /* ax25_std_in.c */
335 extern int  ax25_std_frame_in(ax25_cb *, struct sk_buff *, int);
336
337 /* ax25_std_subr.c */
338 extern void ax25_std_nr_error_recovery(ax25_cb *);
339 extern void ax25_std_establish_data_link(ax25_cb *);
340 extern void ax25_std_transmit_enquiry(ax25_cb *);
341 extern void ax25_std_enquiry_response(ax25_cb *);
342 extern void ax25_std_timeout_response(ax25_cb *);
343
344 /* ax25_std_timer.c */
345 extern void ax25_std_heartbeat_expiry(ax25_cb *);
346 extern void ax25_std_t1timer_expiry(ax25_cb *);
347 extern void ax25_std_t2timer_expiry(ax25_cb *);
348 extern void ax25_std_t3timer_expiry(ax25_cb *);
349 extern void ax25_std_idletimer_expiry(ax25_cb *);
350
351 /* ax25_subr.c */
352 extern void ax25_clear_queues(ax25_cb *);
353 extern void ax25_frames_acked(ax25_cb *, unsigned short);
354 extern void ax25_requeue_frames(ax25_cb *);
355 extern int  ax25_validate_nr(ax25_cb *, unsigned short);
356 extern int  ax25_decode(ax25_cb *, struct sk_buff *, int *, int *, int *);
357 extern void ax25_send_control(ax25_cb *, int, int, int);
358 extern void ax25_return_dm(struct net_device *, ax25_address *, ax25_address *, ax25_digi *);
359 extern void ax25_calculate_t1(ax25_cb *);
360 extern void ax25_calculate_rtt(ax25_cb *);
361 extern void ax25_disconnect(ax25_cb *, int);
362
363 /* ax25_timer.c */
364 extern void ax25_start_heartbeat(ax25_cb *);
365 extern void ax25_start_t1timer(ax25_cb *);
366 extern void ax25_start_t2timer(ax25_cb *);
367 extern void ax25_start_t3timer(ax25_cb *);
368 extern void ax25_start_idletimer(ax25_cb *);
369 extern void ax25_stop_heartbeat(ax25_cb *);
370 extern void ax25_stop_t1timer(ax25_cb *);
371 extern void ax25_stop_t2timer(ax25_cb *);
372 extern void ax25_stop_t3timer(ax25_cb *);
373 extern void ax25_stop_idletimer(ax25_cb *);
374 extern int  ax25_t1timer_running(ax25_cb *);
375 extern unsigned long ax25_display_timer(struct timer_list *);
376
377 /* ax25_uid.c */
378 extern int  ax25_uid_policy;
379 extern ax25_address *ax25_findbyuid(uid_t);
380 extern int  ax25_uid_ioctl(int, struct sockaddr_ax25 *);
381 extern struct file_operations ax25_uid_fops;
382 extern void ax25_uid_free(void);
383
384 /* sysctl_net_ax25.c */
385 #ifdef CONFIG_SYSCTL
386 extern void ax25_register_sysctl(void);
387 extern void ax25_unregister_sysctl(void);
388 #else
389 static inline void ax25_register_sysctl(void) {};
390 static inline void ax25_unregister_sysctl(void) {};
391 #endif /* CONFIG_SYSCTL */
392
393 #endif