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 _UAPILINUX_ATMDEV_H
7 #define _UAPILINUX_ATMDEV_H
8 
9 
10 #include <linux/atmapi.h>
11 #include <linux/atm.h>
12 #include <linux/atmioc.h>
13 
14 
15 #define ESI_LEN		6
16 
17 #define ATM_OC3_PCR	(155520000/270*260/8/53)
18 			/* OC3 link rate:  155520000 bps
19 			   SONET overhead: /270*260 (9 section, 1 path)
20 			   bits per cell:  /8/53
21 			   max cell rate:  353207.547 cells/sec */
22 #define ATM_25_PCR	((25600000/8-8000)/54)
23 			/* 25 Mbps ATM cell rate (59111) */
24 #define ATM_OC12_PCR	(622080000/1080*1040/8/53)
25 			/* OC12 link rate: 622080000 bps
26 			   SONET overhead: /1080*1040
27 			   bits per cell:  /8/53
28 			   max cell rate:  1412830.188 cells/sec */
29 #define ATM_DS3_PCR	(8000*12)
30 			/* DS3: 12 cells in a 125 usec time slot */
31 
32 
33 #define __AAL_STAT_ITEMS \
34     __HANDLE_ITEM(tx);			/* TX okay */ \
35     __HANDLE_ITEM(tx_err);		/* TX errors */ \
36     __HANDLE_ITEM(rx);			/* RX okay */ \
37     __HANDLE_ITEM(rx_err);		/* RX errors */ \
38     __HANDLE_ITEM(rx_drop);		/* RX out of memory */
39 
40 struct atm_aal_stats {
41 #define __HANDLE_ITEM(i) int i
42 	__AAL_STAT_ITEMS
43 #undef __HANDLE_ITEM
44 };
45 
46 
47 struct atm_dev_stats {
48 	struct atm_aal_stats aal0;
49 	struct atm_aal_stats aal34;
50 	struct atm_aal_stats aal5;
51 } __ATM_API_ALIGN;
52 
53 
54 #define ATM_GETLINKRATE	_IOW('a',ATMIOC_ITF+1,struct atmif_sioc)
55 					/* get link rate */
56 #define ATM_GETNAMES	_IOW('a',ATMIOC_ITF+3,struct atm_iobuf)
57 					/* get interface names (numbers) */
58 #define ATM_GETTYPE	_IOW('a',ATMIOC_ITF+4,struct atmif_sioc)
59 					/* get interface type name */
60 #define ATM_GETESI	_IOW('a',ATMIOC_ITF+5,struct atmif_sioc)
61 					/* get interface ESI */
62 #define ATM_GETADDR	_IOW('a',ATMIOC_ITF+6,struct atmif_sioc)
63 					/* get itf's local ATM addr. list */
64 #define ATM_RSTADDR	_IOW('a',ATMIOC_ITF+7,struct atmif_sioc)
65 					/* reset itf's ATM address list */
66 #define ATM_ADDADDR	_IOW('a',ATMIOC_ITF+8,struct atmif_sioc)
67 					/* add a local ATM address */
68 #define ATM_DELADDR	_IOW('a',ATMIOC_ITF+9,struct atmif_sioc)
69 					/* remove a local ATM address */
70 #define ATM_GETCIRANGE	_IOW('a',ATMIOC_ITF+10,struct atmif_sioc)
71 					/* get connection identifier range */
72 #define ATM_SETCIRANGE	_IOW('a',ATMIOC_ITF+11,struct atmif_sioc)
73 					/* set connection identifier range */
74 #define ATM_SETESI	_IOW('a',ATMIOC_ITF+12,struct atmif_sioc)
75 					/* set interface ESI */
76 #define ATM_SETESIF	_IOW('a',ATMIOC_ITF+13,struct atmif_sioc)
77 					/* force interface ESI */
78 #define ATM_ADDLECSADDR	_IOW('a', ATMIOC_ITF+14, struct atmif_sioc)
79 					/* register a LECS address */
80 #define ATM_DELLECSADDR	_IOW('a', ATMIOC_ITF+15, struct atmif_sioc)
81 					/* unregister a LECS address */
82 #define ATM_GETLECSADDR	_IOW('a', ATMIOC_ITF+16, struct atmif_sioc)
83 					/* retrieve LECS address(es) */
84 
85 #define ATM_GETSTAT	_IOW('a',ATMIOC_SARCOM+0,struct atmif_sioc)
86 					/* get AAL layer statistics */
87 #define ATM_GETSTATZ	_IOW('a',ATMIOC_SARCOM+1,struct atmif_sioc)
88 					/* get AAL layer statistics and zero */
89 #define ATM_GETLOOP	_IOW('a',ATMIOC_SARCOM+2,struct atmif_sioc)
90 					/* get loopback mode */
91 #define ATM_SETLOOP	_IOW('a',ATMIOC_SARCOM+3,struct atmif_sioc)
92 					/* set loopback mode */
93 #define ATM_QUERYLOOP	_IOW('a',ATMIOC_SARCOM+4,struct atmif_sioc)
94 					/* query supported loopback modes */
95 #define ATM_SETSC	_IOW('a',ATMIOC_SPECIAL+1,int)
96 					/* enable or disable single-copy */
97 #define ATM_SETBACKEND	_IOW('a',ATMIOC_SPECIAL+2,atm_backend_t)
98 					/* set backend handler */
99 #define ATM_NEWBACKENDIF _IOW('a',ATMIOC_SPECIAL+3,atm_backend_t)
100 					/* use backend to make new if */
101 #define ATM_ADDPARTY  	_IOW('a', ATMIOC_SPECIAL+4,struct atm_iobuf)
102  					/* add party to p2mp call */
103 #ifdef CONFIG_COMPAT
104 /* It actually takes struct sockaddr_atmsvc, not struct atm_iobuf */
105 #define COMPAT_ATM_ADDPARTY  	_IOW('a', ATMIOC_SPECIAL+4,struct compat_atm_iobuf)
106 #endif
107 #define ATM_DROPPARTY 	_IOW('a', ATMIOC_SPECIAL+5,int)
108 					/* drop party from p2mp call */
109 
110 /*
111  * These are backend handkers that can be set via the ATM_SETBACKEND call
112  * above.  In the future we may support dynamic loading of these - for now,
113  * they're just being used to share the ATMIOC_BACKEND ioctls
114  */
115 #define ATM_BACKEND_RAW		0
116 #define ATM_BACKEND_PPP		1	/* PPPoATM - RFC2364 */
117 #define ATM_BACKEND_BR2684	2	/* Bridged RFC1483/2684 */
118 
119 /* for ATM_GETTYPE */
120 #define ATM_ITFTYP_LEN	8	/* maximum length of interface type name */
121 
122 /*
123  * Loopback modes for ATM_{PHY,SAR}_{GET,SET}LOOP
124  */
125 
126 /* Point of loopback				CPU-->SAR-->PHY-->line--> ... */
127 #define __ATM_LM_NONE	0	/* no loop back     ^     ^     ^      ^      */
128 #define __ATM_LM_AAL	1	/* loop back PDUs --'     |     |      |      */
129 #define __ATM_LM_ATM	2	/* loop back ATM cells ---'     |      |      */
130 /* RESERVED		4	loop back on PHY side  ---'		      */
131 #define __ATM_LM_PHY	8	/* loop back bits (digital) ----'      |      */
132 #define __ATM_LM_ANALOG 16	/* loop back the analog signal --------'      */
133 
134 /* Direction of loopback */
135 #define __ATM_LM_MKLOC(n)	((n))	    /* Local (i.e. loop TX to RX) */
136 #define __ATM_LM_MKRMT(n)	((n) << 8)  /* Remote (i.e. loop RX to TX) */
137 
138 #define __ATM_LM_XTLOC(n)	((n) & 0xff)
139 #define __ATM_LM_XTRMT(n)	(((n) >> 8) & 0xff)
140 
141 #define ATM_LM_NONE	0	/* no loopback */
142 
143 #define ATM_LM_LOC_AAL	__ATM_LM_MKLOC(__ATM_LM_AAL)
144 #define ATM_LM_LOC_ATM	__ATM_LM_MKLOC(__ATM_LM_ATM)
145 #define ATM_LM_LOC_PHY	__ATM_LM_MKLOC(__ATM_LM_PHY)
146 #define ATM_LM_LOC_ANALOG __ATM_LM_MKLOC(__ATM_LM_ANALOG)
147 
148 #define ATM_LM_RMT_AAL	__ATM_LM_MKRMT(__ATM_LM_AAL)
149 #define ATM_LM_RMT_ATM	__ATM_LM_MKRMT(__ATM_LM_ATM)
150 #define ATM_LM_RMT_PHY	__ATM_LM_MKRMT(__ATM_LM_PHY)
151 #define ATM_LM_RMT_ANALOG __ATM_LM_MKRMT(__ATM_LM_ANALOG)
152 
153 /*
154  * Note: ATM_LM_LOC_* and ATM_LM_RMT_* can be combined, provided that
155  * __ATM_LM_XTLOC(x) <= __ATM_LM_XTRMT(x)
156  */
157 
158 
159 struct atm_iobuf {
160 	int length;
161 	void __user *buffer;
162 };
163 
164 /* for ATM_GETCIRANGE / ATM_SETCIRANGE */
165 
166 #define ATM_CI_MAX      -1              /* use maximum range of VPI/VCI */
167 
168 struct atm_cirange {
169 	signed char	vpi_bits;	/* 1..8, ATM_CI_MAX (-1) for maximum */
170 	signed char	vci_bits;	/* 1..16, ATM_CI_MAX (-1) for maximum */
171 };
172 
173 /* for ATM_SETSC; actually taken from the ATM_VF number space */
174 
175 #define ATM_SC_RX	1024		/* enable RX single-copy */
176 #define ATM_SC_TX	2048		/* enable TX single-copy */
177 
178 #define ATM_BACKLOG_DEFAULT 32 /* if we get more, we're likely to time out
179 				  anyway */
180 
181 /* MF: change_qos (Modify) flags */
182 
183 #define ATM_MF_IMMED	 1	/* Block until change is effective */
184 #define ATM_MF_INC_RSV	 2	/* Change reservation on increase */
185 #define ATM_MF_INC_SHP	 4	/* Change shaping on increase */
186 #define ATM_MF_DEC_RSV	 8	/* Change reservation on decrease */
187 #define ATM_MF_DEC_SHP	16	/* Change shaping on decrease */
188 #define ATM_MF_BWD	32	/* Set the backward direction parameters */
189 
190 #define ATM_MF_SET	(ATM_MF_INC_RSV | ATM_MF_INC_SHP | ATM_MF_DEC_RSV | \
191 			  ATM_MF_DEC_SHP | ATM_MF_BWD)
192 
193 /*
194  * ATM_VS_* are used to express VC state in a human-friendly way.
195  */
196 
197 #define ATM_VS_IDLE	0	/* VC is not used */
198 #define ATM_VS_CONNECTED 1	/* VC is connected */
199 #define ATM_VS_CLOSING	2	/* VC is closing */
200 #define ATM_VS_LISTEN	3	/* VC is listening for incoming setups */
201 #define ATM_VS_INUSE	4	/* VC is in use (registered with atmsigd) */
202 #define ATM_VS_BOUND	5	/* VC is bound */
203 
204 #define ATM_VS2TXT_MAP \
205     "IDLE", "CONNECTED", "CLOSING", "LISTEN", "INUSE", "BOUND"
206 
207 #define ATM_VF2TXT_MAP \
208     "ADDR",	"READY",	"PARTIAL",	"REGIS", \
209     "RELEASED", "HASQOS",	"LISTEN",	"META", \
210     "256",	"512",		"1024",		"2048", \
211     "SESSION",	"HASSAP",	"BOUND",	"CLOSE"
212 
213 
214 
215 #endif /* _UAPILINUX_ATMDEV_H */
216