KVM: x86: always use "acknowledge interrupt on exit"
[linux/fpc-iii.git] / drivers / scsi / nsp32.c
blob53c84771f0e8939f53e561cad198c40ac337c2f2
1 /*
2 * NinjaSCSI-32Bi Cardbus, NinjaSCSI-32UDE PCI/CardBus SCSI driver
3 * Copyright (C) 2001, 2002, 2003
4 * YOKOTA Hiroshi <yokota@netlab.is.tsukuba.ac.jp>
5 * GOTO Masanori <gotom@debian.or.jp>, <gotom@debian.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2, or (at your option)
10 * any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 * Revision History:
19 * 1.0: Initial Release.
20 * 1.1: Add /proc SDTR status.
21 * Remove obsolete error handler nsp32_reset.
22 * Some clean up.
23 * 1.2: PowerPC (big endian) support.
26 #include <linux/module.h>
27 #include <linux/init.h>
28 #include <linux/kernel.h>
29 #include <linux/string.h>
30 #include <linux/timer.h>
31 #include <linux/ioport.h>
32 #include <linux/major.h>
33 #include <linux/blkdev.h>
34 #include <linux/interrupt.h>
35 #include <linux/pci.h>
36 #include <linux/delay.h>
37 #include <linux/ctype.h>
38 #include <linux/dma-mapping.h>
40 #include <asm/dma.h>
41 #include <asm/io.h>
43 #include <scsi/scsi.h>
44 #include <scsi/scsi_cmnd.h>
45 #include <scsi/scsi_device.h>
46 #include <scsi/scsi_host.h>
47 #include <scsi/scsi_ioctl.h>
49 #include "nsp32.h"
52 /***********************************************************************
53 * Module parameters
55 static int trans_mode = 0; /* default: BIOS */
56 module_param (trans_mode, int, 0);
57 MODULE_PARM_DESC(trans_mode, "transfer mode (0: BIOS(default) 1: Async 2: Ultra20M");
58 #define ASYNC_MODE 1
59 #define ULTRA20M_MODE 2
61 static bool auto_param = 0; /* default: ON */
62 module_param (auto_param, bool, 0);
63 MODULE_PARM_DESC(auto_param, "AutoParameter mode (0: ON(default) 1: OFF)");
65 static bool disc_priv = 1; /* default: OFF */
66 module_param (disc_priv, bool, 0);
67 MODULE_PARM_DESC(disc_priv, "disconnection privilege mode (0: ON 1: OFF(default))");
69 MODULE_AUTHOR("YOKOTA Hiroshi <yokota@netlab.is.tsukuba.ac.jp>, GOTO Masanori <gotom@debian.or.jp>");
70 MODULE_DESCRIPTION("Workbit NinjaSCSI-32Bi/UDE CardBus/PCI SCSI host bus adapter module");
71 MODULE_LICENSE("GPL");
73 static const char *nsp32_release_version = "1.2";
76 /****************************************************************************
77 * Supported hardware
79 static struct pci_device_id nsp32_pci_table[] = {
81 .vendor = PCI_VENDOR_ID_IODATA,
82 .device = PCI_DEVICE_ID_NINJASCSI_32BI_CBSC_II,
83 .subvendor = PCI_ANY_ID,
84 .subdevice = PCI_ANY_ID,
85 .driver_data = MODEL_IODATA,
88 .vendor = PCI_VENDOR_ID_WORKBIT,
89 .device = PCI_DEVICE_ID_NINJASCSI_32BI_KME,
90 .subvendor = PCI_ANY_ID,
91 .subdevice = PCI_ANY_ID,
92 .driver_data = MODEL_KME,
95 .vendor = PCI_VENDOR_ID_WORKBIT,
96 .device = PCI_DEVICE_ID_NINJASCSI_32BI_WBT,
97 .subvendor = PCI_ANY_ID,
98 .subdevice = PCI_ANY_ID,
99 .driver_data = MODEL_WORKBIT,
102 .vendor = PCI_VENDOR_ID_WORKBIT,
103 .device = PCI_DEVICE_ID_WORKBIT_STANDARD,
104 .subvendor = PCI_ANY_ID,
105 .subdevice = PCI_ANY_ID,
106 .driver_data = MODEL_PCI_WORKBIT,
109 .vendor = PCI_VENDOR_ID_WORKBIT,
110 .device = PCI_DEVICE_ID_NINJASCSI_32BI_LOGITEC,
111 .subvendor = PCI_ANY_ID,
112 .subdevice = PCI_ANY_ID,
113 .driver_data = MODEL_LOGITEC,
116 .vendor = PCI_VENDOR_ID_WORKBIT,
117 .device = PCI_DEVICE_ID_NINJASCSI_32BIB_LOGITEC,
118 .subvendor = PCI_ANY_ID,
119 .subdevice = PCI_ANY_ID,
120 .driver_data = MODEL_PCI_LOGITEC,
123 .vendor = PCI_VENDOR_ID_WORKBIT,
124 .device = PCI_DEVICE_ID_NINJASCSI_32UDE_MELCO,
125 .subvendor = PCI_ANY_ID,
126 .subdevice = PCI_ANY_ID,
127 .driver_data = MODEL_PCI_MELCO,
130 .vendor = PCI_VENDOR_ID_WORKBIT,
131 .device = PCI_DEVICE_ID_NINJASCSI_32UDE_MELCO_II,
132 .subvendor = PCI_ANY_ID,
133 .subdevice = PCI_ANY_ID,
134 .driver_data = MODEL_PCI_MELCO,
136 {0,0,},
138 MODULE_DEVICE_TABLE(pci, nsp32_pci_table);
140 static nsp32_hw_data nsp32_data_base; /* probe <-> detect glue */
144 * Period/AckWidth speed conversion table
146 * Note: This period/ackwidth speed table must be in descending order.
148 static nsp32_sync_table nsp32_sync_table_40M[] = {
149 /* {PNo, AW, SP, EP, SREQ smpl} Speed(MB/s) Period AckWidth */
150 {0x1, 0, 0x0c, 0x0c, SMPL_40M}, /* 20.0 : 50ns, 25ns */
151 {0x2, 0, 0x0d, 0x18, SMPL_40M}, /* 13.3 : 75ns, 25ns */
152 {0x3, 1, 0x19, 0x19, SMPL_40M}, /* 10.0 : 100ns, 50ns */
153 {0x4, 1, 0x1a, 0x1f, SMPL_20M}, /* 8.0 : 125ns, 50ns */
154 {0x5, 2, 0x20, 0x25, SMPL_20M}, /* 6.7 : 150ns, 75ns */
155 {0x6, 2, 0x26, 0x31, SMPL_20M}, /* 5.7 : 175ns, 75ns */
156 {0x7, 3, 0x32, 0x32, SMPL_20M}, /* 5.0 : 200ns, 100ns */
157 {0x8, 3, 0x33, 0x38, SMPL_10M}, /* 4.4 : 225ns, 100ns */
158 {0x9, 3, 0x39, 0x3e, SMPL_10M}, /* 4.0 : 250ns, 100ns */
161 static nsp32_sync_table nsp32_sync_table_20M[] = {
162 {0x1, 0, 0x19, 0x19, SMPL_40M}, /* 10.0 : 100ns, 50ns */
163 {0x2, 0, 0x1a, 0x25, SMPL_20M}, /* 6.7 : 150ns, 50ns */
164 {0x3, 1, 0x26, 0x32, SMPL_20M}, /* 5.0 : 200ns, 100ns */
165 {0x4, 1, 0x33, 0x3e, SMPL_10M}, /* 4.0 : 250ns, 100ns */
166 {0x5, 2, 0x3f, 0x4b, SMPL_10M}, /* 3.3 : 300ns, 150ns */
167 {0x6, 2, 0x4c, 0x57, SMPL_10M}, /* 2.8 : 350ns, 150ns */
168 {0x7, 3, 0x58, 0x64, SMPL_10M}, /* 2.5 : 400ns, 200ns */
169 {0x8, 3, 0x65, 0x70, SMPL_10M}, /* 2.2 : 450ns, 200ns */
170 {0x9, 3, 0x71, 0x7d, SMPL_10M}, /* 2.0 : 500ns, 200ns */
173 static nsp32_sync_table nsp32_sync_table_pci[] = {
174 {0x1, 0, 0x0c, 0x0f, SMPL_40M}, /* 16.6 : 60ns, 30ns */
175 {0x2, 0, 0x10, 0x16, SMPL_40M}, /* 11.1 : 90ns, 30ns */
176 {0x3, 1, 0x17, 0x1e, SMPL_20M}, /* 8.3 : 120ns, 60ns */
177 {0x4, 1, 0x1f, 0x25, SMPL_20M}, /* 6.7 : 150ns, 60ns */
178 {0x5, 2, 0x26, 0x2d, SMPL_20M}, /* 5.6 : 180ns, 90ns */
179 {0x6, 2, 0x2e, 0x34, SMPL_10M}, /* 4.8 : 210ns, 90ns */
180 {0x7, 3, 0x35, 0x3c, SMPL_10M}, /* 4.2 : 240ns, 120ns */
181 {0x8, 3, 0x3d, 0x43, SMPL_10M}, /* 3.7 : 270ns, 120ns */
182 {0x9, 3, 0x44, 0x4b, SMPL_10M}, /* 3.3 : 300ns, 120ns */
186 * function declaration
188 /* module entry point */
189 static int nsp32_probe (struct pci_dev *, const struct pci_device_id *);
190 static void nsp32_remove(struct pci_dev *);
191 static int __init init_nsp32 (void);
192 static void __exit exit_nsp32 (void);
194 /* struct struct scsi_host_template */
195 static int nsp32_show_info (struct seq_file *, struct Scsi_Host *);
197 static int nsp32_detect (struct pci_dev *pdev);
198 static int nsp32_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
199 static const char *nsp32_info (struct Scsi_Host *);
200 static int nsp32_release (struct Scsi_Host *);
202 /* SCSI error handler */
203 static int nsp32_eh_abort (struct scsi_cmnd *);
204 static int nsp32_eh_bus_reset (struct scsi_cmnd *);
205 static int nsp32_eh_host_reset(struct scsi_cmnd *);
207 /* generate SCSI message */
208 static void nsp32_build_identify(struct scsi_cmnd *);
209 static void nsp32_build_nop (struct scsi_cmnd *);
210 static void nsp32_build_reject (struct scsi_cmnd *);
211 static void nsp32_build_sdtr (struct scsi_cmnd *, unsigned char, unsigned char);
213 /* SCSI message handler */
214 static int nsp32_busfree_occur(struct scsi_cmnd *, unsigned short);
215 static void nsp32_msgout_occur (struct scsi_cmnd *);
216 static void nsp32_msgin_occur (struct scsi_cmnd *, unsigned long, unsigned short);
218 static int nsp32_setup_sg_table (struct scsi_cmnd *);
219 static int nsp32_selection_autopara(struct scsi_cmnd *);
220 static int nsp32_selection_autoscsi(struct scsi_cmnd *);
221 static void nsp32_scsi_done (struct scsi_cmnd *);
222 static int nsp32_arbitration (struct scsi_cmnd *, unsigned int);
223 static int nsp32_reselection (struct scsi_cmnd *, unsigned char);
224 static void nsp32_adjust_busfree (struct scsi_cmnd *, unsigned int);
225 static void nsp32_restart_autoscsi (struct scsi_cmnd *, unsigned short);
227 /* SCSI SDTR */
228 static void nsp32_analyze_sdtr (struct scsi_cmnd *);
229 static int nsp32_search_period_entry(nsp32_hw_data *, nsp32_target *, unsigned char);
230 static void nsp32_set_async (nsp32_hw_data *, nsp32_target *);
231 static void nsp32_set_max_sync (nsp32_hw_data *, nsp32_target *, unsigned char *, unsigned char *);
232 static void nsp32_set_sync_entry (nsp32_hw_data *, nsp32_target *, int, unsigned char);
234 /* SCSI bus status handler */
235 static void nsp32_wait_req (nsp32_hw_data *, int);
236 static void nsp32_wait_sack (nsp32_hw_data *, int);
237 static void nsp32_sack_assert (nsp32_hw_data *);
238 static void nsp32_sack_negate (nsp32_hw_data *);
239 static void nsp32_do_bus_reset(nsp32_hw_data *);
241 /* hardware interrupt handler */
242 static irqreturn_t do_nsp32_isr(int, void *);
244 /* initialize hardware */
245 static int nsp32hw_init(nsp32_hw_data *);
247 /* EEPROM handler */
248 static int nsp32_getprom_param (nsp32_hw_data *);
249 static int nsp32_getprom_at24 (nsp32_hw_data *);
250 static int nsp32_getprom_c16 (nsp32_hw_data *);
251 static void nsp32_prom_start (nsp32_hw_data *);
252 static void nsp32_prom_stop (nsp32_hw_data *);
253 static int nsp32_prom_read (nsp32_hw_data *, int);
254 static int nsp32_prom_read_bit (nsp32_hw_data *);
255 static void nsp32_prom_write_bit(nsp32_hw_data *, int);
256 static void nsp32_prom_set (nsp32_hw_data *, int, int);
257 static int nsp32_prom_get (nsp32_hw_data *, int);
259 /* debug/warning/info message */
260 static void nsp32_message (const char *, int, char *, char *, ...);
261 #ifdef NSP32_DEBUG
262 static void nsp32_dmessage(const char *, int, int, char *, ...);
263 #endif
266 * max_sectors is currently limited up to 128.
268 static struct scsi_host_template nsp32_template = {
269 .proc_name = "nsp32",
270 .name = "Workbit NinjaSCSI-32Bi/UDE",
271 .show_info = nsp32_show_info,
272 .info = nsp32_info,
273 .queuecommand = nsp32_queuecommand,
274 .can_queue = 1,
275 .sg_tablesize = NSP32_SG_SIZE,
276 .max_sectors = 128,
277 .this_id = NSP32_HOST_SCSIID,
278 .use_clustering = DISABLE_CLUSTERING,
279 .eh_abort_handler = nsp32_eh_abort,
280 .eh_bus_reset_handler = nsp32_eh_bus_reset,
281 .eh_host_reset_handler = nsp32_eh_host_reset,
282 /* .highmem_io = 1, */
285 #include "nsp32_io.h"
287 /***********************************************************************
288 * debug, error print
290 #ifndef NSP32_DEBUG
291 # define NSP32_DEBUG_MASK 0x000000
292 # define nsp32_msg(type, args...) nsp32_message ("", 0, (type), args)
293 # define nsp32_dbg(mask, args...) /* */
294 #else
295 # define NSP32_DEBUG_MASK 0xffffff
296 # define nsp32_msg(type, args...) \
297 nsp32_message (__func__, __LINE__, (type), args)
298 # define nsp32_dbg(mask, args...) \
299 nsp32_dmessage(__func__, __LINE__, (mask), args)
300 #endif
302 #define NSP32_DEBUG_QUEUECOMMAND BIT(0)
303 #define NSP32_DEBUG_REGISTER BIT(1)
304 #define NSP32_DEBUG_AUTOSCSI BIT(2)
305 #define NSP32_DEBUG_INTR BIT(3)
306 #define NSP32_DEBUG_SGLIST BIT(4)
307 #define NSP32_DEBUG_BUSFREE BIT(5)
308 #define NSP32_DEBUG_CDB_CONTENTS BIT(6)
309 #define NSP32_DEBUG_RESELECTION BIT(7)
310 #define NSP32_DEBUG_MSGINOCCUR BIT(8)
311 #define NSP32_DEBUG_EEPROM BIT(9)
312 #define NSP32_DEBUG_MSGOUTOCCUR BIT(10)
313 #define NSP32_DEBUG_BUSRESET BIT(11)
314 #define NSP32_DEBUG_RESTART BIT(12)
315 #define NSP32_DEBUG_SYNC BIT(13)
316 #define NSP32_DEBUG_WAIT BIT(14)
317 #define NSP32_DEBUG_TARGETFLAG BIT(15)
318 #define NSP32_DEBUG_PROC BIT(16)
319 #define NSP32_DEBUG_INIT BIT(17)
320 #define NSP32_SPECIAL_PRINT_REGISTER BIT(20)
322 #define NSP32_DEBUG_BUF_LEN 100
324 static void nsp32_message(const char *func, int line, char *type, char *fmt, ...)
326 va_list args;
327 char buf[NSP32_DEBUG_BUF_LEN];
329 va_start(args, fmt);
330 vsnprintf(buf, sizeof(buf), fmt, args);
331 va_end(args);
333 #ifndef NSP32_DEBUG
334 printk("%snsp32: %s\n", type, buf);
335 #else
336 printk("%snsp32: %s (%d): %s\n", type, func, line, buf);
337 #endif
340 #ifdef NSP32_DEBUG
341 static void nsp32_dmessage(const char *func, int line, int mask, char *fmt, ...)
343 va_list args;
344 char buf[NSP32_DEBUG_BUF_LEN];
346 va_start(args, fmt);
347 vsnprintf(buf, sizeof(buf), fmt, args);
348 va_end(args);
350 if (mask & NSP32_DEBUG_MASK) {
351 printk("nsp32-debug: 0x%x %s (%d): %s\n", mask, func, line, buf);
354 #endif
356 #ifdef NSP32_DEBUG
357 # include "nsp32_debug.c"
358 #else
359 # define show_command(arg) /* */
360 # define show_busphase(arg) /* */
361 # define show_autophase(arg) /* */
362 #endif
365 * IDENTIFY Message
367 static void nsp32_build_identify(struct scsi_cmnd *SCpnt)
369 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
370 int pos = data->msgout_len;
371 int mode = FALSE;
373 /* XXX: Auto DiscPriv detection is progressing... */
374 if (disc_priv == 0) {
375 /* mode = TRUE; */
378 data->msgoutbuf[pos] = IDENTIFY(mode, SCpnt->device->lun); pos++;
380 data->msgout_len = pos;
384 * SDTR Message Routine
386 static void nsp32_build_sdtr(struct scsi_cmnd *SCpnt,
387 unsigned char period,
388 unsigned char offset)
390 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
391 int pos = data->msgout_len;
393 data->msgoutbuf[pos] = EXTENDED_MESSAGE; pos++;
394 data->msgoutbuf[pos] = EXTENDED_SDTR_LEN; pos++;
395 data->msgoutbuf[pos] = EXTENDED_SDTR; pos++;
396 data->msgoutbuf[pos] = period; pos++;
397 data->msgoutbuf[pos] = offset; pos++;
399 data->msgout_len = pos;
403 * No Operation Message
405 static void nsp32_build_nop(struct scsi_cmnd *SCpnt)
407 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
408 int pos = data->msgout_len;
410 if (pos != 0) {
411 nsp32_msg(KERN_WARNING,
412 "Some messages are already contained!");
413 return;
416 data->msgoutbuf[pos] = NOP; pos++;
417 data->msgout_len = pos;
421 * Reject Message
423 static void nsp32_build_reject(struct scsi_cmnd *SCpnt)
425 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
426 int pos = data->msgout_len;
428 data->msgoutbuf[pos] = MESSAGE_REJECT; pos++;
429 data->msgout_len = pos;
433 * timer
435 #if 0
436 static void nsp32_start_timer(struct scsi_cmnd *SCpnt, int time)
438 unsigned int base = SCpnt->host->io_port;
440 nsp32_dbg(NSP32_DEBUG_INTR, "timer=%d", time);
442 if (time & (~TIMER_CNT_MASK)) {
443 nsp32_dbg(NSP32_DEBUG_INTR, "timer set overflow");
446 nsp32_write2(base, TIMER_SET, time & TIMER_CNT_MASK);
448 #endif
452 * set SCSI command and other parameter to asic, and start selection phase
454 static int nsp32_selection_autopara(struct scsi_cmnd *SCpnt)
456 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
457 unsigned int base = SCpnt->device->host->io_port;
458 unsigned int host_id = SCpnt->device->host->this_id;
459 unsigned char target = scmd_id(SCpnt);
460 nsp32_autoparam *param = data->autoparam;
461 unsigned char phase;
462 int i, ret;
463 unsigned int msgout;
464 u16_le s;
466 nsp32_dbg(NSP32_DEBUG_AUTOSCSI, "in");
469 * check bus free
471 phase = nsp32_read1(base, SCSI_BUS_MONITOR);
472 if (phase != BUSMON_BUS_FREE) {
473 nsp32_msg(KERN_WARNING, "bus busy");
474 show_busphase(phase & BUSMON_PHASE_MASK);
475 SCpnt->result = DID_BUS_BUSY << 16;
476 return FALSE;
480 * message out
482 * Note: If the range of msgout_len is 1 - 3, fill scsi_msgout.
483 * over 3 messages needs another routine.
485 if (data->msgout_len == 0) {
486 nsp32_msg(KERN_ERR, "SCSI MsgOut without any message!");
487 SCpnt->result = DID_ERROR << 16;
488 return FALSE;
489 } else if (data->msgout_len > 0 && data->msgout_len <= 3) {
490 msgout = 0;
491 for (i = 0; i < data->msgout_len; i++) {
493 * the sending order of the message is:
494 * MCNT 3: MSG#0 -> MSG#1 -> MSG#2
495 * MCNT 2: MSG#1 -> MSG#2
496 * MCNT 1: MSG#2
498 msgout >>= 8;
499 msgout |= ((unsigned int)(data->msgoutbuf[i]) << 24);
501 msgout |= MV_VALID; /* MV valid */
502 msgout |= (unsigned int)data->msgout_len; /* len */
503 } else {
504 /* data->msgout_len > 3 */
505 msgout = 0;
508 // nsp_dbg(NSP32_DEBUG_AUTOSCSI, "sel time out=0x%x\n", nsp32_read2(base, SEL_TIME_OUT));
509 // nsp32_write2(base, SEL_TIME_OUT, SEL_TIMEOUT_TIME);
512 * setup asic parameter
514 memset(param, 0, sizeof(nsp32_autoparam));
516 /* cdb */
517 for (i = 0; i < SCpnt->cmd_len; i++) {
518 param->cdb[4 * i] = SCpnt->cmnd[i];
521 /* outgoing messages */
522 param->msgout = cpu_to_le32(msgout);
524 /* syncreg, ackwidth, target id, SREQ sampling rate */
525 param->syncreg = data->cur_target->syncreg;
526 param->ackwidth = data->cur_target->ackwidth;
527 param->target_id = BIT(host_id) | BIT(target);
528 param->sample_reg = data->cur_target->sample_reg;
530 // nsp32_dbg(NSP32_DEBUG_AUTOSCSI, "sample rate=0x%x\n", data->cur_target->sample_reg);
532 /* command control */
533 param->command_control = cpu_to_le16(CLEAR_CDB_FIFO_POINTER |
534 AUTOSCSI_START |
535 AUTO_MSGIN_00_OR_04 |
536 AUTO_MSGIN_02 |
537 AUTO_ATN );
540 /* transfer control */
541 s = 0;
542 switch (data->trans_method) {
543 case NSP32_TRANSFER_BUSMASTER:
544 s |= BM_START;
545 break;
546 case NSP32_TRANSFER_MMIO:
547 s |= CB_MMIO_MODE;
548 break;
549 case NSP32_TRANSFER_PIO:
550 s |= CB_IO_MODE;
551 break;
552 default:
553 nsp32_msg(KERN_ERR, "unknown trans_method");
554 break;
557 * OR-ed BLIEND_MODE, FIFO intr is decreased, instead of PCI bus waits.
558 * For bus master transfer, it's taken off.
560 s |= (TRANSFER_GO | ALL_COUNTER_CLR);
561 param->transfer_control = cpu_to_le16(s);
563 /* sg table addr */
564 param->sgt_pointer = cpu_to_le32(data->cur_lunt->sglun_paddr);
567 * transfer parameter to ASIC
569 nsp32_write4(base, SGT_ADR, data->auto_paddr);
570 nsp32_write2(base, COMMAND_CONTROL, CLEAR_CDB_FIFO_POINTER |
571 AUTO_PARAMETER );
574 * Check arbitration
576 ret = nsp32_arbitration(SCpnt, base);
578 return ret;
583 * Selection with AUTO SCSI (without AUTO PARAMETER)
585 static int nsp32_selection_autoscsi(struct scsi_cmnd *SCpnt)
587 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
588 unsigned int base = SCpnt->device->host->io_port;
589 unsigned int host_id = SCpnt->device->host->this_id;
590 unsigned char target = scmd_id(SCpnt);
591 unsigned char phase;
592 int status;
593 unsigned short command = 0;
594 unsigned int msgout = 0;
595 unsigned short execph;
596 int i;
598 nsp32_dbg(NSP32_DEBUG_AUTOSCSI, "in");
601 * IRQ disable
603 nsp32_write2(base, IRQ_CONTROL, IRQ_CONTROL_ALL_IRQ_MASK);
606 * check bus line
608 phase = nsp32_read1(base, SCSI_BUS_MONITOR);
609 if(((phase & BUSMON_BSY) == 1) || (phase & BUSMON_SEL) == 1) {
610 nsp32_msg(KERN_WARNING, "bus busy");
611 SCpnt->result = DID_BUS_BUSY << 16;
612 status = 1;
613 goto out;
617 * clear execph
619 execph = nsp32_read2(base, SCSI_EXECUTE_PHASE);
622 * clear FIFO counter to set CDBs
624 nsp32_write2(base, COMMAND_CONTROL, CLEAR_CDB_FIFO_POINTER);
627 * set CDB0 - CDB15
629 for (i = 0; i < SCpnt->cmd_len; i++) {
630 nsp32_write1(base, COMMAND_DATA, SCpnt->cmnd[i]);
632 nsp32_dbg(NSP32_DEBUG_CDB_CONTENTS, "CDB[0]=[0x%x]", SCpnt->cmnd[0]);
635 * set SCSIOUT LATCH(initiator)/TARGET(target) (OR-ed) ID
637 nsp32_write1(base, SCSI_OUT_LATCH_TARGET_ID, BIT(host_id) | BIT(target));
640 * set SCSI MSGOUT REG
642 * Note: If the range of msgout_len is 1 - 3, fill scsi_msgout.
643 * over 3 messages needs another routine.
645 if (data->msgout_len == 0) {
646 nsp32_msg(KERN_ERR, "SCSI MsgOut without any message!");
647 SCpnt->result = DID_ERROR << 16;
648 status = 1;
649 goto out;
650 } else if (data->msgout_len > 0 && data->msgout_len <= 3) {
651 msgout = 0;
652 for (i = 0; i < data->msgout_len; i++) {
654 * the sending order of the message is:
655 * MCNT 3: MSG#0 -> MSG#1 -> MSG#2
656 * MCNT 2: MSG#1 -> MSG#2
657 * MCNT 1: MSG#2
659 msgout >>= 8;
660 msgout |= ((unsigned int)(data->msgoutbuf[i]) << 24);
662 msgout |= MV_VALID; /* MV valid */
663 msgout |= (unsigned int)data->msgout_len; /* len */
664 nsp32_write4(base, SCSI_MSG_OUT, msgout);
665 } else {
666 /* data->msgout_len > 3 */
667 nsp32_write4(base, SCSI_MSG_OUT, 0);
671 * set selection timeout(= 250ms)
673 nsp32_write2(base, SEL_TIME_OUT, SEL_TIMEOUT_TIME);
676 * set SREQ hazard killer sampling rate
678 * TODO: sample_rate (BASE+0F) is 0 when internal clock = 40MHz.
679 * check other internal clock!
681 nsp32_write1(base, SREQ_SMPL_RATE, data->cur_target->sample_reg);
684 * clear Arbit
686 nsp32_write1(base, SET_ARBIT, ARBIT_CLEAR);
689 * set SYNCREG
690 * Don't set BM_START_ADR before setting this register.
692 nsp32_write1(base, SYNC_REG, data->cur_target->syncreg);
695 * set ACKWIDTH
697 nsp32_write1(base, ACK_WIDTH, data->cur_target->ackwidth);
699 nsp32_dbg(NSP32_DEBUG_AUTOSCSI,
700 "syncreg=0x%x, ackwidth=0x%x, sgtpaddr=0x%x, id=0x%x",
701 nsp32_read1(base, SYNC_REG), nsp32_read1(base, ACK_WIDTH),
702 nsp32_read4(base, SGT_ADR), nsp32_read1(base, SCSI_OUT_LATCH_TARGET_ID));
703 nsp32_dbg(NSP32_DEBUG_AUTOSCSI, "msgout_len=%d, msgout=0x%x",
704 data->msgout_len, msgout);
707 * set SGT ADDR (physical address)
709 nsp32_write4(base, SGT_ADR, data->cur_lunt->sglun_paddr);
712 * set TRANSFER CONTROL REG
714 command = 0;
715 command |= (TRANSFER_GO | ALL_COUNTER_CLR);
716 if (data->trans_method & NSP32_TRANSFER_BUSMASTER) {
717 if (scsi_bufflen(SCpnt) > 0) {
718 command |= BM_START;
720 } else if (data->trans_method & NSP32_TRANSFER_MMIO) {
721 command |= CB_MMIO_MODE;
722 } else if (data->trans_method & NSP32_TRANSFER_PIO) {
723 command |= CB_IO_MODE;
725 nsp32_write2(base, TRANSFER_CONTROL, command);
728 * start AUTO SCSI, kick off arbitration
730 command = (CLEAR_CDB_FIFO_POINTER |
731 AUTOSCSI_START |
732 AUTO_MSGIN_00_OR_04 |
733 AUTO_MSGIN_02 |
734 AUTO_ATN );
735 nsp32_write2(base, COMMAND_CONTROL, command);
738 * Check arbitration
740 status = nsp32_arbitration(SCpnt, base);
742 out:
744 * IRQ enable
746 nsp32_write2(base, IRQ_CONTROL, 0);
748 return status;
753 * Arbitration Status Check
755 * Note: Arbitration counter is waited during ARBIT_GO is not lifting.
756 * Using udelay(1) consumes CPU time and system time, but
757 * arbitration delay time is defined minimal 2.4us in SCSI
758 * specification, thus udelay works as coarse grained wait timer.
760 static int nsp32_arbitration(struct scsi_cmnd *SCpnt, unsigned int base)
762 unsigned char arbit;
763 int status = TRUE;
764 int time = 0;
766 do {
767 arbit = nsp32_read1(base, ARBIT_STATUS);
768 time++;
769 } while ((arbit & (ARBIT_WIN | ARBIT_FAIL)) == 0 &&
770 (time <= ARBIT_TIMEOUT_TIME));
772 nsp32_dbg(NSP32_DEBUG_AUTOSCSI,
773 "arbit: 0x%x, delay time: %d", arbit, time);
775 if (arbit & ARBIT_WIN) {
776 /* Arbitration succeeded */
777 SCpnt->result = DID_OK << 16;
778 nsp32_index_write1(base, EXT_PORT, LED_ON); /* PCI LED on */
779 } else if (arbit & ARBIT_FAIL) {
780 /* Arbitration failed */
781 SCpnt->result = DID_BUS_BUSY << 16;
782 status = FALSE;
783 } else {
785 * unknown error or ARBIT_GO timeout,
786 * something lock up! guess no connection.
788 nsp32_dbg(NSP32_DEBUG_AUTOSCSI, "arbit timeout");
789 SCpnt->result = DID_NO_CONNECT << 16;
790 status = FALSE;
794 * clear Arbit
796 nsp32_write1(base, SET_ARBIT, ARBIT_CLEAR);
798 return status;
803 * reselection
805 * Note: This reselection routine is called from msgin_occur,
806 * reselection target id&lun must be already set.
807 * SCSI-2 says IDENTIFY implies RESTORE_POINTER operation.
809 static int nsp32_reselection(struct scsi_cmnd *SCpnt, unsigned char newlun)
811 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
812 unsigned int host_id = SCpnt->device->host->this_id;
813 unsigned int base = SCpnt->device->host->io_port;
814 unsigned char tmpid, newid;
816 nsp32_dbg(NSP32_DEBUG_RESELECTION, "enter");
819 * calculate reselected SCSI ID
821 tmpid = nsp32_read1(base, RESELECT_ID);
822 tmpid &= (~BIT(host_id));
823 newid = 0;
824 while (tmpid) {
825 if (tmpid & 1) {
826 break;
828 tmpid >>= 1;
829 newid++;
833 * If reselected New ID:LUN is not existed
834 * or current nexus is not existed, unexpected
835 * reselection is occurred. Send reject message.
837 if (newid >= ARRAY_SIZE(data->lunt) || newlun >= ARRAY_SIZE(data->lunt[0])) {
838 nsp32_msg(KERN_WARNING, "unknown id/lun");
839 return FALSE;
840 } else if(data->lunt[newid][newlun].SCpnt == NULL) {
841 nsp32_msg(KERN_WARNING, "no SCSI command is processing");
842 return FALSE;
845 data->cur_id = newid;
846 data->cur_lun = newlun;
847 data->cur_target = &(data->target[newid]);
848 data->cur_lunt = &(data->lunt[newid][newlun]);
850 /* reset SACK/SavedACK counter (or ALL clear?) */
851 nsp32_write4(base, CLR_COUNTER, CLRCOUNTER_ALLMASK);
853 return TRUE;
858 * nsp32_setup_sg_table - build scatter gather list for transfer data
859 * with bus master.
861 * Note: NinjaSCSI-32Bi/UDE bus master can not transfer over 64KB at a time.
863 static int nsp32_setup_sg_table(struct scsi_cmnd *SCpnt)
865 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
866 struct scatterlist *sg;
867 nsp32_sgtable *sgt = data->cur_lunt->sglun->sgt;
868 int num, i;
869 u32_le l;
871 if (sgt == NULL) {
872 nsp32_dbg(NSP32_DEBUG_SGLIST, "SGT == null");
873 return FALSE;
876 num = scsi_dma_map(SCpnt);
877 if (!num)
878 return TRUE;
879 else if (num < 0)
880 return FALSE;
881 else {
882 scsi_for_each_sg(SCpnt, sg, num, i) {
884 * Build nsp32_sglist, substitute sg dma addresses.
886 sgt[i].addr = cpu_to_le32(sg_dma_address(sg));
887 sgt[i].len = cpu_to_le32(sg_dma_len(sg));
889 if (le32_to_cpu(sgt[i].len) > 0x10000) {
890 nsp32_msg(KERN_ERR,
891 "can't transfer over 64KB at a time, size=0x%lx", le32_to_cpu(sgt[i].len));
892 return FALSE;
894 nsp32_dbg(NSP32_DEBUG_SGLIST,
895 "num 0x%x : addr 0x%lx len 0x%lx",
897 le32_to_cpu(sgt[i].addr),
898 le32_to_cpu(sgt[i].len ));
901 /* set end mark */
902 l = le32_to_cpu(sgt[num-1].len);
903 sgt[num-1].len = cpu_to_le32(l | SGTEND);
906 return TRUE;
909 static int nsp32_queuecommand_lck(struct scsi_cmnd *SCpnt, void (*done)(struct scsi_cmnd *))
911 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
912 nsp32_target *target;
913 nsp32_lunt *cur_lunt;
914 int ret;
916 nsp32_dbg(NSP32_DEBUG_QUEUECOMMAND,
917 "enter. target: 0x%x LUN: 0x%llx cmnd: 0x%x cmndlen: 0x%x "
918 "use_sg: 0x%x reqbuf: 0x%lx reqlen: 0x%x",
919 SCpnt->device->id, SCpnt->device->lun, SCpnt->cmnd[0], SCpnt->cmd_len,
920 scsi_sg_count(SCpnt), scsi_sglist(SCpnt), scsi_bufflen(SCpnt));
922 if (data->CurrentSC != NULL) {
923 nsp32_msg(KERN_ERR, "Currentsc != NULL. Cancel this command request");
924 data->CurrentSC = NULL;
925 SCpnt->result = DID_NO_CONNECT << 16;
926 done(SCpnt);
927 return 0;
930 /* check target ID is not same as this initiator ID */
931 if (scmd_id(SCpnt) == SCpnt->device->host->this_id) {
932 nsp32_dbg(NSP32_DEBUG_QUEUECOMMAND, "target==host???");
933 SCpnt->result = DID_BAD_TARGET << 16;
934 done(SCpnt);
935 return 0;
938 /* check target LUN is allowable value */
939 if (SCpnt->device->lun >= MAX_LUN) {
940 nsp32_dbg(NSP32_DEBUG_QUEUECOMMAND, "no more lun");
941 SCpnt->result = DID_BAD_TARGET << 16;
942 done(SCpnt);
943 return 0;
946 show_command(SCpnt);
948 SCpnt->scsi_done = done;
949 data->CurrentSC = SCpnt;
950 SCpnt->SCp.Status = CHECK_CONDITION;
951 SCpnt->SCp.Message = 0;
952 scsi_set_resid(SCpnt, scsi_bufflen(SCpnt));
954 SCpnt->SCp.ptr = (char *)scsi_sglist(SCpnt);
955 SCpnt->SCp.this_residual = scsi_bufflen(SCpnt);
956 SCpnt->SCp.buffer = NULL;
957 SCpnt->SCp.buffers_residual = 0;
959 /* initialize data */
960 data->msgout_len = 0;
961 data->msgin_len = 0;
962 cur_lunt = &(data->lunt[SCpnt->device->id][SCpnt->device->lun]);
963 cur_lunt->SCpnt = SCpnt;
964 cur_lunt->save_datp = 0;
965 cur_lunt->msgin03 = FALSE;
966 data->cur_lunt = cur_lunt;
967 data->cur_id = SCpnt->device->id;
968 data->cur_lun = SCpnt->device->lun;
970 ret = nsp32_setup_sg_table(SCpnt);
971 if (ret == FALSE) {
972 nsp32_msg(KERN_ERR, "SGT fail");
973 SCpnt->result = DID_ERROR << 16;
974 nsp32_scsi_done(SCpnt);
975 return 0;
978 /* Build IDENTIFY */
979 nsp32_build_identify(SCpnt);
982 * If target is the first time to transfer after the reset
983 * (target don't have SDTR_DONE and SDTR_INITIATOR), sync
984 * message SDTR is needed to do synchronous transfer.
986 target = &data->target[scmd_id(SCpnt)];
987 data->cur_target = target;
989 if (!(target->sync_flag & (SDTR_DONE | SDTR_INITIATOR | SDTR_TARGET))) {
990 unsigned char period, offset;
992 if (trans_mode != ASYNC_MODE) {
993 nsp32_set_max_sync(data, target, &period, &offset);
994 nsp32_build_sdtr(SCpnt, period, offset);
995 target->sync_flag |= SDTR_INITIATOR;
996 } else {
997 nsp32_set_async(data, target);
998 target->sync_flag |= SDTR_DONE;
1001 nsp32_dbg(NSP32_DEBUG_QUEUECOMMAND,
1002 "SDTR: entry: %d start_period: 0x%x offset: 0x%x\n",
1003 target->limit_entry, period, offset);
1004 } else if (target->sync_flag & SDTR_INITIATOR) {
1006 * It was negotiating SDTR with target, sending from the
1007 * initiator, but there are no chance to remove this flag.
1008 * Set async because we don't get proper negotiation.
1010 nsp32_set_async(data, target);
1011 target->sync_flag &= ~SDTR_INITIATOR;
1012 target->sync_flag |= SDTR_DONE;
1014 nsp32_dbg(NSP32_DEBUG_QUEUECOMMAND,
1015 "SDTR_INITIATOR: fall back to async");
1016 } else if (target->sync_flag & SDTR_TARGET) {
1018 * It was negotiating SDTR with target, sending from target,
1019 * but there are no chance to remove this flag. Set async
1020 * because we don't get proper negotiation.
1022 nsp32_set_async(data, target);
1023 target->sync_flag &= ~SDTR_TARGET;
1024 target->sync_flag |= SDTR_DONE;
1026 nsp32_dbg(NSP32_DEBUG_QUEUECOMMAND,
1027 "Unknown SDTR from target is reached, fall back to async.");
1030 nsp32_dbg(NSP32_DEBUG_TARGETFLAG,
1031 "target: %d sync_flag: 0x%x syncreg: 0x%x ackwidth: 0x%x",
1032 SCpnt->device->id, target->sync_flag, target->syncreg,
1033 target->ackwidth);
1035 /* Selection */
1036 if (auto_param == 0) {
1037 ret = nsp32_selection_autopara(SCpnt);
1038 } else {
1039 ret = nsp32_selection_autoscsi(SCpnt);
1042 if (ret != TRUE) {
1043 nsp32_dbg(NSP32_DEBUG_QUEUECOMMAND, "selection fail");
1044 nsp32_scsi_done(SCpnt);
1047 return 0;
1050 static DEF_SCSI_QCMD(nsp32_queuecommand)
1052 /* initialize asic */
1053 static int nsp32hw_init(nsp32_hw_data *data)
1055 unsigned int base = data->BaseAddress;
1056 unsigned short irq_stat;
1057 unsigned long lc_reg;
1058 unsigned char power;
1060 lc_reg = nsp32_index_read4(base, CFG_LATE_CACHE);
1061 if ((lc_reg & 0xff00) == 0) {
1062 lc_reg |= (0x20 << 8);
1063 nsp32_index_write2(base, CFG_LATE_CACHE, lc_reg & 0xffff);
1066 nsp32_write2(base, IRQ_CONTROL, IRQ_CONTROL_ALL_IRQ_MASK);
1067 nsp32_write2(base, TRANSFER_CONTROL, 0);
1068 nsp32_write4(base, BM_CNT, 0);
1069 nsp32_write2(base, SCSI_EXECUTE_PHASE, 0);
1071 do {
1072 irq_stat = nsp32_read2(base, IRQ_STATUS);
1073 nsp32_dbg(NSP32_DEBUG_INIT, "irq_stat 0x%x", irq_stat);
1074 } while (irq_stat & IRQSTATUS_ANY_IRQ);
1077 * Fill FIFO_FULL_SHLD, FIFO_EMPTY_SHLD. Below parameter is
1078 * designated by specification.
1080 if ((data->trans_method & NSP32_TRANSFER_PIO) ||
1081 (data->trans_method & NSP32_TRANSFER_MMIO)) {
1082 nsp32_index_write1(base, FIFO_FULL_SHLD_COUNT, 0x40);
1083 nsp32_index_write1(base, FIFO_EMPTY_SHLD_COUNT, 0x40);
1084 } else if (data->trans_method & NSP32_TRANSFER_BUSMASTER) {
1085 nsp32_index_write1(base, FIFO_FULL_SHLD_COUNT, 0x10);
1086 nsp32_index_write1(base, FIFO_EMPTY_SHLD_COUNT, 0x60);
1087 } else {
1088 nsp32_dbg(NSP32_DEBUG_INIT, "unknown transfer mode");
1091 nsp32_dbg(NSP32_DEBUG_INIT, "full 0x%x emp 0x%x",
1092 nsp32_index_read1(base, FIFO_FULL_SHLD_COUNT),
1093 nsp32_index_read1(base, FIFO_EMPTY_SHLD_COUNT));
1095 nsp32_index_write1(base, CLOCK_DIV, data->clock);
1096 nsp32_index_write1(base, BM_CYCLE, MEMRD_CMD1 | SGT_AUTO_PARA_MEMED_CMD);
1097 nsp32_write1(base, PARITY_CONTROL, 0); /* parity check is disable */
1100 * initialize MISC_WRRD register
1102 * Note: Designated parameters is obeyed as following:
1103 * MISC_SCSI_DIRECTION_DETECTOR_SELECT: It must be set.
1104 * MISC_MASTER_TERMINATION_SELECT: It must be set.
1105 * MISC_BMREQ_NEGATE_TIMING_SEL: It should be set.
1106 * MISC_AUTOSEL_TIMING_SEL: It should be set.
1107 * MISC_BMSTOP_CHANGE2_NONDATA_PHASE: It should be set.
1108 * MISC_DELAYED_BMSTART: It's selected for safety.
1110 * Note: If MISC_BMSTOP_CHANGE2_NONDATA_PHASE is set, then
1111 * we have to set TRANSFERCONTROL_BM_START as 0 and set
1112 * appropriate value before restarting bus master transfer.
1114 nsp32_index_write2(base, MISC_WR,
1115 (SCSI_DIRECTION_DETECTOR_SELECT |
1116 DELAYED_BMSTART |
1117 MASTER_TERMINATION_SELECT |
1118 BMREQ_NEGATE_TIMING_SEL |
1119 AUTOSEL_TIMING_SEL |
1120 BMSTOP_CHANGE2_NONDATA_PHASE));
1122 nsp32_index_write1(base, TERM_PWR_CONTROL, 0);
1123 power = nsp32_index_read1(base, TERM_PWR_CONTROL);
1124 if (!(power & SENSE)) {
1125 nsp32_msg(KERN_INFO, "term power on");
1126 nsp32_index_write1(base, TERM_PWR_CONTROL, BPWR);
1129 nsp32_write2(base, TIMER_SET, TIMER_STOP);
1130 nsp32_write2(base, TIMER_SET, TIMER_STOP); /* Required 2 times */
1132 nsp32_write1(base, SYNC_REG, 0);
1133 nsp32_write1(base, ACK_WIDTH, 0);
1134 nsp32_write2(base, SEL_TIME_OUT, SEL_TIMEOUT_TIME);
1137 * enable to select designated IRQ (except for
1138 * IRQSELECT_SERR, IRQSELECT_PERR, IRQSELECT_BMCNTERR)
1140 nsp32_index_write2(base, IRQ_SELECT, IRQSELECT_TIMER_IRQ |
1141 IRQSELECT_SCSIRESET_IRQ |
1142 IRQSELECT_FIFO_SHLD_IRQ |
1143 IRQSELECT_RESELECT_IRQ |
1144 IRQSELECT_PHASE_CHANGE_IRQ |
1145 IRQSELECT_AUTO_SCSI_SEQ_IRQ |
1146 // IRQSELECT_BMCNTERR_IRQ |
1147 IRQSELECT_TARGET_ABORT_IRQ |
1148 IRQSELECT_MASTER_ABORT_IRQ );
1149 nsp32_write2(base, IRQ_CONTROL, 0);
1151 /* PCI LED off */
1152 nsp32_index_write1(base, EXT_PORT_DDR, LED_OFF);
1153 nsp32_index_write1(base, EXT_PORT, LED_OFF);
1155 return TRUE;
1159 /* interrupt routine */
1160 static irqreturn_t do_nsp32_isr(int irq, void *dev_id)
1162 nsp32_hw_data *data = dev_id;
1163 unsigned int base = data->BaseAddress;
1164 struct scsi_cmnd *SCpnt = data->CurrentSC;
1165 unsigned short auto_stat, irq_stat, trans_stat;
1166 unsigned char busmon, busphase;
1167 unsigned long flags;
1168 int ret;
1169 int handled = 0;
1170 struct Scsi_Host *host = data->Host;
1172 spin_lock_irqsave(host->host_lock, flags);
1175 * IRQ check, then enable IRQ mask
1177 irq_stat = nsp32_read2(base, IRQ_STATUS);
1178 nsp32_dbg(NSP32_DEBUG_INTR,
1179 "enter IRQ: %d, IRQstatus: 0x%x", irq, irq_stat);
1180 /* is this interrupt comes from Ninja asic? */
1181 if ((irq_stat & IRQSTATUS_ANY_IRQ) == 0) {
1182 nsp32_dbg(NSP32_DEBUG_INTR, "shared interrupt: irq other 0x%x", irq_stat);
1183 goto out2;
1185 handled = 1;
1186 nsp32_write2(base, IRQ_CONTROL, IRQ_CONTROL_ALL_IRQ_MASK);
1188 busmon = nsp32_read1(base, SCSI_BUS_MONITOR);
1189 busphase = busmon & BUSMON_PHASE_MASK;
1191 trans_stat = nsp32_read2(base, TRANSFER_STATUS);
1192 if ((irq_stat == 0xffff) && (trans_stat == 0xffff)) {
1193 nsp32_msg(KERN_INFO, "card disconnect");
1194 if (data->CurrentSC != NULL) {
1195 nsp32_msg(KERN_INFO, "clean up current SCSI command");
1196 SCpnt->result = DID_BAD_TARGET << 16;
1197 nsp32_scsi_done(SCpnt);
1199 goto out;
1202 /* Timer IRQ */
1203 if (irq_stat & IRQSTATUS_TIMER_IRQ) {
1204 nsp32_dbg(NSP32_DEBUG_INTR, "timer stop");
1205 nsp32_write2(base, TIMER_SET, TIMER_STOP);
1206 goto out;
1209 /* SCSI reset */
1210 if (irq_stat & IRQSTATUS_SCSIRESET_IRQ) {
1211 nsp32_msg(KERN_INFO, "detected someone do bus reset");
1212 nsp32_do_bus_reset(data);
1213 if (SCpnt != NULL) {
1214 SCpnt->result = DID_RESET << 16;
1215 nsp32_scsi_done(SCpnt);
1217 goto out;
1220 if (SCpnt == NULL) {
1221 nsp32_msg(KERN_WARNING, "SCpnt==NULL this can't be happened");
1222 nsp32_msg(KERN_WARNING, "irq_stat=0x%x trans_stat=0x%x", irq_stat, trans_stat);
1223 goto out;
1227 * AutoSCSI Interrupt.
1228 * Note: This interrupt is occurred when AutoSCSI is finished. Then
1229 * check SCSIEXECUTEPHASE, and do appropriate action. Each phases are
1230 * recorded when AutoSCSI sequencer has been processed.
1232 if(irq_stat & IRQSTATUS_AUTOSCSI_IRQ) {
1233 /* getting SCSI executed phase */
1234 auto_stat = nsp32_read2(base, SCSI_EXECUTE_PHASE);
1235 nsp32_write2(base, SCSI_EXECUTE_PHASE, 0);
1237 /* Selection Timeout, go busfree phase. */
1238 if (auto_stat & SELECTION_TIMEOUT) {
1239 nsp32_dbg(NSP32_DEBUG_INTR,
1240 "selection timeout occurred");
1242 SCpnt->result = DID_TIME_OUT << 16;
1243 nsp32_scsi_done(SCpnt);
1244 goto out;
1247 if (auto_stat & MSGOUT_PHASE) {
1249 * MsgOut phase was processed.
1250 * If MSG_IN_OCCUER is not set, then MsgOut phase is
1251 * completed. Thus, msgout_len must reset. Otherwise,
1252 * nothing to do here. If MSG_OUT_OCCUER is occurred,
1253 * then we will encounter the condition and check.
1255 if (!(auto_stat & MSG_IN_OCCUER) &&
1256 (data->msgout_len <= 3)) {
1258 * !MSG_IN_OCCUER && msgout_len <=3
1259 * ---> AutoSCSI with MSGOUTreg is processed.
1261 data->msgout_len = 0;
1264 nsp32_dbg(NSP32_DEBUG_INTR, "MsgOut phase processed");
1267 if ((auto_stat & DATA_IN_PHASE) &&
1268 (scsi_get_resid(SCpnt) > 0) &&
1269 ((nsp32_read2(base, FIFO_REST_CNT) & FIFO_REST_MASK) != 0)) {
1270 printk( "auto+fifo\n");
1271 //nsp32_pio_read(SCpnt);
1274 if (auto_stat & (DATA_IN_PHASE | DATA_OUT_PHASE)) {
1275 /* DATA_IN_PHASE/DATA_OUT_PHASE was processed. */
1276 nsp32_dbg(NSP32_DEBUG_INTR,
1277 "Data in/out phase processed");
1279 /* read BMCNT, SGT pointer addr */
1280 nsp32_dbg(NSP32_DEBUG_INTR, "BMCNT=0x%lx",
1281 nsp32_read4(base, BM_CNT));
1282 nsp32_dbg(NSP32_DEBUG_INTR, "addr=0x%lx",
1283 nsp32_read4(base, SGT_ADR));
1284 nsp32_dbg(NSP32_DEBUG_INTR, "SACK=0x%lx",
1285 nsp32_read4(base, SACK_CNT));
1286 nsp32_dbg(NSP32_DEBUG_INTR, "SSACK=0x%lx",
1287 nsp32_read4(base, SAVED_SACK_CNT));
1289 scsi_set_resid(SCpnt, 0); /* all data transferred! */
1293 * MsgIn Occur
1295 if (auto_stat & MSG_IN_OCCUER) {
1296 nsp32_msgin_occur(SCpnt, irq_stat, auto_stat);
1300 * MsgOut Occur
1302 if (auto_stat & MSG_OUT_OCCUER) {
1303 nsp32_msgout_occur(SCpnt);
1307 * Bus Free Occur
1309 if (auto_stat & BUS_FREE_OCCUER) {
1310 ret = nsp32_busfree_occur(SCpnt, auto_stat);
1311 if (ret == TRUE) {
1312 goto out;
1316 if (auto_stat & STATUS_PHASE) {
1318 * Read CSB and substitute CSB for SCpnt->result
1319 * to save status phase stutas byte.
1320 * scsi error handler checks host_byte (DID_*:
1321 * low level driver to indicate status), then checks
1322 * status_byte (SCSI status byte).
1324 SCpnt->result = (int)nsp32_read1(base, SCSI_CSB_IN);
1327 if (auto_stat & ILLEGAL_PHASE) {
1328 /* Illegal phase is detected. SACK is not back. */
1329 nsp32_msg(KERN_WARNING,
1330 "AUTO SCSI ILLEGAL PHASE OCCUR!!!!");
1332 /* TODO: currently we don't have any action... bus reset? */
1335 * To send back SACK, assert, wait, and negate.
1337 nsp32_sack_assert(data);
1338 nsp32_wait_req(data, NEGATE);
1339 nsp32_sack_negate(data);
1343 if (auto_stat & COMMAND_PHASE) {
1344 /* nothing to do */
1345 nsp32_dbg(NSP32_DEBUG_INTR, "Command phase processed");
1348 if (auto_stat & AUTOSCSI_BUSY) {
1349 /* AutoSCSI is running */
1352 show_autophase(auto_stat);
1355 /* FIFO_SHLD_IRQ */
1356 if (irq_stat & IRQSTATUS_FIFO_SHLD_IRQ) {
1357 nsp32_dbg(NSP32_DEBUG_INTR, "FIFO IRQ");
1359 switch(busphase) {
1360 case BUSPHASE_DATA_OUT:
1361 nsp32_dbg(NSP32_DEBUG_INTR, "fifo/write");
1363 //nsp32_pio_write(SCpnt);
1365 break;
1367 case BUSPHASE_DATA_IN:
1368 nsp32_dbg(NSP32_DEBUG_INTR, "fifo/read");
1370 //nsp32_pio_read(SCpnt);
1372 break;
1374 case BUSPHASE_STATUS:
1375 nsp32_dbg(NSP32_DEBUG_INTR, "fifo/status");
1377 SCpnt->SCp.Status = nsp32_read1(base, SCSI_CSB_IN);
1379 break;
1380 default:
1381 nsp32_dbg(NSP32_DEBUG_INTR, "fifo/other phase");
1382 nsp32_dbg(NSP32_DEBUG_INTR, "irq_stat=0x%x trans_stat=0x%x", irq_stat, trans_stat);
1383 show_busphase(busphase);
1384 break;
1387 goto out;
1390 /* Phase Change IRQ */
1391 if (irq_stat & IRQSTATUS_PHASE_CHANGE_IRQ) {
1392 nsp32_dbg(NSP32_DEBUG_INTR, "phase change IRQ");
1394 switch(busphase) {
1395 case BUSPHASE_MESSAGE_IN:
1396 nsp32_dbg(NSP32_DEBUG_INTR, "phase chg/msg in");
1397 nsp32_msgin_occur(SCpnt, irq_stat, 0);
1398 break;
1399 default:
1400 nsp32_msg(KERN_WARNING, "phase chg/other phase?");
1401 nsp32_msg(KERN_WARNING, "irq_stat=0x%x trans_stat=0x%x\n",
1402 irq_stat, trans_stat);
1403 show_busphase(busphase);
1404 break;
1406 goto out;
1409 /* PCI_IRQ */
1410 if (irq_stat & IRQSTATUS_PCI_IRQ) {
1411 nsp32_dbg(NSP32_DEBUG_INTR, "PCI IRQ occurred");
1412 /* Do nothing */
1415 /* BMCNTERR_IRQ */
1416 if (irq_stat & IRQSTATUS_BMCNTERR_IRQ) {
1417 nsp32_msg(KERN_ERR, "Received unexpected BMCNTERR IRQ! ");
1419 * TODO: To be implemented improving bus master
1420 * transfer reliability when BMCNTERR is occurred in
1421 * AutoSCSI phase described in specification.
1425 #if 0
1426 nsp32_dbg(NSP32_DEBUG_INTR,
1427 "irq_stat=0x%x trans_stat=0x%x", irq_stat, trans_stat);
1428 show_busphase(busphase);
1429 #endif
1431 out:
1432 /* disable IRQ mask */
1433 nsp32_write2(base, IRQ_CONTROL, 0);
1435 out2:
1436 spin_unlock_irqrestore(host->host_lock, flags);
1438 nsp32_dbg(NSP32_DEBUG_INTR, "exit");
1440 return IRQ_RETVAL(handled);
1444 static int nsp32_show_info(struct seq_file *m, struct Scsi_Host *host)
1446 unsigned long flags;
1447 nsp32_hw_data *data;
1448 int hostno;
1449 unsigned int base;
1450 unsigned char mode_reg;
1451 int id, speed;
1452 long model;
1454 hostno = host->host_no;
1455 data = (nsp32_hw_data *)host->hostdata;
1456 base = host->io_port;
1458 seq_puts(m, "NinjaSCSI-32 status\n\n");
1459 seq_printf(m, "Driver version: %s, $Revision: 1.33 $\n", nsp32_release_version);
1460 seq_printf(m, "SCSI host No.: %d\n", hostno);
1461 seq_printf(m, "IRQ: %d\n", host->irq);
1462 seq_printf(m, "IO: 0x%lx-0x%lx\n", host->io_port, host->io_port + host->n_io_port - 1);
1463 seq_printf(m, "MMIO(virtual address): 0x%lx-0x%lx\n", host->base, host->base + data->MmioLength - 1);
1464 seq_printf(m, "sg_tablesize: %d\n", host->sg_tablesize);
1465 seq_printf(m, "Chip revision: 0x%x\n", (nsp32_read2(base, INDEX_REG) >> 8) & 0xff);
1467 mode_reg = nsp32_index_read1(base, CHIP_MODE);
1468 model = data->pci_devid->driver_data;
1470 #ifdef CONFIG_PM
1471 seq_printf(m, "Power Management: %s\n", (mode_reg & OPTF) ? "yes" : "no");
1472 #endif
1473 seq_printf(m, "OEM: %ld, %s\n", (mode_reg & (OEM0|OEM1)), nsp32_model[model]);
1475 spin_lock_irqsave(&(data->Lock), flags);
1476 seq_printf(m, "CurrentSC: 0x%p\n\n", data->CurrentSC);
1477 spin_unlock_irqrestore(&(data->Lock), flags);
1480 seq_puts(m, "SDTR status\n");
1481 for (id = 0; id < ARRAY_SIZE(data->target); id++) {
1483 seq_printf(m, "id %d: ", id);
1485 if (id == host->this_id) {
1486 seq_puts(m, "----- NinjaSCSI-32 host adapter\n");
1487 continue;
1490 if (data->target[id].sync_flag == SDTR_DONE) {
1491 if (data->target[id].period == 0 &&
1492 data->target[id].offset == ASYNC_OFFSET ) {
1493 seq_puts(m, "async");
1494 } else {
1495 seq_puts(m, " sync");
1497 } else {
1498 seq_puts(m, " none");
1501 if (data->target[id].period != 0) {
1503 speed = 1000000 / (data->target[id].period * 4);
1505 seq_printf(m, " transfer %d.%dMB/s, offset %d",
1506 speed / 1000,
1507 speed % 1000,
1508 data->target[id].offset
1511 seq_putc(m, '\n');
1513 return 0;
1519 * Reset parameters and call scsi_done for data->cur_lunt.
1520 * Be careful setting SCpnt->result = DID_* before calling this function.
1522 static void nsp32_scsi_done(struct scsi_cmnd *SCpnt)
1524 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
1525 unsigned int base = SCpnt->device->host->io_port;
1527 scsi_dma_unmap(SCpnt);
1530 * clear TRANSFERCONTROL_BM_START
1532 nsp32_write2(base, TRANSFER_CONTROL, 0);
1533 nsp32_write4(base, BM_CNT, 0);
1536 * call scsi_done
1538 (*SCpnt->scsi_done)(SCpnt);
1541 * reset parameters
1543 data->cur_lunt->SCpnt = NULL;
1544 data->cur_lunt = NULL;
1545 data->cur_target = NULL;
1546 data->CurrentSC = NULL;
1551 * Bus Free Occur
1553 * Current Phase is BUSFREE. AutoSCSI is automatically execute BUSFREE phase
1554 * with ACK reply when below condition is matched:
1555 * MsgIn 00: Command Complete.
1556 * MsgIn 02: Save Data Pointer.
1557 * MsgIn 04: Diconnect.
1558 * In other case, unexpected BUSFREE is detected.
1560 static int nsp32_busfree_occur(struct scsi_cmnd *SCpnt, unsigned short execph)
1562 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
1563 unsigned int base = SCpnt->device->host->io_port;
1565 nsp32_dbg(NSP32_DEBUG_BUSFREE, "enter execph=0x%x", execph);
1566 show_autophase(execph);
1568 nsp32_write4(base, BM_CNT, 0);
1569 nsp32_write2(base, TRANSFER_CONTROL, 0);
1572 * MsgIn 02: Save Data Pointer
1574 * VALID:
1575 * Save Data Pointer is received. Adjust pointer.
1577 * NO-VALID:
1578 * SCSI-3 says if Save Data Pointer is not received, then we restart
1579 * processing and we can't adjust any SCSI data pointer in next data
1580 * phase.
1582 if (execph & MSGIN_02_VALID) {
1583 nsp32_dbg(NSP32_DEBUG_BUSFREE, "MsgIn02_Valid");
1586 * Check sack_cnt/saved_sack_cnt, then adjust sg table if
1587 * needed.
1589 if (!(execph & MSGIN_00_VALID) &&
1590 ((execph & DATA_IN_PHASE) || (execph & DATA_OUT_PHASE))) {
1591 unsigned int sacklen, s_sacklen;
1594 * Read SACK count and SAVEDSACK count, then compare.
1596 sacklen = nsp32_read4(base, SACK_CNT );
1597 s_sacklen = nsp32_read4(base, SAVED_SACK_CNT);
1600 * If SAVEDSACKCNT == 0, it means SavedDataPointer is
1601 * come after data transferring.
1603 if (s_sacklen > 0) {
1605 * Comparing between sack and savedsack to
1606 * check the condition of AutoMsgIn03.
1608 * If they are same, set msgin03 == TRUE,
1609 * COMMANDCONTROL_AUTO_MSGIN_03 is enabled at
1610 * reselection. On the other hand, if they
1611 * aren't same, set msgin03 == FALSE, and
1612 * COMMANDCONTROL_AUTO_MSGIN_03 is disabled at
1613 * reselection.
1615 if (sacklen != s_sacklen) {
1616 data->cur_lunt->msgin03 = FALSE;
1617 } else {
1618 data->cur_lunt->msgin03 = TRUE;
1621 nsp32_adjust_busfree(SCpnt, s_sacklen);
1625 /* This value has not substitude with valid value yet... */
1626 //data->cur_lunt->save_datp = data->cur_datp;
1627 } else {
1629 * no processing.
1633 if (execph & MSGIN_03_VALID) {
1634 /* MsgIn03 was valid to be processed. No need processing. */
1638 * target SDTR check
1640 if (data->cur_target->sync_flag & SDTR_INITIATOR) {
1642 * SDTR negotiation pulled by the initiator has not
1643 * finished yet. Fall back to ASYNC mode.
1645 nsp32_set_async(data, data->cur_target);
1646 data->cur_target->sync_flag &= ~SDTR_INITIATOR;
1647 data->cur_target->sync_flag |= SDTR_DONE;
1648 } else if (data->cur_target->sync_flag & SDTR_TARGET) {
1650 * SDTR negotiation pulled by the target has been
1651 * negotiating.
1653 if (execph & (MSGIN_00_VALID | MSGIN_04_VALID)) {
1655 * If valid message is received, then
1656 * negotiation is succeeded.
1658 } else {
1660 * On the contrary, if unexpected bus free is
1661 * occurred, then negotiation is failed. Fall
1662 * back to ASYNC mode.
1664 nsp32_set_async(data, data->cur_target);
1666 data->cur_target->sync_flag &= ~SDTR_TARGET;
1667 data->cur_target->sync_flag |= SDTR_DONE;
1671 * It is always ensured by SCSI standard that initiator
1672 * switches into Bus Free Phase after
1673 * receiving message 00 (Command Complete), 04 (Disconnect).
1674 * It's the reason that processing here is valid.
1676 if (execph & MSGIN_00_VALID) {
1677 /* MsgIn 00: Command Complete */
1678 nsp32_dbg(NSP32_DEBUG_BUSFREE, "command complete");
1680 SCpnt->SCp.Status = nsp32_read1(base, SCSI_CSB_IN);
1681 SCpnt->SCp.Message = 0;
1682 nsp32_dbg(NSP32_DEBUG_BUSFREE,
1683 "normal end stat=0x%x resid=0x%x\n",
1684 SCpnt->SCp.Status, scsi_get_resid(SCpnt));
1685 SCpnt->result = (DID_OK << 16) |
1686 (SCpnt->SCp.Message << 8) |
1687 (SCpnt->SCp.Status << 0);
1688 nsp32_scsi_done(SCpnt);
1689 /* All operation is done */
1690 return TRUE;
1691 } else if (execph & MSGIN_04_VALID) {
1692 /* MsgIn 04: Disconnect */
1693 SCpnt->SCp.Status = nsp32_read1(base, SCSI_CSB_IN);
1694 SCpnt->SCp.Message = 4;
1696 nsp32_dbg(NSP32_DEBUG_BUSFREE, "disconnect");
1697 return TRUE;
1698 } else {
1699 /* Unexpected bus free */
1700 nsp32_msg(KERN_WARNING, "unexpected bus free occurred");
1702 /* DID_ERROR? */
1703 //SCpnt->result = (DID_OK << 16) | (SCpnt->SCp.Message << 8) | (SCpnt->SCp.Status << 0);
1704 SCpnt->result = DID_ERROR << 16;
1705 nsp32_scsi_done(SCpnt);
1706 return TRUE;
1708 return FALSE;
1713 * nsp32_adjust_busfree - adjusting SG table
1715 * Note: This driver adjust the SG table using SCSI ACK
1716 * counter instead of BMCNT counter!
1718 static void nsp32_adjust_busfree(struct scsi_cmnd *SCpnt, unsigned int s_sacklen)
1720 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
1721 int old_entry = data->cur_entry;
1722 int new_entry;
1723 int sg_num = data->cur_lunt->sg_num;
1724 nsp32_sgtable *sgt = data->cur_lunt->sglun->sgt;
1725 unsigned int restlen, sentlen;
1726 u32_le len, addr;
1728 nsp32_dbg(NSP32_DEBUG_SGLIST, "old resid=0x%x", scsi_get_resid(SCpnt));
1730 /* adjust saved SACK count with 4 byte start address boundary */
1731 s_sacklen -= le32_to_cpu(sgt[old_entry].addr) & 3;
1734 * calculate new_entry from sack count and each sgt[].len
1735 * calculate the byte which is intent to send
1737 sentlen = 0;
1738 for (new_entry = old_entry; new_entry < sg_num; new_entry++) {
1739 sentlen += (le32_to_cpu(sgt[new_entry].len) & ~SGTEND);
1740 if (sentlen > s_sacklen) {
1741 break;
1745 /* all sgt is processed */
1746 if (new_entry == sg_num) {
1747 goto last;
1750 if (sentlen == s_sacklen) {
1751 /* XXX: confirm it's ok or not */
1752 /* In this case, it's ok because we are at
1753 the head element of the sg. restlen is correctly calculated. */
1756 /* calculate the rest length for transferring */
1757 restlen = sentlen - s_sacklen;
1759 /* update adjusting current SG table entry */
1760 len = le32_to_cpu(sgt[new_entry].len);
1761 addr = le32_to_cpu(sgt[new_entry].addr);
1762 addr += (len - restlen);
1763 sgt[new_entry].addr = cpu_to_le32(addr);
1764 sgt[new_entry].len = cpu_to_le32(restlen);
1766 /* set cur_entry with new_entry */
1767 data->cur_entry = new_entry;
1769 return;
1771 last:
1772 if (scsi_get_resid(SCpnt) < sentlen) {
1773 nsp32_msg(KERN_ERR, "resid underflow");
1776 scsi_set_resid(SCpnt, scsi_get_resid(SCpnt) - sentlen);
1777 nsp32_dbg(NSP32_DEBUG_SGLIST, "new resid=0x%x", scsi_get_resid(SCpnt));
1779 /* update hostdata and lun */
1781 return;
1786 * It's called MsgOut phase occur.
1787 * NinjaSCSI-32Bi/UDE automatically processes up to 3 messages in
1788 * message out phase. It, however, has more than 3 messages,
1789 * HBA creates the interrupt and we have to process by hand.
1791 static void nsp32_msgout_occur(struct scsi_cmnd *SCpnt)
1793 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
1794 unsigned int base = SCpnt->device->host->io_port;
1795 //unsigned short command;
1796 long new_sgtp;
1797 int i;
1799 nsp32_dbg(NSP32_DEBUG_MSGOUTOCCUR,
1800 "enter: msgout_len: 0x%x", data->msgout_len);
1803 * If MsgOut phase is occurred without having any
1804 * message, then No_Operation is sent (SCSI-2).
1806 if (data->msgout_len == 0) {
1807 nsp32_build_nop(SCpnt);
1811 * Set SGTP ADDR current entry for restarting AUTOSCSI,
1812 * because SGTP is incremented next point.
1813 * There is few statement in the specification...
1815 new_sgtp = data->cur_lunt->sglun_paddr +
1816 (data->cur_lunt->cur_entry * sizeof(nsp32_sgtable));
1819 * send messages
1821 for (i = 0; i < data->msgout_len; i++) {
1822 nsp32_dbg(NSP32_DEBUG_MSGOUTOCCUR,
1823 "%d : 0x%x", i, data->msgoutbuf[i]);
1826 * Check REQ is asserted.
1828 nsp32_wait_req(data, ASSERT);
1830 if (i == (data->msgout_len - 1)) {
1832 * If the last message, set the AutoSCSI restart
1833 * before send back the ack message. AutoSCSI
1834 * restart automatically negate ATN signal.
1836 //command = (AUTO_MSGIN_00_OR_04 | AUTO_MSGIN_02);
1837 //nsp32_restart_autoscsi(SCpnt, command);
1838 nsp32_write2(base, COMMAND_CONTROL,
1839 (CLEAR_CDB_FIFO_POINTER |
1840 AUTO_COMMAND_PHASE |
1841 AUTOSCSI_RESTART |
1842 AUTO_MSGIN_00_OR_04 |
1843 AUTO_MSGIN_02 ));
1846 * Write data with SACK, then wait sack is
1847 * automatically negated.
1849 nsp32_write1(base, SCSI_DATA_WITH_ACK, data->msgoutbuf[i]);
1850 nsp32_wait_sack(data, NEGATE);
1852 nsp32_dbg(NSP32_DEBUG_MSGOUTOCCUR, "bus: 0x%x\n",
1853 nsp32_read1(base, SCSI_BUS_MONITOR));
1856 data->msgout_len = 0;
1858 nsp32_dbg(NSP32_DEBUG_MSGOUTOCCUR, "exit");
1862 * Restart AutoSCSI
1864 * Note: Restarting AutoSCSI needs set:
1865 * SYNC_REG, ACK_WIDTH, SGT_ADR, TRANSFER_CONTROL
1867 static void nsp32_restart_autoscsi(struct scsi_cmnd *SCpnt, unsigned short command)
1869 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
1870 unsigned int base = data->BaseAddress;
1871 unsigned short transfer = 0;
1873 nsp32_dbg(NSP32_DEBUG_RESTART, "enter");
1875 if (data->cur_target == NULL || data->cur_lunt == NULL) {
1876 nsp32_msg(KERN_ERR, "Target or Lun is invalid");
1880 * set SYNC_REG
1881 * Don't set BM_START_ADR before setting this register.
1883 nsp32_write1(base, SYNC_REG, data->cur_target->syncreg);
1886 * set ACKWIDTH
1888 nsp32_write1(base, ACK_WIDTH, data->cur_target->ackwidth);
1891 * set SREQ hazard killer sampling rate
1893 nsp32_write1(base, SREQ_SMPL_RATE, data->cur_target->sample_reg);
1896 * set SGT ADDR (physical address)
1898 nsp32_write4(base, SGT_ADR, data->cur_lunt->sglun_paddr);
1901 * set TRANSFER CONTROL REG
1903 transfer = 0;
1904 transfer |= (TRANSFER_GO | ALL_COUNTER_CLR);
1905 if (data->trans_method & NSP32_TRANSFER_BUSMASTER) {
1906 if (scsi_bufflen(SCpnt) > 0) {
1907 transfer |= BM_START;
1909 } else if (data->trans_method & NSP32_TRANSFER_MMIO) {
1910 transfer |= CB_MMIO_MODE;
1911 } else if (data->trans_method & NSP32_TRANSFER_PIO) {
1912 transfer |= CB_IO_MODE;
1914 nsp32_write2(base, TRANSFER_CONTROL, transfer);
1917 * restart AutoSCSI
1919 * TODO: COMMANDCONTROL_AUTO_COMMAND_PHASE is needed ?
1921 command |= (CLEAR_CDB_FIFO_POINTER |
1922 AUTO_COMMAND_PHASE |
1923 AUTOSCSI_RESTART );
1924 nsp32_write2(base, COMMAND_CONTROL, command);
1926 nsp32_dbg(NSP32_DEBUG_RESTART, "exit");
1931 * cannot run automatically message in occur
1933 static void nsp32_msgin_occur(struct scsi_cmnd *SCpnt,
1934 unsigned long irq_status,
1935 unsigned short execph)
1937 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
1938 unsigned int base = SCpnt->device->host->io_port;
1939 unsigned char msg;
1940 unsigned char msgtype;
1941 unsigned char newlun;
1942 unsigned short command = 0;
1943 int msgclear = TRUE;
1944 long new_sgtp;
1945 int ret;
1948 * read first message
1949 * Use SCSIDATA_W_ACK instead of SCSIDATAIN, because the procedure
1950 * of Message-In have to be processed before sending back SCSI ACK.
1952 msg = nsp32_read1(base, SCSI_DATA_IN);
1953 data->msginbuf[(unsigned char)data->msgin_len] = msg;
1954 msgtype = data->msginbuf[0];
1955 nsp32_dbg(NSP32_DEBUG_MSGINOCCUR,
1956 "enter: msglen: 0x%x msgin: 0x%x msgtype: 0x%x",
1957 data->msgin_len, msg, msgtype);
1960 * TODO: We need checking whether bus phase is message in?
1964 * assert SCSI ACK
1966 nsp32_sack_assert(data);
1969 * processing IDENTIFY
1971 if (msgtype & 0x80) {
1972 if (!(irq_status & IRQSTATUS_RESELECT_OCCUER)) {
1973 /* Invalid (non reselect) phase */
1974 goto reject;
1977 newlun = msgtype & 0x1f; /* TODO: SPI-3 compliant? */
1978 ret = nsp32_reselection(SCpnt, newlun);
1979 if (ret == TRUE) {
1980 goto restart;
1981 } else {
1982 goto reject;
1987 * processing messages except for IDENTIFY
1989 * TODO: Messages are all SCSI-2 terminology. SCSI-3 compliance is TODO.
1991 switch (msgtype) {
1993 * 1-byte message
1995 case COMMAND_COMPLETE:
1996 case DISCONNECT:
1998 * These messages should not be occurred.
1999 * They should be processed on AutoSCSI sequencer.
2001 nsp32_msg(KERN_WARNING,
2002 "unexpected message of AutoSCSI MsgIn: 0x%x", msg);
2003 break;
2005 case RESTORE_POINTERS:
2007 * AutoMsgIn03 is disabled, and HBA gets this message.
2010 if ((execph & DATA_IN_PHASE) || (execph & DATA_OUT_PHASE)) {
2011 unsigned int s_sacklen;
2013 s_sacklen = nsp32_read4(base, SAVED_SACK_CNT);
2014 if ((execph & MSGIN_02_VALID) && (s_sacklen > 0)) {
2015 nsp32_adjust_busfree(SCpnt, s_sacklen);
2016 } else {
2017 /* No need to rewrite SGT */
2020 data->cur_lunt->msgin03 = FALSE;
2022 /* Update with the new value */
2024 /* reset SACK/SavedACK counter (or ALL clear?) */
2025 nsp32_write4(base, CLR_COUNTER, CLRCOUNTER_ALLMASK);
2028 * set new sg pointer
2030 new_sgtp = data->cur_lunt->sglun_paddr +
2031 (data->cur_lunt->cur_entry * sizeof(nsp32_sgtable));
2032 nsp32_write4(base, SGT_ADR, new_sgtp);
2034 break;
2036 case SAVE_POINTERS:
2038 * These messages should not be occurred.
2039 * They should be processed on AutoSCSI sequencer.
2041 nsp32_msg (KERN_WARNING,
2042 "unexpected message of AutoSCSI MsgIn: SAVE_POINTERS");
2044 break;
2046 case MESSAGE_REJECT:
2047 /* If previous message_out is sending SDTR, and get
2048 message_reject from target, SDTR negotiation is failed */
2049 if (data->cur_target->sync_flag &
2050 (SDTR_INITIATOR | SDTR_TARGET)) {
2052 * Current target is negotiating SDTR, but it's
2053 * failed. Fall back to async transfer mode, and set
2054 * SDTR_DONE.
2056 nsp32_set_async(data, data->cur_target);
2057 data->cur_target->sync_flag &= ~SDTR_INITIATOR;
2058 data->cur_target->sync_flag |= SDTR_DONE;
2061 break;
2063 case LINKED_CMD_COMPLETE:
2064 case LINKED_FLG_CMD_COMPLETE:
2065 /* queue tag is not supported currently */
2066 nsp32_msg (KERN_WARNING,
2067 "unsupported message: 0x%x", msgtype);
2068 break;
2070 case INITIATE_RECOVERY:
2071 /* staring ECA (Extended Contingent Allegiance) state. */
2072 /* This message is declined in SPI2 or later. */
2074 goto reject;
2077 * 2-byte message
2079 case SIMPLE_QUEUE_TAG:
2080 case 0x23:
2082 * 0x23: Ignore_Wide_Residue is not declared in scsi.h.
2083 * No support is needed.
2085 if (data->msgin_len >= 1) {
2086 goto reject;
2089 /* current position is 1-byte of 2 byte */
2090 msgclear = FALSE;
2092 break;
2095 * extended message
2097 case EXTENDED_MESSAGE:
2098 if (data->msgin_len < 1) {
2100 * Current position does not reach 2-byte
2101 * (2-byte is extended message length).
2103 msgclear = FALSE;
2104 break;
2107 if ((data->msginbuf[1] + 1) > data->msgin_len) {
2109 * Current extended message has msginbuf[1] + 2
2110 * (msgin_len starts counting from 0, so buf[1] + 1).
2111 * If current message position is not finished,
2112 * continue receiving message.
2114 msgclear = FALSE;
2115 break;
2119 * Reach here means regular length of each type of
2120 * extended messages.
2122 switch (data->msginbuf[2]) {
2123 case EXTENDED_MODIFY_DATA_POINTER:
2124 /* TODO */
2125 goto reject; /* not implemented yet */
2126 break;
2128 case EXTENDED_SDTR:
2130 * Exchange this message between initiator and target.
2132 if (data->msgin_len != EXTENDED_SDTR_LEN + 1) {
2134 * received inappropriate message.
2136 goto reject;
2137 break;
2140 nsp32_analyze_sdtr(SCpnt);
2142 break;
2144 case EXTENDED_EXTENDED_IDENTIFY:
2145 /* SCSI-I only, not supported. */
2146 goto reject; /* not implemented yet */
2148 break;
2150 case EXTENDED_WDTR:
2151 goto reject; /* not implemented yet */
2153 break;
2155 default:
2156 goto reject;
2158 break;
2160 default:
2161 goto reject;
2164 restart:
2165 if (msgclear == TRUE) {
2166 data->msgin_len = 0;
2169 * If restarting AutoSCSI, but there are some message to out
2170 * (msgout_len > 0), set AutoATN, and set SCSIMSGOUT as 0
2171 * (MV_VALID = 0). When commandcontrol is written with
2172 * AutoSCSI restart, at the same time MsgOutOccur should be
2173 * happened (however, such situation is really possible...?).
2175 if (data->msgout_len > 0) {
2176 nsp32_write4(base, SCSI_MSG_OUT, 0);
2177 command |= AUTO_ATN;
2181 * restart AutoSCSI
2182 * If it's failed, COMMANDCONTROL_AUTO_COMMAND_PHASE is needed.
2184 command |= (AUTO_MSGIN_00_OR_04 | AUTO_MSGIN_02);
2187 * If current msgin03 is TRUE, then flag on.
2189 if (data->cur_lunt->msgin03 == TRUE) {
2190 command |= AUTO_MSGIN_03;
2192 data->cur_lunt->msgin03 = FALSE;
2193 } else {
2194 data->msgin_len++;
2198 * restart AutoSCSI
2200 nsp32_restart_autoscsi(SCpnt, command);
2203 * wait SCSI REQ negate for REQ-ACK handshake
2205 nsp32_wait_req(data, NEGATE);
2208 * negate SCSI ACK
2210 nsp32_sack_negate(data);
2212 nsp32_dbg(NSP32_DEBUG_MSGINOCCUR, "exit");
2214 return;
2216 reject:
2217 nsp32_msg(KERN_WARNING,
2218 "invalid or unsupported MessageIn, rejected. "
2219 "current msg: 0x%x (len: 0x%x), processing msg: 0x%x",
2220 msg, data->msgin_len, msgtype);
2221 nsp32_build_reject(SCpnt);
2222 data->msgin_len = 0;
2224 goto restart;
2230 static void nsp32_analyze_sdtr(struct scsi_cmnd *SCpnt)
2232 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
2233 nsp32_target *target = data->cur_target;
2234 nsp32_sync_table *synct;
2235 unsigned char get_period = data->msginbuf[3];
2236 unsigned char get_offset = data->msginbuf[4];
2237 int entry;
2238 int syncnum;
2240 nsp32_dbg(NSP32_DEBUG_MSGINOCCUR, "enter");
2242 synct = data->synct;
2243 syncnum = data->syncnum;
2246 * If this inititor sent the SDTR message, then target responds SDTR,
2247 * initiator SYNCREG, ACKWIDTH from SDTR parameter.
2248 * Messages are not appropriate, then send back reject message.
2249 * If initiator did not send the SDTR, but target sends SDTR,
2250 * initiator calculator the appropriate parameter and send back SDTR.
2252 if (target->sync_flag & SDTR_INITIATOR) {
2254 * Initiator sent SDTR, the target responds and
2255 * send back negotiation SDTR.
2257 nsp32_dbg(NSP32_DEBUG_MSGINOCCUR, "target responds SDTR");
2259 target->sync_flag &= ~SDTR_INITIATOR;
2260 target->sync_flag |= SDTR_DONE;
2263 * offset:
2265 if (get_offset > SYNC_OFFSET) {
2267 * Negotiation is failed, the target send back
2268 * unexpected offset value.
2270 goto reject;
2273 if (get_offset == ASYNC_OFFSET) {
2275 * Negotiation is succeeded, the target want
2276 * to fall back into asynchronous transfer mode.
2278 goto async;
2282 * period:
2283 * Check whether sync period is too short. If too short,
2284 * fall back to async mode. If it's ok, then investigate
2285 * the received sync period. If sync period is acceptable
2286 * between sync table start_period and end_period, then
2287 * set this I_T nexus as sent offset and period.
2288 * If it's not acceptable, send back reject and fall back
2289 * to async mode.
2291 if (get_period < data->synct[0].period_num) {
2293 * Negotiation is failed, the target send back
2294 * unexpected period value.
2296 goto reject;
2299 entry = nsp32_search_period_entry(data, target, get_period);
2301 if (entry < 0) {
2303 * Target want to use long period which is not
2304 * acceptable NinjaSCSI-32Bi/UDE.
2306 goto reject;
2310 * Set new sync table and offset in this I_T nexus.
2312 nsp32_set_sync_entry(data, target, entry, get_offset);
2313 } else {
2314 /* Target send SDTR to initiator. */
2315 nsp32_dbg(NSP32_DEBUG_MSGINOCCUR, "target send SDTR");
2317 target->sync_flag |= SDTR_INITIATOR;
2319 /* offset: */
2320 if (get_offset > SYNC_OFFSET) {
2321 /* send back as SYNC_OFFSET */
2322 get_offset = SYNC_OFFSET;
2325 /* period: */
2326 if (get_period < data->synct[0].period_num) {
2327 get_period = data->synct[0].period_num;
2330 entry = nsp32_search_period_entry(data, target, get_period);
2332 if (get_offset == ASYNC_OFFSET || entry < 0) {
2333 nsp32_set_async(data, target);
2334 nsp32_build_sdtr(SCpnt, 0, ASYNC_OFFSET);
2335 } else {
2336 nsp32_set_sync_entry(data, target, entry, get_offset);
2337 nsp32_build_sdtr(SCpnt, get_period, get_offset);
2341 target->period = get_period;
2342 nsp32_dbg(NSP32_DEBUG_MSGINOCCUR, "exit");
2343 return;
2345 reject:
2347 * If the current message is unacceptable, send back to the target
2348 * with reject message.
2350 nsp32_build_reject(SCpnt);
2352 async:
2353 nsp32_set_async(data, target); /* set as ASYNC transfer mode */
2355 target->period = 0;
2356 nsp32_dbg(NSP32_DEBUG_MSGINOCCUR, "exit: set async");
2357 return;
2362 * Search config entry number matched in sync_table from given
2363 * target and speed period value. If failed to search, return negative value.
2365 static int nsp32_search_period_entry(nsp32_hw_data *data,
2366 nsp32_target *target,
2367 unsigned char period)
2369 int i;
2371 if (target->limit_entry >= data->syncnum) {
2372 nsp32_msg(KERN_ERR, "limit_entry exceeds syncnum!");
2373 target->limit_entry = 0;
2376 for (i = target->limit_entry; i < data->syncnum; i++) {
2377 if (period >= data->synct[i].start_period &&
2378 period <= data->synct[i].end_period) {
2379 break;
2384 * Check given period value is over the sync_table value.
2385 * If so, return max value.
2387 if (i == data->syncnum) {
2388 i = -1;
2391 return i;
2396 * target <-> initiator use ASYNC transfer
2398 static void nsp32_set_async(nsp32_hw_data *data, nsp32_target *target)
2400 unsigned char period = data->synct[target->limit_entry].period_num;
2402 target->offset = ASYNC_OFFSET;
2403 target->period = 0;
2404 target->syncreg = TO_SYNCREG(period, ASYNC_OFFSET);
2405 target->ackwidth = 0;
2406 target->sample_reg = 0;
2408 nsp32_dbg(NSP32_DEBUG_SYNC, "set async");
2413 * target <-> initiator use maximum SYNC transfer
2415 static void nsp32_set_max_sync(nsp32_hw_data *data,
2416 nsp32_target *target,
2417 unsigned char *period,
2418 unsigned char *offset)
2420 unsigned char period_num, ackwidth;
2422 period_num = data->synct[target->limit_entry].period_num;
2423 *period = data->synct[target->limit_entry].start_period;
2424 ackwidth = data->synct[target->limit_entry].ackwidth;
2425 *offset = SYNC_OFFSET;
2427 target->syncreg = TO_SYNCREG(period_num, *offset);
2428 target->ackwidth = ackwidth;
2429 target->offset = *offset;
2430 target->sample_reg = 0; /* disable SREQ sampling */
2435 * target <-> initiator use entry number speed
2437 static void nsp32_set_sync_entry(nsp32_hw_data *data,
2438 nsp32_target *target,
2439 int entry,
2440 unsigned char offset)
2442 unsigned char period, ackwidth, sample_rate;
2444 period = data->synct[entry].period_num;
2445 ackwidth = data->synct[entry].ackwidth;
2446 offset = offset;
2447 sample_rate = data->synct[entry].sample_rate;
2449 target->syncreg = TO_SYNCREG(period, offset);
2450 target->ackwidth = ackwidth;
2451 target->offset = offset;
2452 target->sample_reg = sample_rate | SAMPLING_ENABLE;
2454 nsp32_dbg(NSP32_DEBUG_SYNC, "set sync");
2459 * It waits until SCSI REQ becomes assertion or negation state.
2461 * Note: If nsp32_msgin_occur is called, we asserts SCSI ACK. Then
2462 * connected target responds SCSI REQ negation. We have to wait
2463 * SCSI REQ becomes negation in order to negate SCSI ACK signal for
2464 * REQ-ACK handshake.
2466 static void nsp32_wait_req(nsp32_hw_data *data, int state)
2468 unsigned int base = data->BaseAddress;
2469 int wait_time = 0;
2470 unsigned char bus, req_bit;
2472 if (!((state == ASSERT) || (state == NEGATE))) {
2473 nsp32_msg(KERN_ERR, "unknown state designation");
2475 /* REQ is BIT(5) */
2476 req_bit = (state == ASSERT ? BUSMON_REQ : 0);
2478 do {
2479 bus = nsp32_read1(base, SCSI_BUS_MONITOR);
2480 if ((bus & BUSMON_REQ) == req_bit) {
2481 nsp32_dbg(NSP32_DEBUG_WAIT,
2482 "wait_time: %d", wait_time);
2483 return;
2485 udelay(1);
2486 wait_time++;
2487 } while (wait_time < REQSACK_TIMEOUT_TIME);
2489 nsp32_msg(KERN_WARNING, "wait REQ timeout, req_bit: 0x%x", req_bit);
2493 * It waits until SCSI SACK becomes assertion or negation state.
2495 static void nsp32_wait_sack(nsp32_hw_data *data, int state)
2497 unsigned int base = data->BaseAddress;
2498 int wait_time = 0;
2499 unsigned char bus, ack_bit;
2501 if (!((state == ASSERT) || (state == NEGATE))) {
2502 nsp32_msg(KERN_ERR, "unknown state designation");
2504 /* ACK is BIT(4) */
2505 ack_bit = (state == ASSERT ? BUSMON_ACK : 0);
2507 do {
2508 bus = nsp32_read1(base, SCSI_BUS_MONITOR);
2509 if ((bus & BUSMON_ACK) == ack_bit) {
2510 nsp32_dbg(NSP32_DEBUG_WAIT,
2511 "wait_time: %d", wait_time);
2512 return;
2514 udelay(1);
2515 wait_time++;
2516 } while (wait_time < REQSACK_TIMEOUT_TIME);
2518 nsp32_msg(KERN_WARNING, "wait SACK timeout, ack_bit: 0x%x", ack_bit);
2522 * assert SCSI ACK
2524 * Note: SCSI ACK assertion needs with ACKENB=1, AUTODIRECTION=1.
2526 static void nsp32_sack_assert(nsp32_hw_data *data)
2528 unsigned int base = data->BaseAddress;
2529 unsigned char busctrl;
2531 busctrl = nsp32_read1(base, SCSI_BUS_CONTROL);
2532 busctrl |= (BUSCTL_ACK | AUTODIRECTION | ACKENB);
2533 nsp32_write1(base, SCSI_BUS_CONTROL, busctrl);
2537 * negate SCSI ACK
2539 static void nsp32_sack_negate(nsp32_hw_data *data)
2541 unsigned int base = data->BaseAddress;
2542 unsigned char busctrl;
2544 busctrl = nsp32_read1(base, SCSI_BUS_CONTROL);
2545 busctrl &= ~BUSCTL_ACK;
2546 nsp32_write1(base, SCSI_BUS_CONTROL, busctrl);
2552 * Note: n_io_port is defined as 0x7f because I/O register port is
2553 * assigned as:
2554 * 0x800-0x8ff: memory mapped I/O port
2555 * 0x900-0xbff: (map same 0x800-0x8ff I/O port image repeatedly)
2556 * 0xc00-0xfff: CardBus status registers
2558 static int nsp32_detect(struct pci_dev *pdev)
2560 struct Scsi_Host *host; /* registered host structure */
2561 struct resource *res;
2562 nsp32_hw_data *data;
2563 int ret;
2564 int i, j;
2566 nsp32_dbg(NSP32_DEBUG_REGISTER, "enter");
2569 * register this HBA as SCSI device
2571 host = scsi_host_alloc(&nsp32_template, sizeof(nsp32_hw_data));
2572 if (host == NULL) {
2573 nsp32_msg (KERN_ERR, "failed to scsi register");
2574 goto err;
2578 * set nsp32_hw_data
2580 data = (nsp32_hw_data *)host->hostdata;
2582 memcpy(data, &nsp32_data_base, sizeof(nsp32_hw_data));
2584 host->irq = data->IrqNumber;
2585 host->io_port = data->BaseAddress;
2586 host->unique_id = data->BaseAddress;
2587 host->n_io_port = data->NumAddress;
2588 host->base = (unsigned long)data->MmioAddress;
2590 data->Host = host;
2591 spin_lock_init(&(data->Lock));
2593 data->cur_lunt = NULL;
2594 data->cur_target = NULL;
2597 * Bus master transfer mode is supported currently.
2599 data->trans_method = NSP32_TRANSFER_BUSMASTER;
2602 * Set clock div, CLOCK_4 (HBA has own external clock, and
2603 * dividing * 100ns/4).
2604 * Currently CLOCK_4 has only tested, not for CLOCK_2/PCICLK yet.
2606 data->clock = CLOCK_4;
2609 * Select appropriate nsp32_sync_table and set I_CLOCKDIV.
2611 switch (data->clock) {
2612 case CLOCK_4:
2613 /* If data->clock is CLOCK_4, then select 40M sync table. */
2614 data->synct = nsp32_sync_table_40M;
2615 data->syncnum = ARRAY_SIZE(nsp32_sync_table_40M);
2616 break;
2617 case CLOCK_2:
2618 /* If data->clock is CLOCK_2, then select 20M sync table. */
2619 data->synct = nsp32_sync_table_20M;
2620 data->syncnum = ARRAY_SIZE(nsp32_sync_table_20M);
2621 break;
2622 case PCICLK:
2623 /* If data->clock is PCICLK, then select pci sync table. */
2624 data->synct = nsp32_sync_table_pci;
2625 data->syncnum = ARRAY_SIZE(nsp32_sync_table_pci);
2626 break;
2627 default:
2628 nsp32_msg(KERN_WARNING,
2629 "Invalid clock div is selected, set CLOCK_4.");
2630 /* Use default value CLOCK_4 */
2631 data->clock = CLOCK_4;
2632 data->synct = nsp32_sync_table_40M;
2633 data->syncnum = ARRAY_SIZE(nsp32_sync_table_40M);
2637 * setup nsp32_lunt
2641 * setup DMA
2643 if (pci_set_dma_mask(pdev, DMA_BIT_MASK(32)) != 0) {
2644 nsp32_msg (KERN_ERR, "failed to set PCI DMA mask");
2645 goto scsi_unregister;
2649 * allocate autoparam DMA resource.
2651 data->autoparam = pci_alloc_consistent(pdev, sizeof(nsp32_autoparam), &(data->auto_paddr));
2652 if (data->autoparam == NULL) {
2653 nsp32_msg(KERN_ERR, "failed to allocate DMA memory");
2654 goto scsi_unregister;
2658 * allocate scatter-gather DMA resource.
2660 data->sg_list = pci_alloc_consistent(pdev, NSP32_SG_TABLE_SIZE,
2661 &(data->sg_paddr));
2662 if (data->sg_list == NULL) {
2663 nsp32_msg(KERN_ERR, "failed to allocate DMA memory");
2664 goto free_autoparam;
2667 for (i = 0; i < ARRAY_SIZE(data->lunt); i++) {
2668 for (j = 0; j < ARRAY_SIZE(data->lunt[0]); j++) {
2669 int offset = i * ARRAY_SIZE(data->lunt[0]) + j;
2670 nsp32_lunt tmp = {
2671 .SCpnt = NULL,
2672 .save_datp = 0,
2673 .msgin03 = FALSE,
2674 .sg_num = 0,
2675 .cur_entry = 0,
2676 .sglun = &(data->sg_list[offset]),
2677 .sglun_paddr = data->sg_paddr + (offset * sizeof(nsp32_sglun)),
2680 data->lunt[i][j] = tmp;
2685 * setup target
2687 for (i = 0; i < ARRAY_SIZE(data->target); i++) {
2688 nsp32_target *target = &(data->target[i]);
2690 target->limit_entry = 0;
2691 target->sync_flag = 0;
2692 nsp32_set_async(data, target);
2696 * EEPROM check
2698 ret = nsp32_getprom_param(data);
2699 if (ret == FALSE) {
2700 data->resettime = 3; /* default 3 */
2704 * setup HBA
2706 nsp32hw_init(data);
2708 snprintf(data->info_str, sizeof(data->info_str),
2709 "NinjaSCSI-32Bi/UDE: irq %d, io 0x%lx+0x%x",
2710 host->irq, host->io_port, host->n_io_port);
2713 * SCSI bus reset
2715 * Note: It's important to reset SCSI bus in initialization phase.
2716 * NinjaSCSI-32Bi/UDE HBA EEPROM seems to exchange SDTR when
2717 * system is coming up, so SCSI devices connected to HBA is set as
2718 * un-asynchronous mode. It brings the merit that this HBA is
2719 * ready to start synchronous transfer without any preparation,
2720 * but we are difficult to control transfer speed. In addition,
2721 * it prevents device transfer speed from effecting EEPROM start-up
2722 * SDTR. NinjaSCSI-32Bi/UDE has the feature if EEPROM is set as
2723 * Auto Mode, then FAST-10M is selected when SCSI devices are
2724 * connected same or more than 4 devices. It should be avoided
2725 * depending on this specification. Thus, resetting the SCSI bus
2726 * restores all connected SCSI devices to asynchronous mode, then
2727 * this driver set SDTR safely later, and we can control all SCSI
2728 * device transfer mode.
2730 nsp32_do_bus_reset(data);
2732 ret = request_irq(host->irq, do_nsp32_isr, IRQF_SHARED, "nsp32", data);
2733 if (ret < 0) {
2734 nsp32_msg(KERN_ERR, "Unable to allocate IRQ for NinjaSCSI32 "
2735 "SCSI PCI controller. Interrupt: %d", host->irq);
2736 goto free_sg_list;
2740 * PCI IO register
2742 res = request_region(host->io_port, host->n_io_port, "nsp32");
2743 if (res == NULL) {
2744 nsp32_msg(KERN_ERR,
2745 "I/O region 0x%lx+0x%lx is already used",
2746 data->BaseAddress, data->NumAddress);
2747 goto free_irq;
2750 ret = scsi_add_host(host, &pdev->dev);
2751 if (ret) {
2752 nsp32_msg(KERN_ERR, "failed to add scsi host");
2753 goto free_region;
2755 scsi_scan_host(host);
2756 pci_set_drvdata(pdev, host);
2757 return 0;
2759 free_region:
2760 release_region(host->io_port, host->n_io_port);
2762 free_irq:
2763 free_irq(host->irq, data);
2765 free_sg_list:
2766 pci_free_consistent(pdev, NSP32_SG_TABLE_SIZE,
2767 data->sg_list, data->sg_paddr);
2769 free_autoparam:
2770 pci_free_consistent(pdev, sizeof(nsp32_autoparam),
2771 data->autoparam, data->auto_paddr);
2773 scsi_unregister:
2774 scsi_host_put(host);
2776 err:
2777 return 1;
2780 static int nsp32_release(struct Scsi_Host *host)
2782 nsp32_hw_data *data = (nsp32_hw_data *)host->hostdata;
2784 if (data->autoparam) {
2785 pci_free_consistent(data->Pci, sizeof(nsp32_autoparam),
2786 data->autoparam, data->auto_paddr);
2789 if (data->sg_list) {
2790 pci_free_consistent(data->Pci, NSP32_SG_TABLE_SIZE,
2791 data->sg_list, data->sg_paddr);
2794 if (host->irq) {
2795 free_irq(host->irq, data);
2798 if (host->io_port && host->n_io_port) {
2799 release_region(host->io_port, host->n_io_port);
2802 if (data->MmioAddress) {
2803 iounmap(data->MmioAddress);
2806 return 0;
2809 static const char *nsp32_info(struct Scsi_Host *shpnt)
2811 nsp32_hw_data *data = (nsp32_hw_data *)shpnt->hostdata;
2813 return data->info_str;
2817 /****************************************************************************
2818 * error handler
2820 static int nsp32_eh_abort(struct scsi_cmnd *SCpnt)
2822 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
2823 unsigned int base = SCpnt->device->host->io_port;
2825 nsp32_msg(KERN_WARNING, "abort");
2827 if (data->cur_lunt->SCpnt == NULL) {
2828 nsp32_dbg(NSP32_DEBUG_BUSRESET, "abort failed");
2829 return FAILED;
2832 if (data->cur_target->sync_flag & (SDTR_INITIATOR | SDTR_TARGET)) {
2833 /* reset SDTR negotiation */
2834 data->cur_target->sync_flag = 0;
2835 nsp32_set_async(data, data->cur_target);
2838 nsp32_write2(base, TRANSFER_CONTROL, 0);
2839 nsp32_write2(base, BM_CNT, 0);
2841 SCpnt->result = DID_ABORT << 16;
2842 nsp32_scsi_done(SCpnt);
2844 nsp32_dbg(NSP32_DEBUG_BUSRESET, "abort success");
2845 return SUCCESS;
2848 static int nsp32_eh_bus_reset(struct scsi_cmnd *SCpnt)
2850 nsp32_hw_data *data = (nsp32_hw_data *)SCpnt->device->host->hostdata;
2851 unsigned int base = SCpnt->device->host->io_port;
2853 spin_lock_irq(SCpnt->device->host->host_lock);
2855 nsp32_msg(KERN_INFO, "Bus Reset");
2856 nsp32_dbg(NSP32_DEBUG_BUSRESET, "SCpnt=0x%x", SCpnt);
2858 nsp32_write2(base, IRQ_CONTROL, IRQ_CONTROL_ALL_IRQ_MASK);
2859 nsp32_do_bus_reset(data);
2860 nsp32_write2(base, IRQ_CONTROL, 0);
2862 spin_unlock_irq(SCpnt->device->host->host_lock);
2863 return SUCCESS; /* SCSI bus reset is succeeded at any time. */
2866 static void nsp32_do_bus_reset(nsp32_hw_data *data)
2868 unsigned int base = data->BaseAddress;
2869 unsigned short intrdat;
2870 int i;
2872 nsp32_dbg(NSP32_DEBUG_BUSRESET, "in");
2875 * stop all transfer
2876 * clear TRANSFERCONTROL_BM_START
2877 * clear counter
2879 nsp32_write2(base, TRANSFER_CONTROL, 0);
2880 nsp32_write4(base, BM_CNT, 0);
2881 nsp32_write4(base, CLR_COUNTER, CLRCOUNTER_ALLMASK);
2884 * fall back to asynchronous transfer mode
2885 * initialize SDTR negotiation flag
2887 for (i = 0; i < ARRAY_SIZE(data->target); i++) {
2888 nsp32_target *target = &data->target[i];
2890 target->sync_flag = 0;
2891 nsp32_set_async(data, target);
2895 * reset SCSI bus
2897 nsp32_write1(base, SCSI_BUS_CONTROL, BUSCTL_RST);
2898 mdelay(RESET_HOLD_TIME / 1000);
2899 nsp32_write1(base, SCSI_BUS_CONTROL, 0);
2900 for(i = 0; i < 5; i++) {
2901 intrdat = nsp32_read2(base, IRQ_STATUS); /* dummy read */
2902 nsp32_dbg(NSP32_DEBUG_BUSRESET, "irq:1: 0x%x", intrdat);
2905 data->CurrentSC = NULL;
2908 static int nsp32_eh_host_reset(struct scsi_cmnd *SCpnt)
2910 struct Scsi_Host *host = SCpnt->device->host;
2911 unsigned int base = SCpnt->device->host->io_port;
2912 nsp32_hw_data *data = (nsp32_hw_data *)host->hostdata;
2914 nsp32_msg(KERN_INFO, "Host Reset");
2915 nsp32_dbg(NSP32_DEBUG_BUSRESET, "SCpnt=0x%x", SCpnt);
2917 spin_lock_irq(SCpnt->device->host->host_lock);
2919 nsp32hw_init(data);
2920 nsp32_write2(base, IRQ_CONTROL, IRQ_CONTROL_ALL_IRQ_MASK);
2921 nsp32_do_bus_reset(data);
2922 nsp32_write2(base, IRQ_CONTROL, 0);
2924 spin_unlock_irq(SCpnt->device->host->host_lock);
2925 return SUCCESS; /* Host reset is succeeded at any time. */
2929 /**************************************************************************
2930 * EEPROM handler
2934 * getting EEPROM parameter
2936 static int nsp32_getprom_param(nsp32_hw_data *data)
2938 int vendor = data->pci_devid->vendor;
2939 int device = data->pci_devid->device;
2940 int ret, val, i;
2943 * EEPROM checking.
2945 ret = nsp32_prom_read(data, 0x7e);
2946 if (ret != 0x55) {
2947 nsp32_msg(KERN_INFO, "No EEPROM detected: 0x%x", ret);
2948 return FALSE;
2950 ret = nsp32_prom_read(data, 0x7f);
2951 if (ret != 0xaa) {
2952 nsp32_msg(KERN_INFO, "Invalid number: 0x%x", ret);
2953 return FALSE;
2957 * check EEPROM type
2959 if (vendor == PCI_VENDOR_ID_WORKBIT &&
2960 device == PCI_DEVICE_ID_WORKBIT_STANDARD) {
2961 ret = nsp32_getprom_c16(data);
2962 } else if (vendor == PCI_VENDOR_ID_WORKBIT &&
2963 device == PCI_DEVICE_ID_NINJASCSI_32BIB_LOGITEC) {
2964 ret = nsp32_getprom_at24(data);
2965 } else if (vendor == PCI_VENDOR_ID_WORKBIT &&
2966 device == PCI_DEVICE_ID_NINJASCSI_32UDE_MELCO ) {
2967 ret = nsp32_getprom_at24(data);
2968 } else {
2969 nsp32_msg(KERN_WARNING, "Unknown EEPROM");
2970 ret = FALSE;
2973 /* for debug : SPROM data full checking */
2974 for (i = 0; i <= 0x1f; i++) {
2975 val = nsp32_prom_read(data, i);
2976 nsp32_dbg(NSP32_DEBUG_EEPROM,
2977 "rom address 0x%x : 0x%x", i, val);
2980 return ret;
2985 * AT24C01A (Logitec: LHA-600S), AT24C02 (Melco Buffalo: IFC-USLP) data map:
2987 * ROMADDR
2988 * 0x00 - 0x06 : Device Synchronous Transfer Period (SCSI ID 0 - 6)
2989 * Value 0x0: ASYNC, 0x0c: Ultra-20M, 0x19: Fast-10M
2990 * 0x07 : HBA Synchronous Transfer Period
2991 * Value 0: AutoSync, 1: Manual Setting
2992 * 0x08 - 0x0f : Not Used? (0x0)
2993 * 0x10 : Bus Termination
2994 * Value 0: Auto[ON], 1: ON, 2: OFF
2995 * 0x11 : Not Used? (0)
2996 * 0x12 : Bus Reset Delay Time (0x03)
2997 * 0x13 : Bootable CD Support
2998 * Value 0: Disable, 1: Enable
2999 * 0x14 : Device Scan
3000 * Bit 7 6 5 4 3 2 1 0
3001 * | <----------------->
3002 * | SCSI ID: Value 0: Skip, 1: YES
3003 * |-> Value 0: ALL scan, Value 1: Manual
3004 * 0x15 - 0x1b : Not Used? (0)
3005 * 0x1c : Constant? (0x01) (clock div?)
3006 * 0x1d - 0x7c : Not Used (0xff)
3007 * 0x7d : Not Used? (0xff)
3008 * 0x7e : Constant (0x55), Validity signature
3009 * 0x7f : Constant (0xaa), Validity signature
3011 static int nsp32_getprom_at24(nsp32_hw_data *data)
3013 int ret, i;
3014 int auto_sync;
3015 nsp32_target *target;
3016 int entry;
3019 * Reset time which is designated by EEPROM.
3021 * TODO: Not used yet.
3023 data->resettime = nsp32_prom_read(data, 0x12);
3026 * HBA Synchronous Transfer Period
3028 * Note: auto_sync = 0: auto, 1: manual. Ninja SCSI HBA spec says
3029 * that if auto_sync is 0 (auto), and connected SCSI devices are
3030 * same or lower than 3, then transfer speed is set as ULTRA-20M.
3031 * On the contrary if connected SCSI devices are same or higher
3032 * than 4, then transfer speed is set as FAST-10M.
3034 * I break this rule. The number of connected SCSI devices are
3035 * only ignored. If auto_sync is 0 (auto), then transfer speed is
3036 * forced as ULTRA-20M.
3038 ret = nsp32_prom_read(data, 0x07);
3039 switch (ret) {
3040 case 0:
3041 auto_sync = TRUE;
3042 break;
3043 case 1:
3044 auto_sync = FALSE;
3045 break;
3046 default:
3047 nsp32_msg(KERN_WARNING,
3048 "Unsupported Auto Sync mode. Fall back to manual mode.");
3049 auto_sync = TRUE;
3052 if (trans_mode == ULTRA20M_MODE) {
3053 auto_sync = TRUE;
3057 * each device Synchronous Transfer Period
3059 for (i = 0; i < NSP32_HOST_SCSIID; i++) {
3060 target = &data->target[i];
3061 if (auto_sync == TRUE) {
3062 target->limit_entry = 0; /* set as ULTRA20M */
3063 } else {
3064 ret = nsp32_prom_read(data, i);
3065 entry = nsp32_search_period_entry(data, target, ret);
3066 if (entry < 0) {
3067 /* search failed... set maximum speed */
3068 entry = 0;
3070 target->limit_entry = entry;
3074 return TRUE;
3079 * C16 110 (I-O Data: SC-NBD) data map:
3081 * ROMADDR
3082 * 0x00 - 0x06 : Device Synchronous Transfer Period (SCSI ID 0 - 6)
3083 * Value 0x0: 20MB/S, 0x1: 10MB/S, 0x2: 5MB/S, 0x3: ASYNC
3084 * 0x07 : 0 (HBA Synchronous Transfer Period: Auto Sync)
3085 * 0x08 - 0x0f : Not Used? (0x0)
3086 * 0x10 : Transfer Mode
3087 * Value 0: PIO, 1: Busmater
3088 * 0x11 : Bus Reset Delay Time (0x00-0x20)
3089 * 0x12 : Bus Termination
3090 * Value 0: Disable, 1: Enable
3091 * 0x13 - 0x19 : Disconnection
3092 * Value 0: Disable, 1: Enable
3093 * 0x1a - 0x7c : Not Used? (0)
3094 * 0x7d : Not Used? (0xf8)
3095 * 0x7e : Constant (0x55), Validity signature
3096 * 0x7f : Constant (0xaa), Validity signature
3098 static int nsp32_getprom_c16(nsp32_hw_data *data)
3100 int ret, i;
3101 nsp32_target *target;
3102 int entry, val;
3105 * Reset time which is designated by EEPROM.
3107 * TODO: Not used yet.
3109 data->resettime = nsp32_prom_read(data, 0x11);
3112 * each device Synchronous Transfer Period
3114 for (i = 0; i < NSP32_HOST_SCSIID; i++) {
3115 target = &data->target[i];
3116 ret = nsp32_prom_read(data, i);
3117 switch (ret) {
3118 case 0: /* 20MB/s */
3119 val = 0x0c;
3120 break;
3121 case 1: /* 10MB/s */
3122 val = 0x19;
3123 break;
3124 case 2: /* 5MB/s */
3125 val = 0x32;
3126 break;
3127 case 3: /* ASYNC */
3128 val = 0x00;
3129 break;
3130 default: /* default 20MB/s */
3131 val = 0x0c;
3132 break;
3134 entry = nsp32_search_period_entry(data, target, val);
3135 if (entry < 0 || trans_mode == ULTRA20M_MODE) {
3136 /* search failed... set maximum speed */
3137 entry = 0;
3139 target->limit_entry = entry;
3142 return TRUE;
3147 * Atmel AT24C01A (drived in 5V) serial EEPROM routines
3149 static int nsp32_prom_read(nsp32_hw_data *data, int romaddr)
3151 int i, val;
3153 /* start condition */
3154 nsp32_prom_start(data);
3156 /* device address */
3157 nsp32_prom_write_bit(data, 1); /* 1 */
3158 nsp32_prom_write_bit(data, 0); /* 0 */
3159 nsp32_prom_write_bit(data, 1); /* 1 */
3160 nsp32_prom_write_bit(data, 0); /* 0 */
3161 nsp32_prom_write_bit(data, 0); /* A2: 0 (GND) */
3162 nsp32_prom_write_bit(data, 0); /* A1: 0 (GND) */
3163 nsp32_prom_write_bit(data, 0); /* A0: 0 (GND) */
3165 /* R/W: W for dummy write */
3166 nsp32_prom_write_bit(data, 0);
3168 /* ack */
3169 nsp32_prom_write_bit(data, 0);
3171 /* word address */
3172 for (i = 7; i >= 0; i--) {
3173 nsp32_prom_write_bit(data, ((romaddr >> i) & 1));
3176 /* ack */
3177 nsp32_prom_write_bit(data, 0);
3179 /* start condition */
3180 nsp32_prom_start(data);
3182 /* device address */
3183 nsp32_prom_write_bit(data, 1); /* 1 */
3184 nsp32_prom_write_bit(data, 0); /* 0 */
3185 nsp32_prom_write_bit(data, 1); /* 1 */
3186 nsp32_prom_write_bit(data, 0); /* 0 */
3187 nsp32_prom_write_bit(data, 0); /* A2: 0 (GND) */
3188 nsp32_prom_write_bit(data, 0); /* A1: 0 (GND) */
3189 nsp32_prom_write_bit(data, 0); /* A0: 0 (GND) */
3191 /* R/W: R */
3192 nsp32_prom_write_bit(data, 1);
3194 /* ack */
3195 nsp32_prom_write_bit(data, 0);
3197 /* data... */
3198 val = 0;
3199 for (i = 7; i >= 0; i--) {
3200 val += (nsp32_prom_read_bit(data) << i);
3203 /* no ack */
3204 nsp32_prom_write_bit(data, 1);
3206 /* stop condition */
3207 nsp32_prom_stop(data);
3209 return val;
3212 static void nsp32_prom_set(nsp32_hw_data *data, int bit, int val)
3214 int base = data->BaseAddress;
3215 int tmp;
3217 tmp = nsp32_index_read1(base, SERIAL_ROM_CTL);
3219 if (val == 0) {
3220 tmp &= ~bit;
3221 } else {
3222 tmp |= bit;
3225 nsp32_index_write1(base, SERIAL_ROM_CTL, tmp);
3227 udelay(10);
3230 static int nsp32_prom_get(nsp32_hw_data *data, int bit)
3232 int base = data->BaseAddress;
3233 int tmp, ret;
3235 if (bit != SDA) {
3236 nsp32_msg(KERN_ERR, "return value is not appropriate");
3237 return 0;
3241 tmp = nsp32_index_read1(base, SERIAL_ROM_CTL) & bit;
3243 if (tmp == 0) {
3244 ret = 0;
3245 } else {
3246 ret = 1;
3249 udelay(10);
3251 return ret;
3254 static void nsp32_prom_start (nsp32_hw_data *data)
3256 /* start condition */
3257 nsp32_prom_set(data, SCL, 1);
3258 nsp32_prom_set(data, SDA, 1);
3259 nsp32_prom_set(data, ENA, 1); /* output mode */
3260 nsp32_prom_set(data, SDA, 0); /* keeping SCL=1 and transiting
3261 * SDA 1->0 is start condition */
3262 nsp32_prom_set(data, SCL, 0);
3265 static void nsp32_prom_stop (nsp32_hw_data *data)
3267 /* stop condition */
3268 nsp32_prom_set(data, SCL, 1);
3269 nsp32_prom_set(data, SDA, 0);
3270 nsp32_prom_set(data, ENA, 1); /* output mode */
3271 nsp32_prom_set(data, SDA, 1);
3272 nsp32_prom_set(data, SCL, 0);
3275 static void nsp32_prom_write_bit(nsp32_hw_data *data, int val)
3277 /* write */
3278 nsp32_prom_set(data, SDA, val);
3279 nsp32_prom_set(data, SCL, 1 );
3280 nsp32_prom_set(data, SCL, 0 );
3283 static int nsp32_prom_read_bit(nsp32_hw_data *data)
3285 int val;
3287 /* read */
3288 nsp32_prom_set(data, ENA, 0); /* input mode */
3289 nsp32_prom_set(data, SCL, 1);
3291 val = nsp32_prom_get(data, SDA);
3293 nsp32_prom_set(data, SCL, 0);
3294 nsp32_prom_set(data, ENA, 1); /* output mode */
3296 return val;
3300 /**************************************************************************
3301 * Power Management
3303 #ifdef CONFIG_PM
3305 /* Device suspended */
3306 static int nsp32_suspend(struct pci_dev *pdev, pm_message_t state)
3308 struct Scsi_Host *host = pci_get_drvdata(pdev);
3310 nsp32_msg(KERN_INFO, "pci-suspend: pdev=0x%p, state=%ld, slot=%s, host=0x%p", pdev, state, pci_name(pdev), host);
3312 pci_save_state (pdev);
3313 pci_disable_device (pdev);
3314 pci_set_power_state(pdev, pci_choose_state(pdev, state));
3316 return 0;
3319 /* Device woken up */
3320 static int nsp32_resume(struct pci_dev *pdev)
3322 struct Scsi_Host *host = pci_get_drvdata(pdev);
3323 nsp32_hw_data *data = (nsp32_hw_data *)host->hostdata;
3324 unsigned short reg;
3326 nsp32_msg(KERN_INFO, "pci-resume: pdev=0x%p, slot=%s, host=0x%p", pdev, pci_name(pdev), host);
3328 pci_set_power_state(pdev, PCI_D0);
3329 pci_enable_wake (pdev, PCI_D0, 0);
3330 pci_restore_state (pdev);
3332 reg = nsp32_read2(data->BaseAddress, INDEX_REG);
3334 nsp32_msg(KERN_INFO, "io=0x%x reg=0x%x", data->BaseAddress, reg);
3336 if (reg == 0xffff) {
3337 nsp32_msg(KERN_INFO, "missing device. abort resume.");
3338 return 0;
3341 nsp32hw_init (data);
3342 nsp32_do_bus_reset(data);
3344 nsp32_msg(KERN_INFO, "resume success");
3346 return 0;
3349 #endif
3351 /************************************************************************
3352 * PCI/Cardbus probe/remove routine
3354 static int nsp32_probe(struct pci_dev *pdev, const struct pci_device_id *id)
3356 int ret;
3357 nsp32_hw_data *data = &nsp32_data_base;
3359 nsp32_dbg(NSP32_DEBUG_REGISTER, "enter");
3361 ret = pci_enable_device(pdev);
3362 if (ret) {
3363 nsp32_msg(KERN_ERR, "failed to enable pci device");
3364 return ret;
3367 data->Pci = pdev;
3368 data->pci_devid = id;
3369 data->IrqNumber = pdev->irq;
3370 data->BaseAddress = pci_resource_start(pdev, 0);
3371 data->NumAddress = pci_resource_len (pdev, 0);
3372 data->MmioAddress = pci_ioremap_bar(pdev, 1);
3373 data->MmioLength = pci_resource_len (pdev, 1);
3375 pci_set_master(pdev);
3377 ret = nsp32_detect(pdev);
3379 nsp32_msg(KERN_INFO, "irq: %i mmio: %p+0x%lx slot: %s model: %s",
3380 pdev->irq,
3381 data->MmioAddress, data->MmioLength,
3382 pci_name(pdev),
3383 nsp32_model[id->driver_data]);
3385 nsp32_dbg(NSP32_DEBUG_REGISTER, "exit %d", ret);
3387 return ret;
3390 static void nsp32_remove(struct pci_dev *pdev)
3392 struct Scsi_Host *host = pci_get_drvdata(pdev);
3394 nsp32_dbg(NSP32_DEBUG_REGISTER, "enter");
3396 scsi_remove_host(host);
3398 nsp32_release(host);
3400 scsi_host_put(host);
3403 static struct pci_driver nsp32_driver = {
3404 .name = "nsp32",
3405 .id_table = nsp32_pci_table,
3406 .probe = nsp32_probe,
3407 .remove = nsp32_remove,
3408 #ifdef CONFIG_PM
3409 .suspend = nsp32_suspend,
3410 .resume = nsp32_resume,
3411 #endif
3414 /*********************************************************************
3415 * Moule entry point
3417 static int __init init_nsp32(void) {
3418 nsp32_msg(KERN_INFO, "loading...");
3419 return pci_register_driver(&nsp32_driver);
3422 static void __exit exit_nsp32(void) {
3423 nsp32_msg(KERN_INFO, "unloading...");
3424 pci_unregister_driver(&nsp32_driver);
3427 module_init(init_nsp32);
3428 module_exit(exit_nsp32);
3430 /* end */