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