1 /* 2 ******************************************************************************** 3 ** OS : FreeBSD 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. 12 ** 13 ** Redistribution and use in source and binary forms,with or without 14 ** modification,are permitted provided that the following conditions 15 ** are met: 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. 23 ** 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 ************************************************************************** 35 * $FreeBSD: head/sys/dev/arcmsr/arcmsr.h 259565 2013-12-18 19:25:40Z delphij $ 36 */ 37 38 #include <sys/ioccom.h> 39 40 #define ARCMSR_SCSI_INITIATOR_ID 255 41 #define ARCMSR_DEV_SECTOR_SIZE 512 42 #define ARCMSR_MAX_XFER_SECTORS 4096 43 #define ARCMSR_MAX_TARGETID 17 /*16 max target id + 1*/ 44 #define ARCMSR_MAX_TARGETLUN 8 /*8*/ 45 #define ARCMSR_MAX_CHIPTYPE_NUM 4 46 #define ARCMSR_MAX_OUTSTANDING_CMD 256 47 #define ARCMSR_MAX_START_JOB 256 48 #define ARCMSR_MAX_CMD_PERLUN ARCMSR_MAX_OUTSTANDING_CMD 49 #define ARCMSR_MAX_FREESRB_NUM 384 50 #define ARCMSR_MAX_QBUFFER 4096 /* ioctl QBUFFER */ 51 #define ARCMSR_MAX_SG_ENTRIES 38 /* max 38*/ 52 #define ARCMSR_MAX_ADAPTER 4 53 #define ARCMSR_RELEASE_SIMQ_LEVEL 230 54 #define ARCMSR_MAX_HBB_POSTQUEUE 264 /* (ARCMSR_MAX_OUTSTANDING_CMD+8) */ 55 #define ARCMSR_MAX_HBD_POSTQUEUE 256 56 #define ARCMSR_TIMEOUT_DELAY 60 /* in sec */ 57 /* 58 ********************************************************************* 59 */ 60 #ifndef TRUE 61 #define TRUE 1 62 #endif 63 #ifndef FALSE 64 #define FALSE 0 65 #endif 66 #ifndef INTR_ENTROPY 67 # define INTR_ENTROPY 0 68 #endif 69 70 #ifndef offsetof 71 #define offsetof(type, member) ((size_t)(&((type *)0)->member)) 72 #endif 73 74 #define ARCMSR_LOCK_INIT(l, s) lockinit(l, s, 0, LK_CANRECURSE) 75 #define ARCMSR_LOCK_DESTROY(l) lockuninit(l) 76 #define ARCMSR_LOCK_ACQUIRE(l) lockmgr(l, LK_EXCLUSIVE) 77 #define ARCMSR_LOCK_RELEASE(l) lockmgr(l, LK_RELEASE) 78 #define ARCMSR_LOCK_TRY(l) lockmgr(&l, LK_EXCLUSIVE|LK_NOWAIT) 79 #define arcmsr_htole32(x) htole32(x) 80 typedef struct lock arcmsr_lock_t; 81 82 /* 83 ********************************************************************************** 84 ** 85 ********************************************************************************** 86 */ 87 #define PCI_VENDOR_ID_ARECA 0x17D3 /* Vendor ID */ 88 #define PCI_DEVICE_ID_ARECA_1110 0x1110 /* Device ID */ 89 #define PCI_DEVICE_ID_ARECA_1120 0x1120 /* Device ID */ 90 #define PCI_DEVICE_ID_ARECA_1130 0x1130 /* Device ID */ 91 #define PCI_DEVICE_ID_ARECA_1160 0x1160 /* Device ID */ 92 #define PCI_DEVICE_ID_ARECA_1170 0x1170 /* Device ID */ 93 #define PCI_DEVICE_ID_ARECA_1200 0x1200 /* Device ID */ 94 #define PCI_DEVICE_ID_ARECA_1201 0x1201 /* Device ID */ 95 #define PCI_DEVICE_ID_ARECA_1210 0x1210 /* Device ID */ 96 #define PCI_DEVICE_ID_ARECA_1212 0x1212 /* Device ID */ 97 #define PCI_DEVICE_ID_ARECA_1214 0x1214 /* Device ID */ 98 #define PCI_DEVICE_ID_ARECA_1220 0x1220 /* Device ID */ 99 #define PCI_DEVICE_ID_ARECA_1222 0x1222 /* Device ID */ 100 #define PCI_DEVICE_ID_ARECA_1230 0x1230 /* Device ID */ 101 #define PCI_DEVICE_ID_ARECA_1231 0x1231 /* Device ID */ 102 #define PCI_DEVICE_ID_ARECA_1260 0x1260 /* Device ID */ 103 #define PCI_DEVICE_ID_ARECA_1261 0x1261 /* Device ID */ 104 #define PCI_DEVICE_ID_ARECA_1270 0x1270 /* Device ID */ 105 #define PCI_DEVICE_ID_ARECA_1280 0x1280 /* Device ID */ 106 #define PCI_DEVICE_ID_ARECA_1380 0x1380 /* Device ID */ 107 #define PCI_DEVICE_ID_ARECA_1381 0x1381 /* Device ID */ 108 #define PCI_DEVICE_ID_ARECA_1680 0x1680 /* Device ID */ 109 #define PCI_DEVICE_ID_ARECA_1681 0x1681 /* Device ID */ 110 #define PCI_DEVICE_ID_ARECA_1880 0x1880 /* Device ID */ 111 112 #define ARECA_SUB_DEV_ID_1880 0x1880 /* Subsystem Device ID */ 113 #define ARECA_SUB_DEV_ID_1882 0x1882 /* Subsystem Device ID */ 114 #define ARECA_SUB_DEV_ID_1883 0x1883 /* Subsystem Device ID */ 115 #define ARECA_SUB_DEV_ID_1212 0x1212 /* Subsystem Device ID */ 116 #define ARECA_SUB_DEV_ID_1213 0x1213 /* Subsystem Device ID */ 117 #define ARECA_SUB_DEV_ID_1222 0x1222 /* Subsystem Device ID */ 118 #define ARECA_SUB_DEV_ID_1223 0x1223 /* Subsystem Device ID */ 119 120 #define PCIDevVenIDARC1110 0x111017D3 /* Vendor Device ID */ 121 #define PCIDevVenIDARC1120 0x112017D3 /* Vendor Device ID */ 122 #define PCIDevVenIDARC1130 0x113017D3 /* Vendor Device ID */ 123 #define PCIDevVenIDARC1160 0x116017D3 /* Vendor Device ID */ 124 #define PCIDevVenIDARC1170 0x117017D3 /* Vendor Device ID */ 125 #define PCIDevVenIDARC1200 0x120017D3 /* Vendor Device ID */ 126 #define PCIDevVenIDARC1201 0x120117D3 /* Vendor Device ID */ 127 #define PCIDevVenIDARC1210 0x121017D3 /* Vendor Device ID */ 128 #define PCIDevVenIDARC1212 0x121217D3 /* Vendor Device ID */ 129 #define PCIDevVenIDARC1213 0x121317D3 /* Vendor Device ID */ 130 #define PCIDevVenIDARC1214 0x121417D3 /* Vendor Device ID */ 131 #define PCIDevVenIDARC1220 0x122017D3 /* Vendor Device ID */ 132 #define PCIDevVenIDARC1222 0x122217D3 /* Vendor Device ID */ 133 #define PCIDevVenIDARC1223 0x122317D3 /* Vendor Device ID */ 134 #define PCIDevVenIDARC1230 0x123017D3 /* Vendor Device ID */ 135 #define PCIDevVenIDARC1231 0x123117D3 /* Vendor Device ID */ 136 #define PCIDevVenIDARC1260 0x126017D3 /* Vendor Device ID */ 137 #define PCIDevVenIDARC1261 0x126117D3 /* Vendor Device ID */ 138 #define PCIDevVenIDARC1270 0x127017D3 /* Vendor Device ID */ 139 #define PCIDevVenIDARC1280 0x128017D3 /* Vendor Device ID */ 140 #define PCIDevVenIDARC1380 0x138017D3 /* Vendor Device ID */ 141 #define PCIDevVenIDARC1381 0x138117D3 /* Vendor Device ID */ 142 #define PCIDevVenIDARC1680 0x168017D3 /* Vendor Device ID */ 143 #define PCIDevVenIDARC1681 0x168117D3 /* Vendor Device ID */ 144 #define PCIDevVenIDARC1880 0x188017D3 /* Vendor Device ID */ 145 #define PCIDevVenIDARC1882 0x188217D3 /* Vendor Device ID */ 146 147 #ifndef PCIR_BARS 148 #define PCIR_BARS 0x10 149 #define PCIR_BAR(x) (PCIR_BARS + (x) * 4) 150 #endif 151 152 #define PCI_BASE_ADDR0 0x10 153 #define PCI_BASE_ADDR1 0x14 154 #define PCI_BASE_ADDR2 0x18 155 #define PCI_BASE_ADDR3 0x1C 156 #define PCI_BASE_ADDR4 0x20 157 #define PCI_BASE_ADDR5 0x24 158 /* 159 ********************************************************************************** 160 ** 161 ********************************************************************************** 162 */ 163 #define ARCMSR_SCSICMD_IOCTL 0x77 164 #define ARCMSR_CDEVSW_IOCTL 0x88 165 #define ARCMSR_MESSAGE_FAIL 0x0001 166 #define ARCMSR_MESSAGE_SUCCESS 0x0000 167 /* 168 ********************************************************************************** 169 ** 170 ********************************************************************************** 171 */ 172 #define arcmsr_ccbsrb_ptr spriv_ptr0 173 #define arcmsr_ccbacb_ptr spriv_ptr1 174 #define dma_addr_hi32(addr) (u_int32_t) ((addr>>16)>>16) 175 #define dma_addr_lo32(addr) (u_int32_t) (addr & 0xffffffff) 176 #define get_min(x,y) ((x) < (y) ? (x) : (y)) 177 #define get_max(x,y) ((x) < (y) ? (y) : (x)) 178 /* 179 ************************************************************************** 180 ************************************************************************** 181 */ 182 #define CHIP_REG_READ32(s, b, r) bus_space_read_4(acb->btag[b], acb->bhandle[b], offsetof(struct s, r)) 183 #define CHIP_REG_WRITE32(s, b, r, d) bus_space_write_4(acb->btag[b], acb->bhandle[b], offsetof(struct s, r), d) 184 /* 185 ********************************************************************************** 186 ** IOCTL CONTROL Mail Box 187 ********************************************************************************** 188 */ 189 struct CMD_MESSAGE { 190 u_int32_t HeaderLength; 191 u_int8_t Signature[8]; 192 u_int32_t Timeout; 193 u_int32_t ControlCode; 194 u_int32_t ReturnCode; 195 u_int32_t Length; 196 }; 197 198 struct CMD_MESSAGE_FIELD { 199 struct CMD_MESSAGE cmdmessage; /* ioctl header */ 200 u_int8_t messagedatabuffer[1032]; /* areca gui program does not accept more than 1031 byte */ 201 }; 202 203 /************************************************************************/ 204 /************************************************************************/ 205 206 #define ARCMSR_IOP_ERROR_ILLEGALPCI 0x0001 207 #define ARCMSR_IOP_ERROR_VENDORID 0x0002 208 #define ARCMSR_IOP_ERROR_DEVICEID 0x0002 209 #define ARCMSR_IOP_ERROR_ILLEGALCDB 0x0003 210 #define ARCMSR_IOP_ERROR_UNKNOW_CDBERR 0x0004 211 #define ARCMSR_SYS_ERROR_MEMORY_ALLOCATE 0x0005 212 #define ARCMSR_SYS_ERROR_MEMORY_CROSS4G 0x0006 213 #define ARCMSR_SYS_ERROR_MEMORY_LACK 0x0007 214 #define ARCMSR_SYS_ERROR_MEMORY_RANGE 0x0008 215 #define ARCMSR_SYS_ERROR_DEVICE_BASE 0x0009 216 #define ARCMSR_SYS_ERROR_PORT_VALIDATE 0x000A 217 218 /*DeviceType*/ 219 #define ARECA_SATA_RAID 0x90000000 220 221 /*FunctionCode*/ 222 #define FUNCTION_READ_RQBUFFER 0x0801 223 #define FUNCTION_WRITE_WQBUFFER 0x0802 224 #define FUNCTION_CLEAR_RQBUFFER 0x0803 225 #define FUNCTION_CLEAR_WQBUFFER 0x0804 226 #define FUNCTION_CLEAR_ALLQBUFFER 0x0805 227 #define FUNCTION_REQUEST_RETURNCODE_3F 0x0806 228 #define FUNCTION_SAY_HELLO 0x0807 229 #define FUNCTION_SAY_GOODBYE 0x0808 230 #define FUNCTION_FLUSH_ADAPTER_CACHE 0x0809 231 /* 232 ************************************************************************ 233 ** IOCTL CONTROL CODE 234 ************************************************************************ 235 */ 236 /* ARECA IO CONTROL CODE*/ 237 #define ARCMSR_MESSAGE_READ_RQBUFFER _IOWR('F', FUNCTION_READ_RQBUFFER, struct CMD_MESSAGE_FIELD) 238 #define ARCMSR_MESSAGE_WRITE_WQBUFFER _IOWR('F', FUNCTION_WRITE_WQBUFFER, struct CMD_MESSAGE_FIELD) 239 #define ARCMSR_MESSAGE_CLEAR_RQBUFFER _IOWR('F', FUNCTION_CLEAR_RQBUFFER, struct CMD_MESSAGE_FIELD) 240 #define ARCMSR_MESSAGE_CLEAR_WQBUFFER _IOWR('F', FUNCTION_CLEAR_WQBUFFER, struct CMD_MESSAGE_FIELD) 241 #define ARCMSR_MESSAGE_CLEAR_ALLQBUFFER _IOWR('F', FUNCTION_CLEAR_ALLQBUFFER, struct CMD_MESSAGE_FIELD) 242 #define ARCMSR_MESSAGE_REQUEST_RETURNCODE_3F _IOWR('F', FUNCTION_REQUEST_RETURNCODE_3F, struct CMD_MESSAGE_FIELD) 243 #define ARCMSR_MESSAGE_SAY_HELLO _IOWR('F', FUNCTION_SAY_HELLO, struct CMD_MESSAGE_FIELD) 244 #define ARCMSR_MESSAGE_SAY_GOODBYE _IOWR('F', FUNCTION_SAY_GOODBYE, struct CMD_MESSAGE_FIELD) 245 #define ARCMSR_MESSAGE_FLUSH_ADAPTER_CACHE _IOWR('F', FUNCTION_FLUSH_ADAPTER_CACHE, struct CMD_MESSAGE_FIELD) 246 247 /* ARECA IOCTL ReturnCode */ 248 #define ARCMSR_MESSAGE_RETURNCODE_OK 0x00000001 249 #define ARCMSR_MESSAGE_RETURNCODE_ERROR 0x00000006 250 #define ARCMSR_MESSAGE_RETURNCODE_3F 0x0000003F 251 #define ARCMSR_IOCTL_RETURNCODE_BUS_HANG_ON 0x00000088 252 /* 253 ************************************************************************ 254 ** SPEC. for Areca HBA adapter 255 ************************************************************************ 256 */ 257 /* signature of set and get firmware config */ 258 #define ARCMSR_SIGNATURE_GET_CONFIG 0x87974060 259 #define ARCMSR_SIGNATURE_SET_CONFIG 0x87974063 260 /* message code of inbound message register */ 261 #define ARCMSR_INBOUND_MESG0_NOP 0x00000000 262 #define ARCMSR_INBOUND_MESG0_GET_CONFIG 0x00000001 263 #define ARCMSR_INBOUND_MESG0_SET_CONFIG 0x00000002 264 #define ARCMSR_INBOUND_MESG0_ABORT_CMD 0x00000003 265 #define ARCMSR_INBOUND_MESG0_STOP_BGRB 0x00000004 266 #define ARCMSR_INBOUND_MESG0_FLUSH_CACHE 0x00000005 267 #define ARCMSR_INBOUND_MESG0_START_BGRB 0x00000006 268 #define ARCMSR_INBOUND_MESG0_CHK331PENDING 0x00000007 269 #define ARCMSR_INBOUND_MESG0_SYNC_TIMER 0x00000008 270 /* doorbell interrupt generator */ 271 #define ARCMSR_INBOUND_DRIVER_DATA_WRITE_OK 0x00000001 272 #define ARCMSR_INBOUND_DRIVER_DATA_READ_OK 0x00000002 273 #define ARCMSR_OUTBOUND_IOP331_DATA_WRITE_OK 0x00000001 274 #define ARCMSR_OUTBOUND_IOP331_DATA_READ_OK 0x00000002 275 /* srb areca cdb flag */ 276 #define ARCMSR_SRBPOST_FLAG_SGL_BSIZE 0x80000000 277 #define ARCMSR_SRBPOST_FLAG_IAM_BIOS 0x40000000 278 #define ARCMSR_SRBREPLY_FLAG_IAM_BIOS 0x40000000 279 #define ARCMSR_SRBREPLY_FLAG_ERROR 0x10000000 280 #define ARCMSR_SRBREPLY_FLAG_ERROR_MODE0 0x10000000 281 #define ARCMSR_SRBREPLY_FLAG_ERROR_MODE1 0x00000001 282 /* outbound firmware ok */ 283 #define ARCMSR_OUTBOUND_MESG1_FIRMWARE_OK 0x80000000 284 285 #define ARCMSR_ARC1680_BUS_RESET 0x00000003 286 /* 287 ************************************************************************ 288 ** SPEC. for Areca HBB adapter 289 ************************************************************************ 290 */ 291 /* ARECA HBB COMMAND for its FIRMWARE */ 292 #define ARCMSR_DRV2IOP_DOORBELL 0x00020400 /* window of "instruction flags" from driver to iop */ 293 #define ARCMSR_DRV2IOP_DOORBELL_MASK 0x00020404 294 #define ARCMSR_IOP2DRV_DOORBELL 0x00020408 /* window of "instruction flags" from iop to driver */ 295 #define ARCMSR_IOP2DRV_DOORBELL_MASK 0x0002040C 296 297 /* ARECA FLAG LANGUAGE */ 298 #define ARCMSR_IOP2DRV_DATA_WRITE_OK 0x00000001 /* ioctl transfer */ 299 #define ARCMSR_IOP2DRV_DATA_READ_OK 0x00000002 /* ioctl transfer */ 300 #define ARCMSR_IOP2DRV_CDB_DONE 0x00000004 301 #define ARCMSR_IOP2DRV_MESSAGE_CMD_DONE 0x00000008 302 303 #define ARCMSR_DOORBELL_HANDLE_INT 0x0000000F 304 #define ARCMSR_DOORBELL_INT_CLEAR_PATTERN 0xFF00FFF0 305 #define ARCMSR_MESSAGE_INT_CLEAR_PATTERN 0xFF00FFF7 306 307 #define ARCMSR_MESSAGE_GET_CONFIG 0x00010008 /* (ARCMSR_INBOUND_MESG0_GET_CONFIG<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 308 #define ARCMSR_MESSAGE_SET_CONFIG 0x00020008 /* (ARCMSR_INBOUND_MESG0_SET_CONFIG<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 309 #define ARCMSR_MESSAGE_ABORT_CMD 0x00030008 /* (ARCMSR_INBOUND_MESG0_ABORT_CMD<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 310 #define ARCMSR_MESSAGE_STOP_BGRB 0x00040008 /* (ARCMSR_INBOUND_MESG0_STOP_BGRB<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 311 #define ARCMSR_MESSAGE_FLUSH_CACHE 0x00050008 /* (ARCMSR_INBOUND_MESG0_FLUSH_CACHE<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 312 #define ARCMSR_MESSAGE_START_BGRB 0x00060008 /* (ARCMSR_INBOUND_MESG0_START_BGRB<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 313 #define ARCMSR_MESSAGE_START_DRIVER_MODE 0x000E0008 314 #define ARCMSR_MESSAGE_SET_POST_WINDOW 0x000F0008 315 #define ARCMSR_MESSAGE_ACTIVE_EOI_MODE 0x00100008 316 #define ARCMSR_MESSAGE_FIRMWARE_OK 0x80000000 /* ARCMSR_OUTBOUND_MESG1_FIRMWARE_OK */ 317 318 #define ARCMSR_DRV2IOP_DATA_WRITE_OK 0x00000001 /* ioctl transfer */ 319 #define ARCMSR_DRV2IOP_DATA_READ_OK 0x00000002 /* ioctl transfer */ 320 #define ARCMSR_DRV2IOP_CDB_POSTED 0x00000004 321 #define ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED 0x00000008 322 #define ARCMSR_DRV2IOP_END_OF_INTERRUPT 0x00000010 /* */ 323 324 /* data tunnel buffer between user space program and its firmware */ 325 #define ARCMSR_MSGCODE_RWBUFFER 0x0000fa00 /* iop msgcode_rwbuffer for message command */ 326 #define ARCMSR_IOCTL_WBUFFER 0x0000fe00 /* user space data to iop 128bytes */ 327 #define ARCMSR_IOCTL_RBUFFER 0x0000ff00 /* iop data to user space 128bytes */ 328 #define ARCMSR_HBB_BASE0_OFFSET 0x00000010 329 #define ARCMSR_HBB_BASE1_OFFSET 0x00000018 330 #define ARCMSR_HBB_BASE0_LEN 0x00021000 331 #define ARCMSR_HBB_BASE1_LEN 0x00010000 332 /* 333 ************************************************************************ 334 ** SPEC. for Areca HBC adapter 335 ************************************************************************ 336 */ 337 #define ARCMSR_HBC_ISR_THROTTLING_LEVEL 12 338 #define ARCMSR_HBC_ISR_MAX_DONE_QUEUE 20 339 /* Host Interrupt Mask */ 340 #define ARCMSR_HBCMU_UTILITY_A_ISR_MASK 0x00000001 /* When clear, the Utility_A interrupt routes to the host.*/ 341 #define ARCMSR_HBCMU_OUTBOUND_DOORBELL_ISR_MASK 0x00000004 /* When clear, the General Outbound Doorbell interrupt routes to the host.*/ 342 #define ARCMSR_HBCMU_OUTBOUND_POSTQUEUE_ISR_MASK 0x00000008 /* When clear, the Outbound Post List FIFO Not Empty interrupt routes to the host.*/ 343 #define ARCMSR_HBCMU_ALL_INTMASKENABLE 0x0000000D /* disable all ISR */ 344 /* Host Interrupt Status */ 345 #define ARCMSR_HBCMU_UTILITY_A_ISR 0x00000001 346 /* 347 ** Set when the Utility_A Interrupt bit is set in the Outbound Doorbell Register. 348 ** It clears by writing a 1 to the Utility_A bit in the Outbound Doorbell Clear Register or through automatic clearing (if enabled). 349 */ 350 #define ARCMSR_HBCMU_OUTBOUND_DOORBELL_ISR 0x00000004 351 /* 352 ** Set if Outbound Doorbell register bits 30:1 have a non-zero 353 ** value. This bit clears only when Outbound Doorbell bits 354 ** 30:1 are ALL clear. Only a write to the Outbound Doorbell 355 ** Clear register clears bits in the Outbound Doorbell register. 356 */ 357 #define ARCMSR_HBCMU_OUTBOUND_POSTQUEUE_ISR 0x00000008 358 /* 359 ** Set whenever the Outbound Post List Producer/Consumer 360 ** Register (FIFO) is not empty. It clears when the Outbound 361 ** Post List FIFO is empty. 362 */ 363 #define ARCMSR_HBCMU_SAS_ALL_INT 0x00000010 364 /* 365 ** This bit indicates a SAS interrupt from a source external to 366 ** the PCIe core. This bit is not maskable. 367 */ 368 /* DoorBell*/ 369 #define ARCMSR_HBCMU_DRV2IOP_DATA_WRITE_OK 0x00000002/**/ 370 #define ARCMSR_HBCMU_DRV2IOP_DATA_READ_OK 0x00000004/**/ 371 #define ARCMSR_HBCMU_DRV2IOP_MESSAGE_CMD_DONE 0x00000008/*inbound message 0 ready*/ 372 #define ARCMSR_HBCMU_DRV2IOP_POSTQUEUE_THROTTLING 0x00000010/*more than 12 request completed in a time*/ 373 #define ARCMSR_HBCMU_IOP2DRV_DATA_WRITE_OK 0x00000002/**/ 374 #define ARCMSR_HBCMU_IOP2DRV_DATA_WRITE_DOORBELL_CLEAR 0x00000002/*outbound DATA WRITE isr door bell clear*/ 375 #define ARCMSR_HBCMU_IOP2DRV_DATA_READ_OK 0x00000004/**/ 376 #define ARCMSR_HBCMU_IOP2DRV_DATA_READ_DOORBELL_CLEAR 0x00000004/*outbound DATA READ isr door bell clear*/ 377 #define ARCMSR_HBCMU_IOP2DRV_MESSAGE_CMD_DONE 0x00000008/*outbound message 0 ready*/ 378 #define ARCMSR_HBCMU_IOP2DRV_MESSAGE_CMD_DONE_DOORBELL_CLEAR 0x00000008/*outbound message cmd isr door bell clear*/ 379 #define ARCMSR_HBCMU_MESSAGE_FIRMWARE_OK 0x80000000/*ARCMSR_HBCMU_MESSAGE_FIRMWARE_OK*/ 380 #define ARCMSR_HBCMU_RESET_ADAPTER 0x00000024 381 #define ARCMSR_HBCMU_DiagWrite_ENABLE 0x00000080 382 383 /* 384 ************************************************************************ 385 ** SPEC. for Areca HBD adapter 386 ************************************************************************ 387 */ 388 #define ARCMSR_HBDMU_CHIP_ID 0x00004 389 #define ARCMSR_HBDMU_CPU_MEMORY_CONFIGURATION 0x00008 390 #define ARCMSR_HBDMU_I2_HOST_INTERRUPT_MASK 0x00034 391 #define ARCMSR_HBDMU_MAIN_INTERRUPT_STATUS 0x00200 392 #define ARCMSR_HBDMU_PCIE_F0_INTERRUPT_ENABLE 0x0020C 393 #define ARCMSR_HBDMU_INBOUND_MESSAGE0 0x00400 394 #define ARCMSR_HBDMU_INBOUND_MESSAGE1 0x00404 395 #define ARCMSR_HBDMU_OUTBOUND_MESSAGE0 0x00420 396 #define ARCMSR_HBDMU_OUTBOUND_MESSAGE1 0x00424 397 #define ARCMSR_HBDMU_INBOUND_DOORBELL 0x00460 398 #define ARCMSR_HBDMU_OUTBOUND_DOORBELL 0x00480 399 #define ARCMSR_HBDMU_OUTBOUND_DOORBELL_ENABLE 0x00484 400 #define ARCMSR_HBDMU_INBOUND_LIST_BASE_LOW 0x01000 401 #define ARCMSR_HBDMU_INBOUND_LIST_BASE_HIGH 0x01004 402 #define ARCMSR_HBDMU_INBOUND_LIST_WRITE_POINTER 0x01018 403 #define ARCMSR_HBDMU_OUTBOUND_LIST_BASE_LOW 0x01060 404 #define ARCMSR_HBDMU_OUTBOUND_LIST_BASE_HIGH 0x01064 405 #define ARCMSR_HBDMU_OUTBOUND_LIST_COPY_POINTER 0x0106C 406 #define ARCMSR_HBDMU_OUTBOUND_LIST_READ_POINTER 0x01070 407 #define ARCMSR_HBDMU_OUTBOUND_INTERRUPT_CAUSE 0x01088 408 #define ARCMSR_HBDMU_OUTBOUND_INTERRUPT_ENABLE 0x0108C 409 410 #define ARCMSR_HBDMU_MESSAGE_WBUFFER 0x02000 411 #define ARCMSR_HBDMU_MESSAGE_RBUFFER 0x02100 412 #define ARCMSR_HBDMU_MESSAGE_RWBUFFER 0x02200 413 414 #define ARCMSR_HBDMU_ISR_THROTTLING_LEVEL 16 415 #define ARCMSR_HBDMU_ISR_MAX_DONE_QUEUE 20 416 417 /* Host Interrupt Mask */ 418 #define ARCMSR_HBDMU_ALL_INT_ENABLE 0x00001010 /* enable all ISR */ 419 #define ARCMSR_HBDMU_ALL_INT_DISABLE 0x00000000 /* disable all ISR */ 420 421 /* Host Interrupt Status */ 422 #define ARCMSR_HBDMU_OUTBOUND_INT 0x00001010 423 #define ARCMSR_HBDMU_OUTBOUND_DOORBELL_INT 0x00001000 424 #define ARCMSR_HBDMU_OUTBOUND_POSTQUEUE_INT 0x00000010 425 426 /* DoorBell*/ 427 #define ARCMSR_HBDMU_DRV2IOP_DATA_IN_READY 0x00000001 428 #define ARCMSR_HBDMU_DRV2IOP_DATA_OUT_READ 0x00000002 429 430 #define ARCMSR_HBDMU_IOP2DRV_DATA_WRITE_OK 0x00000001 431 #define ARCMSR_HBDMU_IOP2DRV_DATA_READ_OK 0x00000002 432 433 /*outbound message 0 ready*/ 434 #define ARCMSR_HBDMU_IOP2DRV_MESSAGE_CMD_DONE 0x02000000 435 436 #define ARCMSR_HBDMU_F0_DOORBELL_CAUSE 0x02000003 437 438 /*outbound message cmd isr door bell clear*/ 439 #define ARCMSR_HBDMU_IOP2DRV_MESSAGE_CMD_DONE_CLEAR 0x02000000 440 441 /*outbound list */ 442 #define ARCMSR_HBDMU_OUTBOUND_LIST_INTERRUPT 0x00000001 443 #define ARCMSR_HBDMU_OUTBOUND_LIST_INTERRUPT_CLEAR 0x00000001 444 445 /*ARCMSR_HBAMU_MESSAGE_FIRMWARE_OK*/ 446 #define ARCMSR_HBDMU_MESSAGE_FIRMWARE_OK 0x80000000 447 /* 448 ********************************************************************* 449 ** Message Unit structure 450 ********************************************************************* 451 */ 452 struct HBA_MessageUnit 453 { 454 u_int32_t resrved0[4]; /*0000 000F*/ 455 u_int32_t inbound_msgaddr0; /*0010 0013*/ 456 u_int32_t inbound_msgaddr1; /*0014 0017*/ 457 u_int32_t outbound_msgaddr0; /*0018 001B*/ 458 u_int32_t outbound_msgaddr1; /*001C 001F*/ 459 u_int32_t inbound_doorbell; /*0020 0023*/ 460 u_int32_t inbound_intstatus; /*0024 0027*/ 461 u_int32_t inbound_intmask; /*0028 002B*/ 462 u_int32_t outbound_doorbell; /*002C 002F*/ 463 u_int32_t outbound_intstatus; /*0030 0033*/ 464 u_int32_t outbound_intmask; /*0034 0037*/ 465 u_int32_t reserved1[2]; /*0038 003F*/ 466 u_int32_t inbound_queueport; /*0040 0043*/ 467 u_int32_t outbound_queueport; /*0044 0047*/ 468 u_int32_t reserved2[2]; /*0048 004F*/ 469 u_int32_t reserved3[492]; /*0050 07FF ......local_buffer 492*/ 470 u_int32_t reserved4[128]; /*0800 09FF 128*/ 471 u_int32_t msgcode_rwbuffer[256]; /*0a00 0DFF 256*/ 472 u_int32_t message_wbuffer[32]; /*0E00 0E7F 32*/ 473 u_int32_t reserved5[32]; /*0E80 0EFF 32*/ 474 u_int32_t message_rbuffer[32]; /*0F00 0F7F 32*/ 475 u_int32_t reserved6[32]; /*0F80 0FFF 32*/ 476 }; 477 /* 478 ********************************************************************* 479 ** 480 ********************************************************************* 481 */ 482 struct HBB_DOORBELL 483 { 484 u_int8_t doorbell_reserved[ARCMSR_DRV2IOP_DOORBELL]; /*reserved */ 485 u_int32_t drv2iop_doorbell; /*offset 0x00020400:00,01,02,03: window of "instruction flags" from driver to iop */ 486 u_int32_t drv2iop_doorbell_mask; /* 04,05,06,07: doorbell mask */ 487 u_int32_t iop2drv_doorbell; /* 08,09,10,11: window of "instruction flags" from iop to driver */ 488 u_int32_t iop2drv_doorbell_mask; /* 12,13,14,15: doorbell mask */ 489 }; 490 /* 491 ********************************************************************* 492 ** 493 ********************************************************************* 494 */ 495 struct HBB_RWBUFFER 496 { 497 u_int8_t message_reserved0[ARCMSR_MSGCODE_RWBUFFER]; /*reserved */ 498 u_int32_t msgcode_rwbuffer[256]; /*offset 0x0000fa00: 0, 1, 2, 3,...,1023: message code read write 1024bytes */ 499 u_int32_t message_wbuffer[32]; /*offset 0x0000fe00:1024,1025,1026,1027,...,1151: user space data to iop 128bytes */ 500 u_int32_t message_reserved1[32]; /* 1152,1153,1154,1155,...,1279: message reserved*/ 501 u_int32_t message_rbuffer[32]; /*offset 0x0000ff00:1280,1281,1282,1283,...,1407: iop data to user space 128bytes */ 502 }; 503 /* 504 ********************************************************************* 505 ** 506 ********************************************************************* 507 */ 508 struct HBB_MessageUnit 509 { 510 u_int32_t post_qbuffer[ARCMSR_MAX_HBB_POSTQUEUE]; /* post queue buffer for iop */ 511 u_int32_t done_qbuffer[ARCMSR_MAX_HBB_POSTQUEUE]; /* done queue buffer for iop */ 512 int32_t postq_index; /* post queue index */ 513 int32_t doneq_index; /* done queue index */ 514 struct HBB_DOORBELL *hbb_doorbell; 515 struct HBB_RWBUFFER *hbb_rwbuffer; 516 }; 517 518 /* 519 ********************************************************************* 520 ** 521 ********************************************************************* 522 */ 523 struct HBC_MessageUnit { 524 u_int32_t message_unit_status; /*0000 0003*/ 525 u_int32_t slave_error_attribute; /*0004 0007*/ 526 u_int32_t slave_error_address; /*0008 000B*/ 527 u_int32_t posted_outbound_doorbell; /*000C 000F*/ 528 u_int32_t master_error_attribute; /*0010 0013*/ 529 u_int32_t master_error_address_low; /*0014 0017*/ 530 u_int32_t master_error_address_high; /*0018 001B*/ 531 u_int32_t hcb_size; /*001C 001F size of the PCIe window used for HCB_Mode accesses*/ 532 u_int32_t inbound_doorbell; /*0020 0023*/ 533 u_int32_t diagnostic_rw_data; /*0024 0027*/ 534 u_int32_t diagnostic_rw_address_low; /*0028 002B*/ 535 u_int32_t diagnostic_rw_address_high; /*002C 002F*/ 536 u_int32_t host_int_status; /*0030 0033 host interrupt status*/ 537 u_int32_t host_int_mask; /*0034 0037 host interrupt mask*/ 538 u_int32_t dcr_data; /*0038 003B*/ 539 u_int32_t dcr_address; /*003C 003F*/ 540 u_int32_t inbound_queueport; /*0040 0043 port32 host inbound queue port*/ 541 u_int32_t outbound_queueport; /*0044 0047 port32 host outbound queue port*/ 542 u_int32_t hcb_pci_address_low; /*0048 004B*/ 543 u_int32_t hcb_pci_address_high; /*004C 004F*/ 544 u_int32_t iop_int_status; /*0050 0053*/ 545 u_int32_t iop_int_mask; /*0054 0057*/ 546 u_int32_t iop_inbound_queue_port; /*0058 005B*/ 547 u_int32_t iop_outbound_queue_port; /*005C 005F*/ 548 u_int32_t inbound_free_list_index; /*0060 0063 inbound free list producer consumer index*/ 549 u_int32_t inbound_post_list_index; /*0064 0067 inbound post list producer consumer index*/ 550 u_int32_t outbound_free_list_index; /*0068 006B outbound free list producer consumer index*/ 551 u_int32_t outbound_post_list_index; /*006C 006F outbound post list producer consumer index*/ 552 u_int32_t inbound_doorbell_clear; /*0070 0073*/ 553 u_int32_t i2o_message_unit_control; /*0074 0077*/ 554 u_int32_t last_used_message_source_address_low; /*0078 007B*/ 555 u_int32_t last_used_message_source_address_high; /*007C 007F*/ 556 u_int32_t pull_mode_data_byte_count[4]; /*0080 008F pull mode data byte count0..count7*/ 557 u_int32_t message_dest_address_index; /*0090 0093*/ 558 u_int32_t done_queue_not_empty_int_counter_timer; /*0094 0097*/ 559 u_int32_t utility_A_int_counter_timer; /*0098 009B*/ 560 u_int32_t outbound_doorbell; /*009C 009F*/ 561 u_int32_t outbound_doorbell_clear; /*00A0 00A3*/ 562 u_int32_t message_source_address_index; /*00A4 00A7 message accelerator source address consumer producer index*/ 563 u_int32_t message_done_queue_index; /*00A8 00AB message accelerator completion queue consumer producer index*/ 564 u_int32_t reserved0; /*00AC 00AF*/ 565 u_int32_t inbound_msgaddr0; /*00B0 00B3 scratchpad0*/ 566 u_int32_t inbound_msgaddr1; /*00B4 00B7 scratchpad1*/ 567 u_int32_t outbound_msgaddr0; /*00B8 00BB scratchpad2*/ 568 u_int32_t outbound_msgaddr1; /*00BC 00BF scratchpad3*/ 569 u_int32_t inbound_queueport_low; /*00C0 00C3 port64 host inbound queue port low*/ 570 u_int32_t inbound_queueport_high; /*00C4 00C7 port64 host inbound queue port high*/ 571 u_int32_t outbound_queueport_low; /*00C8 00CB port64 host outbound queue port low*/ 572 u_int32_t outbound_queueport_high; /*00CC 00CF port64 host outbound queue port high*/ 573 u_int32_t iop_inbound_queue_port_low; /*00D0 00D3*/ 574 u_int32_t iop_inbound_queue_port_high; /*00D4 00D7*/ 575 u_int32_t iop_outbound_queue_port_low; /*00D8 00DB*/ 576 u_int32_t iop_outbound_queue_port_high; /*00DC 00DF*/ 577 u_int32_t message_dest_queue_port_low; /*00E0 00E3 message accelerator destination queue port low*/ 578 u_int32_t message_dest_queue_port_high; /*00E4 00E7 message accelerator destination queue port high*/ 579 u_int32_t last_used_message_dest_address_low; /*00E8 00EB last used message accelerator destination address low*/ 580 u_int32_t last_used_message_dest_address_high; /*00EC 00EF last used message accelerator destination address high*/ 581 u_int32_t message_done_queue_base_address_low; /*00F0 00F3 message accelerator completion queue base address low*/ 582 u_int32_t message_done_queue_base_address_high; /*00F4 00F7 message accelerator completion queue base address high*/ 583 u_int32_t host_diagnostic; /*00F8 00FB*/ 584 u_int32_t write_sequence; /*00FC 00FF*/ 585 u_int32_t reserved1[34]; /*0100 0187*/ 586 u_int32_t reserved2[1950]; /*0188 1FFF*/ 587 u_int32_t message_wbuffer[32]; /*2000 207F*/ 588 u_int32_t reserved3[32]; /*2080 20FF*/ 589 u_int32_t message_rbuffer[32]; /*2100 217F*/ 590 u_int32_t reserved4[32]; /*2180 21FF*/ 591 u_int32_t msgcode_rwbuffer[256]; /*2200 23FF*/ 592 }; 593 /* 594 ********************************************************************* 595 ** 596 ********************************************************************* 597 */ 598 struct InBound_SRB { 599 uint32_t addressLow; //pointer to SRB block 600 uint32_t addressHigh; 601 uint32_t length; // in DWORDs 602 uint32_t reserved0; 603 }; 604 605 struct OutBound_SRB { 606 uint32_t addressLow; //pointer to SRB block 607 uint32_t addressHigh; 608 }; 609 610 struct HBD_MessageUnit { 611 uint32_t reserved0; 612 uint32_t chip_id; //0x0004 613 uint32_t cpu_mem_config; //0x0008 614 uint32_t reserved1[10]; //0x000C 615 uint32_t i2o_host_interrupt_mask; //0x0034 616 uint32_t reserved2[114]; //0x0038 617 uint32_t host_int_status; //0x0200 618 uint32_t host_int_enable; //0x0204 619 uint32_t reserved3[1]; //0x0208 620 uint32_t pcief0_int_enable; //0x020C 621 uint32_t reserved4[124]; //0x0210 622 uint32_t inbound_msgaddr0; //0x0400 623 uint32_t inbound_msgaddr1; //0x0404 624 uint32_t reserved5[6]; //0x0408 625 uint32_t outbound_msgaddr0; //0x0420 626 uint32_t outbound_msgaddr1; //0x0424 627 uint32_t reserved6[14]; //0x0428 628 uint32_t inbound_doorbell; //0x0460 629 uint32_t reserved7[7]; //0x0464 630 uint32_t outbound_doorbell; //0x0480 631 uint32_t outbound_doorbell_enable; //0x0484 632 uint32_t reserved8[734]; //0x0488 633 uint32_t inboundlist_base_low; //0x1000 634 uint32_t inboundlist_base_high; //0x1004 635 uint32_t reserved9[4]; //0x1008 636 uint32_t inboundlist_write_pointer; //0x1018 637 uint32_t inboundlist_read_pointer; //0x101C 638 uint32_t reserved10[16]; //0x1020 639 uint32_t outboundlist_base_low; //0x1060 640 uint32_t outboundlist_base_high; //0x1064 641 uint32_t reserved11; //0x1068 642 uint32_t outboundlist_copy_pointer; //0x106C 643 uint32_t outboundlist_read_pointer; //0x1070 0x1072 644 uint32_t reserved12[5]; //0x1074 645 uint32_t outboundlist_interrupt_cause; //0x1088 646 uint32_t outboundlist_interrupt_enable; //0x108C 647 uint32_t reserved13[988]; //0x1090 648 uint32_t message_wbuffer[32]; //0x2000 649 uint32_t reserved14[32]; //0x2080 650 uint32_t message_rbuffer[32]; //0x2100 651 uint32_t reserved15[32]; //0x2180 652 uint32_t msgcode_rwbuffer[256]; //0x2200 653 }; 654 655 struct HBD_MessageUnit0 { 656 struct InBound_SRB post_qbuffer[ARCMSR_MAX_HBD_POSTQUEUE]; 657 struct OutBound_SRB done_qbuffer[ARCMSR_MAX_HBD_POSTQUEUE+1]; 658 uint16_t postq_index; 659 uint16_t doneq_index; 660 struct HBD_MessageUnit *phbdmu; 661 }; 662 663 /* 664 ********************************************************************* 665 ** 666 ********************************************************************* 667 */ 668 struct MessageUnit_UNION 669 { 670 union { 671 struct HBA_MessageUnit hbamu; 672 struct HBB_MessageUnit hbbmu; 673 struct HBC_MessageUnit hbcmu; 674 struct HBD_MessageUnit0 hbdmu; 675 } muu; 676 }; 677 /* 678 ************************************************************* 679 ** structure for holding DMA address data 680 ************************************************************* 681 */ 682 #define IS_SG64_ADDR 0x01000000 /* bit24 */ 683 /* 684 ************************************************************************************************ 685 ** ARECA FIRMWARE SPEC 686 ************************************************************************************************ 687 ** Usage of IOP331 adapter 688 ** (All In/Out is in IOP331's view) 689 ** 1. Message 0 --> InitThread message and retrun code 690 ** 2. Doorbell is used for RS-232 emulation 691 ** inDoorBell : bit0 -- data in ready (DRIVER DATA WRITE OK) 692 ** bit1 -- data out has been read (DRIVER DATA READ OK) 693 ** outDooeBell: bit0 -- data out ready (IOP331 DATA WRITE OK) 694 ** bit1 -- data in has been read (IOP331 DATA READ OK) 695 ** 3. Index Memory Usage 696 ** offset 0xf00 : for RS232 out (request buffer) 697 ** offset 0xe00 : for RS232 in (scratch buffer) 698 ** offset 0xa00 : for inbound message code msgcode_rwbuffer (driver send to IOP331) 699 ** offset 0xa00 : for outbound message code msgcode_rwbuffer (IOP331 send to driver) 700 ** 4. RS-232 emulation 701 ** Currently 128 byte buffer is used 702 ** 1st u_int32_t : Data length (1--124) 703 ** Byte 4--127 : Max 124 bytes of data 704 ** 5. PostQ 705 ** All SCSI Command must be sent through postQ: 706 ** (inbound queue port) Request frame must be 32 bytes aligned 707 ** # bit27--bit31 => flag for post ccb 708 ** # bit0--bit26 => real address (bit27--bit31) of post arcmsr_cdb 709 ** bit31 : 0 : 256 bytes frame 710 ** 1 : 512 bytes frame 711 ** bit30 : 0 : normal request 712 ** 1 : BIOS request 713 ** bit29 : reserved 714 ** bit28 : reserved 715 ** bit27 : reserved 716 ** ------------------------------------------------------------------------------- 717 ** (outbount queue port) Request reply 718 ** # bit27--bit31 => flag for reply 719 ** # bit0--bit26 => real address (bit27--bit31) of reply arcmsr_cdb 720 ** bit31 : must be 0 (for this type of reply) 721 ** bit30 : reserved for BIOS handshake 722 ** bit29 : reserved 723 ** bit28 : 0 : no error, ignore AdapStatus/DevStatus/SenseData 724 ** 1 : Error, error code in AdapStatus/DevStatus/SenseData 725 ** bit27 : reserved 726 ** 6. BIOS request 727 ** All BIOS request is the same with request from PostQ 728 ** Except : 729 ** Request frame is sent from configuration space 730 ** offset: 0x78 : Request Frame (bit30 == 1) 731 ** offset: 0x18 : writeonly to generate IRQ to IOP331 732 ** Completion of request: 733 ** (bit30 == 0, bit28==err flag) 734 ** 7. Definition of SGL entry (structure) 735 ** 8. Message1 Out - Diag Status Code (????) 736 ** 9. Message0 message code : 737 ** 0x00 : NOP 738 ** 0x01 : Get Config ->offset 0xa00 :for outbound message code msgcode_rwbuffer (IOP331 send to driver) 739 ** Signature 0x87974060(4) 740 ** Request len 0x00000200(4) 741 ** numbers of queue 0x00000100(4) 742 ** SDRAM Size 0x00000100(4)-->256 MB 743 ** IDE Channels 0x00000008(4) 744 ** vendor 40 bytes char 745 ** model 8 bytes char 746 ** FirmVer 16 bytes char 747 ** Device Map 16 bytes char 748 ** 749 ** FirmwareVersion DWORD <== Added for checking of new firmware capability 750 ** 0x02 : Set Config ->offset 0xa00 : for inbound message code msgcode_rwbuffer (driver send to IOP331) 751 ** Signature 0x87974063(4) 752 ** UPPER32 of Request Frame (4)-->Driver Only 753 ** 0x03 : Reset (Abort all queued Command) 754 ** 0x04 : Stop Background Activity 755 ** 0x05 : Flush Cache 756 ** 0x06 : Start Background Activity (re-start if background is halted) 757 ** 0x07 : Check If Host Command Pending (Novell May Need This Function) 758 ** 0x08 : Set controller time ->offset 0xa00 : for inbound message code msgcode_rwbuffer (driver to IOP331) 759 ** byte 0 : 0xaa <-- signature 760 ** byte 1 : 0x55 <-- signature 761 ** byte 2 : year (04) 762 ** byte 3 : month (1..12) 763 ** byte 4 : date (1..31) 764 ** byte 5 : hour (0..23) 765 ** byte 6 : minute (0..59) 766 ** byte 7 : second (0..59) 767 ** ********************************************************************************* 768 ** Porting Of LSI2108/2116 Based PCIE SAS/6G host raid adapter 769 ** ==> Difference from IOP348 770 ** <1> Message Register 0,1 (the same usage) Init Thread message and retrun code 771 ** Inbound Message 0 (inbound_msgaddr0) : at offset 0xB0 (Scratchpad0) for inbound message code msgcode_rwbuffer (driver send to IOP) 772 ** Inbound Message 1 (inbound_msgaddr1) : at offset 0xB4 (Scratchpad1) Out.... Diag Status Code 773 ** Outbound Message 0 (outbound_msgaddr0): at offset 0xB8 (Scratchpad3) Out.... Diag Status Code 774 ** Outbound Message 1 (outbound_msgaddr1): at offset 0xBC (Scratchpad2) for outbound message code msgcode_rwbuffer (IOP send to driver) 775 ** <A> use doorbell to generate interrupt 776 ** 777 ** inbound doorbell: bit3 -- inbound message 0 ready (driver to iop) 778 ** outbound doorbell: bit3 -- outbound message 0 ready (iop to driver) 779 ** 780 ** a. Message1: Out - Diag Status Code (????) 781 ** 782 ** b. Message0: message code 783 ** 0x00 : NOP 784 ** 0x01 : Get Config ->offset 0xB8 :for outbound message code msgcode_rwbuffer (IOP send to driver) 785 ** Signature 0x87974060(4) 786 ** Request len 0x00000200(4) 787 ** numbers of queue 0x00000100(4) 788 ** SDRAM Size 0x00000100(4)-->256 MB 789 ** IDE Channels 0x00000008(4) 790 ** vendor 40 bytes char 791 ** model 8 bytes char 792 ** FirmVer 16 bytes char 793 ** Device Map 16 bytes char 794 ** cfgVersion ULONG <== Added for checking of new firmware capability 795 ** 0x02 : Set Config ->offset 0xB0 :for inbound message code msgcode_rwbuffer (driver send to IOP) 796 ** Signature 0x87974063(4) 797 ** UPPER32 of Request Frame (4)-->Driver Only 798 ** 0x03 : Reset (Abort all queued Command) 799 ** 0x04 : Stop Background Activity 800 ** 0x05 : Flush Cache 801 ** 0x06 : Start Background Activity (re-start if background is halted) 802 ** 0x07 : Check If Host Command Pending (Novell May Need This Function) 803 ** 0x08 : Set controller time ->offset 0xB0 : for inbound message code msgcode_rwbuffer (driver to IOP) 804 ** byte 0 : 0xaa <-- signature 805 ** byte 1 : 0x55 <-- signature 806 ** byte 2 : year (04) 807 ** byte 3 : month (1..12) 808 ** byte 4 : date (1..31) 809 ** byte 5 : hour (0..23) 810 ** byte 6 : minute (0..59) 811 ** byte 7 : second (0..59) 812 ** 813 ** <2> Doorbell Register is used for RS-232 emulation 814 ** <A> different clear register 815 ** <B> different bit0 definition (bit0 is reserved) 816 ** 817 ** inbound doorbell : at offset 0x20 818 ** inbound doorbell clear : at offset 0x70 819 ** 820 ** inbound doorbell : bit0 -- reserved 821 ** bit1 -- data in ready (DRIVER DATA WRITE OK) 822 ** bit2 -- data out has been read (DRIVER DATA READ OK) 823 ** bit3 -- inbound message 0 ready 824 ** bit4 -- more than 12 request completed in a time 825 ** 826 ** outbound doorbell : at offset 0x9C 827 ** outbound doorbell clear : at offset 0xA0 828 ** 829 ** outbound doorbell : bit0 -- reserved 830 ** bit1 -- data out ready (IOP DATA WRITE OK) 831 ** bit2 -- data in has been read (IOP DATA READ OK) 832 ** bit3 -- outbound message 0 ready 833 ** 834 ** <3> Index Memory Usage (Buffer Area) 835 ** COMPORT_IN at 0x2000: message_wbuffer -- 128 bytes (to be sent to ROC) : for RS232 in (scratch buffer) 836 ** COMPORT_OUT at 0x2100: message_rbuffer -- 128 bytes (to be sent to host): for RS232 out (request buffer) 837 ** BIOS_CFG_AREA at 0x2200: msgcode_rwbuffer -- 1024 bytes for outbound message code msgcode_rwbuffer (IOP send to driver) 838 ** BIOS_CFG_AREA at 0x2200: msgcode_rwbuffer -- 1024 bytes for inbound message code msgcode_rwbuffer (driver send to IOP) 839 ** 840 ** <4> PostQ (Command Post Address) 841 ** All SCSI Command must be sent through postQ: 842 ** inbound queue port32 at offset 0x40 , 0x41, 0x42, 0x43 843 ** inbound queue port64 at offset 0xC0 (lower)/0xC4 (upper) 844 ** outbound queue port32 at offset 0x44 845 ** outbound queue port64 at offset 0xC8 (lower)/0xCC (upper) 846 ** <A> For 32bit queue, access low part is enough to send/receive request 847 ** i.e. write 0x40/0xC0, ROC will get the request with high part == 0, the 848 ** same for outbound queue port 849 ** <B> For 64bit queue, if 64bit instruction is supported, use 64bit instruction 850 ** to post inbound request in a single instruction, and use 64bit instruction 851 ** to retrieve outbound request in a single instruction. 852 ** If in 32bit environment, when sending inbound queue, write high part first 853 ** then write low part. For receiving outbound request, read high part first 854 ** then low part, to check queue empty, ONLY check high part to be 0xFFFFFFFF. 855 ** If high part is 0xFFFFFFFF, DO NOT read low part, this may corrupt the 856 ** consistency of the FIFO. Another way to check empty is to check status flag 857 ** at 0x30 bit3. 858 ** <C> Post Address IS NOT shifted (must be 16 bytes aligned) 859 ** For BIOS, 16bytes aligned is OK 860 ** For Driver, 32bytes alignment is recommended. 861 ** POST Command bit0 to bit3 is defined differently 862 ** ---------------------------- 863 ** bit0:1 for PULL mode (must be 1) 864 ** ---------------------------- 865 ** bit3/2/1: for arcmsr cdb size (arccdbsize) 866 ** 000: <= 0x0080 (128) 867 ** 001: <= 0x0100 (256) 868 ** 010: <= 0x0180 (384) 869 ** 011: <= 0x0200 (512) 870 ** 100: <= 0x0280 (640) 871 ** 101: <= 0x0300 (768) 872 ** 110: <= 0x0300 (reserved) 873 ** 111: <= 0x0300 (reserved) 874 ** ----------------------------- 875 ** if len > 0x300 the len always set as 0x300 876 ** ----------------------------- 877 ** post addr = addr | ((len-1) >> 6) | 1 878 ** ----------------------------- 879 ** page length in command buffer still required, 880 ** 881 ** if page length > 3, 882 ** firmware will assume more request data need to be retrieved 883 ** 884 ** <D> Outbound Posting 885 ** bit0:0 , no error, 1 with error, refer to status buffer 886 ** bit1:0 , reserved (will be 0) 887 ** bit2:0 , reserved (will be 0) 888 ** bit3:0 , reserved (will be 0) 889 ** bit63-4: Completed command address 890 ** 891 ** <E> BIOS support, no special support is required. 892 ** LSI2108 support I/O register 893 ** All driver functionality is supported through I/O address 894 ** 895 ************************************************************************************************ 896 */ 897 /* 898 ********************************** 899 ** 900 ********************************** 901 */ 902 /* size 8 bytes */ 903 /* 32bit Scatter-Gather list */ 904 struct SG32ENTRY { /* length bit 24 == 0 */ 905 u_int32_t length; /* high 8 bit == flag,low 24 bit == length */ 906 u_int32_t address; 907 }; 908 /* size 12 bytes */ 909 /* 64bit Scatter-Gather list */ 910 struct SG64ENTRY { /* length bit 24 == 1 */ 911 u_int32_t length; /* high 8 bit == flag,low 24 bit == length */ 912 u_int32_t address; 913 u_int32_t addresshigh; 914 }; 915 struct SGENTRY_UNION { 916 union { 917 struct SG32ENTRY sg32entry; /* 30h Scatter gather address */ 918 struct SG64ENTRY sg64entry; /* 30h */ 919 }u; 920 }; 921 /* 922 ********************************** 923 ** 924 ********************************** 925 */ 926 struct QBUFFER { 927 u_int32_t data_len; 928 u_int8_t data[124]; 929 }; 930 /* 931 ********************************** 932 */ 933 typedef struct PHYS_ADDR64 { 934 u_int32_t phyadd_low; 935 u_int32_t phyadd_high; 936 }PHYSADDR64; 937 /* 938 ************************************************************************************************ 939 ** FIRMWARE INFO 940 ************************************************************************************************ 941 */ 942 #define ARCMSR_FW_MODEL_OFFSET 15 943 #define ARCMSR_FW_VERS_OFFSET 17 944 #define ARCMSR_FW_DEVMAP_OFFSET 21 945 #define ARCMSR_FW_CFGVER_OFFSET 25 946 947 struct FIRMWARE_INFO { 948 u_int32_t signature; /*0,00-03*/ 949 u_int32_t request_len; /*1,04-07*/ 950 u_int32_t numbers_queue; /*2,08-11*/ 951 u_int32_t sdram_size; /*3,12-15*/ 952 u_int32_t ide_channels; /*4,16-19*/ 953 char vendor[40]; /*5,20-59*/ 954 char model[8]; /*15,60-67*/ 955 char firmware_ver[16]; /*17,68-83*/ 956 char device_map[16]; /*21,84-99*/ 957 u_int32_t cfgVersion; /*25,100-103 Added for checking of new firmware capability*/ 958 char cfgSerial[16]; /*26,104-119*/ 959 u_int32_t cfgPicStatus; /*30,120-123*/ 960 }; 961 /* (A) For cfgVersion in FIRMWARE_INFO 962 ** if low BYTE (byte#0) >= 3 (version 3) 963 ** then byte#1 report the capability of the firmware can xfer in a single request 964 ** 965 ** byte#1 966 ** 0 256K 967 ** 1 512K 968 ** 2 1M 969 ** 3 2M 970 ** 4 4M 971 ** 5 8M 972 ** 6 16M 973 ** (B) Byte offset 7 (Reserved1) of CDB is changed to msgPages 974 ** Driver support new xfer method need to set this field to indicate 975 ** large CDB block in 0x100 unit (we use 0x100 byte as one page) 976 ** e.g. If the length of CDB including MSG header and SGL is 0x1508 977 ** driver need to set the msgPages to 0x16 978 ** (C) REQ_LEN_512BYTE must be used also to indicate SRB length 979 ** e.g. CDB len msgPages REQ_LEN_512BYTE flag 980 ** <= 0x100 1 0 981 ** <= 0x200 2 1 982 ** <= 0x300 3 1 983 ** <= 0x400 4 1 984 ** . 985 ** . 986 */ 987 988 /* 989 ************************************************************************************************ 990 ** size 0x1F8 (504) 991 ************************************************************************************************ 992 */ 993 struct ARCMSR_CDB { 994 u_int8_t Bus; /* 00h should be 0 */ 995 u_int8_t TargetID; /* 01h should be 0--15 */ 996 u_int8_t LUN; /* 02h should be 0--7 */ 997 u_int8_t Function; /* 03h should be 1 */ 998 999 u_int8_t CdbLength; /* 04h not used now */ 1000 u_int8_t sgcount; /* 05h */ 1001 u_int8_t Flags; /* 06h */ 1002 u_int8_t msgPages; /* 07h */ 1003 1004 u_int32_t Context; /* 08h Address of this request */ 1005 u_int32_t DataLength; /* 0ch not used now */ 1006 1007 u_int8_t Cdb[16]; /* 10h SCSI CDB */ 1008 /* 1009 ******************************************************** 1010 ** Device Status : the same from SCSI bus if error occur 1011 ** SCSI bus status codes. 1012 ******************************************************** 1013 */ 1014 u_int8_t DeviceStatus; /* 20h if error */ 1015 1016 u_int8_t SenseData[15]; /* 21h output */ 1017 1018 union { 1019 struct SG32ENTRY sg32entry[ARCMSR_MAX_SG_ENTRIES]; /* 30h Scatter gather address */ 1020 struct SG64ENTRY sg64entry[ARCMSR_MAX_SG_ENTRIES]; /* 30h */ 1021 } u; 1022 }; 1023 /* CDB flag */ 1024 #define ARCMSR_CDB_FLAG_SGL_BSIZE 0x01 /* bit 0: 0(256) / 1(512) bytes */ 1025 #define ARCMSR_CDB_FLAG_BIOS 0x02 /* bit 1: 0(from driver) / 1(from BIOS) */ 1026 #define ARCMSR_CDB_FLAG_WRITE 0x04 /* bit 2: 0(Data in) / 1(Data out) */ 1027 #define ARCMSR_CDB_FLAG_SIMPLEQ 0x00 /* bit 4/3 ,00 : simple Q,01 : head of Q,10 : ordered Q */ 1028 #define ARCMSR_CDB_FLAG_HEADQ 0x08 1029 #define ARCMSR_CDB_FLAG_ORDEREDQ 0x10 1030 /* scsi status */ 1031 #define SCSISTAT_GOOD 0x00 1032 #define SCSISTAT_CHECK_CONDITION 0x02 1033 #define SCSISTAT_CONDITION_MET 0x04 1034 #define SCSISTAT_BUSY 0x08 1035 #define SCSISTAT_INTERMEDIATE 0x10 1036 #define SCSISTAT_INTERMEDIATE_COND_MET 0x14 1037 #define SCSISTAT_RESERVATION_CONFLICT 0x18 1038 #define SCSISTAT_COMMAND_TERMINATED 0x22 1039 #define SCSISTAT_QUEUE_FULL 0x28 1040 /* DeviceStatus */ 1041 #define ARCMSR_DEV_SELECT_TIMEOUT 0xF0 1042 #define ARCMSR_DEV_ABORTED 0xF1 1043 #define ARCMSR_DEV_INIT_FAIL 0xF2 1044 /* 1045 ********************************************************************* 1046 ** Command Control Block (SrbExtension) 1047 ** SRB must be not cross page boundary,and the order from offset 0 1048 ** structure describing an ATA disk request 1049 ** this SRB length must be 32 bytes boundary 1050 ********************************************************************* 1051 */ 1052 struct CommandControlBlock { 1053 struct ARCMSR_CDB arcmsr_cdb; /* 0 -503 (size of CDB=504): arcmsr messenger scsi command descriptor size 504 bytes */ 1054 u_int32_t cdb_phyaddr_low; /* 504-507 */ 1055 u_int32_t arc_cdb_size; /* 508-511 */ 1056 /* ======================512+32 bytes============================ */ 1057 union ccb *pccb; /* 512-515 516-519 pointer of freebsd scsi command */ 1058 struct AdapterControlBlock *acb; /* 520-523 524-527 */ 1059 bus_dmamap_t dm_segs_dmamap; /* 528-531 532-535 */ 1060 u_int16_t srb_flags; /* 536-537 */ 1061 u_int16_t srb_state; /* 538-539 */ 1062 u_int32_t cdb_phyaddr_high; /* 540-543 */ 1063 struct callout ccb_callout; 1064 /* ========================================================== */ 1065 }; 1066 /* srb_flags */ 1067 #define SRB_FLAG_READ 0x0000 1068 #define SRB_FLAG_WRITE 0x0001 1069 #define SRB_FLAG_ERROR 0x0002 1070 #define SRB_FLAG_FLUSHCACHE 0x0004 1071 #define SRB_FLAG_MASTER_ABORTED 0x0008 1072 #define SRB_FLAG_DMAVALID 0x0010 1073 #define SRB_FLAG_DMACONSISTENT 0x0020 1074 #define SRB_FLAG_DMAWRITE 0x0040 1075 #define SRB_FLAG_PKTBIND 0x0080 1076 #define SRB_FLAG_TIMER_START 0x0080 1077 /* srb_state */ 1078 #define ARCMSR_SRB_DONE 0x0000 1079 #define ARCMSR_SRB_UNBUILD 0x0000 1080 #define ARCMSR_SRB_TIMEOUT 0x1111 1081 #define ARCMSR_SRB_RETRY 0x2222 1082 #define ARCMSR_SRB_START 0x55AA 1083 #define ARCMSR_SRB_PENDING 0xAA55 1084 #define ARCMSR_SRB_RESET 0xA5A5 1085 #define ARCMSR_SRB_ABORTED 0x5A5A 1086 #define ARCMSR_SRB_ILLEGAL 0xFFFF 1087 1088 #define SRB_SIZE ((sizeof(struct CommandControlBlock)+0x1f) & 0xffe0) 1089 #define ARCMSR_SRBS_POOL_SIZE (SRB_SIZE * ARCMSR_MAX_FREESRB_NUM) 1090 1091 /* 1092 ********************************************************************* 1093 ** Adapter Control Block 1094 ********************************************************************* 1095 */ 1096 #define ACB_ADAPTER_TYPE_A 0x00000001 /* hba I IOP */ 1097 #define ACB_ADAPTER_TYPE_B 0x00000002 /* hbb M IOP */ 1098 #define ACB_ADAPTER_TYPE_C 0x00000004 /* hbc L IOP */ 1099 #define ACB_ADAPTER_TYPE_D 0x00000008 /* hbd M IOP */ 1100 1101 struct AdapterControlBlock { 1102 u_int32_t adapter_type; /* adapter A,B..... */ 1103 1104 bus_space_tag_t btag[2]; 1105 bus_space_handle_t bhandle[2]; 1106 bus_dma_tag_t parent_dmat; 1107 bus_dma_tag_t dm_segs_dmat; /* dmat for buffer I/O */ 1108 bus_dma_tag_t srb_dmat; /* dmat for freesrb */ 1109 bus_dmamap_t srb_dmamap; 1110 device_t pci_dev; 1111 struct cdev *ioctl_dev; 1112 int pci_unit; 1113 1114 struct resource *sys_res_arcmsr[2]; 1115 struct resource *irqres; 1116 void *ih; /* interrupt handle */ 1117 int irq_type; 1118 1119 /* Hooks into the CAM XPT */ 1120 struct cam_sim *psim; 1121 struct cam_path *ppath; 1122 u_int8_t *uncacheptr; 1123 unsigned long vir2phy_offset; 1124 union { 1125 unsigned long phyaddr; 1126 struct { 1127 u_int32_t phyadd_low; 1128 u_int32_t phyadd_high; 1129 }B; 1130 }srb_phyaddr; 1131 // unsigned long srb_phyaddr; 1132 /* Offset is used in making arc cdb physical to virtual calculations */ 1133 u_int32_t outbound_int_enable; 1134 1135 struct MessageUnit_UNION *pmu; /* message unit ATU inbound base address0 */ 1136 1137 u_int8_t adapter_index; 1138 u_int8_t irq; 1139 u_int16_t acb_flags; 1140 1141 struct CommandControlBlock *psrb_pool[ARCMSR_MAX_FREESRB_NUM]; /* serial srb pointer array */ 1142 struct CommandControlBlock *srbworkingQ[ARCMSR_MAX_FREESRB_NUM]; /* working srb pointer array */ 1143 int32_t workingsrb_doneindex; /* done srb array index */ 1144 int32_t workingsrb_startindex; /* start srb array index */ 1145 int32_t srboutstandingcount; 1146 1147 u_int8_t rqbuffer[ARCMSR_MAX_QBUFFER]; /* data collection buffer for read from 80331 */ 1148 u_int32_t rqbuf_firstindex; /* first of read buffer */ 1149 u_int32_t rqbuf_lastindex; /* last of read buffer */ 1150 1151 u_int8_t wqbuffer[ARCMSR_MAX_QBUFFER]; /* data collection buffer for write to 80331 */ 1152 u_int32_t wqbuf_firstindex; /* first of write buffer */ 1153 u_int32_t wqbuf_lastindex; /* last of write buffer */ 1154 1155 arcmsr_lock_t isr_lock; 1156 arcmsr_lock_t srb_lock; 1157 arcmsr_lock_t postDone_lock; 1158 arcmsr_lock_t qbuffer_lock; 1159 1160 u_int8_t devstate[ARCMSR_MAX_TARGETID][ARCMSR_MAX_TARGETLUN]; /* id0 ..... id15,lun0...lun7 */ 1161 u_int32_t num_resets; 1162 u_int32_t num_aborts; 1163 u_int32_t firm_request_len; /*1,04-07*/ 1164 u_int32_t firm_numbers_queue; /*2,08-11*/ 1165 u_int32_t firm_sdram_size; /*3,12-15*/ 1166 u_int32_t firm_ide_channels; /*4,16-19*/ 1167 u_int32_t firm_cfg_version; 1168 char firm_model[12]; /*15,60-67*/ 1169 char firm_version[20]; /*17,68-83*/ 1170 char device_map[20]; /*21,84-99 */ 1171 struct callout devmap_callout; 1172 u_int32_t pktRequestCount; 1173 u_int32_t pktReturnCount; 1174 u_int32_t vendor_device_id; 1175 u_int32_t adapter_bus_speed; 1176 u_int32_t maxOutstanding; 1177 u_int16_t sub_device_id; 1178 };/* HW_DEVICE_EXTENSION */ 1179 /* acb_flags */ 1180 #define ACB_F_SCSISTOPADAPTER 0x0001 1181 #define ACB_F_MSG_STOP_BGRB 0x0002 /* stop RAID background rebuild */ 1182 #define ACB_F_MSG_START_BGRB 0x0004 /* stop RAID background rebuild */ 1183 #define ACB_F_IOPDATA_OVERFLOW 0x0008 /* iop ioctl data rqbuffer overflow */ 1184 #define ACB_F_MESSAGE_WQBUFFER_CLEARED 0x0010 /* ioctl clear wqbuffer */ 1185 #define ACB_F_MESSAGE_RQBUFFER_CLEARED 0x0020 /* ioctl clear rqbuffer */ 1186 #define ACB_F_MESSAGE_WQBUFFER_READ 0x0040 1187 #define ACB_F_BUS_RESET 0x0080 1188 #define ACB_F_IOP_INITED 0x0100 /* iop init */ 1189 #define ACB_F_MAPFREESRB_FAILD 0x0200 /* arcmsr_map_freesrb faild */ 1190 #define ACB_F_CAM_DEV_QFRZN 0x0400 1191 #define ACB_F_BUS_HANG_ON 0x0800 /* need hardware reset bus */ 1192 #define ACB_F_SRB_FUNCTION_POWER 0x1000 1193 /* devstate */ 1194 #define ARECA_RAID_GONE 0x55 1195 #define ARECA_RAID_GOOD 0xaa 1196 /* adapter_bus_speed */ 1197 #define ACB_BUS_SPEED_3G 0 1198 #define ACB_BUS_SPEED_6G 1 1199 #define ACB_BUS_SPEED_12G 2 1200 /* 1201 ************************************************************* 1202 ************************************************************* 1203 */ 1204 struct SENSE_DATA { 1205 u_int8_t ErrorCode:7; 1206 u_int8_t Valid:1; 1207 u_int8_t SegmentNumber; 1208 u_int8_t SenseKey:4; 1209 u_int8_t Reserved:1; 1210 u_int8_t IncorrectLength:1; 1211 u_int8_t EndOfMedia:1; 1212 u_int8_t FileMark:1; 1213 u_int8_t Information[4]; 1214 u_int8_t AdditionalSenseLength; 1215 u_int8_t CommandSpecificInformation[4]; 1216 u_int8_t AdditionalSenseCode; 1217 u_int8_t AdditionalSenseCodeQualifier; 1218 u_int8_t FieldReplaceableUnitCode; 1219 u_int8_t SenseKeySpecific[3]; 1220 }; 1221 /* 1222 ********************************** 1223 ** Peripheral Device Type definitions 1224 ********************************** 1225 */ 1226 #define SCSI_DASD 0x00 /* Direct-access Device */ 1227 #define SCSI_SEQACESS 0x01 /* Sequential-access device */ 1228 #define SCSI_PRINTER 0x02 /* Printer device */ 1229 #define SCSI_PROCESSOR 0x03 /* Processor device */ 1230 #define SCSI_WRITEONCE 0x04 /* Write-once device */ 1231 #define SCSI_CDROM 0x05 /* CD-ROM device */ 1232 #define SCSI_SCANNER 0x06 /* Scanner device */ 1233 #define SCSI_OPTICAL 0x07 /* Optical memory device */ 1234 #define SCSI_MEDCHGR 0x08 /* Medium changer device */ 1235 #define SCSI_COMM 0x09 /* Communications device */ 1236 #define SCSI_NODEV 0x1F /* Unknown or no device type */ 1237 /* 1238 ************************************************************************************************************ 1239 ** @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 1240 ** 80331 PCI-to-PCI Bridge 1241 ** PCI Configuration Space 1242 ** 1243 ** @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 1244 ** Programming Interface 1245 ** ======================== 1246 ** Configuration Register Address Space Groupings and Ranges 1247 ** ============================================================= 1248 ** Register Group Configuration Offset 1249 ** ------------------------------------------------------------- 1250 ** Standard PCI Configuration 00-3Fh 1251 ** ------------------------------------------------------------- 1252 ** Device Specific Registers 40-A7h 1253 ** ------------------------------------------------------------- 1254 ** Reserved A8-CBh 1255 ** ------------------------------------------------------------- 1256 ** Enhanced Capability List CC-FFh 1257 ** ========================================================================================================== 1258 ** Standard PCI [Type 1] Configuration Space Address Map 1259 ** ********************************************************************************************************** 1260 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset 1261 ** ---------------------------------------------------------------------------------------------------------- 1262 ** | Device ID | Vendor ID | 00h 1263 ** ---------------------------------------------------------------------------------------------------------- 1264 ** | Primary Status | Primary Command | 04h 1265 ** ---------------------------------------------------------------------------------------------------------- 1266 ** | Class Code | RevID | 08h 1267 ** ---------------------------------------------------------------------------------------------------------- 1268 ** | reserved | Header Type | Primary MLT | Primary CLS | 0Ch 1269 ** ---------------------------------------------------------------------------------------------------------- 1270 ** | Reserved | 10h 1271 ** ---------------------------------------------------------------------------------------------------------- 1272 ** | Reserved | 14h 1273 ** ---------------------------------------------------------------------------------------------------------- 1274 ** | Secondary MLT | Subordinate Bus Number | Secondary Bus Number | Primary Bus Number | 18h 1275 ** ---------------------------------------------------------------------------------------------------------- 1276 ** | Secondary Status | I/O Limit | I/O Base | 1Ch 1277 ** ---------------------------------------------------------------------------------------------------------- 1278 ** | Non-prefetchable Memory Limit Address | Non-prefetchable Memory Base Address | 20h 1279 ** ---------------------------------------------------------------------------------------------------------- 1280 ** | Prefetchable Memory Limit Address | Prefetchable Memory Base Address | 24h 1281 ** ---------------------------------------------------------------------------------------------------------- 1282 ** | Prefetchable Memory Base Address Upper 32 Bits | 28h 1283 ** ---------------------------------------------------------------------------------------------------------- 1284 ** | Prefetchable Memory Limit Address Upper 32 Bits | 2Ch 1285 ** ---------------------------------------------------------------------------------------------------------- 1286 ** | I/O Limit Upper 16 Bits | I/O Base Upper 16 | 30h 1287 ** ---------------------------------------------------------------------------------------------------------- 1288 ** | Reserved | Capabilities Pointer | 34h 1289 ** ---------------------------------------------------------------------------------------------------------- 1290 ** | Reserved | 38h 1291 ** ---------------------------------------------------------------------------------------------------------- 1292 ** | Bridge Control | Primary Interrupt Pin | Primary Interrupt Line | 3Ch 1293 **============================================================================================================= 1294 */ 1295 /* 1296 **============================================================================================================= 1297 ** 0x03-0x00 : 1298 ** Bit Default Description 1299 **31:16 0335h Device ID (DID): Indicates the unique device ID that is assigned to bridge by the PCI SIG. 1300 ** ID is unique per product speed as indicated. 1301 **15:00 8086h Vendor ID (VID): 16-bit field which indicates that Intel is the vendor. 1302 **============================================================================================================= 1303 */ 1304 #define ARCMSR_PCI2PCI_VENDORID_REG 0x00 /*word*/ 1305 #define ARCMSR_PCI2PCI_DEVICEID_REG 0x02 /*word*/ 1306 /* 1307 **============================================================================== 1308 ** 0x05-0x04 : command register 1309 ** Bit Default Description 1310 **15:11 00h Reserved 1311 ** 10 0 Interrupt Disable: Disables/Enables the generation of Interrupts on the primary bus. 1312 ** The bridge does not support interrupts. 1313 ** 09 0 FB2B Enable: Enables/Disables the generation of fast back to back 1314 ** transactions on the primary bus. 1315 ** The bridge does not generate fast back to back 1316 ** transactions on the primary bus. 1317 ** 08 0 SERR# Enable (SEE): Enables primary bus SERR# assertions. 1318 ** 0=The bridge does not assert P_SERR#. 1319 ** 1=The bridge may assert P_SERR#, subject to other programmable criteria. 1320 ** 07 0 Wait Cycle Control (WCC): Always returns 0bzero indicating 1321 ** that bridge does not perform address or data stepping, 1322 ** 06 0 Parity Error Response (PER): Controls bridge response to a detected primary bus parity error. 1323 ** 0=When a data parity error is detected bridge does not assert S_PERR#. 1324 ** Also bridge does not assert P_SERR# in response to 1325 ** a detected address or attribute parity error. 1326 ** 1=When a data parity error is detected bridge asserts S_PERR#. 1327 ** The bridge also asserts P_SERR# 1328 ** (when enabled globally via bit(8) of this register) 1329 ** in response to a detected address or attribute parity error. 1330 ** 05 0 VGA Palette Snoop Enable (VGA_PSE): Controls bridge response to VGA-compatible palette write transactions. 1331 ** VGA palette write transactions are I/O transactions 1332 ** whose address bits are: P_AD[9:0] equal to 3C6h, 3C8h or 3C9h 1333 ** P_AD[15:10] are not decoded (i.e. aliases are claimed), 1334 ** or are fully decoding 1335 ** (i.e., must be all 0's depending upon the VGA 1336 ** aliasing bit in the Bridge Control Register, offset 3Eh. 1337 ** P_AD[31:16] equal to 0000h 1338 ** 0=The bridge ignores VGA palette write transactions, 1339 ** unless decoded by the standard I/O address range window. 1340 ** 1=The bridge responds to VGA palette write transactions 1341 ** with medium DEVSEL# timing and forwards them to the secondary bus. 1342 ** 04 0 Memory Write and Invalidate Enable (MWIE): The bridge does not promote MW transactions to MWI transactions. 1343 ** MWI transactions targeting resources on the opposite side of the bridge, 1344 ** however, are forwarded as MWI transactions. 1345 ** 03 0 Special Cycle Enable (SCE): The bridge ignores special cycle transactions. 1346 ** This bit is read only and always returns 0 when read 1347 ** 02 0 Bus Master Enable (BME): Enables bridge to initiate memory and I/O transactions on the primary interface. 1348 ** Initiation of configuration transactions is not affected by the state of this bit. 1349 ** 0=The bridge does not initiate memory or I/O transactions on the primary interface. 1350 ** 1=The bridge is enabled to function as an initiator on the primary interface. 1351 ** 01 0 Memory Space Enable (MSE): Controls target response to memory transactions on the primary interface. 1352 ** 0=The bridge target response to memory transactions on the primary interface is disabled. 1353 ** 1=The bridge target response to memory transactions on the primary interface is enabled. 1354 ** 00 0 I/O Space Enable (IOSE): Controls target response to I/O transactions on the primary interface. 1355 ** 0=The bridge target response to I/O transactions on the primary interface is disabled. 1356 ** 1=The bridge target response to I/O transactions on the primary interface is enabled. 1357 **============================================================================== 1358 */ 1359 #define ARCMSR_PCI2PCI_PRIMARY_COMMAND_REG 0x04 /*word*/ 1360 #define PCI_DISABLE_INTERRUPT 0x0400 1361 /* 1362 **============================================================================== 1363 ** 0x07-0x06 : status register 1364 ** Bit Default Description 1365 ** 15 0 Detected Parity Error: The bridge sets this bit to a 1b whenever it detects an address, 1366 ** attribute or data parity error. 1367 ** This bit is set regardless of the state of the PER bit in the command register. 1368 ** 14 0 Signaled System Error: The bridge sets this bit to a 1b whenever it asserts SERR# on the primary bus. 1369 ** 13 0 Received Master Abort: The bridge sets this bit to a 1b when, 1370 ** acting as the initiator on the primary bus, 1371 ** its transaction (with the exception of special cycles) 1372 ** has been terminated with a Master Abort. 1373 ** 12 0 Received Target Abort: The bridge sets this bit to a 1b when, 1374 ** acting as the initiator on the primary bus, 1375 ** its transaction has been terminated with a Target Abort. 1376 ** 11 0 Signaled Target Abort: The bridge sets this bit to a 1b when it, 1377 ** as the target of a transaction, terminates it with a Target Abort. 1378 ** In PCI-X mode this bit is also set when it forwards a SCM with a target abort error code. 1379 ** 10:09 01 DEVSEL# Timing: Indicates slowest response to a non-configuration command on the primary interface. 1380 ** Returns ��01b�� when read, indicating that bridge responds no slower than with medium timing. 1381 ** 08 0 Master Data Parity Error: The bridge sets this bit to a 1b when all of the following conditions are true: 1382 ** The bridge is the current master on the primary bus 1383 ** S_PERR# is detected asserted or is asserted by bridge 1384 ** The Parity Error Response bit is set in the Command register 1385 ** 07 1 Fast Back to Back Capable: Returns a 1b when read indicating that bridge 1386 ** is able to respond to fast back to back transactions on its primary interface. 1387 ** 06 0 Reserved 1388 ** 05 1 66 MHz Capable Indication: Returns a 1b when read indicating that bridge primary interface is 66 MHz capable. 1389 ** 1 = 1390 ** 04 1 Capabilities List Enable: Returns 1b when read indicating that bridge supports PCI standard enhanced capabilities. 1391 ** Offset 34h (Capability Pointer register) 1392 ** provides the offset for the first entry 1393 ** in the linked list of enhanced capabilities. 1394 ** 03 0 Interrupt Status: Reflects the state of the interrupt in the device/function. 1395 ** The bridge does not support interrupts. 1396 ** 02:00 000 Reserved 1397 **============================================================================== 1398 */ 1399 #define ARCMSR_PCI2PCI_PRIMARY_STATUS_REG 0x06 /*word: 06,07 */ 1400 #define ARCMSR_ADAP_66MHZ 0x20 1401 /* 1402 **============================================================================== 1403 ** 0x08 : revision ID 1404 ** Bit Default Description 1405 ** 07:00 00000000 Revision ID (RID): '00h' indicating bridge A-0 stepping. 1406 **============================================================================== 1407 */ 1408 #define ARCMSR_PCI2PCI_REVISIONID_REG 0x08 /*byte*/ 1409 /* 1410 **============================================================================== 1411 ** 0x0b-0x09 : 0180_00 (class code 1,native pci mode ) 1412 ** Bit Default Description 1413 ** 23:16 06h Base Class Code (BCC): Indicates that this is a bridge device. 1414 ** 15:08 04h Sub Class Code (SCC): Indicates this is of type PCI-to-PCI bridge. 1415 ** 07:00 00h Programming Interface (PIF): Indicates that this is standard (non-subtractive) PCI-PCI bridge. 1416 **============================================================================== 1417 */ 1418 #define ARCMSR_PCI2PCI_CLASSCODE_REG 0x09 /*3bytes*/ 1419 /* 1420 **============================================================================== 1421 ** 0x0c : cache line size 1422 ** Bit Default Description 1423 ** 07:00 00h Cache Line Size (CLS): Designates the cache line size in 32-bit dword units. 1424 ** The contents of this register are factored into 1425 ** internal policy decisions associated with memory read prefetching, 1426 ** and the promotion of Memory Write transactions to MWI transactions. 1427 ** Valid cache line sizes are 8 and 16 dwords. 1428 ** When the cache line size is set to an invalid value, 1429 ** bridge behaves as though the cache line size was set to 00h. 1430 **============================================================================== 1431 */ 1432 #define ARCMSR_PCI2PCI_PRIMARY_CACHELINESIZE_REG 0x0C /*byte*/ 1433 /* 1434 **============================================================================== 1435 ** 0x0d : latency timer (number of pci clock 00-ff ) 1436 ** Bit Default Description 1437 ** Primary Latency Timer (PTV): 1438 ** 07:00 00h (Conventional PCI) Conventional PCI Mode: Primary bus Master latency timer. Indicates the number of PCI clock cycles, 1439 ** referenced from the assertion of FRAME# to the expiration of the timer, 1440 ** when bridge may continue as master of the current transaction. All bits are writable, 1441 ** resulting in a granularity of 1 PCI clock cycle. 1442 ** When the timer expires (i.e., equals 00h) 1443 ** bridge relinquishes the bus after the first data transfer 1444 ** when its PCI bus grant has been deasserted. 1445 ** or 40h (PCI-X) PCI-X Mode: Primary bus Master latency timer. 1446 ** Indicates the number of PCI clock cycles, 1447 ** referenced from the assertion of FRAME# to the expiration of the timer, 1448 ** when bridge may continue as master of the current transaction. 1449 ** All bits are writable, resulting in a granularity of 1 PCI clock cycle. 1450 ** When the timer expires (i.e., equals 00h) bridge relinquishes the bus at the next ADB. 1451 ** (Except in the case where MLT expires within 3 data phases 1452 ** of an ADB.In this case bridge continues on 1453 ** until it reaches the next ADB before relinquishing the bus.) 1454 **============================================================================== 1455 */ 1456 #define ARCMSR_PCI2PCI_PRIMARY_LATENCYTIMER_REG 0x0D /*byte*/ 1457 /* 1458 **============================================================================== 1459 ** 0x0e : (header type,single function ) 1460 ** Bit Default Description 1461 ** 07 0 Multi-function device (MVD): 80331 is a single-function device. 1462 ** 06:00 01h Header Type (HTYPE): Defines the layout of addresses 10h through 3Fh in configuration space. 1463 ** Returns ��01h�� when read indicating 1464 ** that the register layout conforms to the standard PCI-to-PCI bridge layout. 1465 **============================================================================== 1466 */ 1467 #define ARCMSR_PCI2PCI_HEADERTYPE_REG 0x0E /*byte*/ 1468 /* 1469 **============================================================================== 1470 ** 0x0f : 1471 **============================================================================== 1472 */ 1473 /* 1474 **============================================================================== 1475 ** 0x13-0x10 : 1476 ** PCI CFG Base Address #0 (0x10) 1477 **============================================================================== 1478 */ 1479 /* 1480 **============================================================================== 1481 ** 0x17-0x14 : 1482 ** PCI CFG Base Address #1 (0x14) 1483 **============================================================================== 1484 */ 1485 /* 1486 **============================================================================== 1487 ** 0x1b-0x18 : 1488 ** PCI CFG Base Address #2 (0x18) 1489 **-----------------0x1A,0x19,0x18--Bus Number Register - BNR 1490 ** Bit Default Description 1491 ** 23:16 00h Subordinate Bus Number (SBBN): Indicates the highest PCI bus number below this bridge. 1492 ** Any Type 1 configuration cycle 1493 ** on the primary bus whose bus number is greater than the secondary bus number, 1494 ** and less than or equal to the subordinate bus number 1495 ** is forwarded unaltered as a Type 1 configuration cycle on the secondary PCI bus. 1496 ** 15:08 00h Secondary Bus Number (SCBN): Indicates the bus number of PCI to which the secondary interface is connected. 1497 ** Any Type 1 configuration cycle matching this bus number 1498 ** is translated to a Type 0 configuration cycle (or a Special Cycle) 1499 ** before being executed on bridge's secondary PCI bus. 1500 ** 07:00 00h Primary Bus Number (PBN): Indicates bridge primary bus number. 1501 ** Any Type 1 configuration cycle on the primary interface 1502 ** with a bus number that is less than the contents 1503 ** of this register field does not be claimed by bridge. 1504 **-----------------0x1B--Secondary Latency Timer Register - SLTR 1505 ** Bit Default Description 1506 ** Secondary Latency Timer (STV): 1507 ** 07:00 00h (Conventional PCI) Conventional PCI Mode: Secondary bus Master latency timer. 1508 ** Indicates the number of PCI clock cycles, 1509 ** referenced from the assertion of FRAME# to the expiration of the timer, 1510 ** when bridge may continue as master of the current transaction. All bits are writable, 1511 ** resulting in a granularity of 1 PCI clock cycle. 1512 ** When the timer expires (i.e., equals 00h) 1513 ** bridge relinquishes the bus after the first data transfer 1514 ** when its PCI bus grant has been deasserted. 1515 ** or 40h (PCI-X) PCI-X Mode: Secondary bus Master latency timer. 1516 ** Indicates the number of PCI clock cycles,referenced from the assertion of FRAME# 1517 ** to the expiration of the timer, 1518 ** when bridge may continue as master of the current transaction. All bits are writable, 1519 ** resulting in a granularity of 1 PCI clock cycle. 1520 ** When the timer expires (i.e., equals 00h) bridge relinquishes the bus at the next ADB. 1521 ** (Except in the case where MLT expires within 3 data phases of an ADB. 1522 ** In this case bridge continues on until it reaches the next ADB 1523 ** before relinquishing the bus) 1524 **============================================================================== 1525 */ 1526 #define ARCMSR_PCI2PCI_PRIMARY_BUSNUMBER_REG 0x18 /*3byte 0x1A,0x19,0x18*/ 1527 #define ARCMSR_PCI2PCI_SECONDARY_BUSNUMBER_REG 0x19 /*byte*/ 1528 #define ARCMSR_PCI2PCI_SUBORDINATE_BUSNUMBER_REG 0x1A /*byte*/ 1529 #define ARCMSR_PCI2PCI_SECONDARY_LATENCYTIMER_REG 0x1B /*byte*/ 1530 /* 1531 **============================================================================== 1532 ** 0x1f-0x1c : 1533 ** PCI CFG Base Address #3 (0x1C) 1534 **-----------------0x1D,0x1C--I/O Base and Limit Register - IOBL 1535 ** Bit Default Description 1536 ** 15:12 0h I/O Limit Address Bits [15:12]: Defines the top address of an address range to 1537 ** determine when to forward I/O transactions from one interface to the other. 1538 ** These bits correspond to address lines 15:12 for 4KB alignment. 1539 ** Bits 11:0 are assumed to be FFFh. 1540 ** 11:08 1h I/O Limit Addressing Capability: This field is hard-wired to 1h, indicating support 32-bit I/O addressing. 1541 ** 07:04 0h I/O Base Address Bits [15:12]: Defines the bottom address of 1542 ** an address range to determine when to forward I/O transactions 1543 ** from one interface to the other. 1544 ** These bits correspond to address lines 15:12 for 4KB alignment. 1545 ** Bits 11:0 are assumed to be 000h. 1546 ** 03:00 1h I/O Base Addressing Capability: This is hard-wired to 1h, indicating support for 32-bit I/O addressing. 1547 **-----------------0x1F,0x1E--Secondary Status Register - SSR 1548 ** Bit Default Description 1549 ** 15 0b Detected Parity Error: The bridge sets this bit to a 1b whenever it detects an address, 1550 ** attribute or data parity error on its secondary interface. 1551 ** 14 0b Received System Error: The bridge sets this bit when it samples SERR# asserted on its secondary bus interface. 1552 ** 13 0b Received Master Abort: The bridge sets this bit to a 1b when, 1553 ** acting as the initiator on the secondary bus, 1554 ** it's transaction (with the exception of special cycles) 1555 ** has been terminated with a Master Abort. 1556 ** 12 0b Received Target Abort: The bridge sets this bit to a 1b when, 1557 ** acting as the initiator on the secondary bus, 1558 ** it's transaction has been terminated with a Target Abort. 1559 ** 11 0b Signaled Target Abort: The bridge sets this bit to a 1b when it, 1560 ** as the target of a transaction, terminates it with a Target Abort. 1561 ** In PCI-X mode this bit is also set when it forwards a SCM with a target abort error code. 1562 ** 10:09 01b DEVSEL# Timing: Indicates slowest response to a non-configuration command on the secondary interface. 1563 ** Returns ��01b�� when read, indicating that bridge responds no slower than with medium timing. 1564 ** 08 0b Master Data Parity Error: The bridge sets this bit to a 1b when all of the following conditions are true: 1565 ** The bridge is the current master on the secondary bus 1566 ** S_PERR# is detected asserted or is asserted by bridge 1567 ** The Parity Error Response bit is set in the Command register 1568 ** 07 1b Fast Back-to-Back Capable (FBC): Indicates that the secondary interface of bridge can receive fast back-to-back cycles. 1569 ** 06 0b Reserved 1570 ** 05 1b 66 MHz Capable (C66): Indicates the secondary interface of the bridge is 66 MHz capable. 1571 ** 1 = 1572 ** 04:00 00h Reserved 1573 **============================================================================== 1574 */ 1575 #define ARCMSR_PCI2PCI_IO_BASE_REG 0x1C /*byte*/ 1576 #define ARCMSR_PCI2PCI_IO_LIMIT_REG 0x1D /*byte*/ 1577 #define ARCMSR_PCI2PCI_SECONDARY_STATUS_REG 0x1E /*word: 0x1F,0x1E */ 1578 /* 1579 **============================================================================== 1580 ** 0x23-0x20 : 1581 ** PCI CFG Base Address #4 (0x20) 1582 **-----------------0x23,0x22,0x21,0x20--Memory Base and Limit Register - MBL 1583 ** Bit Default Description 1584 ** 31:20 000h Memory Limit: These 12 bits are compared with P_AD[31:20] of the incoming address to determine 1585 ** the upper 1MB aligned value (exclusive) of the range. 1586 ** The incoming address must be less than or equal to this value. 1587 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0] 1588 ** are assumed to be F FFFFh. 1589 ** 19:16 0h Reserved. 1590 ** 15:04 000h Memory Base: These 12 bits are compared with bits P_AD[31:20] 1591 ** of the incoming address to determine the lower 1MB 1592 ** aligned value (inclusive) of the range. 1593 ** The incoming address must be greater than or equal to this value. 1594 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0]) 1595 ** are assumed to be 0 0000h. 1596 ** 03:00 0h Reserved. 1597 **============================================================================== 1598 */ 1599 #define ARCMSR_PCI2PCI_NONPREFETCHABLE_MEMORY_BASE_REG 0x20 /*word: 0x21,0x20 */ 1600 #define ARCMSR_PCI2PCI_NONPREFETCHABLE_MEMORY_LIMIT_REG 0x22 /*word: 0x23,0x22 */ 1601 /* 1602 **============================================================================== 1603 ** 0x27-0x24 : 1604 ** PCI CFG Base Address #5 (0x24) 1605 **-----------------0x27,0x26,0x25,0x24--Prefetchable Memory Base and Limit Register - PMBL 1606 ** Bit Default Description 1607 ** 31:20 000h Prefetchable Memory Limit: These 12 bits are compared with P_AD[31:20] of the incoming address to determine 1608 ** the upper 1MB aligned value (exclusive) of the range. 1609 ** The incoming address must be less than or equal to this value. 1610 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0] 1611 ** are assumed to be F FFFFh. 1612 ** 19:16 1h 64-bit Indicator: Indicates that 64-bit addressing is supported. 1613 ** 15:04 000h Prefetchable Memory Base: These 12 bits are compared with bits P_AD[31:20] 1614 ** of the incoming address to determine the lower 1MB aligned value (inclusive) 1615 ** of the range. 1616 ** The incoming address must be greater than or equal to this value. 1617 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0]) 1618 ** are assumed to be 0 0000h. 1619 ** 03:00 1h 64-bit Indicator: Indicates that 64-bit addressing is supported. 1620 **============================================================================== 1621 */ 1622 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_BASE_REG 0x24 /*word: 0x25,0x24 */ 1623 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_LIMIT_REG 0x26 /*word: 0x27,0x26 */ 1624 /* 1625 **============================================================================== 1626 ** 0x2b-0x28 : 1627 ** Bit Default Description 1628 ** 31:00 00000000h Prefetchable Memory Base Upper Portion: All bits are read/writable 1629 ** bridge supports full 64-bit addressing. 1630 **============================================================================== 1631 */ 1632 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_BASE_UPPER32_REG 0x28 /*dword: 0x2b,0x2a,0x29,0x28 */ 1633 /* 1634 **============================================================================== 1635 ** 0x2f-0x2c : 1636 ** Bit Default Description 1637 ** 31:00 00000000h Prefetchable Memory Limit Upper Portion: All bits are read/writable 1638 ** bridge supports full 64-bit addressing. 1639 **============================================================================== 1640 */ 1641 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_LIMIT_UPPER32_REG 0x2C /*dword: 0x2f,0x2e,0x2d,0x2c */ 1642 /* 1643 **============================================================================== 1644 ** 0x33-0x30 : 1645 ** Bit Default Description 1646 ** 07:00 DCh Capabilities Pointer: Pointer to the first CAP ID entry in the capabilities list is at DCh in PCI configuration 1647 ** space. (Power Management Capability Registers) 1648 **============================================================================== 1649 */ 1650 #define ARCMSR_PCI2PCI_CAPABILITIES_POINTER_REG 0x34 /*byte*/ 1651 /* 1652 **============================================================================== 1653 ** 0x3b-0x35 : reserved 1654 **============================================================================== 1655 */ 1656 /* 1657 **============================================================================== 1658 ** 0x3d-0x3c : 1659 ** 1660 ** Bit Default Description 1661 ** 15:08 00h Interrupt Pin (PIN): Bridges do not support the generation of interrupts. 1662 ** 07:00 00h Interrupt Line (LINE): The bridge does not generate interrupts, so this is reserved as '00h'. 1663 **============================================================================== 1664 */ 1665 #define ARCMSR_PCI2PCI_PRIMARY_INTERRUPT_LINE_REG 0x3C /*byte*/ 1666 #define ARCMSR_PCI2PCI_PRIMARY_INTERRUPT_PIN_REG 0x3D /*byte*/ 1667 /* 1668 **============================================================================== 1669 ** 0x3f-0x3e : 1670 ** Bit Default Description 1671 ** 15:12 0h Reserved 1672 ** 11 0b Discard Timer SERR# Enable: Controls the generation of SERR# on the primary interface (P_SERR#) in response 1673 ** to a timer discard on either the primary or secondary interface. 1674 ** 0b=SERR# is not asserted. 1675 ** 1b=SERR# is asserted. 1676 ** 10 0b Discard Timer Status (DTS): This bit is set to a '1b' when either the primary or secondary discard timer expires. 1677 ** The delayed completion is then discarded. 1678 ** 09 0b Secondary Discard Timer (SDT): Sets the maximum number of PCI clock cycles 1679 ** that bridge waits for an initiator on the secondary bus 1680 ** to repeat a delayed transaction request. 1681 ** The counter starts when the delayed transaction completion is ready 1682 ** to be returned to the initiator. 1683 ** When the initiator has not repeated the transaction 1684 ** at least once before the counter expires,bridge 1685 ** discards the delayed transaction from its queues. 1686 ** 0b=The secondary master time-out counter is 2 15 PCI clock cycles. 1687 ** 1b=The secondary master time-out counter is 2 10 PCI clock cycles. 1688 ** 08 0b Primary Discard Timer (PDT): Sets the maximum number of PCI clock cycles 1689 ** that bridge waits for an initiator on the primary bus 1690 ** to repeat a delayed transaction request. 1691 ** The counter starts when the delayed transaction completion 1692 ** is ready to be returned to the initiator. 1693 ** When the initiator has not repeated the transaction 1694 ** at least once before the counter expires, 1695 ** bridge discards the delayed transaction from its queues. 1696 ** 0b=The primary master time-out counter is 2 15 PCI clock cycles. 1697 ** 1b=The primary master time-out counter is 2 10 PCI clock cycles. 1698 ** 07 0b Fast Back-to-Back Enable (FBE): The bridge does not initiate back to back transactions. 1699 ** 06 0b Secondary Bus Reset (SBR): 1700 ** When cleared to 0b: The bridge deasserts S_RST#, 1701 ** when it had been asserted by writing this bit to a 1b. 1702 ** When set to 1b: The bridge asserts S_RST#. 1703 ** 05 0b Master Abort Mode (MAM): Dictates bridge behavior on the initiator bus 1704 ** when a master abort termination occurs in response to 1705 ** a delayed transaction initiated by bridge on the target bus. 1706 ** 0b=The bridge asserts TRDY# in response to a non-locked delayed transaction, 1707 ** and returns FFFF FFFFh when a read. 1708 ** 1b=When the transaction had not yet been completed on the initiator bus 1709 ** (e.g.,delayed reads, or non-posted writes), 1710 ** then bridge returns a Target Abort in response to the original requester 1711 ** when it returns looking for its delayed completion on the initiator bus. 1712 ** When the transaction had completed on the initiator bus (e.g., a PMW), 1713 ** then bridge asserts P_SERR# (when enabled). 1714 ** For PCI-X transactions this bit is an enable for the assertion of P_SERR# due to a master abort 1715 ** while attempting to deliver a posted memory write on the destination bus. 1716 ** 04 0b VGA Alias Filter Enable: This bit dictates bridge behavior in conjunction with the VGA enable bit 1717 ** (also of this register), 1718 ** and the VGA Palette Snoop Enable bit (Command Register). 1719 ** When the VGA enable, or VGA Palette Snoop enable bits are on (i.e., 1b) 1720 ** the VGA Aliasing bit for the corresponding enabled functionality,: 1721 ** 0b=Ignores address bits AD[15:10] when decoding VGA I/O addresses. 1722 ** 1b=Ensures that address bits AD[15:10] equal 000000b when decoding VGA I/O addresses. 1723 ** When all VGA cycle forwarding is disabled, (i.e., VGA Enable bit =0b and VGA Palette Snoop bit =0b), 1724 ** then this bit has no impact on bridge behavior. 1725 ** 03 0b VGA Enable: Setting this bit enables address decoding 1726 ** and transaction forwarding of the following VGA transactions from the primary bus 1727 ** to the secondary bus: 1728 ** frame buffer memory addresses 000A0000h:000BFFFFh, 1729 ** 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), 1730 ** or must be ��000000b�� 1731 ** depending upon the state of the VGA Alias Filter Enable bit. (bit(4) of this register) 1732 ** I/O and Memory Enable bits must be set in the Command register 1733 ** to enable forwarding of VGA cycles. 1734 ** 02 0b ISA Enable: Setting this bit enables special handling 1735 ** for the forwarding of ISA I/O transactions that fall within the address range 1736 ** specified by the I/O Base and Limit registers, 1737 ** and are within the lowest 64Kbyte of the I/O address map 1738 ** (i.e., 0000 0000h - 0000 FFFFh). 1739 ** 0b=All I/O transactions that fall within the I/O Base 1740 ** and Limit registers' specified range are forwarded 1741 ** from primary to secondary unfiltered. 1742 ** 1b=Blocks the forwarding from primary to secondary 1743 ** of the top 768 bytes of each 1Kbyte alias. 1744 ** On the secondary the top 768 bytes of each 1K alias 1745 ** are inversely decoded and forwarded 1746 ** from secondary to primary. 1747 ** 01 0b SERR# Forward Enable: 0b=The bridge does not assert P_SERR# as a result of an S_SERR# assertion. 1748 ** 1b=The bridge asserts P_SERR# whenever S_SERR# is detected 1749 ** asserted provided the SERR# Enable bit is set (PCI Command Register bit(8)=1b). 1750 ** 00 0b Parity Error Response: This bit controls bridge response to a parity error 1751 ** that is detected on its secondary interface. 1752 ** 0b=When a data parity error is detected bridge does not assert S_PERR#. 1753 ** Also bridge does not assert P_SERR# in response to a detected address 1754 ** or attribute parity error. 1755 ** 1b=When a data parity error is detected bridge asserts S_PERR#. 1756 ** The bridge also asserts P_SERR# (when enabled globally via bit(8) 1757 ** of the Command register) 1758 ** in response to a detected address or attribute parity error. 1759 **============================================================================== 1760 */ 1761 #define ARCMSR_PCI2PCI_BRIDGE_CONTROL_REG 0x3E /*word*/ 1762 /* 1763 ************************************************************************** 1764 ** Device Specific Registers 40-A7h 1765 ************************************************************************** 1766 ** ---------------------------------------------------------------------------------------------------------- 1767 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset 1768 ** ---------------------------------------------------------------------------------------------------------- 1769 ** | Bridge Control 0 | Arbiter Control/Status | Reserved | 40h 1770 ** ---------------------------------------------------------------------------------------------------------- 1771 ** | Bridge Control 2 | Bridge Control 1 | 44h 1772 ** ---------------------------------------------------------------------------------------------------------- 1773 ** | Reserved | Bridge Status | 48h 1774 ** ---------------------------------------------------------------------------------------------------------- 1775 ** | Reserved | 4Ch 1776 ** ---------------------------------------------------------------------------------------------------------- 1777 ** | Prefetch Policy | Multi-Transaction Timer | 50h 1778 ** ---------------------------------------------------------------------------------------------------------- 1779 ** | Reserved | Pre-boot Status | P_SERR# Assertion Control | 54h 1780 ** ---------------------------------------------------------------------------------------------------------- 1781 ** | Reserved | Reserved | Secondary Decode Enable | 58h 1782 ** ---------------------------------------------------------------------------------------------------------- 1783 ** | Reserved | Secondary IDSEL | 5Ch 1784 ** ---------------------------------------------------------------------------------------------------------- 1785 ** | Reserved | 5Ch 1786 ** ---------------------------------------------------------------------------------------------------------- 1787 ** | Reserved | 68h:CBh 1788 ** ---------------------------------------------------------------------------------------------------------- 1789 ************************************************************************** 1790 **============================================================================== 1791 ** 0x42-0x41: Secondary Arbiter Control/Status Register - SACSR 1792 ** Bit Default Description 1793 ** 15:12 1111b Grant Time-out Violator: This field indicates the agent that violated the Grant Time-out rule 1794 ** (PCI=16 clocks,PCI-X=6 clocks). 1795 ** Note that this field is only meaningful when: 1796 ** # Bit[11] of this register is set to 1b, 1797 ** indicating that a Grant Time-out violation had occurred. 1798 ** # bridge internal arbiter is enabled. 1799 ** Bits[15:12] Violating Agent (REQ#/GNT# pair number) 1800 ** 0000b REQ#/GNT#[0] 1801 ** 0001b REQ#/GNT#[1] 1802 ** 0010b REQ#/GNT#[2] 1803 ** 0011b REQ#/GNT#[3] 1804 ** 1111b Default Value (no violation detected) 1805 ** When bit[11] is cleared by software, this field reverts back to its default value. 1806 ** All other values are Reserved 1807 ** 11 0b Grant Time-out Occurred: When set to 1b, 1808 ** this indicates that a Grant Time-out error had occurred involving one of the secondary bus agents. 1809 ** Software clears this bit by writing a 1b to it. 1810 ** 10 0b Bus Parking Control: 0=During bus idle, bridge parks the bus on the last master to use the bus. 1811 ** 1=During bus idle, bridge parks the bus on itself. 1812 ** The bus grant is removed from the last master and internally asserted to bridge. 1813 ** 09:08 00b Reserved 1814 ** 07:00 0000 0000b Secondary Bus Arbiter Priority Configuration: The bridge secondary arbiter provides two rings of arbitration priority. 1815 ** Each bit of this field assigns its corresponding secondary 1816 ** bus master to either the high priority arbiter ring (1b) 1817 ** or to the low priority arbiter ring (0b). 1818 ** Bits [3:0] correspond to request inputs S_REQ#[3:0], respectively. 1819 ** Bit [6] corresponds to the bridge internal secondary bus request 1820 ** while Bit [7] corresponds to the SATU secondary bus request. 1821 ** Bits [5:4] are unused. 1822 ** 0b=Indicates that the master belongs to the low priority group. 1823 ** 1b=Indicates that the master belongs to the high priority group 1824 **================================================================================= 1825 ** 0x43: Bridge Control Register 0 - BCR0 1826 ** Bit Default Description 1827 ** 07 0b Fully Dynamic Queue Mode: 0=The number of Posted write transactions is limited to eight 1828 ** and the Posted Write data is limited to 4KB. 1829 ** 1=Operation in fully dynamic queue mode. The bridge enqueues up to 1830 ** 14 Posted Memory Write transactions and 8KB of posted write data. 1831 ** 06:03 0H Reserved. 1832 ** 02 0b Upstream Prefetch Disable: This bit disables bridge ability 1833 ** to perform upstream prefetch operations for Memory 1834 ** Read requests received on its secondary interface. 1835 ** This bit also controls the bridge's ability to generate advanced read commands 1836 ** when forwarding a Memory Read Block transaction request upstream from a PCI-X bus 1837 ** to a Conventional PCI bus. 1838 ** 0b=bridge treats all upstream Memory Read requests as though they target prefetchable memory. 1839 ** The use of Memory Read Line and Memory Read 1840 ** Multiple is enabled when forwarding a PCI-X Memory Read Block request 1841 ** to an upstream bus operating in Conventional PCI mode. 1842 ** 1b=bridge treats upstream PCI Memory Read requests as though 1843 ** they target non-prefetchable memory and forwards upstream PCI-X Memory 1844 ** Read Block commands as Memory Read 1845 ** when the primary bus is operating 1846 ** in Conventional PCI mode. 1847 ** NOTE: This bit does not affect bridge ability to perform read prefetching 1848 ** when the received command is Memory Read Line or Memory Read Multiple. 1849 **================================================================================= 1850 ** 0x45-0x44: Bridge Control Register 1 - BCR1 (Sheet 2 of 2) 1851 ** Bit Default Description 1852 ** 15:08 0000000b Reserved 1853 ** 07:06 00b Alias Command Mapping: This two bit field determines how bridge handles PCI-X ��Alias�� commands, 1854 ** specifically the Alias to Memory Read Block and Alias to Memory Write Block commands. 1855 ** The three options for handling these alias commands are to either pass it as is, 1856 ** re-map to the actual block memory read/write command encoding, or ignore 1857 ** the transaction forcing a Master Abort to occur on the Origination Bus. 1858 ** Bit (7:6) Handling of command 1859 ** 0 0 Re-map to Memory Read/Write Block before forwarding 1860 ** 0 1 Enqueue and forward the alias command code unaltered 1861 ** 1 0 Ignore the transaction, forcing Master Abort 1862 ** 1 1 Reserved 1863 ** 05 1b Watchdog Timers Disable: Disables or enables all 2 24 Watchdog Timers in both directions. 1864 ** The watchdog timers are used to detect prohibitively long latencies in the system. 1865 ** The watchdog timer expires when any Posted Memory Write (PMW), Delayed Request, 1866 ** or Split Requests (PCI-X mode) is not completed within 2 24 events 1867 ** (��events�� are defined as PCI Clocks when operating in PCI-X mode, 1868 ** and as the number of times being retried when operating in Conventional PCI mode) 1869 ** 0b=All 2 24 watchdog timers are enabled. 1870 ** 1b=All 2 24 watchdog timers are disabled and there is no limits to 1871 ** the number of attempts bridge makes when initiating a PMW, 1872 ** transacting a Delayed Transaction, or how long it waits for 1873 ** a split completion corresponding to one of its requests. 1874 ** 04 0b GRANT# time-out disable: This bit enables/disables the GNT# time-out mechanism. 1875 ** Grant time-out is 16 clocks for conventional PCI, and 6 clocks for PCI-X. 1876 ** 0b=The Secondary bus arbiter times out an agent 1877 ** that does not assert FRAME# within 16/6 clocks of receiving its grant, 1878 ** once the bus has gone idle. 1879 ** The time-out counter begins as soon as the bus goes idle with the new GNT# asserted. 1880 ** An infringing agent does not receive a subsequent GNT# 1881 ** until it de-asserts its REQ# for at least one clock cycle. 1882 ** 1b=GNT# time-out mechanism is disabled. 1883 ** 03 00b Reserved. 1884 ** 02 0b Secondary Discard Timer Disable: This bit enables/disables bridge secondary delayed transaction discard mechanism. 1885 ** The time out mechanism is used to ensure that initiators 1886 ** of delayed transactions return for their delayed completion data/status 1887 ** within a reasonable amount of time after it is available from bridge. 1888 ** 0b=The secondary master time-out counter is enabled 1889 ** and uses the value specified by the Secondary Discard Timer bit 1890 ** (see Bridge Control Register). 1891 ** 1b=The secondary master time-out counter is disabled. 1892 ** The bridge waits indefinitely for a secondary bus master 1893 ** to repeat a delayed transaction. 1894 ** 01 0b Primary Discard Timer Disable: This bit enables/disables bridge primary 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 primary master time-out counter is enabled and uses the value specified 1899 ** by the Primary Discard Timer bit (see Bridge Control Register). 1900 ** 1b=The secondary master time-out counter is disabled. 1901 ** The bridge waits indefinitely for a secondary bus master 1902 ** to repeat a delayed transaction. 1903 ** 00 0b Reserved 1904 **================================================================================= 1905 ** 0x47-0x46: Bridge Control Register 2 - BCR2 1906 ** Bit Default Description 1907 ** 15:07 0000b Reserved. 1908 ** 06 0b Global Clock Out Disable (External Secondary Bus Clock Source Enable): 1909 ** This bit disables all of the secondary PCI clock outputs including 1910 ** the feedback clock S_CLKOUT. 1911 ** This means that the user is required to provide an S_CLKIN input source. 1912 ** 05:04 11 (66 MHz) Preserved. 1913 ** 01 (100 MHz) 1914 ** 00 (133 MHz) 1915 ** 03:00 Fh (100 MHz & 66 MHz) 1916 ** 7h (133 MHz) 1917 ** This 4 bit field provides individual enable/disable mask bits for each of bridge 1918 ** secondary PCI clock outputs. Some, or all secondary clock outputs (S_CLKO[3:0]) 1919 ** default to being enabled following the rising edge of P_RST#, depending on the 1920 ** frequency of the secondary bus clock: 1921 ** �E Designs with 100 MHz (or lower) Secondary PCI clock power up with 1922 ** all four S_CLKOs enabled by default. (SCLKO[3:0])�P 1923 ** �E Designs with 133 MHz Secondary PCI clock power up 1924 ** with the lower order 3 S_CLKOs enabled by default. 1925 ** (S_CLKO[2:0]) Only those SCLKs that power up enabled by can be connected 1926 ** to downstream device clock inputs. 1927 **================================================================================= 1928 ** 0x49-0x48: Bridge Status Register - BSR 1929 ** Bit Default Description 1930 ** 15 0b Upstream Delayed Transaction Discard Timer Expired: This bit is set to a 1b and P_SERR# 1931 ** is conditionally asserted when the secondary discard timer expires. 1932 ** 14 0b Upstream Delayed/Split Read Watchdog Timer Expired: 1933 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# 1934 ** is conditionally asserted when bridge discards an upstream delayed read ** ** transaction request after 2 24 retries following the initial retry. 1935 ** PCI-X Mode: This bit is set to a 1b and P_SERR# is conditionally asserted 1936 ** when bridge discards an upstream split read request 1937 ** after waiting in excess of 2 24 clocks for the corresponding 1938 ** Split Completion to arrive. 1939 ** 13 0b Upstream Delayed/Split Write Watchdog Timer Expired: 1940 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# 1941 ** is conditionally asserted when bridge discards an upstream delayed write ** ** transaction request after 2 24 retries following the initial retry. 1942 ** PCI-X Mode: This bit is set to a 1b and P_SERR# 1943 ** is conditionally asserted when bridge discards an upstream split write request ** after waiting in excess of 2 24 clocks for the corresponding 1944 ** Split Completion to arrive. 1945 ** 12 0b Master Abort during Upstream Posted Write: This bit is set to a 1b and P_SERR# 1946 ** is conditionally asserted when a Master Abort occurs as a result of an attempt, 1947 ** by bridge, to retire a PMW upstream. 1948 ** 11 0b Target Abort during Upstream Posted Write: This bit is set to a 1b and P_SERR# 1949 ** is conditionally asserted when a Target Abort occurs as a result of an attempt, 1950 ** by bridge, to retire a PMW upstream. 1951 ** 10 0b Upstream Posted Write Data Discarded: This bit is set to a 1b and P_SERR# 1952 ** is conditionally asserted when bridge discards an upstream PMW transaction 1953 ** after receiving 2 24 target retries from the primary bus target 1954 ** 09 0b Upstream Posted Write Data Parity Error: This bit is set to a 1b and P_SERR# 1955 ** is conditionally asserted when a data parity error is detected by bridge 1956 ** while attempting to retire a PMW upstream 1957 ** 08 0b Secondary Bus Address Parity Error: This bit is set to a 1b and P_SERR# 1958 ** is conditionally asserted when bridge detects an address parity error on 1959 ** the secondary bus. 1960 ** 07 0b Downstream Delayed Transaction Discard Timer Expired: This bit is set to a 1b and P_SERR# 1961 ** is conditionally asserted when the primary bus discard timer expires. 1962 ** 06 0b Downstream Delayed/Split Read Watchdog Timer Expired: 1963 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# 1964 ** is conditionally asserted when bridge discards a downstream delayed read ** ** transaction request after receiving 2 24 target retries 1965 ** from the secondary bus target. 1966 ** PCI-X Mode: This bit is set to a 1b and P_SERR# is conditionally asserted 1967 ** when bridge discards a downstream split read request 1968 ** after waiting in excess of 2 24 clocks for the corresponding 1969 ** Split Completion to arrive. 1970 ** 05 0b Downstream Delayed Write/Split Watchdog Timer Expired: 1971 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# is conditionally asserted 1972 ** when bridge discards a downstream delayed write transaction request 1973 ** after receiving 2 24 target retries from the secondary bus target. 1974 ** PCI-X Mode: This bit is set to a 1b and P_SERR# 1975 ** is conditionally asserted when bridge discards a downstream 1976 ** split write request after waiting in excess of 2 24 clocks 1977 ** for the corresponding Split Completion to arrive. 1978 ** 04 0b Master Abort during Downstream Posted Write: This bit is set to a 1b and P_SERR# 1979 ** is conditionally asserted when a Master Abort occurs as a result of an attempt, 1980 ** by bridge, to retire a PMW downstream. 1981 ** 03 0b Target Abort during Downstream Posted Write: This bit is set to a 1b and P_SERR# is conditionally asserted 1982 ** when a Target Abort occurs as a result of an attempt, by bridge, 1983 ** to retire a PMW downstream. 1984 ** 02 0b Downstream Posted Write Data Discarded: This bit is set to a 1b and P_SERR# 1985 ** is conditionally asserted when bridge discards a downstream PMW transaction 1986 ** after receiving 2 24 target retries from the secondary bus target 1987 ** 01 0b Downstream Posted Write Data Parity Error: This bit is set to a 1b and P_SERR# 1988 ** is conditionally asserted when a data parity error is detected by bridge 1989 ** while attempting to retire a PMW downstream. 1990 ** 00 0b Primary Bus Address Parity Error: This bit is set to a 1b and P_SERR# is conditionally asserted 1991 ** when bridge detects an address parity error on the primary bus. 1992 **================================================================================== 1993 ** 0x51-0x50: Bridge Multi-Transaction Timer Register - BMTTR 1994 ** Bit Default Description 1995 ** 15:13 000b Reserved 1996 ** 12:10 000b GRANT# Duration: This field specifies the count (PCI clocks) 1997 ** that a secondary bus master has its grant maintained in order to enable 1998 ** multiple transactions to execute within the same arbitration cycle. 1999 ** Bit[02:00] GNT# Extended Duration 2000 ** 000 MTT Disabled (Default=no GNT# extension) 2001 ** 001 16 clocks 2002 ** 010 32 clocks 2003 ** 011 64 clocks 2004 ** 100 128 clocks 2005 ** 101 256 clocks 2006 ** 110 Invalid (treated as 000) 2007 ** 111 Invalid (treated as 000) 2008 ** 09:08 00b Reserved 2009 ** 07:00 FFh MTT Mask: This field enables/disables MTT usage for each REQ#/GNT# 2010 ** pair supported by bridge secondary arbiter. 2011 ** Bit(7) corresponds to SATU internal REQ#/GNT# pair, 2012 ** bit(6) corresponds to bridge internal REQ#/GNT# pair, 2013 ** bit(5) corresponds to REQ#/GNT#(5) pair, etc. 2014 ** When a given bit is set to 1b, its corresponding REQ#/GNT# 2015 ** pair is enabled for MTT functionality as determined by bits(12:10) of this register. 2016 ** When a given bit is cleared to 0b, its corresponding REQ#/GNT# pair is disabled from using the MTT. 2017 **================================================================================== 2018 ** 0x53-0x52: Read Prefetch Policy Register - RPPR 2019 ** Bit Default Description 2020 ** 15:13 000b ReRead_Primary Bus: 3-bit field indicating the multiplication factor 2021 ** 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 2022 ** using the FirstRead parameter. 2023 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount Memory Read 4 DWORDs 2024 ** Memory Read Line 1 cache lines Memory Read Multiple 2 cache lines 2025 ** 12:10 000b FirstRead_Primary Bus: 3-bit field indicating the multiplication factor to be used in calculating 2026 ** the number of bytes to prefetch from the secondary bus interface 2027 ** on the initial PreFetch operation. 2028 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount Memory Read 4 DWORDs 2029 ** Memory Read Line 1 cache line Memory Read Multiple 2 cache lines 2030 ** 09:07 010b ReRead_Secondary Bus: 3-bit field indicating the multiplication factor to be used 2031 ** in calculating the number of bytes to prefetch from the primary 2032 ** bus interface on subsequent PreFetch operations given 2033 ** that the read demands were not satisfied using 2034 ** the FirstRead parameter. 2035 ** The default value of 010b correlates to: Command Type Hardwired pre-fetch a 2036 ** mount Memory Read 3 cache lines Memory Read Line 3 cache lines 2037 ** Memory Read Multiple 6 cache lines 2038 ** 06:04 000b FirstRead_Secondary Bus: 3-bit field indicating the multiplication factor to be used 2039 ** in calculating the number of bytes to prefetch from 2040 ** the primary bus interface on the initial PreFetch operation. 2041 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount 2042 ** Memory Read 4 DWORDs Memory Read Line 1 cache line Memory Read Multiple 2 cache lines 2043 ** 03:00 1111b Staged Prefetch Enable: This field enables/disables the FirstRead/ReRead pre-fetch 2044 ** algorithm for the secondary and the primary bus interfaces. 2045 ** Bit(3) is a ganged enable bit for REQ#/GNT#[7:3], and bits(2:0) provide individual 2046 ** enable bits for REQ#/GNT#[2:0]. 2047 ** (bit(2) is the enable bit for REQ#/GNT#[2], etc...) 2048 ** 1b: enables the staged pre-fetch feature 2049 ** 0b: disables staged pre-fetch, 2050 ** and hardwires read pre-fetch policy to the following for 2051 ** Memory Read, 2052 ** Memory Read Line, 2053 ** and Memory Read Multiple commands: 2054 ** Command Type Hardwired Pre-Fetch Amount... 2055 ** Memory Read 4 DWORDs 2056 ** Memory Read Line 1 cache line 2057 ** Memory Read Multiple 2 cache lines 2058 ** NOTE: When the starting address is not cache line aligned, bridge pre-fetches Memory Read line commands 2059 ** only to the next higher cache line boundary.For non-cache line aligned Memory Read 2060 ** Multiple commands bridge pre-fetches only to the second cache line boundary encountered. 2061 **================================================================================== 2062 ** 0x55-0x54: P_SERR# Assertion Control - SERR_CTL 2063 ** Bit Default Description 2064 ** 15 0b Upstream Delayed Transaction Discard Timer Expired: Dictates the bridge behavior 2065 ** in response to its discarding of a delayed transaction that was initiated from the primary bus. 2066 ** 0b=bridge asserts P_SERR#. 2067 ** 1b=bridge does not assert P_SERR# 2068 ** 14 0b Upstream Delayed/Split Read Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer. 2069 ** 0b=bridge asserts P_SERR#. 2070 ** 1b=bridge does not assert P_SERR# 2071 ** 13 0b Upstream Delayed/Split Write Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer. 2072 ** 0b=bridge asserts P_SERR#. 2073 ** 1b=bridge does not assert P_SERR# 2074 ** 12 0b Master Abort during Upstream Posted Write: Dictates bridge behavior following 2075 ** its having detected a Master Abort while attempting to retire one of its PMWs upstream. 2076 ** 0b=bridge asserts P_SERR#. 2077 ** 1b=bridge does not assert P_SERR# 2078 ** 11 0b Target Abort during Upstream Posted Write: Dictates bridge behavior following 2079 ** its having been terminated with Target Abort while attempting to retire one of its PMWs upstream. 2080 ** 0b=bridge asserts P_SERR#. 2081 ** 1b=bridge does not assert P_SERR# 2082 ** 10 0b Upstream Posted Write Data Discarded: Dictates bridge behavior in the event that 2083 ** it discards an upstream posted write transaction. 2084 ** 0b=bridge asserts P_SERR#. 2085 ** 1b=bridge does not assert P_SERR# 2086 ** 09 0b Upstream Posted Write Data Parity Error: Dictates bridge behavior 2087 ** when a data parity error is detected while attempting to retire on of its PMWs upstream. 2088 ** 0b=bridge asserts P_SERR#. 2089 ** 1b=bridge does not assert P_SERR# 2090 ** 08 0b Secondary Bus Address Parity Error: This bit dictates bridge behavior 2091 ** when it detects an address parity error on the secondary bus. 2092 ** 0b=bridge asserts P_SERR#. 2093 ** 1b=bridge does not assert P_SERR# 2094 ** 07 0b Downstream Delayed Transaction Discard Timer Expired: Dictates bridge behavior in response to 2095 ** its discarding of a delayed transaction that was initiated on the secondary bus. 2096 ** 0b=bridge asserts P_SERR#. 2097 ** 1b=bridge does not assert P_SERR# 2098 ** 06 0b Downstream Delayed/Split Read Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer. 2099 ** 0b=bridge asserts P_SERR#. 2100 ** 1b=bridge does not assert P_SERR# 2101 ** 05 0b Downstream Delayed/Split Write Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer. 2102 ** 0b=bridge asserts P_SERR#. 2103 ** 1b=bridge does not assert P_SERR# 2104 ** 04 0b Master Abort during Downstream Posted Write: Dictates bridge behavior following 2105 ** its having detected a Master Abort while attempting to retire one of its PMWs downstream. 2106 ** 0b=bridge asserts P_SERR#. 2107 ** 1b=bridge does not assert P_SERR# 2108 ** 03 0b Target Abort during Downstream Posted Write: Dictates bridge behavior following 2109 ** its having been terminated with Target Abort while attempting to retire one of its PMWs downstream. 2110 ** 0b=bridge asserts P_SERR#. 2111 ** 1b=bridge does not assert P_SERR# 2112 ** 02 0b Downstream Posted Write Data Discarded: Dictates bridge behavior in the event 2113 ** that it discards a downstream posted write transaction. 2114 ** 0b=bridge asserts P_SERR#. 2115 ** 1b=bridge does not assert P_SERR# 2116 ** 01 0b Downstream Posted Write Data Parity Error: Dictates bridge behavior 2117 ** when a data parity error is detected while attempting to retire on of its PMWs downstream. 2118 ** 0b=bridge asserts P_SERR#. 2119 ** 1b=bridge does not assert P_SERR# 2120 ** 00 0b Primary Bus Address Parity Error: This bit dictates bridge behavior 2121 ** when it detects an address parity error on the primary bus. 2122 ** 0b=bridge asserts P_SERR#. 2123 ** 1b=bridge does not assert P_SERR# 2124 **=============================================================================== 2125 ** 0x56: Pre-Boot Status Register - PBSR 2126 ** Bit Default Description 2127 ** 07 1 Reserved 2128 ** 06 - Reserved - value indeterminate 2129 ** 05:02 0 Reserved 2130 ** 01 Varies with External State of S_133EN at PCI Bus Reset Secondary Bus Max Frequency Setting: 2131 ** This bit reflect captured S_133EN strap, 2132 ** indicating the maximum secondary bus clock frequency when in PCI-X mode. 2133 ** Max Allowable Secondary Bus Frequency 2134 ** ** S_133EN PCI-X Mode 2135 ** ** 0 100 MHz 2136 ** ** 1 133 MH 2137 ** 00 0b Reserved 2138 **=============================================================================== 2139 ** 0x59-0x58: Secondary Decode Enable Register - SDER 2140 ** Bit Default Description 2141 ** 15:03 FFF1h Preserved. 2142 ** 02 Varies with External State of PRIVMEM at PCI Bus Reset Private Memory Space Enable - when set, 2143 ** bridge overrides its secondary inverse decode logic and not 2144 ** forward upstream any secondary bus initiated DAC Memory transactions with AD(63)=1b. 2145 ** This creates a private memory space on the Secondary PCI bus 2146 ** that allows peer-to-peer transactions. 2147 ** 01:00 10 2 Preserved. 2148 **=============================================================================== 2149 ** 0x5D-0x5C: Secondary IDSEL Select Register - SISR 2150 ** Bit Default Description 2151 ** 15:10 000000 2 Reserved. 2152 ** 09 Varies with External State of PRIVDEV at PCI Bus Reset AD25- IDSEL Disable - When this bit is set, 2153 ** AD25 is deasserted for any possible Type 1 to Type 0 conversion. 2154 ** When this bit is clear, 2155 ** AD25 is asserted when Primary addresses AD[15:11]=01001 2 during a Type 1 to Type 0 conversion. 2156 ** 08 Varies with External State of PRIVDEV at PCI Bus Reset AD24- IDSEL Disable - When this bit is set, 2157 ** AD24 is deasserted for any possible Type 1 to Type 0 conversion. 2158 ** When this bit is clear, 2159 ** AD24 is asserted when Primary addresses AD[15:11]=01000 2 during a Type 1 to Type 0 conversion. 2160 ** 07 Varies with External State of PRIVDEV at PCI Bus Reset AD23- IDSEL Disable - When this bit is set, 2161 ** AD23 is deasserted for any possible Type 1 to Type 0 conversion. 2162 ** When this bit is clear, 2163 ** AD23 is asserted when Primary addresses AD[15:11]=00111 2 during a Type 1 to Type 0 conversion. 2164 ** 06 Varies with External State of PRIVDEV at PCI Bus Reset AD22- IDSEL Disable - When this bit is set, 2165 ** AD22 is deasserted for any possible Type 1 to Type 0 conversion. 2166 ** When this bit is clear, 2167 ** AD22 is asserted when Primary addresses AD[15:11]=00110 2 during a Type 1 to Type 0 conversion. 2168 ** 05 Varies with External State of PRIVDEV at PCI Bus Reset AD21- IDSEL Disable - When this bit is set, 2169 ** AD21 is deasserted for any possible Type 1 to Type 0 conversion. 2170 ** When this bit is clear, 2171 ** AD21 is asserted when Primary addresses AD[15:11]=00101 2 during a Type 1 to Type 0 conversion. 2172 ** 04 Varies with External State of PRIVDEV at PCI Bus Reset AD20- IDSEL Disable - When this bit is set, 2173 ** AD20 is deasserted for any possible Type 1 to Type 0 conversion. 2174 ** When this bit is clear, 2175 ** AD20 is asserted when Primary addresses AD[15:11]=00100 2 during a Type 1 to Type 0 conversion. 2176 ** 03 Varies with External State of PRIVDEV at PCI Bus Reset AD19- IDSEL Disable - When this bit is set, 2177 ** AD19 is deasserted for any possible Type 1 to Type 0 conversion. 2178 ** When this bit is clear, 2179 ** AD19 is asserted when Primary addresses AD[15:11]=00011 2 during a Type 1 to Type 0 conversion. 2180 ** 02 Varies with External State of PRIVDEV at PCI Bus Reset AD18- IDSEL Disable - When this bit is set, 2181 ** AD18 is deasserted for any possible Type 1 to Type 0 conversion. 2182 ** When this bit is clear, 2183 ** AD18 is asserted when Primary addresses AD[15:11]=00010 2 during a Type 1 to Type 0 conversion. 2184 ** 01 Varies with External State of PRIVDEV at PCI Bus Reset AD17- IDSEL Disable - When this bit is set, 2185 ** AD17 is deasserted for any possible Type 1 to Type 0 conversion. 2186 ** When this bit is clear, 2187 ** AD17 is asserted when Primary addresses AD[15:11]=00001 2 during a Type 1 to Type 0 conversion. 2188 ** 00 Varies with External State of PRIVDEV at PCI Bus Reset AD16- IDSEL Disable - When this bit is set, 2189 ** AD16 is deasserted for any possible Type 1 to Type 0 conversion. 2190 ** When this bit is clear, 2191 ** AD16 is asserted when Primary addresses AD[15:11]=00000 2 during a Type 1 to Type 0 conversion. 2192 ************************************************************************** 2193 */ 2194 /* 2195 ************************************************************************** 2196 ** Reserved A8-CBh 2197 ************************************************************************** 2198 */ 2199 /* 2200 ************************************************************************** 2201 ** PCI Extended Enhanced Capabilities List CC-FFh 2202 ************************************************************************** 2203 ** ---------------------------------------------------------------------------------------------------------- 2204 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset 2205 ** ---------------------------------------------------------------------------------------------------------- 2206 ** | Power Management Capabilities | Next Item Ptr | Capability ID | DCh 2207 ** ---------------------------------------------------------------------------------------------------------- 2208 ** | PM Data | PPB Support | Extensions Power Management CSR | E0h 2209 ** ---------------------------------------------------------------------------------------------------------- 2210 ** | Reserved | Reserved | Reserved | E4h 2211 ** ---------------------------------------------------------------------------------------------------------- 2212 ** | Reserved | E8h 2213 ** ---------------------------------------------------------------------------------------------------------- 2214 ** | Reserved | Reserved | Reserved | Reserved | ECh 2215 ** ---------------------------------------------------------------------------------------------------------- 2216 ** | PCI-X Secondary Status | Next Item Ptr | Capability ID | F0h 2217 ** ---------------------------------------------------------------------------------------------------------- 2218 ** | PCI-X Bridge Status | F4h 2219 ** ---------------------------------------------------------------------------------------------------------- 2220 ** | PCI-X Upstream Split Transaction Control | F8h 2221 ** ---------------------------------------------------------------------------------------------------------- 2222 ** | PCI-X Downstream Split Transaction Control | FCh 2223 ** ---------------------------------------------------------------------------------------------------------- 2224 **=============================================================================== 2225 ** 0xDC: Power Management Capabilities Identifier - PM_CAPID 2226 ** Bit Default Description 2227 ** 07:00 01h Identifier (ID): PCI SIG assigned ID for PCI-PM register block 2228 **=============================================================================== 2229 ** 0xDD: Next Item Pointer - PM_NXTP 2230 ** Bit Default Description 2231 ** 07:00 F0H Next Capabilities Pointer (PTR): The register defaults to F0H pointing to the PCI-X Extended Capability Header. 2232 **=============================================================================== 2233 ** 0xDF-0xDE: Power Management Capabilities Register - PMCR 2234 ** Bit Default Description 2235 ** 15:11 00h PME Supported (PME): PME# cannot be asserted by bridge. 2236 ** 10 0h State D2 Supported (D2): Indicates no support for state D2. No power management action in this state. 2237 ** 09 1h State D1 Supported (D1): Indicates support for state D1. No power management action in this state. 2238 ** 08:06 0h Auxiliary Current (AUXC): This 3 bit field reports the 3.3Vaux auxiliary current requirements for the PCI function. 2239 ** This returns 000b as PME# wake-up for bridge is not implemented. 2240 ** 05 0 Special Initialization Required (SINT): Special initialization is not required for bridge. 2241 ** 04:03 00 Reserved 2242 ** 02:00 010 Version (VS): Indicates that this supports PCI Bus Power Management Interface Specification, Revision 1.1. 2243 **=============================================================================== 2244 ** 0xE1-0xE0: Power Management Control / Status - Register - PMCSR 2245 ** Bit Default Description 2246 ** 15:09 00h Reserved 2247 ** 08 0b PME_Enable: This bit, when set to 1b enables bridge to assert PME#. 2248 ** 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. 2249 ** 07:02 00h Reserved 2250 ** 01:00 00 Power State (PSTATE): This 2-bit field is used both to determine the current power state of 2251 ** a function and to set the Function into a new power state. 2252 ** 00 - D0 state 2253 ** 01 - D1 state 2254 ** 10 - D2 state 2255 ** 11 - D3 hot state 2256 **=============================================================================== 2257 ** 0xE2: Power Management Control / Status PCI to PCI Bridge Support - PMCSR_BSE 2258 ** Bit Default Description 2259 ** 07 0 Bus Power/Clock Control Enable (BPCC_En): Indicates that the bus power/clock control policies have been disabled. 2260 ** 06 0 B2/B3 support for D3 Hot (B2_B3#): The state of this bit determines the action that 2261 ** is to occur as a direct result of programming the function to D3 hot. 2262 ** This bit is only meaningful when bit 7 (BPCC_En) is a ��1��. 2263 ** 05:00 00h Reserved 2264 **=============================================================================== 2265 ** 0xE3: Power Management Data Register - PMDR 2266 ** Bit Default Description 2267 ** 07:00 00h Reserved 2268 **=============================================================================== 2269 ** 0xF0: PCI-X Capabilities Identifier - PX_CAPID 2270 ** Bit Default Description 2271 ** 07:00 07h Identifier (ID): Indicates this is a PCI-X capabilities list. 2272 **=============================================================================== 2273 ** 0xF1: Next Item Pointer - PX_NXTP 2274 ** Bit Default Description 2275 ** 07:00 00h Next Item Pointer: Points to the next capability in the linked list The power on default value of this 2276 ** register is 00h indicating that this is the last entry in the linked list of capabilities. 2277 **=============================================================================== 2278 ** 0xF3-0xF2: PCI-X Secondary Status - PX_SSTS 2279 ** Bit Default Description 2280 ** 15:09 00h Reserved 2281 ** 08:06 Xxx Secondary Clock Frequency (SCF): This field is set with the frequency of the secondary bus. 2282 ** The values are: 2283 ** ** BitsMax FrequencyClock Period 2284 ** ** 000PCI ModeN/A 2285 ** ** 00166 15 2286 ** ** 01010010 2287 ** ** 0111337.5 2288 ** ** 1xxreservedreserved 2289 ** ** The default value for this register is the operating frequency of the secondary bus 2290 ** 05 0b Split Request Delayed. (SRD): This bit is supposed to be set by a bridge when it cannot forward a transaction on the 2291 ** secondary bus to the primary bus because there is not enough room within the limit 2292 ** specified in the Split Transaction Commitment Limit field in the Downstream Split 2293 ** Transaction Control register. The bridge does not set this bit. 2294 ** 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. 2295 ** The bridge does not set this bit. 2296 ** 03 0b Unexpected Split Completion (USC): This bit is set when an unexpected split completion with a requester ID 2297 ** equal to bridge secondary bus number, device number 00h, 2298 ** and function number 0 is received on the secondary interface. 2299 ** This bit is cleared by software writing a '1'. 2300 ** 02 0b Split Completion Discarded (SCD): This bit is set 2301 ** when bridge discards a split completion moving toward the secondary bus 2302 ** because the requester would not accept it. This bit cleared by software writing a '1'. 2303 ** 01 1b 133 MHz Capable: Indicates that bridge is capable of running its secondary bus at 133 MHz 2304 ** 00 1b 64-bit Device (D64): Indicates the width of the secondary bus as 64-bits. 2305 **=============================================================================== 2306 ** 0xF7-0xF6-0xf5-0xF4: PCI-X Bridge Status - PX_BSTS 2307 ** Bit Default Description 2308 ** 31:22 0 Reserved 2309 ** 21 0 Split Request Delayed (SRD): This bit does not be set by bridge. 2310 ** 20 0 Split Completion Overrun (SCO): This bit does not be set by bridge 2311 ** because bridge throttles traffic on the completion side. 2312 ** 19 0 Unexpected Split Completion (USC): The bridge sets this bit to 1b 2313 ** when it encounters a corrupted Split Completion, possibly with an ** ** inconsistent remaining byte count.Software clears 2314 ** this bit by writing a 1b to it. 2315 ** 18 0 Split Completion Discarded (SCD): The bridge sets this bit to 1b 2316 ** when it has discarded a Split Completion.Software clears this bit by ** ** writing a 1b to it. 2317 ** 17 1 133 MHz Capable: This bit indicates that the bridge primary interface is ** capable of 133 MHz operation in PCI-X mode. 2318 ** 0=The maximum operating frequency is 66 MHz. 2319 ** 1=The maximum operating frequency is 133 MHz. 2320 ** 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. 2321 ** 0=Primary Interface is connected as a 32-bit PCI bus. 2322 ** 1=Primary Interface is connected as a 64-bit PCI bus. 2323 ** 15:08 00h Bus Number (BNUM): This field is simply an alias to the PBN field 2324 ** of the BNUM register at offset 18h. 2325 ** Apparently it was deemed necessary reflect it here for diagnostic purposes. 2326 ** 07:03 1fh Device Number (DNUM): Indicates which IDSEL bridge consumes. 2327 ** May be updated whenever a PCI-X 2328 ** configuration write cycle that targets bridge scores a hit. 2329 ** 02:00 0h Function Number (FNUM): The bridge Function # 2330 **=============================================================================== 2331 ** 0xFB-0xFA-0xF9-0xF8: PCI-X Upstream Split Transaction Control - PX_USTC 2332 ** Bit Default Description 2333 ** 31:16 003Eh Split Transaction Limit (STL): This register indicates the size of the commitment limit in units of ADQs. 2334 ** Software is permitted to program this register to any value greater than or equal to 2335 ** the contents of the Split Transaction Capacity register. A value less than the contents 2336 ** of the Split Transaction Capacity register causes unspecified results. 2337 ** A value of 003Eh or greater enables the bridge to forward all Split Requests of any 2338 ** size regardless of the amount of buffer space available. 2339 ** 15:00 003Eh Split Transaction Capacity (STC): This read-only field indicates the size of the buffer (number of ADQs) for storing 2340 ** split completions. This register controls behavior of the bridge buffers for forwarding 2341 ** Split Transactions from a primary bus requester to a secondary bus completer. 2342 ** The default value of 003Eh indicates there is available buffer space for 62 ADQs (7936 bytes). 2343 **=============================================================================== 2344 ** 0xFF-0xFE-0xFD-0xFC: PCI-X Downstream Split Transaction Control - PX_DSTC 2345 ** Bit Default Description 2346 ** 31:16 003Eh Split Transaction Limit (STL): This register indicates the size of the commitment limit in units of ADQs. 2347 ** Software is permitted to program this register to any value greater than or equal to 2348 ** the contents of the Split Transaction Capacity register. A value less than the contents 2349 ** of the Split Transaction Capacity register causes unspecified results. 2350 ** A value of 003Eh or greater enables the bridge to forward all Split Requests of any 2351 ** size regardless of the amount of buffer space available. 2352 ** 15:00 003Eh Split Transaction Capacity (STC): This read-only field indicates the size of the buffer (number of ADQs) for storing 2353 ** split completions. This register controls behavior of the bridge buffers for forwarding 2354 ** Split Transactions from a primary bus requester to a secondary bus completer. 2355 ** The default value of 003Eh indicates there is available buffer space for 62 ADQs 2356 ** (7936 bytes). 2357 ************************************************************************** 2358 */ 2359 2360 2361 2362 2363 /* 2364 ************************************************************************************************************************************* 2365 ** 80331 Address Translation Unit Register Definitions 2366 ** ATU Interface Configuration Header Format 2367 ** The ATU is programmed via a [Type 0] configuration command on the PCI interface. 2368 ************************************************************************************************************************************* 2369 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configuration Byte Offset 2370 **=================================================================================================================================== 2371 ** | ATU Device ID | Vendor ID | 00h 2372 ** ---------------------------------------------------------------------------------------------------------- 2373 ** | Status | Command | 04H 2374 ** ---------------------------------------------------------------------------------------------------------- 2375 ** | ATU Class Code | Revision ID | 08H 2376 ** ---------------------------------------------------------------------------------------------------------- 2377 ** | ATUBISTR | Header Type | Latency Timer | Cacheline Size | 0CH 2378 ** ---------------------------------------------------------------------------------------------------------- 2379 ** | Inbound ATU Base Address 0 | 10H 2380 ** ---------------------------------------------------------------------------------------------------------- 2381 ** | Inbound ATU Upper Base Address 0 | 14H 2382 ** ---------------------------------------------------------------------------------------------------------- 2383 ** | Inbound ATU Base Address 1 | 18H 2384 ** ---------------------------------------------------------------------------------------------------------- 2385 ** | Inbound ATU Upper Base Address 1 | 1CH 2386 ** ---------------------------------------------------------------------------------------------------------- 2387 ** | Inbound ATU Base Address 2 | 20H 2388 ** ---------------------------------------------------------------------------------------------------------- 2389 ** | Inbound ATU Upper Base Address 2 | 24H 2390 ** ---------------------------------------------------------------------------------------------------------- 2391 ** | Reserved | 28H 2392 ** ---------------------------------------------------------------------------------------------------------- 2393 ** | ATU Subsystem ID | ATU Subsystem Vendor ID | 2CH 2394 ** ---------------------------------------------------------------------------------------------------------- 2395 ** | Expansion ROM Base Address | 30H 2396 ** ---------------------------------------------------------------------------------------------------------- 2397 ** | Reserved Capabilities Pointer | 34H 2398 ** ---------------------------------------------------------------------------------------------------------- 2399 ** | Reserved | 38H 2400 ** ---------------------------------------------------------------------------------------------------------- 2401 ** | Maximum Latency | Minimum Grant | Interrupt Pin | Interrupt Line | 3CH 2402 ** ---------------------------------------------------------------------------------------------------------- 2403 ********************************************************************************************************************* 2404 */ 2405 /* 2406 *********************************************************************************** 2407 ** ATU Vendor ID Register - ATUVID 2408 ** ----------------------------------------------------------------- 2409 ** Bit Default Description 2410 ** 15:00 8086H (0x17D3) ATU Vendor ID - This is a 16-bit value assigned to Intel. 2411 ** This register, combined with the DID, uniquely identify the PCI device. 2412 ** Access type is Read/Write to allow the 80331 to configure the register as a different vendor ID 2413 ** to simulate the interface of a standard mechanism currently used by existing application software. 2414 *********************************************************************************** 2415 */ 2416 #define ARCMSR_ATU_VENDOR_ID_REG 0x00 /*word*/ 2417 /* 2418 *********************************************************************************** 2419 ** ATU Device ID Register - ATUDID 2420 ** ----------------------------------------------------------------- 2421 ** Bit Default Description 2422 ** 15:00 0336H (0x1110) ATU Device ID - This is a 16-bit value assigned to the ATU. 2423 ** This ID, combined with the VID, uniquely identify any PCI device. 2424 *********************************************************************************** 2425 */ 2426 #define ARCMSR_ATU_DEVICE_ID_REG 0x02 /*word*/ 2427 /* 2428 *********************************************************************************** 2429 ** ATU Command Register - ATUCMD 2430 ** ----------------------------------------------------------------- 2431 ** Bit Default Description 2432 ** 15:11 000000 2 Reserved 2433 ** 10 0 Interrupt Disable - This bit disables 80331 from asserting the ATU interrupt signal. 2434 ** 0=enables the assertion of interrupt signal. 2435 ** 1=disables the assertion of its interrupt signal. 2436 ** 09 0 2 Fast Back to Back Enable - When cleared, 2437 ** the ATU interface is not allowed to generate fast back-to-back cycles on its bus. 2438 ** Ignored when operating in the PCI-X mode. 2439 ** 08 0 2 SERR# Enable - When cleared, the ATU interface is not allowed to assert SERR# on the PCI interface. 2440 ** 07 1 2 Address/Data Stepping Control - Address stepping is implemented for configuration transactions. The 2441 ** ATU inserts 2 clock cycles of address stepping for Conventional Mode and 4 clock cycles 2442 ** of address stepping for PCI-X mode. 2443 ** 06 0 2 Parity Error Response - When set, the ATU takes normal action when a parity error 2444 ** is detected. When cleared, parity checking is disabled. 2445 ** 05 0 2 VGA Palette Snoop Enable - The ATU interface does not support I/O writes and therefore, 2446 ** does not perform VGA palette snooping. 2447 ** 04 0 2 Memory Write and Invalidate Enable - When set, ATU may generate MWI commands. 2448 ** When clear, ATU use Memory Write commands instead of MWI. Ignored when operating in the PCI-X mode. 2449 ** 03 0 2 Special Cycle Enable - The ATU interface does not respond to special cycle commands in any way. 2450 ** Not implemented and a reserved bit field. 2451 ** 02 0 2 Bus Master Enable - The ATU interface can act as a master on the PCI bus. 2452 ** When cleared, disables the device from generating PCI accesses. 2453 ** When set, allows the device to behave as a PCI bus master. 2454 ** When operating in the PCI-X mode, ATU initiates a split completion transaction regardless 2455 ** of the state of this bit. 2456 ** 01 0 2 Memory Enable - Controls the ATU interface��s response to PCI memory addresses. 2457 ** When cleared, the ATU interface does not respond to any memory access on the PCI bus. 2458 ** 00 0 2 I/O Space Enable - Controls the ATU interface response to I/O transactions. 2459 ** Not implemented and a reserved bit field. 2460 *********************************************************************************** 2461 */ 2462 #define ARCMSR_ATU_COMMAND_REG 0x04 /*word*/ 2463 /* 2464 *********************************************************************************** 2465 ** ATU Status Register - ATUSR (Sheet 1 of 2) 2466 ** ----------------------------------------------------------------- 2467 ** Bit Default Description 2468 ** 15 0 2 Detected Parity Error - set when a parity error is detected in data received by the ATU on the PCI bus even 2469 ** when the ATUCMD register��s Parity Error Response bit is cleared. Set under the following conditions: 2470 ** �E Write Data Parity Error when the ATU is a target (inbound write). 2471 ** �E Read Data Parity Error when the ATU is a requester (outbound read). 2472 ** �E Any Address or Attribute (PCI-X Only) Parity Error on the Bus ** ** ** (including one generated by the ATU). 2473 ** 14 0 2 SERR# Asserted - set when SERR# is asserted on the PCI bus by the ATU. 2474 ** 13 0 2 Master Abort - set when a transaction initiated by the ATU PCI master interface, ends in a Master-Abort 2475 ** or when the ATU receives a Master Abort Split Completion Error Message in PCI-X mode. 2476 ** 12 0 2 Target Abort (master) - set when a transaction initiated by the ATU PCI master interface, ends in a target 2477 ** abort or when the ATU receives a Target Abort Split Completion Error Message in PCI-X mode. 2478 ** 11 0 2 Target Abort (target) - set when the ATU interface, acting as a target, 2479 ** terminates the transaction on the PCI bus with a target abort. 2480 ** 10:09 01 2 DEVSEL# Timing - These bits are read-only and define the slowest DEVSEL# 2481 ** timing for a target device in Conventional PCI Mode regardless of the operating mode 2482 ** (except configuration accesses). 2483 ** 00 2=Fast 2484 ** 01 2=Medium 2485 ** 10 2=Slow 2486 ** 11 2=Reserved 2487 ** The ATU interface uses Medium timing. 2488 ** 08 0 2 Master Parity Error - The ATU interface sets this bit under the following conditions: 2489 ** �E The ATU asserted PERR# itself or the ATU observed PERR# asserted. 2490 ** �E And the ATU acted as the requester 2491 ** for the operation in which the error occurred. 2492 ** �E And the ATUCMD register��s Parity Error Response bit is set 2493 ** �E Or (PCI-X Mode Only) the ATU received a Write Data Parity Error Message 2494 ** �E And the ATUCMD register��s Parity Error Response bit is set 2495 ** 07 1 2 (Conventional mode) 2496 ** 0 2 (PCI-X mode) 2497 ** Fast Back-to-Back - The ATU/Messaging Unit interface is capable of accepting fast back-to-back 2498 ** transactions in Conventional PCI mode when the transactions are not to the same target. Since fast 2499 ** back-to-back transactions do not exist in PCI-X mode, this bit is forced to 0 in the PCI-X mode. 2500 ** 06 0 2 UDF Supported - User Definable Features are not supported 2501 ** 05 1 2 66 MHz. Capable - 66 MHz operation is supported. 2502 ** 04 1 2 Capabilities - When set, this function implements extended capabilities. 2503 ** 03 0 Interrupt Status - reflects the state of the ATU interrupt 2504 ** when the Interrupt Disable bit in the command register is a 0. 2505 ** 0=ATU interrupt signal deasserted. 2506 ** 1=ATU interrupt signal asserted. 2507 ** NOTE: Setting the Interrupt Disable bit to a 1 has no effect on the state of this bit. Refer to 2508 ** Section 3.10.23, ��ATU Interrupt Pin Register - ATUIPR�� on page 236 for details on the ATU 2509 ** interrupt signal. 2510 ** 02:00 00000 2 Reserved. 2511 *********************************************************************************** 2512 */ 2513 #define ARCMSR_ATU_STATUS_REG 0x06 /*word*/ 2514 /* 2515 *********************************************************************************** 2516 ** ATU Revision ID Register - ATURID 2517 ** ----------------------------------------------------------------- 2518 ** Bit Default Description 2519 ** 07:00 00H ATU Revision - identifies the 80331 revision number. 2520 *********************************************************************************** 2521 */ 2522 #define ARCMSR_ATU_REVISION_REG 0x08 /*byte*/ 2523 /* 2524 *********************************************************************************** 2525 ** ATU Class Code Register - ATUCCR 2526 ** ----------------------------------------------------------------- 2527 ** Bit Default Description 2528 ** 23:16 05H Base Class - Memory Controller 2529 ** 15:08 80H Sub Class - Other Memory Controller 2530 ** 07:00 00H Programming Interface - None defined 2531 *********************************************************************************** 2532 */ 2533 #define ARCMSR_ATU_CLASS_CODE_REG 0x09 /*3bytes 0x0B,0x0A,0x09*/ 2534 /* 2535 *********************************************************************************** 2536 ** ATU Cacheline Size Register - ATUCLSR 2537 ** ----------------------------------------------------------------- 2538 ** Bit Default Description 2539 ** 07:00 00H ATU Cacheline Size - specifies the system cacheline size in DWORDs. Cacheline size is restricted to either 0, 8 or 16 DWORDs. 2540 *********************************************************************************** 2541 */ 2542 #define ARCMSR_ATU_CACHELINE_SIZE_REG 0x0C /*byte*/ 2543 /* 2544 *********************************************************************************** 2545 ** ATU Latency Timer Register - ATULT 2546 ** ----------------------------------------------------------------- 2547 ** Bit Default Description 2548 ** 07:03 00000 2 (for Conventional mode) 2549 ** 01000 2 (for PCI-X mode) 2550 ** Programmable Latency Timer - This field varies the latency timer for the interface from 0 to 248 clocks. 2551 ** The default value is 0 clocks for Conventional PCI mode, and 64 clocks for PCI-X mode. 2552 ** 02:00 000 2 Latency Timer Granularity - These Bits are read only giving a programmable granularity of 8 clocks for the latency timer. 2553 *********************************************************************************** 2554 */ 2555 #define ARCMSR_ATU_LATENCY_TIMER_REG 0x0D /*byte*/ 2556 /* 2557 *********************************************************************************** 2558 ** ATU Header Type Register - ATUHTR 2559 ** ----------------------------------------------------------------- 2560 ** Bit Default Description 2561 ** 07 0 2 Single Function/Multi-Function Device - Identifies the 80331 as a single-function PCI device. 2562 ** 06:00 000000 2 PCI Header Type - This bit field indicates the type of PCI header implemented. The ATU interface 2563 ** header conforms to PCI Local Bus Specification, Revision 2.3. 2564 *********************************************************************************** 2565 */ 2566 #define ARCMSR_ATU_HEADER_TYPE_REG 0x0E /*byte*/ 2567 /* 2568 *********************************************************************************** 2569 ** ATU BIST Register - ATUBISTR 2570 ** 2571 ** The ATU BIST Register controls the functions the Intel XScale core performs when BIST is 2572 ** initiated. This register is the interface between the host processor requesting BIST functions and 2573 ** the 80331 replying with the results from the software implementation of the BIST functionality. 2574 ** ----------------------------------------------------------------- 2575 ** Bit Default Description 2576 ** 07 0 2 BIST Capable - This bit value is always equal to the ATUCR ATU BIST Interrupt Enable bit. 2577 ** 06 0 2 Start BIST - When the ATUCR BIST Interrupt Enable bit is set: 2578 ** Setting this bit generates an interrupt to the Intel XScale core to perform a software BIST function. 2579 ** The Intel XScale core clears this bit when the BIST software has completed with the BIST results 2580 ** found in ATUBISTR register bits [3:0]. 2581 ** When the ATUCR BIST Interrupt Enable bit is clear: 2582 ** Setting this bit does not generate an interrupt to the Intel XScale core and no BIST functions is performed. 2583 ** The Intel XScale core does not clear this bit. 2584 ** 05:04 00 2 Reserved 2585 ** 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): 2586 ** The Intel XScale core places the results of the software BIST in these bits. 2587 ** A nonzero value indicates a device-specific error. 2588 *********************************************************************************** 2589 */ 2590 #define ARCMSR_ATU_BIST_REG 0x0F /*byte*/ 2591 2592 /* 2593 *************************************************************************************** 2594 ** ATU Base Registers and Associated Limit Registers 2595 *************************************************************************************** 2596 ** Base Address Register Limit Register Description 2597 ** Inbound ATU Base Address Register 0 Inbound ATU Limit Register 0 Defines the inbound translation window 0 from the PCI bus. 2598 ** 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. 2599 ** Inbound ATU Base Address Register 1 Inbound ATU Limit Register 1 Defines inbound window 1 from the PCI bus. 2600 ** 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. 2601 ** Inbound ATU Base Address Register 2 Inbound ATU Limit Register 2 Defines the inbound translation window 2 from the PCI bus. 2602 ** 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. 2603 ** Inbound ATU Base Address Register 3 Inbound ATU Limit Register 3 Defines the inbound translation window 3 from the PCI bus. 2604 ** 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. 2605 ** NOTE: This is a private BAR that resides outside of the standard PCI configuration header space (offsets 00H-3FH). 2606 ** 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. 2607 **-------------------------------------------------------------------------------------- 2608 ** ATU Inbound Window 1 is not a translate window. 2609 ** The ATU does not claim any PCI accesses that fall within this range. 2610 ** This window is used to allocate host memory for use by Private Devices. 2611 ** When enabled, the ATU interrupts the Intel XScale core when either the IABAR1 register or the IAUBAR1 register is written from the PCI bus. 2612 *********************************************************************************** 2613 */ 2614 2615 /* 2616 *********************************************************************************** 2617 ** Inbound ATU Base Address Register 0 - IABAR0 2618 ** 2619 ** . The Inbound ATU Base Address Register 0 (IABAR0) together with the Inbound ATU Upper Base Address Register 0 (IAUBAR0) 2620 ** defines the block of memory addresses where the inbound translation window 0 begins. 2621 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory. 2622 ** . The IABAR0 and IAUBAR0 define the base address and describes the required memory block size. 2623 ** . Bits 31 through 12 of the IABAR0 is either read/write bits or read only with a value of 0 2624 ** depending on the value located within the IALR0. 2625 ** This configuration allows the IABAR0 to be programmed per PCI Local Bus Specification. 2626 ** The first 4 Kbytes of memory defined by the IABAR0, IAUBAR0 and the IALR0 is reserved for the Messaging Unit. 2627 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 2628 ** Warning: 2629 ** When IALR0 is cleared prior to host configuration: 2630 ** the user should also clear the Prefetchable Indicator and the Type Indicator. 2631 ** Assuming IALR0 is not cleared: 2632 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary, 2633 ** when the Prefetchable Indicator is cleared prior to host configuration, 2634 ** the user should also set the Type Indicator for 32 bit addressability. 2635 ** b. For compliance to the PCI-X Addendum to the PCI Local Bus Specification, 2636 ** when the Prefetchable Indicator is set prior to host configuration, the user 2637 ** should also set the Type Indicator for 64 bit addressability. 2638 ** This is the default for IABAR0. 2639 ** ----------------------------------------------------------------- 2640 ** Bit Default Description 2641 ** 31:12 00000H Translation Base Address 0 - These bits define the actual location 2642 ** the translation function is to respond to when addressed from the PCI bus. 2643 ** 11:04 00H Reserved. 2644 ** 03 1 2 Prefetchable Indicator - When set, defines the memory space as prefetchable. 2645 ** 02:01 10 2 Type Indicator - Defines the width of the addressability for this memory window: 2646 ** 00 - Memory Window is locatable anywhere in 32 bit address space 2647 ** 10 - Memory Window is locatable anywhere in 64 bit address space 2648 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address. 2649 ** The ATU does not occupy I/O space, 2650 ** thus this bit must be zero. 2651 *********************************************************************************** 2652 */ 2653 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS0_REG 0x10 /*dword 0x13,0x12,0x11,0x10*/ 2654 #define ARCMSR_INBOUND_ATU_MEMORY_PREFETCHABLE 0x08 2655 #define ARCMSR_INBOUND_ATU_MEMORY_WINDOW64 0x04 2656 /* 2657 *********************************************************************************** 2658 ** Inbound ATU Upper Base Address Register 0 - IAUBAR0 2659 ** 2660 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes. 2661 ** Together with the Translation Base Address this register defines the actual location the translation 2662 ** function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs). 2663 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 2664 ** Note: 2665 ** When the Type indicator of IABAR0 is set to indicate 32 bit addressability, 2666 ** the IAUBAR0 register attributes are read-only. 2667 ** ----------------------------------------------------------------- 2668 ** Bit Default Description 2669 ** 31:0 00000H Translation Upper Base Address 0 - Together with the Translation Base Address 0 these bits define the 2670 ** actual location the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes. 2671 *********************************************************************************** 2672 */ 2673 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS0_REG 0x14 /*dword 0x17,0x16,0x15,0x14*/ 2674 /* 2675 *********************************************************************************** 2676 ** Inbound ATU Base Address Register 1 - IABAR1 2677 ** 2678 ** . The Inbound ATU Base Address Register (IABAR1) together with the Inbound ATU Upper Base Address Register 1 (IAUBAR1) 2679 ** defines the block of memory addresses where the inbound translation window 1 begins. 2680 ** . 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. 2681 ** . The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 2682 ** . When enabled, the ATU interrupts the Intel XScale core when the IABAR1 register is written from the PCI bus. 2683 ** Warning: 2684 ** When a non-zero value is not written to IALR1 prior to host configuration, 2685 ** the user should not set either the Prefetchable Indicator or the Type Indicator for 64 bit addressability. 2686 ** This is the default for IABAR1. 2687 ** Assuming a non-zero value is written to IALR1, 2688 ** the user may set the Prefetchable Indicator 2689 ** or the Type Indicator: 2690 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address 2691 ** boundary, when the Prefetchable Indicator is not set prior to host configuration, 2692 ** the user should also leave the Type Indicator set for 32 bit addressability. 2693 ** This is the default for IABAR1. 2694 ** b. when the Prefetchable Indicator is set prior to host configuration, 2695 ** the user should also set the Type Indicator for 64 bit addressability. 2696 ** ----------------------------------------------------------------- 2697 ** Bit Default Description 2698 ** 31:12 00000H Translation Base Address 1 - These bits define the actual location of window 1 on the PCI bus. 2699 ** 11:04 00H Reserved. 2700 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable. 2701 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window: 2702 ** 00 - Memory Window is locatable anywhere in 32 bit address space 2703 ** 10 - Memory Window is locatable anywhere in 64 bit address space 2704 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address. 2705 ** The ATU does not occupy I/O space, 2706 ** thus this bit must be zero. 2707 *********************************************************************************** 2708 */ 2709 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS1_REG 0x18 /*dword 0x1B,0x1A,0x19,0x18*/ 2710 /* 2711 *********************************************************************************** 2712 ** Inbound ATU Upper Base Address Register 1 - IAUBAR1 2713 ** 2714 ** This register contains the upper base address when locating this window for PCI addresses beyond 4 GBytes. 2715 ** Together with the IABAR1 this register defines the actual location for this memory window for addresses > 4GBytes (for DACs). 2716 ** 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. 2717 ** The programmed value within the base address register must comply with the PCI programming 2718 ** requirements for address alignment. 2719 ** When enabled, the ATU interrupts the Intel XScale core when the IAUBAR1 register is written 2720 ** from the PCI bus. 2721 ** Note: 2722 ** When the Type indicator of IABAR1 is set to indicate 32 bit addressability, 2723 ** the IAUBAR1 register attributes are read-only. 2724 ** This is the default for IABAR1. 2725 ** ----------------------------------------------------------------- 2726 ** Bit Default Description 2727 ** 31:0 00000H Translation Upper Base Address 1 - Together with the Translation Base Address 1 2728 ** these bits define the actual location for this memory window on the PCI bus for addresses > 4GBytes. 2729 *********************************************************************************** 2730 */ 2731 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS1_REG 0x1C /*dword 0x1F,0x1E,0x1D,0x1C*/ 2732 /* 2733 *********************************************************************************** 2734 ** Inbound ATU Base Address Register 2 - IABAR2 2735 ** 2736 ** . The Inbound ATU Base Address Register 2 (IABAR2) together with the Inbound ATU Upper Base Address Register 2 (IAUBAR2) 2737 ** defines the block of memory addresses where the inbound translation window 2 begins. 2738 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory. 2739 ** . The IABAR2 and IAUBAR2 define the base address and describes the required memory block size 2740 ** . 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. 2741 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 2742 ** Warning: 2743 ** When a non-zero value is not written to IALR2 prior to host configuration, 2744 ** the user should not set either the Prefetchable Indicator 2745 ** or the Type Indicator for 64 bit addressability. 2746 ** This is the default for IABAR2. 2747 ** Assuming a non-zero value is written to IALR2, 2748 ** the user may set the Prefetchable Indicator 2749 ** or the Type Indicator: 2750 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary, 2751 ** when the Prefetchable Indicator is not set prior to host configuration, 2752 ** the user should also leave the Type Indicator set for 32 bit addressability. 2753 ** This is the default for IABAR2. 2754 ** b. when the Prefetchable Indicator is set prior to host configuration, 2755 ** the user should also set the Type Indicator for 64 bit addressability. 2756 ** ----------------------------------------------------------------- 2757 ** Bit Default Description 2758 ** 31:12 00000H Translation Base Address 2 - These bits define the actual location 2759 ** the translation function is to respond to when addressed from the PCI bus. 2760 ** 11:04 00H Reserved. 2761 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable. 2762 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window: 2763 ** 00 - Memory Window is locatable anywhere in 32 bit address space 2764 ** 10 - Memory Window is locatable anywhere in 64 bit address space 2765 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address. 2766 ** The ATU does not occupy I/O space, 2767 ** thus this bit must be zero. 2768 *********************************************************************************** 2769 */ 2770 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS2_REG 0x20 /*dword 0x23,0x22,0x21,0x20*/ 2771 /* 2772 *********************************************************************************** 2773 ** Inbound ATU Upper Base Address Register 2 - IAUBAR2 2774 ** 2775 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes. 2776 ** Together with the Translation Base Address this register defines the actual location 2777 ** the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs). 2778 ** The programmed value within the base address register must comply with the PCI programming 2779 ** requirements for address alignment. 2780 ** Note: 2781 ** When the Type indicator of IABAR2 is set to indicate 32 bit addressability, 2782 ** the IAUBAR2 register attributes are read-only. 2783 ** This is the default for IABAR2. 2784 ** ----------------------------------------------------------------- 2785 ** Bit Default Description 2786 ** 31:0 00000H Translation Upper Base Address 2 - Together with the Translation Base Address 2 2787 ** these bits define the actual location the translation function is to respond to 2788 ** when addressed from the PCI bus for addresses > 4GBytes. 2789 *********************************************************************************** 2790 */ 2791 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS2_REG 0x24 /*dword 0x27,0x26,0x25,0x24*/ 2792 /* 2793 *********************************************************************************** 2794 ** ATU Subsystem Vendor ID Register - ASVIR 2795 ** ----------------------------------------------------------------- 2796 ** Bit Default Description 2797 ** 15:0 0000H Subsystem Vendor ID - This register uniquely identifies the add-in board or subsystem vendor. 2798 *********************************************************************************** 2799 */ 2800 #define ARCMSR_ATU_SUBSYSTEM_VENDOR_ID_REG 0x2C /*word 0x2D,0x2C*/ 2801 /* 2802 *********************************************************************************** 2803 ** ATU Subsystem ID Register - ASIR 2804 ** ----------------------------------------------------------------- 2805 ** Bit Default Description 2806 ** 15:0 0000H Subsystem ID - uniquely identifies the add-in board or subsystem. 2807 *********************************************************************************** 2808 */ 2809 #define ARCMSR_ATU_SUBSYSTEM_ID_REG 0x2E /*word 0x2F,0x2E*/ 2810 /* 2811 *********************************************************************************** 2812 ** Expansion ROM Base Address Register -ERBAR 2813 ** ----------------------------------------------------------------- 2814 ** Bit Default Description 2815 ** 31:12 00000H Expansion ROM Base Address - These bits define the actual location 2816 ** where the Expansion ROM address window resides when addressed from the PCI bus on any 4 Kbyte boundary. 2817 ** 11:01 000H Reserved 2818 ** 00 0 2 Address Decode Enable - This bit field shows the ROM address 2819 ** decoder is enabled or disabled. When cleared, indicates the address decoder is disabled. 2820 *********************************************************************************** 2821 */ 2822 #define ARCMSR_EXPANSION_ROM_BASE_ADDRESS_REG 0x30 /*dword 0x33,0x32,0v31,0x30*/ 2823 #define ARCMSR_EXPANSION_ROM_ADDRESS_DECODE_ENABLE 0x01 2824 /* 2825 *********************************************************************************** 2826 ** ATU Capabilities Pointer Register - ATU_CAP_PTR 2827 ** ----------------------------------------------------------------- 2828 ** Bit Default Description 2829 ** 07:00 C0H Capability List Pointer - This provides an offset in this function��s configuration space 2830 ** that points to the 80331 PCl Bus Power Management extended capability. 2831 *********************************************************************************** 2832 */ 2833 #define ARCMSR_ATU_CAPABILITY_PTR_REG 0x34 /*byte*/ 2834 /* 2835 *********************************************************************************** 2836 ** Determining Block Sizes for Base Address Registers 2837 ** The required address size and type can be determined by writing ones to a base address register and 2838 ** reading from the registers. By scanning the returned value from the least-significant bit of the base 2839 ** address registers upwards, the programmer can determine the required address space size. The 2840 ** binary-weighted value of the first non-zero bit found indicates the required amount of space. 2841 ** Table 105 describes the relationship between the values read back and the byte sizes the base 2842 ** address register requires. 2843 ** As an example, assume that FFFF.FFFFH is written to the ATU Inbound Base Address Register 0 2844 ** (IABAR0) and the value read back is FFF0.0008H. Bit zero is a zero, so the device requires 2845 ** memory address space. Bit three is one, so the memory does supports prefetching. Scanning 2846 ** upwards starting at bit four, bit twenty is the first one bit found. The binary-weighted value of this 2847 ** bit is 1,048,576, indicated that the device requires 1 Mbyte of memory space. 2848 ** The ATU Base Address Registers and the Expansion ROM Base Address Register use their 2849 ** associated limit registers to enable which bits within the base address register are read/write and 2850 ** which bits are read only (0). This allows the programming of these registers in a manner similar to 2851 ** other PCI devices even though the limit is variable. 2852 ** Table 105. Memory Block Size Read Response 2853 ** Response After Writing all 1s 2854 ** to the Base Address Register 2855 ** Size 2856 ** (Bytes) 2857 ** Response After Writing all 1s 2858 ** to the Base Address Register 2859 ** Size 2860 ** (Bytes) 2861 ** FFFFFFF0H 16 FFF00000H 1 M 2862 ** FFFFFFE0H 32 FFE00000H 2 M 2863 ** FFFFFFC0H 64 FFC00000H 4 M 2864 ** FFFFFF80H 128 FF800000H 8 M 2865 ** FFFFFF00H 256 FF000000H 16 M 2866 ** FFFFFE00H 512 FE000000H 32 M 2867 ** FFFFFC00H 1K FC000000H 64 M 2868 ** FFFFF800H 2K F8000000H 128 M 2869 ** FFFFF000H 4K F0000000H 256 M 2870 ** FFFFE000H 8K E0000000H 512 M 2871 ** FFFFC000H 16K C0000000H 1 G 2872 ** FFFF8000H 32K 80000000H 2 G 2873 ** FFFF0000H 64K 2874 ** 00000000H 2875 ** Register not 2876 ** imple-mented, 2877 ** no 2878 ** address 2879 ** space 2880 ** required. 2881 ** FFFE0000H 128K 2882 ** FFFC0000H 256K 2883 ** FFF80000H 512K 2884 ** 2885 *************************************************************************************** 2886 */ 2887 2888 2889 2890 /* 2891 *********************************************************************************** 2892 ** ATU Interrupt Line Register - ATUILR 2893 ** ----------------------------------------------------------------- 2894 ** Bit Default Description 2895 ** 07:00 FFH Interrupt Assigned - system-assigned value identifies which system interrupt controller��s interrupt 2896 ** request line connects to the device's PCI interrupt request lines 2897 ** (as specified in the interrupt pin register). 2898 ** A value of FFH signifies ��no connection�� or ��unknown��. 2899 *********************************************************************************** 2900 */ 2901 #define ARCMSR_ATU_INTERRUPT_LINE_REG 0x3C /*byte*/ 2902 /* 2903 *********************************************************************************** 2904 ** ATU Interrupt Pin Register - ATUIPR 2905 ** ----------------------------------------------------------------- 2906 ** Bit Default Description 2907 ** 07:00 01H Interrupt Used - A value of 01H signifies that the ATU interface unit uses INTA# as the interrupt pin. 2908 *********************************************************************************** 2909 */ 2910 #define ARCMSR_ATU_INTERRUPT_PIN_REG 0x3D /*byte*/ 2911 /* 2912 *********************************************************************************** 2913 ** ATU Minimum Grant Register - ATUMGNT 2914 ** ----------------------------------------------------------------- 2915 ** Bit Default Description 2916 ** 07:00 80H This register specifies how long a burst period the device needs in increments of 8 PCI clocks. 2917 *********************************************************************************** 2918 */ 2919 #define ARCMSR_ATU_MINIMUM_GRANT_REG 0x3E /*byte*/ 2920 /* 2921 *********************************************************************************** 2922 ** ATU Maximum Latency Register - ATUMLAT 2923 ** ----------------------------------------------------------------- 2924 ** Bit Default Description 2925 ** 07:00 00H Specifies frequency (how often) the device needs to access the PCI bus 2926 ** in increments of 8 PCI clocks. A zero value indicates the device has no stringent requirement. 2927 *********************************************************************************** 2928 */ 2929 #define ARCMSR_ATU_MAXIMUM_LATENCY_REG 0x3F /*byte*/ 2930 /* 2931 *********************************************************************************** 2932 ** Inbound Address Translation 2933 ** 2934 ** The ATU allows external PCI bus initiators to directly access the internal bus. 2935 ** These PCI bus initiators can read or write 80331 memory-mapped registers or 80331 local memory space. 2936 ** The process of inbound address translation involves two steps: 2937 ** 1. Address Detection. 2938 ** �E Determine when the 32-bit PCI address (64-bit PCI address during DACs) is 2939 ** within the address windows defined for the inbound ATU. 2940 ** �E Claim the PCI transaction with medium DEVSEL# timing in the conventional PCI 2941 ** mode and with Decode A DEVSEL# timing in the PCI-X mode. 2942 ** 2. Address Translation. 2943 ** �E Translate the 32-bit PCI address (lower 32-bit PCI address during DACs) to a 32-bit 80331 internal bus address. 2944 ** The ATU uses the following registers in inbound address window 0 translation: 2945 ** �E Inbound ATU Base Address Register 0 2946 ** �E Inbound ATU Limit Register 0 2947 ** �E Inbound ATU Translate Value Register 0 2948 ** The ATU uses the following registers in inbound address window 2 translation: 2949 ** �E Inbound ATU Base Address Register 2 2950 ** �E Inbound ATU Limit Register 2 2951 ** �E Inbound ATU Translate Value Register 2 2952 ** The ATU uses the following registers in inbound address window 3 translation: 2953 ** �E Inbound ATU Base Address Register 3 2954 ** �E Inbound ATU Limit Register 3 2955 ** �E Inbound ATU Translate Value Register 3 2956 ** Note: Inbound Address window 1 is not a translate window. 2957 ** Instead, window 1 may be used to allocate host memory for Private Devices. 2958 ** Inbound Address window 3 does not reside in the standard section of the configuration header (offsets 00H - 3CH), 2959 ** thus the host BIOS does not configure window 3. 2960 ** Window 3 is intended to be used as a special window into local memory for private PCI 2961 ** agents controlled by the 80331 in conjunction with the Private Memory Space of the bridge. 2962 ** PCI-to-PCI Bridge in 80331 or 2963 ** Inbound address detection is determined from the 32-bit PCI address, 2964 ** (64-bit PCI address during DACs) the base address register and the limit register. 2965 ** In the case of DACs none of the upper 32-bits of the address is masked during address comparison. 2966 ** 2967 ** The algorithm for detection is: 2968 ** 2969 ** Equation 1. Inbound Address Detection 2970 ** When (PCI_Address [31:0] & Limit_Register[31:0]) == (Base_Register[31:0] & PCI_Address [63:32]) == Base_Register[63:32] (for DACs only) 2971 ** the PCI Address is claimed by the Inbound ATU. 2972 ** 2973 ** The incoming 32-bit PCI address (lower 32-bits of the address in case of DACs) is bitwise ANDed 2974 ** with the associated inbound limit register. 2975 ** When the result matches the base register (and upper base address matches upper PCI address in case of DACs), 2976 ** the inbound PCI address is detected as being within the inbound translation window and is claimed by the ATU. 2977 ** 2978 ** Note: The first 4 Kbytes of the ATU inbound address translation window 0 are reserved for the Messaging Unit. 2979 ** Once the transaction is claimed, the address must be translated from a PCI address to a 32-bit 2980 ** internal bus address. In case of DACs upper 32-bits of the address is simply discarded and only the 2981 ** lower 32-bits are used during address translation. 2982 ** The algorithm is: 2983 ** 2984 ** 2985 ** Equation 2. Inbound Translation 2986 ** Intel I/O processor Internal Bus Address=(PCI_Address[31:0] & ~Limit_Register[31:0]) | ATU_Translate_Value_Register[31:0]. 2987 ** 2988 ** The incoming 32-bit PCI address (lower 32-bits in case of DACs) is first bitwise ANDed with the 2989 ** bitwise inverse of the limit register. This result is bitwise ORed with the ATU Translate Value and 2990 ** the result is the internal bus address. This translation mechanism is used for all inbound memory 2991 ** read and write commands excluding inbound configuration read and writes. 2992 ** In the PCI mode for inbound memory transactions, the only burst order supported is Linear 2993 ** Incrementing. For any other burst order, the ATU signals a Disconnect after the first data phase. 2994 ** The PCI-X supports linear incrementing only, and hence above situation is not encountered in the PCI-X mode. 2995 ** example: 2996 ** Register Values 2997 ** Base_Register=3A00 0000H 2998 ** Limit_Register=FF80 0000H (8 Mbyte limit value) 2999 ** Value_Register=B100 0000H 3000 ** Inbound Translation Window ranges from 3A00 0000H to 3A7F FFFFH (8 Mbytes) 3001 ** 3002 ** Address Detection (32-bit address) 3003 ** 3004 ** PCI_Address & Limit_Register == Base_Register 3005 ** 3A45 012CH & FF80 0000H == 3A00 0000H 3006 ** 3007 ** ANS: PCI_Address is in the Inbound Translation Window 3008 ** Address Translation (to get internal bus address) 3009 ** 3010 ** IB_Address=(PCI_Address & ~Limit_Register) | Value_Reg 3011 ** IB_Address=(3A45 012CH & 007F FFFFH) | B100 0000H 3012 ** 3013 ** ANS:IB_Address=B145 012CH 3014 *********************************************************************************** 3015 */ 3016 3017 3018 3019 /* 3020 *********************************************************************************** 3021 ** Inbound ATU Limit Register 0 - IALR0 3022 ** 3023 ** Inbound address translation for memory window 0 occurs for data transfers occurring from the PCI 3024 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts 3025 ** PCI addresses to internal bus addresses. 3026 ** The 80331 translate value register��s programmed value must be naturally aligned with the base 3027 ** address register��s programmed value. The limit register is used as a mask; thus, the lower address 3028 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus 3029 ** Specification, Revision 2.3 for additional information on programming base address registers. 3030 ** Bits 31 to 12 within the IALR0 have a direct effect on the IABAR0 register, bits 31 to 12, with a 3031 ** one to one correspondence. A value of 0 in a bit within the IALR0 makes the corresponding bit 3032 ** within the IABAR0 a read only bit which always returns 0. A value of 1 in a bit within the IALR0 3033 ** makes the corresponding bit within the IABAR0 read/write from PCI. Note that a consequence of 3034 ** this programming scheme is that unless a valid value exists within the IALR0, all writes to the 3035 ** IABAR0 has no effect since a value of all zeros within the IALR0 makes the IABAR0 a read only register. 3036 ** ----------------------------------------------------------------- 3037 ** Bit Default Description 3038 ** 31:12 FF000H Inbound Translation Limit 0 - This readback value determines the memory block size required for 3039 ** inbound memory window 0 of the address translation unit. This defaults to an inbound window of 16MB. 3040 ** 11:00 000H Reserved 3041 *********************************************************************************** 3042 */ 3043 #define ARCMSR_INBOUND_ATU_LIMIT0_REG 0x40 /*dword 0x43,0x42,0x41,0x40*/ 3044 /* 3045 *********************************************************************************** 3046 ** Inbound ATU Translate Value Register 0 - IATVR0 3047 ** 3048 ** The Inbound ATU Translate Value Register 0 (IATVR0) contains the internal bus address used to 3049 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the 3050 ** inbound ATU address translation. 3051 ** ----------------------------------------------------------------- 3052 ** Bit Default Description 3053 ** 31:12 FF000H Inbound ATU Translation Value 0 - This value is used to convert the PCI address to internal bus addresses. 3054 ** This value must be 64-bit aligned on the internal bus. 3055 ** The default address allows the ATU to access the internal 80331 memory-mapped registers. 3056 ** 11:00 000H Reserved 3057 *********************************************************************************** 3058 */ 3059 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE0_REG 0x44 /*dword 0x47,0x46,0x45,0x44*/ 3060 /* 3061 *********************************************************************************** 3062 ** Expansion ROM Limit Register - ERLR 3063 ** 3064 ** The Expansion ROM Limit Register (ERLR) defines the block size of addresses the ATU defines 3065 ** as Expansion ROM address space. The block size is programmed by writing a value into the ERLR. 3066 ** Bits 31 to 12 within the ERLR have a direct effect on the ERBAR register, bits 31 to 12, with a one 3067 ** to one correspondence. A value of 0 in a bit within the ERLR makes the corresponding bit within 3068 ** the ERBAR a read only bit which always returns 0. A value of 1 in a bit within the ERLR makes 3069 ** the corresponding bit within the ERBAR read/write from PCI. 3070 ** ----------------------------------------------------------------- 3071 ** Bit Default Description 3072 ** 31:12 000000H Expansion ROM Limit - Block size of memory required for the Expansion ROM translation unit. Default 3073 ** value is 0, which indicates no Expansion ROM address space and all bits within the ERBAR are read only with a value of 0. 3074 ** 11:00 000H Reserved. 3075 *********************************************************************************** 3076 */ 3077 #define ARCMSR_EXPANSION_ROM_LIMIT_REG 0x48 /*dword 0x4B,0x4A,0x49,0x48*/ 3078 /* 3079 *********************************************************************************** 3080 ** Expansion ROM Translate Value Register - ERTVR 3081 ** 3082 ** The Expansion ROM Translate Value Register contains the 80331 internal bus address which the 3083 ** ATU converts the PCI bus access. This address is driven on the internal bus as a result of the 3084 ** Expansion ROM address translation. 3085 ** ----------------------------------------------------------------- 3086 ** Bit Default Description 3087 ** 31:12 00000H Expansion ROM Translation Value - Used to convert PCI addresses to 80331 internal bus addresses 3088 ** for Expansion ROM accesses. The Expansion ROM address translation value must be word aligned on the internal bus. 3089 ** 11:00 000H Reserved 3090 *********************************************************************************** 3091 */ 3092 #define ARCMSR_EXPANSION_ROM_TRANSLATE_VALUE_REG 0x4C /*dword 0x4F,0x4E,0x4D,0x4C*/ 3093 /* 3094 *********************************************************************************** 3095 ** Inbound ATU Limit Register 1 - IALR1 3096 ** 3097 ** Bits 31 to 12 within the IALR1 have a direct effect on the IABAR1 register, bits 31 to 12, with a 3098 ** one to one correspondence. A value of 0 in a bit within the IALR1 makes the corresponding bit 3099 ** within the IABAR1 a read only bit which always returns 0. A value of 1 in a bit within the IALR1 3100 ** makes the corresponding bit within the IABAR1 read/write from PCI. Note that a consequence of 3101 ** this programming scheme is that unless a valid value exists within the IALR1, all writes to the 3102 ** IABAR1 has no effect since a value of all zeros within the IALR1 makes the IABAR1 a read only 3103 ** register. 3104 ** The inbound memory window 1 is used merely to allocate memory on the PCI bus. The ATU does 3105 ** not process any PCI bus transactions to this memory range. 3106 ** Warning: The ATU does not claim any PCI accesses that fall within the range defined by IABAR1, 3107 ** IAUBAR1, and IALR1. 3108 ** ----------------------------------------------------------------- 3109 ** Bit Default Description 3110 ** 31:12 00000H Inbound Translation Limit 1 - This readback value determines the memory block size 3111 ** required for the ATUs memory window 1. 3112 ** 11:00 000H Reserved 3113 *********************************************************************************** 3114 */ 3115 #define ARCMSR_INBOUND_ATU_LIMIT1_REG 0x50 /*dword 0x53,0x52,0x51,0x50*/ 3116 /* 3117 *********************************************************************************** 3118 ** Inbound ATU Limit Register 2 - IALR2 3119 ** 3120 ** Inbound address translation for memory window 2 occurs for data transfers occurring from the PCI 3121 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts 3122 ** PCI addresses to internal bus addresses. 3123 ** The inbound translation base address for inbound window 2 is specified in Section 3.10.15. When 3124 ** determining block size requirements �X as described in Section 3.10.21 �X the translation limit 3125 ** register provides the block size requirements for the base address register. The remaining registers 3126 ** used for performing address translation are discussed in Section 3.2.1.1. 3127 ** The 80331 translate value register��s programmed value must be naturally aligned with the base 3128 ** address register��s programmed value. The limit register is used as a mask; thus, the lower address 3129 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus 3130 ** Specification, Revision 2.3 for additional information on programming base address registers. 3131 ** Bits 31 to 12 within the IALR2 have a direct effect on the IABAR2 register, bits 31 to 12, with a 3132 ** one to one correspondence. A value of 0 in a bit within the IALR2 makes the corresponding bit 3133 ** within the IABAR2 a read only bit which always returns 0. A value of 1 in a bit within the IALR2 3134 ** makes the corresponding bit within the IABAR2 read/write from PCI. Note that a consequence of 3135 ** this programming scheme is that unless a valid value exists within the IALR2, all writes to the 3136 ** IABAR2 has no effect since a value of all zeros within the IALR2 makes the IABAR2 a read only 3137 ** register. 3138 ** ----------------------------------------------------------------- 3139 ** Bit Default Description 3140 ** 31:12 00000H Inbound Translation Limit 2 - This readback value determines the memory block size 3141 ** required for the ATUs memory window 2. 3142 ** 11:00 000H Reserved 3143 *********************************************************************************** 3144 */ 3145 #define ARCMSR_INBOUND_ATU_LIMIT2_REG 0x54 /*dword 0x57,0x56,0x55,0x54*/ 3146 /* 3147 *********************************************************************************** 3148 ** Inbound ATU Translate Value Register 2 - IATVR2 3149 ** 3150 ** The Inbound ATU Translate Value Register 2 (IATVR2) contains the internal bus address used to 3151 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the 3152 ** inbound ATU address translation. 3153 ** ----------------------------------------------------------------- 3154 ** Bit Default Description 3155 ** 31:12 00000H Inbound ATU Translation Value 2 - This value is used to convert the PCI address to internal bus addresses. 3156 ** This value must be 64-bit aligned on the internal bus. 3157 ** The default address allows the ATU to access the internal 80331 ** ** memory-mapped registers. 3158 ** 11:00 000H Reserved 3159 *********************************************************************************** 3160 */ 3161 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE2_REG 0x58 /*dword 0x5B,0x5A,0x59,0x58*/ 3162 /* 3163 *********************************************************************************** 3164 ** Outbound I/O Window Translate Value Register - OIOWTVR 3165 ** 3166 ** The Outbound I/O Window Translate Value Register (OIOWTVR) contains the PCI I/O address 3167 ** used to convert the internal bus access to a PCI address. This address is driven on the PCI bus as a 3168 ** result of the outbound ATU address translation. 3169 ** The I/O window is from 80331 internal bus address 9000 000H to 9000 FFFFH with the fixed 3170 ** length of 64 Kbytes. 3171 ** ----------------------------------------------------------------- 3172 ** Bit Default Description 3173 ** 31:16 0000H Outbound I/O Window Translate Value - Used to convert internal bus addresses to PCI addresses. 3174 ** 15:00 0000H Reserved 3175 *********************************************************************************** 3176 */ 3177 #define ARCMSR_OUTBOUND_IO_WINDOW_TRANSLATE_VALUE_REG 0x5C /*dword 0x5F,0x5E,0x5D,0x5C*/ 3178 /* 3179 *********************************************************************************** 3180 ** Outbound Memory Window Translate Value Register 0 -OMWTVR0 3181 ** 3182 ** The Outbound Memory Window Translate Value Register 0 (OMWTVR0) contains the PCI 3183 ** address used to convert 80331 internal bus addresses for outbound transactions. This address is 3184 ** driven on the PCI bus as a result of the outbound ATU address translation. 3185 ** The memory window is from internal bus address 8000 000H to 83FF FFFFH with the fixed length 3186 ** of 64 Mbytes. 3187 ** ----------------------------------------------------------------- 3188 ** Bit Default Description 3189 ** 31:26 00H Outbound MW Translate Value - Used to convert 80331 internal bus addresses to PCI addresses. 3190 ** 25:02 00 0000H Reserved 3191 ** 01:00 00 2 Burst Order - This bit field shows the address sequence during a memory burst. 3192 ** Only linear incrementing mode is supported. 3193 *********************************************************************************** 3194 */ 3195 #define ARCMSR_OUTBOUND_MEMORY_WINDOW_TRANSLATE_VALUE0_REG 0x60 /*dword 0x63,0x62,0x61,0x60*/ 3196 /* 3197 *********************************************************************************** 3198 ** Outbound Upper 32-bit Memory Window Translate Value Register 0 - OUMWTVR0 3199 ** 3200 ** The Outbound Upper 32-bit Memory Window Translate Value Register 0 (OUMWTVR0) defines 3201 ** the upper 32-bits of address used during a dual address cycle. This enables the outbound ATU to 3202 ** directly address anywhere within the 64-bit host address space. When this register is all-zero, then 3203 ** a SAC is generated on the PCI bus. 3204 ** The memory window is from internal bus address 8000 000H to 83FF FFFFH with the fixed 3205 ** length of 64 Mbytes. 3206 ** ----------------------------------------------------------------- 3207 ** Bit Default Description 3208 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC). 3209 *********************************************************************************** 3210 */ 3211 #define ARCMSR_OUTBOUND_UPPER32_MEMORY_WINDOW_TRANSLATE_VALUE0_REG 0x64 /*dword 0x67,0x66,0x65,0x64*/ 3212 /* 3213 *********************************************************************************** 3214 ** Outbound Memory Window Translate Value Register 1 -OMWTVR1 3215 ** 3216 ** The Outbound Memory Window Translate Value Register 1 (OMWTVR1) contains the PCI 3217 ** address used to convert 80331 internal bus addresses for outbound transactions. This address is 3218 ** driven on the PCI bus as a result of the outbound ATU address translation. 3219 ** The memory window is from internal bus address 8400 000H to 87FF FFFFH with the fixed length 3220 ** of 64 Mbytes. 3221 ** ----------------------------------------------------------------- 3222 ** Bit Default Description 3223 ** 31:26 00H Outbound MW Translate Value - Used to convert 80331 internal bus addresses to PCI addresses. 3224 ** 25:02 00 0000H Reserved 3225 ** 01:00 00 2 Burst Order - This bit field shows the address sequence during a memory burst. 3226 ** Only linear incrementing mode is supported. 3227 *********************************************************************************** 3228 */ 3229 #define ARCMSR_OUTBOUND_MEMORY_WINDOW_TRANSLATE_VALUE1_REG 0x68 /*dword 0x6B,0x6A,0x69,0x68*/ 3230 /* 3231 *********************************************************************************** 3232 ** Outbound Upper 32-bit Memory Window Translate Value Register 1 - OUMWTVR1 3233 ** 3234 ** The Outbound Upper 32-bit Memory Window Translate Value Register 1 (OUMWTVR1) defines 3235 ** the upper 32-bits of address used during a dual address cycle. This enables the outbound ATU to 3236 ** directly address anywhere within the 64-bit host address space. When this register is all-zero, then 3237 ** a SAC is generated on the PCI bus. 3238 ** The memory window is from internal bus address 8400 000H to 87FF FFFFH with the fixed length 3239 ** of 64 Mbytes. 3240 ** ----------------------------------------------------------------- 3241 ** Bit Default Description 3242 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC). 3243 *********************************************************************************** 3244 */ 3245 #define ARCMSR_OUTBOUND_UPPER32_MEMORY_WINDOW_TRANSLATE_VALUE1_REG 0x6C /*dword 0x6F,0x6E,0x6D,0x6C*/ 3246 /* 3247 *********************************************************************************** 3248 ** Outbound Upper 32-bit Direct Window Translate Value Register - OUDWTVR 3249 ** 3250 ** The Outbound Upper 32-bit Direct Window Translate Value Register (OUDWTVR) defines the 3251 ** upper 32-bits of address used during a dual address cycle for the transactions via Direct Addressing 3252 ** Window. This enables the outbound ATU to directly address anywhere within the 64-bit host 3253 ** address space. When this register is all-zero, then a SAC is generated on the PCI bus. 3254 ** ----------------------------------------------------------------- 3255 ** Bit Default Description 3256 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC). 3257 *********************************************************************************** 3258 */ 3259 #define ARCMSR_OUTBOUND_UPPER32_DIRECT_WINDOW_TRANSLATE_VALUE_REG 0x78 /*dword 0x7B,0x7A,0x79,0x78*/ 3260 /* 3261 *********************************************************************************** 3262 ** ATU Configuration Register - ATUCR 3263 ** 3264 ** The ATU Configuration Register controls the outbound address translation for address translation 3265 ** unit. It also contains bits for Conventional PCI Delayed Read Command (DRC) aliasing, discard 3266 ** timer status, SERR# manual assertion, SERR# detection interrupt masking, and ATU BIST 3267 ** interrupt enabling. 3268 ** ----------------------------------------------------------------- 3269 ** Bit Default Description 3270 ** 31:20 00H Reserved 3271 ** 19 0 2 ATU DRC Alias - when set, the ATU does not distinguish read commands when attempting to match a 3272 ** current PCI read transaction with read data enqueued within the DRC buffer. When clear, a current read 3273 ** transaction must have the exact same read command as the DRR for the ATU to deliver DRC data. Not 3274 ** applicable in the PCI-X mode. 3275 ** 18 0 2 Direct Addressing Upper 2Gbytes Translation Enable - When set, 3276 ** with Direct Addressing enabled (bit 7 of the ATUCR set), 3277 ** the ATU forwards internal bus cycles with an address between 0000.0040H and 3278 ** 7FFF.FFFFH to the PCI bus with bit 31 of the address set (8000.0000H - FFFF.FFFFH). 3279 ** When clear, no translation occurs. 3280 ** 17 0 2 Reserved 3281 ** 16 0 2 SERR# Manual Assertion - when set, the ATU asserts SERR# for one clock on the PCI interface. Until 3282 ** cleared, SERR# may not be manually asserted again. Once cleared, operation proceeds as specified. 3283 ** 15 0 2 ATU Discard Timer Status - when set, one of the 4 discard timers within the ATU has expired and 3284 ** discarded the delayed completion transaction within the queue. When clear, no timer has expired. 3285 ** 14:10 00000 2 Reserved 3286 ** 09 0 2 SERR# Detected Interrupt Enable - When set, the Intel XScale core is signalled an HPI# interrupt 3287 ** when the ATU detects that SERR# was asserted. When clear, 3288 ** the Intel XScale core is not interrupted when SERR# is detected. 3289 ** 08 0 2 Direct Addressing Enable - Setting this bit enables direct outbound addressing through the ATU. 3290 ** Internal bus cycles with an address between 0000.0040H and 7FFF.FFFFH automatically forwards to 3291 ** the PCI bus with or without translation of address bit 31 based on the setting of bit 18 of 3292 ** the ATUCR. 3293 ** 07:04 0000 2 Reserved 3294 ** 03 0 2 ATU BIST Interrupt Enable - When set, enables an interrupt to the Intel XScale core when the start 3295 ** BIST bit is set in the ATUBISTR register. This bit is also reflected as the BIST Capable bit 7 3296 ** in the ATUBISTR register. 3297 ** 02 0 2 Reserved 3298 ** 01 0 2 Outbound ATU Enable - When set, enables the outbound address translation unit. 3299 ** When cleared, disables the outbound ATU. 3300 ** 00 0 2 Reserved 3301 *********************************************************************************** 3302 */ 3303 #define ARCMSR_ATU_CONFIGURATION_REG 0x80 /*dword 0x83,0x82,0x81,0x80*/ 3304 /* 3305 *********************************************************************************** 3306 ** PCI Configuration and Status Register - PCSR 3307 ** 3308 ** The PCI Configuration and Status Register has additional bits for controlling and monitoring 3309 ** various features of the PCI bus interface. 3310 ** ----------------------------------------------------------------- 3311 ** Bit Default Description 3312 ** 31:19 0000H Reserved 3313 ** 18 0 2 Detected Address or Attribute Parity Error - set when a parity error is detected during either the address 3314 ** or attribute phase of a transaction on the PCI bus even when the ATUCMD register Parity Error 3315 ** Response bit is cleared. Set under the following conditions: 3316 ** �E Any Address or Attribute (PCI-X Only) Parity Error on the Bus (including one generated by the ATU). 3317 ** 17:16 Varies with 3318 ** external state 3319 ** of DEVSEL#, 3320 ** STOP#, and 3321 ** TRDY#, 3322 ** during 3323 ** P_RST# 3324 ** PCI-X capability - These two bits define the mode of 3325 ** the PCI bus (conventional or PCI-X) as well as the 3326 ** operating frequency in the case of PCI-X mode. 3327 ** 00 - Conventional PCI mode 3328 ** 01 - PCI-X 66 3329 ** 10 - PCI-X 100 3330 ** 11 - PCI-X 133 3331 ** As defined by the PCI-X Addendum to the PCI Local Bus Specification, 3332 ** Revision 1.0a, the operating 3333 ** mode is determined by an initialization pattern on the PCI bus during 3334 ** P_RST# assertion: 3335 ** DEVSEL# STOP# TRDY# Mode 3336 ** Deasserted Deasserted Deasserted Conventional 3337 ** Deasserted Deasserted Asserted PCI-X 66 3338 ** Deasserted Asserted Deasserted PCI-X 100 3339 ** Deasserted Asserted Asserted PCI-X 133 3340 ** All other patterns are reserved. 3341 ** 15 0 2 3342 ** Outbound Transaction Queue Busy: 3343 ** 0=Outbound Transaction Queue Empty 3344 ** 1=Outbound Transaction Queue Busy 3345 ** 14 0 2 3346 ** Inbound Transaction Queue Busy: 3347 ** 0=Inbound Transaction Queue Empty 3348 ** 1=Inbound Transaction Queue Busy 3349 ** 13 0 2 Reserved. 3350 ** 12 0 2 Discard Timer Value - This bit controls the time-out value 3351 ** for the four discard timers attached to the queues holding read data. 3352 ** A value of 0 indicates the time-out value is 2 15 clocks. 3353 ** A value of 1 indicates the time-out value is 2 10 clocks. 3354 ** 11 0 2 Reserved. 3355 ** 10 Varies with 3356 ** external state 3357 ** of M66EN 3358 ** during 3359 ** P_RST# 3360 ** Bus Operating at 66 MHz - When set, the interface has been initialized to function at 66 MHz in 3361 ** Conventional PCI mode by the assertion of M66EN during bus initialization. 3362 ** When clear, the interface 3363 ** has been initialized as a 33 MHz bus. 3364 ** 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. 3365 ** 09 0 2 Reserved 3366 ** 08 Varies with 3367 ** external state 3368 ** of REQ64# 3369 ** during 3370 ** P_RST# 3371 ** PCI Bus 64-Bit Capable - When clear, the PCI bus interface has been 3372 ** configured as 64-bit capable by 3373 ** the assertion of REQ64# on the rising edge of P_RST#. When set, 3374 ** the PCI interface is configured as 3375 ** 32-bit only. 3376 ** 07:06 00 2 Reserved. 3377 ** 05 0 2 Reset Internal Bus - This bit controls the reset of the Intel XScale core 3378 ** and all units on the internal 3379 ** bus. In addition to the internal bus initialization, 3380 ** this bit triggers the assertion of the M_RST# pin for 3381 ** initialization of registered DIMMs. When set: 3382 ** When operating in the conventional PCI mode: 3383 ** �E All current PCI transactions being mastered by the ATU completes, 3384 ** and the ATU master interfaces 3385 ** proceeds to an idle state. No additional transactions is mastered by these units 3386 ** until the internal bus reset is complete. 3387 ** �E All current transactions being slaved by the ATU on either the PCI bus 3388 ** or the internal bus 3389 ** completes, and the ATU target interfaces proceeds to an idle state. 3390 ** All future slave transactions master aborts, 3391 ** with the exception of the completion cycle for the transaction that set the Reset 3392 ** Internal Bus bit in the PCSR. 3393 ** �E When the value of the Core Processor Reset bit in the PCSR (upon P_RST# assertion) 3394 ** is set, the Intel XScale core is held in reset when the internal bus reset is complete. 3395 ** �E The ATU ignores configuration cycles, and they appears as master aborts for: 32 3396 ** Internal Bus clocks. 3397 ** �E The 80331 hardware clears this bit after the reset operation completes. 3398 ** When operating in the PCI-X mode: 3399 ** The ATU hardware responds the same as in Conventional PCI-X mode. 3400 ** However, this may create a problem in PCI-X mode for split requests in 3401 ** that there may still be an outstanding split completion that the 3402 ** ATU is either waiting to receive (Outbound Request) or initiate 3403 ** (Inbound Read Request). For a cleaner 3404 ** internal bus reset, host software can take the following steps prior 3405 ** to asserting Reset Internal bus: 3406 ** 1. Clear the Bus Master (bit 2 of the ATUCMD) and the Memory Enable (bit 1 of the ATUCMD) bits in 3407 ** the ATUCMD. This ensures that no new transactions, either outbound or inbound are enqueued. 3408 ** 2. Wait for both the Outbound (bit 15 of the PCSR) and Inbound Read (bit 14 of the PCSR) Transaction 3409 ** queue busy bits to be clear. 3410 ** 3. Set the Reset Internal Bus bit 3411 ** As a result, the ATU hardware resets the internal bus using the same logic as in conventional mode, 3412 ** however the user is now assured that the ATU no longer has any pending inbound or outbound split 3413 ** completion transactions. 3414 ** NOTE: Since the Reset Internal Bus bit is set using an inbound configuration cycle, the user is 3415 ** guaranteed that any prior configuration cycles have properly completed since there is only a one 3416 ** deep transaction queue for configuration transaction requests. The ATU sends the appropriate 3417 ** Split Write Completion Message to the Requester prior to the onset of Internal Bus Reset. 3418 ** 04 0 2 Bus Master Indicator Enable: Provides software control for the 3419 ** Bus Master Indicator signal P_BMI used 3420 ** for external RAIDIOS logic control of private devices. Only valid when operating with the bridge and 3421 ** central resource/arbiter disabled (BRG_EN =low, ARB_EN=low). 3422 ** 03 Varies with external state of PRIVDEV during 3423 ** P_RST# 3424 ** Private Device Enable - This bit indicates the state of the reset strap which enables the private device 3425 ** control mechanism within the PCI-to-PCI Bridge SISR configuration register. 3426 ** 0=Private Device control Disabled - SISR register bits default to zero 3427 ** 1=Private Device control Enabled - SISR register bits default to one 3428 ** 02 Varies with external state of RETRY during P_RST# 3429 ** Configuration Cycle Retry - When this bit is set, the PCI interface of the 80331 responds to all 3430 ** configuration cycles with a Retry condition. When clear, the 80331 responds to the appropriate 3431 ** configuration cycles. 3432 ** The default condition for this bit is based on the external state of the RETRY pin at the rising edge of 3433 ** P_RST#. When the external state of the pin is high, the bit is set. When the external state of the pin is 3434 ** low, the bit is cleared. 3435 ** 01 Varies with external state of CORE_RST# during P_RST# 3436 ** Core Processor Reset - This bit is set to its default value by the hardware when either P_RST# is 3437 ** asserted or the Reset Internal Bus bit in PCSR is set. When this bit is set, the Intel XScale core is 3438 ** being held in reset. Software cannot set this bit. Software is required to clear this bit to deassert Intel 3439 ** XScale core reset. 3440 ** The default condition for this bit is based on the external state of the CORE_RST# pin at the rising edge 3441 ** of P_RST#. When the external state of the pin is low, the bit is set. When the external state of the pin is 3442 ** high, the bit is clear. 3443 ** 00 Varies with external state of PRIVMEM during P_RST# 3444 ** Private Memory Enable - This bit indicates the state of the reset strap which enables the private device 3445 ** control mechanism within the PCI-to-PCI Bridge SDER configuration register. 3446 ** 0=Private Memory control Disabled - SDER register bit 2 default to zero 3447 ** 1=Private Memory control Enabled - SDER register bits 2 default to one 3448 *********************************************************************************** 3449 */ 3450 #define ARCMSR_PCI_CONFIGURATION_STATUS_REG 0x84 /*dword 0x87,0x86,0x85,0x84*/ 3451 /* 3452 *********************************************************************************** 3453 ** ATU Interrupt Status Register - ATUISR 3454 ** 3455 ** The ATU Interrupt Status Register is used to notify the core processor of the source of an ATU 3456 ** interrupt. In addition, this register is written to clear the source of the interrupt to the interrupt unit 3457 ** of the 80331. All bits in this register are Read/Clear. 3458 ** Bits 4:0 are a direct reflection of bits 14:11 and bit 8 (respectively) of the ATU Status Register 3459 ** (these bits are set at the same time by hardware but need to be cleared independently). Bit 7 is set 3460 ** by an error associated with the internal bus of the 80331. Bit 8 is for software BIST. The 3461 ** conditions that result in an ATU interrupt are cleared by writing a 1 to the appropriate bits in this 3462 ** register. 3463 ** Note: Bits 4:0, and bits 15 and 13:7 can result in an interrupt being driven to the Intel XScale core. 3464 ** ----------------------------------------------------------------- 3465 ** Bit Default Description 3466 ** 31:18 0000H Reserved 3467 ** 17 0 2 VPD Address Register Updated - This bit is set when a PCI bus configuration write occurs to the VPDAR 3468 ** register. Configuration register writes to the VPDAR does NOT result in bit 15 also being set. When set, 3469 ** this bit results in the assertion of the ATU Configure Register Write Interrupt. 3470 ** 16 0 2 Reserved 3471 ** 15 0 2 ATU Configuration Write - This bit is set when a PCI bus configuration write occurs to any ATU register. 3472 ** When set, this bit results in the assertion of the ATU Configure Register Write Interrupt. 3473 ** 14 0 2 ATU Inbound Memory Window 1 Base Updated - This bit is set when a PCI bus configuration write 3474 ** occurs to either the IABAR1 register or the IAUBAR1 register. Configuration register writes to these 3475 ** registers deos NOT result in bit 15 also being set. When set, this bit results in the assertion of the ATU 3476 ** Configure Register Write Interrupt. 3477 ** 13 0 2 Initiated Split Completion Error Message - This bit is set when the device initiates a Split Completion 3478 ** Message on the PCI Bus with the Split Completion Error attribute bit set. 3479 ** 12 0 2 Received Split Completion Error Message - This bit is set when the device receives a Split Completion 3480 ** Message from the PCI Bus with the Split Completion Error attribute bit set. 3481 ** 11 0 2 Power State Transition - When the Power State Field of the ATU Power Management Control/Status 3482 ** Register is written to transition the ATU function Power State from D0 to D3, D0 to D1, or D3 to D0 and 3483 ** the ATU Power State Transition Interrupt mask bit is cleared, this bit is set. 3484 ** 10 0 2 P_SERR# Asserted - set when P_SERR# is asserted on the PCI bus by the ATU. 3485 ** 09 0 2 Detected Parity Error - set when a parity error is detected on the PCI bus even when the ATUCMD 3486 ** register��s Parity Error Response bit is cleared. Set under the following conditions: 3487 ** �E Write Data Parity Error when the ATU is a target (inbound write). 3488 ** �E Read Data Parity Error when the ATU is an initiator (outbound read). 3489 ** �E Any Address or Attribute (PCI-X Only) Parity Error on the Bus. 3490 ** 08 0 2 ATU BIST Interrupt - When set, generates the ATU BIST Start Interrupt and indicates the host processor 3491 ** has set the Start BIST bit (ATUBISTR register bit 6), when the ATU BIST interrupt is enabled (ATUCR 3492 ** register bit 3). The Intel XScale core can initiate the software BIST and store the result in ATUBISTR 3493 ** register bits 3:0. 3494 ** Configuration register writes to the ATUBISTR does NOT result in bit 15 also being set or the assertion 3495 ** of the ATU Configure Register Write Interrupt. 3496 ** 07 0 2 Internal Bus Master Abort - set when a transaction initiated by the ATU internal bus initiator interface ends in a Master-abort. 3497 ** 06:05 00 2 Reserved. 3498 ** 04 0 2 P_SERR# Detected - set when P_SERR# is detected on the PCI bus by the ATU. 3499 ** 03 0 2 PCI Master Abort - set when a transaction initiated by the ATU PCI initiator interface ends in a Master-abort. 3500 ** 02 0 2 PCI Target Abort (master) - set when a transaction initiated by the ATU PCI master interface ends in a Target-abort. 3501 ** 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. 3502 ** 00 0 2 PCI Master Parity Error - Master Parity Error - The ATU interface sets this bit under the following 3503 ** conditions: 3504 ** �E The ATU asserted PERR# itself or the ATU observed PERR# asserted. 3505 ** �E And the ATU acted as the requester for the operation in which the error occurred. 3506 ** �E And the ATUCMD register��s Parity Error Response bit is set 3507 ** �E Or (PCI-X Mode Only) the ATU received a Write Data Parity Error Message 3508 ** �E And the ATUCMD register��s Parity Error Response bit is set 3509 *********************************************************************************** 3510 */ 3511 #define ARCMSR_ATU_INTERRUPT_STATUS_REG 0x88 /*dword 0x8B,0x8A,0x89,0x88*/ 3512 /* 3513 *********************************************************************************** 3514 ** ATU Interrupt Mask Register - ATUIMR 3515 ** 3516 ** The ATU Interrupt Mask Register contains the control bit to enable and disable interrupts 3517 ** generated by the ATU. 3518 ** ----------------------------------------------------------------- 3519 ** Bit Default Description 3520 ** 31:15 0 0000H Reserved 3521 ** 14 0 2 VPD Address Register Updated Mask - Controls the setting of bit 17 of the ATUISR and generation of the 3522 ** ATU Configuration Register Write interrupt when a PCI bus write occurs to the VPDAR register. 3523 ** 0=Not Masked 3524 ** 1=Masked 3525 ** 13 0 2 Reserved 3526 ** 12 0 2 Configuration Register Write Mask - Controls the setting of bit 15 of the ATUISR and generation of the 3527 ** ATU Configuration Register Write interrupt when a PCI bus write occurs to any ATU configuration register 3528 ** except those covered by mask bit 11 and bit 14 of this register, and ATU BIST enable bit 3 of the ATUCR. 3529 ** 0=Not Masked 3530 ** 1=Masked 3531 ** 11 1 2 ATU Inbound Memory Window 1 Base Updated Mask - Controls the setting of bit 14 of the ATUISR and 3532 ** generation of the ATU Configuration Register Write interrupt when a PCI bus write occurs to either the 3533 ** IABAR1 register or the IAUBAR1 register. 3534 ** 0=Not Masked 3535 ** 1=Masked 3536 ** 10 0 2 Initiated Split Completion Error Message Interrupt Mask - Controls the setting of bit 13 of the ATUISR and 3537 ** generation of the ATU Error interrupt when the ATU initiates a Split Completion Error Message. 3538 ** 0=Not Masked 3539 ** 1=Masked 3540 ** 09 0 2 Received Split Completion Error Message Interrupt Mask- Controls the setting of bit 12 of the ATUISR 3541 ** and generation of the ATU Error interrupt when a Split Completion Error Message results in bit 29 of the 3542 ** PCIXSR being set. 3543 ** 0=Not Masked 3544 ** 1=Masked 3545 ** 08 1 2 Power State Transition Interrupt Mask - Controls the setting of bit 12 of the ATUISR and generation of the 3546 ** ATU Error interrupt when ATU Power Management Control/Status Register is written to transition the 3547 ** ATU Function Power State from D0 to D3, D0 to D1, D1 to D3 or D3 to D0. 3548 ** 0=Not Masked 3549 ** 1=Masked 3550 ** 07 0 2 ATU Detected Parity Error Interrupt Mask - Controls the setting of bit 9 of the ATUISR and generation of 3551 ** the ATU Error interrupt when a parity error detected on the PCI bus that sets bit 15 of the ATUSR. 3552 ** 0=Not Masked 3553 ** 1=Masked 3554 ** 06 0 2 ATU SERR# Asserted Interrupt Mask - Controls the setting of bit 10 of the ATUISR and generation of the 3555 ** ATU Error interrupt when SERR# is asserted on the PCI interface resulting in bit 14 of the ATUSR being set. 3556 ** 0=Not Masked 3557 ** 1=Masked 3558 ** NOTE: This bit is specific to the ATU asserting SERR# and not detecting SERR# from another master. 3559 ** 05 0 2 ATU PCI Master Abort Interrupt Mask - Controls the setting of bit 3 of the ATUISR and generation of the 3560 ** ATU Error interrupt when a master abort error resulting in bit 13 of the ATUSR being set. 3561 ** 0=Not Masked 3562 ** 1=Masked 3563 ** 04 0 2 ATU PCI Target Abort (Master) Interrupt Mask- Controls the setting of bit 12 of the ATUISR and ATU Error 3564 ** generation of the interrupt when a target abort error resulting in bit 12 of the ATUSR being set 3565 ** 0=Not Masked 3566 ** 1=Masked 3567 ** 03 0 2 ATU PCI Target Abort (Target) Interrupt Mask- Controls the setting of bit 1 of the ATUISR and generation 3568 ** of the ATU Error interrupt when a target abort error resulting in bit 11 of the ATUSR being set. 3569 ** 0=Not Masked 3570 ** 1=Masked 3571 ** 02 0 2 ATU PCI Master Parity Error Interrupt Mask - Controls the setting of bit 0 of the ATUISR and generation 3572 ** of the ATU Error interrupt when a parity error resulting in bit 8 of the ATUSR being set. 3573 ** 0=Not Masked 3574 ** 1=Masked 3575 ** 01 0 2 ATU Inbound Error SERR# Enable - Controls when the ATU asserts (when enabled through the 3576 ** ATUCMD) SERR# on the PCI interface in response to a master abort on the internal bus during an 3577 ** inbound write transaction. 3578 ** 0=SERR# Not Asserted due to error 3579 ** 1=SERR# Asserted due to error 3580 ** 00 0 2 ATU ECC Target Abort Enable - Controls the ATU response on the PCI interface to a target abort (ECC 3581 ** error) from the memory controller on the internal bus. In conventional mode, this action only occurs 3582 ** during an inbound read transaction where the data phase that was target aborted on the internal bus is 3583 ** actually requested from the inbound read queue. 3584 ** 0=Disconnect with data 3585 ** (the data being up to 64 bits of 1��s) 3586 ** 1=Target Abort 3587 ** NOTE: In PCI-X Mode, The ATU initiates a Split Completion Error Message (with message class=2h - 3588 ** completer error and message index=81h - 80331 internal bus target abort) on the PCI bus, 3589 ** independent of the setting of this bit. 3590 *********************************************************************************** 3591 */ 3592 #define ARCMSR_ATU_INTERRUPT_MASK_REG 0x8C /*dword 0x8F,0x8E,0x8D,0x8C*/ 3593 /* 3594 *********************************************************************************** 3595 ** Inbound ATU Base Address Register 3 - IABAR3 3596 ** 3597 ** . The Inbound ATU Base Address Register 3 (IABAR3) together with the Inbound ATU Upper Base Address Register 3 (IAUBAR3) defines the block 3598 ** of memory addresses where the inbound translation window 3 begins. 3599 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory. 3600 ** . The IABAR3 and IAUBAR3 define the base address and describes the required memory block size. 3601 ** . 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. 3602 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 3603 ** Note: 3604 ** Since IABAR3 does not appear in the standard PCI configuration header space (offsets 00H - 3CH), 3605 ** IABAR3 is not configured by the host during normal system initialization. 3606 ** Warning: 3607 ** When a non-zero value is not written to IALR3, 3608 ** the user should not set either the Prefetchable Indicator 3609 ** or the Type Indicator for 64 bit addressability. 3610 ** This is the default for IABAR3. 3611 ** Assuming a non-zero value is written to IALR3, 3612 ** the user may set the Prefetchable Indicator 3613 ** or the Type Indicator: 3614 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary, 3615 ** when the Prefetchable Indicator is not set, 3616 ** the user should also leave the Type Indicator set for 32 bit addressability. 3617 ** This is the default for IABAR3. 3618 ** b. when the Prefetchable Indicator is set, 3619 ** the user should also set the Type Indicator for 64 bit addressability. 3620 ** ----------------------------------------------------------------- 3621 ** Bit Default Description 3622 ** 31:12 00000H Translation Base Address 3 - These bits define the actual location 3623 ** the translation function is to respond to when addressed from the PCI bus. 3624 ** 11:04 00H Reserved. 3625 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable. 3626 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window: 3627 ** 00 - Memory Window is locatable anywhere in 32 bit address space 3628 ** 10 - Memory Window is locatable anywhere in 64 bit address space 3629 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address. 3630 ** The ATU does not occupy I/O space, 3631 ** thus this bit must be zero. 3632 *********************************************************************************** 3633 */ 3634 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS3_REG 0x90 /*dword 0x93,0x92,0x91,0x90*/ 3635 /* 3636 *********************************************************************************** 3637 ** Inbound ATU Upper Base Address Register 3 - IAUBAR3 3638 ** 3639 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes. 3640 ** Together with the Translation Base Address this register defines the actual location 3641 ** the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs). 3642 ** The programmed value within the base address register must comply with the PCI programming 3643 ** requirements for address alignment. 3644 ** Note: 3645 ** When the Type indicator of IABAR3 is set to indicate 32 bit addressability, 3646 ** the IAUBAR3 register attributes are read-only. 3647 ** This is the default for IABAR3. 3648 ** ----------------------------------------------------------------- 3649 ** Bit Default Description 3650 ** 31:0 00000H Translation Upper Base Address 3 - Together with the Translation Base Address 3 these bits define 3651 ** the actual location the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes. 3652 *********************************************************************************** 3653 */ 3654 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS3_REG 0x94 /*dword 0x97,0x96,0x95,0x94*/ 3655 /* 3656 *********************************************************************************** 3657 ** Inbound ATU Limit Register 3 - IALR3 3658 ** 3659 ** Inbound address translation for memory window 3 occurs for data transfers occurring from the PCI 3660 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts 3661 ** PCI addresses to internal bus addresses. 3662 ** The inbound translation base address for inbound window 3 is specified in Section 3.10.15. When 3663 ** determining block size requirements �X as described in Section 3.10.21 �X the translation limit 3664 ** register provides the block size requirements for the base address register. The remaining registers 3665 ** used for performing address translation are discussed in Section 3.2.1.1. 3666 ** The 80331 translate value register��s programmed value must be naturally aligned with the base 3667 ** address register��s programmed value. The limit register is used as a mask; thus, the lower address 3668 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus 3669 ** Specification, Revision 2.3 for additional information on programming base address registers. 3670 ** Bits 31 to 12 within the IALR3 have a direct effect on the IABAR3 register, bits 31 to 12, with a 3671 ** one to one correspondence. A value of 0 in a bit within the IALR3 makes the corresponding bit 3672 ** within the IABAR3 a read only bit which always returns 0. A value of 1 in a bit within the IALR3 3673 ** makes the corresponding bit within the IABAR3 read/write from PCI. Note that a consequence of 3674 ** this programming scheme is that unless a valid value exists within the IALR3, all writes to the 3675 ** IABAR3 has no effect since a value of all zeros within the IALR3 makes the IABAR3 a read only 3676 ** register. 3677 ** ----------------------------------------------------------------- 3678 ** Bit Default Description 3679 ** 31:12 00000H Inbound Translation Limit 3 - This readback value determines the memory block size required 3680 ** for the ATUs memory window 3. 3681 ** 11:00 000H Reserved 3682 *********************************************************************************** 3683 */ 3684 #define ARCMSR_INBOUND_ATU_LIMIT3_REG 0x98 /*dword 0x9B,0x9A,0x99,0x98*/ 3685 /* 3686 *********************************************************************************** 3687 ** Inbound ATU Translate Value Register 3 - IATVR3 3688 ** 3689 ** The Inbound ATU Translate Value Register 3 (IATVR3) contains the internal bus address used to 3690 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the 3691 ** inbound ATU address translation. 3692 ** ----------------------------------------------------------------- 3693 ** Bit Default Description 3694 ** 31:12 00000H Inbound ATU Translation Value 3 - This value is used to convert the PCI address to internal bus addresses. 3695 ** This value must be 64-bit aligned on the internal bus. The default address allows the ATU to 3696 ** access the internal 80331 memory-mapped registers. 3697 ** 11:00 000H Reserved 3698 *********************************************************************************** 3699 */ 3700 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE3_REG 0x9C /*dword 0x9F,0x9E,0x9D,0x9C*/ 3701 /* 3702 *********************************************************************************** 3703 ** Outbound Configuration Cycle Address Register - OCCAR 3704 ** 3705 ** The Outbound Configuration Cycle Address Register is used to hold the 32-bit PCI configuration 3706 ** cycle address. The Intel XScale core writes the PCI configuration cycles address which then 3707 ** enables the outbound configuration read or write. The Intel XScale core then performs a read or 3708 ** write to the Outbound Configuration Cycle Data Register to initiate the configuration cycle on the 3709 ** PCI bus. 3710 ** Note: Bits 15:11 of the configuration cycle address for Type 0 configuration cycles are defined differently 3711 ** for Conventional versus PCI-X modes. When 80331 software programs the OCCAR to initiate a 3712 ** Type 0 configuration cycle, the OCCAR should always be loaded based on the PCI-X definition for 3713 ** the Type 0 configuration cycle address. When operating in Conventional mode, the 80331 clears 3714 ** bits 15:11 of the OCCAR prior to initiating an outbound Type 0 configuration cycle. See the PCI-X 3715 ** Addendum to the PCI Local Bus Specification, Revision 1.0a for details on the two formats. 3716 ** ----------------------------------------------------------------- 3717 ** Bit Default Description 3718 ** 31:00 0000 0000H Configuration Cycle Address - These bits define the 32-bit PCI address used during an outbound 3719 ** configuration read or write cycle. 3720 *********************************************************************************** 3721 */ 3722 #define ARCMSR_OUTBOUND_CONFIGURATION_CYCLE_ADDRESS_REG 0xA4 /*dword 0xA7,0xA6,0xA5,0xA4*/ 3723 /* 3724 *********************************************************************************** 3725 ** Outbound Configuration Cycle Data Register - OCCDR 3726 ** 3727 ** The Outbound Configuration Cycle Data Register is used to initiate a configuration read or write 3728 ** on the PCI bus. The register is logical rather than physical meaning that it is an address not a 3729 ** register. The Intel XScale core reads or writes the data registers memory-mapped address to 3730 ** initiate the configuration cycle on the PCI bus with the address found in the OCCAR. For a 3731 ** configuration write, the data is latched from the internal bus and forwarded directly to the OWQ. 3732 ** For a read, the data is returned directly from the ORQ to the Intel XScale core and is never 3733 ** actually entered into the data register (which does not physically exist). 3734 ** The OCCDR is only visible from 80331 internal bus address space and appears as a reserved value 3735 ** within the ATU configuration space. 3736 ** ----------------------------------------------------------------- 3737 ** Bit Default Description 3738 ** 31:00 0000 0000H Configuration Cycle Data - These bits define the data used during an outbound configuration read 3739 ** or write cycle. 3740 *********************************************************************************** 3741 */ 3742 #define ARCMSR_OUTBOUND_CONFIGURATION_CYCLE_DATA_REG 0xAC /*dword 0xAF,0xAE,0xAD,0xAC*/ 3743 /* 3744 *********************************************************************************** 3745 ** VPD Capability Identifier Register - VPD_CAPID 3746 ** 3747 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification, 3748 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended 3749 ** Capability contained in that header. In the case of the 80331, this is the VPD extended capability 3750 ** with an ID of 03H as defined by the PCI Local Bus Specification, Revision 2.3. 3751 ** ----------------------------------------------------------------- 3752 ** Bit Default Description 3753 ** 07:00 03H Cap_Id - This field with its�� 03H value identifies this item in the linked list of Extended Capability 3754 ** Headers as being the VPD capability registers. 3755 *********************************************************************************** 3756 */ 3757 #define ARCMSR_VPD_CAPABILITY_IDENTIFIER_REG 0xB8 /*byte*/ 3758 /* 3759 *********************************************************************************** 3760 ** VPD Next Item Pointer Register - VPD_NXTP 3761 ** 3762 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification, 3763 ** Revision 2.3. This register describes the location of the next item in the function��s capability list. 3764 ** For the 80331, this the final capability list, and hence, this register is set to 00H. 3765 ** ----------------------------------------------------------------- 3766 ** Bit Default Description 3767 ** 07:00 00H Next_ Item_ Pointer - This field provides an offset into the function��s configuration space pointing to the 3768 ** next item in the function��s capability list. Since the VPD capabilities are the last in the linked list of 3769 ** extended capabilities in the 80331, the register is set to 00H. 3770 *********************************************************************************** 3771 */ 3772 #define ARCMSR_VPD_NEXT_ITEM_PTR_REG 0xB9 /*byte*/ 3773 /* 3774 *********************************************************************************** 3775 ** VPD Address Register - VPD_AR 3776 ** 3777 ** The VPD Address register (VPDAR) contains the DWORD-aligned byte address of the VPD to be 3778 ** accessed. The register is read/write and the initial value at power-up is indeterminate. 3779 ** A PCI Configuration Write to the VPDAR interrupts the Intel XScale core. Software can use 3780 ** the Flag setting to determine whether the configuration write was intended to initiate a read or 3781 ** write of the VPD through the VPD Data Register. 3782 ** ----------------------------------------------------------------- 3783 ** Bit Default Description 3784 ** 15 0 2 Flag - A flag is used to indicate when a transfer of data between the VPD Data Register and the storage 3785 ** component has completed. Please see Section 3.9, ��Vital Product Data�� on page 201 for more details on 3786 ** how the 80331 handles the data transfer. 3787 ** 14:0 0000H VPD Address - This register is written to set the DWORD-aligned byte address used to read or write 3788 ** Vital Product Data from the VPD storage component. 3789 *********************************************************************************** 3790 */ 3791 #define ARCMSR_VPD_ADDRESS_REG 0xBA /*word 0xBB,0xBA*/ 3792 /* 3793 *********************************************************************************** 3794 ** VPD Data Register - VPD_DR 3795 ** 3796 ** This register is used to transfer data between the 80331 and the VPD storage component. 3797 ** ----------------------------------------------------------------- 3798 ** Bit Default Description 3799 ** 31:00 0000H VPD Data - Four bytes are always read or written through this register to/from the VPD storage component. 3800 *********************************************************************************** 3801 */ 3802 #define ARCMSR_VPD_DATA_REG 0xBC /*dword 0xBF,0xBE,0xBD,0xBC*/ 3803 /* 3804 *********************************************************************************** 3805 ** Power Management Capability Identifier Register -PM_CAPID 3806 ** 3807 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification, 3808 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended 3809 ** Capability contained in that header. In the case of the 80331, this is the PCI Bus Power 3810 ** Management extended capability with an ID of 01H as defined by the PCI Bus Power Management 3811 ** Interface Specification, Revision 1.1. 3812 ** ----------------------------------------------------------------- 3813 ** Bit Default Description 3814 ** 07:00 01H Cap_Id - This field with its�� 01H value identifies this item in the linked list of Extended Capability 3815 ** Headers as being the PCI Power Management Registers. 3816 *********************************************************************************** 3817 */ 3818 #define ARCMSR_POWER_MANAGEMENT_CAPABILITY_IDENTIFIER_REG 0xC0 /*byte*/ 3819 /* 3820 *********************************************************************************** 3821 ** Power Management Next Item Pointer Register - PM_NXTP 3822 ** 3823 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification, 3824 ** Revision 2.3. This register describes the location of the next item in the function��s capability list. 3825 ** For the 80331, the next capability (MSI capability list) is located at off-set D0H. 3826 ** ----------------------------------------------------------------- 3827 ** Bit Default Description 3828 ** 07:00 D0H Next_ Item_ Pointer - This field provides an offset into the function��s configuration space pointing to the 3829 ** next item in the function��s capability list which in the 80331 is the MSI extended capabilities header. 3830 *********************************************************************************** 3831 */ 3832 #define ARCMSR_POWER_NEXT_ITEM_PTR_REG 0xC1 /*byte*/ 3833 /* 3834 *********************************************************************************** 3835 ** Power Management Capabilities Register - PM_CAP 3836 ** 3837 ** Power Management Capabilities bits adhere to the definitions in the PCI Bus Power Management 3838 ** Interface Specification, Revision 1.1. This register is a 16-bit read-only register which provides 3839 ** information on the capabilities of the ATU function related to power management. 3840 ** ----------------------------------------------------------------- 3841 ** Bit Default Description 3842 ** 15:11 00000 2 PME_Support - This function is not capable of asserting the PME# signal in any state, since PME# 3843 ** is not supported by the 80331. 3844 ** 10 0 2 D2_Support - This bit is set to 0 2 indicating that the 80331 does not support the D2 Power Management State 3845 ** 9 1 2 D1_Support - This bit is set to 1 2 indicating that the 80331 supports the D1 Power Management State 3846 ** 8:6 000 2 Aux_Current - This field is set to 000 2 indicating that the 80331 has no current requirements for the 3847 ** 3.3Vaux signal as defined in the PCI Bus Power Management Interface Specification, Revision 1.1 3848 ** 5 0 2 DSI - This field is set to 0 2 meaning that this function requires a device specific initialization sequence 3849 ** following the transition to the D0 uninitialized state. 3850 ** 4 0 2 Reserved. 3851 ** 3 0 2 PME Clock - Since the 80331 does not support PME# signal generation this bit is cleared to 0 2 . 3852 ** 2:0 010 2 Version - Setting these bits to 010 2 means that this function complies with PCI Bus Power Management 3853 ** Interface Specification, Revision 1.1 3854 *********************************************************************************** 3855 */ 3856 #define ARCMSR_POWER_MANAGEMENT_CAPABILITY_REG 0xC2 /*word 0xC3,0xC2*/ 3857 /* 3858 *********************************************************************************** 3859 ** Power Management Control/Status Register - PM_CSR 3860 ** 3861 ** Power Management Control/Status bits adhere to the definitions in the PCI Bus Power 3862 ** Management Interface Specification, Revision 1.1. This 16-bit register is the control and status 3863 ** interface for the power management extended capability. 3864 ** ----------------------------------------------------------------- 3865 ** Bit Default Description 3866 ** 15 0 2 PME_Status - This function is not capable of asserting the PME# signal in any state, since PME## is not 3867 ** supported by the 80331. 3868 ** 14:9 00H Reserved 3869 ** 8 0 2 PME_En - This bit is hardwired to read-only 0 2 since this function does not support PME# 3870 ** generation from any power state. 3871 ** 7:2 000000 2 Reserved 3872 ** 1:0 00 2 Power State - This 2-bit field is used both to determine the current power state 3873 ** of a function and to set the function into a new power state. The definition of the values is: 3874 ** 00 2 - D0 3875 ** 01 2 - D1 3876 ** 10 2 - D2 (Unsupported) 3877 ** 11 2 - D3 hot 3878 ** The 80331 supports only the D0 and D3 hot states. 3879 ** 3880 *********************************************************************************** 3881 */ 3882 #define ARCMSR_POWER_MANAGEMENT_CONTROL_STATUS_REG 0xC4 /*word 0xC5,0xC4*/ 3883 /* 3884 *********************************************************************************** 3885 ** PCI-X Capability Identifier Register - PX_CAPID 3886 ** 3887 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification, 3888 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended 3889 ** Capability contained in that header. In the case of the 80331, this is the PCI-X extended capability with 3890 ** an ID of 07H as defined by the PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0a. 3891 ** ----------------------------------------------------------------- 3892 ** Bit Default Description 3893 ** 07:00 07H Cap_Id - This field with its�� 07H value identifies this item in the linked list of Extended Capability 3894 ** Headers as being the PCI-X capability registers. 3895 *********************************************************************************** 3896 */ 3897 #define ARCMSR_PCIX_CAPABILITY_IDENTIFIER_REG 0xE0 /*byte*/ 3898 /* 3899 *********************************************************************************** 3900 ** PCI-X Next Item Pointer Register - PX_NXTP 3901 ** 3902 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification, 3903 ** Revision 2.3. This register describes the location of the next item in the function��s capability list. 3904 ** By default, the PCI-X capability is the last capabilities list for the 80331, thus this register defaults 3905 ** to 00H. 3906 ** However, this register may be written to B8H prior to host configuration to include the VPD 3907 ** capability located at off-set B8H. 3908 ** Warning: Writing this register to any value other than 00H (default) or B8H is not supported and may 3909 ** produce unpredictable system behavior. 3910 ** In order to guarantee that this register is written prior to host configuration, the 80331 must be 3911 ** initialized at P_RST# assertion to Retry Type 0 configuration cycles (bit 2 of PCSR). Typically, 3912 ** the Intel XScale core would be enabled to boot immediately following P_RST# assertion in 3913 ** this case (bit 1 of PCSR), as well. Please see Table 125, ��PCI Configuration and Status Register - 3914 ** PCSR�� on page 253 for more details on the 80331 initialization modes. 3915 ** ----------------------------------------------------------------- 3916 ** Bit Default Description 3917 ** 07:00 00H Next_ Item_ Pointer - This field provides an offset into the function��s configuration space pointing to the 3918 ** next item in the function��s capability list. Since the PCI-X capabilities are the last in the linked list of 3919 ** extended capabilities in the 80331, the register is set to 00H. 3920 ** However, this field may be written prior to host configuration with B8H to extend the list to include the 3921 ** VPD extended capabilities header. 3922 *********************************************************************************** 3923 */ 3924 #define ARCMSR_PCIX_NEXT_ITEM_PTR_REG 0xE1 /*byte*/ 3925 /* 3926 *********************************************************************************** 3927 ** PCI-X Command Register - PX_CMD 3928 ** 3929 ** This register controls various modes and features of ATU and Message Unit when operating in the 3930 ** PCI-X mode. 3931 ** ----------------------------------------------------------------- 3932 ** Bit Default Description 3933 ** 15:7 000000000 2 Reserved. 3934 ** 6:4 011 2 Maximum Outstanding Split Transactions - This register sets the maximum number of Split Transactions 3935 ** the device is permitted to have outstanding at one time. 3936 ** Register Maximum Outstanding 3937 ** 0 1 3938 ** 1 2 3939 ** 2 3 3940 ** 3 4 3941 ** 4 8 3942 ** 5 12 3943 ** 6 16 3944 ** 7 32 3945 ** 3:2 00 2 Maximum Memory Read Byte Count - This register sets the maximum byte count the device uses when 3946 ** initiating a Sequence with one of the burst memory read commands. 3947 ** Register Maximum Byte Count 3948 ** 0 512 3949 ** 1 1024 3950 ** 2 2048 3951 ** 3 4096 3952 ** 1 0 2 3953 ** Enable Relaxed Ordering - The 80331 does not set the relaxed ordering bit in the Requester Attributes 3954 ** of Transactions. 3955 ** 0 0 2 Data Parity Error Recovery Enable - The device driver sets this bit to enable the device to attempt to 3956 ** recover from data parity errors. When this bit is 0 and the device is in PCI-X mode, the device asserts 3957 ** SERR# (when enabled) whenever the Master Data Parity Error bit (Status register, bit 8) is set. 3958 *********************************************************************************** 3959 */ 3960 #define ARCMSR_PCIX_COMMAND_REG 0xE2 /*word 0xE3,0xE2*/ 3961 /* 3962 *********************************************************************************** 3963 ** PCI-X Status Register - PX_SR 3964 ** 3965 ** This register identifies the capabilities and current operating mode of ATU, DMAs and Message 3966 ** Unit when operating in the PCI-X mode. 3967 ** ----------------------------------------------------------------- 3968 ** Bit Default Description 3969 ** 31:30 00 2 Reserved 3970 ** 29 0 2 Received Split Completion Error Message - This bit is set when the device receives a Split Completion 3971 ** Message with the Split Completion Error attribute bit set. Once set, this bit remains set until software 3972 ** writes a 1 to this location. 3973 ** 0=no Split Completion error message received. 3974 ** 1=a Split Completion error message has been received. 3975 ** 28:26 001 2 Designed Maximum Cumulative Read Size (DMCRS) - The value of this register depends on the setting 3976 ** of the Maximum Memory Read Byte Count field of the PCIXCMD register: 3977 ** DMCRS Max ADQs Maximum Memory Read Byte Count Register Setting 3978 ** 1 16 512 (Default) 3979 ** 2 32 1024 3980 ** 2 32 2048 3981 ** 2 32 4096 3982 ** 25:23 011 2 Designed Maximum Outstanding Split Transactions - The 80331 can have up to four outstanding split transactions. 3983 ** 22:21 01 2 Designed Maximum Memory Read Byte Count - The 80331 can generate memory reads with byte counts up 3984 ** to 1024 bytes. 3985 ** 20 1 2 80331 is a complex device. 3986 ** 19 0 2 Unexpected Split Completion - This bit is set when an unexpected Split Completion with this device��s 3987 ** Requester ID is received. Once set, this bit remains set until software writes a 1 to this location. 3988 ** 0=no unexpected Split Completion has been received. 3989 ** 1=an unexpected Split Completion has been received. 3990 ** 18 0 2 Split Completion Discarded - This bit is set when the device discards a Split Completion because the 3991 ** requester would not accept it. See Section 5.4.4 of the PCI-X Addendum to the PCI Local Bus 3992 ** Specification, Revision 1.0a for details. Once set, this bit remains set until software writes a 1 to this 3993 ** location. 3994 ** 0=no Split Completion has been discarded. 3995 ** 1=a Split Completion has been discarded. 3996 ** NOTE: The 80331 does not set this bit since there is no Inbound address responding to Inbound Read 3997 ** Requests with Split Responses (Memory or Register) that has ��read side effects.�� 3998 ** 17 1 2 80331 is a 133 MHz capable device. 3999 ** 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, 4000 ** therefore this bit is always set. 4001 ** 80331 with no bridge and central resource disabled (BRG_EN=0, ARB_EN=0), 4002 ** 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#). 4003 ** This strap, by default, identifies the add in card based on 80331 with bridge disabled 4004 ** as 64-bit unless the user attaches the appropriate pull-down resistor to the strap. 4005 ** 0=The bus is 32 bits wide. 4006 ** 1=The bus is 64 bits wide. 4007 ** 15:8 FFH Bus Number - This register is read for diagnostic purposes only. It indicates the number of the bus 4008 ** segment for the device containing this function. The function uses this number as part of its Requester 4009 ** ID and Completer ID. For all devices other than the source bridge, each time the function is addressed 4010 ** by a Configuration Write transaction, the function must update this register with the contents of AD[7::0] 4011 ** of the attribute phase of the Configuration Write, regardless of which register in the function is 4012 ** addressed by the transaction. The function is addressed by a Configuration Write transaction when all of 4013 ** the following are true: 4014 ** 1. The transaction uses a Configuration Write command. 4015 ** 2. IDSEL is asserted during the address phase. 4016 ** 3. AD[1::0] are 00b (Type 0 configuration transaction). 4017 ** 4. AD[10::08] of the configuration address contain the appropriate function number. 4018 ** 7:3 1FH Device Number - This register is read for diagnostic purposes only. It indicates the number of the device 4019 ** containing this function, i.e., the number in the Device Number field (AD[15::11]) of the address of a 4020 ** Type 0 configuration transaction that is assigned to the device containing this function by the connection 4021 ** of the system hardware. The system must assign a device number other than 00h (00h is reserved for 4022 ** the source bridge). The function uses this number as part of its Requester ID and Completer ID. Each 4023 ** time the function is addressed by a Configuration Write transaction, the device must update this register 4024 ** with the contents of AD[15::11] of the address phase of the Configuration Write, regardless of which 4025 ** register in the function is addressed by the transaction. The function is addressed by a Configuration 4026 ** Write transaction when all of the following are true: 4027 ** 1. The transaction uses a Configuration Write command. 4028 ** 2. IDSEL is asserted during the address phase. 4029 ** 3. AD[1::0] are 00b (Type 0 configuration transaction). 4030 ** 4. AD[10::08] of the configuration address contain the appropriate function number. 4031 ** 2:0 000 2 Function Number - This register is read for diagnostic purposes only. It indicates the number of this 4032 ** function; i.e., the number in the Function Number field (AD[10::08]) of the address of a Type 0 4033 ** configuration transaction to which this function responds. The function uses this number as part of its 4034 ** Requester ID and Completer ID. 4035 ** 4036 ************************************************************************** 4037 */ 4038 #define ARCMSR_PCIX_STATUS_REG 0xE4 /*dword 0xE7,0xE6,0xE5,0xE4*/ 4039 4040 /* 4041 ************************************************************************** 4042 ** Inbound Read Transaction 4043 ** ======================================================================== 4044 ** An inbound read transaction is initiated by a PCI initiator and is targeted at either 80331 local 4045 ** memory or a 80331 memory-mapped register space. The read transaction is propagated through 4046 ** the inbound transaction queue (ITQ) and read data is returned through the inbound read queue 4047 ** (IRQ). 4048 ** When operating in the conventional PCI mode, all inbound read transactions are processed as 4049 ** delayed read transactions. When operating in the PCI-X mode, all inbound read transactions are 4050 ** processed as split transactions. The ATUs PCI interface claims the read transaction and forwards 4051 ** the read request through to the internal bus and returns the read data to the PCI bus. Data flow for 4052 ** an inbound read transaction on the PCI bus is summarized in the following statements: 4053 ** �E The ATU claims the PCI read transaction when the PCI address is within the inbound 4054 ** translation window defined by ATU Inbound Base Address Register (and Inbound Upper Base 4055 ** Address Register during DACs) and Inbound Limit Register. 4056 ** �E When operating in the conventional PCI mode, when the ITQ is currently holding transaction 4057 ** information from a previous delayed read, the current transaction information is compared to 4058 ** the previous transaction information (based on the setting of the DRC Alias bit in 4059 ** Section 3.10.39, ��ATU Configuration Register - ATUCR�� on page 252). When there is a 4060 ** match and the data is in the IRQ, return the data to the master on the PCI bus. When there is a 4061 ** match and the data is not available, a Retry is signaled with no other action taken. When there 4062 ** is not a match and when the ITQ has less than eight entries, capture the transaction 4063 ** information, signal a Retry and initiate a delayed transaction. When there is not a match and 4064 ** when the ITQ is full, then signal a Retry with no other action taken. 4065 ** �X When an address parity error is detected, the address parity response defined in 4066 ** Section 3.7 is used. 4067 ** �E When operating in the conventional PCI mode, once read data is driven onto the PCI bus from 4068 ** the IRQ, it continues until one of the following is true: 4069 ** �X The initiator completes the PCI transaction. When there is data left unread in the IRQ, the 4070 ** data is flushed. 4071 ** �X An internal bus Target Abort was detected. In this case, the QWORD associated with the 4072 ** Target Abort is never entered into the IRQ, and therefore is never returned. 4073 ** �X Target Abort or a Disconnect with Data is returned in response to the Internal Bus Error. 4074 ** �X The IRQ becomes empty. In this case, the PCI interface signals a Disconnect with data to 4075 ** the initiator on the last data word available. 4076 ** �E When operating in the PCI-X mode, when ITQ is not full, the PCI address, attribute and 4077 ** command are latched into the available ITQ and a Split Response Termination is signalled to 4078 ** the initiator. 4079 ** �E When operating in the PCI-X mode, when the transaction does not cross a 1024 byte aligned 4080 ** boundary, then the ATU waits until it receives the full byte count from the internal bus target 4081 ** before returning read data by generating the split completion transaction on the PCI-X bus. 4082 ** When the read requested crosses at least one 1024 byte boundary, then ATU completes the 4083 ** transfer by returning data in 1024 byte aligned chunks. 4084 ** �E When operating in the PCI-X mode, once a split completion transaction has started, it 4085 ** continues until one of the following is true: 4086 ** �X The requester (now the target) generates a Retry Termination, or a Disconnection at Next 4087 ** ADB (when the requester is a bridge) 4088 ** �X The byte count is satisfied. 4089 ** �X An internal bus Target Abort was detected. The ATU generates a Split Completion 4090 ** Message (message class=2h - completer error, and message index=81h - target abort) to 4091 ** inform the requester about the abnormal condition. The ITQ for this transaction is flushed. 4092 ** Refer to Section 3.7.1. 4093 ** �X An internal bus Master Abort was detected. The ATU generates a Split Completion 4094 ** Message (message class=2h - completer error, and message index=80h - Master abort) to 4095 ** inform the requester about the abnormal condition. The ITQ for this transaction is flushed. 4096 ** Refer to Section 3.7.1 4097 ** �E When operating in the conventional PCI mode, when the master inserts wait states on the PCI 4098 ** bus, the ATU PCI slave interface waits with no premature disconnects. 4099 ** �E When a data parity error occurs signified by PERR# asserted from the initiator, no action is 4100 ** taken by the target interface. Refer to Section 3.7.2.5. 4101 ** �E When operating in the conventional PCI mode, when the read on the internal bus is 4102 ** target-aborted, either a target-abort or a disconnect with data is signaled to the initiator. This is 4103 ** based on the ATU ECC Target Abort Enable bit (bit 0 of the ATUIMR for ATU). When set, a 4104 ** target abort is used, when clear, a disconnect is used. 4105 ** �E When operating in the PCI-X mode (with the exception of the MU queue ports at offsets 40h 4106 ** and 44h), when the transaction on the internal bus resulted in a target abort, the ATU generates 4107 ** a Split Completion Message (message class=2h - completer error, and message index=81h - 4108 ** internal bus target abort) to inform the requester about the abnormal condition. For the MU 4109 ** queue ports, the ATU returns either a target abort or a single data phase disconnect depending 4110 ** on the ATU ECC Target Abort Enable bit (bit 0 of the ATUIMR for ATU). The ITQ for this 4111 ** transaction is flushed. Refer to Section 3.7.1. 4112 ** �E When operating in the conventional PCI mode, when the transaction on the internal bus 4113 ** resulted in a master abort, the ATU returns a target abort to inform the requester about the 4114 ** abnormal condition. The ITQ for this transaction is flushed. Refer to Section 3.7.1 4115 ** �E When operating in the PCI-X mode, when the transaction on the internal bus resulted in a 4116 ** master abort, the ATU generates a Split Completion Message (message class=2h - completer 4117 ** error, and message index=80h - internal bus master abort) to inform the requester about the 4118 ** abnormal condition. The ITQ for this transaction is flushed. Refer to Section 3.7.1. 4119 ** �E When operating in the PCI-X mode, when the Split Completion transaction completes with 4120 ** either Master-Abort or Target-Abort, the requester is indicating a failure condition that 4121 ** prevents it from accepting the completion it requested. In this case, since the Split Request 4122 ** addresses a location that has no read side effects, the completer must discard the Split 4123 ** Completion and take no further action. 4124 ** The data flow for an inbound read transaction on the internal bus is summarized in the following 4125 ** statements: 4126 ** �E The ATU internal bus master interface requests the internal bus when a PCI address appears in 4127 ** an ITQ and transaction ordering has been satisfied. When operating in the PCI-X mode the 4128 ** ATU does not use the information provided by the Relax Ordering Attribute bit. That is, ATU 4129 ** always uses conventional PCI ordering rules. 4130 ** �E Once the internal bus is granted, the internal bus master interface drives the translated address 4131 ** onto the bus and wait for IB_DEVSEL#. When a Retry is signaled, the request is repeated. 4132 ** When a master abort occurs, the transaction is considered complete and a target abort is loaded 4133 ** into the associated IRQ for return to the PCI initiator (transaction is flushed once the PCI 4134 ** master has been delivered the target abort). 4135 ** �E Once the translated address is on the bus and the transaction has been accepted, the internal 4136 ** bus target starts returning data with the assertion of IB_TRDY#. Read data is continuously 4137 ** received by the IRQ until one of the following is true: 4138 ** �X The full byte count requested by the ATU read request is received. The ATU internal bus 4139 ** initiator interface performs a initiator completion in this case. 4140 ** �X When operating in the conventional PCI mode, a Target Abort is received on the internal 4141 ** bus from the internal bus target. In this case, the transaction is aborted and the PCI side is 4142 ** informed. 4143 ** �X When operating in the PCI-X mode, a Target Abort is received on the internal bus from 4144 ** the internal bus target. In this case, the transaction is aborted. The ATU generates a Split 4145 ** Completion Message (message class=2h - completer error, and message index=81h - 4146 ** target abort) on the PCI bus to inform the requester about the abnormal condition. The 4147 ** ITQ for this transaction is flushed. 4148 ** �X When operating in the conventional PCI mode, a single data phase disconnection is 4149 ** received from the internal bus target. When the data has not been received up to the next 4150 ** QWORD boundary, the ATU internal bus master interface attempts to reacquire the bus. 4151 ** When not, the bus returns to idle. 4152 ** �X When operating in the PCI-X mode, a single data phase disconnection is received from 4153 ** the internal bus target. The ATU IB initiator interface attempts to reacquire the bus to 4154 ** obtain remaining data. 4155 ** �X When operating in the conventional PCI mode, a disconnection at Next ADB is received 4156 ** from the internal bus target. The bus returns to idle. 4157 ** �X When operating in the PCI-X mode, a disconnection at Next ADB is received from the 4158 ** internal bus target. The ATU IB initiator interface attempts to reacquire the bus to obtain 4159 ** remaining data. 4160 ** To support PCI Local Bus Specification, Revision 2.0 devices, the ATU can be programmed to 4161 ** ignore the memory read command (Memory Read, Memory Read Line, and Memory Read 4162 ** Multiple) when trying to match the current inbound read transaction with data in a DRC queue 4163 ** which was read previously (DRC on target bus). When the Read Command Alias Bit in the 4164 ** ATUCR register is set, the ATU does not distinguish the read commands on transactions. For 4165 ** example, the ATU enqueues a DRR with a Memory Read Multiple command and performs the read 4166 ** on the internal bus. Some time later, a PCI master attempts a Memory Read with the same address 4167 ** as the previous Memory Read Multiple. When the Read Command Bit is set, the ATU would return 4168 ** the read data from the DRC queue and consider the Delayed Read transaction complete. When the 4169 ** Read Command bit in the ATUCR was clear, the ATU would not return data since the PCI read 4170 ** commands did not match, only the address. 4171 ************************************************************************** 4172 */ 4173 /* 4174 ************************************************************************** 4175 ** Inbound Write Transaction 4176 **======================================================================== 4177 ** An inbound write transaction is initiated by a PCI master and is targeted at either 80331 local 4178 ** memory or a 80331 memory-mapped register. 4179 ** Data flow for an inbound write transaction on the PCI bus is summarized as: 4180 ** �E The ATU claims the PCI write transaction when the PCI address is within the inbound 4181 ** translation window defined by the ATU Inbound Base Address Register (and Inbound Upper 4182 ** Base Address Register during DACs) and Inbound Limit Register. 4183 ** �E When the IWADQ has at least one address entry available and the IWQ has at least one buffer 4184 ** available, the address is captured and the first data phase is accepted. 4185 ** �E The PCI interface continues to accept write data until one of the following is true: 4186 ** �X The initiator performs a disconnect. 4187 ** �X The transaction crosses a buffer boundary. 4188 ** �E When an address parity error is detected during the address phase of the transaction, the 4189 ** address parity error mechanisms are used. Refer to Section 3.7.1 for details of the address 4190 ** parity error response. 4191 ** �E When operating in the PCI-X mode when an attribute parity error is detected, the attribute 4192 ** parity error mechanism described in Section 3.7.1 is used. 4193 ** �E When a data parity error is detected while accepting data, the slave interface sets the 4194 ** appropriate bits based on PCI specifications. No other action is taken. Refer to Section 3.7.2.6 4195 ** for details of the inbound write data parity error response. 4196 ** Once the PCI interface places a PCI address in the IWADQ, when IWQ has received data sufficient 4197 ** to cross a buffer boundary or the master disconnects on the PCI bus, the ATUs internal bus 4198 ** interface becomes aware of the inbound write. When there are additional write transactions ahead 4199 ** in the IWQ/IWADQ, the current transaction remains posted until ordering and priority have been 4200 ** satisfied (Refer to Section 3.5.3) and the transaction is attempted on the internal bus by the ATU 4201 ** internal master interface. The ATU does not insert target wait states nor do data merging on the PCI 4202 ** interface, when operating in the PCI mode. 4203 ** In the PCI-X mode memory writes are always executed as immediate transactions, while 4204 ** configuration write transactions are processed as split transactions. The ATU generates a Split 4205 ** Completion Message, (with Message class=0h - Write Completion Class and Message index = 4206 ** 00h - Write Completion Message) once a configuration write is successfully executed. 4207 ** Also, when operating in the PCI-X mode a write sequence may contain multiple write transactions. 4208 ** The ATU handles such transactions as independent transactions. 4209 ** Data flow for the inbound write transaction on the internal bus is summarized as: 4210 ** �E The ATU internal bus master requests the internal bus when IWADQ has at least one entry 4211 ** with associated data in the IWQ. 4212 ** �E When the internal bus is granted, the internal bus master interface initiates the write 4213 ** transaction by driving the translated address onto the internal bus. For details on inbound 4214 ** address translation. 4215 ** �E When IB_DEVSEL# is not returned, a master abort condition is signaled on the internal bus. 4216 ** The current transaction is flushed from the queue and SERR# may be asserted on the PCI 4217 ** interface. 4218 ** �E The ATU initiator interface asserts IB_REQ64# to attempt a 64-bit transfer. When 4219 ** IB_ACK64# is not returned, a 32-bit transfer is used. Transfers of less than 64-bits use the 4220 ** IB_C/BE[7:0]# to mask the bytes not written in the 64-bit data phase. Write data is transferred 4221 ** from the IWQ to the internal bus when data is available and the internal bus interface retains 4222 ** internal bus ownership. 4223 ** �E The internal bus interface stops transferring data from the current transaction to the internal 4224 ** bus when one of the following conditions becomes true: 4225 ** �X The internal bus initiator interface loses bus ownership. The ATU internal initiator 4226 ** terminates the transfer (initiator disconnection) at the next ADB (for the internal bus ADB 4227 ** is defined as a naturally aligned 128-byte boundary) and attempt to reacquire the bus to 4228 ** complete the delivery of remaining data using the same sequence ID but with the 4229 ** modified starting address and byte count. 4230 ** �X A Disconnect at Next ADB is signaled on the internal bus from the internal target. When 4231 ** the transaction in the IWQ completes at that ADB, the initiator returns to idle. When the 4232 ** transaction in the IWQ is not complete, the initiator attempts to reacquire the bus to 4233 ** complete the delivery of remaining data using the same sequence ID but with the 4234 ** modified starting address and byte count. 4235 ** �X A Single Data Phase Disconnect is signaled on the internal bus from the internal target. 4236 ** When the transaction in the IWQ needs only a single data phase, the master returns to idle. 4237 ** When the transaction in the IWQ is not complete, the initiator attempts to reacquire the 4238 ** bus to complete the delivery of remaining data using the same sequence ID but with the 4239 ** modified starting address and byte count. 4240 ** �X The data from the current transaction has completed (satisfaction of byte count). An 4241 ** initiator termination is performed and the bus returns to idle. 4242 ** �X A Master Abort is signaled on the internal bus. SERR# may be asserted on the PCI bus. 4243 ** Data is flushed from the IWQ. 4244 ***************************************************************** 4245 */ 4246 4247 4248 4249 /* 4250 ************************************************************************** 4251 ** Inbound Read Completions Data Parity Errors 4252 **======================================================================== 4253 ** As an initiator, the ATU may encounter this error condition when operating in the PCI-X mode. 4254 ** When as the completer of a Split Read Request the ATU observes PERR# assertion during the split 4255 ** completion transaction, the ATU attempts to complete the transaction normally and no further 4256 ** action is taken. 4257 ************************************************************************** 4258 */ 4259 4260 /* 4261 ************************************************************************** 4262 ** Inbound Configuration Write Completion Message Data Parity Errors 4263 **======================================================================== 4264 ** As an initiator, the ATU may encounter this error condition when operating in the PCI-X mode. 4265 ** When as the completer of a Configuration (Split) Write Request the ATU observes PERR# 4266 ** assertion during the split completion transaction, the ATU attempts to complete the transaction 4267 ** normally and no further action is taken. 4268 ************************************************************************** 4269 */ 4270 4271 /* 4272 ************************************************************************** 4273 ** Inbound Read Request Data Parity Errors 4274 **===================== Immediate Data Transfer ========================== 4275 ** As a target, the ATU may encounter this error when operating in the Conventional PCI or PCI-X modes. 4276 ** Inbound read data parity errors occur when read data delivered from the IRQ is detected as having 4277 ** bad parity by the initiator of the transaction who is receiving the data. The initiator may optionally 4278 ** report the error to the system by asserting PERR#. As a target device in this scenario, no action is 4279 ** required and no error bits are set. 4280 **=====================Split Response Termination========================= 4281 ** As a target, the ATU may encounter this error when operating in the PCI-X mode. 4282 ** Inbound read data parity errors occur during the Split Response Termination. The initiator may 4283 ** optionally report the error to the system by asserting PERR#. As a target device in this scenario, no 4284 ** action is required and no error bits are set. 4285 ************************************************************************** 4286 */ 4287 4288 /* 4289 ************************************************************************** 4290 ** Inbound Write Request Data Parity Errors 4291 **======================================================================== 4292 ** As a target, the ATU may encounter this error when operating in the Conventional or PCI-X modes. 4293 ** Data parity errors occurring during write operations received by the ATU may assert PERR# on 4294 ** the PCI Bus. When an error occurs, the ATU continues accepting data until the initiator of the write 4295 ** transaction completes or a queue fill condition is reached. Specifically, the following actions with 4296 ** the given constraints are taken by the ATU: 4297 ** �E PERR# is asserted two clocks cycles (three clock cycles when operating in the PCI-X mode) 4298 ** following the data phase in which the data parity error is detected on the bus. This is only 4299 ** done when the Parity Error Response bit in the ATUCMD is set. 4300 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4301 ** actions is taken: 4302 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4303 ** Detected Parity Error bit in the ATUISR. When set, no action. 4304 *************************************************************************** 4305 */ 4306 4307 4308 /* 4309 *************************************************************************** 4310 ** Inbound Configuration Write Request 4311 ** ===================================================================== 4312 ** As a target, the ATU may encounter this error when operating in the Conventional or PCI-X modes. 4313 ** =============================================== 4314 ** Conventional PCI Mode 4315 ** =============================================== 4316 ** To allow for correct data parity calculations for delayed write transactions, the ATU delays the 4317 ** assertion of STOP# (signalling a Retry) until PAR is driven by the master. A parity error during a 4318 ** delayed write transaction (inbound configuration write cycle) can occur in any of the following 4319 ** parts of the transactions: 4320 ** �E During the initial Delayed Write Request cycle on the PCI bus when the ATU latches the 4321 ** address/command and data for delayed delivery to the internal configuration register. 4322 ** �E During the Delayed Write Completion cycle on the PCI bus when the ATU delivers the status 4323 ** of the operation back to the original master. 4324 ** The 80331 ATU PCI interface has the following responses to a delayed write parity error for 4325 ** inbound transactions during Delayed Write Request cycles with the given constraints: 4326 ** �E When the Parity Error Response bit in the ATUCMD is set, the ATU asserts TRDY# 4327 ** (disconnects with data) and two clock cycles later asserts PERR# notifying the initiator of the 4328 ** parity error. The delayed write cycle is not enqueued and forwarded to the internal bus. 4329 ** When the Parity Error Response bit in the ATUCMD is cleared, the ATU retries the 4330 ** transaction by asserting STOP# and enqueues the Delayed Write Request cycle to be 4331 ** forwarded to the internal bus. PERR# is not asserted. 4332 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4333 ** actions is taken: 4334 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4335 ** Detected Parity Error bit in the ATUISR. When set, no action. 4336 ** For the original write transaction to be completed, the initiator retries the transaction on the PCI 4337 ** bus and the ATU returns the status from the internal bus, completing the transaction. 4338 ** For the Delayed Write Completion transaction on the PCI bus where a data parity error occurs and 4339 ** therefore does not agree with the status being returned from the internal bus (i.e. status being 4340 ** returned is normal completion) the ATU performs the following actions with the given constraints: 4341 ** �E When the Parity Error Response Bit is set in the ATUCMD, the ATU asserts TRDY# 4342 ** (disconnects with data) and two clocks later asserts PERR#. The Delayed Completion cycle in 4343 ** the IDWQ remains since the data of retried command did not match the data within the queue. 4344 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4345 ** actions is taken: 4346 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4347 ** Detected Parity Error bit in the ATUISR. When set, no action. 4348 ** =================================================== 4349 ** PCI-X Mode 4350 ** =================================================== 4351 ** Data parity errors occurring during configuration write operations received by the ATU may cause 4352 ** PERR# assertion and delivery of a Split Completion Error Message on the PCI Bus. When an error 4353 ** occurs, the ATU accepts the write data and complete with a Split Response Termination. 4354 ** Specifically, the following actions with the given constraints are then taken by the ATU: 4355 ** �E When the Parity Error Response bit in the ATUCMD is set, PERR# is asserted three clocks 4356 ** cycles following the Split Response Termination in which the data parity error is detected on 4357 ** the bus. When the ATU asserts PERR#, additional actions is taken: 4358 ** �X A Split Write Data Parity Error message (with message class=2h - completer error and 4359 ** message index=01h - Split Write Data Parity Error) is initiated by the ATU on the PCI bus 4360 ** that addresses the requester of the configuration write. 4361 ** �X When the Initiated Split Completion Error Message Interrupt Mask in the ATUIMR is 4362 ** clear, set the Initiated Split Completion Error Message bit in the ATUISR. When set, no 4363 ** action. 4364 ** �X The Split Write Request is not enqueued and forwarded to the internal bus. 4365 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4366 ** actions is taken: 4367 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4368 ** Detected Parity Error bit in the ATUISR. When set, no action. 4369 ** 4370 *************************************************************************** 4371 */ 4372 4373 /* 4374 *************************************************************************** 4375 ** Split Completion Messages 4376 ** ======================================================================= 4377 ** As a target, the ATU may encounter this error when operating in the PCI-X mode. 4378 ** Data parity errors occurring during Split Completion Messages claimed by the ATU may assert 4379 ** PERR# (when enabled) or SERR# (when enabled) on the PCI Bus. When an error occurs, the 4380 ** ATU accepts the data and complete normally. Specifically, the following actions with the given 4381 ** constraints are taken by the ATU: 4382 ** �E PERR# is asserted three clocks cycles following the data phase in which the data parity error 4383 ** is detected on the bus. This is only done when the Parity Error Response bit in the ATUCMD 4384 ** is set. When the ATU asserts PERR#, additional actions is taken: 4385 ** �X The Master Parity Error bit in the ATUSR is set. 4386 ** �X When the ATU PCI Master Parity Error Interrupt Mask Bit in the ATUIMR is clear, set the 4387 ** PCI Master Parity Error bit in the ATUISR. When set, no action. 4388 ** �X When the SERR# Enable bit in the ATUCMD is set, and the Data Parity Error Recover 4389 ** Enable bit in the PCIXCMD register is clear, assert SERR#; otherwise no action is taken. 4390 ** When the ATU asserts SERR#, additional actions is taken: 4391 ** Set the SERR# Asserted bit in the ATUSR. 4392 ** When the ATU SERR# Asserted Interrupt Mask Bit in the ATUIMR is clear, set the 4393 ** SERR# Asserted bit in the ATUISR. When set, no action. 4394 ** When the ATU SERR# Detected Interrupt Enable Bit in the ATUCR is set, set the 4395 ** SERR# Detected bit in the ATUISR. When clear, no action. 4396 ** �E When the SCE bit (Split Completion Error -- bit 30 of the Completer Attributes) is set during 4397 ** the Attribute phase, the Received Split Completion Error Message bit in the PCIXSR is set. 4398 ** When the ATU sets this bit, additional actions is taken: 4399 ** �X When the ATU Received Split Completion Error Message Interrupt Mask bit in the 4400 ** ATUIMR is clear, set the Received Split Completion Error Message bit in the ATUISR. 4401 ** When set, no action. 4402 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4403 ** actions is taken: 4404 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4405 ** Detected Parity Error bit in the ATUISR. When set, no action. 4406 ** �E The transaction associated with the Split Completion Message is discarded. 4407 ** �E When the discarded transaction was a read, a completion error message (with message 4408 ** class=2h - completer error and message index=82h - PCI bus read parity error) is generated on 4409 ** the internal bus of the 80331. 4410 ***************************************************************************** 4411 */ 4412 4413 4414 /* 4415 ****************************************************************************************************** 4416 ** Messaging Unit (MU) of the Intel R 80331 I/O processor (80331) 4417 ** ================================================================================================== 4418 ** The Messaging Unit (MU) transfers data between the PCI system and the 80331 4419 ** notifies the respective system when new data arrives. 4420 ** The PCI window for messaging transactions is always the first 4 Kbytes of the inbound translation. 4421 ** window defined by: 4422 ** 1.Inbound ATU Base Address Register 0 (IABAR0) 4423 ** 2.Inbound ATU Limit Register 0 (IALR0) 4424 ** All of the Messaging Unit errors are reported in the same manner as ATU errors. 4425 ** Error conditions and status can be found in : 4426 ** 1.ATUSR 4427 ** 2.ATUISR 4428 **==================================================================================================== 4429 ** Mechanism Quantity Assert PCI Interrupt Signals Generate I/O Processor Interrupt 4430 **---------------------------------------------------------------------------------------------------- 4431 ** Message Registers 2 Inbound Optional Optional 4432 ** 2 Outbound 4433 **---------------------------------------------------------------------------------------------------- 4434 ** Doorbell Registers 1 Inbound Optional Optional 4435 ** 1 Outbound 4436 **---------------------------------------------------------------------------------------------------- 4437 ** Circular Queues 4 Circular Queues Under certain conditions Under certain conditions 4438 **---------------------------------------------------------------------------------------------------- 4439 ** Index Registers 1004 32-bit Memory Locations No Optional 4440 **==================================================================================================== 4441 ** PCI Memory Map: First 4 Kbytes of the ATU Inbound PCI Address Space 4442 **==================================================================================================== 4443 ** 0000H Reserved 4444 ** 0004H Reserved 4445 ** 0008H Reserved 4446 ** 000CH Reserved 4447 **------------------------------------------------------------------------ 4448 ** 0010H Inbound Message Register 0 ] 4449 ** 0014H Inbound Message Register 1 ] 4450 ** 0018H Outbound Message Register 0 ] 4451 ** 001CH Outbound Message Register 1 ] 4 Message Registers 4452 **------------------------------------------------------------------------ 4453 ** 0020H Inbound Doorbell Register ] 4454 ** 0024H Inbound Interrupt Status Register ] 4455 ** 0028H Inbound Interrupt Mask Register ] 4456 ** 002CH Outbound Doorbell Register ] 4457 ** 0030H Outbound Interrupt Status Register ] 4458 ** 0034H Outbound Interrupt Mask Register ] 2 Doorbell Registers and 4 Interrupt Registers 4459 **------------------------------------------------------------------------ 4460 ** 0038H Reserved 4461 ** 003CH Reserved 4462 **------------------------------------------------------------------------ 4463 ** 0040H Inbound Queue Port ] 4464 ** 0044H Outbound Queue Port ] 2 Queue Ports 4465 **------------------------------------------------------------------------ 4466 ** 0048H Reserved 4467 ** 004CH Reserved 4468 **------------------------------------------------------------------------ 4469 ** 0050H ] 4470 ** : ] 4471 ** : Intel Xscale Microarchitecture Local Memory ] 4472 ** : ] 4473 ** 0FFCH ] 1004 Index Registers 4474 ******************************************************************************* 4475 */ 4476 /* 4477 ***************************************************************************** 4478 ** Theory of MU Operation 4479 ***************************************************************************** 4480 **-------------------- 4481 ** inbound_msgaddr0: 4482 ** inbound_msgaddr1: 4483 ** outbound_msgaddr0: 4484 ** outbound_msgaddr1: 4485 ** . The MU has four independent messaging mechanisms. 4486 ** There are four Message Registers that are similar to a combination of mailbox and doorbell registers. 4487 ** Each holds a 32-bit value and generates an interrupt when written. 4488 **-------------------- 4489 ** inbound_doorbell: 4490 ** outbound_doorbell: 4491 ** . The two Doorbell Registers support software interrupts. 4492 ** When a bit is set in a Doorbell Register, an interrupt is generated. 4493 **-------------------- 4494 ** inbound_queueport: 4495 ** outbound_queueport: 4496 ** 4497 ** 4498 ** . The Circular Queues support a message passing scheme that uses 4 circular queues. 4499 ** The 4 circular queues are implemented in 80331 local memory. 4500 ** Two queues are used for inbound messages and two are used for outbound messages. 4501 ** Interrupts may be generated when the queue is written. 4502 **-------------------- 4503 ** local_buffer 0x0050 ....0x0FFF 4504 ** . The Index Registers use a portion of the 80331 local memory to implement a large set of message registers. 4505 ** When one of the Index Registers is written, an interrupt is generated and the address of the register written is captured. 4506 ** Interrupt status for all interrupts is recorded in the Inbound Interrupt Status Register and the Outbound Interrupt Status Register. 4507 ** Each interrupt generated by the Messaging Unit can be masked. 4508 **-------------------- 4509 ** . Multi-DWORD PCI burst accesses are not supported by the Messaging Unit, 4510 ** with the exception of Multi-DWORD reads to the index registers. 4511 ** In Conventional mode: the MU terminates Multi-DWORD PCI transactions 4512 ** (other than index register reads) with a disconnect at the next Qword boundary, with the exception of queue ports. 4513 ** In PCI-X mode : the MU terminates a Multi-DWORD PCI read transaction with a Split Response 4514 ** and the data is returned through split completion transaction(s). 4515 ** however, when the burst request crosses into or through the range of offsets 40h to 4Ch 4516 ** (e.g., this includes the queue ports) the transaction is signaled target-abort immediately on the PCI bus. 4517 ** In PCI-X mode, Multi-DWORD PCI writes is signaled a Single-Data-Phase Disconnect 4518 ** which means that no data beyond the first Qword (Dword when the MU does not assert P_ACK64#) is written. 4519 **-------------------- 4520 ** . All registers needed to configure and control the Messaging Unit are memory-mapped registers. 4521 ** The MU uses the first 4 Kbytes of the inbound translation window in the Address Translation Unit (ATU). 4522 ** This PCI address window is used for PCI transactions that access the 80331 local memory. 4523 ** The PCI address of the inbound translation window is contained in the Inbound ATU Base Address Register. 4524 **-------------------- 4525 ** . From the PCI perspective, the Messaging Unit is part of the Address Translation Unit. 4526 ** The Messaging Unit uses the PCI configuration registers of the ATU for control and status information. 4527 ** The Messaging Unit must observe all PCI control bits in the ATU Command Register and ATU Configuration Register. 4528 ** The Messaging Unit reports all PCI errors in the ATU Status Register. 4529 **-------------------- 4530 ** . Parts of the Messaging Unit can be accessed as a 64-bit PCI device. 4531 ** The register interface, message registers, doorbell registers, 4532 ** and index registers returns a P_ACK64# in response to a P_REQ64# on the PCI interface. 4533 ** Up to 1 Qword of data can be read or written per transaction (except Index Register reads). 4534 ** The Inbound and Outbound Queue Ports are always 32-bit addresses and the MU does not assert P_ACK64# to offsets 40H and 44H. 4535 ************************************************************************** 4536 */ 4537 /* 4538 ************************************************************************** 4539 ** Message Registers 4540 ** ============================== 4541 ** . Messages can be sent and received by the 80331 through the use of the Message Registers. 4542 ** . When written, the message registers may cause an interrupt to be generated to either the Intel XScale core or the host processor. 4543 ** . Inbound messages are sent by the host processor and received by the 80331. 4544 ** Outbound messages are sent by the 80331 and received by the host processor. 4545 ** . The interrupt status for outbound messages is recorded in the Outbound Interrupt Status Register. 4546 ** Interrupt status for inbound messages is recorded in the Inbound Interrupt Status Register. 4547 ** 4548 ** Inbound Messages: 4549 ** ----------------- 4550 ** . When an inbound message register is written by an external PCI agent, an interrupt may be generated to the Intel XScale core. 4551 ** . The interrupt may be masked by the mask bits in the Inbound Interrupt Mask Register. 4552 ** . The Intel XScale core interrupt is recorded in the Inbound Interrupt Status Register. 4553 ** The interrupt causes the Inbound Message Interrupt bit to be set in the Inbound Interrupt Status Register. 4554 ** This is a Read/Clear bit that is set by the MU hardware and cleared by software. 4555 ** The interrupt is cleared when the Intel XScale core writes a value of 4556 ** 1 to the Inbound Message Interrupt bit in the Inbound Interrupt Status Register. 4557 ** ------------------------------------------------------------------------ 4558 ** Inbound Message Register - IMRx 4559 ** 4560 ** . There are two Inbound Message Registers: IMR0 and IMR1. 4561 ** . When the IMR register is written, an interrupt to the Intel XScale core may be generated. 4562 ** The interrupt is recorded in the Inbound Interrupt Status Register and may be masked 4563 ** by the Inbound Message Interrupt Mask bit in the Inbound Interrupt Mask Register. 4564 ** ----------------------------------------------------------------- 4565 ** Bit Default Description 4566 ** 31:00 0000 0000H Inbound Message - This is a 32-bit message written by an external PCI agent. 4567 ** When written, an interrupt to the Intel XScale core may be generated. 4568 ************************************************************************** 4569 */ 4570 #define ARCMSR_MU_INBOUND_MESSAGE_REG0 0x10 /*dword 0x13,0x12,0x11,0x10*/ 4571 #define ARCMSR_MU_INBOUND_MESSAGE_REG1 0x14 /*dword 0x17,0x16,0x15,0x14*/ 4572 /* 4573 ************************************************************************** 4574 ** Outbound Message Register - OMRx 4575 ** -------------------------------- 4576 ** There are two Outbound Message Registers: OMR0 and OMR1. When the OMR register is 4577 ** written, a PCI interrupt may be generated. The interrupt is recorded in the Outbound Interrupt 4578 ** Status Register and may be masked by the Outbound Message Interrupt Mask bit in the Outbound 4579 ** Interrupt Mask Register. 4580 ** 4581 ** Bit Default Description 4582 ** 31:00 00000000H Outbound Message - This is 32-bit message written by the Intel XScale core. When written, an 4583 ** interrupt may be generated on the PCI Interrupt pin determined by the ATU Interrupt Pin Register. 4584 ************************************************************************** 4585 */ 4586 #define ARCMSR_MU_OUTBOUND_MESSAGE_REG0 0x18 /*dword 0x1B,0x1A,0x19,0x18*/ 4587 #define ARCMSR_MU_OUTBOUND_MESSAGE_REG1 0x1C /*dword 0x1F,0x1E,0x1D,0x1C*/ 4588 /* 4589 ************************************************************************** 4590 ** Doorbell Registers 4591 ** ============================== 4592 ** There are two Doorbell Registers: 4593 ** Inbound Doorbell Register 4594 ** Outbound Doorbell Register 4595 ** The Inbound Doorbell Register allows external PCI agents to generate interrupts to the Intel R XScale core. 4596 ** The Outbound Doorbell Register allows the Intel R XScale core to generate a PCI interrupt. 4597 ** Both Doorbell Registers may generate interrupts whenever a bit in the register is set. 4598 ** 4599 ** Inbound Doorbells: 4600 ** ------------------ 4601 ** . When the Inbound Doorbell Register is written by an external PCI agent, an interrupt may be generated to the Intel R XScale core. 4602 ** An interrupt is generated when any of the bits in the doorbell register is written to a value of 1. 4603 ** 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. 4604 ** . Once a bit is set in the Inbound Doorbell Register, it cannot be cleared by any external PCI agent. 4605 ** The interrupt is recorded in the Inbound Interrupt Status Register. 4606 ** . The interrupt may be masked by the Inbound Doorbell Interrupt mask bit in the Inbound Interrupt Mask Register. 4607 ** When the mask bit is set for a particular bit, no interrupt is generated for that bit. 4608 ** The Inbound Interrupt Mask Register affects only the generation of the normal messaging unit interrupt 4609 ** and not the values written to the Inbound Doorbell Register. 4610 ** One bit in the Inbound Doorbell Register is reserved for an Error Doorbell interrupt. 4611 ** . 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. 4612 ** Writing a value of 0 to any bit does not change the value of that bit and does not clear the interrupt. 4613 ** ------------------------------------------------------------------------ 4614 ** Inbound Doorbell Register - IDR 4615 ** 4616 ** . The Inbound Doorbell Register (IDR) is used to generate interrupts to the Intel XScale core. 4617 ** . Bit 31 is reserved for generating an Error Doorbell interrupt. 4618 ** When bit 31 is set, an Error interrupt may be generated to the Intel XScale core. 4619 ** All other bits, when set, cause the Normal Messaging Unit interrupt line of the Intel XScale core to be asserted, 4620 ** when the interrupt is not masked by the Inbound Doorbell Interrupt Mask bit in the Inbound Interrupt Mask Register. 4621 ** 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. 4622 ** ------------------------------------------------------------------------ 4623 ** Bit Default Description 4624 ** 31 0 2 Error Interrupt - Generate an Error Interrupt to the Intel XScale core. 4625 ** 30:00 00000000H Normal Interrupt - When any bit is set, generate a Normal interrupt to the Intel XScale core. 4626 ** When all bits are clear, do not generate a Normal Interrupt. 4627 ************************************************************************** 4628 */ 4629 #define ARCMSR_MU_INBOUND_DOORBELL_REG 0x20 /*dword 0x23,0x22,0x21,0x20*/ 4630 /* 4631 ************************************************************************** 4632 ** Inbound Interrupt Status Register - IISR 4633 ** 4634 ** . The Inbound Interrupt Status Register (IISR) contains hardware interrupt status. 4635 ** It records the status of Intel XScale core interrupts generated by the Message Registers, Doorbell Registers, and the Circular Queues. 4636 ** All interrupts are routed to the Normal Messaging Unit interrupt input of the Intel XScale core, 4637 ** except for the Error Doorbell Interrupt and the Outbound Free Queue Full interrupt; 4638 ** these two are routed to the Messaging Unit Error interrupt input. 4639 ** The generation of interrupts recorded in the Inbound Interrupt Status Register 4640 ** may be masked by setting the corresponding bit in the Inbound Interrupt Mask Register. 4641 ** Some of the bits in this register are Read Only. 4642 ** For those bits, the interrupt must be cleared through another register. 4643 ** 4644 ** Bit Default Description 4645 ** 31:07 0000000H 0 2 Reserved 4646 ** 06 0 2 Index Register Interrupt - This bit is set by the MU hardware 4647 ** when an Index Register has been written after a PCI transaction. 4648 ** 05 0 2 Outbound Free Queue Full Interrupt - This bit is set 4649 ** when the Outbound Free Head Pointer becomes equal to the Tail Pointer and the queue is full. 4650 ** An Error interrupt is generated for this condition. 4651 ** 04 0 2 Inbound Post Queue Interrupt - This bit is set by the MU hardware when the Inbound Post Queue has been written. 4652 ** Once cleared, an interrupt does NOT be generated 4653 ** when the head and tail pointers remain unequal (i.e. queue status is Not Empty). 4654 ** Therefore, when software leaves any unprocessed messages in the post queue when the interrupt is cleared, 4655 ** software must retain the information that the Inbound Post queue status is not empty. 4656 ** NOTE: This interrupt is provided with dedicated support in the 80331 Interrupt Controller. 4657 ** 03 0 2 Error Doorbell Interrupt - This bit is set when the Error Interrupt of the Inbound Doorbell Register is set. 4658 ** To clear this bit (and the interrupt), the Error Interrupt bit of the Inbound Doorbell Register must be clear. 4659 ** 02 0 2 Inbound Doorbell Interrupt - This bit is set when at least one 4660 ** Normal Interrupt bit in the Inbound Doorbell Register is set. 4661 ** To clear this bit (and the interrupt), the Normal Interrupt bits in the Inbound Doorbell Register must all be clear. 4662 ** 01 0 2 Inbound Message 1 Interrupt - This bit is set by the MU hardware when the Inbound Message 1 Register has been written. 4663 ** 00 0 2 Inbound Message 0 Interrupt - This bit is set by the MU hardware when the Inbound Message 0 Register has been written. 4664 ************************************************************************** 4665 */ 4666 #define ARCMSR_MU_INBOUND_INTERRUPT_STATUS_REG 0x24 /*dword 0x27,0x26,0x25,0x24*/ 4667 #define ARCMSR_MU_INBOUND_INDEX_INT 0x40 4668 #define ARCMSR_MU_INBOUND_QUEUEFULL_INT 0x20 4669 #define ARCMSR_MU_INBOUND_POSTQUEUE_INT 0x10 4670 #define ARCMSR_MU_INBOUND_ERROR_DOORBELL_INT 0x08 4671 #define ARCMSR_MU_INBOUND_DOORBELL_INT 0x04 4672 #define ARCMSR_MU_INBOUND_MESSAGE1_INT 0x02 4673 #define ARCMSR_MU_INBOUND_MESSAGE0_INT 0x01 4674 /* 4675 ************************************************************************** 4676 ** Inbound Interrupt Mask Register - IIMR 4677 ** 4678 ** . The Inbound Interrupt Mask Register (IIMR) provides the ability to mask Intel XScale core interrupts generated by the Messaging Unit. 4679 ** Each bit in the Mask register corresponds to an interrupt bit in the Inbound Interrupt Status Register. 4680 ** Setting or clearing bits in this register does not affect the Inbound Interrupt Status Register. 4681 ** They only affect the generation of the Intel XScale core interrupt. 4682 ** ------------------------------------------------------------------------ 4683 ** Bit Default Description 4684 ** 31:07 000000H 0 2 Reserved 4685 ** 06 0 2 Index Register Interrupt Mask - When set, this bit masks the interrupt generated by the MU hardware 4686 ** when an Index Register has been written after a PCI transaction. 4687 ** 05 0 2 Outbound Free Queue Full Interrupt Mask - When set, this bit masks the Error interrupt generated 4688 ** when the Outbound Free Head Pointer becomes equal to the Tail Pointer and the queue is full. 4689 ** 04 0 2 Inbound Post Queue Interrupt Mask - When set, this bit masks the interrupt generated 4690 ** by the MU hardware when the Inbound Post Queue has been written. 4691 ** 03 0 2 Error Doorbell Interrupt Mask - When set, this bit masks the Error Interrupt 4692 ** when the Error Interrupt bit of the Inbound Doorbell Register is set. 4693 ** 02 0 2 Inbound Doorbell Interrupt Mask - When set, this bit masks the interrupt generated 4694 ** when at least one Normal Interrupt bit in the Inbound Doorbell Register is set. 4695 ** 01 0 2 Inbound Message 1 Interrupt Mask - When set, this bit masks the Inbound Message 1 4696 ** Interrupt generated by a write to the Inbound Message 1 Register. 4697 ** 00 0 2 Inbound Message 0 Interrupt Mask - When set, 4698 ** this bit masks the Inbound Message 0 Interrupt generated by a write to the Inbound Message 0 Register. 4699 ************************************************************************** 4700 */ 4701 #define ARCMSR_MU_INBOUND_INTERRUPT_MASK_REG 0x28 /*dword 0x2B,0x2A,0x29,0x28*/ 4702 #define ARCMSR_MU_INBOUND_INDEX_INTMASKENABLE 0x40 4703 #define ARCMSR_MU_INBOUND_QUEUEFULL_INTMASKENABLE 0x20 4704 #define ARCMSR_MU_INBOUND_POSTQUEUE_INTMASKENABLE 0x10 4705 #define ARCMSR_MU_INBOUND_DOORBELL_ERROR_INTMASKENABLE 0x08 4706 #define ARCMSR_MU_INBOUND_DOORBELL_INTMASKENABLE 0x04 4707 #define ARCMSR_MU_INBOUND_MESSAGE1_INTMASKENABLE 0x02 4708 #define ARCMSR_MU_INBOUND_MESSAGE0_INTMASKENABLE 0x01 4709 /* 4710 ************************************************************************** 4711 ** Outbound Doorbell Register - ODR 4712 ** 4713 ** The Outbound Doorbell Register (ODR) allows software interrupt generation. It allows the Intel 4714 ** XScale core to generate PCI interrupts to the host processor by writing to this register. The 4715 ** generation of PCI interrupts through the Outbound Doorbell Register may be masked by setting the 4716 ** Outbound Doorbell Interrupt Mask bit in the Outbound Interrupt Mask Register. 4717 ** The Software Interrupt bits in this register can only be set by the Intel XScale core and can only 4718 ** be cleared by an external PCI agent. 4719 ** ---------------------------------------------------------------------- 4720 ** Bit Default Description 4721 ** 31 0 2 Reserved 4722 ** 30 0 2 Reserved. 4723 ** 29 0 2 Reserved 4724 ** 28 0000 0000H PCI Interrupt - When set, this bit causes the P_INTC# interrupt output 4725 ** (P_INTA# with BRG_EN and ARB_EN straps low) 4726 ** signal to be asserted or a Message-signaled Interrupt is generated (when enabled). 4727 ** When this bit is cleared, the P_INTC# interrupt output 4728 ** (P_INTA# with BRG_EN and ARB_EN straps low) 4729 ** signal is deasserted. 4730 ** 27:00 000 0000H Software Interrupts - When any bit is set the P_INTC# interrupt output 4731 ** (P_INTA# with BRG_EN and ARB_EN straps low) 4732 ** signal is asserted or a Message-signaled Interrupt is generated (when enabled). 4733 ** When all bits are cleared, the P_INTC# interrupt output (P_INTA# with BRG_EN and ARB_EN straps low) 4734 ** signal is deasserted. 4735 ************************************************************************** 4736 */ 4737 #define ARCMSR_MU_OUTBOUND_DOORBELL_REG 0x2C /*dword 0x2F,0x2E,0x2D,0x2C*/ 4738 /* 4739 ************************************************************************** 4740 ** Outbound Interrupt Status Register - OISR 4741 ** 4742 ** The Outbound Interrupt Status Register (OISR) contains hardware interrupt status. It records the 4743 ** status of PCI interrupts generated by the Message Registers, Doorbell Registers, and the Circular 4744 ** Queues. The generation of PCI interrupts recorded in the Outbound Interrupt Status Register may 4745 ** be masked by setting the corresponding bit in the Outbound Interrupt Mask Register. Some of the 4746 ** bits in this register are Read Only. For those bits, the interrupt must be cleared through another 4747 ** register. 4748 ** ---------------------------------------------------------------------- 4749 ** Bit Default Description 4750 ** 31:05 000000H 000 2 Reserved 4751 ** 04 0 2 PCI Interrupt - This bit is set when the PCI Interrupt bit (bit 28) is set in the Outbound Doorbell Register. 4752 ** To clear this bit (and the interrupt), the PCI Interrupt bit must be cleared. 4753 ** 03 0 2 Outbound Post Queue Interrupt - This bit is set when data in the prefetch buffer is valid. This bit is 4754 ** cleared when any prefetch data has been read from the Outbound Queue Port. 4755 ** 02 0 2 Outbound Doorbell Interrupt - This bit is set when at least one Software Interrupt bit in the Outbound 4756 ** Doorbell Register is set. To clear this bit (and the interrupt), the Software Interrupt bits in the Outbound 4757 ** Doorbell Register must all be clear. 4758 ** 01 0 2 Outbound Message 1 Interrupt - This bit is set by the MU when the Outbound Message 1 Register is 4759 ** written. Clearing this bit clears the interrupt. 4760 ** 00 0 2 Outbound Message 0 Interrupt - This bit is set by the MU when the Outbound Message 0 Register is 4761 ** written. Clearing this bit clears the interrupt. 4762 ************************************************************************** 4763 */ 4764 #define ARCMSR_MU_OUTBOUND_INTERRUPT_STATUS_REG 0x30 /*dword 0x33,0x32,0x31,0x30*/ 4765 #define ARCMSR_MU_OUTBOUND_PCI_INT 0x10 4766 #define ARCMSR_MU_OUTBOUND_POSTQUEUE_INT 0x08 4767 #define ARCMSR_MU_OUTBOUND_DOORBELL_INT 0x04 4768 #define ARCMSR_MU_OUTBOUND_MESSAGE1_INT 0x02 4769 #define ARCMSR_MU_OUTBOUND_MESSAGE0_INT 0x01 4770 /* 4771 ************************************************************************** 4772 ** Outbound Interrupt Mask Register - OIMR 4773 ** The Outbound Interrupt Mask Register (OIMR) provides the ability to mask outbound PCI 4774 ** interrupts generated by the Messaging Unit. Each bit in the mask register corresponds to a 4775 ** hardware interrupt bit in the Outbound Interrupt Status Register. When the bit is set, the PCI 4776 ** interrupt is not generated. When the bit is clear, the interrupt is allowed to be generated. 4777 ** Setting or clearing bits in this register does not affect the Outbound Interrupt Status Register. They 4778 ** only affect the generation of the PCI interrupt. 4779 ** ---------------------------------------------------------------------- 4780 ** Bit Default Description 4781 ** 31:05 000000H Reserved 4782 ** 04 0 2 PCI Interrupt Mask - When set, this bit masks the interrupt generation when the PCI Interrupt bit (bit 28) 4783 ** in the Outbound Doorbell Register is set. 4784 ** 03 0 2 Outbound Post Queue Interrupt Mask - When set, this bit masks the interrupt generated when data in 4785 ** the prefetch buffer is valid. 4786 ** 02 0 2 Outbound Doorbell Interrupt Mask - When set, this bit masks the interrupt generated by the Outbound 4787 ** Doorbell Register. 4788 ** 01 0 2 Outbound Message 1 Interrupt Mask - When set, this bit masks the Outbound Message 1 Interrupt 4789 ** generated by a write to the Outbound Message 1 Register. 4790 ** 00 0 2 Outbound Message 0 Interrupt Mask- When set, this bit masks the Outbound Message 0 Interrupt 4791 ** generated by a write to the Outbound Message 0 Register. 4792 ************************************************************************** 4793 */ 4794 #define ARCMSR_MU_OUTBOUND_INTERRUPT_MASK_REG 0x34 /*dword 0x37,0x36,0x35,0x34*/ 4795 #define ARCMSR_MU_OUTBOUND_PCI_INTMASKENABLE 0x10 4796 #define ARCMSR_MU_OUTBOUND_POSTQUEUE_INTMASKENABLE 0x08 4797 #define ARCMSR_MU_OUTBOUND_DOORBELL_INTMASKENABLE 0x04 4798 #define ARCMSR_MU_OUTBOUND_MESSAGE1_INTMASKENABLE 0x02 4799 #define ARCMSR_MU_OUTBOUND_MESSAGE0_INTMASKENABLE 0x01 4800 #define ARCMSR_MU_OUTBOUND_ALL_INTMASKENABLE 0x1F 4801 /* 4802 ************************************************************************** 4803 ** 4804 ************************************************************************** 4805 */ 4806 #define ARCMSR_MU_INBOUND_QUEUE_PORT_REG 0x40 /*dword 0x43,0x42,0x41,0x40*/ 4807 #define ARCMSR_MU_OUTBOUND_QUEUE_PORT_REG 0x44 /*dword 0x47,0x46,0x45,0x44*/ 4808 /* 4809 ************************************************************************** 4810 ** Circular Queues 4811 ** ====================================================================== 4812 ** The MU implements four circular queues. There are 2 inbound queues and 2 outbound queues. In 4813 ** this case, inbound and outbound refer to the direction of the flow of posted messages. 4814 ** Inbound messages are either: 4815 ** �E posted messages by other processors for the Intel XScale core to process or 4816 ** �E free (or empty) messages that can be reused by other processors. 4817 ** Outbound messages are either: 4818 ** �E posted messages by the Intel XScale core for other processors to process or 4819 ** �E free (or empty) messages that can be reused by the Intel XScale core. 4820 ** Therefore, free inbound messages flow away from the 80331 and free outbound messages flow toward the 80331. 4821 ** The four Circular Queues are used to pass messages in the following manner. 4822 ** . The two inbound queues are used to handle inbound messages 4823 ** and the two outbound queues are used to handle outbound messages. 4824 ** . One of the inbound queues is designated the Free queue and it contains inbound free messages. 4825 ** The other inbound queue is designated the Post queue and it contains inbound posted messages. 4826 ** Similarly, one of the outbound queues is designated the Free queue and the other outbound queue is designated the Post queue. 4827 ** 4828 ** ============================================================================================================= 4829 ** Circular Queue Summary 4830 ** _____________________________________________________________________________________________________________ 4831 ** | Queue Name | Purpose | Action on PCI Interface| 4832 ** |______________________|____________________________________________________________|_________________________| 4833 ** |Inbound Post Queue | Queue for inbound messages from other processors | Written | 4834 ** | | waiting to be processed by the 80331 | | 4835 ** |Inbound Free Queue | Queue for empty inbound messages from the 80331 | Read | 4836 ** | | available for use by other processors | | 4837 ** |Outbound Post Queue | Queue for outbound messages from the 80331 | Read | 4838 ** | | that are being posted to the other processors | | 4839 ** |Outbound Free Queue | Queue for empty outbound messages from other processors | Written | 4840 ** | | available for use by the 80331 | | 4841 ** |______________________|____________________________________________________________|_________________________| 4842 ** 4843 ** . The two inbound queues allow the host processor to post inbound messages for the 80331 in one 4844 ** queue and to receive free messages returning from the 80331. 4845 ** The host processor posts inbound messages, 4846 ** the Intel XScale core receives the posted message and when it is finished with the message, 4847 ** places it back on the inbound free queue for reuse by the host processor. 4848 ** 4849 ** The circular queues are accessed by external PCI agents through two port locations in the PCI 4850 ** address space: 4851 ** Inbound Queue Port 4852 ** and Outbound Queue Port. 4853 ** The Inbound Queue Port is used by external PCI agents to read the Inbound Free Queue and write the Inbound Post Queue. 4854 ** The Outbound Queue Port is used by external PCI agents to read the Outbound Post Queue and write the Outbound Free Queue. 4855 ** Note that a PCI transaction to the inbound or outbound queue ports with null byte enables (P_C/BE[3:0]#=1111 2 ) 4856 ** does not cause the MU hardware to increment the queue pointers. 4857 ** This is treated as when the PCI transaction did not occur. 4858 ** The Inbound and Outbound Queue Ports never respond with P_ACK64# on the PCI interface. 4859 ** ====================================================================================== 4860 ** Overview of Circular Queue Operation 4861 ** ====================================================================================== 4862 ** . The data storage for the circular queues must be provided by the 80331 local memory. 4863 ** . The base address of the circular queues is contained in the Queue Base Address Register. 4864 ** Each entry in the queue is a 32-bit data value. 4865 ** . Each read from or write to the queue may access only one queue entry. 4866 ** . Multi-DWORD accesses to the circular queues are not allowed. 4867 ** Sub-DWORD accesses are promoted to DWORD accesses. 4868 ** . Each circular queue has a head pointer and a tail pointer. 4869 ** The pointers are offsets from the Queue Base Address. 4870 ** . Writes to a queue occur at the head of the queue and reads occur from the tail. 4871 ** The head and tail pointers are incremented by either the Intel XScale core or the Messaging Unit hardware. 4872 ** Which unit maintains the pointer is determined by the writer of the queue. 4873 ** More details about the pointers are given in the queue descriptions below. 4874 ** The pointers are incremented after the queue access. 4875 ** Both pointers wrap around to the first address of the circular queue when they reach the circular queue size. 4876 ** 4877 ** Messaging Unit... 4878 ** 4879 ** The Messaging Unit generates an interrupt to the Intel XScale core or generate a PCI interrupt under certain conditions. 4880 ** . In general, when a Post queue is written, an interrupt is generated to notify the receiver that a message was posted. 4881 ** The size of each circular queue can range from 4K entries (16 Kbytes) to 64K entries (256 Kbytes). 4882 ** . All four queues must be the same size and may be contiguous. 4883 ** Therefore, the total amount of local memory needed by the circular queues ranges from 64 Kbytes to 1 Mbytes. 4884 ** The Queue size is determined by the Queue Size field in the MU Configuration Register. 4885 ** . There is one base address for all four queues. 4886 ** It is stored in the Queue Base Address Register (QBAR). 4887 ** The starting addresses of each queue is based on the Queue Base Address and the Queue Size field. 4888 ** here shows an example of how the circular queues should be set up based on the 4889 ** Intelligent I/O (I 2 O) Architecture Specification. 4890 ** Other ordering of the circular queues is possible. 4891 ** 4892 ** Queue Starting Address 4893 ** Inbound Free Queue QBAR 4894 ** Inbound Post Queue QBAR + Queue Size 4895 ** Outbound Post Queue QBAR + 2 * Queue Size 4896 ** Outbound Free Queue QBAR + 3 * Queue Size 4897 ** =================================================================================== 4898 ** Inbound Post Queue 4899 ** ------------------ 4900 ** The Inbound Post Queue holds posted messages placed there by other processors for the Intel XScale core to process. 4901 ** This queue is read from the queue tail by the Intel XScale core. It is written to the queue head by external PCI agents. 4902 ** The tail pointer is maintained by the Intel XScale core. The head pointer is maintained by the MU hardware. 4903 ** For a PCI write transaction that accesses the Inbound Queue Port, 4904 ** the MU writes the data to the local memory location address in the Inbound Post Head Pointer Register. 4905 ** When the data written to the Inbound Queue Port is written to local memory, the MU hardware increments the Inbound Post Head Pointer Register. 4906 ** An Intel XScale core interrupt may be generated when the Inbound Post Queue is written. 4907 ** The Inbound Post Queue Interrupt bit in the Inbound Interrupt Status Register indicates the interrupt status. 4908 ** The interrupt is cleared when the Inbound Post Queue Interrupt bit is cleared. 4909 ** The interrupt can be masked by the Inbound Interrupt Mask Register. 4910 ** Software must be aware of the state of the Inbound Post Queue Interrupt Mask bit to guarantee 4911 ** that the full condition is recognized by the core processor. 4912 ** In addition, to guarantee that the queue does not get overwritten, 4913 ** software must process messages from the tail of the queue before incrementing the tail pointer and clearing this interrupt. 4914 ** Once cleared, an interrupt is NOT generated when the head and tail pointers remain unequal (i.e. queue status is Not Empty). 4915 ** Only a new message posting the in the inbound queue generates a new interrupt. 4916 ** Therefore, when software leaves any unprocessed messages in the post queue when the interrupt is cleared, 4917 ** software must retain the information that the Inbound Post queue status. 4918 ** From the time that the PCI write transaction is received until the data is written 4919 ** in local memory and the Inbound Post Head Pointer Register is incremented, 4920 ** any PCI transaction that attempts to access the Inbound Post Queue Port is signalled a Retry. 4921 ** The Intel XScale core may read messages from the Inbound Post Queue 4922 ** by reading the data from the local memory location pointed to by the Inbound Post Tail Pointer Register. 4923 ** The Intel XScale core must then increment the Inbound Post Tail Pointer Register. 4924 ** When the Inbound Post Queue is full (head and tail pointers are equal and the head pointer was last updated by hardware), 4925 ** the hardware retries any PCI writes until a slot in the queue becomes available. 4926 ** A slot in the post queue becomes available by the Intel XScale core incrementing the tail pointer. 4927 ** =================================================================================== 4928 ** Inbound Free Queue 4929 ** ------------------ 4930 ** The Inbound Free Queue holds free inbound messages placed there by the Intel XScale core for other processors to use. 4931 ** This queue is read from the queue tail by external PCI agents. 4932 ** It is written to the queue head by the Intel XScale core. 4933 ** The tail pointer is maintained by the MU hardware. 4934 ** The head pointer is maintained by the Intel XScale core. 4935 ** For a PCI read transaction that accesses the Inbound Queue Port, 4936 ** the MU attempts to read the data at the local memory address in the Inbound Free Tail Pointer. 4937 ** When the queue is not empty (head and tail pointers are not equal) 4938 ** or full (head and tail pointers are equal but the head pointer was last written by software), the data is returned. 4939 ** When the queue is empty (head and tail pointers are equal and the head pointer was last updated by hardware), 4940 ** the value of -1 (FFFF.FFFFH) is returned. 4941 ** When the queue was not empty and the MU succeeded in returning the data at the tail, 4942 ** the MU hardware must increment the value in the Inbound Free Tail Pointer Register. 4943 ** To reduce latency for the PCI read access, the MU implements a prefetch mechanism to anticipate accesses to the Inbound Free Queue. 4944 ** The MU hardware prefetches the data at the tail of the Inbound Free Queue and load it into an internal prefetch register. 4945 ** When the PCI read access occurs, the data is read directly from the prefetch register. 4946 ** The prefetch mechanism loads a value of -1 (FFFF.FFFFH) into the prefetch register 4947 ** when the head and tail pointers are equal and the queue is empty. 4948 ** In order to update the prefetch register when messages are added to the queue and it becomes non-empty, 4949 ** the prefetch mechanism automatically starts a prefetch when the prefetch register contains FFFF.FFFFH 4950 ** and the Inbound Free Head Pointer Register is written. 4951 ** The Intel XScale core needs to update the Inbound Free Head Pointer Register when it adds messages to the queue. 4952 ** A prefetch must appear atomic from the perspective of the external PCI agent. 4953 ** 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. 4954 ** The Intel XScale core may place messages in the Inbound Free Queue by writing the data to the 4955 ** local memory location pointed to by the Inbound Free Head Pointer Register. 4956 ** The processor must then increment the Inbound Free Head Pointer Register. 4957 ** ================================================================================== 4958 ** Outbound Post Queue 4959 ** ------------------- 4960 ** The Outbound Post Queue holds outbound posted messages placed there by the Intel XScale 4961 ** core for other processors to process. This queue is read from the queue tail by external PCI agents. 4962 ** It is written to the queue head by the Intel XScale core. The tail pointer is maintained by the 4963 ** MU hardware. The head pointer is maintained by the Intel XScale core. 4964 ** For a PCI read transaction that accesses the Outbound Queue Port, the MU attempts to read the 4965 ** data at the local memory address in the Outbound Post Tail Pointer Register. When the queue is not 4966 ** empty (head and tail pointers are not equal) or full (head and tail pointers are equal but the head 4967 ** pointer was last written by software), the data is returned. When the queue is empty (head and tail 4968 ** pointers are equal and the head pointer was last updated by hardware), the value of -1 4969 ** (FFFF.FFFFH) is returned. When the queue was not empty and the MU succeeded in returning the 4970 ** data at the tail, the MU hardware must increment the value in the Outbound Post Tail Pointer 4971 ** Register. 4972 ** To reduce latency for the PCI read access, the MU implements a prefetch mechanism to anticipate 4973 ** accesses to the Outbound Post Queue. The MU hardware prefetches the data at the tail of the 4974 ** Outbound Post Queue and load it into an internal prefetch register. When the PCI read access 4975 ** occurs, the data is read directly from the prefetch register. 4976 ** The prefetch mechanism loads a value of -1 (FFFF.FFFFH) into the prefetch register when the head 4977 ** and tail pointers are equal and the queue is empty. In order to update the prefetch register when 4978 ** messages are added to the queue and it becomes non-empty, the prefetch mechanism automatically 4979 ** starts a prefetch when the prefetch register contains FFFF.FFFFH and the Outbound Post Head 4980 ** Pointer Register is written. The Intel XScale core needs to update the Outbound Post Head 4981 ** Pointer Register when it adds messages to the queue. 4982 ** A prefetch must appear atomic from the perspective of the external PCI agent. When a prefetch is 4983 ** started, any PCI transaction that attempts to access the Outbound Post Queue is signalled a Retry 4984 ** until the prefetch is completed. 4985 ** A PCI interrupt may be generated when data in the prefetch buffer is valid. When the prefetch 4986 ** queue is clear, no interrupt is generated. The Outbound Post Queue Interrupt bit in the Outbound 4987 ** Interrupt Status Register shall indicate the status of the prefetch buffer data and therefore the 4988 ** interrupt status. The interrupt is cleared when any prefetched data has been read from the Outbound 4989 ** Queue Port. The interrupt can be masked by the Outbound Interrupt Mask Register. 4990 ** The Intel XScale core may place messages in the Outbound Post Queue by writing the data to 4991 ** the local memory address in the Outbound Post Head Pointer Register. The processor must then 4992 ** increment the Outbound Post Head Pointer Register. 4993 ** ================================================== 4994 ** Outbound Free Queue 4995 ** ----------------------- 4996 ** The Outbound Free Queue holds free messages placed there by other processors for the Intel 4997 ** XScale core to use. This queue is read from the queue tail by the Intel XScale core. It is 4998 ** written to the queue head by external PCI agents. The tail pointer is maintained by the Intel 4999 ** XScale core. The head pointer is maintained by the MU hardware. 5000 ** For a PCI write transaction that accesses the Outbound Queue Port, the MU writes the data to the 5001 ** local memory address in the Outbound Free Head Pointer Register. When the data written to the 5002 ** Outbound Queue Port is written to local memory, the MU hardware increments the Outbound Free 5003 ** Head Pointer Register. 5004 ** When the head pointer and the tail pointer become equal and the queue is full, the MU may signal 5005 ** an interrupt to the Intel XScale core to register the queue full condition. This interrupt is 5006 ** recorded in the Inbound Interrupt Status Register. The interrupt is cleared when the Outbound Free 5007 ** Queue Full Interrupt bit is cleared and not by writing to the head or tail pointers. The interrupt can 5008 ** be masked by the Inbound Interrupt Mask Register. Software must be aware of the state of the 5009 ** Outbound Free Queue Interrupt Mask bit to guarantee that the full condition is recognized by the 5010 ** core processor. 5011 ** From the time that a PCI write transaction is received until the data is written in local memory and 5012 ** the Outbound Free Head Pointer Register is incremented, any PCI transaction that attempts to 5013 ** access the Outbound Free Queue Port is signalled a retry. 5014 ** The Intel XScale core may read messages from the Outbound Free Queue by reading the data 5015 ** from the local memory address in the Outbound Free Tail Pointer Register. The processor must 5016 ** then increment the Outbound Free Tail Pointer Register. When the Outbound Free Queue is full, 5017 ** the hardware must retry any PCI writes until a slot in the queue becomes available. 5018 ** 5019 ** ================================================================================== 5020 ** Circular Queue Summary 5021 ** ---------------------- 5022 ** ________________________________________________________________________________________________________________________________________________ 5023 ** | Queue Name | PCI Port |Generate PCI Interrupt |Generate Intel Xscale Core Interrupt|Head Pointer maintained by|Tail Pointer maintained by| 5024 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________| 5025 ** |Inbound Post | Inbound Queue | | | | | 5026 ** | Queue | Port | NO | Yes, when queue is written | MU hardware | Intel XScale | 5027 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________| 5028 ** |Inbound Free | Inbound Queue | | | | | 5029 ** | Queue | Port | NO | NO | Intel XScale | MU hardware | 5030 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________| 5031 ** ================================================================================== 5032 ** Circular Queue Status Summary 5033 ** ---------------------- 5034 ** ____________________________________________________________________________________________________ 5035 ** | Queue Name | Queue Status | Head & Tail Pointer | Last Pointer Update | 5036 ** |_____________________|________________|_____________________|_______________________________________| 5037 ** | Inbound Post Queue | Empty | Equal | Tail pointer last updated by software | 5038 ** |_____________________|________________|_____________________|_______________________________________| 5039 ** | Inbound Free Queue | Empty | Equal | Head pointer last updated by hardware | 5040 ** |_____________________|________________|_____________________|_______________________________________| 5041 ************************************************************************** 5042 */ 5043 5044 /* 5045 ************************************************************************** 5046 ** Index Registers 5047 ** ======================== 5048 ** . 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. 5049 ** These registers are for inbound messages only. 5050 ** The interrupt is recorded in the Inbound Interrupt Status Register. 5051 ** The storage for the Index Registers is allocated from the 80331 local memory. 5052 ** PCI write accesses to the Index Registers write the data to local memory. 5053 ** PCI read accesses to the Index Registers read the data from local memory. 5054 ** . The local memory used for the Index Registers ranges from Inbound ATU Translate Value Register + 050H 5055 ** to Inbound ATU Translate Value Register + FFFH. 5056 ** . The address of the first write access is stored in the Index Address Register. 5057 ** This register is written during the earliest write access and provides a means to determine which Index Register was written. 5058 ** Once updated by the MU, the Index Address Register is not updated until the Index Register 5059 ** Interrupt bit in the Inbound Interrupt Status Register is cleared. 5060 ** . When the interrupt is cleared, the Index Address Register is re-enabled and stores the address of the next Index Register write access. 5061 ** Writes by the Intel XScale core to the local memory used by the Index Registers 5062 ** does not cause an interrupt and does not update the Index Address Register. 5063 ** . The index registers can be accessed with Multi-DWORD reads and single QWORD aligned writes. 5064 ************************************************************************** 5065 */ 5066 /* 5067 ************************************************************************** 5068 ** Messaging Unit Internal Bus Memory Map 5069 ** ======================================= 5070 ** Internal Bus Address___Register Description (Name)____________________|_PCI Configuration Space Register Number_ 5071 ** FFFF E300H reserved | 5072 ** .. .. | 5073 ** FFFF E30CH reserved | 5074 ** FFFF E310H Inbound Message Register 0 | Available through 5075 ** FFFF E314H Inbound Message Register 1 | ATU Inbound Translation Window 5076 ** FFFF E318H Outbound Message Register 0 | 5077 ** FFFF E31CH Outbound Message Register 1 | or 5078 ** FFFF E320H Inbound Doorbell Register | 5079 ** FFFF E324H Inbound Interrupt Status Register | must translate PCI address to 5080 ** FFFF E328H Inbound Interrupt Mask Register | the Intel Xscale Core 5081 ** FFFF E32CH Outbound Doorbell Register | Memory-Mapped Address 5082 ** FFFF E330H Outbound Interrupt Status Register | 5083 ** FFFF E334H Outbound Interrupt Mask Register | 5084 ** ______________________________________________________________________|________________________________________ 5085 ** FFFF E338H reserved | 5086 ** FFFF E33CH reserved | 5087 ** FFFF E340H reserved | 5088 ** FFFF E344H reserved | 5089 ** FFFF E348H reserved | 5090 ** FFFF E34CH reserved | 5091 ** FFFF E350H MU Configuration Register | 5092 ** FFFF E354H Queue Base Address Register | 5093 ** FFFF E358H reserved | 5094 ** FFFF E35CH reserved | must translate PCI address to 5095 ** FFFF E360H Inbound Free Head Pointer Register | the Intel Xscale Core 5096 ** FFFF E364H Inbound Free Tail Pointer Register | Memory-Mapped Address 5097 ** FFFF E368H Inbound Post Head pointer Register | 5098 ** FFFF E36CH Inbound Post Tail Pointer Register | 5099 ** FFFF E370H Outbound Free Head Pointer Register | 5100 ** FFFF E374H Outbound Free Tail Pointer Register | 5101 ** FFFF E378H Outbound Post Head pointer Register | 5102 ** FFFF E37CH Outbound Post Tail Pointer Register | 5103 ** FFFF E380H Index Address Register | 5104 ** FFFF E384H reserved | 5105 ** .. .. | 5106 ** FFFF E3FCH reserved | 5107 ** ______________________________________________________________________|_______________________________________ 5108 ************************************************************************** 5109 */ 5110 /* 5111 ************************************************************************** 5112 ** MU Configuration Register - MUCR FFFF.E350H 5113 ** 5114 ** . The MU Configuration Register (MUCR) contains the Circular Queue Enable bit and the size of one Circular Queue. 5115 ** . The Circular Queue Enable bit enables or disables the Circular Queues. 5116 ** The Circular Queues are disabled at reset to allow the software to initialize the head 5117 ** and tail pointer registers before any PCI accesses to the Queue Ports. 5118 ** . Each Circular Queue may range from 4 K entries (16 Kbytes) to 64 K entries (256 Kbytes) and there are four Circular Queues. 5119 ** ------------------------------------------------------------------------ 5120 ** Bit Default Description 5121 ** 31:06 000000H 00 2 Reserved 5122 ** 05:01 00001 2 Circular Queue Size - This field determines the size of each Circular Queue. 5123 ** All four queues are the same size. 5124 ** �E 00001 2 - 4K Entries (16 Kbytes) 5125 ** �E 00010 2 - 8K Entries (32 Kbytes) 5126 ** �E 00100 2 - 16K Entries (64 Kbytes) 5127 ** �E 01000 2 - 32K Entries (128 Kbytes) 5128 ** �E 10000 2 - 64K Entries (256 Kbytes) 5129 ** 00 0 2 Circular Queue Enable - This bit enables or disables the Circular Queues. When clear the Circular 5130 ** Queues are disabled, however the MU accepts PCI accesses to the Circular Queue Ports but ignores 5131 ** the data for Writes and return FFFF.FFFFH for Reads. Interrupts are not generated to the core when 5132 ** disabled. When set, the Circular Queues are fully enabled. 5133 ************************************************************************** 5134 */ 5135 #define ARCMSR_MU_CONFIGURATION_REG 0xFFFFE350 5136 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE64K 0x0020 5137 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE32K 0x0010 5138 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE16K 0x0008 5139 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE8K 0x0004 5140 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE4K 0x0002 5141 #define ARCMSR_MU_CIRCULAR_QUEUE_ENABLE 0x0001 /*0:disable 1:enable*/ 5142 /* 5143 ************************************************************************** 5144 ** Queue Base Address Register - QBAR 5145 ** 5146 ** . The Queue Base Address Register (QBAR) contains the local memory address of the Circular Queues. 5147 ** The base address is required to be located on a 1 Mbyte address boundary. 5148 ** . All Circular Queue head and tail pointers are based on the QBAR. 5149 ** When the head and tail pointer registers are read, the Queue Base Address is returned in the upper 12 bits. 5150 ** 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. 5151 ** Warning: 5152 ** The QBAR must designate a range allocated to the 80331 DDR SDRAM interface 5153 ** ------------------------------------------------------------------------ 5154 ** Bit Default Description 5155 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 5156 ** 19:00 00000H Reserved 5157 ************************************************************************** 5158 */ 5159 #define ARCMSR_MU_QUEUE_BASE_ADDRESS_REG 0xFFFFE354 5160 /* 5161 ************************************************************************** 5162 ** Inbound Free Head Pointer Register - IFHPR 5163 ** 5164 ** . The Inbound Free Head Pointer Register (IFHPR) contains the local memory offset from 5165 ** the Queue Base Address of the head pointer for the Inbound Free Queue. 5166 ** The Head Pointer must be aligned on a DWORD address boundary. 5167 ** When read, the Queue Base Address is provided in the upper 12 bits of the register. 5168 ** Writes to the upper 12 bits of the register are ignored. 5169 ** This register is maintained by software. 5170 ** ------------------------------------------------------------------------ 5171 ** Bit Default Description 5172 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 5173 ** 19:02 0000H 00 2 Inbound Free Head Pointer - Local memory offset of the head pointer for the Inbound Free Queue. 5174 ** 01:00 00 2 Reserved 5175 ************************************************************************** 5176 */ 5177 #define ARCMSR_MU_INBOUND_FREE_HEAD_PTR_REG 0xFFFFE360 5178 /* 5179 ************************************************************************** 5180 ** Inbound Free Tail Pointer Register - IFTPR 5181 ** 5182 ** . The Inbound Free Tail Pointer Register (IFTPR) contains the local memory offset from the Queue 5183 ** Base Address of the tail pointer for the Inbound Free Queue. The Tail Pointer must be aligned on a 5184 ** DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits 5185 ** of the register. Writes to the upper 12 bits of the register are ignored. 5186 ** ------------------------------------------------------------------------ 5187 ** Bit Default Description 5188 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 5189 ** 19:02 0000H 00 2 Inbound Free Tail Pointer - Local memory offset of the tail pointer for the Inbound Free Queue. 5190 ** 01:00 00 2 Reserved 5191 ************************************************************************** 5192 */ 5193 #define ARCMSR_MU_INBOUND_FREE_TAIL_PTR_REG 0xFFFFE364 5194 /* 5195 ************************************************************************** 5196 ** Inbound Post Head Pointer Register - IPHPR 5197 ** 5198 ** . The Inbound Post Head Pointer Register (IPHPR) contains the local memory offset from the Queue 5199 ** Base Address of the head pointer for the Inbound Post Queue. The Head Pointer must be aligned on 5200 ** a DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits 5201 ** of the register. Writes to the upper 12 bits of the register are ignored. 5202 ** ------------------------------------------------------------------------ 5203 ** Bit Default Description 5204 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 5205 ** 19:02 0000H 00 2 Inbound Post Head Pointer - Local memory offset of the head pointer for the Inbound Post Queue. 5206 ** 01:00 00 2 Reserved 5207 ************************************************************************** 5208 */ 5209 #define ARCMSR_MU_INBOUND_POST_HEAD_PTR_REG 0xFFFFE368 5210 /* 5211 ************************************************************************** 5212 ** Inbound Post Tail Pointer Register - IPTPR 5213 ** 5214 ** . The Inbound Post Tail Pointer Register (IPTPR) contains the local memory offset from the Queue 5215 ** Base Address of the tail pointer for the Inbound Post Queue. The Tail Pointer must be aligned on a 5216 ** DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits 5217 ** of the register. Writes to the upper 12 bits of the register are ignored. 5218 ** ------------------------------------------------------------------------ 5219 ** Bit Default Description 5220 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 5221 ** 19:02 0000H 00 2 Inbound Post Tail Pointer - Local memory offset of the tail pointer for the Inbound Post Queue. 5222 ** 01:00 00 2 Reserved 5223 ************************************************************************** 5224 */ 5225 #define ARCMSR_MU_INBOUND_POST_TAIL_PTR_REG 0xFFFFE36C 5226 /* 5227 ************************************************************************** 5228 ** Index Address Register - IAR 5229 ** 5230 ** . The Index Address Register (IAR) contains the offset of the least recently accessed Index Register. 5231 ** It is written by the MU when the Index Registers are written by a PCI agent. 5232 ** The register is not updated until the Index Interrupt bit in the Inbound Interrupt Status Register is cleared. 5233 ** . The local memory address of the Index Register least recently accessed is computed 5234 ** by adding the Index Address Register to the Inbound ATU Translate Value Register. 5235 ** ------------------------------------------------------------------------ 5236 ** Bit Default Description 5237 ** 31:12 000000H Reserved 5238 ** 11:02 00H 00 2 Index Address - is the local memory offset of the Index Register written (050H to FFCH) 5239 ** 01:00 00 2 Reserved 5240 ************************************************************************** 5241 */ 5242 #define ARCMSR_MU_LOCAL_MEMORY_INDEX_REG 0xFFFFE380 /*1004 dwords 0x0050....0x0FFC, 4016 bytes 0x0050...0x0FFF*/ 5243 /* 5244 ********************************************************************************************************** 5245 ** RS-232 Interface for Areca Raid Controller 5246 ** The low level command interface is exclusive with VT100 terminal 5247 ** -------------------------------------------------------------------- 5248 ** 1. Sequence of command execution 5249 ** -------------------------------------------------------------------- 5250 ** (A) Header : 3 bytes sequence (0x5E, 0x01, 0x61) 5251 ** (B) Command block : variable length of data including length, command code, data and checksum byte 5252 ** (C) Return data : variable length of data 5253 ** -------------------------------------------------------------------- 5254 ** 2. Command block 5255 ** -------------------------------------------------------------------- 5256 ** (A) 1st byte : command block length (low byte) 5257 ** (B) 2nd byte : command block length (high byte) 5258 ** note ..command block length shouldn't > 2040 bytes, length excludes these two bytes 5259 ** (C) 3rd byte : command code 5260 ** (D) 4th and following bytes : variable length data bytes depends on command code 5261 ** (E) last byte : checksum byte (sum of 1st byte until last data byte) 5262 ** -------------------------------------------------------------------- 5263 ** 3. Command code and associated data 5264 ** -------------------------------------------------------------------- 5265 ** The following are command code defined in raid controller Command code 0x10--0x1? are used for system level management, 5266 ** no password checking is needed and should be implemented in separate well controlled utility and not for end user access. 5267 ** Command code 0x20--0x?? always check the password, password must be entered to enable these command. 5268 ** enum 5269 ** { 5270 ** GUI_SET_SERIAL=0x10, 5271 ** GUI_SET_VENDOR, 5272 ** GUI_SET_MODEL, 5273 ** GUI_IDENTIFY, 5274 ** GUI_CHECK_PASSWORD, 5275 ** GUI_LOGOUT, 5276 ** GUI_HTTP, 5277 ** GUI_SET_ETHERNET_ADDR, 5278 ** GUI_SET_LOGO, 5279 ** GUI_POLL_EVENT, 5280 ** GUI_GET_EVENT, 5281 ** GUI_GET_HW_MONITOR, 5282 ** 5283 ** // GUI_QUICK_CREATE=0x20, (function removed) 5284 ** GUI_GET_INFO_R=0x20, 5285 ** GUI_GET_INFO_V, 5286 ** GUI_GET_INFO_P, 5287 ** GUI_GET_INFO_S, 5288 ** GUI_CLEAR_EVENT, 5289 ** 5290 ** GUI_MUTE_BEEPER=0x30, 5291 ** GUI_BEEPER_SETTING, 5292 ** GUI_SET_PASSWORD, 5293 ** GUI_HOST_INTERFACE_MODE, 5294 ** GUI_REBUILD_PRIORITY, 5295 ** GUI_MAX_ATA_MODE, 5296 ** GUI_RESET_CONTROLLER, 5297 ** GUI_COM_PORT_SETTING, 5298 ** GUI_NO_OPERATION, 5299 ** GUI_DHCP_IP, 5300 ** 5301 ** GUI_CREATE_PASS_THROUGH=0x40, 5302 ** GUI_MODIFY_PASS_THROUGH, 5303 ** GUI_DELETE_PASS_THROUGH, 5304 ** GUI_IDENTIFY_DEVICE, 5305 ** 5306 ** GUI_CREATE_RAIDSET=0x50, 5307 ** GUI_DELETE_RAIDSET, 5308 ** GUI_EXPAND_RAIDSET, 5309 ** GUI_ACTIVATE_RAIDSET, 5310 ** GUI_CREATE_HOT_SPARE, 5311 ** GUI_DELETE_HOT_SPARE, 5312 ** 5313 ** GUI_CREATE_VOLUME=0x60, 5314 ** GUI_MODIFY_VOLUME, 5315 ** GUI_DELETE_VOLUME, 5316 ** GUI_START_CHECK_VOLUME, 5317 ** GUI_STOP_CHECK_VOLUME 5318 ** }; 5319 ** 5320 ** Command description : 5321 ** 5322 ** GUI_SET_SERIAL : Set the controller serial# 5323 ** byte 0,1 : length 5324 ** byte 2 : command code 0x10 5325 ** byte 3 : password length (should be 0x0f) 5326 ** byte 4-0x13 : should be "ArEcATecHnoLogY" 5327 ** byte 0x14--0x23 : Serial number string (must be 16 bytes) 5328 ** GUI_SET_VENDOR : Set vendor string for the controller 5329 ** byte 0,1 : length 5330 ** byte 2 : command code 0x11 5331 ** byte 3 : password length (should be 0x08) 5332 ** byte 4-0x13 : should be "ArEcAvAr" 5333 ** byte 0x14--0x3B : vendor string (must be 40 bytes) 5334 ** GUI_SET_MODEL : Set the model name of the controller 5335 ** byte 0,1 : length 5336 ** byte 2 : command code 0x12 5337 ** byte 3 : password length (should be 0x08) 5338 ** byte 4-0x13 : should be "ArEcAvAr" 5339 ** byte 0x14--0x1B : model string (must be 8 bytes) 5340 ** GUI_IDENTIFY : Identify device 5341 ** byte 0,1 : length 5342 ** byte 2 : command code 0x13 5343 ** return "Areca RAID Subsystem " 5344 ** GUI_CHECK_PASSWORD : Verify password 5345 ** byte 0,1 : length 5346 ** byte 2 : command code 0x14 5347 ** byte 3 : password length 5348 ** byte 4-0x?? : user password to be checked 5349 ** GUI_LOGOUT : Logout GUI (force password checking on next command) 5350 ** byte 0,1 : length 5351 ** byte 2 : command code 0x15 5352 ** GUI_HTTP : HTTP interface (reserved for Http proxy service)(0x16) 5353 ** 5354 ** GUI_SET_ETHERNET_ADDR : Set the ethernet MAC address 5355 ** byte 0,1 : length 5356 ** byte 2 : command code 0x17 5357 ** byte 3 : password length (should be 0x08) 5358 ** byte 4-0x13 : should be "ArEcAvAr" 5359 ** byte 0x14--0x19 : Ethernet MAC address (must be 6 bytes) 5360 ** GUI_SET_LOGO : Set logo in HTTP 5361 ** byte 0,1 : length 5362 ** byte 2 : command code 0x18 5363 ** byte 3 : Page# (0/1/2/3) (0xff --> clear OEM logo) 5364 ** byte 4/5/6/7 : 0x55/0xaa/0xa5/0x5a 5365 ** byte 8 : TITLE.JPG data (each page must be 2000 bytes) 5366 ** note .... page0 1st 2 byte must be actual length of the JPG file 5367 ** GUI_POLL_EVENT : Poll If Event Log Changed 5368 ** byte 0,1 : length 5369 ** byte 2 : command code 0x19 5370 ** GUI_GET_EVENT : Read Event 5371 ** byte 0,1 : length 5372 ** byte 2 : command code 0x1a 5373 ** byte 3 : Event Page (0:1st page/1/2/3:last page) 5374 ** GUI_GET_HW_MONITOR : Get HW monitor data 5375 ** byte 0,1 : length 5376 ** byte 2 : command code 0x1b 5377 ** byte 3 : # of FANs(example 2) 5378 ** byte 4 : # of Voltage sensor(example 3) 5379 ** byte 5 : # of temperature sensor(example 2) 5380 ** byte 6 : # of power 5381 ** byte 7/8 : Fan#0 (RPM) 5382 ** byte 9/10 : Fan#1 5383 ** byte 11/12 : Voltage#0 original value in *1000 5384 ** byte 13/14 : Voltage#0 value 5385 ** byte 15/16 : Voltage#1 org 5386 ** byte 17/18 : Voltage#1 5387 ** byte 19/20 : Voltage#2 org 5388 ** byte 21/22 : Voltage#2 5389 ** byte 23 : Temp#0 5390 ** byte 24 : Temp#1 5391 ** byte 25 : Power indicator (bit0 : power#0, bit1 : power#1) 5392 ** byte 26 : UPS indicator 5393 ** GUI_QUICK_CREATE : Quick create raid/volume set 5394 ** byte 0,1 : length 5395 ** byte 2 : command code 0x20 5396 ** byte 3/4/5/6 : raw capacity 5397 ** byte 7 : raid level 5398 ** byte 8 : stripe size 5399 ** byte 9 : spare 5400 ** byte 10/11/12/13: device mask (the devices to create raid/volume) 5401 ** This function is removed, application like to implement quick create function 5402 ** need to use GUI_CREATE_RAIDSET and GUI_CREATE_VOLUMESET function. 5403 ** GUI_GET_INFO_R : Get Raid Set Information 5404 ** byte 0,1 : length 5405 ** byte 2 : command code 0x20 5406 ** byte 3 : raidset# 5407 ** 5408 ** typedef struct sGUI_RAIDSET 5409 ** { 5410 ** BYTE grsRaidSetName[16]; 5411 ** DWORD grsCapacity; 5412 ** DWORD grsCapacityX; 5413 ** DWORD grsFailMask; 5414 ** BYTE grsDevArray[32]; 5415 ** BYTE grsMemberDevices; 5416 ** BYTE grsNewMemberDevices; 5417 ** BYTE grsRaidState; 5418 ** BYTE grsVolumes; 5419 ** BYTE grsVolumeList[16]; 5420 ** BYTE grsRes1; 5421 ** BYTE grsRes2; 5422 ** BYTE grsRes3; 5423 ** BYTE grsFreeSegments; 5424 ** DWORD grsRawStripes[8]; 5425 ** DWORD grsRes4; 5426 ** DWORD grsRes5; // Total to 128 bytes 5427 ** DWORD grsRes6; // Total to 128 bytes 5428 ** } sGUI_RAIDSET, *pGUI_RAIDSET; 5429 ** GUI_GET_INFO_V : Get Volume Set Information 5430 ** byte 0,1 : length 5431 ** byte 2 : command code 0x21 5432 ** byte 3 : volumeset# 5433 ** 5434 ** typedef struct sGUI_VOLUMESET 5435 ** { 5436 ** BYTE gvsVolumeName[16]; // 16 5437 ** DWORD gvsCapacity; 5438 ** DWORD gvsCapacityX; 5439 ** DWORD gvsFailMask; 5440 ** DWORD gvsStripeSize; 5441 ** DWORD gvsNewFailMask; 5442 ** DWORD gvsNewStripeSize; 5443 ** DWORD gvsVolumeStatus; 5444 ** DWORD gvsProgress; // 32 5445 ** sSCSI_ATTR gvsScsi; 5446 ** BYTE gvsMemberDisks; 5447 ** BYTE gvsRaidLevel; // 8 5448 ** 5449 ** BYTE gvsNewMemberDisks; 5450 ** BYTE gvsNewRaidLevel; 5451 ** BYTE gvsRaidSetNumber; 5452 ** BYTE gvsRes0; // 4 5453 ** BYTE gvsRes1[4]; // 64 bytes 5454 ** } sGUI_VOLUMESET, *pGUI_VOLUMESET; 5455 ** 5456 ** GUI_GET_INFO_P : Get Physical Drive Information 5457 ** byte 0,1 : length 5458 ** byte 2 : command code 0x22 5459 ** byte 3 : drive # (from 0 to max-channels - 1) 5460 ** 5461 ** typedef struct sGUI_PHY_DRV 5462 ** { 5463 ** BYTE gpdModelName[40]; 5464 ** BYTE gpdSerialNumber[20]; 5465 ** BYTE gpdFirmRev[8]; 5466 ** DWORD gpdCapacity; 5467 ** DWORD gpdCapacityX; // Reserved for expansion 5468 ** BYTE gpdDeviceState; 5469 ** BYTE gpdPioMode; 5470 ** BYTE gpdCurrentUdmaMode; 5471 ** BYTE gpdUdmaMode; 5472 ** BYTE gpdDriveSelect; 5473 ** BYTE gpdRaidNumber; // 0xff if not belongs to a raid set 5474 ** sSCSI_ATTR gpdScsi; 5475 ** BYTE gpdReserved[40]; // Total to 128 bytes 5476 ** } sGUI_PHY_DRV, *pGUI_PHY_DRV; 5477 ** 5478 ** GUI_GET_INFO_S : Get System Information 5479 ** byte 0,1 : length 5480 ** byte 2 : command code 0x23 5481 ** 5482 ** typedef struct sCOM_ATTR 5483 ** { 5484 ** BYTE comBaudRate; 5485 ** BYTE comDataBits; 5486 ** BYTE comStopBits; 5487 ** BYTE comParity; 5488 ** BYTE comFlowControl; 5489 ** } sCOM_ATTR, *pCOM_ATTR; 5490 ** 5491 ** typedef struct sSYSTEM_INFO 5492 ** { 5493 ** BYTE gsiVendorName[40]; 5494 ** BYTE gsiSerialNumber[16]; 5495 ** BYTE gsiFirmVersion[16]; 5496 ** BYTE gsiBootVersion[16]; 5497 ** BYTE gsiMbVersion[16]; 5498 ** BYTE gsiModelName[8]; 5499 ** BYTE gsiLocalIp[4]; 5500 ** BYTE gsiCurrentIp[4]; 5501 ** DWORD gsiTimeTick; 5502 ** DWORD gsiCpuSpeed; 5503 ** DWORD gsiICache; 5504 ** DWORD gsiDCache; 5505 ** DWORD gsiScache; 5506 ** DWORD gsiMemorySize; 5507 ** DWORD gsiMemorySpeed; 5508 ** DWORD gsiEvents; 5509 ** BYTE gsiMacAddress[6]; 5510 ** BYTE gsiDhcp; 5511 ** BYTE gsiBeeper; 5512 ** BYTE gsiChannelUsage; 5513 ** BYTE gsiMaxAtaMode; 5514 ** BYTE gsiSdramEcc; // 1:if ECC enabled 5515 ** BYTE gsiRebuildPriority; 5516 ** sCOM_ATTR gsiComA; // 5 bytes 5517 ** sCOM_ATTR gsiComB; // 5 bytes 5518 ** BYTE gsiIdeChannels; 5519 ** BYTE gsiScsiHostChannels; 5520 ** BYTE gsiIdeHostChannels; 5521 ** BYTE gsiMaxVolumeSet; 5522 ** BYTE gsiMaxRaidSet; 5523 ** BYTE gsiEtherPort; // 1:if ether net port supported 5524 ** BYTE gsiRaid6Engine; // 1:Raid6 engine supported 5525 ** BYTE gsiRes[75]; 5526 ** } sSYSTEM_INFO, *pSYSTEM_INFO; 5527 ** 5528 ** GUI_CLEAR_EVENT : Clear System Event 5529 ** byte 0,1 : length 5530 ** byte 2 : command code 0x24 5531 ** 5532 ** GUI_MUTE_BEEPER : Mute current beeper 5533 ** byte 0,1 : length 5534 ** byte 2 : command code 0x30 5535 ** 5536 ** GUI_BEEPER_SETTING : Disable beeper 5537 ** byte 0,1 : length 5538 ** byte 2 : command code 0x31 5539 ** byte 3 : 0->disable, 1->enable 5540 ** 5541 ** GUI_SET_PASSWORD : Change password 5542 ** byte 0,1 : length 5543 ** byte 2 : command code 0x32 5544 ** byte 3 : pass word length ( must <= 15 ) 5545 ** byte 4 : password (must be alpha-numerical) 5546 ** 5547 ** GUI_HOST_INTERFACE_MODE : Set host interface mode 5548 ** byte 0,1 : length 5549 ** byte 2 : command code 0x33 5550 ** byte 3 : 0->Independent, 1->cluster 5551 ** 5552 ** GUI_REBUILD_PRIORITY : Set rebuild priority 5553 ** byte 0,1 : length 5554 ** byte 2 : command code 0x34 5555 ** byte 3 : 0/1/2/3 (low->high) 5556 ** 5557 ** GUI_MAX_ATA_MODE : Set maximum ATA mode to be used 5558 ** byte 0,1 : length 5559 ** byte 2 : command code 0x35 5560 ** byte 3 : 0/1/2/3 (133/100/66/33) 5561 ** 5562 ** GUI_RESET_CONTROLLER : Reset Controller 5563 ** byte 0,1 : length 5564 ** byte 2 : command code 0x36 5565 ** *Response with VT100 screen (discard it) 5566 ** 5567 ** GUI_COM_PORT_SETTING : COM port setting 5568 ** byte 0,1 : length 5569 ** byte 2 : command code 0x37 5570 ** byte 3 : 0->COMA (term port), 1->COMB (debug port) 5571 ** byte 4 : 0/1/2/3/4/5/6/7 (1200/2400/4800/9600/19200/38400/57600/115200) 5572 ** byte 5 : data bit (0:7 bit, 1:8 bit : must be 8 bit) 5573 ** byte 6 : stop bit (0:1, 1:2 stop bits) 5574 ** byte 7 : parity (0:none, 1:off, 2:even) 5575 ** byte 8 : flow control (0:none, 1:xon/xoff, 2:hardware => must use none) 5576 ** 5577 ** GUI_NO_OPERATION : No operation 5578 ** byte 0,1 : length 5579 ** byte 2 : command code 0x38 5580 ** 5581 ** GUI_DHCP_IP : Set DHCP option and local IP address 5582 ** byte 0,1 : length 5583 ** byte 2 : command code 0x39 5584 ** byte 3 : 0:dhcp disabled, 1:dhcp enabled 5585 ** byte 4/5/6/7 : IP address 5586 ** 5587 ** GUI_CREATE_PASS_THROUGH : Create pass through disk 5588 ** byte 0,1 : length 5589 ** byte 2 : command code 0x40 5590 ** byte 3 : device # 5591 ** byte 4 : scsi channel (0/1) 5592 ** byte 5 : scsi id (0-->15) 5593 ** byte 6 : scsi lun (0-->7) 5594 ** byte 7 : tagged queue (1 : enabled) 5595 ** byte 8 : cache mode (1 : enabled) 5596 ** byte 9 : max speed (0/1/2/3/4, async/20/40/80/160 for scsi) 5597 ** (0/1/2/3/4, 33/66/100/133/150 for ide ) 5598 ** 5599 ** GUI_MODIFY_PASS_THROUGH : Modify pass through disk 5600 ** byte 0,1 : length 5601 ** byte 2 : command code 0x41 5602 ** byte 3 : device # 5603 ** byte 4 : scsi channel (0/1) 5604 ** byte 5 : scsi id (0-->15) 5605 ** byte 6 : scsi lun (0-->7) 5606 ** byte 7 : tagged queue (1 : enabled) 5607 ** byte 8 : cache mode (1 : enabled) 5608 ** byte 9 : max speed (0/1/2/3/4, async/20/40/80/160 for scsi) 5609 ** (0/1/2/3/4, 33/66/100/133/150 for ide ) 5610 ** 5611 ** GUI_DELETE_PASS_THROUGH : Delete pass through disk 5612 ** byte 0,1 : length 5613 ** byte 2 : command code 0x42 5614 ** byte 3 : device# to be deleted 5615 ** 5616 ** GUI_IDENTIFY_DEVICE : Identify Device 5617 ** byte 0,1 : length 5618 ** byte 2 : command code 0x43 5619 ** byte 3 : Flash Method(0:flash selected, 1:flash not selected) 5620 ** byte 4/5/6/7 : IDE device mask to be flashed 5621 ** note .... no response data available 5622 ** 5623 ** GUI_CREATE_RAIDSET : Create Raid Set 5624 ** byte 0,1 : length 5625 ** byte 2 : command code 0x50 5626 ** byte 3/4/5/6 : device mask 5627 ** byte 7-22 : raidset name (if byte 7 == 0:use default) 5628 ** 5629 ** GUI_DELETE_RAIDSET : Delete Raid Set 5630 ** byte 0,1 : length 5631 ** byte 2 : command code 0x51 5632 ** byte 3 : raidset# 5633 ** 5634 ** GUI_EXPAND_RAIDSET : Expand Raid Set 5635 ** byte 0,1 : length 5636 ** byte 2 : command code 0x52 5637 ** byte 3 : raidset# 5638 ** byte 4/5/6/7 : device mask for expansion 5639 ** 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 ) 5640 ** byte 11/12/13 : repeat for each volume in the raidset .... 5641 ** 5642 ** GUI_ACTIVATE_RAIDSET : Activate incomplete raid set 5643 ** byte 0,1 : length 5644 ** byte 2 : command code 0x53 5645 ** byte 3 : raidset# 5646 ** 5647 ** GUI_CREATE_HOT_SPARE : Create hot spare disk 5648 ** byte 0,1 : length 5649 ** byte 2 : command code 0x54 5650 ** byte 3/4/5/6 : device mask for hot spare creation 5651 ** 5652 ** GUI_DELETE_HOT_SPARE : Delete hot spare disk 5653 ** byte 0,1 : length 5654 ** byte 2 : command code 0x55 5655 ** byte 3/4/5/6 : device mask for hot spare deletion 5656 ** 5657 ** GUI_CREATE_VOLUME : Create volume set 5658 ** byte 0,1 : length 5659 ** byte 2 : command code 0x60 5660 ** byte 3 : raidset# 5661 ** byte 4-19 : volume set name (if byte4 == 0, use default) 5662 ** byte 20-27 : volume capacity (blocks) 5663 ** byte 28 : raid level 5664 ** byte 29 : stripe size (0/1/2/3/4/5->4/8/16/32/64/128K) 5665 ** byte 30 : channel 5666 ** byte 31 : ID 5667 ** byte 32 : LUN 5668 ** byte 33 : 1 enable tag 5669 ** byte 34 : 1 enable cache 5670 ** byte 35 : speed (0/1/2/3/4->async/20/40/80/160 for scsi) 5671 ** (0/1/2/3/4->33/66/100/133/150 for IDE ) 5672 ** byte 36 : 1 to select quick init 5673 ** 5674 ** GUI_MODIFY_VOLUME : Modify volume Set 5675 ** byte 0,1 : length 5676 ** byte 2 : command code 0x61 5677 ** byte 3 : volumeset# 5678 ** byte 4-19 : new volume set name (if byte4 == 0, not change) 5679 ** byte 20-27 : new volume capacity (reserved) 5680 ** byte 28 : new raid level 5681 ** byte 29 : new stripe size (0/1/2/3/4/5->4/8/16/32/64/128K) 5682 ** byte 30 : new channel 5683 ** byte 31 : new ID 5684 ** byte 32 : new LUN 5685 ** byte 33 : 1 enable tag 5686 ** byte 34 : 1 enable cache 5687 ** byte 35 : speed (0/1/2/3/4->async/20/40/80/160 for scsi) 5688 ** (0/1/2/3/4->33/66/100/133/150 for IDE ) 5689 ** 5690 ** GUI_DELETE_VOLUME : Delete volume set 5691 ** byte 0,1 : length 5692 ** byte 2 : command code 0x62 5693 ** byte 3 : volumeset# 5694 ** 5695 ** GUI_START_CHECK_VOLUME : Start volume consistency check 5696 ** byte 0,1 : length 5697 ** byte 2 : command code 0x63 5698 ** byte 3 : volumeset# 5699 ** 5700 ** GUI_STOP_CHECK_VOLUME : Stop volume consistency check 5701 ** byte 0,1 : length 5702 ** byte 2 : command code 0x64 5703 ** --------------------------------------------------------------------- 5704 ** 4. Returned data 5705 ** --------------------------------------------------------------------- 5706 ** (A) Header : 3 bytes sequence (0x5E, 0x01, 0x61) 5707 ** (B) Length : 2 bytes (low byte 1st, excludes length and checksum byte) 5708 ** (C) status or data : 5709 ** <1> If length == 1 ==> 1 byte status code 5710 ** #define GUI_OK 0x41 5711 ** #define GUI_RAIDSET_NOT_NORMAL 0x42 5712 ** #define GUI_VOLUMESET_NOT_NORMAL 0x43 5713 ** #define GUI_NO_RAIDSET 0x44 5714 ** #define GUI_NO_VOLUMESET 0x45 5715 ** #define GUI_NO_PHYSICAL_DRIVE 0x46 5716 ** #define GUI_PARAMETER_ERROR 0x47 5717 ** #define GUI_UNSUPPORTED_COMMAND 0x48 5718 ** #define GUI_DISK_CONFIG_CHANGED 0x49 5719 ** #define GUI_INVALID_PASSWORD 0x4a 5720 ** #define GUI_NO_DISK_SPACE 0x4b 5721 ** #define GUI_CHECKSUM_ERROR 0x4c 5722 ** #define GUI_PASSWORD_REQUIRED 0x4d 5723 ** <2> If length > 1 ==> data block returned from controller and the contents depends on the command code 5724 ** (E) Checksum : checksum of length and status or data byte 5725 ************************************************************************** 5726 */ 5727