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