1 /* 2 *********************************************************************************************** 3 ** O.S : FreeBSD 4 ** FILE NAME : arcmsr.h 5 ** BY : Erich Chen, Ching Huang 6 ** Description: SCSI RAID Device Driver for 7 ** ARECA SATA/SAS RAID HOST Adapter 8 ** [RAID controller:INTEL 331(PCI-X) 341(PCI-EXPRESS) chip set] 9 *********************************************************************************************** 10 ************************************************************************ 11 ** Copyright (C) 2002 - 2010, Areca Technology Corporation All rights reserved. 12 ** 13 ** Web site: www.areca.com.tw 14 ** E-mail: erich@areca.com.tw; ching2048@areca.com.tw 15 ** 16 ** Redistribution and use in source and binary forms,with or without 17 ** modification,are permitted provided that the following conditions 18 ** are met: 19 ** 1. Redistributions of source code must retain the above copyright 20 ** notice,this list of conditions and the following disclaimer. 21 ** 2. Redistributions in binary form must reproduce the above copyright 22 ** notice,this list of conditions and the following disclaimer in the 23 ** documentation and/or other materials provided with the distribution. 24 ** 3. The name of the author may not be used to endorse or promote products 25 ** derived from this software without specific prior written permission. 26 ** 27 ** THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 28 ** IMPLIED WARRANTIES,INCLUDING,BUT NOT LIMITED TO,THE IMPLIED WARRANTIES 29 ** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 30 ** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,INDIRECT, 31 ** INCIDENTAL,SPECIAL,EXEMPLARY,OR CONSEQUENTIAL DAMAGES(INCLUDING,BUT 32 ** NOT LIMITED TO,PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 33 ** DATA,OR PROFITS; OR BUSINESS INTERRUPTION)HOWEVER CAUSED AND ON ANY 34 ** THEORY OF LIABILITY,WHETHER IN CONTRACT,STRICT LIABILITY,OR TORT 35 **(INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN ANY WAY OUT OF THE USE OF 36 ** THIS SOFTWARE,EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 37 ************************************************************************** 38 * $FreeBSD: src/sys/dev/arcmsr/arcmsr.h,v 1.8 2010/11/13 08:58:36 delphij Exp $ 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 257 48 #define ARCMSR_MAX_CMD_PERLUN ARCMSR_MAX_OUTSTANDING_CMD 49 #define ARCMSR_MAX_FREESRB_NUM 320 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 /* 56 ********************************************************************* 57 */ 58 #ifndef TRUE 59 #define TRUE 1 60 #endif 61 #ifndef FALSE 62 #define FALSE 0 63 #endif 64 #ifndef INTR_ENTROPY 65 # define INTR_ENTROPY 0 66 #endif 67 68 #ifndef offsetof 69 #define offsetof(type, member) ((size_t)(&((type *)0)->member)) 70 #endif 71 /* 72 ********************************************************************************** 73 ** 74 ********************************************************************************** 75 */ 76 #define PCI_VENDOR_ID_ARECA 0x17D3 /* Vendor ID */ 77 #define PCI_DEVICE_ID_ARECA_1110 0x1110 /* Device ID */ 78 #define PCI_DEVICE_ID_ARECA_1120 0x1120 /* Device ID */ 79 #define PCI_DEVICE_ID_ARECA_1130 0x1130 /* Device ID */ 80 #define PCI_DEVICE_ID_ARECA_1160 0x1160 /* Device ID */ 81 #define PCI_DEVICE_ID_ARECA_1170 0x1170 /* Device ID */ 82 #define PCI_DEVICE_ID_ARECA_1200 0x1200 /* Device ID */ 83 #define PCI_DEVICE_ID_ARECA_1201 0x1201 /* Device ID */ 84 #define PCI_DEVICE_ID_ARECA_1210 0x1210 /* Device ID */ 85 #define PCI_DEVICE_ID_ARECA_1212 0x1212 /* Device ID */ 86 #define PCI_DEVICE_ID_ARECA_1220 0x1220 /* Device ID */ 87 #define PCI_DEVICE_ID_ARECA_1222 0x1222 /* Device ID */ 88 #define PCI_DEVICE_ID_ARECA_1230 0x1230 /* Device ID */ 89 #define PCI_DEVICE_ID_ARECA_1231 0x1231 /* Device ID */ 90 #define PCI_DEVICE_ID_ARECA_1260 0x1260 /* Device ID */ 91 #define PCI_DEVICE_ID_ARECA_1261 0x1261 /* Device ID */ 92 #define PCI_DEVICE_ID_ARECA_1270 0x1270 /* Device ID */ 93 #define PCI_DEVICE_ID_ARECA_1280 0x1280 /* Device ID */ 94 #define PCI_DEVICE_ID_ARECA_1380 0x1380 /* Device ID */ 95 #define PCI_DEVICE_ID_ARECA_1381 0x1381 /* Device ID */ 96 #define PCI_DEVICE_ID_ARECA_1680 0x1680 /* Device ID */ 97 #define PCI_DEVICE_ID_ARECA_1681 0x1681 /* Device ID */ 98 #define PCI_DEVICE_ID_ARECA_1880 0x1880 /* Device ID */ 99 100 #define PCIDevVenIDARC1110 0x111017D3 /* Vendor Device ID */ 101 #define PCIDevVenIDARC1120 0x112017D3 /* Vendor Device ID */ 102 #define PCIDevVenIDARC1130 0x113017D3 /* Vendor Device ID */ 103 #define PCIDevVenIDARC1160 0x116017D3 /* Vendor Device ID */ 104 #define PCIDevVenIDARC1170 0x117017D3 /* Vendor Device ID */ 105 #define PCIDevVenIDARC1200 0x120017D3 /* Vendor Device ID */ 106 #define PCIDevVenIDARC1201 0x120117D3 /* Vendor Device ID */ 107 #define PCIDevVenIDARC1210 0x121017D3 /* Vendor Device ID */ 108 #define PCIDevVenIDARC1212 0x121217D3 /* Vendor Device ID */ 109 #define PCIDevVenIDARC1220 0x122017D3 /* Vendor Device ID */ 110 #define PCIDevVenIDARC1222 0x122217D3 /* Vendor Device ID */ 111 #define PCIDevVenIDARC1230 0x123017D3 /* Vendor Device ID */ 112 #define PCIDevVenIDARC1231 0x123117D3 /* Vendor Device ID */ 113 #define PCIDevVenIDARC1260 0x126017D3 /* Vendor Device ID */ 114 #define PCIDevVenIDARC1261 0x126117D3 /* Vendor Device ID */ 115 #define PCIDevVenIDARC1270 0x127017D3 /* Vendor Device ID */ 116 #define PCIDevVenIDARC1280 0x128017D3 /* Vendor Device ID */ 117 #define PCIDevVenIDARC1380 0x138017D3 /* Vendor Device ID */ 118 #define PCIDevVenIDARC1381 0x138117D3 /* Vendor Device ID */ 119 #define PCIDevVenIDARC1680 0x168017D3 /* Vendor Device ID */ 120 #define PCIDevVenIDARC1681 0x168117D3 /* Vendor Device ID */ 121 #define PCIDevVenIDARC1880 0x188017D3 /* Vendor Device ID */ 122 123 #ifndef PCIR_BARS 124 #define PCIR_BARS 0x10 125 #define PCIR_BAR(x) (PCIR_BARS + (x) * 4) 126 #endif 127 128 #define PCI_BASE_ADDR0 0x10 129 #define PCI_BASE_ADDR1 0x14 130 #define PCI_BASE_ADDR2 0x18 131 #define PCI_BASE_ADDR3 0x1C 132 #define PCI_BASE_ADDR4 0x20 133 #define PCI_BASE_ADDR5 0x24 134 /* 135 ********************************************************************************** 136 ** 137 ********************************************************************************** 138 */ 139 #define ARCMSR_SCSICMD_IOCTL 0x77 140 #define ARCMSR_CDEVSW_IOCTL 0x88 141 #define ARCMSR_MESSAGE_FAIL 0x0001 142 #define ARCMSR_MESSAGE_SUCCESS 0x0000 143 /* 144 ********************************************************************************** 145 ** 146 ********************************************************************************** 147 */ 148 #define arcmsr_ccbsrb_ptr spriv_ptr0 149 #define arcmsr_ccbacb_ptr spriv_ptr1 150 #define dma_addr_hi32(addr) (u_int32_t) ((addr>>16)>>16) 151 #define dma_addr_lo32(addr) (u_int32_t) (addr & 0xffffffff) 152 #define get_min(x,y) ((x) < (y) ? (x) : (y)) 153 #define get_max(x,y) ((x) < (y) ? (y) : (x)) 154 /* 155 ********************************************************************************** 156 ** 157 ********************************************************************************** 158 */ 159 struct CMD_MESSAGE { 160 u_int32_t HeaderLength; 161 u_int8_t Signature[8]; 162 u_int32_t Timeout; 163 u_int32_t ControlCode; 164 u_int32_t ReturnCode; 165 u_int32_t Length; 166 }; 167 168 struct CMD_MESSAGE_FIELD { 169 struct CMD_MESSAGE cmdmessage; /* ioctl header */ 170 u_int8_t messagedatabuffer[1032]; /* areca gui program does not accept more than 1031 byte */ 171 }; 172 173 /************************************************************************/ 174 /************************************************************************/ 175 176 #define ARCMSR_IOP_ERROR_ILLEGALPCI 0x0001 177 #define ARCMSR_IOP_ERROR_VENDORID 0x0002 178 #define ARCMSR_IOP_ERROR_DEVICEID 0x0002 179 #define ARCMSR_IOP_ERROR_ILLEGALCDB 0x0003 180 #define ARCMSR_IOP_ERROR_UNKNOW_CDBERR 0x0004 181 #define ARCMSR_SYS_ERROR_MEMORY_ALLOCATE 0x0005 182 #define ARCMSR_SYS_ERROR_MEMORY_CROSS4G 0x0006 183 #define ARCMSR_SYS_ERROR_MEMORY_LACK 0x0007 184 #define ARCMSR_SYS_ERROR_MEMORY_RANGE 0x0008 185 #define ARCMSR_SYS_ERROR_DEVICE_BASE 0x0009 186 #define ARCMSR_SYS_ERROR_PORT_VALIDATE 0x000A 187 188 /*DeviceType*/ 189 #define ARECA_SATA_RAID 0x90000000 190 191 /*FunctionCode*/ 192 #define FUNCTION_READ_RQBUFFER 0x0801 193 #define FUNCTION_WRITE_WQBUFFER 0x0802 194 #define FUNCTION_CLEAR_RQBUFFER 0x0803 195 #define FUNCTION_CLEAR_WQBUFFER 0x0804 196 #define FUNCTION_CLEAR_ALLQBUFFER 0x0805 197 #define FUNCTION_REQUEST_RETURNCODE_3F 0x0806 198 #define FUNCTION_SAY_HELLO 0x0807 199 #define FUNCTION_SAY_GOODBYE 0x0808 200 #define FUNCTION_FLUSH_ADAPTER_CACHE 0x0809 201 /* 202 ************************************************************************ 203 ** IOCTL CONTROL CODE 204 ************************************************************************ 205 */ 206 /* ARECA IO CONTROL CODE*/ 207 #define ARCMSR_MESSAGE_READ_RQBUFFER _IOWR('F', FUNCTION_READ_RQBUFFER, struct CMD_MESSAGE_FIELD) 208 #define ARCMSR_MESSAGE_WRITE_WQBUFFER _IOWR('F', FUNCTION_WRITE_WQBUFFER, struct CMD_MESSAGE_FIELD) 209 #define ARCMSR_MESSAGE_CLEAR_RQBUFFER _IOWR('F', FUNCTION_CLEAR_RQBUFFER, struct CMD_MESSAGE_FIELD) 210 #define ARCMSR_MESSAGE_CLEAR_WQBUFFER _IOWR('F', FUNCTION_CLEAR_WQBUFFER, struct CMD_MESSAGE_FIELD) 211 #define ARCMSR_MESSAGE_CLEAR_ALLQBUFFER _IOWR('F', FUNCTION_CLEAR_ALLQBUFFER, struct CMD_MESSAGE_FIELD) 212 #define ARCMSR_MESSAGE_REQUEST_RETURNCODE_3F _IOWR('F', FUNCTION_REQUEST_RETURNCODE_3F, struct CMD_MESSAGE_FIELD) 213 #define ARCMSR_MESSAGE_SAY_HELLO _IOWR('F', FUNCTION_SAY_HELLO, struct CMD_MESSAGE_FIELD) 214 #define ARCMSR_MESSAGE_SAY_GOODBYE _IOWR('F', FUNCTION_SAY_GOODBYE, struct CMD_MESSAGE_FIELD) 215 #define ARCMSR_MESSAGE_FLUSH_ADAPTER_CACHE _IOWR('F', FUNCTION_FLUSH_ADAPTER_CACHE, struct CMD_MESSAGE_FIELD) 216 217 /* ARECA IOCTL ReturnCode */ 218 #define ARCMSR_MESSAGE_RETURNCODE_OK 0x00000001 219 #define ARCMSR_MESSAGE_RETURNCODE_ERROR 0x00000006 220 #define ARCMSR_MESSAGE_RETURNCODE_3F 0x0000003F 221 #define ARCMSR_IOCTL_RETURNCODE_BUS_HANG_ON 0x00000088 222 /* 223 ************************************************************************ 224 ** SPEC. for Areca HBB adapter 225 ************************************************************************ 226 */ 227 /* ARECA HBB COMMAND for its FIRMWARE */ 228 #define ARCMSR_DRV2IOP_DOORBELL 0x00020400 /* window of "instruction flags" from driver to iop */ 229 #define ARCMSR_DRV2IOP_DOORBELL_MASK 0x00020404 230 #define ARCMSR_IOP2DRV_DOORBELL 0x00020408 /* window of "instruction flags" from iop to driver */ 231 #define ARCMSR_IOP2DRV_DOORBELL_MASK 0x0002040C 232 233 /* ARECA FLAG LANGUAGE */ 234 #define ARCMSR_IOP2DRV_DATA_WRITE_OK 0x00000001 /* ioctl transfer */ 235 #define ARCMSR_IOP2DRV_DATA_READ_OK 0x00000002 /* ioctl transfer */ 236 #define ARCMSR_IOP2DRV_CDB_DONE 0x00000004 237 #define ARCMSR_IOP2DRV_MESSAGE_CMD_DONE 0x00000008 238 239 #define ARCMSR_DOORBELL_HANDLE_INT 0x0000000F 240 #define ARCMSR_DOORBELL_INT_CLEAR_PATTERN 0xFF00FFF0 241 #define ARCMSR_MESSAGE_INT_CLEAR_PATTERN 0xFF00FFF7 242 243 #define ARCMSR_MESSAGE_GET_CONFIG 0x00010008 /* (ARCMSR_INBOUND_MESG0_GET_CONFIG<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 244 #define ARCMSR_MESSAGE_SET_CONFIG 0x00020008 /* (ARCMSR_INBOUND_MESG0_SET_CONFIG<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 245 #define ARCMSR_MESSAGE_ABORT_CMD 0x00030008 /* (ARCMSR_INBOUND_MESG0_ABORT_CMD<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 246 #define ARCMSR_MESSAGE_STOP_BGRB 0x00040008 /* (ARCMSR_INBOUND_MESG0_STOP_BGRB<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 247 #define ARCMSR_MESSAGE_FLUSH_CACHE 0x00050008 /* (ARCMSR_INBOUND_MESG0_FLUSH_CACHE<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 248 #define ARCMSR_MESSAGE_START_BGRB 0x00060008 /* (ARCMSR_INBOUND_MESG0_START_BGRB<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */ 249 #define ARCMSR_MESSAGE_START_DRIVER_MODE 0x000E0008 250 #define ARCMSR_MESSAGE_SET_POST_WINDOW 0x000F0008 251 #define ARCMSR_MESSAGE_ACTIVE_EOI_MODE 0x00100008 252 #define ARCMSR_MESSAGE_FIRMWARE_OK 0x80000000 /* ARCMSR_OUTBOUND_MESG1_FIRMWARE_OK */ 253 254 #define ARCMSR_DRV2IOP_DATA_WRITE_OK 0x00000001 /* ioctl transfer */ 255 #define ARCMSR_DRV2IOP_DATA_READ_OK 0x00000002 /* ioctl transfer */ 256 #define ARCMSR_DRV2IOP_CDB_POSTED 0x00000004 257 #define ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED 0x00000008 258 #define ARCMSR_DRV2IOP_END_OF_INTERRUPT 0x00000010 /* */ 259 260 /* data tunnel buffer between user space program and its firmware */ 261 #define ARCMSR_MSGCODE_RWBUFFER 0x0000fa00 /* iop msgcode_rwbuffer for message command */ 262 #define ARCMSR_IOCTL_WBUFFER 0x0000fe00 /* user space data to iop 128bytes */ 263 #define ARCMSR_IOCTL_RBUFFER 0x0000ff00 /* iop data to user space 128bytes */ 264 #define ARCMSR_HBB_BASE0_OFFSET 0x00000010 265 #define ARCMSR_HBB_BASE1_OFFSET 0x00000018 266 #define ARCMSR_HBB_BASE0_LEN 0x00021000 267 #define ARCMSR_HBB_BASE1_LEN 0x00010000 268 /* 269 ************************************************************************ 270 ** SPEC. for Areca HBC adapter 271 ************************************************************************ 272 */ 273 #define ARCMSR_HBC_ISR_THROTTLING_LEVEL 12 274 #define ARCMSR_HBC_ISR_MAX_DONE_QUEUE 20 275 /* Host Interrupt Mask */ 276 #define ARCMSR_HBCMU_UTILITY_A_ISR_MASK 0x00000001 /* When clear, the Utility_A interrupt routes to the host.*/ 277 #define ARCMSR_HBCMU_OUTBOUND_DOORBELL_ISR_MASK 0x00000004 /* When clear, the General Outbound Doorbell interrupt routes to the host.*/ 278 #define ARCMSR_HBCMU_OUTBOUND_POSTQUEUE_ISR_MASK 0x00000008 /* When clear, the Outbound Post List FIFO Not Empty interrupt routes to the host.*/ 279 #define ARCMSR_HBCMU_ALL_INTMASKENABLE 0x0000000D /* disable all ISR */ 280 /* Host Interrupt Status */ 281 #define ARCMSR_HBCMU_UTILITY_A_ISR 0x00000001 282 /* 283 ** Set when the Utility_A Interrupt bit is set in the Outbound Doorbell Register. 284 ** It clears by writing a 1 to the Utility_A bit in the Outbound Doorbell Clear Register or through automatic clearing (if enabled). 285 */ 286 #define ARCMSR_HBCMU_OUTBOUND_DOORBELL_ISR 0x00000004 287 /* 288 ** Set if Outbound Doorbell register bits 30:1 have a non-zero 289 ** value. This bit clears only when Outbound Doorbell bits 290 ** 30:1 are ALL clear. Only a write to the Outbound Doorbell 291 ** Clear register clears bits in the Outbound Doorbell register. 292 */ 293 #define ARCMSR_HBCMU_OUTBOUND_POSTQUEUE_ISR 0x00000008 294 /* 295 ** Set whenever the Outbound Post List Producer/Consumer 296 ** Register (FIFO) is not empty. It clears when the Outbound 297 ** Post List FIFO is empty. 298 */ 299 #define ARCMSR_HBCMU_SAS_ALL_INT 0x00000010 300 /* 301 ** This bit indicates a SAS interrupt from a source external to 302 ** the PCIe core. This bit is not maskable. 303 */ 304 /* DoorBell*/ 305 #define ARCMSR_HBCMU_DRV2IOP_DATA_WRITE_OK 0x00000002/**/ 306 #define ARCMSR_HBCMU_DRV2IOP_DATA_READ_OK 0x00000004/**/ 307 #define ARCMSR_HBCMU_DRV2IOP_MESSAGE_CMD_DONE 0x00000008/*inbound message 0 ready*/ 308 #define ARCMSR_HBCMU_DRV2IOP_POSTQUEUE_THROTTLING 0x00000010/*more than 12 request completed in a time*/ 309 #define ARCMSR_HBCMU_IOP2DRV_DATA_WRITE_OK 0x00000002/**/ 310 #define ARCMSR_HBCMU_IOP2DRV_DATA_WRITE_DOORBELL_CLEAR 0x00000002/*outbound DATA WRITE isr door bell clear*/ 311 #define ARCMSR_HBCMU_IOP2DRV_DATA_READ_OK 0x00000004/**/ 312 #define ARCMSR_HBCMU_IOP2DRV_DATA_READ_DOORBELL_CLEAR 0x00000004/*outbound DATA READ isr door bell clear*/ 313 #define ARCMSR_HBCMU_IOP2DRV_MESSAGE_CMD_DONE 0x00000008/*outbound message 0 ready*/ 314 #define ARCMSR_HBCMU_IOP2DRV_MESSAGE_CMD_DONE_DOORBELL_CLEAR 0x00000008/*outbound message cmd isr door bell clear*/ 315 #define ARCMSR_HBCMU_MESSAGE_FIRMWARE_OK 0x80000000/*ARCMSR_HBCMU_MESSAGE_FIRMWARE_OK*/ 316 317 /* 318 ************************************************************* 319 ** structure for holding DMA address data 320 ************************************************************* 321 */ 322 #define IS_SG64_ADDR 0x01000000 /* bit24 */ 323 /* 324 ************************************************************************************************ 325 ** ARECA FIRMWARE SPEC 326 ************************************************************************************************ 327 ** Usage of IOP331 adapter 328 ** (All In/Out is in IOP331's view) 329 ** 1. Message 0 --> InitThread message and retrun code 330 ** 2. Doorbell is used for RS-232 emulation 331 ** inDoorBell : bit0 -- data in ready (DRIVER DATA WRITE OK) 332 ** bit1 -- data out has been read (DRIVER DATA READ OK) 333 ** outDooeBell: bit0 -- data out ready (IOP331 DATA WRITE OK) 334 ** bit1 -- data in has been read (IOP331 DATA READ OK) 335 ** 3. Index Memory Usage 336 ** offset 0xf00 : for RS232 out (request buffer) 337 ** offset 0xe00 : for RS232 in (scratch buffer) 338 ** offset 0xa00 : for inbound message code msgcode_rwbuffer (driver send to IOP331) 339 ** offset 0xa00 : for outbound message code msgcode_rwbuffer (IOP331 send to driver) 340 ** 4. RS-232 emulation 341 ** Currently 128 byte buffer is used 342 ** 1st u_int32_t : Data length (1--124) 343 ** Byte 4--127 : Max 124 bytes of data 344 ** 5. PostQ 345 ** All SCSI Command must be sent through postQ: 346 ** (inbound queue port) Request frame must be 32 bytes aligned 347 ** # bit27--bit31 => flag for post ccb 348 ** # bit0--bit26 => real address (bit27--bit31) of post arcmsr_cdb 349 ** bit31 : 0 : 256 bytes frame 350 ** 1 : 512 bytes frame 351 ** bit30 : 0 : normal request 352 ** 1 : BIOS request 353 ** bit29 : reserved 354 ** bit28 : reserved 355 ** bit27 : reserved 356 ** ------------------------------------------------------------------------------- 357 ** (outbount queue port) Request reply 358 ** # bit27--bit31 => flag for reply 359 ** # bit0--bit26 => real address (bit27--bit31) of reply arcmsr_cdb 360 ** bit31 : must be 0 (for this type of reply) 361 ** bit30 : reserved for BIOS handshake 362 ** bit29 : reserved 363 ** bit28 : 0 : no error, ignore AdapStatus/DevStatus/SenseData 364 ** 1 : Error, error code in AdapStatus/DevStatus/SenseData 365 ** bit27 : reserved 366 ** 6. BIOS request 367 ** All BIOS request is the same with request from PostQ 368 ** Except : 369 ** Request frame is sent from configuration space 370 ** offset: 0x78 : Request Frame (bit30 == 1) 371 ** offset: 0x18 : writeonly to generate IRQ to IOP331 372 ** Completion of request: 373 ** (bit30 == 0, bit28==err flag) 374 ** 7. Definition of SGL entry (structure) 375 ** 8. Message1 Out - Diag Status Code (????) 376 ** 9. Message0 message code : 377 ** 0x00 : NOP 378 ** 0x01 : Get Config ->offset 0xa00 :for outbound message code msgcode_rwbuffer (IOP331 send to driver) 379 ** Signature 0x87974060(4) 380 ** Request len 0x00000200(4) 381 ** numbers of queue 0x00000100(4) 382 ** SDRAM Size 0x00000100(4)-->256 MB 383 ** IDE Channels 0x00000008(4) 384 ** vendor 40 bytes char 385 ** model 8 bytes char 386 ** FirmVer 16 bytes char 387 ** Device Map 16 bytes char 388 ** 389 ** FirmwareVersion DWORD <== Added for checking of new firmware capability 390 ** 0x02 : Set Config ->offset 0xa00 : for inbound message code msgcode_rwbuffer (driver send to IOP331) 391 ** Signature 0x87974063(4) 392 ** UPPER32 of Request Frame (4)-->Driver Only 393 ** 0x03 : Reset (Abort all queued Command) 394 ** 0x04 : Stop Background Activity 395 ** 0x05 : Flush Cache 396 ** 0x06 : Start Background Activity (re-start if background is halted) 397 ** 0x07 : Check If Host Command Pending (Novell May Need This Function) 398 ** 0x08 : Set controller time ->offset 0xa00 : for inbound message code msgcode_rwbuffer (driver to IOP331) 399 ** byte 0 : 0xaa <-- signature 400 ** byte 1 : 0x55 <-- signature 401 ** byte 2 : year (04) 402 ** byte 3 : month (1..12) 403 ** byte 4 : date (1..31) 404 ** byte 5 : hour (0..23) 405 ** byte 6 : minute (0..59) 406 ** byte 7 : second (0..59) 407 ** ********************************************************************************* 408 ** Porting Of LSI2108/2116 Based PCIE SAS/6G host raid adapter 409 ** ==> Difference from IOP348 410 ** <1> Message Register 0,1 (the same usage) Init Thread message and retrun code 411 ** Inbound Message 0 (inbound_msgaddr0) : at offset 0xB0 (Scratchpad0) for inbound message code msgcode_rwbuffer (driver send to IOP) 412 ** Inbound Message 1 (inbound_msgaddr1) : at offset 0xB4 (Scratchpad1) Out.... Diag Status Code 413 ** Outbound Message 0 (outbound_msgaddr0): at offset 0xB8 (Scratchpad3) Out.... Diag Status Code 414 ** Outbound Message 1 (outbound_msgaddr1): at offset 0xBC (Scratchpad2) for outbound message code msgcode_rwbuffer (IOP send to driver) 415 ** <A> use doorbell to generate interrupt 416 ** 417 ** inbound doorbell: bit3 -- inbound message 0 ready (driver to iop) 418 ** outbound doorbell: bit3 -- outbound message 0 ready (iop to driver) 419 ** 420 ** a. Message1: Out - Diag Status Code (????) 421 ** 422 ** b. Message0: message code 423 ** 0x00 : NOP 424 ** 0x01 : Get Config ->offset 0xB8 :for outbound message code msgcode_rwbuffer (IOP send to driver) 425 ** Signature 0x87974060(4) 426 ** Request len 0x00000200(4) 427 ** numbers of queue 0x00000100(4) 428 ** SDRAM Size 0x00000100(4)-->256 MB 429 ** IDE Channels 0x00000008(4) 430 ** vendor 40 bytes char 431 ** model 8 bytes char 432 ** FirmVer 16 bytes char 433 ** Device Map 16 bytes char 434 ** cfgVersion ULONG <== Added for checking of new firmware capability 435 ** 0x02 : Set Config ->offset 0xB0 :for inbound message code msgcode_rwbuffer (driver send to IOP) 436 ** Signature 0x87974063(4) 437 ** UPPER32 of Request Frame (4)-->Driver Only 438 ** 0x03 : Reset (Abort all queued Command) 439 ** 0x04 : Stop Background Activity 440 ** 0x05 : Flush Cache 441 ** 0x06 : Start Background Activity (re-start if background is halted) 442 ** 0x07 : Check If Host Command Pending (Novell May Need This Function) 443 ** 0x08 : Set controller time ->offset 0xB0 : for inbound message code msgcode_rwbuffer (driver to IOP) 444 ** byte 0 : 0xaa <-- signature 445 ** byte 1 : 0x55 <-- signature 446 ** byte 2 : year (04) 447 ** byte 3 : month (1..12) 448 ** byte 4 : date (1..31) 449 ** byte 5 : hour (0..23) 450 ** byte 6 : minute (0..59) 451 ** byte 7 : second (0..59) 452 ** 453 ** <2> Doorbell Register is used for RS-232 emulation 454 ** <A> different clear register 455 ** <B> different bit0 definition (bit0 is reserved) 456 ** 457 ** inbound doorbell : at offset 0x20 458 ** inbound doorbell clear : at offset 0x70 459 ** 460 ** inbound doorbell : bit0 -- reserved 461 ** bit1 -- data in ready (DRIVER DATA WRITE OK) 462 ** bit2 -- data out has been read (DRIVER DATA READ OK) 463 ** bit3 -- inbound message 0 ready 464 ** bit4 -- more than 12 request completed in a time 465 ** 466 ** outbound doorbell : at offset 0x9C 467 ** outbound doorbell clear : at offset 0xA0 468 ** 469 ** outbound doorbell : bit0 -- reserved 470 ** bit1 -- data out ready (IOP DATA WRITE OK) 471 ** bit2 -- data in has been read (IOP DATA READ OK) 472 ** bit3 -- outbound message 0 ready 473 ** 474 ** <3> Index Memory Usage (Buffer Area) 475 ** COMPORT_IN at 0x2000: message_wbuffer -- 128 bytes (to be sent to ROC) : for RS232 in (scratch buffer) 476 ** COMPORT_OUT at 0x2100: message_rbuffer -- 128 bytes (to be sent to host): for RS232 out (request buffer) 477 ** BIOS_CFG_AREA at 0x2200: msgcode_rwbuffer -- 1024 bytes for outbound message code msgcode_rwbuffer (IOP send to driver) 478 ** BIOS_CFG_AREA at 0x2200: msgcode_rwbuffer -- 1024 bytes for inbound message code msgcode_rwbuffer (driver send to IOP) 479 ** 480 ** <4> PostQ (Command Post Address) 481 ** All SCSI Command must be sent through postQ: 482 ** inbound queue port32 at offset 0x40 , 0x41, 0x42, 0x43 483 ** inbound queue port64 at offset 0xC0 (lower)/0xC4 (upper) 484 ** outbound queue port32 at offset 0x44 485 ** outbound queue port64 at offset 0xC8 (lower)/0xCC (upper) 486 ** <A> For 32bit queue, access low part is enough to send/receive request 487 ** i.e. write 0x40/0xC0, ROC will get the request with high part == 0, the 488 ** same for outbound queue port 489 ** <B> For 64bit queue, if 64bit instruction is supported, use 64bit instruction 490 ** to post inbound request in a single instruction, and use 64bit instruction 491 ** to retrieve outbound request in a single instruction. 492 ** If in 32bit environment, when sending inbound queue, write high part first 493 ** then write low part. For receiving outbound request, read high part first 494 ** then low part, to check queue empty, ONLY check high part to be 0xFFFFFFFF. 495 ** If high part is 0xFFFFFFFF, DO NOT read low part, this may corrupt the 496 ** consistency of the FIFO. Another way to check empty is to check status flag 497 ** at 0x30 bit3. 498 ** <C> Post Address IS NOT shifted (must be 16 bytes aligned) 499 ** For BIOS, 16bytes aligned is OK 500 ** For Driver, 32bytes alignment is recommended. 501 ** POST Command bit0 to bit3 is defined differently 502 ** ---------------------------- 503 ** bit0:1 for PULL mode (must be 1) 504 ** ---------------------------- 505 ** bit3/2/1: for arcmsr cdb size (arccdbsize) 506 ** 000: <= 0x0080 (128) 507 ** 001: <= 0x0100 (256) 508 ** 010: <= 0x0180 (384) 509 ** 011: <= 0x0200 (512) 510 ** 100: <= 0x0280 (640) 511 ** 101: <= 0x0300 (768) 512 ** 110: <= 0x0300 (reserved) 513 ** 111: <= 0x0300 (reserved) 514 ** ----------------------------- 515 ** if len > 0x300 the len always set as 0x300 516 ** ----------------------------- 517 ** post addr = addr | ((len-1) >> 6) | 1 518 ** ----------------------------- 519 ** page length in command buffer still required, 520 ** 521 ** if page length > 3, 522 ** firmware will assume more request data need to be retrieved 523 ** 524 ** <D> Outbound Posting 525 ** bit0:0 , no error, 1 with error, refer to status buffer 526 ** bit1:0 , reserved (will be 0) 527 ** bit2:0 , reserved (will be 0) 528 ** bit3:0 , reserved (will be 0) 529 ** bit63-4: Completed command address 530 ** 531 ** <E> BIOS support, no special support is required. 532 ** LSI2108 support I/O register 533 ** All driver functionality is supported through I/O address 534 ** 535 ** For further spec, refer to 536 ** \spec\lsi\2108 for Areca\2108\LSISAS2108_PG_NoEncryption.pdf : Chapter 8 (8-11/8-28) 537 ** \spec\lsi\2108 for Areca\2108\SAS2108_RM_20.pdf : for configuration space 538 ************************************************************************************************ 539 */ 540 /* signature of set and get firmware config */ 541 #define ARCMSR_SIGNATURE_GET_CONFIG 0x87974060 542 #define ARCMSR_SIGNATURE_SET_CONFIG 0x87974063 543 /* message code of inbound message register */ 544 #define ARCMSR_INBOUND_MESG0_NOP 0x00000000 545 #define ARCMSR_INBOUND_MESG0_GET_CONFIG 0x00000001 546 #define ARCMSR_INBOUND_MESG0_SET_CONFIG 0x00000002 547 #define ARCMSR_INBOUND_MESG0_ABORT_CMD 0x00000003 548 #define ARCMSR_INBOUND_MESG0_STOP_BGRB 0x00000004 549 #define ARCMSR_INBOUND_MESG0_FLUSH_CACHE 0x00000005 550 #define ARCMSR_INBOUND_MESG0_START_BGRB 0x00000006 551 #define ARCMSR_INBOUND_MESG0_CHK331PENDING 0x00000007 552 #define ARCMSR_INBOUND_MESG0_SYNC_TIMER 0x00000008 553 /* doorbell interrupt generator */ 554 #define ARCMSR_INBOUND_DRIVER_DATA_WRITE_OK 0x00000001 555 #define ARCMSR_INBOUND_DRIVER_DATA_READ_OK 0x00000002 556 #define ARCMSR_OUTBOUND_IOP331_DATA_WRITE_OK 0x00000001 557 #define ARCMSR_OUTBOUND_IOP331_DATA_READ_OK 0x00000002 558 /* srb areca cdb flag */ 559 #define ARCMSR_SRBPOST_FLAG_SGL_BSIZE 0x80000000 560 #define ARCMSR_SRBPOST_FLAG_IAM_BIOS 0x40000000 561 #define ARCMSR_SRBREPLY_FLAG_IAM_BIOS 0x40000000 562 #define ARCMSR_SRBREPLY_FLAG_ERROR 0x10000000 563 #define ARCMSR_SRBREPLY_FLAG_ERROR_MODE0 0x10000000 564 #define ARCMSR_SRBREPLY_FLAG_ERROR_MODE1 0x00000001 565 /* outbound firmware ok */ 566 #define ARCMSR_OUTBOUND_MESG1_FIRMWARE_OK 0x80000000 567 /* 568 ********************************** 569 ** 570 ********************************** 571 */ 572 /* size 8 bytes */ 573 /* 32bit Scatter-Gather list */ 574 struct SG32ENTRY { /* length bit 24 == 0 */ 575 u_int32_t length; /* high 8 bit == flag,low 24 bit == length */ 576 u_int32_t address; 577 }; 578 /* size 12 bytes */ 579 /* 64bit Scatter-Gather list */ 580 struct SG64ENTRY { /* length bit 24 == 1 */ 581 u_int32_t length; /* high 8 bit == flag,low 24 bit == length */ 582 u_int32_t address; 583 u_int32_t addresshigh; 584 }; 585 struct SGENTRY_UNION { 586 union { 587 struct SG32ENTRY sg32entry; /* 30h Scatter gather address */ 588 struct SG64ENTRY sg64entry; /* 30h */ 589 }u; 590 }; 591 /* 592 ********************************** 593 ** 594 ********************************** 595 */ 596 struct QBUFFER { 597 u_int32_t data_len; 598 u_int8_t data[124]; 599 }; 600 /* 601 ************************************************************************************************ 602 ** FIRMWARE INFO 603 ************************************************************************************************ 604 */ 605 #define ARCMSR_FW_MODEL_OFFSET 15 606 #define ARCMSR_FW_VERS_OFFSET 17 607 #define ARCMSR_FW_DEVMAP_OFFSET 21 608 #define ARCMSR_FW_CFGVER_OFFSET 25 609 610 struct FIRMWARE_INFO { 611 u_int32_t signature; /*0,00-03*/ 612 u_int32_t request_len; /*1,04-07*/ 613 u_int32_t numbers_queue; /*2,08-11*/ 614 u_int32_t sdram_size; /*3,12-15*/ 615 u_int32_t ide_channels; /*4,16-19*/ 616 char vendor[40]; /*5,20-59*/ 617 char model[8]; /*15,60-67*/ 618 char firmware_ver[16]; /*17,68-83*/ 619 char device_map[16]; /*21,84-99*/ 620 u_int32_t cfgVersion; /*25,100-103 Added for checking of new firmware capability*/ 621 char cfgSerial[16]; /*26,104-119*/ 622 u_int32_t cfgPicStatus; /*30,120-123*/ 623 }; 624 /* (A) For cfgVersion in FIRMWARE_INFO 625 ** if low BYTE (byte#0) >= 3 (version 3) 626 ** then byte#1 report the capability of the firmware can xfer in a single request 627 ** 628 ** byte#1 629 ** 0 256K 630 ** 1 512K 631 ** 2 1M 632 ** 3 2M 633 ** 4 4M 634 ** 5 8M 635 ** 6 16M 636 ** (B) Byte offset 7 (Reserved1) of CDB is changed to msgPages 637 ** Driver support new xfer method need to set this field to indicate 638 ** large CDB block in 0x100 unit (we use 0x100 byte as one page) 639 ** e.g. If the length of CDB including MSG header and SGL is 0x1508 640 ** driver need to set the msgPages to 0x16 641 ** (C) REQ_LEN_512BYTE must be used also to indicate SRB length 642 ** e.g. CDB len msgPages REQ_LEN_512BYTE flag 643 ** <= 0x100 1 0 644 ** <= 0x200 2 1 645 ** <= 0x300 3 1 646 ** <= 0x400 4 1 647 ** . 648 ** . 649 */ 650 651 /* 652 ************************************************************************************************ 653 ** size 0x1F8 (504) 654 ************************************************************************************************ 655 */ 656 struct ARCMSR_CDB { 657 u_int8_t Bus; /* 00h should be 0 */ 658 u_int8_t TargetID; /* 01h should be 0--15 */ 659 u_int8_t LUN; /* 02h should be 0--7 */ 660 u_int8_t Function; /* 03h should be 1 */ 661 662 u_int8_t CdbLength; /* 04h not used now */ 663 u_int8_t sgcount; /* 05h */ 664 u_int8_t Flags; /* 06h */ 665 #define ARCMSR_CDB_FLAG_SGL_BSIZE 0x01 /* bit 0: 0(256) / 1(512) bytes */ 666 #define ARCMSR_CDB_FLAG_BIOS 0x02 /* bit 1: 0(from driver) / 1(from BIOS) */ 667 #define ARCMSR_CDB_FLAG_WRITE 0x04 /* bit 2: 0(Data in) / 1(Data out) */ 668 #define ARCMSR_CDB_FLAG_SIMPLEQ 0x00 /* bit 4/3 ,00 : simple Q,01 : head of Q,10 : ordered Q */ 669 #define ARCMSR_CDB_FLAG_HEADQ 0x08 670 #define ARCMSR_CDB_FLAG_ORDEREDQ 0x10 671 u_int8_t msgPages; /* 07h */ 672 673 u_int32_t Context; /* 08h Address of this request */ 674 u_int32_t DataLength; /* 0ch not used now */ 675 676 u_int8_t Cdb[16]; /* 10h SCSI CDB */ 677 /* 678 ******************************************************** 679 **Device Status : the same from SCSI bus if error occur 680 ** SCSI bus status codes. 681 ******************************************************** 682 */ 683 u_int8_t DeviceStatus; /* 20h if error */ 684 #define SCSISTAT_GOOD 0x00 685 #define SCSISTAT_CHECK_CONDITION 0x02 686 #define SCSISTAT_CONDITION_MET 0x04 687 #define SCSISTAT_BUSY 0x08 688 #define SCSISTAT_INTERMEDIATE 0x10 689 #define SCSISTAT_INTERMEDIATE_COND_MET 0x14 690 #define SCSISTAT_RESERVATION_CONFLICT 0x18 691 #define SCSISTAT_COMMAND_TERMINATED 0x22 692 #define SCSISTAT_QUEUE_FULL 0x28 693 #define ARCMSR_DEV_SELECT_TIMEOUT 0xF0 694 #define ARCMSR_DEV_ABORTED 0xF1 695 #define ARCMSR_DEV_INIT_FAIL 0xF2 696 697 u_int8_t SenseData[15]; /* 21h output */ 698 699 union { 700 struct SG32ENTRY sg32entry[ARCMSR_MAX_SG_ENTRIES]; /* 30h Scatter gather address */ 701 struct SG64ENTRY sg64entry[ARCMSR_MAX_SG_ENTRIES]; /* 30h */ 702 } u; 703 }; 704 /* 705 ********************************************************************* 706 ** Command Control Block (SrbExtension) 707 ** SRB must be not cross page boundary,and the order from offset 0 708 ** structure describing an ATA disk request 709 ** this SRB length must be 32 bytes boundary 710 ********************************************************************* 711 */ 712 struct CommandControlBlock { 713 struct ARCMSR_CDB arcmsr_cdb; /* 0 -503 (size of CDB=504): arcmsr messenger scsi command descriptor size 504 bytes */ 714 u_int32_t cdb_shifted_phyaddr; /* 504-507 */ 715 u_int32_t arc_cdb_size; /* 508-511 */ 716 /* ======================512+32 bytes============================ */ 717 #if defined(__x86_64__) || defined(__amd64__) || defined(__ia64__) || defined(__sparc64__) || defined(__powerpc__) 718 union ccb *pccb; /* 512-515 516-519 pointer of freebsd scsi command */ 719 struct AdapterControlBlock *acb; /* 520-523 524-527 */ 720 bus_dmamap_t dm_segs_dmamap; /* 528-531 532-535 */ 721 u_int16_t srb_flags; /* 536-537 */ 722 u_int16_t startdone; /* 538-539 */ 723 u_int32_t reserved2; /* 540-543 */ 724 #else 725 union ccb *pccb; /* 512-515 pointer of freebsd scsi command */ 726 struct AdapterControlBlock *acb; /* 516-519 */ 727 bus_dmamap_t dm_segs_dmamap; /* 520-523 */ 728 u_int16_t srb_flags; /* 524-525 */ 729 u_int16_t startdone; /* 526-527 */ 730 u_int32_t reserved2[4]; /* 528-531 532-535 536-539 540-543 */ 731 #endif 732 /* ========================================================== */ 733 /* struct callout ccb_callout; */ 734 }; 735 /* srb_flags */ 736 #define SRB_FLAG_READ 0x0000 737 #define SRB_FLAG_WRITE 0x0001 738 #define SRB_FLAG_ERROR 0x0002 739 #define SRB_FLAG_FLUSHCACHE 0x0004 740 #define SRB_FLAG_MASTER_ABORTED 0x0008 741 #define SRB_FLAG_DMAVALID 0x0010 742 #define SRB_FLAG_DMACONSISTENT 0x0020 743 #define SRB_FLAG_DMAWRITE 0x0040 744 #define SRB_FLAG_PKTBIND 0x0080 745 /* startdone */ 746 #define ARCMSR_SRB_DONE 0x0000 747 #define ARCMSR_SRB_UNBUILD 0x0000 748 #define ARCMSR_SRB_TIMEOUT 0x1111 749 #define ARCMSR_SRB_RETRY 0x2222 750 #define ARCMSR_SRB_START 0x55AA 751 #define ARCMSR_SRB_PENDING 0xAA55 752 #define ARCMSR_SRB_RESET 0xA5A5 753 #define ARCMSR_SRB_ABORTED 0x5A5A 754 #define ARCMSR_SRB_ILLEGAL 0xFFFF 755 /* 756 ********************************************************************* 757 ** Adapter Control Block 758 ********************************************************************* 759 */ 760 #define ACB_ADAPTER_TYPE_A 0x00000001 /* hba I IOP */ 761 #define ACB_ADAPTER_TYPE_B 0x00000002 /* hbb M IOP */ 762 #define ACB_ADAPTER_TYPE_C 0x00000004 /* hbc L IOP */ 763 #define ACB_ADAPTER_TYPE_D 0x00000008 /* hbd A IOP */ 764 765 struct AdapterControlBlock { 766 u_int32_t adapter_type; /* adapter A,B..... */ 767 768 bus_space_tag_t btag[2]; 769 bus_space_handle_t bhandle[2]; 770 bus_dma_tag_t parent_dmat; 771 bus_dma_tag_t dm_segs_dmat; /* dmat for buffer I/O */ 772 bus_dma_tag_t srb_dmat; /* dmat for freesrb */ 773 bus_dmamap_t srb_dmamap; 774 device_t pci_dev; 775 struct cdev * ioctl_dev; 776 int pci_unit; 777 778 struct resource * sys_res_arcmsr[2]; 779 struct resource * irqres; 780 void * ih; /* interrupt handle */ 781 782 /* Hooks into the CAM XPT */ 783 struct cam_sim *psim; 784 struct cam_path *ppath; 785 u_int8_t * uncacheptr; 786 unsigned long vir2phy_offset; 787 union { 788 unsigned long phyaddr; 789 struct { 790 u_int32_t phyadd_low; 791 u_int32_t phyadd_high; 792 }B; 793 } srb_phyaddr; 794 // unsigned long srb_phyaddr; 795 /* Offset is used in making arc cdb physical to virtual calculations */ 796 u_int32_t outbound_int_enable; 797 798 struct MessageUnit_UNION * pmu; /* message unit ATU inbound base address0 */ 799 800 u_int8_t adapter_index; /* */ 801 u_int8_t irq; 802 u_int16_t acb_flags; /* */ 803 804 struct CommandControlBlock * psrb_pool[ARCMSR_MAX_FREESRB_NUM]; /* serial srb pointer array */ 805 struct CommandControlBlock * srbworkingQ[ARCMSR_MAX_FREESRB_NUM]; /* working srb pointer array */ 806 int32_t workingsrb_doneindex; /* done srb array index */ 807 int32_t workingsrb_startindex; /* start srb array index */ 808 int32_t srboutstandingcount; 809 810 u_int8_t rqbuffer[ARCMSR_MAX_QBUFFER]; /* data collection buffer for read from 80331 */ 811 u_int32_t rqbuf_firstindex; /* first of read buffer */ 812 u_int32_t rqbuf_lastindex; /* last of read buffer */ 813 814 u_int8_t wqbuffer[ARCMSR_MAX_QBUFFER]; /* data collection buffer for write to 80331 */ 815 u_int32_t wqbuf_firstindex; /* first of write buffer */ 816 u_int32_t wqbuf_lastindex; /* last of write buffer */ 817 818 arcmsr_lock_t workingQ_done_lock; 819 arcmsr_lock_t workingQ_start_lock; 820 arcmsr_lock_t qbuffer_lock; 821 822 u_int8_t devstate[ARCMSR_MAX_TARGETID][ARCMSR_MAX_TARGETLUN]; /* id0 ..... id15,lun0...lun7 */ 823 u_int32_t num_resets; 824 u_int32_t num_aborts; 825 u_int32_t firm_request_len; /*1,04-07*/ 826 u_int32_t firm_numbers_queue; /*2,08-11*/ 827 u_int32_t firm_sdram_size; /*3,12-15*/ 828 u_int32_t firm_ide_channels; /*4,16-19*/ 829 u_int32_t firm_cfg_version; 830 char firm_model[12]; /*15,60-67*/ 831 char firm_version[20]; /*17,68-83*/ 832 char device_map[20]; /*21,84-99 */ 833 struct callout devmap_callout; 834 };/* HW_DEVICE_EXTENSION */ 835 /* acb_flags */ 836 #define ACB_F_SCSISTOPADAPTER 0x0001 837 #define ACB_F_MSG_STOP_BGRB 0x0002 /* stop RAID background rebuild */ 838 #define ACB_F_MSG_START_BGRB 0x0004 /* stop RAID background rebuild */ 839 #define ACB_F_IOPDATA_OVERFLOW 0x0008 /* iop ioctl data rqbuffer overflow */ 840 #define ACB_F_MESSAGE_WQBUFFER_CLEARED 0x0010 /* ioctl clear wqbuffer */ 841 #define ACB_F_MESSAGE_RQBUFFER_CLEARED 0x0020 /* ioctl clear rqbuffer */ 842 #define ACB_F_MESSAGE_WQBUFFER_READ 0x0040 843 #define ACB_F_BUS_RESET 0x0080 844 #define ACB_F_IOP_INITED 0x0100 /* iop init */ 845 #define ACB_F_MAPFREESRB_FAILD 0x0200 /* arcmsr_map_freesrb faild */ 846 #define ACB_F_CAM_DEV_QFRZN 0x0400 847 #define ACB_F_BUS_HANG_ON 0x0800 /* need hardware reset bus */ 848 #define ACB_F_SRB_FUNCTION_POWER 0x1000 849 /* devstate */ 850 #define ARECA_RAID_GONE 0x55 851 #define ARECA_RAID_GOOD 0xaa 852 /* 853 ********************************************************************* 854 ** Message Unit structure 855 ********************************************************************* 856 */ 857 struct HBA_MessageUnit 858 { 859 u_int32_t resrved0[4]; /*0000 000F*/ 860 u_int32_t inbound_msgaddr0; /*0010 0013*/ 861 u_int32_t inbound_msgaddr1; /*0014 0017*/ 862 u_int32_t outbound_msgaddr0; /*0018 001B*/ 863 u_int32_t outbound_msgaddr1; /*001C 001F*/ 864 u_int32_t inbound_doorbell; /*0020 0023*/ 865 u_int32_t inbound_intstatus; /*0024 0027*/ 866 u_int32_t inbound_intmask; /*0028 002B*/ 867 u_int32_t outbound_doorbell; /*002C 002F*/ 868 u_int32_t outbound_intstatus; /*0030 0033*/ 869 u_int32_t outbound_intmask; /*0034 0037*/ 870 u_int32_t reserved1[2]; /*0038 003F*/ 871 u_int32_t inbound_queueport; /*0040 0043*/ 872 u_int32_t outbound_queueport; /*0044 0047*/ 873 u_int32_t reserved2[2]; /*0048 004F*/ 874 u_int32_t reserved3[492]; /*0050 07FF ......local_buffer 492*/ 875 u_int32_t reserved4[128]; /*0800 09FF 128*/ 876 u_int32_t msgcode_rwbuffer[256]; /*0a00 0DFF 256*/ 877 u_int32_t message_wbuffer[32]; /*0E00 0E7F 32*/ 878 u_int32_t reserved5[32]; /*0E80 0EFF 32*/ 879 u_int32_t message_rbuffer[32]; /*0F00 0F7F 32*/ 880 u_int32_t reserved6[32]; /*0F80 0FFF 32*/ 881 }; 882 /* 883 ********************************************************************* 884 ** 885 ********************************************************************* 886 */ 887 struct HBB_DOORBELL 888 { 889 u_int8_t doorbell_reserved[ARCMSR_DRV2IOP_DOORBELL]; /*reserved */ 890 u_int32_t drv2iop_doorbell; /*offset 0x00020400:00,01,02,03: window of "instruction flags" from driver to iop */ 891 u_int32_t drv2iop_doorbell_mask; /* 04,05,06,07: doorbell mask */ 892 u_int32_t iop2drv_doorbell; /* 08,09,10,11: window of "instruction flags" from iop to driver */ 893 u_int32_t iop2drv_doorbell_mask; /* 12,13,14,15: doorbell mask */ 894 }; 895 /* 896 ********************************************************************* 897 ** 898 ********************************************************************* 899 */ 900 struct HBB_RWBUFFER 901 { 902 u_int8_t message_reserved0[ARCMSR_MSGCODE_RWBUFFER]; /*reserved */ 903 u_int32_t msgcode_rwbuffer[256]; /*offset 0x0000fa00: 0, 1, 2, 3,...,1023: message code read write 1024bytes */ 904 u_int32_t message_wbuffer[32]; /*offset 0x0000fe00:1024,1025,1026,1027,...,1151: user space data to iop 128bytes */ 905 u_int32_t message_reserved1[32]; /* 1152,1153,1154,1155,...,1279: message reserved*/ 906 u_int32_t message_rbuffer[32]; /*offset 0x0000ff00:1280,1281,1282,1283,...,1407: iop data to user space 128bytes */ 907 }; 908 /* 909 ********************************************************************* 910 ** 911 ********************************************************************* 912 */ 913 struct HBB_MessageUnit 914 { 915 u_int32_t post_qbuffer[ARCMSR_MAX_HBB_POSTQUEUE]; /* post queue buffer for iop */ 916 u_int32_t done_qbuffer[ARCMSR_MAX_HBB_POSTQUEUE]; /* done queue buffer for iop */ 917 int32_t postq_index; /* post queue index */ 918 int32_t doneq_index; /* done queue index */ 919 struct HBB_DOORBELL *hbb_doorbell; 920 struct HBB_RWBUFFER *hbb_rwbuffer; 921 }; 922 923 /* 924 ********************************************************************* 925 ** 926 ********************************************************************* 927 */ 928 struct HBC_MessageUnit { 929 u_int32_t message_unit_status; /*0000 0003*/ 930 u_int32_t slave_error_attribute; /*0004 0007*/ 931 u_int32_t slave_error_address; /*0008 000B*/ 932 u_int32_t posted_outbound_doorbell; /*000C 000F*/ 933 u_int32_t master_error_attribute; /*0010 0013*/ 934 u_int32_t master_error_address_low; /*0014 0017*/ 935 u_int32_t master_error_address_high; /*0018 001B*/ 936 u_int32_t hcb_size; /*001C 001F size of the PCIe window used for HCB_Mode accesses*/ 937 u_int32_t inbound_doorbell; /*0020 0023*/ 938 u_int32_t diagnostic_rw_data; /*0024 0027*/ 939 u_int32_t diagnostic_rw_address_low; /*0028 002B*/ 940 u_int32_t diagnostic_rw_address_high; /*002C 002F*/ 941 u_int32_t host_int_status; /*0030 0033 host interrupt status*/ 942 u_int32_t host_int_mask; /*0034 0037 host interrupt mask*/ 943 u_int32_t dcr_data; /*0038 003B*/ 944 u_int32_t dcr_address; /*003C 003F*/ 945 u_int32_t inbound_queueport; /*0040 0043 port32 host inbound queue port*/ 946 u_int32_t outbound_queueport; /*0044 0047 port32 host outbound queue port*/ 947 u_int32_t hcb_pci_address_low; /*0048 004B*/ 948 u_int32_t hcb_pci_address_high; /*004C 004F*/ 949 u_int32_t iop_int_status; /*0050 0053*/ 950 u_int32_t iop_int_mask; /*0054 0057*/ 951 u_int32_t iop_inbound_queue_port; /*0058 005B*/ 952 u_int32_t iop_outbound_queue_port; /*005C 005F*/ 953 u_int32_t inbound_free_list_index; /*0060 0063 inbound free list producer consumer index*/ 954 u_int32_t inbound_post_list_index; /*0064 0067 inbound post list producer consumer index*/ 955 u_int32_t outbound_free_list_index; /*0068 006B outbound free list producer consumer index*/ 956 u_int32_t outbound_post_list_index; /*006C 006F outbound post list producer consumer index*/ 957 u_int32_t inbound_doorbell_clear; /*0070 0073*/ 958 u_int32_t i2o_message_unit_control; /*0074 0077*/ 959 u_int32_t last_used_message_source_address_low; /*0078 007B*/ 960 u_int32_t last_used_message_source_address_high; /*007C 007F*/ 961 u_int32_t pull_mode_data_byte_count[4]; /*0080 008F pull mode data byte count0..count7*/ 962 u_int32_t message_dest_address_index; /*0090 0093*/ 963 u_int32_t done_queue_not_empty_int_counter_timer; /*0094 0097*/ 964 u_int32_t utility_A_int_counter_timer; /*0098 009B*/ 965 u_int32_t outbound_doorbell; /*009C 009F*/ 966 u_int32_t outbound_doorbell_clear; /*00A0 00A3*/ 967 u_int32_t message_source_address_index; /*00A4 00A7 message accelerator source address consumer producer index*/ 968 u_int32_t message_done_queue_index; /*00A8 00AB message accelerator completion queue consumer producer index*/ 969 u_int32_t reserved0; /*00AC 00AF*/ 970 u_int32_t inbound_msgaddr0; /*00B0 00B3 scratchpad0*/ 971 u_int32_t inbound_msgaddr1; /*00B4 00B7 scratchpad1*/ 972 u_int32_t outbound_msgaddr0; /*00B8 00BB scratchpad2*/ 973 u_int32_t outbound_msgaddr1; /*00BC 00BF scratchpad3*/ 974 u_int32_t inbound_queueport_low; /*00C0 00C3 port64 host inbound queue port low*/ 975 u_int32_t inbound_queueport_high; /*00C4 00C7 port64 host inbound queue port high*/ 976 u_int32_t outbound_queueport_low; /*00C8 00CB port64 host outbound queue port low*/ 977 u_int32_t outbound_queueport_high; /*00CC 00CF port64 host outbound queue port high*/ 978 u_int32_t iop_inbound_queue_port_low; /*00D0 00D3*/ 979 u_int32_t iop_inbound_queue_port_high; /*00D4 00D7*/ 980 u_int32_t iop_outbound_queue_port_low; /*00D8 00DB*/ 981 u_int32_t iop_outbound_queue_port_high; /*00DC 00DF*/ 982 u_int32_t message_dest_queue_port_low; /*00E0 00E3 message accelerator destination queue port low*/ 983 u_int32_t message_dest_queue_port_high; /*00E4 00E7 message accelerator destination queue port high*/ 984 u_int32_t last_used_message_dest_address_low; /*00E8 00EB last used message accelerator destination address low*/ 985 u_int32_t last_used_message_dest_address_high; /*00EC 00EF last used message accelerator destination address high*/ 986 u_int32_t message_done_queue_base_address_low; /*00F0 00F3 message accelerator completion queue base address low*/ 987 u_int32_t message_done_queue_base_address_high; /*00F4 00F7 message accelerator completion queue base address high*/ 988 u_int32_t host_diagnostic; /*00F8 00FB*/ 989 u_int32_t write_sequence; /*00FC 00FF*/ 990 u_int32_t reserved1[34]; /*0100 0187*/ 991 u_int32_t reserved2[1950]; /*0188 1FFF*/ 992 u_int32_t message_wbuffer[32]; /*2000 207F*/ 993 u_int32_t reserved3[32]; /*2080 20FF*/ 994 u_int32_t message_rbuffer[32]; /*2100 217F*/ 995 u_int32_t reserved4[32]; /*2180 21FF*/ 996 u_int32_t msgcode_rwbuffer[256]; /*2200 23FF*/ 997 }; 998 999 /* 1000 ********************************************************************* 1001 ** 1002 ********************************************************************* 1003 */ 1004 struct MessageUnit_UNION 1005 { 1006 union { 1007 struct HBA_MessageUnit hbamu; 1008 struct HBB_MessageUnit hbbmu; 1009 struct HBC_MessageUnit hbcmu; 1010 } muu; 1011 }; 1012 1013 /* 1014 ************************************************************* 1015 ************************************************************* 1016 */ 1017 struct SENSE_DATA { 1018 u_int8_t ErrorCode:7; 1019 u_int8_t Valid:1; 1020 u_int8_t SegmentNumber; 1021 u_int8_t SenseKey:4; 1022 u_int8_t Reserved:1; 1023 u_int8_t IncorrectLength:1; 1024 u_int8_t EndOfMedia:1; 1025 u_int8_t FileMark:1; 1026 u_int8_t Information[4]; 1027 u_int8_t AdditionalSenseLength; 1028 u_int8_t CommandSpecificInformation[4]; 1029 u_int8_t AdditionalSenseCode; 1030 u_int8_t AdditionalSenseCodeQualifier; 1031 u_int8_t FieldReplaceableUnitCode; 1032 u_int8_t SenseKeySpecific[3]; 1033 }; 1034 /* 1035 ********************************** 1036 ** Peripheral Device Type definitions 1037 ********************************** 1038 */ 1039 #define SCSI_DASD 0x00 /* Direct-access Device */ 1040 #define SCSI_SEQACESS 0x01 /* Sequential-access device */ 1041 #define SCSI_PRINTER 0x02 /* Printer device */ 1042 #define SCSI_PROCESSOR 0x03 /* Processor device */ 1043 #define SCSI_WRITEONCE 0x04 /* Write-once device */ 1044 #define SCSI_CDROM 0x05 /* CD-ROM device */ 1045 #define SCSI_SCANNER 0x06 /* Scanner device */ 1046 #define SCSI_OPTICAL 0x07 /* Optical memory device */ 1047 #define SCSI_MEDCHGR 0x08 /* Medium changer device */ 1048 #define SCSI_COMM 0x09 /* Communications device */ 1049 #define SCSI_NODEV 0x1F /* Unknown or no device type */ 1050 /* 1051 ************************************************************************************************************ 1052 ** @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 1053 ** 80331 PCI-to-PCI Bridge 1054 ** PCI Configuration Space 1055 ** 1056 ** @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 1057 ** Programming Interface 1058 ** ======================== 1059 ** Configuration Register Address Space Groupings and Ranges 1060 ** ============================================================= 1061 ** Register Group Configuration Offset 1062 ** ------------------------------------------------------------- 1063 ** Standard PCI Configuration 00-3Fh 1064 ** ------------------------------------------------------------- 1065 ** Device Specific Registers 40-A7h 1066 ** ------------------------------------------------------------- 1067 ** Reserved A8-CBh 1068 ** ------------------------------------------------------------- 1069 ** Enhanced Capability List CC-FFh 1070 ** ========================================================================================================== 1071 ** Standard PCI [Type 1] Configuration Space Address Map 1072 ** ********************************************************************************************************** 1073 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset 1074 ** ---------------------------------------------------------------------------------------------------------- 1075 ** | Device ID | Vendor ID | 00h 1076 ** ---------------------------------------------------------------------------------------------------------- 1077 ** | Primary Status | Primary Command | 04h 1078 ** ---------------------------------------------------------------------------------------------------------- 1079 ** | Class Code | RevID | 08h 1080 ** ---------------------------------------------------------------------------------------------------------- 1081 ** | reserved | Header Type | Primary MLT | Primary CLS | 0Ch 1082 ** ---------------------------------------------------------------------------------------------------------- 1083 ** | Reserved | 10h 1084 ** ---------------------------------------------------------------------------------------------------------- 1085 ** | Reserved | 14h 1086 ** ---------------------------------------------------------------------------------------------------------- 1087 ** | Secondary MLT | Subordinate Bus Number | Secondary Bus Number | Primary Bus Number | 18h 1088 ** ---------------------------------------------------------------------------------------------------------- 1089 ** | Secondary Status | I/O Limit | I/O Base | 1Ch 1090 ** ---------------------------------------------------------------------------------------------------------- 1091 ** | Non-prefetchable Memory Limit Address | Non-prefetchable Memory Base Address | 20h 1092 ** ---------------------------------------------------------------------------------------------------------- 1093 ** | Prefetchable Memory Limit Address | Prefetchable Memory Base Address | 24h 1094 ** ---------------------------------------------------------------------------------------------------------- 1095 ** | Prefetchable Memory Base Address Upper 32 Bits | 28h 1096 ** ---------------------------------------------------------------------------------------------------------- 1097 ** | Prefetchable Memory Limit Address Upper 32 Bits | 2Ch 1098 ** ---------------------------------------------------------------------------------------------------------- 1099 ** | I/O Limit Upper 16 Bits | I/O Base Upper 16 | 30h 1100 ** ---------------------------------------------------------------------------------------------------------- 1101 ** | Reserved | Capabilities Pointer | 34h 1102 ** ---------------------------------------------------------------------------------------------------------- 1103 ** | Reserved | 38h 1104 ** ---------------------------------------------------------------------------------------------------------- 1105 ** | Bridge Control | Primary Interrupt Pin | Primary Interrupt Line | 3Ch 1106 **============================================================================================================= 1107 */ 1108 /* 1109 **============================================================================================================= 1110 ** 0x03-0x00 : 1111 ** Bit Default Description 1112 **31:16 0335h Device ID (DID): Indicates the unique device ID that is assigned to bridge by the PCI SIG. 1113 ** ID is unique per product speed as indicated. 1114 **15:00 8086h Vendor ID (VID): 16-bit field which indicates that Intel is the vendor. 1115 **============================================================================================================= 1116 */ 1117 #define ARCMSR_PCI2PCI_VENDORID_REG 0x00 /*word*/ 1118 #define ARCMSR_PCI2PCI_DEVICEID_REG 0x02 /*word*/ 1119 /* 1120 **============================================================================== 1121 ** 0x05-0x04 : command register 1122 ** Bit Default Description 1123 **15:11 00h Reserved 1124 ** 10 0 Interrupt Disable: Disables/Enables the generation of Interrupts on the primary bus. 1125 ** The bridge does not support interrupts. 1126 ** 09 0 FB2B Enable: Enables/Disables the generation of fast back to back 1127 ** transactions on the primary bus. 1128 ** The bridge does not generate fast back to back 1129 ** transactions on the primary bus. 1130 ** 08 0 SERR# Enable (SEE): Enables primary bus SERR# assertions. 1131 ** 0=The bridge does not assert P_SERR#. 1132 ** 1=The bridge may assert P_SERR#, subject to other programmable criteria. 1133 ** 07 0 Wait Cycle Control (WCC): Always returns 0bzero indicating 1134 ** that bridge does not perform address or data stepping, 1135 ** 06 0 Parity Error Response (PER): Controls bridge response to a detected primary bus parity error. 1136 ** 0=When a data parity error is detected bridge does not assert S_PERR#. 1137 ** Also bridge does not assert P_SERR# in response to 1138 ** a detected address or attribute parity error. 1139 ** 1=When a data parity error is detected bridge asserts S_PERR#. 1140 ** The bridge also asserts P_SERR# 1141 ** (when enabled globally via bit(8) of this register) 1142 ** in response to a detected address or attribute parity error. 1143 ** 05 0 VGA Palette Snoop Enable (VGA_PSE): Controls bridge response to VGA-compatible palette write transactions. 1144 ** VGA palette write transactions are I/O transactions 1145 ** whose address bits are: P_AD[9:0] equal to 3C6h, 3C8h or 3C9h 1146 ** P_AD[15:10] are not decoded (i.e. aliases are claimed), 1147 ** or are fully decoding 1148 ** (i.e., must be all 0's depending upon the VGA 1149 ** aliasing bit in the Bridge Control Register, offset 3Eh. 1150 ** P_AD[31:16] equal to 0000h 1151 ** 0=The bridge ignores VGA palette write transactions, 1152 ** unless decoded by the standard I/O address range window. 1153 ** 1=The bridge responds to VGA palette write transactions 1154 ** with medium DEVSEL# timing and forwards them to the secondary bus. 1155 ** 04 0 Memory Write and Invalidate Enable (MWIE): The bridge does not promote MW transactions to MWI transactions. 1156 ** MWI transactions targeting resources on the opposite side of the bridge, 1157 ** however, are forwarded as MWI transactions. 1158 ** 03 0 Special Cycle Enable (SCE): The bridge ignores special cycle transactions. 1159 ** This bit is read only and always returns 0 when read 1160 ** 02 0 Bus Master Enable (BME): Enables bridge to initiate memory and I/O transactions on the primary interface. 1161 ** Initiation of configuration transactions is not affected by the state of this bit. 1162 ** 0=The bridge does not initiate memory or I/O transactions on the primary interface. 1163 ** 1=The bridge is enabled to function as an initiator on the primary interface. 1164 ** 01 0 Memory Space Enable (MSE): Controls target response to memory transactions on the primary interface. 1165 ** 0=The bridge target response to memory transactions on the primary interface is disabled. 1166 ** 1=The bridge target response to memory transactions on the primary interface is enabled. 1167 ** 00 0 I/O Space Enable (IOSE): Controls target response to I/O transactions on the primary interface. 1168 ** 0=The bridge target response to I/O transactions on the primary interface is disabled. 1169 ** 1=The bridge target response to I/O transactions on the primary interface is enabled. 1170 **============================================================================== 1171 */ 1172 #define ARCMSR_PCI2PCI_PRIMARY_COMMAND_REG 0x04 /*word*/ 1173 #define PCI_DISABLE_INTERRUPT 0x0400 1174 /* 1175 **============================================================================== 1176 ** 0x07-0x06 : status register 1177 ** Bit Default Description 1178 ** 15 0 Detected Parity Error: The bridge sets this bit to a 1b whenever it detects an address, 1179 ** attribute or data parity error. 1180 ** This bit is set regardless of the state of the PER bit in the command register. 1181 ** 14 0 Signaled System Error: The bridge sets this bit to a 1b whenever it asserts SERR# on the primary bus. 1182 ** 13 0 Received Master Abort: The bridge sets this bit to a 1b when, 1183 ** acting as the initiator on the primary bus, 1184 ** its transaction (with the exception of special cycles) 1185 ** has been terminated with a Master Abort. 1186 ** 12 0 Received Target Abort: The bridge sets this bit to a 1b when, 1187 ** acting as the initiator on the primary bus, 1188 ** its transaction has been terminated with a Target Abort. 1189 ** 11 0 Signaled Target Abort: The bridge sets this bit to a 1b when it, 1190 ** as the target of a transaction, terminates it with a Target Abort. 1191 ** In PCI-X mode this bit is also set when it forwards a SCM with a target abort error code. 1192 ** 10:09 01 DEVSEL# Timing: Indicates slowest response to a non-configuration command on the primary interface. 1193 ** Returns ��01b�� when read, indicating that bridge responds no slower than with medium timing. 1194 ** 08 0 Master Data Parity Error: The bridge sets this bit to a 1b when all of the following conditions are true: 1195 ** The bridge is the current master on the primary bus 1196 ** S_PERR# is detected asserted or is asserted by bridge 1197 ** The Parity Error Response bit is set in the Command register 1198 ** 07 1 Fast Back to Back Capable: Returns a 1b when read indicating that bridge 1199 ** is able to respond to fast back to back transactions on its primary interface. 1200 ** 06 0 Reserved 1201 ** 05 1 66 MHz Capable Indication: Returns a 1b when read indicating that bridge primary interface is 66 MHz capable. 1202 ** 1 = 1203 ** 04 1 Capabilities List Enable: Returns 1b when read indicating that bridge supports PCI standard enhanced capabilities. 1204 ** Offset 34h (Capability Pointer register) 1205 ** provides the offset for the first entry 1206 ** in the linked list of enhanced capabilities. 1207 ** 03 0 Interrupt Status: Reflects the state of the interrupt in the device/function. 1208 ** The bridge does not support interrupts. 1209 ** 02:00 000 Reserved 1210 **============================================================================== 1211 */ 1212 #define ARCMSR_PCI2PCI_PRIMARY_STATUS_REG 0x06 /*word: 06,07 */ 1213 #define ARCMSR_ADAP_66MHZ 0x20 1214 /* 1215 **============================================================================== 1216 ** 0x08 : revision ID 1217 ** Bit Default Description 1218 ** 07:00 00000000 Revision ID (RID): '00h' indicating bridge A-0 stepping. 1219 **============================================================================== 1220 */ 1221 #define ARCMSR_PCI2PCI_REVISIONID_REG 0x08 /*byte*/ 1222 /* 1223 **============================================================================== 1224 ** 0x0b-0x09 : 0180_00 (class code 1,native pci mode ) 1225 ** Bit Default Description 1226 ** 23:16 06h Base Class Code (BCC): Indicates that this is a bridge device. 1227 ** 15:08 04h Sub Class Code (SCC): Indicates this is of type PCI-to-PCI bridge. 1228 ** 07:00 00h Programming Interface (PIF): Indicates that this is standard (non-subtractive) PCI-PCI bridge. 1229 **============================================================================== 1230 */ 1231 #define ARCMSR_PCI2PCI_CLASSCODE_REG 0x09 /*3bytes*/ 1232 /* 1233 **============================================================================== 1234 ** 0x0c : cache line size 1235 ** Bit Default Description 1236 ** 07:00 00h Cache Line Size (CLS): Designates the cache line size in 32-bit dword units. 1237 ** The contents of this register are factored into 1238 ** internal policy decisions associated with memory read prefetching, 1239 ** and the promotion of Memory Write transactions to MWI transactions. 1240 ** Valid cache line sizes are 8 and 16 dwords. 1241 ** When the cache line size is set to an invalid value, 1242 ** bridge behaves as though the cache line size was set to 00h. 1243 **============================================================================== 1244 */ 1245 #define ARCMSR_PCI2PCI_PRIMARY_CACHELINESIZE_REG 0x0C /*byte*/ 1246 /* 1247 **============================================================================== 1248 ** 0x0d : latency timer (number of pci clock 00-ff ) 1249 ** Bit Default Description 1250 ** Primary Latency Timer (PTV): 1251 ** 07:00 00h (Conventional PCI) Conventional PCI Mode: Primary bus Master latency timer. Indicates the number of PCI clock cycles, 1252 ** referenced from the assertion of FRAME# to the expiration of the timer, 1253 ** when bridge may continue as master of the current transaction. All bits are writable, 1254 ** resulting in a granularity of 1 PCI clock cycle. 1255 ** When the timer expires (i.e., equals 00h) 1256 ** bridge relinquishes the bus after the first data transfer 1257 ** when its PCI bus grant has been deasserted. 1258 ** or 40h (PCI-X) PCI-X Mode: Primary bus Master latency timer. 1259 ** Indicates the number of PCI clock cycles, 1260 ** referenced from the assertion of FRAME# to the expiration of the timer, 1261 ** when bridge may continue as master of the current transaction. 1262 ** All bits are writable, resulting in a granularity of 1 PCI clock cycle. 1263 ** When the timer expires (i.e., equals 00h) bridge relinquishes the bus at the next ADB. 1264 ** (Except in the case where MLT expires within 3 data phases 1265 ** of an ADB.In this case bridge continues on 1266 ** until it reaches the next ADB before relinquishing the bus.) 1267 **============================================================================== 1268 */ 1269 #define ARCMSR_PCI2PCI_PRIMARY_LATENCYTIMER_REG 0x0D /*byte*/ 1270 /* 1271 **============================================================================== 1272 ** 0x0e : (header type,single function ) 1273 ** Bit Default Description 1274 ** 07 0 Multi-function device (MVD): 80331 is a single-function device. 1275 ** 06:00 01h Header Type (HTYPE): Defines the layout of addresses 10h through 3Fh in configuration space. 1276 ** Returns ��01h�� when read indicating 1277 ** that the register layout conforms to the standard PCI-to-PCI bridge layout. 1278 **============================================================================== 1279 */ 1280 #define ARCMSR_PCI2PCI_HEADERTYPE_REG 0x0E /*byte*/ 1281 /* 1282 **============================================================================== 1283 ** 0x0f : 1284 **============================================================================== 1285 */ 1286 /* 1287 **============================================================================== 1288 ** 0x13-0x10 : 1289 ** PCI CFG Base Address #0 (0x10) 1290 **============================================================================== 1291 */ 1292 /* 1293 **============================================================================== 1294 ** 0x17-0x14 : 1295 ** PCI CFG Base Address #1 (0x14) 1296 **============================================================================== 1297 */ 1298 /* 1299 **============================================================================== 1300 ** 0x1b-0x18 : 1301 ** PCI CFG Base Address #2 (0x18) 1302 **-----------------0x1A,0x19,0x18--Bus Number Register - BNR 1303 ** Bit Default Description 1304 ** 23:16 00h Subordinate Bus Number (SBBN): Indicates the highest PCI bus number below this bridge. 1305 ** Any Type 1 configuration cycle 1306 ** on the primary bus whose bus number is greater than the secondary bus number, 1307 ** and less than or equal to the subordinate bus number 1308 ** is forwarded unaltered as a Type 1 configuration cycle on the secondary PCI bus. 1309 ** 15:08 00h Secondary Bus Number (SCBN): Indicates the bus number of PCI to which the secondary interface is connected. 1310 ** Any Type 1 configuration cycle matching this bus number 1311 ** is translated to a Type 0 configuration cycle (or a Special Cycle) 1312 ** before being executed on bridge's secondary PCI bus. 1313 ** 07:00 00h Primary Bus Number (PBN): Indicates bridge primary bus number. 1314 ** Any Type 1 configuration cycle on the primary interface 1315 ** with a bus number that is less than the contents 1316 ** of this register field does not be claimed by bridge. 1317 **-----------------0x1B--Secondary Latency Timer Register - SLTR 1318 ** Bit Default Description 1319 ** Secondary Latency Timer (STV): 1320 ** 07:00 00h (Conventional PCI) Conventional PCI Mode: Secondary bus Master latency timer. 1321 ** Indicates the number of PCI clock cycles, 1322 ** referenced from the assertion of FRAME# to the expiration of the timer, 1323 ** when bridge may continue as master of the current transaction. All bits are writable, 1324 ** resulting in a granularity of 1 PCI clock cycle. 1325 ** When the timer expires (i.e., equals 00h) 1326 ** bridge relinquishes the bus after the first data transfer 1327 ** when its PCI bus grant has been deasserted. 1328 ** or 40h (PCI-X) PCI-X Mode: Secondary bus Master latency timer. 1329 ** Indicates the number of PCI clock cycles,referenced from the assertion of FRAME# 1330 ** to the expiration of the timer, 1331 ** when bridge may continue as master of the current transaction. All bits are writable, 1332 ** resulting in a granularity of 1 PCI clock cycle. 1333 ** When the timer expires (i.e., equals 00h) bridge relinquishes the bus at the next ADB. 1334 ** (Except in the case where MLT expires within 3 data phases of an ADB. 1335 ** In this case bridge continues on until it reaches the next ADB 1336 ** before relinquishing the bus) 1337 **============================================================================== 1338 */ 1339 #define ARCMSR_PCI2PCI_PRIMARY_BUSNUMBER_REG 0x18 /*3byte 0x1A,0x19,0x18*/ 1340 #define ARCMSR_PCI2PCI_SECONDARY_BUSNUMBER_REG 0x19 /*byte*/ 1341 #define ARCMSR_PCI2PCI_SUBORDINATE_BUSNUMBER_REG 0x1A /*byte*/ 1342 #define ARCMSR_PCI2PCI_SECONDARY_LATENCYTIMER_REG 0x1B /*byte*/ 1343 /* 1344 **============================================================================== 1345 ** 0x1f-0x1c : 1346 ** PCI CFG Base Address #3 (0x1C) 1347 **-----------------0x1D,0x1C--I/O Base and Limit Register - IOBL 1348 ** Bit Default Description 1349 ** 15:12 0h I/O Limit Address Bits [15:12]: Defines the top address of an address range to 1350 ** determine when to forward I/O transactions from one interface to the other. 1351 ** These bits correspond to address lines 15:12 for 4KB alignment. 1352 ** Bits 11:0 are assumed to be FFFh. 1353 ** 11:08 1h I/O Limit Addressing Capability: This field is hard-wired to 1h, indicating support 32-bit I/O addressing. 1354 ** 07:04 0h I/O Base Address Bits [15:12]: Defines the bottom address of 1355 ** an address range to determine when to forward I/O transactions 1356 ** from one interface to the other. 1357 ** These bits correspond to address lines 15:12 for 4KB alignment. 1358 ** Bits 11:0 are assumed to be 000h. 1359 ** 03:00 1h I/O Base Addressing Capability: This is hard-wired to 1h, indicating support for 32-bit I/O addressing. 1360 **-----------------0x1F,0x1E--Secondary Status Register - SSR 1361 ** Bit Default Description 1362 ** 15 0b Detected Parity Error: The bridge sets this bit to a 1b whenever it detects an address, 1363 ** attribute or data parity error on its secondary interface. 1364 ** 14 0b Received System Error: The bridge sets this bit when it samples SERR# asserted on its secondary bus interface. 1365 ** 13 0b Received Master Abort: The bridge sets this bit to a 1b when, 1366 ** acting as the initiator on the secondary bus, 1367 ** it's transaction (with the exception of special cycles) 1368 ** has been terminated with a Master Abort. 1369 ** 12 0b Received Target Abort: The bridge sets this bit to a 1b when, 1370 ** acting as the initiator on the secondary bus, 1371 ** it's transaction has been terminated with a Target Abort. 1372 ** 11 0b Signaled Target Abort: The bridge sets this bit to a 1b when it, 1373 ** as the target of a transaction, terminates it with a Target Abort. 1374 ** In PCI-X mode this bit is also set when it forwards a SCM with a target abort error code. 1375 ** 10:09 01b DEVSEL# Timing: Indicates slowest response to a non-configuration command on the secondary interface. 1376 ** Returns ��01b�� when read, indicating that bridge responds no slower than with medium timing. 1377 ** 08 0b Master Data Parity Error: The bridge sets this bit to a 1b when all of the following conditions are true: 1378 ** The bridge is the current master on the secondary bus 1379 ** S_PERR# is detected asserted or is asserted by bridge 1380 ** The Parity Error Response bit is set in the Command register 1381 ** 07 1b Fast Back-to-Back Capable (FBC): Indicates that the secondary interface of bridge can receive fast back-to-back cycles. 1382 ** 06 0b Reserved 1383 ** 05 1b 66 MHz Capable (C66): Indicates the secondary interface of the bridge is 66 MHz capable. 1384 ** 1 = 1385 ** 04:00 00h Reserved 1386 **============================================================================== 1387 */ 1388 #define ARCMSR_PCI2PCI_IO_BASE_REG 0x1C /*byte*/ 1389 #define ARCMSR_PCI2PCI_IO_LIMIT_REG 0x1D /*byte*/ 1390 #define ARCMSR_PCI2PCI_SECONDARY_STATUS_REG 0x1E /*word: 0x1F,0x1E */ 1391 /* 1392 **============================================================================== 1393 ** 0x23-0x20 : 1394 ** PCI CFG Base Address #4 (0x20) 1395 **-----------------0x23,0x22,0x21,0x20--Memory Base and Limit Register - MBL 1396 ** Bit Default Description 1397 ** 31:20 000h Memory Limit: These 12 bits are compared with P_AD[31:20] of the incoming address to determine 1398 ** the upper 1MB aligned value (exclusive) of the range. 1399 ** The incoming address must be less than or equal to this value. 1400 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0] 1401 ** are assumed to be F FFFFh. 1402 ** 19:16 0h Reserved. 1403 ** 15:04 000h Memory Base: These 12 bits are compared with bits P_AD[31:20] 1404 ** of the incoming address to determine the lower 1MB 1405 ** aligned value (inclusive) of the range. 1406 ** The incoming address must be greater than or equal to this value. 1407 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0]) 1408 ** are assumed to be 0 0000h. 1409 ** 03:00 0h Reserved. 1410 **============================================================================== 1411 */ 1412 #define ARCMSR_PCI2PCI_NONPREFETCHABLE_MEMORY_BASE_REG 0x20 /*word: 0x21,0x20 */ 1413 #define ARCMSR_PCI2PCI_NONPREFETCHABLE_MEMORY_LIMIT_REG 0x22 /*word: 0x23,0x22 */ 1414 /* 1415 **============================================================================== 1416 ** 0x27-0x24 : 1417 ** PCI CFG Base Address #5 (0x24) 1418 **-----------------0x27,0x26,0x25,0x24--Prefetchable Memory Base and Limit Register - PMBL 1419 ** Bit Default Description 1420 ** 31:20 000h Prefetchable Memory Limit: These 12 bits are compared with P_AD[31:20] of the incoming address to determine 1421 ** the upper 1MB aligned value (exclusive) of the range. 1422 ** The incoming address must be less than or equal to this value. 1423 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0] 1424 ** are assumed to be F FFFFh. 1425 ** 19:16 1h 64-bit Indicator: Indicates that 64-bit addressing is supported. 1426 ** 15:04 000h Prefetchable Memory Base: These 12 bits are compared with bits P_AD[31:20] 1427 ** of the incoming address to determine the lower 1MB aligned value (inclusive) 1428 ** of the range. 1429 ** The incoming address must be greater than or equal to this value. 1430 ** For the purposes of address decoding the lower 20 address bits (P_AD[19:0]) 1431 ** are assumed to be 0 0000h. 1432 ** 03:00 1h 64-bit Indicator: Indicates that 64-bit addressing is supported. 1433 **============================================================================== 1434 */ 1435 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_BASE_REG 0x24 /*word: 0x25,0x24 */ 1436 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_LIMIT_REG 0x26 /*word: 0x27,0x26 */ 1437 /* 1438 **============================================================================== 1439 ** 0x2b-0x28 : 1440 ** Bit Default Description 1441 ** 31:00 00000000h Prefetchable Memory Base Upper Portion: All bits are read/writable 1442 ** bridge supports full 64-bit addressing. 1443 **============================================================================== 1444 */ 1445 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_BASE_UPPER32_REG 0x28 /*dword: 0x2b,0x2a,0x29,0x28 */ 1446 /* 1447 **============================================================================== 1448 ** 0x2f-0x2c : 1449 ** Bit Default Description 1450 ** 31:00 00000000h Prefetchable Memory Limit Upper Portion: All bits are read/writable 1451 ** bridge supports full 64-bit addressing. 1452 **============================================================================== 1453 */ 1454 #define ARCMSR_PCI2PCI_PREFETCHABLE_MEMORY_LIMIT_UPPER32_REG 0x2C /*dword: 0x2f,0x2e,0x2d,0x2c */ 1455 /* 1456 **============================================================================== 1457 ** 0x33-0x30 : 1458 ** Bit Default Description 1459 ** 07:00 DCh Capabilities Pointer: Pointer to the first CAP ID entry in the capabilities list is at DCh in PCI configuration 1460 ** space. (Power Management Capability Registers) 1461 **============================================================================== 1462 */ 1463 #define ARCMSR_PCI2PCI_CAPABILITIES_POINTER_REG 0x34 /*byte*/ 1464 /* 1465 **============================================================================== 1466 ** 0x3b-0x35 : reserved 1467 **============================================================================== 1468 */ 1469 /* 1470 **============================================================================== 1471 ** 0x3d-0x3c : 1472 ** 1473 ** Bit Default Description 1474 ** 15:08 00h Interrupt Pin (PIN): Bridges do not support the generation of interrupts. 1475 ** 07:00 00h Interrupt Line (LINE): The bridge does not generate interrupts, so this is reserved as '00h'. 1476 **============================================================================== 1477 */ 1478 #define ARCMSR_PCI2PCI_PRIMARY_INTERRUPT_LINE_REG 0x3C /*byte*/ 1479 #define ARCMSR_PCI2PCI_PRIMARY_INTERRUPT_PIN_REG 0x3D /*byte*/ 1480 /* 1481 **============================================================================== 1482 ** 0x3f-0x3e : 1483 ** Bit Default Description 1484 ** 15:12 0h Reserved 1485 ** 11 0b Discard Timer SERR# Enable: Controls the generation of SERR# on the primary interface (P_SERR#) in response 1486 ** to a timer discard on either the primary or secondary interface. 1487 ** 0b=SERR# is not asserted. 1488 ** 1b=SERR# is asserted. 1489 ** 10 0b Discard Timer Status (DTS): This bit is set to a '1b' when either the primary or secondary discard timer expires. 1490 ** The delayed completion is then discarded. 1491 ** 09 0b Secondary Discard Timer (SDT): Sets the maximum number of PCI clock cycles 1492 ** that bridge waits for an initiator on the secondary bus 1493 ** to repeat a delayed transaction request. 1494 ** The counter starts when the delayed transaction completion is ready 1495 ** to be returned to the initiator. 1496 ** When the initiator has not repeated the transaction 1497 ** at least once before the counter expires,bridge 1498 ** discards the delayed transaction from its queues. 1499 ** 0b=The secondary master time-out counter is 2 15 PCI clock cycles. 1500 ** 1b=The secondary master time-out counter is 2 10 PCI clock cycles. 1501 ** 08 0b Primary Discard Timer (PDT): Sets the maximum number of PCI clock cycles 1502 ** that bridge waits for an initiator on the primary bus 1503 ** to repeat a delayed transaction request. 1504 ** The counter starts when the delayed transaction completion 1505 ** is ready to be returned to the initiator. 1506 ** When the initiator has not repeated the transaction 1507 ** at least once before the counter expires, 1508 ** bridge discards the delayed transaction from its queues. 1509 ** 0b=The primary master time-out counter is 2 15 PCI clock cycles. 1510 ** 1b=The primary master time-out counter is 2 10 PCI clock cycles. 1511 ** 07 0b Fast Back-to-Back Enable (FBE): The bridge does not initiate back to back transactions. 1512 ** 06 0b Secondary Bus Reset (SBR): 1513 ** When cleared to 0b: The bridge deasserts S_RST#, 1514 ** when it had been asserted by writing this bit to a 1b. 1515 ** When set to 1b: The bridge asserts S_RST#. 1516 ** 05 0b Master Abort Mode (MAM): Dictates bridge behavior on the initiator bus 1517 ** when a master abort termination occurs in response to 1518 ** a delayed transaction initiated by bridge on the target bus. 1519 ** 0b=The bridge asserts TRDY# in response to a non-locked delayed transaction, 1520 ** and returns FFFF FFFFh when a read. 1521 ** 1b=When the transaction had not yet been completed on the initiator bus 1522 ** (e.g.,delayed reads, or non-posted writes), 1523 ** then bridge returns a Target Abort in response to the original requester 1524 ** when it returns looking for its delayed completion on the initiator bus. 1525 ** When the transaction had completed on the initiator bus (e.g., a PMW), 1526 ** then bridge asserts P_SERR# (when enabled). 1527 ** For PCI-X transactions this bit is an enable for the assertion of P_SERR# due to a master abort 1528 ** while attempting to deliver a posted memory write on the destination bus. 1529 ** 04 0b VGA Alias Filter Enable: This bit dictates bridge behavior in conjunction with the VGA enable bit 1530 ** (also of this register), 1531 ** and the VGA Palette Snoop Enable bit (Command Register). 1532 ** When the VGA enable, or VGA Palette Snoop enable bits are on (i.e., 1b) 1533 ** the VGA Aliasing bit for the corresponding enabled functionality,: 1534 ** 0b=Ignores address bits AD[15:10] when decoding VGA I/O addresses. 1535 ** 1b=Ensures that address bits AD[15:10] equal 000000b when decoding VGA I/O addresses. 1536 ** When all VGA cycle forwarding is disabled, (i.e., VGA Enable bit =0b and VGA Palette Snoop bit =0b), 1537 ** then this bit has no impact on bridge behavior. 1538 ** 03 0b VGA Enable: Setting this bit enables address decoding 1539 ** and transaction forwarding of the following VGA transactions from the primary bus 1540 ** to the secondary bus: 1541 ** frame buffer memory addresses 000A0000h:000BFFFFh, 1542 ** 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), 1543 ** or must be ��000000b�� 1544 ** depending upon the state of the VGA Alias Filter Enable bit. (bit(4) of this register) 1545 ** I/O and Memory Enable bits must be set in the Command register 1546 ** to enable forwarding of VGA cycles. 1547 ** 02 0b ISA Enable: Setting this bit enables special handling 1548 ** for the forwarding of ISA I/O transactions that fall within the address range 1549 ** specified by the I/O Base and Limit registers, 1550 ** and are within the lowest 64Kbyte of the I/O address map 1551 ** (i.e., 0000 0000h - 0000 FFFFh). 1552 ** 0b=All I/O transactions that fall within the I/O Base 1553 ** and Limit registers' specified range are forwarded 1554 ** from primary to secondary unfiltered. 1555 ** 1b=Blocks the forwarding from primary to secondary 1556 ** of the top 768 bytes of each 1Kbyte alias. 1557 ** On the secondary the top 768 bytes of each 1K alias 1558 ** are inversely decoded and forwarded 1559 ** from secondary to primary. 1560 ** 01 0b SERR# Forward Enable: 0b=The bridge does not assert P_SERR# as a result of an S_SERR# assertion. 1561 ** 1b=The bridge asserts P_SERR# whenever S_SERR# is detected 1562 ** asserted provided the SERR# Enable bit is set (PCI Command Register bit(8)=1b). 1563 ** 00 0b Parity Error Response: This bit controls bridge response to a parity error 1564 ** that is detected on its secondary interface. 1565 ** 0b=When a data parity error is detected bridge does not assert S_PERR#. 1566 ** Also bridge does not assert P_SERR# in response to a detected address 1567 ** or attribute parity error. 1568 ** 1b=When a data parity error is detected bridge asserts S_PERR#. 1569 ** The bridge also asserts P_SERR# (when enabled globally via bit(8) 1570 ** of the Command register) 1571 ** in response to a detected address or attribute parity error. 1572 **============================================================================== 1573 */ 1574 #define ARCMSR_PCI2PCI_BRIDGE_CONTROL_REG 0x3E /*word*/ 1575 /* 1576 ************************************************************************** 1577 ** Device Specific Registers 40-A7h 1578 ************************************************************************** 1579 ** ---------------------------------------------------------------------------------------------------------- 1580 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset 1581 ** ---------------------------------------------------------------------------------------------------------- 1582 ** | Bridge Control 0 | Arbiter Control/Status | Reserved | 40h 1583 ** ---------------------------------------------------------------------------------------------------------- 1584 ** | Bridge Control 2 | Bridge Control 1 | 44h 1585 ** ---------------------------------------------------------------------------------------------------------- 1586 ** | Reserved | Bridge Status | 48h 1587 ** ---------------------------------------------------------------------------------------------------------- 1588 ** | Reserved | 4Ch 1589 ** ---------------------------------------------------------------------------------------------------------- 1590 ** | Prefetch Policy | Multi-Transaction Timer | 50h 1591 ** ---------------------------------------------------------------------------------------------------------- 1592 ** | Reserved | Pre-boot Status | P_SERR# Assertion Control | 54h 1593 ** ---------------------------------------------------------------------------------------------------------- 1594 ** | Reserved | Reserved | Secondary Decode Enable | 58h 1595 ** ---------------------------------------------------------------------------------------------------------- 1596 ** | Reserved | Secondary IDSEL | 5Ch 1597 ** ---------------------------------------------------------------------------------------------------------- 1598 ** | Reserved | 5Ch 1599 ** ---------------------------------------------------------------------------------------------------------- 1600 ** | Reserved | 68h:CBh 1601 ** ---------------------------------------------------------------------------------------------------------- 1602 ************************************************************************** 1603 **============================================================================== 1604 ** 0x42-0x41: Secondary Arbiter Control/Status Register - SACSR 1605 ** Bit Default Description 1606 ** 15:12 1111b Grant Time-out Violator: This field indicates the agent that violated the Grant Time-out rule 1607 ** (PCI=16 clocks,PCI-X=6 clocks). 1608 ** Note that this field is only meaningful when: 1609 ** # Bit[11] of this register is set to 1b, 1610 ** indicating that a Grant Time-out violation had occurred. 1611 ** # bridge internal arbiter is enabled. 1612 ** Bits[15:12] Violating Agent (REQ#/GNT# pair number) 1613 ** 0000b REQ#/GNT#[0] 1614 ** 0001b REQ#/GNT#[1] 1615 ** 0010b REQ#/GNT#[2] 1616 ** 0011b REQ#/GNT#[3] 1617 ** 1111b Default Value (no violation detected) 1618 ** When bit[11] is cleared by software, this field reverts back to its default value. 1619 ** All other values are Reserved 1620 ** 11 0b Grant Time-out Occurred: When set to 1b, 1621 ** this indicates that a Grant Time-out error had occurred involving one of the secondary bus agents. 1622 ** Software clears this bit by writing a 1b to it. 1623 ** 10 0b Bus Parking Control: 0=During bus idle, bridge parks the bus on the last master to use the bus. 1624 ** 1=During bus idle, bridge parks the bus on itself. 1625 ** The bus grant is removed from the last master and internally asserted to bridge. 1626 ** 09:08 00b Reserved 1627 ** 07:00 0000 0000b Secondary Bus Arbiter Priority Configuration: The bridge secondary arbiter provides two rings of arbitration priority. 1628 ** Each bit of this field assigns its corresponding secondary 1629 ** bus master to either the high priority arbiter ring (1b) 1630 ** or to the low priority arbiter ring (0b). 1631 ** Bits [3:0] correspond to request inputs S_REQ#[3:0], respectively. 1632 ** Bit [6] corresponds to the bridge internal secondary bus request 1633 ** while Bit [7] corresponds to the SATU secondary bus request. 1634 ** Bits [5:4] are unused. 1635 ** 0b=Indicates that the master belongs to the low priority group. 1636 ** 1b=Indicates that the master belongs to the high priority group 1637 **================================================================================= 1638 ** 0x43: Bridge Control Register 0 - BCR0 1639 ** Bit Default Description 1640 ** 07 0b Fully Dynamic Queue Mode: 0=The number of Posted write transactions is limited to eight 1641 ** and the Posted Write data is limited to 4KB. 1642 ** 1=Operation in fully dynamic queue mode. The bridge enqueues up to 1643 ** 14 Posted Memory Write transactions and 8KB of posted write data. 1644 ** 06:03 0H Reserved. 1645 ** 02 0b Upstream Prefetch Disable: This bit disables bridge ability 1646 ** to perform upstream prefetch operations for Memory 1647 ** Read requests received on its secondary interface. 1648 ** This bit also controls the bridge's ability to generate advanced read commands 1649 ** when forwarding a Memory Read Block transaction request upstream from a PCI-X bus 1650 ** to a Conventional PCI bus. 1651 ** 0b=bridge treats all upstream Memory Read requests as though they target prefetchable memory. 1652 ** The use of Memory Read Line and Memory Read 1653 ** Multiple is enabled when forwarding a PCI-X Memory Read Block request 1654 ** to an upstream bus operating in Conventional PCI mode. 1655 ** 1b=bridge treats upstream PCI Memory Read requests as though 1656 ** they target non-prefetchable memory and forwards upstream PCI-X Memory 1657 ** Read Block commands as Memory Read 1658 ** when the primary bus is operating 1659 ** in Conventional PCI mode. 1660 ** NOTE: This bit does not affect bridge ability to perform read prefetching 1661 ** when the received command is Memory Read Line or Memory Read Multiple. 1662 **================================================================================= 1663 ** 0x45-0x44: Bridge Control Register 1 - BCR1 (Sheet 2 of 2) 1664 ** Bit Default Description 1665 ** 15:08 0000000b Reserved 1666 ** 07:06 00b Alias Command Mapping: This two bit field determines how bridge handles PCI-X ��Alias�� commands, 1667 ** specifically the Alias to Memory Read Block and Alias to Memory Write Block commands. 1668 ** The three options for handling these alias commands are to either pass it as is, 1669 ** re-map to the actual block memory read/write command encoding, or ignore 1670 ** the transaction forcing a Master Abort to occur on the Origination Bus. 1671 ** Bit (7:6) Handling of command 1672 ** 0 0 Re-map to Memory Read/Write Block before forwarding 1673 ** 0 1 Enqueue and forward the alias command code unaltered 1674 ** 1 0 Ignore the transaction, forcing Master Abort 1675 ** 1 1 Reserved 1676 ** 05 1b Watchdog Timers Disable: Disables or enables all 2 24 Watchdog Timers in both directions. 1677 ** The watchdog timers are used to detect prohibitively long latencies in the system. 1678 ** The watchdog timer expires when any Posted Memory Write (PMW), Delayed Request, 1679 ** or Split Requests (PCI-X mode) is not completed within 2 24 events 1680 ** (��events�� are defined as PCI Clocks when operating in PCI-X mode, 1681 ** and as the number of times being retried when operating in Conventional PCI mode) 1682 ** 0b=All 2 24 watchdog timers are enabled. 1683 ** 1b=All 2 24 watchdog timers are disabled and there is no limits to 1684 ** the number of attempts bridge makes when initiating a PMW, 1685 ** transacting a Delayed Transaction, or how long it waits for 1686 ** a split completion corresponding to one of its requests. 1687 ** 04 0b GRANT# time-out disable: This bit enables/disables the GNT# time-out mechanism. 1688 ** Grant time-out is 16 clocks for conventional PCI, and 6 clocks for PCI-X. 1689 ** 0b=The Secondary bus arbiter times out an agent 1690 ** that does not assert FRAME# within 16/6 clocks of receiving its grant, 1691 ** once the bus has gone idle. 1692 ** The time-out counter begins as soon as the bus goes idle with the new GNT# asserted. 1693 ** An infringing agent does not receive a subsequent GNT# 1694 ** until it de-asserts its REQ# for at least one clock cycle. 1695 ** 1b=GNT# time-out mechanism is disabled. 1696 ** 03 00b Reserved. 1697 ** 02 0b Secondary Discard Timer Disable: This bit enables/disables bridge secondary delayed transaction discard mechanism. 1698 ** The time out mechanism is used to ensure that initiators 1699 ** of delayed transactions return for their delayed completion data/status 1700 ** within a reasonable amount of time after it is available from bridge. 1701 ** 0b=The secondary master time-out counter is enabled 1702 ** and uses the value specified by the Secondary Discard Timer bit 1703 ** (see Bridge Control Register). 1704 ** 1b=The secondary master time-out counter is disabled. 1705 ** The bridge waits indefinitely for a secondary bus master 1706 ** to repeat a delayed transaction. 1707 ** 01 0b Primary Discard Timer Disable: This bit enables/disables bridge primary delayed transaction discard mechanism. 1708 ** The time out mechanism is used to ensure that initiators 1709 ** of delayed transactions return for their delayed completion data/status 1710 ** within a reasonable amount of time after it is available from bridge. 1711 ** 0b=The primary master time-out counter is enabled and uses the value specified 1712 ** by the Primary Discard Timer bit (see Bridge Control Register). 1713 ** 1b=The secondary master time-out counter is disabled. 1714 ** The bridge waits indefinitely for a secondary bus master 1715 ** to repeat a delayed transaction. 1716 ** 00 0b Reserved 1717 **================================================================================= 1718 ** 0x47-0x46: Bridge Control Register 2 - BCR2 1719 ** Bit Default Description 1720 ** 15:07 0000b Reserved. 1721 ** 06 0b Global Clock Out Disable (External Secondary Bus Clock Source Enable): 1722 ** This bit disables all of the secondary PCI clock outputs including 1723 ** the feedback clock S_CLKOUT. 1724 ** This means that the user is required to provide an S_CLKIN input source. 1725 ** 05:04 11 (66 MHz) Preserved. 1726 ** 01 (100 MHz) 1727 ** 00 (133 MHz) 1728 ** 03:00 Fh (100 MHz & 66 MHz) 1729 ** 7h (133 MHz) 1730 ** This 4 bit field provides individual enable/disable mask bits for each of bridge 1731 ** secondary PCI clock outputs. Some, or all secondary clock outputs (S_CLKO[3:0]) 1732 ** default to being enabled following the rising edge of P_RST#, depending on the 1733 ** frequency of the secondary bus clock: 1734 ** �E Designs with 100 MHz (or lower) Secondary PCI clock power up with 1735 ** all four S_CLKOs enabled by default. (SCLKO[3:0])�P 1736 ** �E Designs with 133 MHz Secondary PCI clock power up 1737 ** with the lower order 3 S_CLKOs enabled by default. 1738 ** (S_CLKO[2:0]) Only those SCLKs that power up enabled by can be connected 1739 ** to downstream device clock inputs. 1740 **================================================================================= 1741 ** 0x49-0x48: Bridge Status Register - BSR 1742 ** Bit Default Description 1743 ** 15 0b Upstream Delayed Transaction Discard Timer Expired: This bit is set to a 1b and P_SERR# 1744 ** is conditionally asserted when the secondary discard timer expires. 1745 ** 14 0b Upstream Delayed/Split Read Watchdog Timer Expired: 1746 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# 1747 ** is conditionally asserted when bridge discards an upstream delayed read ** ** transaction request after 2 24 retries following the initial retry. 1748 ** PCI-X Mode: This bit is set to a 1b and P_SERR# is conditionally asserted 1749 ** when bridge discards an upstream split read request 1750 ** after waiting in excess of 2 24 clocks for the corresponding 1751 ** Split Completion to arrive. 1752 ** 13 0b Upstream Delayed/Split Write Watchdog Timer Expired: 1753 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# 1754 ** is conditionally asserted when bridge discards an upstream delayed write ** ** transaction request after 2 24 retries following the initial retry. 1755 ** PCI-X Mode: This bit is set to a 1b and P_SERR# 1756 ** is conditionally asserted when bridge discards an upstream split write request ** after waiting in excess of 2 24 clocks for the corresponding 1757 ** Split Completion to arrive. 1758 ** 12 0b Master Abort during Upstream Posted Write: This bit is set to a 1b and P_SERR# 1759 ** is conditionally asserted when a Master Abort occurs as a result of an attempt, 1760 ** by bridge, to retire a PMW upstream. 1761 ** 11 0b Target Abort during Upstream Posted Write: This bit is set to a 1b and P_SERR# 1762 ** is conditionally asserted when a Target Abort occurs as a result of an attempt, 1763 ** by bridge, to retire a PMW upstream. 1764 ** 10 0b Upstream Posted Write Data Discarded: This bit is set to a 1b and P_SERR# 1765 ** is conditionally asserted when bridge discards an upstream PMW transaction 1766 ** after receiving 2 24 target retries from the primary bus target 1767 ** 09 0b Upstream Posted Write Data Parity Error: This bit is set to a 1b and P_SERR# 1768 ** is conditionally asserted when a data parity error is detected by bridge 1769 ** while attempting to retire a PMW upstream 1770 ** 08 0b Secondary Bus Address Parity Error: This bit is set to a 1b and P_SERR# 1771 ** is conditionally asserted when bridge detects an address parity error on 1772 ** the secondary bus. 1773 ** 07 0b Downstream Delayed Transaction Discard Timer Expired: This bit is set to a 1b and P_SERR# 1774 ** is conditionally asserted when the primary bus discard timer expires. 1775 ** 06 0b Downstream Delayed/Split Read Watchdog Timer Expired: 1776 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# 1777 ** is conditionally asserted when bridge discards a downstream delayed read ** ** transaction request after receiving 2 24 target retries 1778 ** from the secondary bus target. 1779 ** PCI-X Mode: This bit is set to a 1b and P_SERR# is conditionally asserted 1780 ** when bridge discards a downstream split read request 1781 ** after waiting in excess of 2 24 clocks for the corresponding 1782 ** Split Completion to arrive. 1783 ** 05 0b Downstream Delayed Write/Split Watchdog Timer Expired: 1784 ** Conventional PCI Mode: This bit is set to a 1b and P_SERR# is conditionally asserted 1785 ** when bridge discards a downstream delayed write transaction request 1786 ** after receiving 2 24 target retries from the secondary bus target. 1787 ** PCI-X Mode: This bit is set to a 1b and P_SERR# 1788 ** is conditionally asserted when bridge discards a downstream 1789 ** split write request after waiting in excess of 2 24 clocks 1790 ** for the corresponding Split Completion to arrive. 1791 ** 04 0b Master Abort during Downstream Posted Write: This bit is set to a 1b and P_SERR# 1792 ** is conditionally asserted when a Master Abort occurs as a result of an attempt, 1793 ** by bridge, to retire a PMW downstream. 1794 ** 03 0b Target Abort during Downstream Posted Write: This bit is set to a 1b and P_SERR# is conditionally asserted 1795 ** when a Target Abort occurs as a result of an attempt, by bridge, 1796 ** to retire a PMW downstream. 1797 ** 02 0b Downstream Posted Write Data Discarded: This bit is set to a 1b and P_SERR# 1798 ** is conditionally asserted when bridge discards a downstream PMW transaction 1799 ** after receiving 2 24 target retries from the secondary bus target 1800 ** 01 0b Downstream Posted Write Data Parity Error: This bit is set to a 1b and P_SERR# 1801 ** is conditionally asserted when a data parity error is detected by bridge 1802 ** while attempting to retire a PMW downstream. 1803 ** 00 0b Primary Bus Address Parity Error: This bit is set to a 1b and P_SERR# is conditionally asserted 1804 ** when bridge detects an address parity error on the primary bus. 1805 **================================================================================== 1806 ** 0x51-0x50: Bridge Multi-Transaction Timer Register - BMTTR 1807 ** Bit Default Description 1808 ** 15:13 000b Reserved 1809 ** 12:10 000b GRANT# Duration: This field specifies the count (PCI clocks) 1810 ** that a secondary bus master has its grant maintained in order to enable 1811 ** multiple transactions to execute within the same arbitration cycle. 1812 ** Bit[02:00] GNT# Extended Duration 1813 ** 000 MTT Disabled (Default=no GNT# extension) 1814 ** 001 16 clocks 1815 ** 010 32 clocks 1816 ** 011 64 clocks 1817 ** 100 128 clocks 1818 ** 101 256 clocks 1819 ** 110 Invalid (treated as 000) 1820 ** 111 Invalid (treated as 000) 1821 ** 09:08 00b Reserved 1822 ** 07:00 FFh MTT Mask: This field enables/disables MTT usage for each REQ#/GNT# 1823 ** pair supported by bridge secondary arbiter. 1824 ** Bit(7) corresponds to SATU internal REQ#/GNT# pair, 1825 ** bit(6) corresponds to bridge internal REQ#/GNT# pair, 1826 ** bit(5) corresponds to REQ#/GNT#(5) pair, etc. 1827 ** When a given bit is set to 1b, its corresponding REQ#/GNT# 1828 ** pair is enabled for MTT functionality as determined by bits(12:10) of this register. 1829 ** When a given bit is cleared to 0b, its corresponding REQ#/GNT# pair is disabled from using the MTT. 1830 **================================================================================== 1831 ** 0x53-0x52: Read Prefetch Policy Register - RPPR 1832 ** Bit Default Description 1833 ** 15:13 000b ReRead_Primary Bus: 3-bit field indicating the multiplication factor 1834 ** 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 1835 ** using the FirstRead parameter. 1836 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount Memory Read 4 DWORDs 1837 ** Memory Read Line 1 cache lines Memory Read Multiple 2 cache lines 1838 ** 12:10 000b FirstRead_Primary Bus: 3-bit field indicating the multiplication factor to be used in calculating 1839 ** the number of bytes to prefetch from the secondary bus interface 1840 ** on the initial PreFetch operation. 1841 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount Memory Read 4 DWORDs 1842 ** Memory Read Line 1 cache line Memory Read Multiple 2 cache lines 1843 ** 09:07 010b ReRead_Secondary Bus: 3-bit field indicating the multiplication factor to be used 1844 ** in calculating the number of bytes to prefetch from the primary 1845 ** bus interface on subsequent PreFetch operations given 1846 ** that the read demands were not satisfied using 1847 ** the FirstRead parameter. 1848 ** The default value of 010b correlates to: Command Type Hardwired pre-fetch a 1849 ** mount Memory Read 3 cache lines Memory Read Line 3 cache lines 1850 ** Memory Read Multiple 6 cache lines 1851 ** 06:04 000b FirstRead_Secondary Bus: 3-bit field indicating the multiplication factor to be used 1852 ** in calculating the number of bytes to prefetch from 1853 ** the primary bus interface on the initial PreFetch operation. 1854 ** The default value of 000b correlates to: Command Type Hardwired pre-fetch amount 1855 ** Memory Read 4 DWORDs Memory Read Line 1 cache line Memory Read Multiple 2 cache lines 1856 ** 03:00 1111b Staged Prefetch Enable: This field enables/disables the FirstRead/ReRead pre-fetch 1857 ** algorithm for the secondary and the primary bus interfaces. 1858 ** Bit(3) is a ganged enable bit for REQ#/GNT#[7:3], and bits(2:0) provide individual 1859 ** enable bits for REQ#/GNT#[2:0]. 1860 ** (bit(2) is the enable bit for REQ#/GNT#[2], etc...) 1861 ** 1b: enables the staged pre-fetch feature 1862 ** 0b: disables staged pre-fetch, 1863 ** and hardwires read pre-fetch policy to the following for 1864 ** Memory Read, 1865 ** Memory Read Line, 1866 ** and Memory Read Multiple commands: 1867 ** Command Type Hardwired Pre-Fetch Amount... 1868 ** Memory Read 4 DWORDs 1869 ** Memory Read Line 1 cache line 1870 ** Memory Read Multiple 2 cache lines 1871 ** NOTE: When the starting address is not cache line aligned, bridge pre-fetches Memory Read line commands 1872 ** only to the next higher cache line boundary.For non-cache line aligned Memory Read 1873 ** Multiple commands bridge pre-fetches only to the second cache line boundary encountered. 1874 **================================================================================== 1875 ** 0x55-0x54: P_SERR# Assertion Control - SERR_CTL 1876 ** Bit Default Description 1877 ** 15 0b Upstream Delayed Transaction Discard Timer Expired: Dictates the bridge behavior 1878 ** in response to its discarding of a delayed transaction that was initiated from the primary bus. 1879 ** 0b=bridge asserts P_SERR#. 1880 ** 1b=bridge does not assert P_SERR# 1881 ** 14 0b Upstream Delayed/Split Read Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer. 1882 ** 0b=bridge asserts P_SERR#. 1883 ** 1b=bridge does not assert P_SERR# 1884 ** 13 0b Upstream Delayed/Split Write Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer. 1885 ** 0b=bridge asserts P_SERR#. 1886 ** 1b=bridge does not assert P_SERR# 1887 ** 12 0b Master Abort during Upstream Posted Write: Dictates bridge behavior following 1888 ** its having detected a Master Abort while attempting to retire one of its PMWs upstream. 1889 ** 0b=bridge asserts P_SERR#. 1890 ** 1b=bridge does not assert P_SERR# 1891 ** 11 0b Target Abort during Upstream Posted Write: Dictates bridge behavior following 1892 ** its having been terminated with Target Abort while attempting to retire one of its PMWs upstream. 1893 ** 0b=bridge asserts P_SERR#. 1894 ** 1b=bridge does not assert P_SERR# 1895 ** 10 0b Upstream Posted Write Data Discarded: Dictates bridge behavior in the event that 1896 ** it discards an upstream posted write transaction. 1897 ** 0b=bridge asserts P_SERR#. 1898 ** 1b=bridge does not assert P_SERR# 1899 ** 09 0b Upstream Posted Write Data Parity Error: Dictates bridge behavior 1900 ** when a data parity error is detected while attempting to retire on of its PMWs upstream. 1901 ** 0b=bridge asserts P_SERR#. 1902 ** 1b=bridge does not assert P_SERR# 1903 ** 08 0b Secondary Bus Address Parity Error: This bit dictates bridge behavior 1904 ** when it detects an address parity error on the secondary bus. 1905 ** 0b=bridge asserts P_SERR#. 1906 ** 1b=bridge does not assert P_SERR# 1907 ** 07 0b Downstream Delayed Transaction Discard Timer Expired: Dictates bridge behavior in response to 1908 ** its discarding of a delayed transaction that was initiated on the secondary bus. 1909 ** 0b=bridge asserts P_SERR#. 1910 ** 1b=bridge does not assert P_SERR# 1911 ** 06 0b Downstream Delayed/Split Read Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer. 1912 ** 0b=bridge asserts P_SERR#. 1913 ** 1b=bridge does not assert P_SERR# 1914 ** 05 0b Downstream Delayed/Split Write Watchdog Timer Expired: Dictates bridge behavior following expiration of the subject watchdog timer. 1915 ** 0b=bridge asserts P_SERR#. 1916 ** 1b=bridge does not assert P_SERR# 1917 ** 04 0b Master Abort during Downstream Posted Write: Dictates bridge behavior following 1918 ** its having detected a Master Abort while attempting to retire one of its PMWs downstream. 1919 ** 0b=bridge asserts P_SERR#. 1920 ** 1b=bridge does not assert P_SERR# 1921 ** 03 0b Target Abort during Downstream Posted Write: Dictates bridge behavior following 1922 ** its having been terminated with Target Abort while attempting to retire one of its PMWs downstream. 1923 ** 0b=bridge asserts P_SERR#. 1924 ** 1b=bridge does not assert P_SERR# 1925 ** 02 0b Downstream Posted Write Data Discarded: Dictates bridge behavior in the event 1926 ** that it discards a downstream posted write transaction. 1927 ** 0b=bridge asserts P_SERR#. 1928 ** 1b=bridge does not assert P_SERR# 1929 ** 01 0b Downstream Posted Write Data Parity Error: Dictates bridge behavior 1930 ** when a data parity error is detected while attempting to retire on of its PMWs downstream. 1931 ** 0b=bridge asserts P_SERR#. 1932 ** 1b=bridge does not assert P_SERR# 1933 ** 00 0b Primary Bus Address Parity Error: This bit dictates bridge behavior 1934 ** when it detects an address parity error on the primary bus. 1935 ** 0b=bridge asserts P_SERR#. 1936 ** 1b=bridge does not assert P_SERR# 1937 **=============================================================================== 1938 ** 0x56: Pre-Boot Status Register - PBSR 1939 ** Bit Default Description 1940 ** 07 1 Reserved 1941 ** 06 - Reserved - value indeterminate 1942 ** 05:02 0 Reserved 1943 ** 01 Varies with External State of S_133EN at PCI Bus Reset Secondary Bus Max Frequency Setting: 1944 ** This bit reflect captured S_133EN strap, 1945 ** indicating the maximum secondary bus clock frequency when in PCI-X mode. 1946 ** Max Allowable Secondary Bus Frequency 1947 ** ** S_133EN PCI-X Mode 1948 ** ** 0 100 MHz 1949 ** ** 1 133 MH 1950 ** 00 0b Reserved 1951 **=============================================================================== 1952 ** 0x59-0x58: Secondary Decode Enable Register - SDER 1953 ** Bit Default Description 1954 ** 15:03 FFF1h Preserved. 1955 ** 02 Varies with External State of PRIVMEM at PCI Bus Reset Private Memory Space Enable - when set, 1956 ** bridge overrides its secondary inverse decode logic and not 1957 ** forward upstream any secondary bus initiated DAC Memory transactions with AD(63)=1b. 1958 ** This creates a private memory space on the Secondary PCI bus 1959 ** that allows peer-to-peer transactions. 1960 ** 01:00 10 2 Preserved. 1961 **=============================================================================== 1962 ** 0x5D-0x5C: Secondary IDSEL Select Register - SISR 1963 ** Bit Default Description 1964 ** 15:10 000000 2 Reserved. 1965 ** 09 Varies with External State of PRIVDEV at PCI Bus Reset AD25- IDSEL Disable - When this bit is set, 1966 ** AD25 is deasserted for any possible Type 1 to Type 0 conversion. 1967 ** When this bit is clear, 1968 ** AD25 is asserted when Primary addresses AD[15:11]=01001 2 during a Type 1 to Type 0 conversion. 1969 ** 08 Varies with External State of PRIVDEV at PCI Bus Reset AD24- IDSEL Disable - When this bit is set, 1970 ** AD24 is deasserted for any possible Type 1 to Type 0 conversion. 1971 ** When this bit is clear, 1972 ** AD24 is asserted when Primary addresses AD[15:11]=01000 2 during a Type 1 to Type 0 conversion. 1973 ** 07 Varies with External State of PRIVDEV at PCI Bus Reset AD23- IDSEL Disable - When this bit is set, 1974 ** AD23 is deasserted for any possible Type 1 to Type 0 conversion. 1975 ** When this bit is clear, 1976 ** AD23 is asserted when Primary addresses AD[15:11]=00111 2 during a Type 1 to Type 0 conversion. 1977 ** 06 Varies with External State of PRIVDEV at PCI Bus Reset AD22- IDSEL Disable - When this bit is set, 1978 ** AD22 is deasserted for any possible Type 1 to Type 0 conversion. 1979 ** When this bit is clear, 1980 ** AD22 is asserted when Primary addresses AD[15:11]=00110 2 during a Type 1 to Type 0 conversion. 1981 ** 05 Varies with External State of PRIVDEV at PCI Bus Reset AD21- IDSEL Disable - When this bit is set, 1982 ** AD21 is deasserted for any possible Type 1 to Type 0 conversion. 1983 ** When this bit is clear, 1984 ** AD21 is asserted when Primary addresses AD[15:11]=00101 2 during a Type 1 to Type 0 conversion. 1985 ** 04 Varies with External State of PRIVDEV at PCI Bus Reset AD20- IDSEL Disable - When this bit is set, 1986 ** AD20 is deasserted for any possible Type 1 to Type 0 conversion. 1987 ** When this bit is clear, 1988 ** AD20 is asserted when Primary addresses AD[15:11]=00100 2 during a Type 1 to Type 0 conversion. 1989 ** 03 Varies with External State of PRIVDEV at PCI Bus Reset AD19- IDSEL Disable - When this bit is set, 1990 ** AD19 is deasserted for any possible Type 1 to Type 0 conversion. 1991 ** When this bit is clear, 1992 ** AD19 is asserted when Primary addresses AD[15:11]=00011 2 during a Type 1 to Type 0 conversion. 1993 ** 02 Varies with External State of PRIVDEV at PCI Bus Reset AD18- IDSEL Disable - When this bit is set, 1994 ** AD18 is deasserted for any possible Type 1 to Type 0 conversion. 1995 ** When this bit is clear, 1996 ** AD18 is asserted when Primary addresses AD[15:11]=00010 2 during a Type 1 to Type 0 conversion. 1997 ** 01 Varies with External State of PRIVDEV at PCI Bus Reset AD17- IDSEL Disable - When this bit is set, 1998 ** AD17 is deasserted for any possible Type 1 to Type 0 conversion. 1999 ** When this bit is clear, 2000 ** AD17 is asserted when Primary addresses AD[15:11]=00001 2 during a Type 1 to Type 0 conversion. 2001 ** 00 Varies with External State of PRIVDEV at PCI Bus Reset AD16- IDSEL Disable - When this bit is set, 2002 ** AD16 is deasserted for any possible Type 1 to Type 0 conversion. 2003 ** When this bit is clear, 2004 ** AD16 is asserted when Primary addresses AD[15:11]=00000 2 during a Type 1 to Type 0 conversion. 2005 ************************************************************************** 2006 */ 2007 /* 2008 ************************************************************************** 2009 ** Reserved A8-CBh 2010 ************************************************************************** 2011 */ 2012 /* 2013 ************************************************************************** 2014 ** PCI Extended Enhanced Capabilities List CC-FFh 2015 ************************************************************************** 2016 ** ---------------------------------------------------------------------------------------------------------- 2017 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configu-ration Byte Offset 2018 ** ---------------------------------------------------------------------------------------------------------- 2019 ** | Power Management Capabilities | Next Item Ptr | Capability ID | DCh 2020 ** ---------------------------------------------------------------------------------------------------------- 2021 ** | PM Data | PPB Support | Extensions Power Management CSR | E0h 2022 ** ---------------------------------------------------------------------------------------------------------- 2023 ** | Reserved | Reserved | Reserved | E4h 2024 ** ---------------------------------------------------------------------------------------------------------- 2025 ** | Reserved | E8h 2026 ** ---------------------------------------------------------------------------------------------------------- 2027 ** | Reserved | Reserved | Reserved | Reserved | ECh 2028 ** ---------------------------------------------------------------------------------------------------------- 2029 ** | PCI-X Secondary Status | Next Item Ptr | Capability ID | F0h 2030 ** ---------------------------------------------------------------------------------------------------------- 2031 ** | PCI-X Bridge Status | F4h 2032 ** ---------------------------------------------------------------------------------------------------------- 2033 ** | PCI-X Upstream Split Transaction Control | F8h 2034 ** ---------------------------------------------------------------------------------------------------------- 2035 ** | PCI-X Downstream Split Transaction Control | FCh 2036 ** ---------------------------------------------------------------------------------------------------------- 2037 **=============================================================================== 2038 ** 0xDC: Power Management Capabilities Identifier - PM_CAPID 2039 ** Bit Default Description 2040 ** 07:00 01h Identifier (ID): PCI SIG assigned ID for PCI-PM register block 2041 **=============================================================================== 2042 ** 0xDD: Next Item Pointer - PM_NXTP 2043 ** Bit Default Description 2044 ** 07:00 F0H Next Capabilities Pointer (PTR): The register defaults to F0H pointing to the PCI-X Extended Capability Header. 2045 **=============================================================================== 2046 ** 0xDF-0xDE: Power Management Capabilities Register - PMCR 2047 ** Bit Default Description 2048 ** 15:11 00h PME Supported (PME): PME# cannot be asserted by bridge. 2049 ** 10 0h State D2 Supported (D2): Indicates no support for state D2. No power management action in this state. 2050 ** 09 1h State D1 Supported (D1): Indicates support for state D1. No power management action in this state. 2051 ** 08:06 0h Auxiliary Current (AUXC): This 3 bit field reports the 3.3Vaux auxiliary current requirements for the PCI function. 2052 ** This returns 000b as PME# wake-up for bridge is not implemented. 2053 ** 05 0 Special Initialization Required (SINT): Special initialization is not required for bridge. 2054 ** 04:03 00 Reserved 2055 ** 02:00 010 Version (VS): Indicates that this supports PCI Bus Power Management Interface Specification, Revision 1.1. 2056 **=============================================================================== 2057 ** 0xE1-0xE0: Power Management Control / Status - Register - PMCSR 2058 ** Bit Default Description 2059 ** 15:09 00h Reserved 2060 ** 08 0b PME_Enable: This bit, when set to 1b enables bridge to assert PME#. 2061 ** 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. 2062 ** 07:02 00h Reserved 2063 ** 01:00 00 Power State (PSTATE): This 2-bit field is used both to determine the current power state of 2064 ** a function and to set the Function into a new power state. 2065 ** 00 - D0 state 2066 ** 01 - D1 state 2067 ** 10 - D2 state 2068 ** 11 - D3 hot state 2069 **=============================================================================== 2070 ** 0xE2: Power Management Control / Status PCI to PCI Bridge Support - PMCSR_BSE 2071 ** Bit Default Description 2072 ** 07 0 Bus Power/Clock Control Enable (BPCC_En): Indicates that the bus power/clock control policies have been disabled. 2073 ** 06 0 B2/B3 support for D3 Hot (B2_B3#): The state of this bit determines the action that 2074 ** is to occur as a direct result of programming the function to D3 hot. 2075 ** This bit is only meaningful when bit 7 (BPCC_En) is a ��1��. 2076 ** 05:00 00h Reserved 2077 **=============================================================================== 2078 ** 0xE3: Power Management Data Register - PMDR 2079 ** Bit Default Description 2080 ** 07:00 00h Reserved 2081 **=============================================================================== 2082 ** 0xF0: PCI-X Capabilities Identifier - PX_CAPID 2083 ** Bit Default Description 2084 ** 07:00 07h Identifier (ID): Indicates this is a PCI-X capabilities list. 2085 **=============================================================================== 2086 ** 0xF1: Next Item Pointer - PX_NXTP 2087 ** Bit Default Description 2088 ** 07:00 00h Next Item Pointer: Points to the next capability in the linked list The power on default value of this 2089 ** register is 00h indicating that this is the last entry in the linked list of capabilities. 2090 **=============================================================================== 2091 ** 0xF3-0xF2: PCI-X Secondary Status - PX_SSTS 2092 ** Bit Default Description 2093 ** 15:09 00h Reserved 2094 ** 08:06 Xxx Secondary Clock Frequency (SCF): This field is set with the frequency of the secondary bus. 2095 ** The values are: 2096 ** ** BitsMax FrequencyClock Period 2097 ** ** 000PCI ModeN/A 2098 ** ** 00166 15 2099 ** ** 01010010 2100 ** ** 0111337.5 2101 ** ** 1xxreservedreserved 2102 ** ** The default value for this register is the operating frequency of the secondary bus 2103 ** 05 0b Split Request Delayed. (SRD): This bit is supposed to be set by a bridge when it cannot forward a transaction on the 2104 ** secondary bus to the primary bus because there is not enough room within the limit 2105 ** specified in the Split Transaction Commitment Limit field in the Downstream Split 2106 ** Transaction Control register. The bridge does not set this bit. 2107 ** 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. 2108 ** The bridge does not set this bit. 2109 ** 03 0b Unexpected Split Completion (USC): This bit is set when an unexpected split completion with a requester ID 2110 ** equal to bridge secondary bus number, device number 00h, 2111 ** and function number 0 is received on the secondary interface. 2112 ** This bit is cleared by software writing a '1'. 2113 ** 02 0b Split Completion Discarded (SCD): This bit is set 2114 ** when bridge discards a split completion moving toward the secondary bus 2115 ** because the requester would not accept it. This bit cleared by software writing a '1'. 2116 ** 01 1b 133 MHz Capable: Indicates that bridge is capable of running its secondary bus at 133 MHz 2117 ** 00 1b 64-bit Device (D64): Indicates the width of the secondary bus as 64-bits. 2118 **=============================================================================== 2119 ** 0xF7-0xF6-0xf5-0xF4: PCI-X Bridge Status - PX_BSTS 2120 ** Bit Default Description 2121 ** 31:22 0 Reserved 2122 ** 21 0 Split Request Delayed (SRD): This bit does not be set by bridge. 2123 ** 20 0 Split Completion Overrun (SCO): This bit does not be set by bridge 2124 ** because bridge throttles traffic on the completion side. 2125 ** 19 0 Unexpected Split Completion (USC): The bridge sets this bit to 1b 2126 ** when it encounters a corrupted Split Completion, possibly with an ** ** inconsistent remaining byte count.Software clears 2127 ** this bit by writing a 1b to it. 2128 ** 18 0 Split Completion Discarded (SCD): The bridge sets this bit to 1b 2129 ** when it has discarded a Split Completion.Software clears this bit by ** ** writing a 1b to it. 2130 ** 17 1 133 MHz Capable: This bit indicates that the bridge primary interface is ** capable of 133 MHz operation in PCI-X mode. 2131 ** 0=The maximum operating frequency is 66 MHz. 2132 ** 1=The maximum operating frequency is 133 MHz. 2133 ** 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. 2134 ** 0=Primary Interface is connected as a 32-bit PCI bus. 2135 ** 1=Primary Interface is connected as a 64-bit PCI bus. 2136 ** 15:08 00h Bus Number (BNUM): This field is simply an alias to the PBN field 2137 ** of the BNUM register at offset 18h. 2138 ** Apparently it was deemed necessary reflect it here for diagnostic purposes. 2139 ** 07:03 1fh Device Number (DNUM): Indicates which IDSEL bridge consumes. 2140 ** May be updated whenever a PCI-X 2141 ** configuration write cycle that targets bridge scores a hit. 2142 ** 02:00 0h Function Number (FNUM): The bridge Function # 2143 **=============================================================================== 2144 ** 0xFB-0xFA-0xF9-0xF8: PCI-X Upstream Split Transaction Control - PX_USTC 2145 ** Bit Default Description 2146 ** 31:16 003Eh Split Transaction Limit (STL): This register indicates the size of the commitment limit in units of ADQs. 2147 ** Software is permitted to program this register to any value greater than or equal to 2148 ** the contents of the Split Transaction Capacity register. A value less than the contents 2149 ** of the Split Transaction Capacity register causes unspecified results. 2150 ** A value of 003Eh or greater enables the bridge to forward all Split Requests of any 2151 ** size regardless of the amount of buffer space available. 2152 ** 15:00 003Eh Split Transaction Capacity (STC): This read-only field indicates the size of the buffer (number of ADQs) for storing 2153 ** split completions. This register controls behavior of the bridge buffers for forwarding 2154 ** Split Transactions from a primary bus requester to a secondary bus completer. 2155 ** The default value of 003Eh indicates there is available buffer space for 62 ADQs (7936 bytes). 2156 **=============================================================================== 2157 ** 0xFF-0xFE-0xFD-0xFC: PCI-X Downstream Split Transaction Control - PX_DSTC 2158 ** Bit Default Description 2159 ** 31:16 003Eh Split Transaction Limit (STL): This register indicates the size of the commitment limit in units of ADQs. 2160 ** Software is permitted to program this register to any value greater than or equal to 2161 ** the contents of the Split Transaction Capacity register. A value less than the contents 2162 ** of the Split Transaction Capacity register causes unspecified results. 2163 ** A value of 003Eh or greater enables the bridge to forward all Split Requests of any 2164 ** size regardless of the amount of buffer space available. 2165 ** 15:00 003Eh Split Transaction Capacity (STC): This read-only field indicates the size of the buffer (number of ADQs) for storing 2166 ** split completions. This register controls behavior of the bridge buffers for forwarding 2167 ** Split Transactions from a primary bus requester to a secondary bus completer. 2168 ** The default value of 003Eh indicates there is available buffer space for 62 ADQs 2169 ** (7936 bytes). 2170 ************************************************************************** 2171 */ 2172 2173 2174 2175 2176 /* 2177 ************************************************************************************************************************************* 2178 ** 80331 Address Translation Unit Register Definitions 2179 ** ATU Interface Configuration Header Format 2180 ** The ATU is programmed via a [Type 0] configuration command on the PCI interface. 2181 ************************************************************************************************************************************* 2182 ** | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Configuration Byte Offset 2183 **=================================================================================================================================== 2184 ** | ATU Device ID | Vendor ID | 00h 2185 ** ---------------------------------------------------------------------------------------------------------- 2186 ** | Status | Command | 04H 2187 ** ---------------------------------------------------------------------------------------------------------- 2188 ** | ATU Class Code | Revision ID | 08H 2189 ** ---------------------------------------------------------------------------------------------------------- 2190 ** | ATUBISTR | Header Type | Latency Timer | Cacheline Size | 0CH 2191 ** ---------------------------------------------------------------------------------------------------------- 2192 ** | Inbound ATU Base Address 0 | 10H 2193 ** ---------------------------------------------------------------------------------------------------------- 2194 ** | Inbound ATU Upper Base Address 0 | 14H 2195 ** ---------------------------------------------------------------------------------------------------------- 2196 ** | Inbound ATU Base Address 1 | 18H 2197 ** ---------------------------------------------------------------------------------------------------------- 2198 ** | Inbound ATU Upper Base Address 1 | 1CH 2199 ** ---------------------------------------------------------------------------------------------------------- 2200 ** | Inbound ATU Base Address 2 | 20H 2201 ** ---------------------------------------------------------------------------------------------------------- 2202 ** | Inbound ATU Upper Base Address 2 | 24H 2203 ** ---------------------------------------------------------------------------------------------------------- 2204 ** | Reserved | 28H 2205 ** ---------------------------------------------------------------------------------------------------------- 2206 ** | ATU Subsystem ID | ATU Subsystem Vendor ID | 2CH 2207 ** ---------------------------------------------------------------------------------------------------------- 2208 ** | Expansion ROM Base Address | 30H 2209 ** ---------------------------------------------------------------------------------------------------------- 2210 ** | Reserved Capabilities Pointer | 34H 2211 ** ---------------------------------------------------------------------------------------------------------- 2212 ** | Reserved | 38H 2213 ** ---------------------------------------------------------------------------------------------------------- 2214 ** | Maximum Latency | Minimum Grant | Interrupt Pin | Interrupt Line | 3CH 2215 ** ---------------------------------------------------------------------------------------------------------- 2216 ********************************************************************************************************************* 2217 */ 2218 /* 2219 *********************************************************************************** 2220 ** ATU Vendor ID Register - ATUVID 2221 ** ----------------------------------------------------------------- 2222 ** Bit Default Description 2223 ** 15:00 8086H (0x17D3) ATU Vendor ID - This is a 16-bit value assigned to Intel. 2224 ** This register, combined with the DID, uniquely identify the PCI device. 2225 ** Access type is Read/Write to allow the 80331 to configure the register as a different vendor ID 2226 ** to simulate the interface of a standard mechanism currently used by existing application software. 2227 *********************************************************************************** 2228 */ 2229 #define ARCMSR_ATU_VENDOR_ID_REG 0x00 /*word*/ 2230 /* 2231 *********************************************************************************** 2232 ** ATU Device ID Register - ATUDID 2233 ** ----------------------------------------------------------------- 2234 ** Bit Default Description 2235 ** 15:00 0336H (0x1110) ATU Device ID - This is a 16-bit value assigned to the ATU. 2236 ** This ID, combined with the VID, uniquely identify any PCI device. 2237 *********************************************************************************** 2238 */ 2239 #define ARCMSR_ATU_DEVICE_ID_REG 0x02 /*word*/ 2240 /* 2241 *********************************************************************************** 2242 ** ATU Command Register - ATUCMD 2243 ** ----------------------------------------------------------------- 2244 ** Bit Default Description 2245 ** 15:11 000000 2 Reserved 2246 ** 10 0 Interrupt Disable - This bit disables 80331 from asserting the ATU interrupt signal. 2247 ** 0=enables the assertion of interrupt signal. 2248 ** 1=disables the assertion of its interrupt signal. 2249 ** 09 0 2 Fast Back to Back Enable - When cleared, 2250 ** the ATU interface is not allowed to generate fast back-to-back cycles on its bus. 2251 ** Ignored when operating in the PCI-X mode. 2252 ** 08 0 2 SERR# Enable - When cleared, the ATU interface is not allowed to assert SERR# on the PCI interface. 2253 ** 07 1 2 Address/Data Stepping Control - Address stepping is implemented for configuration transactions. The 2254 ** ATU inserts 2 clock cycles of address stepping for Conventional Mode and 4 clock cycles 2255 ** of address stepping for PCI-X mode. 2256 ** 06 0 2 Parity Error Response - When set, the ATU takes normal action when a parity error 2257 ** is detected. When cleared, parity checking is disabled. 2258 ** 05 0 2 VGA Palette Snoop Enable - The ATU interface does not support I/O writes and therefore, 2259 ** does not perform VGA palette snooping. 2260 ** 04 0 2 Memory Write and Invalidate Enable - When set, ATU may generate MWI commands. 2261 ** When clear, ATU use Memory Write commands instead of MWI. Ignored when operating in the PCI-X mode. 2262 ** 03 0 2 Special Cycle Enable - The ATU interface does not respond to special cycle commands in any way. 2263 ** Not implemented and a reserved bit field. 2264 ** 02 0 2 Bus Master Enable - The ATU interface can act as a master on the PCI bus. 2265 ** When cleared, disables the device from generating PCI accesses. 2266 ** When set, allows the device to behave as a PCI bus master. 2267 ** When operating in the PCI-X mode, ATU initiates a split completion transaction regardless 2268 ** of the state of this bit. 2269 ** 01 0 2 Memory Enable - Controls the ATU interface��s response to PCI memory addresses. 2270 ** When cleared, the ATU interface does not respond to any memory access on the PCI bus. 2271 ** 00 0 2 I/O Space Enable - Controls the ATU interface response to I/O transactions. 2272 ** Not implemented and a reserved bit field. 2273 *********************************************************************************** 2274 */ 2275 #define ARCMSR_ATU_COMMAND_REG 0x04 /*word*/ 2276 /* 2277 *********************************************************************************** 2278 ** ATU Status Register - ATUSR (Sheet 1 of 2) 2279 ** ----------------------------------------------------------------- 2280 ** Bit Default Description 2281 ** 15 0 2 Detected Parity Error - set when a parity error is detected in data received by the ATU on the PCI bus even 2282 ** when the ATUCMD register��s Parity Error Response bit is cleared. Set under the following conditions: 2283 ** �E Write Data Parity Error when the ATU is a target (inbound write). 2284 ** �E Read Data Parity Error when the ATU is a requester (outbound read). 2285 ** �E Any Address or Attribute (PCI-X Only) Parity Error on the Bus ** ** ** (including one generated by the ATU). 2286 ** 14 0 2 SERR# Asserted - set when SERR# is asserted on the PCI bus by the ATU. 2287 ** 13 0 2 Master Abort - set when a transaction initiated by the ATU PCI master interface, ends in a Master-Abort 2288 ** or when the ATU receives a Master Abort Split Completion Error Message in PCI-X mode. 2289 ** 12 0 2 Target Abort (master) - set when a transaction initiated by the ATU PCI master interface, ends in a target 2290 ** abort or when the ATU receives a Target Abort Split Completion Error Message in PCI-X mode. 2291 ** 11 0 2 Target Abort (target) - set when the ATU interface, acting as a target, 2292 ** terminates the transaction on the PCI bus with a target abort. 2293 ** 10:09 01 2 DEVSEL# Timing - These bits are read-only and define the slowest DEVSEL# 2294 ** timing for a target device in Conventional PCI Mode regardless of the operating mode 2295 ** (except configuration accesses). 2296 ** 00 2=Fast 2297 ** 01 2=Medium 2298 ** 10 2=Slow 2299 ** 11 2=Reserved 2300 ** The ATU interface uses Medium timing. 2301 ** 08 0 2 Master Parity Error - The ATU interface sets this bit under the following conditions: 2302 ** �E The ATU asserted PERR# itself or the ATU observed PERR# asserted. 2303 ** �E And the ATU acted as the requester 2304 ** for the operation in which the error occurred. 2305 ** �E And the ATUCMD register��s Parity Error Response bit is set 2306 ** �E Or (PCI-X Mode Only) the ATU received a Write Data Parity Error Message 2307 ** �E And the ATUCMD register��s Parity Error Response bit is set 2308 ** 07 1 2 (Conventional mode) 2309 ** 0 2 (PCI-X mode) 2310 ** Fast Back-to-Back - The ATU/Messaging Unit interface is capable of accepting fast back-to-back 2311 ** transactions in Conventional PCI mode when the transactions are not to the same target. Since fast 2312 ** back-to-back transactions do not exist in PCI-X mode, this bit is forced to 0 in the PCI-X mode. 2313 ** 06 0 2 UDF Supported - User Definable Features are not supported 2314 ** 05 1 2 66 MHz. Capable - 66 MHz operation is supported. 2315 ** 04 1 2 Capabilities - When set, this function implements extended capabilities. 2316 ** 03 0 Interrupt Status - reflects the state of the ATU interrupt 2317 ** when the Interrupt Disable bit in the command register is a 0. 2318 ** 0=ATU interrupt signal deasserted. 2319 ** 1=ATU interrupt signal asserted. 2320 ** NOTE: Setting the Interrupt Disable bit to a 1 has no effect on the state of this bit. Refer to 2321 ** Section 3.10.23, ��ATU Interrupt Pin Register - ATUIPR�� on page 236 for details on the ATU 2322 ** interrupt signal. 2323 ** 02:00 00000 2 Reserved. 2324 *********************************************************************************** 2325 */ 2326 #define ARCMSR_ATU_STATUS_REG 0x06 /*word*/ 2327 /* 2328 *********************************************************************************** 2329 ** ATU Revision ID Register - ATURID 2330 ** ----------------------------------------------------------------- 2331 ** Bit Default Description 2332 ** 07:00 00H ATU Revision - identifies the 80331 revision number. 2333 *********************************************************************************** 2334 */ 2335 #define ARCMSR_ATU_REVISION_REG 0x08 /*byte*/ 2336 /* 2337 *********************************************************************************** 2338 ** ATU Class Code Register - ATUCCR 2339 ** ----------------------------------------------------------------- 2340 ** Bit Default Description 2341 ** 23:16 05H Base Class - Memory Controller 2342 ** 15:08 80H Sub Class - Other Memory Controller 2343 ** 07:00 00H Programming Interface - None defined 2344 *********************************************************************************** 2345 */ 2346 #define ARCMSR_ATU_CLASS_CODE_REG 0x09 /*3bytes 0x0B,0x0A,0x09*/ 2347 /* 2348 *********************************************************************************** 2349 ** ATU Cacheline Size Register - ATUCLSR 2350 ** ----------------------------------------------------------------- 2351 ** Bit Default Description 2352 ** 07:00 00H ATU Cacheline Size - specifies the system cacheline size in DWORDs. Cacheline size is restricted to either 0, 8 or 16 DWORDs. 2353 *********************************************************************************** 2354 */ 2355 #define ARCMSR_ATU_CACHELINE_SIZE_REG 0x0C /*byte*/ 2356 /* 2357 *********************************************************************************** 2358 ** ATU Latency Timer Register - ATULT 2359 ** ----------------------------------------------------------------- 2360 ** Bit Default Description 2361 ** 07:03 00000 2 (for Conventional mode) 2362 ** 01000 2 (for PCI-X mode) 2363 ** Programmable Latency Timer - This field varies the latency timer for the interface from 0 to 248 clocks. 2364 ** The default value is 0 clocks for Conventional PCI mode, and 64 clocks for PCI-X mode. 2365 ** 02:00 000 2 Latency Timer Granularity - These Bits are read only giving a programmable granularity of 8 clocks for the latency timer. 2366 *********************************************************************************** 2367 */ 2368 #define ARCMSR_ATU_LATENCY_TIMER_REG 0x0D /*byte*/ 2369 /* 2370 *********************************************************************************** 2371 ** ATU Header Type Register - ATUHTR 2372 ** ----------------------------------------------------------------- 2373 ** Bit Default Description 2374 ** 07 0 2 Single Function/Multi-Function Device - Identifies the 80331 as a single-function PCI device. 2375 ** 06:00 000000 2 PCI Header Type - This bit field indicates the type of PCI header implemented. The ATU interface 2376 ** header conforms to PCI Local Bus Specification, Revision 2.3. 2377 *********************************************************************************** 2378 */ 2379 #define ARCMSR_ATU_HEADER_TYPE_REG 0x0E /*byte*/ 2380 /* 2381 *********************************************************************************** 2382 ** ATU BIST Register - ATUBISTR 2383 ** 2384 ** The ATU BIST Register controls the functions the Intel XScale core performs when BIST is 2385 ** initiated. This register is the interface between the host processor requesting BIST functions and 2386 ** the 80331 replying with the results from the software implementation of the BIST functionality. 2387 ** ----------------------------------------------------------------- 2388 ** Bit Default Description 2389 ** 07 0 2 BIST Capable - This bit value is always equal to the ATUCR ATU BIST Interrupt Enable bit. 2390 ** 06 0 2 Start BIST - When the ATUCR BIST Interrupt Enable bit is set: 2391 ** Setting this bit generates an interrupt to the Intel XScale core to perform a software BIST function. 2392 ** The Intel XScale core clears this bit when the BIST software has completed with the BIST results 2393 ** found in ATUBISTR register bits [3:0]. 2394 ** When the ATUCR BIST Interrupt Enable bit is clear: 2395 ** Setting this bit does not generate an interrupt to the Intel XScale core and no BIST functions is performed. 2396 ** The Intel XScale core does not clear this bit. 2397 ** 05:04 00 2 Reserved 2398 ** 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): 2399 ** The Intel XScale core places the results of the software BIST in these bits. 2400 ** A nonzero value indicates a device-specific error. 2401 *********************************************************************************** 2402 */ 2403 #define ARCMSR_ATU_BIST_REG 0x0F /*byte*/ 2404 2405 /* 2406 *************************************************************************************** 2407 ** ATU Base Registers and Associated Limit Registers 2408 *************************************************************************************** 2409 ** Base Address Register Limit Register Description 2410 ** Inbound ATU Base Address Register 0 Inbound ATU Limit Register 0 Defines the inbound translation window 0 from the PCI bus. 2411 ** 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. 2412 ** Inbound ATU Base Address Register 1 Inbound ATU Limit Register 1 Defines inbound window 1 from the PCI bus. 2413 ** 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. 2414 ** Inbound ATU Base Address Register 2 Inbound ATU Limit Register 2 Defines the inbound translation window 2 from the PCI bus. 2415 ** 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. 2416 ** Inbound ATU Base Address Register 3 Inbound ATU Limit Register 3 Defines the inbound translation window 3 from the PCI bus. 2417 ** 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. 2418 ** NOTE: This is a private BAR that resides outside of the standard PCI configuration header space (offsets 00H-3FH). 2419 ** 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. 2420 **-------------------------------------------------------------------------------------- 2421 ** ATU Inbound Window 1 is not a translate window. 2422 ** The ATU does not claim any PCI accesses that fall within this range. 2423 ** This window is used to allocate host memory for use by Private Devices. 2424 ** When enabled, the ATU interrupts the Intel XScale core when either the IABAR1 register or the IAUBAR1 register is written from the PCI bus. 2425 *********************************************************************************** 2426 */ 2427 2428 /* 2429 *********************************************************************************** 2430 ** Inbound ATU Base Address Register 0 - IABAR0 2431 ** 2432 ** . The Inbound ATU Base Address Register 0 (IABAR0) together with the Inbound ATU Upper Base Address Register 0 (IAUBAR0) 2433 ** defines the block of memory addresses where the inbound translation window 0 begins. 2434 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory. 2435 ** . The IABAR0 and IAUBAR0 define the base address and describes the required memory block size. 2436 ** . Bits 31 through 12 of the IABAR0 is either read/write bits or read only with a value of 0 2437 ** depending on the value located within the IALR0. 2438 ** This configuration allows the IABAR0 to be programmed per PCI Local Bus Specification. 2439 ** The first 4 Kbytes of memory defined by the IABAR0, IAUBAR0 and the IALR0 is reserved for the Messaging Unit. 2440 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 2441 ** Warning: 2442 ** When IALR0 is cleared prior to host configuration: 2443 ** the user should also clear the Prefetchable Indicator and the Type Indicator. 2444 ** Assuming IALR0 is not cleared: 2445 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary, 2446 ** when the Prefetchable Indicator is cleared prior to host configuration, 2447 ** the user should also set the Type Indicator for 32 bit addressability. 2448 ** b. For compliance to the PCI-X Addendum to the PCI Local Bus Specification, 2449 ** when the Prefetchable Indicator is set prior to host configuration, the user 2450 ** should also set the Type Indicator for 64 bit addressability. 2451 ** This is the default for IABAR0. 2452 ** ----------------------------------------------------------------- 2453 ** Bit Default Description 2454 ** 31:12 00000H Translation Base Address 0 - These bits define the actual location 2455 ** the translation function is to respond to when addressed from the PCI bus. 2456 ** 11:04 00H Reserved. 2457 ** 03 1 2 Prefetchable Indicator - When set, defines the memory space as prefetchable. 2458 ** 02:01 10 2 Type Indicator - Defines the width of the addressability for this memory window: 2459 ** 00 - Memory Window is locatable anywhere in 32 bit address space 2460 ** 10 - Memory Window is locatable anywhere in 64 bit address space 2461 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address. 2462 ** The ATU does not occupy I/O space, 2463 ** thus this bit must be zero. 2464 *********************************************************************************** 2465 */ 2466 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS0_REG 0x10 /*dword 0x13,0x12,0x11,0x10*/ 2467 #define ARCMSR_INBOUND_ATU_MEMORY_PREFETCHABLE 0x08 2468 #define ARCMSR_INBOUND_ATU_MEMORY_WINDOW64 0x04 2469 /* 2470 *********************************************************************************** 2471 ** Inbound ATU Upper Base Address Register 0 - IAUBAR0 2472 ** 2473 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes. 2474 ** Together with the Translation Base Address this register defines the actual location the translation 2475 ** function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs). 2476 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 2477 ** Note: 2478 ** When the Type indicator of IABAR0 is set to indicate 32 bit addressability, 2479 ** the IAUBAR0 register attributes are read-only. 2480 ** ----------------------------------------------------------------- 2481 ** Bit Default Description 2482 ** 31:0 00000H Translation Upper Base Address 0 - Together with the Translation Base Address 0 these bits define the 2483 ** actual location the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes. 2484 *********************************************************************************** 2485 */ 2486 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS0_REG 0x14 /*dword 0x17,0x16,0x15,0x14*/ 2487 /* 2488 *********************************************************************************** 2489 ** Inbound ATU Base Address Register 1 - IABAR1 2490 ** 2491 ** . The Inbound ATU Base Address Register (IABAR1) together with the Inbound ATU Upper Base Address Register 1 (IAUBAR1) 2492 ** defines the block of memory addresses where the inbound translation window 1 begins. 2493 ** . 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. 2494 ** . The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 2495 ** . When enabled, the ATU interrupts the Intel XScale core when the IABAR1 register is written from the PCI bus. 2496 ** Warning: 2497 ** When a non-zero value is not written to IALR1 prior to host configuration, 2498 ** the user should not set either the Prefetchable Indicator or the Type Indicator for 64 bit addressability. 2499 ** This is the default for IABAR1. 2500 ** Assuming a non-zero value is written to IALR1, 2501 ** the user may set the Prefetchable Indicator 2502 ** or the Type Indicator: 2503 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address 2504 ** boundary, when the Prefetchable Indicator is not set prior to host configuration, 2505 ** the user should also leave the Type Indicator set for 32 bit addressability. 2506 ** This is the default for IABAR1. 2507 ** b. when the Prefetchable Indicator is set prior to host configuration, 2508 ** the user should also set the Type Indicator for 64 bit addressability. 2509 ** ----------------------------------------------------------------- 2510 ** Bit Default Description 2511 ** 31:12 00000H Translation Base Address 1 - These bits define the actual location of window 1 on the PCI bus. 2512 ** 11:04 00H Reserved. 2513 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable. 2514 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window: 2515 ** 00 - Memory Window is locatable anywhere in 32 bit address space 2516 ** 10 - Memory Window is locatable anywhere in 64 bit address space 2517 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address. 2518 ** The ATU does not occupy I/O space, 2519 ** thus this bit must be zero. 2520 *********************************************************************************** 2521 */ 2522 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS1_REG 0x18 /*dword 0x1B,0x1A,0x19,0x18*/ 2523 /* 2524 *********************************************************************************** 2525 ** Inbound ATU Upper Base Address Register 1 - IAUBAR1 2526 ** 2527 ** This register contains the upper base address when locating this window for PCI addresses beyond 4 GBytes. 2528 ** Together with the IABAR1 this register defines the actual location for this memory window for addresses > 4GBytes (for DACs). 2529 ** 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. 2530 ** The programmed value within the base address register must comply with the PCI programming 2531 ** requirements for address alignment. 2532 ** When enabled, the ATU interrupts the Intel XScale core when the IAUBAR1 register is written 2533 ** from the PCI bus. 2534 ** Note: 2535 ** When the Type indicator of IABAR1 is set to indicate 32 bit addressability, 2536 ** the IAUBAR1 register attributes are read-only. 2537 ** This is the default for IABAR1. 2538 ** ----------------------------------------------------------------- 2539 ** Bit Default Description 2540 ** 31:0 00000H Translation Upper Base Address 1 - Together with the Translation Base Address 1 2541 ** these bits define the actual location for this memory window on the PCI bus for addresses > 4GBytes. 2542 *********************************************************************************** 2543 */ 2544 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS1_REG 0x1C /*dword 0x1F,0x1E,0x1D,0x1C*/ 2545 /* 2546 *********************************************************************************** 2547 ** Inbound ATU Base Address Register 2 - IABAR2 2548 ** 2549 ** . The Inbound ATU Base Address Register 2 (IABAR2) together with the Inbound ATU Upper Base Address Register 2 (IAUBAR2) 2550 ** defines the block of memory addresses where the inbound translation window 2 begins. 2551 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory. 2552 ** . The IABAR2 and IAUBAR2 define the base address and describes the required memory block size 2553 ** . 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. 2554 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 2555 ** Warning: 2556 ** When a non-zero value is not written to IALR2 prior to host configuration, 2557 ** the user should not set either the Prefetchable Indicator 2558 ** or the Type Indicator for 64 bit addressability. 2559 ** This is the default for IABAR2. 2560 ** Assuming a non-zero value is written to IALR2, 2561 ** the user may set the Prefetchable Indicator 2562 ** or the Type Indicator: 2563 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary, 2564 ** when the Prefetchable Indicator is not set prior to host configuration, 2565 ** the user should also leave the Type Indicator set for 32 bit addressability. 2566 ** This is the default for IABAR2. 2567 ** b. when the Prefetchable Indicator is set prior to host configuration, 2568 ** the user should also set the Type Indicator for 64 bit addressability. 2569 ** ----------------------------------------------------------------- 2570 ** Bit Default Description 2571 ** 31:12 00000H Translation Base Address 2 - These bits define the actual location 2572 ** the translation function is to respond to when addressed from the PCI bus. 2573 ** 11:04 00H Reserved. 2574 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable. 2575 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window: 2576 ** 00 - Memory Window is locatable anywhere in 32 bit address space 2577 ** 10 - Memory Window is locatable anywhere in 64 bit address space 2578 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address. 2579 ** The ATU does not occupy I/O space, 2580 ** thus this bit must be zero. 2581 *********************************************************************************** 2582 */ 2583 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS2_REG 0x20 /*dword 0x23,0x22,0x21,0x20*/ 2584 /* 2585 *********************************************************************************** 2586 ** Inbound ATU Upper Base Address Register 2 - IAUBAR2 2587 ** 2588 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes. 2589 ** Together with the Translation Base Address this register defines the actual location 2590 ** the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs). 2591 ** The programmed value within the base address register must comply with the PCI programming 2592 ** requirements for address alignment. 2593 ** Note: 2594 ** When the Type indicator of IABAR2 is set to indicate 32 bit addressability, 2595 ** the IAUBAR2 register attributes are read-only. 2596 ** This is the default for IABAR2. 2597 ** ----------------------------------------------------------------- 2598 ** Bit Default Description 2599 ** 31:0 00000H Translation Upper Base Address 2 - Together with the Translation Base Address 2 2600 ** these bits define the actual location the translation function is to respond to 2601 ** when addressed from the PCI bus for addresses > 4GBytes. 2602 *********************************************************************************** 2603 */ 2604 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS2_REG 0x24 /*dword 0x27,0x26,0x25,0x24*/ 2605 /* 2606 *********************************************************************************** 2607 ** ATU Subsystem Vendor ID Register - ASVIR 2608 ** ----------------------------------------------------------------- 2609 ** Bit Default Description 2610 ** 15:0 0000H Subsystem Vendor ID - This register uniquely identifies the add-in board or subsystem vendor. 2611 *********************************************************************************** 2612 */ 2613 #define ARCMSR_ATU_SUBSYSTEM_VENDOR_ID_REG 0x2C /*word 0x2D,0x2C*/ 2614 /* 2615 *********************************************************************************** 2616 ** ATU Subsystem ID Register - ASIR 2617 ** ----------------------------------------------------------------- 2618 ** Bit Default Description 2619 ** 15:0 0000H Subsystem ID - uniquely identifies the add-in board or subsystem. 2620 *********************************************************************************** 2621 */ 2622 #define ARCMSR_ATU_SUBSYSTEM_ID_REG 0x2E /*word 0x2F,0x2E*/ 2623 /* 2624 *********************************************************************************** 2625 ** Expansion ROM Base Address Register -ERBAR 2626 ** ----------------------------------------------------------------- 2627 ** Bit Default Description 2628 ** 31:12 00000H Expansion ROM Base Address - These bits define the actual location 2629 ** where the Expansion ROM address window resides when addressed from the PCI bus on any 4 Kbyte boundary. 2630 ** 11:01 000H Reserved 2631 ** 00 0 2 Address Decode Enable - This bit field shows the ROM address 2632 ** decoder is enabled or disabled. When cleared, indicates the address decoder is disabled. 2633 *********************************************************************************** 2634 */ 2635 #define ARCMSR_EXPANSION_ROM_BASE_ADDRESS_REG 0x30 /*dword 0x33,0x32,0v31,0x30*/ 2636 #define ARCMSR_EXPANSION_ROM_ADDRESS_DECODE_ENABLE 0x01 2637 /* 2638 *********************************************************************************** 2639 ** ATU Capabilities Pointer Register - ATU_CAP_PTR 2640 ** ----------------------------------------------------------------- 2641 ** Bit Default Description 2642 ** 07:00 C0H Capability List Pointer - This provides an offset in this function��s configuration space 2643 ** that points to the 80331 PCl Bus Power Management extended capability. 2644 *********************************************************************************** 2645 */ 2646 #define ARCMSR_ATU_CAPABILITY_PTR_REG 0x34 /*byte*/ 2647 /* 2648 *********************************************************************************** 2649 ** Determining Block Sizes for Base Address Registers 2650 ** The required address size and type can be determined by writing ones to a base address register and 2651 ** reading from the registers. By scanning the returned value from the least-significant bit of the base 2652 ** address registers upwards, the programmer can determine the required address space size. The 2653 ** binary-weighted value of the first non-zero bit found indicates the required amount of space. 2654 ** Table 105 describes the relationship between the values read back and the byte sizes the base 2655 ** address register requires. 2656 ** As an example, assume that FFFF.FFFFH is written to the ATU Inbound Base Address Register 0 2657 ** (IABAR0) and the value read back is FFF0.0008H. Bit zero is a zero, so the device requires 2658 ** memory address space. Bit three is one, so the memory does supports prefetching. Scanning 2659 ** upwards starting at bit four, bit twenty is the first one bit found. The binary-weighted value of this 2660 ** bit is 1,048,576, indicated that the device requires 1 Mbyte of memory space. 2661 ** The ATU Base Address Registers and the Expansion ROM Base Address Register use their 2662 ** associated limit registers to enable which bits within the base address register are read/write and 2663 ** which bits are read only (0). This allows the programming of these registers in a manner similar to 2664 ** other PCI devices even though the limit is variable. 2665 ** Table 105. Memory Block Size Read Response 2666 ** Response After Writing all 1s 2667 ** to the Base Address Register 2668 ** Size 2669 ** (Bytes) 2670 ** Response After Writing all 1s 2671 ** to the Base Address Register 2672 ** Size 2673 ** (Bytes) 2674 ** FFFFFFF0H 16 FFF00000H 1 M 2675 ** FFFFFFE0H 32 FFE00000H 2 M 2676 ** FFFFFFC0H 64 FFC00000H 4 M 2677 ** FFFFFF80H 128 FF800000H 8 M 2678 ** FFFFFF00H 256 FF000000H 16 M 2679 ** FFFFFE00H 512 FE000000H 32 M 2680 ** FFFFFC00H 1K FC000000H 64 M 2681 ** FFFFF800H 2K F8000000H 128 M 2682 ** FFFFF000H 4K F0000000H 256 M 2683 ** FFFFE000H 8K E0000000H 512 M 2684 ** FFFFC000H 16K C0000000H 1 G 2685 ** FFFF8000H 32K 80000000H 2 G 2686 ** FFFF0000H 64K 2687 ** 00000000H 2688 ** Register not 2689 ** imple-mented, 2690 ** no 2691 ** address 2692 ** space 2693 ** required. 2694 ** FFFE0000H 128K 2695 ** FFFC0000H 256K 2696 ** FFF80000H 512K 2697 ** 2698 *************************************************************************************** 2699 */ 2700 2701 2702 2703 /* 2704 *********************************************************************************** 2705 ** ATU Interrupt Line Register - ATUILR 2706 ** ----------------------------------------------------------------- 2707 ** Bit Default Description 2708 ** 07:00 FFH Interrupt Assigned - system-assigned value identifies which system interrupt controller��s interrupt 2709 ** request line connects to the device's PCI interrupt request lines 2710 ** (as specified in the interrupt pin register). 2711 ** A value of FFH signifies ��no connection�� or ��unknown��. 2712 *********************************************************************************** 2713 */ 2714 #define ARCMSR_ATU_INTERRUPT_LINE_REG 0x3C /*byte*/ 2715 /* 2716 *********************************************************************************** 2717 ** ATU Interrupt Pin Register - ATUIPR 2718 ** ----------------------------------------------------------------- 2719 ** Bit Default Description 2720 ** 07:00 01H Interrupt Used - A value of 01H signifies that the ATU interface unit uses INTA# as the interrupt pin. 2721 *********************************************************************************** 2722 */ 2723 #define ARCMSR_ATU_INTERRUPT_PIN_REG 0x3D /*byte*/ 2724 /* 2725 *********************************************************************************** 2726 ** ATU Minimum Grant Register - ATUMGNT 2727 ** ----------------------------------------------------------------- 2728 ** Bit Default Description 2729 ** 07:00 80H This register specifies how long a burst period the device needs in increments of 8 PCI clocks. 2730 *********************************************************************************** 2731 */ 2732 #define ARCMSR_ATU_MINIMUM_GRANT_REG 0x3E /*byte*/ 2733 /* 2734 *********************************************************************************** 2735 ** ATU Maximum Latency Register - ATUMLAT 2736 ** ----------------------------------------------------------------- 2737 ** Bit Default Description 2738 ** 07:00 00H Specifies frequency (how often) the device needs to access the PCI bus 2739 ** in increments of 8 PCI clocks. A zero value indicates the device has no stringent requirement. 2740 *********************************************************************************** 2741 */ 2742 #define ARCMSR_ATU_MAXIMUM_LATENCY_REG 0x3F /*byte*/ 2743 /* 2744 *********************************************************************************** 2745 ** Inbound Address Translation 2746 ** 2747 ** The ATU allows external PCI bus initiators to directly access the internal bus. 2748 ** These PCI bus initiators can read or write 80331 memory-mapped registers or 80331 local memory space. 2749 ** The process of inbound address translation involves two steps: 2750 ** 1. Address Detection. 2751 ** �E Determine when the 32-bit PCI address (64-bit PCI address during DACs) is 2752 ** within the address windows defined for the inbound ATU. 2753 ** �E Claim the PCI transaction with medium DEVSEL# timing in the conventional PCI 2754 ** mode and with Decode A DEVSEL# timing in the PCI-X mode. 2755 ** 2. Address Translation. 2756 ** �E Translate the 32-bit PCI address (lower 32-bit PCI address during DACs) to a 32-bit 80331 internal bus address. 2757 ** The ATU uses the following registers in inbound address window 0 translation: 2758 ** �E Inbound ATU Base Address Register 0 2759 ** �E Inbound ATU Limit Register 0 2760 ** �E Inbound ATU Translate Value Register 0 2761 ** The ATU uses the following registers in inbound address window 2 translation: 2762 ** �E Inbound ATU Base Address Register 2 2763 ** �E Inbound ATU Limit Register 2 2764 ** �E Inbound ATU Translate Value Register 2 2765 ** The ATU uses the following registers in inbound address window 3 translation: 2766 ** �E Inbound ATU Base Address Register 3 2767 ** �E Inbound ATU Limit Register 3 2768 ** �E Inbound ATU Translate Value Register 3 2769 ** Note: Inbound Address window 1 is not a translate window. 2770 ** Instead, window 1 may be used to allocate host memory for Private Devices. 2771 ** Inbound Address window 3 does not reside in the standard section of the configuration header (offsets 00H - 3CH), 2772 ** thus the host BIOS does not configure window 3. 2773 ** Window 3 is intended to be used as a special window into local memory for private PCI 2774 ** agents controlled by the 80331 in conjunction with the Private Memory Space of the bridge. 2775 ** PCI-to-PCI Bridge in 80331 or 2776 ** Inbound address detection is determined from the 32-bit PCI address, 2777 ** (64-bit PCI address during DACs) the base address register and the limit register. 2778 ** In the case of DACs none of the upper 32-bits of the address is masked during address comparison. 2779 ** 2780 ** The algorithm for detection is: 2781 ** 2782 ** Equation 1. Inbound Address Detection 2783 ** When (PCI_Address [31:0] & Limit_Register[31:0]) == (Base_Register[31:0] & PCI_Address [63:32]) == Base_Register[63:32] (for DACs only) 2784 ** the PCI Address is claimed by the Inbound ATU. 2785 ** 2786 ** The incoming 32-bit PCI address (lower 32-bits of the address in case of DACs) is bitwise ANDed 2787 ** with the associated inbound limit register. 2788 ** When the result matches the base register (and upper base address matches upper PCI address in case of DACs), 2789 ** the inbound PCI address is detected as being within the inbound translation window and is claimed by the ATU. 2790 ** 2791 ** Note: The first 4 Kbytes of the ATU inbound address translation window 0 are reserved for the Messaging Unit. 2792 ** Once the transaction is claimed, the address must be translated from a PCI address to a 32-bit 2793 ** internal bus address. In case of DACs upper 32-bits of the address is simply discarded and only the 2794 ** lower 32-bits are used during address translation. 2795 ** The algorithm is: 2796 ** 2797 ** 2798 ** Equation 2. Inbound Translation 2799 ** Intel I/O processor Internal Bus Address=(PCI_Address[31:0] & ~Limit_Register[31:0]) | ATU_Translate_Value_Register[31:0]. 2800 ** 2801 ** The incoming 32-bit PCI address (lower 32-bits in case of DACs) is first bitwise ANDed with the 2802 ** bitwise inverse of the limit register. This result is bitwise ORed with the ATU Translate Value and 2803 ** the result is the internal bus address. This translation mechanism is used for all inbound memory 2804 ** read and write commands excluding inbound configuration read and writes. 2805 ** In the PCI mode for inbound memory transactions, the only burst order supported is Linear 2806 ** Incrementing. For any other burst order, the ATU signals a Disconnect after the first data phase. 2807 ** The PCI-X supports linear incrementing only, and hence above situation is not encountered in the PCI-X mode. 2808 ** example: 2809 ** Register Values 2810 ** Base_Register=3A00 0000H 2811 ** Limit_Register=FF80 0000H (8 Mbyte limit value) 2812 ** Value_Register=B100 0000H 2813 ** Inbound Translation Window ranges from 3A00 0000H to 3A7F FFFFH (8 Mbytes) 2814 ** 2815 ** Address Detection (32-bit address) 2816 ** 2817 ** PCI_Address & Limit_Register == Base_Register 2818 ** 3A45 012CH & FF80 0000H == 3A00 0000H 2819 ** 2820 ** ANS: PCI_Address is in the Inbound Translation Window 2821 ** Address Translation (to get internal bus address) 2822 ** 2823 ** IB_Address=(PCI_Address & ~Limit_Register) | Value_Reg 2824 ** IB_Address=(3A45 012CH & 007F FFFFH) | B100 0000H 2825 ** 2826 ** ANS:IB_Address=B145 012CH 2827 *********************************************************************************** 2828 */ 2829 2830 2831 2832 /* 2833 *********************************************************************************** 2834 ** Inbound ATU Limit Register 0 - IALR0 2835 ** 2836 ** Inbound address translation for memory window 0 occurs for data transfers occurring from the PCI 2837 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts 2838 ** PCI addresses to internal bus addresses. 2839 ** The 80331 translate value register��s programmed value must be naturally aligned with the base 2840 ** address register��s programmed value. The limit register is used as a mask; thus, the lower address 2841 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus 2842 ** Specification, Revision 2.3 for additional information on programming base address registers. 2843 ** Bits 31 to 12 within the IALR0 have a direct effect on the IABAR0 register, bits 31 to 12, with a 2844 ** one to one correspondence. A value of 0 in a bit within the IALR0 makes the corresponding bit 2845 ** within the IABAR0 a read only bit which always returns 0. A value of 1 in a bit within the IALR0 2846 ** makes the corresponding bit within the IABAR0 read/write from PCI. Note that a consequence of 2847 ** this programming scheme is that unless a valid value exists within the IALR0, all writes to the 2848 ** IABAR0 has no effect since a value of all zeros within the IALR0 makes the IABAR0 a read only register. 2849 ** ----------------------------------------------------------------- 2850 ** Bit Default Description 2851 ** 31:12 FF000H Inbound Translation Limit 0 - This readback value determines the memory block size required for 2852 ** inbound memory window 0 of the address translation unit. This defaults to an inbound window of 16MB. 2853 ** 11:00 000H Reserved 2854 *********************************************************************************** 2855 */ 2856 #define ARCMSR_INBOUND_ATU_LIMIT0_REG 0x40 /*dword 0x43,0x42,0x41,0x40*/ 2857 /* 2858 *********************************************************************************** 2859 ** Inbound ATU Translate Value Register 0 - IATVR0 2860 ** 2861 ** The Inbound ATU Translate Value Register 0 (IATVR0) contains the internal bus address used to 2862 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the 2863 ** inbound ATU address translation. 2864 ** ----------------------------------------------------------------- 2865 ** Bit Default Description 2866 ** 31:12 FF000H Inbound ATU Translation Value 0 - This value is used to convert the PCI address to internal bus addresses. 2867 ** This value must be 64-bit aligned on the internal bus. 2868 ** The default address allows the ATU to access the internal 80331 memory-mapped registers. 2869 ** 11:00 000H Reserved 2870 *********************************************************************************** 2871 */ 2872 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE0_REG 0x44 /*dword 0x47,0x46,0x45,0x44*/ 2873 /* 2874 *********************************************************************************** 2875 ** Expansion ROM Limit Register - ERLR 2876 ** 2877 ** The Expansion ROM Limit Register (ERLR) defines the block size of addresses the ATU defines 2878 ** as Expansion ROM address space. The block size is programmed by writing a value into the ERLR. 2879 ** Bits 31 to 12 within the ERLR have a direct effect on the ERBAR register, bits 31 to 12, with a one 2880 ** to one correspondence. A value of 0 in a bit within the ERLR makes the corresponding bit within 2881 ** the ERBAR a read only bit which always returns 0. A value of 1 in a bit within the ERLR makes 2882 ** the corresponding bit within the ERBAR read/write from PCI. 2883 ** ----------------------------------------------------------------- 2884 ** Bit Default Description 2885 ** 31:12 000000H Expansion ROM Limit - Block size of memory required for the Expansion ROM translation unit. Default 2886 ** value is 0, which indicates no Expansion ROM address space and all bits within the ERBAR are read only with a value of 0. 2887 ** 11:00 000H Reserved. 2888 *********************************************************************************** 2889 */ 2890 #define ARCMSR_EXPANSION_ROM_LIMIT_REG 0x48 /*dword 0x4B,0x4A,0x49,0x48*/ 2891 /* 2892 *********************************************************************************** 2893 ** Expansion ROM Translate Value Register - ERTVR 2894 ** 2895 ** The Expansion ROM Translate Value Register contains the 80331 internal bus address which the 2896 ** ATU converts the PCI bus access. This address is driven on the internal bus as a result of the 2897 ** Expansion ROM address translation. 2898 ** ----------------------------------------------------------------- 2899 ** Bit Default Description 2900 ** 31:12 00000H Expansion ROM Translation Value - Used to convert PCI addresses to 80331 internal bus addresses 2901 ** for Expansion ROM accesses. The Expansion ROM address translation value must be word aligned on the internal bus. 2902 ** 11:00 000H Reserved 2903 *********************************************************************************** 2904 */ 2905 #define ARCMSR_EXPANSION_ROM_TRANSLATE_VALUE_REG 0x4C /*dword 0x4F,0x4E,0x4D,0x4C*/ 2906 /* 2907 *********************************************************************************** 2908 ** Inbound ATU Limit Register 1 - IALR1 2909 ** 2910 ** Bits 31 to 12 within the IALR1 have a direct effect on the IABAR1 register, bits 31 to 12, with a 2911 ** one to one correspondence. A value of 0 in a bit within the IALR1 makes the corresponding bit 2912 ** within the IABAR1 a read only bit which always returns 0. A value of 1 in a bit within the IALR1 2913 ** makes the corresponding bit within the IABAR1 read/write from PCI. Note that a consequence of 2914 ** this programming scheme is that unless a valid value exists within the IALR1, all writes to the 2915 ** IABAR1 has no effect since a value of all zeros within the IALR1 makes the IABAR1 a read only 2916 ** register. 2917 ** The inbound memory window 1 is used merely to allocate memory on the PCI bus. The ATU does 2918 ** not process any PCI bus transactions to this memory range. 2919 ** Warning: The ATU does not claim any PCI accesses that fall within the range defined by IABAR1, 2920 ** IAUBAR1, and IALR1. 2921 ** ----------------------------------------------------------------- 2922 ** Bit Default Description 2923 ** 31:12 00000H Inbound Translation Limit 1 - This readback value determines the memory block size 2924 ** required for the ATUs memory window 1. 2925 ** 11:00 000H Reserved 2926 *********************************************************************************** 2927 */ 2928 #define ARCMSR_INBOUND_ATU_LIMIT1_REG 0x50 /*dword 0x53,0x52,0x51,0x50*/ 2929 /* 2930 *********************************************************************************** 2931 ** Inbound ATU Limit Register 2 - IALR2 2932 ** 2933 ** Inbound address translation for memory window 2 occurs for data transfers occurring from the PCI 2934 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts 2935 ** PCI addresses to internal bus addresses. 2936 ** The inbound translation base address for inbound window 2 is specified in Section 3.10.15. When 2937 ** determining block size requirements �X as described in Section 3.10.21 �X the translation limit 2938 ** register provides the block size requirements for the base address register. The remaining registers 2939 ** used for performing address translation are discussed in Section 3.2.1.1. 2940 ** The 80331 translate value register��s programmed value must be naturally aligned with the base 2941 ** address register��s programmed value. The limit register is used as a mask; thus, the lower address 2942 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus 2943 ** Specification, Revision 2.3 for additional information on programming base address registers. 2944 ** Bits 31 to 12 within the IALR2 have a direct effect on the IABAR2 register, bits 31 to 12, with a 2945 ** one to one correspondence. A value of 0 in a bit within the IALR2 makes the corresponding bit 2946 ** within the IABAR2 a read only bit which always returns 0. A value of 1 in a bit within the IALR2 2947 ** makes the corresponding bit within the IABAR2 read/write from PCI. Note that a consequence of 2948 ** this programming scheme is that unless a valid value exists within the IALR2, all writes to the 2949 ** IABAR2 has no effect since a value of all zeros within the IALR2 makes the IABAR2 a read only 2950 ** register. 2951 ** ----------------------------------------------------------------- 2952 ** Bit Default Description 2953 ** 31:12 00000H Inbound Translation Limit 2 - This readback value determines the memory block size 2954 ** required for the ATUs memory window 2. 2955 ** 11:00 000H Reserved 2956 *********************************************************************************** 2957 */ 2958 #define ARCMSR_INBOUND_ATU_LIMIT2_REG 0x54 /*dword 0x57,0x56,0x55,0x54*/ 2959 /* 2960 *********************************************************************************** 2961 ** Inbound ATU Translate Value Register 2 - IATVR2 2962 ** 2963 ** The Inbound ATU Translate Value Register 2 (IATVR2) contains the internal bus address used to 2964 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the 2965 ** inbound ATU address translation. 2966 ** ----------------------------------------------------------------- 2967 ** Bit Default Description 2968 ** 31:12 00000H Inbound ATU Translation Value 2 - This value is used to convert the PCI address to internal bus addresses. 2969 ** This value must be 64-bit aligned on the internal bus. 2970 ** The default address allows the ATU to access the internal 80331 ** ** memory-mapped registers. 2971 ** 11:00 000H Reserved 2972 *********************************************************************************** 2973 */ 2974 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE2_REG 0x58 /*dword 0x5B,0x5A,0x59,0x58*/ 2975 /* 2976 *********************************************************************************** 2977 ** Outbound I/O Window Translate Value Register - OIOWTVR 2978 ** 2979 ** The Outbound I/O Window Translate Value Register (OIOWTVR) contains the PCI I/O address 2980 ** used to convert the internal bus access to a PCI address. This address is driven on the PCI bus as a 2981 ** result of the outbound ATU address translation. 2982 ** The I/O window is from 80331 internal bus address 9000 000H to 9000 FFFFH with the fixed 2983 ** length of 64 Kbytes. 2984 ** ----------------------------------------------------------------- 2985 ** Bit Default Description 2986 ** 31:16 0000H Outbound I/O Window Translate Value - Used to convert internal bus addresses to PCI addresses. 2987 ** 15:00 0000H Reserved 2988 *********************************************************************************** 2989 */ 2990 #define ARCMSR_OUTBOUND_IO_WINDOW_TRANSLATE_VALUE_REG 0x5C /*dword 0x5F,0x5E,0x5D,0x5C*/ 2991 /* 2992 *********************************************************************************** 2993 ** Outbound Memory Window Translate Value Register 0 -OMWTVR0 2994 ** 2995 ** The Outbound Memory Window Translate Value Register 0 (OMWTVR0) contains the PCI 2996 ** address used to convert 80331 internal bus addresses for outbound transactions. This address is 2997 ** driven on the PCI bus as a result of the outbound ATU address translation. 2998 ** The memory window is from internal bus address 8000 000H to 83FF FFFFH with the fixed length 2999 ** of 64 Mbytes. 3000 ** ----------------------------------------------------------------- 3001 ** Bit Default Description 3002 ** 31:26 00H Outbound MW Translate Value - Used to convert 80331 internal bus addresses to PCI addresses. 3003 ** 25:02 00 0000H Reserved 3004 ** 01:00 00 2 Burst Order - This bit field shows the address sequence during a memory burst. 3005 ** Only linear incrementing mode is supported. 3006 *********************************************************************************** 3007 */ 3008 #define ARCMSR_OUTBOUND_MEMORY_WINDOW_TRANSLATE_VALUE0_REG 0x60 /*dword 0x63,0x62,0x61,0x60*/ 3009 /* 3010 *********************************************************************************** 3011 ** Outbound Upper 32-bit Memory Window Translate Value Register 0 - OUMWTVR0 3012 ** 3013 ** The Outbound Upper 32-bit Memory Window Translate Value Register 0 (OUMWTVR0) defines 3014 ** the upper 32-bits of address used during a dual address cycle. This enables the outbound ATU to 3015 ** directly address anywhere within the 64-bit host address space. When this register is all-zero, then 3016 ** a SAC is generated on the PCI bus. 3017 ** The memory window is from internal bus address 8000 000H to 83FF FFFFH with the fixed 3018 ** length of 64 Mbytes. 3019 ** ----------------------------------------------------------------- 3020 ** Bit Default Description 3021 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC). 3022 *********************************************************************************** 3023 */ 3024 #define ARCMSR_OUTBOUND_UPPER32_MEMORY_WINDOW_TRANSLATE_VALUE0_REG 0x64 /*dword 0x67,0x66,0x65,0x64*/ 3025 /* 3026 *********************************************************************************** 3027 ** Outbound Memory Window Translate Value Register 1 -OMWTVR1 3028 ** 3029 ** The Outbound Memory Window Translate Value Register 1 (OMWTVR1) contains the PCI 3030 ** address used to convert 80331 internal bus addresses for outbound transactions. This address is 3031 ** driven on the PCI bus as a result of the outbound ATU address translation. 3032 ** The memory window is from internal bus address 8400 000H to 87FF FFFFH with the fixed length 3033 ** of 64 Mbytes. 3034 ** ----------------------------------------------------------------- 3035 ** Bit Default Description 3036 ** 31:26 00H Outbound MW Translate Value - Used to convert 80331 internal bus addresses to PCI addresses. 3037 ** 25:02 00 0000H Reserved 3038 ** 01:00 00 2 Burst Order - This bit field shows the address sequence during a memory burst. 3039 ** Only linear incrementing mode is supported. 3040 *********************************************************************************** 3041 */ 3042 #define ARCMSR_OUTBOUND_MEMORY_WINDOW_TRANSLATE_VALUE1_REG 0x68 /*dword 0x6B,0x6A,0x69,0x68*/ 3043 /* 3044 *********************************************************************************** 3045 ** Outbound Upper 32-bit Memory Window Translate Value Register 1 - OUMWTVR1 3046 ** 3047 ** The Outbound Upper 32-bit Memory Window Translate Value Register 1 (OUMWTVR1) defines 3048 ** the upper 32-bits of address used during a dual address cycle. This enables the outbound ATU to 3049 ** directly address anywhere within the 64-bit host address space. When this register is all-zero, then 3050 ** a SAC is generated on the PCI bus. 3051 ** The memory window is from internal bus address 8400 000H to 87FF FFFFH with the fixed length 3052 ** of 64 Mbytes. 3053 ** ----------------------------------------------------------------- 3054 ** Bit Default Description 3055 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC). 3056 *********************************************************************************** 3057 */ 3058 #define ARCMSR_OUTBOUND_UPPER32_MEMORY_WINDOW_TRANSLATE_VALUE1_REG 0x6C /*dword 0x6F,0x6E,0x6D,0x6C*/ 3059 /* 3060 *********************************************************************************** 3061 ** Outbound Upper 32-bit Direct Window Translate Value Register - OUDWTVR 3062 ** 3063 ** The Outbound Upper 32-bit Direct Window Translate Value Register (OUDWTVR) defines the 3064 ** upper 32-bits of address used during a dual address cycle for the transactions via Direct Addressing 3065 ** Window. This enables the outbound ATU to directly address anywhere within the 64-bit host 3066 ** address space. When this register is all-zero, then a SAC is generated on the PCI bus. 3067 ** ----------------------------------------------------------------- 3068 ** Bit Default Description 3069 ** 31:00 0000 0000H These bits define the upper 32-bits of address driven during the dual address cycle (DAC). 3070 *********************************************************************************** 3071 */ 3072 #define ARCMSR_OUTBOUND_UPPER32_DIRECT_WINDOW_TRANSLATE_VALUE_REG 0x78 /*dword 0x7B,0x7A,0x79,0x78*/ 3073 /* 3074 *********************************************************************************** 3075 ** ATU Configuration Register - ATUCR 3076 ** 3077 ** The ATU Configuration Register controls the outbound address translation for address translation 3078 ** unit. It also contains bits for Conventional PCI Delayed Read Command (DRC) aliasing, discard 3079 ** timer status, SERR# manual assertion, SERR# detection interrupt masking, and ATU BIST 3080 ** interrupt enabling. 3081 ** ----------------------------------------------------------------- 3082 ** Bit Default Description 3083 ** 31:20 00H Reserved 3084 ** 19 0 2 ATU DRC Alias - when set, the ATU does not distinguish read commands when attempting to match a 3085 ** current PCI read transaction with read data enqueued within the DRC buffer. When clear, a current read 3086 ** transaction must have the exact same read command as the DRR for the ATU to deliver DRC data. Not 3087 ** applicable in the PCI-X mode. 3088 ** 18 0 2 Direct Addressing Upper 2Gbytes Translation Enable - When set, 3089 ** with Direct Addressing enabled (bit 7 of the ATUCR set), 3090 ** the ATU forwards internal bus cycles with an address between 0000.0040H and 3091 ** 7FFF.FFFFH to the PCI bus with bit 31 of the address set (8000.0000H - FFFF.FFFFH). 3092 ** When clear, no translation occurs. 3093 ** 17 0 2 Reserved 3094 ** 16 0 2 SERR# Manual Assertion - when set, the ATU asserts SERR# for one clock on the PCI interface. Until 3095 ** cleared, SERR# may not be manually asserted again. Once cleared, operation proceeds as specified. 3096 ** 15 0 2 ATU Discard Timer Status - when set, one of the 4 discard timers within the ATU has expired and 3097 ** discarded the delayed completion transaction within the queue. When clear, no timer has expired. 3098 ** 14:10 00000 2 Reserved 3099 ** 09 0 2 SERR# Detected Interrupt Enable - When set, the Intel XScale core is signalled an HPI# interrupt 3100 ** when the ATU detects that SERR# was asserted. When clear, 3101 ** the Intel XScale core is not interrupted when SERR# is detected. 3102 ** 08 0 2 Direct Addressing Enable - Setting this bit enables direct outbound addressing through the ATU. 3103 ** Internal bus cycles with an address between 0000.0040H and 7FFF.FFFFH automatically forwards to 3104 ** the PCI bus with or without translation of address bit 31 based on the setting of bit 18 of 3105 ** the ATUCR. 3106 ** 07:04 0000 2 Reserved 3107 ** 03 0 2 ATU BIST Interrupt Enable - When set, enables an interrupt to the Intel XScale core when the start 3108 ** BIST bit is set in the ATUBISTR register. This bit is also reflected as the BIST Capable bit 7 3109 ** in the ATUBISTR register. 3110 ** 02 0 2 Reserved 3111 ** 01 0 2 Outbound ATU Enable - When set, enables the outbound address translation unit. 3112 ** When cleared, disables the outbound ATU. 3113 ** 00 0 2 Reserved 3114 *********************************************************************************** 3115 */ 3116 #define ARCMSR_ATU_CONFIGURATION_REG 0x80 /*dword 0x83,0x82,0x81,0x80*/ 3117 /* 3118 *********************************************************************************** 3119 ** PCI Configuration and Status Register - PCSR 3120 ** 3121 ** The PCI Configuration and Status Register has additional bits for controlling and monitoring 3122 ** various features of the PCI bus interface. 3123 ** ----------------------------------------------------------------- 3124 ** Bit Default Description 3125 ** 31:19 0000H Reserved 3126 ** 18 0 2 Detected Address or Attribute Parity Error - set when a parity error is detected during either the address 3127 ** or attribute phase of a transaction on the PCI bus even when the ATUCMD register Parity Error 3128 ** Response bit is cleared. Set under the following conditions: 3129 ** �E Any Address or Attribute (PCI-X Only) Parity Error on the Bus (including one generated by the ATU). 3130 ** 17:16 Varies with 3131 ** external state 3132 ** of DEVSEL#, 3133 ** STOP#, and 3134 ** TRDY#, 3135 ** during 3136 ** P_RST# 3137 ** PCI-X capability - These two bits define the mode of 3138 ** the PCI bus (conventional or PCI-X) as well as the 3139 ** operating frequency in the case of PCI-X mode. 3140 ** 00 - Conventional PCI mode 3141 ** 01 - PCI-X 66 3142 ** 10 - PCI-X 100 3143 ** 11 - PCI-X 133 3144 ** As defined by the PCI-X Addendum to the PCI Local Bus Specification, 3145 ** Revision 1.0a, the operating 3146 ** mode is determined by an initialization pattern on the PCI bus during 3147 ** P_RST# assertion: 3148 ** DEVSEL# STOP# TRDY# Mode 3149 ** Deasserted Deasserted Deasserted Conventional 3150 ** Deasserted Deasserted Asserted PCI-X 66 3151 ** Deasserted Asserted Deasserted PCI-X 100 3152 ** Deasserted Asserted Asserted PCI-X 133 3153 ** All other patterns are reserved. 3154 ** 15 0 2 3155 ** Outbound Transaction Queue Busy: 3156 ** 0=Outbound Transaction Queue Empty 3157 ** 1=Outbound Transaction Queue Busy 3158 ** 14 0 2 3159 ** Inbound Transaction Queue Busy: 3160 ** 0=Inbound Transaction Queue Empty 3161 ** 1=Inbound Transaction Queue Busy 3162 ** 13 0 2 Reserved. 3163 ** 12 0 2 Discard Timer Value - This bit controls the time-out value 3164 ** for the four discard timers attached to the queues holding read data. 3165 ** A value of 0 indicates the time-out value is 2 15 clocks. 3166 ** A value of 1 indicates the time-out value is 2 10 clocks. 3167 ** 11 0 2 Reserved. 3168 ** 10 Varies with 3169 ** external state 3170 ** of M66EN 3171 ** during 3172 ** P_RST# 3173 ** Bus Operating at 66 MHz - When set, the interface has been initialized to function at 66 MHz in 3174 ** Conventional PCI mode by the assertion of M66EN during bus initialization. 3175 ** When clear, the interface 3176 ** has been initialized as a 33 MHz bus. 3177 ** 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. 3178 ** 09 0 2 Reserved 3179 ** 08 Varies with 3180 ** external state 3181 ** of REQ64# 3182 ** during 3183 ** P_RST# 3184 ** PCI Bus 64-Bit Capable - When clear, the PCI bus interface has been 3185 ** configured as 64-bit capable by 3186 ** the assertion of REQ64# on the rising edge of P_RST#. When set, 3187 ** the PCI interface is configured as 3188 ** 32-bit only. 3189 ** 07:06 00 2 Reserved. 3190 ** 05 0 2 Reset Internal Bus - This bit controls the reset of the Intel XScale core 3191 ** and all units on the internal 3192 ** bus. In addition to the internal bus initialization, 3193 ** this bit triggers the assertion of the M_RST# pin for 3194 ** initialization of registered DIMMs. When set: 3195 ** When operating in the conventional PCI mode: 3196 ** �E All current PCI transactions being mastered by the ATU completes, 3197 ** and the ATU master interfaces 3198 ** proceeds to an idle state. No additional transactions is mastered by these units 3199 ** until the internal bus reset is complete. 3200 ** �E All current transactions being slaved by the ATU on either the PCI bus 3201 ** or the internal bus 3202 ** completes, and the ATU target interfaces proceeds to an idle state. 3203 ** All future slave transactions master aborts, 3204 ** with the exception of the completion cycle for the transaction that set the Reset 3205 ** Internal Bus bit in the PCSR. 3206 ** �E When the value of the Core Processor Reset bit in the PCSR (upon P_RST# assertion) 3207 ** is set, the Intel XScale core is held in reset when the internal bus reset is complete. 3208 ** �E The ATU ignores configuration cycles, and they appears as master aborts for: 32 3209 ** Internal Bus clocks. 3210 ** �E The 80331 hardware clears this bit after the reset operation completes. 3211 ** When operating in the PCI-X mode: 3212 ** The ATU hardware responds the same as in Conventional PCI-X mode. 3213 ** However, this may create a problem in PCI-X mode for split requests in 3214 ** that there may still be an outstanding split completion that the 3215 ** ATU is either waiting to receive (Outbound Request) or initiate 3216 ** (Inbound Read Request). For a cleaner 3217 ** internal bus reset, host software can take the following steps prior 3218 ** to asserting Reset Internal bus: 3219 ** 1. Clear the Bus Master (bit 2 of the ATUCMD) and the Memory Enable (bit 1 of the ATUCMD) bits in 3220 ** the ATUCMD. This ensures that no new transactions, either outbound or inbound are enqueued. 3221 ** 2. Wait for both the Outbound (bit 15 of the PCSR) and Inbound Read (bit 14 of the PCSR) Transaction 3222 ** queue busy bits to be clear. 3223 ** 3. Set the Reset Internal Bus bit 3224 ** As a result, the ATU hardware resets the internal bus using the same logic as in conventional mode, 3225 ** however the user is now assured that the ATU no longer has any pending inbound or outbound split 3226 ** completion transactions. 3227 ** NOTE: Since the Reset Internal Bus bit is set using an inbound configuration cycle, the user is 3228 ** guaranteed that any prior configuration cycles have properly completed since there is only a one 3229 ** deep transaction queue for configuration transaction requests. The ATU sends the appropriate 3230 ** Split Write Completion Message to the Requester prior to the onset of Internal Bus Reset. 3231 ** 04 0 2 Bus Master Indicator Enable: Provides software control for the 3232 ** Bus Master Indicator signal P_BMI used 3233 ** for external RAIDIOS logic control of private devices. Only valid when operating with the bridge and 3234 ** central resource/arbiter disabled (BRG_EN =low, ARB_EN=low). 3235 ** 03 Varies with external state of PRIVDEV during 3236 ** P_RST# 3237 ** Private Device Enable - This bit indicates the state of the reset strap which enables the private device 3238 ** control mechanism within the PCI-to-PCI Bridge SISR configuration register. 3239 ** 0=Private Device control Disabled - SISR register bits default to zero 3240 ** 1=Private Device control Enabled - SISR register bits default to one 3241 ** 02 Varies with external state of RETRY during P_RST# 3242 ** Configuration Cycle Retry - When this bit is set, the PCI interface of the 80331 responds to all 3243 ** configuration cycles with a Retry condition. When clear, the 80331 responds to the appropriate 3244 ** configuration cycles. 3245 ** The default condition for this bit is based on the external state of the RETRY pin at the rising edge of 3246 ** P_RST#. When the external state of the pin is high, the bit is set. When the external state of the pin is 3247 ** low, the bit is cleared. 3248 ** 01 Varies with external state of CORE_RST# during P_RST# 3249 ** Core Processor Reset - This bit is set to its default value by the hardware when either P_RST# is 3250 ** asserted or the Reset Internal Bus bit in PCSR is set. When this bit is set, the Intel XScale core is 3251 ** being held in reset. Software cannot set this bit. Software is required to clear this bit to deassert Intel 3252 ** XScale core reset. 3253 ** The default condition for this bit is based on the external state of the CORE_RST# pin at the rising edge 3254 ** of P_RST#. When the external state of the pin is low, the bit is set. When the external state of the pin is 3255 ** high, the bit is clear. 3256 ** 00 Varies with external state of PRIVMEM during P_RST# 3257 ** Private Memory Enable - This bit indicates the state of the reset strap which enables the private device 3258 ** control mechanism within the PCI-to-PCI Bridge SDER configuration register. 3259 ** 0=Private Memory control Disabled - SDER register bit 2 default to zero 3260 ** 1=Private Memory control Enabled - SDER register bits 2 default to one 3261 *********************************************************************************** 3262 */ 3263 #define ARCMSR_PCI_CONFIGURATION_STATUS_REG 0x84 /*dword 0x87,0x86,0x85,0x84*/ 3264 /* 3265 *********************************************************************************** 3266 ** ATU Interrupt Status Register - ATUISR 3267 ** 3268 ** The ATU Interrupt Status Register is used to notify the core processor of the source of an ATU 3269 ** interrupt. In addition, this register is written to clear the source of the interrupt to the interrupt unit 3270 ** of the 80331. All bits in this register are Read/Clear. 3271 ** Bits 4:0 are a direct reflection of bits 14:11 and bit 8 (respectively) of the ATU Status Register 3272 ** (these bits are set at the same time by hardware but need to be cleared independently). Bit 7 is set 3273 ** by an error associated with the internal bus of the 80331. Bit 8 is for software BIST. The 3274 ** conditions that result in an ATU interrupt are cleared by writing a 1 to the appropriate bits in this 3275 ** register. 3276 ** Note: Bits 4:0, and bits 15 and 13:7 can result in an interrupt being driven to the Intel XScale core. 3277 ** ----------------------------------------------------------------- 3278 ** Bit Default Description 3279 ** 31:18 0000H Reserved 3280 ** 17 0 2 VPD Address Register Updated - This bit is set when a PCI bus configuration write occurs to the VPDAR 3281 ** register. Configuration register writes to the VPDAR does NOT result in bit 15 also being set. When set, 3282 ** this bit results in the assertion of the ATU Configure Register Write Interrupt. 3283 ** 16 0 2 Reserved 3284 ** 15 0 2 ATU Configuration Write - This bit is set when a PCI bus configuration write occurs to any ATU register. 3285 ** When set, this bit results in the assertion of the ATU Configure Register Write Interrupt. 3286 ** 14 0 2 ATU Inbound Memory Window 1 Base Updated - This bit is set when a PCI bus configuration write 3287 ** occurs to either the IABAR1 register or the IAUBAR1 register. Configuration register writes to these 3288 ** registers deos NOT result in bit 15 also being set. When set, this bit results in the assertion of the ATU 3289 ** Configure Register Write Interrupt. 3290 ** 13 0 2 Initiated Split Completion Error Message - This bit is set when the device initiates a Split Completion 3291 ** Message on the PCI Bus with the Split Completion Error attribute bit set. 3292 ** 12 0 2 Received Split Completion Error Message - This bit is set when the device receives a Split Completion 3293 ** Message from the PCI Bus with the Split Completion Error attribute bit set. 3294 ** 11 0 2 Power State Transition - When the Power State Field of the ATU Power Management Control/Status 3295 ** Register is written to transition the ATU function Power State from D0 to D3, D0 to D1, or D3 to D0 and 3296 ** the ATU Power State Transition Interrupt mask bit is cleared, this bit is set. 3297 ** 10 0 2 P_SERR# Asserted - set when P_SERR# is asserted on the PCI bus by the ATU. 3298 ** 09 0 2 Detected Parity Error - set when a parity error is detected on the PCI bus even when the ATUCMD 3299 ** register��s Parity Error Response bit is cleared. Set under the following conditions: 3300 ** �E Write Data Parity Error when the ATU is a target (inbound write). 3301 ** �E Read Data Parity Error when the ATU is an initiator (outbound read). 3302 ** �E Any Address or Attribute (PCI-X Only) Parity Error on the Bus. 3303 ** 08 0 2 ATU BIST Interrupt - When set, generates the ATU BIST Start Interrupt and indicates the host processor 3304 ** has set the Start BIST bit (ATUBISTR register bit 6), when the ATU BIST interrupt is enabled (ATUCR 3305 ** register bit 3). The Intel XScale core can initiate the software BIST and store the result in ATUBISTR 3306 ** register bits 3:0. 3307 ** Configuration register writes to the ATUBISTR does NOT result in bit 15 also being set or the assertion 3308 ** of the ATU Configure Register Write Interrupt. 3309 ** 07 0 2 Internal Bus Master Abort - set when a transaction initiated by the ATU internal bus initiator interface ends in a Master-abort. 3310 ** 06:05 00 2 Reserved. 3311 ** 04 0 2 P_SERR# Detected - set when P_SERR# is detected on the PCI bus by the ATU. 3312 ** 03 0 2 PCI Master Abort - set when a transaction initiated by the ATU PCI initiator interface ends in a Master-abort. 3313 ** 02 0 2 PCI Target Abort (master) - set when a transaction initiated by the ATU PCI master interface ends in a Target-abort. 3314 ** 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. 3315 ** 00 0 2 PCI Master Parity Error - Master Parity Error - The ATU interface sets this bit under the following 3316 ** conditions: 3317 ** �E The ATU asserted PERR# itself or the ATU observed PERR# asserted. 3318 ** �E And the ATU acted as the requester for the operation in which the error occurred. 3319 ** �E And the ATUCMD register��s Parity Error Response bit is set 3320 ** �E Or (PCI-X Mode Only) the ATU received a Write Data Parity Error Message 3321 ** �E And the ATUCMD register��s Parity Error Response bit is set 3322 *********************************************************************************** 3323 */ 3324 #define ARCMSR_ATU_INTERRUPT_STATUS_REG 0x88 /*dword 0x8B,0x8A,0x89,0x88*/ 3325 /* 3326 *********************************************************************************** 3327 ** ATU Interrupt Mask Register - ATUIMR 3328 ** 3329 ** The ATU Interrupt Mask Register contains the control bit to enable and disable interrupts 3330 ** generated by the ATU. 3331 ** ----------------------------------------------------------------- 3332 ** Bit Default Description 3333 ** 31:15 0 0000H Reserved 3334 ** 14 0 2 VPD Address Register Updated Mask - Controls the setting of bit 17 of the ATUISR and generation of the 3335 ** ATU Configuration Register Write interrupt when a PCI bus write occurs to the VPDAR register. 3336 ** 0=Not Masked 3337 ** 1=Masked 3338 ** 13 0 2 Reserved 3339 ** 12 0 2 Configuration Register Write Mask - Controls the setting of bit 15 of the ATUISR and generation of the 3340 ** ATU Configuration Register Write interrupt when a PCI bus write occurs to any ATU configuration register 3341 ** except those covered by mask bit 11 and bit 14 of this register, and ATU BIST enable bit 3 of the ATUCR. 3342 ** 0=Not Masked 3343 ** 1=Masked 3344 ** 11 1 2 ATU Inbound Memory Window 1 Base Updated Mask - Controls the setting of bit 14 of the ATUISR and 3345 ** generation of the ATU Configuration Register Write interrupt when a PCI bus write occurs to either the 3346 ** IABAR1 register or the IAUBAR1 register. 3347 ** 0=Not Masked 3348 ** 1=Masked 3349 ** 10 0 2 Initiated Split Completion Error Message Interrupt Mask - Controls the setting of bit 13 of the ATUISR and 3350 ** generation of the ATU Error interrupt when the ATU initiates a Split Completion Error Message. 3351 ** 0=Not Masked 3352 ** 1=Masked 3353 ** 09 0 2 Received Split Completion Error Message Interrupt Mask- Controls the setting of bit 12 of the ATUISR 3354 ** and generation of the ATU Error interrupt when a Split Completion Error Message results in bit 29 of the 3355 ** PCIXSR being set. 3356 ** 0=Not Masked 3357 ** 1=Masked 3358 ** 08 1 2 Power State Transition Interrupt Mask - Controls the setting of bit 12 of the ATUISR and generation of the 3359 ** ATU Error interrupt when ATU Power Management Control/Status Register is written to transition the 3360 ** ATU Function Power State from D0 to D3, D0 to D1, D1 to D3 or D3 to D0. 3361 ** 0=Not Masked 3362 ** 1=Masked 3363 ** 07 0 2 ATU Detected Parity Error Interrupt Mask - Controls the setting of bit 9 of the ATUISR and generation of 3364 ** the ATU Error interrupt when a parity error detected on the PCI bus that sets bit 15 of the ATUSR. 3365 ** 0=Not Masked 3366 ** 1=Masked 3367 ** 06 0 2 ATU SERR# Asserted Interrupt Mask - Controls the setting of bit 10 of the ATUISR and generation of the 3368 ** ATU Error interrupt when SERR# is asserted on the PCI interface resulting in bit 14 of the ATUSR being set. 3369 ** 0=Not Masked 3370 ** 1=Masked 3371 ** NOTE: This bit is specific to the ATU asserting SERR# and not detecting SERR# from another master. 3372 ** 05 0 2 ATU PCI Master Abort Interrupt Mask - Controls the setting of bit 3 of the ATUISR and generation of the 3373 ** ATU Error interrupt when a master abort error resulting in bit 13 of the ATUSR being set. 3374 ** 0=Not Masked 3375 ** 1=Masked 3376 ** 04 0 2 ATU PCI Target Abort (Master) Interrupt Mask- Controls the setting of bit 12 of the ATUISR and ATU Error 3377 ** generation of the interrupt when a target abort error resulting in bit 12 of the ATUSR being set 3378 ** 0=Not Masked 3379 ** 1=Masked 3380 ** 03 0 2 ATU PCI Target Abort (Target) Interrupt Mask- Controls the setting of bit 1 of the ATUISR and generation 3381 ** of the ATU Error interrupt when a target abort error resulting in bit 11 of the ATUSR being set. 3382 ** 0=Not Masked 3383 ** 1=Masked 3384 ** 02 0 2 ATU PCI Master Parity Error Interrupt Mask - Controls the setting of bit 0 of the ATUISR and generation 3385 ** of the ATU Error interrupt when a parity error resulting in bit 8 of the ATUSR being set. 3386 ** 0=Not Masked 3387 ** 1=Masked 3388 ** 01 0 2 ATU Inbound Error SERR# Enable - Controls when the ATU asserts (when enabled through the 3389 ** ATUCMD) SERR# on the PCI interface in response to a master abort on the internal bus during an 3390 ** inbound write transaction. 3391 ** 0=SERR# Not Asserted due to error 3392 ** 1=SERR# Asserted due to error 3393 ** 00 0 2 ATU ECC Target Abort Enable - Controls the ATU response on the PCI interface to a target abort (ECC 3394 ** error) from the memory controller on the internal bus. In conventional mode, this action only occurs 3395 ** during an inbound read transaction where the data phase that was target aborted on the internal bus is 3396 ** actually requested from the inbound read queue. 3397 ** 0=Disconnect with data 3398 ** (the data being up to 64 bits of 1��s) 3399 ** 1=Target Abort 3400 ** NOTE: In PCI-X Mode, The ATU initiates a Split Completion Error Message (with message class=2h - 3401 ** completer error and message index=81h - 80331 internal bus target abort) on the PCI bus, 3402 ** independent of the setting of this bit. 3403 *********************************************************************************** 3404 */ 3405 #define ARCMSR_ATU_INTERRUPT_MASK_REG 0x8C /*dword 0x8F,0x8E,0x8D,0x8C*/ 3406 /* 3407 *********************************************************************************** 3408 ** Inbound ATU Base Address Register 3 - IABAR3 3409 ** 3410 ** . The Inbound ATU Base Address Register 3 (IABAR3) together with the Inbound ATU Upper Base Address Register 3 (IAUBAR3) defines the block 3411 ** of memory addresses where the inbound translation window 3 begins. 3412 ** . The inbound ATU decodes and forwards the bus request to the 80331 internal bus with a translated address to map into 80331 local memory. 3413 ** . The IABAR3 and IAUBAR3 define the base address and describes the required memory block size. 3414 ** . 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. 3415 ** The programmed value within the base address register must comply with the PCI programming requirements for address alignment. 3416 ** Note: 3417 ** Since IABAR3 does not appear in the standard PCI configuration header space (offsets 00H - 3CH), 3418 ** IABAR3 is not configured by the host during normal system initialization. 3419 ** Warning: 3420 ** When a non-zero value is not written to IALR3, 3421 ** the user should not set either the Prefetchable Indicator 3422 ** or the Type Indicator for 64 bit addressability. 3423 ** This is the default for IABAR3. 3424 ** Assuming a non-zero value is written to IALR3, 3425 ** the user may set the Prefetchable Indicator 3426 ** or the Type Indicator: 3427 ** a. Since non prefetchable memory windows can never be placed above the 4 Gbyte address boundary, 3428 ** when the Prefetchable Indicator is not set, 3429 ** the user should also leave the Type Indicator set for 32 bit addressability. 3430 ** This is the default for IABAR3. 3431 ** b. when the Prefetchable Indicator is set, 3432 ** the user should also set the Type Indicator for 64 bit addressability. 3433 ** ----------------------------------------------------------------- 3434 ** Bit Default Description 3435 ** 31:12 00000H Translation Base Address 3 - These bits define the actual location 3436 ** the translation function is to respond to when addressed from the PCI bus. 3437 ** 11:04 00H Reserved. 3438 ** 03 0 2 Prefetchable Indicator - When set, defines the memory space as prefetchable. 3439 ** 02:01 00 2 Type Indicator - Defines the width of the addressability for this memory window: 3440 ** 00 - Memory Window is locatable anywhere in 32 bit address space 3441 ** 10 - Memory Window is locatable anywhere in 64 bit address space 3442 ** 00 0 2 Memory Space Indicator - This bit field describes memory or I/O space base address. 3443 ** The ATU does not occupy I/O space, 3444 ** thus this bit must be zero. 3445 *********************************************************************************** 3446 */ 3447 #define ARCMSR_INBOUND_ATU_BASE_ADDRESS3_REG 0x90 /*dword 0x93,0x92,0x91,0x90*/ 3448 /* 3449 *********************************************************************************** 3450 ** Inbound ATU Upper Base Address Register 3 - IAUBAR3 3451 ** 3452 ** This register contains the upper base address when decoding PCI addresses beyond 4 GBytes. 3453 ** Together with the Translation Base Address this register defines the actual location 3454 ** the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes (for DACs). 3455 ** The programmed value within the base address register must comply with the PCI programming 3456 ** requirements for address alignment. 3457 ** Note: 3458 ** When the Type indicator of IABAR3 is set to indicate 32 bit addressability, 3459 ** the IAUBAR3 register attributes are read-only. 3460 ** This is the default for IABAR3. 3461 ** ----------------------------------------------------------------- 3462 ** Bit Default Description 3463 ** 31:0 00000H Translation Upper Base Address 3 - Together with the Translation Base Address 3 these bits define 3464 ** the actual location the translation function is to respond to when addressed from the PCI bus for addresses > 4GBytes. 3465 *********************************************************************************** 3466 */ 3467 #define ARCMSR_INBOUND_ATU_UPPER_BASE_ADDRESS3_REG 0x94 /*dword 0x97,0x96,0x95,0x94*/ 3468 /* 3469 *********************************************************************************** 3470 ** Inbound ATU Limit Register 3 - IALR3 3471 ** 3472 ** Inbound address translation for memory window 3 occurs for data transfers occurring from the PCI 3473 ** bus (originated from the PCI bus) to the 80331 internal bus. The address translation block converts 3474 ** PCI addresses to internal bus addresses. 3475 ** The inbound translation base address for inbound window 3 is specified in Section 3.10.15. When 3476 ** determining block size requirements �X as described in Section 3.10.21 �X the translation limit 3477 ** register provides the block size requirements for the base address register. The remaining registers 3478 ** used for performing address translation are discussed in Section 3.2.1.1. 3479 ** The 80331 translate value register��s programmed value must be naturally aligned with the base 3480 ** address register��s programmed value. The limit register is used as a mask; thus, the lower address 3481 ** bits programmed into the 80331 translate value register are invalid. Refer to the PCI Local Bus 3482 ** Specification, Revision 2.3 for additional information on programming base address registers. 3483 ** Bits 31 to 12 within the IALR3 have a direct effect on the IABAR3 register, bits 31 to 12, with a 3484 ** one to one correspondence. A value of 0 in a bit within the IALR3 makes the corresponding bit 3485 ** within the IABAR3 a read only bit which always returns 0. A value of 1 in a bit within the IALR3 3486 ** makes the corresponding bit within the IABAR3 read/write from PCI. Note that a consequence of 3487 ** this programming scheme is that unless a valid value exists within the IALR3, all writes to the 3488 ** IABAR3 has no effect since a value of all zeros within the IALR3 makes the IABAR3 a read only 3489 ** register. 3490 ** ----------------------------------------------------------------- 3491 ** Bit Default Description 3492 ** 31:12 00000H Inbound Translation Limit 3 - This readback value determines the memory block size required 3493 ** for the ATUs memory window 3. 3494 ** 11:00 000H Reserved 3495 *********************************************************************************** 3496 */ 3497 #define ARCMSR_INBOUND_ATU_LIMIT3_REG 0x98 /*dword 0x9B,0x9A,0x99,0x98*/ 3498 /* 3499 *********************************************************************************** 3500 ** Inbound ATU Translate Value Register 3 - IATVR3 3501 ** 3502 ** The Inbound ATU Translate Value Register 3 (IATVR3) contains the internal bus address used to 3503 ** convert PCI bus addresses. The converted address is driven on the internal bus as a result of the 3504 ** inbound ATU address translation. 3505 ** ----------------------------------------------------------------- 3506 ** Bit Default Description 3507 ** 31:12 00000H Inbound ATU Translation Value 3 - This value is used to convert the PCI address to internal bus addresses. 3508 ** This value must be 64-bit aligned on the internal bus. The default address allows the ATU to 3509 ** access the internal 80331 memory-mapped registers. 3510 ** 11:00 000H Reserved 3511 *********************************************************************************** 3512 */ 3513 #define ARCMSR_INBOUND_ATU_TRANSLATE_VALUE3_REG 0x9C /*dword 0x9F,0x9E,0x9D,0x9C*/ 3514 /* 3515 *********************************************************************************** 3516 ** Outbound Configuration Cycle Address Register - OCCAR 3517 ** 3518 ** The Outbound Configuration Cycle Address Register is used to hold the 32-bit PCI configuration 3519 ** cycle address. The Intel XScale core writes the PCI configuration cycles address which then 3520 ** enables the outbound configuration read or write. The Intel XScale core then performs a read or 3521 ** write to the Outbound Configuration Cycle Data Register to initiate the configuration cycle on the 3522 ** PCI bus. 3523 ** Note: Bits 15:11 of the configuration cycle address for Type 0 configuration cycles are defined differently 3524 ** for Conventional versus PCI-X modes. When 80331 software programs the OCCAR to initiate a 3525 ** Type 0 configuration cycle, the OCCAR should always be loaded based on the PCI-X definition for 3526 ** the Type 0 configuration cycle address. When operating in Conventional mode, the 80331 clears 3527 ** bits 15:11 of the OCCAR prior to initiating an outbound Type 0 configuration cycle. See the PCI-X 3528 ** Addendum to the PCI Local Bus Specification, Revision 1.0a for details on the two formats. 3529 ** ----------------------------------------------------------------- 3530 ** Bit Default Description 3531 ** 31:00 0000 0000H Configuration Cycle Address - These bits define the 32-bit PCI address used during an outbound 3532 ** configuration read or write cycle. 3533 *********************************************************************************** 3534 */ 3535 #define ARCMSR_OUTBOUND_CONFIGURATION_CYCLE_ADDRESS_REG 0xA4 /*dword 0xA7,0xA6,0xA5,0xA4*/ 3536 /* 3537 *********************************************************************************** 3538 ** Outbound Configuration Cycle Data Register - OCCDR 3539 ** 3540 ** The Outbound Configuration Cycle Data Register is used to initiate a configuration read or write 3541 ** on the PCI bus. The register is logical rather than physical meaning that it is an address not a 3542 ** register. The Intel XScale core reads or writes the data registers memory-mapped address to 3543 ** initiate the configuration cycle on the PCI bus with the address found in the OCCAR. For a 3544 ** configuration write, the data is latched from the internal bus and forwarded directly to the OWQ. 3545 ** For a read, the data is returned directly from the ORQ to the Intel XScale core and is never 3546 ** actually entered into the data register (which does not physically exist). 3547 ** The OCCDR is only visible from 80331 internal bus address space and appears as a reserved value 3548 ** within the ATU configuration space. 3549 ** ----------------------------------------------------------------- 3550 ** Bit Default Description 3551 ** 31:00 0000 0000H Configuration Cycle Data - These bits define the data used during an outbound configuration read 3552 ** or write cycle. 3553 *********************************************************************************** 3554 */ 3555 #define ARCMSR_OUTBOUND_CONFIGURATION_CYCLE_DATA_REG 0xAC /*dword 0xAF,0xAE,0xAD,0xAC*/ 3556 /* 3557 *********************************************************************************** 3558 ** VPD Capability Identifier Register - VPD_CAPID 3559 ** 3560 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification, 3561 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended 3562 ** Capability contained in that header. In the case of the 80331, this is the VPD extended capability 3563 ** with an ID of 03H as defined by the PCI Local Bus Specification, Revision 2.3. 3564 ** ----------------------------------------------------------------- 3565 ** Bit Default Description 3566 ** 07:00 03H Cap_Id - This field with its�� 03H value identifies this item in the linked list of Extended Capability 3567 ** Headers as being the VPD capability registers. 3568 *********************************************************************************** 3569 */ 3570 #define ARCMSR_VPD_CAPABILITY_IDENTIFIER_REG 0xB8 /*byte*/ 3571 /* 3572 *********************************************************************************** 3573 ** VPD Next Item Pointer Register - VPD_NXTP 3574 ** 3575 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification, 3576 ** Revision 2.3. This register describes the location of the next item in the function��s capability list. 3577 ** For the 80331, this the final capability list, and hence, this register is set to 00H. 3578 ** ----------------------------------------------------------------- 3579 ** Bit Default Description 3580 ** 07:00 00H Next_ Item_ Pointer - This field provides an offset into the function��s configuration space pointing to the 3581 ** next item in the function��s capability list. Since the VPD capabilities are the last in the linked list of 3582 ** extended capabilities in the 80331, the register is set to 00H. 3583 *********************************************************************************** 3584 */ 3585 #define ARCMSR_VPD_NEXT_ITEM_PTR_REG 0xB9 /*byte*/ 3586 /* 3587 *********************************************************************************** 3588 ** VPD Address Register - VPD_AR 3589 ** 3590 ** The VPD Address register (VPDAR) contains the DWORD-aligned byte address of the VPD to be 3591 ** accessed. The register is read/write and the initial value at power-up is indeterminate. 3592 ** A PCI Configuration Write to the VPDAR interrupts the Intel XScale core. Software can use 3593 ** the Flag setting to determine whether the configuration write was intended to initiate a read or 3594 ** write of the VPD through the VPD Data Register. 3595 ** ----------------------------------------------------------------- 3596 ** Bit Default Description 3597 ** 15 0 2 Flag - A flag is used to indicate when a transfer of data between the VPD Data Register and the storage 3598 ** component has completed. Please see Section 3.9, ��Vital Product Data�� on page 201 for more details on 3599 ** how the 80331 handles the data transfer. 3600 ** 14:0 0000H VPD Address - This register is written to set the DWORD-aligned byte address used to read or write 3601 ** Vital Product Data from the VPD storage component. 3602 *********************************************************************************** 3603 */ 3604 #define ARCMSR_VPD_ADDRESS_REG 0xBA /*word 0xBB,0xBA*/ 3605 /* 3606 *********************************************************************************** 3607 ** VPD Data Register - VPD_DR 3608 ** 3609 ** This register is used to transfer data between the 80331 and the VPD storage component. 3610 ** ----------------------------------------------------------------- 3611 ** Bit Default Description 3612 ** 31:00 0000H VPD Data - Four bytes are always read or written through this register to/from the VPD storage component. 3613 *********************************************************************************** 3614 */ 3615 #define ARCMSR_VPD_DATA_REG 0xBC /*dword 0xBF,0xBE,0xBD,0xBC*/ 3616 /* 3617 *********************************************************************************** 3618 ** Power Management Capability Identifier Register -PM_CAPID 3619 ** 3620 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification, 3621 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended 3622 ** Capability contained in that header. In the case of the 80331, this is the PCI Bus Power 3623 ** Management extended capability with an ID of 01H as defined by the PCI Bus Power Management 3624 ** Interface Specification, Revision 1.1. 3625 ** ----------------------------------------------------------------- 3626 ** Bit Default Description 3627 ** 07:00 01H Cap_Id - This field with its�� 01H value identifies this item in the linked list of Extended Capability 3628 ** Headers as being the PCI Power Management Registers. 3629 *********************************************************************************** 3630 */ 3631 #define ARCMSR_POWER_MANAGEMENT_CAPABILITY_IDENTIFIER_REG 0xC0 /*byte*/ 3632 /* 3633 *********************************************************************************** 3634 ** Power Management Next Item Pointer Register - PM_NXTP 3635 ** 3636 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification, 3637 ** Revision 2.3. This register describes the location of the next item in the function��s capability list. 3638 ** For the 80331, the next capability (MSI capability list) is located at off-set D0H. 3639 ** ----------------------------------------------------------------- 3640 ** Bit Default Description 3641 ** 07:00 D0H Next_ Item_ Pointer - This field provides an offset into the function��s configuration space pointing to the 3642 ** next item in the function��s capability list which in the 80331 is the MSI extended capabilities header. 3643 *********************************************************************************** 3644 */ 3645 #define ARCMSR_POWER_NEXT_ITEM_PTR_REG 0xC1 /*byte*/ 3646 /* 3647 *********************************************************************************** 3648 ** Power Management Capabilities Register - PM_CAP 3649 ** 3650 ** Power Management Capabilities bits adhere to the definitions in the PCI Bus Power Management 3651 ** Interface Specification, Revision 1.1. This register is a 16-bit read-only register which provides 3652 ** information on the capabilities of the ATU function related to power management. 3653 ** ----------------------------------------------------------------- 3654 ** Bit Default Description 3655 ** 15:11 00000 2 PME_Support - This function is not capable of asserting the PME# signal in any state, since PME# 3656 ** is not supported by the 80331. 3657 ** 10 0 2 D2_Support - This bit is set to 0 2 indicating that the 80331 does not support the D2 Power Management State 3658 ** 9 1 2 D1_Support - This bit is set to 1 2 indicating that the 80331 supports the D1 Power Management State 3659 ** 8:6 000 2 Aux_Current - This field is set to 000 2 indicating that the 80331 has no current requirements for the 3660 ** 3.3Vaux signal as defined in the PCI Bus Power Management Interface Specification, Revision 1.1 3661 ** 5 0 2 DSI - This field is set to 0 2 meaning that this function requires a device specific initialization sequence 3662 ** following the transition to the D0 uninitialized state. 3663 ** 4 0 2 Reserved. 3664 ** 3 0 2 PME Clock - Since the 80331 does not support PME# signal generation this bit is cleared to 0 2 . 3665 ** 2:0 010 2 Version - Setting these bits to 010 2 means that this function complies with PCI Bus Power Management 3666 ** Interface Specification, Revision 1.1 3667 *********************************************************************************** 3668 */ 3669 #define ARCMSR_POWER_MANAGEMENT_CAPABILITY_REG 0xC2 /*word 0xC3,0xC2*/ 3670 /* 3671 *********************************************************************************** 3672 ** Power Management Control/Status Register - PM_CSR 3673 ** 3674 ** Power Management Control/Status bits adhere to the definitions in the PCI Bus Power 3675 ** Management Interface Specification, Revision 1.1. This 16-bit register is the control and status 3676 ** interface for the power management extended capability. 3677 ** ----------------------------------------------------------------- 3678 ** Bit Default Description 3679 ** 15 0 2 PME_Status - This function is not capable of asserting the PME# signal in any state, since PME## is not 3680 ** supported by the 80331. 3681 ** 14:9 00H Reserved 3682 ** 8 0 2 PME_En - This bit is hardwired to read-only 0 2 since this function does not support PME# 3683 ** generation from any power state. 3684 ** 7:2 000000 2 Reserved 3685 ** 1:0 00 2 Power State - This 2-bit field is used both to determine the current power state 3686 ** of a function and to set the function into a new power state. The definition of the values is: 3687 ** 00 2 - D0 3688 ** 01 2 - D1 3689 ** 10 2 - D2 (Unsupported) 3690 ** 11 2 - D3 hot 3691 ** The 80331 supports only the D0 and D3 hot states. 3692 ** 3693 *********************************************************************************** 3694 */ 3695 #define ARCMSR_POWER_MANAGEMENT_CONTROL_STATUS_REG 0xC4 /*word 0xC5,0xC4*/ 3696 /* 3697 *********************************************************************************** 3698 ** PCI-X Capability Identifier Register - PX_CAPID 3699 ** 3700 ** The Capability Identifier Register bits adhere to the definitions in the PCI Local Bus Specification, 3701 ** Revision 2.3. This register in the PCI Extended Capability header identifies the type of Extended 3702 ** Capability contained in that header. In the case of the 80331, this is the PCI-X extended capability with 3703 ** an ID of 07H as defined by the PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0a. 3704 ** ----------------------------------------------------------------- 3705 ** Bit Default Description 3706 ** 07:00 07H Cap_Id - This field with its�� 07H value identifies this item in the linked list of Extended Capability 3707 ** Headers as being the PCI-X capability registers. 3708 *********************************************************************************** 3709 */ 3710 #define ARCMSR_PCIX_CAPABILITY_IDENTIFIER_REG 0xE0 /*byte*/ 3711 /* 3712 *********************************************************************************** 3713 ** PCI-X Next Item Pointer Register - PX_NXTP 3714 ** 3715 ** The Next Item Pointer Register bits adhere to the definitions in the PCI Local Bus Specification, 3716 ** Revision 2.3. This register describes the location of the next item in the function��s capability list. 3717 ** By default, the PCI-X capability is the last capabilities list for the 80331, thus this register defaults 3718 ** to 00H. 3719 ** However, this register may be written to B8H prior to host configuration to include the VPD 3720 ** capability located at off-set B8H. 3721 ** Warning: Writing this register to any value other than 00H (default) or B8H is not supported and may 3722 ** produce unpredictable system behavior. 3723 ** In order to guarantee that this register is written prior to host configuration, the 80331 must be 3724 ** initialized at P_RST# assertion to Retry Type 0 configuration cycles (bit 2 of PCSR). Typically, 3725 ** the Intel XScale core would be enabled to boot immediately following P_RST# assertion in 3726 ** this case (bit 1 of PCSR), as well. Please see Table 125, ��PCI Configuration and Status Register - 3727 ** PCSR�� on page 253 for more details on the 80331 initialization modes. 3728 ** ----------------------------------------------------------------- 3729 ** Bit Default Description 3730 ** 07:00 00H Next_ Item_ Pointer - This field provides an offset into the function��s configuration space pointing to the 3731 ** next item in the function��s capability list. Since the PCI-X capabilities are the last in the linked list of 3732 ** extended capabilities in the 80331, the register is set to 00H. 3733 ** However, this field may be written prior to host configuration with B8H to extend the list to include the 3734 ** VPD extended capabilities header. 3735 *********************************************************************************** 3736 */ 3737 #define ARCMSR_PCIX_NEXT_ITEM_PTR_REG 0xE1 /*byte*/ 3738 /* 3739 *********************************************************************************** 3740 ** PCI-X Command Register - PX_CMD 3741 ** 3742 ** This register controls various modes and features of ATU and Message Unit when operating in the 3743 ** PCI-X mode. 3744 ** ----------------------------------------------------------------- 3745 ** Bit Default Description 3746 ** 15:7 000000000 2 Reserved. 3747 ** 6:4 011 2 Maximum Outstanding Split Transactions - This register sets the maximum number of Split Transactions 3748 ** the device is permitted to have outstanding at one time. 3749 ** Register Maximum Outstanding 3750 ** 0 1 3751 ** 1 2 3752 ** 2 3 3753 ** 3 4 3754 ** 4 8 3755 ** 5 12 3756 ** 6 16 3757 ** 7 32 3758 ** 3:2 00 2 Maximum Memory Read Byte Count - This register sets the maximum byte count the device uses when 3759 ** initiating a Sequence with one of the burst memory read commands. 3760 ** Register Maximum Byte Count 3761 ** 0 512 3762 ** 1 1024 3763 ** 2 2048 3764 ** 3 4096 3765 ** 1 0 2 3766 ** Enable Relaxed Ordering - The 80331 does not set the relaxed ordering bit in the Requester Attributes 3767 ** of Transactions. 3768 ** 0 0 2 Data Parity Error Recovery Enable - The device driver sets this bit to enable the device to attempt to 3769 ** recover from data parity errors. When this bit is 0 and the device is in PCI-X mode, the device asserts 3770 ** SERR# (when enabled) whenever the Master Data Parity Error bit (Status register, bit 8) is set. 3771 *********************************************************************************** 3772 */ 3773 #define ARCMSR_PCIX_COMMAND_REG 0xE2 /*word 0xE3,0xE2*/ 3774 /* 3775 *********************************************************************************** 3776 ** PCI-X Status Register - PX_SR 3777 ** 3778 ** This register identifies the capabilities and current operating mode of ATU, DMAs and Message 3779 ** Unit when operating in the PCI-X mode. 3780 ** ----------------------------------------------------------------- 3781 ** Bit Default Description 3782 ** 31:30 00 2 Reserved 3783 ** 29 0 2 Received Split Completion Error Message - This bit is set when the device receives a Split Completion 3784 ** Message with the Split Completion Error attribute bit set. Once set, this bit remains set until software 3785 ** writes a 1 to this location. 3786 ** 0=no Split Completion error message received. 3787 ** 1=a Split Completion error message has been received. 3788 ** 28:26 001 2 Designed Maximum Cumulative Read Size (DMCRS) - The value of this register depends on the setting 3789 ** of the Maximum Memory Read Byte Count field of the PCIXCMD register: 3790 ** DMCRS Max ADQs Maximum Memory Read Byte Count Register Setting 3791 ** 1 16 512 (Default) 3792 ** 2 32 1024 3793 ** 2 32 2048 3794 ** 2 32 4096 3795 ** 25:23 011 2 Designed Maximum Outstanding Split Transactions - The 80331 can have up to four outstanding split transactions. 3796 ** 22:21 01 2 Designed Maximum Memory Read Byte Count - The 80331 can generate memory reads with byte counts up 3797 ** to 1024 bytes. 3798 ** 20 1 2 80331 is a complex device. 3799 ** 19 0 2 Unexpected Split Completion - This bit is set when an unexpected Split Completion with this device��s 3800 ** Requester ID is received. Once set, this bit remains set until software writes a 1 to this location. 3801 ** 0=no unexpected Split Completion has been received. 3802 ** 1=an unexpected Split Completion has been received. 3803 ** 18 0 2 Split Completion Discarded - This bit is set when the device discards a Split Completion because the 3804 ** requester would not accept it. See Section 5.4.4 of the PCI-X Addendum to the PCI Local Bus 3805 ** Specification, Revision 1.0a for details. Once set, this bit remains set until software writes a 1 to this 3806 ** location. 3807 ** 0=no Split Completion has been discarded. 3808 ** 1=a Split Completion has been discarded. 3809 ** NOTE: The 80331 does not set this bit since there is no Inbound address responding to Inbound Read 3810 ** Requests with Split Responses (Memory or Register) that has ��read side effects.�� 3811 ** 17 1 2 80331 is a 133 MHz capable device. 3812 ** 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, 3813 ** therefore this bit is always set. 3814 ** 80331 with no bridge and central resource disabled (BRG_EN=0, ARB_EN=0), 3815 ** 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#). 3816 ** This strap, by default, identifies the add in card based on 80331 with bridge disabled 3817 ** as 64-bit unless the user attaches the appropriate pull-down resistor to the strap. 3818 ** 0=The bus is 32 bits wide. 3819 ** 1=The bus is 64 bits wide. 3820 ** 15:8 FFH Bus Number - This register is read for diagnostic purposes only. It indicates the number of the bus 3821 ** segment for the device containing this function. The function uses this number as part of its Requester 3822 ** ID and Completer ID. For all devices other than the source bridge, each time the function is addressed 3823 ** by a Configuration Write transaction, the function must update this register with the contents of AD[7::0] 3824 ** of the attribute phase of the Configuration Write, regardless of which register in the function is 3825 ** addressed by the transaction. The function is addressed by a Configuration Write transaction when all of 3826 ** the following are true: 3827 ** 1. The transaction uses a Configuration Write command. 3828 ** 2. IDSEL is asserted during the address phase. 3829 ** 3. AD[1::0] are 00b (Type 0 configuration transaction). 3830 ** 4. AD[10::08] of the configuration address contain the appropriate function number. 3831 ** 7:3 1FH Device Number - This register is read for diagnostic purposes only. It indicates the number of the device 3832 ** containing this function, i.e., the number in the Device Number field (AD[15::11]) of the address of a 3833 ** Type 0 configuration transaction that is assigned to the device containing this function by the connection 3834 ** of the system hardware. The system must assign a device number other than 00h (00h is reserved for 3835 ** the source bridge). The function uses this number as part of its Requester ID and Completer ID. Each 3836 ** time the function is addressed by a Configuration Write transaction, the device must update this register 3837 ** with the contents of AD[15::11] of the address phase of the Configuration Write, regardless of which 3838 ** register in the function is addressed by the transaction. The function is addressed by a Configuration 3839 ** Write transaction when all of the following are true: 3840 ** 1. The transaction uses a Configuration Write command. 3841 ** 2. IDSEL is asserted during the address phase. 3842 ** 3. AD[1::0] are 00b (Type 0 configuration transaction). 3843 ** 4. AD[10::08] of the configuration address contain the appropriate function number. 3844 ** 2:0 000 2 Function Number - This register is read for diagnostic purposes only. It indicates the number of this 3845 ** function; i.e., the number in the Function Number field (AD[10::08]) of the address of a Type 0 3846 ** configuration transaction to which this function responds. The function uses this number as part of its 3847 ** Requester ID and Completer ID. 3848 ** 3849 ************************************************************************** 3850 */ 3851 #define ARCMSR_PCIX_STATUS_REG 0xE4 /*dword 0xE7,0xE6,0xE5,0xE4*/ 3852 3853 /* 3854 ************************************************************************** 3855 ** Inbound Read Transaction 3856 ** ======================================================================== 3857 ** An inbound read transaction is initiated by a PCI initiator and is targeted at either 80331 local 3858 ** memory or a 80331 memory-mapped register space. The read transaction is propagated through 3859 ** the inbound transaction queue (ITQ) and read data is returned through the inbound read queue 3860 ** (IRQ). 3861 ** When operating in the conventional PCI mode, all inbound read transactions are processed as 3862 ** delayed read transactions. When operating in the PCI-X mode, all inbound read transactions are 3863 ** processed as split transactions. The ATUs PCI interface claims the read transaction and forwards 3864 ** the read request through to the internal bus and returns the read data to the PCI bus. Data flow for 3865 ** an inbound read transaction on the PCI bus is summarized in the following statements: 3866 ** �E The ATU claims the PCI read transaction when the PCI address is within the inbound 3867 ** translation window defined by ATU Inbound Base Address Register (and Inbound Upper Base 3868 ** Address Register during DACs) and Inbound Limit Register. 3869 ** �E When operating in the conventional PCI mode, when the ITQ is currently holding transaction 3870 ** information from a previous delayed read, the current transaction information is compared to 3871 ** the previous transaction information (based on the setting of the DRC Alias bit in 3872 ** Section 3.10.39, ��ATU Configuration Register - ATUCR�� on page 252). When there is a 3873 ** match and the data is in the IRQ, return the data to the master on the PCI bus. When there is a 3874 ** match and the data is not available, a Retry is signaled with no other action taken. When there 3875 ** is not a match and when the ITQ has less than eight entries, capture the transaction 3876 ** information, signal a Retry and initiate a delayed transaction. When there is not a match and 3877 ** when the ITQ is full, then signal a Retry with no other action taken. 3878 ** �X When an address parity error is detected, the address parity response defined in 3879 ** Section 3.7 is used. 3880 ** �E When operating in the conventional PCI mode, once read data is driven onto the PCI bus from 3881 ** the IRQ, it continues until one of the following is true: 3882 ** �X The initiator completes the PCI transaction. When there is data left unread in the IRQ, the 3883 ** data is flushed. 3884 ** �X An internal bus Target Abort was detected. In this case, the QWORD associated with the 3885 ** Target Abort is never entered into the IRQ, and therefore is never returned. 3886 ** �X Target Abort or a Disconnect with Data is returned in response to the Internal Bus Error. 3887 ** �X The IRQ becomes empty. In this case, the PCI interface signals a Disconnect with data to 3888 ** the initiator on the last data word available. 3889 ** �E When operating in the PCI-X mode, when ITQ is not full, the PCI address, attribute and 3890 ** command are latched into the available ITQ and a Split Response Termination is signalled to 3891 ** the initiator. 3892 ** �E When operating in the PCI-X mode, when the transaction does not cross a 1024 byte aligned 3893 ** boundary, then the ATU waits until it receives the full byte count from the internal bus target 3894 ** before returning read data by generating the split completion transaction on the PCI-X bus. 3895 ** When the read requested crosses at least one 1024 byte boundary, then ATU completes the 3896 ** transfer by returning data in 1024 byte aligned chunks. 3897 ** �E When operating in the PCI-X mode, once a split completion transaction has started, it 3898 ** continues until one of the following is true: 3899 ** �X The requester (now the target) generates a Retry Termination, or a Disconnection at Next 3900 ** ADB (when the requester is a bridge) 3901 ** �X The byte count is satisfied. 3902 ** �X An internal bus Target Abort was detected. The ATU generates a Split Completion 3903 ** Message (message class=2h - completer error, and message index=81h - target abort) to 3904 ** inform the requester about the abnormal condition. The ITQ for this transaction is flushed. 3905 ** Refer to Section 3.7.1. 3906 ** �X An internal bus Master Abort was detected. The ATU generates a Split Completion 3907 ** Message (message class=2h - completer error, and message index=80h - Master abort) to 3908 ** inform the requester about the abnormal condition. The ITQ for this transaction is flushed. 3909 ** Refer to Section 3.7.1 3910 ** �E When operating in the conventional PCI mode, when the master inserts wait states on the PCI 3911 ** bus, the ATU PCI slave interface waits with no premature disconnects. 3912 ** �E When a data parity error occurs signified by PERR# asserted from the initiator, no action is 3913 ** taken by the target interface. Refer to Section 3.7.2.5. 3914 ** �E When operating in the conventional PCI mode, when the read on the internal bus is 3915 ** target-aborted, either a target-abort or a disconnect with data is signaled to the initiator. This is 3916 ** based on the ATU ECC Target Abort Enable bit (bit 0 of the ATUIMR for ATU). When set, a 3917 ** target abort is used, when clear, a disconnect is used. 3918 ** �E When operating in the PCI-X mode (with the exception of the MU queue ports at offsets 40h 3919 ** and 44h), when the transaction on the internal bus resulted in a target abort, the ATU generates 3920 ** a Split Completion Message (message class=2h - completer error, and message index=81h - 3921 ** internal bus target abort) to inform the requester about the abnormal condition. For the MU 3922 ** queue ports, the ATU returns either a target abort or a single data phase disconnect depending 3923 ** on the ATU ECC Target Abort Enable bit (bit 0 of the ATUIMR for ATU). The ITQ for this 3924 ** transaction is flushed. Refer to Section 3.7.1. 3925 ** �E When operating in the conventional PCI mode, when the transaction on the internal bus 3926 ** resulted in a master abort, the ATU returns a target abort to inform the requester about the 3927 ** abnormal condition. The ITQ for this transaction is flushed. Refer to Section 3.7.1 3928 ** �E When operating in the PCI-X mode, when the transaction on the internal bus resulted in a 3929 ** master abort, the ATU generates a Split Completion Message (message class=2h - completer 3930 ** error, and message index=80h - internal bus master abort) to inform the requester about the 3931 ** abnormal condition. The ITQ for this transaction is flushed. Refer to Section 3.7.1. 3932 ** �E When operating in the PCI-X mode, when the Split Completion transaction completes with 3933 ** either Master-Abort or Target-Abort, the requester is indicating a failure condition that 3934 ** prevents it from accepting the completion it requested. In this case, since the Split Request 3935 ** addresses a location that has no read side effects, the completer must discard the Split 3936 ** Completion and take no further action. 3937 ** The data flow for an inbound read transaction on the internal bus is summarized in the following 3938 ** statements: 3939 ** �E The ATU internal bus master interface requests the internal bus when a PCI address appears in 3940 ** an ITQ and transaction ordering has been satisfied. When operating in the PCI-X mode the 3941 ** ATU does not use the information provided by the Relax Ordering Attribute bit. That is, ATU 3942 ** always uses conventional PCI ordering rules. 3943 ** �E Once the internal bus is granted, the internal bus master interface drives the translated address 3944 ** onto the bus and wait for IB_DEVSEL#. When a Retry is signaled, the request is repeated. 3945 ** When a master abort occurs, the transaction is considered complete and a target abort is loaded 3946 ** into the associated IRQ for return to the PCI initiator (transaction is flushed once the PCI 3947 ** master has been delivered the target abort). 3948 ** �E Once the translated address is on the bus and the transaction has been accepted, the internal 3949 ** bus target starts returning data with the assertion of IB_TRDY#. Read data is continuously 3950 ** received by the IRQ until one of the following is true: 3951 ** �X The full byte count requested by the ATU read request is received. The ATU internal bus 3952 ** initiator interface performs a initiator completion in this case. 3953 ** �X When operating in the conventional PCI mode, a Target Abort is received on the internal 3954 ** bus from the internal bus target. In this case, the transaction is aborted and the PCI side is 3955 ** informed. 3956 ** �X When operating in the PCI-X mode, a Target Abort is received on the internal bus from 3957 ** the internal bus target. In this case, the transaction is aborted. The ATU generates a Split 3958 ** Completion Message (message class=2h - completer error, and message index=81h - 3959 ** target abort) on the PCI bus to inform the requester about the abnormal condition. The 3960 ** ITQ for this transaction is flushed. 3961 ** �X When operating in the conventional PCI mode, a single data phase disconnection is 3962 ** received from the internal bus target. When the data has not been received up to the next 3963 ** QWORD boundary, the ATU internal bus master interface attempts to reacquire the bus. 3964 ** When not, the bus returns to idle. 3965 ** �X When operating in the PCI-X mode, a single data phase disconnection is received from 3966 ** the internal bus target. The ATU IB initiator interface attempts to reacquire the bus to 3967 ** obtain remaining data. 3968 ** �X When operating in the conventional PCI mode, a disconnection at Next ADB is received 3969 ** from the internal bus target. The bus returns to idle. 3970 ** �X When operating in the PCI-X mode, a disconnection at Next ADB is received from the 3971 ** internal bus target. The ATU IB initiator interface attempts to reacquire the bus to obtain 3972 ** remaining data. 3973 ** To support PCI Local Bus Specification, Revision 2.0 devices, the ATU can be programmed to 3974 ** ignore the memory read command (Memory Read, Memory Read Line, and Memory Read 3975 ** Multiple) when trying to match the current inbound read transaction with data in a DRC queue 3976 ** which was read previously (DRC on target bus). When the Read Command Alias Bit in the 3977 ** ATUCR register is set, the ATU does not distinguish the read commands on transactions. For 3978 ** example, the ATU enqueues a DRR with a Memory Read Multiple command and performs the read 3979 ** on the internal bus. Some time later, a PCI master attempts a Memory Read with the same address 3980 ** as the previous Memory Read Multiple. When the Read Command Bit is set, the ATU would return 3981 ** the read data from the DRC queue and consider the Delayed Read transaction complete. When the 3982 ** Read Command bit in the ATUCR was clear, the ATU would not return data since the PCI read 3983 ** commands did not match, only the address. 3984 ************************************************************************** 3985 */ 3986 /* 3987 ************************************************************************** 3988 ** Inbound Write Transaction 3989 **======================================================================== 3990 ** An inbound write transaction is initiated by a PCI master and is targeted at either 80331 local 3991 ** memory or a 80331 memory-mapped register. 3992 ** Data flow for an inbound write transaction on the PCI bus is summarized as: 3993 ** �E The ATU claims the PCI write transaction when the PCI address is within the inbound 3994 ** translation window defined by the ATU Inbound Base Address Register (and Inbound Upper 3995 ** Base Address Register during DACs) and Inbound Limit Register. 3996 ** �E When the IWADQ has at least one address entry available and the IWQ has at least one buffer 3997 ** available, the address is captured and the first data phase is accepted. 3998 ** �E The PCI interface continues to accept write data until one of the following is true: 3999 ** �X The initiator performs a disconnect. 4000 ** �X The transaction crosses a buffer boundary. 4001 ** �E When an address parity error is detected during the address phase of the transaction, the 4002 ** address parity error mechanisms are used. Refer to Section 3.7.1 for details of the address 4003 ** parity error response. 4004 ** �E When operating in the PCI-X mode when an attribute parity error is detected, the attribute 4005 ** parity error mechanism described in Section 3.7.1 is used. 4006 ** �E When a data parity error is detected while accepting data, the slave interface sets the 4007 ** appropriate bits based on PCI specifications. No other action is taken. Refer to Section 3.7.2.6 4008 ** for details of the inbound write data parity error response. 4009 ** Once the PCI interface places a PCI address in the IWADQ, when IWQ has received data sufficient 4010 ** to cross a buffer boundary or the master disconnects on the PCI bus, the ATUs internal bus 4011 ** interface becomes aware of the inbound write. When there are additional write transactions ahead 4012 ** in the IWQ/IWADQ, the current transaction remains posted until ordering and priority have been 4013 ** satisfied (Refer to Section 3.5.3) and the transaction is attempted on the internal bus by the ATU 4014 ** internal master interface. The ATU does not insert target wait states nor do data merging on the PCI 4015 ** interface, when operating in the PCI mode. 4016 ** In the PCI-X mode memory writes are always executed as immediate transactions, while 4017 ** configuration write transactions are processed as split transactions. The ATU generates a Split 4018 ** Completion Message, (with Message class=0h - Write Completion Class and Message index = 4019 ** 00h - Write Completion Message) once a configuration write is successfully executed. 4020 ** Also, when operating in the PCI-X mode a write sequence may contain multiple write transactions. 4021 ** The ATU handles such transactions as independent transactions. 4022 ** Data flow for the inbound write transaction on the internal bus is summarized as: 4023 ** �E The ATU internal bus master requests the internal bus when IWADQ has at least one entry 4024 ** with associated data in the IWQ. 4025 ** �E When the internal bus is granted, the internal bus master interface initiates the write 4026 ** transaction by driving the translated address onto the internal bus. For details on inbound 4027 ** address translation. 4028 ** �E When IB_DEVSEL# is not returned, a master abort condition is signaled on the internal bus. 4029 ** The current transaction is flushed from the queue and SERR# may be asserted on the PCI 4030 ** interface. 4031 ** �E The ATU initiator interface asserts IB_REQ64# to attempt a 64-bit transfer. When 4032 ** IB_ACK64# is not returned, a 32-bit transfer is used. Transfers of less than 64-bits use the 4033 ** IB_C/BE[7:0]# to mask the bytes not written in the 64-bit data phase. Write data is transferred 4034 ** from the IWQ to the internal bus when data is available and the internal bus interface retains 4035 ** internal bus ownership. 4036 ** �E The internal bus interface stops transferring data from the current transaction to the internal 4037 ** bus when one of the following conditions becomes true: 4038 ** �X The internal bus initiator interface loses bus ownership. The ATU internal initiator 4039 ** terminates the transfer (initiator disconnection) at the next ADB (for the internal bus ADB 4040 ** is defined as a naturally aligned 128-byte boundary) and attempt to reacquire the bus to 4041 ** complete the delivery of remaining data using the same sequence ID but with the 4042 ** modified starting address and byte count. 4043 ** �X A Disconnect at Next ADB is signaled on the internal bus from the internal target. When 4044 ** the transaction in the IWQ completes at that ADB, the initiator returns to idle. When the 4045 ** transaction in the IWQ is not complete, the initiator attempts to reacquire the bus to 4046 ** complete the delivery of remaining data using the same sequence ID but with the 4047 ** modified starting address and byte count. 4048 ** �X A Single Data Phase Disconnect is signaled on the internal bus from the internal target. 4049 ** When the transaction in the IWQ needs only a single data phase, the master returns to idle. 4050 ** When the transaction in the IWQ is not complete, the initiator attempts to reacquire the 4051 ** bus to complete the delivery of remaining data using the same sequence ID but with the 4052 ** modified starting address and byte count. 4053 ** �X The data from the current transaction has completed (satisfaction of byte count). An 4054 ** initiator termination is performed and the bus returns to idle. 4055 ** �X A Master Abort is signaled on the internal bus. SERR# may be asserted on the PCI bus. 4056 ** Data is flushed from the IWQ. 4057 ***************************************************************** 4058 */ 4059 4060 4061 4062 /* 4063 ************************************************************************** 4064 ** Inbound Read Completions Data Parity Errors 4065 **======================================================================== 4066 ** As an initiator, the ATU may encounter this error condition when operating in the PCI-X mode. 4067 ** When as the completer of a Split Read Request the ATU observes PERR# assertion during the split 4068 ** completion transaction, the ATU attempts to complete the transaction normally and no further 4069 ** action is taken. 4070 ************************************************************************** 4071 */ 4072 4073 /* 4074 ************************************************************************** 4075 ** Inbound Configuration Write Completion Message Data Parity Errors 4076 **======================================================================== 4077 ** As an initiator, the ATU may encounter this error condition when operating in the PCI-X mode. 4078 ** When as the completer of a Configuration (Split) Write Request the ATU observes PERR# 4079 ** assertion during the split completion transaction, the ATU attempts to complete the transaction 4080 ** normally and no further action is taken. 4081 ************************************************************************** 4082 */ 4083 4084 /* 4085 ************************************************************************** 4086 ** Inbound Read Request Data Parity Errors 4087 **===================== Immediate Data Transfer ========================== 4088 ** As a target, the ATU may encounter this error when operating in the Conventional PCI or PCI-X modes. 4089 ** Inbound read data parity errors occur when read data delivered from the IRQ is detected as having 4090 ** bad parity by the initiator of the transaction who is receiving the data. The initiator may optionally 4091 ** report the error to the system by asserting PERR#. As a target device in this scenario, no action is 4092 ** required and no error bits are set. 4093 **=====================Split Response Termination========================= 4094 ** As a target, the ATU may encounter this error when operating in the PCI-X mode. 4095 ** Inbound read data parity errors occur during the Split Response Termination. The initiator may 4096 ** optionally report the error to the system by asserting PERR#. As a target device in this scenario, no 4097 ** action is required and no error bits are set. 4098 ************************************************************************** 4099 */ 4100 4101 /* 4102 ************************************************************************** 4103 ** Inbound Write Request Data Parity Errors 4104 **======================================================================== 4105 ** As a target, the ATU may encounter this error when operating in the Conventional or PCI-X modes. 4106 ** Data parity errors occurring during write operations received by the ATU may assert PERR# on 4107 ** the PCI Bus. When an error occurs, the ATU continues accepting data until the initiator of the write 4108 ** transaction completes or a queue fill condition is reached. Specifically, the following actions with 4109 ** the given constraints are taken by the ATU: 4110 ** �E PERR# is asserted two clocks cycles (three clock cycles when operating in the PCI-X mode) 4111 ** following the data phase in which the data parity error is detected on the bus. This is only 4112 ** done when the Parity Error Response bit in the ATUCMD is set. 4113 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4114 ** actions is taken: 4115 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4116 ** Detected Parity Error bit in the ATUISR. When set, no action. 4117 *************************************************************************** 4118 */ 4119 4120 4121 /* 4122 *************************************************************************** 4123 ** Inbound Configuration Write Request 4124 ** ===================================================================== 4125 ** As a target, the ATU may encounter this error when operating in the Conventional or PCI-X modes. 4126 ** =============================================== 4127 ** Conventional PCI Mode 4128 ** =============================================== 4129 ** To allow for correct data parity calculations for delayed write transactions, the ATU delays the 4130 ** assertion of STOP# (signalling a Retry) until PAR is driven by the master. A parity error during a 4131 ** delayed write transaction (inbound configuration write cycle) can occur in any of the following 4132 ** parts of the transactions: 4133 ** �E During the initial Delayed Write Request cycle on the PCI bus when the ATU latches the 4134 ** address/command and data for delayed delivery to the internal configuration register. 4135 ** �E During the Delayed Write Completion cycle on the PCI bus when the ATU delivers the status 4136 ** of the operation back to the original master. 4137 ** The 80331 ATU PCI interface has the following responses to a delayed write parity error for 4138 ** inbound transactions during Delayed Write Request cycles with the given constraints: 4139 ** �E When the Parity Error Response bit in the ATUCMD is set, the ATU asserts TRDY# 4140 ** (disconnects with data) and two clock cycles later asserts PERR# notifying the initiator of the 4141 ** parity error. The delayed write cycle is not enqueued and forwarded to the internal bus. 4142 ** When the Parity Error Response bit in the ATUCMD is cleared, the ATU retries the 4143 ** transaction by asserting STOP# and enqueues the Delayed Write Request cycle to be 4144 ** forwarded to the internal bus. PERR# is not asserted. 4145 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4146 ** actions is taken: 4147 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4148 ** Detected Parity Error bit in the ATUISR. When set, no action. 4149 ** For the original write transaction to be completed, the initiator retries the transaction on the PCI 4150 ** bus and the ATU returns the status from the internal bus, completing the transaction. 4151 ** For the Delayed Write Completion transaction on the PCI bus where a data parity error occurs and 4152 ** therefore does not agree with the status being returned from the internal bus (i.e. status being 4153 ** returned is normal completion) the ATU performs the following actions with the given constraints: 4154 ** �E When the Parity Error Response Bit is set in the ATUCMD, the ATU asserts TRDY# 4155 ** (disconnects with data) and two clocks later asserts PERR#. The Delayed Completion cycle in 4156 ** the IDWQ remains since the data of retried command did not match the data within the queue. 4157 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4158 ** actions is taken: 4159 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4160 ** Detected Parity Error bit in the ATUISR. When set, no action. 4161 ** =================================================== 4162 ** PCI-X Mode 4163 ** =================================================== 4164 ** Data parity errors occurring during configuration write operations received by the ATU may cause 4165 ** PERR# assertion and delivery of a Split Completion Error Message on the PCI Bus. When an error 4166 ** occurs, the ATU accepts the write data and complete with a Split Response Termination. 4167 ** Specifically, the following actions with the given constraints are then taken by the ATU: 4168 ** �E When the Parity Error Response bit in the ATUCMD is set, PERR# is asserted three clocks 4169 ** cycles following the Split Response Termination in which the data parity error is detected on 4170 ** the bus. When the ATU asserts PERR#, additional actions is taken: 4171 ** �X A Split Write Data Parity Error message (with message class=2h - completer error and 4172 ** message index=01h - Split Write Data Parity Error) is initiated by the ATU on the PCI bus 4173 ** that addresses the requester of the configuration write. 4174 ** �X When the Initiated Split Completion Error Message Interrupt Mask in the ATUIMR is 4175 ** clear, set the Initiated Split Completion Error Message bit in the ATUISR. When set, no 4176 ** action. 4177 ** �X The Split Write Request is not enqueued and forwarded to the internal bus. 4178 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4179 ** actions is taken: 4180 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4181 ** Detected Parity Error bit in the ATUISR. When set, no action. 4182 ** 4183 *************************************************************************** 4184 */ 4185 4186 /* 4187 *************************************************************************** 4188 ** Split Completion Messages 4189 ** ======================================================================= 4190 ** As a target, the ATU may encounter this error when operating in the PCI-X mode. 4191 ** Data parity errors occurring during Split Completion Messages claimed by the ATU may assert 4192 ** PERR# (when enabled) or SERR# (when enabled) on the PCI Bus. When an error occurs, the 4193 ** ATU accepts the data and complete normally. Specifically, the following actions with the given 4194 ** constraints are taken by the ATU: 4195 ** �E PERR# is asserted three clocks cycles following the data phase in which the data parity error 4196 ** is detected on the bus. This is only done when the Parity Error Response bit in the ATUCMD 4197 ** is set. When the ATU asserts PERR#, additional actions is taken: 4198 ** �X The Master Parity Error bit in the ATUSR is set. 4199 ** �X When the ATU PCI Master Parity Error Interrupt Mask Bit in the ATUIMR is clear, set the 4200 ** PCI Master Parity Error bit in the ATUISR. When set, no action. 4201 ** �X When the SERR# Enable bit in the ATUCMD is set, and the Data Parity Error Recover 4202 ** Enable bit in the PCIXCMD register is clear, assert SERR#; otherwise no action is taken. 4203 ** When the ATU asserts SERR#, additional actions is taken: 4204 ** Set the SERR# Asserted bit in the ATUSR. 4205 ** When the ATU SERR# Asserted Interrupt Mask Bit in the ATUIMR is clear, set the 4206 ** SERR# Asserted bit in the ATUISR. When set, no action. 4207 ** When the ATU SERR# Detected Interrupt Enable Bit in the ATUCR is set, set the 4208 ** SERR# Detected bit in the ATUISR. When clear, no action. 4209 ** �E When the SCE bit (Split Completion Error -- bit 30 of the Completer Attributes) is set during 4210 ** the Attribute phase, the Received Split Completion Error Message bit in the PCIXSR is set. 4211 ** When the ATU sets this bit, additional actions is taken: 4212 ** �X When the ATU Received Split Completion Error Message Interrupt Mask bit in the 4213 ** ATUIMR is clear, set the Received Split Completion Error Message bit in the ATUISR. 4214 ** When set, no action. 4215 ** �E The Detected Parity Error bit in the ATUSR is set. When the ATU sets this bit, additional 4216 ** actions is taken: 4217 ** �X When the ATU Detected Parity Error Interrupt Mask bit in the ATUIMR is clear, set the 4218 ** Detected Parity Error bit in the ATUISR. When set, no action. 4219 ** �E The transaction associated with the Split Completion Message is discarded. 4220 ** �E When the discarded transaction was a read, a completion error message (with message 4221 ** class=2h - completer error and message index=82h - PCI bus read parity error) is generated on 4222 ** the internal bus of the 80331. 4223 ***************************************************************************** 4224 */ 4225 4226 4227 /* 4228 ****************************************************************************************************** 4229 ** Messaging Unit (MU) of the Intel R 80331 I/O processor (80331) 4230 ** ================================================================================================== 4231 ** The Messaging Unit (MU) transfers data between the PCI system and the 80331 4232 ** notifies the respective system when new data arrives. 4233 ** The PCI window for messaging transactions is always the first 4 Kbytes of the inbound translation. 4234 ** window defined by: 4235 ** 1.Inbound ATU Base Address Register 0 (IABAR0) 4236 ** 2.Inbound ATU Limit Register 0 (IALR0) 4237 ** All of the Messaging Unit errors are reported in the same manner as ATU errors. 4238 ** Error conditions and status can be found in : 4239 ** 1.ATUSR 4240 ** 2.ATUISR 4241 **==================================================================================================== 4242 ** Mechanism Quantity Assert PCI Interrupt Signals Generate I/O Processor Interrupt 4243 **---------------------------------------------------------------------------------------------------- 4244 ** Message Registers 2 Inbound Optional Optional 4245 ** 2 Outbound 4246 **---------------------------------------------------------------------------------------------------- 4247 ** Doorbell Registers 1 Inbound Optional Optional 4248 ** 1 Outbound 4249 **---------------------------------------------------------------------------------------------------- 4250 ** Circular Queues 4 Circular Queues Under certain conditions Under certain conditions 4251 **---------------------------------------------------------------------------------------------------- 4252 ** Index Registers 1004 32-bit Memory Locations No Optional 4253 **==================================================================================================== 4254 ** PCI Memory Map: First 4 Kbytes of the ATU Inbound PCI Address Space 4255 **==================================================================================================== 4256 ** 0000H Reserved 4257 ** 0004H Reserved 4258 ** 0008H Reserved 4259 ** 000CH Reserved 4260 **------------------------------------------------------------------------ 4261 ** 0010H Inbound Message Register 0 ] 4262 ** 0014H Inbound Message Register 1 ] 4263 ** 0018H Outbound Message Register 0 ] 4264 ** 001CH Outbound Message Register 1 ] 4 Message Registers 4265 **------------------------------------------------------------------------ 4266 ** 0020H Inbound Doorbell Register ] 4267 ** 0024H Inbound Interrupt Status Register ] 4268 ** 0028H Inbound Interrupt Mask Register ] 4269 ** 002CH Outbound Doorbell Register ] 4270 ** 0030H Outbound Interrupt Status Register ] 4271 ** 0034H Outbound Interrupt Mask Register ] 2 Doorbell Registers and 4 Interrupt Registers 4272 **------------------------------------------------------------------------ 4273 ** 0038H Reserved 4274 ** 003CH Reserved 4275 **------------------------------------------------------------------------ 4276 ** 0040H Inbound Queue Port ] 4277 ** 0044H Outbound Queue Port ] 2 Queue Ports 4278 **------------------------------------------------------------------------ 4279 ** 0048H Reserved 4280 ** 004CH Reserved 4281 **------------------------------------------------------------------------ 4282 ** 0050H ] 4283 ** : ] 4284 ** : Intel Xscale Microarchitecture Local Memory ] 4285 ** : ] 4286 ** 0FFCH ] 1004 Index Registers 4287 ******************************************************************************* 4288 */ 4289 /* 4290 ***************************************************************************** 4291 ** Theory of MU Operation 4292 ***************************************************************************** 4293 **-------------------- 4294 ** inbound_msgaddr0: 4295 ** inbound_msgaddr1: 4296 ** outbound_msgaddr0: 4297 ** outbound_msgaddr1: 4298 ** . The MU has four independent messaging mechanisms. 4299 ** There are four Message Registers that are similar to a combination of mailbox and doorbell registers. 4300 ** Each holds a 32-bit value and generates an interrupt when written. 4301 **-------------------- 4302 ** inbound_doorbell: 4303 ** outbound_doorbell: 4304 ** . The two Doorbell Registers support software interrupts. 4305 ** When a bit is set in a Doorbell Register, an interrupt is generated. 4306 **-------------------- 4307 ** inbound_queueport: 4308 ** outbound_queueport: 4309 ** 4310 ** 4311 ** . The Circular Queues support a message passing scheme that uses 4 circular queues. 4312 ** The 4 circular queues are implemented in 80331 local memory. 4313 ** Two queues are used for inbound messages and two are used for outbound messages. 4314 ** Interrupts may be generated when the queue is written. 4315 **-------------------- 4316 ** local_buffer 0x0050 ....0x0FFF 4317 ** . The Index Registers use a portion of the 80331 local memory to implement a large set of message registers. 4318 ** When one of the Index Registers is written, an interrupt is generated and the address of the register written is captured. 4319 ** Interrupt status for all interrupts is recorded in the Inbound Interrupt Status Register and the Outbound Interrupt Status Register. 4320 ** Each interrupt generated by the Messaging Unit can be masked. 4321 **-------------------- 4322 ** . Multi-DWORD PCI burst accesses are not supported by the Messaging Unit, 4323 ** with the exception of Multi-DWORD reads to the index registers. 4324 ** In Conventional mode: the MU terminates Multi-DWORD PCI transactions 4325 ** (other than index register reads) with a disconnect at the next Qword boundary, with the exception of queue ports. 4326 ** In PCI-X mode : the MU terminates a Multi-DWORD PCI read transaction with a Split Response 4327 ** and the data is returned through split completion transaction(s). 4328 ** however, when the burst request crosses into or through the range of offsets 40h to 4Ch 4329 ** (e.g., this includes the queue ports) the transaction is signaled target-abort immediately on the PCI bus. 4330 ** In PCI-X mode, Multi-DWORD PCI writes is signaled a Single-Data-Phase Disconnect 4331 ** which means that no data beyond the first Qword (Dword when the MU does not assert P_ACK64#) is written. 4332 **-------------------- 4333 ** . All registers needed to configure and control the Messaging Unit are memory-mapped registers. 4334 ** The MU uses the first 4 Kbytes of the inbound translation window in the Address Translation Unit (ATU). 4335 ** This PCI address window is used for PCI transactions that access the 80331 local memory. 4336 ** The PCI address of the inbound translation window is contained in the Inbound ATU Base Address Register. 4337 **-------------------- 4338 ** . From the PCI perspective, the Messaging Unit is part of the Address Translation Unit. 4339 ** The Messaging Unit uses the PCI configuration registers of the ATU for control and status information. 4340 ** The Messaging Unit must observe all PCI control bits in the ATU Command Register and ATU Configuration Register. 4341 ** The Messaging Unit reports all PCI errors in the ATU Status Register. 4342 **-------------------- 4343 ** . Parts of the Messaging Unit can be accessed as a 64-bit PCI device. 4344 ** The register interface, message registers, doorbell registers, 4345 ** and index registers returns a P_ACK64# in response to a P_REQ64# on the PCI interface. 4346 ** Up to 1 Qword of data can be read or written per transaction (except Index Register reads). 4347 ** The Inbound and Outbound Queue Ports are always 32-bit addresses and the MU does not assert P_ACK64# to offsets 40H and 44H. 4348 ************************************************************************** 4349 */ 4350 /* 4351 ************************************************************************** 4352 ** Message Registers 4353 ** ============================== 4354 ** . Messages can be sent and received by the 80331 through the use of the Message Registers. 4355 ** . When written, the message registers may cause an interrupt to be generated to either the Intel XScale core or the host processor. 4356 ** . Inbound messages are sent by the host processor and received by the 80331. 4357 ** Outbound messages are sent by the 80331 and received by the host processor. 4358 ** . The interrupt status for outbound messages is recorded in the Outbound Interrupt Status Register. 4359 ** Interrupt status for inbound messages is recorded in the Inbound Interrupt Status Register. 4360 ** 4361 ** Inbound Messages: 4362 ** ----------------- 4363 ** . When an inbound message register is written by an external PCI agent, an interrupt may be generated to the Intel XScale core. 4364 ** . The interrupt may be masked by the mask bits in the Inbound Interrupt Mask Register. 4365 ** . The Intel XScale core interrupt is recorded in the Inbound Interrupt Status Register. 4366 ** The interrupt causes the Inbound Message Interrupt bit to be set in the Inbound Interrupt Status Register. 4367 ** This is a Read/Clear bit that is set by the MU hardware and cleared by software. 4368 ** The interrupt is cleared when the Intel XScale core writes a value of 4369 ** 1 to the Inbound Message Interrupt bit in the Inbound Interrupt Status Register. 4370 ** ------------------------------------------------------------------------ 4371 ** Inbound Message Register - IMRx 4372 ** 4373 ** . There are two Inbound Message Registers: IMR0 and IMR1. 4374 ** . When the IMR register is written, an interrupt to the Intel XScale core may be generated. 4375 ** The interrupt is recorded in the Inbound Interrupt Status Register and may be masked 4376 ** by the Inbound Message Interrupt Mask bit in the Inbound Interrupt Mask Register. 4377 ** ----------------------------------------------------------------- 4378 ** Bit Default Description 4379 ** 31:00 0000 0000H Inbound Message - This is a 32-bit message written by an external PCI agent. 4380 ** When written, an interrupt to the Intel XScale core may be generated. 4381 ************************************************************************** 4382 */ 4383 #define ARCMSR_MU_INBOUND_MESSAGE_REG0 0x10 /*dword 0x13,0x12,0x11,0x10*/ 4384 #define ARCMSR_MU_INBOUND_MESSAGE_REG1 0x14 /*dword 0x17,0x16,0x15,0x14*/ 4385 /* 4386 ************************************************************************** 4387 ** Outbound Message Register - OMRx 4388 ** -------------------------------- 4389 ** There are two Outbound Message Registers: OMR0 and OMR1. When the OMR register is 4390 ** written, a PCI interrupt may be generated. The interrupt is recorded in the Outbound Interrupt 4391 ** Status Register and may be masked by the Outbound Message Interrupt Mask bit in the Outbound 4392 ** Interrupt Mask Register. 4393 ** 4394 ** Bit Default Description 4395 ** 31:00 00000000H Outbound Message - This is 32-bit message written by the Intel XScale core. When written, an 4396 ** interrupt may be generated on the PCI Interrupt pin determined by the ATU Interrupt Pin Register. 4397 ************************************************************************** 4398 */ 4399 #define ARCMSR_MU_OUTBOUND_MESSAGE_REG0 0x18 /*dword 0x1B,0x1A,0x19,0x18*/ 4400 #define ARCMSR_MU_OUTBOUND_MESSAGE_REG1 0x1C /*dword 0x1F,0x1E,0x1D,0x1C*/ 4401 /* 4402 ************************************************************************** 4403 ** Doorbell Registers 4404 ** ============================== 4405 ** There are two Doorbell Registers: 4406 ** Inbound Doorbell Register 4407 ** Outbound Doorbell Register 4408 ** The Inbound Doorbell Register allows external PCI agents to generate interrupts to the Intel R XScale core. 4409 ** The Outbound Doorbell Register allows the Intel R XScale core to generate a PCI interrupt. 4410 ** Both Doorbell Registers may generate interrupts whenever a bit in the register is set. 4411 ** 4412 ** Inbound Doorbells: 4413 ** ------------------ 4414 ** . When the Inbound Doorbell Register is written by an external PCI agent, an interrupt may be generated to the Intel R XScale core. 4415 ** An interrupt is generated when any of the bits in the doorbell register is written to a value of 1. 4416 ** 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. 4417 ** . Once a bit is set in the Inbound Doorbell Register, it cannot be cleared by any external PCI agent. 4418 ** The interrupt is recorded in the Inbound Interrupt Status Register. 4419 ** . The interrupt may be masked by the Inbound Doorbell Interrupt mask bit in the Inbound Interrupt Mask Register. 4420 ** When the mask bit is set for a particular bit, no interrupt is generated for that bit. 4421 ** The Inbound Interrupt Mask Register affects only the generation of the normal messaging unit interrupt 4422 ** and not the values written to the Inbound Doorbell Register. 4423 ** One bit in the Inbound Doorbell Register is reserved for an Error Doorbell interrupt. 4424 ** . 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. 4425 ** Writing a value of 0 to any bit does not change the value of that bit and does not clear the interrupt. 4426 ** ------------------------------------------------------------------------ 4427 ** Inbound Doorbell Register - IDR 4428 ** 4429 ** . The Inbound Doorbell Register (IDR) is used to generate interrupts to the Intel XScale core. 4430 ** . Bit 31 is reserved for generating an Error Doorbell interrupt. 4431 ** When bit 31 is set, an Error interrupt may be generated to the Intel XScale core. 4432 ** All other bits, when set, cause the Normal Messaging Unit interrupt line of the Intel XScale core to be asserted, 4433 ** when the interrupt is not masked by the Inbound Doorbell Interrupt Mask bit in the Inbound Interrupt Mask Register. 4434 ** 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. 4435 ** ------------------------------------------------------------------------ 4436 ** Bit Default Description 4437 ** 31 0 2 Error Interrupt - Generate an Error Interrupt to the Intel XScale core. 4438 ** 30:00 00000000H Normal Interrupt - When any bit is set, generate a Normal interrupt to the Intel XScale core. 4439 ** When all bits are clear, do not generate a Normal Interrupt. 4440 ************************************************************************** 4441 */ 4442 #define ARCMSR_MU_INBOUND_DOORBELL_REG 0x20 /*dword 0x23,0x22,0x21,0x20*/ 4443 /* 4444 ************************************************************************** 4445 ** Inbound Interrupt Status Register - IISR 4446 ** 4447 ** . The Inbound Interrupt Status Register (IISR) contains hardware interrupt status. 4448 ** It records the status of Intel XScale core interrupts generated by the Message Registers, Doorbell Registers, and the Circular Queues. 4449 ** All interrupts are routed to the Normal Messaging Unit interrupt input of the Intel XScale core, 4450 ** except for the Error Doorbell Interrupt and the Outbound Free Queue Full interrupt; 4451 ** these two are routed to the Messaging Unit Error interrupt input. 4452 ** The generation of interrupts recorded in the Inbound Interrupt Status Register 4453 ** may be masked by setting the corresponding bit in the Inbound Interrupt Mask Register. 4454 ** Some of the bits in this register are Read Only. 4455 ** For those bits, the interrupt must be cleared through another register. 4456 ** 4457 ** Bit Default Description 4458 ** 31:07 0000000H 0 2 Reserved 4459 ** 06 0 2 Index Register Interrupt - This bit is set by the MU hardware 4460 ** when an Index Register has been written after a PCI transaction. 4461 ** 05 0 2 Outbound Free Queue Full Interrupt - This bit is set 4462 ** when the Outbound Free Head Pointer becomes equal to the Tail Pointer and the queue is full. 4463 ** An Error interrupt is generated for this condition. 4464 ** 04 0 2 Inbound Post Queue Interrupt - This bit is set by the MU hardware when the Inbound Post Queue has been written. 4465 ** Once cleared, an interrupt does NOT be generated 4466 ** when the head and tail pointers remain unequal (i.e. queue status is Not Empty). 4467 ** Therefore, when software leaves any unprocessed messages in the post queue when the interrupt is cleared, 4468 ** software must retain the information that the Inbound Post queue status is not empty. 4469 ** NOTE: This interrupt is provided with dedicated support in the 80331 Interrupt Controller. 4470 ** 03 0 2 Error Doorbell Interrupt - This bit is set when the Error Interrupt of the Inbound Doorbell Register is set. 4471 ** To clear this bit (and the interrupt), the Error Interrupt bit of the Inbound Doorbell Register must be clear. 4472 ** 02 0 2 Inbound Doorbell Interrupt - This bit is set when at least one 4473 ** Normal Interrupt bit in the Inbound Doorbell Register is set. 4474 ** To clear this bit (and the interrupt), the Normal Interrupt bits in the Inbound Doorbell Register must all be clear. 4475 ** 01 0 2 Inbound Message 1 Interrupt - This bit is set by the MU hardware when the Inbound Message 1 Register has been written. 4476 ** 00 0 2 Inbound Message 0 Interrupt - This bit is set by the MU hardware when the Inbound Message 0 Register has been written. 4477 ************************************************************************** 4478 */ 4479 #define ARCMSR_MU_INBOUND_INTERRUPT_STATUS_REG 0x24 /*dword 0x27,0x26,0x25,0x24*/ 4480 #define ARCMSR_MU_INBOUND_INDEX_INT 0x40 4481 #define ARCMSR_MU_INBOUND_QUEUEFULL_INT 0x20 4482 #define ARCMSR_MU_INBOUND_POSTQUEUE_INT 0x10 4483 #define ARCMSR_MU_INBOUND_ERROR_DOORBELL_INT 0x08 4484 #define ARCMSR_MU_INBOUND_DOORBELL_INT 0x04 4485 #define ARCMSR_MU_INBOUND_MESSAGE1_INT 0x02 4486 #define ARCMSR_MU_INBOUND_MESSAGE0_INT 0x01 4487 /* 4488 ************************************************************************** 4489 ** Inbound Interrupt Mask Register - IIMR 4490 ** 4491 ** . The Inbound Interrupt Mask Register (IIMR) provides the ability to mask Intel XScale core interrupts generated by the Messaging Unit. 4492 ** Each bit in the Mask register corresponds to an interrupt bit in the Inbound Interrupt Status Register. 4493 ** Setting or clearing bits in this register does not affect the Inbound Interrupt Status Register. 4494 ** They only affect the generation of the Intel XScale core interrupt. 4495 ** ------------------------------------------------------------------------ 4496 ** Bit Default Description 4497 ** 31:07 000000H 0 2 Reserved 4498 ** 06 0 2 Index Register Interrupt Mask - When set, this bit masks the interrupt generated by the MU hardware 4499 ** when an Index Register has been written after a PCI transaction. 4500 ** 05 0 2 Outbound Free Queue Full Interrupt Mask - When set, this bit masks the Error interrupt generated 4501 ** when the Outbound Free Head Pointer becomes equal to the Tail Pointer and the queue is full. 4502 ** 04 0 2 Inbound Post Queue Interrupt Mask - When set, this bit masks the interrupt generated 4503 ** by the MU hardware when the Inbound Post Queue has been written. 4504 ** 03 0 2 Error Doorbell Interrupt Mask - When set, this bit masks the Error Interrupt 4505 ** when the Error Interrupt bit of the Inbound Doorbell Register is set. 4506 ** 02 0 2 Inbound Doorbell Interrupt Mask - When set, this bit masks the interrupt generated 4507 ** when at least one Normal Interrupt bit in the Inbound Doorbell Register is set. 4508 ** 01 0 2 Inbound Message 1 Interrupt Mask - When set, this bit masks the Inbound Message 1 4509 ** Interrupt generated by a write to the Inbound Message 1 Register. 4510 ** 00 0 2 Inbound Message 0 Interrupt Mask - When set, 4511 ** this bit masks the Inbound Message 0 Interrupt generated by a write to the Inbound Message 0 Register. 4512 ************************************************************************** 4513 */ 4514 #define ARCMSR_MU_INBOUND_INTERRUPT_MASK_REG 0x28 /*dword 0x2B,0x2A,0x29,0x28*/ 4515 #define ARCMSR_MU_INBOUND_INDEX_INTMASKENABLE 0x40 4516 #define ARCMSR_MU_INBOUND_QUEUEFULL_INTMASKENABLE 0x20 4517 #define ARCMSR_MU_INBOUND_POSTQUEUE_INTMASKENABLE 0x10 4518 #define ARCMSR_MU_INBOUND_DOORBELL_ERROR_INTMASKENABLE 0x08 4519 #define ARCMSR_MU_INBOUND_DOORBELL_INTMASKENABLE 0x04 4520 #define ARCMSR_MU_INBOUND_MESSAGE1_INTMASKENABLE 0x02 4521 #define ARCMSR_MU_INBOUND_MESSAGE0_INTMASKENABLE 0x01 4522 /* 4523 ************************************************************************** 4524 ** Outbound Doorbell Register - ODR 4525 ** 4526 ** The Outbound Doorbell Register (ODR) allows software interrupt generation. It allows the Intel 4527 ** XScale core to generate PCI interrupts to the host processor by writing to this register. The 4528 ** generation of PCI interrupts through the Outbound Doorbell Register may be masked by setting the 4529 ** Outbound Doorbell Interrupt Mask bit in the Outbound Interrupt Mask Register. 4530 ** The Software Interrupt bits in this register can only be set by the Intel XScale core and can only 4531 ** be cleared by an external PCI agent. 4532 ** ---------------------------------------------------------------------- 4533 ** Bit Default Description 4534 ** 31 0 2 Reserved 4535 ** 30 0 2 Reserved. 4536 ** 29 0 2 Reserved 4537 ** 28 0000 0000H PCI Interrupt - When set, this bit causes the P_INTC# interrupt output 4538 ** (P_INTA# with BRG_EN and ARB_EN straps low) 4539 ** signal to be asserted or a Message-signaled Interrupt is generated (when enabled). 4540 ** When this bit is cleared, the P_INTC# interrupt output 4541 ** (P_INTA# with BRG_EN and ARB_EN straps low) 4542 ** signal is deasserted. 4543 ** 27:00 000 0000H Software Interrupts - When any bit is set the P_INTC# interrupt output 4544 ** (P_INTA# with BRG_EN and ARB_EN straps low) 4545 ** signal is asserted or a Message-signaled Interrupt is generated (when enabled). 4546 ** When all bits are cleared, the P_INTC# interrupt output (P_INTA# with BRG_EN and ARB_EN straps low) 4547 ** signal is deasserted. 4548 ************************************************************************** 4549 */ 4550 #define ARCMSR_MU_OUTBOUND_DOORBELL_REG 0x2C /*dword 0x2F,0x2E,0x2D,0x2C*/ 4551 /* 4552 ************************************************************************** 4553 ** Outbound Interrupt Status Register - OISR 4554 ** 4555 ** The Outbound Interrupt Status Register (OISR) contains hardware interrupt status. It records the 4556 ** status of PCI interrupts generated by the Message Registers, Doorbell Registers, and the Circular 4557 ** Queues. The generation of PCI interrupts recorded in the Outbound Interrupt Status Register may 4558 ** be masked by setting the corresponding bit in the Outbound Interrupt Mask Register. Some of the 4559 ** bits in this register are Read Only. For those bits, the interrupt must be cleared through another 4560 ** register. 4561 ** ---------------------------------------------------------------------- 4562 ** Bit Default Description 4563 ** 31:05 000000H 000 2 Reserved 4564 ** 04 0 2 PCI Interrupt - This bit is set when the PCI Interrupt bit (bit 28) is set in the Outbound Doorbell Register. 4565 ** To clear this bit (and the interrupt), the PCI Interrupt bit must be cleared. 4566 ** 03 0 2 Outbound Post Queue Interrupt - This bit is set when data in the prefetch buffer is valid. This bit is 4567 ** cleared when any prefetch data has been read from the Outbound Queue Port. 4568 ** 02 0 2 Outbound Doorbell Interrupt - This bit is set when at least one Software Interrupt bit in the Outbound 4569 ** Doorbell Register is set. To clear this bit (and the interrupt), the Software Interrupt bits in the Outbound 4570 ** Doorbell Register must all be clear. 4571 ** 01 0 2 Outbound Message 1 Interrupt - This bit is set by the MU when the Outbound Message 1 Register is 4572 ** written. Clearing this bit clears the interrupt. 4573 ** 00 0 2 Outbound Message 0 Interrupt - This bit is set by the MU when the Outbound Message 0 Register is 4574 ** written. Clearing this bit clears the interrupt. 4575 ************************************************************************** 4576 */ 4577 #define ARCMSR_MU_OUTBOUND_INTERRUPT_STATUS_REG 0x30 /*dword 0x33,0x32,0x31,0x30*/ 4578 #define ARCMSR_MU_OUTBOUND_PCI_INT 0x10 4579 #define ARCMSR_MU_OUTBOUND_POSTQUEUE_INT 0x08 4580 #define ARCMSR_MU_OUTBOUND_DOORBELL_INT 0x04 4581 #define ARCMSR_MU_OUTBOUND_MESSAGE1_INT 0x02 4582 #define ARCMSR_MU_OUTBOUND_MESSAGE0_INT 0x01 4583 /* 4584 ************************************************************************** 4585 ** Outbound Interrupt Mask Register - OIMR 4586 ** The Outbound Interrupt Mask Register (OIMR) provides the ability to mask outbound PCI 4587 ** interrupts generated by the Messaging Unit. Each bit in the mask register corresponds to a 4588 ** hardware interrupt bit in the Outbound Interrupt Status Register. When the bit is set, the PCI 4589 ** interrupt is not generated. When the bit is clear, the interrupt is allowed to be generated. 4590 ** Setting or clearing bits in this register does not affect the Outbound Interrupt Status Register. They 4591 ** only affect the generation of the PCI interrupt. 4592 ** ---------------------------------------------------------------------- 4593 ** Bit Default Description 4594 ** 31:05 000000H Reserved 4595 ** 04 0 2 PCI Interrupt Mask - When set, this bit masks the interrupt generation when the PCI Interrupt bit (bit 28) 4596 ** in the Outbound Doorbell Register is set. 4597 ** 03 0 2 Outbound Post Queue Interrupt Mask - When set, this bit masks the interrupt generated when data in 4598 ** the prefetch buffer is valid. 4599 ** 02 0 2 Outbound Doorbell Interrupt Mask - When set, this bit masks the interrupt generated by the Outbound 4600 ** Doorbell Register. 4601 ** 01 0 2 Outbound Message 1 Interrupt Mask - When set, this bit masks the Outbound Message 1 Interrupt 4602 ** generated by a write to the Outbound Message 1 Register. 4603 ** 00 0 2 Outbound Message 0 Interrupt Mask- When set, this bit masks the Outbound Message 0 Interrupt 4604 ** generated by a write to the Outbound Message 0 Register. 4605 ************************************************************************** 4606 */ 4607 #define ARCMSR_MU_OUTBOUND_INTERRUPT_MASK_REG 0x34 /*dword 0x37,0x36,0x35,0x34*/ 4608 #define ARCMSR_MU_OUTBOUND_PCI_INTMASKENABLE 0x10 4609 #define ARCMSR_MU_OUTBOUND_POSTQUEUE_INTMASKENABLE 0x08 4610 #define ARCMSR_MU_OUTBOUND_DOORBELL_INTMASKENABLE 0x04 4611 #define ARCMSR_MU_OUTBOUND_MESSAGE1_INTMASKENABLE 0x02 4612 #define ARCMSR_MU_OUTBOUND_MESSAGE0_INTMASKENABLE 0x01 4613 #define ARCMSR_MU_OUTBOUND_ALL_INTMASKENABLE 0x1F 4614 /* 4615 ************************************************************************** 4616 ** 4617 ************************************************************************** 4618 */ 4619 #define ARCMSR_MU_INBOUND_QUEUE_PORT_REG 0x40 /*dword 0x43,0x42,0x41,0x40*/ 4620 #define ARCMSR_MU_OUTBOUND_QUEUE_PORT_REG 0x44 /*dword 0x47,0x46,0x45,0x44*/ 4621 /* 4622 ************************************************************************** 4623 ** Circular Queues 4624 ** ====================================================================== 4625 ** The MU implements four circular queues. There are 2 inbound queues and 2 outbound queues. In 4626 ** this case, inbound and outbound refer to the direction of the flow of posted messages. 4627 ** Inbound messages are either: 4628 ** �E posted messages by other processors for the Intel XScale core to process or 4629 ** �E free (or empty) messages that can be reused by other processors. 4630 ** Outbound messages are either: 4631 ** �E posted messages by the Intel XScale core for other processors to process or 4632 ** �E free (or empty) messages that can be reused by the Intel XScale core. 4633 ** Therefore, free inbound messages flow away from the 80331 and free outbound messages flow toward the 80331. 4634 ** The four Circular Queues are used to pass messages in the following manner. 4635 ** . The two inbound queues are used to handle inbound messages 4636 ** and the two outbound queues are used to handle outbound messages. 4637 ** . One of the inbound queues is designated the Free queue and it contains inbound free messages. 4638 ** The other inbound queue is designated the Post queue and it contains inbound posted messages. 4639 ** Similarly, one of the outbound queues is designated the Free queue and the other outbound queue is designated the Post queue. 4640 ** 4641 ** ============================================================================================================= 4642 ** Circular Queue Summary 4643 ** _____________________________________________________________________________________________________________ 4644 ** | Queue Name | Purpose | Action on PCI Interface| 4645 ** |______________________|____________________________________________________________|_________________________| 4646 ** |Inbound Post Queue | Queue for inbound messages from other processors | Written | 4647 ** | | waiting to be processed by the 80331 | | 4648 ** |Inbound Free Queue | Queue for empty inbound messages from the 80331 | Read | 4649 ** | | available for use by other processors | | 4650 ** |Outbound Post Queue | Queue for outbound messages from the 80331 | Read | 4651 ** | | that are being posted to the other processors | | 4652 ** |Outbound Free Queue | Queue for empty outbound messages from other processors | Written | 4653 ** | | available for use by the 80331 | | 4654 ** |______________________|____________________________________________________________|_________________________| 4655 ** 4656 ** . The two inbound queues allow the host processor to post inbound messages for the 80331 in one 4657 ** queue and to receive free messages returning from the 80331. 4658 ** The host processor posts inbound messages, 4659 ** the Intel XScale core receives the posted message and when it is finished with the message, 4660 ** places it back on the inbound free queue for reuse by the host processor. 4661 ** 4662 ** The circular queues are accessed by external PCI agents through two port locations in the PCI 4663 ** address space: 4664 ** Inbound Queue Port 4665 ** and Outbound Queue Port. 4666 ** The Inbound Queue Port is used by external PCI agents to read the Inbound Free Queue and write the Inbound Post Queue. 4667 ** The Outbound Queue Port is used by external PCI agents to read the Outbound Post Queue and write the Outbound Free Queue. 4668 ** Note that a PCI transaction to the inbound or outbound queue ports with null byte enables (P_C/BE[3:0]#=1111 2 ) 4669 ** does not cause the MU hardware to increment the queue pointers. 4670 ** This is treated as when the PCI transaction did not occur. 4671 ** The Inbound and Outbound Queue Ports never respond with P_ACK64# on the PCI interface. 4672 ** ====================================================================================== 4673 ** Overview of Circular Queue Operation 4674 ** ====================================================================================== 4675 ** . The data storage for the circular queues must be provided by the 80331 local memory. 4676 ** . The base address of the circular queues is contained in the Queue Base Address Register. 4677 ** Each entry in the queue is a 32-bit data value. 4678 ** . Each read from or write to the queue may access only one queue entry. 4679 ** . Multi-DWORD accesses to the circular queues are not allowed. 4680 ** Sub-DWORD accesses are promoted to DWORD accesses. 4681 ** . Each circular queue has a head pointer and a tail pointer. 4682 ** The pointers are offsets from the Queue Base Address. 4683 ** . Writes to a queue occur at the head of the queue and reads occur from the tail. 4684 ** The head and tail pointers are incremented by either the Intel XScale core or the Messaging Unit hardware. 4685 ** Which unit maintains the pointer is determined by the writer of the queue. 4686 ** More details about the pointers are given in the queue descriptions below. 4687 ** The pointers are incremented after the queue access. 4688 ** Both pointers wrap around to the first address of the circular queue when they reach the circular queue size. 4689 ** 4690 ** Messaging Unit... 4691 ** 4692 ** The Messaging Unit generates an interrupt to the Intel XScale core or generate a PCI interrupt under certain conditions. 4693 ** . In general, when a Post queue is written, an interrupt is generated to notify the receiver that a message was posted. 4694 ** The size of each circular queue can range from 4K entries (16 Kbytes) to 64K entries (256 Kbytes). 4695 ** . All four queues must be the same size and may be contiguous. 4696 ** Therefore, the total amount of local memory needed by the circular queues ranges from 64 Kbytes to 1 Mbytes. 4697 ** The Queue size is determined by the Queue Size field in the MU Configuration Register. 4698 ** . There is one base address for all four queues. 4699 ** It is stored in the Queue Base Address Register (QBAR). 4700 ** The starting addresses of each queue is based on the Queue Base Address and the Queue Size field. 4701 ** here shows an example of how the circular queues should be set up based on the 4702 ** Intelligent I/O (I 2 O) Architecture Specification. 4703 ** Other ordering of the circular queues is possible. 4704 ** 4705 ** Queue Starting Address 4706 ** Inbound Free Queue QBAR 4707 ** Inbound Post Queue QBAR + Queue Size 4708 ** Outbound Post Queue QBAR + 2 * Queue Size 4709 ** Outbound Free Queue QBAR + 3 * Queue Size 4710 ** =================================================================================== 4711 ** Inbound Post Queue 4712 ** ------------------ 4713 ** The Inbound Post Queue holds posted messages placed there by other processors for the Intel XScale core to process. 4714 ** This queue is read from the queue tail by the Intel XScale core. It is written to the queue head by external PCI agents. 4715 ** The tail pointer is maintained by the Intel XScale core. The head pointer is maintained by the MU hardware. 4716 ** For a PCI write transaction that accesses the Inbound Queue Port, 4717 ** the MU writes the data to the local memory location address in the Inbound Post Head Pointer Register. 4718 ** When the data written to the Inbound Queue Port is written to local memory, the MU hardware increments the Inbound Post Head Pointer Register. 4719 ** An Intel XScale core interrupt may be generated when the Inbound Post Queue is written. 4720 ** The Inbound Post Queue Interrupt bit in the Inbound Interrupt Status Register indicates the interrupt status. 4721 ** The interrupt is cleared when the Inbound Post Queue Interrupt bit is cleared. 4722 ** The interrupt can be masked by the Inbound Interrupt Mask Register. 4723 ** Software must be aware of the state of the Inbound Post Queue Interrupt Mask bit to guarantee 4724 ** that the full condition is recognized by the core processor. 4725 ** In addition, to guarantee that the queue does not get overwritten, 4726 ** software must process messages from the tail of the queue before incrementing the tail pointer and clearing this interrupt. 4727 ** Once cleared, an interrupt is NOT generated when the head and tail pointers remain unequal (i.e. queue status is Not Empty). 4728 ** Only a new message posting the in the inbound queue generates a new interrupt. 4729 ** Therefore, when software leaves any unprocessed messages in the post queue when the interrupt is cleared, 4730 ** software must retain the information that the Inbound Post queue status. 4731 ** From the time that the PCI write transaction is received until the data is written 4732 ** in local memory and the Inbound Post Head Pointer Register is incremented, 4733 ** any PCI transaction that attempts to access the Inbound Post Queue Port is signalled a Retry. 4734 ** The Intel XScale core may read messages from the Inbound Post Queue 4735 ** by reading the data from the local memory location pointed to by the Inbound Post Tail Pointer Register. 4736 ** The Intel XScale core must then increment the Inbound Post Tail Pointer Register. 4737 ** When the Inbound Post Queue is full (head and tail pointers are equal and the head pointer was last updated by hardware), 4738 ** the hardware retries any PCI writes until a slot in the queue becomes available. 4739 ** A slot in the post queue becomes available by the Intel XScale core incrementing the tail pointer. 4740 ** =================================================================================== 4741 ** Inbound Free Queue 4742 ** ------------------ 4743 ** The Inbound Free Queue holds free inbound messages placed there by the Intel XScale core for other processors to use. 4744 ** This queue is read from the queue tail by external PCI agents. 4745 ** It is written to the queue head by the Intel XScale core. 4746 ** The tail pointer is maintained by the MU hardware. 4747 ** The head pointer is maintained by the Intel XScale core. 4748 ** For a PCI read transaction that accesses the Inbound Queue Port, 4749 ** the MU attempts to read the data at the local memory address in the Inbound Free Tail Pointer. 4750 ** When the queue is not empty (head and tail pointers are not equal) 4751 ** or full (head and tail pointers are equal but the head pointer was last written by software), the data is returned. 4752 ** When the queue is empty (head and tail pointers are equal and the head pointer was last updated by hardware), 4753 ** the value of -1 (FFFF.FFFFH) is returned. 4754 ** When the queue was not empty and the MU succeeded in returning the data at the tail, 4755 ** the MU hardware must increment the value in the Inbound Free Tail Pointer Register. 4756 ** To reduce latency for the PCI read access, the MU implements a prefetch mechanism to anticipate accesses to the Inbound Free Queue. 4757 ** The MU hardware prefetches the data at the tail of the Inbound Free Queue and load it into an internal prefetch register. 4758 ** When the PCI read access occurs, the data is read directly from the prefetch register. 4759 ** The prefetch mechanism loads a value of -1 (FFFF.FFFFH) into the prefetch register 4760 ** when the head and tail pointers are equal and the queue is empty. 4761 ** In order to update the prefetch register when messages are added to the queue and it becomes non-empty, 4762 ** the prefetch mechanism automatically starts a prefetch when the prefetch register contains FFFF.FFFFH 4763 ** and the Inbound Free Head Pointer Register is written. 4764 ** The Intel XScale core needs to update the Inbound Free Head Pointer Register when it adds messages to the queue. 4765 ** A prefetch must appear atomic from the perspective of the external PCI agent. 4766 ** 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. 4767 ** The Intel XScale core may place messages in the Inbound Free Queue by writing the data to the 4768 ** local memory location pointed to by the Inbound Free Head Pointer Register. 4769 ** The processor must then increment the Inbound Free Head Pointer Register. 4770 ** ================================================================================== 4771 ** Outbound Post Queue 4772 ** ------------------- 4773 ** The Outbound Post Queue holds outbound posted messages placed there by the Intel XScale 4774 ** core for other processors to process. This queue is read from the queue tail by external PCI agents. 4775 ** It is written to the queue head by the Intel XScale core. The tail pointer is maintained by the 4776 ** MU hardware. The head pointer is maintained by the Intel XScale core. 4777 ** For a PCI read transaction that accesses the Outbound Queue Port, the MU attempts to read the 4778 ** data at the local memory address in the Outbound Post Tail Pointer Register. When the queue is not 4779 ** empty (head and tail pointers are not equal) or full (head and tail pointers are equal but the head 4780 ** pointer was last written by software), the data is returned. When the queue is empty (head and tail 4781 ** pointers are equal and the head pointer was last updated by hardware), the value of -1 4782 ** (FFFF.FFFFH) is returned. When the queue was not empty and the MU succeeded in returning the 4783 ** data at the tail, the MU hardware must increment the value in the Outbound Post Tail Pointer 4784 ** Register. 4785 ** To reduce latency for the PCI read access, the MU implements a prefetch mechanism to anticipate 4786 ** accesses to the Outbound Post Queue. The MU hardware prefetches the data at the tail of the 4787 ** Outbound Post Queue and load it into an internal prefetch register. When the PCI read access 4788 ** occurs, the data is read directly from the prefetch register. 4789 ** The prefetch mechanism loads a value of -1 (FFFF.FFFFH) into the prefetch register when the head 4790 ** and tail pointers are equal and the queue is empty. In order to update the prefetch register when 4791 ** messages are added to the queue and it becomes non-empty, the prefetch mechanism automatically 4792 ** starts a prefetch when the prefetch register contains FFFF.FFFFH and the Outbound Post Head 4793 ** Pointer Register is written. The Intel XScale core needs to update the Outbound Post Head 4794 ** Pointer Register when it adds messages to the queue. 4795 ** A prefetch must appear atomic from the perspective of the external PCI agent. When a prefetch is 4796 ** started, any PCI transaction that attempts to access the Outbound Post Queue is signalled a Retry 4797 ** until the prefetch is completed. 4798 ** A PCI interrupt may be generated when data in the prefetch buffer is valid. When the prefetch 4799 ** queue is clear, no interrupt is generated. The Outbound Post Queue Interrupt bit in the Outbound 4800 ** Interrupt Status Register shall indicate the status of the prefetch buffer data and therefore the 4801 ** interrupt status. The interrupt is cleared when any prefetched data has been read from the Outbound 4802 ** Queue Port. The interrupt can be masked by the Outbound Interrupt Mask Register. 4803 ** The Intel XScale core may place messages in the Outbound Post Queue by writing the data to 4804 ** the local memory address in the Outbound Post Head Pointer Register. The processor must then 4805 ** increment the Outbound Post Head Pointer Register. 4806 ** ================================================== 4807 ** Outbound Free Queue 4808 ** ----------------------- 4809 ** The Outbound Free Queue holds free messages placed there by other processors for the Intel 4810 ** XScale core to use. This queue is read from the queue tail by the Intel XScale core. It is 4811 ** written to the queue head by external PCI agents. The tail pointer is maintained by the Intel 4812 ** XScale core. The head pointer is maintained by the MU hardware. 4813 ** For a PCI write transaction that accesses the Outbound Queue Port, the MU writes the data to the 4814 ** local memory address in the Outbound Free Head Pointer Register. When the data written to the 4815 ** Outbound Queue Port is written to local memory, the MU hardware increments the Outbound Free 4816 ** Head Pointer Register. 4817 ** When the head pointer and the tail pointer become equal and the queue is full, the MU may signal 4818 ** an interrupt to the Intel XScale core to register the queue full condition. This interrupt is 4819 ** recorded in the Inbound Interrupt Status Register. The interrupt is cleared when the Outbound Free 4820 ** Queue Full Interrupt bit is cleared and not by writing to the head or tail pointers. The interrupt can 4821 ** be masked by the Inbound Interrupt Mask Register. Software must be aware of the state of the 4822 ** Outbound Free Queue Interrupt Mask bit to guarantee that the full condition is recognized by the 4823 ** core processor. 4824 ** From the time that a PCI write transaction is received until the data is written in local memory and 4825 ** the Outbound Free Head Pointer Register is incremented, any PCI transaction that attempts to 4826 ** access the Outbound Free Queue Port is signalled a retry. 4827 ** The Intel XScale core may read messages from the Outbound Free Queue by reading the data 4828 ** from the local memory address in the Outbound Free Tail Pointer Register. The processor must 4829 ** then increment the Outbound Free Tail Pointer Register. When the Outbound Free Queue is full, 4830 ** the hardware must retry any PCI writes until a slot in the queue becomes available. 4831 ** 4832 ** ================================================================================== 4833 ** Circular Queue Summary 4834 ** ---------------------- 4835 ** ________________________________________________________________________________________________________________________________________________ 4836 ** | Queue Name | PCI Port |Generate PCI Interrupt |Generate Intel Xscale Core Interrupt|Head Pointer maintained by|Tail Pointer maintained by| 4837 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________| 4838 ** |Inbound Post | Inbound Queue | | | | | 4839 ** | Queue | Port | NO | Yes, when queue is written | MU hardware | Intel XScale | 4840 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________| 4841 ** |Inbound Free | Inbound Queue | | | | | 4842 ** | Queue | Port | NO | NO | Intel XScale | MU hardware | 4843 ** |_____________|_______________|_______________________|____________________________________|__________________________|__________________________| 4844 ** ================================================================================== 4845 ** Circular Queue Status Summary 4846 ** ---------------------- 4847 ** ____________________________________________________________________________________________________ 4848 ** | Queue Name | Queue Status | Head & Tail Pointer | Last Pointer Update | 4849 ** |_____________________|________________|_____________________|_______________________________________| 4850 ** | Inbound Post Queue | Empty | Equal | Tail pointer last updated by software | 4851 ** |_____________________|________________|_____________________|_______________________________________| 4852 ** | Inbound Free Queue | Empty | Equal | Head pointer last updated by hardware | 4853 ** |_____________________|________________|_____________________|_______________________________________| 4854 ************************************************************************** 4855 */ 4856 4857 /* 4858 ************************************************************************** 4859 ** Index Registers 4860 ** ======================== 4861 ** . 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. 4862 ** These registers are for inbound messages only. 4863 ** The interrupt is recorded in the Inbound Interrupt Status Register. 4864 ** The storage for the Index Registers is allocated from the 80331 local memory. 4865 ** PCI write accesses to the Index Registers write the data to local memory. 4866 ** PCI read accesses to the Index Registers read the data from local memory. 4867 ** . The local memory used for the Index Registers ranges from Inbound ATU Translate Value Register + 050H 4868 ** to Inbound ATU Translate Value Register + FFFH. 4869 ** . The address of the first write access is stored in the Index Address Register. 4870 ** This register is written during the earliest write access and provides a means to determine which Index Register was written. 4871 ** Once updated by the MU, the Index Address Register is not updated until the Index Register 4872 ** Interrupt bit in the Inbound Interrupt Status Register is cleared. 4873 ** . When the interrupt is cleared, the Index Address Register is re-enabled and stores the address of the next Index Register write access. 4874 ** Writes by the Intel XScale core to the local memory used by the Index Registers 4875 ** does not cause an interrupt and does not update the Index Address Register. 4876 ** . The index registers can be accessed with Multi-DWORD reads and single QWORD aligned writes. 4877 ************************************************************************** 4878 */ 4879 /* 4880 ************************************************************************** 4881 ** Messaging Unit Internal Bus Memory Map 4882 ** ======================================= 4883 ** Internal Bus Address___Register Description (Name)____________________|_PCI Configuration Space Register Number_ 4884 ** FFFF E300H reserved | 4885 ** .. .. | 4886 ** FFFF E30CH reserved | 4887 ** FFFF E310H Inbound Message Register 0 | Available through 4888 ** FFFF E314H Inbound Message Register 1 | ATU Inbound Translation Window 4889 ** FFFF E318H Outbound Message Register 0 | 4890 ** FFFF E31CH Outbound Message Register 1 | or 4891 ** FFFF E320H Inbound Doorbell Register | 4892 ** FFFF E324H Inbound Interrupt Status Register | must translate PCI address to 4893 ** FFFF E328H Inbound Interrupt Mask Register | the Intel Xscale Core 4894 ** FFFF E32CH Outbound Doorbell Register | Memory-Mapped Address 4895 ** FFFF E330H Outbound Interrupt Status Register | 4896 ** FFFF E334H Outbound Interrupt Mask Register | 4897 ** ______________________________________________________________________|________________________________________ 4898 ** FFFF E338H reserved | 4899 ** FFFF E33CH reserved | 4900 ** FFFF E340H reserved | 4901 ** FFFF E344H reserved | 4902 ** FFFF E348H reserved | 4903 ** FFFF E34CH reserved | 4904 ** FFFF E350H MU Configuration Register | 4905 ** FFFF E354H Queue Base Address Register | 4906 ** FFFF E358H reserved | 4907 ** FFFF E35CH reserved | must translate PCI address to 4908 ** FFFF E360H Inbound Free Head Pointer Register | the Intel Xscale Core 4909 ** FFFF E364H Inbound Free Tail Pointer Register | Memory-Mapped Address 4910 ** FFFF E368H Inbound Post Head pointer Register | 4911 ** FFFF E36CH Inbound Post Tail Pointer Register | 4912 ** FFFF E370H Outbound Free Head Pointer Register | 4913 ** FFFF E374H Outbound Free Tail Pointer Register | 4914 ** FFFF E378H Outbound Post Head pointer Register | 4915 ** FFFF E37CH Outbound Post Tail Pointer Register | 4916 ** FFFF E380H Index Address Register | 4917 ** FFFF E384H reserved | 4918 ** .. .. | 4919 ** FFFF E3FCH reserved | 4920 ** ______________________________________________________________________|_______________________________________ 4921 ************************************************************************** 4922 */ 4923 /* 4924 ************************************************************************** 4925 ** MU Configuration Register - MUCR FFFF.E350H 4926 ** 4927 ** . The MU Configuration Register (MUCR) contains the Circular Queue Enable bit and the size of one Circular Queue. 4928 ** . The Circular Queue Enable bit enables or disables the Circular Queues. 4929 ** The Circular Queues are disabled at reset to allow the software to initialize the head 4930 ** and tail pointer registers before any PCI accesses to the Queue Ports. 4931 ** . Each Circular Queue may range from 4 K entries (16 Kbytes) to 64 K entries (256 Kbytes) and there are four Circular Queues. 4932 ** ------------------------------------------------------------------------ 4933 ** Bit Default Description 4934 ** 31:06 000000H 00 2 Reserved 4935 ** 05:01 00001 2 Circular Queue Size - This field determines the size of each Circular Queue. 4936 ** All four queues are the same size. 4937 ** �E 00001 2 - 4K Entries (16 Kbytes) 4938 ** �E 00010 2 - 8K Entries (32 Kbytes) 4939 ** �E 00100 2 - 16K Entries (64 Kbytes) 4940 ** �E 01000 2 - 32K Entries (128 Kbytes) 4941 ** �E 10000 2 - 64K Entries (256 Kbytes) 4942 ** 00 0 2 Circular Queue Enable - This bit enables or disables the Circular Queues. When clear the Circular 4943 ** Queues are disabled, however the MU accepts PCI accesses to the Circular Queue Ports but ignores 4944 ** the data for Writes and return FFFF.FFFFH for Reads. Interrupts are not generated to the core when 4945 ** disabled. When set, the Circular Queues are fully enabled. 4946 ************************************************************************** 4947 */ 4948 #define ARCMSR_MU_CONFIGURATION_REG 0xFFFFE350 4949 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE64K 0x0020 4950 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE32K 0x0010 4951 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE16K 0x0008 4952 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE8K 0x0004 4953 #define ARCMSR_MU_CIRCULAR_QUEUE_SIZE4K 0x0002 4954 #define ARCMSR_MU_CIRCULAR_QUEUE_ENABLE 0x0001 /*0:disable 1:enable*/ 4955 /* 4956 ************************************************************************** 4957 ** Queue Base Address Register - QBAR 4958 ** 4959 ** . The Queue Base Address Register (QBAR) contains the local memory address of the Circular Queues. 4960 ** The base address is required to be located on a 1 Mbyte address boundary. 4961 ** . All Circular Queue head and tail pointers are based on the QBAR. 4962 ** When the head and tail pointer registers are read, the Queue Base Address is returned in the upper 12 bits. 4963 ** 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. 4964 ** Warning: 4965 ** The QBAR must designate a range allocated to the 80331 DDR SDRAM interface 4966 ** ------------------------------------------------------------------------ 4967 ** Bit Default Description 4968 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 4969 ** 19:00 00000H Reserved 4970 ************************************************************************** 4971 */ 4972 #define ARCMSR_MU_QUEUE_BASE_ADDRESS_REG 0xFFFFE354 4973 /* 4974 ************************************************************************** 4975 ** Inbound Free Head Pointer Register - IFHPR 4976 ** 4977 ** . The Inbound Free Head Pointer Register (IFHPR) contains the local memory offset from 4978 ** the Queue Base Address of the head pointer for the Inbound Free Queue. 4979 ** The Head Pointer must be aligned on a DWORD address boundary. 4980 ** When read, the Queue Base Address is provided in the upper 12 bits of the register. 4981 ** Writes to the upper 12 bits of the register are ignored. 4982 ** This register is maintained by software. 4983 ** ------------------------------------------------------------------------ 4984 ** Bit Default Description 4985 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 4986 ** 19:02 0000H 00 2 Inbound Free Head Pointer - Local memory offset of the head pointer for the Inbound Free Queue. 4987 ** 01:00 00 2 Reserved 4988 ************************************************************************** 4989 */ 4990 #define ARCMSR_MU_INBOUND_FREE_HEAD_PTR_REG 0xFFFFE360 4991 /* 4992 ************************************************************************** 4993 ** Inbound Free Tail Pointer Register - IFTPR 4994 ** 4995 ** . The Inbound Free Tail Pointer Register (IFTPR) contains the local memory offset from the Queue 4996 ** Base Address of the tail pointer for the Inbound Free Queue. The Tail Pointer must be aligned on a 4997 ** DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits 4998 ** of the register. Writes to the upper 12 bits of the register are ignored. 4999 ** ------------------------------------------------------------------------ 5000 ** Bit Default Description 5001 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 5002 ** 19:02 0000H 00 2 Inbound Free Tail Pointer - Local memory offset of the tail pointer for the Inbound Free Queue. 5003 ** 01:00 00 2 Reserved 5004 ************************************************************************** 5005 */ 5006 #define ARCMSR_MU_INBOUND_FREE_TAIL_PTR_REG 0xFFFFE364 5007 /* 5008 ************************************************************************** 5009 ** Inbound Post Head Pointer Register - IPHPR 5010 ** 5011 ** . The Inbound Post Head Pointer Register (IPHPR) contains the local memory offset from the Queue 5012 ** Base Address of the head pointer for the Inbound Post Queue. The Head Pointer must be aligned on 5013 ** a DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits 5014 ** of the register. Writes to the upper 12 bits of the register are ignored. 5015 ** ------------------------------------------------------------------------ 5016 ** Bit Default Description 5017 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 5018 ** 19:02 0000H 00 2 Inbound Post Head Pointer - Local memory offset of the head pointer for the Inbound Post Queue. 5019 ** 01:00 00 2 Reserved 5020 ************************************************************************** 5021 */ 5022 #define ARCMSR_MU_INBOUND_POST_HEAD_PTR_REG 0xFFFFE368 5023 /* 5024 ************************************************************************** 5025 ** Inbound Post Tail Pointer Register - IPTPR 5026 ** 5027 ** . The Inbound Post Tail Pointer Register (IPTPR) contains the local memory offset from the Queue 5028 ** Base Address of the tail pointer for the Inbound Post Queue. The Tail Pointer must be aligned on a 5029 ** DWORD address boundary. When read, the Queue Base Address is provided in the upper 12 bits 5030 ** of the register. Writes to the upper 12 bits of the register are ignored. 5031 ** ------------------------------------------------------------------------ 5032 ** Bit Default Description 5033 ** 31:20 000H Queue Base Address - Local memory address of the circular queues. 5034 ** 19:02 0000H 00 2 Inbound Post Tail Pointer - Local memory offset of the tail pointer for the Inbound Post Queue. 5035 ** 01:00 00 2 Reserved 5036 ************************************************************************** 5037 */ 5038 #define ARCMSR_MU_INBOUND_POST_TAIL_PTR_REG 0xFFFFE36C 5039 /* 5040 ************************************************************************** 5041 ** Index Address Register - IAR 5042 ** 5043 ** . The Index Address Register (IAR) contains the offset of the least recently accessed Index Register. 5044 ** It is written by the MU when the Index Registers are written by a PCI agent. 5045 ** The register is not updated until the Index Interrupt bit in the Inbound Interrupt Status Register is cleared. 5046 ** . The local memory address of the Index Register least recently accessed is computed 5047 ** by adding the Index Address Register to the Inbound ATU Translate Value Register. 5048 ** ------------------------------------------------------------------------ 5049 ** Bit Default Description 5050 ** 31:12 000000H Reserved 5051 ** 11:02 00H 00 2 Index Address - is the local memory offset of the Index Register written (050H to FFCH) 5052 ** 01:00 00 2 Reserved 5053 ************************************************************************** 5054 */ 5055 #define ARCMSR_MU_LOCAL_MEMORY_INDEX_REG 0xFFFFE380 /*1004 dwords 0x0050....0x0FFC, 4016 bytes 0x0050...0x0FFF*/ 5056 /* 5057 ********************************************************************************************************** 5058 ** RS-232 Interface for Areca Raid Controller 5059 ** The low level command interface is exclusive with VT100 terminal 5060 ** -------------------------------------------------------------------- 5061 ** 1. Sequence of command execution 5062 ** -------------------------------------------------------------------- 5063 ** (A) Header : 3 bytes sequence (0x5E, 0x01, 0x61) 5064 ** (B) Command block : variable length of data including length, command code, data and checksum byte 5065 ** (C) Return data : variable length of data 5066 ** -------------------------------------------------------------------- 5067 ** 2. Command block 5068 ** -------------------------------------------------------------------- 5069 ** (A) 1st byte : command block length (low byte) 5070 ** (B) 2nd byte : command block length (high byte) 5071 ** note ..command block length shouldn't > 2040 bytes, length excludes these two bytes 5072 ** (C) 3rd byte : command code 5073 ** (D) 4th and following bytes : variable length data bytes depends on command code 5074 ** (E) last byte : checksum byte (sum of 1st byte until last data byte) 5075 ** -------------------------------------------------------------------- 5076 ** 3. Command code and associated data 5077 ** -------------------------------------------------------------------- 5078 ** The following are command code defined in raid controller Command code 0x10--0x1? are used for system level management, 5079 ** no password checking is needed and should be implemented in separate well controlled utility and not for end user access. 5080 ** Command code 0x20--0x?? always check the password, password must be entered to enable these command. 5081 ** enum 5082 ** { 5083 ** GUI_SET_SERIAL=0x10, 5084 ** GUI_SET_VENDOR, 5085 ** GUI_SET_MODEL, 5086 ** GUI_IDENTIFY, 5087 ** GUI_CHECK_PASSWORD, 5088 ** GUI_LOGOUT, 5089 ** GUI_HTTP, 5090 ** GUI_SET_ETHERNET_ADDR, 5091 ** GUI_SET_LOGO, 5092 ** GUI_POLL_EVENT, 5093 ** GUI_GET_EVENT, 5094 ** GUI_GET_HW_MONITOR, 5095 ** 5096 ** // GUI_QUICK_CREATE=0x20, (function removed) 5097 ** GUI_GET_INFO_R=0x20, 5098 ** GUI_GET_INFO_V, 5099 ** GUI_GET_INFO_P, 5100 ** GUI_GET_INFO_S, 5101 ** GUI_CLEAR_EVENT, 5102 ** 5103 ** GUI_MUTE_BEEPER=0x30, 5104 ** GUI_BEEPER_SETTING, 5105 ** GUI_SET_PASSWORD, 5106 ** GUI_HOST_INTERFACE_MODE, 5107 ** GUI_REBUILD_PRIORITY, 5108 ** GUI_MAX_ATA_MODE, 5109 ** GUI_RESET_CONTROLLER, 5110 ** GUI_COM_PORT_SETTING, 5111 ** GUI_NO_OPERATION, 5112 ** GUI_DHCP_IP, 5113 ** 5114 ** GUI_CREATE_PASS_THROUGH=0x40, 5115 ** GUI_MODIFY_PASS_THROUGH, 5116 ** GUI_DELETE_PASS_THROUGH, 5117 ** GUI_IDENTIFY_DEVICE, 5118 ** 5119 ** GUI_CREATE_RAIDSET=0x50, 5120 ** GUI_DELETE_RAIDSET, 5121 ** GUI_EXPAND_RAIDSET, 5122 ** GUI_ACTIVATE_RAIDSET, 5123 ** GUI_CREATE_HOT_SPARE, 5124 ** GUI_DELETE_HOT_SPARE, 5125 ** 5126 ** GUI_CREATE_VOLUME=0x60, 5127 ** GUI_MODIFY_VOLUME, 5128 ** GUI_DELETE_VOLUME, 5129 ** GUI_START_CHECK_VOLUME, 5130 ** GUI_STOP_CHECK_VOLUME 5131 ** }; 5132 ** 5133 ** Command description : 5134 ** 5135 ** GUI_SET_SERIAL : Set the controller serial# 5136 ** byte 0,1 : length 5137 ** byte 2 : command code 0x10 5138 ** byte 3 : password length (should be 0x0f) 5139 ** byte 4-0x13 : should be "ArEcATecHnoLogY" 5140 ** byte 0x14--0x23 : Serial number string (must be 16 bytes) 5141 ** GUI_SET_VENDOR : Set vendor string for the controller 5142 ** byte 0,1 : length 5143 ** byte 2 : command code 0x11 5144 ** byte 3 : password length (should be 0x08) 5145 ** byte 4-0x13 : should be "ArEcAvAr" 5146 ** byte 0x14--0x3B : vendor string (must be 40 bytes) 5147 ** GUI_SET_MODEL : Set the model name of the controller 5148 ** byte 0,1 : length 5149 ** byte 2 : command code 0x12 5150 ** byte 3 : password length (should be 0x08) 5151 ** byte 4-0x13 : should be "ArEcAvAr" 5152 ** byte 0x14--0x1B : model string (must be 8 bytes) 5153 ** GUI_IDENTIFY : Identify device 5154 ** byte 0,1 : length 5155 ** byte 2 : command code 0x13 5156 ** return "Areca RAID Subsystem " 5157 ** GUI_CHECK_PASSWORD : Verify password 5158 ** byte 0,1 : length 5159 ** byte 2 : command code 0x14 5160 ** byte 3 : password length 5161 ** byte 4-0x?? : user password to be checked 5162 ** GUI_LOGOUT : Logout GUI (force password checking on next command) 5163 ** byte 0,1 : length 5164 ** byte 2 : command code 0x15 5165 ** GUI_HTTP : HTTP interface (reserved for Http proxy service)(0x16) 5166 ** 5167 ** GUI_SET_ETHERNET_ADDR : Set the ethernet MAC address 5168 ** byte 0,1 : length 5169 ** byte 2 : command code 0x17 5170 ** byte 3 : password length (should be 0x08) 5171 ** byte 4-0x13 : should be "ArEcAvAr" 5172 ** byte 0x14--0x19 : Ethernet MAC address (must be 6 bytes) 5173 ** GUI_SET_LOGO : Set logo in HTTP 5174 ** byte 0,1 : length 5175 ** byte 2 : command code 0x18 5176 ** byte 3 : Page# (0/1/2/3) (0xff --> clear OEM logo) 5177 ** byte 4/5/6/7 : 0x55/0xaa/0xa5/0x5a 5178 ** byte 8 : TITLE.JPG data (each page must be 2000 bytes) 5179 ** note .... page0 1st 2 byte must be actual length of the JPG file 5180 ** GUI_POLL_EVENT : Poll If Event Log Changed 5181 ** byte 0,1 : length 5182 ** byte 2 : command code 0x19 5183 ** GUI_GET_EVENT : Read Event 5184 ** byte 0,1 : length 5185 ** byte 2 : command code 0x1a 5186 ** byte 3 : Event Page (0:1st page/1/2/3:last page) 5187 ** GUI_GET_HW_MONITOR : Get HW monitor data 5188 ** byte 0,1 : length 5189 ** byte 2 : command code 0x1b 5190 ** byte 3 : # of FANs(example 2) 5191 ** byte 4 : # of Voltage sensor(example 3) 5192 ** byte 5 : # of temperature sensor(example 2) 5193 ** byte 6 : # of power 5194 ** byte 7/8 : Fan#0 (RPM) 5195 ** byte 9/10 : Fan#1 5196 ** byte 11/12 : Voltage#0 original value in *1000 5197 ** byte 13/14 : Voltage#0 value 5198 ** byte 15/16 : Voltage#1 org 5199 ** byte 17/18 : Voltage#1 5200 ** byte 19/20 : Voltage#2 org 5201 ** byte 21/22 : Voltage#2 5202 ** byte 23 : Temp#0 5203 ** byte 24 : Temp#1 5204 ** byte 25 : Power indicator (bit0 : power#0, bit1 : power#1) 5205 ** byte 26 : UPS indicator 5206 ** GUI_QUICK_CREATE : Quick create raid/volume set 5207 ** byte 0,1 : length 5208 ** byte 2 : command code 0x20 5209 ** byte 3/4/5/6 : raw capacity 5210 ** byte 7 : raid level 5211 ** byte 8 : stripe size 5212 ** byte 9 : spare 5213 ** byte 10/11/12/13: device mask (the devices to create raid/volume) 5214 ** This function is removed, application like to implement quick create function 5215 ** need to use GUI_CREATE_RAIDSET and GUI_CREATE_VOLUMESET function. 5216 ** GUI_GET_INFO_R : Get Raid Set Information 5217 ** byte 0,1 : length 5218 ** byte 2 : command code 0x20 5219 ** byte 3 : raidset# 5220 ** 5221 ** typedef struct sGUI_RAIDSET 5222 ** { 5223 ** BYTE grsRaidSetName[16]; 5224 ** DWORD grsCapacity; 5225 ** DWORD grsCapacityX; 5226 ** DWORD grsFailMask; 5227 ** BYTE grsDevArray[32]; 5228 ** BYTE grsMemberDevices; 5229 ** BYTE grsNewMemberDevices; 5230 ** BYTE grsRaidState; 5231 ** BYTE grsVolumes; 5232 ** BYTE grsVolumeList[16]; 5233 ** BYTE grsRes1; 5234 ** BYTE grsRes2; 5235 ** BYTE grsRes3; 5236 ** BYTE grsFreeSegments; 5237 ** DWORD grsRawStripes[8]; 5238 ** DWORD grsRes4; 5239 ** DWORD grsRes5; // Total to 128 bytes 5240 ** DWORD grsRes6; // Total to 128 bytes 5241 ** } sGUI_RAIDSET, *pGUI_RAIDSET; 5242 ** GUI_GET_INFO_V : Get Volume Set Information 5243 ** byte 0,1 : length 5244 ** byte 2 : command code 0x21 5245 ** byte 3 : volumeset# 5246 ** 5247 ** typedef struct sGUI_VOLUMESET 5248 ** { 5249 ** BYTE gvsVolumeName[16]; // 16 5250 ** DWORD gvsCapacity; 5251 ** DWORD gvsCapacityX; 5252 ** DWORD gvsFailMask; 5253 ** DWORD gvsStripeSize; 5254 ** DWORD gvsNewFailMask; 5255 ** DWORD gvsNewStripeSize; 5256 ** DWORD gvsVolumeStatus; 5257 ** DWORD gvsProgress; // 32 5258 ** sSCSI_ATTR gvsScsi; 5259 ** BYTE gvsMemberDisks; 5260 ** BYTE gvsRaidLevel; // 8 5261 ** 5262 ** BYTE gvsNewMemberDisks; 5263 ** BYTE gvsNewRaidLevel; 5264 ** BYTE gvsRaidSetNumber; 5265 ** BYTE gvsRes0; // 4 5266 ** BYTE gvsRes1[4]; // 64 bytes 5267 ** } sGUI_VOLUMESET, *pGUI_VOLUMESET; 5268 ** 5269 ** GUI_GET_INFO_P : Get Physical Drive Information 5270 ** byte 0,1 : length 5271 ** byte 2 : command code 0x22 5272 ** byte 3 : drive # (from 0 to max-channels - 1) 5273 ** 5274 ** typedef struct sGUI_PHY_DRV 5275 ** { 5276 ** BYTE gpdModelName[40]; 5277 ** BYTE gpdSerialNumber[20]; 5278 ** BYTE gpdFirmRev[8]; 5279 ** DWORD gpdCapacity; 5280 ** DWORD gpdCapacityX; // Reserved for expansion 5281 ** BYTE gpdDeviceState; 5282 ** BYTE gpdPioMode; 5283 ** BYTE gpdCurrentUdmaMode; 5284 ** BYTE gpdUdmaMode; 5285 ** BYTE gpdDriveSelect; 5286 ** BYTE gpdRaidNumber; // 0xff if not belongs to a raid set 5287 ** sSCSI_ATTR gpdScsi; 5288 ** BYTE gpdReserved[40]; // Total to 128 bytes 5289 ** } sGUI_PHY_DRV, *pGUI_PHY_DRV; 5290 ** 5291 ** GUI_GET_INFO_S : Get System Information 5292 ** byte 0,1 : length 5293 ** byte 2 : command code 0x23 5294 ** 5295 ** typedef struct sCOM_ATTR 5296 ** { 5297 ** BYTE comBaudRate; 5298 ** BYTE comDataBits; 5299 ** BYTE comStopBits; 5300 ** BYTE comParity; 5301 ** BYTE comFlowControl; 5302 ** } sCOM_ATTR, *pCOM_ATTR; 5303 ** 5304 ** typedef struct sSYSTEM_INFO 5305 ** { 5306 ** BYTE gsiVendorName[40]; 5307 ** BYTE gsiSerialNumber[16]; 5308 ** BYTE gsiFirmVersion[16]; 5309 ** BYTE gsiBootVersion[16]; 5310 ** BYTE gsiMbVersion[16]; 5311 ** BYTE gsiModelName[8]; 5312 ** BYTE gsiLocalIp[4]; 5313 ** BYTE gsiCurrentIp[4]; 5314 ** DWORD gsiTimeTick; 5315 ** DWORD gsiCpuSpeed; 5316 ** DWORD gsiICache; 5317 ** DWORD gsiDCache; 5318 ** DWORD gsiScache; 5319 ** DWORD gsiMemorySize; 5320 ** DWORD gsiMemorySpeed; 5321 ** DWORD gsiEvents; 5322 ** BYTE gsiMacAddress[6]; 5323 ** BYTE gsiDhcp; 5324 ** BYTE gsiBeeper; 5325 ** BYTE gsiChannelUsage; 5326 ** BYTE gsiMaxAtaMode; 5327 ** BYTE gsiSdramEcc; // 1:if ECC enabled 5328 ** BYTE gsiRebuildPriority; 5329 ** sCOM_ATTR gsiComA; // 5 bytes 5330 ** sCOM_ATTR gsiComB; // 5 bytes 5331 ** BYTE gsiIdeChannels; 5332 ** BYTE gsiScsiHostChannels; 5333 ** BYTE gsiIdeHostChannels; 5334 ** BYTE gsiMaxVolumeSet; 5335 ** BYTE gsiMaxRaidSet; 5336 ** BYTE gsiEtherPort; // 1:if ether net port supported 5337 ** BYTE gsiRaid6Engine; // 1:Raid6 engine supported 5338 ** BYTE gsiRes[75]; 5339 ** } sSYSTEM_INFO, *pSYSTEM_INFO; 5340 ** 5341 ** GUI_CLEAR_EVENT : Clear System Event 5342 ** byte 0,1 : length 5343 ** byte 2 : command code 0x24 5344 ** 5345 ** GUI_MUTE_BEEPER : Mute current beeper 5346 ** byte 0,1 : length 5347 ** byte 2 : command code 0x30 5348 ** 5349 ** GUI_BEEPER_SETTING : Disable beeper 5350 ** byte 0,1 : length 5351 ** byte 2 : command code 0x31 5352 ** byte 3 : 0->disable, 1->enable 5353 ** 5354 ** GUI_SET_PASSWORD : Change password 5355 ** byte 0,1 : length 5356 ** byte 2 : command code 0x32 5357 ** byte 3 : pass word length ( must <= 15 ) 5358 ** byte 4 : password (must be alpha-numerical) 5359 ** 5360 ** GUI_HOST_INTERFACE_MODE : Set host interface mode 5361 ** byte 0,1 : length 5362 ** byte 2 : command code 0x33 5363 ** byte 3 : 0->Independent, 1->cluster 5364 ** 5365 ** GUI_REBUILD_PRIORITY : Set rebuild priority 5366 ** byte 0,1 : length 5367 ** byte 2 : command code 0x34 5368 ** byte 3 : 0/1/2/3 (low->high) 5369 ** 5370 ** GUI_MAX_ATA_MODE : Set maximum ATA mode to be used 5371 ** byte 0,1 : length 5372 ** byte 2 : command code 0x35 5373 ** byte 3 : 0/1/2/3 (133/100/66/33) 5374 ** 5375 ** GUI_RESET_CONTROLLER : Reset Controller 5376 ** byte 0,1 : length 5377 ** byte 2 : command code 0x36 5378 ** *Response with VT100 screen (discard it) 5379 ** 5380 ** GUI_COM_PORT_SETTING : COM port setting 5381 ** byte 0,1 : length 5382 ** byte 2 : command code 0x37 5383 ** byte 3 : 0->COMA (term port), 1->COMB (debug port) 5384 ** byte 4 : 0/1/2/3/4/5/6/7 (1200/2400/4800/9600/19200/38400/57600/115200) 5385 ** byte 5 : data bit (0:7 bit, 1:8 bit : must be 8 bit) 5386 ** byte 6 : stop bit (0:1, 1:2 stop bits) 5387 ** byte 7 : parity (0:none, 1:off, 2:even) 5388 ** byte 8 : flow control (0:none, 1:xon/xoff, 2:hardware => must use none) 5389 ** 5390 ** GUI_NO_OPERATION : No operation 5391 ** byte 0,1 : length 5392 ** byte 2 : command code 0x38 5393 ** 5394 ** GUI_DHCP_IP : Set DHCP option and local IP address 5395 ** byte 0,1 : length 5396 ** byte 2 : command code 0x39 5397 ** byte 3 : 0:dhcp disabled, 1:dhcp enabled 5398 ** byte 4/5/6/7 : IP address 5399 ** 5400 ** GUI_CREATE_PASS_THROUGH : Create pass through disk 5401 ** byte 0,1 : length 5402 ** byte 2 : command code 0x40 5403 ** byte 3 : device # 5404 ** byte 4 : scsi channel (0/1) 5405 ** byte 5 : scsi id (0-->15) 5406 ** byte 6 : scsi lun (0-->7) 5407 ** byte 7 : tagged queue (1 : enabled) 5408 ** byte 8 : cache mode (1 : enabled) 5409 ** byte 9 : max speed (0/1/2/3/4, async/20/40/80/160 for scsi) 5410 ** (0/1/2/3/4, 33/66/100/133/150 for ide ) 5411 ** 5412 ** GUI_MODIFY_PASS_THROUGH : Modify pass through disk 5413 ** byte 0,1 : length 5414 ** byte 2 : command code 0x41 5415 ** byte 3 : device # 5416 ** byte 4 : scsi channel (0/1) 5417 ** byte 5 : scsi id (0-->15) 5418 ** byte 6 : scsi lun (0-->7) 5419 ** byte 7 : tagged queue (1 : enabled) 5420 ** byte 8 : cache mode (1 : enabled) 5421 ** byte 9 : max speed (0/1/2/3/4, async/20/40/80/160 for scsi) 5422 ** (0/1/2/3/4, 33/66/100/133/150 for ide ) 5423 ** 5424 ** GUI_DELETE_PASS_THROUGH : Delete pass through disk 5425 ** byte 0,1 : length 5426 ** byte 2 : command code 0x42 5427 ** byte 3 : device# to be deleted 5428 ** 5429 ** GUI_IDENTIFY_DEVICE : Identify Device 5430 ** byte 0,1 : length 5431 ** byte 2 : command code 0x43 5432 ** byte 3 : Flash Method(0:flash selected, 1:flash not selected) 5433 ** byte 4/5/6/7 : IDE device mask to be flashed 5434 ** note .... no response data available 5435 ** 5436 ** GUI_CREATE_RAIDSET : Create Raid Set 5437 ** byte 0,1 : length 5438 ** byte 2 : command code 0x50 5439 ** byte 3/4/5/6 : device mask 5440 ** byte 7-22 : raidset name (if byte 7 == 0:use default) 5441 ** 5442 ** GUI_DELETE_RAIDSET : Delete Raid Set 5443 ** byte 0,1 : length 5444 ** byte 2 : command code 0x51 5445 ** byte 3 : raidset# 5446 ** 5447 ** GUI_EXPAND_RAIDSET : Expand Raid Set 5448 ** byte 0,1 : length 5449 ** byte 2 : command code 0x52 5450 ** byte 3 : raidset# 5451 ** byte 4/5/6/7 : device mask for expansion 5452 ** 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 ) 5453 ** byte 11/12/13 : repeat for each volume in the raidset .... 5454 ** 5455 ** GUI_ACTIVATE_RAIDSET : Activate incomplete raid set 5456 ** byte 0,1 : length 5457 ** byte 2 : command code 0x53 5458 ** byte 3 : raidset# 5459 ** 5460 ** GUI_CREATE_HOT_SPARE : Create hot spare disk 5461 ** byte 0,1 : length 5462 ** byte 2 : command code 0x54 5463 ** byte 3/4/5/6 : device mask for hot spare creation 5464 ** 5465 ** GUI_DELETE_HOT_SPARE : Delete hot spare disk 5466 ** byte 0,1 : length 5467 ** byte 2 : command code 0x55 5468 ** byte 3/4/5/6 : device mask for hot spare deletion 5469 ** 5470 ** GUI_CREATE_VOLUME : Create volume set 5471 ** byte 0,1 : length 5472 ** byte 2 : command code 0x60 5473 ** byte 3 : raidset# 5474 ** byte 4-19 : volume set name (if byte4 == 0, use default) 5475 ** byte 20-27 : volume capacity (blocks) 5476 ** byte 28 : raid level 5477 ** byte 29 : stripe size (0/1/2/3/4/5->4/8/16/32/64/128K) 5478 ** byte 30 : channel 5479 ** byte 31 : ID 5480 ** byte 32 : LUN 5481 ** byte 33 : 1 enable tag 5482 ** byte 34 : 1 enable cache 5483 ** byte 35 : speed (0/1/2/3/4->async/20/40/80/160 for scsi) 5484 ** (0/1/2/3/4->33/66/100/133/150 for IDE ) 5485 ** byte 36 : 1 to select quick init 5486 ** 5487 ** GUI_MODIFY_VOLUME : Modify volume Set 5488 ** byte 0,1 : length 5489 ** byte 2 : command code 0x61 5490 ** byte 3 : volumeset# 5491 ** byte 4-19 : new volume set name (if byte4 == 0, not change) 5492 ** byte 20-27 : new volume capacity (reserved) 5493 ** byte 28 : new raid level 5494 ** byte 29 : new stripe size (0/1/2/3/4/5->4/8/16/32/64/128K) 5495 ** byte 30 : new channel 5496 ** byte 31 : new ID 5497 ** byte 32 : new LUN 5498 ** byte 33 : 1 enable tag 5499 ** byte 34 : 1 enable cache 5500 ** byte 35 : speed (0/1/2/3/4->async/20/40/80/160 for scsi) 5501 ** (0/1/2/3/4->33/66/100/133/150 for IDE ) 5502 ** 5503 ** GUI_DELETE_VOLUME : Delete volume set 5504 ** byte 0,1 : length 5505 ** byte 2 : command code 0x62 5506 ** byte 3 : volumeset# 5507 ** 5508 ** GUI_START_CHECK_VOLUME : Start volume consistency check 5509 ** byte 0,1 : length 5510 ** byte 2 : command code 0x63 5511 ** byte 3 : volumeset# 5512 ** 5513 ** GUI_STOP_CHECK_VOLUME : Stop volume consistency check 5514 ** byte 0,1 : length 5515 ** byte 2 : command code 0x64 5516 ** --------------------------------------------------------------------- 5517 ** 4. Returned data 5518 ** --------------------------------------------------------------------- 5519 ** (A) Header : 3 bytes sequence (0x5E, 0x01, 0x61) 5520 ** (B) Length : 2 bytes (low byte 1st, excludes length and checksum byte) 5521 ** (C) status or data : 5522 ** <1> If length == 1 ==> 1 byte status code 5523 ** #define GUI_OK 0x41 5524 ** #define GUI_RAIDSET_NOT_NORMAL 0x42 5525 ** #define GUI_VOLUMESET_NOT_NORMAL 0x43 5526 ** #define GUI_NO_RAIDSET 0x44 5527 ** #define GUI_NO_VOLUMESET 0x45 5528 ** #define GUI_NO_PHYSICAL_DRIVE 0x46 5529 ** #define GUI_PARAMETER_ERROR 0x47 5530 ** #define GUI_UNSUPPORTED_COMMAND 0x48 5531 ** #define GUI_DISK_CONFIG_CHANGED 0x49 5532 ** #define GUI_INVALID_PASSWORD 0x4a 5533 ** #define GUI_NO_DISK_SPACE 0x4b 5534 ** #define GUI_CHECKSUM_ERROR 0x4c 5535 ** #define GUI_PASSWORD_REQUIRED 0x4d 5536 ** <2> If length > 1 ==> data block returned from controller and the contents depends on the command code 5537 ** (E) Checksum : checksum of length and status or data byte 5538 ************************************************************************** 5539 */ 5540