xref: /openbmc/linux/drivers/scsi/arm/fas216.c (revision aa0dc6a7)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  linux/drivers/acorn/scsi/fas216.c
4  *
5  *  Copyright (C) 1997-2003 Russell King
6  *
7  * Based on information in qlogicfas.c by Tom Zerucha, Michael Griffith, and
8  * other sources, including:
9  *   the AMD Am53CF94 data sheet
10  *   the AMD Am53C94 data sheet
11  *
12  * This is a generic driver.  To use it, have a look at cumana_2.c.  You
13  * should define your own structure that overlays FAS216_Info, eg:
14  * struct my_host_data {
15  *    FAS216_Info info;
16  *    ... my host specific data ...
17  * };
18  *
19  * Changelog:
20  *  30-08-1997	RMK	Created
21  *  14-09-1997	RMK	Started disconnect support
22  *  08-02-1998	RMK	Corrected real DMA support
23  *  15-02-1998	RMK	Started sync xfer support
24  *  06-04-1998	RMK	Tightened conditions for printing incomplete
25  *			transfers
26  *  02-05-1998	RMK	Added extra checks in fas216_reset
27  *  24-05-1998	RMK	Fixed synchronous transfers with period >= 200ns
28  *  27-06-1998	RMK	Changed asm/delay.h to linux/delay.h
29  *  26-08-1998	RMK	Improved message support wrt MESSAGE_REJECT
30  *  02-04-2000	RMK	Converted to use the new error handling, and
31  *			automatically request sense data upon check
32  *			condition status from targets.
33  */
34 #include <linux/module.h>
35 #include <linux/blkdev.h>
36 #include <linux/kernel.h>
37 #include <linux/string.h>
38 #include <linux/ioport.h>
39 #include <linux/proc_fs.h>
40 #include <linux/delay.h>
41 #include <linux/bitops.h>
42 #include <linux/init.h>
43 #include <linux/interrupt.h>
44 
45 #include <asm/dma.h>
46 #include <asm/io.h>
47 #include <asm/irq.h>
48 #include <asm/ecard.h>
49 
50 #include "../scsi.h"
51 #include <scsi/scsi_dbg.h>
52 #include <scsi/scsi_host.h>
53 #include "fas216.h"
54 #include "scsi.h"
55 
56 /* NOTE: SCSI2 Synchronous transfers *require* DMA according to
57  *  the data sheet.  This restriction is crazy, especially when
58  *  you only want to send 16 bytes!  What were the guys who
59  *  designed this chip on at that time?  Did they read the SCSI2
60  *  spec at all?  The following sections are taken from the SCSI2
61  *  standard (s2r10) concerning this:
62  *
63  * > IMPLEMENTORS NOTES:
64  * >   (1)  Re-negotiation at every selection is not recommended, since a
65  * >   significant performance impact is likely.
66  *
67  * >  The implied synchronous agreement shall remain in effect until a BUS DEVICE
68  * >  RESET message is received, until a hard reset condition occurs, or until one
69  * >  of the two SCSI devices elects to modify the agreement.  The default data
70  * >  transfer mode is asynchronous data transfer mode.  The default data transfer
71  * >  mode is entered at power on, after a BUS DEVICE RESET message, or after a hard
72  * >  reset condition.
73  *
74  *  In total, this means that once you have elected to use synchronous
75  *  transfers, you must always use DMA.
76  *
77  *  I was thinking that this was a good chip until I found this restriction ;(
78  */
79 #define SCSI2_SYNC
80 #undef  SCSI2_TAG
81 
82 #undef DEBUG_CONNECT
83 #undef DEBUG_MESSAGES
84 
85 #undef CHECK_STRUCTURE
86 
87 #define LOG_CONNECT		(1 << 0)
88 #define LOG_BUSSERVICE		(1 << 1)
89 #define LOG_FUNCTIONDONE	(1 << 2)
90 #define LOG_MESSAGES		(1 << 3)
91 #define LOG_BUFFER		(1 << 4)
92 #define LOG_ERROR		(1 << 8)
93 
94 static int level_mask = LOG_ERROR;
95 
96 module_param(level_mask, int, 0644);
97 
98 #ifndef MODULE
99 static int __init fas216_log_setup(char *str)
100 {
101 	char *s;
102 
103 	level_mask = 0;
104 
105 	while ((s = strsep(&str, ",")) != NULL) {
106 		switch (s[0]) {
107 		case 'a':
108 			if (strcmp(s, "all") == 0)
109 				level_mask |= -1;
110 			break;
111 		case 'b':
112 			if (strncmp(s, "bus", 3) == 0)
113 				level_mask |= LOG_BUSSERVICE;
114 			if (strncmp(s, "buf", 3) == 0)
115 				level_mask |= LOG_BUFFER;
116 			break;
117 		case 'c':
118 			level_mask |= LOG_CONNECT;
119 			break;
120 		case 'e':
121 			level_mask |= LOG_ERROR;
122 			break;
123 		case 'm':
124 			level_mask |= LOG_MESSAGES;
125 			break;
126 		case 'n':
127 			if (strcmp(s, "none") == 0)
128 				level_mask = 0;
129 			break;
130 		case 's':
131 			level_mask |= LOG_FUNCTIONDONE;
132 			break;
133 		}
134 	}
135 	return 1;
136 }
137 
138 __setup("fas216_logging=", fas216_log_setup);
139 #endif
140 
141 static inline unsigned char fas216_readb(FAS216_Info *info, unsigned int reg)
142 {
143 	unsigned int off = reg << info->scsi.io_shift;
144 	return readb(info->scsi.io_base + off);
145 }
146 
147 static inline void fas216_writeb(FAS216_Info *info, unsigned int reg, unsigned int val)
148 {
149 	unsigned int off = reg << info->scsi.io_shift;
150 	writeb(val, info->scsi.io_base + off);
151 }
152 
153 static void fas216_dumpstate(FAS216_Info *info)
154 {
155 	unsigned char is, stat, inst;
156 
157 	is   = fas216_readb(info, REG_IS);
158 	stat = fas216_readb(info, REG_STAT);
159 	inst = fas216_readb(info, REG_INST);
160 
161 	printk("FAS216: CTCL=%02X CTCM=%02X CMD=%02X STAT=%02X"
162 	       " INST=%02X IS=%02X CFIS=%02X",
163 		fas216_readb(info, REG_CTCL),
164 		fas216_readb(info, REG_CTCM),
165 		fas216_readb(info, REG_CMD),  stat, inst, is,
166 		fas216_readb(info, REG_CFIS));
167 	printk(" CNTL1=%02X CNTL2=%02X CNTL3=%02X CTCH=%02X\n",
168 		fas216_readb(info, REG_CNTL1),
169 		fas216_readb(info, REG_CNTL2),
170 		fas216_readb(info, REG_CNTL3),
171 		fas216_readb(info, REG_CTCH));
172 }
173 
174 static void print_SCp(struct scsi_pointer *SCp, const char *prefix, const char *suffix)
175 {
176 	printk("%sptr %p this_residual 0x%x buffer %p buffers_residual 0x%x%s",
177 		prefix, SCp->ptr, SCp->this_residual, SCp->buffer,
178 		SCp->buffers_residual, suffix);
179 }
180 
181 #ifdef CHECK_STRUCTURE
182 static void fas216_dumpinfo(FAS216_Info *info)
183 {
184 	static int used = 0;
185 	int i;
186 
187 	if (used++)
188 		return;
189 
190 	printk("FAS216_Info=\n");
191 	printk("  { magic_start=%lX host=%p SCpnt=%p origSCpnt=%p\n",
192 		info->magic_start, info->host, info->SCpnt,
193 		info->origSCpnt);
194 	printk("    scsi={ io_shift=%X irq=%X cfg={ %X %X %X %X }\n",
195 		info->scsi.io_shift, info->scsi.irq,
196 		info->scsi.cfg[0], info->scsi.cfg[1], info->scsi.cfg[2],
197 		info->scsi.cfg[3]);
198 	printk("           type=%p phase=%X\n",
199 		info->scsi.type, info->scsi.phase);
200 	print_SCp(&info->scsi.SCp, "           SCp={ ", " }\n");
201 	printk("      msgs async_stp=%X disconnectable=%d aborting=%d }\n",
202 		info->scsi.async_stp,
203 		info->scsi.disconnectable, info->scsi.aborting);
204 	printk("    stats={ queues=%X removes=%X fins=%X reads=%X writes=%X miscs=%X\n"
205 	       "            disconnects=%X aborts=%X bus_resets=%X host_resets=%X}\n",
206 		info->stats.queues, info->stats.removes, info->stats.fins,
207 		info->stats.reads, info->stats.writes, info->stats.miscs,
208 		info->stats.disconnects, info->stats.aborts, info->stats.bus_resets,
209 		info->stats.host_resets);
210 	printk("    ifcfg={ clockrate=%X select_timeout=%X asyncperiod=%X sync_max_depth=%X }\n",
211 		info->ifcfg.clockrate, info->ifcfg.select_timeout,
212 		info->ifcfg.asyncperiod, info->ifcfg.sync_max_depth);
213 	for (i = 0; i < 8; i++) {
214 		printk("    busyluns[%d]=%08lx dev[%d]={ disconnect_ok=%d stp=%X sof=%X sync_state=%X }\n",
215 			i, info->busyluns[i], i,
216 			info->device[i].disconnect_ok, info->device[i].stp,
217 			info->device[i].sof, info->device[i].sync_state);
218 	}
219 	printk("    dma={ transfer_type=%X setup=%p pseudo=%p stop=%p }\n",
220 		info->dma.transfer_type, info->dma.setup,
221 		info->dma.pseudo, info->dma.stop);
222 	printk("    internal_done=%X magic_end=%lX }\n",
223 		info->internal_done, info->magic_end);
224 }
225 
226 static void __fas216_checkmagic(FAS216_Info *info, const char *func)
227 {
228 	int corruption = 0;
229 	if (info->magic_start != MAGIC) {
230 		printk(KERN_CRIT "FAS216 Error: magic at start corrupted\n");
231 		corruption++;
232 	}
233 	if (info->magic_end != MAGIC) {
234 		printk(KERN_CRIT "FAS216 Error: magic at end corrupted\n");
235 		corruption++;
236 	}
237 	if (corruption) {
238 		fas216_dumpinfo(info);
239 		panic("scsi memory space corrupted in %s", func);
240 	}
241 }
242 #define fas216_checkmagic(info) __fas216_checkmagic((info), __func__)
243 #else
244 #define fas216_checkmagic(info)
245 #endif
246 
247 static const char *fas216_bus_phase(int stat)
248 {
249 	static const char *phases[] = {
250 		"DATA OUT", "DATA IN",
251 		"COMMAND", "STATUS",
252 		"MISC OUT", "MISC IN",
253 		"MESG OUT", "MESG IN"
254 	};
255 
256 	return phases[stat & STAT_BUSMASK];
257 }
258 
259 static const char *fas216_drv_phase(FAS216_Info *info)
260 {
261 	static const char *phases[] = {
262 		[PHASE_IDLE]		= "idle",
263 		[PHASE_SELECTION]	= "selection",
264 		[PHASE_COMMAND]		= "command",
265 		[PHASE_DATAOUT]		= "data out",
266 		[PHASE_DATAIN]		= "data in",
267 		[PHASE_MSGIN]		= "message in",
268 		[PHASE_MSGIN_DISCONNECT]= "disconnect",
269 		[PHASE_MSGOUT_EXPECT]	= "expect message out",
270 		[PHASE_MSGOUT]		= "message out",
271 		[PHASE_STATUS]		= "status",
272 		[PHASE_DONE]		= "done",
273 	};
274 
275 	if (info->scsi.phase < ARRAY_SIZE(phases) &&
276 	    phases[info->scsi.phase])
277 		return phases[info->scsi.phase];
278 	return "???";
279 }
280 
281 static char fas216_target(FAS216_Info *info)
282 {
283 	if (info->SCpnt)
284 		return '0' + info->SCpnt->device->id;
285 	else
286 		return 'H';
287 }
288 
289 static void
290 fas216_do_log(FAS216_Info *info, char target, char *fmt, va_list ap)
291 {
292 	static char buf[1024];
293 
294 	vsnprintf(buf, sizeof(buf), fmt, ap);
295 	printk("scsi%d.%c: %s", info->host->host_no, target, buf);
296 }
297 
298 static void fas216_log_command(FAS216_Info *info, int level,
299 			       struct scsi_cmnd *SCpnt, char *fmt, ...)
300 {
301 	va_list args;
302 
303 	if (level != 0 && !(level & level_mask))
304 		return;
305 
306 	va_start(args, fmt);
307 	fas216_do_log(info, '0' + SCpnt->device->id, fmt, args);
308 	va_end(args);
309 
310 	scsi_print_command(SCpnt);
311 }
312 
313 static void
314 fas216_log_target(FAS216_Info *info, int level, int target, char *fmt, ...)
315 {
316 	va_list args;
317 
318 	if (level != 0 && !(level & level_mask))
319 		return;
320 
321 	if (target < 0)
322 		target = 'H';
323 	else
324 		target += '0';
325 
326 	va_start(args, fmt);
327 	fas216_do_log(info, target, fmt, args);
328 	va_end(args);
329 
330 	printk("\n");
331 }
332 
333 static void fas216_log(FAS216_Info *info, int level, char *fmt, ...)
334 {
335 	va_list args;
336 
337 	if (level != 0 && !(level & level_mask))
338 		return;
339 
340 	va_start(args, fmt);
341 	fas216_do_log(info, fas216_target(info), fmt, args);
342 	va_end(args);
343 
344 	printk("\n");
345 }
346 
347 #define PH_SIZE	32
348 
349 static struct { int stat, ssr, isr, ph; } ph_list[PH_SIZE];
350 static int ph_ptr;
351 
352 static void add_debug_list(int stat, int ssr, int isr, int ph)
353 {
354 	ph_list[ph_ptr].stat = stat;
355 	ph_list[ph_ptr].ssr = ssr;
356 	ph_list[ph_ptr].isr = isr;
357 	ph_list[ph_ptr].ph = ph;
358 
359 	ph_ptr = (ph_ptr + 1) & (PH_SIZE-1);
360 }
361 
362 static struct { int command; void *from; } cmd_list[8];
363 static int cmd_ptr;
364 
365 static void fas216_cmd(FAS216_Info *info, unsigned int command)
366 {
367 	cmd_list[cmd_ptr].command = command;
368 	cmd_list[cmd_ptr].from = __builtin_return_address(0);
369 
370 	cmd_ptr = (cmd_ptr + 1) & 7;
371 
372 	fas216_writeb(info, REG_CMD, command);
373 }
374 
375 static void print_debug_list(void)
376 {
377 	int i;
378 
379 	i = ph_ptr;
380 
381 	printk(KERN_ERR "SCSI IRQ trail\n");
382 	do {
383 		printk(" %02x:%02x:%02x:%1x",
384 			ph_list[i].stat, ph_list[i].ssr,
385 			ph_list[i].isr, ph_list[i].ph);
386 		i = (i + 1) & (PH_SIZE - 1);
387 		if (((i ^ ph_ptr) & 7) == 0)
388 			printk("\n");
389 	} while (i != ph_ptr);
390 	if ((i ^ ph_ptr) & 7)
391 		printk("\n");
392 
393 	i = cmd_ptr;
394 	printk(KERN_ERR "FAS216 commands: ");
395 	do {
396 		printk("%02x:%p ", cmd_list[i].command, cmd_list[i].from);
397 		i = (i + 1) & 7;
398 	} while (i != cmd_ptr);
399 	printk("\n");
400 }
401 
402 static void fas216_done(FAS216_Info *info, unsigned int result);
403 
404 /**
405  * fas216_get_last_msg - retrive last message from the list
406  * @info: interface to search
407  * @pos: current fifo position
408  *
409  * Retrieve a last message from the list, using position in fifo.
410  */
411 static inline unsigned short
412 fas216_get_last_msg(FAS216_Info *info, int pos)
413 {
414 	unsigned short packed_msg = NOP;
415 	struct message *msg;
416 	int msgnr = 0;
417 
418 	while ((msg = msgqueue_getmsg(&info->scsi.msgs, msgnr++)) != NULL) {
419 		if (pos >= msg->fifo)
420 			break;
421 	}
422 
423 	if (msg) {
424 		if (msg->msg[0] == EXTENDED_MESSAGE)
425 			packed_msg = EXTENDED_MESSAGE | msg->msg[2] << 8;
426 		else
427 			packed_msg = msg->msg[0];
428 	}
429 
430 	fas216_log(info, LOG_MESSAGES,
431 		"Message: %04x found at position %02x\n", packed_msg, pos);
432 
433 	return packed_msg;
434 }
435 
436 /**
437  * fas216_syncperiod - calculate STP register value
438  * @info: state structure for interface connected to device
439  * @ns: period in ns (between subsequent bytes)
440  *
441  * Calculate value to be loaded into the STP register for a given period
442  * in ns. Returns a value suitable for REG_STP.
443  */
444 static int fas216_syncperiod(FAS216_Info *info, int ns)
445 {
446 	int value = (info->ifcfg.clockrate * ns) / 1000;
447 
448 	fas216_checkmagic(info);
449 
450 	if (value < 4)
451 		value = 4;
452 	else if (value > 35)
453 		value = 35;
454 
455 	return value & 31;
456 }
457 
458 /**
459  * fas216_set_sync - setup FAS216 chip for specified transfer period.
460  * @info: state structure for interface connected to device
461  * @target: target
462  *
463  * Correctly setup FAS216 chip for specified transfer period.
464  * Notes   : we need to switch the chip out of FASTSCSI mode if we have
465  *           a transfer period >= 200ns - otherwise the chip will violate
466  *           the SCSI timings.
467  */
468 static void fas216_set_sync(FAS216_Info *info, int target)
469 {
470 	unsigned int cntl3;
471 
472 	fas216_writeb(info, REG_SOF, info->device[target].sof);
473 	fas216_writeb(info, REG_STP, info->device[target].stp);
474 
475 	cntl3 = info->scsi.cfg[2];
476 	if (info->device[target].period >= (200 / 4))
477 		cntl3 = cntl3 & ~CNTL3_FASTSCSI;
478 
479 	fas216_writeb(info, REG_CNTL3, cntl3);
480 }
481 
482 /* Synchronous transfer support
483  *
484  * Note: The SCSI II r10 spec says (5.6.12):
485  *
486  *  (2)  Due to historical problems with early host adapters that could
487  *  not accept an SDTR message, some targets may not initiate synchronous
488  *  negotiation after a power cycle as required by this standard.  Host
489  *  adapters that support synchronous mode may avoid the ensuing failure
490  *  modes when the target is independently power cycled by initiating a
491  *  synchronous negotiation on each REQUEST SENSE and INQUIRY command.
492  *  This approach increases the SCSI bus overhead and is not recommended
493  *  for new implementations.  The correct method is to respond to an
494  *  SDTR message with a MESSAGE REJECT message if the either the
495  *  initiator or target devices does not support synchronous transfers
496  *  or does not want to negotiate for synchronous transfers at the time.
497  *  Using the correct method assures compatibility with wide data
498  *  transfers and future enhancements.
499  *
500  * We will always initiate a synchronous transfer negotiation request on
501  * every INQUIRY or REQUEST SENSE message, unless the target itself has
502  * at some point performed a synchronous transfer negotiation request, or
503  * we have synchronous transfers disabled for this device.
504  */
505 
506 /**
507  * fas216_handlesync - Handle a synchronous transfer message
508  * @info: state structure for interface
509  * @msg: message from target
510  *
511  * Handle a synchronous transfer message from the target
512  */
513 static void fas216_handlesync(FAS216_Info *info, char *msg)
514 {
515 	struct fas216_device *dev = &info->device[info->SCpnt->device->id];
516 	enum { sync, async, none, reject } res = none;
517 
518 #ifdef SCSI2_SYNC
519 	switch (msg[0]) {
520 	case MESSAGE_REJECT:
521 		/* Synchronous transfer request failed.
522 		 * Note: SCSI II r10:
523 		 *
524 		 *  SCSI devices that are capable of synchronous
525 		 *  data transfers shall not respond to an SDTR
526 		 *  message with a MESSAGE REJECT message.
527 		 *
528 		 * Hence, if we get this condition, we disable
529 		 * negotiation for this device.
530 		 */
531 		if (dev->sync_state == neg_inprogress) {
532 			dev->sync_state = neg_invalid;
533 			res = async;
534 		}
535 		break;
536 
537 	case EXTENDED_MESSAGE:
538 		switch (dev->sync_state) {
539 		/* We don't accept synchronous transfer requests.
540 		 * Respond with a MESSAGE_REJECT to prevent a
541 		 * synchronous transfer agreement from being reached.
542 		 */
543 		case neg_invalid:
544 			res = reject;
545 			break;
546 
547 		/* We were not negotiating a synchronous transfer,
548 		 * but the device sent us a negotiation request.
549 		 * Honour the request by sending back a SDTR
550 		 * message containing our capability, limited by
551 		 * the targets capability.
552 		 */
553 		default:
554 			fas216_cmd(info, CMD_SETATN);
555 			if (msg[4] > info->ifcfg.sync_max_depth)
556 				msg[4] = info->ifcfg.sync_max_depth;
557 			if (msg[3] < 1000 / info->ifcfg.clockrate)
558 				msg[3] = 1000 / info->ifcfg.clockrate;
559 
560 			msgqueue_flush(&info->scsi.msgs);
561 			msgqueue_addmsg(&info->scsi.msgs, 5,
562 					EXTENDED_MESSAGE, 3, EXTENDED_SDTR,
563 					msg[3], msg[4]);
564 			info->scsi.phase = PHASE_MSGOUT_EXPECT;
565 
566 			/* This is wrong.  The agreement is not in effect
567 			 * until this message is accepted by the device
568 			 */
569 			dev->sync_state = neg_targcomplete;
570 			res = sync;
571 			break;
572 
573 		/* We initiated the synchronous transfer negotiation,
574 		 * and have successfully received a response from the
575 		 * target.  The synchronous transfer agreement has been
576 		 * reached.  Note: if the values returned are out of our
577 		 * bounds, we must reject the message.
578 		 */
579 		case neg_inprogress:
580 			res = reject;
581 			if (msg[4] <= info->ifcfg.sync_max_depth &&
582 			    msg[3] >= 1000 / info->ifcfg.clockrate) {
583 				dev->sync_state = neg_complete;
584 				res = sync;
585 			}
586 			break;
587 		}
588 	}
589 #else
590 	res = reject;
591 #endif
592 
593 	switch (res) {
594 	case sync:
595 		dev->period = msg[3];
596 		dev->sof    = msg[4];
597 		dev->stp    = fas216_syncperiod(info, msg[3] * 4);
598 		fas216_set_sync(info, info->SCpnt->device->id);
599 		break;
600 
601 	case reject:
602 		fas216_cmd(info, CMD_SETATN);
603 		msgqueue_flush(&info->scsi.msgs);
604 		msgqueue_addmsg(&info->scsi.msgs, 1, MESSAGE_REJECT);
605 		info->scsi.phase = PHASE_MSGOUT_EXPECT;
606 		fallthrough;
607 
608 	case async:
609 		dev->period = info->ifcfg.asyncperiod / 4;
610 		dev->sof    = 0;
611 		dev->stp    = info->scsi.async_stp;
612 		fas216_set_sync(info, info->SCpnt->device->id);
613 		break;
614 
615 	case none:
616 		break;
617 	}
618 }
619 
620 /**
621  * fas216_updateptrs - update data pointers after transfer suspended/paused
622  * @info: interface's local pointer to update
623  * @bytes_transferred: number of bytes transferred
624  *
625  * Update data pointers after transfer suspended/paused
626  */
627 static void fas216_updateptrs(FAS216_Info *info, int bytes_transferred)
628 {
629 	struct scsi_pointer *SCp = &info->scsi.SCp;
630 
631 	fas216_checkmagic(info);
632 
633 	BUG_ON(bytes_transferred < 0);
634 
635 	SCp->phase -= bytes_transferred;
636 
637 	while (bytes_transferred != 0) {
638 		if (SCp->this_residual > bytes_transferred)
639 			break;
640 		/*
641 		 * We have used up this buffer.  Move on to the
642 		 * next buffer.
643 		 */
644 		bytes_transferred -= SCp->this_residual;
645 		if (!next_SCp(SCp) && bytes_transferred) {
646 			printk(KERN_WARNING "scsi%d.%c: out of buffers\n",
647 				info->host->host_no, '0' + info->SCpnt->device->id);
648 			return;
649 		}
650 	}
651 
652 	SCp->this_residual -= bytes_transferred;
653 	if (SCp->this_residual)
654 		SCp->ptr += bytes_transferred;
655 	else
656 		SCp->ptr = NULL;
657 }
658 
659 /**
660  * fas216_pio - transfer data off of/on to card using programmed IO
661  * @info: interface to transfer data to/from
662  * @direction: direction to transfer data (DMA_OUT/DMA_IN)
663  *
664  * Transfer data off of/on to card using programmed IO.
665  * Notes: this is incredibly slow.
666  */
667 static void fas216_pio(FAS216_Info *info, fasdmadir_t direction)
668 {
669 	struct scsi_pointer *SCp = &info->scsi.SCp;
670 
671 	fas216_checkmagic(info);
672 
673 	if (direction == DMA_OUT)
674 		fas216_writeb(info, REG_FF, get_next_SCp_byte(SCp));
675 	else
676 		put_next_SCp_byte(SCp, fas216_readb(info, REG_FF));
677 
678 	if (SCp->this_residual == 0)
679 		next_SCp(SCp);
680 }
681 
682 static void fas216_set_stc(FAS216_Info *info, unsigned int length)
683 {
684 	fas216_writeb(info, REG_STCL, length);
685 	fas216_writeb(info, REG_STCM, length >> 8);
686 	fas216_writeb(info, REG_STCH, length >> 16);
687 }
688 
689 static unsigned int fas216_get_ctc(FAS216_Info *info)
690 {
691 	return fas216_readb(info, REG_CTCL) +
692 	       (fas216_readb(info, REG_CTCM) << 8) +
693 	       (fas216_readb(info, REG_CTCH) << 16);
694 }
695 
696 /**
697  * fas216_cleanuptransfer - clean up after a transfer has completed.
698  * @info: interface to clean up
699  *
700  * Update the data pointers according to the number of bytes transferred
701  * on the SCSI bus.
702  */
703 static void fas216_cleanuptransfer(FAS216_Info *info)
704 {
705 	unsigned long total, residual, fifo;
706 	fasdmatype_t dmatype = info->dma.transfer_type;
707 
708 	info->dma.transfer_type = fasdma_none;
709 
710 	/*
711 	 * PIO transfers do not need to be cleaned up.
712 	 */
713 	if (dmatype == fasdma_pio || dmatype == fasdma_none)
714 		return;
715 
716 	if (dmatype == fasdma_real_all)
717 		total = info->scsi.SCp.phase;
718 	else
719 		total = info->scsi.SCp.this_residual;
720 
721 	residual = fas216_get_ctc(info);
722 
723 	fifo = fas216_readb(info, REG_CFIS) & CFIS_CF;
724 
725 	fas216_log(info, LOG_BUFFER, "cleaning up from previous "
726 		   "transfer: length 0x%06x, residual 0x%x, fifo %d",
727 		   total, residual, fifo);
728 
729 	/*
730 	 * If we were performing Data-Out, the transfer counter
731 	 * counts down each time a byte is transferred by the
732 	 * host to the FIFO.  This means we must include the
733 	 * bytes left in the FIFO from the transfer counter.
734 	 */
735 	if (info->scsi.phase == PHASE_DATAOUT)
736 		residual += fifo;
737 
738 	fas216_updateptrs(info, total - residual);
739 }
740 
741 /**
742  * fas216_transfer - Perform a DMA/PIO transfer off of/on to card
743  * @info: interface from which device disconnected from
744  *
745  * Start a DMA/PIO transfer off of/on to card
746  */
747 static void fas216_transfer(FAS216_Info *info)
748 {
749 	fasdmadir_t direction;
750 	fasdmatype_t dmatype;
751 
752 	fas216_log(info, LOG_BUFFER,
753 		   "starttransfer: buffer %p length 0x%06x reqlen 0x%06x",
754 		   info->scsi.SCp.ptr, info->scsi.SCp.this_residual,
755 		   info->scsi.SCp.phase);
756 
757 	if (!info->scsi.SCp.ptr) {
758 		fas216_log(info, LOG_ERROR, "null buffer passed to "
759 			   "fas216_starttransfer");
760 		print_SCp(&info->scsi.SCp, "SCp: ", "\n");
761 		print_SCp(&info->SCpnt->SCp, "Cmnd SCp: ", "\n");
762 		return;
763 	}
764 
765 	/*
766 	 * If we have a synchronous transfer agreement in effect, we must
767 	 * use DMA mode.  If we are using asynchronous transfers, we may
768 	 * use DMA mode or PIO mode.
769 	 */
770 	if (info->device[info->SCpnt->device->id].sof)
771 		dmatype = fasdma_real_all;
772 	else
773 		dmatype = fasdma_pio;
774 
775 	if (info->scsi.phase == PHASE_DATAOUT)
776 		direction = DMA_OUT;
777 	else
778 		direction = DMA_IN;
779 
780 	if (info->dma.setup)
781 		dmatype = info->dma.setup(info->host, &info->scsi.SCp,
782 					  direction, dmatype);
783 	info->dma.transfer_type = dmatype;
784 
785 	if (dmatype == fasdma_real_all)
786 		fas216_set_stc(info, info->scsi.SCp.phase);
787 	else
788 		fas216_set_stc(info, info->scsi.SCp.this_residual);
789 
790 	switch (dmatype) {
791 	case fasdma_pio:
792 		fas216_log(info, LOG_BUFFER, "PIO transfer");
793 		fas216_writeb(info, REG_SOF, 0);
794 		fas216_writeb(info, REG_STP, info->scsi.async_stp);
795 		fas216_cmd(info, CMD_TRANSFERINFO);
796 		fas216_pio(info, direction);
797 		break;
798 
799 	case fasdma_pseudo:
800 		fas216_log(info, LOG_BUFFER, "pseudo transfer");
801 		fas216_cmd(info, CMD_TRANSFERINFO | CMD_WITHDMA);
802 		info->dma.pseudo(info->host, &info->scsi.SCp,
803 				 direction, info->SCpnt->transfersize);
804 		break;
805 
806 	case fasdma_real_block:
807 		fas216_log(info, LOG_BUFFER, "block dma transfer");
808 		fas216_cmd(info, CMD_TRANSFERINFO | CMD_WITHDMA);
809 		break;
810 
811 	case fasdma_real_all:
812 		fas216_log(info, LOG_BUFFER, "total dma transfer");
813 		fas216_cmd(info, CMD_TRANSFERINFO | CMD_WITHDMA);
814 		break;
815 
816 	default:
817 		fas216_log(info, LOG_BUFFER | LOG_ERROR,
818 			   "invalid FAS216 DMA type");
819 		break;
820 	}
821 }
822 
823 /**
824  * fas216_stoptransfer - Stop a DMA transfer onto / off of the card
825  * @info: interface from which device disconnected from
826  *
827  * Called when we switch away from DATA IN or DATA OUT phases.
828  */
829 static void fas216_stoptransfer(FAS216_Info *info)
830 {
831 	fas216_checkmagic(info);
832 
833 	if (info->dma.transfer_type == fasdma_real_all ||
834 	    info->dma.transfer_type == fasdma_real_block)
835 		info->dma.stop(info->host, &info->scsi.SCp);
836 
837 	fas216_cleanuptransfer(info);
838 
839 	if (info->scsi.phase == PHASE_DATAIN) {
840 		unsigned int fifo;
841 
842 		/*
843 		 * If we were performing Data-In, then the FIFO counter
844 		 * contains the number of bytes not transferred via DMA
845 		 * from the on-board FIFO.  Read them manually.
846 		 */
847 		fifo = fas216_readb(info, REG_CFIS) & CFIS_CF;
848 		while (fifo && info->scsi.SCp.ptr) {
849 			*info->scsi.SCp.ptr = fas216_readb(info, REG_FF);
850 			fas216_updateptrs(info, 1);
851 			fifo--;
852 		}
853 	} else {
854 		/*
855 		 * After a Data-Out phase, there may be unsent
856 		 * bytes left in the FIFO.  Flush them out.
857 		 */
858 		fas216_cmd(info, CMD_FLUSHFIFO);
859 	}
860 }
861 
862 static void fas216_aborttransfer(FAS216_Info *info)
863 {
864 	fas216_checkmagic(info);
865 
866 	if (info->dma.transfer_type == fasdma_real_all ||
867 	    info->dma.transfer_type == fasdma_real_block)
868 		info->dma.stop(info->host, &info->scsi.SCp);
869 
870 	info->dma.transfer_type = fasdma_none;
871 	fas216_cmd(info, CMD_FLUSHFIFO);
872 }
873 
874 static void fas216_kick(FAS216_Info *info);
875 
876 /**
877  * fas216_disconnected_intr - handle device disconnection
878  * @info: interface from which device disconnected from
879  *
880  * Handle device disconnection
881  */
882 static void fas216_disconnect_intr(FAS216_Info *info)
883 {
884 	unsigned long flags;
885 
886 	fas216_checkmagic(info);
887 
888 	fas216_log(info, LOG_CONNECT, "disconnect phase=%02x",
889 		   info->scsi.phase);
890 
891 	msgqueue_flush(&info->scsi.msgs);
892 
893 	switch (info->scsi.phase) {
894 	case PHASE_SELECTION:			/* while selecting - no target		*/
895 	case PHASE_SELSTEPS:
896 		fas216_done(info, DID_NO_CONNECT);
897 		break;
898 
899 	case PHASE_MSGIN_DISCONNECT:		/* message in - disconnecting		*/
900 		info->scsi.disconnectable = 1;
901 		info->scsi.phase = PHASE_IDLE;
902 		info->stats.disconnects += 1;
903 		spin_lock_irqsave(&info->host_lock, flags);
904 		if (info->scsi.phase == PHASE_IDLE)
905 			fas216_kick(info);
906 		spin_unlock_irqrestore(&info->host_lock, flags);
907 		break;
908 
909 	case PHASE_DONE:			/* at end of command - complete		*/
910 		fas216_done(info, DID_OK);
911 		break;
912 
913 	case PHASE_MSGOUT:			/* message out - possible ABORT message	*/
914 		if (fas216_get_last_msg(info, info->scsi.msgin_fifo) == ABORT) {
915 			info->scsi.aborting = 0;
916 			fas216_done(info, DID_ABORT);
917 			break;
918 		}
919 		fallthrough;
920 
921 	default:				/* huh?					*/
922 		printk(KERN_ERR "scsi%d.%c: unexpected disconnect in phase %s\n",
923 			info->host->host_no, fas216_target(info), fas216_drv_phase(info));
924 		print_debug_list();
925 		fas216_stoptransfer(info);
926 		fas216_done(info, DID_ERROR);
927 		break;
928 	}
929 }
930 
931 /**
932  * fas216_reselected_intr - start reconnection of a device
933  * @info: interface which was reselected
934  *
935  * Start reconnection of a device
936  */
937 static void
938 fas216_reselected_intr(FAS216_Info *info)
939 {
940 	unsigned int cfis, i;
941 	unsigned char msg[4];
942 	unsigned char target, lun, tag;
943 
944 	fas216_checkmagic(info);
945 
946 	WARN_ON(info->scsi.phase == PHASE_SELECTION ||
947 		info->scsi.phase == PHASE_SELSTEPS);
948 
949 	cfis = fas216_readb(info, REG_CFIS);
950 
951 	fas216_log(info, LOG_CONNECT, "reconnect phase=%02x cfis=%02x",
952 		   info->scsi.phase, cfis);
953 
954 	cfis &= CFIS_CF;
955 
956 	if (cfis < 2 || cfis > 4) {
957 		printk(KERN_ERR "scsi%d.H: incorrect number of bytes after reselect\n",
958 			info->host->host_no);
959 		goto bad_message;
960 	}
961 
962 	for (i = 0; i < cfis; i++)
963 		msg[i] = fas216_readb(info, REG_FF);
964 
965 	if (!(msg[0] & (1 << info->host->this_id)) ||
966 	    !(msg[1] & 0x80))
967 		goto initiator_error;
968 
969 	target = msg[0] & ~(1 << info->host->this_id);
970 	target = ffs(target) - 1;
971 	lun = msg[1] & 7;
972 	tag = 0;
973 
974 	if (cfis >= 3) {
975 		if (msg[2] != SIMPLE_QUEUE_TAG)
976 			goto initiator_error;
977 
978 		tag = msg[3];
979 	}
980 
981 	/* set up for synchronous transfers */
982 	fas216_writeb(info, REG_SDID, target);
983 	fas216_set_sync(info, target);
984 	msgqueue_flush(&info->scsi.msgs);
985 
986 	fas216_log(info, LOG_CONNECT, "Reconnected: target %1x lun %1x tag %02x",
987 		   target, lun, tag);
988 
989 	if (info->scsi.disconnectable && info->SCpnt) {
990 		info->scsi.disconnectable = 0;
991 		if (info->SCpnt->device->id  == target &&
992 		    info->SCpnt->device->lun == lun &&
993 		    info->SCpnt->tag         == tag) {
994 			fas216_log(info, LOG_CONNECT, "reconnected previously executing command");
995 		} else {
996 			queue_add_cmd_tail(&info->queues.disconnected, info->SCpnt);
997 			fas216_log(info, LOG_CONNECT, "had to move command to disconnected queue");
998 			info->SCpnt = NULL;
999 		}
1000 	}
1001 	if (!info->SCpnt) {
1002 		info->SCpnt = queue_remove_tgtluntag(&info->queues.disconnected,
1003 					target, lun, tag);
1004 		fas216_log(info, LOG_CONNECT, "had to get command");
1005 	}
1006 
1007 	if (info->SCpnt) {
1008 		/*
1009 		 * Restore data pointer from SAVED data pointer
1010 		 */
1011 		info->scsi.SCp = info->SCpnt->SCp;
1012 
1013 		fas216_log(info, LOG_CONNECT, "data pointers: [%p, %X]",
1014 			info->scsi.SCp.ptr, info->scsi.SCp.this_residual);
1015 		info->scsi.phase = PHASE_MSGIN;
1016 	} else {
1017 		/*
1018 		 * Our command structure not found - abort the
1019 		 * command on the target.  Since we have no
1020 		 * record of this command, we can't send
1021 		 * an INITIATOR DETECTED ERROR message.
1022 		 */
1023 		fas216_cmd(info, CMD_SETATN);
1024 
1025 #if 0
1026 		if (tag)
1027 			msgqueue_addmsg(&info->scsi.msgs, 2, ABORT_TAG, tag);
1028 		else
1029 #endif
1030 			msgqueue_addmsg(&info->scsi.msgs, 1, ABORT);
1031 		info->scsi.phase = PHASE_MSGOUT_EXPECT;
1032 		info->scsi.aborting = 1;
1033 	}
1034 
1035 	fas216_cmd(info, CMD_MSGACCEPTED);
1036 	return;
1037 
1038  initiator_error:
1039 	printk(KERN_ERR "scsi%d.H: error during reselection: bytes",
1040 		info->host->host_no);
1041 	for (i = 0; i < cfis; i++)
1042 		printk(" %02x", msg[i]);
1043 	printk("\n");
1044  bad_message:
1045 	fas216_cmd(info, CMD_SETATN);
1046 	msgqueue_flush(&info->scsi.msgs);
1047 	msgqueue_addmsg(&info->scsi.msgs, 1, INITIATOR_ERROR);
1048 	info->scsi.phase = PHASE_MSGOUT_EXPECT;
1049 	fas216_cmd(info, CMD_MSGACCEPTED);
1050 }
1051 
1052 static void fas216_parse_message(FAS216_Info *info, unsigned char *message, int msglen)
1053 {
1054 	int i;
1055 
1056 	switch (message[0]) {
1057 	case COMMAND_COMPLETE:
1058 		if (msglen != 1)
1059 			goto unrecognised;
1060 
1061 		printk(KERN_ERR "scsi%d.%c: command complete with no "
1062 			"status in MESSAGE_IN?\n",
1063 			info->host->host_no, fas216_target(info));
1064 		break;
1065 
1066 	case SAVE_POINTERS:
1067 		if (msglen != 1)
1068 			goto unrecognised;
1069 
1070 		/*
1071 		 * Save current data pointer to SAVED data pointer
1072 		 * SCSI II standard says that we must not acknowledge
1073 		 * this until we have really saved pointers.
1074 		 * NOTE: we DO NOT save the command nor status pointers
1075 		 * as required by the SCSI II standard.  These always
1076 		 * point to the start of their respective areas.
1077 		 */
1078 		info->SCpnt->SCp = info->scsi.SCp;
1079 		info->SCpnt->SCp.sent_command = 0;
1080 		fas216_log(info, LOG_CONNECT | LOG_MESSAGES | LOG_BUFFER,
1081 			"save data pointers: [%p, %X]",
1082 			info->scsi.SCp.ptr, info->scsi.SCp.this_residual);
1083 		break;
1084 
1085 	case RESTORE_POINTERS:
1086 		if (msglen != 1)
1087 			goto unrecognised;
1088 
1089 		/*
1090 		 * Restore current data pointer from SAVED data pointer
1091 		 */
1092 		info->scsi.SCp = info->SCpnt->SCp;
1093 		fas216_log(info, LOG_CONNECT | LOG_MESSAGES | LOG_BUFFER,
1094 			"restore data pointers: [%p, 0x%x]",
1095 			info->scsi.SCp.ptr, info->scsi.SCp.this_residual);
1096 		break;
1097 
1098 	case DISCONNECT:
1099 		if (msglen != 1)
1100 			goto unrecognised;
1101 
1102 		info->scsi.phase = PHASE_MSGIN_DISCONNECT;
1103 		break;
1104 
1105 	case MESSAGE_REJECT:
1106 		if (msglen != 1)
1107 			goto unrecognised;
1108 
1109 		switch (fas216_get_last_msg(info, info->scsi.msgin_fifo)) {
1110 		case EXTENDED_MESSAGE | EXTENDED_SDTR << 8:
1111 			fas216_handlesync(info, message);
1112 			break;
1113 
1114 		default:
1115 			fas216_log(info, 0, "reject, last message 0x%04x",
1116 				fas216_get_last_msg(info, info->scsi.msgin_fifo));
1117 		}
1118 		break;
1119 
1120 	case NOP:
1121 		break;
1122 
1123 	case EXTENDED_MESSAGE:
1124 		if (msglen < 3)
1125 			goto unrecognised;
1126 
1127 		switch (message[2]) {
1128 		case EXTENDED_SDTR:	/* Sync transfer negotiation request/reply */
1129 			fas216_handlesync(info, message);
1130 			break;
1131 
1132 		default:
1133 			goto unrecognised;
1134 		}
1135 		break;
1136 
1137 	default:
1138 		goto unrecognised;
1139 	}
1140 	return;
1141 
1142 unrecognised:
1143 	fas216_log(info, 0, "unrecognised message, rejecting");
1144 	printk("scsi%d.%c: message was", info->host->host_no, fas216_target(info));
1145 	for (i = 0; i < msglen; i++)
1146 		printk("%s%02X", i & 31 ? " " : "\n  ", message[i]);
1147 	printk("\n");
1148 
1149 	/*
1150 	 * Something strange seems to be happening here -
1151 	 * I can't use SETATN since the chip gives me an
1152 	 * invalid command interrupt when I do.  Weird.
1153 	 */
1154 fas216_cmd(info, CMD_NOP);
1155 fas216_dumpstate(info);
1156 	fas216_cmd(info, CMD_SETATN);
1157 	msgqueue_flush(&info->scsi.msgs);
1158 	msgqueue_addmsg(&info->scsi.msgs, 1, MESSAGE_REJECT);
1159 	info->scsi.phase = PHASE_MSGOUT_EXPECT;
1160 fas216_dumpstate(info);
1161 }
1162 
1163 static int fas216_wait_cmd(FAS216_Info *info, int cmd)
1164 {
1165 	int tout;
1166 	int stat;
1167 
1168 	fas216_cmd(info, cmd);
1169 
1170 	for (tout = 1000; tout; tout -= 1) {
1171 		stat = fas216_readb(info, REG_STAT);
1172 		if (stat & (STAT_INT|STAT_PARITYERROR))
1173 			break;
1174 		udelay(1);
1175 	}
1176 
1177 	return stat;
1178 }
1179 
1180 static int fas216_get_msg_byte(FAS216_Info *info)
1181 {
1182 	unsigned int stat = fas216_wait_cmd(info, CMD_MSGACCEPTED);
1183 
1184 	if ((stat & STAT_INT) == 0)
1185 		goto timedout;
1186 
1187 	if ((stat & STAT_BUSMASK) != STAT_MESGIN)
1188 		goto unexpected_phase_change;
1189 
1190 	fas216_readb(info, REG_INST);
1191 
1192 	stat = fas216_wait_cmd(info, CMD_TRANSFERINFO);
1193 
1194 	if ((stat & STAT_INT) == 0)
1195 		goto timedout;
1196 
1197 	if (stat & STAT_PARITYERROR)
1198 		goto parity_error;
1199 
1200 	if ((stat & STAT_BUSMASK) != STAT_MESGIN)
1201 		goto unexpected_phase_change;
1202 
1203 	fas216_readb(info, REG_INST);
1204 
1205 	return fas216_readb(info, REG_FF);
1206 
1207 timedout:
1208 	fas216_log(info, LOG_ERROR, "timed out waiting for message byte");
1209 	return -1;
1210 
1211 unexpected_phase_change:
1212 	fas216_log(info, LOG_ERROR, "unexpected phase change: status = %02x", stat);
1213 	return -2;
1214 
1215 parity_error:
1216 	fas216_log(info, LOG_ERROR, "parity error during message in phase");
1217 	return -3;
1218 }
1219 
1220 /**
1221  * fas216_message - handle a function done interrupt from FAS216 chip
1222  * @info: interface which caused function done interrupt
1223  *
1224  * Handle a function done interrupt from FAS216 chip
1225  */
1226 static void fas216_message(FAS216_Info *info)
1227 {
1228 	unsigned char *message = info->scsi.message;
1229 	unsigned int msglen = 1;
1230 	int msgbyte = 0;
1231 
1232 	fas216_checkmagic(info);
1233 
1234 	message[0] = fas216_readb(info, REG_FF);
1235 
1236 	if (message[0] == EXTENDED_MESSAGE) {
1237 		msgbyte = fas216_get_msg_byte(info);
1238 
1239 		if (msgbyte >= 0) {
1240 			message[1] = msgbyte;
1241 
1242 			for (msglen = 2; msglen < message[1] + 2; msglen++) {
1243 				msgbyte = fas216_get_msg_byte(info);
1244 
1245 				if (msgbyte >= 0)
1246 					message[msglen] = msgbyte;
1247 				else
1248 					break;
1249 			}
1250 		}
1251 	}
1252 
1253 	if (msgbyte == -3)
1254 		goto parity_error;
1255 
1256 #ifdef DEBUG_MESSAGES
1257 	{
1258 		int i;
1259 
1260 		printk("scsi%d.%c: message in: ",
1261 			info->host->host_no, fas216_target(info));
1262 		for (i = 0; i < msglen; i++)
1263 			printk("%02X ", message[i]);
1264 		printk("\n");
1265 	}
1266 #endif
1267 
1268 	fas216_parse_message(info, message, msglen);
1269 	fas216_cmd(info, CMD_MSGACCEPTED);
1270 	return;
1271 
1272 parity_error:
1273 	fas216_cmd(info, CMD_SETATN);
1274 	msgqueue_flush(&info->scsi.msgs);
1275 	msgqueue_addmsg(&info->scsi.msgs, 1, MSG_PARITY_ERROR);
1276 	info->scsi.phase = PHASE_MSGOUT_EXPECT;
1277 	fas216_cmd(info, CMD_MSGACCEPTED);
1278 	return;
1279 }
1280 
1281 /**
1282  * fas216_send_command - send command after all message bytes have been sent
1283  * @info: interface which caused bus service
1284  *
1285  * Send a command to a target after all message bytes have been sent
1286  */
1287 static void fas216_send_command(FAS216_Info *info)
1288 {
1289 	int i;
1290 
1291 	fas216_checkmagic(info);
1292 
1293 	fas216_cmd(info, CMD_NOP|CMD_WITHDMA);
1294 	fas216_cmd(info, CMD_FLUSHFIFO);
1295 
1296 	/* load command */
1297 	for (i = info->scsi.SCp.sent_command; i < info->SCpnt->cmd_len; i++)
1298 		fas216_writeb(info, REG_FF, info->SCpnt->cmnd[i]);
1299 
1300 	fas216_cmd(info, CMD_TRANSFERINFO);
1301 
1302 	info->scsi.phase = PHASE_COMMAND;
1303 }
1304 
1305 /**
1306  * fas216_send_messageout - handle bus service to send a message
1307  * @info: interface which caused bus service
1308  *
1309  * Handle bus service to send a message.
1310  * Note: We do not allow the device to change the data direction!
1311  */
1312 static void fas216_send_messageout(FAS216_Info *info, int start)
1313 {
1314 	unsigned int tot_msglen = msgqueue_msglength(&info->scsi.msgs);
1315 
1316 	fas216_checkmagic(info);
1317 
1318 	fas216_cmd(info, CMD_FLUSHFIFO);
1319 
1320 	if (tot_msglen) {
1321 		struct message *msg;
1322 		int msgnr = 0;
1323 
1324 		while ((msg = msgqueue_getmsg(&info->scsi.msgs, msgnr++)) != NULL) {
1325 			int i;
1326 
1327 			for (i = start; i < msg->length; i++)
1328 				fas216_writeb(info, REG_FF, msg->msg[i]);
1329 
1330 			msg->fifo = tot_msglen - (fas216_readb(info, REG_CFIS) & CFIS_CF);
1331 			start = 0;
1332 		}
1333 	} else
1334 		fas216_writeb(info, REG_FF, NOP);
1335 
1336 	fas216_cmd(info, CMD_TRANSFERINFO);
1337 
1338 	info->scsi.phase = PHASE_MSGOUT;
1339 }
1340 
1341 /**
1342  * fas216_busservice_intr - handle bus service interrupt from FAS216 chip
1343  * @info: interface which caused bus service interrupt
1344  * @stat: Status register contents
1345  * @is: SCSI Status register contents
1346  *
1347  * Handle a bus service interrupt from FAS216 chip
1348  */
1349 static void fas216_busservice_intr(FAS216_Info *info, unsigned int stat, unsigned int is)
1350 {
1351 	fas216_checkmagic(info);
1352 
1353 	fas216_log(info, LOG_BUSSERVICE,
1354 		   "bus service: stat=%02x is=%02x phase=%02x",
1355 		   stat, is, info->scsi.phase);
1356 
1357 	switch (info->scsi.phase) {
1358 	case PHASE_SELECTION:
1359 		if ((is & IS_BITS) != IS_MSGBYTESENT)
1360 			goto bad_is;
1361 		break;
1362 
1363 	case PHASE_SELSTEPS:
1364 		switch (is & IS_BITS) {
1365 		case IS_SELARB:
1366 		case IS_MSGBYTESENT:
1367 			goto bad_is;
1368 
1369 		case IS_NOTCOMMAND:
1370 		case IS_EARLYPHASE:
1371 			if ((stat & STAT_BUSMASK) == STAT_MESGIN)
1372 				break;
1373 			goto bad_is;
1374 
1375 		case IS_COMPLETE:
1376 			break;
1377 		}
1378 
1379 	default:
1380 		break;
1381 	}
1382 
1383 	fas216_cmd(info, CMD_NOP);
1384 
1385 #define STATE(st,ph) ((ph) << 3 | (st))
1386 	/* This table describes the legal SCSI state transitions,
1387 	 * as described by the SCSI II spec.
1388 	 */
1389 	switch (STATE(stat & STAT_BUSMASK, info->scsi.phase)) {
1390 	case STATE(STAT_DATAIN, PHASE_SELSTEPS):/* Sel w/ steps -> Data In      */
1391 	case STATE(STAT_DATAIN, PHASE_MSGOUT):  /* Message Out  -> Data In      */
1392 	case STATE(STAT_DATAIN, PHASE_COMMAND): /* Command      -> Data In      */
1393 	case STATE(STAT_DATAIN, PHASE_MSGIN):   /* Message In   -> Data In      */
1394 		info->scsi.phase = PHASE_DATAIN;
1395 		fas216_transfer(info);
1396 		return;
1397 
1398 	case STATE(STAT_DATAIN, PHASE_DATAIN):  /* Data In      -> Data In      */
1399 	case STATE(STAT_DATAOUT, PHASE_DATAOUT):/* Data Out     -> Data Out     */
1400 		fas216_cleanuptransfer(info);
1401 		fas216_transfer(info);
1402 		return;
1403 
1404 	case STATE(STAT_DATAOUT, PHASE_SELSTEPS):/* Sel w/ steps-> Data Out     */
1405 	case STATE(STAT_DATAOUT, PHASE_MSGOUT): /* Message Out  -> Data Out     */
1406 	case STATE(STAT_DATAOUT, PHASE_COMMAND):/* Command      -> Data Out     */
1407 	case STATE(STAT_DATAOUT, PHASE_MSGIN):  /* Message In   -> Data Out     */
1408 		fas216_cmd(info, CMD_FLUSHFIFO);
1409 		info->scsi.phase = PHASE_DATAOUT;
1410 		fas216_transfer(info);
1411 		return;
1412 
1413 	case STATE(STAT_STATUS, PHASE_DATAOUT): /* Data Out     -> Status       */
1414 	case STATE(STAT_STATUS, PHASE_DATAIN):  /* Data In      -> Status       */
1415 		fas216_stoptransfer(info);
1416 		fallthrough;
1417 
1418 	case STATE(STAT_STATUS, PHASE_SELSTEPS):/* Sel w/ steps -> Status       */
1419 	case STATE(STAT_STATUS, PHASE_MSGOUT):  /* Message Out  -> Status       */
1420 	case STATE(STAT_STATUS, PHASE_COMMAND): /* Command      -> Status       */
1421 	case STATE(STAT_STATUS, PHASE_MSGIN):   /* Message In   -> Status       */
1422 		fas216_cmd(info, CMD_INITCMDCOMPLETE);
1423 		info->scsi.phase = PHASE_STATUS;
1424 		return;
1425 
1426 	case STATE(STAT_MESGIN, PHASE_DATAOUT): /* Data Out     -> Message In   */
1427 	case STATE(STAT_MESGIN, PHASE_DATAIN):  /* Data In      -> Message In   */
1428 		fas216_stoptransfer(info);
1429 		fallthrough;
1430 
1431 	case STATE(STAT_MESGIN, PHASE_COMMAND):	/* Command	-> Message In	*/
1432 	case STATE(STAT_MESGIN, PHASE_SELSTEPS):/* Sel w/ steps -> Message In   */
1433 	case STATE(STAT_MESGIN, PHASE_MSGOUT):  /* Message Out  -> Message In   */
1434 		info->scsi.msgin_fifo = fas216_readb(info, REG_CFIS) & CFIS_CF;
1435 		fas216_cmd(info, CMD_FLUSHFIFO);
1436 		fas216_cmd(info, CMD_TRANSFERINFO);
1437 		info->scsi.phase = PHASE_MSGIN;
1438 		return;
1439 
1440 	case STATE(STAT_MESGIN, PHASE_MSGIN):
1441 		info->scsi.msgin_fifo = fas216_readb(info, REG_CFIS) & CFIS_CF;
1442 		fas216_cmd(info, CMD_TRANSFERINFO);
1443 		return;
1444 
1445 	case STATE(STAT_COMMAND, PHASE_MSGOUT): /* Message Out  -> Command      */
1446 	case STATE(STAT_COMMAND, PHASE_MSGIN):  /* Message In   -> Command      */
1447 		fas216_send_command(info);
1448 		info->scsi.phase = PHASE_COMMAND;
1449 		return;
1450 
1451 
1452 	/*
1453 	 * Selection    -> Message Out
1454 	 */
1455 	case STATE(STAT_MESGOUT, PHASE_SELECTION):
1456 		fas216_send_messageout(info, 1);
1457 		return;
1458 
1459 	/*
1460 	 * Message Out  -> Message Out
1461 	 */
1462 	case STATE(STAT_MESGOUT, PHASE_SELSTEPS):
1463 	case STATE(STAT_MESGOUT, PHASE_MSGOUT):
1464 		/*
1465 		 * If we get another message out phase, this usually
1466 		 * means some parity error occurred.  Resend complete
1467 		 * set of messages.  If we have more than one byte to
1468 		 * send, we need to assert ATN again.
1469 		 */
1470 		if (info->device[info->SCpnt->device->id].parity_check) {
1471 			/*
1472 			 * We were testing... good, the device
1473 			 * supports parity checking.
1474 			 */
1475 			info->device[info->SCpnt->device->id].parity_check = 0;
1476 			info->device[info->SCpnt->device->id].parity_enabled = 1;
1477 			fas216_writeb(info, REG_CNTL1, info->scsi.cfg[0]);
1478 		}
1479 
1480 		if (msgqueue_msglength(&info->scsi.msgs) > 1)
1481 			fas216_cmd(info, CMD_SETATN);
1482 		fallthrough;
1483 
1484 	/*
1485 	 * Any          -> Message Out
1486 	 */
1487 	case STATE(STAT_MESGOUT, PHASE_MSGOUT_EXPECT):
1488 		fas216_send_messageout(info, 0);
1489 		return;
1490 
1491 	/* Error recovery rules.
1492 	 *   These either attempt to abort or retry the operation.
1493 	 * TODO: we need more of these
1494 	 */
1495 	case STATE(STAT_COMMAND, PHASE_COMMAND):/* Command      -> Command      */
1496 		/* error - we've sent out all the command bytes
1497 		 * we have.
1498 		 * NOTE: we need SAVE DATA POINTERS/RESTORE DATA POINTERS
1499 		 * to include the command bytes sent for this to work
1500 		 * correctly.
1501 		 */
1502 		printk(KERN_ERR "scsi%d.%c: "
1503 			"target trying to receive more command bytes\n",
1504 			info->host->host_no, fas216_target(info));
1505 		fas216_cmd(info, CMD_SETATN);
1506 		fas216_set_stc(info, 15);
1507 		fas216_cmd(info, CMD_PADBYTES | CMD_WITHDMA);
1508 		msgqueue_flush(&info->scsi.msgs);
1509 		msgqueue_addmsg(&info->scsi.msgs, 1, INITIATOR_ERROR);
1510 		info->scsi.phase = PHASE_MSGOUT_EXPECT;
1511 		return;
1512 	}
1513 
1514 	if (info->scsi.phase == PHASE_MSGIN_DISCONNECT) {
1515 		printk(KERN_ERR "scsi%d.%c: disconnect message received, but bus service %s?\n",
1516 			info->host->host_no, fas216_target(info),
1517 			fas216_bus_phase(stat));
1518 		msgqueue_flush(&info->scsi.msgs);
1519 		fas216_cmd(info, CMD_SETATN);
1520 		msgqueue_addmsg(&info->scsi.msgs, 1, INITIATOR_ERROR);
1521 		info->scsi.phase = PHASE_MSGOUT_EXPECT;
1522 		info->scsi.aborting = 1;
1523 		fas216_cmd(info, CMD_TRANSFERINFO);
1524 		return;
1525 	}
1526 	printk(KERN_ERR "scsi%d.%c: bus phase %s after %s?\n",
1527 		info->host->host_no, fas216_target(info),
1528 		fas216_bus_phase(stat),
1529 		fas216_drv_phase(info));
1530 	print_debug_list();
1531 	return;
1532 
1533 bad_is:
1534 	fas216_log(info, 0, "bus service at step %d?", is & IS_BITS);
1535 	fas216_dumpstate(info);
1536 	print_debug_list();
1537 
1538 	fas216_done(info, DID_ERROR);
1539 }
1540 
1541 /**
1542  * fas216_funcdone_intr - handle a function done interrupt from FAS216 chip
1543  * @info: interface which caused function done interrupt
1544  * @stat: Status register contents
1545  * @is: SCSI Status register contents
1546  *
1547  * Handle a function done interrupt from FAS216 chip
1548  */
1549 static void fas216_funcdone_intr(FAS216_Info *info, unsigned int stat, unsigned int is)
1550 {
1551 	unsigned int fifo_len = fas216_readb(info, REG_CFIS) & CFIS_CF;
1552 
1553 	fas216_checkmagic(info);
1554 
1555 	fas216_log(info, LOG_FUNCTIONDONE,
1556 		   "function done: stat=%02x is=%02x phase=%02x",
1557 		   stat, is, info->scsi.phase);
1558 
1559 	switch (info->scsi.phase) {
1560 	case PHASE_STATUS:			/* status phase - read status and msg	*/
1561 		if (fifo_len != 2) {
1562 			fas216_log(info, 0, "odd number of bytes in FIFO: %d", fifo_len);
1563 		}
1564 		/*
1565 		 * Read status then message byte.
1566 		 */
1567 		info->scsi.SCp.Status = fas216_readb(info, REG_FF);
1568 		info->scsi.SCp.Message = fas216_readb(info, REG_FF);
1569 		info->scsi.phase = PHASE_DONE;
1570 		fas216_cmd(info, CMD_MSGACCEPTED);
1571 		break;
1572 
1573 	case PHASE_IDLE:
1574 	case PHASE_SELECTION:
1575 	case PHASE_SELSTEPS:
1576 		break;
1577 
1578 	case PHASE_MSGIN:			/* message in phase			*/
1579 		if ((stat & STAT_BUSMASK) == STAT_MESGIN) {
1580 			info->scsi.msgin_fifo = fifo_len;
1581 			fas216_message(info);
1582 			break;
1583 		}
1584 		fallthrough;
1585 
1586 	default:
1587 		fas216_log(info, 0, "internal phase %s for function done?"
1588 			"  What do I do with this?",
1589 			fas216_target(info), fas216_drv_phase(info));
1590 	}
1591 }
1592 
1593 static void fas216_bus_reset(FAS216_Info *info)
1594 {
1595 	neg_t sync_state;
1596 	int i;
1597 
1598 	msgqueue_flush(&info->scsi.msgs);
1599 
1600 	sync_state = neg_invalid;
1601 
1602 #ifdef SCSI2_SYNC
1603 	if (info->ifcfg.capabilities & (FASCAP_DMA|FASCAP_PSEUDODMA))
1604 		sync_state = neg_wait;
1605 #endif
1606 
1607 	info->scsi.phase = PHASE_IDLE;
1608 	info->SCpnt = NULL; /* bug! */
1609 	memset(&info->scsi.SCp, 0, sizeof(info->scsi.SCp));
1610 
1611 	for (i = 0; i < 8; i++) {
1612 		info->device[i].disconnect_ok	= info->ifcfg.disconnect_ok;
1613 		info->device[i].sync_state	= sync_state;
1614 		info->device[i].period		= info->ifcfg.asyncperiod / 4;
1615 		info->device[i].stp		= info->scsi.async_stp;
1616 		info->device[i].sof		= 0;
1617 		info->device[i].wide_xfer	= 0;
1618 	}
1619 
1620 	info->rst_bus_status = 1;
1621 	wake_up(&info->eh_wait);
1622 }
1623 
1624 /**
1625  * fas216_intr - handle interrupts to progress a command
1626  * @info: interface to service
1627  *
1628  * Handle interrupts from the interface to progress a command
1629  */
1630 irqreturn_t fas216_intr(FAS216_Info *info)
1631 {
1632 	unsigned char inst, is, stat;
1633 	int handled = IRQ_NONE;
1634 
1635 	fas216_checkmagic(info);
1636 
1637 	stat = fas216_readb(info, REG_STAT);
1638 	is = fas216_readb(info, REG_IS);
1639 	inst = fas216_readb(info, REG_INST);
1640 
1641 	add_debug_list(stat, is, inst, info->scsi.phase);
1642 
1643 	if (stat & STAT_INT) {
1644 		if (inst & INST_BUSRESET) {
1645 			fas216_log(info, 0, "bus reset detected");
1646 			fas216_bus_reset(info);
1647 			scsi_report_bus_reset(info->host, 0);
1648 		} else if (inst & INST_ILLEGALCMD) {
1649 			fas216_log(info, LOG_ERROR, "illegal command given\n");
1650 			fas216_dumpstate(info);
1651 			print_debug_list();
1652 		} else if (inst & INST_DISCONNECT)
1653 			fas216_disconnect_intr(info);
1654 		else if (inst & INST_RESELECTED)	/* reselected			*/
1655 			fas216_reselected_intr(info);
1656 		else if (inst & INST_BUSSERVICE)	/* bus service request		*/
1657 			fas216_busservice_intr(info, stat, is);
1658 		else if (inst & INST_FUNCDONE)		/* function done		*/
1659 			fas216_funcdone_intr(info, stat, is);
1660 		else
1661 		    	fas216_log(info, 0, "unknown interrupt received:"
1662 				" phase %s inst %02X is %02X stat %02X",
1663 				fas216_drv_phase(info), inst, is, stat);
1664 		handled = IRQ_HANDLED;
1665 	}
1666 	return handled;
1667 }
1668 
1669 static void __fas216_start_command(FAS216_Info *info, struct scsi_cmnd *SCpnt)
1670 {
1671 	int tot_msglen;
1672 
1673 	/* following what the ESP driver says */
1674 	fas216_set_stc(info, 0);
1675 	fas216_cmd(info, CMD_NOP | CMD_WITHDMA);
1676 
1677 	/* flush FIFO */
1678 	fas216_cmd(info, CMD_FLUSHFIFO);
1679 
1680 	/* load bus-id and timeout */
1681 	fas216_writeb(info, REG_SDID, BUSID(SCpnt->device->id));
1682 	fas216_writeb(info, REG_STIM, info->ifcfg.select_timeout);
1683 
1684 	/* synchronous transfers */
1685 	fas216_set_sync(info, SCpnt->device->id);
1686 
1687 	tot_msglen = msgqueue_msglength(&info->scsi.msgs);
1688 
1689 #ifdef DEBUG_MESSAGES
1690 	{
1691 		struct message *msg;
1692 		int msgnr = 0, i;
1693 
1694 		printk("scsi%d.%c: message out: ",
1695 			info->host->host_no, '0' + SCpnt->device->id);
1696 		while ((msg = msgqueue_getmsg(&info->scsi.msgs, msgnr++)) != NULL) {
1697 			printk("{ ");
1698 			for (i = 0; i < msg->length; i++)
1699 				printk("%02x ", msg->msg[i]);
1700 			printk("} ");
1701 		}
1702 		printk("\n");
1703 	}
1704 #endif
1705 
1706 	if (tot_msglen == 1 || tot_msglen == 3) {
1707 		/*
1708 		 * We have an easy message length to send...
1709 		 */
1710 		struct message *msg;
1711 		int msgnr = 0, i;
1712 
1713 		info->scsi.phase = PHASE_SELSTEPS;
1714 
1715 		/* load message bytes */
1716 		while ((msg = msgqueue_getmsg(&info->scsi.msgs, msgnr++)) != NULL) {
1717 			for (i = 0; i < msg->length; i++)
1718 				fas216_writeb(info, REG_FF, msg->msg[i]);
1719 			msg->fifo = tot_msglen - (fas216_readb(info, REG_CFIS) & CFIS_CF);
1720 		}
1721 
1722 		/* load command */
1723 		for (i = 0; i < SCpnt->cmd_len; i++)
1724 			fas216_writeb(info, REG_FF, SCpnt->cmnd[i]);
1725 
1726 		if (tot_msglen == 1)
1727 			fas216_cmd(info, CMD_SELECTATN);
1728 		else
1729 			fas216_cmd(info, CMD_SELECTATN3);
1730 	} else {
1731 		/*
1732 		 * We have an unusual number of message bytes to send.
1733 		 *  Load first byte into fifo, and issue SELECT with ATN and
1734 		 *  stop steps.
1735 		 */
1736 		struct message *msg = msgqueue_getmsg(&info->scsi.msgs, 0);
1737 
1738 		fas216_writeb(info, REG_FF, msg->msg[0]);
1739 		msg->fifo = 1;
1740 
1741 		fas216_cmd(info, CMD_SELECTATNSTOP);
1742 	}
1743 }
1744 
1745 /*
1746  * Decide whether we need to perform a parity test on this device.
1747  * Can also be used to force parity error conditions during initial
1748  * information transfer phase (message out) for test purposes.
1749  */
1750 static int parity_test(FAS216_Info *info, int target)
1751 {
1752 #if 0
1753 	if (target == 3) {
1754 		info->device[target].parity_check = 0;
1755 		return 1;
1756 	}
1757 #endif
1758 	return info->device[target].parity_check;
1759 }
1760 
1761 static void fas216_start_command(FAS216_Info *info, struct scsi_cmnd *SCpnt)
1762 {
1763 	int disconnect_ok;
1764 
1765 	/*
1766 	 * claim host busy
1767 	 */
1768 	info->scsi.phase = PHASE_SELECTION;
1769 	info->scsi.SCp = SCpnt->SCp;
1770 	info->SCpnt = SCpnt;
1771 	info->dma.transfer_type = fasdma_none;
1772 
1773 	if (parity_test(info, SCpnt->device->id))
1774 		fas216_writeb(info, REG_CNTL1, info->scsi.cfg[0] | CNTL1_PTE);
1775 	else
1776 		fas216_writeb(info, REG_CNTL1, info->scsi.cfg[0]);
1777 
1778 	/*
1779 	 * Don't allow request sense commands to disconnect.
1780 	 */
1781 	disconnect_ok = SCpnt->cmnd[0] != REQUEST_SENSE &&
1782 			info->device[SCpnt->device->id].disconnect_ok;
1783 
1784 	/*
1785 	 * build outgoing message bytes
1786 	 */
1787 	msgqueue_flush(&info->scsi.msgs);
1788 	msgqueue_addmsg(&info->scsi.msgs, 1, IDENTIFY(disconnect_ok, SCpnt->device->lun));
1789 
1790 	/*
1791 	 * add tag message if required
1792 	 */
1793 	if (SCpnt->tag)
1794 		msgqueue_addmsg(&info->scsi.msgs, 2, SIMPLE_QUEUE_TAG, SCpnt->tag);
1795 
1796 	do {
1797 #ifdef SCSI2_SYNC
1798 		if ((info->device[SCpnt->device->id].sync_state == neg_wait ||
1799 		     info->device[SCpnt->device->id].sync_state == neg_complete) &&
1800 		    (SCpnt->cmnd[0] == REQUEST_SENSE ||
1801 		     SCpnt->cmnd[0] == INQUIRY)) {
1802 			info->device[SCpnt->device->id].sync_state = neg_inprogress;
1803 			msgqueue_addmsg(&info->scsi.msgs, 5,
1804 					EXTENDED_MESSAGE, 3, EXTENDED_SDTR,
1805 					1000 / info->ifcfg.clockrate,
1806 					info->ifcfg.sync_max_depth);
1807 			break;
1808 		}
1809 #endif
1810 	} while (0);
1811 
1812 	__fas216_start_command(info, SCpnt);
1813 }
1814 
1815 static void fas216_allocate_tag(FAS216_Info *info, struct scsi_cmnd *SCpnt)
1816 {
1817 #ifdef SCSI2_TAG
1818 	/*
1819 	 * tagged queuing - allocate a new tag to this command
1820 	 */
1821 	if (SCpnt->device->simple_tags && SCpnt->cmnd[0] != REQUEST_SENSE &&
1822 	    SCpnt->cmnd[0] != INQUIRY) {
1823 	    SCpnt->device->current_tag += 1;
1824 		if (SCpnt->device->current_tag == 0)
1825 		    SCpnt->device->current_tag = 1;
1826 			SCpnt->tag = SCpnt->device->current_tag;
1827 	} else
1828 #endif
1829 		set_bit(SCpnt->device->id * 8 +
1830 			(u8)(SCpnt->device->lun & 0x7), info->busyluns);
1831 
1832 	info->stats.removes += 1;
1833 	switch (SCpnt->cmnd[0]) {
1834 	case WRITE_6:
1835 	case WRITE_10:
1836 	case WRITE_12:
1837 		info->stats.writes += 1;
1838 		break;
1839 	case READ_6:
1840 	case READ_10:
1841 	case READ_12:
1842 		info->stats.reads += 1;
1843 		break;
1844 	default:
1845 		info->stats.miscs += 1;
1846 		break;
1847 	}
1848 }
1849 
1850 static void fas216_do_bus_device_reset(FAS216_Info *info,
1851 				       struct scsi_cmnd *SCpnt)
1852 {
1853 	struct message *msg;
1854 
1855 	/*
1856 	 * claim host busy
1857 	 */
1858 	info->scsi.phase = PHASE_SELECTION;
1859 	info->scsi.SCp = SCpnt->SCp;
1860 	info->SCpnt = SCpnt;
1861 	info->dma.transfer_type = fasdma_none;
1862 
1863 	fas216_log(info, LOG_ERROR, "sending bus device reset");
1864 
1865 	msgqueue_flush(&info->scsi.msgs);
1866 	msgqueue_addmsg(&info->scsi.msgs, 1, BUS_DEVICE_RESET);
1867 
1868 	/* following what the ESP driver says */
1869 	fas216_set_stc(info, 0);
1870 	fas216_cmd(info, CMD_NOP | CMD_WITHDMA);
1871 
1872 	/* flush FIFO */
1873 	fas216_cmd(info, CMD_FLUSHFIFO);
1874 
1875 	/* load bus-id and timeout */
1876 	fas216_writeb(info, REG_SDID, BUSID(SCpnt->device->id));
1877 	fas216_writeb(info, REG_STIM, info->ifcfg.select_timeout);
1878 
1879 	/* synchronous transfers */
1880 	fas216_set_sync(info, SCpnt->device->id);
1881 
1882 	msg = msgqueue_getmsg(&info->scsi.msgs, 0);
1883 
1884 	fas216_writeb(info, REG_FF, BUS_DEVICE_RESET);
1885 	msg->fifo = 1;
1886 
1887 	fas216_cmd(info, CMD_SELECTATNSTOP);
1888 }
1889 
1890 /**
1891  * fas216_kick - kick a command to the interface
1892  * @info: our host interface to kick
1893  *
1894  * Kick a command to the interface, interface should be idle.
1895  * Notes: Interrupts are always disabled!
1896  */
1897 static void fas216_kick(FAS216_Info *info)
1898 {
1899 	struct scsi_cmnd *SCpnt = NULL;
1900 #define TYPE_OTHER	0
1901 #define TYPE_RESET	1
1902 #define TYPE_QUEUE	2
1903 	int where_from = TYPE_OTHER;
1904 
1905 	fas216_checkmagic(info);
1906 
1907 	/*
1908 	 * Obtain the next command to process.
1909 	 */
1910 	do {
1911 		if (info->rstSCpnt) {
1912 			SCpnt = info->rstSCpnt;
1913 			/* don't remove it */
1914 			where_from = TYPE_RESET;
1915 			break;
1916 		}
1917 
1918 		if (info->reqSCpnt) {
1919 			SCpnt = info->reqSCpnt;
1920 			info->reqSCpnt = NULL;
1921 			break;
1922 		}
1923 
1924 		if (info->origSCpnt) {
1925 			SCpnt = info->origSCpnt;
1926 			info->origSCpnt = NULL;
1927 			break;
1928 		}
1929 
1930 		/* retrieve next command */
1931 		if (!SCpnt) {
1932 			SCpnt = queue_remove_exclude(&info->queues.issue,
1933 						     info->busyluns);
1934 			where_from = TYPE_QUEUE;
1935 			break;
1936 		}
1937 	} while (0);
1938 
1939 	if (!SCpnt) {
1940 		/*
1941 		 * no command pending, so enable reselection.
1942 		 */
1943 		fas216_cmd(info, CMD_ENABLESEL);
1944 		return;
1945 	}
1946 
1947 	/*
1948 	 * We're going to start a command, so disable reselection
1949 	 */
1950 	fas216_cmd(info, CMD_DISABLESEL);
1951 
1952 	if (info->scsi.disconnectable && info->SCpnt) {
1953 		fas216_log(info, LOG_CONNECT,
1954 			"moved command for %d to disconnected queue",
1955 			info->SCpnt->device->id);
1956 		queue_add_cmd_tail(&info->queues.disconnected, info->SCpnt);
1957 		info->scsi.disconnectable = 0;
1958 		info->SCpnt = NULL;
1959 	}
1960 
1961 	fas216_log_command(info, LOG_CONNECT | LOG_MESSAGES, SCpnt,
1962 			   "starting");
1963 
1964 	switch (where_from) {
1965 	case TYPE_QUEUE:
1966 		fas216_allocate_tag(info, SCpnt);
1967 		fallthrough;
1968 	case TYPE_OTHER:
1969 		fas216_start_command(info, SCpnt);
1970 		break;
1971 	case TYPE_RESET:
1972 		fas216_do_bus_device_reset(info, SCpnt);
1973 		break;
1974 	}
1975 
1976 	fas216_log(info, LOG_CONNECT, "select: data pointers [%p, %X]",
1977 		info->scsi.SCp.ptr, info->scsi.SCp.this_residual);
1978 
1979 	/*
1980 	 * should now get either DISCONNECT or
1981 	 * (FUNCTION DONE with BUS SERVICE) interrupt
1982 	 */
1983 }
1984 
1985 /*
1986  * Clean up from issuing a BUS DEVICE RESET message to a device.
1987  */
1988 static void fas216_devicereset_done(FAS216_Info *info, struct scsi_cmnd *SCpnt,
1989 				    unsigned int result)
1990 {
1991 	fas216_log(info, LOG_ERROR, "fas216 device reset complete");
1992 
1993 	info->rstSCpnt = NULL;
1994 	info->rst_dev_status = 1;
1995 	wake_up(&info->eh_wait);
1996 }
1997 
1998 /**
1999  * fas216_rq_sns_done - Finish processing automatic request sense command
2000  * @info: interface that completed
2001  * @SCpnt: command that completed
2002  * @result: driver byte of result
2003  *
2004  * Finish processing automatic request sense command
2005  */
2006 static void fas216_rq_sns_done(FAS216_Info *info, struct scsi_cmnd *SCpnt,
2007 			       unsigned int result)
2008 {
2009 	fas216_log_target(info, LOG_CONNECT, SCpnt->device->id,
2010 		   "request sense complete, result=0x%04x%02x%02x",
2011 		   result, SCpnt->SCp.Message, SCpnt->SCp.Status);
2012 
2013 	if (result != DID_OK || SCpnt->SCp.Status != SAM_STAT_GOOD)
2014 		/*
2015 		 * Something went wrong.  Make sure that we don't
2016 		 * have valid data in the sense buffer that could
2017 		 * confuse the higher levels.
2018 		 */
2019 		memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2020 //printk("scsi%d.%c: sense buffer: ", info->host->host_no, '0' + SCpnt->device->id);
2021 //{ int i; for (i = 0; i < 32; i++) printk("%02x ", SCpnt->sense_buffer[i]); printk("\n"); }
2022 	/*
2023 	 * Note that we don't set SCpnt->result, since that should
2024 	 * reflect the status of the command that we were asked by
2025 	 * the upper layers to process.  This would have been set
2026 	 * correctly by fas216_std_done.
2027 	 */
2028 	scsi_eh_restore_cmnd(SCpnt, &info->ses);
2029 	SCpnt->scsi_done(SCpnt);
2030 }
2031 
2032 /**
2033  * fas216_std_done - finish processing of standard command
2034  * @info: interface that completed
2035  * @SCpnt: command that completed
2036  * @result: driver byte of result
2037  *
2038  * Finish processing of standard command
2039  */
2040 static void
2041 fas216_std_done(FAS216_Info *info, struct scsi_cmnd *SCpnt, unsigned int result)
2042 {
2043 	info->stats.fins += 1;
2044 
2045 	set_host_byte(SCpnt, result);
2046 	if (result == DID_OK)
2047 		scsi_msg_to_host_byte(SCpnt, info->scsi.SCp.Message);
2048 	set_status_byte(SCpnt, info->scsi.SCp.Status);
2049 
2050 	fas216_log_command(info, LOG_CONNECT, SCpnt,
2051 		"command complete, result=0x%08x", SCpnt->result);
2052 
2053 	/*
2054 	 * If the driver detected an error, we're all done.
2055 	 */
2056 	if (get_host_byte(SCpnt) != DID_OK)
2057 		goto done;
2058 
2059 	/*
2060 	 * If the command returned CHECK_CONDITION or COMMAND_TERMINATED
2061 	 * status, request the sense information.
2062 	 */
2063 	if (get_status_byte(SCpnt) == SAM_STAT_CHECK_CONDITION ||
2064 	    get_status_byte(SCpnt) == SAM_STAT_COMMAND_TERMINATED)
2065 		goto request_sense;
2066 
2067 	/*
2068 	 * If the command did not complete with GOOD status,
2069 	 * we are all done here.
2070 	 */
2071 	if (get_status_byte(SCpnt) != SAM_STAT_GOOD)
2072 		goto done;
2073 
2074 	/*
2075 	 * We have successfully completed a command.  Make sure that
2076 	 * we do not have any buffers left to transfer.  The world
2077 	 * is not perfect, and we seem to occasionally hit this.
2078 	 * It can be indicative of a buggy driver, target or the upper
2079 	 * levels of the SCSI code.
2080 	 */
2081 	if (info->scsi.SCp.ptr) {
2082 		switch (SCpnt->cmnd[0]) {
2083 		case INQUIRY:
2084 		case START_STOP:
2085 		case MODE_SENSE:
2086 			break;
2087 
2088 		default:
2089 			scmd_printk(KERN_ERR, SCpnt,
2090 				    "incomplete data transfer detected: res=%08X ptr=%p len=%X\n",
2091 				    SCpnt->result, info->scsi.SCp.ptr,
2092 				    info->scsi.SCp.this_residual);
2093 			scsi_print_command(SCpnt);
2094 			set_host_byte(SCpnt, DID_ERROR);
2095 			goto request_sense;
2096 		}
2097 	}
2098 
2099 done:
2100 	if (SCpnt->scsi_done) {
2101 		SCpnt->scsi_done(SCpnt);
2102 		return;
2103 	}
2104 
2105 	panic("scsi%d.H: null scsi_done function in fas216_done",
2106 		info->host->host_no);
2107 
2108 
2109 request_sense:
2110 	if (SCpnt->cmnd[0] == REQUEST_SENSE)
2111 		goto done;
2112 
2113 	scsi_eh_prep_cmnd(SCpnt, &info->ses, NULL, 0, ~0);
2114 	fas216_log_target(info, LOG_CONNECT, SCpnt->device->id,
2115 			  "requesting sense");
2116 	init_SCp(SCpnt);
2117 	SCpnt->SCp.Message = 0;
2118 	SCpnt->SCp.Status = 0;
2119 	SCpnt->tag = 0;
2120 	SCpnt->host_scribble = (void *)fas216_rq_sns_done;
2121 
2122 	/*
2123 	 * Place this command into the high priority "request
2124 	 * sense" slot.  This will be the very next command
2125 	 * executed, unless a target connects to us.
2126 	 */
2127 	if (info->reqSCpnt)
2128 		printk(KERN_WARNING "scsi%d.%c: losing request command\n",
2129 			info->host->host_no, '0' + SCpnt->device->id);
2130 	info->reqSCpnt = SCpnt;
2131 }
2132 
2133 /**
2134  * fas216_done - complete processing for current command
2135  * @info: interface that completed
2136  * @result: driver byte of result
2137  *
2138  * Complete processing for current command
2139  */
2140 static void fas216_done(FAS216_Info *info, unsigned int result)
2141 {
2142 	void (*fn)(FAS216_Info *, struct scsi_cmnd *, unsigned int);
2143 	struct scsi_cmnd *SCpnt;
2144 	unsigned long flags;
2145 
2146 	fas216_checkmagic(info);
2147 
2148 	if (!info->SCpnt)
2149 		goto no_command;
2150 
2151 	SCpnt = info->SCpnt;
2152 	info->SCpnt = NULL;
2153     	info->scsi.phase = PHASE_IDLE;
2154 
2155 	if (info->scsi.aborting) {
2156 		fas216_log(info, 0, "uncaught abort - returning DID_ABORT");
2157 		result = DID_ABORT;
2158 		info->scsi.aborting = 0;
2159 	}
2160 
2161 	/*
2162 	 * Sanity check the completion - if we have zero bytes left
2163 	 * to transfer, we should not have a valid pointer.
2164 	 */
2165 	if (info->scsi.SCp.ptr && info->scsi.SCp.this_residual == 0) {
2166 		scmd_printk(KERN_INFO, SCpnt,
2167 			    "zero bytes left to transfer, but buffer pointer still valid: ptr=%p len=%08x\n",
2168 			    info->scsi.SCp.ptr, info->scsi.SCp.this_residual);
2169 		info->scsi.SCp.ptr = NULL;
2170 		scsi_print_command(SCpnt);
2171 	}
2172 
2173 	/*
2174 	 * Clear down this command as completed.  If we need to request
2175 	 * the sense information, fas216_kick will re-assert the busy
2176 	 * status.
2177 	 */
2178 	info->device[SCpnt->device->id].parity_check = 0;
2179 	clear_bit(SCpnt->device->id * 8 +
2180 		  (u8)(SCpnt->device->lun & 0x7), info->busyluns);
2181 
2182 	fn = (void (*)(FAS216_Info *, struct scsi_cmnd *, unsigned int))SCpnt->host_scribble;
2183 	fn(info, SCpnt, result);
2184 
2185 	if (info->scsi.irq) {
2186 		spin_lock_irqsave(&info->host_lock, flags);
2187 		if (info->scsi.phase == PHASE_IDLE)
2188 			fas216_kick(info);
2189 		spin_unlock_irqrestore(&info->host_lock, flags);
2190 	}
2191 	return;
2192 
2193 no_command:
2194 	panic("scsi%d.H: null command in fas216_done",
2195 		info->host->host_no);
2196 }
2197 
2198 /**
2199  * fas216_queue_command - queue a command for adapter to process.
2200  * @SCpnt: Command to queue
2201  * @done: done function to call once command is complete
2202  *
2203  * Queue a command for adapter to process.
2204  * Returns: 0 on success, else error.
2205  * Notes: io_request_lock is held, interrupts are disabled.
2206  */
2207 static int fas216_queue_command_lck(struct scsi_cmnd *SCpnt,
2208 			 void (*done)(struct scsi_cmnd *))
2209 {
2210 	FAS216_Info *info = (FAS216_Info *)SCpnt->device->host->hostdata;
2211 	int result;
2212 
2213 	fas216_checkmagic(info);
2214 
2215 	fas216_log_command(info, LOG_CONNECT, SCpnt,
2216 			   "received command (%p)", SCpnt);
2217 
2218 	SCpnt->scsi_done = done;
2219 	SCpnt->host_scribble = (void *)fas216_std_done;
2220 	SCpnt->result = 0;
2221 
2222 	init_SCp(SCpnt);
2223 
2224 	info->stats.queues += 1;
2225 	SCpnt->tag = 0;
2226 
2227 	spin_lock(&info->host_lock);
2228 
2229 	/*
2230 	 * Add command into execute queue and let it complete under
2231 	 * whatever scheme we're using.
2232 	 */
2233 	result = !queue_add_cmd_ordered(&info->queues.issue, SCpnt);
2234 
2235 	/*
2236 	 * If we successfully added the command,
2237 	 * kick the interface to get it moving.
2238 	 */
2239 	if (result == 0 && info->scsi.phase == PHASE_IDLE)
2240 		fas216_kick(info);
2241 	spin_unlock(&info->host_lock);
2242 
2243 	fas216_log_target(info, LOG_CONNECT, -1, "queue %s",
2244 		result ? "failure" : "success");
2245 
2246 	return result;
2247 }
2248 
2249 DEF_SCSI_QCMD(fas216_queue_command)
2250 
2251 /**
2252  * fas216_internal_done - trigger restart of a waiting thread in fas216_noqueue_command
2253  * @SCpnt: Command to wake
2254  *
2255  * Trigger restart of a waiting thread in fas216_command
2256  */
2257 static void fas216_internal_done(struct scsi_cmnd *SCpnt)
2258 {
2259 	FAS216_Info *info = (FAS216_Info *)SCpnt->device->host->hostdata;
2260 
2261 	fas216_checkmagic(info);
2262 
2263 	info->internal_done = 1;
2264 }
2265 
2266 /**
2267  * fas216_noqueue_command - process a command for the adapter.
2268  * @SCpnt: Command to queue
2269  *
2270  * Queue a command for adapter to process.
2271  * Returns: scsi result code.
2272  * Notes: io_request_lock is held, interrupts are disabled.
2273  */
2274 static int fas216_noqueue_command_lck(struct scsi_cmnd *SCpnt,
2275 			   void (*done)(struct scsi_cmnd *))
2276 {
2277 	FAS216_Info *info = (FAS216_Info *)SCpnt->device->host->hostdata;
2278 
2279 	fas216_checkmagic(info);
2280 
2281 	/*
2282 	 * We should only be using this if we don't have an interrupt.
2283 	 * Provide some "incentive" to use the queueing code.
2284 	 */
2285 	BUG_ON(info->scsi.irq);
2286 
2287 	info->internal_done = 0;
2288 	fas216_queue_command_lck(SCpnt, fas216_internal_done);
2289 
2290 	/*
2291 	 * This wastes time, since we can't return until the command is
2292 	 * complete. We can't sleep either since we may get re-entered!
2293 	 * However, we must re-enable interrupts, or else we'll be
2294 	 * waiting forever.
2295 	 */
2296 	spin_unlock_irq(info->host->host_lock);
2297 
2298 	while (!info->internal_done) {
2299 		/*
2300 		 * If we don't have an IRQ, then we must poll the card for
2301 		 * it's interrupt, and use that to call this driver's
2302 		 * interrupt routine.  That way, we keep the command
2303 		 * progressing.  Maybe we can add some intelligence here
2304 		 * and go to sleep if we know that the device is going
2305 		 * to be some time (eg, disconnected).
2306 		 */
2307 		if (fas216_readb(info, REG_STAT) & STAT_INT) {
2308 			spin_lock_irq(info->host->host_lock);
2309 			fas216_intr(info);
2310 			spin_unlock_irq(info->host->host_lock);
2311 		}
2312 	}
2313 
2314 	spin_lock_irq(info->host->host_lock);
2315 
2316 	done(SCpnt);
2317 
2318 	return 0;
2319 }
2320 
2321 DEF_SCSI_QCMD(fas216_noqueue_command)
2322 
2323 /*
2324  * Error handler timeout function.  Indicate that we timed out,
2325  * and wake up any error handler process so it can continue.
2326  */
2327 static void fas216_eh_timer(struct timer_list *t)
2328 {
2329 	FAS216_Info *info = from_timer(info, t, eh_timer);
2330 
2331 	fas216_log(info, LOG_ERROR, "error handling timed out\n");
2332 
2333 	del_timer(&info->eh_timer);
2334 
2335 	if (info->rst_bus_status == 0)
2336 		info->rst_bus_status = -1;
2337 	if (info->rst_dev_status == 0)
2338 		info->rst_dev_status = -1;
2339 
2340 	wake_up(&info->eh_wait);
2341 }
2342 
2343 enum res_find {
2344 	res_failed,		/* not found			*/
2345 	res_success,		/* command on issue queue	*/
2346 	res_hw_abort		/* command on disconnected dev	*/
2347 };
2348 
2349 /**
2350  * fas216_do_abort - decide how to abort a command
2351  * @SCpnt: command to abort
2352  *
2353  * Decide how to abort a command.
2354  * Returns: abort status
2355  */
2356 static enum res_find fas216_find_command(FAS216_Info *info,
2357 					 struct scsi_cmnd *SCpnt)
2358 {
2359 	enum res_find res = res_failed;
2360 
2361 	if (queue_remove_cmd(&info->queues.issue, SCpnt)) {
2362 		/*
2363 		 * The command was on the issue queue, and has not been
2364 		 * issued yet.  We can remove the command from the queue,
2365 		 * and acknowledge the abort.  Neither the device nor the
2366 		 * interface know about the command.
2367 		 */
2368 		printk("on issue queue ");
2369 
2370 		res = res_success;
2371 	} else if (queue_remove_cmd(&info->queues.disconnected, SCpnt)) {
2372 		/*
2373 		 * The command was on the disconnected queue.  We must
2374 		 * reconnect with the device if possible, and send it
2375 		 * an abort message.
2376 		 */
2377 		printk("on disconnected queue ");
2378 
2379 		res = res_hw_abort;
2380 	} else if (info->SCpnt == SCpnt) {
2381 		printk("executing ");
2382 
2383 		switch (info->scsi.phase) {
2384 		/*
2385 		 * If the interface is idle, and the command is 'disconnectable',
2386 		 * then it is the same as on the disconnected queue.
2387 		 */
2388 		case PHASE_IDLE:
2389 			if (info->scsi.disconnectable) {
2390 				info->scsi.disconnectable = 0;
2391 				info->SCpnt = NULL;
2392 				res = res_hw_abort;
2393 			}
2394 			break;
2395 
2396 		default:
2397 			break;
2398 		}
2399 	} else if (info->origSCpnt == SCpnt) {
2400 		/*
2401 		 * The command will be executed next, but a command
2402 		 * is currently using the interface.  This is similar to
2403 		 * being on the issue queue, except the busylun bit has
2404 		 * been set.
2405 		 */
2406 		info->origSCpnt = NULL;
2407 		clear_bit(SCpnt->device->id * 8 +
2408 			  (u8)(SCpnt->device->lun & 0x7), info->busyluns);
2409 		printk("waiting for execution ");
2410 		res = res_success;
2411 	} else
2412 		printk("unknown ");
2413 
2414 	return res;
2415 }
2416 
2417 /**
2418  * fas216_eh_abort - abort this command
2419  * @SCpnt: command to abort
2420  *
2421  * Abort this command.
2422  * Returns: FAILED if unable to abort
2423  * Notes: io_request_lock is taken, and irqs are disabled
2424  */
2425 int fas216_eh_abort(struct scsi_cmnd *SCpnt)
2426 {
2427 	FAS216_Info *info = (FAS216_Info *)SCpnt->device->host->hostdata;
2428 	int result = FAILED;
2429 
2430 	fas216_checkmagic(info);
2431 
2432 	info->stats.aborts += 1;
2433 
2434 	scmd_printk(KERN_WARNING, SCpnt, "abort command\n");
2435 
2436 	print_debug_list();
2437 	fas216_dumpstate(info);
2438 
2439 	switch (fas216_find_command(info, SCpnt)) {
2440 	/*
2441 	 * We found the command, and cleared it out.  Either
2442 	 * the command is still known to be executing on the
2443 	 * target, or the busylun bit is not set.
2444 	 */
2445 	case res_success:
2446 		scmd_printk(KERN_WARNING, SCpnt, "abort %p success\n", SCpnt);
2447 		result = SUCCESS;
2448 		break;
2449 
2450 	/*
2451 	 * We need to reconnect to the target and send it an
2452 	 * ABORT or ABORT_TAG message.  We can only do this
2453 	 * if the bus is free.
2454 	 */
2455 	case res_hw_abort:
2456 
2457 	/*
2458 	 * We are unable to abort the command for some reason.
2459 	 */
2460 	default:
2461 	case res_failed:
2462 		scmd_printk(KERN_WARNING, SCpnt, "abort %p failed\n", SCpnt);
2463 		break;
2464 	}
2465 
2466 	return result;
2467 }
2468 
2469 /**
2470  * fas216_eh_device_reset - Reset the device associated with this command
2471  * @SCpnt: command specifing device to reset
2472  *
2473  * Reset the device associated with this command.
2474  * Returns: FAILED if unable to reset.
2475  * Notes: We won't be re-entered, so we'll only have one device
2476  * reset on the go at one time.
2477  */
2478 int fas216_eh_device_reset(struct scsi_cmnd *SCpnt)
2479 {
2480 	FAS216_Info *info = (FAS216_Info *)SCpnt->device->host->hostdata;
2481 	unsigned long flags;
2482 	int i, res = FAILED, target = SCpnt->device->id;
2483 
2484 	fas216_log(info, LOG_ERROR, "device reset for target %d", target);
2485 
2486 	spin_lock_irqsave(&info->host_lock, flags);
2487 
2488 	do {
2489 		/*
2490 		 * If we are currently connected to a device, and
2491 		 * it is the device we want to reset, there is
2492 		 * nothing we can do here.  Chances are it is stuck,
2493 		 * and we need a bus reset.
2494 		 */
2495 		if (info->SCpnt && !info->scsi.disconnectable &&
2496 		    info->SCpnt->device->id == SCpnt->device->id)
2497 			break;
2498 
2499 		/*
2500 		 * We're going to be resetting this device.  Remove
2501 		 * all pending commands from the driver.  By doing
2502 		 * so, we guarantee that we won't touch the command
2503 		 * structures except to process the reset request.
2504 		 */
2505 		queue_remove_all_target(&info->queues.issue, target);
2506 		queue_remove_all_target(&info->queues.disconnected, target);
2507 		if (info->origSCpnt && info->origSCpnt->device->id == target)
2508 			info->origSCpnt = NULL;
2509 		if (info->reqSCpnt && info->reqSCpnt->device->id == target)
2510 			info->reqSCpnt = NULL;
2511 		for (i = 0; i < 8; i++)
2512 			clear_bit(target * 8 + i, info->busyluns);
2513 
2514 		/*
2515 		 * Hijack this SCSI command structure to send
2516 		 * a bus device reset message to this device.
2517 		 */
2518 		SCpnt->host_scribble = (void *)fas216_devicereset_done;
2519 
2520 		info->rst_dev_status = 0;
2521 		info->rstSCpnt = SCpnt;
2522 
2523 		if (info->scsi.phase == PHASE_IDLE)
2524 			fas216_kick(info);
2525 
2526 		mod_timer(&info->eh_timer, jiffies + 30 * HZ);
2527 		spin_unlock_irqrestore(&info->host_lock, flags);
2528 
2529 		/*
2530 		 * Wait up to 30 seconds for the reset to complete.
2531 		 */
2532 		wait_event(info->eh_wait, info->rst_dev_status);
2533 
2534 		del_timer_sync(&info->eh_timer);
2535 		spin_lock_irqsave(&info->host_lock, flags);
2536 		info->rstSCpnt = NULL;
2537 
2538 		if (info->rst_dev_status == 1)
2539 			res = SUCCESS;
2540 	} while (0);
2541 
2542 	SCpnt->host_scribble = NULL;
2543 	spin_unlock_irqrestore(&info->host_lock, flags);
2544 
2545 	fas216_log(info, LOG_ERROR, "device reset complete: %s\n",
2546 		   res == SUCCESS ? "success" : "failed");
2547 
2548 	return res;
2549 }
2550 
2551 /**
2552  * fas216_eh_bus_reset - Reset the bus associated with the command
2553  * @SCpnt: command specifing bus to reset
2554  *
2555  * Reset the bus associated with the command.
2556  * Returns: FAILED if unable to reset.
2557  * Notes: Further commands are blocked.
2558  */
2559 int fas216_eh_bus_reset(struct scsi_cmnd *SCpnt)
2560 {
2561 	FAS216_Info *info = (FAS216_Info *)SCpnt->device->host->hostdata;
2562 	unsigned long flags;
2563 	struct scsi_device *SDpnt;
2564 
2565 	fas216_checkmagic(info);
2566 	fas216_log(info, LOG_ERROR, "resetting bus");
2567 
2568 	info->stats.bus_resets += 1;
2569 
2570 	spin_lock_irqsave(&info->host_lock, flags);
2571 
2572 	/*
2573 	 * Stop all activity on this interface.
2574 	 */
2575 	fas216_aborttransfer(info);
2576 	fas216_writeb(info, REG_CNTL3, info->scsi.cfg[2]);
2577 
2578 	/*
2579 	 * Clear any pending interrupts.
2580 	 */
2581 	while (fas216_readb(info, REG_STAT) & STAT_INT)
2582 		fas216_readb(info, REG_INST);
2583 
2584 	info->rst_bus_status = 0;
2585 
2586 	/*
2587 	 * For each attached hard-reset device, clear out
2588 	 * all command structures.  Leave the running
2589 	 * command in place.
2590 	 */
2591 	shost_for_each_device(SDpnt, info->host) {
2592 		int i;
2593 
2594 		if (SDpnt->soft_reset)
2595 			continue;
2596 
2597 		queue_remove_all_target(&info->queues.issue, SDpnt->id);
2598 		queue_remove_all_target(&info->queues.disconnected, SDpnt->id);
2599 		if (info->origSCpnt && info->origSCpnt->device->id == SDpnt->id)
2600 			info->origSCpnt = NULL;
2601 		if (info->reqSCpnt && info->reqSCpnt->device->id == SDpnt->id)
2602 			info->reqSCpnt = NULL;
2603 		info->SCpnt = NULL;
2604 
2605 		for (i = 0; i < 8; i++)
2606 			clear_bit(SDpnt->id * 8 + i, info->busyluns);
2607 	}
2608 
2609 	info->scsi.phase = PHASE_IDLE;
2610 
2611 	/*
2612 	 * Reset the SCSI bus.  Device cleanup happens in
2613 	 * the interrupt handler.
2614 	 */
2615 	fas216_cmd(info, CMD_RESETSCSI);
2616 
2617 	mod_timer(&info->eh_timer, jiffies + HZ);
2618 	spin_unlock_irqrestore(&info->host_lock, flags);
2619 
2620 	/*
2621 	 * Wait one second for the interrupt.
2622 	 */
2623 	wait_event(info->eh_wait, info->rst_bus_status);
2624 	del_timer_sync(&info->eh_timer);
2625 
2626 	fas216_log(info, LOG_ERROR, "bus reset complete: %s\n",
2627 		   info->rst_bus_status == 1 ? "success" : "failed");
2628 
2629 	return info->rst_bus_status == 1 ? SUCCESS : FAILED;
2630 }
2631 
2632 /**
2633  * fas216_init_chip - Initialise FAS216 state after reset
2634  * @info: state structure for interface
2635  *
2636  * Initialise FAS216 state after reset
2637  */
2638 static void fas216_init_chip(FAS216_Info *info)
2639 {
2640 	unsigned int clock = ((info->ifcfg.clockrate - 1) / 5 + 1) & 7;
2641 	fas216_writeb(info, REG_CLKF, clock);
2642 	fas216_writeb(info, REG_CNTL1, info->scsi.cfg[0]);
2643 	fas216_writeb(info, REG_CNTL2, info->scsi.cfg[1]);
2644 	fas216_writeb(info, REG_CNTL3, info->scsi.cfg[2]);
2645 	fas216_writeb(info, REG_STIM, info->ifcfg.select_timeout);
2646 	fas216_writeb(info, REG_SOF, 0);
2647 	fas216_writeb(info, REG_STP, info->scsi.async_stp);
2648 	fas216_writeb(info, REG_CNTL1, info->scsi.cfg[0]);
2649 }
2650 
2651 /**
2652  * fas216_eh_host_reset - Reset the host associated with this command
2653  * @SCpnt: command specifing host to reset
2654  *
2655  * Reset the host associated with this command.
2656  * Returns: FAILED if unable to reset.
2657  * Notes: io_request_lock is taken, and irqs are disabled
2658  */
2659 int fas216_eh_host_reset(struct scsi_cmnd *SCpnt)
2660 {
2661 	FAS216_Info *info = (FAS216_Info *)SCpnt->device->host->hostdata;
2662 
2663 	spin_lock_irq(info->host->host_lock);
2664 
2665 	fas216_checkmagic(info);
2666 
2667 	fas216_log(info, LOG_ERROR, "resetting host");
2668 
2669 	/*
2670 	 * Reset the SCSI chip.
2671 	 */
2672 	fas216_cmd(info, CMD_RESETCHIP);
2673 
2674 	/*
2675 	 * Ugly ugly ugly!
2676 	 * We need to release the host_lock and enable
2677 	 * IRQs if we sleep, but we must relock and disable
2678 	 * IRQs after the sleep.
2679 	 */
2680 	spin_unlock_irq(info->host->host_lock);
2681 	msleep(50 * 1000/100);
2682 	spin_lock_irq(info->host->host_lock);
2683 
2684 	/*
2685 	 * Release the SCSI reset.
2686 	 */
2687 	fas216_cmd(info, CMD_NOP);
2688 
2689 	fas216_init_chip(info);
2690 
2691 	spin_unlock_irq(info->host->host_lock);
2692 	return SUCCESS;
2693 }
2694 
2695 #define TYPE_UNKNOWN	0
2696 #define TYPE_NCR53C90	1
2697 #define TYPE_NCR53C90A	2
2698 #define TYPE_NCR53C9x	3
2699 #define TYPE_Am53CF94	4
2700 #define TYPE_EmFAS216	5
2701 #define TYPE_QLFAS216	6
2702 
2703 static char *chip_types[] = {
2704 	"unknown",
2705 	"NS NCR53C90",
2706 	"NS NCR53C90A",
2707 	"NS NCR53C9x",
2708 	"AMD Am53CF94",
2709 	"Emulex FAS216",
2710 	"QLogic FAS216"
2711 };
2712 
2713 static int fas216_detect_type(FAS216_Info *info)
2714 {
2715 	int family, rev;
2716 
2717 	/*
2718 	 * Reset the chip.
2719 	 */
2720 	fas216_writeb(info, REG_CMD, CMD_RESETCHIP);
2721 	udelay(50);
2722 	fas216_writeb(info, REG_CMD, CMD_NOP);
2723 
2724 	/*
2725 	 * Check to see if control reg 2 is present.
2726 	 */
2727 	fas216_writeb(info, REG_CNTL3, 0);
2728 	fas216_writeb(info, REG_CNTL2, CNTL2_S2FE);
2729 
2730 	/*
2731 	 * If we are unable to read back control reg 2
2732 	 * correctly, it is not present, and we have a
2733 	 * NCR53C90.
2734 	 */
2735 	if ((fas216_readb(info, REG_CNTL2) & (~0xe0)) != CNTL2_S2FE)
2736 		return TYPE_NCR53C90;
2737 
2738 	/*
2739 	 * Now, check control register 3
2740 	 */
2741 	fas216_writeb(info, REG_CNTL2, 0);
2742 	fas216_writeb(info, REG_CNTL3, 0);
2743 	fas216_writeb(info, REG_CNTL3, 5);
2744 
2745 	/*
2746 	 * If we are unable to read the register back
2747 	 * correctly, we have a NCR53C90A
2748 	 */
2749 	if (fas216_readb(info, REG_CNTL3) != 5)
2750 		return TYPE_NCR53C90A;
2751 
2752 	/*
2753 	 * Now read the ID from the chip.
2754 	 */
2755 	fas216_writeb(info, REG_CNTL3, 0);
2756 
2757 	fas216_writeb(info, REG_CNTL3, CNTL3_ADIDCHK);
2758 	fas216_writeb(info, REG_CNTL3, 0);
2759 
2760 	fas216_writeb(info, REG_CMD, CMD_RESETCHIP);
2761 	udelay(50);
2762 	fas216_writeb(info, REG_CMD, CMD_WITHDMA | CMD_NOP);
2763 
2764 	fas216_writeb(info, REG_CNTL2, CNTL2_ENF);
2765 	fas216_writeb(info, REG_CMD, CMD_RESETCHIP);
2766 	udelay(50);
2767 	fas216_writeb(info, REG_CMD, CMD_NOP);
2768 
2769 	rev     = fas216_readb(info, REG_ID);
2770 	family  = rev >> 3;
2771 	rev    &= 7;
2772 
2773 	switch (family) {
2774 	case 0x01:
2775 		if (rev == 4)
2776 			return TYPE_Am53CF94;
2777 		break;
2778 
2779 	case 0x02:
2780 		switch (rev) {
2781 		case 2:
2782 			return TYPE_EmFAS216;
2783 		case 3:
2784 			return TYPE_QLFAS216;
2785 		}
2786 		break;
2787 
2788 	default:
2789 		break;
2790 	}
2791 	printk("family %x rev %x\n", family, rev);
2792 	return TYPE_NCR53C9x;
2793 }
2794 
2795 /**
2796  * fas216_reset_state - Initialise driver internal state
2797  * @info: state to initialise
2798  *
2799  * Initialise driver internal state
2800  */
2801 static void fas216_reset_state(FAS216_Info *info)
2802 {
2803 	int i;
2804 
2805 	fas216_checkmagic(info);
2806 
2807 	fas216_bus_reset(info);
2808 
2809 	/*
2810 	 * Clear out all stale info in our state structure
2811 	 */
2812 	memset(info->busyluns, 0, sizeof(info->busyluns));
2813 	info->scsi.disconnectable = 0;
2814 	info->scsi.aborting = 0;
2815 
2816 	for (i = 0; i < 8; i++) {
2817 		info->device[i].parity_enabled	= 0;
2818 		info->device[i].parity_check	= 1;
2819 	}
2820 
2821 	/*
2822 	 * Drain all commands on disconnected queue
2823 	 */
2824 	while (queue_remove(&info->queues.disconnected) != NULL);
2825 
2826 	/*
2827 	 * Remove executing commands.
2828 	 */
2829 	info->SCpnt     = NULL;
2830 	info->reqSCpnt  = NULL;
2831 	info->rstSCpnt  = NULL;
2832 	info->origSCpnt = NULL;
2833 }
2834 
2835 /**
2836  * fas216_init - initialise FAS/NCR/AMD SCSI structures.
2837  * @host: a driver-specific filled-out structure
2838  *
2839  * Initialise FAS/NCR/AMD SCSI structures.
2840  * Returns: 0 on success
2841  */
2842 int fas216_init(struct Scsi_Host *host)
2843 {
2844 	FAS216_Info *info = (FAS216_Info *)host->hostdata;
2845 
2846 	info->magic_start    = MAGIC;
2847 	info->magic_end      = MAGIC;
2848 	info->host           = host;
2849 	info->scsi.cfg[0]    = host->this_id | CNTL1_PERE;
2850 	info->scsi.cfg[1]    = CNTL2_ENF | CNTL2_S2FE;
2851 	info->scsi.cfg[2]    = info->ifcfg.cntl3 |
2852 			       CNTL3_ADIDCHK | CNTL3_QTAG | CNTL3_G2CB | CNTL3_LBTM;
2853 	info->scsi.async_stp = fas216_syncperiod(info, info->ifcfg.asyncperiod);
2854 
2855 	info->rst_dev_status = -1;
2856 	info->rst_bus_status = -1;
2857 	init_waitqueue_head(&info->eh_wait);
2858 	timer_setup(&info->eh_timer, fas216_eh_timer, 0);
2859 
2860 	spin_lock_init(&info->host_lock);
2861 
2862 	memset(&info->stats, 0, sizeof(info->stats));
2863 
2864 	msgqueue_initialise(&info->scsi.msgs);
2865 
2866 	if (!queue_initialise(&info->queues.issue))
2867 		return -ENOMEM;
2868 
2869 	if (!queue_initialise(&info->queues.disconnected)) {
2870 		queue_free(&info->queues.issue);
2871 		return -ENOMEM;
2872 	}
2873 
2874 	return 0;
2875 }
2876 
2877 /**
2878  * fas216_add - initialise FAS/NCR/AMD SCSI ic.
2879  * @host: a driver-specific filled-out structure
2880  * @dev: parent device
2881  *
2882  * Initialise FAS/NCR/AMD SCSI ic.
2883  * Returns: 0 on success
2884  */
2885 int fas216_add(struct Scsi_Host *host, struct device *dev)
2886 {
2887 	FAS216_Info *info = (FAS216_Info *)host->hostdata;
2888 	int type, ret;
2889 
2890 	if (info->ifcfg.clockrate <= 10 || info->ifcfg.clockrate > 40) {
2891 		printk(KERN_CRIT "fas216: invalid clock rate %u MHz\n",
2892 			info->ifcfg.clockrate);
2893 		return -EINVAL;
2894 	}
2895 
2896 	fas216_reset_state(info);
2897 	type = fas216_detect_type(info);
2898 	info->scsi.type = chip_types[type];
2899 
2900 	udelay(300);
2901 
2902 	/*
2903 	 * Initialise the chip correctly.
2904 	 */
2905 	fas216_init_chip(info);
2906 
2907 	/*
2908 	 * Reset the SCSI bus.  We don't want to see
2909 	 * the resulting reset interrupt, so mask it
2910 	 * out.
2911 	 */
2912 	fas216_writeb(info, REG_CNTL1, info->scsi.cfg[0] | CNTL1_DISR);
2913 	fas216_writeb(info, REG_CMD, CMD_RESETSCSI);
2914 
2915 	/*
2916 	 * scsi standard says wait 250ms
2917 	 */
2918 	spin_unlock_irq(info->host->host_lock);
2919 	msleep(100*1000/100);
2920 	spin_lock_irq(info->host->host_lock);
2921 
2922 	fas216_writeb(info, REG_CNTL1, info->scsi.cfg[0]);
2923 	fas216_readb(info, REG_INST);
2924 
2925 	fas216_checkmagic(info);
2926 
2927 	ret = scsi_add_host(host, dev);
2928 	if (ret)
2929 		fas216_writeb(info, REG_CMD, CMD_RESETCHIP);
2930 	else
2931 		scsi_scan_host(host);
2932 
2933 	return ret;
2934 }
2935 
2936 void fas216_remove(struct Scsi_Host *host)
2937 {
2938 	FAS216_Info *info = (FAS216_Info *)host->hostdata;
2939 
2940 	fas216_checkmagic(info);
2941 	scsi_remove_host(host);
2942 
2943 	fas216_writeb(info, REG_CMD, CMD_RESETCHIP);
2944 	scsi_host_put(host);
2945 }
2946 
2947 /**
2948  * fas216_release - release all resources for FAS/NCR/AMD SCSI ic.
2949  * @host: a driver-specific filled-out structure
2950  *
2951  * release all resources and put everything to bed for FAS/NCR/AMD SCSI ic.
2952  */
2953 void fas216_release(struct Scsi_Host *host)
2954 {
2955 	FAS216_Info *info = (FAS216_Info *)host->hostdata;
2956 
2957 	queue_free(&info->queues.disconnected);
2958 	queue_free(&info->queues.issue);
2959 }
2960 
2961 void fas216_print_host(FAS216_Info *info, struct seq_file *m)
2962 {
2963 	seq_printf(m,
2964 			"\n"
2965 			"Chip    : %s\n"
2966 			" Address: 0x%p\n"
2967 			" IRQ    : %d\n"
2968 			" DMA    : %d\n",
2969 			info->scsi.type, info->scsi.io_base,
2970 			info->scsi.irq, info->scsi.dma);
2971 }
2972 
2973 void fas216_print_stats(FAS216_Info *info, struct seq_file *m)
2974 {
2975 	seq_printf(m, "\n"
2976 			"Command Statistics:\n"
2977 			" Queued     : %u\n"
2978 			" Issued     : %u\n"
2979 			" Completed  : %u\n"
2980 			" Reads      : %u\n"
2981 			" Writes     : %u\n"
2982 			" Others     : %u\n"
2983 			" Disconnects: %u\n"
2984 			" Aborts     : %u\n"
2985 			" Bus resets : %u\n"
2986 			" Host resets: %u\n",
2987 			info->stats.queues,	 info->stats.removes,
2988 			info->stats.fins,	 info->stats.reads,
2989 			info->stats.writes,	 info->stats.miscs,
2990 			info->stats.disconnects, info->stats.aborts,
2991 			info->stats.bus_resets,	 info->stats.host_resets);
2992 }
2993 
2994 void fas216_print_devices(FAS216_Info *info, struct seq_file *m)
2995 {
2996 	struct fas216_device *dev;
2997 	struct scsi_device *scd;
2998 
2999 	seq_puts(m, "Device/Lun TaggedQ       Parity   Sync\n");
3000 
3001 	shost_for_each_device(scd, info->host) {
3002 		dev = &info->device[scd->id];
3003 		seq_printf(m, "     %d/%llu   ", scd->id, scd->lun);
3004 		if (scd->tagged_supported)
3005 			seq_printf(m, "%3sabled(%3d) ",
3006 				     scd->simple_tags ? "en" : "dis",
3007 				     scd->current_tag);
3008 		else
3009 			seq_puts(m, "unsupported   ");
3010 
3011 		seq_printf(m, "%3sabled ", dev->parity_enabled ? "en" : "dis");
3012 
3013 		if (dev->sof)
3014 			seq_printf(m, "offset %d, %d ns\n",
3015 				     dev->sof, dev->period * 4);
3016 		else
3017 			seq_puts(m, "async\n");
3018 	}
3019 }
3020 
3021 EXPORT_SYMBOL(fas216_init);
3022 EXPORT_SYMBOL(fas216_add);
3023 EXPORT_SYMBOL(fas216_queue_command);
3024 EXPORT_SYMBOL(fas216_noqueue_command);
3025 EXPORT_SYMBOL(fas216_intr);
3026 EXPORT_SYMBOL(fas216_remove);
3027 EXPORT_SYMBOL(fas216_release);
3028 EXPORT_SYMBOL(fas216_eh_abort);
3029 EXPORT_SYMBOL(fas216_eh_device_reset);
3030 EXPORT_SYMBOL(fas216_eh_bus_reset);
3031 EXPORT_SYMBOL(fas216_eh_host_reset);
3032 EXPORT_SYMBOL(fas216_print_host);
3033 EXPORT_SYMBOL(fas216_print_stats);
3034 EXPORT_SYMBOL(fas216_print_devices);
3035 
3036 MODULE_AUTHOR("Russell King");
3037 MODULE_DESCRIPTION("Generic FAS216/NCR53C9x driver core");
3038 MODULE_LICENSE("GPL");
3039