File: /usr/include/linux/atm.h
1 /* atm.h - general ATM declarations */
2
3 /* Written 1995-2000 by Werner Almesberger, EPFL LRC/ICA */
4
5
6 /*
7 * WARNING: User-space programs should not #include <linux/atm.h> directly.
8 * Instead, #include <atm.h>
9 */
10
11 #ifndef _LINUX_ATM_H
12 #define _LINUX_ATM_H
13
14 /*
15 * BEGIN_xx and END_xx markers are used for automatic generation of
16 * documentation. Do not change them.
17 */
18
19 #ifdef __KERNEL__
20 #include <linux/socket.h>
21 #include <linux/types.h>
22 #endif
23 #include <linux/atmapi.h>
24 #include <linux/atmsap.h>
25 #include <linux/atmioc.h>
26
27
28 /* general ATM constants */
29 #define ATM_CELL_SIZE 53 /* ATM cell size incl. header */
30 #define ATM_CELL_PAYLOAD 48 /* ATM payload size */
31 #define ATM_AAL0_SDU 52 /* AAL0 SDU size */
32 #define ATM_MAX_AAL34_PDU 65535 /* maximum AAL3/4 PDU payload */
33 #define ATM_AAL5_TRAILER 8 /* AAL5 trailer size */
34 #define ATM_MAX_AAL5_PDU 65535 /* maximum AAL5 PDU payload */
35 #define ATM_MAX_CDV 9999 /* maximum (default) CDV */
36 #define ATM_NOT_RSV_VCI 32 /* first non-reserved VCI value */
37
38 #define ATM_MAX_VPI 255 /* maximum VPI at the UNI */
39 #define ATM_MAX_VPI_NNI 4096 /* maximum VPI at the NNI */
40 #define ATM_MAX_VCI 65535 /* maximum VCI */
41
42
43 /* "protcol" values for the socket system call */
44 #define ATM_NO_AAL 0 /* AAL not specified */
45 #define ATM_AAL0 13 /* "raw" ATM cells */
46 #define ATM_AAL1 1 /* AAL1 (CBR) */
47 #define ATM_AAL2 2 /* AAL2 (VBR) */
48 #define ATM_AAL34 3 /* AAL3/4 (data) */
49 #define ATM_AAL5 5 /* AAL5 (data) */
50
51 /*
52 * socket option name coding functions
53 *
54 * Note that __SO_ENCODE and __SO_LEVEL are somewhat a hack since the
55 * << 22 only reserves 9 bits for the level. On some architectures
56 * SOL_SOCKET is 0xFFFF, so that's a bit of a problem
57 */
58
59 #define __SO_ENCODE(l,n,t) ((((l) & 0x1FF) << 22) | ((n) << 16) | \
60 sizeof(t))
61 #define __SO_LEVEL_MATCH(c,m) (((c) >> 22) == ((m) & 0x1FF))
62 #define __SO_NUMBER(c) (((c) >> 16) & 0x3f)
63 #define __SO_SIZE(c) ((c) & 0x3fff)
64
65 /*
66 * ATM layer
67 */
68
69 #define SO_SETCLP __SO_ENCODE(SOL_ATM,0,int)
70 /* set CLP bit value - TODO */
71 #define SO_CIRANGE __SO_ENCODE(SOL_ATM,1,struct atm_cirange)
72 /* connection identifier range; socket must be
73 bound or connected */
74 #define SO_ATMQOS __SO_ENCODE(SOL_ATM,2,struct atm_qos)
75 /* Quality of Service setting */
76 #define SO_ATMSAP __SO_ENCODE(SOL_ATM,3,struct atm_sap)
77 /* Service Access Point */
78 #define SO_ATMPVC __SO_ENCODE(SOL_ATM,4,struct sockaddr_atmpvc)
79 /* "PVC" address (also for SVCs); get only */
80
81 /*
82 * Note @@@: since the socket layers don't really distinguish the control and
83 * the data plane but generally seems to be data plane-centric, any layer is
84 * about equally wrong for the SAP. If you have a better idea about this,
85 * please speak up ...
86 */
87
88
89 /* ATM cell header (for AAL0) */
90
91 /* BEGIN_CH */
92 #define ATM_HDR_GFC_MASK 0xf0000000
93 #define ATM_HDR_GFC_SHIFT 28
94 #define ATM_HDR_VPI_MASK 0x0ff00000
95 #define ATM_HDR_VPI_SHIFT 20
96 #define ATM_HDR_VCI_MASK 0x000ffff0
97 #define ATM_HDR_VCI_SHIFT 4
98 #define ATM_HDR_PTI_MASK 0x0000000e
99 #define ATM_HDR_PTI_SHIFT 1
100 #define ATM_HDR_CLP 0x00000001
101 /* END_CH */
102
103
104 /* PTI codings */
105
106 /* BEGIN_PTI */
107 #define ATM_PTI_US0 0 /* user data cell, congestion not exp, SDU-type 0 */
108 #define ATM_PTI_US1 1 /* user data cell, congestion not exp, SDU-type 1 */
109 #define ATM_PTI_UCES0 2 /* user data cell, cong. experienced, SDU-type 0 */
110 #define ATM_PTI_UCES1 3 /* user data cell, cong. experienced, SDU-type 1 */
111 #define ATM_PTI_SEGF5 4 /* segment OAM F5 flow related cell */
112 #define ATM_PTI_E2EF5 5 /* end-to-end OAM F5 flow related cell */
113 #define ATM_PTI_RSV_RM 6 /* reserved for traffic control/resource mgmt */
114 #define ATM_PTI_RSV 7 /* reserved */
115 /* END_PTI */
116
117
118 /*
119 * The following items should stay in linux/atm.h, which should be linked to
120 * netatm/atm.h
121 */
122
123 /* Traffic description */
124
125 #define ATM_NONE 0 /* no traffic */
126 #define ATM_UBR 1
127 #define ATM_CBR 2
128 #define ATM_VBR 3
129 #define ATM_ABR 4
130 #define ATM_ANYCLASS 5 /* compatible with everything */
131
132 #define ATM_MAX_PCR -1 /* maximum available PCR */
133
134 struct atm_trafprm {
135 unsigned char traffic_class; /* traffic class (ATM_UBR, ...) */
136 int max_pcr; /* maximum PCR in cells per second */
137 int pcr; /* desired PCR in cells per second */
138 int min_pcr; /* minimum PCR in cells per second */
139 int max_cdv; /* maximum CDV in microseconds */
140 int max_sdu; /* maximum SDU in bytes */
141 /* extra params for ABR */
142 unsigned int icr; /* Initial Cell Rate (24-bit) */
143 unsigned int tbe; /* Transient Buffer Exposure (24-bit) */
144 unsigned int frtt : 24; /* Fixed Round Trip Time (24-bit) */
145 unsigned int rif : 4; /* Rate Increment Factor (4-bit) */
146 unsigned int rdf : 4; /* Rate Decrease Factor (4-bit) */
147 unsigned int nrm_pres :1; /* nrm present bit */
148 unsigned int trm_pres :1; /* rm present bit */
149 unsigned int adtf_pres :1; /* adtf present bit */
150 unsigned int cdf_pres :1; /* cdf present bit*/
151 unsigned int nrm :3; /* Max # of Cells for each forward RM cell (3-bit) */
152 unsigned int trm :3; /* Time between forward RM cells (3-bit) */
153 unsigned int adtf :10; /* ACR Decrease Time Factor (10-bit) */
154 unsigned int cdf :3; /* Cutoff Decrease Factor (3-bit) */
155 unsigned int spare :9; /* spare bits */
156 };
157
158 struct atm_qos {
159 struct atm_trafprm txtp; /* parameters in TX direction */
160 struct atm_trafprm rxtp __ATM_API_ALIGN;
161 /* parameters in RX direction */
162 unsigned char aal __ATM_API_ALIGN;
163 };
164
165 /* PVC addressing */
166
167 #define ATM_ITF_ANY -1 /* "magic" PVC address values */
168 #define ATM_VPI_ANY -1
169 #define ATM_VCI_ANY -1
170 #define ATM_VPI_UNSPEC -2
171 #define ATM_VCI_UNSPEC -2
172
173
174 struct sockaddr_atmpvc {
175 unsigned short sap_family; /* address family, AF_ATMPVC */
176 struct { /* PVC address */
177 short itf; /* ATM interface */
178 short vpi; /* VPI (only 8 bits at UNI) */
179 int vci; /* VCI (only 16 bits at UNI) */
180 } sap_addr __ATM_API_ALIGN; /* PVC address */
181 };
182
183 /* SVC addressing */
184
185 #define ATM_ESA_LEN 20 /* ATM End System Address length */
186 #define ATM_E164_LEN 12 /* maximum E.164 number length */
187
188 #define ATM_AFI_DCC 0x39 /* DCC ATM Format */
189 #define ATM_AFI_ICD 0x47 /* ICD ATM Format */
190 #define ATM_AFI_E164 0x45 /* E.164 ATM Format */
191 #define ATM_AFI_LOCAL 0x49 /* Local ATM Format */
192
193 #define ATM_AFI_DCC_GROUP 0xBD /* DCC ATM Group Format */
194 #define ATM_AFI_ICD_GROUP 0xC5 /* ICD ATM Group Format */
195 #define ATM_AFI_E164_GROUP 0xC3 /* E.164 ATM Group Format */
196 #define ATM_AFI_LOCAL_GROUP 0xC7 /* Local ATM Group Format */
197
198 #define ATM_LIJ_NONE 0 /* no leaf-initiated join */
199 #define ATM_LIJ 1 /* request joining */
200 #define ATM_LIJ_RPJ 2 /* set to root-prompted join */
201 #define ATM_LIJ_NJ 3 /* set to network join */
202
203
204 struct sockaddr_atmsvc {
205 unsigned short sas_family; /* address family, AF_ATMSVC */
206 struct { /* SVC address */
207 unsigned char prv[ATM_ESA_LEN];/* private ATM address */
208 char pub[ATM_E164_LEN+1]; /* public address (E.164) */
209 /* unused addresses must be bzero'ed */
210 char lij_type; /* role in LIJ call; one of ATM_LIJ* */
211 uint32_t lij_id; /* LIJ call identifier */
212 } sas_addr __ATM_API_ALIGN; /* SVC address */
213 };
214
215
216 static __inline__ int atmsvc_addr_in_use(struct sockaddr_atmsvc addr)
217 {
218 return *addr.sas_addr.prv || *addr.sas_addr.pub;
219 }
220
221
222 static __inline__ int atmpvc_addr_in_use(struct sockaddr_atmpvc addr)
223 {
224 return addr.sap_addr.itf || addr.sap_addr.vpi || addr.sap_addr.vci;
225 }
226
227
228 /*
229 * Some stuff for linux/sockios.h
230 */
231
232 struct atmif_sioc {
233 int number;
234 int length;
235 void *arg;
236 };
237
238
239 #ifdef __KERNEL__
240
241 #include <linux/net.h> /* struct net_proto */
242
243
244 void atmpvc_proto_init(struct net_proto *pro);
245 void atmsvc_proto_init(struct net_proto *pro);
246
247 #endif /* __KERNEL__ */
248
249 #endif
250