atmdev.h 16 KB

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