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