2 * Generic register and struct definitions for the BusLogic
3 * MultiMaster SCSI host adapters. Product specific probe and
4 * attach routines can be found in:
5 * sys/dev/buslogic/bt_pci.c BT-946, BT-948, BT-956, BT-958 cards
7 * Copyright (c) 1998, 1999 Justin T. Gibbs.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions, and the following disclaimer,
15 * without modification, immediately at the beginning of the file.
16 * 2. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * $FreeBSD: src/sys/dev/buslogic/btreg.h,v 1.10.2.2 2001/09/03 02:45:22 peter Exp $
37 #include <sys/queue.h>
39 #define BT_MAXTRANSFER_SIZE 0xffffffff /* limited by 32bit counter */
40 #define BT_NSEG 32 /* The number of dma segments supported.
41 * BT_NSEG can be maxed out at 8192 entries,
42 * but the kernel will never need to transfer
43 * such a large request. To reduce the
44 * driver's memory consumption, we reduce the
45 * max to 32. 16 would work if all transfers
46 * are paged alined since the kernel will only
47 * generate at most a 64k transfer, but to
48 * handle non-page aligned transfers, you need
49 * 17, so we round to the next power of two
50 * to make allocating SG space easy and
54 #define ALL_TARGETS (~0)
57 * Control Register pp. 1-8, 1-9 (Write Only)
59 #define CONTROL_REG 0x00
60 #define HARD_RESET 0x80 /* Hard Reset - return to POST state */
61 #define SOFT_RESET 0x40 /* Soft Reset - Clears Adapter state */
62 #define RESET_INTR 0x20 /* Reset/Ack Interrupt */
63 #define RESET_SBUS 0x10 /* Drive SCSI bus reset signal */
66 * Status Register pp. 1-9, 1-10 (Read Only)
68 #define STATUS_REG 0x00
69 #define DIAG_ACTIVE 0x80 /* Performing Internal Diags */
70 #define DIAG_FAIL 0x40 /* Internal Diags failed */
71 #define INIT_REQUIRED 0x20 /* MBOXes need initialization */
72 #define HA_READY 0x10 /* HA ready for new commands */
73 #define CMD_REG_BUSY 0x08 /* HA busy with last cmd byte */
74 #define DATAIN_REG_READY 0x04 /* Data-in Byte available */
75 #define STATUS_REG_RSVD 0x02
76 #define CMD_INVALID 0x01 /* Invalid Command detected */
79 * Command/Parameter Register pp. 1-10, 1-11 (Write Only)
81 #define COMMAND_REG 0x01
84 * Data in Register p. 1-11 (Read Only)
86 #define DATAIN_REG 0x01
89 * Interrupt Status Register pp. 1-12 -> 1-14 (Read Only)
91 #define INTSTAT_REG 0x02
92 #define INTR_PENDING 0x80 /* There is a pending INTR */
93 #define INTSTAT_REG_RSVD 0x70
94 #define SCSI_BUS_RESET 0x08 /* Bus Reset detected */
95 #define CMD_COMPLETE 0x04
96 #define OMB_READY 0x02 /* Outgoin Mailbox Ready */
97 #define IMB_LOADED 0x01 /* Incoming Mailbox loaded */
100 * Definitions for the "undocumented" geometry register
109 #define GEOMETRY_REG 0x03
110 #define DISK0_GEOMETRY 0x03
111 #define DISK1_GEOMETRY 0x0c
112 #define EXTENDED_TRANSLATION 0x80
113 #define GEOMETRY_DISK0(g_reg) (greg & DISK0_GEOMETRY)
114 #define GEOMETRY_DISK1(g_reg) ((greg & DISK1_GEOMETRY) >> 2)
118 * Opcodes for Adapter commands.
122 BOP_TEST_CMDC_INTR = 0x00,
123 BOP_INITIALIZE_24BMBOX = 0x01,
124 BOP_START_MBOX = 0x02,
125 BOP_EXECUTE_BIOS_CMD = 0x03,
126 BOP_INQUIRE_BOARD_ID = 0x04,
127 BOP_ENABLE_OMBR_INT = 0x05,
128 BOP_SET_SEL_TIMOUT = 0x06,
129 BOP_SET_TIME_ON_BUS = 0x07,
130 BOP_SET_TIME_OFF_BUS = 0x08,
131 BOP_SET_BUS_TRANS_RATE = 0x09,
132 BOP_INQUIRE_INST_LDEVS = 0x0A,
133 BOP_INQUIRE_CONFIG = 0x0B,
134 BOP_ENABLE_TARGET_MODE = 0x0C,
135 BOP_INQUIRE_SETUP_INFO = 0x0D,
136 BOP_WRITE_LRAM = 0x1A,
137 BOP_READ_LRAM = 0x1B,
138 BOP_WRITE_CHIP_FIFO = 0x1C,
139 BOP_READ_CHIP_FIFO = 0x1C,
140 BOP_ECHO_DATA_BYTE = 0x1F,
141 BOP_ADAPTER_DIAGNOSTICS = 0x20,
142 BOP_SET_ADAPTER_OPTIONS = 0x21,
143 BOP_INQUIRE_INST_HDEVS = 0x23,
144 BOP_INQUIRE_TARG_DEVS = 0x24,
145 BOP_DISABLE_HAC_INTR = 0x25,
146 BOP_INITIALIZE_32BMBOX = 0x81,
147 BOP_EXECUTE_SCSI_CMD = 0x83,
148 BOP_INQUIRE_FW_VER_3DIG = 0x84,
149 BOP_INQUIRE_FW_VER_4DIG = 0x85,
150 BOP_INQUIRE_PCI_INFO = 0x86,
151 BOP_INQUIRE_MODEL = 0x8B,
152 BOP_TARG_SYNC_INFO = 0x8C,
153 BOP_INQUIRE_ESETUP_INFO = 0x8D,
154 BOP_ENABLE_STRICT_RR = 0x8F,
155 BOP_STORE_LRAM = 0x90,
156 BOP_FETCH_LRAM = 0x91,
157 BOP_SAVE_TO_EEPROM = 0x92,
158 BOP_UPLOAD_AUTO_SCSI = 0x94,
159 BOP_MODIFY_IO_ADDR = 0x95,
160 BOP_SET_CCB_FORMAT = 0x96,
161 BOP_FLASH_ROM_DOWNLOAD = 0x97,
162 BOP_FLASH_WRITE_ENABLE = 0x98,
163 BOP_WRITE_INQ_BUFFER = 0x9A,
164 BOP_READ_INQ_BUFFER = 0x9B,
165 BOP_FLASH_UP_DOWNLOAD = 0xA7,
166 BOP_READ_SCAM_DATA = 0xA8,
167 BOP_WRITE_SCAM_DATA = 0xA9
170 /************** Definitions of Multi-byte commands and responses ************/
174 u_int8_t base_addr[3];
175 } init_24b_mbox_params_t;
179 #define BOARD_TYPE_NON_MCA 0x41
180 #define BOARD_TYPE_MCA 0x42
181 u_int8_t cust_features;
182 #define FEATURES_STANDARD 0x41
183 u_int8_t firmware_rev_major;
184 u_int8_t firmware_rev_minor;
189 } enable_ombr_intr_params_t;
194 u_int8_t timeout[2]; /* timeout in milliseconds */
195 } set_selto_parmas_t;
198 u_int8_t time; /* time in milliseconds (2-15) */
199 } set_timeon_bus_params_t;
202 u_int8_t time; /* time in milliseconds (2-15) */
203 } set_timeoff_bus_params_t;
207 } set_bus_trasfer_rate_params_t;
211 } installed_ldevs_data_t;
215 #define DMA_CHAN_5 0x20
216 #define DMA_CHAN_6 0x40
217 #define DMA_CHAN_7 0x80
230 } target_mode_params_t;
248 u_int8_t initiate_sync : 1,
252 u_int8_t bus_transfer_rate;
253 u_int8_t time_on_bus;
254 u_int8_t time_off_bus;
256 u_int8_t mbox_base_addr[3];
257 targ_syncinfo_t low_syncinfo[8]; /* For fast and ultra, use 8C */
258 u_int8_t low_discinfo;
259 u_int8_t customer_sig;
262 u_int8_t low_wide_allowed;
263 u_int8_t low_wide_active;
264 targ_syncinfo_t high_syncinfo[8];
265 u_int8_t high_discinfo;
266 u_int8_t high_wide_allowed;
267 u_int8_t high_wide_active;
271 u_int8_t phys_addr[3];
272 } write_adapter_lram_params_t;
275 u_int8_t phys_addr[3];
276 } read_adapter_lram_params_t;
279 u_int8_t phys_addr[3];
280 } write_chip_fifo_params_t;
283 u_int8_t phys_addr[3];
284 } read_chip_fifo_params_t;
287 u_int8_t length; /* Excludes this member */
288 u_int8_t low_disc_disable;
289 u_int8_t low_busy_retry_disable;
290 u_int8_t high_disc_disable;
291 u_int8_t high_busy_retry_disable;
292 } set_adapter_options_params_t;
296 } installed_hdevs_data_t;
301 } target_devs_data_t;
305 } enable_hac_interrupt_params_t;
309 u_int8_t base_addr[4];
310 } init_32b_mbox_params_t;
312 typedef u_int8_t fw_ver_3dig_data_t;
314 typedef u_int8_t fw_ver_4dig_data_t;
318 u_int8_t response_len;
319 } fetch_lram_params_t;
321 #define AUTO_SCSI_BYTE_OFFSET 64
323 u_int8_t factory_sig[2];
324 u_int8_t auto_scsi_data_size; /* 2 -> 64 bytes */
325 u_int8_t model_num[6];
326 u_int8_t adapter_ioport;
327 u_int8_t floppy_enabled :1,
332 u_int8_t dma_channel :7,
334 u_int8_t irq_channel :7,
336 u_int8_t dma_trans_rate;
338 u_int8_t low_termination :1,
346 u_int8_t bus_on_delay;
347 u_int8_t bus_off_delay;
348 u_int8_t bios_enabled :1,
356 u_int8_t low_device_enabled;
357 u_int8_t high_device_enabled;
358 u_int8_t low_wide_permitted;
359 u_int8_t high_wide_permitted;
360 u_int8_t low_fast_permitted;
361 u_int8_t high_fast_permitted;
362 u_int8_t low_sync_permitted;
363 u_int8_t high_sync_permitted;
364 u_int8_t low_disc_permitted;
365 u_int8_t high_disc_permitted;
366 u_int8_t low_send_start_unit;
367 u_int8_t high_send_start_unit;
368 u_int8_t low_ignore_in_bios_scan;
369 u_int8_t high_ignore_in_bios_scan;
370 u_int8_t pci_int_pin :2,
376 u_int8_t low_ultra_permitted;
377 u_int8_t high_ultra_permitted;
378 u_int8_t reserved[5];
379 u_int8_t auto_scsi_max_lun;
385 u_int8_t int13_extensions :1,
391 u_int8_t boot_target_id :4,
393 u_int8_t force_dev_scan :1,
395 u_int8_t low_tagged_lun_independance;
396 u_int8_t high_tagged_lun_independance;
397 u_int8_t low_renegotiate_after_cc;
398 u_int8_t high_renegotiate_after_cc;
399 u_int8_t reserverd2[10];
400 u_int8_t manufacturing_diagnotic[2];
401 u_int8_t checksum[2];
407 u_int8_t low_byte_term :1,
418 u_int8_t ascii_model[5]; /* Fifth byte is always 0 */
422 u_int8_t sync_rate[16]; /* Sync in 10ns units */
423 } target_sync_info_data_t;
430 u_int8_t mbox_base[4];
434 floppy_secondary_port :1,
435 burst_mode_enabled :1,
436 level_trigger_ints :1,
438 u_int8_t fw_ver_bytes_2_to_4[3];
439 u_int8_t wide_bus :1,
445 } esetup_info_data_t;
452 /********************** Mail Box definitions *******************************/
455 BMBO_FREE = 0x0, /* MBO intry is free */
456 BMBO_START = 0x1, /* MBO activate entry */
457 BMBO_ABORT = 0x2 /* MBO abort entry */
458 } bt_mbo_action_code_t;
460 typedef struct bt_mbox_out {
462 u_int8_t reserved[3];
463 u_int8_t action_code;
467 BMBI_FREE = 0x0, /* MBI entry is free */
468 BMBI_OK = 0x1, /* completed without error */
469 BMBI_ABORT = 0x2, /* aborted ccb */
470 BMBI_NOT_FOUND = 0x3, /* Tried to abort invalid CCB */
471 BMBI_ERROR = 0x4 /* Completed with error */
472 } bt_mbi_comp_code_t;
474 typedef struct bt_mbox_in {
482 /***************** Compiled Probe Information *******************************/
483 struct bt_probe_info {
488 /****************** Hardware CCB definition *********************************/
490 INITIATOR_CCB = 0x00,
491 INITIATOR_SG_CCB = 0x02,
492 INITIATOR_CCB_WRESID = 0x03,
493 INITIATOR_SG_CCB_WRESID = 0x04,
494 INITIATOR_BUS_DEV_RESET = 0x81
498 BTSTAT_NOERROR = 0x00,
499 BTSTAT_LINKED_CMD_COMPLETE = 0x0A,
500 BTSTAT_LINKED_CMD_FLAG_COMPLETE = 0x0B,
501 BTSTAT_DATAUNDERUN_ERROR = 0x0C,
502 BTSTAT_SELTIMEOUT = 0x11,
503 BTSTAT_DATARUN_ERROR = 0x12,
504 BTSTAT_UNEXPECTED_BUSFREE = 0x13,
505 BTSTAT_INVALID_PHASE = 0x14,
506 BTSTAT_INVALID_ACTION_CODE = 0x15,
507 BTSTAT_INVALID_OPCODE = 0x16,
508 BTSTAT_LINKED_CCB_LUN_MISMATCH = 0x17,
509 BTSTAT_INVALID_CCB_OR_SG_PARAM = 0x1A,
510 BTSTAT_AUTOSENSE_FAILED = 0x1B,
511 BTSTAT_TAGGED_MSG_REJECTED = 0x1C,
512 BTSTAT_UNSUPPORTED_MSG_RECEIVED = 0x1D,
513 BTSTAT_HARDWARE_FAILURE = 0x20,
514 BTSTAT_TARGET_IGNORED_ATN = 0x21,
515 BTSTAT_HA_SCSI_BUS_RESET = 0x22,
516 BTSTAT_OTHER_SCSI_BUS_RESET = 0x23,
517 BTSTAT_INVALID_RECONNECT = 0x24,
518 BTSTAT_HA_BDR = 0x25,
519 BTSTAT_ABORT_QUEUE_GENERATED = 0x26,
520 BTSTAT_HA_SOFTWARE_ERROR = 0x27,
521 BTSTAT_HA_WATCHDOG_ERROR = 0x28,
522 BTSTAT_SCSI_PERROR_DETECTED = 0x30
530 wide_tag_enable :1, /* Wide Lun CCB format */
531 wide_tag_type :2; /* Wide Lun CCB format */
534 int32_t data_len; /* residuals can be negative */
536 u_int8_t reserved[2];
540 u_int8_t target_lun :5,
543 u_int8_t scsi_cdb[12];
544 u_int8_t reserved2[6];
545 u_int32_t sense_addr;
551 BCCB_DEVICE_RESET = 0x2,
552 BCCB_RELEASE_SIMQ = 0x4
557 SLIST_ENTRY(bt_ccb) links;
562 u_int32_t sg_list_phys;
566 bus_dmamap_t sg_dmamap;
567 bus_addr_t sg_physaddr;
569 SLIST_ENTRY(sg_map_node) links;
574 struct resource *port;
575 struct resource *irq;
576 struct resource *drq;
579 bus_space_handle_t bsh;
581 struct cam_path *path;
582 bt_mbox_out_t *cur_outbox;
583 bt_mbox_in_t *cur_inbox;
584 bt_mbox_out_t *last_outbox;
585 bt_mbox_in_t *last_inbox;
586 struct bt_ccb *bt_ccb_array;
587 SLIST_HEAD(,bt_ccb) free_bt_ccbs;
588 LIST_HEAD(,ccb_hdr) pending_ccbs;
590 u_int32_t bt_ccb_physbase;
591 bt_mbox_in_t *in_boxes;
592 bt_mbox_out_t *out_boxes;
593 struct scsi_sense_data *sense_buffers;
594 u_int32_t sense_buffers_physbase;
595 struct bt_ccb *recovery_bccb;
597 bus_dma_tag_t parent_dmat; /*
598 * All dmat's derive from
599 * the dmat defined by our
602 bus_dma_tag_t buffer_dmat; /* dmat for buffer I/O */
603 bus_dma_tag_t mailbox_dmat; /* dmat for our mailboxes */
604 bus_dmamap_t mailbox_dmamap;
605 bus_dma_tag_t ccb_dmat; /* dmat for our ccb array */
606 bus_dmamap_t ccb_dmamap;
607 bus_dma_tag_t sg_dmat; /* dmat for our sg segments */
608 bus_dma_tag_t sense_dmat; /* dmat for our sense buffers */
609 bus_dmamap_t sense_dmamap;
610 SLIST_HEAD(, sg_map_node) sg_maps;
611 bus_addr_t mailbox_physbase;
612 u_int num_ccbs; /* Number of CCBs malloc'd */
613 u_int max_ccbs; /* Maximum allocatable CCBs */
617 u_int32_t extended_trans :1,
625 resource_shortage :1,
626 level_trigger_ints:1,
628 u_int16_t tags_permitted;
629 u_int16_t disc_permitted;
630 u_int16_t sync_permitted;
631 u_int16_t fast_permitted;
632 u_int16_t ultra_permitted;
633 u_int16_t wide_permitted;
635 volatile u_int8_t command_cmp;
636 volatile u_int8_t latched_status;
638 char firmware_ver[6];
642 extern u_long bt_unit;
644 #define BT_TEMP_UNIT 0xFF /* Unit for probes */
645 void bt_init_softc(device_t dev,
646 struct resource *port,
647 struct resource *irq,
648 struct resource *drq);
649 void bt_free_softc(device_t dev);
650 int bt_probe(device_t dev);
651 int bt_fetch_adapter_info(device_t dev);
652 int bt_init(device_t dev);
653 int bt_attach(device_t dev);
654 void bt_intr(void *arg);
656 #define DEFAULT_CMD_TIMEOUT 100000 /* 10 sec */
657 int bt_cmd(struct bt_softc *bt, bt_op_t opcode,
658 u_int8_t *params, u_int param_len,
659 u_int8_t *reply_data, u_int reply_len,
662 #define bt_name(bt) device_get_nameunit(bt->dev)
664 #define bt_inb(bt, port) \
665 bus_space_read_1((bt)->tag, (bt)->bsh, port)
667 #define bt_outb(bt, port, value) \
668 bus_space_write_1((bt)->tag, (bt)->bsh, port, value)