diff options
author | Linus Torvalds <torvalds@ppc970.osdl.org> | 2005-04-16 18:20:36 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@ppc970.osdl.org> | 2005-04-16 18:20:36 -0400 |
commit | 1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 (patch) | |
tree | 0bba044c4ce775e45a88a51686b5d9f90697ea9d /drivers/atm/uPD98401.h |
Linux-2.6.12-rc2v2.6.12-rc2
Initial git repository build. I'm not bothering with the full history,
even though we have it. We can create a separate "historical" git
archive of that later if we want to, and in the meantime it's about
3.2GB when imported into git - space that would just make the early
git days unnecessarily complicated, when we don't have a lot of good
infrastructure for it.
Let it rip!
Diffstat (limited to 'drivers/atm/uPD98401.h')
-rw-r--r-- | drivers/atm/uPD98401.h | 292 |
1 files changed, 292 insertions, 0 deletions
diff --git a/drivers/atm/uPD98401.h b/drivers/atm/uPD98401.h new file mode 100644 index 000000000000..0ab36503a4b7 --- /dev/null +++ b/drivers/atm/uPD98401.h | |||
@@ -0,0 +1,292 @@ | |||
1 | /* drivers/atm/uPD98401.h - NEC uPD98401 (SAR) declarations */ | ||
2 | |||
3 | /* Written 1995 by Werner Almesberger, EPFL LRC */ | ||
4 | |||
5 | |||
6 | #ifndef DRIVERS_ATM_uPD98401_H | ||
7 | #define DRIVERS_ATM_uPD98401_H | ||
8 | |||
9 | |||
10 | #define MAX_CRAM_SIZE (1 << 18) /* 2^18 words */ | ||
11 | #define RAM_INCREMENT 1024 /* check in 4 kB increments */ | ||
12 | |||
13 | #define uPD98401_PORTS 0x24 /* probably more ? */ | ||
14 | |||
15 | |||
16 | /* | ||
17 | * Commands | ||
18 | */ | ||
19 | |||
20 | #define uPD98401_OPEN_CHAN 0x20000000 /* open channel */ | ||
21 | #define uPD98401_CHAN_ADDR 0x0003fff8 /* channel address */ | ||
22 | #define uPD98401_CHAN_ADDR_SHIFT 3 | ||
23 | #define uPD98401_CLOSE_CHAN 0x24000000 /* close channel */ | ||
24 | #define uPD98401_CHAN_RT 0x02000000 /* RX/TX (0 TX, 1 RX) */ | ||
25 | #define uPD98401_DEACT_CHAN 0x28000000 /* deactivate channel */ | ||
26 | #define uPD98401_TX_READY 0x30000000 /* TX ready */ | ||
27 | #define uPD98401_ADD_BAT 0x34000000 /* add batches */ | ||
28 | #define uPD98401_POOL 0x000f0000 /* pool number */ | ||
29 | #define uPD98401_POOL_SHIFT 16 | ||
30 | #define uPD98401_POOL_NUMBAT 0x0000ffff /* number of batches */ | ||
31 | #define uPD98401_NOP 0x3f000000 /* NOP */ | ||
32 | #define uPD98401_IND_ACC 0x00000000 /* Indirect Access */ | ||
33 | #define uPD98401_IA_RW 0x10000000 /* Read/Write (0 W, 1 R) */ | ||
34 | #define uPD98401_IA_B3 0x08000000 /* Byte select, 1 enable */ | ||
35 | #define uPD98401_IA_B2 0x04000000 | ||
36 | #define uPD98401_IA_B1 0x02000000 | ||
37 | #define uPD98401_IA_B0 0x01000000 | ||
38 | #define uPD98401_IA_BALL 0x0f000000 /* whole longword */ | ||
39 | #define uPD98401_IA_TGT 0x000c0000 /* Target */ | ||
40 | #define uPD98401_IA_TGT_SHIFT 18 | ||
41 | #define uPD98401_IA_TGT_CM 0 /* - Control Memory */ | ||
42 | #define uPD98401_IA_TGT_SAR 1 /* - uPD98401 registers */ | ||
43 | #define uPD98401_IA_TGT_PHY 3 /* - PHY device */ | ||
44 | #define uPD98401_IA_ADDR 0x0003ffff | ||
45 | |||
46 | /* | ||
47 | * Command Register Status | ||
48 | */ | ||
49 | |||
50 | #define uPD98401_BUSY 0x80000000 /* SAR is busy */ | ||
51 | #define uPD98401_LOCKED 0x40000000 /* SAR is locked by other CPU */ | ||
52 | |||
53 | /* | ||
54 | * Indications | ||
55 | */ | ||
56 | |||
57 | /* Normal (AAL5) Receive Indication */ | ||
58 | #define uPD98401_AAL5_UINFO 0xffff0000 /* user-supplied information */ | ||
59 | #define uPD98401_AAL5_UINFO_SHIFT 16 | ||
60 | #define uPD98401_AAL5_SIZE 0x0000ffff /* PDU size (in _CELLS_ !!) */ | ||
61 | #define uPD98401_AAL5_CHAN 0x7fff0000 /* Channel number */ | ||
62 | #define uPD98401_AAL5_CHAN_SHIFT 16 | ||
63 | #define uPD98401_AAL5_ERR 0x00008000 /* Error indication */ | ||
64 | #define uPD98401_AAL5_CI 0x00004000 /* Congestion Indication */ | ||
65 | #define uPD98401_AAL5_CLP 0x00002000 /* CLP (>= 1 cell had CLP=1) */ | ||
66 | #define uPD98401_AAL5_ES 0x00000f00 /* Error Status */ | ||
67 | #define uPD98401_AAL5_ES_SHIFT 8 | ||
68 | #define uPD98401_AAL5_ES_NONE 0 /* No error */ | ||
69 | #define uPD98401_AAL5_ES_FREE 1 /* Receiver free buf underflow */ | ||
70 | #define uPD98401_AAL5_ES_FIFO 2 /* Receiver FIFO overrun */ | ||
71 | #define uPD98401_AAL5_ES_TOOBIG 3 /* Maximum length violation */ | ||
72 | #define uPD98401_AAL5_ES_CRC 4 /* CRC error */ | ||
73 | #define uPD98401_AAL5_ES_ABORT 5 /* User abort */ | ||
74 | #define uPD98401_AAL5_ES_LENGTH 6 /* Length violation */ | ||
75 | #define uPD98401_AAL5_ES_T1 7 /* T1 error (timeout) */ | ||
76 | #define uPD98401_AAL5_ES_DEACT 8 /* Deactivated with DEACT_CHAN */ | ||
77 | #define uPD98401_AAL5_POOL 0x0000001f /* Free buffer pool number */ | ||
78 | |||
79 | /* Raw Cell Indication */ | ||
80 | #define uPD98401_RAW_UINFO uPD98401_AAL5_UINFO | ||
81 | #define uPD98401_RAW_UINFO_SHIFT uPD98401_AAL5_UINFO_SHIFT | ||
82 | #define uPD98401_RAW_HEC 0x000000ff /* HEC */ | ||
83 | #define uPD98401_RAW_CHAN uPD98401_AAL5_CHAN | ||
84 | #define uPD98401_RAW_CHAN_SHIFT uPD98401_AAL5_CHAN_SHIFT | ||
85 | |||
86 | /* Transmit Indication */ | ||
87 | #define uPD98401_TXI_CONN 0x7fff0000 /* Connection Number */ | ||
88 | #define uPD98401_TXI_CONN_SHIFT 16 | ||
89 | #define uPD98401_TXI_ACTIVE 0x00008000 /* Channel remains active */ | ||
90 | #define uPD98401_TXI_PQP 0x00007fff /* Packet Queue Pointer */ | ||
91 | |||
92 | /* | ||
93 | * Directly Addressable Registers | ||
94 | */ | ||
95 | |||
96 | #define uPD98401_GMR 0x00 /* General Mode Register */ | ||
97 | #define uPD98401_GSR 0x01 /* General Status Register */ | ||
98 | #define uPD98401_IMR 0x02 /* Interrupt Mask Register */ | ||
99 | #define uPD98401_RQU 0x03 /* Receive Queue Underrun */ | ||
100 | #define uPD98401_RQA 0x04 /* Receive Queue Alert */ | ||
101 | #define uPD98401_ADDR 0x05 /* Last Burst Address */ | ||
102 | #define uPD98401_VER 0x06 /* Version Number */ | ||
103 | #define uPD98401_SWR 0x07 /* Software Reset */ | ||
104 | #define uPD98401_CMR 0x08 /* Command Register */ | ||
105 | #define uPD98401_CMR_L 0x09 /* Command Register and Lock/Unlock */ | ||
106 | #define uPD98401_CER 0x0a /* Command Extension Register */ | ||
107 | #define uPD98401_CER_L 0x0b /* Command Ext Reg and Lock/Unlock */ | ||
108 | |||
109 | #define uPD98401_MSH(n) (0x10+(n)) /* Mailbox n Start Address High */ | ||
110 | #define uPD98401_MSL(n) (0x14+(n)) /* Mailbox n Start Address High */ | ||
111 | #define uPD98401_MBA(n) (0x18+(n)) /* Mailbox n Bottom Address */ | ||
112 | #define uPD98401_MTA(n) (0x1c+(n)) /* Mailbox n Tail Address */ | ||
113 | #define uPD98401_MWA(n) (0x20+(n)) /* Mailbox n Write Address */ | ||
114 | |||
115 | /* GMR is at 0x00 */ | ||
116 | #define uPD98401_GMR_ONE 0x80000000 /* Must be set to one */ | ||
117 | #define uPD98401_GMR_SLM 0x40000000 /* Address mode (0 word, 1 byte) */ | ||
118 | #define uPD98401_GMR_CPE 0x00008000 /* Control Memory Parity Enable */ | ||
119 | #define uPD98401_GMR_LP 0x00004000 /* Loopback */ | ||
120 | #define uPD98401_GMR_WA 0x00002000 /* Early Bus Write Abort/RDY */ | ||
121 | #define uPD98401_GMR_RA 0x00001000 /* Early Read Abort/RDY */ | ||
122 | #define uPD98401_GMR_SZ 0x00000f00 /* Burst Size Enable */ | ||
123 | #define uPD98401_BURST16 0x00000800 /* 16-word burst */ | ||
124 | #define uPD98401_BURST8 0x00000400 /* 8-word burst */ | ||
125 | #define uPD98401_BURST4 0x00000200 /* 4-word burst */ | ||
126 | #define uPD98401_BURST2 0x00000100 /* 2-word burst */ | ||
127 | #define uPD98401_GMR_AD 0x00000080 /* Address (burst resolution) Disable */ | ||
128 | #define uPD98401_GMR_BO 0x00000040 /* Byte Order (0 little, 1 big) */ | ||
129 | #define uPD98401_GMR_PM 0x00000020 /* Bus Parity Mode (0 byte, 1 word)*/ | ||
130 | #define uPD98401_GMR_PC 0x00000010 /* Bus Parity Control (0even,1odd) */ | ||
131 | #define uPD98401_GMR_BPE 0x00000008 /* Bus Parity Enable */ | ||
132 | #define uPD98401_GMR_DR 0x00000004 /* Receive Drop Mode (0drop,1don't)*/ | ||
133 | #define uPD98401_GMR_SE 0x00000002 /* Shapers Enable */ | ||
134 | #define uPD98401_GMR_RE 0x00000001 /* Receiver Enable */ | ||
135 | |||
136 | /* GSR is at 0x01, IMR is at 0x02 */ | ||
137 | #define uPD98401_INT_PI 0x80000000 /* PHY interrupt */ | ||
138 | #define uPD98401_INT_RQA 0x40000000 /* Receive Queue Alert */ | ||
139 | #define uPD98401_INT_RQU 0x20000000 /* Receive Queue Underrun */ | ||
140 | #define uPD98401_INT_RD 0x10000000 /* Receiver Deactivated */ | ||
141 | #define uPD98401_INT_SPE 0x08000000 /* System Parity Error */ | ||
142 | #define uPD98401_INT_CPE 0x04000000 /* Control Memory Parity Error */ | ||
143 | #define uPD98401_INT_SBE 0x02000000 /* System Bus Error */ | ||
144 | #define uPD98401_INT_IND 0x01000000 /* Initialization Done */ | ||
145 | #define uPD98401_INT_RCR 0x0000ff00 /* Raw Cell Received */ | ||
146 | #define uPD98401_INT_RCR_SHIFT 8 | ||
147 | #define uPD98401_INT_MF 0x000000f0 /* Mailbox Full */ | ||
148 | #define uPD98401_INT_MF_SHIFT 4 | ||
149 | #define uPD98401_INT_MM 0x0000000f /* Mailbox Modified */ | ||
150 | |||
151 | /* VER is at 0x06 */ | ||
152 | #define uPD98401_MAJOR 0x0000ff00 /* Major revision */ | ||
153 | #define uPD98401_MAJOR_SHIFT 8 | ||
154 | #define uPD98401_MINOR 0x000000ff /* Minor revision */ | ||
155 | |||
156 | /* | ||
157 | * Indirectly Addressable Registers | ||
158 | */ | ||
159 | |||
160 | #define uPD98401_IM(n) (0x40000+(n)) /* Scheduler n I and M */ | ||
161 | #define uPD98401_X(n) (0x40010+(n)) /* Scheduler n X */ | ||
162 | #define uPD98401_Y(n) (0x40020+(n)) /* Scheduler n Y */ | ||
163 | #define uPD98401_PC(n) (0x40030+(n)) /* Scheduler n P, C, p and c */ | ||
164 | #define uPD98401_PS(n) (0x40040+(n)) /* Scheduler n priority and status */ | ||
165 | |||
166 | /* IM contents */ | ||
167 | #define uPD98401_IM_I 0xff000000 /* I */ | ||
168 | #define uPD98401_IM_I_SHIFT 24 | ||
169 | #define uPD98401_IM_M 0x00ffffff /* M */ | ||
170 | |||
171 | /* PC contents */ | ||
172 | #define uPD98401_PC_P 0xff000000 /* P */ | ||
173 | #define uPD98401_PC_P_SHIFT 24 | ||
174 | #define uPD98401_PC_C 0x00ff0000 /* C */ | ||
175 | #define uPD98401_PC_C_SHIFT 16 | ||
176 | #define uPD98401_PC_p 0x0000ff00 /* p */ | ||
177 | #define uPD98401_PC_p_SHIFT 8 | ||
178 | #define uPD98401_PC_c 0x000000ff /* c */ | ||
179 | |||
180 | /* PS contents */ | ||
181 | #define uPD98401_PS_PRIO 0xf0 /* Priority level (0 high, 15 low) */ | ||
182 | #define uPD98401_PS_PRIO_SHIFT 4 | ||
183 | #define uPD98401_PS_S 0x08 /* Scan - must be 0 (internal) */ | ||
184 | #define uPD98401_PS_R 0x04 /* Round Robin (internal) */ | ||
185 | #define uPD98401_PS_A 0x02 /* Active (internal) */ | ||
186 | #define uPD98401_PS_E 0x01 /* Enabled */ | ||
187 | |||
188 | #define uPD98401_TOS 0x40100 /* Top of Stack Control Memory Address */ | ||
189 | #define uPD98401_SMA 0x40200 /* Shapers Control Memory Start Address */ | ||
190 | #define uPD98401_PMA 0x40201 /* Receive Pool Control Memory Start Address */ | ||
191 | #define uPD98401_T1R 0x40300 /* T1 Register */ | ||
192 | #define uPD98401_VRR 0x40301 /* VPI/VCI Reduction Register/Recv. Shutdown */ | ||
193 | #define uPD98401_TSR 0x40302 /* Time-Stamp Register */ | ||
194 | |||
195 | /* VRR is at 0x40301 */ | ||
196 | #define uPD98401_VRR_SDM 0x80000000 /* Shutdown Mode */ | ||
197 | #define uPD98401_VRR_SHIFT 0x000f0000 /* VPI/VCI Shift */ | ||
198 | #define uPD98401_VRR_SHIFT_SHIFT 16 | ||
199 | #define uPD98401_VRR_MASK 0x0000ffff /* VPI/VCI mask */ | ||
200 | |||
201 | /* | ||
202 | * TX packet descriptor | ||
203 | */ | ||
204 | |||
205 | #define uPD98401_TXPD_SIZE 16 /* descriptor size (in bytes) */ | ||
206 | |||
207 | #define uPD98401_TXPD_V 0x80000000 /* Valid bit */ | ||
208 | #define uPD98401_TXPD_DP 0x40000000 /* Descriptor (1) or Pointer (0) */ | ||
209 | #define uPD98401_TXPD_SM 0x20000000 /* Single (1) or Multiple (0) */ | ||
210 | #define uPD98401_TXPD_CLPM 0x18000000 /* CLP mode */ | ||
211 | #define uPD98401_CLPM_0 0 /* 00 CLP = 0 */ | ||
212 | #define uPD98401_CLPM_1 3 /* 11 CLP = 1 */ | ||
213 | #define uPD98401_CLPM_LAST 1 /* 01 CLP unless last cell */ | ||
214 | #define uPD98401_TXPD_CLPM_SHIFT 27 | ||
215 | #define uPD98401_TXPD_PTI 0x07000000 /* PTI pattern */ | ||
216 | #define uPD98401_TXPD_PTI_SHIFT 24 | ||
217 | #define uPD98401_TXPD_GFC 0x00f00000 /* GFC pattern */ | ||
218 | #define uPD98401_TXPD_GFC_SHIFT 20 | ||
219 | #define uPD98401_TXPD_C10 0x00040000 /* insert CRC-10 */ | ||
220 | #define uPD98401_TXPD_AAL5 0x00020000 /* AAL5 processing */ | ||
221 | #define uPD98401_TXPD_MB 0x00010000 /* TX mailbox number */ | ||
222 | #define uPD98401_TXPD_UU 0x0000ff00 /* CPCS-UU */ | ||
223 | #define uPD98401_TXPD_UU_SHIFT 8 | ||
224 | #define uPD98401_TXPD_CPI 0x000000ff /* CPI */ | ||
225 | |||
226 | /* | ||
227 | * TX buffer descriptor | ||
228 | */ | ||
229 | |||
230 | #define uPD98401_TXBD_SIZE 8 /* descriptor size (in bytes) */ | ||
231 | |||
232 | #define uPD98401_TXBD_LAST 0x80000000 /* last buffer in packet */ | ||
233 | |||
234 | /* | ||
235 | * TX VC table | ||
236 | */ | ||
237 | |||
238 | /* 1st word has the same structure as in a TX packet descriptor */ | ||
239 | #define uPD98401_TXVC_L 0x80000000 /* last buffer */ | ||
240 | #define uPD98401_TXVC_SHP 0x0f000000 /* shaper number */ | ||
241 | #define uPD98401_TXVC_SHP_SHIFT 24 | ||
242 | #define uPD98401_TXVC_VPI 0x00ff0000 /* VPI */ | ||
243 | #define uPD98401_TXVC_VPI_SHIFT 16 | ||
244 | #define uPD98401_TXVC_VCI 0x0000ffff /* VCI */ | ||
245 | #define uPD98401_TXVC_QRP 6 /* Queue Read Pointer is in word 6 */ | ||
246 | |||
247 | /* | ||
248 | * RX free buffer pools descriptor | ||
249 | */ | ||
250 | |||
251 | #define uPD98401_RXFP_ALERT 0x70000000 /* low water mark */ | ||
252 | #define uPD98401_RXFP_ALERT_SHIFT 28 | ||
253 | #define uPD98401_RXFP_BFSZ 0x0f000000 /* buffer size, 64*2^n */ | ||
254 | #define uPD98401_RXFP_BFSZ_SHIFT 24 | ||
255 | #define uPD98401_RXFP_BTSZ 0x00ff0000 /* batch size, n+1 */ | ||
256 | #define uPD98401_RXFP_BTSZ_SHIFT 16 | ||
257 | #define uPD98401_RXFP_REMAIN 0x0000ffff /* remaining batches in pool */ | ||
258 | |||
259 | /* | ||
260 | * RX VC table | ||
261 | */ | ||
262 | |||
263 | #define uPD98401_RXVC_BTSZ 0xff000000 /* remaining free buffers in batch */ | ||
264 | #define uPD98401_RXVC_BTSZ_SHIFT 24 | ||
265 | #define uPD98401_RXVC_MB 0x00200000 /* RX mailbox number */ | ||
266 | #define uPD98401_RXVC_POOL 0x001f0000 /* free buffer pool number */ | ||
267 | #define uPD98401_RXVC_POOL_SHIFT 16 | ||
268 | #define uPD98401_RXVC_UINFO 0x0000ffff /* user-supplied information */ | ||
269 | #define uPD98401_RXVC_T1 0xffff0000 /* T1 timestamp */ | ||
270 | #define uPD98401_RXVC_T1_SHIFT 16 | ||
271 | #define uPD98401_RXVC_PR 0x00008000 /* Packet Reception, 1 if busy */ | ||
272 | #define uPD98401_RXVC_DR 0x00004000 /* FIFO Drop */ | ||
273 | #define uPD98401_RXVC_OD 0x00001000 /* Drop OAM cells */ | ||
274 | #define uPD98401_RXVC_AR 0x00000800 /* AAL5 or raw cell; 1 if AAL5 */ | ||
275 | #define uPD98401_RXVC_MAXSEG 0x000007ff /* max number of segments per PDU */ | ||
276 | #define uPD98401_RXVC_REM 0xfffe0000 /* remaining words in curr buffer */ | ||
277 | #define uPD98401_RXVC_REM_SHIFT 17 | ||
278 | #define uPD98401_RXVC_CLP 0x00010000 /* CLP received */ | ||
279 | #define uPD98401_RXVC_BFA 0x00008000 /* Buffer Assigned */ | ||
280 | #define uPD98401_RXVC_BTA 0x00004000 /* Batch Assigned */ | ||
281 | #define uPD98401_RXVC_CI 0x00002000 /* Congestion Indication */ | ||
282 | #define uPD98401_RXVC_DD 0x00001000 /* Dropping incoming cells */ | ||
283 | #define uPD98401_RXVC_DP 0x00000800 /* like PR ? */ | ||
284 | #define uPD98401_RXVC_CURSEG 0x000007ff /* Current Segment count */ | ||
285 | |||
286 | /* | ||
287 | * RX lookup table | ||
288 | */ | ||
289 | |||
290 | #define uPD98401_RXLT_ENBL 0x8000 /* Enable */ | ||
291 | |||
292 | #endif | ||