atmdev.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:15k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

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