atmdev.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:16k
源码类别:

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