Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[platform/adaptation/renesas_rcar/renesas_kernel.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/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/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 Address 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 #ifdef CONFIG_AX25_DAMA_SLAVE
114         AX25_PROTO_DAMA_SLAVE,
115 #ifdef CONFIG_AX25_DAMA_MASTER
116         AX25_PROTO_DAMA_MASTER,
117 #define AX25_PROTO_MAX AX25_PROTO_DAMA_MASTER
118 #endif
119 #endif
120         __AX25_PROTO_MAX,
121         AX25_PROTO_MAX = __AX25_PROTO_MAX -1
122 };
123
124 enum {
125         AX25_VALUES_IPDEFMODE,  /* 0=DG 1=VC */
126         AX25_VALUES_AXDEFMODE,  /* 0=Normal 1=Extended Seq Nos */
127         AX25_VALUES_BACKOFF,    /* 0=None 1=Linear 2=Exponential */
128         AX25_VALUES_CONMODE,    /* Allow connected modes - 0=No 1=no "PID text" 2=all PIDs */
129         AX25_VALUES_WINDOW,     /* Default window size for standard AX.25 */
130         AX25_VALUES_EWINDOW,    /* Default window size for extended AX.25 */
131         AX25_VALUES_T1,         /* Default T1 timeout value */
132         AX25_VALUES_T2,         /* Default T2 timeout value */
133         AX25_VALUES_T3,         /* Default T3 timeout value */
134         AX25_VALUES_IDLE,       /* Connected mode idle timer */
135         AX25_VALUES_N2,         /* Default N2 value */
136         AX25_VALUES_PACLEN,     /* AX.25 MTU */
137         AX25_VALUES_PROTOCOL,   /* Std AX.25, DAMA Slave, DAMA Master */
138         AX25_VALUES_DS_TIMEOUT, /* DAMA Slave timeout */
139         AX25_MAX_VALUES         /* THIS MUST REMAIN THE LAST ENTRY OF THIS LIST */
140 };
141
142 #define AX25_DEF_IPDEFMODE      0                       /* Datagram */
143 #define AX25_DEF_AXDEFMODE      0                       /* Normal */
144 #define AX25_DEF_BACKOFF        1                       /* Linear backoff */
145 #define AX25_DEF_CONMODE        2                       /* Connected mode allowed */
146 #define AX25_DEF_WINDOW         2                       /* Window=2 */
147 #define AX25_DEF_EWINDOW        32                      /* Module-128 Window=32 */
148 #define AX25_DEF_T1             10000                   /* T1=10s */
149 #define AX25_DEF_T2             3000                    /* T2=3s  */
150 #define AX25_DEF_T3             300000                  /* T3=300s */
151 #define AX25_DEF_N2             10                      /* N2=10 */
152 #define AX25_DEF_IDLE           0                       /* Idle=None */
153 #define AX25_DEF_PACLEN         256                     /* Paclen=256 */
154 #define AX25_DEF_PROTOCOL       AX25_PROTO_STD_SIMPLEX  /* Standard AX.25 */
155 #define AX25_DEF_DS_TIMEOUT     180000                  /* DAMA timeout 3 minutes */
156
157 typedef struct ax25_uid_assoc {
158         struct hlist_node       uid_node;
159         atomic_t                refcount;
160         kuid_t                  uid;
161         ax25_address            call;
162 } ax25_uid_assoc;
163
164 #define ax25_uid_for_each(__ax25, list) \
165         hlist_for_each_entry(__ax25, list, uid_node)
166
167 #define ax25_uid_hold(ax25) \
168         atomic_inc(&((ax25)->refcount))
169
170 static inline void ax25_uid_put(ax25_uid_assoc *assoc)
171 {
172         if (atomic_dec_and_test(&assoc->refcount)) {
173                 kfree(assoc);
174         }
175 }
176
177 typedef struct {
178         ax25_address            calls[AX25_MAX_DIGIS];
179         unsigned char           repeated[AX25_MAX_DIGIS];
180         unsigned char           ndigi;
181         signed char             lastrepeat;
182 } ax25_digi;
183
184 typedef struct ax25_route {
185         struct ax25_route       *next;
186         atomic_t                refcount;
187         ax25_address            callsign;
188         struct net_device       *dev;
189         ax25_digi               *digipeat;
190         char                    ip_mode;
191 } ax25_route;
192
193 static inline void ax25_hold_route(ax25_route *ax25_rt)
194 {
195         atomic_inc(&ax25_rt->refcount);
196 }
197
198 void __ax25_put_route(ax25_route *ax25_rt);
199
200 static inline void ax25_put_route(ax25_route *ax25_rt)
201 {
202         if (atomic_dec_and_test(&ax25_rt->refcount))
203                 __ax25_put_route(ax25_rt);
204 }
205
206 typedef struct {
207         char                    slave;                  /* slave_mode?   */
208         struct timer_list       slave_timer;            /* timeout timer */
209         unsigned short          slave_timeout;          /* when? */
210 } ax25_dama_info;
211
212 struct ctl_table;
213
214 typedef struct ax25_dev {
215         struct ax25_dev         *next;
216         struct net_device       *dev;
217         struct net_device       *forward;
218         struct ctl_table_header *sysheader;
219         int                     values[AX25_MAX_VALUES];
220 #if defined(CONFIG_AX25_DAMA_SLAVE) || defined(CONFIG_AX25_DAMA_MASTER)
221         ax25_dama_info          dama;
222 #endif
223 } ax25_dev;
224
225 typedef struct ax25_cb {
226         struct hlist_node       ax25_node;
227         ax25_address            source_addr, dest_addr;
228         ax25_digi               *digipeat;
229         ax25_dev                *ax25_dev;
230         unsigned char           iamdigi;
231         unsigned char           state, modulus, pidincl;
232         unsigned short          vs, vr, va;
233         unsigned char           condition, backoff;
234         unsigned char           n2, n2count;
235         struct timer_list       t1timer, t2timer, t3timer, idletimer;
236         unsigned long           t1, t2, t3, idle, rtt;
237         unsigned short          paclen, fragno, fraglen;
238         struct sk_buff_head     write_queue;
239         struct sk_buff_head     reseq_queue;
240         struct sk_buff_head     ack_queue;
241         struct sk_buff_head     frag_queue;
242         unsigned char           window;
243         struct timer_list       timer, dtimer;
244         struct sock             *sk;            /* Backlink to socket */
245         atomic_t                refcount;
246 } ax25_cb;
247
248 #define ax25_sk(__sk) ((ax25_cb *)(__sk)->sk_protinfo)
249
250 #define ax25_for_each(__ax25, list) \
251         hlist_for_each_entry(__ax25, list, ax25_node)
252
253 #define ax25_cb_hold(__ax25) \
254         atomic_inc(&((__ax25)->refcount))
255
256 static __inline__ void ax25_cb_put(ax25_cb *ax25)
257 {
258         if (atomic_dec_and_test(&ax25->refcount)) {
259                 kfree(ax25->digipeat);
260                 kfree(ax25);
261         }
262 }
263
264 static inline __be16 ax25_type_trans(struct sk_buff *skb, struct net_device *dev)
265 {
266         skb->dev      = dev;
267         skb_reset_mac_header(skb);
268         skb->pkt_type = PACKET_HOST;
269         return htons(ETH_P_AX25);
270 }
271
272 /* af_ax25.c */
273 extern struct hlist_head ax25_list;
274 extern spinlock_t ax25_list_lock;
275 void ax25_cb_add(ax25_cb *);
276 struct sock *ax25_find_listener(ax25_address *, int, struct net_device *, int);
277 struct sock *ax25_get_socket(ax25_address *, ax25_address *, int);
278 ax25_cb *ax25_find_cb(ax25_address *, ax25_address *, ax25_digi *,
279                       struct net_device *);
280 void ax25_send_to_raw(ax25_address *, struct sk_buff *, int);
281 void ax25_destroy_socket(ax25_cb *);
282 ax25_cb * __must_check ax25_create_cb(void);
283 void ax25_fillin_cb(ax25_cb *, ax25_dev *);
284 struct sock *ax25_make_new(struct sock *, struct ax25_dev *);
285
286 /* ax25_addr.c */
287 extern const ax25_address ax25_bcast;
288 extern const ax25_address ax25_defaddr;
289 extern const ax25_address null_ax25_address;
290 char *ax2asc(char *buf, const ax25_address *);
291 void asc2ax(ax25_address *addr, const char *callsign);
292 int ax25cmp(const ax25_address *, const ax25_address *);
293 int ax25digicmp(const ax25_digi *, const ax25_digi *);
294 const unsigned char *ax25_addr_parse(const unsigned char *, int,
295         ax25_address *, ax25_address *, ax25_digi *, int *, int *);
296 int ax25_addr_build(unsigned char *, const ax25_address *,
297                     const ax25_address *, const ax25_digi *, int, int);
298 int ax25_addr_size(const ax25_digi *);
299 void ax25_digi_invert(const ax25_digi *, ax25_digi *);
300
301 /* ax25_dev.c */
302 extern ax25_dev *ax25_dev_list;
303 extern spinlock_t ax25_dev_lock;
304
305 static inline ax25_dev *ax25_dev_ax25dev(struct net_device *dev)
306 {
307         return dev->ax25_ptr;
308 }
309
310 ax25_dev *ax25_addr_ax25dev(ax25_address *);
311 void ax25_dev_device_up(struct net_device *);
312 void ax25_dev_device_down(struct net_device *);
313 int ax25_fwd_ioctl(unsigned int, struct ax25_fwd_struct *);
314 struct net_device *ax25_fwd_dev(struct net_device *);
315 void ax25_dev_free(void);
316
317 /* ax25_ds_in.c */
318 int ax25_ds_frame_in(ax25_cb *, struct sk_buff *, int);
319
320 /* ax25_ds_subr.c */
321 void ax25_ds_nr_error_recovery(ax25_cb *);
322 void ax25_ds_enquiry_response(ax25_cb *);
323 void ax25_ds_establish_data_link(ax25_cb *);
324 void ax25_dev_dama_off(ax25_dev *);
325 void ax25_dama_on(ax25_cb *);
326 void ax25_dama_off(ax25_cb *);
327
328 /* ax25_ds_timer.c */
329 void ax25_ds_setup_timer(ax25_dev *);
330 void ax25_ds_set_timer(ax25_dev *);
331 void ax25_ds_del_timer(ax25_dev *);
332 void ax25_ds_timer(ax25_cb *);
333 void ax25_ds_t1_timeout(ax25_cb *);
334 void ax25_ds_heartbeat_expiry(ax25_cb *);
335 void ax25_ds_t3timer_expiry(ax25_cb *);
336 void ax25_ds_idletimer_expiry(ax25_cb *);
337
338 /* ax25_iface.c */
339
340 struct ax25_protocol {
341         struct ax25_protocol *next;
342         unsigned int pid;
343         int (*func)(struct sk_buff *, ax25_cb *);
344 };
345
346 void ax25_register_pid(struct ax25_protocol *ap);
347 void ax25_protocol_release(unsigned int);
348
349 struct ax25_linkfail {
350         struct hlist_node lf_node;
351         void (*func)(ax25_cb *, int);
352 };
353
354 void ax25_linkfail_register(struct ax25_linkfail *lf);
355 void ax25_linkfail_release(struct ax25_linkfail *lf);
356 int __must_check ax25_listen_register(ax25_address *, struct net_device *);
357 void ax25_listen_release(ax25_address *, struct net_device *);
358 int(*ax25_protocol_function(unsigned int))(struct sk_buff *, ax25_cb *);
359 int ax25_listen_mine(ax25_address *, struct net_device *);
360 void ax25_link_failed(ax25_cb *, int);
361 int ax25_protocol_is_registered(unsigned int);
362
363 /* ax25_in.c */
364 int ax25_rx_iframe(ax25_cb *, struct sk_buff *);
365 int ax25_kiss_rcv(struct sk_buff *, struct net_device *, struct packet_type *,
366                   struct net_device *);
367
368 /* ax25_ip.c */
369 int ax25_hard_header(struct sk_buff *, struct net_device *, unsigned short,
370                      const void *, const void *, unsigned int);
371 int ax25_rebuild_header(struct sk_buff *);
372 extern const struct header_ops ax25_header_ops;
373
374 /* ax25_out.c */
375 ax25_cb *ax25_send_frame(struct sk_buff *, int, ax25_address *, ax25_address *,
376                          ax25_digi *, struct net_device *);
377 void ax25_output(ax25_cb *, int, struct sk_buff *);
378 void ax25_kick(ax25_cb *);
379 void ax25_transmit_buffer(ax25_cb *, struct sk_buff *, int);
380 void ax25_queue_xmit(struct sk_buff *skb, struct net_device *dev);
381 int ax25_check_iframes_acked(ax25_cb *, unsigned short);
382
383 /* ax25_route.c */
384 void ax25_rt_device_down(struct net_device *);
385 int ax25_rt_ioctl(unsigned int, void __user *);
386 extern const struct file_operations ax25_route_fops;
387 ax25_route *ax25_get_route(ax25_address *addr, struct net_device *dev);
388 int ax25_rt_autobind(ax25_cb *, ax25_address *);
389 struct sk_buff *ax25_rt_build_path(struct sk_buff *, ax25_address *,
390                                    ax25_address *, ax25_digi *);
391 void ax25_rt_free(void);
392
393 /* ax25_std_in.c */
394 int ax25_std_frame_in(ax25_cb *, struct sk_buff *, int);
395
396 /* ax25_std_subr.c */
397 void ax25_std_nr_error_recovery(ax25_cb *);
398 void ax25_std_establish_data_link(ax25_cb *);
399 void ax25_std_transmit_enquiry(ax25_cb *);
400 void ax25_std_enquiry_response(ax25_cb *);
401 void ax25_std_timeout_response(ax25_cb *);
402
403 /* ax25_std_timer.c */
404 void ax25_std_heartbeat_expiry(ax25_cb *);
405 void ax25_std_t1timer_expiry(ax25_cb *);
406 void ax25_std_t2timer_expiry(ax25_cb *);
407 void ax25_std_t3timer_expiry(ax25_cb *);
408 void ax25_std_idletimer_expiry(ax25_cb *);
409
410 /* ax25_subr.c */
411 void ax25_clear_queues(ax25_cb *);
412 void ax25_frames_acked(ax25_cb *, unsigned short);
413 void ax25_requeue_frames(ax25_cb *);
414 int ax25_validate_nr(ax25_cb *, unsigned short);
415 int ax25_decode(ax25_cb *, struct sk_buff *, int *, int *, int *);
416 void ax25_send_control(ax25_cb *, int, int, int);
417 void ax25_return_dm(struct net_device *, ax25_address *, ax25_address *,
418                     ax25_digi *);
419 void ax25_calculate_t1(ax25_cb *);
420 void ax25_calculate_rtt(ax25_cb *);
421 void ax25_disconnect(ax25_cb *, int);
422
423 /* ax25_timer.c */
424 void ax25_setup_timers(ax25_cb *);
425 void ax25_start_heartbeat(ax25_cb *);
426 void ax25_start_t1timer(ax25_cb *);
427 void ax25_start_t2timer(ax25_cb *);
428 void ax25_start_t3timer(ax25_cb *);
429 void ax25_start_idletimer(ax25_cb *);
430 void ax25_stop_heartbeat(ax25_cb *);
431 void ax25_stop_t1timer(ax25_cb *);
432 void ax25_stop_t2timer(ax25_cb *);
433 void ax25_stop_t3timer(ax25_cb *);
434 void ax25_stop_idletimer(ax25_cb *);
435 int ax25_t1timer_running(ax25_cb *);
436 unsigned long ax25_display_timer(struct timer_list *);
437
438 /* ax25_uid.c */
439 extern int  ax25_uid_policy;
440 ax25_uid_assoc *ax25_findbyuid(kuid_t);
441 int __must_check ax25_uid_ioctl(int, struct sockaddr_ax25 *);
442 extern const struct file_operations ax25_uid_fops;
443 void ax25_uid_free(void);
444
445 /* sysctl_net_ax25.c */
446 #ifdef CONFIG_SYSCTL
447 int ax25_register_dev_sysctl(ax25_dev *ax25_dev);
448 void ax25_unregister_dev_sysctl(ax25_dev *ax25_dev);
449 #else
450 static inline int ax25_register_dev_sysctl(ax25_dev *ax25_dev) { return 0; }
451 static inline void ax25_unregister_dev_sysctl(ax25_dev *ax25_dev) {}
452 #endif /* CONFIG_SYSCTL */
453
454 #endif