[PATCH] pcmcia: new suspend core
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / scsi / sun3_NCR5380.c
CommitLineData
1da177e4
LT
1/* sun3_NCR5380.c -- adapted from atari_NCR5380.c for the sun3 by
2 Sam Creasey. */
3/*
4 * NCR 5380 generic driver routines. These should make it *trivial*
5 * to implement 5380 SCSI drivers under Linux with a non-trantor
6 * architecture.
7 *
8 * Note that these routines also work with NR53c400 family chips.
9 *
10 * Copyright 1993, Drew Eckhardt
11 * Visionary Computing
12 * (Unix and Linux consulting and custom programming)
13 * drew@colorado.edu
14 * +1 (303) 666-5836
15 *
16 * DISTRIBUTION RELEASE 6.
17 *
18 * For more information, please consult
19 *
20 * NCR 5380 Family
21 * SCSI Protocol Controller
22 * Databook
23 *
24 * NCR Microelectronics
25 * 1635 Aeroplaza Drive
26 * Colorado Springs, CO 80916
27 * 1+ (719) 578-3400
28 * 1+ (800) 334-5454
29 */
30
31/*
32 * ++roman: To port the 5380 driver to the Atari, I had to do some changes in
33 * this file, too:
34 *
35 * - Some of the debug statements were incorrect (undefined variables and the
36 * like). I fixed that.
37 *
38 * - In information_transfer(), I think a #ifdef was wrong. Looking at the
39 * possible DMA transfer size should also happen for REAL_DMA. I added this
40 * in the #if statement.
41 *
42 * - When using real DMA, information_transfer() should return in a DATAOUT
43 * phase after starting the DMA. It has nothing more to do.
44 *
45 * - The interrupt service routine should run main after end of DMA, too (not
46 * only after RESELECTION interrupts). Additionally, it should _not_ test
47 * for more interrupts after running main, since a DMA process may have
48 * been started and interrupts are turned on now. The new int could happen
49 * inside the execution of NCR5380_intr(), leading to recursive
50 * calls.
51 *
52 * - I've added a function merge_contiguous_buffers() that tries to
53 * merge scatter-gather buffers that are located at contiguous
54 * physical addresses and can be processed with the same DMA setup.
55 * Since most scatter-gather operations work on a page (4K) of
56 * 4 buffers (1K), in more than 90% of all cases three interrupts and
57 * DMA setup actions are saved.
58 *
59 * - I've deleted all the stuff for AUTOPROBE_IRQ, REAL_DMA_POLL, PSEUDO_DMA
60 * and USLEEP, because these were messing up readability and will never be
61 * needed for Atari SCSI.
62 *
63 * - I've revised the NCR5380_main() calling scheme (relax the 'main_running'
64 * stuff), and 'main' is executed in a bottom half if awoken by an
65 * interrupt.
66 *
67 * - The code was quite cluttered up by "#if (NDEBUG & NDEBUG_*) printk..."
68 * constructs. In my eyes, this made the source rather unreadable, so I
69 * finally replaced that by the *_PRINTK() macros.
70 *
71 */
db9dff36 72#include <scsi/scsi_dbg.h>
1abfd370 73#include <scsi/scsi_transport_spi.h>
1da177e4
LT
74
75/*
76 * Further development / testing that should be done :
77 * 1. Test linked command handling code after Eric is ready with
78 * the high level code.
79 */
80
81#if (NDEBUG & NDEBUG_LISTS)
82#define LIST(x,y) \
83 { printk("LINE:%d Adding %p to %p\n", __LINE__, (void*)(x), (void*)(y)); \
84 if ((x)==(y)) udelay(5); }
85#define REMOVE(w,x,y,z) \
86 { printk("LINE:%d Removing: %p->%p %p->%p \n", __LINE__, \
87 (void*)(w), (void*)(x), (void*)(y), (void*)(z)); \
88 if ((x)==(y)) udelay(5); }
89#else
90#define LIST(x,y)
91#define REMOVE(w,x,y,z)
92#endif
93
94#ifndef notyet
95#undef LINKED
96#endif
97
98/*
99 * Design
100 * Issues :
101 *
102 * The other Linux SCSI drivers were written when Linux was Intel PC-only,
103 * and specifically for each board rather than each chip. This makes their
104 * adaptation to platforms like the Mac (Some of which use NCR5380's)
105 * more difficult than it has to be.
106 *
107 * Also, many of the SCSI drivers were written before the command queuing
108 * routines were implemented, meaning their implementations of queued
109 * commands were hacked on rather than designed in from the start.
110 *
111 * When I designed the Linux SCSI drivers I figured that
112 * while having two different SCSI boards in a system might be useful
113 * for debugging things, two of the same type wouldn't be used.
114 * Well, I was wrong and a number of users have mailed me about running
115 * multiple high-performance SCSI boards in a server.
116 *
117 * Finally, when I get questions from users, I have no idea what
118 * revision of my driver they are running.
119 *
120 * This driver attempts to address these problems :
121 * This is a generic 5380 driver. To use it on a different platform,
122 * one simply writes appropriate system specific macros (ie, data
123 * transfer - some PC's will use the I/O bus, 68K's must use
124 * memory mapped) and drops this file in their 'C' wrapper.
125 *
126 * As far as command queueing, two queues are maintained for
127 * each 5380 in the system - commands that haven't been issued yet,
128 * and commands that are currently executing. This means that an
129 * unlimited number of commands may be queued, letting
130 * more commands propagate from the higher driver levels giving higher
131 * throughput. Note that both I_T_L and I_T_L_Q nexuses are supported,
132 * allowing multiple commands to propagate all the way to a SCSI-II device
133 * while a command is already executing.
134 *
135 * To solve the multiple-boards-in-the-same-system problem,
136 * there is a separate instance structure for each instance
137 * of a 5380 in the system. So, multiple NCR5380 drivers will
138 * be able to coexist with appropriate changes to the high level
139 * SCSI code.
140 *
141 * A NCR5380_PUBLIC_REVISION macro is provided, with the release
142 * number (updated for each public release) printed by the
143 * NCR5380_print_options command, which should be called from the
144 * wrapper detect function, so that I know what release of the driver
145 * users are using.
146 *
147 * Issues specific to the NCR5380 :
148 *
149 * When used in a PIO or pseudo-dma mode, the NCR5380 is a braindead
150 * piece of hardware that requires you to sit in a loop polling for
151 * the REQ signal as long as you are connected. Some devices are
152 * brain dead (ie, many TEXEL CD ROM drives) and won't disconnect
153 * while doing long seek operations.
154 *
155 * The workaround for this is to keep track of devices that have
156 * disconnected. If the device hasn't disconnected, for commands that
157 * should disconnect, we do something like
158 *
159 * while (!REQ is asserted) { sleep for N usecs; poll for M usecs }
160 *
161 * Some tweaking of N and M needs to be done. An algorithm based
162 * on "time to data" would give the best results as long as short time
163 * to datas (ie, on the same track) were considered, however these
164 * broken devices are the exception rather than the rule and I'd rather
165 * spend my time optimizing for the normal case.
166 *
167 * Architecture :
168 *
169 * At the heart of the design is a coroutine, NCR5380_main,
170 * which is started when not running by the interrupt handler,
171 * timer, and queue command function. It attempts to establish
172 * I_T_L or I_T_L_Q nexuses by removing the commands from the
173 * issue queue and calling NCR5380_select() if a nexus
174 * is not established.
175 *
176 * Once a nexus is established, the NCR5380_information_transfer()
177 * phase goes through the various phases as instructed by the target.
178 * if the target goes into MSG IN and sends a DISCONNECT message,
179 * the command structure is placed into the per instance disconnected
180 * queue, and NCR5380_main tries to find more work. If USLEEP
181 * was defined, and the target is idle for too long, the system
182 * will try to sleep.
183 *
184 * If a command has disconnected, eventually an interrupt will trigger,
185 * calling NCR5380_intr() which will in turn call NCR5380_reselect
186 * to reestablish a nexus. This will run main if necessary.
187 *
188 * On command termination, the done function will be called as
189 * appropriate.
190 *
191 * SCSI pointers are maintained in the SCp field of SCSI command
192 * structures, being initialized after the command is connected
193 * in NCR5380_select, and set as appropriate in NCR5380_information_transfer.
194 * Note that in violation of the standard, an implicit SAVE POINTERS operation
195 * is done, since some BROKEN disks fail to issue an explicit SAVE POINTERS.
196 */
197
198/*
199 * Using this file :
200 * This file a skeleton Linux SCSI driver for the NCR 5380 series
201 * of chips. To use it, you write an architecture specific functions
202 * and macros and include this file in your driver.
203 *
204 * These macros control options :
205 * AUTOSENSE - if defined, REQUEST SENSE will be performed automatically
206 * for commands that return with a CHECK CONDITION status.
207 *
208 * LINKED - if defined, linked commands are supported.
209 *
210 * REAL_DMA - if defined, REAL DMA is used during the data transfer phases.
211 *
212 * SUPPORT_TAGS - if defined, SCSI-2 tagged queuing is used where possible
213 *
214 * These macros MUST be defined :
215 *
216 * NCR5380_read(register) - read from the specified register
217 *
218 * NCR5380_write(register, value) - write to the specific register
219 *
220 * Either real DMA *or* pseudo DMA may be implemented
221 * REAL functions :
222 * NCR5380_REAL_DMA should be defined if real DMA is to be used.
223 * Note that the DMA setup functions should return the number of bytes
224 * that they were able to program the controller for.
225 *
226 * Also note that generic i386/PC versions of these macros are
227 * available as NCR5380_i386_dma_write_setup,
228 * NCR5380_i386_dma_read_setup, and NCR5380_i386_dma_residual.
229 *
230 * NCR5380_dma_write_setup(instance, src, count) - initialize
231 * NCR5380_dma_read_setup(instance, dst, count) - initialize
232 * NCR5380_dma_residual(instance); - residual count
233 *
234 * PSEUDO functions :
235 * NCR5380_pwrite(instance, src, count)
236 * NCR5380_pread(instance, dst, count);
237 *
238 * If nothing specific to this implementation needs doing (ie, with external
239 * hardware), you must also define
240 *
241 * NCR5380_queue_command
242 * NCR5380_reset
243 * NCR5380_abort
244 * NCR5380_proc_info
245 *
246 * to be the global entry points into the specific driver, ie
247 * #define NCR5380_queue_command t128_queue_command.
248 *
249 * If this is not done, the routines will be defined as static functions
250 * with the NCR5380* names and the user must provide a globally
251 * accessible wrapper function.
252 *
253 * The generic driver is initialized by calling NCR5380_init(instance),
254 * after setting the appropriate host specific fields and ID. If the
255 * driver wishes to autoprobe for an IRQ line, the NCR5380_probe_irq(instance,
256 * possible) function may be used. Before the specific driver initialization
257 * code finishes, NCR5380_print_options should be called.
258 */
259
260static struct Scsi_Host *first_instance = NULL;
d0be4a7d 261static struct scsi_host_template *the_template = NULL;
1da177e4
LT
262
263/* Macros ease life... :-) */
264#define SETUP_HOSTDATA(in) \
265 struct NCR5380_hostdata *hostdata = \
266 (struct NCR5380_hostdata *)(in)->hostdata
267#define HOSTDATA(in) ((struct NCR5380_hostdata *)(in)->hostdata)
268
269#define NEXT(cmd) ((Scsi_Cmnd *)((cmd)->host_scribble))
270#define NEXTADDR(cmd) ((Scsi_Cmnd **)&((cmd)->host_scribble))
271
272#define HOSTNO instance->host_no
273#define H_NO(cmd) (cmd)->device->host->host_no
274
275#define SGADDR(buffer) (void *)(((unsigned long)page_address((buffer)->page)) + \
276 (buffer)->offset)
277
278#ifdef SUPPORT_TAGS
279
280/*
281 * Functions for handling tagged queuing
282 * =====================================
283 *
284 * ++roman (01/96): Now I've implemented SCSI-2 tagged queuing. Some notes:
285 *
286 * Using consecutive numbers for the tags is no good idea in my eyes. There
287 * could be wrong re-usings if the counter (8 bit!) wraps and some early
288 * command has been preempted for a long time. My solution: a bitfield for
289 * remembering used tags.
290 *
291 * There's also the problem that each target has a certain queue size, but we
292 * cannot know it in advance :-( We just see a QUEUE_FULL status being
293 * returned. So, in this case, the driver internal queue size assumption is
294 * reduced to the number of active tags if QUEUE_FULL is returned by the
295 * target. The command is returned to the mid-level, but with status changed
296 * to BUSY, since --as I've seen-- the mid-level can't handle QUEUE_FULL
297 * correctly.
298 *
299 * We're also not allowed running tagged commands as long as an untagged
300 * command is active. And REQUEST SENSE commands after a contingent allegiance
301 * condition _must_ be untagged. To keep track whether an untagged command has
302 * been issued, the host->busy array is still employed, as it is without
303 * support for tagged queuing.
304 *
305 * One could suspect that there are possible race conditions between
306 * is_lun_busy(), cmd_get_tag() and cmd_free_tag(). But I think this isn't the
307 * case: is_lun_busy() and cmd_get_tag() are both called from NCR5380_main(),
308 * which already guaranteed to be running at most once. It is also the only
309 * place where tags/LUNs are allocated. So no other allocation can slip
310 * between that pair, there could only happen a reselection, which can free a
311 * tag, but that doesn't hurt. Only the sequence in cmd_free_tag() becomes
312 * important: the tag bit must be cleared before 'nr_allocated' is decreased.
313 */
314
315/* -1 for TAG_NONE is not possible with unsigned char cmd->tag */
316#undef TAG_NONE
317#define TAG_NONE 0xff
318
319/* For the m68k, the number of bits in 'allocated' must be a multiple of 32! */
320#if (MAX_TAGS % 32) != 0
321#error "MAX_TAGS must be a multiple of 32!"
322#endif
323
324typedef struct {
325 char allocated[MAX_TAGS/8];
326 int nr_allocated;
327 int queue_size;
328} TAG_ALLOC;
329
330static TAG_ALLOC TagAlloc[8][8]; /* 8 targets and 8 LUNs */
331
332
333static void __init init_tags( void )
334{
335 int target, lun;
336 TAG_ALLOC *ta;
337
338 if (!setup_use_tagged_queuing)
339 return;
340
341 for( target = 0; target < 8; ++target ) {
342 for( lun = 0; lun < 8; ++lun ) {
343 ta = &TagAlloc[target][lun];
344 memset( &ta->allocated, 0, MAX_TAGS/8 );
345 ta->nr_allocated = 0;
346 /* At the beginning, assume the maximum queue size we could
347 * support (MAX_TAGS). This value will be decreased if the target
348 * returns QUEUE_FULL status.
349 */
350 ta->queue_size = MAX_TAGS;
351 }
352 }
353}
354
355
356/* Check if we can issue a command to this LUN: First see if the LUN is marked
357 * busy by an untagged command. If the command should use tagged queuing, also
358 * check that there is a free tag and the target's queue won't overflow. This
359 * function should be called with interrupts disabled to avoid race
360 * conditions.
361 */
362
363static int is_lun_busy( Scsi_Cmnd *cmd, int should_be_tagged )
364{
365 SETUP_HOSTDATA(cmd->device->host);
366
367 if (hostdata->busy[cmd->device->id] & (1 << cmd->device->lun))
368 return( 1 );
369 if (!should_be_tagged ||
370 !setup_use_tagged_queuing || !cmd->device->tagged_supported)
371 return( 0 );
372 if (TagAlloc[cmd->device->id][cmd->device->lun].nr_allocated >=
373 TagAlloc[cmd->device->id][cmd->device->lun].queue_size ) {
374 TAG_PRINTK( "scsi%d: target %d lun %d: no free tags\n",
375 H_NO(cmd), cmd->device->id, cmd->device->lun );
376 return( 1 );
377 }
378 return( 0 );
379}
380
381
382/* Allocate a tag for a command (there are no checks anymore, check_lun_busy()
383 * must be called before!), or reserve the LUN in 'busy' if the command is
384 * untagged.
385 */
386
387static void cmd_get_tag( Scsi_Cmnd *cmd, int should_be_tagged )
388{
389 SETUP_HOSTDATA(cmd->device->host);
390
391 /* If we or the target don't support tagged queuing, allocate the LUN for
392 * an untagged command.
393 */
394 if (!should_be_tagged ||
395 !setup_use_tagged_queuing || !cmd->device->tagged_supported) {
396 cmd->tag = TAG_NONE;
397 hostdata->busy[cmd->device->id] |= (1 << cmd->device->lun);
398 TAG_PRINTK( "scsi%d: target %d lun %d now allocated by untagged "
399 "command\n", H_NO(cmd), cmd->device->id, cmd->device->lun );
400 }
401 else {
402 TAG_ALLOC *ta = &TagAlloc[cmd->device->id][cmd->device->lun];
403
404 cmd->tag = find_first_zero_bit( &ta->allocated, MAX_TAGS );
405 set_bit( cmd->tag, &ta->allocated );
406 ta->nr_allocated++;
407 TAG_PRINTK( "scsi%d: using tag %d for target %d lun %d "
408 "(now %d tags in use)\n",
409 H_NO(cmd), cmd->tag, cmd->device->id, cmd->device->lun,
410 ta->nr_allocated );
411 }
412}
413
414
415/* Mark the tag of command 'cmd' as free, or in case of an untagged command,
416 * unlock the LUN.
417 */
418
419static void cmd_free_tag( Scsi_Cmnd *cmd )
420{
421 SETUP_HOSTDATA(cmd->device->host);
422
423 if (cmd->tag == TAG_NONE) {
424 hostdata->busy[cmd->device->id] &= ~(1 << cmd->device->lun);
425 TAG_PRINTK( "scsi%d: target %d lun %d untagged cmd finished\n",
426 H_NO(cmd), cmd->device->id, cmd->device->lun );
427 }
428 else if (cmd->tag >= MAX_TAGS) {
429 printk(KERN_NOTICE "scsi%d: trying to free bad tag %d!\n",
430 H_NO(cmd), cmd->tag );
431 }
432 else {
433 TAG_ALLOC *ta = &TagAlloc[cmd->device->id][cmd->device->lun];
434 clear_bit( cmd->tag, &ta->allocated );
435 ta->nr_allocated--;
436 TAG_PRINTK( "scsi%d: freed tag %d for target %d lun %d\n",
437 H_NO(cmd), cmd->tag, cmd->device->id, cmd->device->lun );
438 }
439}
440
441
442static void free_all_tags( void )
443{
444 int target, lun;
445 TAG_ALLOC *ta;
446
447 if (!setup_use_tagged_queuing)
448 return;
449
450 for( target = 0; target < 8; ++target ) {
451 for( lun = 0; lun < 8; ++lun ) {
452 ta = &TagAlloc[target][lun];
453 memset( &ta->allocated, 0, MAX_TAGS/8 );
454 ta->nr_allocated = 0;
455 }
456 }
457}
458
459#endif /* SUPPORT_TAGS */
460
461
462/*
463 * Function: void merge_contiguous_buffers( Scsi_Cmnd *cmd )
464 *
465 * Purpose: Try to merge several scatter-gather requests into one DMA
466 * transfer. This is possible if the scatter buffers lie on
467 * physical contiguous addresses.
468 *
469 * Parameters: Scsi_Cmnd *cmd
470 * The command to work on. The first scatter buffer's data are
471 * assumed to be already transfered into ptr/this_residual.
472 */
473
474static void merge_contiguous_buffers( Scsi_Cmnd *cmd )
475{
476 unsigned long endaddr;
477#if (NDEBUG & NDEBUG_MERGING)
478 unsigned long oldlen = cmd->SCp.this_residual;
479 int cnt = 1;
480#endif
481
482 for (endaddr = virt_to_phys(cmd->SCp.ptr + cmd->SCp.this_residual - 1) + 1;
483 cmd->SCp.buffers_residual &&
484 virt_to_phys(SGADDR(&(cmd->SCp.buffer[1]))) == endaddr; ) {
485
486 MER_PRINTK("VTOP(%p) == %08lx -> merging\n",
487 SGADDR(&(cmd->SCp.buffer[1])), endaddr);
488#if (NDEBUG & NDEBUG_MERGING)
489 ++cnt;
490#endif
491 ++cmd->SCp.buffer;
492 --cmd->SCp.buffers_residual;
493 cmd->SCp.this_residual += cmd->SCp.buffer->length;
494 endaddr += cmd->SCp.buffer->length;
495 }
496#if (NDEBUG & NDEBUG_MERGING)
497 if (oldlen != cmd->SCp.this_residual)
498 MER_PRINTK("merged %d buffers from %p, new length %08x\n",
499 cnt, cmd->SCp.ptr, cmd->SCp.this_residual);
500#endif
501}
502
503/*
504 * Function : void initialize_SCp(Scsi_Cmnd *cmd)
505 *
506 * Purpose : initialize the saved data pointers for cmd to point to the
507 * start of the buffer.
508 *
509 * Inputs : cmd - Scsi_Cmnd structure to have pointers reset.
510 */
511
512static __inline__ void initialize_SCp(Scsi_Cmnd *cmd)
513{
514 /*
515 * Initialize the Scsi Pointer field so that all of the commands in the
516 * various queues are valid.
517 */
518
519 if (cmd->use_sg) {
520 cmd->SCp.buffer = (struct scatterlist *) cmd->buffer;
521 cmd->SCp.buffers_residual = cmd->use_sg - 1;
522 cmd->SCp.ptr = (char *) SGADDR(cmd->SCp.buffer);
523 cmd->SCp.this_residual = cmd->SCp.buffer->length;
524
525 /* ++roman: Try to merge some scatter-buffers if they are at
526 * contiguous physical addresses.
527 */
528// merge_contiguous_buffers( cmd );
529 } else {
530 cmd->SCp.buffer = NULL;
531 cmd->SCp.buffers_residual = 0;
532 cmd->SCp.ptr = (char *) cmd->request_buffer;
533 cmd->SCp.this_residual = cmd->request_bufflen;
534 }
535
536}
537
538#include <linux/config.h>
539#include <linux/delay.h>
540
541#if 1
542static struct {
543 unsigned char mask;
544 const char * name;}
545signals[] = {{ SR_DBP, "PARITY"}, { SR_RST, "RST" }, { SR_BSY, "BSY" },
546 { SR_REQ, "REQ" }, { SR_MSG, "MSG" }, { SR_CD, "CD" }, { SR_IO, "IO" },
547 { SR_SEL, "SEL" }, {0, NULL}},
548basrs[] = {{BASR_ATN, "ATN"}, {BASR_ACK, "ACK"}, {0, NULL}},
549icrs[] = {{ICR_ASSERT_RST, "ASSERT RST"},{ICR_ASSERT_ACK, "ASSERT ACK"},
550 {ICR_ASSERT_BSY, "ASSERT BSY"}, {ICR_ASSERT_SEL, "ASSERT SEL"},
551 {ICR_ASSERT_ATN, "ASSERT ATN"}, {ICR_ASSERT_DATA, "ASSERT DATA"},
552 {0, NULL}},
553mrs[] = {{MR_BLOCK_DMA_MODE, "MODE BLOCK DMA"}, {MR_TARGET, "MODE TARGET"},
554 {MR_ENABLE_PAR_CHECK, "MODE PARITY CHECK"}, {MR_ENABLE_PAR_INTR,
555 "MODE PARITY INTR"}, {MR_ENABLE_EOP_INTR,"MODE EOP INTR"},
556 {MR_MONITOR_BSY, "MODE MONITOR BSY"},
557 {MR_DMA_MODE, "MODE DMA"}, {MR_ARBITRATE, "MODE ARBITRATION"},
558 {0, NULL}};
559
560/*
561 * Function : void NCR5380_print(struct Scsi_Host *instance)
562 *
563 * Purpose : print the SCSI bus signals for debugging purposes
564 *
565 * Input : instance - which NCR5380
566 */
567
568static void NCR5380_print(struct Scsi_Host *instance) {
569 unsigned char status, data, basr, mr, icr, i;
570 unsigned long flags;
571
572 local_irq_save(flags);
573 data = NCR5380_read(CURRENT_SCSI_DATA_REG);
574 status = NCR5380_read(STATUS_REG);
575 mr = NCR5380_read(MODE_REG);
576 icr = NCR5380_read(INITIATOR_COMMAND_REG);
577 basr = NCR5380_read(BUS_AND_STATUS_REG);
578 local_irq_restore(flags);
579 printk("STATUS_REG: %02x ", status);
580 for (i = 0; signals[i].mask ; ++i)
581 if (status & signals[i].mask)
582 printk(",%s", signals[i].name);
583 printk("\nBASR: %02x ", basr);
584 for (i = 0; basrs[i].mask ; ++i)
585 if (basr & basrs[i].mask)
586 printk(",%s", basrs[i].name);
587 printk("\nICR: %02x ", icr);
588 for (i = 0; icrs[i].mask; ++i)
589 if (icr & icrs[i].mask)
590 printk(",%s", icrs[i].name);
591 printk("\nMODE: %02x ", mr);
592 for (i = 0; mrs[i].mask; ++i)
593 if (mr & mrs[i].mask)
594 printk(",%s", mrs[i].name);
595 printk("\n");
596}
597
598static struct {
599 unsigned char value;
600 const char *name;
601} phases[] = {
602 {PHASE_DATAOUT, "DATAOUT"}, {PHASE_DATAIN, "DATAIN"}, {PHASE_CMDOUT, "CMDOUT"},
603 {PHASE_STATIN, "STATIN"}, {PHASE_MSGOUT, "MSGOUT"}, {PHASE_MSGIN, "MSGIN"},
604 {PHASE_UNKNOWN, "UNKNOWN"}};
605
606/*
607 * Function : void NCR5380_print_phase(struct Scsi_Host *instance)
608 *
609 * Purpose : print the current SCSI phase for debugging purposes
610 *
611 * Input : instance - which NCR5380
612 */
613
614static void NCR5380_print_phase(struct Scsi_Host *instance)
615{
616 unsigned char status;
617 int i;
618
619 status = NCR5380_read(STATUS_REG);
620 if (!(status & SR_REQ))
621 printk(KERN_DEBUG "scsi%d: REQ not asserted, phase unknown.\n", HOSTNO);
622 else {
623 for (i = 0; (phases[i].value != PHASE_UNKNOWN) &&
624 (phases[i].value != (status & PHASE_MASK)); ++i);
625 printk(KERN_DEBUG "scsi%d: phase %s\n", HOSTNO, phases[i].name);
626 }
627}
628
629#else /* !NDEBUG */
630
631/* dummies... */
632__inline__ void NCR5380_print(struct Scsi_Host *instance) { };
633__inline__ void NCR5380_print_phase(struct Scsi_Host *instance) { };
634
635#endif
636
637/*
638 * ++roman: New scheme of calling NCR5380_main()
639 *
640 * If we're not in an interrupt, we can call our main directly, it cannot be
641 * already running. Else, we queue it on a task queue, if not 'main_running'
642 * tells us that a lower level is already executing it. This way,
643 * 'main_running' needs not be protected in a special way.
644 *
645 * queue_main() is a utility function for putting our main onto the task
646 * queue, if main_running is false. It should be called only from a
647 * interrupt or bottom half.
648 */
649
650#include <linux/workqueue.h>
651#include <linux/interrupt.h>
652
653static volatile int main_running = 0;
654static DECLARE_WORK(NCR5380_tqueue, (void (*)(void*))NCR5380_main, NULL);
655
656static __inline__ void queue_main(void)
657{
658 if (!main_running) {
659 /* If in interrupt and NCR5380_main() not already running,
660 queue it on the 'immediate' task queue, to be processed
661 immediately after the current interrupt processing has
662 finished. */
663 schedule_work(&NCR5380_tqueue);
664 }
665 /* else: nothing to do: the running NCR5380_main() will pick up
666 any newly queued command. */
667}
668
669
670static inline void NCR5380_all_init (void)
671{
672 static int done = 0;
673 if (!done) {
674 INI_PRINTK("scsi : NCR5380_all_init()\n");
675 done = 1;
676 }
677}
678
679
680/*
681 * Function : void NCR58380_print_options (struct Scsi_Host *instance)
682 *
683 * Purpose : called by probe code indicating the NCR5380 driver
684 * options that were selected.
685 *
686 * Inputs : instance, pointer to this instance. Unused.
687 */
688
689static void __init NCR5380_print_options (struct Scsi_Host *instance)
690{
691 printk(" generic options"
692#ifdef AUTOSENSE
693 " AUTOSENSE"
694#endif
695#ifdef REAL_DMA
696 " REAL DMA"
697#endif
698#ifdef PARITY
699 " PARITY"
700#endif
701#ifdef SUPPORT_TAGS
702 " SCSI-2 TAGGED QUEUING"
703#endif
704 );
705 printk(" generic release=%d", NCR5380_PUBLIC_RELEASE);
706}
707
708/*
709 * Function : void NCR5380_print_status (struct Scsi_Host *instance)
710 *
711 * Purpose : print commands in the various queues, called from
712 * NCR5380_abort and NCR5380_debug to aid debugging.
713 *
714 * Inputs : instance, pointer to this instance.
715 */
716
717static void NCR5380_print_status (struct Scsi_Host *instance)
718{
719 char *pr_bfr;
720 char *start;
721 int len;
722
723 NCR_PRINT(NDEBUG_ANY);
724 NCR_PRINT_PHASE(NDEBUG_ANY);
725
726 pr_bfr = (char *) __get_free_page(GFP_ATOMIC);
727 if (!pr_bfr) {
728 printk("NCR5380_print_status: no memory for print buffer\n");
729 return;
730 }
731 len = NCR5380_proc_info(instance, pr_bfr, &start, 0, PAGE_SIZE, 0);
732 pr_bfr[len] = 0;
733 printk("\n%s\n", pr_bfr);
734 free_page((unsigned long) pr_bfr);
735}
736
737
738/******************************************/
739/*
740 * /proc/scsi/[dtc pas16 t128 generic]/[0-ASC_NUM_BOARD_SUPPORTED]
741 *
742 * *buffer: I/O buffer
743 * **start: if inout == FALSE pointer into buffer where user read should start
744 * offset: current offset
745 * length: length of buffer
746 * hostno: Scsi_Host host_no
747 * inout: TRUE - user is writing; FALSE - user is reading
748 *
749 * Return the number of bytes read from or written
750*/
751
752#undef SPRINTF
753#define SPRINTF(fmt,args...) \
754 do { if (pos + strlen(fmt) + 20 /* slop */ < buffer + length) \
755 pos += sprintf(pos, fmt , ## args); } while(0)
756static
757char *lprint_Scsi_Cmnd (Scsi_Cmnd *cmd, char *pos, char *buffer, int length);
758
759static int NCR5380_proc_info (struct Scsi_Host *instance, char *buffer, char **start,
760 off_t offset, int length, int inout)
761{
762 char *pos = buffer;
763 struct NCR5380_hostdata *hostdata;
764 Scsi_Cmnd *ptr;
765 unsigned long flags;
766 off_t begin = 0;
767#define check_offset() \
768 do { \
769 if (pos - buffer < offset - begin) { \
770 begin += pos - buffer; \
771 pos = buffer; \
772 } \
773 } while (0)
774
775 hostdata = (struct NCR5380_hostdata *)instance->hostdata;
776
777 if (inout) { /* Has data been written to the file ? */
778 return(-ENOSYS); /* Currently this is a no-op */
779 }
780 SPRINTF("NCR5380 core release=%d.\n", NCR5380_PUBLIC_RELEASE);
781 check_offset();
782 local_irq_save(flags);
783 SPRINTF("NCR5380: coroutine is%s running.\n", main_running ? "" : "n't");
784 check_offset();
785 if (!hostdata->connected)
786 SPRINTF("scsi%d: no currently connected command\n", HOSTNO);
787 else
788 pos = lprint_Scsi_Cmnd ((Scsi_Cmnd *) hostdata->connected,
789 pos, buffer, length);
790 SPRINTF("scsi%d: issue_queue\n", HOSTNO);
791 check_offset();
792 for (ptr = (Scsi_Cmnd *) hostdata->issue_queue; ptr; ptr = NEXT(ptr)) {
793 pos = lprint_Scsi_Cmnd (ptr, pos, buffer, length);
794 check_offset();
795 }
796
797 SPRINTF("scsi%d: disconnected_queue\n", HOSTNO);
798 check_offset();
799 for (ptr = (Scsi_Cmnd *) hostdata->disconnected_queue; ptr;
800 ptr = NEXT(ptr)) {
801 pos = lprint_Scsi_Cmnd (ptr, pos, buffer, length);
802 check_offset();
803 }
804
805 local_irq_restore(flags);
806 *start = buffer + (offset - begin);
807 if (pos - buffer < offset - begin)
808 return 0;
809 else if (pos - buffer - (offset - begin) < length)
810 return pos - buffer - (offset - begin);
811 return length;
812}
813
814static char *
815lprint_Scsi_Cmnd (Scsi_Cmnd *cmd, char *pos, char *buffer, int length)
816{
817 int i, s;
818 unsigned char *command;
819 SPRINTF("scsi%d: destination target %d, lun %d\n",
820 H_NO(cmd), cmd->device->id, cmd->device->lun);
821 SPRINTF(" command = ");
822 command = cmd->cmnd;
823 SPRINTF("%2d (0x%02x)", command[0], command[0]);
824 for (i = 1, s = COMMAND_SIZE(command[0]); i < s; ++i)
825 SPRINTF(" %02x", command[i]);
826 SPRINTF("\n");
827 return pos;
828}
829
830
831/*
832 * Function : void NCR5380_init (struct Scsi_Host *instance)
833 *
834 * Purpose : initializes *instance and corresponding 5380 chip.
835 *
836 * Inputs : instance - instantiation of the 5380 driver.
837 *
838 * Notes : I assume that the host, hostno, and id bits have been
839 * set correctly. I don't care about the irq and other fields.
840 *
841 */
842
843static int NCR5380_init (struct Scsi_Host *instance, int flags)
844{
845 int i;
846 SETUP_HOSTDATA(instance);
847
848 NCR5380_all_init();
849
850 hostdata->aborted = 0;
851 hostdata->id_mask = 1 << instance->this_id;
852 hostdata->id_higher_mask = 0;
853 for (i = hostdata->id_mask; i <= 0x80; i <<= 1)
854 if (i > hostdata->id_mask)
855 hostdata->id_higher_mask |= i;
856 for (i = 0; i < 8; ++i)
857 hostdata->busy[i] = 0;
858#ifdef SUPPORT_TAGS
859 init_tags();
860#endif
861#if defined (REAL_DMA)
862 hostdata->dma_len = 0;
863#endif
864 hostdata->targets_present = 0;
865 hostdata->connected = NULL;
866 hostdata->issue_queue = NULL;
867 hostdata->disconnected_queue = NULL;
868 hostdata->flags = FLAG_CHECK_LAST_BYTE_SENT;
869
870 if (!the_template) {
871 the_template = instance->hostt;
872 first_instance = instance;
873 }
874
875
876#ifndef AUTOSENSE
877 if ((instance->cmd_per_lun > 1) || (instance->can_queue > 1))
878 printk("scsi%d: WARNING : support for multiple outstanding commands enabled\n"
879 " without AUTOSENSE option, contingent allegiance conditions may\n"
880 " be incorrectly cleared.\n", HOSTNO);
881#endif /* def AUTOSENSE */
882
883 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
884 NCR5380_write(MODE_REG, MR_BASE);
885 NCR5380_write(TARGET_COMMAND_REG, 0);
886 NCR5380_write(SELECT_ENABLE_REG, 0);
887
888 return 0;
889}
890
891/*
892 * Function : int NCR5380_queue_command (Scsi_Cmnd *cmd,
893 * void (*done)(Scsi_Cmnd *))
894 *
895 * Purpose : enqueues a SCSI command
896 *
897 * Inputs : cmd - SCSI command, done - function called on completion, with
898 * a pointer to the command descriptor.
899 *
900 * Returns : 0
901 *
902 * Side effects :
903 * cmd is added to the per instance issue_queue, with minor
904 * twiddling done to the host specific fields of cmd. If the
905 * main coroutine is not running, it is restarted.
906 *
907 */
908
909/* Only make static if a wrapper function is used */
910static int NCR5380_queue_command (Scsi_Cmnd *cmd, void (*done)(Scsi_Cmnd *))
911{
912 SETUP_HOSTDATA(cmd->device->host);
913 Scsi_Cmnd *tmp;
914 unsigned long flags;
915
916#if (NDEBUG & NDEBUG_NO_WRITE)
917 switch (cmd->cmnd[0]) {
918 case WRITE_6:
919 case WRITE_10:
920 printk(KERN_NOTICE "scsi%d: WRITE attempted with NO_WRITE debugging flag set\n",
921 H_NO(cmd));
922 cmd->result = (DID_ERROR << 16);
923 done(cmd);
924 return 0;
925 }
926#endif /* (NDEBUG & NDEBUG_NO_WRITE) */
927
928
929#ifdef NCR5380_STATS
930# if 0
931 if (!hostdata->connected && !hostdata->issue_queue &&
932 !hostdata->disconnected_queue) {
933 hostdata->timebase = jiffies;
934 }
935# endif
936# ifdef NCR5380_STAT_LIMIT
937 if (cmd->request_bufflen > NCR5380_STAT_LIMIT)
938# endif
939 switch (cmd->cmnd[0])
940 {
941 case WRITE:
942 case WRITE_6:
943 case WRITE_10:
944 hostdata->time_write[cmd->device->id] -= (jiffies - hostdata->timebase);
945 hostdata->bytes_write[cmd->device->id] += cmd->request_bufflen;
946 hostdata->pendingw++;
947 break;
948 case READ:
949 case READ_6:
950 case READ_10:
951 hostdata->time_read[cmd->device->id] -= (jiffies - hostdata->timebase);
952 hostdata->bytes_read[cmd->device->id] += cmd->request_bufflen;
953 hostdata->pendingr++;
954 break;
955 }
956#endif
957
958 /*
959 * We use the host_scribble field as a pointer to the next command
960 * in a queue
961 */
962
963 NEXT(cmd) = NULL;
964 cmd->scsi_done = done;
965
966 cmd->result = 0;
967
968
969 /*
970 * Insert the cmd into the issue queue. Note that REQUEST SENSE
971 * commands are added to the head of the queue since any command will
972 * clear the contingent allegiance condition that exists and the
973 * sense data is only guaranteed to be valid while the condition exists.
974 */
975
976 local_irq_save(flags);
977 /* ++guenther: now that the issue queue is being set up, we can lock ST-DMA.
978 * Otherwise a running NCR5380_main may steal the lock.
979 * Lock before actually inserting due to fairness reasons explained in
980 * atari_scsi.c. If we insert first, then it's impossible for this driver
981 * to release the lock.
982 * Stop timer for this command while waiting for the lock, or timeouts
983 * may happen (and they really do), and it's no good if the command doesn't
984 * appear in any of the queues.
985 * ++roman: Just disabling the NCR interrupt isn't sufficient here,
986 * because also a timer int can trigger an abort or reset, which would
987 * alter queues and touch the lock.
988 */
989 if (!(hostdata->issue_queue) || (cmd->cmnd[0] == REQUEST_SENSE)) {
990 LIST(cmd, hostdata->issue_queue);
991 NEXT(cmd) = hostdata->issue_queue;
992 hostdata->issue_queue = cmd;
993 } else {
994 for (tmp = (Scsi_Cmnd *)hostdata->issue_queue;
995 NEXT(tmp); tmp = NEXT(tmp))
996 ;
997 LIST(cmd, tmp);
998 NEXT(tmp) = cmd;
999 }
1000
1001 local_irq_restore(flags);
1002
1003 QU_PRINTK("scsi%d: command added to %s of queue\n", H_NO(cmd),
1004 (cmd->cmnd[0] == REQUEST_SENSE) ? "head" : "tail");
1005
1006 /* If queue_command() is called from an interrupt (real one or bottom
1007 * half), we let queue_main() do the job of taking care about main. If it
1008 * is already running, this is a no-op, else main will be queued.
1009 *
1010 * If we're not in an interrupt, we can call NCR5380_main()
1011 * unconditionally, because it cannot be already running.
1012 */
1013 if (in_interrupt() || ((flags >> 8) & 7) >= 6)
1014 queue_main();
1015 else
1016 NCR5380_main(NULL);
1017 return 0;
1018}
1019
1020/*
1021 * Function : NCR5380_main (void)
1022 *
1023 * Purpose : NCR5380_main is a coroutine that runs as long as more work can
1024 * be done on the NCR5380 host adapters in a system. Both
1025 * NCR5380_queue_command() and NCR5380_intr() will try to start it
1026 * in case it is not running.
1027 *
1028 * NOTE : NCR5380_main exits with interrupts *disabled*, the caller should
1029 * reenable them. This prevents reentrancy and kernel stack overflow.
1030 */
1031
1032static void NCR5380_main (void *bl)
1033{
1034 Scsi_Cmnd *tmp, *prev;
1035 struct Scsi_Host *instance = first_instance;
1036 struct NCR5380_hostdata *hostdata = HOSTDATA(instance);
1037 int done;
1038 unsigned long flags;
1039
1040 /*
1041 * We run (with interrupts disabled) until we're sure that none of
1042 * the host adapters have anything that can be done, at which point
1043 * we set main_running to 0 and exit.
1044 *
1045 * Interrupts are enabled before doing various other internal
1046 * instructions, after we've decided that we need to run through
1047 * the loop again.
1048 *
1049 * this should prevent any race conditions.
1050 *
1051 * ++roman: Just disabling the NCR interrupt isn't sufficient here,
1052 * because also a timer int can trigger an abort or reset, which can
1053 * alter queues and touch the Falcon lock.
1054 */
1055
1056 /* Tell int handlers main() is now already executing. Note that
1057 no races are possible here. If an int comes in before
1058 'main_running' is set here, and queues/executes main via the
1059 task queue, it doesn't do any harm, just this instance of main
1060 won't find any work left to do. */
1061 if (main_running)
1062 return;
1063 main_running = 1;
1064
1065 local_save_flags(flags);
1066 do {
1067 local_irq_disable(); /* Freeze request queues */
1068 done = 1;
1069
1070 if (!hostdata->connected) {
1071 MAIN_PRINTK( "scsi%d: not connected\n", HOSTNO );
1072 /*
1073 * Search through the issue_queue for a command destined
1074 * for a target that's not busy.
1075 */
1076#if (NDEBUG & NDEBUG_LISTS)
1077 for (tmp = (Scsi_Cmnd *) hostdata->issue_queue, prev = NULL;
1078 tmp && (tmp != prev); prev = tmp, tmp = NEXT(tmp))
1079 ;
1080 if ((tmp == prev) && tmp) printk(" LOOP\n");/* else printk("\n");*/
1081#endif
1082 for (tmp = (Scsi_Cmnd *) hostdata->issue_queue,
1083 prev = NULL; tmp; prev = tmp, tmp = NEXT(tmp) ) {
1084
1085#if (NDEBUG & NDEBUG_LISTS)
1086 if (prev != tmp)
1087 printk("MAIN tmp=%p target=%d busy=%d lun=%d\n",
1088 tmp, tmp->target, hostdata->busy[tmp->target],
1089 tmp->lun);
1090#endif
1091 /* When we find one, remove it from the issue queue. */
1092 /* ++guenther: possible race with Falcon locking */
1093 if (
1094#ifdef SUPPORT_TAGS
1095 !is_lun_busy( tmp, tmp->cmnd[0] != REQUEST_SENSE)
1096#else
1097 !(hostdata->busy[tmp->device->id] & (1 << tmp->device->lun))
1098#endif
1099 ) {
1100 /* ++guenther: just to be sure, this must be atomic */
1101 local_irq_disable();
1102 if (prev) {
1103 REMOVE(prev, NEXT(prev), tmp, NEXT(tmp));
1104 NEXT(prev) = NEXT(tmp);
1105 } else {
1106 REMOVE(-1, hostdata->issue_queue, tmp, NEXT(tmp));
1107 hostdata->issue_queue = NEXT(tmp);
1108 }
1109 NEXT(tmp) = NULL;
1110
1111 /* reenable interrupts after finding one */
1112 local_irq_restore(flags);
1113
1114 /*
1115 * Attempt to establish an I_T_L nexus here.
1116 * On success, instance->hostdata->connected is set.
1117 * On failure, we must add the command back to the
1118 * issue queue so we can keep trying.
1119 */
1120 MAIN_PRINTK("scsi%d: main(): command for target %d "
1121 "lun %d removed from issue_queue\n",
1122 HOSTNO, tmp->target, tmp->lun);
1123 /*
1124 * REQUEST SENSE commands are issued without tagged
1125 * queueing, even on SCSI-II devices because the
1126 * contingent allegiance condition exists for the
1127 * entire unit.
1128 */
1129 /* ++roman: ...and the standard also requires that
1130 * REQUEST SENSE command are untagged.
1131 */
1132
1133#ifdef SUPPORT_TAGS
1134 cmd_get_tag( tmp, tmp->cmnd[0] != REQUEST_SENSE );
1135#endif
1136 if (!NCR5380_select(instance, tmp,
1137 (tmp->cmnd[0] == REQUEST_SENSE) ? TAG_NONE :
1138 TAG_NEXT)) {
1139 break;
1140 } else {
1141 local_irq_disable();
1142 LIST(tmp, hostdata->issue_queue);
1143 NEXT(tmp) = hostdata->issue_queue;
1144 hostdata->issue_queue = tmp;
1145#ifdef SUPPORT_TAGS
1146 cmd_free_tag( tmp );
1147#endif
1148 local_irq_restore(flags);
1149 MAIN_PRINTK("scsi%d: main(): select() failed, "
1150 "returned to issue_queue\n", HOSTNO);
1151 if (hostdata->connected)
1152 break;
1153 }
1154 } /* if target/lun/target queue is not busy */
1155 } /* for issue_queue */
1156 } /* if (!hostdata->connected) */
1157 if (hostdata->connected
1158#ifdef REAL_DMA
1159 && !hostdata->dma_len
1160#endif
1161 ) {
1162 local_irq_restore(flags);
1163 MAIN_PRINTK("scsi%d: main: performing information transfer\n",
1164 HOSTNO);
1165 NCR5380_information_transfer(instance);
1166 MAIN_PRINTK("scsi%d: main: done set false\n", HOSTNO);
1167 done = 0;
1168 }
1169 } while (!done);
1170
1171 /* Better allow ints _after_ 'main_running' has been cleared, else
1172 an interrupt could believe we'll pick up the work it left for
1173 us, but we won't see it anymore here... */
1174 main_running = 0;
1175 local_irq_restore(flags);
1176}
1177
1178
1179#ifdef REAL_DMA
1180/*
1181 * Function : void NCR5380_dma_complete (struct Scsi_Host *instance)
1182 *
1183 * Purpose : Called by interrupt handler when DMA finishes or a phase
1184 * mismatch occurs (which would finish the DMA transfer).
1185 *
1186 * Inputs : instance - this instance of the NCR5380.
1187 *
1188 */
1189
1190static void NCR5380_dma_complete( struct Scsi_Host *instance )
1191{
1192 SETUP_HOSTDATA(instance);
1193 int transfered;
1194 unsigned char **data;
1195 volatile int *count;
1196
1197 if (!hostdata->connected) {
1198 printk(KERN_WARNING "scsi%d: received end of DMA interrupt with "
1199 "no connected cmd\n", HOSTNO);
1200 return;
1201 }
1202
1203 DMA_PRINTK("scsi%d: real DMA transfer complete, basr 0x%X, sr 0x%X\n",
1204 HOSTNO, NCR5380_read(BUS_AND_STATUS_REG),
1205 NCR5380_read(STATUS_REG));
1206
1207 if((sun3scsi_dma_finish(rq_data_dir(hostdata->connected->request)))) {
1208 printk("scsi%d: overrun in UDC counter -- not prepared to deal with this!\n", HOSTNO);
1209 printk("please e-mail sammy@sammy.net with a description of how this\n");
1210 printk("error was produced.\n");
1211 BUG();
1212 }
1213
1214 /* make sure we're not stuck in a data phase */
1215 if((NCR5380_read(BUS_AND_STATUS_REG) & (BASR_PHASE_MATCH |
1216 BASR_ACK)) ==
1217 (BASR_PHASE_MATCH | BASR_ACK)) {
1218 printk("scsi%d: BASR %02x\n", HOSTNO, NCR5380_read(BUS_AND_STATUS_REG));
1219 printk("scsi%d: bus stuck in data phase -- probably a single byte "
1220 "overrun!\n", HOSTNO);
1221 printk("not prepared for this error!\n");
1222 printk("please e-mail sammy@sammy.net with a description of how this\n");
1223 printk("error was produced.\n");
1224 BUG();
1225 }
1226
1227
1228
1229 (void) NCR5380_read(RESET_PARITY_INTERRUPT_REG);
1230 NCR5380_write(MODE_REG, MR_BASE);
1231 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1232
1233 transfered = hostdata->dma_len - NCR5380_dma_residual(instance);
1234 hostdata->dma_len = 0;
1235
1236 data = (unsigned char **) &(hostdata->connected->SCp.ptr);
1237 count = &(hostdata->connected->SCp.this_residual);
1238 *data += transfered;
1239 *count -= transfered;
1240
1241}
1242#endif /* REAL_DMA */
1243
1244
1245/*
1246 * Function : void NCR5380_intr (int irq)
1247 *
1248 * Purpose : handle interrupts, reestablishing I_T_L or I_T_L_Q nexuses
1249 * from the disconnected queue, and restarting NCR5380_main()
1250 * as required.
1251 *
1252 * Inputs : int irq, irq that caused this interrupt.
1253 *
1254 */
1255
1256static irqreturn_t NCR5380_intr (int irq, void *dev_id, struct pt_regs *regs)
1257{
1258 struct Scsi_Host *instance = first_instance;
1259 int done = 1, handled = 0;
1260 unsigned char basr;
1261
1262 INT_PRINTK("scsi%d: NCR5380 irq triggered\n", HOSTNO);
1263
1264 /* Look for pending interrupts */
1265 basr = NCR5380_read(BUS_AND_STATUS_REG);
1266 INT_PRINTK("scsi%d: BASR=%02x\n", HOSTNO, basr);
1267 /* dispatch to appropriate routine if found and done=0 */
1268 if (basr & BASR_IRQ) {
1269 NCR_PRINT(NDEBUG_INTR);
1270 if ((NCR5380_read(STATUS_REG) & (SR_SEL|SR_IO)) == (SR_SEL|SR_IO)) {
1271 done = 0;
1272 ENABLE_IRQ();
1273 INT_PRINTK("scsi%d: SEL interrupt\n", HOSTNO);
1274 NCR5380_reselect(instance);
1275 (void) NCR5380_read(RESET_PARITY_INTERRUPT_REG);
1276 }
1277 else if (basr & BASR_PARITY_ERROR) {
1278 INT_PRINTK("scsi%d: PARITY interrupt\n", HOSTNO);
1279 (void) NCR5380_read(RESET_PARITY_INTERRUPT_REG);
1280 }
1281 else if ((NCR5380_read(STATUS_REG) & SR_RST) == SR_RST) {
1282 INT_PRINTK("scsi%d: RESET interrupt\n", HOSTNO);
1283 (void)NCR5380_read(RESET_PARITY_INTERRUPT_REG);
1284 }
1285 else {
1286 /*
1287 * The rest of the interrupt conditions can occur only during a
1288 * DMA transfer
1289 */
1290
1291#if defined(REAL_DMA)
1292 /*
1293 * We should only get PHASE MISMATCH and EOP interrupts if we have
1294 * DMA enabled, so do a sanity check based on the current setting
1295 * of the MODE register.
1296 */
1297
1298 if ((NCR5380_read(MODE_REG) & MR_DMA_MODE) &&
1299 ((basr & BASR_END_DMA_TRANSFER) ||
1300 !(basr & BASR_PHASE_MATCH))) {
1301
1302 INT_PRINTK("scsi%d: PHASE MISM or EOP interrupt\n", HOSTNO);
1303 NCR5380_dma_complete( instance );
1304 done = 0;
1305 ENABLE_IRQ();
1306 } else
1307#endif /* REAL_DMA */
1308 {
1309/* MS: Ignore unknown phase mismatch interrupts (caused by EOP interrupt) */
1310 if (basr & BASR_PHASE_MATCH)
1311 INT_PRINTK("scsi%d: unknown interrupt, "
1312 "BASR 0x%x, MR 0x%x, SR 0x%x\n",
1313 HOSTNO, basr, NCR5380_read(MODE_REG),
1314 NCR5380_read(STATUS_REG));
1315 (void) NCR5380_read(RESET_PARITY_INTERRUPT_REG);
1316#ifdef SUN3_SCSI_VME
1317 dregs->csr |= CSR_DMA_ENABLE;
1318#endif
1319 }
1320 } /* if !(SELECTION || PARITY) */
1321 handled = 1;
1322 } /* BASR & IRQ */
1323 else {
1324
1325 printk(KERN_NOTICE "scsi%d: interrupt without IRQ bit set in BASR, "
1326 "BASR 0x%X, MR 0x%X, SR 0x%x\n", HOSTNO, basr,
1327 NCR5380_read(MODE_REG), NCR5380_read(STATUS_REG));
1328 (void) NCR5380_read(RESET_PARITY_INTERRUPT_REG);
1329#ifdef SUN3_SCSI_VME
1330 dregs->csr |= CSR_DMA_ENABLE;
1331#endif
1332 }
1333
1334 if (!done) {
1335 INT_PRINTK("scsi%d: in int routine, calling main\n", HOSTNO);
1336 /* Put a call to NCR5380_main() on the queue... */
1337 queue_main();
1338 }
1339 return IRQ_RETVAL(handled);
1340}
1341
1342#ifdef NCR5380_STATS
1343static void collect_stats(struct NCR5380_hostdata* hostdata, Scsi_Cmnd* cmd)
1344{
1345# ifdef NCR5380_STAT_LIMIT
1346 if (cmd->request_bufflen > NCR5380_STAT_LIMIT)
1347# endif
1348 switch (cmd->cmnd[0])
1349 {
1350 case WRITE:
1351 case WRITE_6:
1352 case WRITE_10:
1353 hostdata->time_write[cmd->device->id] += (jiffies - hostdata->timebase);
1354 /*hostdata->bytes_write[cmd->device->id] += cmd->request_bufflen;*/
1355 hostdata->pendingw--;
1356 break;
1357 case READ:
1358 case READ_6:
1359 case READ_10:
1360 hostdata->time_read[cmd->device->id] += (jiffies - hostdata->timebase);
1361 /*hostdata->bytes_read[cmd->device->id] += cmd->request_bufflen;*/
1362 hostdata->pendingr--;
1363 break;
1364 }
1365}
1366#endif
1367
1368/*
1369 * Function : int NCR5380_select (struct Scsi_Host *instance, Scsi_Cmnd *cmd,
1370 * int tag);
1371 *
1372 * Purpose : establishes I_T_L or I_T_L_Q nexus for new or existing command,
1373 * including ARBITRATION, SELECTION, and initial message out for
1374 * IDENTIFY and queue messages.
1375 *
1376 * Inputs : instance - instantiation of the 5380 driver on which this
1377 * target lives, cmd - SCSI command to execute, tag - set to TAG_NEXT for
1378 * new tag, TAG_NONE for untagged queueing, otherwise set to the tag for
1379 * the command that is presently connected.
1380 *
1381 * Returns : -1 if selection could not execute for some reason,
1382 * 0 if selection succeeded or failed because the target
1383 * did not respond.
1384 *
1385 * Side effects :
1386 * If bus busy, arbitration failed, etc, NCR5380_select() will exit
1387 * with registers as they should have been on entry - ie
1388 * SELECT_ENABLE will be set appropriately, the NCR5380
1389 * will cease to drive any SCSI bus signals.
1390 *
1391 * If successful : I_T_L or I_T_L_Q nexus will be established,
1392 * instance->connected will be set to cmd.
1393 * SELECT interrupt will be disabled.
1394 *
1395 * If failed (no target) : cmd->scsi_done() will be called, and the
1396 * cmd->result host byte set to DID_BAD_TARGET.
1397 */
1398
1399static int NCR5380_select (struct Scsi_Host *instance, Scsi_Cmnd *cmd, int tag)
1400{
1401 SETUP_HOSTDATA(instance);
1402 unsigned char tmp[3], phase;
1403 unsigned char *data;
1404 int len;
1405 unsigned long timeout;
1406 unsigned long flags;
1407
1408 hostdata->restart_select = 0;
1409 NCR_PRINT(NDEBUG_ARBITRATION);
1410 ARB_PRINTK("scsi%d: starting arbitration, id = %d\n", HOSTNO,
1411 instance->this_id);
1412
1413 /*
1414 * Set the phase bits to 0, otherwise the NCR5380 won't drive the
1415 * data bus during SELECTION.
1416 */
1417
1418 local_irq_save(flags);
1419 if (hostdata->connected) {
1420 local_irq_restore(flags);
1421 return -1;
1422 }
1423 NCR5380_write(TARGET_COMMAND_REG, 0);
1424
1425
1426 /*
1427 * Start arbitration.
1428 */
1429
1430 NCR5380_write(OUTPUT_DATA_REG, hostdata->id_mask);
1431 NCR5380_write(MODE_REG, MR_ARBITRATE);
1432
1433 local_irq_restore(flags);
1434
1435 /* Wait for arbitration logic to complete */
1436#if NCR_TIMEOUT
1437 {
1438 unsigned long timeout = jiffies + 2*NCR_TIMEOUT;
1439
1440 while (!(NCR5380_read(INITIATOR_COMMAND_REG) & ICR_ARBITRATION_PROGRESS)
1441 && time_before(jiffies, timeout) && !hostdata->connected)
1442 ;
1443 if (time_after_eq(jiffies, timeout))
1444 {
1445 printk("scsi : arbitration timeout at %d\n", __LINE__);
1446 NCR5380_write(MODE_REG, MR_BASE);
1447 NCR5380_write(SELECT_ENABLE_REG, hostdata->id_mask);
1448 return -1;
1449 }
1450 }
1451#else /* NCR_TIMEOUT */
1452 while (!(NCR5380_read(INITIATOR_COMMAND_REG) & ICR_ARBITRATION_PROGRESS)
1453 && !hostdata->connected);
1454#endif
1455
1456 ARB_PRINTK("scsi%d: arbitration complete\n", HOSTNO);
1457
1458 if (hostdata->connected) {
1459 NCR5380_write(MODE_REG, MR_BASE);
1460 return -1;
1461 }
1462 /*
1463 * The arbitration delay is 2.2us, but this is a minimum and there is
1464 * no maximum so we can safely sleep for ceil(2.2) usecs to accommodate
1465 * the integral nature of udelay().
1466 *
1467 */
1468
1469 udelay(3);
1470
1471 /* Check for lost arbitration */
1472 if ((NCR5380_read(INITIATOR_COMMAND_REG) & ICR_ARBITRATION_LOST) ||
1473 (NCR5380_read(CURRENT_SCSI_DATA_REG) & hostdata->id_higher_mask) ||
1474 (NCR5380_read(INITIATOR_COMMAND_REG) & ICR_ARBITRATION_LOST) ||
1475 hostdata->connected) {
1476 NCR5380_write(MODE_REG, MR_BASE);
1477 ARB_PRINTK("scsi%d: lost arbitration, deasserting MR_ARBITRATE\n",
1478 HOSTNO);
1479 return -1;
1480 }
1481
1482 /* after/during arbitration, BSY should be asserted.
1483 IBM DPES-31080 Version S31Q works now */
1484 /* Tnx to Thomas_Roesch@m2.maus.de for finding this! (Roman) */
1485 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_SEL |
1486 ICR_ASSERT_BSY ) ;
1487
1488 if ((NCR5380_read(INITIATOR_COMMAND_REG) & ICR_ARBITRATION_LOST) ||
1489 hostdata->connected) {
1490 NCR5380_write(MODE_REG, MR_BASE);
1491 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1492 ARB_PRINTK("scsi%d: lost arbitration, deasserting ICR_ASSERT_SEL\n",
1493 HOSTNO);
1494 return -1;
1495 }
1496
1497 /*
1498 * Again, bus clear + bus settle time is 1.2us, however, this is
1499 * a minimum so we'll udelay ceil(1.2)
1500 */
1501
1502#ifdef CONFIG_ATARI_SCSI_TOSHIBA_DELAY
1503 /* ++roman: But some targets (see above :-) seem to need a bit more... */
1504 udelay(15);
1505#else
1506 udelay(2);
1507#endif
1508
1509 if (hostdata->connected) {
1510 NCR5380_write(MODE_REG, MR_BASE);
1511 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1512 return -1;
1513 }
1514
1515 ARB_PRINTK("scsi%d: won arbitration\n", HOSTNO);
1516
1517 /*
1518 * Now that we have won arbitration, start Selection process, asserting
1519 * the host and target ID's on the SCSI bus.
1520 */
1521
1522 NCR5380_write(OUTPUT_DATA_REG, (hostdata->id_mask | (1 << cmd->device->id)));
1523
1524 /*
1525 * Raise ATN while SEL is true before BSY goes false from arbitration,
1526 * since this is the only way to guarantee that we'll get a MESSAGE OUT
1527 * phase immediately after selection.
1528 */
1529
1530 NCR5380_write(INITIATOR_COMMAND_REG, (ICR_BASE | ICR_ASSERT_BSY |
1531 ICR_ASSERT_DATA | ICR_ASSERT_ATN | ICR_ASSERT_SEL ));
1532 NCR5380_write(MODE_REG, MR_BASE);
1533
1534 /*
1535 * Reselect interrupts must be turned off prior to the dropping of BSY,
1536 * otherwise we will trigger an interrupt.
1537 */
1538
1539 if (hostdata->connected) {
1540 NCR5380_write(INITIATOR_COMMAND_REG, ICR_BASE);
1541 return -1;
1542 }
1543
1544 NCR5380_write(SELECT_ENABLE_REG, 0);
1545
1546 /*
1547 * The initiator shall then wait at least two deskew delays and release
1548 * the BSY signal.
1549 */
1550 udelay(1); /* wingel -- wait two bus deskew delay >2*45ns */
1551
1552 /* Reset BSY */
1553 NCR5380_write(INITIATOR_COMMAND_REG, (ICR_BASE | ICR_ASSERT_DATA |
1554 ICR_ASSERT_ATN | ICR_ASSERT_SEL));
1555
1556 /*
1557 * Something weird happens when we cease to drive BSY - looks
1558 * like the board/chip is letting us do another read before the
1559 * appropriate propagation delay has expired, and we're confusing
1560 * a BSY signal from ourselves as the target's response to SELECTION.
1561 *
1562 * A small delay (the 'C++' frontend breaks the pipeline with an
1563 * unnecessary jump, making it work on my 386-33/Trantor T128, the
1564 * tighter 'C' code breaks and requires this) solves the problem -
1565 * the 1 us delay is arbitrary, and only used because this delay will
1566 * be the same on other platforms and since it works here, it should
1567 * work there.
1568 *
1569 * wingel suggests that this could be due to failing to wait
1570 * one deskew delay.
1571 */
1572
1573 udelay(1);
1574
1575 SEL_PRINTK("scsi%d: selecting target %d\n", HOSTNO, cmd->device->id);
1576
1577 /*
1578 * The SCSI specification calls for a 250 ms timeout for the actual
1579 * selection.
1580 */
1581
1582 timeout = jiffies + 25;
1583
1584 /*
1585 * XXX very interesting - we're seeing a bounce where the BSY we
1586 * asserted is being reflected / still asserted (propagation delay?)
1587 * and it's detecting as true. Sigh.
1588 */
1589
1590#if 0
1591 /* ++roman: If a target conformed to the SCSI standard, it wouldn't assert
1592 * IO while SEL is true. But again, there are some disks out the in the
1593 * world that do that nevertheless. (Somebody claimed that this announces
1594 * reselection capability of the target.) So we better skip that test and
1595