blob: 3774adb3e75a595b39e4eaa13d2fe2daa92ea54f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * NCR 5380 generic driver routines. These should make it *trivial*
3 * to implement 5380 SCSI drivers under Linux with a non-trantor
4 * architecture.
5 *
6 * Note that these routines also work with NR53c400 family chips.
7 *
8 * Copyright 1993, Drew Eckhardt
9 * Visionary Computing
10 * (Unix and Linux consulting and custom programming)
11 * drew@colorado.edu
12 * +1 (303) 666-5836
13 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 * For more information, please consult
15 *
16 * NCR 5380 Family
17 * SCSI Protocol Controller
18 * Databook
19 *
20 * NCR Microelectronics
21 * 1635 Aeroplaza Drive
22 * Colorado Springs, CO 80916
23 * 1+ (719) 578-3400
24 * 1+ (800) 334-5454
25 */
26
27/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 * Revision 1.10 1998/9/2 Alan Cox
Alan Coxfa195af2008-10-27 15:16:36 +000029 * (alan@lxorguk.ukuu.org.uk)
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 * Fixed up the timer lockups reported so far. Things still suck. Looking
31 * forward to 2.3 and per device request queues. Then it'll be possible to
32 * SMP thread this beast and improve life no end.
33
34 * Revision 1.9 1997/7/27 Ronald van Cuijlenborg
35 * (ronald.van.cuijlenborg@tip.nl or nutty@dds.nl)
36 * (hopefully) fixed and enhanced USLEEP
37 * added support for DTC3181E card (for Mustek scanner)
38 *
39
40 * Revision 1.8 Ingmar Baumgart
41 * (ingmar@gonzo.schwaben.de)
42 * added support for NCR53C400a card
43 *
44
45 * Revision 1.7 1996/3/2 Ray Van Tassle (rayvt@comm.mot.com)
46 * added proc_info
47 * added support needed for DTC 3180/3280
48 * fixed a couple of bugs
49 *
50
51 * Revision 1.5 1994/01/19 09:14:57 drew
52 * Fixed udelay() hack that was being used on DATAOUT phases
53 * instead of a proper wait for the final handshake.
54 *
55 * Revision 1.4 1994/01/19 06:44:25 drew
56 * *** empty log message ***
57 *
58 * Revision 1.3 1994/01/19 05:24:40 drew
59 * Added support for TCR LAST_BYTE_SENT bit.
60 *
61 * Revision 1.2 1994/01/15 06:14:11 drew
62 * REAL DMA support, bug fixes.
63 *
64 * Revision 1.1 1994/01/15 06:00:54 drew
65 * Initial revision
66 *
67 */
68
69/*
70 * Further development / testing that should be done :
71 * 1. Cleanup the NCR5380_transfer_dma function and DMA operation complete
72 * code so that everything does the same thing that's done at the
73 * end of a pseudo-DMA read operation.
74 *
75 * 2. Fix REAL_DMA (interrupt driven, polled works fine) -
76 * basically, transfer size needs to be reduced by one
77 * and the last byte read as is done with PSEUDO_DMA.
78 *
79 * 4. Test SCSI-II tagged queueing (I have no devices which support
80 * tagged queueing)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 */
82
83#if (NDEBUG & NDEBUG_LISTS)
84#define LIST(x,y) {printk("LINE:%d Adding %p to %p\n", __LINE__, (void*)(x), (void*)(y)); if ((x)==(y)) udelay(5); }
85#define REMOVE(w,x,y,z) {printk("LINE:%d Removing: %p->%p %p->%p \n", __LINE__, (void*)(w), (void*)(x), (void*)(y), (void*)(z)); if ((x)==(y)) udelay(5); }
86#else
87#define LIST(x,y)
88#define REMOVE(w,x,y,z)
89#endif
90
91#ifndef notyet
Linus Torvalds1da177e2005-04-16 15:20:36 -070092#undef REAL_DMA
93#endif
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#ifdef BOARD_REQUIRES_NO_DELAY
96#define io_recovery_delay(x)
97#else
98#define io_recovery_delay(x) udelay(x)
99#endif
100
101/*
102 * Design
103 *
104 * This is a generic 5380 driver. To use it on a different platform,
105 * one simply writes appropriate system specific macros (ie, data
106 * transfer - some PC's will use the I/O bus, 68K's must use
107 * memory mapped) and drops this file in their 'C' wrapper.
108 *
109 * (Note from hch: unfortunately it was not enough for the different
110 * m68k folks and instead of improving this driver they copied it
111 * and hacked it up for their needs. As a consequence they lost
112 * most updates to this driver. Maybe someone will fix all these
113 * drivers to use a common core one day..)
114 *
115 * As far as command queueing, two queues are maintained for
116 * each 5380 in the system - commands that haven't been issued yet,
117 * and commands that are currently executing. This means that an
118 * unlimited number of commands may be queued, letting
119 * more commands propagate from the higher driver levels giving higher
120 * throughput. Note that both I_T_L and I_T_L_Q nexuses are supported,
121 * allowing multiple commands to propagate all the way to a SCSI-II device
122 * while a command is already executing.
123 *
124 *
125 * Issues specific to the NCR5380 :
126 *
127 * When used in a PIO or pseudo-dma mode, the NCR5380 is a braindead
128 * piece of hardware that requires you to sit in a loop polling for
129 * the REQ signal as long as you are connected. Some devices are
130 * brain dead (ie, many TEXEL CD ROM drives) and won't disconnect
Finn Thain686f3992016-01-03 16:05:26 +1100131 * while doing long seek operations. [...] These
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * broken devices are the exception rather than the rule and I'd rather
133 * spend my time optimizing for the normal case.
134 *
135 * Architecture :
136 *
137 * At the heart of the design is a coroutine, NCR5380_main,
138 * which is started from a workqueue for each NCR5380 host in the
139 * system. It attempts to establish I_T_L or I_T_L_Q nexuses by
140 * removing the commands from the issue queue and calling
141 * NCR5380_select() if a nexus is not established.
142 *
143 * Once a nexus is established, the NCR5380_information_transfer()
144 * phase goes through the various phases as instructed by the target.
145 * if the target goes into MSG IN and sends a DISCONNECT message,
146 * the command structure is placed into the per instance disconnected
147 * queue, and NCR5380_main tries to find more work. If the target is
148 * idle for too long, the system will try to sleep.
149 *
150 * If a command has disconnected, eventually an interrupt will trigger,
151 * calling NCR5380_intr() which will in turn call NCR5380_reselect
152 * to reestablish a nexus. This will run main if necessary.
153 *
154 * On command termination, the done function will be called as
155 * appropriate.
156 *
157 * SCSI pointers are maintained in the SCp field of SCSI command
158 * structures, being initialized after the command is connected
159 * in NCR5380_select, and set as appropriate in NCR5380_information_transfer.
160 * Note that in violation of the standard, an implicit SAVE POINTERS operation
161 * is done, since some BROKEN disks fail to issue an explicit SAVE POINTERS.
162 */
163
164/*
165 * Using this file :
166 * This file a skeleton Linux SCSI driver for the NCR 5380 series
167 * of chips. To use it, you write an architecture specific functions
168 * and macros and include this file in your driver.
169 *
170 * These macros control options :
171 * AUTOPROBE_IRQ - if defined, the NCR5380_probe_irq() function will be
172 * defined.
173 *
174 * AUTOSENSE - if defined, REQUEST SENSE will be performed automatically
175 * for commands that return with a CHECK CONDITION status.
176 *
177 * DIFFERENTIAL - if defined, NCR53c81 chips will use external differential
178 * transceivers.
179 *
180 * DONT_USE_INTR - if defined, never use interrupts, even if we probe or
181 * override-configure an IRQ.
182 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 * PSEUDO_DMA - if defined, PSEUDO DMA is used during the data transfer phases.
184 *
185 * REAL_DMA - if defined, REAL DMA is used during the data transfer phases.
186 *
187 * REAL_DMA_POLL - if defined, REAL DMA is used but the driver doesn't
188 * rely on phase mismatch and EOP interrupts to determine end
189 * of phase.
190 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * Defaults for these will be provided although the user may want to adjust
192 * these to allocate CPU resources to the SCSI driver or "real" code.
193 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 * These macros MUST be defined :
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 *
196 * NCR5380_read(register) - read from the specified register
197 *
198 * NCR5380_write(register, value) - write to the specific register
199 *
200 * NCR5380_implementation_fields - additional fields needed for this
201 * specific implementation of the NCR5380
202 *
203 * Either real DMA *or* pseudo DMA may be implemented
204 * REAL functions :
205 * NCR5380_REAL_DMA should be defined if real DMA is to be used.
206 * Note that the DMA setup functions should return the number of bytes
207 * that they were able to program the controller for.
208 *
209 * Also note that generic i386/PC versions of these macros are
210 * available as NCR5380_i386_dma_write_setup,
211 * NCR5380_i386_dma_read_setup, and NCR5380_i386_dma_residual.
212 *
213 * NCR5380_dma_write_setup(instance, src, count) - initialize
214 * NCR5380_dma_read_setup(instance, dst, count) - initialize
215 * NCR5380_dma_residual(instance); - residual count
216 *
217 * PSEUDO functions :
218 * NCR5380_pwrite(instance, src, count)
219 * NCR5380_pread(instance, dst, count);
220 *
221 * The generic driver is initialized by calling NCR5380_init(instance),
222 * after setting the appropriate host specific fields and ID. If the
223 * driver wishes to autoprobe for an IRQ line, the NCR5380_probe_irq(instance,
224 * possible) function may be used.
225 */
226
Finn Thain54d8fe42016-01-03 16:05:06 +1100227static int do_abort(struct Scsi_Host *);
228static void do_reset(struct Scsi_Host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230/*
231 * initialize_SCp - init the scsi pointer field
232 * @cmd: command block to set up
233 *
234 * Set up the internal fields in the SCSI command.
235 */
236
Finn Thain710ddd02014-11-12 16:12:02 +1100237static inline void initialize_SCp(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238{
239 /*
240 * Initialize the Scsi Pointer field so that all of the commands in the
241 * various queues are valid.
242 */
243
Boaz Harrosh9e0fe442007-11-05 11:23:35 +0200244 if (scsi_bufflen(cmd)) {
245 cmd->SCp.buffer = scsi_sglist(cmd);
246 cmd->SCp.buffers_residual = scsi_sg_count(cmd) - 1;
Jens Axboe45711f12007-10-22 21:19:53 +0200247 cmd->SCp.ptr = sg_virt(cmd->SCp.buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 cmd->SCp.this_residual = cmd->SCp.buffer->length;
249 } else {
250 cmd->SCp.buffer = NULL;
251 cmd->SCp.buffers_residual = 0;
Boaz Harrosh9e0fe442007-11-05 11:23:35 +0200252 cmd->SCp.ptr = NULL;
253 cmd->SCp.this_residual = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 }
255}
256
257/**
Finn Thainb32ade12016-01-03 16:05:41 +1100258 * NCR5380_poll_politely2 - wait for two chip register values
Finn Thain2f854b82016-01-03 16:05:22 +1100259 * @instance: controller to poll
Finn Thainb32ade12016-01-03 16:05:41 +1100260 * @reg1: 5380 register to poll
261 * @bit1: Bitmask to check
262 * @val1: Expected value
263 * @reg2: Second 5380 register to poll
264 * @bit2: Second bitmask to check
265 * @val2: Second expected value
Finn Thain2f854b82016-01-03 16:05:22 +1100266 * @wait: Time-out in jiffies
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 *
Finn Thain2f854b82016-01-03 16:05:22 +1100268 * Polls the chip in a reasonably efficient manner waiting for an
269 * event to occur. After a short quick poll we begin to yield the CPU
270 * (if possible). In irq contexts the time-out is arbitrarily limited.
271 * Callers may hold locks as long as they are held in irq mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 *
Finn Thainb32ade12016-01-03 16:05:41 +1100273 * Returns 0 if either or both event(s) occurred otherwise -ETIMEDOUT.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Finn Thainb32ade12016-01-03 16:05:41 +1100276static int NCR5380_poll_politely2(struct Scsi_Host *instance,
277 int reg1, int bit1, int val1,
278 int reg2, int bit2, int val2, int wait)
Finn Thain2f854b82016-01-03 16:05:22 +1100279{
280 struct NCR5380_hostdata *hostdata = shost_priv(instance);
281 unsigned long deadline = jiffies + wait;
282 unsigned long n;
283
284 /* Busy-wait for up to 10 ms */
285 n = min(10000U, jiffies_to_usecs(wait));
286 n *= hostdata->accesses_per_ms;
Finn Thainb32ade12016-01-03 16:05:41 +1100287 n /= 2000;
Finn Thain2f854b82016-01-03 16:05:22 +1100288 do {
Finn Thainb32ade12016-01-03 16:05:41 +1100289 if ((NCR5380_read(reg1) & bit1) == val1)
290 return 0;
291 if ((NCR5380_read(reg2) & bit2) == val2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 return 0;
293 cpu_relax();
Finn Thain2f854b82016-01-03 16:05:22 +1100294 } while (n--);
295
296 if (irqs_disabled() || in_interrupt())
297 return -ETIMEDOUT;
298
299 /* Repeatedly sleep for 1 ms until deadline */
300 while (time_is_after_jiffies(deadline)) {
301 schedule_timeout_uninterruptible(1);
Finn Thainb32ade12016-01-03 16:05:41 +1100302 if ((NCR5380_read(reg1) & bit1) == val1)
303 return 0;
304 if ((NCR5380_read(reg2) & bit2) == val2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 }
Finn Thain2f854b82016-01-03 16:05:22 +1100307
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 return -ETIMEDOUT;
309}
310
Finn Thainb32ade12016-01-03 16:05:41 +1100311static inline int NCR5380_poll_politely(struct Scsi_Host *instance,
312 int reg, int bit, int val, int wait)
313{
314 return NCR5380_poll_politely2(instance, reg, bit, val,
315 reg, bit, val, wait);
316}
317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318static struct {
319 unsigned char value;
320 const char *name;
Andrew Morton702809c2007-05-23 14:41:56 -0700321} phases[] __maybe_unused = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 {PHASE_DATAOUT, "DATAOUT"},
323 {PHASE_DATAIN, "DATAIN"},
324 {PHASE_CMDOUT, "CMDOUT"},
325 {PHASE_STATIN, "STATIN"},
326 {PHASE_MSGOUT, "MSGOUT"},
327 {PHASE_MSGIN, "MSGIN"},
328 {PHASE_UNKNOWN, "UNKNOWN"}
329};
330
viro@ZenIV.linux.org.uk185a7a12005-09-07 23:18:24 +0100331#if NDEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332static struct {
333 unsigned char mask;
334 const char *name;
335} signals[] = {
336 {SR_DBP, "PARITY"},
337 {SR_RST, "RST"},
338 {SR_BSY, "BSY"},
339 {SR_REQ, "REQ"},
340 {SR_MSG, "MSG"},
341 {SR_CD, "CD"},
342 {SR_IO, "IO"},
343 {SR_SEL, "SEL"},
344 {0, NULL}
345},
346basrs[] = {
347 {BASR_ATN, "ATN"},
348 {BASR_ACK, "ACK"},
349 {0, NULL}
350},
351icrs[] = {
352 {ICR_ASSERT_RST, "ASSERT RST"},
353 {ICR_ASSERT_ACK, "ASSERT ACK"},
354 {ICR_ASSERT_BSY, "ASSERT BSY"},
355 {ICR_ASSERT_SEL, "ASSERT SEL"},
356 {ICR_ASSERT_ATN, "ASSERT ATN"},
357 {ICR_ASSERT_DATA, "ASSERT DATA"},
358 {0, NULL}
359},
360mrs[] = {
361 {MR_BLOCK_DMA_MODE, "MODE BLOCK DMA"},
362 {MR_TARGET, "MODE TARGET"},
363 {MR_ENABLE_PAR_CHECK, "MODE PARITY CHECK"},
364 {MR_ENABLE_PAR_INTR, "MODE PARITY INTR"},
365 {MR_MONITOR_BSY, "MODE MONITOR BSY"},
366 {MR_DMA_MODE, "MODE DMA"},
367 {MR_ARBITRATE, "MODE ARBITRATION"},
368 {0, NULL}
369};
370
371/**
372 * NCR5380_print - print scsi bus signals
373 * @instance: adapter state to dump
374 *
375 * Print the SCSI bus signals for debugging purposes
376 *
377 * Locks: caller holds hostdata lock (not essential)
378 */
379
380static void NCR5380_print(struct Scsi_Host *instance)
381{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 unsigned char status, data, basr, mr, icr, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384 data = NCR5380_read(CURRENT_SCSI_DATA_REG);
385 status = NCR5380_read(STATUS_REG);
386 mr = NCR5380_read(MODE_REG);
387 icr = NCR5380_read(INITIATOR_COMMAND_REG);
388 basr = NCR5380_read(BUS_AND_STATUS_REG);
389
390 printk("STATUS_REG: %02x ", status);
391 for (i = 0; signals[i].mask; ++i)
392 if (status & signals[i].mask)
393 printk(",%s", signals[i].name);
394 printk("\nBASR: %02x ", basr);
395 for (i = 0; basrs[i].mask; ++i)
396 if (basr & basrs[i].mask)
397 printk(",%s", basrs[i].name);
398 printk("\nICR: %02x ", icr);
399 for (i = 0; icrs[i].mask; ++i)
400 if (icr & icrs[i].mask)
401 printk(",%s", icrs[i].name);
402 printk("\nMODE: %02x ", mr);
403 for (i = 0; mrs[i].mask; ++i)
404 if (mr & mrs[i].mask)
405 printk(",%s", mrs[i].name);
406 printk("\n");
407}
408
409
410/*
411 * NCR5380_print_phase - show SCSI phase
412 * @instance: adapter to dump
413 *
414 * Print the current SCSI phase for debugging purposes
415 *
416 * Locks: none
417 */
418
419static void NCR5380_print_phase(struct Scsi_Host *instance)
420{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 unsigned char status;
422 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
424 status = NCR5380_read(STATUS_REG);
425 if (!(status & SR_REQ))
426 printk("scsi%d : REQ not asserted, phase unknown.\n", instance->host_no);
427 else {
428 for (i = 0; (phases[i].value != PHASE_UNKNOWN) && (phases[i].value != (status & PHASE_MASK)); ++i);
429 printk("scsi%d : phase %s\n", instance->host_no, phases[i].name);
430 }
431}
432#endif
433
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
Finn Thaind5f7e652016-01-03 16:05:03 +1100435static int probe_irq __initdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
437/**
438 * probe_intr - helper for IRQ autoprobe
439 * @irq: interrupt number
440 * @dev_id: unused
441 * @regs: unused
442 *
443 * Set a flag to indicate the IRQ in question was received. This is
444 * used by the IRQ probe code.
445 */
446
David Howells7d12e782006-10-05 14:55:46 +0100447static irqreturn_t __init probe_intr(int irq, void *dev_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448{
449 probe_irq = irq;
450 return IRQ_HANDLED;
451}
452
453/**
454 * NCR5380_probe_irq - find the IRQ of an NCR5380
455 * @instance: NCR5380 controller
456 * @possible: bitmask of ISA IRQ lines
457 *
458 * Autoprobe for the IRQ line used by the NCR5380 by triggering an IRQ
459 * and then looking to see what interrupt actually turned up.
460 *
461 * Locks: none, irqs must be enabled on entry
462 */
463
Andrew Morton702809c2007-05-23 14:41:56 -0700464static int __init __maybe_unused NCR5380_probe_irq(struct Scsi_Host *instance,
465 int possible)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466{
Finn Thaine8a60142016-01-03 16:05:54 +1100467 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 unsigned long timeout;
469 int trying_irqs, i, mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
Finn Thain22f5f102014-11-12 16:11:56 +1100471 for (trying_irqs = 0, i = 1, mask = 2; i < 16; ++i, mask <<= 1)
Michael Opdenacker4909cc22014-03-05 06:09:41 +0100472 if ((mask & possible) && (request_irq(i, &probe_intr, 0, "NCR-probe", NULL) == 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 trying_irqs |= mask;
474
Nicholas Mc Guire4e5a8002015-02-04 13:30:20 -0500475 timeout = jiffies + msecs_to_jiffies(250);
Finn Thain22f5f102014-11-12 16:11:56 +1100476 probe_irq = NO_IRQ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
478 /*
479 * A interrupt is triggered whenever BSY = false, SEL = true
480 * and a bit set in the SELECT_ENABLE_REG is asserted on the
481 * SCSI bus.
482 *
483 * Note that the bus is only driven when the phase control signals
484 * (I/O, C/D, and MSG) match those in the TCR, so we must reset that
485 * to zero.
486 */
487
488 NCR5380_write(TARGET_COMMAND_REG, 0);
489 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
490 NCR5380_write(OUTPUT_DATA_REG, hostdata->id_mask);
491 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_DATA | ICR_ASSERT_SEL);
492
Finn Thain22f5f102014-11-12 16:11:56 +1100493 while (probe_irq == NO_IRQ && time_before(jiffies, timeout))
Nishanth Aravamudana9a30472005-11-07 01:01:20 -0800494 schedule_timeout_uninterruptible(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
496 NCR5380_write(SELECT_ENABLE_REG, 0);
497 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
498
Finn Thain22f5f102014-11-12 16:11:56 +1100499 for (i = 1, mask = 2; i < 16; ++i, mask <<= 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 if (trying_irqs & mask)
501 free_irq(i, NULL);
502
503 return probe_irq;
504}
505
506/**
Finn Thain8c325132014-11-12 16:11:58 +1100507 * NCR58380_info - report driver and host information
508 * @instance: relevant scsi host instance
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 *
Finn Thain8c325132014-11-12 16:11:58 +1100510 * For use as the host template info() handler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 *
512 * Locks: none
513 */
514
Finn Thain8c325132014-11-12 16:11:58 +1100515static const char *NCR5380_info(struct Scsi_Host *instance)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516{
Finn Thain8c325132014-11-12 16:11:58 +1100517 struct NCR5380_hostdata *hostdata = shost_priv(instance);
518
519 return hostdata->info;
520}
521
522static void prepare_info(struct Scsi_Host *instance)
523{
524 struct NCR5380_hostdata *hostdata = shost_priv(instance);
525
526 snprintf(hostdata->info, sizeof(hostdata->info),
527 "%s, io_port 0x%lx, n_io_port %d, "
528 "base 0x%lx, irq %d, "
529 "can_queue %d, cmd_per_lun %d, "
530 "sg_tablesize %d, this_id %d, "
Finn Thainbe3f4122016-01-03 16:05:50 +1100531 "flags { %s%s%s}, "
Finn Thain8c325132014-11-12 16:11:58 +1100532 "options { %s} ",
533 instance->hostt->name, instance->io_port, instance->n_io_port,
534 instance->base, instance->irq,
535 instance->can_queue, instance->cmd_per_lun,
536 instance->sg_tablesize, instance->this_id,
Finn Thain55181be2016-01-03 16:05:42 +1100537 hostdata->flags & FLAG_NO_DMA_FIXUP ? "NO_DMA_FIXUP " : "",
Finn Thain8c325132014-11-12 16:11:58 +1100538 hostdata->flags & FLAG_NO_PSEUDO_DMA ? "NO_PSEUDO_DMA " : "",
Finn Thain9c3f0e22016-01-03 16:05:11 +1100539 hostdata->flags & FLAG_TOSHIBA_DELAY ? "TOSHIBA_DELAY " : "",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540#ifdef AUTOPROBE_IRQ
Finn Thain8c325132014-11-12 16:11:58 +1100541 "AUTOPROBE_IRQ "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543#ifdef DIFFERENTIAL
Finn Thain8c325132014-11-12 16:11:58 +1100544 "DIFFERENTIAL "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545#endif
546#ifdef REAL_DMA
Finn Thain8c325132014-11-12 16:11:58 +1100547 "REAL_DMA "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548#endif
549#ifdef REAL_DMA_POLL
Finn Thain8c325132014-11-12 16:11:58 +1100550 "REAL_DMA_POLL "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551#endif
552#ifdef PARITY
Finn Thain8c325132014-11-12 16:11:58 +1100553 "PARITY "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554#endif
555#ifdef PSEUDO_DMA
Finn Thain8c325132014-11-12 16:11:58 +1100556 "PSEUDO_DMA "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557#endif
Finn Thain8c325132014-11-12 16:11:58 +1100558 "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559}
560
Finn Thaina9c2dc42014-11-12 16:11:59 +1100561#ifdef PSEUDO_DMA
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562/******************************************/
563/*
564 * /proc/scsi/[dtc pas16 t128 generic]/[0-ASC_NUM_BOARD_SUPPORTED]
565 *
566 * *buffer: I/O buffer
567 * **start: if inout == FALSE pointer into buffer where user read should start
568 * offset: current offset
569 * length: length of buffer
570 * hostno: Scsi_Host host_no
571 * inout: TRUE - user is writing; FALSE - user is reading
572 *
573 * Return the number of bytes read from or written
574 */
575
Al Virodd7ab712013-03-31 01:15:54 -0400576static int __maybe_unused NCR5380_write_info(struct Scsi_Host *instance,
577 char *buffer, int length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Finn Thaina9c2dc42014-11-12 16:11:59 +1100579 struct NCR5380_hostdata *hostdata = shost_priv(instance);
580
581 hostdata->spin_max_r = 0;
582 hostdata->spin_max_w = 0;
583 return 0;
Al Virodd7ab712013-03-31 01:15:54 -0400584}
Al Virodd7ab712013-03-31 01:15:54 -0400585
586static int __maybe_unused NCR5380_show_info(struct seq_file *m,
587 struct Scsi_Host *instance)
588{
Finn Thaine8a60142016-01-03 16:05:54 +1100589 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Rasmus Villemoes0c3de382014-12-03 00:10:49 +0100591 seq_printf(m, "Highwater I/O busy spin counts: write %d, read %d\n",
Finn Thaina9c2dc42014-11-12 16:11:59 +1100592 hostdata->spin_max_w, hostdata->spin_max_r);
Al Virodd7ab712013-03-31 01:15:54 -0400593 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594}
Finn Thaine5c3fdd2016-01-03 16:05:52 +1100595#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
597/**
598 * NCR5380_init - initialise an NCR5380
599 * @instance: adapter to configure
600 * @flags: control flags
601 *
602 * Initializes *instance and corresponding 5380 chip,
603 * with flags OR'd into the initial flags value.
604 *
605 * Notes : I assume that the host, hostno, and id bits have been
606 * set correctly. I don't care about the irq and other fields.
607 *
608 * Returns 0 for success
609 *
610 * Locks: interrupts must be enabled when we are called
611 */
612
Greg Kroah-Hartman6f039792012-12-21 13:08:55 -0800613static int NCR5380_init(struct Scsi_Host *instance, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614{
Finn Thaine8a60142016-01-03 16:05:54 +1100615 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Finn Thainb6488f92016-01-03 16:05:08 +1100616 int i;
Finn Thain2f854b82016-01-03 16:05:22 +1100617 unsigned long deadline;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619 if(in_interrupt())
620 printk(KERN_ERR "NCR5380_init called with interrupts off!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 hostdata->id_mask = 1 << instance->this_id;
623 for (i = hostdata->id_mask; i <= 0x80; i <<= 1)
624 if (i > hostdata->id_mask)
625 hostdata->id_higher_mask |= i;
626 for (i = 0; i < 8; ++i)
627 hostdata->busy[i] = 0;
628#ifdef REAL_DMA
629 hostdata->dmalen = 0;
630#endif
Finn Thain11d2f632016-01-03 16:05:51 +1100631 spin_lock_init(&hostdata->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 hostdata->connected = NULL;
633 hostdata->issue_queue = NULL;
634 hostdata->disconnected_queue = NULL;
Finn Thain55181be2016-01-03 16:05:42 +1100635 hostdata->flags = flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Finn Thain8d8601a2016-01-03 16:05:37 +1100637 INIT_WORK(&hostdata->main_task, NCR5380_main);
Finn Thain0ad0eff2016-01-03 16:05:21 +1100638 hostdata->work_q = alloc_workqueue("ncr5380_%d",
639 WQ_UNBOUND | WQ_MEM_RECLAIM,
640 1, instance->host_no);
641 if (!hostdata->work_q)
642 return -ENOMEM;
643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 hostdata->host = instance;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Finn Thain8c325132014-11-12 16:11:58 +1100646 prepare_info(instance);
647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
649 NCR5380_write(MODE_REG, MR_BASE);
650 NCR5380_write(TARGET_COMMAND_REG, 0);
651 NCR5380_write(SELECT_ENABLE_REG, 0);
Finn Thain2f854b82016-01-03 16:05:22 +1100652
653 /* Calibrate register polling loop */
654 i = 0;
655 deadline = jiffies + 1;
656 do {
657 cpu_relax();
658 } while (time_is_after_jiffies(deadline));
659 deadline += msecs_to_jiffies(256);
660 do {
661 NCR5380_read(STATUS_REG);
662 ++i;
663 cpu_relax();
664 } while (time_is_after_jiffies(deadline));
665 hostdata->accesses_per_ms = i / 256;
666
Finn Thainb6488f92016-01-03 16:05:08 +1100667 return 0;
668}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Finn Thainb6488f92016-01-03 16:05:08 +1100670/**
671 * NCR5380_maybe_reset_bus - Detect and correct bus wedge problems.
672 * @instance: adapter to check
673 *
674 * If the system crashed, it may have crashed with a connected target and
675 * the SCSI bus busy. Check for BUS FREE phase. If not, try to abort the
676 * currently established nexus, which we know nothing about. Failing that
677 * do a bus reset.
678 *
679 * Note that a bus reset will cause the chip to assert IRQ.
680 *
681 * Returns 0 if successful, otherwise -ENXIO.
682 */
683
684static int NCR5380_maybe_reset_bus(struct Scsi_Host *instance)
685{
Finn Thain9c3f0e22016-01-03 16:05:11 +1100686 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Finn Thainb6488f92016-01-03 16:05:08 +1100687 int pass;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
689 for (pass = 1; (NCR5380_read(STATUS_REG) & SR_BSY) && pass <= 6; ++pass) {
690 switch (pass) {
691 case 1:
692 case 3:
693 case 5:
Finn Thain636b1ec2016-01-03 16:05:10 +1100694 shost_printk(KERN_ERR, instance, "SCSI bus busy, waiting up to five seconds\n");
695 NCR5380_poll_politely(instance,
696 STATUS_REG, SR_BSY, 0, 5 * HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 break;
698 case 2:
Finn Thain636b1ec2016-01-03 16:05:10 +1100699 shost_printk(KERN_ERR, instance, "bus busy, attempting abort\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 do_abort(instance);
701 break;
702 case 4:
Finn Thain636b1ec2016-01-03 16:05:10 +1100703 shost_printk(KERN_ERR, instance, "bus busy, attempting reset\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 do_reset(instance);
Finn Thain9c3f0e22016-01-03 16:05:11 +1100705 /* Wait after a reset; the SCSI standard calls for
706 * 250ms, we wait 500ms to be on the safe side.
707 * But some Toshiba CD-ROMs need ten times that.
708 */
709 if (hostdata->flags & FLAG_TOSHIBA_DELAY)
710 msleep(2500);
711 else
712 msleep(500);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 break;
714 case 6:
Finn Thain636b1ec2016-01-03 16:05:10 +1100715 shost_printk(KERN_ERR, instance, "bus locked solid\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 return -ENXIO;
717 }
718 }
719 return 0;
720}
721
722/**
723 * NCR5380_exit - remove an NCR5380
724 * @instance: adapter to remove
725 */
726
Randy Dunlapa43cf0f2008-01-22 21:39:33 -0800727static void NCR5380_exit(struct Scsi_Host *instance)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
Finn Thaine8a60142016-01-03 16:05:54 +1100729 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Finn Thain8d8601a2016-01-03 16:05:37 +1100731 cancel_work_sync(&hostdata->main_task);
Finn Thain0ad0eff2016-01-03 16:05:21 +1100732 destroy_workqueue(hostdata->work_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733}
734
735/**
Finn Thain1bb40582016-01-03 16:05:29 +1100736 * NCR5380_queue_command - queue a command
737 * @instance: the relevant SCSI adapter
738 * @cmd: SCSI command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 *
Finn Thain1bb40582016-01-03 16:05:29 +1100740 * cmd is added to the per-instance issue queue, with minor
741 * twiddling done to the host specific fields of cmd. If the
742 * main coroutine is not running, it is restarted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 */
744
Finn Thain1bb40582016-01-03 16:05:29 +1100745static int NCR5380_queue_command(struct Scsi_Host *instance,
746 struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
Finn Thain1bb40582016-01-03 16:05:29 +1100748 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Finn Thain710ddd02014-11-12 16:12:02 +1100749 struct scsi_cmnd *tmp;
Finn Thain1bb40582016-01-03 16:05:29 +1100750 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
752#if (NDEBUG & NDEBUG_NO_WRITE)
753 switch (cmd->cmnd[0]) {
754 case WRITE_6:
755 case WRITE_10:
Finn Thaindbb6b352016-01-03 16:05:53 +1100756 shost_printk(KERN_DEBUG, instance, "WRITE attempted with NDEBUG_NO_WRITE set\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 cmd->result = (DID_ERROR << 16);
Finn Thain1bb40582016-01-03 16:05:29 +1100758 cmd->scsi_done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 return 0;
760 }
761#endif /* (NDEBUG & NDEBUG_NO_WRITE) */
762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 /*
764 * We use the host_scribble field as a pointer to the next command
765 * in a queue
766 */
767
768 cmd->host_scribble = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 cmd->result = 0;
770
Finn Thain11d2f632016-01-03 16:05:51 +1100771 spin_lock_irqsave(&hostdata->lock, flags);
Finn Thain1bb40582016-01-03 16:05:29 +1100772
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 /*
774 * Insert the cmd into the issue queue. Note that REQUEST SENSE
775 * commands are added to the head of the queue since any command will
776 * clear the contingent allegiance condition that exists and the
777 * sense data is only guaranteed to be valid while the condition exists.
778 */
779
780 if (!(hostdata->issue_queue) || (cmd->cmnd[0] == REQUEST_SENSE)) {
781 LIST(cmd, hostdata->issue_queue);
782 cmd->host_scribble = (unsigned char *) hostdata->issue_queue;
783 hostdata->issue_queue = cmd;
784 } else {
Finn Thain710ddd02014-11-12 16:12:02 +1100785 for (tmp = (struct scsi_cmnd *) hostdata->issue_queue; tmp->host_scribble; tmp = (struct scsi_cmnd *) tmp->host_scribble);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 LIST(cmd, tmp);
787 tmp->host_scribble = (unsigned char *) cmd;
788 }
Finn Thain11d2f632016-01-03 16:05:51 +1100789 spin_unlock_irqrestore(&hostdata->lock, flags);
Finn Thain1bb40582016-01-03 16:05:29 +1100790
Finn Thaindbb6b352016-01-03 16:05:53 +1100791 dsprintk(NDEBUG_QUEUES, instance, "command %p added to %s of queue\n",
792 cmd, (cmd->cmnd[0] == REQUEST_SENSE) ? "head" : "tail");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 /* Kick off command processing */
Finn Thain8d8601a2016-01-03 16:05:37 +1100795 queue_work(hostdata->work_q, &hostdata->main_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 return 0;
797}
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799/**
800 * NCR5380_main - NCR state machines
801 *
802 * NCR5380_main is a coroutine that runs as long as more work can
803 * be done on the NCR5380 host adapters in a system. Both
804 * NCR5380_queue_command() and NCR5380_intr() will try to start it
805 * in case it is not running.
806 *
807 * Locks: called as its own thread with no locks held. Takes the
808 * host lock and called routines may take the isa dma lock.
809 */
810
David Howellsc4028952006-11-22 14:57:56 +0000811static void NCR5380_main(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812{
David Howellsc4028952006-11-22 14:57:56 +0000813 struct NCR5380_hostdata *hostdata =
Finn Thain8d8601a2016-01-03 16:05:37 +1100814 container_of(work, struct NCR5380_hostdata, main_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 struct Scsi_Host *instance = hostdata->host;
Finn Thain710ddd02014-11-12 16:12:02 +1100816 struct scsi_cmnd *tmp, *prev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 int done;
818
Finn Thain11d2f632016-01-03 16:05:51 +1100819 spin_lock_irq(&hostdata->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 done = 1;
Finn Thain11d2f632016-01-03 16:05:51 +1100822
Finn Thainae753a32016-01-03 16:05:23 +1100823 if (!hostdata->connected) {
Finn Thain52a6a1c2014-03-18 11:42:18 +1100824 dprintk(NDEBUG_MAIN, "scsi%d : not connected\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 /*
826 * Search through the issue_queue for a command destined
827 * for a target that's not busy.
828 */
Finn Thain710ddd02014-11-12 16:12:02 +1100829 for (tmp = (struct scsi_cmnd *) hostdata->issue_queue, prev = NULL; tmp; prev = tmp, tmp = (struct scsi_cmnd *) tmp->host_scribble)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 {
831 if (prev != tmp)
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200832 dprintk(NDEBUG_LISTS, "MAIN tmp=%p target=%d busy=%d lun=%llu\n", tmp, tmp->device->id, hostdata->busy[tmp->device->id], tmp->device->lun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 /* When we find one, remove it from the issue queue. */
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200834 if (!(hostdata->busy[tmp->device->id] &
835 (1 << (u8)(tmp->device->lun & 0xff)))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 if (prev) {
837 REMOVE(prev, prev->host_scribble, tmp, tmp->host_scribble);
838 prev->host_scribble = tmp->host_scribble;
839 } else {
840 REMOVE(-1, hostdata->issue_queue, tmp, tmp->host_scribble);
Finn Thain710ddd02014-11-12 16:12:02 +1100841 hostdata->issue_queue = (struct scsi_cmnd *) tmp->host_scribble;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 }
843 tmp->host_scribble = NULL;
844
845 /*
846 * Attempt to establish an I_T_L nexus here.
847 * On success, instance->hostdata->connected is set.
848 * On failure, we must add the command back to the
849 * issue queue so we can keep trying.
850 */
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200851 dprintk(NDEBUG_MAIN|NDEBUG_QUEUES, "scsi%d : main() : command for target %d lun %llu removed from issue_queue\n", instance->host_no, tmp->device->id, tmp->device->lun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
Finn Thain76f13b92014-11-12 16:11:53 +1100853 /*
854 * REQUEST SENSE commands are issued without tagged
855 * queueing, even on SCSI-II devices because the
856 * contingent allegiance condition exists for the
857 * entire unit.
858 */
859
860 if (!NCR5380_select(instance, tmp)) {
Finn Thain1f1b0c72016-01-03 16:05:17 +1100861 /* OK or bad target */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 } else {
Finn Thain1f1b0c72016-01-03 16:05:17 +1100863 /* Need to retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 LIST(tmp, hostdata->issue_queue);
865 tmp->host_scribble = (unsigned char *) hostdata->issue_queue;
866 hostdata->issue_queue = tmp;
867 done = 0;
Finn Thain52a6a1c2014-03-18 11:42:18 +1100868 dprintk(NDEBUG_MAIN|NDEBUG_QUEUES, "scsi%d : main(): select() failed, returned to issue_queue\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 }
Finn Thainae753a32016-01-03 16:05:23 +1100870 if (hostdata->connected)
Finn Thain1f1b0c72016-01-03 16:05:17 +1100871 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 } /* if target/lun is not busy */
873 } /* for */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 } /* if (!hostdata->connected) */
Finn Thain11d2f632016-01-03 16:05:51 +1100875
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 if (hostdata->connected
877#ifdef REAL_DMA
878 && !hostdata->dmalen
879#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 ) {
Finn Thain52a6a1c2014-03-18 11:42:18 +1100881 dprintk(NDEBUG_MAIN, "scsi%d : main() : performing information transfer\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 NCR5380_information_transfer(instance);
Finn Thain52a6a1c2014-03-18 11:42:18 +1100883 dprintk(NDEBUG_MAIN, "scsi%d : main() : done set false\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 done = 0;
Finn Thain1d3db592016-01-03 16:05:24 +1100885 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 } while (!done);
Finn Thain11d2f632016-01-03 16:05:51 +1100887 spin_unlock_irq(&hostdata->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888}
889
890#ifndef DONT_USE_INTR
891
892/**
Finn Thaincd400822016-01-03 16:05:40 +1100893 * NCR5380_intr - generic NCR5380 irq handler
894 * @irq: interrupt number
895 * @dev_id: device info
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 *
Finn Thaincd400822016-01-03 16:05:40 +1100897 * Handle interrupts, reestablishing I_T_L or I_T_L_Q nexuses
898 * from the disconnected queue, and restarting NCR5380_main()
899 * as required.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 *
Finn Thaincd400822016-01-03 16:05:40 +1100901 * The chip can assert IRQ in any of six different conditions. The IRQ flag
902 * is then cleared by reading the Reset Parity/Interrupt Register (RPIR).
903 * Three of these six conditions are latched in the Bus and Status Register:
904 * - End of DMA (cleared by ending DMA Mode)
905 * - Parity error (cleared by reading RPIR)
906 * - Loss of BSY (cleared by reading RPIR)
907 * Two conditions have flag bits that are not latched:
908 * - Bus phase mismatch (non-maskable in DMA Mode, cleared by ending DMA Mode)
909 * - Bus reset (non-maskable)
910 * The remaining condition has no flag bit at all:
911 * - Selection/reselection
912 *
913 * Hence, establishing the cause(s) of any interrupt is partly guesswork.
914 * In "The DP8490 and DP5380 Comparison Guide", National Semiconductor
915 * claimed that "the design of the [DP8490] interrupt logic ensures
916 * interrupts will not be lost (they can be on the DP5380)."
917 * The L5380/53C80 datasheet from LOGIC Devices has more details.
918 *
919 * Checking for bus reset by reading RST is futile because of interrupt
920 * latency, but a bus reset will reset chip logic. Checking for parity error
921 * is unnecessary because that interrupt is never enabled. A Loss of BSY
922 * condition will clear DMA Mode. We can tell when this occurs because the
923 * the Busy Monitor interrupt is enabled together with DMA Mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 */
925
Finn Thaincd400822016-01-03 16:05:40 +1100926static irqreturn_t NCR5380_intr(int irq, void *dev_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927{
Jeff Garzikbaa9aac2007-12-13 16:14:14 -0800928 struct Scsi_Host *instance = dev_id;
Finn Thaincd400822016-01-03 16:05:40 +1100929 struct NCR5380_hostdata *hostdata = shost_priv(instance);
930 int handled = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 unsigned char basr;
932 unsigned long flags;
933
Finn Thain11d2f632016-01-03 16:05:51 +1100934 spin_lock_irqsave(&hostdata->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
Finn Thaincd400822016-01-03 16:05:40 +1100936 basr = NCR5380_read(BUS_AND_STATUS_REG);
937 if (basr & BASR_IRQ) {
938 unsigned char mr = NCR5380_read(MODE_REG);
939 unsigned char sr = NCR5380_read(STATUS_REG);
940
941 dprintk(NDEBUG_INTR, "scsi%d: IRQ %d, BASR 0x%02x, SR 0x%02x, MR 0x%02x\n",
942 instance->host_no, irq, basr, sr, mr);
943
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944#if defined(REAL_DMA)
Finn Thaincd400822016-01-03 16:05:40 +1100945 if ((mr & MR_DMA_MODE) || (mr & MR_MONITOR_BSY)) {
946 /* Probably End of DMA, Phase Mismatch or Loss of BSY.
947 * We ack IRQ after clearing Mode Register. Workarounds
948 * for End of DMA errata need to happen in DMA Mode.
949 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Finn Thaincd400822016-01-03 16:05:40 +1100951 dprintk(NDEBUG_INTR, "scsi%d: interrupt in DMA mode\n", intance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Finn Thaincd400822016-01-03 16:05:40 +1100953 int transferred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Finn Thaincd400822016-01-03 16:05:40 +1100955 if (!hostdata->connected)
956 panic("scsi%d : DMA interrupt with no connected cmd\n",
957 instance->hostno);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
Finn Thaincd400822016-01-03 16:05:40 +1100959 transferred = hostdata->dmalen - NCR5380_dma_residual(instance);
960 hostdata->connected->SCp.this_residual -= transferred;
961 hostdata->connected->SCp.ptr += transferred;
962 hostdata->dmalen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
Finn Thaincd400822016-01-03 16:05:40 +1100964 /* FIXME: we need to poll briefly then defer a workqueue task ! */
965 NCR5380_poll_politely(hostdata, BUS_AND_STATUS_REG, BASR_ACK, 0, 2 * HZ);
966
967 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
968 NCR5380_write(MODE_REG, MR_BASE);
969 NCR5380_read(RESET_PARITY_INTERRUPT_REG);
970 } else
971#endif /* REAL_DMA */
972 if ((NCR5380_read(CURRENT_SCSI_DATA_REG) & hostdata->id_mask) &&
973 (sr & (SR_SEL | SR_IO | SR_BSY | SR_RST)) == (SR_SEL | SR_IO)) {
974 /* Probably reselected */
975 NCR5380_write(SELECT_ENABLE_REG, 0);
976 NCR5380_read(RESET_PARITY_INTERRUPT_REG);
977
978 dprintk(NDEBUG_INTR, "scsi%d: interrupt with SEL and IO\n",
979 instance->host_no);
980
981 if (!hostdata->connected) {
982 NCR5380_reselect(instance);
983 queue_work(hostdata->work_q, &hostdata->main_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 }
Finn Thaincd400822016-01-03 16:05:40 +1100985 if (!hostdata->connected)
986 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
987 } else {
988 /* Probably Bus Reset */
989 NCR5380_read(RESET_PARITY_INTERRUPT_REG);
990
991 dprintk(NDEBUG_INTR, "scsi%d: unknown interrupt\n", instance->host_no);
992 }
993 handled = 1;
994 } else {
995 shost_printk(KERN_NOTICE, instance, "interrupt without IRQ bit\n");
996 }
997
Finn Thain11d2f632016-01-03 16:05:51 +1100998 spin_unlock_irqrestore(&hostdata->lock, flags);
Finn Thaincd400822016-01-03 16:05:40 +1100999
1000 return IRQ_RETVAL(handled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001}
1002
1003#endif
1004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005/*
Finn Thain710ddd02014-11-12 16:12:02 +11001006 * Function : int NCR5380_select(struct Scsi_Host *instance,
1007 * struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 *
1009 * Purpose : establishes I_T_L or I_T_L_Q nexus for new or existing command,
1010 * including ARBITRATION, SELECTION, and initial message out for
1011 * IDENTIFY and queue messages.
1012 *
1013 * Inputs : instance - instantiation of the 5380 driver on which this
Finn Thain76f13b92014-11-12 16:11:53 +11001014 * target lives, cmd - SCSI command to execute.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 *
Finn Thain63238762016-01-03 16:05:15 +11001016 * Returns : -1 if selection failed but should be retried.
1017 * 0 if selection failed and should not be retried.
1018 * 0 if selection succeeded completely (hostdata->connected == cmd).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 *
1020 * Side effects :
1021 * If bus busy, arbitration failed, etc, NCR5380_select() will exit
1022 * with registers as they should have been on entry - ie
1023 * SELECT_ENABLE will be set appropriately, the NCR5380
1024 * will cease to drive any SCSI bus signals.
1025 *
1026 * If successful : I_T_L or I_T_L_Q nexus will be established,
1027 * instance->connected will be set to cmd.
1028 * SELECT interrupt will be disabled.
1029 *
1030 * If failed (no target) : cmd->scsi_done() will be called, and the
1031 * cmd->result host byte set to DID_BAD_TARGET.
1032 *
1033 * Locks: caller holds hostdata lock in IRQ mode
1034 */
1035
Finn Thain710ddd02014-11-12 16:12:02 +11001036static int NCR5380_select(struct Scsi_Host *instance, struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037{
Finn Thaine8a60142016-01-03 16:05:54 +11001038 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 unsigned char tmp[3], phase;
1040 unsigned char *data;
1041 int len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 NCR5380_dprint(NDEBUG_ARBITRATION, instance);
Finn Thain52a6a1c2014-03-18 11:42:18 +11001045 dprintk(NDEBUG_ARBITRATION, "scsi%d : starting arbitration, id = %d\n", instance->host_no, instance->this_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046
1047 /*
1048 * Set the phase bits to 0, otherwise the NCR5380 won't drive the
1049 * data bus during SELECTION.
1050 */
1051
1052 NCR5380_write(TARGET_COMMAND_REG, 0);
1053
1054 /*
1055 * Start arbitration.
1056 */
1057
1058 NCR5380_write(OUTPUT_DATA_REG, hostdata->id_mask);
1059 NCR5380_write(MODE_REG, MR_ARBITRATE);
1060
Finn Thain55500d92016-01-03 16:05:35 +11001061 /* The chip now waits for BUS FREE phase. Then after the 800 ns
1062 * Bus Free Delay, arbitration will begin.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 */
1064
Finn Thain11d2f632016-01-03 16:05:51 +11001065 spin_unlock_irq(&hostdata->lock);
Finn Thainb32ade12016-01-03 16:05:41 +11001066 err = NCR5380_poll_politely2(instance, MODE_REG, MR_ARBITRATE, 0,
1067 INITIATOR_COMMAND_REG, ICR_ARBITRATION_PROGRESS,
1068 ICR_ARBITRATION_PROGRESS, HZ);
Finn Thain11d2f632016-01-03 16:05:51 +11001069 spin_lock_irq(&hostdata->lock);
Finn Thainb32ade12016-01-03 16:05:41 +11001070 if (!(NCR5380_read(MODE_REG) & MR_ARBITRATE)) {
1071 /* Reselection interrupt */
1072 return -1;
1073 }
1074 if (err < 0) {
1075 NCR5380_write(MODE_REG, MR_BASE);
1076 shost_printk(KERN_ERR, instance,
1077 "select: arbitration timeout\n");
1078 return -1;
Finn Thain55500d92016-01-03 16:05:35 +11001079 }
Finn Thain11d2f632016-01-03 16:05:51 +11001080 spin_unlock_irq(&hostdata->lock);
Finn Thain55500d92016-01-03 16:05:35 +11001081
1082 /* The SCSI-2 arbitration delay is 2.4 us */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 udelay(3);
1084
1085 /* Check for lost arbitration */
1086 if ((NCR5380_read(INITIATOR_COMMAND_REG) & ICR_ARBITRATION_LOST) || (NCR5380_read(CURRENT_SCSI_DATA_REG) & hostdata->id_higher_mask) || (NCR5380_read(INITIATOR_COMMAND_REG) & ICR_ARBITRATION_LOST)) {
1087 NCR5380_write(MODE_REG, MR_BASE);
Finn Thain52a6a1c2014-03-18 11:42:18 +11001088 dprintk(NDEBUG_ARBITRATION, "scsi%d : lost arbitration, deasserting MR_ARBITRATE\n", instance->host_no);
Finn Thain11d2f632016-01-03 16:05:51 +11001089 spin_lock_irq(&hostdata->lock);
Finn Thain63238762016-01-03 16:05:15 +11001090 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 }
Finn Thaincf13b082016-01-03 16:05:18 +11001092
1093 /* After/during arbitration, BSY should be asserted.
1094 * IBM DPES-31080 Version S31Q works now
1095 * Tnx to Thomas_Roesch@m2.maus.de for finding this! (Roman)
1096 */
1097 NCR5380_write(INITIATOR_COMMAND_REG,
1098 ICR_BASE | ICR_ASSERT_SEL | ICR_ASSERT_BSY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 /*
1101 * Again, bus clear + bus settle time is 1.2us, however, this is
1102 * a minimum so we'll udelay ceil(1.2)
1103 */
1104
Finn Thain9c3f0e22016-01-03 16:05:11 +11001105 if (hostdata->flags & FLAG_TOSHIBA_DELAY)
1106 udelay(15);
1107 else
1108 udelay(2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
Finn Thain11d2f632016-01-03 16:05:51 +11001110 spin_lock_irq(&hostdata->lock);
1111
Finn Thain72064a72016-01-03 16:05:44 +11001112 /* NCR5380_reselect() clears MODE_REG after a reselection interrupt */
1113 if (!(NCR5380_read(MODE_REG) & MR_ARBITRATE))
1114 return -1;
1115
Finn Thain52a6a1c2014-03-18 11:42:18 +11001116 dprintk(NDEBUG_ARBITRATION, "scsi%d : won arbitration\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
1118 /*
1119 * Now that we have won arbitration, start Selection process, asserting
1120 * the host and target ID's on the SCSI bus.
1121 */
1122
Jeff Garzik422c0d62005-10-24 18:05:09 -04001123 NCR5380_write(OUTPUT_DATA_REG, (hostdata->id_mask | (1 << scmd_id(cmd))));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
1125 /*
1126 * Raise ATN while SEL is true before BSY goes false from arbitration,
1127 * since this is the only way to guarantee that we'll get a MESSAGE OUT
1128 * phase immediately after selection.
1129 */
1130
1131 NCR5380_write(INITIATOR_COMMAND_REG, (ICR_BASE | ICR_ASSERT_BSY | ICR_ASSERT_DATA | ICR_ASSERT_ATN | ICR_ASSERT_SEL));
1132 NCR5380_write(MODE_REG, MR_BASE);
1133
1134 /*
1135 * Reselect interrupts must be turned off prior to the dropping of BSY,
1136 * otherwise we will trigger an interrupt.
1137 */
1138 NCR5380_write(SELECT_ENABLE_REG, 0);
1139
Finn Thain11d2f632016-01-03 16:05:51 +11001140 spin_unlock_irq(&hostdata->lock);
1141
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 /*
1143 * The initiator shall then wait at least two deskew delays and release
1144 * the BSY signal.
1145 */
1146 udelay(1); /* wingel -- wait two bus deskew delay >2*45ns */
1147
1148 /* Reset BSY */
1149 NCR5380_write(INITIATOR_COMMAND_REG, (ICR_BASE | ICR_ASSERT_DATA | ICR_ASSERT_ATN | ICR_ASSERT_SEL));
1150
1151 /*
1152 * Something weird happens when we cease to drive BSY - looks
1153 * like the board/chip is letting us do another read before the
1154 * appropriate propagation delay has expired, and we're confusing
1155 * a BSY signal from ourselves as the target's response to SELECTION.
1156 *
1157 * A small delay (the 'C++' frontend breaks the pipeline with an
1158 * unnecessary jump, making it work on my 386-33/Trantor T128, the
1159 * tighter 'C' code breaks and requires this) solves the problem -
1160 * the 1 us delay is arbitrary, and only used because this delay will
1161 * be the same on other platforms and since it works here, it should
1162 * work there.
1163 *
1164 * wingel suggests that this could be due to failing to wait
1165 * one deskew delay.
1166 */
1167
1168 udelay(1);
1169
Finn Thain52a6a1c2014-03-18 11:42:18 +11001170 dprintk(NDEBUG_SELECTION, "scsi%d : selecting target %d\n", instance->host_no, scmd_id(cmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171
1172 /*
1173 * The SCSI specification calls for a 250 ms timeout for the actual
1174 * selection.
1175 */
1176
Finn Thainae753a32016-01-03 16:05:23 +11001177 err = NCR5380_poll_politely(instance, STATUS_REG, SR_BSY, SR_BSY,
1178 msecs_to_jiffies(250));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 if ((NCR5380_read(STATUS_REG) & (SR_SEL | SR_IO)) == (SR_SEL | SR_IO)) {
Finn Thain11d2f632016-01-03 16:05:51 +11001181 spin_lock_irq(&hostdata->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1183 NCR5380_reselect(instance);
Finn Thaincd400822016-01-03 16:05:40 +11001184 if (!hostdata->connected)
1185 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 printk("scsi%d : reselection after won arbitration?\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 return -1;
1188 }
Finn Thainae753a32016-01-03 16:05:23 +11001189
1190 if (err < 0) {
Finn Thain11d2f632016-01-03 16:05:51 +11001191 spin_lock_irq(&hostdata->lock);
Finn Thainae753a32016-01-03 16:05:23 +11001192 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1193 cmd->result = DID_BAD_TARGET << 16;
1194 cmd->scsi_done(cmd);
1195 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
1196 dprintk(NDEBUG_SELECTION, "scsi%d : target did not respond within 250ms\n",
1197 instance->host_no);
1198 return 0;
1199 }
1200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 /*
1202 * No less than two deskew delays after the initiator detects the
1203 * BSY signal is true, it shall release the SEL signal and may
1204 * change the DATA BUS. -wingel
1205 */
1206
1207 udelay(1);
1208
1209 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ATN);
1210
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 /*
1212 * Since we followed the SCSI spec, and raised ATN while SEL
1213 * was true but before BSY was false during selection, the information
1214 * transfer phase should be a MESSAGE OUT phase so that we can send the
1215 * IDENTIFY message.
1216 *
1217 * If SCSI-II tagged queuing is enabled, we also send a SIMPLE_QUEUE_TAG
1218 * message (2 bytes) with a tag ID that we increment with every command
1219 * until it wraps back to 0.
1220 *
1221 * XXX - it turns out that there are some broken SCSI-II devices,
1222 * which claim to support tagged queuing but fail when more than
1223 * some number of commands are issued at once.
1224 */
1225
1226 /* Wait for start of REQ/ACK handshake */
1227
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 err = NCR5380_poll_politely(instance, STATUS_REG, SR_REQ, SR_REQ, HZ);
Finn Thain11d2f632016-01-03 16:05:51 +11001229 spin_lock_irq(&hostdata->lock);
Finn Thain1cc160e2016-01-03 16:05:32 +11001230 if (err < 0) {
Finn Thain55500d92016-01-03 16:05:35 +11001231 shost_printk(KERN_ERR, instance, "select: REQ timeout\n");
1232 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
Finn Thain63238762016-01-03 16:05:15 +11001234 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 }
1236
Finn Thain52a6a1c2014-03-18 11:42:18 +11001237 dprintk(NDEBUG_SELECTION, "scsi%d : target %d selected, going into MESSAGE OUT phase.\n", instance->host_no, cmd->device->id);
Finn Thain22f5f102014-11-12 16:11:56 +11001238 tmp[0] = IDENTIFY(((instance->irq == NO_IRQ) ? 0 : 1), cmd->device->lun);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
1240 len = 1;
1241 cmd->tag = 0;
1242
1243 /* Send message(s) */
1244 data = tmp;
1245 phase = PHASE_MSGOUT;
1246 NCR5380_transfer_pio(instance, &phase, &len, &data);
Finn Thain52a6a1c2014-03-18 11:42:18 +11001247 dprintk(NDEBUG_SELECTION, "scsi%d : nexus established.\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 /* XXX need to handle errors here */
Finn Thain11d2f632016-01-03 16:05:51 +11001249
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 hostdata->connected = cmd;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001251 hostdata->busy[cmd->device->id] |= (1 << (cmd->device->lun & 0xFF));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252
Boaz Harrosh28424d32007-09-10 22:37:45 +03001253 initialize_SCp(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
1255 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256}
1257
1258/*
1259 * Function : int NCR5380_transfer_pio (struct Scsi_Host *instance,
1260 * unsigned char *phase, int *count, unsigned char **data)
1261 *
1262 * Purpose : transfers data in given phase using polled I/O
1263 *
1264 * Inputs : instance - instance of driver, *phase - pointer to
1265 * what phase is expected, *count - pointer to number of
1266 * bytes to transfer, **data - pointer to data pointer.
1267 *
1268 * Returns : -1 when different phase is entered without transferring
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001269 * maximum number of bytes, 0 if all bytes or transferred or exit
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 * is in same phase.
1271 *
1272 * Also, *phase, *count, *data are modified in place.
1273 *
1274 * XXX Note : handling for bus free may be useful.
1275 */
1276
1277/*
1278 * Note : this code is not as quick as it could be, however it
1279 * IS 100% reliable, and for the actual data transfer where speed
1280 * counts, we will always do a pseudo DMA or DMA transfer.
1281 */
1282
1283static int NCR5380_transfer_pio(struct Scsi_Host *instance, unsigned char *phase, int *count, unsigned char **data) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 unsigned char p = *phase, tmp;
1285 int c = *count;
1286 unsigned char *d = *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
1288 if (!(p & SR_IO))
Finn Thain52a6a1c2014-03-18 11:42:18 +11001289 dprintk(NDEBUG_PIO, "scsi%d : pio write %d bytes\n", instance->host_no, c);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 else
Finn Thain52a6a1c2014-03-18 11:42:18 +11001291 dprintk(NDEBUG_PIO, "scsi%d : pio read %d bytes\n", instance->host_no, c);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
1293 /*
1294 * The NCR5380 chip will only drive the SCSI bus when the
1295 * phase specified in the appropriate bits of the TARGET COMMAND
1296 * REGISTER match the STATUS REGISTER
1297 */
1298
1299 NCR5380_write(TARGET_COMMAND_REG, PHASE_SR_TO_TCR(p));
1300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 do {
1302 /*
1303 * Wait for assertion of REQ, after which the phase bits will be
1304 * valid
1305 */
1306
Finn Thain686f3992016-01-03 16:05:26 +11001307 if (NCR5380_poll_politely(instance, STATUS_REG, SR_REQ, SR_REQ, HZ) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
Finn Thain52a6a1c2014-03-18 11:42:18 +11001310 dprintk(NDEBUG_HANDSHAKE, "scsi%d : REQ detected\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311
1312 /* Check for phase mismatch */
Finn Thain686f3992016-01-03 16:05:26 +11001313 if ((NCR5380_read(STATUS_REG) & PHASE_MASK) != p) {
Finn Thain52a6a1c2014-03-18 11:42:18 +11001314 dprintk(NDEBUG_HANDSHAKE, "scsi%d : phase mismatch\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 NCR5380_dprint_phase(NDEBUG_HANDSHAKE, instance);
1316 break;
1317 }
1318 /* Do actual transfer from SCSI bus to / from memory */
1319 if (!(p & SR_IO))
1320 NCR5380_write(OUTPUT_DATA_REG, *d);
1321 else
1322 *d = NCR5380_read(CURRENT_SCSI_DATA_REG);
1323
1324 ++d;
1325
1326 /*
1327 * The SCSI standard suggests that in MSGOUT phase, the initiator
1328 * should drop ATN on the last byte of the message phase
1329 * after REQ has been asserted for the handshake but before
1330 * the initiator raises ACK.
1331 */
1332
1333 if (!(p & SR_IO)) {
1334 if (!((p & SR_MSG) && c > 1)) {
1335 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_DATA);
1336 NCR5380_dprint(NDEBUG_PIO, instance);
1337 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_DATA | ICR_ASSERT_ACK);
1338 } else {
1339 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_DATA | ICR_ASSERT_ATN);
1340 NCR5380_dprint(NDEBUG_PIO, instance);
1341 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_DATA | ICR_ASSERT_ATN | ICR_ASSERT_ACK);
1342 }
1343 } else {
1344 NCR5380_dprint(NDEBUG_PIO, instance);
1345 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ACK);
1346 }
1347
Finn Thaina2edc4a2016-01-03 16:05:27 +11001348 if (NCR5380_poll_politely(instance,
1349 STATUS_REG, SR_REQ, 0, 5 * HZ) < 0)
1350 break;
1351
Finn Thain52a6a1c2014-03-18 11:42:18 +11001352 dprintk(NDEBUG_HANDSHAKE, "scsi%d : req false, handshake complete\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
1354/*
1355 * We have several special cases to consider during REQ/ACK handshaking :
1356 * 1. We were in MSGOUT phase, and we are on the last byte of the
1357 * message. ATN must be dropped as ACK is dropped.
1358 *
1359 * 2. We are in a MSGIN phase, and we are on the last byte of the
1360 * message. We must exit with ACK asserted, so that the calling
1361 * code may raise ATN before dropping ACK to reject the message.
1362 *
1363 * 3. ACK and ATN are clear and the target may proceed as normal.
1364 */
1365 if (!(p == PHASE_MSGIN && c == 1)) {
1366 if (p == PHASE_MSGOUT && c > 1)
1367 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ATN);
1368 else
1369 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1370 }
1371 } while (--c);
1372
Finn Thain52a6a1c2014-03-18 11:42:18 +11001373 dprintk(NDEBUG_PIO, "scsi%d : residual %d\n", instance->host_no, c);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
1375 *count = c;
1376 *data = d;
1377 tmp = NCR5380_read(STATUS_REG);
Finn Thaina2edc4a2016-01-03 16:05:27 +11001378 /* The phase read from the bus is valid if either REQ is (already)
1379 * asserted or if ACK hasn't been released yet. The latter applies if
1380 * we're in MSG IN, DATA IN or STATUS and all bytes have been received.
1381 */
1382 if ((tmp & SR_REQ) || ((tmp & SR_IO) && c == 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 *phase = tmp & PHASE_MASK;
1384 else
1385 *phase = PHASE_UNKNOWN;
1386
1387 if (!c || (*phase == p))
1388 return 0;
1389 else
1390 return -1;
1391}
1392
1393/**
Finn Thain636b1ec2016-01-03 16:05:10 +11001394 * do_reset - issue a reset command
1395 * @instance: adapter to reset
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 *
Finn Thain636b1ec2016-01-03 16:05:10 +11001397 * Issue a reset sequence to the NCR5380 and try and get the bus
1398 * back into sane shape.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 *
Finn Thain636b1ec2016-01-03 16:05:10 +11001400 * This clears the reset interrupt flag because there may be no handler for
1401 * it. When the driver is initialized, the NCR5380_intr() handler has not yet
1402 * been installed. And when in EH we may have released the ST DMA interrupt.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 */
1404
Finn Thain54d8fe42016-01-03 16:05:06 +11001405static void do_reset(struct Scsi_Host *instance)
1406{
Finn Thain636b1ec2016-01-03 16:05:10 +11001407 unsigned long flags;
1408
1409 local_irq_save(flags);
1410 NCR5380_write(TARGET_COMMAND_REG,
1411 PHASE_SR_TO_TCR(NCR5380_read(STATUS_REG) & PHASE_MASK));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_RST);
Finn Thain636b1ec2016-01-03 16:05:10 +11001413 udelay(50);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
Finn Thain636b1ec2016-01-03 16:05:10 +11001415 (void)NCR5380_read(RESET_PARITY_INTERRUPT_REG);
1416 local_irq_restore(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
1418
Finn Thain80d3eb62016-01-03 16:05:34 +11001419/**
1420 * do_abort - abort the currently established nexus by going to
1421 * MESSAGE OUT phase and sending an ABORT message.
1422 * @instance: relevant scsi host instance
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 *
Finn Thain80d3eb62016-01-03 16:05:34 +11001424 * Returns 0 on success, -1 on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 */
1426
Finn Thain54d8fe42016-01-03 16:05:06 +11001427static int do_abort(struct Scsi_Host *instance)
1428{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 unsigned char *msgptr, phase, tmp;
1430 int len;
1431 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432
1433 /* Request message out phase */
1434 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ATN);
1435
1436 /*
1437 * Wait for the target to indicate a valid phase by asserting
1438 * REQ. Once this happens, we'll have either a MSGOUT phase
1439 * and can immediately send the ABORT message, or we'll have some
1440 * other phase and will have to source/sink data.
1441 *
1442 * We really don't care what value was on the bus or what value
1443 * the target sees, so we just handshake.
1444 */
1445
Finn Thain80d3eb62016-01-03 16:05:34 +11001446 rc = NCR5380_poll_politely(instance, STATUS_REG, SR_REQ, SR_REQ, 10 * HZ);
Finn Thain1cc160e2016-01-03 16:05:32 +11001447 if (rc < 0)
Finn Thain80d3eb62016-01-03 16:05:34 +11001448 goto timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449
Finn Thainf35d3472016-01-03 16:05:33 +11001450 tmp = NCR5380_read(STATUS_REG) & PHASE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
1452 NCR5380_write(TARGET_COMMAND_REG, PHASE_SR_TO_TCR(tmp));
1453
Finn Thainf35d3472016-01-03 16:05:33 +11001454 if (tmp != PHASE_MSGOUT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ATN | ICR_ASSERT_ACK);
Finn Thain54d8fe42016-01-03 16:05:06 +11001456 rc = NCR5380_poll_politely(instance, STATUS_REG, SR_REQ, 0, 3 * HZ);
Finn Thain1cc160e2016-01-03 16:05:32 +11001457 if (rc < 0)
Finn Thain80d3eb62016-01-03 16:05:34 +11001458 goto timeout;
1459 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ATN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 }
1461 tmp = ABORT;
1462 msgptr = &tmp;
1463 len = 1;
1464 phase = PHASE_MSGOUT;
Finn Thain54d8fe42016-01-03 16:05:06 +11001465 NCR5380_transfer_pio(instance, &phase, &len, &msgptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
1467 /*
1468 * If we got here, and the command completed successfully,
1469 * we're about to go into bus free state.
1470 */
1471
1472 return len ? -1 : 0;
Finn Thain80d3eb62016-01-03 16:05:34 +11001473
1474timeout:
1475 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1476 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477}
1478
1479#if defined(REAL_DMA) || defined(PSEUDO_DMA) || defined (REAL_DMA_POLL)
1480/*
1481 * Function : int NCR5380_transfer_dma (struct Scsi_Host *instance,
1482 * unsigned char *phase, int *count, unsigned char **data)
1483 *
1484 * Purpose : transfers data in given phase using either real
1485 * or pseudo DMA.
1486 *
1487 * Inputs : instance - instance of driver, *phase - pointer to
1488 * what phase is expected, *count - pointer to number of
1489 * bytes to transfer, **data - pointer to data pointer.
1490 *
1491 * Returns : -1 when different phase is entered without transferring
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001492 * maximum number of bytes, 0 if all bytes or transferred or exit
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 * is in same phase.
1494 *
1495 * Also, *phase, *count, *data are modified in place.
1496 *
1497 * Locks: io_request lock held by caller
1498 */
1499
1500
1501static int NCR5380_transfer_dma(struct Scsi_Host *instance, unsigned char *phase, int *count, unsigned char **data) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 register int c = *count;
1503 register unsigned char p = *phase;
1504 register unsigned char *d = *data;
1505 unsigned char tmp;
1506 int foo;
1507#if defined(REAL_DMA_POLL)
1508 int cnt, toPIO;
1509 unsigned char saved_data = 0, overrun = 0, residue;
1510#endif
1511
Finn Thaine8a60142016-01-03 16:05:54 +11001512 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 if ((tmp = (NCR5380_read(STATUS_REG) & PHASE_MASK)) != p) {
1515 *phase = tmp;
1516 return -1;
1517 }
1518#if defined(REAL_DMA) || defined(REAL_DMA_POLL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 if (p & SR_IO) {
Finn Thain9db60242016-01-03 16:05:43 +11001520 if (!(hostdata->flags & FLAG_NO_DMA_FIXUPS))
1521 c -= 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 }
Finn Thain52a6a1c2014-03-18 11:42:18 +11001523 dprintk(NDEBUG_DMA, "scsi%d : initializing DMA channel %d for %s, %d bytes %s %0x\n", instance->host_no, instance->dma_channel, (p & SR_IO) ? "reading" : "writing", c, (p & SR_IO) ? "to" : "from", (unsigned) d);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 hostdata->dma_len = (p & SR_IO) ? NCR5380_dma_read_setup(instance, d, c) : NCR5380_dma_write_setup(instance, d, c);
1525#endif
1526
1527 NCR5380_write(TARGET_COMMAND_REG, PHASE_SR_TO_TCR(p));
1528
1529#ifdef REAL_DMA
Finn Thaincd400822016-01-03 16:05:40 +11001530 NCR5380_write(MODE_REG, MR_BASE | MR_DMA_MODE | MR_MONITOR_BSY |
1531 MR_ENABLE_EOP_INTR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532#elif defined(REAL_DMA_POLL)
Finn Thaincd400822016-01-03 16:05:40 +11001533 NCR5380_write(MODE_REG, MR_BASE | MR_DMA_MODE | MR_MONITOR_BSY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534#else
1535 /*
1536 * Note : on my sample board, watch-dog timeouts occurred when interrupts
1537 * were not disabled for the duration of a single DMA transfer, from
1538 * before the setting of DMA mode to after transfer of the last byte.
1539 */
1540
Finn Thain55181be2016-01-03 16:05:42 +11001541 if (hostdata->flags & FLAG_NO_DMA_FIXUP)
Finn Thaincd400822016-01-03 16:05:40 +11001542 NCR5380_write(MODE_REG, MR_BASE | MR_DMA_MODE | MR_MONITOR_BSY |
1543 MR_ENABLE_EOP_INTR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 else
Finn Thaincd400822016-01-03 16:05:40 +11001545 NCR5380_write(MODE_REG, MR_BASE | MR_DMA_MODE | MR_MONITOR_BSY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546#endif /* def REAL_DMA */
1547
Finn Thain52a6a1c2014-03-18 11:42:18 +11001548 dprintk(NDEBUG_DMA, "scsi%d : mode reg = 0x%X\n", instance->host_no, NCR5380_read(MODE_REG));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
1550 /*
1551 * On the PAS16 at least I/O recovery delays are not needed here.
1552 * Everyone else seems to want them.
1553 */
1554
1555 if (p & SR_IO) {
1556 io_recovery_delay(1);
1557 NCR5380_write(START_DMA_INITIATOR_RECEIVE_REG, 0);
1558 } else {
1559 io_recovery_delay(1);
1560 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_DATA);
1561 io_recovery_delay(1);
1562 NCR5380_write(START_DMA_SEND_REG, 0);
1563 io_recovery_delay(1);
1564 }
1565
1566#if defined(REAL_DMA_POLL)
1567 do {
1568 tmp = NCR5380_read(BUS_AND_STATUS_REG);
1569 } while ((tmp & BASR_PHASE_MATCH) && !(tmp & (BASR_BUSY_ERROR | BASR_END_DMA_TRANSFER)));
1570
1571/*
1572 At this point, either we've completed DMA, or we have a phase mismatch,
1573 or we've unexpectedly lost BUSY (which is a real error).
1574
1575 For write DMAs, we want to wait until the last byte has been
1576 transferred out over the bus before we turn off DMA mode. Alas, there
1577 seems to be no terribly good way of doing this on a 5380 under all
1578 conditions. For non-scatter-gather operations, we can wait until REQ
1579 and ACK both go false, or until a phase mismatch occurs. Gather-writes
1580 are nastier, since the device will be expecting more data than we
1581 are prepared to send it, and REQ will remain asserted. On a 53C8[01] we
1582 could test LAST BIT SENT to assure transfer (I imagine this is precisely
1583 why this signal was added to the newer chips) but on the older 538[01]
1584 this signal does not exist. The workaround for this lack is a watchdog;
1585 we bail out of the wait-loop after a modest amount of wait-time if
1586 the usual exit conditions are not met. Not a terribly clean or
1587 correct solution :-%
1588
1589 Reads are equally tricky due to a nasty characteristic of the NCR5380.
1590 If the chip is in DMA mode for an READ, it will respond to a target's
1591 REQ by latching the SCSI data into the INPUT DATA register and asserting
1592 ACK, even if it has _already_ been notified by the DMA controller that
1593 the current DMA transfer has completed! If the NCR5380 is then taken
1594 out of DMA mode, this already-acknowledged byte is lost.
1595
1596 This is not a problem for "one DMA transfer per command" reads, because
1597 the situation will never arise... either all of the data is DMA'ed
1598 properly, or the target switches to MESSAGE IN phase to signal a
1599 disconnection (either operation bringing the DMA to a clean halt).
1600 However, in order to handle scatter-reads, we must work around the
1601 problem. The chosen fix is to DMA N-2 bytes, then check for the
1602 condition before taking the NCR5380 out of DMA mode. One or two extra
1603 bytes are transferred via PIO as necessary to fill out the original
1604 request.
1605 */
1606
1607 if (p & SR_IO) {
Finn Thain9db60242016-01-03 16:05:43 +11001608 if (!(hostdata->flags & FLAG_NO_DMA_FIXUPS)) {
1609 udelay(10);
1610 if ((NCR5380_read(BUS_AND_STATUS_REG) & (BASR_PHASE_MATCH | BASR_ACK)) ==
1611 (BASR_PHASE_MATCH | BASR_ACK)) {
1612 saved_data = NCR5380_read(INPUT_DATA_REGISTER);
1613 overrun = 1;
1614 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 } else {
1617 int limit = 100;
1618 while (((tmp = NCR5380_read(BUS_AND_STATUS_REG)) & BASR_ACK) || (NCR5380_read(STATUS_REG) & SR_REQ)) {
1619 if (!(tmp & BASR_PHASE_MATCH))
1620 break;
1621 if (--limit < 0)
1622 break;
1623 }
1624 }
1625
Finn Thain52a6a1c2014-03-18 11:42:18 +11001626 dprintk(NDEBUG_DMA, "scsi%d : polled DMA transfer complete, basr 0x%X, sr 0x%X\n", instance->host_no, tmp, NCR5380_read(STATUS_REG));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627
1628 NCR5380_write(MODE_REG, MR_BASE);
1629 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1630
1631 residue = NCR5380_dma_residual(instance);
1632 c -= residue;
1633 *count -= c;
1634 *data += c;
1635 *phase = NCR5380_read(STATUS_REG) & PHASE_MASK;
1636
Finn Thain9db60242016-01-03 16:05:43 +11001637 if (!(hostdata->flags & FLAG_NO_DMA_FIXUPS) &&
1638 *phase == p && (p & SR_IO) && residue == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 if (overrun) {
Finn Thain52a6a1c2014-03-18 11:42:18 +11001640 dprintk(NDEBUG_DMA, "Got an input overrun, using saved byte\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 **data = saved_data;
1642 *data += 1;
1643 *count -= 1;
1644 cnt = toPIO = 1;
1645 } else {
1646 printk("No overrun??\n");
1647 cnt = toPIO = 2;
1648 }
Finn Thain52a6a1c2014-03-18 11:42:18 +11001649 dprintk(NDEBUG_DMA, "Doing %d-byte PIO to 0x%X\n", cnt, *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 NCR5380_transfer_pio(instance, phase, &cnt, data);
1651 *count -= toPIO - cnt;
1652 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
Finn Thain52a6a1c2014-03-18 11:42:18 +11001654 dprintk(NDEBUG_DMA, "Return with data ptr = 0x%X, count %d, last 0x%X, next 0x%X\n", *data, *count, *(*data + *count - 1), *(*data + *count));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 return 0;
1656
1657#elif defined(REAL_DMA)
1658 return 0;
1659#else /* defined(REAL_DMA_POLL) */
1660 if (p & SR_IO) {
Finn Thain55181be2016-01-03 16:05:42 +11001661 foo = NCR5380_pread(instance, d,
1662 hostdata->flags & FLAG_NO_DMA_FIXUP ? c : c - 1);
1663 if (!foo && !(hostdata->flags & FLAG_NO_DMA_FIXUP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 /*
1665 * We can't disable DMA mode after successfully transferring
1666 * what we plan to be the last byte, since that would open up
1667 * a race condition where if the target asserted REQ before
1668 * we got the DMA mode reset, the NCR5380 would have latched
1669 * an additional byte into the INPUT DATA register and we'd
1670 * have dropped it.
1671 *
1672 * The workaround was to transfer one fewer bytes than we
1673 * intended to with the pseudo-DMA read function, wait for
1674 * the chip to latch the last byte, read it, and then disable
1675 * pseudo-DMA mode.
1676 *
1677 * After REQ is asserted, the NCR5380 asserts DRQ and ACK.
1678 * REQ is deasserted when ACK is asserted, and not reasserted
1679 * until ACK goes false. Since the NCR5380 won't lower ACK
1680 * until DACK is asserted, which won't happen unless we twiddle
1681 * the DMA port or we take the NCR5380 out of DMA mode, we
1682 * can guarantee that we won't handshake another extra
1683 * byte.
1684 */
1685
Finn Thain55181be2016-01-03 16:05:42 +11001686 if (NCR5380_poll_politely(instance, BUS_AND_STATUS_REG,
1687 BASR_DRQ, BASR_DRQ, HZ) < 0) {
1688 foo = -1;
1689 shost_printk(KERN_ERR, instance, "PDMA read: DRQ timeout\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 }
Finn Thain55181be2016-01-03 16:05:42 +11001691 if (NCR5380_poll_politely(instance, STATUS_REG,
1692 SR_REQ, 0, HZ) < 0) {
1693 foo = -1;
1694 shost_printk(KERN_ERR, instance, "PDMA read: !REQ timeout\n");
1695 }
1696 d[c - 1] = NCR5380_read(INPUT_DATA_REG);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 foo = NCR5380_pwrite(instance, d, c);
Finn Thain55181be2016-01-03 16:05:42 +11001700 if (!foo && !(hostdata->flags & FLAG_NO_DMA_FIXUP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 /*
1702 * Wait for the last byte to be sent. If REQ is being asserted for
1703 * the byte we're interested, we'll ACK it and it will go false.
1704 */
Finn Thain55181be2016-01-03 16:05:42 +11001705 if (NCR5380_poll_politely2(instance,
1706 BUS_AND_STATUS_REG, BASR_DRQ, BASR_DRQ,
1707 BUS_AND_STATUS_REG, BASR_PHASE_MATCH, 0, HZ) < 0) {
1708 foo = -1;
1709 shost_printk(KERN_ERR, instance, "PDMA write: DRQ and phase timeout\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 }
1711 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 }
1713 NCR5380_write(MODE_REG, MR_BASE);
1714 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
Finn Thaincd400822016-01-03 16:05:40 +11001715 NCR5380_read(RESET_PARITY_INTERRUPT_REG);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 *data = d + c;
1717 *count = 0;
1718 *phase = NCR5380_read(STATUS_REG) & PHASE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 return foo;
1720#endif /* def REAL_DMA */
1721}
1722#endif /* defined(REAL_DMA) | defined(PSEUDO_DMA) */
1723
1724/*
1725 * Function : NCR5380_information_transfer (struct Scsi_Host *instance)
1726 *
1727 * Purpose : run through the various SCSI phases and do as the target
1728 * directs us to. Operates on the currently connected command,
1729 * instance->connected.
1730 *
1731 * Inputs : instance, instance for which we are doing commands
1732 *
1733 * Side effects : SCSI things happen, the disconnected queue will be
1734 * modified if a command disconnects, *instance->connected will
1735 * change.
1736 *
1737 * XXX Note : we need to watch for bus free or a reset condition here
1738 * to recover from an unexpected bus free condition.
1739 *
1740 * Locks: io_request_lock held by caller in IRQ mode
1741 */
1742
1743static void NCR5380_information_transfer(struct Scsi_Host *instance) {
Finn Thaine8a60142016-01-03 16:05:54 +11001744 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 unsigned char msgout = NOP;
1746 int sink = 0;
1747 int len;
1748#if defined(PSEUDO_DMA) || defined(REAL_DMA_POLL)
1749 int transfersize;
1750#endif
1751 unsigned char *data;
1752 unsigned char phase, tmp, extended_msg[10], old_phase = 0xff;
Finn Thain11d2f632016-01-03 16:05:51 +11001753 struct scsi_cmnd *cmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754
Finn Thain11d2f632016-01-03 16:05:51 +11001755 while ((cmd = hostdata->connected)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 tmp = NCR5380_read(STATUS_REG);
1757 /* We only have a valid SCSI phase when REQ is asserted */
1758 if (tmp & SR_REQ) {
1759 phase = (tmp & PHASE_MASK);
1760 if (phase != old_phase) {
1761 old_phase = phase;
1762 NCR5380_dprint_phase(NDEBUG_INFORMATION, instance);
1763 }
1764 if (sink && (phase != PHASE_MSGOUT)) {
1765 NCR5380_write(TARGET_COMMAND_REG, PHASE_SR_TO_TCR(tmp));
1766
1767 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ATN | ICR_ASSERT_ACK);
1768 while (NCR5380_read(STATUS_REG) & SR_REQ);
1769 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ATN);
1770 sink = 0;
1771 continue;
1772 }
1773 switch (phase) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 case PHASE_DATAOUT:
1775#if (NDEBUG & NDEBUG_NO_DATAOUT)
1776 printk("scsi%d : NDEBUG_NO_DATAOUT set, attempted DATAOUT aborted\n", instance->host_no);
1777 sink = 1;
1778 do_abort(instance);
1779 cmd->result = DID_ERROR << 16;
Matthew Wilcoxcce99c62007-09-25 12:42:01 -04001780 cmd->scsi_done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 return;
1782#endif
Finn Thainbf1a0c62016-01-03 16:05:47 +11001783 case PHASE_DATAIN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 /*
1785 * If there is no room left in the current buffer in the
1786 * scatter-gather list, move onto the next one.
1787 */
1788
1789 if (!cmd->SCp.this_residual && cmd->SCp.buffers_residual) {
1790 ++cmd->SCp.buffer;
1791 --cmd->SCp.buffers_residual;
1792 cmd->SCp.this_residual = cmd->SCp.buffer->length;
Jens Axboe45711f12007-10-22 21:19:53 +02001793 cmd->SCp.ptr = sg_virt(cmd->SCp.buffer);
Finn Thain52a6a1c2014-03-18 11:42:18 +11001794 dprintk(NDEBUG_INFORMATION, "scsi%d : %d bytes and %d buffers left\n", instance->host_no, cmd->SCp.this_residual, cmd->SCp.buffers_residual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 }
1796 /*
1797 * The preferred transfer method is going to be
1798 * PSEUDO-DMA for systems that are strictly PIO,
1799 * since we can let the hardware do the handshaking.
1800 *
1801 * For this to work, we need to know the transfersize
1802 * ahead of time, since the pseudo-DMA code will sit
1803 * in an unconditional loop.
1804 */
1805
1806#if defined(PSEUDO_DMA) || defined(REAL_DMA_POLL)
Finn Thainff3d4572016-01-03 16:05:25 +11001807 transfersize = 0;
1808 if (!cmd->device->borken &&
1809 !(hostdata->flags & FLAG_NO_PSEUDO_DMA))
1810 transfersize = NCR5380_dma_xfer_len(instance, cmd, phase);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Finn Thainff3d4572016-01-03 16:05:25 +11001812 if (transfersize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 len = transfersize;
1814 if (NCR5380_transfer_dma(instance, &phase, &len, (unsigned char **) &cmd->SCp.ptr)) {
1815 /*
1816 * If the watchdog timer fires, all future accesses to this
1817 * device will use the polled-IO.
1818 */
Jeff Garzik017560f2005-10-24 18:04:36 -04001819 scmd_printk(KERN_INFO, cmd,
1820 "switching to slow handshake\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 cmd->device->borken = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 sink = 1;
1823 do_abort(instance);
1824 cmd->result = DID_ERROR << 16;
Matthew Wilcoxcce99c62007-09-25 12:42:01 -04001825 cmd->scsi_done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 /* XXX - need to source or sink data here, as appropriate */
1827 } else
1828 cmd->SCp.this_residual -= transfersize - len;
1829 } else
1830#endif /* defined(PSEUDO_DMA) || defined(REAL_DMA_POLL) */
Finn Thain11d2f632016-01-03 16:05:51 +11001831 {
1832 spin_unlock_irq(&hostdata->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 NCR5380_transfer_pio(instance, &phase, (int *) &cmd->SCp.this_residual, (unsigned char **)
1834 &cmd->SCp.ptr);
Finn Thain11d2f632016-01-03 16:05:51 +11001835 spin_lock_irq(&hostdata->lock);
1836 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 break;
1838 case PHASE_MSGIN:
1839 len = 1;
1840 data = &tmp;
1841 NCR5380_transfer_pio(instance, &phase, &len, &data);
1842 cmd->SCp.Message = tmp;
1843
1844 switch (tmp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 case ABORT:
1846 case COMMAND_COMPLETE:
1847 /* Accept message by clearing ACK */
1848 sink = 1;
1849 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1850 hostdata->connected = NULL;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001851 dprintk(NDEBUG_QUEUES, "scsi%d : command for target %d, lun %llu completed\n", instance->host_no, cmd->device->id, cmd->device->lun);
1852 hostdata->busy[cmd->device->id] &= ~(1 << (cmd->device->lun & 0xFF));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
1854 /*
1855 * I'm not sure what the correct thing to do here is :
1856 *
1857 * If the command that just executed is NOT a request
1858 * sense, the obvious thing to do is to set the result
1859 * code to the values of the stored parameters.
1860 *
1861 * If it was a REQUEST SENSE command, we need some way
1862 * to differentiate between the failure code of the original
1863 * and the failure code of the REQUEST sense - the obvious
1864 * case is success, where we fall through and leave the result
1865 * code unchanged.
1866 *
1867 * The non-obvious place is where the REQUEST SENSE failed
1868 */
1869
1870 if (cmd->cmnd[0] != REQUEST_SENSE)
1871 cmd->result = cmd->SCp.Status | (cmd->SCp.Message << 8);
1872 else if (status_byte(cmd->SCp.Status) != GOOD)
1873 cmd->result = (cmd->result & 0x00ffff) | (DID_ERROR << 16);
1874
Boaz Harrosh28424d32007-09-10 22:37:45 +03001875 if ((cmd->cmnd[0] == REQUEST_SENSE) &&
1876 hostdata->ses.cmd_len) {
1877 scsi_eh_restore_cmnd(cmd, &hostdata->ses);
1878 hostdata->ses.cmd_len = 0 ;
1879 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880
Boaz Harrosh28424d32007-09-10 22:37:45 +03001881 if ((cmd->cmnd[0] != REQUEST_SENSE) && (status_byte(cmd->SCp.Status) == CHECK_CONDITION)) {
1882 scsi_eh_prep_cmnd(cmd, &hostdata->ses, NULL, 0, ~0);
1883
Finn Thain52a6a1c2014-03-18 11:42:18 +11001884 dprintk(NDEBUG_AUTOSENSE, "scsi%d : performing request sense\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885
1886 LIST(cmd, hostdata->issue_queue);
1887 cmd->host_scribble = (unsigned char *)
1888 hostdata->issue_queue;
Finn Thain710ddd02014-11-12 16:12:02 +11001889 hostdata->issue_queue = (struct scsi_cmnd *) cmd;
Finn Thaindbb6b352016-01-03 16:05:53 +11001890 dsprintk(NDEBUG_QUEUES, instance,
1891 "REQUEST SENSE cmd %p added to head of issue queue\n",
1892 cmd);
Finn Thain997acab2014-11-12 16:11:54 +11001893 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 cmd->scsi_done(cmd);
1895 }
1896
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 /*
1898 * Restore phase bits to 0 so an interrupted selection,
1899 * arbitration can resume.
1900 */
1901 NCR5380_write(TARGET_COMMAND_REG, 0);
Finn Thain72064a72016-01-03 16:05:44 +11001902
1903 /* Enable reselect interrupts */
1904 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 return;
1906 case MESSAGE_REJECT:
1907 /* Accept message by clearing ACK */
1908 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1909 switch (hostdata->last_message) {
1910 case HEAD_OF_QUEUE_TAG:
1911 case ORDERED_QUEUE_TAG:
1912 case SIMPLE_QUEUE_TAG:
1913 cmd->device->simple_tags = 0;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001914 hostdata->busy[cmd->device->id] |= (1 << (cmd->device->lun & 0xFF));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 break;
1916 default:
1917 break;
1918 }
Finn Thain340b9612016-01-03 16:05:31 +11001919 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 case DISCONNECT:{
1921 /* Accept message by clearing ACK */
1922 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 LIST(cmd, hostdata->disconnected_queue);
1924 cmd->host_scribble = (unsigned char *)
1925 hostdata->disconnected_queue;
1926 hostdata->connected = NULL;
1927 hostdata->disconnected_queue = cmd;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02001928 dprintk(NDEBUG_QUEUES, "scsi%d : command for target %d lun %llu was moved from connected to" " the disconnected_queue\n", instance->host_no, cmd->device->id, cmd->device->lun);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 /*
1930 * Restore phase bits to 0 so an interrupted selection,
1931 * arbitration can resume.
1932 */
1933 NCR5380_write(TARGET_COMMAND_REG, 0);
1934
1935 /* Enable reselect interrupts */
1936 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 return;
1938 }
1939 /*
1940 * The SCSI data pointer is *IMPLICITLY* saved on a disconnect
1941 * operation, in violation of the SCSI spec so we can safely
1942 * ignore SAVE/RESTORE pointers calls.
1943 *
1944 * Unfortunately, some disks violate the SCSI spec and
1945 * don't issue the required SAVE_POINTERS message before
1946 * disconnecting, and we have to break spec to remain
1947 * compatible.
1948 */
1949 case SAVE_POINTERS:
1950 case RESTORE_POINTERS:
1951 /* Accept message by clearing ACK */
1952 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1953 break;
1954 case EXTENDED_MESSAGE:
1955/*
1956 * Extended messages are sent in the following format :
1957 * Byte
1958 * 0 EXTENDED_MESSAGE == 1
1959 * 1 length (includes one byte for code, doesn't
1960 * include first two bytes)
1961 * 2 code
1962 * 3..length+1 arguments
1963 *
1964 * Start the extended message buffer with the EXTENDED_MESSAGE
Matthew Wilcox1abfd372005-12-15 16:22:01 -05001965 * byte, since spi_print_msg() wants the whole thing.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 */
1967 extended_msg[0] = EXTENDED_MESSAGE;
1968 /* Accept first byte by clearing ACK */
1969 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
Finn Thain11d2f632016-01-03 16:05:51 +11001970
1971 spin_unlock_irq(&hostdata->lock);
1972
Finn Thain52a6a1c2014-03-18 11:42:18 +11001973 dprintk(NDEBUG_EXTENDED, "scsi%d : receiving extended message\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974
1975 len = 2;
1976 data = extended_msg + 1;
1977 phase = PHASE_MSGIN;
1978 NCR5380_transfer_pio(instance, &phase, &len, &data);
1979
Finn Thain52a6a1c2014-03-18 11:42:18 +11001980 dprintk(NDEBUG_EXTENDED, "scsi%d : length=%d, code=0x%02x\n", instance->host_no, (int) extended_msg[1], (int) extended_msg[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981
Finn Thaine0783ed2016-01-03 16:05:45 +11001982 if (!len && extended_msg[1] > 0 &&
1983 extended_msg[1] <= sizeof(extended_msg) - 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 /* Accept third byte by clearing ACK */
1985 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1986 len = extended_msg[1] - 1;
1987 data = extended_msg + 3;
1988 phase = PHASE_MSGIN;
1989
1990 NCR5380_transfer_pio(instance, &phase, &len, &data);
Finn Thain52a6a1c2014-03-18 11:42:18 +11001991 dprintk(NDEBUG_EXTENDED, "scsi%d : message received, residual %d\n", instance->host_no, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992
1993 switch (extended_msg[2]) {
1994 case EXTENDED_SDTR:
1995 case EXTENDED_WDTR:
1996 case EXTENDED_MODIFY_DATA_POINTER:
1997 case EXTENDED_EXTENDED_IDENTIFY:
1998 tmp = 0;
1999 }
2000 } else if (len) {
2001 printk("scsi%d: error receiving extended message\n", instance->host_no);
2002 tmp = 0;
2003 } else {
2004 printk("scsi%d: extended message code %02x length %d is too long\n", instance->host_no, extended_msg[2], extended_msg[1]);
2005 tmp = 0;
2006 }
Finn Thain11d2f632016-01-03 16:05:51 +11002007
2008 spin_lock_irq(&hostdata->lock);
2009 if (!hostdata->connected)
2010 return;
2011
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 /* Fall through to reject message */
2013
2014 /*
2015 * If we get something weird that we aren't expecting,
2016 * reject it.
2017 */
2018 default:
2019 if (!tmp) {
2020 printk("scsi%d: rejecting message ", instance->host_no);
Matthew Wilcox1abfd372005-12-15 16:22:01 -05002021 spi_print_msg(extended_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 printk("\n");
2023 } else if (tmp != EXTENDED_MESSAGE)
Jeff Garzik017560f2005-10-24 18:04:36 -04002024 scmd_printk(KERN_INFO, cmd,
2025 "rejecting unknown message %02x\n",tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 else
Jeff Garzik017560f2005-10-24 18:04:36 -04002027 scmd_printk(KERN_INFO, cmd,
2028 "rejecting unknown extended message code %02x, length %d\n", extended_msg[1], extended_msg[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029
2030 msgout = MESSAGE_REJECT;
2031 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_ATN);
2032 break;
2033 } /* switch (tmp) */
2034 break;
2035 case PHASE_MSGOUT:
2036 len = 1;
2037 data = &msgout;
2038 hostdata->last_message = msgout;
2039 NCR5380_transfer_pio(instance, &phase, &len, &data);
2040 if (msgout == ABORT) {
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002041 hostdata->busy[cmd->device->id] &= ~(1 << (cmd->device->lun & 0xFF));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 hostdata->connected = NULL;
2043 cmd->result = DID_ERROR << 16;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 cmd->scsi_done(cmd);
2045 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
2046 return;
2047 }
2048 msgout = NOP;
2049 break;
2050 case PHASE_CMDOUT:
2051 len = cmd->cmd_len;
2052 data = cmd->cmnd;
2053 /*
2054 * XXX for performance reasons, on machines with a
2055 * PSEUDO-DMA architecture we should probably
2056 * use the dma transfer function.
2057 */
2058 NCR5380_transfer_pio(instance, &phase, &len, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 break;
2060 case PHASE_STATIN:
2061 len = 1;
2062 data = &tmp;
2063 NCR5380_transfer_pio(instance, &phase, &len, &data);
2064 cmd->SCp.Status = tmp;
2065 break;
2066 default:
2067 printk("scsi%d : unknown phase\n", instance->host_no);
Finn Thain4dde8f72014-03-18 11:42:17 +11002068 NCR5380_dprint(NDEBUG_ANY, instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 } /* switch(phase) */
Finn Thain686f3992016-01-03 16:05:26 +11002070 } else {
Finn Thain11d2f632016-01-03 16:05:51 +11002071 spin_unlock_irq(&hostdata->lock);
Finn Thain686f3992016-01-03 16:05:26 +11002072 NCR5380_poll_politely(instance, STATUS_REG, SR_REQ, SR_REQ, HZ);
Finn Thain11d2f632016-01-03 16:05:51 +11002073 spin_lock_irq(&hostdata->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 }
Finn Thain11d2f632016-01-03 16:05:51 +11002075 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076}
2077
2078/*
2079 * Function : void NCR5380_reselect (struct Scsi_Host *instance)
2080 *
2081 * Purpose : does reselection, initializing the instance->connected
Finn Thain710ddd02014-11-12 16:12:02 +11002082 * field to point to the scsi_cmnd for which the I_T_L or I_T_L_Q
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 * nexus has been reestablished,
2084 *
2085 * Inputs : instance - this instance of the NCR5380.
2086 *
2087 * Locks: io_request_lock held by caller if IRQ driven
2088 */
2089
2090static void NCR5380_reselect(struct Scsi_Host *instance) {
Finn Thaine8a60142016-01-03 16:05:54 +11002091 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 unsigned char target_mask;
2093 unsigned char lun, phase;
2094 int len;
2095 unsigned char msg[3];
2096 unsigned char *data;
Finn Thain710ddd02014-11-12 16:12:02 +11002097 struct scsi_cmnd *tmp = NULL, *prev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
2099 /*
2100 * Disable arbitration, etc. since the host adapter obviously
2101 * lost, and tell an interrupted NCR5380_select() to restart.
2102 */
2103
2104 NCR5380_write(MODE_REG, MR_BASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
2106 target_mask = NCR5380_read(CURRENT_SCSI_DATA_REG) & ~(hostdata->id_mask);
Finn Thain72064a72016-01-03 16:05:44 +11002107 dprintk(NDEBUG_RESELECTION, "scsi%d : reselect\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
2109 /*
2110 * At this point, we have detected that our SCSI ID is on the bus,
2111 * SEL is true and BSY was false for at least one bus settle delay
2112 * (400 ns).
2113 *
2114 * We must assert BSY ourselves, until the target drops the SEL
2115 * signal.
2116 */
2117
2118 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_BSY);
Finn Thain72064a72016-01-03 16:05:44 +11002119 if (NCR5380_poll_politely(instance,
2120 STATUS_REG, SR_SEL, 0, 2 * HZ) < 0) {
2121 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
2122 return;
2123 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
2125
2126 /*
2127 * Wait for target to go into MSGIN.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 */
2129
Finn Thain1cc160e2016-01-03 16:05:32 +11002130 if (NCR5380_poll_politely(instance,
Finn Thain72064a72016-01-03 16:05:44 +11002131 STATUS_REG, SR_REQ, SR_REQ, 2 * HZ) < 0) {
2132 do_abort(instance);
2133 return;
2134 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135
2136 len = 1;
2137 data = msg;
2138 phase = PHASE_MSGIN;
2139 NCR5380_transfer_pio(instance, &phase, &len, &data);
2140
Finn Thain72064a72016-01-03 16:05:44 +11002141 if (len) {
2142 do_abort(instance);
2143 return;
2144 }
2145
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 if (!(msg[0] & 0x80)) {
Finn Thain72064a72016-01-03 16:05:44 +11002147 shost_printk(KERN_ERR, instance, "expecting IDENTIFY message, got ");
Matthew Wilcox1abfd372005-12-15 16:22:01 -05002148 spi_print_msg(msg);
Finn Thain72064a72016-01-03 16:05:44 +11002149 printk("\n");
2150 do_abort(instance);
2151 return;
2152 }
2153 lun = msg[0] & 0x07;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154
Finn Thain72064a72016-01-03 16:05:44 +11002155 /*
2156 * We need to add code for SCSI-II to track which devices have
2157 * I_T_L_Q nexuses established, and which have simple I_T_L
2158 * nexuses so we can chose to do additional data transfer.
2159 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160
Finn Thain72064a72016-01-03 16:05:44 +11002161 /*
2162 * Find the command corresponding to the I_T_L or I_T_L_Q nexus we
2163 * just reestablished, and remove it from the disconnected queue.
2164 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165
Finn Thain72064a72016-01-03 16:05:44 +11002166 for (tmp = (struct scsi_cmnd *) hostdata->disconnected_queue, prev = NULL;
2167 tmp; prev = tmp, tmp = (struct scsi_cmnd *) tmp->host_scribble) {
2168 if ((target_mask == (1 << tmp->device->id)) && (lun == (u8)tmp->device->lun)) {
2169 if (prev) {
2170 REMOVE(prev, prev->host_scribble, tmp, tmp->host_scribble);
2171 prev->host_scribble = tmp->host_scribble;
2172 } else {
2173 REMOVE(-1, hostdata->disconnected_queue, tmp, tmp->host_scribble);
2174 hostdata->disconnected_queue =
2175 (struct scsi_cmnd *) tmp->host_scribble;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 }
Finn Thain72064a72016-01-03 16:05:44 +11002177 tmp->host_scribble = NULL;
2178 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 }
2180 }
Finn Thain72064a72016-01-03 16:05:44 +11002181 if (!tmp) {
2182 shost_printk(KERN_ERR, instance, "target bitmask 0x%02x lun %d not in disconnected queue.\n",
2183 target_mask, lun);
2184 /*
2185 * Since we have an established nexus that we can't do anything with,
2186 * we must abort it.
2187 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 do_abort(instance);
Finn Thain72064a72016-01-03 16:05:44 +11002189 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 }
Finn Thain72064a72016-01-03 16:05:44 +11002191
2192 /* Accept message by clearing ACK */
2193 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
2194
2195 hostdata->connected = tmp;
2196 dprintk(NDEBUG_RESELECTION, "scsi%d : nexus established, target = %d, lun = %llu, tag = %d\n",
2197 instance->host_no, tmp->device->id, tmp->device->lun, tmp->tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198}
2199
2200/*
2201 * Function : void NCR5380_dma_complete (struct Scsi_Host *instance)
2202 *
2203 * Purpose : called by interrupt handler when DMA finishes or a phase
2204 * mismatch occurs (which would finish the DMA transfer).
2205 *
2206 * Inputs : instance - this instance of the NCR5380.
2207 *
Finn Thain710ddd02014-11-12 16:12:02 +11002208 * Returns : pointer to the scsi_cmnd structure for which the I_T_L
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 * nexus has been reestablished, on failure NULL is returned.
2210 */
2211
2212#ifdef REAL_DMA
2213static void NCR5380_dma_complete(NCR5380_instance * instance) {
Finn Thaine8a60142016-01-03 16:05:54 +11002214 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 int transferred;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216
2217 /*
2218 * XXX this might not be right.
2219 *
2220 * Wait for final byte to transfer, ie wait for ACK to go false.
2221 *
2222 * We should use the Last Byte Sent bit, unfortunately this is
2223 * not available on the 5380/5381 (only the various CMOS chips)
2224 *
2225 * FIXME: timeout, and need to handle long timeout/irq case
2226 */
2227
2228 NCR5380_poll_politely(instance, BUS_AND_STATUS_REG, BASR_ACK, 0, 5*HZ);
2229
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
2231
2232 /*
2233 * The only places we should see a phase mismatch and have to send
2234 * data from the same set of pointers will be the data transfer
2235 * phases. So, residual, requested length are only important here.
2236 */
2237
2238 if (!(hostdata->connected->SCp.phase & SR_CD)) {
2239 transferred = instance->dmalen - NCR5380_dma_residual();
2240 hostdata->connected->SCp.this_residual -= transferred;
2241 hostdata->connected->SCp.ptr += transferred;
2242 }
2243}
2244#endif /* def REAL_DMA */
2245
2246/*
Finn Thain710ddd02014-11-12 16:12:02 +11002247 * Function : int NCR5380_abort (struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 *
2249 * Purpose : abort a command
2250 *
Finn Thain710ddd02014-11-12 16:12:02 +11002251 * Inputs : cmd - the scsi_cmnd to abort, code - code to set the
Hannes Reineckeb6c92b72014-10-30 09:44:36 +01002252 * host byte of the result field to, if zero DID_ABORTED is
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 * used.
2254 *
Hannes Reineckeb6c92b72014-10-30 09:44:36 +01002255 * Returns : SUCCESS - success, FAILED on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 *
Hannes Reineckeb6c92b72014-10-30 09:44:36 +01002257 * XXX - there is no way to abort the command that is currently
2258 * connected, you have to wait for it to complete. If this is
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 * a problem, we could implement longjmp() / setjmp(), setjmp()
2260 * called where the loop started in NCR5380_main().
2261 *
2262 * Locks: host lock taken by caller
2263 */
2264
Finn Thain710ddd02014-11-12 16:12:02 +11002265static int NCR5380_abort(struct scsi_cmnd *cmd)
2266{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 struct Scsi_Host *instance = cmd->device->host;
Finn Thaine8a60142016-01-03 16:05:54 +11002268 struct NCR5380_hostdata *hostdata = shost_priv(instance);
Finn Thain710ddd02014-11-12 16:12:02 +11002269 struct scsi_cmnd *tmp, **prev;
Finn Thain11d2f632016-01-03 16:05:51 +11002270 unsigned long flags;
Hannes Reinecke1fa6b5f2014-10-24 14:26:58 +02002271
2272 scmd_printk(KERN_WARNING, cmd, "aborting command\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
Finn Thain11d2f632016-01-03 16:05:51 +11002274 spin_lock_irqsave(&hostdata->lock, flags);
2275
Finn Thaine5c3fdd2016-01-03 16:05:52 +11002276 NCR5380_dprint(NDEBUG_ANY, instance);
2277 NCR5380_dprint_phase(NDEBUG_ANY, instance);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278
Finn Thain52a6a1c2014-03-18 11:42:18 +11002279 dprintk(NDEBUG_ABORT, "scsi%d : abort called\n", instance->host_no);
2280 dprintk(NDEBUG_ABORT, " basr 0x%X, sr 0x%X\n", NCR5380_read(BUS_AND_STATUS_REG), NCR5380_read(STATUS_REG));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281
2282#if 0
2283/*
2284 * Case 1 : If the command is the currently executing command,
2285 * we'll set the aborted flag and return control so that
2286 * information transfer routine can exit cleanly.
2287 */
2288
2289 if (hostdata->connected == cmd) {
Finn Thain52a6a1c2014-03-18 11:42:18 +11002290 dprintk(NDEBUG_ABORT, "scsi%d : aborting connected command\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291/*
2292 * We should perform BSY checking, and make sure we haven't slipped
2293 * into BUS FREE.
2294 */
2295
2296 NCR5380_write(INITIATOR_COMMAND_REG, ICR_ASSERT_ATN);
2297/*
2298 * Since we can't change phases until we've completed the current
2299 * handshake, we have to source or sink a byte of data if the current
2300 * phase is not MSGOUT.
2301 */
2302
2303/*
2304 * Return control to the executing NCR drive so we can clear the
2305 * aborted flag and get back into our main loop.
2306 */
2307
Hannes Reineckeb6c92b72014-10-30 09:44:36 +01002308 return SUCCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 }
2310#endif
2311
2312/*
2313 * Case 2 : If the command hasn't been issued yet, we simply remove it
2314 * from the issue queue.
2315 */
2316
Finn Thain52a6a1c2014-03-18 11:42:18 +11002317 dprintk(NDEBUG_ABORT, "scsi%d : abort going into loop.\n", instance->host_no);
Finn Thain710ddd02014-11-12 16:12:02 +11002318 for (prev = (struct scsi_cmnd **) &(hostdata->issue_queue), tmp = (struct scsi_cmnd *) hostdata->issue_queue; tmp; prev = (struct scsi_cmnd **) &(tmp->host_scribble), tmp = (struct scsi_cmnd *) tmp->host_scribble)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 if (cmd == tmp) {
2320 REMOVE(5, *prev, tmp, tmp->host_scribble);
Finn Thain710ddd02014-11-12 16:12:02 +11002321 (*prev) = (struct scsi_cmnd *) tmp->host_scribble;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 tmp->host_scribble = NULL;
Finn Thain11d2f632016-01-03 16:05:51 +11002323 spin_unlock_irqrestore(&hostdata->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 tmp->result = DID_ABORT << 16;
Finn Thain52a6a1c2014-03-18 11:42:18 +11002325 dprintk(NDEBUG_ABORT, "scsi%d : abort removed command from issue queue.\n", instance->host_no);
Matthew Wilcoxcce99c62007-09-25 12:42:01 -04002326 tmp->scsi_done(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 return SUCCESS;
2328 }
2329#if (NDEBUG & NDEBUG_ABORT)
2330 /* KLL */
2331 else if (prev == tmp)
2332 printk(KERN_ERR "scsi%d : LOOP\n", instance->host_no);
2333#endif
2334
2335/*
2336 * Case 3 : If any commands are connected, we're going to fail the abort
2337 * and let the high level SCSI driver retry at a later time or
2338 * issue a reset.
2339 *
2340 * Timeouts, and therefore aborted commands, will be highly unlikely
2341 * and handling them cleanly in this situation would make the common
2342 * case of noresets less efficient, and would pollute our code. So,
2343 * we fail.
2344 */
2345
2346 if (hostdata->connected) {
Finn Thain11d2f632016-01-03 16:05:51 +11002347 spin_unlock_irqrestore(&hostdata->lock, flags);
Finn Thain52a6a1c2014-03-18 11:42:18 +11002348 dprintk(NDEBUG_ABORT, "scsi%d : abort failed, command connected.\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 return FAILED;
2350 }
2351/*
2352 * Case 4: If the command is currently disconnected from the bus, and
2353 * there are no connected commands, we reconnect the I_T_L or
2354 * I_T_L_Q nexus associated with it, go into message out, and send
2355 * an abort message.
2356 *
2357 * This case is especially ugly. In order to reestablish the nexus, we
2358 * need to call NCR5380_select(). The easiest way to implement this
2359 * function was to abort if the bus was busy, and let the interrupt
2360 * handler triggered on the SEL for reselect take care of lost arbitrations
2361 * where necessary, meaning interrupts need to be enabled.
2362 *
2363 * When interrupts are enabled, the queues may change - so we
2364 * can't remove it from the disconnected queue before selecting it
2365 * because that could cause a failure in hashing the nexus if that
2366 * device reselected.
2367 *
2368 * Since the queues may change, we can't use the pointers from when we
2369 * first locate it.
2370 *
2371 * So, we must first locate the command, and if NCR5380_select()
2372 * succeeds, then issue the abort, relocate the command and remove
2373 * it from the disconnected queue.
2374 */
2375
Finn Thain710ddd02014-11-12 16:12:02 +11002376 for (tmp = (struct scsi_cmnd *) hostdata->disconnected_queue; tmp; tmp = (struct scsi_cmnd *) tmp->host_scribble)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 if (cmd == tmp) {
Finn Thain52a6a1c2014-03-18 11:42:18 +11002378 dprintk(NDEBUG_ABORT, "scsi%d : aborting disconnected command.\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379
Finn Thain9dafbd92016-01-03 16:05:28 +11002380 if (NCR5380_select(instance, cmd)) {
Finn Thain11d2f632016-01-03 16:05:51 +11002381 spin_unlock_irq(&hostdata->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 return FAILED;
Finn Thain9dafbd92016-01-03 16:05:28 +11002383 }
Finn Thain52a6a1c2014-03-18 11:42:18 +11002384 dprintk(NDEBUG_ABORT, "scsi%d : nexus reestablished.\n", instance->host_no);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385
2386 do_abort(instance);
2387
Finn Thain710ddd02014-11-12 16:12:02 +11002388 for (prev = (struct scsi_cmnd **) &(hostdata->disconnected_queue), tmp = (struct scsi_cmnd *) hostdata->disconnected_queue; tmp; prev = (struct scsi_cmnd **) &(tmp->host_scribble), tmp = (struct scsi_cmnd *) tmp->host_scribble)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 if (cmd == tmp) {
2390 REMOVE(5, *prev, tmp, tmp->host_scribble);
Finn Thain710ddd02014-11-12 16:12:02 +11002391 *prev = (struct scsi_cmnd *) tmp->host_scribble;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 tmp->host_scribble = NULL;
Finn Thain11d2f632016-01-03 16:05:51 +11002393 spin_unlock_irqrestore(&hostdata->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 tmp->result = DID_ABORT << 16;
Matthew Wilcoxcce99c62007-09-25 12:42:01 -04002395 tmp->scsi_done(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 return SUCCESS;
2397 }
2398 }
2399/*
2400 * Case 5 : If we reached this point, the command was not found in any of
2401 * the queues.
2402 *
2403 * We probably reached this point because of an unlikely race condition
2404 * between the command completing successfully and the abortion code,
2405 * so we won't panic, but we will notify the user in case something really
2406 * broke.
2407 */
Finn Thain11d2f632016-01-03 16:05:51 +11002408 spin_unlock_irqrestore(&hostdata->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 printk(KERN_WARNING "scsi%d : warning : SCSI command probably completed successfully\n"
2410 " before abortion\n", instance->host_no);
2411 return FAILED;
2412}
2413
2414
Finn Thain3be1b3e2016-01-03 16:05:12 +11002415/**
2416 * NCR5380_bus_reset - reset the SCSI bus
2417 * @cmd: SCSI command undergoing EH
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 *
Finn Thain3be1b3e2016-01-03 16:05:12 +11002419 * Returns SUCCESS
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 */
2421
Finn Thain710ddd02014-11-12 16:12:02 +11002422static int NCR5380_bus_reset(struct scsi_cmnd *cmd)
Jeff Garzik 68b3aa72005-05-28 07:56:31 -04002423{
2424 struct Scsi_Host *instance = cmd->device->host;
Finn Thain11d2f632016-01-03 16:05:51 +11002425 struct NCR5380_hostdata *hostdata = shost_priv(instance);
2426 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427
Finn Thain11d2f632016-01-03 16:05:51 +11002428 spin_lock_irqsave(&hostdata->lock, flags);
Finn Thain3be1b3e2016-01-03 16:05:12 +11002429
2430#if (NDEBUG & NDEBUG_ANY)
2431 scmd_printk(KERN_INFO, cmd, "performing bus reset\n");
Finn Thain3be1b3e2016-01-03 16:05:12 +11002432#endif
Finn Thaine5c3fdd2016-01-03 16:05:52 +11002433 NCR5380_dprint(NDEBUG_ANY, instance);
2434 NCR5380_dprint_phase(NDEBUG_ANY, instance);
Finn Thain3be1b3e2016-01-03 16:05:12 +11002435
Jeff Garzik 68b3aa72005-05-28 07:56:31 -04002436 do_reset(instance);
Finn Thain3be1b3e2016-01-03 16:05:12 +11002437
Finn Thain11d2f632016-01-03 16:05:51 +11002438 spin_unlock_irqrestore(&hostdata->lock, flags);
Jeff Garzik 68b3aa72005-05-28 07:56:31 -04002439
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 return SUCCESS;
2441}