2 ********************************************************************************
4 ** FILE NAME : arcmsr.h
5 ** BY : Erich Chen, Ching Huang
6 ** Description: SCSI RAID Device Driver for
7 ** ARECA (ARC11XX/ARC12XX/ARC13XX/ARC16XX/ARC188x)
8 ** SATA/SAS RAID HOST Adapter
9 ********************************************************************************
10 ********************************************************************************
11 ** Copyright (C) 2002 - 2012, Areca Technology Corporation All rights reserved.
13 ** Redistribution and use in source and binary forms,with or without
14 ** modification,are permitted provided that the following conditions
16 ** 1. Redistributions of source code must retain the above copyright
17 ** notice,this list of conditions and the following disclaimer.
18 ** 2. Redistributions in binary form must reproduce the above copyright
19 ** notice,this list of conditions and the following disclaimer in the
20 ** documentation and/or other materials provided with the distribution.
21 ** 3. The name of the author may not be used to endorse or promote products
22 ** derived from this software without specific prior written permission.
24 ** THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25 ** IMPLIED WARRANTIES,INCLUDING,BUT NOT LIMITED TO,THE IMPLIED WARRANTIES
26 ** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27 ** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,INDIRECT,
28 ** INCIDENTAL,SPECIAL,EXEMPLARY,OR CONSEQUENTIAL DAMAGES(INCLUDING,BUT
29 ** NOT LIMITED TO,PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 ** DATA,OR PROFITS; OR BUSINESS INTERRUPTION)HOWEVER CAUSED AND ON ANY
31 ** THEORY OF LIABILITY,WHETHER IN CONTRACT,STRICT LIABILITY,OR TORT
32 **(INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN ANY WAY OUT OF THE USE OF
33 ** THIS SOFTWARE,EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 **************************************************************************
37 #define ARCMSR_SCSI_INITIATOR_ID 255
38 #define ARCMSR_DEV_SECTOR_SIZE 512
39 #define ARCMSR_MAX_XFER_SECTORS 4096
40 #define ARCMSR_MAX_TARGETID 17 /*16 max target id + 1*/
41 #define ARCMSR_MAX_TARGETLUN 8 /*8*/
42 #define ARCMSR_MAX_CHIPTYPE_NUM 4
43 #define ARCMSR_MAX_OUTSTANDING_CMD 256
44 #define ARCMSR_MAX_START_JOB 256
45 #define ARCMSR_MAX_CMD_PERLUN ARCMSR_MAX_OUTSTANDING_CMD
46 #define ARCMSR_MAX_FREESRB_NUM 384
47 #define ARCMSR_MAX_QBUFFER 4096 /* ioctl QBUFFER */
48 #define ARCMSR_MAX_SG_ENTRIES 38 /* max 38*/
49 #define ARCMSR_MAX_ADAPTER 4
50 #define ARCMSR_RELEASE_SIMQ_LEVEL 230
51 #define ARCMSR_MAX_HBB_POSTQUEUE 264 /* (ARCMSR_MAX_OUTSTANDING_CMD+8) */
52 #define ARCMSR_MAX_HBD_POSTQUEUE 256
53 #define ARCMSR_TIMEOUT_DELAY 60 /* in sec */
55 *********************************************************************
64 # define INTR_ENTROPY 0
68 #define offsetof(type, member) ((size_t)(&((type *)0)->member))
71 #if __FreeBSD_version >= 500005
72 #define ARCMSR_LOCK_INIT(l, s) mtx_init(l, s, NULL, MTX_DEF)
73 #define ARCMSR_LOCK_DESTROY(l) mtx_destroy(l)
74 #define ARCMSR_LOCK_ACQUIRE(l) mtx_lock(l)
75 #define ARCMSR_LOCK_RELEASE(l) mtx_unlock(l)
76 #define ARCMSR_LOCK_TRY(l) mtx_trylock(l)
77 #define arcmsr_htole32(x) htole32(x)
78 typedef struct mtx arcmsr_lock_t;
80 #define ARCMSR_LOCK_INIT(l, s) simple_lock_init(l)
81 #define ARCMSR_LOCK_DESTROY(l)
82 #define ARCMSR_LOCK_ACQUIRE(l) simple_lock(l)
83 #define ARCMSR_LOCK_RELEASE(l) simple_unlock(l)
84 #define ARCMSR_LOCK_TRY(l) simple_lock_try(l)
85 #define arcmsr_htole32(x) (x)
86 typedef struct simplelock arcmsr_lock_t;
90 **********************************************************************************
92 **********************************************************************************
94 #define PCI_VENDOR_ID_ARECA 0x17D3 /* Vendor ID */
95 #define PCI_DEVICE_ID_ARECA_1110 0x1110 /* Device ID */
96 #define PCI_DEVICE_ID_ARECA_1120 0x1120 /* Device ID */
97 #define PCI_DEVICE_ID_ARECA_1130 0x1130 /* Device ID */
98 #define PCI_DEVICE_ID_ARECA_1160 0x1160 /* Device ID */
99 #define PCI_DEVICE_ID_ARECA_1170 0x1170 /* Device ID */
100 #define PCI_DEVICE_ID_ARECA_1200 0x1200 /* Device ID */
101 #define PCI_DEVICE_ID_ARECA_1201 0x1201 /* Device ID */
102 #define PCI_DEVICE_ID_ARECA_1210 0x1210 /* Device ID */
103 #define PCI_DEVICE_ID_ARECA_1212 0x1212 /* Device ID */
104 #define PCI_DEVICE_ID_ARECA_1214 0x1214 /* Device ID */
105 #define PCI_DEVICE_ID_ARECA_1220 0x1220 /* Device ID */
106 #define PCI_DEVICE_ID_ARECA_1222 0x1222 /* Device ID */
107 #define PCI_DEVICE_ID_ARECA_1230 0x1230 /* Device ID */
108 #define PCI_DEVICE_ID_ARECA_1231 0x1231 /* Device ID */
109 #define PCI_DEVICE_ID_ARECA_1260 0x1260 /* Device ID */
110 #define PCI_DEVICE_ID_ARECA_1261 0x1261 /* Device ID */
111 #define PCI_DEVICE_ID_ARECA_1270 0x1270 /* Device ID */
112 #define PCI_DEVICE_ID_ARECA_1280 0x1280 /* Device ID */
113 #define PCI_DEVICE_ID_ARECA_1380 0x1380 /* Device ID */
114 #define PCI_DEVICE_ID_ARECA_1381 0x1381 /* Device ID */
115 #define PCI_DEVICE_ID_ARECA_1680 0x1680 /* Device ID */
116 #define PCI_DEVICE_ID_ARECA_1681 0x1681 /* Device ID */
117 #define PCI_DEVICE_ID_ARECA_1880 0x1880 /* Device ID */
119 #define ARECA_SUB_DEV_ID_1880 0x1880 /* Subsystem Device ID */
120 #define ARECA_SUB_DEV_ID_1882 0x1882 /* Subsystem Device ID */
121 #define ARECA_SUB_DEV_ID_1883 0x1883 /* Subsystem Device ID */
122 #define ARECA_SUB_DEV_ID_1212 0x1212 /* Subsystem Device ID */
123 #define ARECA_SUB_DEV_ID_1213 0x1213 /* Subsystem Device ID */
124 #define ARECA_SUB_DEV_ID_1222 0x1222 /* Subsystem Device ID */
125 #define ARECA_SUB_DEV_ID_1223 0x1223 /* Subsystem Device ID */
127 #define PCIDevVenIDARC1110 0x111017D3 /* Vendor Device ID */
128 #define PCIDevVenIDARC1120 0x112017D3 /* Vendor Device ID */
129 #define PCIDevVenIDARC1130 0x113017D3 /* Vendor Device ID */
130 #define PCIDevVenIDARC1160 0x116017D3 /* Vendor Device ID */
131 #define PCIDevVenIDARC1170 0x117017D3 /* Vendor Device ID */
132 #define PCIDevVenIDARC1200 0x120017D3 /* Vendor Device ID */
133 #define PCIDevVenIDARC1201 0x120117D3 /* Vendor Device ID */
134 #define PCIDevVenIDARC1210 0x121017D3 /* Vendor Device ID */
135 #define PCIDevVenIDARC1212 0x121217D3 /* Vendor Device ID */
136 #define PCIDevVenIDARC1213 0x121317D3 /* Vendor Device ID */
137 #define PCIDevVenIDARC1214 0x121417D3 /* Vendor Device ID */
138 #define PCIDevVenIDARC1220 0x122017D3 /* Vendor Device ID */
139 #define PCIDevVenIDARC1222 0x122217D3 /* Vendor Device ID */
140 #define PCIDevVenIDARC1223 0x122317D3 /* Vendor Device ID */
141 #define PCIDevVenIDARC1230 0x123017D3 /* Vendor Device ID */
142 #define PCIDevVenIDARC1231 0x123117D3 /* Vendor Device ID */
143 #define PCIDevVenIDARC1260 0x126017D3 /* Vendor Device ID */
144 #define PCIDevVenIDARC1261 0x126117D3 /* Vendor Device ID */
145 #define PCIDevVenIDARC1270 0x127017D3 /* Vendor Device ID */
146 #define PCIDevVenIDARC1280 0x128017D3 /* Vendor Device ID */
147 #define PCIDevVenIDARC1380 0x138017D3 /* Vendor Device ID */
148 #define PCIDevVenIDARC1381 0x138117D3 /* Vendor Device ID */
149 #define PCIDevVenIDARC1680 0x168017D3 /* Vendor Device ID */
150 #define PCIDevVenIDARC1681 0x168117D3 /* Vendor Device ID */
151 #define PCIDevVenIDARC1880 0x188017D3 /* Vendor Device ID */
152 #define PCIDevVenIDARC1882 0x188217D3 /* Vendor Device ID */
155 #define PCIR_BARS 0x10
156 #define PCIR_BAR(x) (PCIR_BARS + (x) * 4)
159 #define PCI_BASE_ADDR0 0x10
160 #define PCI_BASE_ADDR1 0x14
161 #define PCI_BASE_ADDR2 0x18
162 #define PCI_BASE_ADDR3 0x1C
163 #define PCI_BASE_ADDR4 0x20
164 #define PCI_BASE_ADDR5 0x24
166 **********************************************************************************
168 **********************************************************************************
170 #define ARCMSR_SCSICMD_IOCTL 0x77
171 #define ARCMSR_CDEVSW_IOCTL 0x88
172 #define ARCMSR_MESSAGE_FAIL 0x0001
173 #define ARCMSR_MESSAGE_SUCCESS 0x0000
175 **********************************************************************************
177 **********************************************************************************
179 #define arcmsr_ccbsrb_ptr spriv_ptr0
180 #define arcmsr_ccbacb_ptr spriv_ptr1
181 #define dma_addr_hi32(addr) (u_int32_t) ((addr>>16)>>16)
182 #define dma_addr_lo32(addr) (u_int32_t) (addr & 0xffffffff)
183 #define get_min(x,y) ((x) < (y) ? (x) : (y))
184 #define get_max(x,y) ((x) < (y) ? (y) : (x))
186 **************************************************************************
187 **************************************************************************
189 #define CHIP_REG_READ32(s, b, r) bus_space_read_4(acb->btag[b], acb->bhandle[b], offsetof(struct s, r))
190 #define CHIP_REG_WRITE32(s, b, r, d) bus_space_write_4(acb->btag[b], acb->bhandle[b], offsetof(struct s, r), d)
192 **********************************************************************************
193 ** IOCTL CONTROL Mail Box
194 **********************************************************************************
197 u_int32_t HeaderLength;
198 u_int8_t Signature[8];
200 u_int32_t ControlCode;
201 u_int32_t ReturnCode;
205 struct CMD_MESSAGE_FIELD {
206 struct CMD_MESSAGE cmdmessage; /* ioctl header */
207 u_int8_t messagedatabuffer[1032]; /* areca gui program does not accept more than 1031 byte */
210 /************************************************************************/
211 /************************************************************************/
213 #define ARCMSR_IOP_ERROR_ILLEGALPCI 0x0001
214 #define ARCMSR_IOP_ERROR_VENDORID 0x0002
215 #define ARCMSR_IOP_ERROR_DEVICEID 0x0002
216 #define ARCMSR_IOP_ERROR_ILLEGALCDB 0x0003
217 #define ARCMSR_IOP_ERROR_UNKNOW_CDBERR 0x0004
218 #define ARCMSR_SYS_ERROR_MEMORY_ALLOCATE 0x0005
219 #define ARCMSR_SYS_ERROR_MEMORY_CROSS4G 0x0006
220 #define ARCMSR_SYS_ERROR_MEMORY_LACK 0x0007
221 #define ARCMSR_SYS_ERROR_MEMORY_RANGE 0x0008
222 #define ARCMSR_SYS_ERROR_DEVICE_BASE 0x0009
223 #define ARCMSR_SYS_ERROR_PORT_VALIDATE 0x000A
226 #define ARECA_SATA_RAID 0x90000000
229 #define FUNCTION_READ_RQBUFFER 0x0801
230 #define FUNCTION_WRITE_WQBUFFER 0x0802
231 #define FUNCTION_CLEAR_RQBUFFER 0x0803
232 #define FUNCTION_CLEAR_WQBUFFER 0x0804
233 #define FUNCTION_CLEAR_ALLQBUFFER 0x0805
234 #define FUNCTION_REQUEST_RETURNCODE_3F 0x0806
235 #define FUNCTION_SAY_HELLO 0x0807
236 #define FUNCTION_SAY_GOODBYE 0x0808
237 #define FUNCTION_FLUSH_ADAPTER_CACHE 0x0809
239 ************************************************************************
240 ** IOCTL CONTROL CODE
241 ************************************************************************
243 /* ARECA IO CONTROL CODE*/
244 #define ARCMSR_MESSAGE_READ_RQBUFFER _IOWR('F', FUNCTION_READ_RQBUFFER, struct CMD_MESSAGE_FIELD)
245 #define ARCMSR_MESSAGE_WRITE_WQBUFFER _IOWR('F', FUNCTION_WRITE_WQBUFFER, struct CMD_MESSAGE_FIELD)
246 #define ARCMSR_MESSAGE_CLEAR_RQBUFFER _IOWR('F', FUNCTION_CLEAR_RQBUFFER, struct CMD_MESSAGE_FIELD)
247 #define ARCMSR_MESSAGE_CLEAR_WQBUFFER _IOWR('F', FUNCTION_CLEAR_WQBUFFER, struct CMD_MESSAGE_FIELD)
248 #define ARCMSR_MESSAGE_CLEAR_ALLQBUFFER _IOWR('F', FUNCTION_CLEAR_ALLQBUFFER, struct CMD_MESSAGE_FIELD)
249 #define ARCMSR_MESSAGE_REQUEST_RETURNCODE_3F _IOWR('F', FUNCTION_REQUEST_RETURNCODE_3F, struct CMD_MESSAGE_FIELD)
250 #define ARCMSR_MESSAGE_SAY_HELLO _IOWR('F', FUNCTION_SAY_HELLO, struct CMD_MESSAGE_FIELD)
251 #define ARCMSR_MESSAGE_SAY_GOODBYE _IOWR('F', FUNCTION_SAY_GOODBYE, struct CMD_MESSAGE_FIELD)
252 #define ARCMSR_MESSAGE_FLUSH_ADAPTER_CACHE _IOWR('F', FUNCTION_FLUSH_ADAPTER_CACHE, struct CMD_MESSAGE_FIELD)
254 /* ARECA IOCTL ReturnCode */
255 #define ARCMSR_MESSAGE_RETURNCODE_OK 0x00000001
256 #define ARCMSR_MESSAGE_RETURNCODE_ERROR 0x00000006
257 #define ARCMSR_MESSAGE_RETURNCODE_3F 0x0000003F
258 #define ARCMSR_IOCTL_RETURNCODE_BUS_HANG_ON 0x00000088
260 ************************************************************************
261 ** SPEC. for Areca HBA adapter
262 ************************************************************************
264 /* signature of set and get firmware config */
265 #define ARCMSR_SIGNATURE_GET_CONFIG 0x87974060
266 #define ARCMSR_SIGNATURE_SET_CONFIG 0x87974063
267 /* message code of inbound message register */
268 #define ARCMSR_INBOUND_MESG0_NOP 0x00000000
269 #define ARCMSR_INBOUND_MESG0_GET_CONFIG 0x00000001
270 #define ARCMSR_INBOUND_MESG0_SET_CONFIG 0x00000002
271 #define ARCMSR_INBOUND_MESG0_ABORT_CMD 0x00000003
272 #define ARCMSR_INBOUND_MESG0_STOP_BGRB 0x00000004
273 #define ARCMSR_INBOUND_MESG0_FLUSH_CACHE 0x00000005
274 #define ARCMSR_INBOUND_MESG0_START_BGRB 0x00000006
275 #define ARCMSR_INBOUND_MESG0_CHK331PENDING 0x00000007
276 #define ARCMSR_INBOUND_MESG0_SYNC_TIMER 0x00000008
277 /* doorbell interrupt generator */
278 #define ARCMSR_INBOUND_DRIVER_DATA_WRITE_OK 0x00000001
279 #define ARCMSR_INBOUND_DRIVER_DATA_READ_OK 0x00000002
280 #define ARCMSR_OUTBOUND_IOP331_DATA_WRITE_OK 0x00000001
281 #define ARCMSR_OUTBOUND_IOP331_DATA_READ_OK 0x00000002
282 /* srb areca cdb flag */
283 #define ARCMSR_SRBPOST_FLAG_SGL_BSIZE 0x80000000
284 #define ARCMSR_SRBPOST_FLAG_IAM_BIOS 0x40000000
285 #define ARCMSR_SRBREPLY_FLAG_IAM_BIOS 0x40000000
286 #define ARCMSR_SRBREPLY_FLAG_ERROR 0x10000000
287 #define ARCMSR_SRBREPLY_FLAG_ERROR_MODE0 0x10000000
288 #define ARCMSR_SRBREPLY_FLAG_ERROR_MODE1 0x00000001
289 /* outbound firmware ok */
290 #define ARCMSR_OUTBOUND_MESG1_FIRMWARE_OK 0x80000000
292 #define ARCMSR_ARC1680_BUS_RESET 0x00000003
294 ************************************************************************
295 ** SPEC. for Areca HBB adapter
296 ************************************************************************
298 /* ARECA HBB COMMAND for its FIRMWARE */
299 #define ARCMSR_DRV2IOP_DOORBELL 0x00020400 /* window of "instruction flags" from driver to iop */
300 #define ARCMSR_DRV2IOP_DOORBELL_MASK 0x00020404
301 #define ARCMSR_IOP2DRV_DOORBELL 0x00020408 /* window of "instruction flags" from iop to driver */
302 #define ARCMSR_IOP2DRV_DOORBELL_MASK 0x0002040C
304 /* ARECA FLAG LANGUAGE */
305 #define ARCMSR_IOP2DRV_DATA_WRITE_OK 0x00000001 /* ioctl transfer */
306 #define ARCMSR_IOP2DRV_DATA_READ_OK 0x00000002 /* ioctl transfer */
307 #define ARCMSR_IOP2DRV_CDB_DONE 0x00000004
308 #define ARCMSR_IOP2DRV_MESSAGE_CMD_DONE 0x00000008
310 #define ARCMSR_DOORBELL_HANDLE_INT 0x0000000F
311 #define ARCMSR_DOORBELL_INT_CLEAR_PATTERN 0xFF00FFF0
312 #define ARCMSR_MESSAGE_INT_CLEAR_PATTERN 0xFF00FFF7
314 #define ARCMSR_MESSAGE_GET_CONFIG 0x00010008 /* (ARCMSR_INBOUND_MESG0_GET_CONFIG<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
315 #define ARCMSR_MESSAGE_SET_CONFIG 0x00020008 /* (ARCMSR_INBOUND_MESG0_SET_CONFIG<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
316 #define ARCMSR_MESSAGE_ABORT_CMD 0x00030008 /* (ARCMSR_INBOUND_MESG0_ABORT_CMD<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
317 #define ARCMSR_MESSAGE_STOP_BGRB 0x00040008 /* (ARCMSR_INBOUND_MESG0_STOP_BGRB<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
318 #define ARCMSR_MESSAGE_FLUSH_CACHE 0x00050008 /* (ARCMSR_INBOUND_MESG0_FLUSH_CACHE<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
319 #define ARCMSR_MESSAGE_START_BGRB 0x00060008 /* (ARCMSR_INBOUND_MESG0_START_BGRB<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
320 #define ARCMSR_MESSAGE_START_DRIVER_MODE 0x000E0008
321 #define ARCMSR_MESSAGE_SET_POST_WINDOW 0x000F0008
322 #define ARCMSR_MESSAGE_ACTIVE_EOI_MODE 0x00100008
323 #define ARCMSR_MESSAGE_FIRMWARE_OK 0x80000000 /* ARCMSR_OUTBOUND_MESG1_FIRMWARE_OK */
325 #define ARCMSR_DRV2IOP_DATA_WRITE_OK 0x00000001 /* ioctl transfer */
326 #define ARCMSR_DRV2IOP_DATA_READ_OK 0x00000002 /* ioctl transfer */
327 #define ARCMSR_DRV2IOP_CDB_POSTED 0x00000004
328 #define ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED 0x00000008
329 #define ARCMSR_DRV2IOP_END_OF_INTERRUPT 0x00000010 /* */
331 /* data tunnel buffer between user space program and its firmware */
332 #define ARCMSR_MSGCODE_RWBUFFER 0x0000fa00 /* iop msgcode_rwbuffer for message command */
333 #define ARCMSR_IOCTL_WBUFFER 0x0000fe00 /* user space data to iop 128bytes */
334 #define ARCMSR_IOCTL_RBUFFER 0x0000ff00 /* iop data to user space 128bytes */
335 #define ARCMSR_HBB_BASE0_OFFSET 0x00000010
336 #define ARCMSR_HBB_BASE1_OFFSET 0x00000018
337 #define ARCMSR_HBB_BASE0_LEN 0x00021000
338 #define ARCMSR_HBB_BASE1_LEN 0x00010000
340 ************************************************************************
341 ** SPEC. for Areca HBC adapter
342 ************************************************************************
344 #define ARCMSR_HBC_ISR_THROTTLING_LEVEL 12
345 #define ARCMSR_HBC_ISR_MAX_DONE_QUEUE 20
346 /* Host Interrupt Mask */
347 #define ARCMSR_HBCMU_UTILITY_A_ISR_MASK 0x00000001 /* When clear, the Utility_A interrupt routes to the host.*/
348 #define ARCMSR_HBCMU_OUTBOUND_DOORBELL_ISR_MASK 0x00000004 /* When clear, the General Outbound Doorbell interrupt routes to the host.*/
349 #define ARCMSR_HBCMU_OUTBOUND_POSTQUEUE_ISR_MASK 0x00000008 /* When clear, the Outbound Post List FIFO Not Empty interrupt routes to the host.*/
350 #define ARCMSR_HBCMU_ALL_INTMASKENABLE 0x0000000D /* disable all ISR */
351 /* Host Interrupt Status */
352 #define ARCMSR_HBCMU_UTILITY_A_ISR 0x00000001
354 ** Set when the Utility_A Interrupt bit is set in the Outbound Doorbell Register.
355 ** It clears by writing a 1 to the Utility_A bit in the Outbound Doorbell Clear Register or through automatic clearing (if enabled).
357 #define ARCMSR_HBCMU_OUTBOUND_DOORBELL_ISR 0x00000004
359 ** Set if Outbound Doorbell register bits 30:1 have a non-zero
360 ** value. This bit clears only when Outbound Doorbell bits
361 ** 30:1 are ALL clear. Only a write to the Outbound Doorbell
362 ** Clear register clears bits in the Outbound Doorbell register.
364 #define ARCMSR_HBCMU_OUTBOUND_POSTQUEUE_ISR 0x00000008
366 ** Set whenever the Outbound Post List Producer/Consumer
367 ** Register (FIFO) is not empty. It clears when the Outbound
368 ** Post List FIFO is empty.
370 #define ARCMSR_HBCMU_SAS_ALL_INT 0x00000010
372 ** This bit indicates a SAS interrupt from a source external to
373 ** the PCIe core. This bit is not maskable.
376 #define ARCMSR_HBCMU_DRV2IOP_DATA_WRITE_OK 0x00000002/**/
377 #define ARCMSR_HBCMU_DRV2IOP_DATA_READ_OK 0x00000004/**/
378 #define ARCMSR_HBCMU_DRV2IOP_MESSAGE_CMD_DONE 0x00000008/*inbound message 0 ready*/
379 #define ARCMSR_HBCMU_DRV2IOP_POSTQUEUE_THROTTLING 0x00000010/*more than 12 request completed in a time*/
380 #define ARCMSR_HBCMU_IOP2DRV_DATA_WRITE_OK 0x00000002/**/
381 #define ARCMSR_HBCMU_IOP2DRV_DATA_WRITE_DOORBELL_CLEAR 0x00000002/*outbound DATA WRITE isr door bell clear*/
382 #define ARCMSR_HBCMU_IOP2DRV_DATA_READ_OK 0x00000004/**/
383 #define ARCMSR_HBCMU_IOP2DRV_DATA_READ_DOORBELL_CLEAR 0x00000004/*outbound DATA READ isr door bell clear*/
384 #define ARCMSR_HBCMU_IOP2DRV_MESSAGE_CMD_DONE 0x00000008/*outbound message 0 ready*/
385 #define ARCMSR_HBCMU_IOP2DRV_MESSAGE_CMD_DONE_DOORBELL_CLEAR 0x00000008/*outbound message cmd isr door bell clear*/
386 #define ARCMSR_HBCMU_MESSAGE_FIRMWARE_OK 0x80000000/*ARCMSR_HBCMU_MESSAGE_FIRMWARE_OK*/
387 #define ARCMSR_HBCMU_RESET_ADAPTER 0x00000024
388 #define ARCMSR_HBCMU_DiagWrite_ENABLE 0x00000080
391 ************************************************************************
392 ** SPEC. for Areca HBD adapter
393 ************************************************************************
395 #define ARCMSR_HBDMU_CHIP_ID 0x00004
396 #define ARCMSR_HBDMU_CPU_MEMORY_CONFIGURATION 0x00008
397 #define ARCMSR_HBDMU_I2_HOST_INTERRUPT_MASK 0x00034
398 #define ARCMSR_HBDMU_MAIN_INTERRUPT_STATUS 0x00200
399 #define ARCMSR_HBDMU_PCIE_F0_INTERRUPT_ENABLE 0x0020C
400 #define ARCMSR_HBDMU_INBOUND_MESSAGE0 0x00400
401 #define ARCMSR_HBDMU_INBOUND_MESSAGE1 0x00404
402 #define ARCMSR_HBDMU_OUTBOUND_MESSAGE0 0x00420
403 #define ARCMSR_HBDMU_OUTBOUND_MESSAGE1 0x00424
404 #define ARCMSR_HBDMU_INBOUND_DOORBELL 0x00460
405 #define ARCMSR_HBDMU_OUTBOUND_DOORBELL 0x00480
406 #define ARCMSR_HBDMU_OUTBOUND_DOORBELL_ENABLE 0x00484
407 #define ARCMSR_HBDMU_INBOUND_LIST_BASE_LOW 0x01000
408 #define ARCMSR_HBDMU_INBOUND_LIST_BASE_HIGH 0x01004
409 #define ARCMSR_HBDMU_INBOUND_LIST_WRITE_POINTER 0x01018
410 #define ARCMSR_HBDMU_OUTBOUND_LIST_BASE_LOW 0x01060
411 #define ARCMSR_HBDMU_OUTBOUND_LIST_BASE_HIGH 0x01064
412 #define ARCMSR_HBDMU_OUTBOUND_LIST_COPY_POINTER 0x0106C
413 #define ARCMSR_HBDMU_OUTBOUND_LIST_READ_POINTER 0x01070
414 #define ARCMSR_HBDMU_OUTBOUND_INTERRUPT_CAUSE 0x01088
415 #define ARCMSR_HBDMU_OUTBOUND_INTERRUPT_ENABLE 0x0108C
417 #define ARCMSR_HBDMU_MESSAGE_WBUFFER 0x02000
418 #define ARCMSR_HBDMU_MESSAGE_RBUFFER 0x02100
419 #define ARCMSR_HBDMU_MESSAGE_RWBUFFER 0x02200
421 #define ARCMSR_HBDMU_ISR_THROTTLING_LEVEL 16
422 #define ARCMSR_HBDMU_ISR_MAX_DONE_QUEUE 20
424 /* Host Interrupt Mask */
425 #define ARCMSR_HBDMU_ALL_INT_ENABLE 0x00001010 /* enable all ISR */
426 #define ARCMSR_HBDMU_ALL_INT_DISABLE 0x00000000 /* disable all ISR */
428 /* Host Interrupt Status */
429 #define ARCMSR_HBDMU_OUTBOUND_INT 0x00001010
430 #define ARCMSR_HBDMU_OUTBOUND_DOORBELL_INT 0x00001000
431 #define ARCMSR_HBDMU_OUTBOUND_POSTQUEUE_INT 0x00000010
434 #define ARCMSR_HBDMU_DRV2IOP_DATA_IN_READY 0x00000001
435 #define ARCMSR_HBDMU_DRV2IOP_DATA_OUT_READ 0x00000002
437 #define ARCMSR_HBDMU_IOP2DRV_DATA_WRITE_OK 0x00000001
438 #define ARCMSR_HBDMU_IOP2DRV_DATA_READ_OK 0x00000002
440 /*outbound message 0 ready*/
441 #define ARCMSR_HBDMU_IOP2DRV_MESSAGE_CMD_DONE 0x02000000
443 #define ARCMSR_HBDMU_F0_DOORBELL_CAUSE 0x02000003
445 /*outbound message cmd isr door bell clear*/
446 #define ARCMSR_HBDMU_IOP2DRV_MESSAGE_CMD_DONE_CLEAR 0x02000000
449 #define ARCMSR_HBDMU_OUTBOUND_LIST_INTERRUPT 0x00000001
450 #define ARCMSR_HBDMU_OUTBOUND_LIST_INTERRUPT_CLEAR 0x00000001
452 /*ARCMSR_HBAMU_MESSAGE_FIRMWARE_OK*/
453 #define ARCMSR_HBDMU_MESSAGE_FIRMWARE_OK 0x80000000
455 *********************************************************************
456 ** Message Unit structure
457 *********************************************************************
459 struct HBA_MessageUnit
461 u_int32_t resrved0[4]; /*0000 000F*/
462 u_int32_t inbound_msgaddr0; /*0010 0013*/
463 u_int32_t inbound_msgaddr1; /*0014 0017*/
464 u_int32_t outbound_msgaddr0; /*0018 001B*/
465 u_int32_t outbound_msgaddr1; /*001C 001F*/
466 u_int32_t inbound_doorbell; /*0020 0023*/
467 u_int32_t inbound_intstatus; /*0024 0027*/
468 u_int32_t inbound_intmask; /*0028 002B*/
469 u_int32_t outbound_doorbell; /*002C 002F*/
470 u_int32_t outbound_intstatus; /*0030 0033*/
471 u_int32_t outbound_intmask; /*0034 0037*/
472 u_int32_t reserved1[2]; /*0038 003F*/
473 u_int32_t inbound_queueport; /*0040 0043*/
474 u_int32_t outbound_queueport; /*0044 0047*/
475 u_int32_t reserved2[2]; /*0048 004F*/
476 u_int32_t reserved3[492]; /*0050 07FF ......local_buffer 492*/
477 u_int32_t reserved4[128]; /*0800 09FF 128*/
478 u_int32_t msgcode_rwbuffer[256]; /*0a00 0DFF 256*/
479 u_int32_t message_wbuffer[32]; /*0E00 0E7F 32*/
480 u_int32_t reserved5[32]; /*0E80 0EFF 32*/
481 u_int32_t message_rbuffer[32]; /*0F00 0F7F 32*/
482 u_int32_t reserved6[32]; /*0F80 0FFF 32*/
485 *********************************************************************
487 *********************************************************************
491 u_int8_t doorbell_reserved[ARCMSR_DRV2IOP_DOORBELL]; /*reserved */
492 u_int32_t drv2iop_doorbell; /*offset 0x00020400:00,01,02,03: window of "instruction flags" from driver to iop */
493 u_int32_t drv2iop_doorbell_mask; /* 04,05,06,07: doorbell mask */
494 u_int32_t iop2drv_doorbell; /* 08,09,10,11: window of "instruction flags" from iop to driver */
495 u_int32_t iop2drv_doorbell_mask; /* 12,13,14,15: doorbell mask */
498 *********************************************************************
500 *********************************************************************
504 u_int8_t message_reserved0[ARCMSR_MSGCODE_RWBUFFER]; /*reserved */
505 u_int32_t msgcode_rwbuffer[256]; /*offset 0x0000fa00: 0, 1, 2, 3,...,1023: message code read write 1024bytes */
506 u_int32_t message_wbuffer[32]; /*offset 0x0000fe00:1024,1025,1026,1027,...,1151: user space data to iop 128bytes */
507 u_int32_t message_reserved1[32]; /* 1152,1153,1154,1155,...,1279: message reserved*/
508 u_int32_t message_rbuffer[32]; /*offset 0x0000ff00:1280,1281,1282,1283,...,1407: iop data to user space 128bytes */
511 *********************************************************************
513 *********************************************************************
515 struct HBB_MessageUnit
517 u_int32_t post_qbuffer[ARCMSR_MAX_HBB_POSTQUEUE]; /* post queue buffer for iop */
518 u_int32_t done_qbuffer[ARCMSR_MAX_HBB_POSTQUEUE]; /* done queue buffer for iop */
519 int32_t postq_index; /* post queue index */
520 int32_t doneq_index; /* done queue index */
521 struct HBB_DOORBELL *hbb_doorbell;
522 struct HBB_RWBUFFER *hbb_rwbuffer;
526 *********************************************************************
528 *********************************************************************
530 struct HBC_MessageUnit {
531 u_int32_t message_unit_status; /*0000 0003*/
532 u_int32_t slave_error_attribute; /*0004 0007*/
533 u_int32_t slave_error_address; /*0008 000B*/
534 u_int32_t posted_outbound_doorbell; /*000C 000F*/
535 u_int32_t master_error_attribute; /*0010 0013*/
536 u_int32_t master_error_address_low; /*0014 0017*/
537 u_int32_t master_error_address_high; /*0018 001B*/
538 u_int32_t hcb_size; /*001C 001F size of the PCIe window used for HCB_Mode accesses*/
539 u_int32_t inbound_doorbell; /*0020 0023*/
540 u_int32_t diagnostic_rw_data; /*0024 0027*/
541 u_int32_t diagnostic_rw_address_low; /*0028 002B*/
542 u_int32_t diagnostic_rw_address_high; /*002C 002F*/
543 u_int32_t host_int_status; /*0030 0033 host interrupt status*/
544 u_int32_t host_int_mask; /*0034 0037 host interrupt mask*/
545 u_int32_t dcr_data; /*0038 003B*/
546 u_int32_t dcr_address; /*003C 003F*/
547 u_int32_t inbound_queueport; /*0040 0043 port32 host inbound queue port*/
548 u_int32_t outbound_queueport; /*0044 0047 port32 host outbound queue port*/
549 u_int32_t hcb_pci_address_low; /*0048 004B*/
550 u_int32_t hcb_pci_address_high; /*004C 004F*/
551 u_int32_t iop_int_status; /*0050 0053*/
552 u_int32_t iop_int_mask; /*0054 0057*/
553 u_int32_t iop_inbound_queue_port; /*0058 005B*/
554 u_int32_t iop_outbound_queue_port; /*005C 005F*/
555 u_int32_t inbound_free_list_index; /*0060 0063 inbound free list producer consumer index*/
556 u_int32_t inbound_post_list_index; /*0064 0067 inbound post list producer consumer index*/
557 u_int32_t outbound_free_list_index; /*0068 006B outbound free list producer consumer index*/
558 u_int32_t outbound_post_list_index; /*006C 006F outbound post list producer consumer index*/
559 u_int32_t inbound_doorbell_clear; /*0070 0073*/
560 u_int32_t i2o_message_unit_control; /*0074 0077*/
561 u_int32_t last_used_message_source_address_low; /*0078 007B*/
562 u_int32_t last_used_message_source_address_high; /*007C 007F*/
563 u_int32_t pull_mode_data_byte_count[4]; /*0080 008F pull mode data byte count0..count7*/
564 u_int32_t message_dest_address_index; /*0090 0093*/
565 u_int32_t done_queue_not_empty_int_counter_timer; /*0094 0097*/
566 u_int32_t utility_A_int_counter_timer; /*0098 009B*/
567 u_int32_t outbound_doorbell; /*009C 009F*/
568 u_int32_t outbound_doorbell_clear; /*00A0 00A3*/
569 u_int32_t message_source_address_index; /*00A4 00A7 message accelerator source address consumer producer index*/
570 u_int32_t message_done_queue_index; /*00A8 00AB message accelerator completion queue consumer producer index*/
571 u_int32_t reserved0; /*00AC 00AF*/
572 u_int32_t inbound_msgaddr0; /*00B0 00B3 scratchpad0*/
573 u_int32_t inbound_msgaddr1; /*00B4 00B7 scratchpad1*/
574 u_int32_t outbound_msgaddr0; /*00B8 00BB scratchpad2*/
575 u_int32_t outbound_msgaddr1; /*00BC 00BF scratchpad3*/
576 u_int32_t inbound_queueport_low; /*00C0 00C3 port64 host inbound queue port low*/
577 u_int32_t inbound_queueport_high; /*00C4 00C7 port64 host inbound queue port high*/
578 u_int32_t outbound_queueport_low; /*00C8 00CB port64 host outbound queue port low*/
579 u_int32_t outbound_queueport_high; /*00CC 00CF port64 host outbound queue port high*/
580 u_int32_t iop_inbound_queue_port_low; /*00D0 00D3*/
581 u_int32_t iop_inbound_queue_port_high; /*00D4 00D7*/
582 u_int32_t iop_outbound_queue_port_low; /*00D8 00DB*/
583 u_int32_t iop_outbound_queue_port_high; /*00DC 00DF*/
584 u_int32_t message_dest_queue_port_low; /*00E0 00E3 message accelerator destination queue port low*/
585 u_int32_t message_dest_queue_port_high; /*00E4 00E7 message accelerator destination queue port high*/
586 u_int32_t last_used_message_dest_address_low; /*00E8 00EB last used message accelerator destination address low*/
587 u_int32_t last_used_message_dest_address_high; /*00EC 00EF last used message accelerator destination address high*/
588 u_int32_t message_done_queue_base_address_low; /*00F0 00F3 message accelerator completion queue base address low*/
589 u_int32_t message_done_queue_base_address_high; /*00F4 00F7 message accelerator completion queue base address high*/
590 u_int32_t host_diagnostic; /*00F8 00FB*/
591 u_int32_t write_sequence; /*00FC 00FF*/
592 u_int32_t reserved1[34]; /*0100 0187*/
593 u_int32_t reserved2[1950]; /*0188 1FFF*/
594 u_int32_t message_wbuffer[32]; /*2000 207F*/
595 u_int32_t reserved3[32]; /*2080 20FF*/
596 u_int32_t message_rbuffer[32]; /*2100 217F*/
597 u_int32_t reserved4[32]; /*2180 21FF*/
598 u_int32_t msgcode_rwbuffer[256]; /*2200 23FF*/
601 *********************************************************************
603 *********************************************************************
606 uint32_t addressLow; //pointer to SRB block
607 uint32_t addressHigh;
608 uint32_t length; // in DWORDs
612 struct OutBound_SRB {
613 uint32_t addressLow; //pointer to SRB block
614 uint32_t addressHigh;
617 struct HBD_MessageUnit {
619 uint32_t chip_id; //0x0004
620 uint32_t cpu_mem_config; //0x0008
621 uint32_t reserved1[10]; //0x000C
622 uint32_t i2o_host_interrupt_mask; //0x0034
623 uint32_t reserved2[114]; //0x0038
624 uint32_t host_int_status; //0x0200
625 uint32_t host_int_enable; //0x0204
626 uint32_t reserved3[1]; //0x0208
627 uint32_t pcief0_int_enable; //0x020C
628 uint32_t reserved4[124]; //0x0210
629 uint32_t inbound_msgaddr0; //0x0400
630 uint32_t inbound_msgaddr1; //0x0404
631 uint32_t reserved5[6]; //0x0408
632 uint32_t outbound_msgaddr0; //0x0420
633 uint32_t outbound_msgaddr1; //0x0424
634 uint32_t reserved6[14]; //0x0428
635 uint32_t inbound_doorbell; //0x0460
636 uint32_t reserved7[7]; //0x0464
637 uint32_t outbound_doorbell; //0x0480
638 uint32_t outbound_doorbell_enable; //0x0484
639 uint32_t reserved8[734]; //0x0488
640 uint32_t inboundlist_base_low; //0x1000
641 uint32_t inboundlist_base_high; //0x1004
642 uint32_t reserved9[4]; //0x1008
643 uint32_t inboundlist_write_pointer; //0x1018
644 uint32_t inboundlist_read_pointer; //0x101C
645 uint32_t reserved10[16]; //0x1020
646 uint32_t outboundlist_base_low; //0x1060
647 uint32_t outboundlist_base_high; //0x1064
648 uint32_t reserved11; //0x1068
649 uint32_t outboundlist_copy_pointer; //0x106C
650 uint32_t outboundlist_read_pointer; //0x1070 0x1072
651 uint32_t reserved12[5]; //0x1074
652 uint32_t outboundlist_interrupt_cause; //0x1088
653 uint32_t outboundlist_interrupt_enable; //0x108C
654 uint32_t reserved13[988]; //0x1090
655 uint32_t message_wbuffer[32]; //0x2000
656 uint32_t reserved14[32]; //0x2080
657 uint32_t message_rbuffer[32]; //0x2100
658 uint32_t reserved15[32]; //0x2180
659 uint32_t msgcode_rwbuffer[256]; //0x2200
662 struct HBD_MessageUnit0 {
663 struct InBound_SRB post_qbuffer[ARCMSR_MAX_HBD_POSTQUEUE];
664 struct OutBound_SRB done_qbuffer[ARCMSR_MAX_HBD_POSTQUEUE+1];
665 uint16_t postq_index;
666 uint16_t doneq_index;
667 struct HBD_MessageUnit *phbdmu;
671 *********************************************************************
673 *********************************************************************
675 struct MessageUnit_UNION
678 struct HBA_MessageUnit hbamu;
679 struct HBB_MessageUnit hbbmu;
680 struct HBC_MessageUnit hbcmu;
681 struct HBD_MessageUnit0 hbdmu;
685 *************************************************************
686 ** structure for holding DMA address data
687 *************************************************************
689 #define IS_SG64_ADDR 0x01000000 /* bit24 */
691 ************************************************************************************************
692 ** ARECA FIRMWARE SPEC
693 ************************************************************************************************
694 ** Usage of IOP331 adapter
695 ** (All In/Out is in IOP331's view)
696 ** 1. Message 0 --> InitThread message and retrun code
697 ** 2. Doorbell is used for RS-232 emulation
698 ** inDoorBell : bit0 -- data in ready (DRIVER DATA WRITE OK)
699 ** bit1 -- data out has been read (DRIVER DATA READ OK)
700 ** outDooeBell: bit0 -- data out ready (IOP331 DATA WRITE OK)
701 ** bit1 -- data in has been read (IOP331 DATA READ OK)
702 ** 3. Index Memory Usage
703 ** offset 0xf00 : for RS232 out (request buffer)
704 ** offset 0xe00 : for RS232 in (scratch buffer)
705 ** offset 0xa00 : for inbound message code msgcode_rwbuffer (driver send to IOP331)
706 ** offset 0xa00 : for outbound message code msgcode_rwbuffer (IOP331 send to driver)
707 ** 4. RS-232 emulation
708 ** Currently 128 byte buffer is used
709 ** 1st u_int32_t : Data length (1--124)
710 ** Byte 4--127 : Max 124 bytes of data
712 ** All SCSI Command must be sent through postQ:
713 ** (inbound queue port) Request frame must be 32 bytes aligned
714 ** # bit27--bit31 => flag for post ccb
715 ** # bit0--bit26 => real address (bit27--bit31) of post arcmsr_cdb
716 ** bit31 : 0 : 256 bytes frame
717 ** 1 : 512 bytes frame
718 ** bit30 : 0 : normal request
723 ** -------------------------------------------------------------------------------
724 ** (outbount queue port) Request reply
725 ** # bit27--bit31 => flag for reply
726 ** # bit0--bit26 => real address (bit27--bit31) of reply arcmsr_cdb
727 ** bit31 : must be 0 (for this type of reply)
728 ** bit30 : reserved for BIOS handshake
730 ** bit28 : 0 : no error, ignore AdapStatus/DevStatus/SenseData
731 ** 1 : Error, error code in AdapStatus/DevStatus/SenseData
734 ** All BIOS request is the same with request from PostQ
736 ** Request frame is sent from configuration space
737 ** offset: 0x78 : Request Frame (bit30 == 1)
738 ** offset: 0x18 : writeonly to generate IRQ to IOP331
739 ** Completion of request:
740 ** (bit30 == 0, bit28==err flag)
741 ** 7. Definition of SGL entry (structure)
742 ** 8. Message1 Out - Diag Status Code (????)
743 ** 9. Message0 message code :
745 ** 0x01 : Get Config ->offset 0xa00 :for outbound message code msgcode_rwbuffer (IOP331 send to driver)
746 ** Signature 0x87974060(4)
747 ** Request len 0x00000200(4)
748 ** numbers of queue 0x00000100(4)
749 ** SDRAM Size 0x00000100(4)-->256 MB
750 ** IDE Channels 0x00000008(4)
751 ** vendor 40 bytes char
752 ** model 8 bytes char
753 ** FirmVer 16 bytes char
754 ** Device Map 16 bytes char
756 ** FirmwareVersion DWORD <== Added for checking of new firmware capability
757 ** 0x02 : Set Config ->offset 0xa00 : for inbound message code msgcode_rwbuffer (driver send to IOP331)
758 ** Signature 0x87974063(4)
759 ** UPPER32 of Request Frame (4)-->Driver Only
760 ** 0x03 : Reset (Abort all queued Command)
761 ** 0x04 : Stop Background Activity
762 ** 0x05 : Flush Cache
763 ** 0x06 : Start Background Activity (re-start if background is halted)
764 ** 0x07 : Check If Host Command Pending (Novell May Need This Function)
765 ** 0x08 : Set controller time ->offset 0xa00 : for inbound message code msgcode_rwbuffer (driver to IOP331)
766 ** byte 0 : 0xaa <-- signature
767 ** byte 1 : 0x55 <-- signature
768 ** byte 2 : year (04)
769 ** byte 3 : month (1..12)
770 ** byte 4 : date (1..31)
771 ** byte 5 : hour (0..23)
772 ** byte 6 : minute (0..59)
773 ** byte 7 : second (0..59)
774 ** *********************************************************************************
775 ** Porting Of LSI2108/2116 Based PCIE SAS/6G host raid adapter
776 ** ==> Difference from IOP348
777 ** <1> Message Register 0,1 (the same usage) Init Thread message and retrun code
778 ** Inbound Message 0 (inbound_msgaddr0) : at offset 0xB0 (Scratchpad0) for inbound message code msgcode_rwbuffer (driver send to IOP)
779 ** Inbound Message 1 (inbound_msgaddr1) : at offset 0xB4 (Scratchpad1) Out.... Diag Status Code
780 ** Outbound Message 0 (outbound_msgaddr0): at offset 0xB8 (Scratchpad3) Out.... Diag Status Code
781 ** Outbound Message 1 (outbound_msgaddr1): at offset 0xBC (Scratchpad2) for outbound message code msgcode_rwbuffer (IOP send to driver)
782 ** <A> use doorbell to generate interrupt
784 ** inbound doorbell: bit3 -- inbound message 0 ready (driver to iop)
785 ** outbound doorbell: bit3 -- outbound message 0 ready (iop to driver)
787 ** a. Message1: Out - Diag Status Code (????)
789 ** b. Message0: message code
791 ** 0x01 : Get Config ->offset 0xB8 :for outbound message code msgcode_rwbuffer (IOP send to driver)
792 ** Signature 0x87974060(4)
793 ** Request len 0x00000200(4)
794 ** numbers of queue 0x00000100(4)
795 ** SDRAM Size 0x00000100(4)-->256 MB
796 ** IDE Channels 0x00000008(4)
797 ** vendor 40 bytes char
798 ** model 8 bytes char
799 ** FirmVer 16 bytes char
800 ** Device Map 16 bytes char
801 ** cfgVersion ULONG <== Added for checking of new firmware capability
802 ** 0x02 : Set Config ->offset 0xB0 :for inbound message code msgcode_rwbuffer (driver send to IOP)
803 ** Signature 0x87974063(4)
804 ** UPPER32 of Request Frame (4)-->Driver Only
805 ** 0x03 : Reset (Abort all queued Command)
806 ** 0x04 : Stop Background Activity
807 ** 0x05 : Flush Cache
808 ** 0x06 : Start Background Activity (re-start if background is halted)
809 ** 0x07 : Check If Host Command Pending (Novell May Need This Function)
810 ** 0x08 : Set controller time ->offset 0xB0 : for inbound message code msgcode_rwbuffer (driver to IOP)
811 ** byte 0 : 0xaa <-- signature
812 ** byte 1 : 0x55 <-- signature
813 ** byte 2 : year (04)
814 ** byte 3 : month (1..12)
815 ** byte 4 : date (1..31)
816 ** byte 5 : hour (0..23)
817 ** byte 6 : minute (0..59)
818 ** byte 7 : second (0..59)
820 ** <2> Doorbell Register is used for RS-232 emulation
821 ** <A> different clear register
822 ** <B> different bit0 definition (bit0 is reserved)
824 ** inbound doorbell : at offset 0x20
825 ** inbound doorbell clear : at offset 0x70
827 ** inbound doorbell : bit0 -- reserved
828 ** bit1 -- data in ready (DRIVER DATA WRITE OK)
829 ** bit2 -- data out has been read (DRIVER DATA READ OK)
830 ** bit3 -- inbound message 0 ready
831 ** bit4 -- more than 12 request completed in a time
833 ** outbound doorbell : at offset 0x9C
834 ** outbound doorbell clear : at offset 0xA0
836 ** outbound doorbell : bit0 -- reserved
837 ** bit1 -- data out ready (IOP DATA WRITE OK)
838 ** bit2 -- data in has been read (IOP DATA READ OK)
839 ** bit3 -- outbound message 0 ready
841 ** <3> Index Memory Usage (Buffer Area)
842 ** COMPORT_IN at 0x2000: message_wbuffer -- 128 bytes (to be sent to ROC) : for RS232 in (scratch buffer)
843 ** COMPORT_OUT at 0x2100: message_rbuffer -- 128 bytes (to be sent to host): for RS232 out (request buffer)
844 ** BIOS_CFG_AREA at 0x2200: msgcode_rwbuffer -- 1024 bytes for outbound message code msgcode_rwbuffer (IOP send to driver)
845 ** BIOS_CFG_AREA at 0x2200: msgcode_rwbuffer -- 1024 bytes for inbound message code msgcode_rwbuffer (driver send to IOP)
847 ** <4> PostQ (Command Post Address)
848 ** All SCSI Command must be sent through postQ:
849 ** inbound queue port32 at offset 0x40 , 0x41, 0x42, 0x43
850 ** inbound queue port64 at offset 0xC0 (lower)/0xC4 (upper)
851 ** outbound queue port32 at offset 0x44
852 ** outbound queue port64 at offset 0xC8 (lower)/0xCC (upper)
853 ** <A> For 32bit queue, access low part is enough to send/receive request
854 ** i.e. write 0x40/0xC0, ROC will get the request with high part == 0, the
855 ** same for outbound queue port
856 ** <B> For 64bit queue, if 64bit instruction is supported, use 64bit instruction
857 ** to post inbound request in a single instruction, and use 64bit instruction
858 ** to retrieve outbound request in a single instruction.
859 ** If in 32bit environment, when sending inbound queue, write high part first
860 ** then write low part. For receiving outbound request, read high part first
861 ** then low part, to check queue empty, ONLY check high part to be 0xFFFFFFFF.
862 ** If high part is 0xFFFFFFFF, DO NOT read low part, this may corrupt the
863 ** consistency of the FIFO. Another way to check empty is to check status flag
865 ** <C> Post Address IS NOT shifted (must be 16 bytes aligned)
866 ** For BIOS, 16bytes aligned is OK
867 ** For Driver, 32bytes alignment is recommended.
868 ** POST Command bit0 to bit3 is defined differently
869 ** ----------------------------
870 ** bit0:1 for PULL mode (must be 1)
871 ** ----------------------------
872 ** bit3/2/1: for arcmsr cdb size (arccdbsize)
873 ** 000: <= 0x0080 (128)
874 ** 001: <= 0x0100 (256)
875 ** 010: <= 0x0180 (384)
876 ** 011: <= 0x0200 (512)
877 ** 100: <= 0x0280 (640)
878 ** 101: <= 0x0300 (768)
879 ** 110: <= 0x0300 (reserved)
880 ** 111: <= 0x0300 (reserved)
881 ** -----------------------------
882 ** if len > 0x300 the len always set as 0x300
883 ** -----------------------------
884 ** post addr = addr | ((len-1) >> 6) | 1
885 ** -----------------------------
886 ** page length in command buffer still required,
888 ** if page length > 3,
889 ** firmware will assume more request data need to be retrieved
891 ** <D> Outbound Posting
892 ** bit0:0 , no error, 1 with error, refer to status buffer
893 ** bit1:0 , reserved (will be 0)
894 ** bit2:0 , reserved (will be 0)
895 ** bit3:0 , reserved (will be 0)
896 ** bit63-4: Completed command address
898 ** <E> BIOS support, no special support is required.
899 ** LSI2108 support I/O register
900 ** All driver functionality is supported through I/O address
902 ************************************************************************************************
905 **********************************
907 **********************************
910 /* 32bit Scatter-Gather list */
911 struct SG32ENTRY { /* length bit 24 == 0 */
912 u_int32_t length; /* high 8 bit == flag,low 24 bit == length */
916 /* 64bit Scatter-Gather list */
917 struct SG64ENTRY { /* length bit 24 == 1 */
918 u_int32_t length; /* high 8 bit == flag,low 24 bit == length */
920 u_int32_t addresshigh;
922 struct SGENTRY_UNION {
924 struct SG32ENTRY sg32entry; /* 30h Scatter gather address */
925 struct SG64ENTRY sg64entry; /* 30h */
929 **********************************
931 **********************************
938 **********************************
940 typedef struct PHYS_ADDR64 {
941 u_int32_t phyadd_low;
942 u_int32_t phyadd_high;
945 ************************************************************************************************
947 ************************************************************************************************
949 #define ARCMSR_FW_MODEL_OFFSET 15
950 #define ARCMSR_FW_VERS_OFFSET 17
951 #define ARCMSR_FW_DEVMAP_OFFSET 21
952 #define ARCMSR_FW_CFGVER_OFFSET 25
954 struct FIRMWARE_INFO {
955 u_int32_t signature; /*0,00-03*/
956 u_int32_t request_len; /*1,04-07*/
957 u_int32_t numbers_queue; /*2,08-11*/
958 u_int32_t sdram_size; /*3,12-15*/
959 u_int32_t ide_channels; /*4,16-19*/
960 char vendor[40]; /*5,20-59*/
961 char model[8]; /*15,60-67*/
962 char firmware_ver[16]; /*17,68-83*/
963 char device_map[16]; /*21,84-99*/
964 u_int32_t cfgVersion; /*25,100-103 Added for checking of new firmware capability*/
965 char cfgSerial[16]; /*26,104-119*/
966 u_int32_t cfgPicStatus; /*30,120-123*/
968 /* (A) For cfgVersion in FIRMWARE_INFO
969 ** if low BYTE (byte#0) >= 3 (version 3)
970 ** then byte#1 report the capability of the firmware can xfer in a single request
980 ** (B) Byte offset 7 (Reserved1) of CDB is changed to msgPages
981 ** Driver support new xfer method need to set this field to indicate
982 ** large CDB block in 0x100 unit (we use 0x100 byte as one page)
983 ** e.g. If the length of CDB including MSG header and SGL is 0x1508
984 ** driver need to set the msgPages to 0x16
985 ** (C) REQ_LEN_512BYTE must be used also to indicate SRB length
986 ** e.g. CDB len msgPages REQ_LEN_512BYTE flag
996 ************************************************************************************************
998 ************************************************************************************************
1001 u_int8_t Bus; /* 00h should be 0 */
1002 u_int8_t TargetID; /* 01h should be 0--15 */
1003 u_int8_t LUN; /* 02h should be 0--7 */
1004 u_int8_t Function; /* 03h should be 1 */
1006 u_int8_t CdbLength; /* 04h not used now */
1007 u_int8_t sgcount; /* 05h */
1008 u_int8_t Flags; /* 06h */
1009 u_int8_t msgPages; /* 07h */
1011 u_int32_t Context; /* 08h Address of this request */
1012 u_int32_t DataLength; /* 0ch not used now */
1014 u_int8_t Cdb[16]; /* 10h SCSI CDB */
1016 ********************************************************
1017 ** Device Status : the same from SCSI bus if error occur
1018 ** SCSI bus status codes.
1019 ********************************************************
1021 u_int8_t DeviceStatus; /* 20h if error */
1023 u_int8_t SenseData[15]; /* 21h output */
1026 struct SG32ENTRY sg32entry[ARCMSR_MAX_SG_ENTRIES]; /* 30h Scatter gather address */
1027 struct SG64ENTRY sg64entry[ARCMSR_MAX_SG_ENTRIES]; /* 30h */
1031 #define ARCMSR_CDB_FLAG_SGL_BSIZE 0x01 /* bit 0: 0(256) / 1(512) bytes */
1032 #define ARCMSR_CDB_FLAG_BIOS 0x02 /* bit 1: 0(from driver) / 1(from BIOS) */
1033 #define ARCMSR_CDB_FLAG_WRITE 0x04 /* bit 2: 0(Data in) / 1(Data out) */
1034 #define ARCMSR_CDB_FLAG_SIMPLEQ 0x00 /* bit 4/3 ,00 : simple Q,01 : head of Q,10 : ordered Q */
1035 #define ARCMSR_CDB_FLAG_HEADQ 0x08
1036 #define ARCMSR_CDB_FLAG_ORDEREDQ 0x10
1038 #define SCSISTAT_GOOD 0x00
1039 #define SCSISTAT_CHECK_CONDITION 0x02
1040 #define SCSISTAT_CONDITION_MET 0x04
1041 #define SCSISTAT_BUSY 0x08
1042 #define SCSISTAT_INTERMEDIATE 0x10
1043 #define SCSISTAT_INTERMEDIATE_COND_MET 0x14
1044 #define SCSISTAT_RESERVATION_CONFLICT 0x18
1045 #define SCSISTAT_COMMAND_TERMINATED 0x22
1046 #define SCSISTAT_QUEUE_FULL 0x28
1048 #define ARCMSR_DEV_SELECT_TIMEOUT 0xF0
1049 #define ARCMSR_DEV_ABORTED 0xF1
1050 #define ARCMSR_DEV_INIT_FAIL 0xF2
1052 *********************************************************************
1053 ** Command Control Block (SrbExtension)
1054 ** SRB must be not cross page boundary,and the order from offset 0
1055 ** structure describing an ATA disk request
1056 ** this SRB length must be 32 bytes boundary
1057 *********************************************************************
1059 struct CommandControlBlock {
1060 struct ARCMSR_CDB arcmsr_cdb; /* 0 -503 (size of CDB=504): arcmsr messenger scsi command descriptor size 504 bytes */
1061 u_int32_t cdb_phyaddr_low; /* 504-507 */
1062 u_int32_t arc_cdb_size; /* 508-511 */
1063 /* ======================512+32 bytes============================ */
1064 union ccb *pccb; /* 512-515 516-519 pointer of freebsd scsi command */
1065 struct AdapterControlBlock *acb; /* 520-523 524-527 */
1066 bus_dmamap_t dm_segs_dmamap; /* 528-531 532-535 */
1067 u_int16_t srb_flags; /* 536-537 */
1068 u_int16_t srb_state; /* 538-539 */
1069 u_int32_t cdb_phyaddr_high; /* 540-543 */
1070 struct callout ccb_callout;
1071 /* ========================================================== */
1074 #define SRB_FLAG_READ 0x0000
1075 #define SRB_FLAG_WRITE 0x0001
1076 #define SRB_FLAG_ERROR 0x0002
1077 #define SRB_FLAG_FLUSHCACHE 0x0004
1078 #define SRB_FLAG_MASTER_ABORTED 0x0008
1079 #define SRB_FLAG_DMAVALID 0x0010
1080 #define SRB_FLAG_DMACONSISTENT 0x0020
1081 #define SRB_FLAG_DMAWRITE 0x0040
1082 #define SRB_FLAG_PKTBIND 0x0080
1083 #define SRB_FLAG_TIMER_START 0x0080
1085 #define ARCMSR_SRB_DONE 0x0000
1086 #define ARCMSR_SRB_UNBUILD 0x0000
1087 #define ARCMSR_SRB_TIMEOUT 0x1111
1088 #define ARCMSR_SRB_RETRY 0x2222
1089 #define ARCMSR_SRB_START 0x55AA
1090 #define ARCMSR_SRB_PENDING 0xAA55
1091 #define ARCMSR_SRB_RESET 0xA5A5
1092 #define ARCMSR_SRB_ABORTED 0x5A5A
1093 #define ARCMSR_SRB_ILLEGAL 0xFFFF
1095 #define SRB_SIZE ((sizeof(struct CommandControlBlock)+0x1f) & 0xffe0)
1096 #define ARCMSR_SRBS_POOL_SIZE (SRB_SIZE * ARCMSR_MAX_FREESRB_NUM)
1099 *********************************************************************
1100 ** Adapter Control Block
1101 *********************************************************************
1103 #define ACB_ADAPTER_TYPE_A 0x00000001 /* hba I IOP */
1104 #define ACB_ADAPTER_TYPE_B 0x00000002 /* hbb M IOP */
1105 #define ACB_ADAPTER_TYPE_C 0x00000004 /* hbc L IOP */
1106 #define ACB_ADAPTER_TYPE_D 0x00000008 /* hbd M IOP */
1108 struct AdapterControlBlock {
1109 u_int32_t adapter_type; /* adapter A,B..... */
1111 bus_space_tag_t btag[2];
1112 bus_space_handle_t bhandle[2];
1113 bus_dma_tag_t parent_dmat;
1114 bus_dma_tag_t dm_segs_dmat; /* dmat for buffer I/O */
1115 bus_dma_tag_t srb_dmat; /* dmat for freesrb */
1116 bus_dmamap_t srb_dmamap;
1118 #if __FreeBSD_version < 503000
1121 struct cdev *ioctl_dev;
1125 struct resource *sys_res_arcmsr[2];
1126 struct resource *irqres;
1127 void *ih; /* interrupt handle */
1129 /* Hooks into the CAM XPT */
1130 struct cam_sim *psim;
1131 struct cam_path *ppath;
1132 u_int8_t *uncacheptr;
1133 unsigned long vir2phy_offset;
1135 unsigned long phyaddr;
1137 u_int32_t phyadd_low;
1138 u_int32_t phyadd_high;
1141 // unsigned long srb_phyaddr;
1142 /* Offset is used in making arc cdb physical to virtual calculations */
1143 u_int32_t outbound_int_enable;
1145 struct MessageUnit_UNION *pmu; /* message unit ATU inbound base address0 */
1147 u_int8_t adapter_index;
1149 u_int16_t acb_flags;
1151 struct CommandControlBlock *psrb_pool[ARCMSR_MAX_FREESRB_NUM]; /* serial srb pointer array */
1152 struct CommandControlBlock *srbworkingQ[ARCMSR_MAX_FREESRB_NUM]; /* working srb pointer array */
1153 int32_t workingsrb_doneindex; /* done srb array index */
1154 int32_t workingsrb_startindex; /* start srb array index */
1155 int32_t srboutstandingcount;
1157 u_int8_t rqbuffer[ARCMSR_MAX_QBUFFER]; /* data collection buffer for read from 80331 */
1158 u_int32_t rqbuf_firstindex; /* first of read buffer */
1159 u_int32_t rqbuf_lastindex; /* last of read buffer */
1161 u_int8_t wqbuffer[ARCMSR_MAX_QBUFFER]; /* data collection buffer for write to 80331 */
1162 u_int32_t wqbuf_firstindex; /* first of write buffer */
1163 u_int32_t wqbuf_lastindex; /* last of write buffer */
1165 arcmsr_lock_t isr_lock;
1166 arcmsr_lock_t srb_lock;
1167 arcmsr_lock_t postDone_lock;
1168 arcmsr_lock_t qbuffer_lock;
1170 u_int8_t devstate[ARCMSR_MAX_TARGETID][ARCMSR_MAX_TARGETLUN]; /* id0 ..... id15,lun0...lun7 */
1171 u_int32_t num_resets;
1172 u_int32_t num_aborts;
1173 u_int32_t firm_request_len; /*1,04-07*/
1174 u_int32_t firm_numbers_queue; /*2,08-11*/
1175 u_int32_t firm_sdram_size; /*3,12-15*/
1176 u_int32_t firm_ide_channels; /*4,16-19*/
1177 u_int32_t firm_cfg_version;
1178 char firm_model[12]; /*15,60-67*/
1179 char firm_version[20]; /*17,68-83*/
1180 char device_map[20]; /*21,84-99 */
1181 struct callout devmap_callout;
1182 u_int32_t pktRequestCount;
1183 u_int32_t pktReturnCount;
1184 u_int32_t vendor_device_id;
1185 u_int32_t adapter_bus_speed;
1186 u_int32_t maxOutstanding;
1187 u_int16_t sub_device_id;
1188 };/* HW_DEVICE_EXTENSION */
1190 #define ACB_F_SCSISTOPADAPTER 0x0001
1191 #define ACB_F_MSG_STOP_BGRB 0x0002 /* stop RAID background rebuild */
1192 #define ACB_F_MSG_START_BGRB 0x0004 /* stop RAID background rebuild */
1193 #define ACB_F_IOPDATA_OVERFLOW 0x0008 /* iop ioctl data rqbuffer overflow */
1194 #define ACB_F_MESSAGE_WQBUFFER_CLEARED 0x0010 /* ioctl clear wqbuffer */
1195 #define ACB_F_MESSAGE_RQBUFFER_CLEARED 0x0020 /* ioctl clear rqbuffer */
1196 #define ACB_F_MESSAGE_WQBUFFER_READ 0x0040
1197 #define ACB_F_BUS_RESET 0x0080
1198 #define ACB_F_IOP_INITED 0x0100 /* iop init */
1199 #define ACB_F_MAPFREESRB_FAILD 0x0200 /* arcmsr_map_freesrb faild */
1200 #define ACB_F_CAM_DEV_QFRZN 0x0400
1201 #define ACB_F_BUS_HANG_ON 0x0800 /* need hardware reset bus */
1202 #define ACB_F_SRB_FUNCTION_POWER 0x1000
1204 #define ARECA_RAID_GONE 0x55
1205 #define ARECA_RAID_GOOD 0xaa
1206 /* adapter_bus_speed */
1207 #define ACB_BUS_SPEED_3G 0
1208 #define ACB_BUS_SPEED_6G 1
1209 #define ACB_BUS_SPEED_12G 2
1211 *************************************************************
1212 *************************************************************
1215 u_int8_t ErrorCode:7;
1217 u_int8_t SegmentNumber;
1218 u_int8_t SenseKey:4;
1219 u_int8_t Reserved:1;
1220 u_int8_t IncorrectLength:1;
1221 u_int8_t EndOfMedia:1;
1222 u_int8_t FileMark:1;
1223 u_int8_t Information[4];
1224 u_int8_t AdditionalSenseLength;
1225 u_int8_t CommandSpecificInformation[4];
1226 u_int8_t AdditionalSenseCode;
1227 u_int8_t AdditionalSenseCodeQualifier;
1228 u_int8_t FieldReplaceableUnitCode;
1229 u_int8_t SenseKeySpecific[3];
1232 **********************************
1233 ** Peripheral Device Type definitions
1234 **********************************
1236 #define SCSI_DASD 0x00 /* Direct-access Device */
1237 #define SCSI_SEQACESS 0x01 /* Sequential-access device */
1238 #define SCSI_PRINTER 0x02 /* Printer device */
1239 #define SCSI_PROCESSOR 0x03 /* Processor device */
1240 #define SCSI_WRITEONCE 0x04 /* Write-once device */
1241 #define SCSI_CDROM 0x05 /* CD-ROM device */
1242 #define SCSI_SCANNER 0x06 /* Scanner device */
1243 #define SCSI_OPTICAL 0x07 /* Optical memory device */
1244 #define SCSI_MEDCHGR 0x08 /* Medium changer device */
1245 #define SCSI_COMM 0x09 /* Communications device */
1246 #define SCSI_NODEV 0x1F /* Unknown or no device type */
1248 ************************************************************************************************************
1249 ** @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
1250 ** 80331 PCI-to-PCI Bridge
1251 ** PCI Configuration Space
1253 ** @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
1254 ** Programming Interface
1255 ** ========================
1256 ** Configuration Register Address Space Groupings and Ranges
1257 ** =============================================================
1258 ** Register Group Configuration Offset
1259 ** -------------------------------------------------------------
1260 ** Standard PCI Configuration 00-3Fh
1261 ** -------------------------------------------------------------
1262 ** Device Specific Registers 40-A7h
1263 ** -------------------------------------------------------------
1265 ** -------------------------------------------------------------
1266 ** Enhanced Capability List CC-FFh
1267 ** ==========================================================================================================
1268 ** Standard PCI [Type 1] Configuration Space Address Map
1269 ** **********************************************************************************************************
1270 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset
1271 ** ----------------------------------------------------------------------------------------------------------
1272 ** | Device ID | Vendor ID | 00h
1273 ** ----------------------------------------------------------------------------------------------------------
1274 ** | Primary Status | Primary Command | 04h
1275 ** ----------------------------------------------------------------------------------------------------------
1276 ** | Class Code | RevID | 08h
1277 ** ----------------------------------------------------------------------------------------------------------
1278 ** | reserved | Header Type | Primary MLT | Primary CLS | 0Ch
1279 ** ----------------------------------------------------------------------------------------------------------
1281 ** ----------------------------------------------------------------------------------------------------------
1283 ** ----------------------------------------------------------------------------------------------------------
1284 ** | Secondary MLT | Subordinate Bus Number | Secondary Bus Number | Primary Bus Number | 18h
1285 ** ----------------------------------------------------------------------------------------------------------
1286 ** | Secondary Status | I/O Limit | I/O Base | 1Ch
1287 ** ----------------------------------------------------------------------------------------------------------
1288 ** | Non-prefetchable Memory Limit Address | Non-prefetchable Memory Base Address | 20h
1289 ** ----------------------------------------------------------------------------------------------------------
1290 ** | Prefetchable Memory Limit Address | Prefetchable Memory Base Address | 24h
1291 ** ----------------------------------------------------------------------------------------------------------
1292 ** | Prefetchable Memory Base Address Upper 32 Bits | 28h
1293 ** ----------------------------------------------------------------------------------------------------------
1294 ** | Prefetchable Memory Limit Address Upper 32 Bits | 2Ch
1295 ** ----------------------------------------------------------------------------------------------------------
1296 ** | I/O Limit Upper 16 Bits | I/O Base Upper 16 | 30h
1297 ** ----------------------------------------------------------------------------------------------------------
1298 ** | Reserved | Capabilities Pointer | 34h
1299 ** ----------------------------------------------------------------------------------------------------------
1301 ** ----------------------------------------------------------------------------------------------------------
1302 ** | Bridge Control | Primary Interrupt Pin | Primary Interrupt Line | 3Ch
1303 **=============================================================================================================
1306 **=============================================================================================================
1308 ** Bit Default Description
1309 **31:16 0335h Device ID (DID): Indicates the unique device ID that is assigned to bridge by the PCI SIG.
1310 ** ID is unique per product speed as indicated.
1311 **15:00 8086h Vendor ID (VID): 16-bit field which indicates that Intel is the vendor.
1312 **=============================================================================================================
1314 #define ARCMSR_PCI2PCI_VENDORID_REG 0x00 /*word*/
1315 #define ARCMSR_PCI2PCI_DEVICEID_REG 0x02 /*word*/
1317 **==============================================================================
1318 ** 0x05-0x04 : command register
1319 ** Bit Default Description
1320 **15:11 00h Reserved
1321 ** 10 0 Interrupt Disable: Disables/Enables the generation of Interrupts on the primary bus.
1322 ** The bridge does not support interrupts.
1323 ** 09 0 FB2B Enable: Enables/Disables the generation of fast back to back
1324 ** transactions on the primary bus.
1325 ** The bridge does not generate fast back to back
1326 ** transactions on the primary bus.
1327 ** 08 0 SERR# Enable (SEE): Enables primary bus SERR# assertions.
1328 ** 0=The bridge does not assert P_SERR#.
1329 ** 1=The bridge may assert P_SERR#, subject to other programmable criteria.
1330 ** 07 0 Wait Cycle Control (WCC): Always returns 0bzero indicating
1331 ** that bridge does not perform address or data stepping,
1332 ** 06 0 Parity Error Response (PER): Controls bridge response to a detected primary bus parity error.
1333 ** 0=When a data parity error is detected bridge does not assert S_PERR#.
1334 ** Also bridge does not assert P_SERR# in response to
1335 ** a detected address or attribute parity error.
1336 ** 1=When a data parity error is detected bridge asserts S_PERR#.
1337 ** The bridge also asserts P_SERR#
1338 ** (when enabled globally via bit(8) of this register)
1339 ** in response to a detected address or attribute parity error.
1340 ** 05 0 VGA Palette Snoop Enable (VGA_PSE): Controls bridge response to VGA-compatible palette write transactions.
1341 ** VGA palette write transactions are I/O transactions
1342 ** whose address bits are: P_AD[9:0] equal to 3C6h, 3C8h or 3C9h
1343 ** P_AD[15:10] are not decoded (i.e. aliases are claimed),
1344 ** or are fully decoding
1345 ** (i.e., must be all 0's depending upon the VGA
1346 ** aliasing bit in the Bridge Control Register, offset 3Eh.
1347 ** P_AD[31:16] equal to 0000h
1348 ** 0=The bridge ignores VGA palette write transactions,
1349 ** unless decoded by the standard I/O address range window.
1350 ** 1=The bridge responds to VGA palette write transactions
1351 ** with medium DEVSEL# timing and forwards them to the secondary bus.
1352 ** 04 0 Memory Write and Invalidate Enable (MWIE): The bridge does not promote MW transactions to MWI transactions.
1353 ** MWI transactions targeting resources on the opposite side of the bridge,
1354 ** however, are forwarded as MWI transactions.
1355 ** 03 0 Special Cycle Enable (SCE): The bridge ignores special cycle transactions.
1356 ** This bit is read only and always returns 0 when read
1357 ** 02 0 Bus Master Enable (BME): Enables bridge to initiate memory and I/O transactions on the primary interface.
1358 ** Initiation of configuration transactions is not affected by the state of this bit.
1359 ** 0=The bridge does not initiate memory or I/O transactions on the primary interface.
1360 ** 1=The bridge is enabled to function as an initiator on the primary interface.
1361 ** 01 0 Memory Space Enable (MSE): Controls target response to memory transactions on the primary interface.
1362 ** 0=The bridge target response to memory transactions on the primary interface is disabled.
1363 ** 1=The bridge target response to memory transactions on the primary interface is enabled.
1364 ** 00 0 I/O Space Enable (IOSE): Controls target response to I/O transactions on the primary interface.
1365 ** 0=The bridge target response to I/O transactions on the primary interface is disabled.
1366 ** 1=The bridge target response to I/O transactions on the primary interface is enabled.
1367 **==============================================================================
1369 #define ARCMSR_PCI2PCI_PRIMARY_COMMAND_REG 0x04 /*word*/
1370 #define PCI_DISABLE_INTERRUPT 0x0400
1372 **==============================================================================
1373 ** 0x07-0x06 : status register
1374 ** Bit Default Description
1375 ** 15 0 Detected Parity Error: The bridge sets this bit to a 1b whenever it detects an address,
1376 ** attribute or data parity error.
1377 ** This bit is set regardless of the state of the PER bit in the command register.
1378 ** 14 0 Signaled System Error: The bridge sets this bit to a 1b whenever it asserts SERR# on the primary bus.
1379 ** 13 0 Received Master Abort: The bridge sets this bit to a 1b when,
1380 ** acting as the initiator on the primary bus,
1381 ** its transaction (with the exception of special cycles)
1382 ** has been terminated with a Master Abort.
1383 ** 12 0 Received Target Abort: The bridge sets this bit to a 1b when,
1384 ** acting as the initiator on the primary bus,
1385 ** its transaction has been terminated with a Target Abort.
1386 ** 11 0 Signaled Target Abort: The bridge sets this bit to a 1b when it,
1387 ** as the target of a transaction, terminates it with a Target Abort.
1388 ** In PCI-X mode this bit is also set when it forwards a SCM with a target abort error code.
1389 ** 10:09 01 DEVSEL# Timing: Indicates slowest response to a non-configuration command on the primary interface.
1390 ** Returns ¡§01b¡¨ when read, indicating that bridge responds no slower than with medium timing.
1391 ** 08 0 Master Data Parity Error: The bridge sets this bit to a 1b when all of the following conditions are true:
1392 ** The bridge is the current master on the primary bus
1393 ** S_PERR# is detected asserted or is asserted by bridge
1394 ** The Parity Error Response bit is set in the Command register
1395 ** 07 1 Fast Back to Back Capable: Returns a 1b when read indicating that bridge
1396 ** is able to respond to fast back to back transactions on its primary interface.
1398 ** 05 1 66 MHz Capable Indication: Returns a 1b when read indicating that bridge primary interface is 66 MHz capable.
1400 ** 04 1 Capabilities List Enable: Returns 1b when read indicating that bridge supports PCI standard enhanced capabilities.
1401 ** Offset 34h (Capability Pointer register)
1402 ** provides the offset for the first entry
1403 ** in the linked list of enhanced capabilities.
1404 ** 03 0 Interrupt Status: Reflects the state of the interrupt in the device/function.
1405 ** The bridge does not support interrupts.
1406 ** 02:00 000 Reserved
1407 **==============================================================================
1409 #define ARCMSR_PCI2PCI_PRIMARY_STATUS_REG 0x06 /*word: 06,07 */
1410 #define ARCMSR_ADAP_66MHZ 0x20
1412 **==============================================================================
1413 ** 0x08 : revision ID
1414 ** Bit Default Description
1415 ** 07:00 00000000 Revision ID (RID): '00h' indicating bridge A-0 stepping.
1416 **==============================================================================
1418 #define ARCMSR_PCI2PCI_REVISIONID_REG 0x08 /*byte*/
1420 **==============================================================================
1421 ** 0x0b-0x09 : 0180_00 (class code 1,native pci mode )
1422 ** Bit Default Description
1423 ** 23:16 06h Base Class Code (BCC): Indicates that this is a bridge device.
1424 ** 15:08 04h Sub Class Code (SCC): Indicates this is of type PCI-to-PCI bridge.
1425 ** 07:00 00h Programming Interface (PIF): Indicates that this is standard (non-subtractive) PCI-PCI bridge.
1426 **==============================================================================
1428 #define ARCMSR_PCI2PCI_CLASSCODE_REG 0x09 /*3bytes*/
1430 **==============================================================================
1431 ** 0x0c : cache line size
1432 ** Bit Default Description
1433 ** 07:00 00h Cache Line Size (CLS): Designates the cache line size in 32-bit dword units.
1434 ** The contents of this register are factored into
1435 ** internal policy decisions associated with memory read prefetching,
1436 ** and the promotion of Memory Write transactions to MWI transactions.
1437 ** Valid cache line sizes are 8 and 16 dwords.
1438 ** When the cache line size is set to an invalid value,
1439 ** bridge behaves as though the cache line size was set to 00h.
1440 **==============================================================================
1442 #define ARCMSR_PCI2PCI_PRIMARY_CACHELINESIZE_REG 0x0C /*byte*/
1444 **==============================================================================
1445 ** 0x0d : latency timer (number of pci clock 00-ff )
1446 ** Bit Default Description
1447 ** Primary Latency Timer (PTV):
1448 ** 07:00 00h (Conventional PCI) Conventional PCI Mode: Primary bus Master latency timer. Indicates the number of PCI clock cycles,
1449 ** referenced from the assertion of FRAME# to the expiration of the timer,
1450 ** when bridge may continue as master of the current transaction. All bits are writable,
1451 ** resulting in a granularity of 1 PCI clock cycle.
1452 ** When the timer expires (i.e., equals 00h)
1453 ** bridge relinquishes the bus after the first data transfer
1454 ** when its PCI bus grant has been deasserted.
1455 ** or 40h (PCI-X) PCI-X Mode: Primary bus Master latency timer.
1456 ** Indicates the number of PCI clock cycles,
1457 ** referenced from the assertion of FRAME# to the expiration of the timer,
1458 ** when bridge may continue as master of the current transaction.
1459 ** All bits are writable, resulting in a granularity of 1 PCI clock cycle.
1460 ** When the timer expires (i.e., equals 00h) bridge relinquishes the bus at the next ADB.
1461 ** (Except in the case where MLT expires within 3 data phases
1462 ** of an ADB.In this case bridge continues on
1463 ** until it reaches the next ADB before relinquishing the bus.)
1464 **==============================================================================
1466 #define ARCMSR_PCI2PCI_PRIMARY_LATENCYTIMER_REG 0x0D /*byte*/
1468 **==============================================================================
1469 ** 0x0e : (header type,single function )
1470 ** Bit Default Description
1471 ** 07 0 Multi-function device (MVD): 80331 is a single-function device.
1472 ** 06:00 01h Header Type (HTYPE): Defines the layout of addresses 10h through 3Fh in configuration space.
1473 ** Returns ¡§01h¡¨ when read indicating
1474 ** that the register layout conforms to the standard PCI-to-PCI bridge layout.
1475 **==============================================================================
1477 #define ARCMSR_PCI2PCI_HEADERTYPE_REG 0x0E /*byte*/
1479 **==============================================================================
1481 **==============================================================================
1484 **==============================================================================
1486 ** PCI CFG Base Address #0 (0x10)
1487 **==============================================================================
1490 **==============================================================================
1492 ** PCI CFG Base Address #1 (0x14)
1493 **==============================================================================
1496 **==============================================================================
1498 ** PCI CFG Base Address #2 (0x18)
1499 **-----------------0x1A,0x19,0x18--Bus Number Register - BNR
1500 ** Bit Default Description
1501 ** 23:16 00h Subordinate Bus Number (SBBN): Indicates the highest PCI bus number below this bridge.
1502 ** Any Type 1 configuration cycle
1503 ** on the primary bus whose bus number is greater than the secondary bus number,
1504 ** and less than or equal to the subordinate bus number
1505 ** is forwarded unaltered as a Type 1 configuration cycle on the secondary PCI bus.
1506 ** 15:08 00h Secondary Bus Number (SCBN): Indicates the bus number of PCI to which the secondary interface is connected.
1507 ** Any Type 1 configuration cycle matching this bus number
1508 ** is translated to a Type 0 configuration cycle (or a Special Cycle)
1509 ** before being executed on bridge's secondary PCI bus.
1510 ** 07:00 00h Primary Bus Number (PBN): Indicates bridge primary bus number.
1511 ** Any Type 1 configuration cycle on the primary interface
1512 ** with a bus number that is less than the contents
1513 ** of this register field does not be claimed by bridge.
1514 **-----------------0x1B--Secondary Latency Timer Register - SLTR
1515 ** Bit Default Description
1516 ** Secondary Latency Timer (STV):
1517 ** 07:00 00h (Conventional PCI) Conventional PCI Mode: Secondary bus Master latency timer.
1518 ** Indicates the number of PCI clock cycles,
1519 ** referenced from the assertion of FRAME# to the expiration of the timer,
1520 ** when bridge may continue as master of the current transaction. All bits are writable,
1521 ** resulting in a granularity of 1 PCI clock cycle.
1522 ** When the timer expires (i.e., equals 00h)
1523 ** bridge relinquishes the bus after the first data transfer
1524 ** when its PCI bus grant has been deasserted.
1525 ** or 40h (PCI-X) PCI-X Mode: Secondary bus Master latency timer.
1526 ** Indicates the number of PCI clock cycles,referenced from the assertion of FRAME#
1527 ** to the expiration of the timer,
1528 ** when bridge may continue as master of the current transaction. All bits are writable,
1529 ** resulting in a granularity of 1 PCI clock cycle.
1530 ** When the timer expires (i.e., equals 00h) bridge relinquishes the bus at the next ADB.
1531 ** (Except in the case where MLT expires within 3 data phases of an ADB.
1532 ** In this case bridge continues on until it reaches the next ADB
1533 ** before relinquishing the bus)
1534 **==============================================================================
1536 #define ARCMSR_PCI2PCI_PRIMARY_BUSNUMBER_REG 0x18 /*3byte 0x1A,0x19,0x18*/
1537 #define ARCMSR_PCI2PCI_SECONDARY_BUSNUMBER_REG 0x19 /*byte*/
1538 #define ARCMSR_PCI2PCI_SUBORDINATE_BUSNUMBER_REG 0x1A /*byte*/
1539 #define ARCMSR_PCI2PCI_SECONDARY_LATENCYTIMER_REG 0x1B /*byte*/
1541 **==============================================================================
1543 ** PCI CFG Base Address #3 (0x1C)
1544 **-----------------0x1D,0x1C--I/O Base and Limit Register - IOBL
1545 ** Bit Default Description
1546 ** 15:12 0h I/O Limit Address Bits [15:12]: Defines the top address of an address range to
1547 ** determine when to forward I/O transactions from one interface to the other.
1548 ** These bits correspond to address lines 15:12 for 4KB alignment.
1549 ** Bits 11:0 are assumed to be FFFh.
1550 ** 11:08 1h I/O Limit Addressing Capability: This field is hard-wired to 1h, indicating support 32-bit I/O addressing.
1551 ** 07:04 0h I/O Base Address Bits [15:12]: Defines the bottom address of
1552 ** an address range to determine when to forward I/O transactions
1553 ** from one interface to the other.
1554 ** These bits correspond to address lines 15:12 for 4KB alignment.
1555 ** Bits 11:0 are assumed to be 000h.
1556 ** 03:00 1h I/O Base Addressing Capability: This is hard-wired to 1h, indicating support for 32-bit I/O addressing.
1557 **-----------------0x1F,0x1E--Secondary Status Register - SSR
1558 ** Bit Default Description
1559 ** 15 0b Detected Parity Error: The bridge sets this bit to a 1b whenever it detects an address,
1560 ** attribute or data parity error on its secondary interface.
1561 ** 14 0b Received System Error: The bridge sets this bit when it samples SERR# asserted on its secondary bus interface.
1562 ** 13 0b Received Master Abort: The bridge sets this bit to a 1b when,
1563 ** acting as the initiator on the secondary bus,
1564 ** it's transaction (with the exception of special cycles)
1565 ** has been terminated with a Master Abort.
1566 ** 12 0b Received Target Abort: The bridge sets this bit to a 1b when,
1567 ** acting as the initiator on the secondary bus,
1568 ** it's transaction has been terminated with a Target Abort.
1569 ** 11 0b Signaled Target Abort: The bridge sets this bit to a 1b when it,
1570 ** as the target of a transaction, terminates it with a Target Abort.
1571 ** In PCI-X mode this bit is also set when it forwards a SCM with a target abort error code.
1572 ** 10:09 01b DEVSEL# Timing: Indicates slowest response to a non-configuration command on the secondary interface.
1573 ** Returns ¡§01b¡¨ when read, indicating that bridge responds no slower than with medium timing.
1574 ** 08 0b Master Data Parity Error: The bridge sets this bit to a 1b when all of the following conditions are true:
1575 ** The bridge is the current master on the secondary bus
1576 ** S_PERR# is detected asserted or is asserted by bridge
1577 ** The Parity Error Response bit is set in the Command register
1578 ** 07 1b Fast Back-to-Back Capable (FBC): Indicates that the secondary interface of bridge can receive fast back-to-back cycles.
1580 ** 05 1b 66 MHz Capable (C66): Indicates the secondary interface of the bridge is 66 MHz capable.
1582 ** 04:00 00h Reserved
1583 **==============================================================================
1585 #define ARCMSR_PCI2PCI_IO_BASE_REG 0x1C /*byte*/
1586 #define ARCMSR_PCI2PCI_IO_LIMIT_REG 0x1D /*byte*/
1587 #define ARCMSR_PCI2PCI_SECONDARY_STATUS_REG 0x1E /*word: 0x1F,0x1E */
1589 **==============================================================================
1591 ** PCI CFG Base Address #4 (0x20)
1592 **-----------------0x23,0x22,0x21,0x20--Memory Base and Limit Register - MBL
1593 ** Bit Default Description
1594 ** 31:20 000h Memory Limit: These 12 bits are compared with P_AD[31:20] of the incoming address to determine
1595 ** the upper 1MB aligned value (exclusive) of the range.
1596 ** The incoming address must be less than or equal to this value.
1597 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0]
1598 ** are assumed to be F FFFFh.
1599 ** 19:16 0h Reserved.
1600 ** 15:04 000h Memory Base: These 12 bits are compared with bits P_AD[31:20]
1601 ** of the incoming address to determine the lower 1MB
1602 ** aligned value (inclusive) of the range.
1603 ** The incoming address must be greater than or equal to this value.
1604 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0])
1605 ** are assumed to be 0 0000h.
1606 ** 03:00 0h Reserved.
1607 **==============================================================================
1609 #define ARCMSR_PCI2PCI_NONPREFETCHABLE_MEMORY_BASE_REG 0x20 /*word: 0x21,0x20 */
1610 #define ARCMSR_PCI2PCI_NONPREFETCHABLE_MEMORY_LIMIT_REG 0x22 /*word: 0x23,0x22 */
1612 **==============================================================================
1614 ** PCI CFG Base Address #5 (0x24)
1615 **-----------------0x27,0x26,0x25,0x24--Prefetchable Memory Base and Limit Register - PMBL
1616 ** Bit Default Description
1617 ** 31:20 000h Prefetchable Memory Limit: These 12 bits are compared with P_AD[31:20] of the incoming address to determine
1618 ** the upper 1MB aligned value (exclusive) of the range.
1619 ** The incoming address must be less than or equal to this value.
1620 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0]
1621 ** are assumed to be F FFFFh.
1622 ** 19:16 1h 64-bit Indicator: Indicates that 64-bit addressing is supported.
1623 ** 15:04 000h Prefetchable Memory Base: These 12 bits are compared with bits P_AD[31:20]
1624 ** of the incoming address to determine the lower 1MB aligned value (inclusive)
1626 ** The incoming address must be greater than or equal to this value.
1627 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0])
1628 ** are assumed to be 0 0000h.
1629 ** 03:00 1h 64-bit Indicator: Indicates that 64-bit addressing is supported.
1630 **==============================================================================
1632 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_BASE_REG 0x24 /*word: 0x25,0x24 */
1633 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_LIMIT_REG 0x26 /*word: 0x27,0x26 */
1635 **==============================================================================
1637 ** Bit Default Description
1638 ** 31:00 00000000h Prefetchable Memory Base Upper Portion: All bits are read/writable
1639 ** bridge supports full 64-bit addressing.
1640 **==============================================================================
1642 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_BASE_UPPER32_REG 0x28 /*dword: 0x2b,0x2a,0x29,0x28 */
1644 **==============================================================================
1646 ** Bit Default Description
1647 ** 31:00 00000000h Prefetchable Memory Limit Upper Portion: All bits are read/writable
1648 ** bridge supports full 64-bit addressing.
1649 **==============================================================================
1651 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_LIMIT_UPPER32_REG 0x2C /*dword: 0x2f,0x2e,0x2d,0x2c */
1653 **==============================================================================
1655 ** Bit Default Description
1656 ** 07:00 DCh Capabilities Pointer: Pointer to the first CAP ID entry in the capabilities list is at DCh in PCI configuration
1657 ** space. (Power Management Capability Registers)
1658 **==============================================================================
1660 #define ARCMSR_PCI2PCI_CAPABILITIES_POINTER_REG 0x34 /*byte*/
1662 **==============================================================================
1663 ** 0x3b-0x35 : reserved
1664 **==============================================================================
1667 **==============================================================================
1670 ** Bit Default Description
1671 ** 15:08 00h Interrupt Pin (PIN): Bridges do not support the generation of interrupts.
1672 ** 07:00 00h Interrupt Line (LINE): The bridge does not generate interrupts, so this is reserved as '00h'.
1673 **==============================================================================
1675 #define ARCMSR_PCI2PCI_PRIMARY_INTERRUPT_LINE_REG 0x3C /*byte*/
1676 #define ARCMSR_PCI2PCI_PRIMARY_INTERRUPT_PIN_REG 0x3D /*byte*/
1678 **==============================================================================
1680 ** Bit Default Description
1681 ** 15:12 0h Reserved
1682 ** 11 0b Discard Timer SERR# Enable: Controls the generation of SERR# on the primary interface (P_SERR#) in response
1683 ** to a timer discard on either the primary or secondary interface.
1684 ** 0b=SERR# is not asserted.
1685 ** 1b=SERR# is asserted.
1686 ** 10 0b Discard Timer Status (DTS): This bit is set to a '1b' when either the primary or secondary discard timer expires.
1687 ** The delayed completion is then discarded.
1688 ** 09 0b Secondary Discard Timer (SDT): Sets the maximum number of PCI clock cycles
1689 ** that bridge waits for an initiator on the secondary bus
1690 ** to repeat a delayed transaction request.
1691 ** The counter starts when the delayed transaction completion is ready
1692 ** to be returned to the initiator.
1693 ** When the initiator has not repeated the transaction
1694 ** at least once before the counter expires,bridge
1695 ** discards the delayed transaction from its queues.
1696 ** 0b=The secondary master time-out counter is 2 15 PCI clock cycles.
1697 ** 1b=The secondary master time-out counter is 2 10 PCI clock cycles.
1698 ** 08 0b Primary Discard Timer (PDT): Sets the maximum number of PCI clock cycles
1699 ** that bridge waits for an initiator on the primary bus
1700 ** to repeat a delayed transaction request.
1701 ** The counter starts when the delayed transaction completion
1702 ** is ready to be returned to the initiator.
1703 ** When the initiator has not repeated the transaction
1704 ** at least once before the counter expires,
1705 ** bridge discards the delayed transaction from its queues.
1706 ** 0b=The primary master time-out counter is 2 15 PCI clock cycles.
1707 ** 1b=The primary master time-out counter is 2 10 PCI clock cycles.
1708 ** 07 0b Fast Back-to-Back Enable (FBE): The bridge does not initiate back to back transactions.
1709 ** 06 0b Secondary Bus Reset (SBR):
1710 ** When cleared to 0b: The bridge deasserts S_RST#,
1711 ** when it had been asserted by writing this bit to a 1b.
1712 ** When set to 1b: The bridge asserts S_RST#.
1713 ** 05 0b Master Abort Mode (MAM): Dictates bridge behavior on the initiator bus
1714 ** when a master abort termination occurs in response to
1715 ** a delayed transaction initiated by bridge on the target bus.
1716 ** 0b=The bridge asserts TRDY# in response to a non-locked delayed transaction,
1717 ** and returns FFFF FFFFh when a read.
1718 ** 1b=When the transaction had not yet been completed on the initiator bus
1719 ** (e.g.,delayed reads, or non-posted writes),
1720 ** then bridge returns a Target Abort in response to the original requester
1721 ** when it returns looking for its delayed completion on the initiator bus.
1722 ** When the transaction had completed on the initiator bus (e.g., a PMW),
1723 ** then bridge asserts P_SERR# (when enabled).
1724 ** For PCI-X transactions this bit is an enable for the assertion of P_SERR# due to a master abort
1725 ** while attempting to deliver a posted memory write on the destination bus.
1726 ** 04 0b VGA Alias Filter Enable: This bit dictates bridge behavior in conjunction with the VGA enable bit
1727 ** (also of this register),
1728 ** and the VGA Palette Snoop Enable bit (Command Register).
1729 ** When the VGA enable, or VGA Palette Snoop enable bits are on (i.e., 1b)
1730 ** the VGA Aliasing bit for the corresponding enabled functionality,:
1731 ** 0b=Ignores address bits AD[15:10] when decoding VGA I/O addresses.
1732 ** 1b=Ensures that address bits AD[15:10] equal 000000b when decoding VGA I/O addresses.
1733 ** When all VGA cycle forwarding is disabled, (i.e., VGA Enable bit =0b and VGA Palette Snoop bit =0b),
1734 ** then this bit has no impact on bridge behavior.
1735 ** 03 0b VGA Enable: Setting this bit enables address decoding
1736 ** and transaction forwarding of the following VGA transactions from the primary bus
1737 ** to the secondary bus:
1738 ** frame buffer memory addresses 000A0000h:000BFFFFh,
1739 ** VGA I/O addresses 3B0:3BBh and 3C0h:3DFh, where AD[31:16]=¡§0000h?** ?and AD[15:10] are either not decoded (i.e., don't cares),
1740 ** or must be ¡§000000b¡¨
1741 ** depending upon the state of the VGA Alias Filter Enable bit. (bit(4) of this register)
1742 ** I/O and Memory Enable bits must be set in the Command register
1743 ** to enable forwarding of VGA cycles.
1744 ** 02 0b ISA Enable: Setting this bit enables special handling
1745 ** for the forwarding of ISA I/O transactions that fall within the address range
1746 ** specified by the I/O Base and Limit registers,
1747 ** and are within the lowest 64Kbyte of the I/O address map
1748 ** (i.e., 0000 0000h - 0000 FFFFh).
1749 ** 0b=All I/O transactions that fall within the I/O Base
1750 ** and Limit registers' specified range are forwarded
1751 ** from primary to secondary unfiltered.
1752 ** 1b=Blocks the forwarding from primary to secondary
1753 ** of the top 768 bytes of each 1Kbyte alias.
1754 ** On the secondary the top 768 bytes of each 1K alias
1755 ** are inversely decoded and forwarded
1756 ** from secondary to primary.
1757 ** 01 0b SERR# Forward Enable: 0b=The bridge does not assert P_SERR# as a result of an S_SERR# assertion.
1758 ** 1b=The bridge asserts P_SERR# whenever S_SERR# is detected
1759 ** asserted provided the SERR# Enable bit is set (PCI Command Register bit(8)=1b).
1760 ** 00 0b Parity Error Response: This bit controls bridge response to a parity error
1761 ** that is detected on its secondary interface.
1762 ** 0b=When a data parity error is detected bridge does not assert S_PERR#.
1763 ** Also bridge does not assert P_SERR# in response to a detected address
1764 ** or attribute parity error.
1765 ** 1b=When a data parity error is detected bridge asserts S_PERR#.
1766 ** The bridge also asserts P_SERR# (when enabled globally via bit(8)
1767 ** of the Command register)
1768 ** in response to a detected address or attribute parity error.
1769 **==============================================================================
1771 #define ARCMSR_PCI2PCI_BRIDGE_CONTROL_REG 0x3E /*word*/
1773 **************************************************************************
1774 ** Device Specific Registers 40-A7h
1775 **************************************************************************
1776 ** ----------------------------------------------------------------------------------------------------------
1777 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset
1778 ** ----------------------------------------------------------------------------------------------------------
1779 ** | Bridge Control 0 | Arbiter Control/Status | Reserved | 40h
1780 ** ----------------------------------------------------------------------------------------------------------
1781 ** | Bridge Control 2 | Bridge Control 1 | 44h
1782 ** ----------------------------------------------------------------------------------------------------------
1783 ** | Reserved | Bridge Status | 48h
1784 ** ----------------------------------------------------------------------------------------------------------
1786 ** ----------------------------------------------------------------------------------------------------------
1787 ** | Prefetch Policy | Multi-Transaction Timer | 50h
1788 ** ----------------------------------------------------------------------------------------------------------
1789 ** | Reserved | Pre-boot Status | P_SERR# Assertion Control | 54h
1790 ** ----------------------------------------------------------------------------------------------------------
1791 ** | Reserved | Reserved | Secondary Decode Enable | 58h
1792 ** ----------------------------------------------------------------------------------------------------------
1793 ** | Reserved | Secondary IDSEL | 5Ch
1794 ** ----------------------------------------------------------------------------------------------------------
1796 ** ----------------------------------------------------------------------------------------------------------
1797 ** | Reserved | 68h:CBh
1798 ** ----------------------------------------------------------------------------------------------------------
1799 **************************************************************************
1800 **==============================================================================
1801 ** 0x42-0x41: Secondary Arbiter Control/Status Register - SACSR
1802 ** Bit Default Description
1803 ** 15:12 1111b Grant Time-out Violator: This field indicates the agent that violated the Grant Time-out rule
1804 ** (PCI=16 clocks,PCI-X=6 clocks).
1805 ** Note that this field is only meaningful when:
1806 ** # Bit[11] of this register is set to 1b,
1807 ** indicating that a Grant Time-out violation had occurred.
1808 ** # bridge internal arbiter is enabled.
1809 ** Bits[15:12] Violating Agent (REQ#/GNT# pair number)
1810 ** 0000b REQ#/GNT#[0]
1811 ** 0001b REQ#/GNT#[1]
1812 ** 0010b REQ#/GNT#[2]
1813 ** 0011b REQ#/GNT#[3]
1814 ** 1111b Default Value (no violation detected)
1815 ** When bit[11] is cleared by software, this field reverts back to its default value.
1816 ** All other values are Reserved
1817 ** 11 0b Grant Time-out Occurred: When set to 1b,
1818 ** this indicates that a Grant Time-out error had occurred involving one of the secondary bus agents.
1819 ** Software clears this bit by writing a 1b to it.
1820 ** 10 0b Bus Parking Control: 0=During bus idle, bridge parks the bus on the last master to use the bus.
1821 ** 1=During bus idle, bridge parks the bus on itself.
1822 ** The bus grant is removed from the last master and internally asserted to bridge.
1823 ** 09:08 00b Reserved
1824 ** 07:00 0000 0000b Secondary Bus Arbiter Priority Configuration: The bridge secondary arbiter provides two rings of arbitration priority.
1825 ** Each bit of this field assigns its corresponding secondary
1826 ** bus master to either the high priority arbiter ring (1b)
1827 ** or to the low priority arbiter ring (0b).
1828 ** Bits [3:0] correspond to request inputs S_REQ#[3:0], respectively.
1829 ** Bit [6] corresponds to the bridge internal secondary bus request
1830 ** while Bit [7] corresponds to the SATU secondary bus request.
1831 ** Bits [5:4] are unused.
1832 ** 0b=Indicates that the master belongs to the low priority group.
1833 ** 1b=Indicates that the master belongs to the high priority group
1834 **=================================================================================
1835 ** 0x43: Bridge Control Register 0 - BCR0
1836 ** Bit Default Description
1837 ** 07 0b Fully Dynamic Queue Mode: 0=The number of Posted write transactions is limited to eight
1838 ** and the Posted Write data is limited to 4KB.
1839 ** 1=Operation in fully dynamic queue mode. The bridge enqueues up to
1840 ** 14 Posted Memory Write transactions and 8KB of posted write data.
1841 ** 06:03 0H Reserved.
1842 ** 02 0b Upstream Prefetch Disable: This bit disables bridge ability
1843 ** to perform upstream prefetch operations for Memory
1844 ** Read requests received on its secondary interface.
1845 ** This bit also controls the bridge's ability to generate advanced read commands
1846 ** when forwarding a Memory Read Block transaction request upstream from a PCI-X bus
1847 ** to a Conventional PCI bus.
1848 ** 0b=bridge treats all upstream Memory Read requests as though they target prefetchable memory.
1849 ** The use of Memory Read Line and Memory Read
1850 ** Multiple is enabled when forwarding a PCI-X Memory Read Block request
1851 ** to an upstream bus operating in Conventional PCI mode.
1852 ** 1b=bridge treats upstream PCI Memory Read requests as though
1853 ** they target non-prefetchable memory and forwards upstream PCI-X Memory
1854 ** Read Block commands as Memory Read
1855 ** when the primary bus is operating
1856 ** in Conventional PCI mode.
1857 ** NOTE: This bit does not affect bridge ability to perform read prefetching
1858 ** when the received command is Memory Read Line or Memory Read Multiple.
1859 **=================================================================================
1860 ** 0x45-0x44: Bridge Control Register 1 - BCR1 (Sheet 2 of 2)
1861 ** Bit Default Description
1862 ** 15:08 0000000b Reserved
1863 ** 07:06 00b Alias Command Mapping: This two bit field determines how bridge handles PCI-X ¡§Alias¡¨ commands,
1864 ** specifically the Alias to Memory Read Block and Alias to Memory Write Block commands.
1865 ** The three options for handling these alias commands are to either pass it as is,
1866 ** re-map to the actual block memory read/write command encoding, or ignore
1867 ** the transaction forcing a Master Abort to occur on the Origination Bus.
1868 ** Bit (7:6) Handling of command
1869 ** 0 0 Re-map to Memory Read/Write Block before forwarding
1870 ** 0 1 Enqueue and forward the alias command code unaltered
1871 ** 1 0 Ignore the transaction, forcing Master Abort
1873 ** 05 1b Watchdog Timers Disable: Disables or enables all 2 24 Watchdog Timers in both directions.
1874 ** The watchdog timers are used to detect prohibitively long latencies in the system.
1875 ** The watchdog timer expires when any Posted Memory Write (PMW), Delayed Request,
1876 ** or Split Requests (PCI-X mode) is not completed within 2 24 events
1877 ** (¡§events¡¨ are defined as PCI Clocks when operating in PCI-X mode,
1878 ** and as the number of times being retried when operating in Conventional PCI mode)
1879 ** 0b=All 2 24 watchdog timers are enabled.
1880 ** 1b=All 2 24 watchdog timers are disabled and there is no limits to
1881 ** the number of attempts bridge makes when initiating a PMW,
1882 ** transacting a Delayed Transaction, or how long it waits for
1883 ** a split completion corresponding to one of its requests.
1884 ** 04 0b GRANT# time-out disable: This bit enables/disables the GNT# time-out mechanism.
1885 ** Grant time-out is 16 clocks for conventional PCI, and 6 clocks for PCI-X.
1886 ** 0b=The Secondary bus arbiter times out an agent
1887 ** that does not assert FRAME# within 16/6 clocks of receiving its grant,
1888 ** once the bus has gone idle.
1889 ** The time-out counter begins as soon as the bus goes idle with the new GNT# asserted.
1890 ** An infringing agent does not receive a subsequent GNT#
1891 ** until it de-asserts its REQ# for at least one clock cycle.
1892 ** 1b=GNT# time-out mechanism is disabled.
1894 ** 02 0b Secondary Discard Timer Disable: This bit enables/disables bridge secondary delayed transaction discard mechanism.
1895 ** The time out mechanism is used to ensure that initiators
1896 ** of delayed transactions return for their delayed completion data/status
1897 ** within a reasonable amount of time after it is available from bridge.
1898 ** 0b=The secondary master time-out counter is enabled
1899 ** and uses the value specified by the Secondary Discard Timer bit
1900 ** (see Bridge Control Register).
1901 ** 1b=The secondary master time-out counter is disabled.
1902 ** The bridge waits indefinitely for a secondary bus master
1903 ** to repeat a delayed transaction.
1904 ** 01 0b Primary Discard Timer Disable: This bit enables/disables bridge primary delayed transaction discard mechanism.
1905 ** The time out mechanism is used to ensure that initiators
1906 ** of delayed transactions return for their delayed completion data/status
1907 ** within a reasonable amount of time after it is available from bridge.
1908 ** 0b=The primary master time-out counter is enabled and uses the value specified
1909 ** by the Primary Discard Timer bit (see Bridge Control Register).
1910 ** 1b=The secondary master time-out counter is disabled.
1911 ** The bridge waits indefinitely for a secondary bus master
1912 ** to repeat a delayed transaction.
1914 **=================================================================================
1915 ** 0x47-0x46: Bridge Control Register 2 - BCR2
1916 ** Bit Default Description
1917 ** 15:07 0000b Reserved.
1918 ** 06 0b Global Clock Out Disable (External Secondary Bus Clock Source Enable):
1919 ** This bit disables all of the secondary PCI clock outputs including
1920 ** the feedback clock S_CLKOUT.
1921 ** This means that the user is required to provide an S_CLKIN input source.
1922 ** 05:04 11 (66 MHz) Preserved.
1925 ** 03:00 Fh (100 MHz & 66 MHz)
1927 ** This 4 bit field provides individual enable/disable mask bits for each of bridge
1928 ** secondary PCI clock outputs. Some, or all secondary clock outputs (S_CLKO[3:0])
1929 ** default to being enabled following the rising edge of P_RST#, depending on the
1930 ** frequency of the secondary bus clock:
1931 ** ¡E Designs with 100 MHz (or lower) Secondary PCI clock power up with
1932 ** all four S_CLKOs enabled by default. (SCLKO[3:0])¡P
1933 ** ¡E Designs with 133 MHz Secondary PCI clock power up
1934 ** with the lower order 3 S_CLKOs enabled by default.
1935 ** (S_CLKO[2:0]) Only those SCLKs that power up enabled by can be connected
1936 ** to downstream device clock inputs.
1937 **=================================================================================
1938 ** 0x49-0x48: Bridge Status Register - BSR
1939 ** Bit Default Description
1940 ** 15 0b Upstream Delayed Transaction Discard Timer Expired: This bit is set to a 1b and P_SERR#
1941 ** is conditionally asserted when the secondary discard timer expires.
1942 ** 14 0b Upstream Delayed/Split Read Watchdog Timer Expired:
1943 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR#
1944 ** is conditionally asserted when bridge discards an upstream delayed read ** ** transaction request after 2 24 retries following the initial retry.
1945 ** PCI-X Mode: This bit is set to a 1b and P_SERR# is conditionally asserted
1946 ** when bridge discards an upstream split read request
1947 ** after waiting in excess of 2 24 clocks for the corresponding
1948 ** Split Completion to arrive.
1949 ** 13 0b Upstream Delayed/Split Write Watchdog Timer Expired:
1950 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR#
1951 ** is conditionally asserted when bridge discards an upstream delayed write ** ** transaction request after 2 24 retries following the initial retry.
1952 ** PCI-X Mode: This bit is set to a 1b and P_SERR#
1953 ** is conditionally asserted when bridge discards an upstream split write request ** after waiting in excess of 2 24 clocks for the corresponding
1954 ** Split Completion to arrive.
1955 ** 12 0b Master Abort during Upstream Posted Write: This bit is set to a 1b and P_SERR#
1956 ** is conditionally asserted when a Master Abort occurs as a result of an attempt,
1957 ** by bridge, to retire a PMW upstream.
1958 ** 11 0b Target Abort during Upstream Posted Write: This bit is set to a 1b and P_SERR#
1959 ** is conditionally asserted when a Target Abort occurs as a result of an attempt,
1960 ** by bridge, to retire a PMW upstream.
1961 ** 10 0b Upstream Posted Write Data Discarded: This bit is set to a 1b and P_SERR#
1962 ** is conditionally asserted when bridge discards an upstream PMW transaction
1963 ** after receiving 2 24 target retries from the primary bus target
1964 ** 09 0b Upstream Posted Write Data Parity Error: This bit is set to a 1b and P_SERR#
1965 ** is conditionally asserted when a data parity error is detected by bridge
1966 ** while attempting to retire a PMW upstream
1967 ** 08 0b Secondary Bus Address Parity Error: This bit is set to a 1b and P_SERR#
1968 ** is conditionally asserted when bridge detects an address parity error on
1969 ** the secondary bus.
1970 ** 07 0b Downstream Delayed Transaction Discard Timer Expired: This bit is set to a 1b and P_SERR#
1971 ** is conditionally asserted when the primary bus discard timer expires.
1972 ** 06 0b Downstream Delayed/Split Read Watchdog Timer Expired:
1973 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR#
1974 ** is conditionally asserted when bridge discards a downstream delayed read ** ** transaction request after receiving 2 24 target retries
1975 ** from the secondary bus target.
1976 ** PCI-X Mode: This bit is set to a 1b and P_SERR# is conditionally asserted
1977 ** when bridge discards a downstream split read request
1978 ** after waiting in excess of 2 24 clocks for the corresponding
1979 ** Split Completion to arrive.
1980 ** 05 0b Downstream Delayed Write/Split Watchdog Timer Expired:
1981 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# is conditionally asserted
1982 ** when bridge discards a downstream delayed write transaction request
1983 ** after receiving 2 24 target retries from the secondary bus target.
1984 ** PCI-X Mode: This bit is set to a 1b and P_SERR#
1985 ** is conditionally asserted when bridge discards a downstream
1986 ** split write request after waiting in excess of 2 24 clocks
1987 ** for the corresponding Split Completion to arrive.
1988 ** 04 0b Master Abort during Downstream Posted Write: This bit is set to a 1b and P_SERR#
1989 ** is conditionally asserted when a Master Abort occurs as a result of an attempt,
1990 ** by bridge, to retire a PMW downstream.
1991 ** 03 0b Target Abort during Downstream Posted Write: This bit is set to a 1b and P_SERR# is conditionally asserted
1992 ** when a Target Abort occurs as a result of an attempt, by bridge,
1993 ** to retire a PMW downstream.
1994 ** 02 0b Downstream Posted Write Data Discarded: This bit is set to a 1b and P_SERR#
1995 ** is conditionally asserted when bridge discards a downstream PMW transaction
1996 ** after receiving 2 24 target retries from the secondary bus target
1997 ** 01 0b Downstream Posted Write Data Parity Error: This bit is set to a 1b and P_SERR#
1998 ** is conditionally asserted when a data parity error is detected by bridge
1999 ** while attempting to retire a PMW downstream.
2000 ** 00 0b Primary Bus Address Parity Error: This bit is set to a 1b and P_SERR# is conditionally asserted
2001 ** when bridge detects an address parity error on the primary bus.
2002 **==================================================================================
2003 ** 0x51-0x50: Bridge Multi-Transaction Timer Register - BMTTR
2004 ** Bit Default Description
2005 ** 15:13 000b Reserved
2006 ** 12:10 000b GRANT# Duration: This field specifies the count (PCI clocks)
2007 ** that a secondary bus master has its grant maintained in order to enable
2008 ** multiple transactions to execute within the same arbitration cycle.
2009 ** Bit[02:00] GNT# Extended Duration
2010 ** 000 MTT Disabled (Default=no GNT# extension)
2016 ** 110 Invalid (treated as 000)
2017 ** 111 Invalid (treated as 000)
2018 ** 09:08 00b Reserved
2019 ** 07:00 FFh MTT Mask: This field enables/disables MTT usage for each REQ#/GNT#
2020 ** pair supported by bridge secondary arbiter.
2021 ** Bit(7) corresponds to SATU internal REQ#/GNT# pair,
2022 ** bit(6) corresponds to bridge internal REQ#/GNT# pair,
2023 ** bit(5) corresponds to REQ#/GNT#(5) pair, etc.
2024 ** When a given bit is set to 1b, its corresponding REQ#/GNT#
2025 ** pair is enabled for MTT functionality as determined by bits(12:10) of this register.
2026 ** When a given bit is cleared to 0b, its corresponding REQ#/GNT# pair is disabled from using the MTT.
2027 **==================================================================================
2028 ** 0x53-0x52: Read Prefetch Policy Register - RPPR
2029 ** Bit Default Description
2030 ** 15:13 000b ReRead_Primary Bus: 3-bit field indicating the multiplication factor
2031 ** to be used in calculating the number of bytes to prefetch from the secondary bus interface on ** subsequent PreFetch operations given that the read demands were not satisfied
2032 ** using the FirstRead parameter.
2033 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount Memory Read 4 DWORDs
2034 ** Memory Read Line 1 cache lines Memory Read Multiple 2 cache lines
2035 ** 12:10 000b FirstRead_Primary Bus: 3-bit field indicating the multiplication factor to be used in calculating
2036 ** the number of bytes to prefetch from the secondary bus interface
2037 ** on the initial PreFetch operation.
2038 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount Memory Read 4 DWORDs
2039 ** Memory Read Line 1 cache line Memory Read Multiple 2 cache lines
2040 ** 09:07 010b ReRead_Secondary Bus: 3-bit field indicating the multiplication factor to be used
2041 ** in calculating the number of bytes to prefetch from the primary
2042 ** bus interface on subsequent PreFetch operations given
2043 ** that the read demands were not satisfied using
2044 ** the FirstRead parameter.
2045 ** The default value of 010b correlates to: Command Type Hardwired pre-fetch a
2046 ** mount Memory Read 3 cache lines Memory Read Line 3 cache lines
2047 ** Memory Read Multiple 6 cache lines
2048 ** 06:04 000b FirstRead_Secondary Bus: 3-bit field indicating the multiplication factor to be used
2049 ** in calculating the number of bytes to prefetch from
2050 ** the primary bus interface on the initial PreFetch operation.
2051 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount
2052 ** Memory Read 4 DWORDs Memory Read Line 1 cache line Memory Read Multiple 2 cache lines
2053 ** 03:00 1111b Staged Prefetch Enable: This field enables/disables the FirstRead/ReRead pre-fetch
2054 ** algorithm for the secondary and the primary bus interfaces.
2055 ** Bit(3) is a ganged enable bit for REQ#/GNT#[7:3], and bits(2:0) provide individual
2056 ** enable bits for REQ#/GNT#[2:0].
2057 ** (bit(2) is the enable bit for REQ#/GNT#[2], etc...)
2058 ** 1b: enables the staged pre-fetch feature
2059 ** 0b: disables staged pre-fetch,
2060 ** and hardwires read pre-fetch policy to the following for
2062 ** Memory Read Line,
2063 ** and Memory Read Multiple commands:
2064 ** Command Type Hardwired Pre-Fetch Amount...
2065 ** Memory Read 4 DWORDs
2066 ** Memory Read Line 1 cache line
2067 ** Memory Read Multiple 2 cache lines
2068 ** NOTE: When the starting address is not cache line aligned, bridge pre-fetches Memory Read line commands
2069 ** only to the next higher cache line boundary.For non-cache line aligned Memory Read
2070 ** Multiple commands bridge pre-fetches only to the second cache line boundary encountered.
2071 **==================================================================================
2072 ** 0x55-0x54: P_SERR# Assertion Control - SERR_CTL
2073 ** Bit Default Description
2074 ** 15 0b Upstream Delayed Transaction Discard Timer Expired: Dictates the bridge behavior
2075 ** in response to its discarding of a delayed transaction that was initiated from the primary bus.
2076 ** 0b=bridge asserts P_SERR#.
2077 ** 1b=bridge does not assert P_SERR#
2078 ** 14 0b Upstream Delayed/Split Read Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer.
2079 ** 0b=bridge asserts P_SERR#.
2080 ** 1b=bridge does not assert P_SERR#
2081 ** 13 0b Upstream Delayed/Split Write Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer.
2082 ** 0b=bridge asserts P_SERR#.
2083 ** 1b=bridge does not assert P_SERR#
2084 ** 12 0b Master Abort during Upstream Posted Write: Dictates bridge behavior following
2085 ** its having detected a Master Abort while attempting to retire one of its PMWs upstream.
2086 ** 0b=bridge asserts P_SERR#.
2087 ** 1b=bridge does not assert P_SERR#
2088 ** 11 0b Target Abort during Upstream Posted Write: Dictates bridge behavior following
2089 ** its having been terminated with Target Abort while attempting to retire one of its PMWs upstream.
2090 ** 0b=bridge asserts P_SERR#.
2091 ** 1b=bridge does not assert P_SERR#
2092 ** 10 0b Upstream Posted Write Data Discarded: Dictates bridge behavior in the event that
2093 ** it discards an upstream posted write transaction.
2094 ** 0b=bridge asserts P_SERR#.
2095 ** 1b=bridge does not assert P_SERR#
2096 ** 09 0b Upstream Posted Write Data Parity Error: Dictates bridge behavior
2097 ** when a data parity error is detected while attempting to retire on of its PMWs upstream.
2098 ** 0b=bridge asserts P_SERR#.
2099 ** 1b=bridge does not assert P_SERR#
2100 ** 08 0b Secondary Bus Address Parity Error: This bit dictates bridge behavior
2101 ** when it detects an address parity error on the secondary bus.
2102 ** 0b=bridge asserts P_SERR#.
2103 ** 1b=bridge does not assert P_SERR#
2104 ** 07 0b Downstream Delayed Transaction Discard Timer Expired: Dictates bridge behavior in response to
2105 ** its discarding of a delayed transaction that was initiated on the secondary bus.
2106 ** 0b=bridge asserts P_SERR#.
2107 ** 1b=bridge does not assert P_SERR#
2108 ** 06 0b Downstream Delayed/Split Read Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer.
2109 ** 0b=bridge asserts P_SERR#.
2110 ** 1b=bridge does not assert P_SERR#
2111 ** 05 0b Downstream Delayed/Split Write Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer.
2112 ** 0b=bridge asserts P_SERR#.
2113 ** 1b=bridge does not assert P_SERR#
2114 ** 04 0b Master Abort during Downstream Posted Write: Dictates bridge behavior following
2115 ** its having detected a Master Abort while attempting to retire one of its PMWs downstream.
2116 ** 0b=bridge asserts P_SERR#.
2117 ** 1b=bridge does not assert P_SERR#
2118 ** 03 0b Target Abort during Downstream Posted Write: Dictates bridge behavior following
2119 ** its having been terminated with Target Abort while attempting to retire one of its PMWs downstream.
2120 ** 0b=bridge asserts P_SERR#.
2121 ** 1b=bridge does not assert P_SERR#
2122 ** 02 0b Downstream Posted Write Data Discarded: Dictates bridge behavior in the event
2123 ** that it discards a downstream posted write transaction.
2124 ** 0b=bridge asserts P_SERR#.
2125 ** 1b=bridge does not assert P_SERR#
2126 ** 01 0b Downstream Posted Write Data Parity Error: Dictates bridge behavior
2127 ** when a data parity error is detected while attempting to retire on of its PMWs downstream.
2128 ** 0b=bridge asserts P_SERR#.
2129 ** 1b=bridge does not assert P_SERR#
2130 ** 00 0b Primary Bus Address Parity Error: This bit dictates bridge behavior
2131 ** when it detects an address parity error on the primary bus.
2132 ** 0b=bridge asserts P_SERR#.
2133 ** 1b=bridge does not assert P_SERR#
2134 **===============================================================================
2135 ** 0x56: Pre-Boot Status Register - PBSR
2136 ** Bit Default Description
2138 ** 06 - Reserved - value indeterminate
2140 ** 01 Varies with External State of S_133EN at PCI Bus Reset Secondary Bus Max Frequency Setting:
2141 ** This bit reflect captured S_133EN strap,
2142 ** indicating the maximum secondary bus clock frequency when in PCI-X mode.
2143 ** Max Allowable Secondary Bus Frequency
2144 ** ** S_133EN PCI-X Mode
2148 **===============================================================================
2149 ** 0x59-0x58: Secondary Decode Enable Register - SDER
2150 ** Bit Default Description
2151 ** 15:03 FFF1h Preserved.
2152 ** 02 Varies with External State of PRIVMEM at PCI Bus Reset Private Memory Space Enable - when set,
2153 ** bridge overrides its secondary inverse decode logic and not
2154 ** forward upstream any secondary bus initiated DAC Memory transactions with AD(63)=1b.
2155 ** This creates a private memory space on the Secondary PCI bus
2156 ** that allows peer-to-peer transactions.
2157 ** 01:00 10 2 Preserved.
2158 **===============================================================================
2159 ** 0x5D-0x5C: Secondary IDSEL Select Register - SISR
2160 ** Bit Default Description
2161 ** 15:10 000000 2 Reserved.
2162 ** 09 Varies with External State of PRIVDEV at PCI Bus Reset AD25- IDSEL Disable - When this bit is set,
2163 ** AD25 is deasserted for any possible Type 1 to Type 0 conversion.
2164 ** When this bit is clear,
2165 ** AD25 is asserted when Primary addresses AD[15:11]=01001 2 during a Type 1 to Type 0 conversion.
2166 ** 08 Varies with External State of PRIVDEV at PCI Bus Reset AD24- IDSEL Disable - When this bit is set,
2167 ** AD24 is deasserted for any possible Type 1 to Type 0 conversion.
2168 ** When this bit is clear,
2169 ** AD24 is asserted when Primary addresses AD[15:11]=01000 2 during a Type 1 to Type 0 conversion.
2170 ** 07 Varies with External State of PRIVDEV at PCI Bus Reset AD23- IDSEL Disable - When this bit is set,
2171 ** AD23 is deasserted for any possible Type 1 to Type 0 conversion.
2172 ** When this bit is clear,
2173 ** AD23 is asserted when Primary addresses AD[15:11]=00111 2 during a Type 1 to Type 0 conversion.
2174 ** 06 Varies with External State of PRIVDEV at PCI Bus Reset AD22- IDSEL Disable - When this bit is set,
2175 ** AD22 is deasserted for any possible Type 1 to Type 0 conversion.
2176 ** When this bit is clear,
2177 ** AD22 is asserted when Primary addresses AD[15:11]=00110 2 during a Type 1 to Type 0 conversion.
2178 ** 05 Varies with External State of PRIVDEV at PCI Bus Reset AD21- IDSEL Disable - When this bit is set,
2179 ** AD21 is deasserted for any possible Type 1 to Type 0 conversion.
2180 ** When this bit is clear,
2181 ** AD21 is asserted when Primary addresses AD[15:11]=00101 2 during a Type 1 to Type 0 conversion.
2182 ** 04 Varies with External State of PRIVDEV at PCI Bus Reset AD20- IDSEL Disable - When this bit is set,
2183 ** AD20 is deasserted for any possible Type 1 to Type 0 conversion.
2184 ** When this bit is clear,
2185 ** AD20 is asserted when Primary addresses AD[15:11]=00100 2 during a Type 1 to Type 0 conversion.
2186 ** 03 Varies with External State of PRIVDEV at PCI Bus Reset AD19- IDSEL Disable - When this bit is set,
2187 ** AD19 is deasserted for any possible Type 1 to Type 0 conversion.
2188 ** When this bit is clear,
2189 ** AD19 is asserted when Primary addresses AD[15:11]=00011 2 during a Type 1 to Type 0 conversion.
2190 ** 02 Varies with External State of PRIVDEV at PCI Bus Reset AD18- IDSEL Disable - When this bit is set,
2191 ** AD18 is deasserted for any possible Type 1 to Type 0 conversion.
2192 ** When this bit is clear,
2193 ** AD18 is asserted when Primary addresses AD[15:11]=00010 2 during a Type 1 to Type 0 conversion.
2194 ** 01 Varies with External State of PRIVDEV at PCI Bus Reset AD17- IDSEL Disable - When this bit is set,
2195 ** AD17 is deasserted for any possible Type 1 to Type 0 conversion.
2196 ** When this bit is clear,
2197 ** AD17 is asserted when Primary addresses AD[15:11]=00001 2 during a Type 1 to Type 0 conversion.
2198 ** 00 Varies with External State of PRIVDEV at PCI Bus Reset AD16- IDSEL Disable - When this bit is set,
2199 ** AD16 is deasserted for any possible Type 1 to Type 0 conversion.
2200 ** When this bit is clear,
2201 ** AD16 is asserted when Primary addresses AD[15:11]=00000 2 during a Type 1 to Type 0 conversion.
2202 **************************************************************************
2205 **************************************************************************
2207 **************************************************************************
2210 **************************************************************************
2211 ** PCI Extended Enhanced Capabilities List CC-FFh
2212 **************************************************************************
2213 ** ----------------------------------------------------------------------------------------------------------
2214 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset
2215 ** ----------------------------------------------------------------------------------------------------------
2216 ** | Power Management Capabilities | Next Item Ptr | Capability ID | DCh
2217 ** ----------------------------------------------------------------------------------------------------------
2218 ** | PM Data | PPB Support | Extensions Power Management CSR | E0h
2219 ** ----------------------------------------------------------------------------------------------------------
2220 ** | Reserved | Reserved | Reserved | E4h
2221 ** ----------------------------------------------------------------------------------------------------------
2223 ** ----------------------------------------------------------------------------------------------------------
2224 ** | Reserved | Reserved | Reserved | Reserved | ECh
2225 ** ----------------------------------------------------------------------------------------------------------
2226 ** | PCI-X Secondary Status | Next Item Ptr | Capability ID | F0h
2227 ** ----------------------------------------------------------------------------------------------------------
2228 ** | PCI-X Bridge Status | F4h
2229 ** ----------------------------------------------------------------------------------------------------------
2230 ** | PCI-X Upstream Split Transaction Control | F8h
2231 ** ----------------------------------------------------------------------------------------------------------
2232 ** | PCI-X Downstream Split Transaction Control | FCh
2233 ** ----------------------------------------------------------------------------------------------------------
2234 **===============================================================================
2235 ** 0xDC: Power Management Capabilities Identifier - PM_CAPID
2236 ** Bit Default Description
2237 ** 07:00 01h Identifier (ID): PCI SIG assigned ID for PCI-PM register block
2238 **===============================================================================
2239 ** 0xDD: Next Item Pointer - PM_NXTP
2240 ** Bit Default Description
2241 ** 07:00 F0H Next Capabilities Pointer (PTR): The register defaults to F0H pointing to the PCI-X Extended Capability Header.
2242 **===============================================================================
2243 ** 0xDF-0xDE: Power Management Capabilities Register - PMCR
2244 ** Bit Default Description
2245 ** 15:11 00h PME Supported (PME): PME# cannot be asserted by bridge.
2246 ** 10 0h State D2 Supported (D2): Indicates no support for state D2. No power management action in this state.
2247 ** 09 1h State D1 Supported (D1): Indicates support for state D1. No power management action in this state.
2248 ** 08:06 0h Auxiliary Current (AUXC): This 3 bit field reports the 3.3Vaux auxiliary current requirements for the PCI function.
2249 ** This returns 000b as PME# wake-up for bridge is not implemented.
2250 ** 05 0 Special Initialization Required (SINT): Special initialization is not required for bridge.
2251 ** 04:03 00 Reserved
2252 ** 02:00 010 Version (VS): Indicates that this supports PCI Bus Power Management Interface Specification, Revision 1.1.
2253 **===============================================================================
2254 ** 0xE1-0xE0: Power Management Control / Status - Register - PMCSR
2255 ** Bit Default Description
2256 ** 15:09 00h Reserved
2257 ** 08 0b PME_Enable: This bit, when set to 1b enables bridge to assert PME#.
2258 ** Note that bridge never has occasion to assert PME# and implements this dummy R/W bit only for the purpose of working around an OS PCI-PM bug.
2259 ** 07:02 00h Reserved
2260 ** 01:00 00 Power State (PSTATE): This 2-bit field is used both to determine the current power state of
2261 ** a function and to set the Function into a new power state.
2265 ** 11 - D3 hot state
2266 **===============================================================================
2267 ** 0xE2: Power Management Control / Status PCI to PCI Bridge Support - PMCSR_BSE
2268 ** Bit Default Description
2269 ** 07 0 Bus Power/Clock Control Enable (BPCC_En): Indicates that the bus power/clock control policies have been disabled.
2270 ** 06 0 B2/B3 support for D3 Hot (B2_B3#): The state of this bit determines the action that
2271 ** is to occur as a direct result of programming the function to D3 hot.
2272 ** This bit is only meaningful when bit 7 (BPCC_En) is a ¡§1¡¨.
2273 ** 05:00 00h Reserved
2274 **===============================================================================
2275 ** 0xE3: Power Management Data Register - PMDR
2276 ** Bit Default Description
2277 ** 07:00 00h Reserved
2278 **===============================================================================
2279 ** 0xF0: PCI-X Capabilities Identifier - PX_CAPID
2280 ** Bit Default Description
2281 ** 07:00 07h Identifier (ID): Indicates this is a PCI-X capabilities list.
2282 **===============================================================================
2283 ** 0xF1: Next Item Pointer - PX_NXTP
2284 ** Bit Default Description
2285 ** 07:00 00h Next Item Pointer: Points to the next capability in the linked list The power on default value of this
2286 ** register is 00h indicating that this is the last entry in the linked list of capabilities.
2287 **===============================================================================
2288 ** 0xF3-0xF2: PCI-X Secondary Status - PX_SSTS
2289 ** Bit Default Description
2290 ** 15:09 00h Reserved
2291 ** 08:06 Xxx Secondary Clock Frequency (SCF): This field is set with the frequency of the secondary bus.
2293 ** ** BitsMax FrequencyClock Period
2294 ** ** 000PCI ModeN/A
2298 ** ** 1xxreservedreserved
2299 ** ** The default value for this register is the operating frequency of the secondary bus
2300 ** 05 0b Split Request Delayed. (SRD): This bit is supposed to be set by a bridge when it cannot forward a transaction on the
2301 ** secondary bus to the primary bus because there is not enough room within the limit
2302 ** specified in the Split Transaction Commitment Limit field in the Downstream Split
2303 ** Transaction Control register. The bridge does not set this bit.
2304 ** 04 0b Split Completion Overrun (SCO): This bit is supposed to be set when a bridge terminates a Split Completion on the ** ** secondary bus with retry or Disconnect at next ADB because its buffers are full.
2305 ** The bridge does not set this bit.
2306 ** 03 0b Unexpected Split Completion (USC): This bit is set when an unexpected split completion with a requester ID
2307 ** equal to bridge secondary bus number, device number 00h,
2308 ** and function number 0 is received on the secondary interface.
2309 ** This bit is cleared by software writing a '1'.
2310 ** 02 0b Split Completion Discarded (SCD): This bit is set
2311 ** when bridge discards a split completion moving toward the secondary bus
2312 ** because the requester would not accept it. This bit cleared by software writing a '1'.
2313 ** 01 1b 133 MHz Capable: Indicates that bridge is capable of running its secondary bus at 133 MHz
2314 ** 00 1b 64-bit Device (D64): Indicates the width of the secondary bus as 64-bits.
2315 **===============================================================================
2316 ** 0xF7-0xF6-0xf5-0xF4: PCI-X Bridge Status - PX_BSTS
2317 ** Bit Default Description
2319 ** 21 0 Split Request Delayed (SRD): This bit does not be set by bridge.
2320 ** 20 0 Split Completion Overrun (SCO): This bit does not be set by bridge
2321 ** because bridge throttles traffic on the completion side.
2322 ** 19 0 Unexpected Split Completion (USC): The bridge sets this bit to 1b
2323 ** when it encounters a corrupted Split Completion, possibly with an ** ** inconsistent remaining byte count.Software clears
2324 ** this bit by writing a 1b to it.
2325 ** 18 0 Split Completion Discarded (SCD): The bridge sets this bit to 1b
2326 ** when it has discarded a Split Completion.Software clears this bit by ** ** writing a 1b to it.
2327 ** 17 1 133 MHz Capable: This bit indicates that the bridge primary interface is ** capable of 133 MHz operation in PCI-X mode.
2328 ** 0=The maximum operating frequency is 66 MHz.
2329 ** 1=The maximum operating frequency is 133 MHz.
2330 ** 16 Varies with the external state of P_32BITPCI# at PCI Bus Reset 64-bit Device (D64): Indicates bus width of the Primary PCI bus interface.
2331 ** 0=Primary Interface is connected as a 32-bit PCI bus.
2332 ** 1=Primary Interface is connected as a 64-bit PCI bus.
2333 ** 15:08 00h Bus Number (BNUM): This field is simply an alias to the PBN field
2334 ** of the BNUM register at offset 18h.
2335 ** Apparently it was deemed necessary reflect it here for diagnostic purposes.
2336 ** 07:03 1fh Device Number (DNUM): Indicates which IDSEL bridge consumes.
2337 ** May be updated whenever a PCI-X
2338 ** configuration write cycle that targets bridge scores a hit.
2339 ** 02:00 0h Function Number (FNUM): The bridge Function #
2340 **===============================================================================
2341 ** 0xFB-0xFA-0xF9-0xF8: PCI-X Upstream Split Transaction Control - PX_USTC
2342 ** Bit Default Description
2343 ** 31:16 003Eh Split Transaction Limit (STL): This register indicates the size of the commitment limit in units of ADQs.
2344 ** Software is permitted to program this register to any value greater than or equal to
2345 ** the contents of the Split Transaction Capacity register. A value less than the contents
2346 ** of the Split Transaction Capacity register causes unspecified results.
2347 ** A value of 003Eh or greater enables the bridge to forward all Split Requests of any
2348 ** size regardless of the amount of buffer space available.
2349 ** 15:00 003Eh Split Transaction Capacity (STC): This read-only field indicates the size of the buffer (number of ADQs) for storing
2350 ** split completions. This register controls behavior of the bridge buffers for forwarding
2351 ** Split Transactions from a primary bus requester to a secondary bus completer.
2352 ** The default value of 003Eh indicates there is available buffer space for 62 ADQs (7936 bytes).
2353 **===============================================================================
2354 ** 0xFF-0xFE-0xFD-0xFC: PCI-X Downstream Split Transaction Control - PX_DSTC
2355 ** Bit Default Description
2356 ** 31:16 003Eh Split Transaction Limit (STL): This register indicates the size of the commitment limit in units of ADQs.
2357 ** Software is permitted to program this register to any value greater than or equal to
2358 ** the contents of the Split Transaction Capacity register. A value less than the contents
2359 ** of the Split Transaction Capacity register causes unspecified results.
2360 ** A value of 003Eh or greater enables the bridge to forward all Split Requests of any
2361 ** size regardless of the amount of buffer space available.
2362 ** 15:00 003Eh Split Transaction Capacity (STC): This read-only field indicates the size of the buffer (number of ADQs) for storing
2363 ** split completions. This register controls behavior of the bridge buffers for forwarding
2364 ** Split Transactions from a primary bus requester to a secondary bus completer.
2365 ** The default value of 003Eh indicates there is available buffer space for 62 ADQs
2367 **************************************************************************
2374 *************************************************************************************************************************************
2375 ** 80331 Address Translation Unit Register Definitions
2376 ** ATU Interface Configuration Header Format
2377 ** The ATU is programmed via a [Type 0] configuration command on the PCI interface.
2378 *************************************************************************************************************************************
2379 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configuration Byte Offset
2380 **===================================================================================================================================
2381 ** | ATU Device ID | Vendor ID | 00h
2382 ** ----------------------------------------------------------------------------------------------------------
2383 ** | Status | Command | 04H
2384 ** ----------------------------------------------------------------------------------------------------------
2385 ** | ATU Class Code | Revision ID | 08H
2386 ** ----------------------------------------------------------------------------------------------------------
2387 ** | ATUBISTR | Header Type | Latency Timer | Cacheline Size | 0CH
2388 ** ----------------------------------------------------------------------------------------------------------
2389 ** | Inbound ATU Base Address 0 | 10H
2390 ** ----------------------------------------------------------------------------------------------------------
2391 ** | Inbound ATU Upper Base Address 0 | 14H
2392 ** ----------------------------------------------------------------------------------------------------------
2393 ** | Inbound ATU Base Address 1 | 18H
2394 ** ----------------------------------------------------------------------------------------------------------
2395 ** | Inbound ATU Upper Base Address 1 | 1CH
2396 ** ----------------------------------------------------------------------------------------------------------
2397 ** | Inbound ATU Base Address 2 | 20H
2398 ** ----------------------------------------------------------------------------------------------------------
2399 ** | Inbound ATU Upper Base Address 2 | 24H
2400 ** ----------------------------------------------------------------------------------------------------------
2402 ** ----------------------------------------------------------------------------------------------------------
2403 ** | ATU Subsystem ID | ATU Subsystem Vendor ID | 2CH
2404 ** ----------------------------------------------------------------------------------------------------------
2405 ** | Expansion ROM Base Address | 30H
2406 ** ----------------------------------------------------------------------------------------------------------
2407 ** | Reserved Capabilities Pointer | 34H
2408 ** ----------------------------------------------------------------------------------------------------------
2410 ** ----------------------------------------------------------------------------------------------------------
2411 ** | Maximum Latency | Minimum Grant | Interrupt Pin | Interrupt Line | 3CH
2412 ** ----------------------------------------------------------------------------------------------------------
2413 *********************************************************************************************************************
2416 ***********************************************************************************
2417 ** ATU Vendor ID Register - ATUVID
2418 ** -----------------------------------------------------------------
2419 ** Bit Default Description
2420 ** 15:00 8086H (0x17D3) ATU Vendor ID - This is a 16-bit value assigned to Intel.
2421 ** This register, combined with the DID, uniquely identify the PCI device.
2422 ** Access type is Read/Write to allow the 80331 to configure the register as a different vendor ID
2423 ** to simulate the interface of a standard mechanism currently used by existing application software.
2424 ***********************************************************************************
2426 #define ARCMSR_ATU_VENDOR_ID_REG 0x00 /*word*/
2428 ***********************************************************************************
2429 ** ATU Device ID Register - ATUDID
2430 ** -----------------------------------------------------------------
2431 ** Bit Default Description
2432 ** 15:00 0336H (0x1110) ATU Device ID - This is a 16-bit value assigned to the ATU.
2433 ** This ID, combined with the VID, uniquely identify any PCI device.
2434 ***********************************************************************************
2436 #define ARCMSR_ATU_DEVICE_ID_REG 0x02 /*word*/
2438 ***********************************************************************************
2439 ** ATU Command Register - ATUCMD
2440 ** -----------------------------------------------------------------
2441 ** Bit Default Description
2442 ** 15:11 000000 2 Reserved
2443 ** 10 0 Interrupt Disable - This bit disables 80331 from asserting the ATU interrupt signal.
2444 ** 0=enables the assertion of interrupt signal.
2445 ** 1=disables the assertion of its interrupt signal.
2446 ** 09 0 2 Fast Back to Back Enable - When cleared,
2447 ** the ATU interface is not allowed to generate fast back-to-back cycles on its bus.
2448 ** Ignored when operating in the PCI-X mode.
2449 ** 08 0 2 SERR# Enable - When cleared, the ATU interface is not allowed to assert SERR# on the PCI interface.
2450 ** 07 1 2 Address/Data Stepping Control - Address stepping is implemented for configuration transactions. The
2451 ** ATU inserts 2 clock cycles of address stepping for Conventional Mode and 4 clock cycles
2452 ** of address stepping for PCI-X mode.
2453 ** 06 0 2 Parity Error Response - When set, the ATU takes normal action when a parity error
2454 ** is detected. When cleared, parity checking is disabled.
2455 ** 05 0 2 VGA Palette Snoop Enable - The ATU interface does not support I/O writes and therefore,
2456 ** does not perform VGA palette snooping.
2457 ** 04 0 2 Memory Write and Invalidate Enable - When set, ATU may generate MWI commands.
2458 ** When clear, ATU use Memory Write commands instead of MWI. Ignored when operating in the PCI-X mode.
2459 ** 03 0 2 Special Cycle Enable - The ATU interface does not respond to special cycle commands in any way.
2460 ** Not implemented and a reserved bit field.
2461 ** 02 0 2 Bus Master Enable - The ATU interface can act as a master on the PCI bus.
2462 ** When cleared, disables the device from generating PCI accesses.
2463 ** When set, allows the device to behave as a PCI bus master.
2464 ** When operating in the PCI-X mode, ATU initiates a split completion transaction regardless
2465 ** of the state of this bit.
2466 ** 01 0 2 Memory Enable - Controls the ATU interface¡¦s response to PCI memory addresses.
2467 ** When cleared, the ATU interface does not respond to any memory access on the PCI bus.
2468 ** 00 0 2 I/O Space Enable - Controls the ATU interface response to I/O transactions.
2469 ** Not implemented and a reserved bit field.
2470 ***********************************************************************************
2472 #define ARCMSR_ATU_COMMAND_REG 0x04 /*word*/
2474 ***********************************************************************************
2475 ** ATU Status Register - ATUSR (Sheet 1 of 2)
2476 ** -----------------------------------------------------------------
2477 ** Bit Default Description
2478 ** 15 0 2 Detected Parity Error - set when a parity error is detected in data received by the ATU on the PCI bus even
2479 ** when the ATUCMD register¡¦s Parity Error Response bit is cleared. Set under the following conditions:
2480 ** ¡E Write Data Parity Error when the ATU is a target (inbound write).
2481 ** ¡E Read Data Parity Error when the ATU is a requester (outbound read).
2482 ** ¡E Any Address or Attribute (PCI-X Only) Parity Error on the Bus ** ** ** (including one generated by the ATU).
2483 ** 14 0 2 SERR# Asserted - set when SERR# is asserted on the PCI bus by the ATU.
2484 ** 13 0 2 Master Abort - set when a transaction initiated by the ATU PCI master interface, ends in a Master-Abort
2485 ** or when the ATU receives a Master Abort Split Completion Error Message in PCI-X mode.
2486 ** 12 0 2 Target Abort (master) - set when a transaction initiated by the ATU PCI master interface, ends in a target
2487 ** abort or when the ATU receives a Target Abort Split Completion Error Message in PCI-X mode.
2488 ** 11 0 2 Target Abort (target) - set when the ATU interface, acting as a target,
2489 ** terminates the transaction on the PCI bus with a target abort.
2490 ** 10:09 01 2 DEVSEL# Timing - These bits are read-only and define the slowest DEVSEL#
2491 ** timing for a target device in Conventional PCI Mode regardless of the operating mode
2492 ** (except configuration accesses).
2497 ** The ATU interface uses Medium timing.
2498 ** 08 0 2 Master Parity Error - The ATU interface sets this bit under the following conditions:
2499 ** ¡E The ATU asserted PERR# itself or the ATU observed PERR# asserted.
2500 ** ¡E And the ATU acted as the requester
2501 ** for the operation in which the error occurred.
2502 ** ¡E And the ATUCMD register¡¦s Parity Error Response bit is set
2503 ** ¡E Or (PCI-X Mode Only) the ATU received a Write Data Parity Error Message
2504 ** ¡E And the ATUCMD register¡¦s Parity Error Response bit is set
2505 ** 07 1 2 (Conventional mode)
2507 ** Fast Back-to-Back - The ATU/Messaging Unit interface is capable of accepting fast back-to-back
2508 ** transactions in Conventional PCI mode when the transactions are not to the same target. Since fast
2509 ** back-to-back transactions do not exist in PCI-X mode, this bit is forced to 0 in the PCI-X mode.
2510 ** 06 0 2 UDF Supported - User Definable Features are not supported
2511 ** 05 1 2 66 MHz. Capable - 66 MHz operation is supported.
2512 ** 04 1 2 Capabilities - When set, this function implements extended capabilities.
2513 ** 03 0 Interrupt Status - reflects the state of the ATU interrupt
2514 ** when the Interrupt Disable bit in the command register is a 0.
2515 ** 0=ATU interrupt signal deasserted.
2516 ** 1=ATU interrupt signal asserted.
2517 ** NOTE: Setting the Interrupt Disable bit to a 1 has no effect on the state of this bit. Refer to
2518 ** Section 3.10.23, ¡§ATU Interrupt Pin Register - ATUIPR¡¨ on page 236 for details on the ATU
2519 ** interrupt signal.
2520 ** 02:00 00000 2 Reserved.
2521 ***********************************************************************************
2523 #define ARCMSR_ATU_STATUS_REG 0x06 /*word*/
2525 ***********************************************************************************
2526 ** ATU Revision ID Register - ATURID
2527 ** -----------------------------------------------------------------
2528 ** Bit Default Description
2529 ** 07:00 00H ATU Revision - identifies the 80331 revision number.
2530 ***********************************************************************************
2532 #define ARCMSR_ATU_REVISION_REG 0x08 /*byte*/
2534 ***********************************************************************************
2535 ** ATU Class Code Register - ATUCCR
2536 ** -----------------------------------------------------------------
2537 ** Bit Default Description
2538 ** 23:16 05H Base Class - Memory Controller
2539 ** 15:08 80H Sub Class - Other Memory Controller
2540 ** 07:00 00H Programming Interface - None defined
2541 ***********************************************************************************
2543 #define ARCMSR_ATU_CLASS_CODE_REG 0x09 /*3bytes 0x0B,0x0A,0x09*/
2545 ***********************************************************************************
2546 ** ATU Cacheline Size Register - ATUCLSR
2547 ** -----------------------------------------------------------------
2548 ** Bit Default Description
2549 ** 07:00 00H ATU Cacheline Size - specifies the system cacheline size in DWORDs. Cacheline size is restricted to either 0, 8 or 16 DWORDs.
2550 ***********************************************************************************
2552 #define ARCMSR_ATU_CACHELINE_SIZE_REG 0x0C /*byte*/
2554 ***********************************************************************************
2555 ** ATU Latency Timer Register - ATULT
2556 ** -----------------------------------------------------------------
2557 ** Bit Default Description
2558 ** 07:03 00000 2 (for Conventional mode)
2559 ** 01000 2 (for PCI-X mode)
2560 ** Programmable Latency Timer - This field varies the latency timer for the interface from 0 to 248 clocks.
2561 ** The default value is 0 clocks for Conventional PCI mode, and 64 clocks for PCI-X mode.
2562 ** 02:00 000 2 Latency Timer Granularity - These Bits are read only giving a programmable granularity of 8 clocks for the latency timer.
2563 ***********************************************************************************
2565 #define ARCMSR_ATU_LATENCY_TIMER_REG 0x0D /*byte*/
2567 ***********************************************************************************
2568 ** ATU Header Type Register - ATUHTR
2569 ** -----------------------------------------------------------------
2570 ** Bit Default Description
2571 ** 07 0 2 Single Function/Multi-Function Device - Identifies the 80331 as a single-function PCI device.
2572 ** 06:00 000000 2 PCI Header Type - This bit field indicates the type of PCI header implemented. The ATU interface
2573 ** header conforms to PCI Local Bus Specification, Revision 2.3.
2574 ***********************************************************************************
2576 #define ARCMSR_ATU_HEADER_TYPE_REG 0x0E /*byte*/
2578 ***********************************************************************************
2579 ** ATU BIST Register - ATUBISTR
2581 ** The ATU BIST Register controls the functions the Intel XScale core performs when BIST is
2582 ** initiated. This register is the interface between the host processor requesting BIST functions and
2583 ** the 80331 replying with the results from the software implementation of the BIST functionality.
2584 ** -----------------------------------------------------------------
2585 ** Bit Default Description
2586 ** 07 0 2 BIST Capable - This bit value is always equal to the ATUCR ATU BIST Interrupt Enable bit.
2587 ** 06 0 2 Start BIST - When the ATUCR BIST Interrupt Enable bit is set:
2588 ** Setting this bit generates an interrupt to the Intel XScale core to perform a software BIST function.
2589 ** The Intel XScale core clears this bit when the BIST software has completed with the BIST results
2590 ** found in ATUBISTR register bits [3:0].
2591 ** When the ATUCR BIST Interrupt Enable bit is clear:
2592 ** Setting this bit does not generate an interrupt to the Intel XScale core and no BIST functions is performed.
2593 ** The Intel XScale core does not clear this bit.
2594 ** 05:04 00 2 Reserved
2595 ** 03:00 0000 2 BIST Completion Code - when the ATUCR BIST Interrupt Enable bit is set and the ATUBISTR Start BIST bit is set (bit 6):
2596 ** The Intel XScale core places the results of the software BIST in these bits.
2597 ** A nonzero value indicates a device-specific error.
2598 ***********************************************************************************
2600 #define ARCMSR_ATU_BIST_REG 0x0F /*byte*/
2603 ***************************************************************************************
2604 ** ATU Base Registers and Associated Limit Registers
2605 ***************************************************************************************
2606 ** Base Address Register Limit Register Description
2607 ** Inbound ATU Base Address Register 0 Inbound ATU Limit Register 0 Defines the inbound translation window 0 from the PCI bus.
2608 ** Inbound ATU Upper Base Address Register 0 N/A Together with ATU Base Address Register 0 defines the inbound ** translation window 0 from the PCI bus for DACs.
2609 ** Inbound ATU Base Address Register 1 Inbound ATU Limit Register 1 Defines inbound window 1 from the PCI bus.
2610 ** Inbound ATU Upper Base Address Register 1 N/A Together with ATU Base Address Register 1 defines inbound window ** 1 from the PCI bus for DACs.
2611 ** Inbound ATU Base Address Register 2 Inbound ATU Limit Register 2 Defines the inbound translation window 2 from the PCI bus.
2612 ** Inbound ATU Upper Base Address Register 2 N/A Together with ATU Base Address Register 2 defines the inbound ** ** translation window 2 from the PCI bus for DACs.
2613 ** Inbound ATU Base Address Register 3 Inbound ATU Limit Register 3 Defines the inbound translation window 3 from the PCI bus.
2614 ** Inbound ATU Upper Base Address Register 3 N/A Together with ATU Base Address Register 3 defines the inbound ** ** translation window 3 from the PCI bus for DACs.
2615 ** NOTE: This is a private BAR that resides outside of the standard PCI configuration header space (offsets 00H-3FH).
2616 ** Expansion ROM Base Address Register Expansion ROM Limit Register Defines the window of addresses used by a bus master for reading ** from an Expansion ROM.
2617 **--------------------------------------------------------------------------------------
2618 ** ATU Inbound Window 1 is not a translate window.
2619 ** The ATU does not claim any PCI accesses that fall within this range.
2620 ** This window is used to allocate host memory for use by Private Devices.
2621 ** When enabled, the ATU interrupts the Intel XScale core when either the IABAR1 register or the IAUBAR1 register is written from the PCI bus.
2622 ***********************************************************************************
2626 ***********************************************************************************
2627 ** Inbound ATU Base Address Register 0 - IABAR0
2629 ** . The Inbound ATU Base Address Register 0 (IABAR0) together with the Inbound ATU Upper Base Address Register 0 (IAUBAR0)
2630 ** defines the block of memory addresses where the inbound translation window 0 begins.
2631 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory.
2632 ** . The IABAR0 and IAUBAR0 define the base address and describes the required memory block size.
2633 ** . Bits 31 through 12 of the IABAR0 is either read/write bits or read only with a value of 0
2634 ** depending on the value located within the IALR0.
2635 ** This configuration allows the IABAR0 to be programmed per PCI Local Bus Specification.
2636 ** The first 4 Kbytes of memory defined by the IABAR0, IAUBAR0 and the IALR0 is reserved for the Messaging Unit.
2637 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment.
2639 ** When IALR0 is cleared prior to host configuration:
2640 ** the user should also clear the Prefetchable Indicator and the Type Indicator.
2641 ** Assuming IALR0 is not cleared:
2642 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary,
2643 ** when the Prefetchable Indicator is cleared prior to host configuration,
2644 ** the user should also set the Type Indicator for 32 bit addressability.
2645 ** b. For compliance to the PCI-X Addendum to the PCI Local Bus Specification,
2646 ** when the Prefetchable Indicator is set prior to host configuration, the user
2647 ** should also set the Type Indicator for 64 bit addressability.
2648 ** This is the default for IABAR0.
2649 ** -----------------------------------------------------------------
2650 ** Bit Default Description
2651 ** 31:12 00000H Translation Base Address 0 - These bits define the actual location
2652 ** the translation function is to respond to when addressed from the PCI bus.
2653 ** 11:04 00H Reserved.
2654 ** 03 1 2 Prefetchable Indicator - When set, defines the memory space as prefetchable.
2655 ** 02:01 10 2 Type Indicator - Defines the width of the addressability for this memory window:
2656 ** 00 - Memory Window is locatable anywhere in 32 bit address space
2657 ** 10 - Memory Window is locatable anywhere in 64 bit address space
2658 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address.
2659 ** The ATU does not occupy I/O space,
2660 ** thus this bit must be zero.
2661 ***********************************************************************************
2663 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS0_REG 0x10 /*dword 0x13,0x12,0x11,0x10*/
2664 #define ARCMSR_INBOUND_ATU_MEMORY_PREFETCHABLE 0x08
2665 #define ARCMSR_INBOUND_ATU_MEMORY_WINDOW64 0x04
2667 ***********************************************************************************
2668 ** Inbound ATU Upper Base Address Register 0 - IAUBAR0
2670 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes.
2671 ** Together with the Translation Base Address this register defines the actual location the translation
2672 ** function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs).
2673 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment.
2675 ** When the Type indicator of IABAR0 is set to indicate 32 bit addressability,
2676 ** the IAUBAR0 register attributes are read-only.
2677 ** -----------------------------------------------------------------
2678 ** Bit Default Description
2679 ** 31:0 00000H Translation Upper Base Address 0 - Together with the Translation Base Address 0 these bits define the
2680 ** actual location the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes.
2681 ***********************************************************************************
2683 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS0_REG 0x14 /*dword 0x17,0x16,0x15,0x14*/
2685 ***********************************************************************************
2686 ** Inbound ATU Base Address Register 1 - IABAR1
2688 ** . The Inbound ATU Base Address Register (IABAR1) together with the Inbound ATU Upper Base Address Register 1 (IAUBAR1)
2689 ** defines the block of memory addresses where the inbound translation window 1 begins.
2690 ** . This window is used merely to allocate memory on the PCI bus and, the ATU does not process any PCI bus transactions to this memory range.
2691 ** . The programmed value within the base address register must comply with the PCI programming requirements for address alignment.
2692 ** . When enabled, the ATU interrupts the Intel XScale core when the IABAR1 register is written from the PCI bus.
2694 ** When a non-zero value is not written to IALR1 prior to host configuration,
2695 ** the user should not set either the Prefetchable Indicator or the Type Indicator for 64 bit addressability.
2696 ** This is the default for IABAR1.
2697 ** Assuming a non-zero value is written to IALR1,
2698 ** the user may set the Prefetchable Indicator
2699 ** or the Type Indicator:
2700 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address
2701 ** boundary, when the Prefetchable Indicator is not set prior to host configuration,
2702 ** the user should also leave the Type Indicator set for 32 bit addressability.
2703 ** This is the default for IABAR1.
2704 ** b. when the Prefetchable Indicator is set prior to host configuration,
2705 ** the user should also set the Type Indicator for 64 bit addressability.
2706 ** -----------------------------------------------------------------
2707 ** Bit Default Description
2708 ** 31:12 00000H Translation Base Address 1 - These bits define the actual location of window 1 on the PCI bus.
2709 ** 11:04 00H Reserved.
2710 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable.
2711 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window:
2712 ** 00 - Memory Window is locatable anywhere in 32 bit address space
2713 ** 10 - Memory Window is locatable anywhere in 64 bit address space
2714 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address.
2715 ** The ATU does not occupy I/O space,
2716 ** thus this bit must be zero.
2717 ***********************************************************************************
2719 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS1_REG 0x18 /*dword 0x1B,0x1A,0x19,0x18*/
2721 ***********************************************************************************
2722 ** Inbound ATU Upper Base Address Register 1 - IAUBAR1
2724 ** This register contains the upper base address when locating this window for PCI addresses beyond 4 GBytes.
2725 ** Together with the IABAR1 this register defines the actual location for this memory window for addresses > 4GBytes (for DACs).
2726 ** This window is used merely to allocate memory on the PCI bus and, the ATU does not process any PCI bus transactions to this memory range.
2727 ** The programmed value within the base address register must comply with the PCI programming
2728 ** requirements for address alignment.
2729 ** When enabled, the ATU interrupts the Intel XScale core when the IAUBAR1 register is written
2730 ** from the PCI bus.
2732 ** When the Type indicator of IABAR1 is set to indicate 32 bit addressability,
2733 ** the IAUBAR1 register attributes are read-only.
2734 ** This is the default for IABAR1.
2735 ** -----------------------------------------------------------------
2736 ** Bit Default Description
2737 ** 31:0 00000H Translation Upper Base Address 1 - Together with the Translation Base Address 1
2738 ** these bits define the actual location for this memory window on the PCI bus for addresses > 4GBytes.
2739 ***********************************************************************************
2741 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS1_REG 0x1C /*dword 0x1F,0x1E,0x1D,0x1C*/
2743 ***********************************************************************************
2744 ** Inbound ATU Base Address Register 2 - IABAR2
2746 ** . The Inbound ATU Base Address Register 2 (IABAR2) together with the Inbound ATU Upper Base Address Register 2 (IAUBAR2)
2747 ** defines the block of memory addresses where the inbound translation window 2 begins.
2748 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory.
2749 ** . The IABAR2 and IAUBAR2 define the base address and describes the required memory block size
2750 ** . Bits 31 through 12 of the IABAR2 is either read/write bits or read only with a value of 0 depending on the value located within the IALR2.
2751 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment.
2753 ** When a non-zero value is not written to IALR2 prior to host configuration,
2754 ** the user should not set either the Prefetchable Indicator
2755 ** or the Type Indicator for 64 bit addressability.
2756 ** This is the default for IABAR2.
2757 ** Assuming a non-zero value is written to IALR2,
2758 ** the user may set the Prefetchable Indicator
2759 ** or the Type Indicator:
2760 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary,
2761 ** when the Prefetchable Indicator is not set prior to host configuration,
2762 ** the user should also leave the Type Indicator set for 32 bit addressability.
2763 ** This is the default for IABAR2.
2764 ** b. when the Prefetchable Indicator is set prior to host configuration,
2765 ** the user should also set the Type Indicator for 64 bit addressability.
2766 ** -----------------------------------------------------------------
2767 ** Bit Default Description
2768 ** 31:12 00000H Translation Base Address 2 - These bits define the actual location
2769 ** the translation function is to respond to when addressed from the PCI bus.
2770 ** 11:04 00H Reserved.
2771 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable.
2772 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window:
2773 ** 00 - Memory Window is locatable anywhere in 32 bit address space
2774 ** 10 - Memory Window is locatable anywhere in 64 bit address space
2775 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address.
2776 ** The ATU does not occupy I/O space,
2777 ** thus this bit must be zero.
2778 ***********************************************************************************
2780 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS2_REG 0x20 /*dword 0x23,0x22,0x21,0x20*/
2782 ***********************************************************************************
2783 ** Inbound ATU Upper Base Address Register 2 - IAUBAR2
2785 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes.
2786 ** Together with the Translation Base Address this register defines the actual location
2787 ** the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs).
2788 ** The programmed value within the base address register must comply with the PCI programming
2789 ** requirements for address alignment.
2791 ** When the Type indicator of IABAR2 is set to indicate 32 bit addressability,
2792 ** the IAUBAR2 register attributes are read-only.
2793 ** This is the default for IABAR2.
2794 ** -----------------------------------------------------------------
2795 ** Bit Default Description
2796 ** 31:0 00000H Translation Upper Base Address 2 - Together with the Translation Base Address 2
2797 ** these bits define the actual location the translation function is to respond to
2798 ** when addressed from the PCI bus for addresses > 4GBytes.
2799 ***********************************************************************************
2801 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS2_REG 0x24 /*dword 0x27,0x26,0x25,0x24*/
2803 ***********************************************************************************
2804 ** ATU Subsystem Vendor ID Register - ASVIR
2805 ** -----------------------------------------------------------------
2806 ** Bit Default Description
2807 ** 15:0 0000H Subsystem Vendor ID - This register uniquely identifies the add-in board or subsystem vendor.
2808 ***********************************************************************************
2810 #define ARCMSR_ATU_SUBSYSTEM_VENDOR_ID_REG 0x2C /*word 0x2D,0x2C*/
2812 ***********************************************************************************
2813 ** ATU Subsystem ID Register - ASIR
2814 ** -----------------------------------------------------------------
2815 ** Bit Default Description
2816 ** 15:0 0000H Subsystem ID - uniquely identifies the add-in board or subsystem.
2817 ***********************************************************************************
2819 #define ARCMSR_ATU_SUBSYSTEM_ID_REG 0x2E /*word 0x2F,0x2E*/
2821 ***********************************************************************************
2822 ** Expansion ROM Base Address Register -ERBAR
2823 ** -----------------------------------------------------------------
2824 ** Bit Default Description
2825 ** 31:12 00000H Expansion ROM Base Address - These bits define the actual location
2826 ** where the Expansion ROM address window resides when addressed from the PCI bus on any 4 Kbyte boundary.
2827 ** 11:01 000H Reserved
2828 ** 00 0 2 Address Decode Enable - This bit field shows the ROM address
2829 ** decoder is enabled or disabled. When cleared, indicates the address decoder is disabled.
2830 ***********************************************************************************
2832 #define ARCMSR_EXPANSION_ROM_BASE_ADDRESS_REG 0x30 /*dword 0x33,0x32,0v31,0x30*/
2833 #define ARCMSR_EXPANSION_ROM_ADDRESS_DECODE_ENABLE 0x01
2835 ***********************************************************************************
2836 ** ATU Capabilities Pointer Register - ATU_CAP_PTR
2837 ** -----------------------------------------------------------------
2838 ** Bit Default Description
2839 ** 07:00 C0H Capability List Pointer - This provides an offset in this function¡¦s configuration space
2840 ** that points to the 80331 PCl Bus Power Management extended capability.
2841 ***********************************************************************************
2843 #define ARCMSR_ATU_CAPABILITY_PTR_REG 0x34 /*byte*/
2845 ***********************************************************************************
2846 ** Determining Block Sizes for Base Address Registers
2847 ** The required address size and type can be determined by writing ones to a base address register and
2848 ** reading from the registers. By scanning the returned value from the least-significant bit of the base
2849 ** address registers upwards, the programmer can determine the required address space size. The
2850 ** binary-weighted value of the first non-zero bit found indicates the required amount of space.
2851 ** Table 105 describes the relationship between the values read back and the byte sizes the base
2852 ** address register requires.
2853 ** As an example, assume that FFFF.FFFFH is written to the ATU Inbound Base Address Register 0
2854 ** (IABAR0) and the value read back is FFF0.0008H. Bit zero is a zero, so the device requires
2855 ** memory address space. Bit three is one, so the memory does supports prefetching. Scanning
2856 ** upwards starting at bit four, bit twenty is the first one bit found. The binary-weighted value of this
2857 ** bit is 1,048,576, indicated that the device requires 1 Mbyte of memory space.
2858 ** The ATU Base Address Registers and the Expansion ROM Base Address Register use their
2859 ** associated limit registers to enable which bits within the base address register are read/write and
2860 ** which bits are read only (0). This allows the programming of these registers in a manner similar to
2861 ** other PCI devices even though the limit is variable.
2862 ** Table 105. Memory Block Size Read Response
2863 ** Response After Writing all 1s
2864 ** to the Base Address Register
2867 ** Response After Writing all 1s
2868 ** to the Base Address Register
2871 ** FFFFFFF0H 16 FFF00000H 1 M
2872 ** FFFFFFE0H 32 FFE00000H 2 M
2873 ** FFFFFFC0H 64 FFC00000H 4 M
2874 ** FFFFFF80H 128 FF800000H 8 M
2875 ** FFFFFF00H 256 FF000000H 16 M
2876 ** FFFFFE00H 512 FE000000H 32 M
2877 ** FFFFFC00H 1K FC000000H 64 M
2878 ** FFFFF800H 2K F8000000H 128 M
2879 ** FFFFF000H 4K F0000000H 256 M
2880 ** FFFFE000H 8K E0000000H 512 M
2881 ** FFFFC000H 16K C0000000H 1 G
2882 ** FFFF8000H 32K 80000000H 2 G
2895 ***************************************************************************************
2901 ***********************************************************************************
2902 ** ATU Interrupt Line Register - ATUILR
2903 ** -----------------------------------------------------------------
2904 ** Bit Default Description
2905 ** 07:00 FFH Interrupt Assigned - system-assigned value identifies which system interrupt controller¡¦s interrupt
2906 ** request line connects to the device's PCI interrupt request lines
2907 ** (as specified in the interrupt pin register).
2908 ** A value of FFH signifies ¡§no connection¡¨ or ¡§unknown¡¨.
2909 ***********************************************************************************
2911 #define ARCMSR_ATU_INTERRUPT_LINE_REG 0x3C /*byte*/
2913 ***********************************************************************************
2914 ** ATU Interrupt Pin Register - ATUIPR
2915 ** -----------------------------------------------------------------
2916 ** Bit Default Description
2917 ** 07:00 01H Interrupt Used - A value of 01H signifies that the ATU interface unit uses INTA# as the interrupt pin.
2918 ***********************************************************************************
2920 #define ARCMSR_ATU_INTERRUPT_PIN_REG 0x3D /*byte*/
2922 ***********************************************************************************
2923 ** ATU Minimum Grant Register - ATUMGNT
2924 ** -----------------------------------------------------------------
2925 ** Bit Default Description
2926 ** 07:00 80H This register specifies how long a burst period the device needs in increments of 8 PCI clocks.
2927 ***********************************************************************************
2929 #define ARCMSR_ATU_MINIMUM_GRANT_REG 0x3E /*byte*/
2931 ***********************************************************************************
2932 ** ATU Maximum Latency Register - ATUMLAT
2933 ** -----------------------------------------------------------------
2934 ** Bit Default Description
2935 ** 07:00 00H Specifies frequency (how often) the device needs to access the PCI bus
2936 ** in increments of 8 PCI clocks. A zero value indicates the device has no stringent requirement.
2937 ***********************************************************************************
2939 #define ARCMSR_ATU_MAXIMUM_LATENCY_REG 0x3F /*byte*/
2941 ***********************************************************************************
2942 ** Inbound Address Translation
2944 ** The ATU allows external PCI bus initiators to directly access the internal bus.
2945 ** These PCI bus initiators can read or write 80331 memory-mapped registers or 80331 local memory space.
2946 ** The process of inbound address translation involves two steps:
2947 ** 1. Address Detection.
2948 ** ¡E Determine when the 32-bit PCI address (64-bit PCI address during DACs) is
2949 ** within the address windows defined for the inbound ATU.
2950 ** ¡E Claim the PCI transaction with medium DEVSEL# timing in the conventional PCI
2951 ** mode and with Decode A DEVSEL# timing in the PCI-X mode.
2952 ** 2. Address Translation.
2953 ** ¡E Translate the 32-bit PCI address (lower 32-bit PCI address during DACs) to a 32-bit 80331 internal bus address.
2954 ** The ATU uses the following registers in inbound address window 0 translation:
2955 ** ¡E Inbound ATU Base Address Register 0
2956 ** ¡E Inbound ATU Limit Register 0
2957 ** ¡E Inbound ATU Translate Value Register 0
2958 ** The ATU uses the following registers in inbound address window 2 translation:
2959 ** ¡E Inbound ATU Base Address Register 2
2960 ** ¡E Inbound ATU Limit Register 2
2961 ** ¡E Inbound ATU Translate Value Register 2
2962 ** The ATU uses the following registers in inbound address window 3 translation:
2963 ** ¡E Inbound ATU Base Address Register 3
2964 ** ¡E Inbound ATU Limit Register 3
2965 ** ¡E Inbound ATU Translate Value Register 3
2966 ** Note: Inbound Address window 1 is not a translate window.
2967 ** Instead, window 1 may be used to allocate host memory for Private Devices.
2968 ** Inbound Address window 3 does not reside in the standard section of the configuration header (offsets 00H - 3CH),
2969 ** thus the host BIOS does not configure window 3.
2970 ** Window 3 is intended to be used as a special window into local memory for private PCI
2971 ** agents controlled by the 80331 in conjunction with the Private Memory Space of the bridge.
2972 ** PCI-to-PCI Bridge in 80331 or
2973 ** Inbound address detection is determined from the 32-bit PCI address,
2974 ** (64-bit PCI address during DACs) the base address register and the limit register.
2975 ** In the case of DACs none of the upper 32-bits of the address is masked during address comparison.
2977 ** The algorithm for detection is:
2979 ** Equation 1. Inbound Address Detection
2980 ** When (PCI_Address [31:0] & Limit_Register[31:0]) == (Base_Register[31:0] & PCI_Address [63:32]) == Base_Register[63:32] (for DACs only)
2981 ** the PCI Address is claimed by the Inbound ATU.
2983 ** The incoming 32-bit PCI address (lower 32-bits of the address in case of DACs) is bitwise ANDed
2984 ** with the associated inbound limit register.
2985 ** When the result matches the base register (and upper base address matches upper PCI address in case of DACs),
2986 ** the inbound PCI address is detected as being within the inbound translation window and is claimed by the ATU.
2988 ** Note: The first 4 Kbytes of the ATU inbound address translation window 0 are reserved for the Messaging Unit.
2989 ** Once the transaction is claimed, the address must be translated from a PCI address to a 32-bit
2990 ** internal bus address. In case of DACs upper 32-bits of the address is simply discarded and only the
2991 ** lower 32-bits are used during address translation.
2992 ** The algorithm is:
2995 ** Equation 2. Inbound Translation
2996 ** Intel I/O processor Internal Bus Address=(PCI_Address[31:0] & ~Limit_Register[31:0]) | ATU_Translate_Value_Register[31:0].
2998 ** The incoming 32-bit PCI address (lower 32-bits in case of DACs) is first bitwise ANDed with the
2999 ** bitwise inverse of the limit register. This result is bitwise ORed with the ATU Translate Value and
3000 ** the result is the internal bus address. This translation mechanism is used for all inbound memory
3001 ** read and write commands excluding inbound configuration read and writes.
3002 ** In the PCI mode for inbound memory transactions, the only burst order supported is Linear
3003 ** Incrementing. For any other burst order, the ATU signals a Disconnect after the first data phase.
3004 ** The PCI-X supports linear incrementing only, and hence above situation is not encountered in the PCI-X mode.
3007 ** Base_Register=3A00 0000H
3008 ** Limit_Register=FF80 0000H (8 Mbyte limit value)
3009 ** Value_Register=B100 0000H
3010 ** Inbound Translation Window ranges from 3A00 0000H to 3A7F FFFFH (8 Mbytes)
3012 ** Address Detection (32-bit address)
3014 ** PCI_Address & Limit_Register == Base_Register
3015 ** 3A45 012CH & FF80 0000H == 3A00 0000H
3017 ** ANS: PCI_Address is in the Inbound Translation Window
3018 ** Address Translation (to get internal bus address)
3020 ** IB_Address=(PCI_Address & ~Limit_Register) | Value_Reg
3021 ** IB_Address=(3A45 012CH & 007F FFFFH) | B100 0000H
3023 ** ANS:IB_Address=B145 012CH
3024 ***********************************************************************************
3030 ***********************************************************************************
3031 ** Inbound ATU Limit Register 0 - IALR0
3033 ** Inbound address translation for memory window 0 occurs for data transfers occurring from the PCI
3034 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts
3035 ** PCI addresses to internal bus addresses.
3036 ** The 80331 translate value register¡¦s programmed value must be naturally aligned with the base
3037 ** address register¡¦s programmed value. The limit register is used as a mask; thus, the lower address
3038 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus
3039 ** Specification, Revision 2.3 for additional information on programming base address registers.
3040 ** Bits 31 to 12 within the IALR0 have a direct effect on the IABAR0 register, bits 31 to 12, with a
3041 ** one to one correspondence. A value of 0 in a bit within the IALR0 makes the corresponding bit
3042 ** within the IABAR0 a read only bit which always returns 0. A value of 1 in a bit within the IALR0
3043 ** makes the corresponding bit within the IABAR0 read/write from PCI. Note that a consequence of
3044 ** this programming scheme is that unless a valid value exists within the IALR0, all writes to the
3045 ** IABAR0 has no effect since a value of all zeros within the IALR0 makes the IABAR0 a read only register.
3046 ** -----------------------------------------------------------------
3047 ** Bit Default Description
3048 ** 31:12 FF000H Inbound Translation Limit 0 - This readback value determines the memory block size required for
3049 ** inbound memory window 0 of the address translation unit. This defaults to an inbound window of 16MB.
3050 ** 11:00 000H Reserved
3051 ***********************************************************************************
3053 #define ARCMSR_INBOUND_ATU_LIMIT0_REG 0x40 /*dword 0x43,0x42,0x41,0x40*/
3055 ***********************************************************************************
3056 ** Inbound ATU Translate Value Register 0 - IATVR0
3058 ** The Inbound ATU Translate Value Register 0 (IATVR0) contains the internal bus address used to
3059 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the
3060 ** inbound ATU address translation.
3061 ** -----------------------------------------------------------------
3062 ** Bit Default Description
3063 ** 31:12 FF000H Inbound ATU Translation Value 0 - This value is used to convert the PCI address to internal bus addresses.
3064 ** This value must be 64-bit aligned on the internal bus.
3065 ** The default address allows the ATU to access the internal 80331 memory-mapped registers.
3066 ** 11:00 000H Reserved
3067 ***********************************************************************************
3069 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE0_REG 0x44 /*dword 0x47,0x46,0x45,0x44*/
3071 ***********************************************************************************
3072 ** Expansion ROM Limit Register - ERLR
3074 ** The Expansion ROM Limit Register (ERLR) defines the block size of addresses the ATU defines
3075 ** as Expansion ROM address space. The block size is programmed by writing a value into the ERLR.
3076 ** Bits 31 to 12 within the ERLR have a direct effect on the ERBAR register, bits 31 to 12, with a one
3077 ** to one correspondence. A value of 0 in a bit within the ERLR makes the corresponding bit within
3078 ** the ERBAR a read only bit which always returns 0. A value of 1 in a bit within the ERLR makes
3079 ** the corresponding bit within the ERBAR read/write from PCI.
3080 ** -----------------------------------------------------------------
3081 ** Bit Default Description
3082 ** 31:12 000000H Expansion ROM Limit - Block size of memory required for the Expansion ROM translation unit. Default
3083 ** value is 0, which indicates no Expansion ROM address space and all bits within the ERBAR are read only with a value of 0.
3084 ** 11:00 000H Reserved.
3085 ***********************************************************************************
3087 #define ARCMSR_EXPANSION_ROM_LIMIT_REG 0x48 /*dword 0x4B,0x4A,0x49,0x48*/
3089 ***********************************************************************************
3090 ** Expansion ROM Translate Value Register - ERTVR
3092 ** The Expansion ROM Translate Value Register contains the 80331 internal bus address which the
3093 ** ATU converts the PCI bus access. This address is driven on the internal bus as a result of the
3094 ** Expansion ROM address translation.
3095 ** -----------------------------------------------------------------
3096 ** Bit Default Description
3097 ** 31:12 00000H Expansion ROM Translation Value - Used to convert PCI addresses to 80331 internal bus addresses
3098 ** for Expansion ROM accesses. The Expansion ROM address translation value must be word aligned on the internal bus.
3099 ** 11:00 000H Reserved
3100 ***********************************************************************************
3102 #define ARCMSR_EXPANSION_ROM_TRANSLATE_VALUE_REG 0x4C /*dword 0x4F,0x4E,0x4D,0x4C*/
3104 ***********************************************************************************
3105 ** Inbound ATU Limit Register 1 - IALR1
3107 ** Bits 31 to 12 within the IALR1 have a direct effect on the IABAR1 register, bits 31 to 12, with a
3108 ** one to one correspondence. A value of 0 in a bit within the IALR1 makes the corresponding bit
3109 ** within the IABAR1 a read only bit which always returns 0. A value of 1 in a bit within the IALR1
3110 ** makes the corresponding bit within the IABAR1 read/write from PCI. Note that a consequence of
3111 ** this programming scheme is that unless a valid value exists within the IALR1, all writes to the
3112 ** IABAR1 has no effect since a value of all zeros within the IALR1 makes the IABAR1 a read only
3114 ** The inbound memory window 1 is used merely to allocate memory on the PCI bus. The ATU does
3115 ** not process any PCI bus transactions to this memory range.
3116 ** Warning: The ATU does not claim any PCI accesses that fall within the range defined by IABAR1,
3117 ** IAUBAR1, and IALR1.
3118 ** -----------------------------------------------------------------
3119 ** Bit Default Description
3120 ** 31:12 00000H Inbound Translation Limit 1 - This readback value determines the memory block size
3121 ** required for the ATUs memory window 1.
3122 ** 11:00 000H Reserved
3123 ***********************************************************************************
3125 #define ARCMSR_INBOUND_ATU_LIMIT1_REG 0x50 /*dword 0x53,0x52,0x51,0x50*/
3127 ***********************************************************************************
3128 ** Inbound ATU Limit Register 2 - IALR2
3130 ** Inbound address translation for memory window 2 occurs for data transfers occurring from the PCI
3131 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts
3132 ** PCI addresses to internal bus addresses.
3133 ** The inbound translation base address for inbound window 2 is specified in Section 3.10.15. When
3134 ** determining block size requirements ¡X as described in Section 3.10.21 ¡X the translation limit
3135 ** register provides the block size requirements for the base address register. The remaining registers
3136 ** used for performing address translation are discussed in Section 3.2.1.1.
3137 ** The 80331 translate value register¡¦s programmed value must be naturally aligned with the base
3138 ** address register¡¦s programmed value. The limit register is used as a mask; thus, the lower address
3139 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus
3140 ** Specification, Revision 2.3 for additional information on programming base address registers.
3141 ** Bits 31 to 12 within the IALR2 have a direct effect on the IABAR2 register, bits 31 to 12, with a
3142 ** one to one correspondence. A value of 0 in a bit within the IALR2 makes the corresponding bit
3143 ** within the IABAR2 a read only bit which always returns 0. A value of 1 in a bit within the IALR2
3144 ** makes the corresponding bit within the IABAR2 read/write from PCI. Note that a consequence of
3145 ** this programming scheme is that unless a valid value exists within the IALR2, all writes to the
3146 ** IABAR2 has no effect since a value of all zeros within the IALR2 makes the IABAR2 a read only
3148 ** -----------------------------------------------------------------
3149 ** Bit Default Description
3150 ** 31:12 00000H Inbound Translation Limit 2 - This readback value determines the memory block size
3151 ** required for the ATUs memory window 2.
3152 ** 11:00 000H Reserved
3153 ***********************************************************************************
3155 #define ARCMSR_INBOUND_ATU_LIMIT2_REG 0x54 /*dword 0x57,0x56,0x55,0x54*/
3157 ***********************************************************************************
3158 ** Inbound ATU Translate Value Register 2 - IATVR2
3160 ** The Inbound ATU Translate Value Register 2 (IATVR2) contains the internal bus address used to
3161 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the
3162 ** inbound ATU address translation.
3163 ** -----------------------------------------------------------------
3164 ** Bit Default Description
3165 ** 31:12 00000H Inbound ATU Translation Value 2 - This value is used to convert the PCI address to internal bus addresses.
3166 ** This value must be 64-bit aligned on the internal bus.
3167 ** The default address allows the ATU to access the internal 80331 ** ** memory-mapped registers.
3168 ** 11:00 000H Reserved
3169 ***********************************************************************************
3171 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE2_REG 0x58 /*dword 0x5B,0x5A,0x59,0x58*/
3173 ***********************************************************************************
3174 ** Outbound I/O Window Translate Value Register - OIOWTVR
3176 ** The Outbound I/O Window Translate Value Register (OIOWTVR) contains the PCI I/O address
3177 ** used to convert the internal bus access to a PCI address. This address is driven on the PCI bus as a
3178 ** result of the outbound ATU address translation.
3179 ** The I/O window is from 80331 internal bus address 9000 000H to 9000 FFFFH with the fixed
3180 ** length of 64 Kbytes.
3181 ** -----------------------------------------------------------------
3182 ** Bit Default Description
3183 ** 31:16 0000H Outbound I/O Window Translate Value - Used to convert internal bus addresses to PCI addresses.
3184 ** 15:00 0000H Reserved
3185 ***********************************************************************************
3187 #define ARCMSR_OUTBOUND_IO_WINDOW_TRANSLATE_VALUE_REG 0x5C /*dword 0x5F,0x5E,0x5D,0x5C*/
3189 ***********************************************************************************
3190 ** Outbound Memory Window Translate Value Register 0 -OMWTVR0
3192 ** The Outbound Memory Window Translate Value Register 0 (OMWTVR0) contains the PCI
3193 ** address used to convert 80331 internal bus addresses for outbound transactions. This address is
3194 ** driven on the PCI bus as a result of the outbound ATU address translation.
3195 ** The memory window is from internal bus address 8000 000H to 83FF FFFFH with the fixed length
3197 ** -----------------------------------------------------------------
3198 ** Bit Default Description
3199 ** 31:26 00H Outbound MW Translate Value - Used to convert 80331 internal bus addresses to PCI addresses.
3200 ** 25:02 00 0000H Reserved
3201 ** 01:00 00 2 Burst Order - This bit field shows the address sequence during a memory burst.
3202 ** Only linear incrementing mode is supported.
3203 ***********************************************************************************
3205 #define ARCMSR_OUTBOUND_MEMORY_WINDOW_TRANSLATE_VALUE0_REG 0x60 /*dword 0x63,0x62,0x61,0x60*/
3207 ***********************************************************************************
3208 ** Outbound Upper 32-bit Memory Window Translate Value Register 0 - OUMWTVR0
3210 ** The Outbound Upper 32-bit Memory Window Translate Value Register 0 (OUMWTVR0) defines
3211 ** the upper 32-bits of address used during a dual address cycle. This enables the outbound ATU to
3212 ** directly address anywhere within the 64-bit host address space. When this register is all-zero, then
3213 ** a SAC is generated on the PCI bus.
3214 ** The memory window is from internal bus address 8000 000H to 83FF FFFFH with the fixed
3215 ** length of 64 Mbytes.
3216 ** -----------------------------------------------------------------
3217 ** Bit Default Description
3218 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC).
3219 ***********************************************************************************
3221 #define ARCMSR_OUTBOUND_UPPER32_MEMORY_WINDOW_TRANSLATE_VALUE0_REG 0x64 /*dword 0x67,0x66,0x65,0x64*/
3223 ***********************************************************************************
3224 ** Outbound Memory Window Translate Value Register 1 -OMWTVR1
3226 ** The Outbound Memory Window Translate Value Register 1 (OMWTVR1) contains the PCI
3227 ** address used to convert 80331 internal bus addresses for outbound transactions. This address is
3228 ** driven on the PCI bus as a result of the outbound ATU address translation.
3229 ** The memory window is from internal bus address 8400 000H to 87FF FFFFH with the fixed length
3231 ** -----------------------------------------------------------------
3232 ** Bit Default Description
3233 ** 31:26 00H Outbound MW Translate Value - Used to convert 80331 internal bus addresses to PCI addresses.
3234 ** 25:02 00 0000H Reserved
3235 ** 01:00 00 2 Burst Order - This bit field shows the address sequence during a memory burst.
3236 ** Only linear incrementing mode is supported.
3237 ***********************************************************************************
3239 #define ARCMSR_OUTBOUND_MEMORY_WINDOW_TRANSLATE_VALUE1_REG 0x68 /*dword 0x6B,0x6A,0x69,0x68*/
3241 ***********************************************************************************
3242 ** Outbound Upper 32-bit Memory Window Translate Value Register 1 - OUMWTVR1
3244 ** The Outbound Upper 32-bit Memory Window Translate Value Register 1 (OUMWTVR1) defines
3245 ** the upper 32-bits of address used during a dual address cycle. This enables the outbound ATU to
3246 ** directly address anywhere within the 64-bit host address space. When this register is all-zero, then
3247 ** a SAC is generated on the PCI bus.
3248 ** The memory window is from internal bus address 8400 000H to 87FF FFFFH with the fixed length
3250 ** -----------------------------------------------------------------
3251 ** Bit Default Description
3252 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC).
3253 ***********************************************************************************
3255 #define ARCMSR_OUTBOUND_UPPER32_MEMORY_WINDOW_TRANSLATE_VALUE1_REG 0x6C /*dword 0x6F,0x6E,0x6D,0x6C*/
3257 ***********************************************************************************
3258 ** Outbound Upper 32-bit Direct Window Translate Value Register - OUDWTVR
3260 ** The Outbound Upper 32-bit Direct Window Translate Value Register (OUDWTVR) defines the
3261 ** upper 32-bits of address used during a dual address cycle for the transactions via Direct Addressing
3262 ** Window. This enables the outbound ATU to directly address anywhere within the 64-bit host
3263 ** address space. When this register is all-zero, then a SAC is generated on the PCI bus.
3264 ** -----------------------------------------------------------------
3265 ** Bit Default Description
3266 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC).
3267 ***********************************************************************************
3269 #define ARCMSR_OUTBOUND_UPPER32_DIRECT_WINDOW_TRANSLATE_VALUE_REG 0x78 /*dword 0x7B,0x7A,0x79,0x78*/
3271 ***********************************************************************************
3272 ** ATU Configuration Register - ATUCR
3274 ** The ATU Configuration Register controls the outbound address translation for address translation
3275 ** unit. It also contains bits for Conventional PCI Delayed Read Command (DRC) aliasing, discard
3276 ** timer status, SERR# manual assertion, SERR# detection interrupt masking, and ATU BIST
3277 ** interrupt enabling.
3278 ** -----------------------------------------------------------------
3279 ** Bit Default Description
3280 ** 31:20 00H Reserved
3281 ** 19 0 2 ATU DRC Alias - when set, the ATU does not distinguish read commands when attempting to match a
3282 ** current PCI read transaction with read data enqueued within the DRC buffer. When clear, a current read
3283 ** transaction must have the exact same read command as the DRR for the ATU to deliver DRC data. Not
3284 ** applicable in the PCI-X mode.
3285 ** 18 0 2 Direct Addressing Upper 2Gbytes Translation Enable - When set,
3286 ** with Direct Addressing enabled (bit 7 of the ATUCR set),
3287 ** the ATU forwards internal bus cycles with an address between 0000.0040H and
3288 ** 7FFF.FFFFH to the PCI bus with bit 31 of the address set (8000.0000H - FFFF.FFFFH).
3289 ** When clear, no translation occurs.
3291 ** 16 0 2 SERR# Manual Assertion - when set, the ATU asserts SERR# for one clock on the PCI interface. Until
3292 ** cleared, SERR# may not be manually asserted again. Once cleared, operation proceeds as specified.
3293 ** 15 0 2 ATU Discard Timer Status - when set, one of the 4 discard timers within the ATU has expired and
3294 ** discarded the delayed completion transaction within the queue. When clear, no timer has expired.
3295 ** 14:10 00000 2 Reserved
3296 ** 09 0 2 SERR# Detected Interrupt Enable - When set, the Intel XScale core is signalled an HPI# interrupt
3297 ** when the ATU detects that SERR# was asserted. When clear,
3298 ** the Intel XScale core is not interrupted when SERR# is detected.
3299 ** 08 0 2 Direct Addressing Enable - Setting this bit enables direct outbound addressing through the ATU.
3300 ** Internal bus cycles with an address between 0000.0040H and 7FFF.FFFFH automatically forwards to
3301 ** the PCI bus with or without translation of address bit 31 based on the setting of bit 18 of
3303 ** 07:04 0000 2 Reserved
3304 ** 03 0 2 ATU BIST Interrupt Enable - When set, enables an interrupt to the Intel XScale core when the start
3305 ** BIST bit is set in the ATUBISTR register. This bit is also reflected as the BIST Capable bit 7
3306 ** in the ATUBISTR register.
3308 ** 01 0 2 Outbound ATU Enable - When set, enables the outbound address translation unit.
3309 ** When cleared, disables the outbound ATU.
3311 ***********************************************************************************
3313 #define ARCMSR_ATU_CONFIGURATION_REG 0x80 /*dword 0x83,0x82,0x81,0x80*/
3315 ***********************************************************************************
3316 ** PCI Configuration and Status Register - PCSR
3318 ** The PCI Configuration and Status Register has additional bits for controlling and monitoring
3319 ** various features of the PCI bus interface.
3320 ** -----------------------------------------------------------------
3321 ** Bit Default Description
3322 ** 31:19 0000H Reserved
3323 ** 18 0 2 Detected Address or Attribute Parity Error - set when a parity error is detected during either the address
3324 ** or attribute phase of a transaction on the PCI bus even when the ATUCMD register Parity Error
3325 ** Response bit is cleared. Set under the following conditions:
3326 ** ¡E Any Address or Attribute (PCI-X Only) Parity Error on the Bus (including one generated by the ATU).
3327 ** 17:16 Varies with
3334 ** PCI-X capability - These two bits define the mode of
3335 ** the PCI bus (conventional or PCI-X) as well as the
3336 ** operating frequency in the case of PCI-X mode.
3337 ** 00 - Conventional PCI mode
3341 ** As defined by the PCI-X Addendum to the PCI Local Bus Specification,
3342 ** Revision 1.0a, the operating
3343 ** mode is determined by an initialization pattern on the PCI bus during
3344 ** P_RST# assertion:
3345 ** DEVSEL# STOP# TRDY# Mode
3346 ** Deasserted Deasserted Deasserted Conventional
3347 ** Deasserted Deasserted Asserted PCI-X 66
3348 ** Deasserted Asserted Deasserted PCI-X 100
3349 ** Deasserted Asserted Asserted PCI-X 133
3350 ** All other patterns are reserved.
3352 ** Outbound Transaction Queue Busy:
3353 ** 0=Outbound Transaction Queue Empty
3354 ** 1=Outbound Transaction Queue Busy
3356 ** Inbound Transaction Queue Busy:
3357 ** 0=Inbound Transaction Queue Empty
3358 ** 1=Inbound Transaction Queue Busy
3360 ** 12 0 2 Discard Timer Value - This bit controls the time-out value
3361 ** for the four discard timers attached to the queues holding read data.
3362 ** A value of 0 indicates the time-out value is 2 15 clocks.
3363 ** A value of 1 indicates the time-out value is 2 10 clocks.
3370 ** Bus Operating at 66 MHz - When set, the interface has been initialized to function at 66 MHz in
3371 ** Conventional PCI mode by the assertion of M66EN during bus initialization.
3372 ** When clear, the interface
3373 ** has been initialized as a 33 MHz bus.
3374 ** NOTE: When PCSR bits 17:16 are not equal to zero, then this bit is meaningless since the 80331 is operating in PCI-X mode.
3381 ** PCI Bus 64-Bit Capable - When clear, the PCI bus interface has been
3382 ** configured as 64-bit capable by
3383 ** the assertion of REQ64# on the rising edge of P_RST#. When set,
3384 ** the PCI interface is configured as
3386 ** 07:06 00 2 Reserved.
3387 ** 05 0 2 Reset Internal Bus - This bit controls the reset of the Intel XScale core
3388 ** and all units on the internal
3389 ** bus. In addition to the internal bus initialization,
3390 ** this bit triggers the assertion of the M_RST# pin for
3391 ** initialization of registered DIMMs. When set:
3392 ** When operating in the conventional PCI mode:
3393 ** ¡E All current PCI transactions being mastered by the ATU completes,
3394 ** and the ATU master interfaces
3395 ** proceeds to an idle state. No additional transactions is mastered by these units
3396 ** until the internal bus reset is complete.
3397 ** ¡E All current transactions being slaved by the ATU on either the PCI bus
3398 ** or the internal bus
3399 ** completes, and the ATU target interfaces proceeds to an idle state.
3400 ** All future slave transactions master aborts,
3401 ** with the exception of the completion cycle for the transaction that set the Reset
3402 ** Internal Bus bit in the PCSR.
3403 ** ¡E When the value of the Core Processor Reset bit in the PCSR (upon P_RST# assertion)
3404 ** is set, the Intel XScale core is held in reset when the internal bus reset is complete.
3405 ** ¡E The ATU ignores configuration cycles, and they appears as master aborts for: 32
3406 ** Internal Bus clocks.
3407 ** ¡E The 80331 hardware clears this bit after the reset operation completes.
3408 ** When operating in the PCI-X mode:
3409 ** The ATU hardware responds the same as in Conventional PCI-X mode.
3410 ** However, this may create a problem in PCI-X mode for split requests in
3411 ** that there may still be an outstanding split completion that the
3412 ** ATU is either waiting to receive (Outbound Request) or initiate
3413 ** (Inbound Read Request). For a cleaner
3414 ** internal bus reset, host software can take the following steps prior
3415 ** to asserting Reset Internal bus:
3416 ** 1. Clear the Bus Master (bit 2 of the ATUCMD) and the Memory Enable (bit 1 of the ATUCMD) bits in
3417 ** the ATUCMD. This ensures that no new transactions, either outbound or inbound are enqueued.
3418 ** 2. Wait for both the Outbound (bit 15 of the PCSR) and Inbound Read (bit 14 of the PCSR) Transaction
3419 ** queue busy bits to be clear.
3420 ** 3. Set the Reset Internal Bus bit
3421 ** As a result, the ATU hardware resets the internal bus using the same logic as in conventional mode,
3422 ** however the user is now assured that the ATU no longer has any pending inbound or outbound split
3423 ** completion transactions.
3424 ** NOTE: Since the Reset Internal Bus bit is set using an inbound configuration cycle, the user is
3425 ** guaranteed that any prior configuration cycles have properly completed since there is only a one
3426 ** deep transaction queue for configuration transaction requests. The ATU sends the appropriate
3427 ** Split Write Completion Message to the Requester prior to the onset of Internal Bus Reset.
3428 ** 04 0 2 Bus Master Indicator Enable: Provides software control for the
3429 ** Bus Master Indicator signal P_BMI used
3430 ** for external RAIDIOS logic control of private devices. Only valid when operating with the bridge and
3431 ** central resource/arbiter disabled (BRG_EN =low, ARB_EN=low).
3432 ** 03 Varies with external state of PRIVDEV during
3434 ** Private Device Enable - This bit indicates the state of the reset strap which enables the private device
3435 ** control mechanism within the PCI-to-PCI Bridge SISR configuration register.
3436 ** 0=Private Device control Disabled - SISR register bits default to zero
3437 ** 1=Private Device control Enabled - SISR register bits default to one
3438 ** 02 Varies with external state of RETRY during P_RST#
3439 ** Configuration Cycle Retry - When this bit is set, the PCI interface of the 80331 responds to all
3440 ** configuration cycles with a Retry condition. When clear, the 80331 responds to the appropriate
3441 ** configuration cycles.
3442 ** The default condition for this bit is based on the external state of the RETRY pin at the rising edge of
3443 ** P_RST#. When the external state of the pin is high, the bit is set. When the external state of the pin is
3444 ** low, the bit is cleared.
3445 ** 01 Varies with external state of CORE_RST# during P_RST#
3446 ** Core Processor Reset - This bit is set to its default value by the hardware when either P_RST# is
3447 ** asserted or the Reset Internal Bus bit in PCSR is set. When this bit is set, the Intel XScale core is
3448 ** being held in reset. Software cannot set this bit. Software is required to clear this bit to deassert Intel
3449 ** XScale core reset.
3450 ** The default condition for this bit is based on the external state of the CORE_RST# pin at the rising edge
3451 ** of P_RST#. When the external state of the pin is low, the bit is set. When the external state of the pin is
3452 ** high, the bit is clear.
3453 ** 00 Varies with external state of PRIVMEM during P_RST#
3454 ** Private Memory Enable - This bit indicates the state of the reset strap which enables the private device
3455 ** control mechanism within the PCI-to-PCI Bridge SDER configuration register.
3456 ** 0=Private Memory control Disabled - SDER register bit 2 default to zero
3457 ** 1=Private Memory control Enabled - SDER register bits 2 default to one
3458 ***********************************************************************************
3460 #define ARCMSR_PCI_CONFIGURATION_STATUS_REG 0x84 /*dword 0x87,0x86,0x85,0x84*/
3462 ***********************************************************************************
3463 ** ATU Interrupt Status Register - ATUISR
3465 ** The ATU Interrupt Status Register is used to notify the core processor of the source of an ATU
3466 ** interrupt. In addition, this register is written to clear the source of the interrupt to the interrupt unit
3467 ** of the 80331. All bits in this register are Read/Clear.
3468 ** Bits 4:0 are a direct reflection of bits 14:11 and bit 8 (respectively) of the ATU Status Register
3469 ** (these bits are set at the same time by hardware but need to be cleared independently). Bit 7 is set
3470 ** by an error associated with the internal bus of the 80331. Bit 8 is for software BIST. The
3471 ** conditions that result in an ATU interrupt are cleared by writing a 1 to the appropriate bits in this
3473 ** Note: Bits 4:0, and bits 15 and 13:7 can result in an interrupt being driven to the Intel XScale core.
3474 ** -----------------------------------------------------------------
3475 ** Bit Default Description
3476 ** 31:18 0000H Reserved
3477 ** 17 0 2 VPD Address Register Updated - This bit is set when a PCI bus configuration write occurs to the VPDAR
3478 ** register. Configuration register writes to the VPDAR does NOT result in bit 15 also being set. When set,
3479 ** this bit results in the assertion of the ATU Configure Register Write Interrupt.
3481 ** 15 0 2 ATU Configuration Write - This bit is set when a PCI bus configuration write occurs to any ATU register.
3482 ** When set, this bit results in the assertion of the ATU Configure Register Write Interrupt.
3483 ** 14 0 2 ATU Inbound Memory Window 1 Base Updated - This bit is set when a PCI bus configuration write
3484 ** occurs to either the IABAR1 register or the IAUBAR1 register. Configuration register writes to these
3485 ** registers deos NOT result in bit 15 also being set. When set, this bit results in the assertion of the ATU
3486 ** Configure Register Write Interrupt.
3487 ** 13 0 2 Initiated Split Completion Error Message - This bit is set when the device initiates a Split Completion
3488 ** Message on the PCI Bus with the Split Completion Error attribute bit set.
3489 ** 12 0 2 Received Split Completion Error Message - This bit is set when the device receives a Split Completion
3490 ** Message from the PCI Bus with the Split Completion Error attribute bit set.
3491 ** 11 0 2 Power State Transition - When the Power State Field of the ATU Power Management Control/Status
3492 ** Register is written to transition the ATU function Power State from D0 to D3, D0 to D1, or D3 to D0 and
3493 ** the ATU Power State Transition Interrupt mask bit is cleared, this bit is set.
3494 ** 10 0 2 P_SERR# Asserted - set when P_SERR# is asserted on the PCI bus by the ATU.
3495 ** 09 0 2 Detected Parity Error - set when a parity error is detected on the PCI bus even when the ATUCMD
3496 ** register¡¦s Parity Error Response bit is cleared. Set under the following conditions:
3497 ** ¡E Write Data Parity Error when the ATU is a target (inbound write).
3498 ** ¡E Read Data Parity Error when the ATU is an initiator (outbound read).
3499 ** ¡E Any Address or Attribute (PCI-X Only) Parity Error on the Bus.
3500 ** 08 0 2 ATU BIST Interrupt - When set, generates the ATU BIST Start Interrupt and indicates the host processor
3501 ** has set the Start BIST bit (ATUBISTR register bit 6), when the ATU BIST interrupt is enabled (ATUCR
3502 ** register bit 3). The Intel XScale core can initiate the software BIST and store the result in ATUBISTR
3503 ** register bits 3:0.
3504 ** Configuration register writes to the ATUBISTR does NOT result in bit 15 also being set or the assertion
3505 ** of the ATU Configure Register Write Interrupt.
3506 ** 07 0 2 Internal Bus Master Abort - set when a transaction initiated by the ATU internal bus initiator interface ends in a Master-abort.
3507 ** 06:05 00 2 Reserved.
3508 ** 04 0 2 P_SERR# Detected - set when P_SERR# is detected on the PCI bus by the ATU.
3509 ** 03 0 2 PCI Master Abort - set when a transaction initiated by the ATU PCI initiator interface ends in a Master-abort.
3510 ** 02 0 2 PCI Target Abort (master) - set when a transaction initiated by the ATU PCI master interface ends in a Target-abort.
3511 ** 01 0 2 PCI Target Abort (target) - set when the ATU interface, acting as a target, terminates the transaction on the PCI bus with a target abort.
3512 ** 00 0 2 PCI Master Parity Error - Master Parity Error - The ATU interface sets this bit under the following
3514 ** ¡E The ATU asserted PERR# itself or the ATU observed PERR# asserted.
3515 ** ¡E And the ATU acted as the requester for the operation in which the error occurred.
3516 ** ¡E And the ATUCMD register¡¦s Parity Error Response bit is set
3517 ** ¡E Or (PCI-X Mode Only) the ATU received a Write Data Parity Error Message
3518 ** ¡E And the ATUCMD register¡¦s Parity Error Response bit is set
3519 ***********************************************************************************
3521 #define ARCMSR_ATU_INTERRUPT_STATUS_REG 0x88 /*dword 0x8B,0x8A,0x89,0x88*/
3523 ***********************************************************************************
3524 ** ATU Interrupt Mask Register - ATUIMR
3526 ** The ATU Interrupt Mask Register contains the control bit to enable and disable interrupts
3527 ** generated by the ATU.
3528 ** -----------------------------------------------------------------
3529 ** Bit Default Description
3530 ** 31:15 0 0000H Reserved
3531 ** 14 0 2 VPD Address Register Updated Mask - Controls the setting of bit 17 of the ATUISR and generation of the
3532 ** ATU Configuration Register Write interrupt when a PCI bus write occurs to the VPDAR register.
3536 ** 12 0 2 Configuration Register Write Mask - Controls the setting of bit 15 of the ATUISR and generation of the
3537 ** ATU Configuration Register Write interrupt when a PCI bus write occurs to any ATU configuration register
3538 ** except those covered by mask bit 11 and bit 14 of this register, and ATU BIST enable bit 3 of the ATUCR.
3541 ** 11 1 2 ATU Inbound Memory Window 1 Base Updated Mask - Controls the setting of bit 14 of the ATUISR and
3542 ** generation of the ATU Configuration Register Write interrupt when a PCI bus write occurs to either the
3543 ** IABAR1 register or the IAUBAR1 register.
3546 ** 10 0 2 Initiated Split Completion Error Message Interrupt Mask - Controls the setting of bit 13 of the ATUISR and
3547 ** generation of the ATU Error interrupt when the ATU initiates a Split Completion Error Message.
3550 ** 09 0 2 Received Split Completion Error Message Interrupt Mask- Controls the setting of bit 12 of the ATUISR
3551 ** and generation of the ATU Error interrupt when a Split Completion Error Message results in bit 29 of the
3552 ** PCIXSR being set.
3555 ** 08 1 2 Power State Transition Interrupt Mask - Controls the setting of bit 12 of the ATUISR and generation of the
3556 ** ATU Error interrupt when ATU Power Management Control/Status Register is written to transition the
3557 ** ATU Function Power State from D0 to D3, D0 to D1, D1 to D3 or D3 to D0.
3560 ** 07 0 2 ATU Detected Parity Error Interrupt Mask - Controls the setting of bit 9 of the ATUISR and generation of
3561 ** the ATU Error interrupt when a parity error detected on the PCI bus that sets bit 15 of the ATUSR.
3564 ** 06 0 2 ATU SERR# Asserted Interrupt Mask - Controls the setting of bit 10 of the ATUISR and generation of the
3565 ** ATU Error interrupt when SERR# is asserted on the PCI interface resulting in bit 14 of the ATUSR being set.
3568 ** NOTE: This bit is specific to the ATU asserting SERR# and not detecting SERR# from another master.
3569 ** 05 0 2 ATU PCI Master Abort Interrupt Mask - Controls the setting of bit 3 of the ATUISR and generation of the
3570 ** ATU Error interrupt when a master abort error resulting in bit 13 of the ATUSR being set.
3573 ** 04 0 2 ATU PCI Target Abort (Master) Interrupt Mask- Controls the setting of bit 12 of the ATUISR and ATU Error
3574 ** generation of the interrupt when a target abort error resulting in bit 12 of the ATUSR being set
3577 ** 03 0 2 ATU PCI Target Abort (Target) Interrupt Mask- Controls the setting of bit 1 of the ATUISR and generation
3578 ** of the ATU Error interrupt when a target abort error resulting in bit 11 of the ATUSR being set.
3581 ** 02 0 2 ATU PCI Master Parity Error Interrupt Mask - Controls the setting of bit 0 of the ATUISR and generation
3582 ** of the ATU Error interrupt when a parity error resulting in bit 8 of the ATUSR being set.
3585 ** 01 0 2 ATU Inbound Error SERR# Enable - Controls when the ATU asserts (when enabled through the
3586 ** ATUCMD) SERR# on the PCI interface in response to a master abort on the internal bus during an
3587 ** inbound write transaction.
3588 ** 0=SERR# Not Asserted due to error
3589 ** 1=SERR# Asserted due to error
3590 ** 00 0 2 ATU ECC Target Abort Enable - Controls the ATU response on the PCI interface to a target abort (ECC
3591 ** error) from the memory controller on the internal bus. In conventional mode, this action only occurs
3592 ** during an inbound read transaction where the data phase that was target aborted on the internal bus is
3593 ** actually requested from the inbound read queue.
3594 ** 0=Disconnect with data
3595 ** (the data being up to 64 bits of 1¡¦s)
3597 ** NOTE: In PCI-X Mode, The ATU initiates a Split Completion Error Message (with message class=2h -
3598 ** completer error and message index=81h - 80331 internal bus target abort) on the PCI bus,
3599 ** independent of the setting of this bit.
3600 ***********************************************************************************
3602 #define ARCMSR_ATU_INTERRUPT_MASK_REG 0x8C /*dword 0x8F,0x8E,0x8D,0x8C*/
3604 ***********************************************************************************
3605 ** Inbound ATU Base Address Register 3 - IABAR3
3607 ** . The Inbound ATU Base Address Register 3 (IABAR3) together with the Inbound ATU Upper Base Address Register 3 (IAUBAR3) defines the block
3608 ** of memory addresses where the inbound translation window 3 begins.
3609 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory.
3610 ** . The IABAR3 and IAUBAR3 define the base address and describes the required memory block size.
3611 ** . Bits 31 through 12 of the IABAR3 is either read/write bits or read only with a value of 0 depending on the value located within the IALR3.
3612 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment.
3614 ** Since IABAR3 does not appear in the standard PCI configuration header space (offsets 00H - 3CH),
3615 ** IABAR3 is not configured by the host during normal system initialization.
3617 ** When a non-zero value is not written to IALR3,
3618 ** the user should not set either the Prefetchable Indicator
3619 ** or the Type Indicator for 64 bit addressability.
3620 ** This is the default for IABAR3.
3621 ** Assuming a non-zero value is written to IALR3,
3622 ** the user may set the Prefetchable Indicator
3623 ** or the Type Indicator:
3624 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary,
3625 ** when the Prefetchable Indicator is not set,
3626 ** the user should also leave the Type Indicator set for 32 bit addressability.
3627 ** This is the default for IABAR3.
3628 ** b. when the Prefetchable Indicator is set,
3629 ** the user should also set the Type Indicator for 64 bit addressability.
3630 ** -----------------------------------------------------------------
3631 ** Bit Default Description
3632 ** 31:12 00000H Translation Base Address 3 - These bits define the actual location
3633 ** the translation function is to respond to when addressed from the PCI bus.
3634 ** 11:04 00H Reserved.
3635 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable.
3636 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window:
3637 ** 00 - Memory Window is locatable anywhere in 32 bit address space
3638 ** 10 - Memory Window is locatable anywhere in 64 bit address space
3639 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address.
3640 ** The ATU does not occupy I/O space,
3641 ** thus this bit must be zero.
3642 ***********************************************************************************
3644 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS3_REG 0x90 /*dword 0x93,0x92,0x91,0x90*/
3646 ***********************************************************************************
3647 ** Inbound ATU Upper Base Address Register 3 - IAUBAR3
3649 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes.
3650 ** Together with the Translation Base Address this register defines the actual location
3651 ** the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs).
3652 ** The programmed value within the base address register must comply with the PCI programming
3653 ** requirements for address alignment.
3655 ** When the Type indicator of IABAR3 is set to indicate 32 bit addressability,
3656 ** the IAUBAR3 register attributes are read-only.
3657 ** This is the default for IABAR3.
3658 ** -----------------------------------------------------------------
3659 ** Bit Default Description
3660 ** 31:0 00000H Translation Upper Base Address 3 - Together with the Translation Base Address 3 these bits define
3661 ** the actual location the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes.
3662 ***********************************************************************************
3664 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS3_REG 0x94 /*dword 0x97,0x96,0x95,0x94*/
3666 ***********************************************************************************
3667 ** Inbound ATU Limit Register 3 - IALR3
3669 ** Inbound address translation for memory window 3 occurs for data transfers occurring from the PCI
3670 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts
3671 ** PCI addresses to internal bus addresses.
3672 ** The inbound translation base address for inbound window 3 is specified in Section 3.10.15. When
3673 ** determining block size requirements ¡X as described in Section 3.10.21 ¡X the translation limit
3674 ** register provides the block size requirements for the base address register. The remaining registers
3675 ** used for performing address translation are discussed in Section 3.2.1.1.
3676 ** The 80331 translate value register¡¦s programmed value must be naturally aligned with the base
3677 ** address register¡¦s programmed value. The limit register is used as a mask; thus, the lower address
3678 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus
3679 ** Specification, Revision 2.3 for additional information on programming base address registers.
3680 ** Bits 31 to 12 within the IALR3 have a direct effect on the IABAR3 register, bits 31 to 12, with a
3681 ** one to one correspondence. A value of 0 in a bit within the IALR3 makes the corresponding bit
3682 ** within the IABAR3 a read only bit which always returns 0. A value of 1 in a bit within the IALR3
3683 ** makes the corresponding bit within the IABAR3 read/write from PCI. Note that a consequence of
3684 ** this programming scheme is that unless a valid value exists within the IALR3, all writes to the
3685 ** IABAR3 has no effect since a value of all zeros within the IALR3 makes the IABAR3 a read only
3687 ** -----------------------------------------------------------------
3688 ** Bit Default Description
3689 ** 31:12 00000H Inbound Translation Limit 3 - This readback value determines the memory block size required
3690 ** for the ATUs memory window 3.
3691 ** 11:00 000H Reserved
3692 ***********************************************************************************
3694 #define ARCMSR_INBOUND_ATU_LIMIT3_REG 0x98 /*dword 0x9B,0x9A,0x99,0x98*/
3696 ***********************************************************************************
3697 ** Inbound ATU Translate Value Register 3 - IATVR3
3699 ** The Inbound ATU Translate Value Register 3 (IATVR3) contains the internal bus address used to
3700 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the
3701 ** inbound ATU address translation.
3702 ** -----------------------------------------------------------------
3703 ** Bit Default Description
3704 ** 31:12 00000H Inbound ATU Translation Value 3 - This value is used to convert the PCI address to internal bus addresses.
3705 ** This value must be 64-bit aligned on the internal bus. The default address allows the ATU to
3706 ** access the internal 80331 memory-mapped registers.
3707 ** 11:00 000H Reserved
3708 ***********************************************************************************
3710 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE3_REG 0x9C /*dword 0x9F,0x9E,0x9D,0x9C*/
3712 ***********************************************************************************
3713 ** Outbound Configuration Cycle Address Register - OCCAR
3715 ** The Outbound Configuration Cycle Address Register is used to hold the 32-bit PCI configuration
3716 ** cycle address. The Intel XScale core writes the PCI configuration cycles address which then
3717 ** enables the outbound configuration read or write. The Intel XScale core then performs a read or
3718 ** write to the Outbound Configuration Cycle Data Register to initiate the configuration cycle on the
3720 ** Note: Bits 15:11 of the configuration cycle address for Type 0 configuration cycles are defined differently
3721 ** for Conventional versus PCI-X modes. When 80331 software programs the OCCAR to initiate a
3722 ** Type 0 configuration cycle, the OCCAR should always be loaded based on the PCI-X definition for
3723 ** the Type 0 configuration cycle address. When operating in Conventional mode, the 80331 clears
3724 ** bits 15:11 of the OCCAR prior to initiating an outbound Type 0 configuration cycle. See the PCI-X
3725 ** Addendum to the PCI Local Bus Specification, Revision 1.0a for details on the two formats.
3726 ** -----------------------------------------------------------------
3727 ** Bit Default Description
3728 ** 31:00 0000 0000H Configuration Cycle Address - These bits define the 32-bit PCI address used during an outbound
3729 ** configuration read or write cycle.
3730 ***********************************************************************************
3732 #define ARCMSR_OUTBOUND_CONFIGURATION_CYCLE_ADDRESS_REG 0xA4 /*dword 0xA7,0xA6,0xA5,0xA4*/
3734 ***********************************************************************************
3735 ** Outbound Configuration Cycle Data Register - OCCDR
3737 ** The Outbound Configuration Cycle Data Register is used to initiate a configuration read or write
3738 ** on the PCI bus. The register is logical rather than physical meaning that it is an address not a
3739 ** register. The Intel XScale core reads or writes the data registers memory-mapped address to
3740 ** initiate the configuration cycle on the PCI bus with the address found in the OCCAR. For a
3741 ** configuration write, the data is latched from the internal bus and forwarded directly to the OWQ.
3742 ** For a read, the data is returned directly from the ORQ to the Intel XScale core and is never
3743 ** actually entered into the data register (which does not physically exist).
3744 ** The OCCDR is only visible from 80331 internal bus address space and appears as a reserved value
3745 ** within the ATU configuration space.
3746 ** -----------------------------------------------------------------
3747 ** Bit Default Description
3748 ** 31:00 0000 0000H Configuration Cycle Data - These bits define the data used during an outbound configuration read
3750 ***********************************************************************************
3752 #define ARCMSR_OUTBOUND_CONFIGURATION_CYCLE_DATA_REG 0xAC /*dword 0xAF,0xAE,0xAD,0xAC*/
3754 ***********************************************************************************
3755 ** VPD Capability Identifier Register - VPD_CAPID
3757 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification,
3758 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended
3759 ** Capability contained in that header. In the case of the 80331, this is the VPD extended capability
3760 ** with an ID of 03H as defined by the PCI Local Bus Specification, Revision 2.3.
3761 ** -----------------------------------------------------------------
3762 ** Bit Default Description
3763 ** 07:00 03H Cap_Id - This field with its¡¦ 03H value identifies this item in the linked list of Extended Capability
3764 ** Headers as being the VPD capability registers.
3765 ***********************************************************************************
3767 #define ARCMSR_VPD_CAPABILITY_IDENTIFIER_REG 0xB8 /*byte*/
3769 ***********************************************************************************
3770 ** VPD Next Item Pointer Register - VPD_NXTP
3772 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification,
3773 ** Revision 2.3. This register describes the location of the next item in the function¡¦s capability list.
3774 ** For the 80331, this the final capability list, and hence, this register is set to 00H.
3775 ** -----------------------------------------------------------------
3776 ** Bit Default Description
3777 ** 07:00 00H Next_ Item_ Pointer - This field provides an offset into the function¡¦s configuration space pointing to the
3778 ** next item in the function¡¦s capability list. Since the VPD capabilities are the last in the linked list of
3779 ** extended capabilities in the 80331, the register is set to 00H.
3780 ***********************************************************************************
3782 #define ARCMSR_VPD_NEXT_ITEM_PTR_REG 0xB9 /*byte*/
3784 ***********************************************************************************
3785 ** VPD Address Register - VPD_AR
3787 ** The VPD Address register (VPDAR) contains the DWORD-aligned byte address of the VPD to be
3788 ** accessed. The register is read/write and the initial value at power-up is indeterminate.
3789 ** A PCI Configuration Write to the VPDAR interrupts the Intel XScale core. Software can use
3790 ** the Flag setting to determine whether the configuration write was intended to initiate a read or
3791 ** write of the VPD through the VPD Data Register.
3792 ** -----------------------------------------------------------------
3793 ** Bit Default Description
3794 ** 15 0 2 Flag - A flag is used to indicate when a transfer of data between the VPD Data Register and the storage
3795 ** component has completed. Please see Section 3.9, ¡§Vital Product Data¡¨ on page 201 for more details on
3796 ** how the 80331 handles the data transfer.
3797 ** 14:0 0000H VPD Address - This register is written to set the DWORD-aligned byte address used to read or write
3798 ** Vital Product Data from the VPD storage component.
3799 ***********************************************************************************
3801 #define ARCMSR_VPD_ADDRESS_REG 0xBA /*word 0xBB,0xBA*/
3803 ***********************************************************************************
3804 ** VPD Data Register - VPD_DR
3806 ** This register is used to transfer data between the 80331 and the VPD storage component.
3807 ** -----------------------------------------------------------------
3808 ** Bit Default Description
3809 ** 31:00 0000H VPD Data - Four bytes are always read or written through this register to/from the VPD storage component.
3810 ***********************************************************************************
3812 #define ARCMSR_VPD_DATA_REG 0xBC /*dword 0xBF,0xBE,0xBD,0xBC*/
3814 ***********************************************************************************
3815 ** Power Management Capability Identifier Register -PM_CAPID
3817 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification,
3818 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended
3819 ** Capability contained in that header. In the case of the 80331, this is the PCI Bus Power
3820 ** Management extended capability with an ID of 01H as defined by the PCI Bus Power Management
3821 ** Interface Specification, Revision 1.1.
3822 ** -----------------------------------------------------------------
3823 ** Bit Default Description
3824 ** 07:00 01H Cap_Id - This field with its¡¦ 01H value identifies this item in the linked list of Extended Capability
3825 ** Headers as being the PCI Power Management Registers.
3826 ***********************************************************************************
3828 #define ARCMSR_POWER_MANAGEMENT_CAPABILITY_IDENTIFIER_REG 0xC0 /*byte*/
3830 ***********************************************************************************
3831 ** Power Management Next Item Pointer Register - PM_NXTP
3833 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification,
3834 ** Revision 2.3. This register describes the location of the next item in the function¡¦s capability list.
3835 ** For the 80331, the next capability (MSI capability list) is located at off-set D0H.
3836 ** -----------------------------------------------------------------
3837 ** Bit Default Description
3838 ** 07:00 D0H Next_ Item_ Pointer - This field provides an offset into the function¡¦s configuration space pointing to the
3839 ** next item in the function¡¦s capability list which in the 80331 is the MSI extended capabilities header.
3840 ***********************************************************************************
3842 #define ARCMSR_POWER_NEXT_ITEM_PTR_REG 0xC1 /*byte*/
3844 ***********************************************************************************
3845 ** Power Management Capabilities Register - PM_CAP
3847 ** Power Management Capabilities bits adhere to the definitions in the PCI Bus Power Management
3848 ** Interface Specification, Revision 1.1. This register is a 16-bit read-only register which provides
3849 ** information on the capabilities of the ATU function related to power management.
3850 ** -----------------------------------------------------------------
3851 ** Bit Default Description
3852 ** 15:11 00000 2 PME_Support - This function is not capable of asserting the PME# signal in any state, since PME#
3853 ** is not supported by the 80331.
3854 ** 10 0 2 D2_Support - This bit is set to 0 2 indicating that the 80331 does not support the D2 Power Management State
3855 ** 9 1 2 D1_Support - This bit is set to 1 2 indicating that the 80331 supports the D1 Power Management State
3856 ** 8:6 000 2 Aux_Current - This field is set to 000 2 indicating that the 80331 has no current requirements for the
3857 ** 3.3Vaux signal as defined in the PCI Bus Power Management Interface Specification, Revision 1.1
3858 ** 5 0 2 DSI - This field is set to 0 2 meaning that this function requires a device specific initialization sequence
3859 ** following the transition to the D0 uninitialized state.
3861 ** 3 0 2 PME Clock - Since the 80331 does not support PME# signal generation this bit is cleared to 0 2 .
3862 ** 2:0 010 2 Version - Setting these bits to 010 2 means that this function complies with PCI Bus Power Management
3863 ** Interface Specification, Revision 1.1
3864 ***********************************************************************************
3866 #define ARCMSR_POWER_MANAGEMENT_CAPABILITY_REG 0xC2 /*word 0xC3,0xC2*/
3868 ***********************************************************************************
3869 ** Power Management Control/Status Register - PM_CSR
3871 ** Power Management Control/Status bits adhere to the definitions in the PCI Bus Power
3872 ** Management Interface Specification, Revision 1.1. This 16-bit register is the control and status
3873 ** interface for the power management extended capability.
3874 ** -----------------------------------------------------------------
3875 ** Bit Default Description
3876 ** 15 0 2 PME_Status - This function is not capable of asserting the PME# signal in any state, since PME## is not
3877 ** supported by the 80331.
3878 ** 14:9 00H Reserved
3879 ** 8 0 2 PME_En - This bit is hardwired to read-only 0 2 since this function does not support PME#
3880 ** generation from any power state.
3881 ** 7:2 000000 2 Reserved
3882 ** 1:0 00 2 Power State - This 2-bit field is used both to determine the current power state
3883 ** of a function and to set the function into a new power state. The definition of the values is:
3886 ** 10 2 - D2 (Unsupported)
3888 ** The 80331 supports only the D0 and D3 hot states.
3890 ***********************************************************************************
3892 #define ARCMSR_POWER_MANAGEMENT_CONTROL_STATUS_REG 0xC4 /*word 0xC5,0xC4*/
3894 ***********************************************************************************
3895 ** PCI-X Capability Identifier Register - PX_CAPID
3897 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification,
3898 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended
3899 ** Capability contained in that header. In the case of the 80331, this is the PCI-X extended capability with
3900 ** an ID of 07H as defined by the PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0a.
3901 ** -----------------------------------------------------------------
3902 ** Bit Default Description
3903 ** 07:00 07H Cap_Id - This field with its¡¦ 07H value identifies this item in the linked list of Extended Capability
3904 ** Headers as being the PCI-X capability registers.
3905 ***********************************************************************************
3907 #define ARCMSR_PCIX_CAPABILITY_IDENTIFIER_REG 0xE0 /*byte*/
3909 ***********************************************************************************
3910 ** PCI-X Next Item Pointer Register - PX_NXTP
3912 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification,
3913 ** Revision 2.3. This register describes the location of the next item in the function¡¦s capability list.
3914 ** By default, the PCI-X capability is the last capabilities list for the 80331, thus this register defaults
3916 ** However, this register may be written to B8H prior to host configuration to include the VPD
3917 ** capability located at off-set B8H.
3918 ** Warning: Writing this register to any value other than 00H (default) or B8H is not supported and may
3919 ** produce unpredictable system behavior.
3920 ** In order to guarantee that this register is written prior to host configuration, the 80331 must be
3921 ** initialized at P_RST# assertion to Retry Type 0 configuration cycles (bit 2 of PCSR). Typically,
3922 ** the Intel XScale core would be enabled to boot immediately following P_RST# assertion in
3923 ** this case (bit 1 of PCSR), as well. Please see Table 125, ¡§PCI Configuration and Status Register -
3924 ** PCSR¡¨ on page 253 for more details on the 80331 initialization modes.
3925 ** -----------------------------------------------------------------
3926 ** Bit Default Description
3927 ** 07:00 00H Next_ Item_ Pointer - This field provides an offset into the function¡¦s configuration space pointing to the
3928 ** next item in the function¡¦s capability list. Since the PCI-X capabilities are the last in the linked list of
3929 ** extended capabilities in the 80331, the register is set to 00H.
3930 ** However, this field may be written prior to host configuration with B8H to extend the list to include the
3931 ** VPD extended capabilities header.
3932 ***********************************************************************************
3934 #define ARCMSR_PCIX_NEXT_ITEM_PTR_REG 0xE1 /*byte*/
3936 ***********************************************************************************
3937 ** PCI-X Command Register - PX_CMD
3939 ** This register controls various modes and features of ATU and Message Unit when operating in the
3941 ** -----------------------------------------------------------------
3942 ** Bit Default Description
3943 ** 15:7 000000000 2 Reserved.
3944 ** 6:4 011 2 Maximum Outstanding Split Transactions - This register sets the maximum number of Split Transactions
3945 ** the device is permitted to have outstanding at one time.
3946 ** Register Maximum Outstanding
3955 ** 3:2 00 2 Maximum Memory Read Byte Count - This register sets the maximum byte count the device uses when
3956 ** initiating a Sequence with one of the burst memory read commands.
3957 ** Register Maximum Byte Count
3963 ** Enable Relaxed Ordering - The 80331 does not set the relaxed ordering bit in the Requester Attributes
3965 ** 0 0 2 Data Parity Error Recovery Enable - The device driver sets this bit to enable the device to attempt to
3966 ** recover from data parity errors. When this bit is 0 and the device is in PCI-X mode, the device asserts
3967 ** SERR# (when enabled) whenever the Master Data Parity Error bit (Status register, bit 8) is set.
3968 ***********************************************************************************
3970 #define ARCMSR_PCIX_COMMAND_REG 0xE2 /*word 0xE3,0xE2*/
3972 ***********************************************************************************
3973 ** PCI-X Status Register - PX_SR
3975 ** This register identifies the capabilities and current operating mode of ATU, DMAs and Message
3976 ** Unit when operating in the PCI-X mode.
3977 ** -----------------------------------------------------------------
3978 ** Bit Default Description
3979 ** 31:30 00 2 Reserved
3980 ** 29 0 2 Received Split Completion Error Message - This bit is set when the device receives a Split Completion
3981 ** Message with the Split Completion Error attribute bit set. Once set, this bit remains set until software
3982 ** writes a 1 to this location.
3983 ** 0=no Split Completion error message received.
3984 ** 1=a Split Completion error message has been received.
3985 ** 28:26 001 2 Designed Maximum Cumulative Read Size (DMCRS) - The value of this register depends on the setting
3986 ** of the Maximum Memory Read Byte Count field of the PCIXCMD register:
3987 ** DMCRS Max ADQs Maximum Memory Read Byte Count Register Setting
3988 ** 1 16 512 (Default)
3992 ** 25:23 011 2 Designed Maximum Outstanding Split Transactions - The 80331 can have up to four outstanding split transactions.
3993 ** 22:21 01 2 Designed Maximum Memory Read Byte Count - The 80331 can generate memory reads with byte counts up
3995 ** 20 1 2 80331 is a complex device.
3996 ** 19 0 2 Unexpected Split Completion - This bit is set when an unexpected Split Completion with this device¡¦s
3997 ** Requester ID is received. Once set, this bit remains set until software writes a 1 to this location.
3998 ** 0=no unexpected Split Completion has been received.
3999 ** 1=an unexpected Split Completion has been received.
4000 ** 18 0 2 Split Completion Discarded - This bit is set when the device discards a Split Completion because the
4001 ** requester would not accept it. See Section 5.4.4 of the PCI-X Addendum to the PCI Local Bus
4002 ** Specification, Revision 1.0a for details. Once set, this bit remains set until software writes a 1 to this
4004 ** 0=no Split Completion has been discarded.
4005 ** 1=a Split Completion has been discarded.
4006 ** NOTE: The 80331 does not set this bit since there is no Inbound address responding to Inbound Read
4007 ** Requests with Split Responses (Memory or Register) that has ¡§read side effects.¡¨
4008 ** 17 1 2 80331 is a 133 MHz capable device.
4009 ** 16 1 2 or P_32BITPCI# 80331 with bridge enabled (BRG_EN=1) implements the ATU with a 64-bit interface on the secondary PCI bus,
4010 ** therefore this bit is always set.
4011 ** 80331 with no bridge and central resource disabled (BRG_EN=0, ARB_EN=0),
4012 ** use this bit to identify the add-in card to the system as 64-bit or 32-bit wide via a user-configurable strap (P_32BITPCI#).
4013 ** This strap, by default, identifies the add in card based on 80331 with bridge disabled
4014 ** as 64-bit unless the user attaches the appropriate pull-down resistor to the strap.
4015 ** 0=The bus is 32 bits wide.
4016 ** 1=The bus is 64 bits wide.
4017 ** 15:8 FFH Bus Number - This register is read for diagnostic purposes only. It indicates the number of the bus
4018 ** segment for the device containing this function. The function uses this number as part of its Requester
4019 ** ID and Completer ID. For all devices other than the source bridge, each time the function is addressed
4020 ** by a Configuration Write transaction, the function must update this register with the contents of AD[7::0]
4021 ** of the attribute phase of the Configuration Write, regardless of which register in the function is
4022 ** addressed by the transaction. The function is addressed by a Configuration Write transaction when all of
4023 ** the following are true:
4024 ** 1. The transaction uses a Configuration Write command.
4025 ** 2. IDSEL is asserted during the address phase.
4026 ** 3. AD[1::0] are 00b (Type 0 configuration transaction).
4027 ** 4. AD[10::08] of the configuration address contain the appropriate function number.
4028 ** 7:3 1FH Device Number - This register is read for diagnostic purposes only. It indicates the number of the device
4029 ** containing this function, i.e., the number in the Device Number field (AD[15::11]) of the address of a
4030 ** Type 0 configuration transaction that is assigned to the device containing this function by the connection
4031 ** of the system hardware. The system must assign a device number other than 00h (00h is reserved for
4032 ** the source bridge). The function uses this number as part of its Requester ID and Completer ID. Each
4033 ** time the function is addressed by a Configuration Write transaction, the device must update this register
4034 ** with the contents of AD[15::11] of the address phase of the Configuration Write, regardless of which
4035 ** register in the function is addressed by the transaction. The function is addressed by a Configuration
4036 ** Write transaction when all of the following are true:
4037 ** 1. The transaction uses a Configuration Write command.
4038 ** 2. IDSEL is asserted during the address phase.
4039 ** 3. AD[1::0] are 00b (Type 0 configuration transaction).
4040 ** 4. AD[10::08] of the configuration address contain the appropriate function number.
4041 ** 2:0 000 2 Function Number - This register is read for diagnostic purposes only. It indicates the number of this
4042 ** function; i.e., the number in the Function Number field (AD[10::08]) of the address of a Type 0
4043 ** configuration transaction to which this function responds. The function uses this number as part of its
4044 ** Requester ID and Completer ID.
4046 **************************************************************************
4048 #define ARCMSR_PCIX_STATUS_REG 0xE4 /*dword 0xE7,0xE6,0xE5,0xE4*/
4051 **************************************************************************
4052 ** Inbound Read Transaction
4053 ** ========================================================================
4054 ** An inbound read transaction is initiated by a PCI initiator and is targeted at either 80331 local
4055 ** memory or a 80331 memory-mapped register space. The read transaction is propagated through
4056 ** the inbound transaction queue (ITQ) and read data is returned through the inbound read queue
4058 ** When operating in the conventional PCI mode, all inbound read transactions are processed as
4059 ** delayed read transactions. When operating in the PCI-X mode, all inbound read transactions are
4060 ** processed as split transactions. The ATUs PCI interface claims the read transaction and forwards
4061 ** the read request through to the internal bus and returns the read data to the PCI bus. Data flow for
4062 ** an inbound read transaction on the PCI bus is summarized in the following statements:
4063 ** ¡E The ATU claims the PCI read transaction when the PCI address is within the inbound
4064 ** translation window defined by ATU Inbound Base Address Register (and Inbound Upper Base
4065 ** Address Register during DACs) and Inbound Limit Register.
4066 ** ¡E When operating in the conventional PCI mode, when the ITQ is currently holding transaction
4067 ** information from a previous delayed read, the current transaction information is compared to
4068 ** the previous transaction information (based on the setting of the DRC Alias bit in
4069 ** Section 3.10.39, ¡§ATU Configuration Register - ATUCR¡¨ on page 252). When there is a
4070 ** match and the data is in the IRQ, return the data to the master on the PCI bus. When there is a
4071 ** match and the data is not available, a Retry is signaled with no other action taken. When there
4072 ** is not a match and when the ITQ has less than eight entries, capture the transaction
4073 ** information, signal a Retry and initiate a delayed transaction. When there is not a match and
4074 ** when the ITQ is full, then signal a Retry with no other action taken.
4075 ** ¡X When an address parity error is detected, the address parity response defined in
4076 ** Section 3.7 is used.
4077 ** ¡E When operating in the conventional PCI mode, once read data is driven onto the PCI bus from
4078 ** the IRQ, it continues until one of the following is true:
4079 ** ¡X The initiator completes the PCI transaction. When there is data left unread in the IRQ, the
4081 ** ¡X An internal bus Target Abort was detected. In this case, the QWORD associated with the
4082 ** Target Abort is never entered into the IRQ, and therefore is never returned.
4083 ** ¡X Target Abort or a Disconnect with Data is returned in response to the Internal Bus Error.
4084 ** ¡X The IRQ becomes empty. In this case, the PCI interface signals a Disconnect with data to
4085 ** the initiator on the last data word available.
4086 ** ¡E When operating in the PCI-X mode, when ITQ is not full, the PCI address, attribute and
4087 ** command are latched into the available ITQ and a Split Response Termination is signalled to
4089 ** ¡E When operating in the PCI-X mode, when the transaction does not cross a 1024 byte aligned
4090 ** boundary, then the ATU waits until it receives the full byte count from the internal bus target
4091 ** before returning read data by generating the split completion transaction on the PCI-X bus.
4092 ** When the read requested crosses at least one 1024 byte boundary, then ATU completes the
4093 ** transfer by returning data in 1024 byte aligned chunks.
4094 ** ¡E When operating in the PCI-X mode, once a split completion transaction has started, it
4095 ** continues until one of the following is true:
4096 ** ¡X The requester (now the target) generates a Retry Termination, or a Disconnection at Next
4097 ** ADB (when the requester is a bridge)
4098 ** ¡X The byte count is satisfied.
4099 ** ¡X An internal bus Target Abort was detected. The ATU generates a Split Completion
4100 ** Message (message class=2h - completer error, and message index=81h - target abort) to
4101 ** inform the requester about the abnormal condition. The ITQ for this transaction is flushed.
4102 ** Refer to Section 3.7.1.
4103 ** ¡X An internal bus Master Abort was detected. The ATU generates a Split Completion
4104 ** Message (message class=2h - completer error, and message index=80h - Master abort) to
4105 ** inform the requester about the abnormal condition. The ITQ for this transaction is flushed.
4106 ** Refer to Section 3.7.1
4107 ** ¡E When operating in the conventional PCI mode, when the master inserts wait states on the PCI
4108 ** bus, the ATU PCI slave interface waits with no premature disconnects.
4109 ** ¡E When a data parity error occurs signified by PERR# asserted from the initiator, no action is
4110 ** taken by the target interface. Refer to Section 3.7.2.5.
4111 ** ¡E When operating in the conventional PCI mode, when the read on the internal bus is
4112 ** target-aborted, either a target-abort or a disconnect with data is signaled to the initiator. This is
4113 ** based on the ATU ECC Target Abort Enable bit (bit 0 of the ATUIMR for ATU). When set, a
4114 ** target abort is used, when clear, a disconnect is used.
4115 ** ¡E When operating in the PCI-X mode (with the exception of the MU queue ports at offsets 40h
4116 ** and 44h), when the transaction on the internal bus resulted in a target abort, the ATU generates
4117 ** a Split Completion Message (message class=2h - completer error, and message index=81h -
4118 ** internal bus target abort) to inform the requester about the abnormal condition. For the MU
4119 ** queue ports, the ATU returns either a target abort or a single data phase disconnect depending
4120 ** on the ATU ECC Target Abort Enable bit (bit 0 of the ATUIMR for ATU). The ITQ for this
4121 ** transaction is flushed. Refer to Section 3.7.1.
4122 ** ¡E When operating in the conventional PCI mode, when the transaction on the internal bus
4123 ** resulted in a master abort, the ATU returns a target abort to inform the requester about the
4124 ** abnormal condition. The ITQ for this transaction is flushed. Refer to Section 3.7.1
4125 ** ¡E When operating in the PCI-X mode, when the transaction on the internal bus resulted in a
4126 ** master abort, the ATU generates a Split Completion Message (message class=2h - completer
4127 ** error, and message index=80h - internal bus master abort) to inform the requester about the
4128 ** abnormal condition. The ITQ for this transaction is flushed. Refer to Section 3.7.1.
4129 ** ¡E When operating in the PCI-X mode, when the Split Completion transaction completes with
4130 ** either Master-Abort or Target-Abort, the requester is indicating a failure condition that
4131 ** prevents it from accepting the completion it requested. In this case, since the Split Request
4132 ** addresses a location that has no read side effects, the completer must discard the Split
4133 ** Completion and take no further action.
4134 ** The data flow for an inbound read transaction on the internal bus is summarized in the following
4136 ** ¡E The ATU internal bus master interface requests the internal bus when a PCI address appears in
4137 ** an ITQ and transaction ordering has been satisfied. When operating in the PCI-X mode the
4138 ** ATU does not use the information provided by the Relax Ordering Attribute bit. That is, ATU
4139 ** always uses conventional PCI ordering rules.
4140 ** ¡E Once the internal bus is granted, the internal bus master interface drives the translated address
4141 ** onto the bus and wait for IB_DEVSEL#. When a Retry is signaled, the request is repeated.
4142 ** When a master abort occurs, the transaction is considered complete and a target abort is loaded
4143 ** into the associated IRQ for return to the PCI initiator (transaction is flushed once the PCI
4144 ** master has been delivered the target abort).
4145 ** ¡E Once the translated address is on the bus and the transaction has been accepted, the internal
4146 ** bus target starts returning data with the assertion of IB_TRDY#. Read data is continuously
4147 ** received by the IRQ until one of the following is true:
4148 ** ¡X The full byte count requested by the ATU read request is received. The ATU internal bus
4149 ** initiator interface performs a initiator completion in this case.
4150 ** ¡X When operating in the conventional PCI mode, a Target Abort is received on the internal
4151 ** bus from the internal bus target. In this case, the transaction is aborted and the PCI side is
4153 ** ¡X When operating in the PCI-X mode, a Target Abort is received on the internal bus from
4154 ** the internal bus target. In this case, the transaction is aborted. The ATU generates a Split
4155 ** Completion Message (message class=2h - completer error, and message index=81h -
4156 ** target abort) on the PCI bus to inform the requester about the abnormal condition. The
4157 ** ITQ for this transaction is flushed.
4158 ** ¡X When operating in the conventional PCI mode, a single data phase disconnection is
4159 ** received from the internal bus target. When the data has not been received up to the next
4160 ** QWORD boundary, the ATU internal bus master interface attempts to reacquire the bus.
4161 ** When not, the bus returns to idle.
4162 ** ¡X When operating in the PCI-X mode, a single data phase disconnection is received from
4163 ** the internal bus target. The ATU IB initiator interface attempts to reacquire the bus to
4164 ** obtain remaining data.
4165 ** ¡X When operating in the conventional PCI mode, a disconnection at Next ADB is received
4166 ** from the internal bus target. The bus returns to idle.
4167 ** ¡X When operating in the PCI-X mode, a disconnection at Next ADB is received from the
4168 ** internal bus target. The ATU IB initiator interface attempts to reacquire the bus to obtain
4170 ** To support PCI Local Bus Specification, Revision 2.0 devices, the ATU can be programmed to
4171 ** ignore the memory read command (Memory Read, Memory Read Line, and Memory Read
4172 ** Multiple) when trying to match the current inbound read transaction with data in a DRC queue
4173 ** which was read previously (DRC on target bus). When the Read Command Alias Bit in the
4174 ** ATUCR register is set, the ATU does not distinguish the read commands on transactions. For
4175 ** example, the ATU enqueues a DRR with a Memory Read Multiple command and performs the read
4176 ** on the internal bus. Some time later, a PCI master attempts a Memory Read with the same address
4177 ** as the previous Memory Read Multiple. When the Read Command Bit is set, the ATU would return
4178 ** the read data from the DRC queue and consider the Delayed Read transaction complete. When the
4179 ** Read Command bit in the ATUCR was clear, the ATU would not return data since the PCI read
4180 ** commands did not match, only the address.
4181 **************************************************************************
4184 **************************************************************************
4185 ** Inbound Write Transaction
4186 **========================================================================
4187 ** An inbound write transaction is initiated by a PCI master and is targeted at either 80331 local
4188 ** memory or a 80331 memory-mapped register.
4189 ** Data flow for an inbound write transaction on the PCI bus is summarized as:
4190 ** ¡E The ATU claims the PCI write transaction when the PCI address is within the inbound
4191 ** translation window defined by the ATU Inbound Base Address Register (and Inbound Upper
4192 ** Base Address Register during DACs) and Inbound Limit Register.
4193 ** ¡E When the IWADQ has at least one address entry available and the IWQ has at least one buffer
4194 ** available, the address is captured and the first data phase is accepted.
4195 ** ¡E The PCI interface continues to accept write data until one of the following is true:
4196 ** ¡X The initiator performs a disconnect.
4197 ** ¡X The transaction crosses a buffer boundary.
4198 ** ¡E When an address parity error is detected during the address phase of the transaction, the
4199 ** address parity error mechanisms are used. Refer to Section 3.7.1 for details of the address
4200 ** parity error response.
4201 ** ¡E When operating in the PCI-X mode when an attribute parity error is detected, the attribute
4202 ** parity error mechanism described in Section 3.7.1 is used.
4203 ** ¡E When a data parity error is detected while accepting data, the slave interface sets the
4204 ** appropriate bits based on PCI specifications. No other action is taken. Refer to Section 3.7.2.6
4205 ** for details of the inbound write data parity error response.
4206 ** Once the PCI interface places a PCI address in the IWADQ, when IWQ has received data sufficient
4207 ** to cross a buffer boundary or the master disconnects on the PCI bus, the ATUs internal bus
4208 ** interface becomes aware of the inbound write. When there are additional write transactions ahead
4209 ** in the IWQ/IWADQ, the current transaction remains posted until ordering and priority have been
4210 ** satisfied (Refer to Section 3.5.3) and the transaction is attempted on the internal bus by the ATU
4211 ** internal master interface. The ATU does not insert target wait states nor do data merging on the PCI
4212 ** interface, when operating in the PCI mode.
4213 ** In the PCI-X mode memory writes are always executed as immediate transactions, while
4214 ** configuration write transactions are processed as split transactions. The ATU generates a Split
4215 ** Completion Message, (with Message class=0h - Write Completion Class and Message index =
4216 ** 00h - Write Completion Message) once a configuration write is successfully executed.
4217 ** Also, when operating in the PCI-X mode a write sequence may contain multiple write transactions.
4218 ** The ATU handles such transactions as independent transactions.
4219 ** Data flow for the inbound write transaction on the internal bus is summarized as:
4220 ** ¡E The ATU internal bus master requests the internal bus when IWADQ has at least one entry
4221 ** with associated data in the IWQ.
4222 ** ¡E When the internal bus is granted, the internal bus master interface initiates the write
4223 ** transaction by driving the translated address onto the internal bus. For details on inbound
4224 ** address translation.
4225 ** ¡E When IB_DEVSEL# is not returned, a master abort condition is signaled on the internal bus.
4226 ** The current transaction is flushed from the queue and SERR# may be asserted on the PCI
4228 ** ¡E The ATU initiator interface asserts IB_REQ64# to attempt a 64-bit transfer. When
4229 ** IB_ACK64# is not returned, a 32-bit transfer is used. Transfers of less than 64-bits use the
4230 ** IB_C/BE[7:0]# to mask the bytes not written in the 64-bit data phase. Write data is transferred
4231 ** from the IWQ to the internal bus when data is available and the internal bus interface retains
4232 ** internal bus ownership.
4233 ** ¡E The internal bus interface stops transferring data from the current transaction to the internal
4234 ** bus when one of the following conditions becomes true:
4235 ** ¡X The internal bus initiator interface loses bus ownership. The ATU internal initiator
4236 ** terminates the transfer (initiator disconnection) at the next ADB (for the internal bus ADB
4237 ** is defined as a naturally aligned 128-byte boundary) and attempt to reacquire the bus to
4238 ** complete the delivery of remaining data using the same sequence ID but with the
4239 ** modified starting address and byte count.
4240 ** ¡X A Disconnect at Next ADB is signaled on the internal bus from the internal target. When
4241 ** the transaction in the IWQ completes at that ADB, the initiator returns to idle. When the
4242 ** transaction in the IWQ is not complete, the initiator attempts to reacquire the bus to
4243 ** complete the delivery of remaining data using the same sequence ID but with the
4244 ** modified starting address and byte count.
4245 ** ¡X A Single Data Phase Disconnect is signaled on the internal bus from the internal target.
4246 ** When the transaction in the IWQ needs only a single data phase, the master returns to idle.
4247 ** When the transaction in the IWQ is not complete, the initiator attempts to reacquire the
4248 ** bus to complete the delivery of remaining data using the same sequence ID but with the
4249 ** modified starting address and byte count.
4250 ** ¡X The data from the current transaction has completed (satisfaction of byte count). An
4251 ** initiator termination is performed and the bus returns to idle.
4252 ** ¡X A Master Abort is signaled on the internal bus. SERR# may be asserted on the PCI bus.
4253 ** Data is flushed from the IWQ.
4254 *****************************************************************
4260 **************************************************************************
4261 ** Inbound Read Completions Data Parity Errors
4262 **========================================================================
4263 ** As an initiator, the ATU may encounter this error condition when operating in the PCI-X mode.
4264 ** When as the completer of a Split Read Request the ATU observes PERR# assertion during the split
4265 ** completion transaction, the ATU attempts to complete the transaction normally and no further
4267 **************************************************************************
4271 **************************************************************************
4272 ** Inbound Configuration Write Completion Message Data Parity Errors
4273 **========================================================================
4274 ** As an initiator, the ATU may encounter this error condition when operating in the PCI-X mode.
4275 ** When as the completer of a Configuration (Split) Write Request the ATU observes PERR#
4276 ** assertion during the split completion transaction, the ATU attempts to complete the transaction
4277 ** normally and no further action is taken.
4278 **************************************************************************
4282 **************************************************************************
4283 ** Inbound Read Request Data Parity Errors
4284 **===================== Immediate Data Transfer ==========================
4285 ** As a target, the ATU may encounter this error when operating in the Conventional PCI or PCI-X modes.
4286 ** Inbound read data parity errors occur when read data delivered from the IRQ is detected as having
4287 ** bad parity by the initiator of the transaction who is receiving the data. The initiator may optionally
4288 ** report the error to the system by asserting PERR#. As a target device in this scenario, no action is
4289 ** required and no error bits are set.
4290 **=====================Split Response Termination=========================
4291 ** As a target, the ATU may encounter this error when operating in the PCI-X mode.
4292 ** Inbound read data parity errors occur during the Split Response Termination. The initiator may
4293 ** optionally report the error to the system by asserting PERR#. As a target device in this scenario, no
4294 ** action is required and no error bits are set.
4295 **************************************************************************
4299 **************************************************************************
4300 ** Inbound Write Request Data Parity Errors
4301 **========================================================================
4302 ** As a target, the ATU may encounter this error when operating in the Conventional or PCI-X modes.
4303 ** Data parity errors occurring during write operations received by the ATU may assert PERR# on
4304 ** the PCI Bus. When an error occurs, the ATU continues accepting data until the initiator of the write
4305 ** transaction completes or a queue fill condition is reached. Specifically, the following actions with
4306 ** the given constraints are taken by the ATU:
4307 ** ¡E PERR# is asserted two clocks cycles (three clock cycles when operating in the PCI-X mode)
4308 ** following the data phase in which the data parity error is detected on the bus. This is only
4309 ** done when the Parity Error Response bit in the ATUCMD is set.
4310 ** ¡E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional
4311 ** actions is taken:
4312 ** ¡X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the
4313 ** Detected Parity Error bit in the ATUISR. When set, no action.
4314 ***************************************************************************
4319 ***************************************************************************
4320 ** Inbound Configuration Write Request
4321 ** =====================================================================
4322 ** As a target, the ATU may encounter this error when operating in the Conventional or PCI-X modes.
4323 ** ===============================================
4324 ** Conventional PCI Mode
4325 ** ===============================================
4326 ** To allow for correct data parity calculations for delayed write transactions, the ATU delays the
4327 ** assertion of STOP# (signalling a Retry) until PAR is driven by the master. A parity error during a
4328 ** delayed write transaction (inbound configuration write cycle) can occur in any of the following
4329 ** parts of the transactions:
4330 ** ¡E During the initial Delayed Write Request cycle on the PCI bus when the ATU latches the
4331 ** address/command and data for delayed delivery to the internal configuration register.
4332 ** ¡E During the Delayed Write Completion cycle on the PCI bus when the ATU delivers the status
4333 ** of the operation back to the original master.
4334 ** The 80331 ATU PCI interface has the following responses to a delayed write parity error for
4335 ** inbound transactions during Delayed Write Request cycles with the given constraints:
4336 ** ¡E When the Parity Error Response bit in the ATUCMD is set, the ATU asserts TRDY#
4337 ** (disconnects with data) and two clock cycles later asserts PERR# notifying the initiator of the
4338 ** parity error. The delayed write cycle is not enqueued and forwarded to the internal bus.
4339 ** When the Parity Error Response bit in the ATUCMD is cleared, the ATU retries the
4340 ** transaction by asserting STOP# and enqueues the Delayed Write Request cycle to be
4341 ** forwarded to the internal bus. PERR# is not asserted.
4342 ** ¡E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional
4343 ** actions is taken:
4344 ** ¡X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the
4345 ** Detected Parity Error bit in the ATUISR. When set, no action.
4346 ** For the original write transaction to be completed, the initiator retries the transaction on the PCI
4347 ** bus and the ATU returns the status from the internal bus, completing the transaction.
4348 ** For the Delayed Write Completion transaction on the PCI bus where a data parity error occurs and
4349 ** therefore does not agree with the status being returned from the internal bus (i.e. status being
4350 ** returned is normal completion) the ATU performs the following actions with the given constraints:
4351 ** ¡E When the Parity Error Response Bit is set in the ATUCMD, the ATU asserts TRDY#
4352 ** (disconnects with data) and two clocks later asserts PERR#. The Delayed Completion cycle in
4353 ** the IDWQ remains since the data of retried command did not match the data within the queue.
4354 ** ¡E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional
4355 ** actions is taken:
4356 ** ¡X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the
4357 ** Detected Parity Error bit in the ATUISR. When set, no action.
4358 ** ===================================================
4360 ** ===================================================
4361 ** Data parity errors occurring during configuration write operations received by the ATU may cause
4362 ** PERR# assertion and delivery of a Split Completion Error Message on the PCI Bus. When an error
4363 ** occurs, the ATU accepts the write data and complete with a Split Response Termination.
4364 ** Specifically, the following actions with the given constraints are then taken by the ATU:
4365 ** ¡E When the Parity Error Response bit in the ATUCMD is set, PERR# is asserted three clocks
4366 ** cycles following the Split Response Termination in which the data parity error is detected on
4367 ** the bus. When the ATU asserts PERR#, additional actions is taken:
4368 ** ¡X A Split Write Data Parity Error message (with message class=2h - completer error and
4369 ** message index=01h - Split Write Data Parity Error) is initiated by the ATU on the PCI bus
4370 ** that addresses the requester of the configuration write.
4371 ** ¡X When the Initiated Split Completion Error Message Interrupt Mask in the ATUIMR is
4372 ** clear, set the Initiated Split Completion Error Message bit in the ATUISR. When set, no
4374 ** ¡X The Split Write Request is not enqueued and forwarded to the internal bus.
4375 ** ¡E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional
4376 ** actions is taken:
4377 ** ¡X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the
4378 ** Detected Parity Error bit in the ATUISR. When set, no action.
4380 ***************************************************************************
4384 ***************************************************************************
4385 ** Split Completion Messages
4386 ** =======================================================================
4387 ** As a target, the ATU may encounter this error when operating in the PCI-X mode.
4388 ** Data parity errors occurring during Split Completion Messages claimed by the ATU may assert
4389 ** PERR# (when enabled) or SERR# (when enabled) on the PCI Bus. When an error occurs, the
4390 ** ATU accepts the data and complete normally. Specifically, the following actions with the given
4391 ** constraints are taken by the ATU:
4392 ** ¡E PERR# is asserted three clocks cycles following the data phase in which the data parity error
4393 ** is detected on the bus. This is only done when the Parity Error Response bit in the ATUCMD
4394 ** is set. When the ATU asserts PERR#, additional actions is taken:
4395 ** ¡X The Master Parity Error bit in the ATUSR is set.
4396 ** ¡X When the ATU PCI Master Parity Error Interrupt Mask Bit in the ATUIMR is clear, set the
4397 ** PCI Master Parity Error bit in the ATUISR. When set, no action.
4398 ** ¡X When the SERR# Enable bit in the ATUCMD is set, and the Data Parity Error Recover
4399 ** Enable bit in the PCIXCMD register is clear, assert SERR#; otherwise no action is taken.
4400 ** When the ATU asserts SERR#, additional actions is taken:
4401 ** Set the SERR# Asserted bit in the ATUSR.
4402 ** When the ATU SERR# Asserted Interrupt Mask Bit in the ATUIMR is clear, set the
4403 ** SERR# Asserted bit in the ATUISR. When set, no action.
4404 ** When the ATU SERR# Detected Interrupt Enable Bit in the ATUCR is set, set the
4405 ** SERR# Detected bit in the ATUISR. When clear, no action.
4406 ** ¡E When the SCE bit (Split Completion Error -- bit 30 of the Completer Attributes) is set during
4407 ** the Attribute phase, the Received Split Completion Error Message bit in the PCIXSR is set.
4408 ** When the ATU sets this bit, additional actions is taken:
4409 ** ¡X When the ATU Received Split Completion Error Message Interrupt Mask bit in the
4410 ** ATUIMR is clear, set the Received Split Completion Error Message bit in the ATUISR.
4411 ** When set, no action.
4412 ** ¡E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional
4413 ** actions is taken:
4414 ** ¡X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the
4415 ** Detected Parity Error bit in the ATUISR. When set, no action.
4416 ** ¡E The transaction associated with the Split Completion Message is discarded.
4417 ** ¡E When the discarded transaction was a read, a completion error message (with message
4418 ** class=2h - completer error and message index=82h - PCI bus read parity error) is generated on
4419 ** the internal bus of the 80331.
4420 *****************************************************************************
4425 ******************************************************************************************************
4426 ** Messaging Unit (MU) of the Intel R 80331 I/O processor (80331)
4427 ** ==================================================================================================
4428 ** The Messaging Unit (MU) transfers data between the PCI system and the 80331
4429 ** notifies the respective system when new data arrives.
4430 ** The PCI window for messaging transactions is always the first 4 Kbytes of the inbound translation.
4431 ** window defined by:
4432 ** 1.Inbound ATU Base Address Register 0 (IABAR0)
4433 ** 2.Inbound ATU Limit Register 0 (IALR0)
4434 ** All of the Messaging Unit errors are reported in the same manner as ATU errors.
4435 ** Error conditions and status can be found in :
4438 **====================================================================================================
4439 ** Mechanism Quantity Assert PCI Interrupt Signals Generate I/O Processor Interrupt
4440 **----------------------------------------------------------------------------------------------------
4441 ** Message Registers 2 Inbound Optional Optional
4443 **----------------------------------------------------------------------------------------------------
4444 ** Doorbell Registers 1 Inbound Optional Optional
4446 **----------------------------------------------------------------------------------------------------
4447 ** Circular Queues 4 Circular Queues Under certain conditions Under certain conditions
4448 **----------------------------------------------------------------------------------------------------
4449 ** Index Registers 1004 32-bit Memory Locations No Optional
4450 **====================================================================================================
4451 ** PCI Memory Map: First 4 Kbytes of the ATU Inbound PCI Address Space
4452 **====================================================================================================
4457 **------------------------------------------------------------------------
4458 ** 0010H Inbound Message Register 0 ]
4459 ** 0014H Inbound Message Register 1 ]
4460 ** 0018H Outbound Message Register 0 ]
4461 ** 001CH Outbound Message Register 1 ] 4 Message Registers
4462 **------------------------------------------------------------------------
4463 ** 0020H Inbound Doorbell Register ]
4464 ** 0024H Inbound Interrupt Status Register ]
4465 ** 0028H Inbound Interrupt Mask Register ]
4466 ** 002CH Outbound Doorbell Register ]
4467 ** 0030H Outbound Interrupt Status Register ]
4468 ** 0034H Outbound Interrupt Mask Register ] 2 Doorbell Registers and 4 Interrupt Registers
4469 **------------------------------------------------------------------------
4472 **------------------------------------------------------------------------
4473 ** 0040H Inbound Queue Port ]
4474 ** 0044H Outbound Queue Port ] 2 Queue Ports
4475 **------------------------------------------------------------------------
4478 **------------------------------------------------------------------------
4481 ** : Intel Xscale Microarchitecture Local Memory ]
4483 ** 0FFCH ] 1004 Index Registers
4484 *******************************************************************************
4487 *****************************************************************************
4488 ** Theory of MU Operation
4489 *****************************************************************************
4490 **--------------------
4491 ** inbound_msgaddr0:
4492 ** inbound_msgaddr1:
4493 ** outbound_msgaddr0:
4494 ** outbound_msgaddr1:
4495 ** . The MU has four independent messaging mechanisms.
4496 ** There are four Message Registers that are similar to a combination of mailbox and doorbell registers.
4497 ** Each holds a 32-bit value and generates an interrupt when written.
4498 **--------------------
4499 ** inbound_doorbell:
4500 ** outbound_doorbell:
4501 ** . The two Doorbell Registers support software interrupts.
4502 ** When a bit is set in a Doorbell Register, an interrupt is generated.
4503 **--------------------
4504 ** inbound_queueport:
4505 ** outbound_queueport:
4508 ** . The Circular Queues support a message passing scheme that uses 4 circular queues.
4509 ** The 4 circular queues are implemented in 80331 local memory.
4510 ** Two queues are used for inbound messages and two are used for outbound messages.
4511 ** Interrupts may be generated when the queue is written.
4512 **--------------------
4513 ** local_buffer 0x0050 ....0x0FFF
4514 ** . The Index Registers use a portion of the 80331 local memory to implement a large set of message registers.
4515 ** When one of the Index Registers is written, an interrupt is generated and the address of the register written is captured.
4516 ** Interrupt status for all interrupts is recorded in the Inbound Interrupt Status Register and the Outbound Interrupt Status Register.
4517 ** Each interrupt generated by the Messaging Unit can be masked.
4518 **--------------------
4519 ** . Multi-DWORD PCI burst accesses are not supported by the Messaging Unit,
4520 ** with the exception of Multi-DWORD reads to the index registers.
4521 ** In Conventional mode: the MU terminates Multi-DWORD PCI transactions
4522 ** (other than index register reads) with a disconnect at the next Qword boundary, with the exception of queue ports.
4523 ** In PCI-X mode : the MU terminates a Multi-DWORD PCI read transaction with a Split Response
4524 ** and the data is returned through split completion transaction(s).
4525 ** however, when the burst request crosses into or through the range of offsets 40h to 4Ch
4526 ** (e.g., this includes the queue ports) the transaction is signaled target-abort immediately on the PCI bus.
4527 ** In PCI-X mode, Multi-DWORD PCI writes is signaled a Single-Data-Phase Disconnect
4528 ** which means that no data beyond the first Qword (Dword when the MU does not assert P_ACK64#) is written.
4529 **--------------------
4530 ** . All registers needed to configure and control the Messaging Unit are memory-mapped registers.
4531 ** The MU uses the first 4 Kbytes of the inbound translation window in the Address Translation Unit (ATU).
4532 ** This PCI address window is used for PCI transactions that access the 80331 local memory.
4533 ** The PCI address of the inbound translation window is contained in the Inbound ATU Base Address Register.
4534 **--------------------
4535 ** . From the PCI perspective, the Messaging Unit is part of the Address Translation Unit.
4536 ** The Messaging Unit uses the PCI configuration registers of the ATU for control and status information.
4537 ** The Messaging Unit must observe all PCI control bits in the ATU Command Register and ATU Configuration Register.
4538 ** The Messaging Unit reports all PCI errors in the ATU Status Register.
4539 **--------------------
4540 ** . Parts of the Messaging Unit can be accessed as a 64-bit PCI device.
4541 ** The register interface, message registers, doorbell registers,
4542 ** and index registers returns a P_ACK64# in response to a P_REQ64# on the PCI interface.
4543 ** Up to 1 Qword of data can be read or written per transaction (except Index Register reads).
4544 ** The Inbound and Outbound Queue Ports are always 32-bit addresses and the MU does not assert P_ACK64# to offsets 40H and 44H.
4545 **************************************************************************
4548 **************************************************************************
4549 ** Message Registers
4550 ** ==============================
4551 ** . Messages can be sent and received by the 80331 through the use of the Message Registers.
4552 ** . When written, the message registers may cause an interrupt to be generated to either the Intel XScale core or the host processor.
4553 ** . Inbound messages are sent by the host processor and received by the 80331.
4554 ** Outbound messages are sent by the 80331 and received by the host processor.
4555 ** . The interrupt status for outbound messages is recorded in the Outbound Interrupt Status Register.
4556 ** Interrupt status for inbound messages is recorded in the Inbound Interrupt Status Register.
4558 ** Inbound Messages:
4559 ** -----------------
4560 ** . When an inbound message register is written by an external PCI agent, an interrupt may be generated to the Intel XScale core.
4561 ** . The interrupt may be masked by the mask bits in the Inbound Interrupt Mask Register.
4562 ** . The Intel XScale core interrupt is recorded in the Inbound Interrupt Status Register.
4563 ** The interrupt causes the Inbound Message Interrupt bit to be set in the Inbound Interrupt Status Register.
4564 ** This is a Read/Clear bit that is set by the MU hardware and cleared by software.
4565 ** The interrupt is cleared when the Intel XScale core writes a value of
4566 ** 1 to the Inbound Message Interrupt bit in the Inbound Interrupt Status Register.
4567 ** ------------------------------------------------------------------------
4568 ** Inbound Message Register - IMRx
4570 ** . There are two Inbound Message Registers: IMR0 and IMR1.
4571 ** . When the IMR register is written, an interrupt to the Intel XScale core may be generated.
4572 ** The interrupt is recorded in the Inbound Interrupt Status Register and may be masked
4573 ** by the Inbound Message Interrupt Mask bit in the Inbound Interrupt Mask Register.
4574 ** -----------------------------------------------------------------
4575 ** Bit Default Description
4576 ** 31:00 0000 0000H Inbound Message - This is a 32-bit message written by an external PCI agent.
4577 ** When written, an interrupt to the Intel XScale core may be generated.
4578 **************************************************************************
4580 #define ARCMSR_MU_INBOUND_MESSAGE_REG0 0x10 /*dword 0x13,0x12,0x11,0x10*/
4581 #define ARCMSR_MU_INBOUND_MESSAGE_REG1 0x14 /*dword 0x17,0x16,0x15,0x14*/
4583 **************************************************************************
4584 ** Outbound Message Register - OMRx
4585 ** --------------------------------
4586 ** There are two Outbound Message Registers: OMR0 and OMR1. When the OMR register is
4587 ** written, a PCI interrupt may be generated. The interrupt is recorded in the Outbound Interrupt
4588 ** Status Register and may be masked by the Outbound Message Interrupt Mask bit in the Outbound
4589 ** Interrupt Mask Register.
4591 ** Bit Default Description
4592 ** 31:00 00000000H Outbound Message - This is 32-bit message written by the Intel XScale core. When written, an
4593 ** interrupt may be generated on the PCI Interrupt pin determined by the ATU Interrupt Pin Register.
4594 **************************************************************************
4596 #define ARCMSR_MU_OUTBOUND_MESSAGE_REG0 0x18 /*dword 0x1B,0x1A,0x19,0x18*/
4597 #define ARCMSR_MU_OUTBOUND_MESSAGE_REG1 0x1C /*dword 0x1F,0x1E,0x1D,0x1C*/
4599 **************************************************************************
4600 ** Doorbell Registers
4601 ** ==============================
4602 ** There are two Doorbell Registers:
4603 ** Inbound Doorbell Register
4604 ** Outbound Doorbell Register
4605 ** The Inbound Doorbell Register allows external PCI agents to generate interrupts to the Intel R XScale core.
4606 ** The Outbound Doorbell Register allows the Intel R XScale core to generate a PCI interrupt.
4607 ** Both Doorbell Registers may generate interrupts whenever a bit in the register is set.
4609 ** Inbound Doorbells:
4610 ** ------------------
4611 ** . When the Inbound Doorbell Register is written by an external PCI agent, an interrupt may be generated to the Intel R XScale core.
4612 ** An interrupt is generated when any of the bits in the doorbell register is written to a value of 1.
4613 ** Writing a value of 0 to any bit does not change the value of that bit and does not cause an interrupt to be generated.
4614 ** . Once a bit is set in the Inbound Doorbell Register, it cannot be cleared by any external PCI agent.
4615 ** The interrupt is recorded in the Inbound Interrupt Status Register.
4616 ** . The interrupt may be masked by the Inbound Doorbell Interrupt mask bit in the Inbound Interrupt Mask Register.
4617 ** When the mask bit is set for a particular bit, no interrupt is generated for that bit.
4618 ** The Inbound Interrupt Mask Register affects only the generation of the normal messaging unit interrupt
4619 ** and not the values written to the Inbound Doorbell Register.
4620 ** One bit in the Inbound Doorbell Register is reserved for an Error Doorbell interrupt.
4621 ** . The interrupt is cleared when the Intel R XScale core writes a value of 1 to the bits in the Inbound Doorbell Register that are set.
4622 ** Writing a value of 0 to any bit does not change the value of that bit and does not clear the interrupt.
4623 ** ------------------------------------------------------------------------
4624 ** Inbound Doorbell Register - IDR
4626 ** . The Inbound Doorbell Register (IDR) is used to generate interrupts to the Intel XScale core.
4627 ** . Bit 31 is reserved for generating an Error Doorbell interrupt.
4628 ** When bit 31 is set, an Error interrupt may be generated to the Intel XScale core.
4629 ** All other bits, when set, cause the Normal Messaging Unit interrupt line of the Intel XScale core to be asserted,
4630 ** when the interrupt is not masked by the Inbound Doorbell Interrupt Mask bit in the Inbound Interrupt Mask Register.
4631 ** The bits in the IDR register can only be set by an external PCI agent and can only be cleared by the Intel XScale core.
4632 ** ------------------------------------------------------------------------
4633 ** Bit Default Description
4634 ** 31 0 2 Error Interrupt - Generate an Error Interrupt to the Intel XScale core.
4635 ** 30:00 00000000H Normal Interrupt - When any bit is set, generate a Normal interrupt to the Intel XScale core.
4636 ** When all bits are clear, do not generate a Normal Interrupt.
4637 **************************************************************************
4639 #define ARCMSR_MU_INBOUND_DOORBELL_REG 0x20 /*dword 0x23,0x22,0x21,0x20*/
4641 **************************************************************************
4642 ** Inbound Interrupt Status Register - IISR
4644 ** . The Inbound Interrupt Status Register (IISR) contains hardware interrupt status.
4645 ** It records the status of Intel XScale core interrupts generated by the Message Registers, Doorbell Registers, and the Circular Queues.
4646 ** All interrupts are routed to the Normal Messaging Unit interrupt input of the Intel XScale core,
4647 ** except for the Error Doorbell Interrupt and the Outbound Free Queue Full interrupt;
4648 ** these two are routed to the Messaging Unit Error interrupt input.
4649 ** The generation of interrupts recorded in the Inbound Interrupt Status Register
4650 ** may be masked by setting the corresponding bit in the Inbound Interrupt Mask Register.
4651 ** Some of the bits in this register are Read Only.
4652 ** For those bits, the interrupt must be cleared through another register.
4654 ** Bit Default Description
4655 ** 31:07 0000000H 0 2 Reserved
4656 ** 06 0 2 Index Register Interrupt - This bit is set by the MU hardware
4657 ** when an Index Register has been written after a PCI transaction.
4658 ** 05 0 2 Outbound Free Queue Full Interrupt - This bit is set
4659 ** when the Outbound Free Head Pointer becomes equal to the Tail Pointer and the queue is full.
4660 ** An Error interrupt is generated for this condition.
4661 ** 04 0 2 Inbound Post Queue Interrupt - This bit is set by the MU hardware when the Inbound Post Queue has been written.
4662 ** Once cleared, an interrupt does NOT be generated
4663 ** when the head and tail pointers remain unequal (i.e. queue status is Not Empty).
4664 ** Therefore, when software leaves any unprocessed messages in the post queue when the interrupt is cleared,
4665 ** software must retain the information that the Inbound Post queue status is not empty.
4666 ** NOTE: This interrupt is provided with dedicated support in the 80331 Interrupt Controller.
4667 ** 03 0 2 Error Doorbell Interrupt - This bit is set when the Error Interrupt of the Inbound Doorbell Register is set.
4668 ** To clear this bit (and the interrupt), the Error Interrupt bit of the Inbound Doorbell Register must be clear.
4669 ** 02 0 2 Inbound Doorbell Interrupt - This bit is set when at least one
4670 ** Normal Interrupt bit in the Inbound Doorbell Register is set.
4671 ** To clear this bit (and the interrupt), the Normal Interrupt bits in the Inbound Doorbell Register must all be clear.
4672 ** 01 0 2 Inbound Message 1 Interrupt - This bit is set by the MU hardware when the Inbound Message 1 Register has been written.
4673 ** 00 0 2 Inbound Message 0 Interrupt - This bit is set by the MU hardware when the Inbound Message 0 Register has been written.
4674 **************************************************************************
4676 #define ARCMSR_MU_INBOUND_INTERRUPT_STATUS_REG 0x24 /*dword 0x27,0x26,0x25,0x24*/
4677 #define ARCMSR_MU_INBOUND_INDEX_INT 0x40
4678 #define ARCMSR_MU_INBOUND_QUEUEFULL_INT 0x20
4679 #define ARCMSR_MU_INBOUND_POSTQUEUE_INT 0x10
4680 #define ARCMSR_MU_INBOUND_ERROR_DOORBELL_INT 0x08
4681 #define ARCMSR_MU_INBOUND_DOORBELL_INT 0x04
4682 #define ARCMSR_MU_INBOUND_MESSAGE1_INT 0x02
4683 #define ARCMSR_MU_INBOUND_MESSAGE0_INT 0x01
4685 **************************************************************************
4686 ** Inbound Interrupt Mask Register - IIMR
4688 ** . The Inbound Interrupt Mask Register (IIMR) provides the ability to mask Intel XScale core interrupts generated by the Messaging Unit.
4689 ** Each bit in the Mask register corresponds to an interrupt bit in the Inbound Interrupt Status Register.
4690 ** Setting or clearing bits in this register does not affect the Inbound Interrupt Status Register.
4691 ** They only affect the generation of the Intel XScale core interrupt.
4692 ** ------------------------------------------------------------------------
4693 ** Bit Default Description
4694 ** 31:07 000000H 0 2 Reserved
4695 ** 06 0 2 Index Register Interrupt Mask - When set, this bit masks the interrupt generated by the MU hardware
4696 ** when an Index Register has been written after a PCI transaction.
4697 ** 05 0 2 Outbound Free Queue Full Interrupt Mask - When set, this bit masks the Error interrupt generated
4698 ** when the Outbound Free Head Pointer becomes equal to the Tail Pointer and the queue is full.
4699 ** 04 0 2 Inbound Post Queue Interrupt Mask - When set, this bit masks the interrupt generated
4700 ** by the MU hardware when the Inbound Post Queue has been written.
4701 ** 03 0 2 Error Doorbell Interrupt Mask - When set, this bit masks the Error Interrupt
4702 ** when the Error Interrupt bit of the Inbound Doorbell Register is set.
4703 ** 02 0 2 Inbound Doorbell Interrupt Mask - When set, this bit masks the interrupt generated
4704 ** when at least one Normal Interrupt bit in the Inbound Doorbell Register is set.
4705 ** 01 0 2 Inbound Message 1 Interrupt Mask - When set, this bit masks the Inbound Message 1
4706 ** Interrupt generated by a write to the Inbound Message 1 Register.
4707 ** 00 0 2 Inbound Message 0 Interrupt Mask - When set,
4708 ** this bit masks the Inbound Message 0 Interrupt generated by a write to the Inbound Message 0 Register.
4709 **************************************************************************
4711 #define ARCMSR_MU_INBOUND_INTERRUPT_MASK_REG 0x28 /*dword 0x2B,0x2A,0x29,0x28*/
4712 #define ARCMSR_MU_INBOUND_INDEX_INTMASKENABLE 0x40
4713 #define ARCMSR_MU_INBOUND_QUEUEFULL_INTMASKENABLE 0x20
4714 #define ARCMSR_MU_INBOUND_POSTQUEUE_INTMASKENABLE 0x10
4715 #define ARCMSR_MU_INBOUND_DOORBELL_ERROR_INTMASKENABLE 0x08
4716 #define ARCMSR_MU_INBOUND_DOORBELL_INTMASKENABLE 0x04
4717 #define ARCMSR_MU_INBOUND_MESSAGE1_INTMASKENABLE 0x02
4718 #define ARCMSR_MU_INBOUND_MESSAGE0_INTMASKENABLE 0x01
4720 **************************************************************************
4721 ** Outbound Doorbell Register - ODR
4723 ** The Outbound Doorbell Register (ODR) allows software interrupt generation. It allows the Intel
4724 ** XScale core to generate PCI interrupts to the host processor by writing to this register. The
4725 ** generation of PCI interrupts through the Outbound Doorbell Register may be masked by setting the
4726 ** Outbound Doorbell Interrupt Mask bit in the Outbound Interrupt Mask Register.
4727 ** The Software Interrupt bits in this register can only be set by the Intel XScale core and can only
4728 ** be cleared by an external PCI agent.
4729 ** ----------------------------------------------------------------------
4730 ** Bit Default Description
4734 ** 28 0000 0000H PCI Interrupt - When set, this bit causes the P_INTC# interrupt output
4735 ** (P_INTA# with BRG_EN and ARB_EN straps low)
4736 ** signal to be asserted or a Message-signaled Interrupt is generated (when enabled).
4737 ** When this bit is cleared, the P_INTC# interrupt output
4738 ** (P_INTA# with BRG_EN and ARB_EN straps low)
4739 ** signal is deasserted.
4740 ** 27:00 000 0000H Software Interrupts - When any bit is set the P_INTC# interrupt output
4741 ** (P_INTA# with BRG_EN and ARB_EN straps low)
4742 ** signal is asserted or a Message-signaled Interrupt is generated (when enabled).
4743 ** When all bits are cleared, the P_INTC# interrupt output (P_INTA# with BRG_EN and ARB_EN straps low)
4744 ** signal is deasserted.
4745 **************************************************************************
4747 #define ARCMSR_MU_OUTBOUND_DOORBELL_REG 0x2C /*dword 0x2F,0x2E,0x2D,0x2C*/
4749 **************************************************************************
4750 ** Outbound Interrupt Status Register - OISR
4752 ** The Outbound Interrupt Status Register (OISR) contains hardware interrupt status. It records the
4753 ** status of PCI interrupts generated by the Message Registers, Doorbell Registers, and the Circular
4754 ** Queues. The generation of PCI interrupts recorded in the Outbound Interrupt Status Register may
4755 ** be masked by setting the corresponding bit in the Outbound Interrupt Mask Register. Some of the
4756 ** bits in this register are Read Only. For those bits, the interrupt must be cleared through another
4758 ** ----------------------------------------------------------------------
4759 ** Bit Default Description
4760 ** 31:05 000000H 000 2 Reserved
4761 ** 04 0 2 PCI Interrupt - This bit is set when the PCI Interrupt bit (bit 28) is set in the Outbound Doorbell Register.
4762 ** To clear this bit (and the interrupt), the PCI Interrupt bit must be cleared.
4763 ** 03 0 2 Outbound Post Queue Interrupt - This bit is set when data in the prefetch buffer is valid. This bit is
4764 ** cleared when any prefetch data has been read from the Outbound Queue Port.
4765 ** 02 0 2 Outbound Doorbell Interrupt - This bit is set when at least one Software Interrupt bit in the Outbound
4766 ** Doorbell Register is set. To clear this bit (and the interrupt), the Software Interrupt bits in the Outbound
4767 ** Doorbell Register must all be clear.
4768 ** 01 0 2 Outbound Message 1 Interrupt - This bit is set by the MU when the Outbound Message 1 Register is
4769 ** written. Clearing this bit clears the interrupt.
4770 ** 00 0 2 Outbound Message 0 Interrupt - This bit is set by the MU when the Outbound Message 0 Register is
4771 ** written. Clearing this bit clears the interrupt.
4772 **************************************************************************
4774 #define ARCMSR_MU_OUTBOUND_INTERRUPT_STATUS_REG 0x30 /*dword 0x33,0x32,0x31,0x30*/
4775 #define ARCMSR_MU_OUTBOUND_PCI_INT 0x10
4776 #define ARCMSR_MU_OUTBOUND_POSTQUEUE_INT 0x08
4777 #define ARCMSR_MU_OUTBOUND_DOORBELL_INT 0x04
4778 #define ARCMSR_MU_OUTBOUND_MESSAGE1_INT 0x02
4779 #define ARCMSR_MU_OUTBOUND_MESSAGE0_INT 0x01
4781 **************************************************************************
4782 ** Outbound Interrupt Mask Register - OIMR
4783 ** The Outbound Interrupt Mask Register (OIMR) provides the ability to mask outbound PCI
4784 ** interrupts generated by the Messaging Unit. Each bit in the mask register corresponds to a
4785 ** hardware interrupt bit in the Outbound Interrupt Status Register. When the bit is set, the PCI
4786 ** interrupt is not generated. When the bit is clear, the interrupt is allowed to be generated.
4787 ** Setting or clearing bits in this register does not affect the Outbound Interrupt Status Register. They
4788 ** only affect the generation of the PCI interrupt.
4789 ** ----------------------------------------------------------------------
4790 ** Bit Default Description
4791 ** 31:05 000000H Reserved
4792 ** 04 0 2 PCI Interrupt Mask - When set, this bit masks the interrupt generation when the PCI Interrupt bit (bit 28)
4793 ** in the Outbound Doorbell Register is set.
4794 ** 03 0 2 Outbound Post Queue Interrupt Mask - When set, this bit masks the interrupt generated when data in
4795 ** the prefetch buffer is valid.
4796 ** 02 0 2 Outbound Doorbell Interrupt Mask - When set, this bit masks the interrupt generated by the Outbound
4797 ** Doorbell Register.
4798 ** 01 0 2 Outbound Message 1 Interrupt Mask - When set, this bit masks the Outbound Message 1 Interrupt
4799 ** generated by a write to the Outbound Message 1 Register.
4800 ** 00 0 2 Outbound Message 0 Interrupt Mask- When set, this bit masks the Outbound Message 0 Interrupt
4801 ** generated by a write to the Outbound Message 0 Register.
4802 **************************************************************************
4804 #define ARCMSR_MU_OUTBOUND_INTERRUPT_MASK_REG 0x34 /*dword 0x37,0x36,0x35,0x34*/
4805 #define ARCMSR_MU_OUTBOUND_PCI_INTMASKENABLE 0x10
4806 #define ARCMSR_MU_OUTBOUND_POSTQUEUE_INTMASKENABLE 0x08
4807 #define ARCMSR_MU_OUTBOUND_DOORBELL_INTMASKENABLE 0x04
4808 #define ARCMSR_MU_OUTBOUND_MESSAGE1_INTMASKENABLE 0x02
4809 #define ARCMSR_MU_OUTBOUND_MESSAGE0_INTMASKENABLE 0x01
4810 #define ARCMSR_MU_OUTBOUND_ALL_INTMASKENABLE 0x1F
4812 **************************************************************************
4814 **************************************************************************
4816 #define ARCMSR_MU_INBOUND_QUEUE_PORT_REG 0x40 /*dword 0x43,0x42,0x41,0x40*/
4817 #define ARCMSR_MU_OUTBOUND_QUEUE_PORT_REG 0x44 /*dword 0x47,0x46,0x45,0x44*/
4819 **************************************************************************
4821 ** ======================================================================
4822 ** The MU implements four circular queues. There are 2 inbound queues and 2 outbound queues. In
4823 ** this case, inbound and outbound refer to the direction of the flow of posted messages.
4824 ** Inbound messages are either:
4825 ** ¡E posted messages by other processors for the Intel XScale core to process or
4826 ** ¡E free (or empty) messages that can be reused by other processors.
4827 ** Outbound messages are either:
4828 ** ¡E posted messages by the Intel XScale core for other processors to process or
4829 ** ¡E free (or empty) messages that can be reused by the Intel XScale core.
4830 ** Therefore, free inbound messages flow away from the 80331 and free outbound messages flow toward the 80331.
4831 ** The four Circular Queues are used to pass messages in the following manner.
4832 ** . The two inbound queues are used to handle inbound messages
4833 ** and the two outbound queues are used to handle outbound messages.
4834 ** . One of the inbound queues is designated the Free queue and it contains inbound free messages.
4835 ** The other inbound queue is designated the Post queue and it contains inbound posted messages.
4836 ** Similarly, one of the outbound queues is designated the Free queue and the other outbound queue is designated the Post queue.
4838 ** =============================================================================================================
4839 ** Circular Queue Summary
4840 ** _____________________________________________________________________________________________________________
4841 ** | Queue Name | Purpose | Action on PCI Interface|
4842 ** |______________________|____________________________________________________________|_________________________|
4843 ** |Inbound Post Queue | Queue for inbound messages from other processors | Written |
4844 ** | | waiting to be processed by the 80331 | |
4845 ** |Inbound Free Queue | Queue for empty inbound messages from the 80331 | Read |
4846 ** | | available for use by other processors | |
4847 ** |Outbound Post Queue | Queue for outbound messages from the 80331 | Read |
4848 ** | | that are being posted to the other processors | |
4849 ** |Outbound Free Queue | Queue for empty outbound messages from other processors | Written |
4850 ** | | available for use by the 80331 | |
4851 ** |______________________|____________________________________________________________|_________________________|
4853 ** . The two inbound queues allow the host processor to post inbound messages for the 80331 in one
4854 ** queue and to receive free messages returning from the 80331.
4855 ** The host processor posts inbound messages,
4856 ** the Intel XScale core receives the posted message and when it is finished with the message,
4857 ** places it back on the inbound free queue for reuse by the host processor.
4859 ** The circular queues are accessed by external PCI agents through two port locations in the PCI
4861 ** Inbound Queue Port
4862 ** and Outbound Queue Port.
4863 ** The Inbound Queue Port is used by external PCI agents to read the Inbound Free Queue and write the Inbound Post Queue.
4864 ** The Outbound Queue Port is used by external PCI agents to read the Outbound Post Queue and write the Outbound Free Queue.
4865 ** Note that a PCI transaction to the inbound or outbound queue ports with null byte enables (P_C/BE[3:0]#=1111 2 )
4866 ** does not cause the MU hardware to increment the queue pointers.
4867 ** This is treated as when the PCI transaction did not occur.
4868 ** The Inbound and Outbound Queue Ports never respond with P_ACK64# on the PCI interface.
4869 ** ======================================================================================
4870 ** Overview of Circular Queue Operation
4871 ** ======================================================================================
4872 ** . The data storage for the circular queues must be provided by the 80331 local memory.
4873 ** . The base address of the circular queues is contained in the Queue Base Address Register.
4874 ** Each entry in the queue is a 32-bit data value.
4875 ** . Each read from or write to the queue may access only one queue entry.
4876 ** . Multi-DWORD accesses to the circular queues are not allowed.
4877 ** Sub-DWORD accesses are promoted to DWORD accesses.
4878 ** . Each circular queue has a head pointer and a tail pointer.
4879 ** The pointers are offsets from the Queue Base Address.
4880 ** . Writes to a queue occur at the head of the queue and reads occur from the tail.
4881 ** The head and tail pointers are incremented by either the Intel XScale core or the Messaging Unit hardware.
4882 ** Which unit maintains the pointer is determined by the writer of the queue.
4883 ** More details about the pointers are given in the queue descriptions below.
4884 ** The pointers are incremented after the queue access.
4885 ** Both pointers wrap around to the first address of the circular queue when they reach the circular queue size.
4887 ** Messaging Unit...
4889 ** The Messaging Unit generates an interrupt to the Intel XScale core or generate a PCI interrupt under certain conditions.
4890 ** . In general, when a Post queue is written, an interrupt is generated to notify the receiver that a message was posted.
4891 ** The size of each circular queue can range from 4K entries (16 Kbytes) to 64K entries (256 Kbytes).
4892 ** . All four queues must be the same size and may be contiguous.
4893 ** Therefore, the total amount of local memory needed by the circular queues ranges from 64 Kbytes to 1 Mbytes.
4894 ** The Queue size is determined by the Queue Size field in the MU Configuration Register.
4895 ** . There is one base address for all four queues.
4896 ** It is stored in the Queue Base Address Register (QBAR).
4897 ** The starting addresses of each queue is based on the Queue Base Address and the Queue Size field.
4898 ** here shows an example of how the circular queues should be set up based on the
4899 ** Intelligent I/O (I 2 O) Architecture Specification.
4900 ** Other ordering of the circular queues is possible.
4902 ** Queue Starting Address
4903 ** Inbound Free Queue QBAR
4904 ** Inbound Post Queue QBAR + Queue Size
4905 ** Outbound Post Queue QBAR + 2 * Queue Size
4906 ** Outbound Free Queue QBAR + 3 * Queue Size
4907 ** ===================================================================================
4908 ** Inbound Post Queue
4909 ** ------------------
4910 ** The Inbound Post Queue holds posted messages placed there by other processors for the Intel XScale core to process.
4911 ** This queue is read from the queue tail by the Intel XScale core. It is written to the queue head by external PCI agents.
4912 ** The tail pointer is maintained by the Intel XScale core. The head pointer is maintained by the MU hardware.
4913 ** For a PCI write transaction that accesses the Inbound Queue Port,
4914 ** the MU writes the data to the local memory location address in the Inbound Post Head Pointer Register.
4915 ** When the data written to the Inbound Queue Port is written to local memory, the MU hardware increments the Inbound Post Head Pointer Register.
4916 ** An Intel XScale core interrupt may be generated when the Inbound Post Queue is written.
4917 ** The Inbound Post Queue Interrupt bit in the Inbound Interrupt Status Register indicates the interrupt status.
4918 ** The interrupt is cleared when the Inbound Post Queue Interrupt bit is cleared.
4919 ** The interrupt can be masked by the Inbound Interrupt Mask Register.
4920 ** Software must be aware of the state of the Inbound Post Queue Interrupt Mask bit to guarantee
4921 ** that the full condition is recognized by the core processor.
4922 ** In addition, to guarantee that the queue does not get overwritten,
4923 ** software must process messages from the tail of the queue before incrementing the tail pointer and clearing this interrupt.
4924 ** Once cleared, an interrupt is NOT generated when the head and tail pointers remain unequal (i.e. queue status is Not Empty).
4925 ** Only a new message posting the in the inbound queue generates a new interrupt.
4926 ** Therefore, when software leaves any unprocessed messages in the post queue when the interrupt is cleared,
4927 ** software must retain the information that the Inbound Post queue status.
4928 ** From the time that the PCI write transaction is received until the data is written
4929 ** in local memory and the Inbound Post Head Pointer Register is incremented,
4930 ** any PCI transaction that attempts to access the Inbound Post Queue Port is signalled a Retry.
4931 ** The Intel XScale core may read messages from the Inbound Post Queue
4932 ** by reading the data from the local memory location pointed to by the Inbound Post Tail Pointer Register.
4933 ** The Intel XScale core must then increment the Inbound Post Tail Pointer Register.
4934 ** When the Inbound Post Queue is full (head and tail pointers are equal and the head pointer was last updated by hardware),
4935 ** the hardware retries any PCI writes until a slot in the queue becomes available.
4936 ** A slot in the post queue becomes available by the Intel XScale core incrementing the tail pointer.
4937 ** ===================================================================================
4938 ** Inbound Free Queue
4939 ** ------------------
4940 ** The Inbound Free Queue holds free inbound messages placed there by the Intel XScale core for other processors to use.
4941 ** This queue is read from the queue tail by external PCI agents.
4942 ** It is written to the queue head by the Intel XScale core.
4943 ** The tail pointer is maintained by the MU hardware.
4944 ** The head pointer is maintained by the Intel XScale core.
4945 ** For a PCI read transaction that accesses the Inbound Queue Port,
4946 ** the MU attempts to read the data at the local memory address in the Inbound Free Tail Pointer.
4947 ** When the queue is not empty (head and tail pointers are not equal)
4948 ** or full (head and tail pointers are equal but the head pointer was last written by software), the data is returned.
4949 ** When the queue is empty (head and tail pointers are equal and the head pointer was last updated by hardware),
4950 ** the value of -1 (FFFF.FFFFH) is returned.
4951 ** When the queue was not empty and the MU succeeded in returning the data at the tail,
4952 ** the MU hardware must increment the value in the Inbound Free Tail Pointer Register.
4953 ** To reduce latency for the PCI read access, the MU implements a prefetch mechanism to anticipate accesses to the Inbound Free Queue.
4954 ** The MU hardware prefetches the data at the tail of the Inbound Free Queue and load it into an internal prefetch register.
4955 ** When the PCI read access occurs, the data is read directly from the prefetch register.
4956 ** The prefetch mechanism loads a value of -1 (FFFF.FFFFH) into the prefetch register
4957 ** when the head and tail pointers are equal and the queue is empty.
4958 ** In order to update the prefetch register when messages are added to the queue and it becomes non-empty,
4959 ** the prefetch mechanism automatically starts a prefetch when the prefetch register contains FFFF.FFFFH
4960 ** and the Inbound Free Head Pointer Register is written.
4961 ** The Intel XScale core needs to update the Inbound Free Head Pointer Register when it adds messages to the queue.
4962 ** A prefetch must appear atomic from the perspective of the external PCI agent.
4963 ** When a prefetch is started, any PCI transaction that attempts to access the Inbound Free Queue is signalled a Retry until the prefetch is completed.
4964 ** The Intel XScale core may place messages in the Inbound Free Queue by writing the data to the
4965 ** local memory location pointed to by the Inbound Free Head Pointer Register.
4966 ** The processor must then increment the Inbound Free Head Pointer Register.
4967 ** ==================================================================================
4968 ** Outbound Post Queue
4969 ** -------------------
4970 ** The Outbound Post Queue holds outbound posted messages placed there by the Intel XScale
4971 ** core for other processors to process. This queue is read from the queue tail by external PCI agents.
4972 ** It is written to the queue head by the Intel XScale core. The tail pointer is maintained by the
4973 ** MU hardware. The head pointer is maintained by the Intel XScale core.
4974 ** For a PCI read transaction that accesses the Outbound Queue Port, the MU attempts to read the
4975 ** data at the local memory address in the Outbound Post Tail Pointer Register. When the queue is not
4976 ** empty (head and tail pointers are not equal) or full (head and tail pointers are equal but the head
4977 ** pointer was last written by software), the data is returned. When the queue is empty (head and tail
4978 ** pointers are equal and the head pointer was last updated by hardware), the value of -1
4979 ** (FFFF.FFFFH) is returned. When the queue was not empty and the MU succeeded in returning the
4980 ** data at the tail, the MU hardware must increment the value in the Outbound Post Tail Pointer
4982 ** To reduce latency for the PCI read access, the MU implements a prefetch mechanism to anticipate
4983 ** accesses to the Outbound Post Queue. The MU hardware prefetches the data at the tail of the
4984 ** Outbound Post Queue and load it into an internal prefetch register. When the PCI read access
4985 ** occurs, the data is read directly from the prefetch register.
4986 ** The prefetch mechanism loads a value of -1 (FFFF.FFFFH) into the prefetch register when the head
4987 ** and tail pointers are equal and the queue is empty. In order to update the prefetch register when
4988 ** messages are added to the queue and it becomes non-empty, the prefetch mechanism automatically
4989 ** starts a prefetch when the prefetch register contains FFFF.FFFFH and the Outbound Post Head
4990 ** Pointer Register is written. The Intel XScale core needs to update the Outbound Post Head
4991 ** Pointer Register when it adds messages to the queue.
4992 ** A prefetch must appear atomic from the perspective of the external PCI agent. When a prefetch is
4993 ** started, any PCI transaction that attempts to access the Outbound Post Queue is signalled a Retry
4994 ** until the prefetch is completed.
4995 ** A PCI interrupt may be generated when data in the prefetch buffer is valid. When the prefetch
4996 ** queue is clear, no interrupt is generated. The Outbound Post Queue Interrupt bit in the Outbound
4997 ** Interrupt Status Register shall indicate the status of the prefetch buffer data and therefore the
4998 ** interrupt status. The interrupt is cleared when any prefetched data has been read from the Outbound
4999 ** Queue Port. The interrupt can be masked by the Outbound Interrupt Mask Register.
5000 ** The Intel XScale core may place messages in the Outbound Post Queue by writing the data to
5001 ** the local memory address in the Outbound Post Head Pointer Register. The processor must then
5002 ** increment the Outbound Post Head Pointer Register.
5003 ** ==================================================
5004 ** Outbound Free Queue
5005 ** -----------------------
5006 ** The Outbound Free Queue holds free messages placed there by other processors for the Intel
5007 ** XScale core to use. This queue is read from the queue tail by the Intel XScale core. It is
5008 ** written to the queue head by external PCI agents. The tail pointer is maintained by the Intel
5009 ** XScale core. The head pointer is maintained by the MU hardware.
5010 ** For a PCI write transaction that accesses the Outbound Queue Port, the MU writes the data to the
5011 ** local memory address in the Outbound Free Head Pointer Register. When the data written to the
5012 ** Outbound Queue Port is written to local memory, the MU hardware increments the Outbound Free
5013 ** Head Pointer Register.
5014 ** When the head pointer and the tail pointer become equal and the queue is full, the MU may signal
5015 ** an interrupt to the Intel XScale core to register the queue full condition. This interrupt is
5016 ** recorded in the Inbound Interrupt Status Register. The interrupt is cleared when the Outbound Free
5017 ** Queue Full Interrupt bit is cleared and not by writing to the head or tail pointers. The interrupt can
5018 ** be masked by the Inbound Interrupt Mask Register. Software must be aware of the state of the
5019 ** Outbound Free Queue Interrupt Mask bit to guarantee that the full condition is recognized by the
5021 ** From the time that a PCI write transaction is received until the data is written in local memory and
5022 ** the Outbound Free Head Pointer Register is incremented, any PCI transaction that attempts to
5023 ** access the Outbound Free Queue Port is signalled a retry.
5024 ** The Intel XScale core may read messages from the Outbound Free Queue by reading the data
5025 ** from the local memory address in the Outbound Free Tail Pointer Register. The processor must
5026 ** then increment the Outbound Free Tail Pointer Register. When the Outbound Free Queue is full,
5027 ** the hardware must retry any PCI writes until a slot in the queue becomes available.
5029 ** ==================================================================================
5030 ** Circular Queue Summary
5031 ** ----------------------
5032 ** ________________________________________________________________________________________________________________________________________________
5033 ** | Queue Name | PCI Port |Generate PCI Interrupt |Generate Intel Xscale Core Interrupt|Head Pointer maintained by|Tail Pointer maintained by|
5034 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________|
5035 ** |Inbound Post | Inbound Queue | | | | |
5036 ** | Queue | Port | NO | Yes, when queue is written | MU hardware | Intel XScale |
5037 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________|
5038 ** |Inbound Free | Inbound Queue | | | | |
5039 ** | Queue | Port | NO | NO | Intel XScale | MU hardware |
5040 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________|
5041 ** ==================================================================================
5042 ** Circular Queue Status Summary
5043 ** ----------------------
5044 ** ____________________________________________________________________________________________________
5045 ** | Queue Name | Queue Status | Head & Tail Pointer | Last Pointer Update |
5046 ** |_____________________|________________|_____________________|_______________________________________|
5047 ** | Inbound Post Queue | Empty | Equal | Tail pointer last updated by software |
5048 ** |_____________________|________________|_____________________|_______________________________________|
5049 ** | Inbound Free Queue | Empty | Equal | Head pointer last updated by hardware |
5050 ** |_____________________|________________|_____________________|_______________________________________|
5051 **************************************************************************
5055 **************************************************************************
5057 ** ========================
5058 ** . The Index Registers are a set of 1004 registers that when written by an external PCI agent can generate an interrupt to the Intel XScale core.
5059 ** These registers are for inbound messages only.
5060 ** The interrupt is recorded in the Inbound Interrupt Status Register.
5061 ** The storage for the Index Registers is allocated from the 80331 local memory.
5062 ** PCI write accesses to the Index Registers write the data to local memory.
5063 ** PCI read accesses to the Index Registers read the data from local memory.
5064 ** . The local memory used for the Index Registers ranges from Inbound ATU Translate Value Register + 050H
5065 ** to Inbound ATU Translate Value Register + FFFH.
5066 ** . The address of the first write access is stored in the Index Address Register.
5067 ** This register is written during the earliest write access and provides a means to determine which Index Register was written.
5068 ** Once updated by the MU, the Index Address Register is not updated until the Index Register
5069 ** Interrupt bit in the Inbound Interrupt Status Register is cleared.
5070 ** . When the interrupt is cleared, the Index Address Register is re-enabled and stores the address of the next Index Register write access.
5071 ** Writes by the Intel XScale core to the local memory used by the Index Registers
5072 ** does not cause an interrupt and does not update the Index Address Register.
5073 ** . The index registers can be accessed with Multi-DWORD reads and single QWORD aligned writes.
5074 **************************************************************************
5077 **************************************************************************
5078 ** Messaging Unit Internal Bus Memory Map
5079 ** =======================================
5080 ** Internal Bus Address___Register Description (Name)____________________|_PCI Configuration Space Register Number_
5081 ** FFFF E300H reserved |
5083 ** FFFF E30CH reserved |
5084 ** FFFF E310H Inbound Message Register 0 | Available through
5085 ** FFFF E314H Inbound Message Register 1 | ATU Inbound Translation Window
5086 ** FFFF E318H Outbound Message Register 0 |
5087 ** FFFF E31CH Outbound Message Register 1 | or
5088 ** FFFF E320H Inbound Doorbell Register |
5089 ** FFFF E324H Inbound Interrupt Status Register | must translate PCI address to
5090 ** FFFF E328H Inbound Interrupt Mask Register | the Intel Xscale Core
5091 ** FFFF E32CH Outbound Doorbell Register | Memory-Mapped Address
5092 ** FFFF E330H Outbound Interrupt Status Register |
5093 ** FFFF E334H Outbound Interrupt Mask Register |
5094 ** ______________________________________________________________________|________________________________________
5095 ** FFFF E338H reserved |
5096 ** FFFF E33CH reserved |
5097 ** FFFF E340H reserved |
5098 ** FFFF E344H reserved |
5099 ** FFFF E348H reserved |
5100 ** FFFF E34CH reserved |
5101 ** FFFF E350H MU Configuration Register |
5102 ** FFFF E354H Queue Base Address Register |
5103 ** FFFF E358H reserved |
5104 ** FFFF E35CH reserved | must translate PCI address to
5105 ** FFFF E360H Inbound Free Head Pointer Register | the Intel Xscale Core
5106 ** FFFF E364H Inbound Free Tail Pointer Register | Memory-Mapped Address
5107 ** FFFF E368H Inbound Post Head pointer Register |
5108 ** FFFF E36CH Inbound Post Tail Pointer Register |
5109 ** FFFF E370H Outbound Free Head Pointer Register |
5110 ** FFFF E374H Outbound Free Tail Pointer Register |
5111 ** FFFF E378H Outbound Post Head pointer Register |
5112 ** FFFF E37CH Outbound Post Tail Pointer Register |
5113 ** FFFF E380H Index Address Register |
5114 ** FFFF E384H reserved |
5116 ** FFFF E3FCH reserved |
5117 ** ______________________________________________________________________|_______________________________________
5118 **************************************************************************
5121 **************************************************************************
5122 ** MU Configuration Register - MUCR FFFF.E350H
5124 ** . The MU Configuration Register (MUCR) contains the Circular Queue Enable bit and the size of one Circular Queue.
5125 ** . The Circular Queue Enable bit enables or disables the Circular Queues.
5126 ** The Circular Queues are disabled at reset to allow the software to initialize the head
5127 ** and tail pointer registers before any PCI accesses to the Queue Ports.
5128 ** . Each Circular Queue may range from 4 K entries (16 Kbytes) to 64 K entries (256 Kbytes) and there are four Circular Queues.
5129 ** ------------------------------------------------------------------------
5130 ** Bit Default Description
5131 ** 31:06 000000H 00 2 Reserved
5132 ** 05:01 00001 2 Circular Queue Size - This field determines the size of each Circular Queue.
5133 ** All four queues are the same size.
5134 ** ¡E 00001 2 - 4K Entries (16 Kbytes)
5135 ** ¡E 00010 2 - 8K Entries (32 Kbytes)
5136 ** ¡E 00100 2 - 16K Entries (64 Kbytes)
5137 ** ¡E 01000 2 - 32K Entries (128 Kbytes)
5138 ** ¡E 10000 2 - 64K Entries (256 Kbytes)
5139 ** 00 0 2 Circular Queue Enable - This bit enables or disables the Circular Queues. When clear the Circular
5140 ** Queues are disabled, however the MU accepts PCI accesses to the Circular Queue Ports but ignores
5141 ** the data for Writes and return FFFF.FFFFH for Reads. Interrupts are not generated to the core when
5142 ** disabled. When set, the Circular Queues are fully enabled.
5143 **************************************************************************
5145 #define ARCMSR_MU_CONFIGURATION_REG 0xFFFFE350
5146 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE64K 0x0020
5147 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE32K 0x0010
5148 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE16K 0x0008
5149 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE8K 0x0004
5150 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE4K 0x0002
5151 #define ARCMSR_MU_CIRCULAR_QUEUE_ENABLE 0x0001 /*0:disable 1:enable*/
5153 **************************************************************************
5154 ** Queue Base Address Register - QBAR
5156 ** . The Queue Base Address Register (QBAR) contains the local memory address of the Circular Queues.
5157 ** The base address is required to be located on a 1 Mbyte address boundary.
5158 ** . All Circular Queue head and tail pointers are based on the QBAR.
5159 ** When the head and tail pointer registers are read, the Queue Base Address is returned in the upper 12 bits.
5160 ** Writing to the upper 12 bits of the head and tail pointer registers does not affect the Queue Base Address or Queue Base Address Register.
5162 ** The QBAR must designate a range allocated to the 80331 DDR SDRAM interface
5163 ** ------------------------------------------------------------------------
5164 ** Bit Default Description
5165 ** 31:20 000H Queue Base Address - Local memory address of the circular queues.
5166 ** 19:00 00000H Reserved
5167 **************************************************************************
5169 #define ARCMSR_MU_QUEUE_BASE_ADDRESS_REG 0xFFFFE354
5171 **************************************************************************
5172 ** Inbound Free Head Pointer Register - IFHPR
5174 ** . The Inbound Free Head Pointer Register (IFHPR) contains the local memory offset from
5175 ** the Queue Base Address of the head pointer for the Inbound Free Queue.
5176 ** The Head Pointer must be aligned on a DWORD address boundary.
5177 ** When read, the Queue Base Address is provided in the upper 12 bits of the register.
5178 ** Writes to the upper 12 bits of the register are ignored.
5179 ** This register is maintained by software.
5180 ** ------------------------------------------------------------------------
5181 ** Bit Default Description
5182 ** 31:20 000H Queue Base Address - Local memory address of the circular queues.
5183 ** 19:02 0000H 00 2 Inbound Free Head Pointer - Local memory offset of the head pointer for the Inbound Free Queue.
5184 ** 01:00 00 2 Reserved
5185 **************************************************************************
5187 #define ARCMSR_MU_INBOUND_FREE_HEAD_PTR_REG 0xFFFFE360
5189 **************************************************************************
5190 ** Inbound Free Tail Pointer Register - IFTPR
5192 ** . The Inbound Free Tail Pointer Register (IFTPR) contains the local memory offset from the Queue
5193 ** Base Address of the tail pointer for the Inbound Free Queue. The Tail Pointer must be aligned on a
5194 ** DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits
5195 ** of the register. Writes to the upper 12 bits of the register are ignored.
5196 ** ------------------------------------------------------------------------
5197 ** Bit Default Description
5198 ** 31:20 000H Queue Base Address - Local memory address of the circular queues.
5199 ** 19:02 0000H 00 2 Inbound Free Tail Pointer - Local memory offset of the tail pointer for the Inbound Free Queue.
5200 ** 01:00 00 2 Reserved
5201 **************************************************************************
5203 #define ARCMSR_MU_INBOUND_FREE_TAIL_PTR_REG 0xFFFFE364
5205 **************************************************************************
5206 ** Inbound Post Head Pointer Register - IPHPR
5208 ** . The Inbound Post Head Pointer Register (IPHPR) contains the local memory offset from the Queue
5209 ** Base Address of the head pointer for the Inbound Post Queue. The Head Pointer must be aligned on
5210 ** a DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits
5211 ** of the register. Writes to the upper 12 bits of the register are ignored.
5212 ** ------------------------------------------------------------------------
5213 ** Bit Default Description
5214 ** 31:20 000H Queue Base Address - Local memory address of the circular queues.
5215 ** 19:02 0000H 00 2 Inbound Post Head Pointer - Local memory offset of the head pointer for the Inbound Post Queue.
5216 ** 01:00 00 2 Reserved
5217 **************************************************************************
5219 #define ARCMSR_MU_INBOUND_POST_HEAD_PTR_REG 0xFFFFE368
5221 **************************************************************************
5222 ** Inbound Post Tail Pointer Register - IPTPR
5224 ** . The Inbound Post Tail Pointer Register (IPTPR) contains the local memory offset from the Queue
5225 ** Base Address of the tail pointer for the Inbound Post Queue. The Tail Pointer must be aligned on a
5226 ** DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits
5227 ** of the register. Writes to the upper 12 bits of the register are ignored.
5228 ** ------------------------------------------------------------------------
5229 ** Bit Default Description
5230 ** 31:20 000H Queue Base Address - Local memory address of the circular queues.
5231 ** 19:02 0000H 00 2 Inbound Post Tail Pointer - Local memory offset of the tail pointer for the Inbound Post Queue.
5232 ** 01:00 00 2 Reserved
5233 **************************************************************************
5235 #define ARCMSR_MU_INBOUND_POST_TAIL_PTR_REG 0xFFFFE36C
5237 **************************************************************************
5238 ** Index Address Register - IAR
5240 ** . The Index Address Register (IAR) contains the offset of the least recently accessed Index Register.
5241 ** It is written by the MU when the Index Registers are written by a PCI agent.
5242 ** The register is not updated until the Index Interrupt bit in the Inbound Interrupt Status Register is cleared.
5243 ** . The local memory address of the Index Register least recently accessed is computed
5244 ** by adding the Index Address Register to the Inbound ATU Translate Value Register.
5245 ** ------------------------------------------------------------------------
5246 ** Bit Default Description
5247 ** 31:12 000000H Reserved
5248 ** 11:02 00H 00 2 Index Address - is the local memory offset of the Index Register written (050H to FFCH)
5249 ** 01:00 00 2 Reserved
5250 **************************************************************************
5252 #define ARCMSR_MU_LOCAL_MEMORY_INDEX_REG 0xFFFFE380 /*1004 dwords 0x0050....0x0FFC, 4016 bytes 0x0050...0x0FFF*/
5254 **********************************************************************************************************
5255 ** RS-232 Interface for Areca Raid Controller
5256 ** The low level command interface is exclusive with VT100 terminal
5257 ** --------------------------------------------------------------------
5258 ** 1. Sequence of command execution
5259 ** --------------------------------------------------------------------
5260 ** (A) Header : 3 bytes sequence (0x5E, 0x01, 0x61)
5261 ** (B) Command block : variable length of data including length, command code, data and checksum byte
5262 ** (C) Return data : variable length of data
5263 ** --------------------------------------------------------------------
5265 ** --------------------------------------------------------------------
5266 ** (A) 1st byte : command block length (low byte)
5267 ** (B) 2nd byte : command block length (high byte)
5268 ** note ..command block length shouldn't > 2040 bytes, length excludes these two bytes
5269 ** (C) 3rd byte : command code
5270 ** (D) 4th and following bytes : variable length data bytes depends on command code
5271 ** (E) last byte : checksum byte (sum of 1st byte until last data byte)
5272 ** --------------------------------------------------------------------
5273 ** 3. Command code and associated data
5274 ** --------------------------------------------------------------------
5275 ** The following are command code defined in raid controller Command code 0x10--0x1? are used for system level management,
5276 ** no password checking is needed and should be implemented in separate well controlled utility and not for end user access.
5277 ** Command code 0x20--0x?? always check the password, password must be entered to enable these command.
5280 ** GUI_SET_SERIAL=0x10,
5284 ** GUI_CHECK_PASSWORD,
5287 ** GUI_SET_ETHERNET_ADDR,
5291 ** GUI_GET_HW_MONITOR,
5293 ** // GUI_QUICK_CREATE=0x20, (function removed)
5294 ** GUI_GET_INFO_R=0x20,
5300 ** GUI_MUTE_BEEPER=0x30,
5301 ** GUI_BEEPER_SETTING,
5302 ** GUI_SET_PASSWORD,
5303 ** GUI_HOST_INTERFACE_MODE,
5304 ** GUI_REBUILD_PRIORITY,
5305 ** GUI_MAX_ATA_MODE,
5306 ** GUI_RESET_CONTROLLER,
5307 ** GUI_COM_PORT_SETTING,
5308 ** GUI_NO_OPERATION,
5311 ** GUI_CREATE_PASS_THROUGH=0x40,
5312 ** GUI_MODIFY_PASS_THROUGH,
5313 ** GUI_DELETE_PASS_THROUGH,
5314 ** GUI_IDENTIFY_DEVICE,
5316 ** GUI_CREATE_RAIDSET=0x50,
5317 ** GUI_DELETE_RAIDSET,
5318 ** GUI_EXPAND_RAIDSET,
5319 ** GUI_ACTIVATE_RAIDSET,
5320 ** GUI_CREATE_HOT_SPARE,
5321 ** GUI_DELETE_HOT_SPARE,
5323 ** GUI_CREATE_VOLUME=0x60,
5324 ** GUI_MODIFY_VOLUME,
5325 ** GUI_DELETE_VOLUME,
5326 ** GUI_START_CHECK_VOLUME,
5327 ** GUI_STOP_CHECK_VOLUME
5330 ** Command description :
5332 ** GUI_SET_SERIAL : Set the controller serial#
5333 ** byte 0,1 : length
5334 ** byte 2 : command code 0x10
5335 ** byte 3 : password length (should be 0x0f)
5336 ** byte 4-0x13 : should be "ArEcATecHnoLogY"
5337 ** byte 0x14--0x23 : Serial number string (must be 16 bytes)
5338 ** GUI_SET_VENDOR : Set vendor string for the controller
5339 ** byte 0,1 : length
5340 ** byte 2 : command code 0x11
5341 ** byte 3 : password length (should be 0x08)
5342 ** byte 4-0x13 : should be "ArEcAvAr"
5343 ** byte 0x14--0x3B : vendor string (must be 40 bytes)
5344 ** GUI_SET_MODEL : Set the model name of the controller
5345 ** byte 0,1 : length
5346 ** byte 2 : command code 0x12
5347 ** byte 3 : password length (should be 0x08)
5348 ** byte 4-0x13 : should be "ArEcAvAr"
5349 ** byte 0x14--0x1B : model string (must be 8 bytes)
5350 ** GUI_IDENTIFY : Identify device
5351 ** byte 0,1 : length
5352 ** byte 2 : command code 0x13
5353 ** return "Areca RAID Subsystem "
5354 ** GUI_CHECK_PASSWORD : Verify password
5355 ** byte 0,1 : length
5356 ** byte 2 : command code 0x14
5357 ** byte 3 : password length
5358 ** byte 4-0x?? : user password to be checked
5359 ** GUI_LOGOUT : Logout GUI (force password checking on next command)
5360 ** byte 0,1 : length
5361 ** byte 2 : command code 0x15
5362 ** GUI_HTTP : HTTP interface (reserved for Http proxy service)(0x16)
5364 ** GUI_SET_ETHERNET_ADDR : Set the ethernet MAC address
5365 ** byte 0,1 : length
5366 ** byte 2 : command code 0x17
5367 ** byte 3 : password length (should be 0x08)
5368 ** byte 4-0x13 : should be "ArEcAvAr"
5369 ** byte 0x14--0x19 : Ethernet MAC address (must be 6 bytes)
5370 ** GUI_SET_LOGO : Set logo in HTTP
5371 ** byte 0,1 : length
5372 ** byte 2 : command code 0x18
5373 ** byte 3 : Page# (0/1/2/3) (0xff --> clear OEM logo)
5374 ** byte 4/5/6/7 : 0x55/0xaa/0xa5/0x5a
5375 ** byte 8 : TITLE.JPG data (each page must be 2000 bytes)
5376 ** note .... page0 1st 2 byte must be actual length of the JPG file
5377 ** GUI_POLL_EVENT : Poll If Event Log Changed
5378 ** byte 0,1 : length
5379 ** byte 2 : command code 0x19
5380 ** GUI_GET_EVENT : Read Event
5381 ** byte 0,1 : length
5382 ** byte 2 : command code 0x1a
5383 ** byte 3 : Event Page (0:1st page/1/2/3:last page)
5384 ** GUI_GET_HW_MONITOR : Get HW monitor data
5385 ** byte 0,1 : length
5386 ** byte 2 : command code 0x1b
5387 ** byte 3 : # of FANs(example 2)
5388 ** byte 4 : # of Voltage sensor(example 3)
5389 ** byte 5 : # of temperature sensor(example 2)
5390 ** byte 6 : # of power
5391 ** byte 7/8 : Fan#0 (RPM)
5392 ** byte 9/10 : Fan#1
5393 ** byte 11/12 : Voltage#0 original value in *1000
5394 ** byte 13/14 : Voltage#0 value
5395 ** byte 15/16 : Voltage#1 org
5396 ** byte 17/18 : Voltage#1
5397 ** byte 19/20 : Voltage#2 org
5398 ** byte 21/22 : Voltage#2
5401 ** byte 25 : Power indicator (bit0 : power#0, bit1 : power#1)
5402 ** byte 26 : UPS indicator
5403 ** GUI_QUICK_CREATE : Quick create raid/volume set
5404 ** byte 0,1 : length
5405 ** byte 2 : command code 0x20
5406 ** byte 3/4/5/6 : raw capacity
5407 ** byte 7 : raid level
5408 ** byte 8 : stripe size
5410 ** byte 10/11/12/13: device mask (the devices to create raid/volume)
5411 ** This function is removed, application like to implement quick create function
5412 ** need to use GUI_CREATE_RAIDSET and GUI_CREATE_VOLUMESET function.
5413 ** GUI_GET_INFO_R : Get Raid Set Information
5414 ** byte 0,1 : length
5415 ** byte 2 : command code 0x20
5416 ** byte 3 : raidset#
5418 ** typedef struct sGUI_RAIDSET
5420 ** BYTE grsRaidSetName[16];
5421 ** DWORD grsCapacity;
5422 ** DWORD grsCapacityX;
5423 ** DWORD grsFailMask;
5424 ** BYTE grsDevArray[32];
5425 ** BYTE grsMemberDevices;
5426 ** BYTE grsNewMemberDevices;
5427 ** BYTE grsRaidState;
5429 ** BYTE grsVolumeList[16];
5433 ** BYTE grsFreeSegments;
5434 ** DWORD grsRawStripes[8];
5436 ** DWORD grsRes5; // Total to 128 bytes
5437 ** DWORD grsRes6; // Total to 128 bytes
5438 ** } sGUI_RAIDSET, *pGUI_RAIDSET;
5439 ** GUI_GET_INFO_V : Get Volume Set Information
5440 ** byte 0,1 : length
5441 ** byte 2 : command code 0x21
5442 ** byte 3 : volumeset#
5444 ** typedef struct sGUI_VOLUMESET
5446 ** BYTE gvsVolumeName[16]; // 16
5447 ** DWORD gvsCapacity;
5448 ** DWORD gvsCapacityX;
5449 ** DWORD gvsFailMask;
5450 ** DWORD gvsStripeSize;
5451 ** DWORD gvsNewFailMask;
5452 ** DWORD gvsNewStripeSize;
5453 ** DWORD gvsVolumeStatus;
5454 ** DWORD gvsProgress; // 32
5455 ** sSCSI_ATTR gvsScsi;
5456 ** BYTE gvsMemberDisks;
5457 ** BYTE gvsRaidLevel; // 8
5459 ** BYTE gvsNewMemberDisks;
5460 ** BYTE gvsNewRaidLevel;
5461 ** BYTE gvsRaidSetNumber;
5462 ** BYTE gvsRes0; // 4
5463 ** BYTE gvsRes1[4]; // 64 bytes
5464 ** } sGUI_VOLUMESET, *pGUI_VOLUMESET;
5466 ** GUI_GET_INFO_P : Get Physical Drive Information
5467 ** byte 0,1 : length
5468 ** byte 2 : command code 0x22
5469 ** byte 3 : drive # (from 0 to max-channels - 1)
5471 ** typedef struct sGUI_PHY_DRV
5473 ** BYTE gpdModelName[40];
5474 ** BYTE gpdSerialNumber[20];
5475 ** BYTE gpdFirmRev[8];
5476 ** DWORD gpdCapacity;
5477 ** DWORD gpdCapacityX; // Reserved for expansion
5478 ** BYTE gpdDeviceState;
5480 ** BYTE gpdCurrentUdmaMode;
5481 ** BYTE gpdUdmaMode;
5482 ** BYTE gpdDriveSelect;
5483 ** BYTE gpdRaidNumber; // 0xff if not belongs to a raid set
5484 ** sSCSI_ATTR gpdScsi;
5485 ** BYTE gpdReserved[40]; // Total to 128 bytes
5486 ** } sGUI_PHY_DRV, *pGUI_PHY_DRV;
5488 ** GUI_GET_INFO_S : Get System Information
5489 ** byte 0,1 : length
5490 ** byte 2 : command code 0x23
5492 ** typedef struct sCOM_ATTR
5494 ** BYTE comBaudRate;
5495 ** BYTE comDataBits;
5496 ** BYTE comStopBits;
5498 ** BYTE comFlowControl;
5499 ** } sCOM_ATTR, *pCOM_ATTR;
5501 ** typedef struct sSYSTEM_INFO
5503 ** BYTE gsiVendorName[40];
5504 ** BYTE gsiSerialNumber[16];
5505 ** BYTE gsiFirmVersion[16];
5506 ** BYTE gsiBootVersion[16];
5507 ** BYTE gsiMbVersion[16];
5508 ** BYTE gsiModelName[8];
5509 ** BYTE gsiLocalIp[4];
5510 ** BYTE gsiCurrentIp[4];
5511 ** DWORD gsiTimeTick;
5512 ** DWORD gsiCpuSpeed;
5516 ** DWORD gsiMemorySize;
5517 ** DWORD gsiMemorySpeed;
5519 ** BYTE gsiMacAddress[6];
5522 ** BYTE gsiChannelUsage;
5523 ** BYTE gsiMaxAtaMode;
5524 ** BYTE gsiSdramEcc; // 1:if ECC enabled
5525 ** BYTE gsiRebuildPriority;
5526 ** sCOM_ATTR gsiComA; // 5 bytes
5527 ** sCOM_ATTR gsiComB; // 5 bytes
5528 ** BYTE gsiIdeChannels;
5529 ** BYTE gsiScsiHostChannels;
5530 ** BYTE gsiIdeHostChannels;
5531 ** BYTE gsiMaxVolumeSet;
5532 ** BYTE gsiMaxRaidSet;
5533 ** BYTE gsiEtherPort; // 1:if ether net port supported
5534 ** BYTE gsiRaid6Engine; // 1:Raid6 engine supported
5536 ** } sSYSTEM_INFO, *pSYSTEM_INFO;
5538 ** GUI_CLEAR_EVENT : Clear System Event
5539 ** byte 0,1 : length
5540 ** byte 2 : command code 0x24
5542 ** GUI_MUTE_BEEPER : Mute current beeper
5543 ** byte 0,1 : length
5544 ** byte 2 : command code 0x30
5546 ** GUI_BEEPER_SETTING : Disable beeper
5547 ** byte 0,1 : length
5548 ** byte 2 : command code 0x31
5549 ** byte 3 : 0->disable, 1->enable
5551 ** GUI_SET_PASSWORD : Change password
5552 ** byte 0,1 : length
5553 ** byte 2 : command code 0x32
5554 ** byte 3 : pass word length ( must <= 15 )
5555 ** byte 4 : password (must be alpha-numerical)
5557 ** GUI_HOST_INTERFACE_MODE : Set host interface mode
5558 ** byte 0,1 : length
5559 ** byte 2 : command code 0x33
5560 ** byte 3 : 0->Independent, 1->cluster
5562 ** GUI_REBUILD_PRIORITY : Set rebuild priority
5563 ** byte 0,1 : length
5564 ** byte 2 : command code 0x34
5565 ** byte 3 : 0/1/2/3 (low->high)
5567 ** GUI_MAX_ATA_MODE : Set maximum ATA mode to be used
5568 ** byte 0,1 : length
5569 ** byte 2 : command code 0x35
5570 ** byte 3 : 0/1/2/3 (133/100/66/33)
5572 ** GUI_RESET_CONTROLLER : Reset Controller
5573 ** byte 0,1 : length
5574 ** byte 2 : command code 0x36
5575 ** *Response with VT100 screen (discard it)
5577 ** GUI_COM_PORT_SETTING : COM port setting
5578 ** byte 0,1 : length
5579 ** byte 2 : command code 0x37
5580 ** byte 3 : 0->COMA (term port), 1->COMB (debug port)
5581 ** byte 4 : 0/1/2/3/4/5/6/7 (1200/2400/4800/9600/19200/38400/57600/115200)
5582 ** byte 5 : data bit (0:7 bit, 1:8 bit : must be 8 bit)
5583 ** byte 6 : stop bit (0:1, 1:2 stop bits)
5584 ** byte 7 : parity (0:none, 1:off, 2:even)
5585 ** byte 8 : flow control (0:none, 1:xon/xoff, 2:hardware => must use none)
5587 ** GUI_NO_OPERATION : No operation
5588 ** byte 0,1 : length
5589 ** byte 2 : command code 0x38
5591 ** GUI_DHCP_IP : Set DHCP option and local IP address
5592 ** byte 0,1 : length
5593 ** byte 2 : command code 0x39
5594 ** byte 3 : 0:dhcp disabled, 1:dhcp enabled
5595 ** byte 4/5/6/7 : IP address
5597 ** GUI_CREATE_PASS_THROUGH : Create pass through disk
5598 ** byte 0,1 : length
5599 ** byte 2 : command code 0x40
5600 ** byte 3 : device #
5601 ** byte 4 : scsi channel (0/1)
5602 ** byte 5 : scsi id (0-->15)
5603 ** byte 6 : scsi lun (0-->7)
5604 ** byte 7 : tagged queue (1 : enabled)
5605 ** byte 8 : cache mode (1 : enabled)
5606 ** byte 9 : max speed (0/1/2/3/4, async/20/40/80/160 for scsi)
5607 ** (0/1/2/3/4, 33/66/100/133/150 for ide )
5609 ** GUI_MODIFY_PASS_THROUGH : Modify pass through disk
5610 ** byte 0,1 : length
5611 ** byte 2 : command code 0x41
5612 ** byte 3 : device #
5613 ** byte 4 : scsi channel (0/1)
5614 ** byte 5 : scsi id (0-->15)
5615 ** byte 6 : scsi lun (0-->7)
5616 ** byte 7 : tagged queue (1 : enabled)
5617 ** byte 8 : cache mode (1 : enabled)
5618 ** byte 9 : max speed (0/1/2/3/4, async/20/40/80/160 for scsi)
5619 ** (0/1/2/3/4, 33/66/100/133/150 for ide )
5621 ** GUI_DELETE_PASS_THROUGH : Delete pass through disk
5622 ** byte 0,1 : length
5623 ** byte 2 : command code 0x42
5624 ** byte 3 : device# to be deleted
5626 ** GUI_IDENTIFY_DEVICE : Identify Device
5627 ** byte 0,1 : length
5628 ** byte 2 : command code 0x43
5629 ** byte 3 : Flash Method(0:flash selected, 1:flash not selected)
5630 ** byte 4/5/6/7 : IDE device mask to be flashed
5631 ** note .... no response data available
5633 ** GUI_CREATE_RAIDSET : Create Raid Set
5634 ** byte 0,1 : length
5635 ** byte 2 : command code 0x50
5636 ** byte 3/4/5/6 : device mask
5637 ** byte 7-22 : raidset name (if byte 7 == 0:use default)
5639 ** GUI_DELETE_RAIDSET : Delete Raid Set
5640 ** byte 0,1 : length
5641 ** byte 2 : command code 0x51
5642 ** byte 3 : raidset#
5644 ** GUI_EXPAND_RAIDSET : Expand Raid Set
5645 ** byte 0,1 : length
5646 ** byte 2 : command code 0x52
5647 ** byte 3 : raidset#
5648 ** byte 4/5/6/7 : device mask for expansion
5649 ** byte 8/9/10 : (8:0 no change, 1 change, 0xff:terminate, 9:new raid level,10:new stripe size 0/1/2/3/4/5->4/8/16/32/64/128K )
5650 ** byte 11/12/13 : repeat for each volume in the raidset ....
5652 ** GUI_ACTIVATE_RAIDSET : Activate incomplete raid set
5653 ** byte 0,1 : length
5654 ** byte 2 : command code 0x53
5655 ** byte 3 : raidset#
5657 ** GUI_CREATE_HOT_SPARE : Create hot spare disk
5658 ** byte 0,1 : length
5659 ** byte 2 : command code 0x54
5660 ** byte 3/4/5/6 : device mask for hot spare creation
5662 ** GUI_DELETE_HOT_SPARE : Delete hot spare disk
5663 ** byte 0,1 : length
5664 ** byte 2 : command code 0x55
5665 ** byte 3/4/5/6 : device mask for hot spare deletion
5667 ** GUI_CREATE_VOLUME : Create volume set
5668 ** byte 0,1 : length
5669 ** byte 2 : command code 0x60
5670 ** byte 3 : raidset#
5671 ** byte 4-19 : volume set name (if byte4 == 0, use default)
5672 ** byte 20-27 : volume capacity (blocks)
5673 ** byte 28 : raid level
5674 ** byte 29 : stripe size (0/1/2/3/4/5->4/8/16/32/64/128K)
5675 ** byte 30 : channel
5678 ** byte 33 : 1 enable tag
5679 ** byte 34 : 1 enable cache
5680 ** byte 35 : speed (0/1/2/3/4->async/20/40/80/160 for scsi)
5681 ** (0/1/2/3/4->33/66/100/133/150 for IDE )
5682 ** byte 36 : 1 to select quick init
5684 ** GUI_MODIFY_VOLUME : Modify volume Set
5685 ** byte 0,1 : length
5686 ** byte 2 : command code 0x61
5687 ** byte 3 : volumeset#
5688 ** byte 4-19 : new volume set name (if byte4 == 0, not change)
5689 ** byte 20-27 : new volume capacity (reserved)
5690 ** byte 28 : new raid level
5691 ** byte 29 : new stripe size (0/1/2/3/4/5->4/8/16/32/64/128K)
5692 ** byte 30 : new channel
5694 ** byte 32 : new LUN
5695 ** byte 33 : 1 enable tag
5696 ** byte 34 : 1 enable cache
5697 ** byte 35 : speed (0/1/2/3/4->async/20/40/80/160 for scsi)
5698 ** (0/1/2/3/4->33/66/100/133/150 for IDE )
5700 ** GUI_DELETE_VOLUME : Delete volume set
5701 ** byte 0,1 : length
5702 ** byte 2 : command code 0x62
5703 ** byte 3 : volumeset#
5705 ** GUI_START_CHECK_VOLUME : Start volume consistency check
5706 ** byte 0,1 : length
5707 ** byte 2 : command code 0x63
5708 ** byte 3 : volumeset#
5710 ** GUI_STOP_CHECK_VOLUME : Stop volume consistency check
5711 ** byte 0,1 : length
5712 ** byte 2 : command code 0x64
5713 ** ---------------------------------------------------------------------
5715 ** ---------------------------------------------------------------------
5716 ** (A) Header : 3 bytes sequence (0x5E, 0x01, 0x61)
5717 ** (B) Length : 2 bytes (low byte 1st, excludes length and checksum byte)
5718 ** (C) status or data :
5719 ** <1> If length == 1 ==> 1 byte status code
5720 ** #define GUI_OK 0x41
5721 ** #define GUI_RAIDSET_NOT_NORMAL 0x42
5722 ** #define GUI_VOLUMESET_NOT_NORMAL 0x43
5723 ** #define GUI_NO_RAIDSET 0x44
5724 ** #define GUI_NO_VOLUMESET 0x45
5725 ** #define GUI_NO_PHYSICAL_DRIVE 0x46
5726 ** #define GUI_PARAMETER_ERROR 0x47
5727 ** #define GUI_UNSUPPORTED_COMMAND 0x48
5728 ** #define GUI_DISK_CONFIG_CHANGED 0x49
5729 ** #define GUI_INVALID_PASSWORD 0x4a
5730 ** #define GUI_NO_DISK_SPACE 0x4b
5731 ** #define GUI_CHECKSUM_ERROR 0x4c
5732 ** #define GUI_PASSWORD_REQUIRED 0x4d
5733 ** <2> If length > 1 ==> data block returned from controller and the contents depends on the command code
5734 ** (E) Checksum : checksum of length and status or data byte
5735 **************************************************************************
projects / FreeBSD / FreeBSD.git / blob