include/linux/atmdev.h

   1 /* atmdev.h - ATM device driver declarations and various related items */
   2
   3 /* Written 1995-2000 by Werner Almesberger, EPFL LRC/ICA */
   4
   5
   6 #ifndef LINUX_ATMDEV_H
   7 #define LINUX_ATMDEV_H
   8
   9
  10 #include <linux/config.h>
  11 #include <linux/atmapi.h>
  12 #include <linux/atm.h>
  13 #include <linux/atmioc.h>
  14
  15
  16 #define ESI_LEN         6
  17
  18 #define ATM_OC3_PCR     (155520000/270*260/8/53)
  19                         /* OC3 link rate:  155520000 bps
  20                            SONET overhead: /270*260 (9 section, 1 path)
  21                            bits per cell:  /8/53
  22                            max cell rate:  353207.547 cells/sec */
  23 #define ATM_25_PCR      ((25600000/8-8000)/54)
  24                         /* 25 Mbps ATM cell rate (59111) */
  25 #define ATM_OC12_PCR    (622080000/1080*1040/8/53)
  26                         /* OC12 link rate: 622080000 bps
  27                            SONET overhead: /1080*1040
  28                            bits per cell:  /8/53
  29                            max cell rate:  1412830.188 cells/sec */
  30 #define ATM_DS3_PCR     (8000*12)
  31                         /* DS3: 12 cells in a 125 usec time slot */
  32
  33 #define atm_sk(__sk) ((struct atm_vcc *)(__sk)->sk_protinfo)
  34 #define ATM_SD(s)       (atm_sk((s)->sk))
  35
  36
  37 #define __AAL_STAT_ITEMS \
  38     __HANDLE_ITEM(tx);                  /* TX okay */ \
  39     __HANDLE_ITEM(tx_err);              /* TX errors */ \
  40     __HANDLE_ITEM(rx);                  /* RX okay */ \
  41     __HANDLE_ITEM(rx_err);              /* RX errors */ \
  42     __HANDLE_ITEM(rx_drop);             /* RX out of memory */
  43
  44 struct atm_aal_stats {
  45 #define __HANDLE_ITEM(i) int i
  46         __AAL_STAT_ITEMS
  47 #undef __HANDLE_ITEM
  48 };
  49
  50
  51 struct atm_dev_stats {
  52         struct atm_aal_stats aal0;
  53         struct atm_aal_stats aal34;
  54         struct atm_aal_stats aal5;
  55 } __ATM_API_ALIGN;
  56
  57
  58 #define ATM_GETLINKRATE _IOW('a',ATMIOC_ITF+1,struct atmif_sioc)
  59                                         /* get link rate */
  60 #define ATM_GETNAMES    _IOW('a',ATMIOC_ITF+3,struct atm_iobuf)
  61                                         /* get interface names (numbers) */
  62 #define ATM_GETTYPE     _IOW('a',ATMIOC_ITF+4,struct atmif_sioc)
  63                                         /* get interface type name */
  64 #define ATM_GETESI      _IOW('a',ATMIOC_ITF+5,struct atmif_sioc)
  65                                         /* get interface ESI */
  66 #define ATM_GETADDR     _IOW('a',ATMIOC_ITF+6,struct atmif_sioc)
  67                                         /* get itf's local ATM addr. list */
  68 #define ATM_RSTADDR     _IOW('a',ATMIOC_ITF+7,struct atmif_sioc)
  69                                         /* reset itf's ATM address list */
  70 #define ATM_ADDADDR     _IOW('a',ATMIOC_ITF+8,struct atmif_sioc)
  71                                         /* add a local ATM address */
  72 #define ATM_DELADDR     _IOW('a',ATMIOC_ITF+9,struct atmif_sioc)
  73                                         /* remove a local ATM address */
  74 #define ATM_GETCIRANGE  _IOW('a',ATMIOC_ITF+10,struct atmif_sioc)
  75                                         /* get connection identifier range */
  76 #define ATM_SETCIRANGE  _IOW('a',ATMIOC_ITF+11,struct atmif_sioc)
  77                                         /* set connection identifier range */
  78 #define ATM_SETESI      _IOW('a',ATMIOC_ITF+12,struct atmif_sioc)
  79                                         /* set interface ESI */
  80 #define ATM_SETESIF     _IOW('a',ATMIOC_ITF+13,struct atmif_sioc)
  81                                         /* force interface ESI */
  82 #define ATM_GETSTAT     _IOW('a',ATMIOC_SARCOM+0,struct atmif_sioc)
  83                                         /* get AAL layer statistics */
  84 #define ATM_GETSTATZ    _IOW('a',ATMIOC_SARCOM+1,struct atmif_sioc)
  85                                         /* get AAL layer statistics and zero */
  86 #define ATM_GETLOOP     _IOW('a',ATMIOC_SARCOM+2,struct atmif_sioc)
  87                                         /* get loopback mode */
  88 #define ATM_SETLOOP     _IOW('a',ATMIOC_SARCOM+3,struct atmif_sioc)
  89                                         /* set loopback mode */
  90 #define ATM_QUERYLOOP   _IOW('a',ATMIOC_SARCOM+4,struct atmif_sioc)
  91                                         /* query supported loopback modes */
  92 #define ATM_SETSC       _IOW('a',ATMIOC_SPECIAL+1,int)
  93                                         /* enable or disable single-copy */
  94 #define ATM_SETBACKEND  _IOW('a',ATMIOC_SPECIAL+2,atm_backend_t)
  95                                         /* set backend handler */
  96 #define ATM_NEWBACKENDIF _IOW('a',ATMIOC_SPECIAL+3,atm_backend_t)
  97                                         /* use backend to make new if */
  98 #define ATM_ADDPARTY    _IOW('a', ATMIOC_SPECIAL+4,struct atm_iobuf)
  99                                         /* add party to p2mp call */
 100 #define ATM_DROPPARTY   _IOW('a', ATMIOC_SPECIAL+5,int)
 101                                         /* drop party from p2mp call */
 102
 103 /*
 104  * These are backend handkers that can be set via the ATM_SETBACKEND call
 105  * above.  In the future we may support dynamic loading of these - for now,
 106  * they're just being used to share the ATMIOC_BACKEND ioctls
 107  */
 108 #define ATM_BACKEND_RAW         0
 109 #define ATM_BACKEND_PPP         1       /* PPPoATM - RFC2364 */
 110 #define ATM_BACKEND_BR2684      2       /* Bridged RFC1483/2684 */
 111
 112 /* for ATM_GETTYPE */
 113 #define ATM_ITFTYP_LEN  8       /* maximum length of interface type name */
 114
 115 /*
 116  * Loopback modes for ATM_{PHY,SAR}_{GET,SET}LOOP
 117  */
 118
 119 /* Point of loopback                            CPU-->SAR-->PHY-->line--> ... */
 120 #define __ATM_LM_NONE   0       /* no loop back     ^     ^     ^      ^      */
 121 #define __ATM_LM_AAL    1       /* loop back PDUs --'     |     |      |      */
 122 #define __ATM_LM_ATM    2       /* loop back ATM cells ---'     |      |      */
 123 /* RESERVED             4       loop back on PHY side  ---'                   */
 124 #define __ATM_LM_PHY    8       /* loop back bits (digital) ----'      |      */
 125 #define __ATM_LM_ANALOG 16      /* loop back the analog signal --------'      */
 126
 127 /* Direction of loopback */
 128 #define __ATM_LM_MKLOC(n)       ((n))       /* Local (i.e. loop TX to RX) */
 129 #define __ATM_LM_MKRMT(n)       ((n) << 8)  /* Remote (i.e. loop RX to TX) */
 130
 131 #define __ATM_LM_XTLOC(n)       ((n) & 0xff)
 132 #define __ATM_LM_XTRMT(n)       (((n) >> 8) & 0xff)
 133
 134 #define ATM_LM_NONE     0       /* no loopback */
 135
 136 #define ATM_LM_LOC_AAL  __ATM_LM_MKLOC(__ATM_LM_AAL)
 137 #define ATM_LM_LOC_ATM  __ATM_LM_MKLOC(__ATM_LM_ATM)
 138 #define ATM_LM_LOC_PHY  __ATM_LM_MKLOC(__ATM_LM_PHY)
 139 #define ATM_LM_LOC_ANALOG __ATM_LM_MKLOC(__ATM_LM_ANALOG)
 140
 141 #define ATM_LM_RMT_AAL  __ATM_LM_MKRMT(__ATM_LM_AAL)
 142 #define ATM_LM_RMT_ATM  __ATM_LM_MKRMT(__ATM_LM_ATM)
 143 #define ATM_LM_RMT_PHY  __ATM_LM_MKRMT(__ATM_LM_PHY)
 144 #define ATM_LM_RMT_ANALOG __ATM_LM_MKRMT(__ATM_LM_ANALOG)
 145
 146 /*
 147  * Note: ATM_LM_LOC_* and ATM_LM_RMT_* can be combined, provided that
 148  * __ATM_LM_XTLOC(x) <= __ATM_LM_XTRMT(x)
 149  */
 150
 151
 152 struct atm_iobuf {
 153         int length;
 154         void __user *buffer;
 155 };
 156
 157 /* for ATM_GETCIRANGE / ATM_SETCIRANGE */
 158
 159 #define ATM_CI_MAX      -1              /* use maximum range of VPI/VCI */
 160
 161 struct atm_cirange {
 162         signed char     vpi_bits;       /* 1..8, ATM_CI_MAX (-1) for maximum */
 163         signed char     vci_bits;       /* 1..16, ATM_CI_MAX (-1) for maximum */
 164 };
 165
 166 /* for ATM_SETSC; actually taken from the ATM_VF number space */
 167
 168 #define ATM_SC_RX       1024            /* enable RX single-copy */
 169 #define ATM_SC_TX       2048            /* enable TX single-copy */
 170
 171 #define ATM_BACKLOG_DEFAULT 32 /* if we get more, we're likely to time out
 172                                   anyway */
 173
 174 /* MF: change_qos (Modify) flags */
 175
 176 #define ATM_MF_IMMED     1      /* Block until change is effective */
 177 #define ATM_MF_INC_RSV   2      /* Change reservation on increase */
 178 #define ATM_MF_INC_SHP   4      /* Change shaping on increase */
 179 #define ATM_MF_DEC_RSV   8      /* Change reservation on decrease */
 180 #define ATM_MF_DEC_SHP  16      /* Change shaping on decrease */
 181 #define ATM_MF_BWD      32      /* Set the backward direction parameters */
 182
 183 #define ATM_MF_SET      (ATM_MF_INC_RSV | ATM_MF_INC_SHP | ATM_MF_DEC_RSV | \
 184                           ATM_MF_DEC_SHP | ATM_MF_BWD)
 185
 186 /*
 187  * ATM_VS_* are used to express VC state in a human-friendly way.
 188  */
 189
 190 #define ATM_VS_IDLE     0       /* VC is not used */
 191 #define ATM_VS_CONNECTED 1      /* VC is connected */
 192 #define ATM_VS_CLOSING  2       /* VC is closing */
 193 #define ATM_VS_LISTEN   3       /* VC is listening for incoming setups */
 194 #define ATM_VS_INUSE    4       /* VC is in use (registered with atmsigd) */
 195 #define ATM_VS_BOUND    5       /* VC is bound */
 196
 197 #define ATM_VS2TXT_MAP \
 198     "IDLE", "CONNECTED", "CLOSING", "LISTEN", "INUSE", "BOUND"
 199
 200 #define ATM_VF2TXT_MAP \
 201     "ADDR",     "READY",        "PARTIAL",      "REGIS", \
 202     "RELEASED", "HASQOS",       "LISTEN",       "META", \
 203     "256",      "512",          "1024",         "2048", \
 204     "SESSION",  "HASSAP",       "BOUND",        "CLOSE"
 205
 206
 207 #ifdef __KERNEL__
 208
 209 #include <linux/wait.h> /* wait_queue_head_t */
 210 #include <linux/time.h> /* struct timeval */
 211 #include <linux/net.h>
 212 #include <linux/skbuff.h> /* struct sk_buff */
 213 #include <linux/uio.h>
 214 #include <net/sock.h>
 215 #include <asm/atomic.h>
 216
 217 #ifdef CONFIG_PROC_FS
 218 #include <linux/proc_fs.h>
 219
 220 extern struct proc_dir_entry *atm_proc_root;
 221 #endif
 222
 223
 224 struct k_atm_aal_stats {
 225 #define __HANDLE_ITEM(i) atomic_t i
 226         __AAL_STAT_ITEMS
 227 #undef __HANDLE_ITEM
 228 };
 229
 230
 231 struct k_atm_dev_stats {
 232         struct k_atm_aal_stats aal0;
 233         struct k_atm_aal_stats aal34;
 234         struct k_atm_aal_stats aal5;
 235 };
 236
 237
 238 enum {
 239         ATM_VF_ADDR,            /* Address is in use. Set by anybody, cleared
 240                                    by device driver. */
 241         ATM_VF_READY,           /* VC is ready to transfer data. Set by device
 242                                    driver, cleared by anybody. */
 243         ATM_VF_PARTIAL,         /* resources are bound to PVC (partial PVC
 244                                    setup), controlled by socket layer */
 245         ATM_VF_REGIS,           /* registered with demon, controlled by SVC
 246                                    socket layer */
 247         ATM_VF_BOUND,           /* local SAP is set, controlled by SVC socket
 248                                    layer */
 249         ATM_VF_RELEASED,        /* demon has indicated/requested release,
 250                                    controlled by SVC socket layer */
 251         ATM_VF_HASQOS,          /* QOS parameters have been set */
 252         ATM_VF_LISTEN,          /* socket is used for listening */
 253         ATM_VF_META,            /* SVC socket isn't used for normal data
 254                                    traffic and doesn't depend on signaling
 255                                    to be available */
 256         ATM_VF_SESSION,         /* VCC is p2mp session control descriptor */
 257         ATM_VF_HASSAP,          /* SAP has been set */
 258         ATM_VF_CLOSE,           /* asynchronous close - treat like VF_RELEASED*/
 259         ATM_VF_WAITING,         /* waiting for reply from sigd */
 260         ATM_VF_IS_CLIP,         /* in use by CLIP protocol */
 261 };
 262
 263
 264 #define ATM_VF2VS(flags) \
 265     (test_bit(ATM_VF_READY,&(flags)) ? ATM_VS_CONNECTED : \
 266      test_bit(ATM_VF_RELEASED,&(flags)) ? ATM_VS_CLOSING : \
 267      test_bit(ATM_VF_LISTEN,&(flags)) ? ATM_VS_LISTEN : \
 268      test_bit(ATM_VF_REGIS,&(flags)) ? ATM_VS_INUSE : \
 269      test_bit(ATM_VF_BOUND,&(flags)) ? ATM_VS_BOUND : ATM_VS_IDLE)
 270
 271
 272 enum {
 273         ATM_DF_CLOSE,           /* close device when last VCC is closed */
 274 };
 275
 276
 277 #define ATM_PHY_SIG_LOST    0   /* no carrier/light */
 278 #define ATM_PHY_SIG_UNKNOWN 1   /* carrier/light status is unknown */
 279 #define ATM_PHY_SIG_FOUND   2   /* carrier/light okay */
 280
 281 #define ATM_ATMOPT_CLP  1       /* set CLP bit */
 282
 283 struct atm_vcc {
 284         unsigned long   flags;          /* VCC flags (ATM_VF_*) */
 285         short           vpi;            /* VPI and VCI (types must be equal */
 286                                         /* with sockaddr) */
 287         int             vci;
 288         unsigned long   aal_options;    /* AAL layer options */
 289         unsigned long   atm_options;    /* ATM layer options */
 290         struct atm_dev  *dev;           /* device back pointer */
 291         struct atm_qos  qos;            /* QOS */
 292         struct atm_sap  sap;            /* SAP */
 293         void (*push)(struct atm_vcc *vcc,struct sk_buff *skb);
 294         void (*pop)(struct atm_vcc *vcc,struct sk_buff *skb); /* optional */
 295         int (*push_oam)(struct atm_vcc *vcc,void *cell);
 296         int (*send)(struct atm_vcc *vcc,struct sk_buff *skb);
 297         void            *dev_data;      /* per-device data */
 298         void            *proto_data;    /* per-protocol data */
 299         struct k_atm_aal_stats *stats;  /* pointer to AAL stats group */
 300         struct sock     *sk;            /* socket backpointer */
 301         /* SVC part --- may move later ------------------------------------- */
 302         short           itf;            /* interface number */
 303         struct sockaddr_atmsvc local;
 304         struct sockaddr_atmsvc remote;
 305         /* Multipoint part ------------------------------------------------- */
 306         struct atm_vcc  *session;       /* session VCC descriptor */
 307         /* Other stuff ----------------------------------------------------- */
 308         void            *user_back;     /* user backlink - not touched by */
 309                                         /* native ATM stack. Currently used */
 310                                         /* by CLIP and sch_atm. */
 311 };
 312
 313
 314 struct atm_dev_addr {
 315         struct sockaddr_atmsvc addr;    /* ATM address */
 316         struct list_head entry;         /* next address */
 317 };
 318
 319 struct atm_dev {
 320         const struct atmdev_ops *ops;   /* device operations; NULL if unused */
 321         const struct atmphy_ops *phy;   /* PHY operations, may be undefined */
 322                                         /* (NULL) */
 323         const char      *type;          /* device type name */
 324         int             number;         /* device index */
 325         void            *dev_data;      /* per-device data */
 326         void            *phy_data;      /* private PHY date */
 327         unsigned long   flags;          /* device flags (ATM_DF_*) */
 328         struct list_head local;         /* local ATM addresses */
 329         unsigned char   esi[ESI_LEN];   /* ESI ("MAC" addr) */
 330         struct atm_cirange ci_range;    /* VPI/VCI range */
 331         struct k_atm_dev_stats stats;   /* statistics */
 332         char            signal;         /* signal status (ATM_PHY_SIG_*) */
 333         int             link_rate;      /* link rate (default: OC3) */
 334         atomic_t        refcnt;         /* reference count */
 335         spinlock_t      lock;           /* protect internal members */
 336 #ifdef CONFIG_PROC_FS
 337         struct proc_dir_entry *proc_entry; /* proc entry */
 338         char *proc_name;                /* proc entry name */
 339 #endif
 340         struct list_head dev_list;      /* linkage */
 341 };
 342
 343
 344 /* OF: send_Oam Flags */
 345
 346 #define ATM_OF_IMMED  1         /* Attempt immediate delivery */
 347 #define ATM_OF_INRATE 2         /* Attempt in-rate delivery */
 348
 349
 350 /*
 351  * ioctl, getsockopt, and setsockopt are optional and can be set to NULL.
 352  */
 353
 354 struct atmdev_ops { /* only send is required */
 355         void (*dev_close)(struct atm_dev *dev);
 356         int (*open)(struct atm_vcc *vcc);
 357         void (*close)(struct atm_vcc *vcc);
 358         int (*ioctl)(struct atm_dev *dev,unsigned int cmd,void __user *arg);
 359         int (*getsockopt)(struct atm_vcc *vcc,int level,int optname,
 360             void __user *optval,int optlen);
 361         int (*setsockopt)(struct atm_vcc *vcc,int level,int optname,
 362             void __user *optval,int optlen);
 363         int (*send)(struct atm_vcc *vcc,struct sk_buff *skb);
 364         int (*send_oam)(struct atm_vcc *vcc,void *cell,int flags);
 365         void (*phy_put)(struct atm_dev *dev,unsigned char value,
 366             unsigned long addr);
 367         unsigned char (*phy_get)(struct atm_dev *dev,unsigned long addr);
 368         int (*change_qos)(struct atm_vcc *vcc,struct atm_qos *qos,int flags);
 369         int (*proc_read)(struct atm_dev *dev,loff_t *pos,char *page);
 370         struct module *owner;
 371 };
 372
 373 struct atmphy_ops {
 374         int (*start)(struct atm_dev *dev);
 375         int (*ioctl)(struct atm_dev *dev,unsigned int cmd,void __user *arg);
 376         void (*interrupt)(struct atm_dev *dev);
 377         int (*stop)(struct atm_dev *dev);
 378 };
 379
 380 struct atm_skb_data {
 381         struct atm_vcc  *vcc;           /* ATM VCC */
 382         unsigned long   atm_options;    /* ATM layer options */
 383 };
 384
 385 #define VCC_HTABLE_SIZE 32
 386
 387 extern struct hlist_head vcc_hash[VCC_HTABLE_SIZE];
 388 extern rwlock_t vcc_sklist_lock;
 389
 390 #define ATM_SKB(skb) (((struct atm_skb_data *) (skb)->cb))
 391
 392 struct atm_dev *atm_dev_register(const char *type,const struct atmdev_ops *ops,
 393     int number,unsigned long *flags); /* number == -1: pick first available */
 394 struct atm_dev *atm_dev_lookup(int number);
 395 void atm_dev_deregister(struct atm_dev *dev);
 396 void shutdown_atm_dev(struct atm_dev *dev);
 397 void vcc_insert_socket(struct sock *sk);
 398
 399
 400 /*
 401  * This is approximately the algorithm used by alloc_skb.
 402  *
 403  */
 404
 405 static inline int atm_guess_pdu2truesize(int size)
 406 {
 407         return (SKB_DATA_ALIGN(size) + sizeof(struct skb_shared_info));
 408 }
 409
 410
 411 static inline void atm_force_charge(struct atm_vcc *vcc,int truesize)
 412 {
 413         atomic_add(truesize, &vcc->sk->sk_rmem_alloc);
 414 }
 415
 416
 417 static inline void atm_return(struct atm_vcc *vcc,int truesize)
 418 {
 419         atomic_sub(truesize, &vcc->sk->sk_rmem_alloc);
 420 }
 421
 422
 423 static inline int atm_may_send(struct atm_vcc *vcc,unsigned int size)
 424 {
 425         return (size + atomic_read(&vcc->sk->sk_wmem_alloc)) <
 426                vcc->sk->sk_sndbuf;
 427 }
 428
 429
 430 static inline void atm_dev_hold(struct atm_dev *dev)
 431 {
 432         atomic_inc(&dev->refcnt);
 433 }
 434
 435
 436 static inline void atm_dev_put(struct atm_dev *dev)
 437 {
 438         atomic_dec(&dev->refcnt);
 439
 440         if ((atomic_read(&dev->refcnt) == 1) &&
 441             test_bit(ATM_DF_CLOSE,&dev->flags))
 442                 shutdown_atm_dev(dev);
 443 }
 444
 445
 446 int atm_charge(struct atm_vcc *vcc,int truesize);
 447 struct sk_buff *atm_alloc_charge(struct atm_vcc *vcc,int pdu_size,
 448     int gfp_flags);
 449 int atm_pcr_goal(struct atm_trafprm *tp);
 450
 451 void vcc_release_async(struct atm_vcc *vcc, int reply);
 452
 453 struct atm_ioctl {
 454         struct module *owner;
 455         /* A module reference is kept if appropriate over this call.
 456          * Return -ENOIOCTLCMD if you don't handle it. */
 457         int (*ioctl)(struct socket *, unsigned int cmd, unsigned long arg);
 458         struct list_head list;
 459 };
 460
 461 /**
 462  * register_atm_ioctl - register handler for ioctl operations
 463  *
 464  * Special (non-device) handlers of ioctl's should
 465  * register here. If you're a normal device, you should
 466  * set .ioctl in your atmdev_ops instead.
 467  */
 468 void register_atm_ioctl(struct atm_ioctl *);
 469
 470 /**
 471  * deregister_atm_ioctl - remove the ioctl handler
 472  */
 473 void deregister_atm_ioctl(struct atm_ioctl *);
 474
 475 #endif /* __KERNEL__ */
 476
 477 #endif