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