1 /* $NetBSD: twareg.h,v 1.9 2008/05/08 11:27:54 joerg Exp $ */
2 /* $wasabi: twareg.h,v 1.14 2006/07/28 18:29:51 wrstuden Exp $ */
5 * Copyright (c) 2003-04 3ware, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $FreeBSD: src/sys/dev/twa/twa_reg.h,v 1.2 2004/08/18 16:14:44 vkashyap Exp $
33 * 3ware driver for 9000 series storage controllers.
35 * Author: Vinod Kashyap
38 #ifndef _PCI_TWAREG_H_
39 #define _PCI_TWAREG_H_
45 * The following macro has no business being in twa_reg.h. It should probably
46 * be defined in twa_includes.h, before the #include twa_reg.h.... But that
47 * causes the API to run into build errors. Will leave it here for now...
49 #define TWA_64BIT_ADDRESSES ((sizeof(bus_addr_t) == 8) ? 1 : 0)
52 * Define the following here since it relies on TWA_64BIT_ADDRESSES which
53 * depends on sizeof(bus_addr_t), which is not exported to userland.
54 * The userland API shouldn't care about the kernel's bus_addr_t.
55 * For the userland API, use the array size that we would use for 32-bit
56 * addresses since that's what we use in the sg structure definition.
57 * The userland API does not actually appear to use the array, but it
58 * does include the array in various command structures.
60 #define TWA_MAX_SG_ELEMENTS (TWA_64BIT_ADDRESSES ? 70 : 105)
62 #define TWA_MAX_SG_ELEMENTS 105
67 #define TWAQ_PENDING 2
68 #define TWAQ_COMPLETE 3
69 #define TWAQ_IO_PENDING 4
70 #define TWAQ_COUNT 5 /* total number of queues */
72 #define TWA_DRIVER_VERSION_STRING "1.00.00.000"
74 #define TWA_REQUEST_TIMEOUT_PERIOD 60 /* seconds */
76 #define TWA_MESSAGE_SOURCE_CONTROLLER_ERROR 3
78 /* Register offsets from base address. */
79 #define TWA_CONTROL_REGISTER_OFFSET 0x0
80 #define TWA_STATUS_REGISTER_OFFSET 0x4
81 #define TWA_COMMAND_QUEUE_OFFSET 0x8
82 #define TWA_RESPONSE_QUEUE_OFFSET 0xC
83 #define TWA_COMMAND_QUEUE_OFFSET_LOW 0x20
84 #define TWA_COMMAND_QUEUE_OFFSET_HIGH 0x24
85 #define TWA_RESPONSE_QUEUE_LARGE_OFFSET 0x30
88 #define TWA_WRITE_REGISTER(sc, offset, val) \
89 bus_space_write_4(sc->twa_bus_iot, sc->twa_bus_ioh, offset, (uint32_t)val)
91 #define TWA_WRITE_COMMAND_QUEUE(sc, val) \
93 if (TWA_64BIT_ADDRESSES) { \
94 /* First write the low 4 bytes, then the high 4. */ \
95 TWA_WRITE_REGISTER(sc, TWA_COMMAND_QUEUE_OFFSET_LOW, \
97 TWA_WRITE_REGISTER(sc, TWA_COMMAND_QUEUE_OFFSET_HIGH,\
98 (uint32_t)(((uint64_t)val)>>32)); \
100 TWA_WRITE_REGISTER(sc, TWA_COMMAND_QUEUE_OFFSET,\
105 #define TWA_WRITE_9650_COMMAND_QUEUE_HIGH(sc, val) \
107 TWA_WRITE_REGISTER(sc, TWA_COMMAND_QUEUE_OFFSET_HIGH, \
108 (uint32_t)(((uint64_t)val)>>32)); \
111 #define TWA_WRITE_9650_COMMAND_QUEUE_LOW(sc, val) \
113 TWA_WRITE_REGISTER(sc, TWA_COMMAND_QUEUE_OFFSET_LOW, \
117 /* Control register bit definitions. */
118 #define TWA_CONTROL_ISSUE_HOST_INTERRUPT 0x00000020
119 #define TWA_CONTROL_DISABLE_INTERRUPTS 0x00000040
120 #define TWA_CONTROL_ENABLE_INTERRUPTS 0x00000080
121 #define TWA_CONTROL_ISSUE_SOFT_RESET 0x00000100
122 #define TWA_CONTROL_CLEAR_ERROR_STATUS 0x00000200
123 #define TWA_CONTROL_UNMASK_RESPONSE_INTERRUPT 0x00004000
124 #define TWA_CONTROL_UNMASK_COMMAND_INTERRUPT 0x00008000
125 #define TWA_CONTROL_MASK_RESPONSE_INTERRUPT 0x00010000
126 #define TWA_CONTROL_MASK_COMMAND_INTERRUPT 0x00020000
127 #define TWA_CONTROL_CLEAR_ATTENTION_INTERRUPT 0x00040000
128 #define TWA_CONTROL_CLEAR_HOST_INTERRUPT 0x00080000
129 #define TWA_CONTROL_CLEAR_PCI_ABORT 0x00100000
130 #define TWA_CONTROL_CLEAR_QUEUE_ERROR 0x00400000
131 #define TWA_CONTROL_CLEAR_PARITY_ERROR 0x00800000
133 /* Status register bit definitions. */
134 #define TWA_STATUS_ROM_BIOS_IN_SBUF 0x00000002
135 #define TWA_STATUS_COMMAND_QUEUE_EMPTY 0x00001000
136 #define TWA_STATUS_MICROCONTROLLER_READY 0x00002000
137 #define TWA_STATUS_RESPONSE_QUEUE_EMPTY 0x00004000
138 #define TWA_STATUS_COMMAND_QUEUE_FULL 0x00008000
139 #define TWA_STATUS_RESPONSE_INTERRUPT 0x00010000
140 #define TWA_STATUS_COMMAND_INTERRUPT 0x00020000
141 #define TWA_STATUS_ATTENTION_INTERRUPT 0x00040000
142 #define TWA_STATUS_HOST_INTERRUPT 0x00080000
143 #define TWA_STATUS_PCI_ABORT_INTERRUPT 0x00100000
144 #define TWA_STATUS_MICROCONTROLLER_ERROR 0x00200000
145 #define TWA_STATUS_QUEUE_ERROR_INTERRUPT 0x00400000
146 #define TWA_STATUS_PCI_PARITY_ERROR_INTERRUPT 0x00800000
147 #define TWA_STATUS_MINOR_VERSION_MASK 0x0F000000
148 #define TWA_STATUS_MAJOR_VERSION_MASK 0xF0000000
150 #define TWA_STATUS_EXPECTED_BITS 0x00002000
151 #define TWA_STATUS_UNEXPECTED_BITS 0x00F00000
153 /* For use with the %b printf format. */
154 #define TWA_STATUS_BITS_DESCRIPTION \
155 "\20\15CMD_Q_EMPTY\16MC_RDY\17RESP_Q_EMPTY\20CMD_Q_FULL\21RESP_INTR\22CMD_INTR\23ATTN_INTR\24HOST_INTR\25PCI_ABRT\26MC_ERR\27Q_ERR\30PCI_PERR\n"
157 /* Detect inconsistencies in the status register. */
158 #define TWA_STATUS_ERRORS(x) \
159 ((x & TWA_STATUS_UNEXPECTED_BITS) && \
160 (x & TWA_STATUS_MICROCONTROLLER_READY))
162 /* PCI related defines. */
163 #define TWA_IO_CONFIG_REG 0x10
164 #define TWA_DEVICE_NAME "3ware 9000 series Storage Controller"
165 #define TWA_VENDOR_ID 0x13C1
166 #define TWA_DEVICE_ID_9K 0x1002
168 #define TWA_PCI_CONFIG_CLEAR_PARITY_ERROR 0xc100
169 #define TWA_PCI_CONFIG_CLEAR_PCI_ABORT 0x2000
170 #define TWA_9550SX_DRAIN_COMPLETE 0xffff
172 /* Command packet opcodes. */
173 #define TWA_OP_NOP 0x00
174 #define TWA_OP_INIT_CONNECTION 0x01
175 #define TWA_OP_READ 0x02
176 #define TWA_OP_WRITE 0x03
177 #define TWA_OP_READVERIFY 0x04
178 #define TWA_OP_VERIFY 0x05
179 #define TWA_OP_ZEROUNIT 0x08
180 #define TWA_OP_REPLACEUNIT 0x09
181 #define TWA_OP_HOTSWAP 0x0A
182 #define TWA_OP_SELFTESTS 0x0B
183 #define TWA_OP_SYNC_PARAM 0x0C
184 #define TWA_OP_REORDER_UNITS 0x0D
185 #define TWA_OP_FLUSH 0x0E
186 #define TWA_OP_EXECUTE_SCSI_COMMAND 0x10
187 #define TWA_OP_ATA_PASSTHROUGH 0x11
188 #define TWA_OP_GET_PARAM 0x12
189 #define TWA_OP_SET_PARAM 0x13
190 #define TWA_OP_CREATEUNIT 0x14
191 #define TWA_OP_DELETEUNIT 0x15
192 #define TWA_OP_DOWNLOAD_FIRMWARE 0x16
193 #define TWA_OP_REBUILDUNIT 0x17
194 #define TWA_OP_POWER_MANAGEMENT 0x18
196 #define TWA_OP_REMOTE_PRINT 0x1B
197 #define TWA_OP_RESET_FIRMWARE 0x1C
198 #define TWA_OP_DEBUG 0x1D
200 #define TWA_OP_DIAGNOSTICS 0x1F
203 #define TWA_ALIGNMENT 0x4
204 #define TWA_MAX_UNITS 16
205 #define TWA_9650_MAX_UNITS 32
206 #define TWA_9690_MAX_UNITS 32
207 #define TWA_INIT_MESSAGE_CREDITS 0x100
208 #define TWA_SHUTDOWN_MESSAGE_CREDITS 0x001
209 #define TWA_64BIT_SG_ADDRESSES 0x00000001
210 #define TWA_EXTENDED_INIT_CONNECT 0x00000002
211 #define TWA_BASE_MODE 1
212 #define TWA_BASE_FW_SRL 24
213 #define TWA_BASE_FW_BRANCH 0
214 #define TWA_BASE_FW_BUILD 1
215 #define TWA_CURRENT_FW_SRL 28
216 #define TWA_CURRENT_FW_BRANCH 4
217 #define TWA_CURRENT_FW_BUILD 9
218 #define TWA_9000_ARCH_ID 0x5 /* 9000 series controllers */
219 #define TWA_CTLR_FW_SAME_OR_NEWER 0x00000001
220 #define TWA_CTLR_FW_COMPATIBLE 0x00000002
221 #define TWA_BUNDLED_FW_SAFE_TO_FLASH 0x00000004
222 #define TWA_CTLR_FW_RECOMMENDS_FLASH 0x00000008
223 #define NUM_FW_IMAGE_CHUNKS 5
224 #define TWA_MAX_IO_SIZE 0x20000 /* 128K */
225 /* #define TWA_MAX_SG_ELEMENTS defined above */
226 #define TWA_MAX_ATA_SG_ELEMENTS 60
227 #define TWA_Q_LENGTH TWA_INIT_MESSAGE_CREDITS
228 #define TWA_MAX_RESET_TRIES 3
229 #define TWA_SECTOR_SIZE 0x200 /* generic I/O bufffer */
230 #define TWA_SENSE_DATA_LENGTH 18
231 #define TWA_MICROSECOND 1000000
232 #define TWA_ERROR_LOGICAL_UNIT_NOT_SUPPORTED 0x010a
233 #define TWA_ERROR_UNIT_OFFLINE 0x0128
234 #define TWA_ERROR_MORE_DATA 0x0231
236 /* Scatter/Gather list entry. */
241 uint32_t xx_address_xx
; /* Fail if userland tries to use this */
247 /* 7000 structures. */
248 struct twa_command_init_connect
{
249 uint8_t opcode
:5; /* TWA_OP_INITCONNECTION */
256 uint16_t message_credits
;
265 struct twa_command_download_firmware
{
266 uint8_t opcode
:5; /* TWA_DOWNLOAD_FIRMWARE */
267 uint8_t sgl_offset
:3;
278 struct twa_command_reset_firmware
{
279 uint8_t opcode
:5; /* TWA_OP_RESET_FIRMWARE */
291 struct twa_command_io
{
292 uint8_t opcode
:5; /* TWA_OP_READ/TWA_OP_WRITE */
293 uint8_t sgl_offset
:3;
300 uint16_t block_count
;
302 struct twa_sg sgl
[TWA_MAX_SG_ELEMENTS
];
306 struct twa_command_hotswap
{
307 uint8_t opcode
:5; /* TWA_OP_HOTSWAP */
316 #define TWA_OP_HOTSWAP_REMOVE 0x00 /* remove assumed-degraded unit */
317 #define TWA_OP_HOTSWAP_ADD_CBOD 0x01 /* add CBOD to empty port */
318 #define TWA_OP_HOTSWAP_ADD_SPARE 0x02 /* add spare to empty port */
323 struct twa_command_param
{
324 uint8_t opcode
:5; /* TWA_OP_GETPARAM, TWA_OP_SETPARAM */
325 uint8_t sgl_offset
:3;
332 uint16_t param_count
;
337 struct twa_command_rebuildunit
{
338 uint8_t opcode
:5; /* TWA_OP_REBUILDUNIT */
347 #define TWA_OP_REBUILDUNIT_NOP 0
348 #define TWA_OP_REBUILDUNIT_STOP 2 /* stop all rebuilds */
349 #define TWA_OP_REBUILDUNIT_START 4 /* start rebuild with lowest unit */
350 #define TWA_OP_REBUILDUNIT_STARTUNIT 5 /* rebuild src_unit (not supported) */
351 uint8_t cs
:1; /* request state change on src_unit */
352 uint8_t logical_subunit
; /* for RAID10 rebuild of logical subunit */
356 struct twa_command_ata
{
357 uint8_t opcode
:5; /* TWA_OP_ATA_PASSTHROUGH */
358 uint8_t sgl_offset
:3;
367 uint16_t sector_count
;
369 uint16_t cylinder_lo
;
370 uint16_t cylinder_hi
;
373 struct twa_sg sgl
[TWA_MAX_ATA_SG_ELEMENTS
];
377 struct twa_command_generic
{
379 uint8_t sgl_offset
:3;
386 #define TWA_FLAGS_SUCCESS 0x00
387 #define TWA_FLAGS_INFORMATIONAL 0x01
388 #define TWA_FLAGS_WARNING 0x02
389 #define TWA_FLAGS_FATAL 0x03
390 #define TWA_FLAGS_PERCENTAGE (1<<8) /* bits 0-6 indicate completion percentage */
391 uint16_t count
; /* block count, parameter count, message credits */
394 /* Command packet header. */
396 struct twa_command_header
{
397 uint8_t sense_data
[TWA_SENSE_DATA_LENGTH
];
407 uint8_t err_specific_desc
[98];
417 /* Command packet - must be TWA_ALIGNMENT aligned. */
418 union twa_command_7k
{
419 struct twa_command_init_connect init_connect
;
420 struct twa_command_download_firmware download_fw
;
421 struct twa_command_reset_firmware reset_fw
;
422 struct twa_command_param param
;
423 struct twa_command_generic generic
;
424 uint8_t padding
[1024 - sizeof(struct twa_command_header
)];
428 /* 9000 structures. */
430 /* Command Packet. */
431 struct twa_command_9k
{
439 uint8_t sgl_offset
; /* offset (in bytes) to sg_list, from the end of sgl_entries */
440 uint16_t sgl_entries
;
442 struct twa_sg sg_list
[TWA_MAX_SG_ELEMENTS
];
448 /* Full command packet. */
449 struct twa_command_packet
{
450 struct twa_command_header cmd_hdr
;
452 union twa_command_7k cmd_pkt_7k
;
453 struct twa_command_9k cmd_pkt_9k
;
458 /* Response queue entry. */
459 union twa_response_queue
{
461 uint32_t undefined_1
:4;
462 uint32_t response_id
:8;
463 uint32_t undefined_2
:20;
469 #define TWA_AEN_QUEUE_EMPTY 0x00
470 #define TWA_AEN_SOFT_RESET 0x01
471 #define TWA_AEN_SYNC_TIME_WITH_HOST 0x31
472 #define TWA_AEN_SEVERITY_ERROR 0x1
473 #define TWA_AEN_SEVERITY_WARNING 0x2
474 #define TWA_AEN_SEVERITY_INFO 0x3
475 #define TWA_AEN_SEVERITY_DEBUG 0x4
477 #define TWA_PARAM_DRIVESUMMARY 0x0002
478 #define TWA_PARAM_DRIVESTATUS 3
480 #define TWA_DRIVE_DETECTED 0x80
482 #define TWA_PARAM_DRIVE_TABLE 0x0200
483 #define TWA_PARAM_DRIVESIZEINDEX 2
484 #define TWA_PARAM_DRIVEMODELINDEX 3
486 #define TWA_PARAM_DRIVESIZE_LENGTH 4
487 #define TWA_PARAM_DRIVEMODEL_LENGTH 40
490 #define TWA_PARAM_VERSION 0x0402
491 #define TWA_PARAM_VERSION_Mon 2 /* monitor version [16] */
492 #define TWA_PARAM_VERSION_FW 3 /* firmware version [16] */
493 #define TWA_PARAM_VERSION_BIOS 4 /* BIOSs version [16] */
494 #define TWA_PARAM_VERSION_PCBA 5 /* PCB version [8] */
495 #define TWA_PARAM_VERSION_ATA 6 /* A-chip version [8] */
496 #define TWA_PARAM_VERSION_PCI 7 /* P-chip version [8] */
498 #define TWA_PARAM_CONTROLLER 0x0403
499 #define TWA_PARAM_CONTROLLER_PortCount 3 /* number of ports [1] */
501 #define TWA_PARAM_TIME_TABLE 0x40A
502 #define TWA_PARAM_TIME_SchedulerTime 0x3
504 #define TWA_9K_PARAM_DESCRIPTOR 0x8000
507 struct twa_param_9k
{
509 uint8_t parameter_id
;
511 uint16_t parameter_size_bytes
;
512 uint16_t parameter_actual_size_bytes
;
516 #endif /* !_PCI_TWAREG_H_ */