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