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 <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 Address 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                refcount;
 186         ax25_address            callsign;
 187         struct net_device       *dev;
 188         ax25_digi               *digipeat;
 189         char                    ip_mode;
 190 } ax25_route;
 191
 192 static inline void ax25_hold_route(ax25_route *ax25_rt)
 193 {
 194         atomic_inc(&ax25_rt->refcount);
 195 }
 196
 197 extern void __ax25_put_route(ax25_route *ax25_rt);
 198
 199 static inline void ax25_put_route(ax25_route *ax25_rt)
 200 {
 201         if (atomic_dec_and_test(&ax25_rt->refcount))
 202                 __ax25_put_route(ax25_rt);
 203 }
 204
 205 typedef struct {
 206         char                    slave;                  /* slave_mode?   */
 207         struct timer_list       slave_timer;            /* timeout timer */
 208         unsigned short          slave_timeout;          /* when? */
 209 } ax25_dama_info;
 210
 211 struct ctl_table;
 212
 213 typedef struct ax25_dev {
 214         struct ax25_dev         *next;
 215         struct net_device       *dev;
 216         struct net_device       *forward;
 217         struct ctl_table        *systable;
 218         int                     values[AX25_MAX_VALUES];
 219 #if defined(CONFIG_AX25_DAMA_SLAVE) || defined(CONFIG_AX25_DAMA_MASTER)
 220         ax25_dama_info          dama;
 221 #endif
 222 } ax25_dev;
 223
 224 typedef struct ax25_cb {
 225         struct hlist_node       ax25_node;
 226         ax25_address            source_addr, dest_addr;
 227         ax25_digi               *digipeat;
 228         ax25_dev                *ax25_dev;
 229         unsigned char           iamdigi;
 230         unsigned char           state, modulus, pidincl;
 231         unsigned short          vs, vr, va;
 232         unsigned char           condition, backoff;
 233         unsigned char           n2, n2count;
 234         struct timer_list       t1timer, t2timer, t3timer, idletimer;
 235         unsigned long           t1, t2, t3, idle, rtt;
 236         unsigned short          paclen, fragno, fraglen;
 237         struct sk_buff_head     write_queue;
 238         struct sk_buff_head     reseq_queue;
 239         struct sk_buff_head     ack_queue;
 240         struct sk_buff_head     frag_queue;
 241         unsigned char           window;
 242         struct timer_list       timer, dtimer;
 243         struct sock             *sk;            /* Backlink to socket */
 244         atomic_t                refcount;
 245 } ax25_cb;
 246
 247 #define ax25_sk(__sk) ((ax25_cb *)(__sk)->sk_protinfo)
 248
 249 #define ax25_for_each(__ax25, node, list) \
 250         hlist_for_each_entry(__ax25, node, list, ax25_node)
 251
 252 #define ax25_cb_hold(__ax25) \
 253         atomic_inc(&((__ax25)->refcount))
 254
 255 static __inline__ void ax25_cb_put(ax25_cb *ax25)
 256 {
 257         if (atomic_dec_and_test(&ax25->refcount)) {
 258                 kfree(ax25->digipeat);
 259                 kfree(ax25);
 260         }
 261 }
 262
 263 static inline __be16 ax25_type_trans(struct sk_buff *skb, struct net_device *dev)
 264 {
 265         skb->dev      = dev;
 266         skb_reset_mac_header(skb);
 267         skb->pkt_type = PACKET_HOST;
 268         return htons(ETH_P_AX25);
 269 }
 270
 271 /* af_ax25.c */
 272 extern struct hlist_head ax25_list;
 273 extern spinlock_t ax25_list_lock;
 274 extern void ax25_cb_add(ax25_cb *);
 275 struct sock *ax25_find_listener(ax25_address *, int, struct net_device *, int);
 276 struct sock *ax25_get_socket(ax25_address *, ax25_address *, int);
 277 extern ax25_cb *ax25_find_cb(ax25_address *, ax25_address *, ax25_digi *, struct net_device *);
 278 extern void ax25_send_to_raw(ax25_address *, struct sk_buff *, int);
 279 extern void ax25_destroy_socket(ax25_cb *);
 280 extern ax25_cb * __must_check ax25_create_cb(void);
 281 extern void ax25_fillin_cb(ax25_cb *, ax25_dev *);
 282 extern struct sock *ax25_make_new(struct sock *, struct ax25_dev *);
 283
 284 /* ax25_addr.c */
 285 extern const ax25_address ax25_bcast;
 286 extern const ax25_address ax25_defaddr;
 287 extern const ax25_address null_ax25_address;
 288 extern char *ax2asc(char *buf, const ax25_address *);
 289 extern void asc2ax(ax25_address *addr, const char *callsign);
 290 extern int ax25cmp(const ax25_address *, const ax25_address *);
 291 extern int ax25digicmp(const ax25_digi *, const ax25_digi *);
 292 extern const unsigned char *ax25_addr_parse(const unsigned char *, int,
 293         ax25_address *, ax25_address *, ax25_digi *, int *, int *);
 294 extern int  ax25_addr_build(unsigned char *, const ax25_address *,
 295         const ax25_address *, const ax25_digi *, int, int);
 296 extern int  ax25_addr_size(const ax25_digi *);
 297 extern void ax25_digi_invert(const ax25_digi *, ax25_digi *);
 298
 299 /* ax25_dev.c */
 300 extern ax25_dev *ax25_dev_list;
 301 extern spinlock_t ax25_dev_lock;
 302
 303 static inline ax25_dev *ax25_dev_ax25dev(struct net_device *dev)
 304 {
 305         return dev->ax25_ptr;
 306 }
 307
 308 extern ax25_dev *ax25_addr_ax25dev(ax25_address *);
 309 extern void ax25_dev_device_up(struct net_device *);
 310 extern void ax25_dev_device_down(struct net_device *);
 311 extern int  ax25_fwd_ioctl(unsigned int, struct ax25_fwd_struct *);
 312 extern struct net_device *ax25_fwd_dev(struct net_device *);
 313 extern void ax25_dev_free(void);
 314
 315 /* ax25_ds_in.c */
 316 extern int  ax25_ds_frame_in(ax25_cb *, struct sk_buff *, int);
 317
 318 /* ax25_ds_subr.c */
 319 extern void ax25_ds_nr_error_recovery(ax25_cb *);
 320 extern void ax25_ds_enquiry_response(ax25_cb *);
 321 extern void ax25_ds_establish_data_link(ax25_cb *);
 322 extern void ax25_dev_dama_off(ax25_dev *);
 323 extern void ax25_dama_on(ax25_cb *);
 324 extern void ax25_dama_off(ax25_cb *);
 325
 326 /* ax25_ds_timer.c */
 327 extern void ax25_ds_setup_timer(ax25_dev *);
 328 extern void ax25_ds_set_timer(ax25_dev *);
 329 extern void ax25_ds_del_timer(ax25_dev *);
 330 extern void ax25_ds_timer(ax25_cb *);
 331 extern void ax25_ds_t1_timeout(ax25_cb *);
 332 extern void ax25_ds_heartbeat_expiry(ax25_cb *);
 333 extern void ax25_ds_t3timer_expiry(ax25_cb *);
 334 extern void ax25_ds_idletimer_expiry(ax25_cb *);
 335
 336 /* ax25_iface.c */
 337
 338 struct ax25_protocol {
 339         struct ax25_protocol *next;
 340         unsigned int pid;
 341         int (*func)(struct sk_buff *, ax25_cb *);
 342 };
 343
 344 extern void ax25_register_pid(struct ax25_protocol *ap);
 345 extern void ax25_protocol_release(unsigned int);
 346
 347 struct ax25_linkfail {
 348         struct hlist_node lf_node;
 349         void (*func)(ax25_cb *, int);
 350 };
 351
 352 extern void ax25_linkfail_register(struct ax25_linkfail *lf);
 353 extern void ax25_linkfail_release(struct ax25_linkfail *lf);
 354 extern int __must_check ax25_listen_register(ax25_address *,
 355         struct net_device *);
 356 extern void ax25_listen_release(ax25_address *, struct net_device *);
 357 extern int  (*ax25_protocol_function(unsigned int))(struct sk_buff *, ax25_cb *);
 358 extern int  ax25_listen_mine(ax25_address *, struct net_device *);
 359 extern void ax25_link_failed(ax25_cb *, int);
 360 extern int  ax25_protocol_is_registered(unsigned int);
 361
 362 /* ax25_in.c */
 363 extern int  ax25_rx_iframe(ax25_cb *, struct sk_buff *);
 364 extern int  ax25_kiss_rcv(struct sk_buff *, struct net_device *, struct packet_type *, struct net_device *);
 365
 366 /* ax25_ip.c */
 367 extern int ax25_hard_header(struct sk_buff *, struct net_device *,
 368                             unsigned short, const void *,
 369                             const void *, unsigned int);
 370 extern int  ax25_rebuild_header(struct sk_buff *);
 371 extern const struct header_ops ax25_header_ops;
 372
 373 /* ax25_out.c */
 374 extern ax25_cb *ax25_send_frame(struct sk_buff *, int, ax25_address *, ax25_address *, ax25_digi *, struct net_device *);
 375 extern void ax25_output(ax25_cb *, int, struct sk_buff *);
 376 extern void ax25_kick(ax25_cb *);
 377 extern void ax25_transmit_buffer(ax25_cb *, struct sk_buff *, int);
 378 extern void ax25_queue_xmit(struct sk_buff *skb, struct net_device *dev);
 379 extern int  ax25_check_iframes_acked(ax25_cb *, unsigned short);
 380
 381 /* ax25_route.c */
 382 extern void ax25_rt_device_down(struct net_device *);
 383 extern int  ax25_rt_ioctl(unsigned int, void __user *);
 384 extern const struct file_operations ax25_route_fops;
 385 extern ax25_route *ax25_get_route(ax25_address *addr, struct net_device *dev);
 386 extern int  ax25_rt_autobind(ax25_cb *, ax25_address *);
 387 extern struct sk_buff *ax25_rt_build_path(struct sk_buff *, ax25_address *, ax25_address *, ax25_digi *);
 388 extern void ax25_rt_free(void);
 389
 390 /* ax25_std_in.c */
 391 extern int  ax25_std_frame_in(ax25_cb *, struct sk_buff *, int);
 392
 393 /* ax25_std_subr.c */
 394 extern void ax25_std_nr_error_recovery(ax25_cb *);
 395 extern void ax25_std_establish_data_link(ax25_cb *);
 396 extern void ax25_std_transmit_enquiry(ax25_cb *);
 397 extern void ax25_std_enquiry_response(ax25_cb *);
 398 extern void ax25_std_timeout_response(ax25_cb *);
 399
 400 /* ax25_std_timer.c */
 401 extern void ax25_std_heartbeat_expiry(ax25_cb *);
 402 extern void ax25_std_t1timer_expiry(ax25_cb *);
 403 extern void ax25_std_t2timer_expiry(ax25_cb *);
 404 extern void ax25_std_t3timer_expiry(ax25_cb *);
 405 extern void ax25_std_idletimer_expiry(ax25_cb *);
 406
 407 /* ax25_subr.c */
 408 extern void ax25_clear_queues(ax25_cb *);
 409 extern void ax25_frames_acked(ax25_cb *, unsigned short);
 410 extern void ax25_requeue_frames(ax25_cb *);
 411 extern int  ax25_validate_nr(ax25_cb *, unsigned short);
 412 extern int  ax25_decode(ax25_cb *, struct sk_buff *, int *, int *, int *);
 413 extern void ax25_send_control(ax25_cb *, int, int, int);
 414 extern void ax25_return_dm(struct net_device *, ax25_address *, ax25_address *, ax25_digi *);
 415 extern void ax25_calculate_t1(ax25_cb *);
 416 extern void ax25_calculate_rtt(ax25_cb *);
 417 extern void ax25_disconnect(ax25_cb *, int);
 418
 419 /* ax25_timer.c */
 420 extern void ax25_setup_timers(ax25_cb *);
 421 extern void ax25_start_heartbeat(ax25_cb *);
 422 extern void ax25_start_t1timer(ax25_cb *);
 423 extern void ax25_start_t2timer(ax25_cb *);
 424 extern void ax25_start_t3timer(ax25_cb *);
 425 extern void ax25_start_idletimer(ax25_cb *);
 426 extern void ax25_stop_heartbeat(ax25_cb *);
 427 extern void ax25_stop_t1timer(ax25_cb *);
 428 extern void ax25_stop_t2timer(ax25_cb *);
 429 extern void ax25_stop_t3timer(ax25_cb *);
 430 extern void ax25_stop_idletimer(ax25_cb *);
 431 extern int  ax25_t1timer_running(ax25_cb *);
 432 extern unsigned long ax25_display_timer(struct timer_list *);
 433
 434 /* ax25_uid.c */
 435 extern int  ax25_uid_policy;
 436 extern ax25_uid_assoc *ax25_findbyuid(uid_t);
 437 extern int __must_check ax25_uid_ioctl(int, struct sockaddr_ax25 *);
 438 extern const struct file_operations ax25_uid_fops;
 439 extern void ax25_uid_free(void);
 440
 441 /* sysctl_net_ax25.c */
 442 #ifdef CONFIG_SYSCTL
 443 extern void ax25_register_sysctl(void);
 444 extern void ax25_unregister_sysctl(void);
 445 #else
 446 static inline void ax25_register_sysctl(void) {};
 447 static inline void ax25_unregister_sysctl(void) {};
 448 #endif /* CONFIG_SYSCTL */
 449
 450 #endif