3 Linux Driver for BusLogic MultiMaster and FlashPoint SCSI Host Adapters
5 Copyright 1995-1998 by Leonard N. Zubkoff <lnz@dandelion.com>
7 This program is free software; you may redistribute and/or modify it under
8 the terms of the GNU General Public License Version 2 as published by the
9 Free Software Foundation.
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY
13 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 The author respectfully requests that any modifications to this software be
17 sent directly to him for evaluation and testing.
19 Special thanks to Wayne Yen, Jin-Lon Hon, and Alex Win of BusLogic, whose
20 advice has been invaluable, to David Gentzel, for writing the original Linux
21 BusLogic driver, and to Paul Gortmaker, for being such a dedicated test site.
23 Finally, special thanks to Mylex/BusLogic for making the FlashPoint SCCB
24 Manager available as freely redistributable source code.
33 #define PACKED __attribute__((packed))
37 Define the maximum number of BusLogic Host Adapters supported by this driver.
40 #define BLOGIC_MAX_ADAPTERS 16
44 Define the maximum number of Target Devices supported by this driver.
47 #define BLOGIC_MAXDEV 16
51 Define the maximum number of Scatter/Gather Segments used by this driver.
52 For optimal performance, it is important that this limit be at least as
53 large as the largest single request generated by the I/O Subsystem.
56 #define BLOGIC_SG_LIMIT 128
60 Define the maximum, maximum automatic, minimum automatic, and default Queue
61 Depth to allow for Target Devices depending on whether or not they support
62 Tagged Queuing and whether or not ISA Bounce Buffers are required.
65 #define BLOGIC_MAX_TAG_DEPTH 64
66 #define BLOGIC_MAX_AUTO_TAG_DEPTH 28
67 #define BLOGIC_MIN_AUTO_TAG_DEPTH 7
68 #define BLOGIC_TAG_DEPTH_BB 3
69 #define BLOGIC_UNTAG_DEPTH 3
70 #define BLOGIC_UNTAG_DEPTH_BB 2
74 Define the default amount of time in seconds to wait between a Host Adapter
75 Hard Reset which initiates a SCSI Bus Reset and issuing any SCSI commands.
76 Some SCSI devices get confused if they receive SCSI commands too soon after
80 #define BLOGIC_BUS_SETTLE_TIME 2
84 Define the maximum number of Mailboxes that should be used for MultiMaster
85 Host Adapters. This number is chosen to be larger than the maximum Host
86 Adapter Queue Depth and small enough so that the Host Adapter structure
87 does not cross an allocation block size boundary.
90 #define BLOGIC_MAX_MAILBOX 211
94 Define the number of CCBs that should be allocated as a group to optimize
95 Kernel memory allocation.
98 #define BLOGIC_CCB_GRP_ALLOCSIZE 7
102 Define the Host Adapter Line and Message Buffer Sizes.
105 #define BLOGIC_LINEBUF_SIZE 100
106 #define BLOGIC_MSGBUF_SIZE 9700
110 Define the Driver Message Levels.
113 enum blogic_msglevel {
114 BLOGIC_ANNOUNCE_LEVEL = 0,
115 BLOGIC_INFO_LEVEL = 1,
116 BLOGIC_NOTICE_LEVEL = 2,
117 BLOGIC_WARN_LEVEL = 3,
121 static char *blogic_msglevelmap[] = { KERN_NOTICE, KERN_NOTICE, KERN_NOTICE, KERN_WARNING, KERN_ERR };
125 Define Driver Message macros.
128 #define blogic_announce(format, args...) \
129 blogic_msg(BLOGIC_ANNOUNCE_LEVEL, format, ##args)
131 #define blogic_info(format, args...) \
132 blogic_msg(BLOGIC_INFO_LEVEL, format, ##args)
134 #define blogic_notice(format, args...) \
135 blogic_msg(BLOGIC_NOTICE_LEVEL, format, ##args)
137 #define blogic_warn(format, args...) \
138 blogic_msg(BLOGIC_WARN_LEVEL, format, ##args)
140 #define blogic_err(format, args...) \
141 blogic_msg(BLOGIC_ERR_LEVEL, format, ##args)
145 Define the types of BusLogic Host Adapters that are supported and the number
146 of I/O Addresses required by each type.
149 enum blogic_adapter_type {
150 BLOGIC_MULTIMASTER = 1,
151 BLOGIC_FLASHPOINT = 2
154 #define BLOGIC_MULTIMASTER_ADDR_COUNT 4
155 #define BLOGIC_FLASHPOINT_ADDR_COUNT 256
157 static int blogic_adapter_addr_count[3] = { 0, BLOGIC_MULTIMASTER_ADDR_COUNT, BLOGIC_FLASHPOINT_ADDR_COUNT };
161 Define macros for testing the Host Adapter Type.
164 #ifdef CONFIG_SCSI_FLASHPOINT
166 #define blogic_multimaster_type(adapter) \
167 (adapter->adapter_type == BLOGIC_MULTIMASTER)
169 #define blogic_flashpoint_type(adapter) \
170 (adapter->adapter_type == BLOGIC_FLASHPOINT)
174 #define blogic_multimaster_type(adapter) (true)
175 #define blogic_flashpoint_type(adapter) (false)
181 Define the possible Host Adapter Bus Types.
184 enum blogic_adapter_bus_type {
185 BLOGIC_UNKNOWN_BUS = 0,
193 static char *blogic_adapter_busnames[] = { "Unknown", "ISA", "EISA", "PCI", "VESA", "MCA" };
195 static enum blogic_adapter_bus_type blogic_adater_bus_types[] = {
196 BLOGIC_VESA_BUS, /* BT-4xx */
197 BLOGIC_ISA_BUS, /* BT-5xx */
198 BLOGIC_MCA_BUS, /* BT-6xx */
199 BLOGIC_EISA_BUS, /* BT-7xx */
200 BLOGIC_UNKNOWN_BUS, /* BT-8xx */
201 BLOGIC_PCI_BUS /* BT-9xx */
205 Define the possible Host Adapter BIOS Disk Geometry Translations.
208 enum blogic_bios_diskgeometry {
209 BLOGIC_BIOS_NODISK = 0,
210 BLOGIC_BIOS_DISK64x32 = 1,
211 BLOGIC_BIOS_DISK128x32 = 2,
212 BLOGIC_BIOS_DISK255x63 = 3
217 Define a 10^18 Statistics Byte Counter data type.
220 struct blogic_byte_count {
222 unsigned int billions;
227 Define the structure for I/O Address and Bus Probing Information.
230 struct blogic_probeinfo {
231 enum blogic_adapter_type adapter_type;
232 enum blogic_adapter_bus_type adapter_bus_type;
233 unsigned long io_addr;
234 unsigned long pci_addr;
235 struct pci_dev *pci_device;
238 unsigned char irq_ch;
242 Define the Probe Options.
245 struct blogic_probe_options {
246 bool noprobe:1; /* Bit 0 */
247 bool noprobe_isa:1; /* Bit 1 */
248 bool noprobe_pci:1; /* Bit 2 */
249 bool nosort_pci:1; /* Bit 3 */
250 bool multimaster_first:1; /* Bit 4 */
251 bool flashpoint_first:1; /* Bit 5 */
252 bool limited_isa:1; /* Bit 6 */
253 bool probe330:1; /* Bit 7 */
254 bool probe334:1; /* Bit 8 */
255 bool probe230:1; /* Bit 9 */
256 bool probe234:1; /* Bit 10 */
257 bool probe130:1; /* Bit 11 */
258 bool probe134:1; /* Bit 12 */
262 Define the Global Options.
265 struct blogic_global_options {
266 bool trace_probe:1; /* Bit 0 */
267 bool trace_hw_reset:1; /* Bit 1 */
268 bool trace_config:1; /* Bit 2 */
269 bool trace_err:1; /* Bit 3 */
273 Define the BusLogic SCSI Host Adapter I/O Register Offsets.
276 #define BLOGIC_CNTRL_REG 0 /* WO register */
277 #define BLOGIC_STATUS_REG 0 /* RO register */
278 #define BLOGIC_CMD_PARM_REG 1 /* WO register */
279 #define BLOGIC_DATAIN_REG 1 /* RO register */
280 #define BLOGIC_INT_REG 2 /* RO register */
281 #define BLOGIC_GEOMETRY_REG 3 /* RO register */
284 Define the structure of the write-only Control Register.
287 union blogic_cntrl_reg {
290 unsigned char:4; /* Bits 0-3 */
291 bool bus_reset:1; /* Bit 4 */
292 bool int_reset:1; /* Bit 5 */
293 bool soft_reset:1; /* Bit 6 */
294 bool hard_reset:1; /* Bit 7 */
299 Define the structure of the read-only Status Register.
302 union blogic_stat_reg {
305 bool cmd_invalid:1; /* Bit 0 */
306 bool rsvd:1; /* Bit 1 */
307 bool datain_ready:1; /* Bit 2 */
308 bool cmd_param_busy:1; /* Bit 3 */
309 bool adapter_ready:1; /* Bit 4 */
310 bool init_reqd:1; /* Bit 5 */
311 bool diag_failed:1; /* Bit 6 */
312 bool diag_active:1; /* Bit 7 */
317 Define the structure of the read-only Interrupt Register.
320 union blogic_int_reg {
323 bool mailin_loaded:1; /* Bit 0 */
324 bool mailout_avail:1; /* Bit 1 */
325 bool cmd_complete:1; /* Bit 2 */
326 bool ext_busreset:1; /* Bit 3 */
327 unsigned char rsvd:3; /* Bits 4-6 */
328 bool int_valid:1; /* Bit 7 */
333 Define the structure of the read-only Geometry Register.
336 union blogic_geo_reg {
339 enum blogic_bios_diskgeometry d0_geo:2; /* Bits 0-1 */
340 enum blogic_bios_diskgeometry d1_geo:2; /* Bits 2-3 */
341 unsigned char:3; /* Bits 4-6 */
342 bool ext_trans_enable:1; /* Bit 7 */
347 Define the BusLogic SCSI Host Adapter Command Register Operation Codes.
351 BLOGIC_TEST_CMP_COMPLETE = 0x00,
352 BLOGIC_INIT_MBOX = 0x01,
353 BLOGIC_EXEC_MBOX_CMD = 0x02,
354 BLOGIC_EXEC_BIOS_CMD = 0x03,
355 BLOGIC_GET_BOARD_ID = 0x04,
356 BLOGIC_ENABLE_OUTBOX_AVAIL_INT = 0x05,
357 BLOGIC_SET_SELECT_TIMEOUT = 0x06,
358 BLOGIC_SET_PREEMPT_TIME = 0x07,
359 BLOGIC_SET_TIMEOFF_BUS = 0x08,
360 BLOGIC_SET_TXRATE = 0x09,
361 BLOGIC_INQ_DEV0TO7 = 0x0A,
362 BLOGIC_INQ_CONFIG = 0x0B,
363 BLOGIC_TGT_MODE = 0x0C,
364 BLOGIC_INQ_SETUPINFO = 0x0D,
365 BLOGIC_WRITE_LOCALRAM = 0x1A,
366 BLOGIC_READ_LOCALRAM = 0x1B,
367 BLOGIC_WRITE_BUSMASTER_FIFO = 0x1C,
368 BLOGIC_READ_BUSMASTER_FIFO = 0x1D,
369 BLOGIC_ECHO_CMDDATA = 0x1F,
370 BLOGIC_ADAPTER_DIAG = 0x20,
371 BLOGIC_SET_OPTIONS = 0x21,
372 BLOGIC_INQ_DEV8TO15 = 0x23,
373 BLOGIC_INQ_DEV = 0x24,
374 BLOGIC_DISABLE_INT = 0x25,
375 BLOGIC_INIT_EXT_MBOX = 0x81,
376 BLOGIC_EXEC_SCS_CMD = 0x83,
377 BLOGIC_INQ_FWVER_D3 = 0x84,
378 BLOGIC_INQ_FWVER_LETTER = 0x85,
379 BLOGIC_INQ_PCI_INFO = 0x86,
380 BLOGIC_INQ_MODELNO = 0x8B,
381 BLOGIC_INQ_SYNC_PERIOD = 0x8C,
382 BLOGIC_INQ_EXTSETUP = 0x8D,
383 BLOGIC_STRICT_RR = 0x8F,
384 BLOGIC_STORE_LOCALRAM = 0x90,
385 BLOGIC_FETCH_LOCALRAM = 0x91,
386 BLOGIC_STORE_TO_EEPROM = 0x92,
387 BLOGIC_LOAD_AUTOSCSICODE = 0x94,
388 BLOGIC_MOD_IOADDR = 0x95,
389 BLOGIC_SETCCB_FMT = 0x96,
390 BLOGIC_WRITE_INQBUF = 0x9A,
391 BLOGIC_READ_INQBUF = 0x9B,
392 BLOGIC_FLASH_LOAD = 0xA7,
393 BLOGIC_READ_SCAMDATA = 0xA8,
394 BLOGIC_WRITE_SCAMDATA = 0xA9
398 Define the Inquire Board ID reply structure.
401 struct blogic_board_id {
402 unsigned char type; /* Byte 0 */
403 unsigned char custom_features; /* Byte 1 */
404 unsigned char fw_ver_digit1; /* Byte 2 */
405 unsigned char fw_ver_digit2; /* Byte 3 */
409 Define the Inquire Configuration reply structure.
412 struct blogic_config {
413 unsigned char:5; /* Byte 0 Bits 0-4 */
414 bool dma_ch5:1; /* Byte 0 Bit 5 */
415 bool dma_ch6:1; /* Byte 0 Bit 6 */
416 bool dma_ch7:1; /* Byte 0 Bit 7 */
417 bool irq_ch9:1; /* Byte 1 Bit 0 */
418 bool irq_ch10:1; /* Byte 1 Bit 1 */
419 bool irq_ch11:1; /* Byte 1 Bit 2 */
420 bool irq_ch12:1; /* Byte 1 Bit 3 */
421 unsigned char:1; /* Byte 1 Bit 4 */
422 bool irq_ch14:1; /* Byte 1 Bit 5 */
423 bool irq_ch15:1; /* Byte 1 Bit 6 */
424 unsigned char:1; /* Byte 1 Bit 7 */
425 unsigned char id:4; /* Byte 2 Bits 0-3 */
426 unsigned char:4; /* Byte 2 Bits 4-7 */
430 Define the Inquire Setup Information reply structure.
433 struct blogic_syncval {
434 unsigned char offset:4; /* Bits 0-3 */
435 unsigned char tx_period:3; /* Bits 4-6 */
436 bool sync:1; /* Bit 7 */
439 struct blogic_setup_info {
440 bool sync:1; /* Byte 0 Bit 0 */
441 bool parity:1; /* Byte 0 Bit 1 */
442 unsigned char:6; /* Byte 0 Bits 2-7 */
443 unsigned char tx_rate; /* Byte 1 */
444 unsigned char preempt_time; /* Byte 2 */
445 unsigned char timeoff_bus; /* Byte 3 */
446 unsigned char mbox_count; /* Byte 4 */
447 unsigned char mbox_addr[3]; /* Bytes 5-7 */
448 struct blogic_syncval sync0to7[8]; /* Bytes 8-15 */
449 unsigned char disconnect_ok0to7; /* Byte 16 */
450 unsigned char sig; /* Byte 17 */
451 unsigned char char_d; /* Byte 18 */
452 unsigned char bus_type; /* Byte 19 */
453 unsigned char wide_tx_ok0to7; /* Byte 20 */
454 unsigned char wide_tx_active0to7; /* Byte 21 */
455 struct blogic_syncval sync8to15[8]; /* Bytes 22-29 */
456 unsigned char disconnect_ok8to15; /* Byte 30 */
457 unsigned char:8; /* Byte 31 */
458 unsigned char wide_tx_ok8to15; /* Byte 32 */
459 unsigned char wide_tx_active8to15; /* Byte 33 */
463 Define the Initialize Extended Mailbox request structure.
466 struct blogic_extmbox_req {
467 unsigned char mbox_count; /* Byte 0 */
468 u32 base_mbox_addr; /* Bytes 1-4 */
473 Define the Inquire PCI Host Adapter Information reply type. The ISA
474 Compatible I/O Port values are defined here and are also used with
475 the Modify I/O Address command.
478 enum blogic_isa_ioport {
485 BLOGIC_IO_DISABLE = 6,
486 BLOGIC_IO_DISABLE2 = 7
489 struct blogic_adapter_info {
490 enum blogic_isa_ioport isa_port; /* Byte 0 */
491 unsigned char irq_ch; /* Byte 1 */
492 bool low_term:1; /* Byte 2 Bit 0 */
493 bool high_term:1; /* Byte 2 Bit 1 */
494 unsigned char:2; /* Byte 2 Bits 2-3 */
495 bool JP1:1; /* Byte 2 Bit 4 */
496 bool JP2:1; /* Byte 2 Bit 5 */
497 bool JP3:1; /* Byte 2 Bit 6 */
498 bool genericinfo_valid:1; /* Byte 2 Bit 7 */
499 unsigned char:8; /* Byte 3 */
503 Define the Inquire Extended Setup Information reply structure.
506 struct blogic_ext_setup {
507 unsigned char bus_type; /* Byte 0 */
508 unsigned char bios_addr; /* Byte 1 */
509 unsigned short sg_limit; /* Bytes 2-3 */
510 unsigned char mbox_count; /* Byte 4 */
511 u32 base_mbox_addr; /* Bytes 5-8 */
513 unsigned char:2; /* Byte 9 Bits 0-1 */
514 bool fast_on_eisa:1; /* Byte 9 Bit 2 */
515 unsigned char:3; /* Byte 9 Bits 3-5 */
516 bool level_int:1; /* Byte 9 Bit 6 */
517 unsigned char:1; /* Byte 9 Bit 7 */
519 unsigned char fw_rev[3]; /* Bytes 10-12 */
520 bool wide:1; /* Byte 13 Bit 0 */
521 bool differential:1; /* Byte 13 Bit 1 */
522 bool scam:1; /* Byte 13 Bit 2 */
523 bool ultra:1; /* Byte 13 Bit 3 */
524 bool smart_term:1; /* Byte 13 Bit 4 */
525 unsigned char:3; /* Byte 13 Bits 5-7 */
529 Define the Enable Strict Round Robin Mode request type.
533 BLOGIC_AGGRESSIVE_RR = 0,
534 BLOGIC_STRICT_RR_MODE = 1
539 Define the Fetch Host Adapter Local RAM request type.
542 #define BLOGIC_BIOS_BASE 0
543 #define BLOGIC_AUTOSCSI_BASE 64
545 struct blogic_fetch_localram {
546 unsigned char offset; /* Byte 0 */
547 unsigned char count; /* Byte 1 */
551 Define the Host Adapter Local RAM AutoSCSI structure.
554 struct blogic_autoscsi {
555 unsigned char factory_sig[2]; /* Bytes 0-1 */
556 unsigned char info_bytes; /* Byte 2 */
557 unsigned char adapter_type[6]; /* Bytes 3-8 */
558 unsigned char:8; /* Byte 9 */
559 bool floppy:1; /* Byte 10 Bit 0 */
560 bool floppy_sec:1; /* Byte 10 Bit 1 */
561 bool level_int:1; /* Byte 10 Bit 2 */
562 unsigned char:2; /* Byte 10 Bits 3-4 */
563 unsigned char systemram_bios:3; /* Byte 10 Bits 5-7 */
564 unsigned char dma_ch:7; /* Byte 11 Bits 0-6 */
565 bool dma_autoconf:1; /* Byte 11 Bit 7 */
566 unsigned char irq_ch:7; /* Byte 12 Bits 0-6 */
567 bool irq_autoconf:1; /* Byte 12 Bit 7 */
568 unsigned char dma_tx_rate; /* Byte 13 */
569 unsigned char scsi_id; /* Byte 14 */
570 bool low_term:1; /* Byte 15 Bit 0 */
571 bool parity:1; /* Byte 15 Bit 1 */
572 bool high_term:1; /* Byte 15 Bit 2 */
573 bool noisy_cable:1; /* Byte 15 Bit 3 */
574 bool fast_sync_neg:1; /* Byte 15 Bit 4 */
575 bool reset_enabled:1; /* Byte 15 Bit 5 */
576 bool:1; /* Byte 15 Bit 6 */
577 bool active_negation:1; /* Byte 15 Bit 7 */
578 unsigned char bus_on_delay; /* Byte 16 */
579 unsigned char bus_off_delay; /* Byte 17 */
580 bool bios_enabled:1; /* Byte 18 Bit 0 */
581 bool int19_redir_enabled:1; /* Byte 18 Bit 1 */
582 bool ext_trans_enable:1; /* Byte 18 Bit 2 */
583 bool removable_as_fixed:1; /* Byte 18 Bit 3 */
584 bool:1; /* Byte 18 Bit 4 */
585 bool morethan2_drives:1; /* Byte 18 Bit 5 */
586 bool bios_int:1; /* Byte 18 Bit 6 */
587 bool floptical:1; /* Byte 19 Bit 7 */
588 unsigned short dev_enabled; /* Bytes 19-20 */
589 unsigned short wide_ok; /* Bytes 21-22 */
590 unsigned short fast_ok; /* Bytes 23-24 */
591 unsigned short sync_ok; /* Bytes 25-26 */
592 unsigned short discon_ok; /* Bytes 27-28 */
593 unsigned short send_start_unit; /* Bytes 29-30 */
594 unsigned short ignore_bios_scan; /* Bytes 31-32 */
595 unsigned char pci_int_pin:2; /* Byte 33 Bits 0-1 */
596 unsigned char adapter_ioport:2; /* Byte 33 Bits 2-3 */
597 bool strict_rr_enabled:1; /* Byte 33 Bit 4 */
598 bool vesabus_33mhzplus:1; /* Byte 33 Bit 5 */
599 bool vesa_burst_write:1; /* Byte 33 Bit 6 */
600 bool vesa_burst_read:1; /* Byte 33 Bit 7 */
601 unsigned short ultra_ok; /* Bytes 34-35 */
602 unsigned int:32; /* Bytes 36-39 */
603 unsigned char:8; /* Byte 40 */
604 unsigned char autoscsi_maxlun; /* Byte 41 */
605 bool:1; /* Byte 42 Bit 0 */
606 bool scam_dominant:1; /* Byte 42 Bit 1 */
607 bool scam_enabled:1; /* Byte 42 Bit 2 */
608 bool scam_lev2:1; /* Byte 42 Bit 3 */
609 unsigned char:4; /* Byte 42 Bits 4-7 */
610 bool int13_exten:1; /* Byte 43 Bit 0 */
611 bool:1; /* Byte 43 Bit 1 */
612 bool cd_boot:1; /* Byte 43 Bit 2 */
613 unsigned char:5; /* Byte 43 Bits 3-7 */
614 unsigned char boot_id:4; /* Byte 44 Bits 0-3 */
615 unsigned char boot_ch:4; /* Byte 44 Bits 4-7 */
616 unsigned char force_scan_order:1; /* Byte 45 Bit 0 */
617 unsigned char:7; /* Byte 45 Bits 1-7 */
618 unsigned short nontagged_to_alt_ok; /* Bytes 46-47 */
619 unsigned short reneg_sync_on_check; /* Bytes 48-49 */
620 unsigned char rsvd[10]; /* Bytes 50-59 */
621 unsigned char manuf_diag[2]; /* Bytes 60-61 */
622 unsigned short cksum; /* Bytes 62-63 */
626 Define the Host Adapter Local RAM Auto SCSI Byte 45 structure.
629 struct blogic_autoscsi_byte45 {
630 unsigned char force_scan_order:1; /* Bit 0 */
631 unsigned char:7; /* Bits 1-7 */
635 Define the Host Adapter Local RAM BIOS Drive Map Byte structure.
638 #define BLOGIC_BIOS_DRVMAP 17
640 struct blogic_bios_drvmap {
641 unsigned char tgt_idbit3:1; /* Bit 0 */
642 unsigned char:2; /* Bits 1-2 */
643 enum blogic_bios_diskgeometry diskgeom:2; /* Bits 3-4 */
644 unsigned char tgt_id:3; /* Bits 5-7 */
648 Define the Set CCB Format request type. Extended LUN Format CCBs are
649 necessary to support more than 8 Logical Units per Target Device.
652 enum blogic_setccb_fmt {
653 BLOGIC_LEGACY_LUN_CCB = 0,
654 BLOGIC_EXT_LUN_CCB = 1
658 Define the Outgoing Mailbox Action Codes.
662 BLOGIC_OUTBOX_FREE = 0x00,
663 BLOGIC_MBOX_START = 0x01,
664 BLOGIC_MBOX_ABORT = 0x02
669 Define the Incoming Mailbox Completion Codes. The MultiMaster Firmware
670 only uses codes 0 - 4. The FlashPoint SCCB Manager has no mailboxes, so
671 completion codes are stored in the CCB; it only uses codes 1, 2, 4, and 5.
674 enum blogic_cmplt_code {
675 BLOGIC_INBOX_FREE = 0x00,
676 BLOGIC_CMD_COMPLETE_GOOD = 0x01,
677 BLOGIC_CMD_ABORT_BY_HOST = 0x02,
678 BLOGIC_CMD_NOTFOUND = 0x03,
679 BLOGIC_CMD_COMPLETE_ERROR = 0x04,
680 BLOGIC_INVALID_CCB = 0x05
684 Define the Command Control Block (CCB) Opcodes.
687 enum blogic_ccb_opcode {
688 BLOGIC_INITIATOR_CCB = 0x00,
689 BLOGIC_TGT_CCB = 0x01,
690 BLOGIC_INITIATOR_CCB_SG = 0x02,
691 BLOGIC_INITIATOR_CCBB_RESIDUAL = 0x03,
692 BLOGIC_INITIATOR_CCB_SG_RESIDUAL = 0x04,
698 Define the CCB Data Direction Codes.
701 enum blogic_datadir {
702 BLOGIC_UNCHECKED_TX = 0,
703 BLOGIC_DATAIN_CHECKED = 1,
704 BLOGIC_DATAOUT_CHECKED = 2,
710 Define the Host Adapter Status Codes. The MultiMaster Firmware does not
711 return status code 0x0C; it uses 0x12 for both overruns and underruns.
714 enum blogic_adapter_status {
715 BLOGIC_CMD_CMPLT_NORMAL = 0x00,
716 BLOGIC_LINK_CMD_CMPLT = 0x0A,
717 BLOGIC_LINK_CMD_CMPLT_FLAG = 0x0B,
718 BLOGIC_DATA_UNDERRUN = 0x0C,
719 BLOGIC_SELECT_TIMEOUT = 0x11,
720 BLOGIC_DATA_OVERRUN = 0x12,
721 BLOGIC_NOEXPECT_BUSFREE = 0x13,
722 BLOGIC_INVALID_BUSPHASE = 0x14,
723 BLOGIC_INVALID_OUTBOX_CODE = 0x15,
724 BLOGIC_INVALID_CMD_CODE = 0x16,
725 BLOGIC_LINKCCB_BADLUN = 0x17,
726 BLOGIC_BAD_CMD_PARAM = 0x1A,
727 BLOGIC_AUTOREQSENSE_FAIL = 0x1B,
728 BLOGIC_TAGQUEUE_REJECT = 0x1C,
729 BLOGIC_BAD_MSG_RCVD = 0x1D,
730 BLOGIC_HW_FAIL = 0x20,
731 BLOGIC_NORESPONSE_TO_ATN = 0x21,
732 BLOGIC_HW_RESET = 0x22,
733 BLOGIC_RST_FROM_OTHERDEV = 0x23,
734 BLOGIC_BAD_RECONNECT = 0x24,
735 BLOGIC_HW_BDR = 0x25,
736 BLOGIC_ABRT_QUEUE = 0x26,
737 BLOGIC_ADAPTER_SW_ERROR = 0x27,
738 BLOGIC_HW_TIMEOUT = 0x30,
739 BLOGIC_PARITY_ERR = 0x34
744 Define the SCSI Target Device Status Codes.
747 enum blogic_tgt_status {
748 BLOGIC_OP_GOOD = 0x00,
749 BLOGIC_CHECKCONDITION = 0x02,
750 BLOGIC_DEVBUSY = 0x08
754 Define the Queue Tag Codes.
757 enum blogic_queuetag {
758 BLOGIC_SIMPLETAG = 0,
760 BLOGIC_ORDEREDTAG = 2,
765 Define the SCSI Command Descriptor Block (CDB).
768 #define BLOGIC_CDB_MAXLEN 12
772 Define the Scatter/Gather Segment structure required by the MultiMaster
773 Firmware Interface and the FlashPoint SCCB Manager.
776 struct blogic_sg_seg {
777 u32 segbytes; /* Bytes 0-3 */
778 u32 segdata; /* Bytes 4-7 */
782 Define the Driver CCB Status Codes.
785 enum blogic_ccb_status {
787 BLOGIC_CCB_ACTIVE = 1,
788 BLOGIC_CCB_COMPLETE = 2,
794 Define the 32 Bit Mode Command Control Block (CCB) structure. The first 40
795 bytes are defined by and common to both the MultiMaster Firmware and the
796 FlashPoint SCCB Manager. The next 60 bytes are defined by the FlashPoint
797 SCCB Manager. The remaining components are defined by the Linux BusLogic
798 Driver. Extended LUN Format CCBs differ from Legacy LUN Format 32 Bit Mode
799 CCBs only in having the TagEnable and QueueTag fields moved from byte 17 to
800 byte 1, and the Logical Unit field in byte 17 expanded to 6 bits. In theory,
801 Extended LUN Format CCBs can support up to 64 Logical Units, but in practice
802 many devices will respond improperly to Logical Units between 32 and 63, and
803 the SCSI-2 specification defines Bit 5 as LUNTAR. Extended LUN Format CCBs
804 are used by recent versions of the MultiMaster Firmware, as well as by the
805 FlashPoint SCCB Manager; the FlashPoint SCCB Manager only supports 32 Logical
806 Units. Since 64 Logical Units are unlikely to be needed in practice, and
807 since they are problematic for the above reasons, and since limiting them to
808 5 bits simplifies the CCB structure definition, this driver only supports
809 32 Logical Units per Target Device.
814 MultiMaster Firmware and FlashPoint SCCB Manager Common Portion.
816 enum blogic_ccb_opcode opcode; /* Byte 0 */
817 unsigned char:3; /* Byte 1 Bits 0-2 */
818 enum blogic_datadir datadir:2; /* Byte 1 Bits 3-4 */
819 bool tag_enable:1; /* Byte 1 Bit 5 */
820 enum blogic_queuetag queuetag:2; /* Byte 1 Bits 6-7 */
821 unsigned char cdblen; /* Byte 2 */
822 unsigned char sense_datalen; /* Byte 3 */
823 u32 datalen; /* Bytes 4-7 */
824 void *data; /* Bytes 8-11 */
825 unsigned char:8; /* Byte 12 */
826 unsigned char:8; /* Byte 13 */
827 enum blogic_adapter_status adapter_status; /* Byte 14 */
828 enum blogic_tgt_status tgt_status; /* Byte 15 */
829 unsigned char tgt_id; /* Byte 16 */
830 unsigned char lun:5; /* Byte 17 Bits 0-4 */
831 bool legacytag_enable:1; /* Byte 17 Bit 5 */
832 enum blogic_queuetag legacy_tag:2; /* Byte 17 Bits 6-7 */
833 unsigned char cdb[BLOGIC_CDB_MAXLEN]; /* Bytes 18-29 */
834 unsigned char:8; /* Byte 30 */
835 unsigned char:8; /* Byte 31 */
836 u32 rsvd_int; /* Bytes 32-35 */
837 u32 sensedata; /* Bytes 36-39 */
839 FlashPoint SCCB Manager Defined Portion.
841 void (*callback) (struct blogic_ccb *); /* Bytes 40-43 */
842 u32 base_addr; /* Bytes 44-47 */
843 enum blogic_cmplt_code comp_code; /* Byte 48 */
844 #ifdef CONFIG_SCSI_FLASHPOINT
845 unsigned char:8; /* Byte 49 */
846 u16 os_flags; /* Bytes 50-51 */
847 unsigned char private[24]; /* Bytes 52-99 */
850 unsigned char private2[16];
853 BusLogic Linux Driver Defined Portion.
855 dma_addr_t allocgrp_head;
856 unsigned int allocgrp_size;
858 enum blogic_ccb_status status;
859 unsigned long serial;
860 struct scsi_cmnd *command;
861 struct blogic_adapter *adapter;
862 struct blogic_ccb *next;
863 struct blogic_ccb *next_all;
864 struct blogic_sg_seg sglist[BLOGIC_SG_LIMIT];
868 Define the 32 Bit Mode Outgoing Mailbox structure.
871 struct blogic_outbox {
872 u32 ccb; /* Bytes 0-3 */
873 u32:24; /* Bytes 4-6 */
874 enum blogic_action action; /* Byte 7 */
878 Define the 32 Bit Mode Incoming Mailbox structure.
881 struct blogic_inbox {
882 u32 ccb; /* Bytes 0-3 */
883 enum blogic_adapter_status adapter_status; /* Byte 4 */
884 enum blogic_tgt_status tgt_status; /* Byte 5 */
885 unsigned char:8; /* Byte 6 */
886 enum blogic_cmplt_code comp_code; /* Byte 7 */
891 Define the BusLogic Driver Options structure.
894 struct blogic_drvr_options {
895 unsigned short tagq_ok;
896 unsigned short tagq_ok_mask;
897 unsigned short bus_settle_time;
898 unsigned short stop_tgt_inquiry;
899 unsigned char common_qdepth;
900 unsigned char qdepth[BLOGIC_MAXDEV];
904 Define the Host Adapter Target Flags structure.
907 struct blogic_tgt_flags {
918 Define the Host Adapter Target Statistics structure.
921 #define BLOGIC_SZ_BUCKETS 10
923 struct blogic_tgt_stats {
924 unsigned int cmds_tried;
925 unsigned int cmds_complete;
926 unsigned int read_cmds;
927 unsigned int write_cmds;
928 struct blogic_byte_count bytesread;
929 struct blogic_byte_count byteswritten;
930 unsigned int read_sz_buckets[BLOGIC_SZ_BUCKETS];
931 unsigned int write_sz_buckets[BLOGIC_SZ_BUCKETS];
932 unsigned short aborts_request;
933 unsigned short aborts_tried;
934 unsigned short aborts_done;
935 unsigned short bdr_request;
936 unsigned short bdr_tried;
937 unsigned short bdr_done;
938 unsigned short adatper_reset_req;
939 unsigned short adapter_reset_attempt;
940 unsigned short adapter_reset_done;
944 Define the FlashPoint Card Handle data type.
947 #define FPOINT_BADCARD_HANDLE 0xFFFFFFFFL
951 Define the FlashPoint Information structure. This structure is defined
952 by the FlashPoint SCCB Manager.
956 u32 base_addr; /* Bytes 0-3 */
957 bool present; /* Byte 4 */
958 unsigned char irq_ch; /* Byte 5 */
959 unsigned char scsi_id; /* Byte 6 */
960 unsigned char scsi_lun; /* Byte 7 */
961 u16 fw_rev; /* Bytes 8-9 */
962 u16 sync_ok; /* Bytes 10-11 */
963 u16 fast_ok; /* Bytes 12-13 */
964 u16 ultra_ok; /* Bytes 14-15 */
965 u16 discon_ok; /* Bytes 16-17 */
966 u16 wide_ok; /* Bytes 18-19 */
967 bool parity:1; /* Byte 20 Bit 0 */
968 bool wide:1; /* Byte 20 Bit 1 */
969 bool softreset:1; /* Byte 20 Bit 2 */
970 bool ext_trans_enable:1; /* Byte 20 Bit 3 */
971 bool low_term:1; /* Byte 20 Bit 4 */
972 bool high_term:1; /* Byte 20 Bit 5 */
973 bool report_underrun:1; /* Byte 20 Bit 6 */
974 bool scam_enabled:1; /* Byte 20 Bit 7 */
975 bool scam_lev2:1; /* Byte 21 Bit 0 */
976 unsigned char:7; /* Byte 21 Bits 1-7 */
977 unsigned char family; /* Byte 22 */
978 unsigned char bus_type; /* Byte 23 */
979 unsigned char model[3]; /* Bytes 24-26 */
980 unsigned char relative_cardnum; /* Byte 27 */
981 unsigned char rsvd[4]; /* Bytes 28-31 */
982 u32 os_rsvd; /* Bytes 32-35 */
983 unsigned char translation_info[4]; /* Bytes 36-39 */
984 u32 rsvd2[5]; /* Bytes 40-59 */
985 u32 sec_range; /* Bytes 60-63 */
989 Define the BusLogic Driver Host Adapter structure.
992 struct blogic_adapter {
993 struct Scsi_Host *scsi_host;
994 struct pci_dev *pci_device;
995 enum blogic_adapter_type adapter_type;
996 enum blogic_adapter_bus_type adapter_bus_type;
997 unsigned long io_addr;
998 unsigned long pci_addr;
999 unsigned short addr_count;
1000 unsigned char host_no;
1001 unsigned char model[9];
1002 unsigned char fw_ver[6];
1003 unsigned char full_model[18];
1006 unsigned char irq_ch;
1007 unsigned char dma_ch;
1008 unsigned char scsi_id;
1009 bool irq_acquired:1;
1010 bool dma_chan_acquired:1;
1011 bool ext_trans_enable:1;
1013 bool reset_enabled:1;
1016 bool differential:1;
1020 bool terminfo_valid:1;
1023 bool need_bouncebuf:1;
1025 bool scam_enabled:1;
1027 bool adapter_initd:1;
1028 bool adapter_extreset:1;
1029 bool adapter_intern_err:1;
1030 bool processing_ccbs;
1031 volatile bool adapter_cmd_complete;
1032 unsigned short adapter_sglimit;
1033 unsigned short drvr_sglimit;
1034 unsigned short maxdev;
1035 unsigned short maxlun;
1036 unsigned short mbox_count;
1037 unsigned short initccbs;
1038 unsigned short inc_ccbs;
1039 unsigned short alloc_ccbs;
1040 unsigned short drvr_qdepth;
1041 unsigned short adapter_qdepth;
1042 unsigned short untag_qdepth;
1043 unsigned short common_qdepth;
1044 unsigned short bus_settle_time;
1045 unsigned short sync_ok;
1046 unsigned short fast_ok;
1047 unsigned short ultra_ok;
1048 unsigned short wide_ok;
1049 unsigned short discon_ok;
1050 unsigned short tagq_ok;
1051 unsigned short ext_resets;
1052 unsigned short adapter_intern_errors;
1053 unsigned short tgt_count;
1054 unsigned short msgbuflen;
1056 struct blogic_drvr_options *drvr_opts;
1057 struct fpoint_info fpinfo;
1059 struct list_head host_list;
1060 struct blogic_ccb *all_ccbs;
1061 struct blogic_ccb *free_ccbs;
1062 struct blogic_ccb *firstccb;
1063 struct blogic_ccb *lastccb;
1064 struct blogic_ccb *bdr_pend[BLOGIC_MAXDEV];
1065 struct blogic_tgt_flags tgt_flags[BLOGIC_MAXDEV];
1066 unsigned char qdepth[BLOGIC_MAXDEV];
1067 unsigned char sync_period[BLOGIC_MAXDEV];
1068 unsigned char sync_offset[BLOGIC_MAXDEV];
1069 unsigned char active_cmds[BLOGIC_MAXDEV];
1070 unsigned int cmds_since_rst[BLOGIC_MAXDEV];
1071 unsigned long last_seqpoint[BLOGIC_MAXDEV];
1072 unsigned long last_resettried[BLOGIC_MAXDEV];
1073 unsigned long last_resetdone[BLOGIC_MAXDEV];
1074 struct blogic_outbox *first_outbox;
1075 struct blogic_outbox *last_outbox;
1076 struct blogic_outbox *next_outbox;
1077 struct blogic_inbox *first_inbox;
1078 struct blogic_inbox *last_inbox;
1079 struct blogic_inbox *next_inbox;
1080 struct blogic_tgt_stats tgt_stats[BLOGIC_MAXDEV];
1081 unsigned char *mbox_space;
1082 dma_addr_t mbox_space_handle;
1083 unsigned int mbox_sz;
1084 unsigned long ccb_offset;
1085 char msgbuf[BLOGIC_MSGBUF_SIZE];
1089 Define a structure for the BIOS Disk Parameters.
1092 struct bios_diskparam {
1099 Define a structure for the SCSI Inquiry command results.
1102 struct scsi_inquiry {
1103 unsigned char devtype:5; /* Byte 0 Bits 0-4 */
1104 unsigned char dev_qual:3; /* Byte 0 Bits 5-7 */
1105 unsigned char dev_modifier:7; /* Byte 1 Bits 0-6 */
1106 bool rmb:1; /* Byte 1 Bit 7 */
1107 unsigned char ansi_ver:3; /* Byte 2 Bits 0-2 */
1108 unsigned char ecma_ver:3; /* Byte 2 Bits 3-5 */
1109 unsigned char iso_ver:2; /* Byte 2 Bits 6-7 */
1110 unsigned char resp_fmt:4; /* Byte 3 Bits 0-3 */
1111 unsigned char:2; /* Byte 3 Bits 4-5 */
1112 bool TrmIOP:1; /* Byte 3 Bit 6 */
1113 bool AENC:1; /* Byte 3 Bit 7 */
1114 unsigned char addl_len; /* Byte 4 */
1115 unsigned char:8; /* Byte 5 */
1116 unsigned char:8; /* Byte 6 */
1117 bool SftRe:1; /* Byte 7 Bit 0 */
1118 bool CmdQue:1; /* Byte 7 Bit 1 */
1119 bool:1; /* Byte 7 Bit 2 */
1120 bool linked:1; /* Byte 7 Bit 3 */
1121 bool sync:1; /* Byte 7 Bit 4 */
1122 bool WBus16:1; /* Byte 7 Bit 5 */
1123 bool WBus32:1; /* Byte 7 Bit 6 */
1124 bool RelAdr:1; /* Byte 7 Bit 7 */
1125 unsigned char vendor[8]; /* Bytes 8-15 */
1126 unsigned char product[16]; /* Bytes 16-31 */
1127 unsigned char product_rev[4]; /* Bytes 32-35 */
1132 Define functions to provide an abstraction for reading and writing the
1133 Host Adapter I/O Registers.
1136 static inline void blogic_busreset(struct blogic_adapter *adapter)
1138 union blogic_cntrl_reg cr;
1140 cr.cr.bus_reset = true;
1141 outb(cr.all, adapter->io_addr + BLOGIC_CNTRL_REG);
1144 static inline void blogic_intreset(struct blogic_adapter *adapter)
1146 union blogic_cntrl_reg cr;
1148 cr.cr.int_reset = true;
1149 outb(cr.all, adapter->io_addr + BLOGIC_CNTRL_REG);
1152 static inline void blogic_softreset(struct blogic_adapter *adapter)
1154 union blogic_cntrl_reg cr;
1156 cr.cr.soft_reset = true;
1157 outb(cr.all, adapter->io_addr + BLOGIC_CNTRL_REG);
1160 static inline void blogic_hardreset(struct blogic_adapter *adapter)
1162 union blogic_cntrl_reg cr;
1164 cr.cr.hard_reset = true;
1165 outb(cr.all, adapter->io_addr + BLOGIC_CNTRL_REG);
1168 static inline unsigned char blogic_rdstatus(struct blogic_adapter *adapter)
1170 return inb(adapter->io_addr + BLOGIC_STATUS_REG);
1173 static inline void blogic_setcmdparam(struct blogic_adapter *adapter,
1174 unsigned char value)
1176 outb(value, adapter->io_addr + BLOGIC_CMD_PARM_REG);
1179 static inline unsigned char blogic_rddatain(struct blogic_adapter *adapter)
1181 return inb(adapter->io_addr + BLOGIC_DATAIN_REG);
1184 static inline unsigned char blogic_rdint(struct blogic_adapter *adapter)
1186 return inb(adapter->io_addr + BLOGIC_INT_REG);
1189 static inline unsigned char blogic_rdgeom(struct blogic_adapter *adapter)
1191 return inb(adapter->io_addr + BLOGIC_GEOMETRY_REG);
1195 blogic_execmbox issues an Execute Mailbox Command, which
1196 notifies the Host Adapter that an entry has been made in an Outgoing
1200 static inline void blogic_execmbox(struct blogic_adapter *adapter)
1202 blogic_setcmdparam(adapter, BLOGIC_EXEC_MBOX_CMD);
1206 blogic_delay waits for Seconds to elapse.
1209 static inline void blogic_delay(int seconds)
1211 mdelay(1000 * seconds);
1215 virt_to_32bit_virt maps between Kernel Virtual Addresses and
1216 32 bit Kernel Virtual Addresses. This avoids compilation warnings
1217 on 64 bit architectures.
1220 static inline u32 virt_to_32bit_virt(void *virt_addr)
1222 return (u32) (unsigned long) virt_addr;
1226 blogic_inc_count increments counter by 1, stopping at
1227 65535 rather than wrapping around to 0.
1230 static inline void blogic_inc_count(unsigned short *count)
1237 blogic_addcount increments Byte Counter by Amount.
1240 static inline void blogic_addcount(struct blogic_byte_count *bytecount,
1241 unsigned int amount)
1243 bytecount->units += amount;
1244 if (bytecount->units > 999999999) {
1245 bytecount->units -= 1000000000;
1246 bytecount->billions++;
1251 blogic_incszbucket increments the Bucket for Amount.
1254 static inline void blogic_incszbucket(unsigned int *cmdsz_buckets,
1255 unsigned int amount)
1258 if (amount < 8 * 1024) {
1259 if (amount < 2 * 1024)
1260 index = (amount < 1 * 1024 ? 0 : 1);
1262 index = (amount < 4 * 1024 ? 2 : 3);
1263 } else if (amount < 128 * 1024) {
1264 if (amount < 32 * 1024)
1265 index = (amount < 16 * 1024 ? 4 : 5);
1267 index = (amount < 64 * 1024 ? 6 : 7);
1269 index = (amount < 256 * 1024 ? 8 : 9);
1270 cmdsz_buckets[index]++;
1274 Define the version number of the FlashPoint Firmware (SCCB Manager).
1277 #define FLASHPOINT_FW_VER "5.02"
1280 Define the possible return values from FlashPoint_HandleInterrupt.
1283 #define FPOINT_NORMAL_INT 0x00
1284 #define FPOINT_INTERN_ERR 0xFE
1285 #define FPOINT_EXT_RESET 0xFF
1288 Define prototypes for the forward referenced BusLogic Driver
1292 static const char *blogic_drvr_info(struct Scsi_Host *);
1293 static int blogic_qcmd(struct Scsi_Host *h, struct scsi_cmnd *);
1294 static int blogic_diskparam(struct scsi_device *, struct block_device *, sector_t, int *);
1295 static int blogic_slaveconfig(struct scsi_device *);
1296 static void blogic_qcompleted_ccb(struct blogic_ccb *);
1297 static irqreturn_t blogic_inthandler(int, void *);
1298 static int blogic_resetadapter(struct blogic_adapter *, bool hard_reset);
1299 static void blogic_msg(enum blogic_msglevel, char *, struct blogic_adapter *, ...);
1300 static int __init blogic_setup(char *);
1302 #endif /* _BUSLOGIC_H */