Linux Audio

Check our new training course

Loading...
Note: File does not exist in v6.8.
  1#define AUTOSENSE
  2#define PSEUDO_DMA
  3#define FOO
  4#define UNSAFE  /* Not unsafe for PAS16 -- use it */
  5#define PDEBUG 0
  6
  7/*
  8 * This driver adapted from Drew Eckhardt's Trantor T128 driver
  9 *
 10 * Copyright 1993, Drew Eckhardt
 11 *	Visionary Computing
 12 *	(Unix and Linux consulting and custom programming)
 13 *	drew@colorado.edu
 14 *      +1 (303) 666-5836
 15 *
 16 *  ( Based on T128 - DISTRIBUTION RELEASE 3. ) 
 17 *
 18 * Modified to work with the Pro Audio Spectrum/Studio 16
 19 * by John Weidman.
 20 *
 21 *
 22 * For more information, please consult 
 23 *
 24 * Media Vision
 25 * (510) 770-8600
 26 * (800) 348-7116
 27 * 
 28 * and 
 29 *
 30 * NCR 5380 Family
 31 * SCSI Protocol Controller
 32 * Databook
 33 *
 34 * NCR Microelectronics
 35 * 1635 Aeroplaza Drive
 36 * Colorado Springs, CO 80916
 37 * 1+ (719) 578-3400
 38 * 1+ (800) 334-5454
 39 */
 40
 41/*
 42 * Options : 
 43 * AUTOSENSE - if defined, REQUEST SENSE will be performed automatically
 44 *      for commands that return with a CHECK CONDITION status. 
 45 *
 46 * LIMIT_TRANSFERSIZE - if defined, limit the pseudo-dma transfers to 512
 47 *      bytes at a time.  Since interrupts are disabled by default during
 48 *      these transfers, we might need this to give reasonable interrupt
 49 *      service time if the transfer size gets too large.
 50 *
 51 * PSEUDO_DMA - enables PSEUDO-DMA hardware, should give a 3-4X performance
 52 * increase compared to polled I/O.
 53 *
 54 * PARITY - enable parity checking.  Not supported.
 55 * 
 56 * SCSI2 - enable support for SCSI-II tagged queueing.  Untested.
 57 *
 58 * UNSAFE - leave interrupts enabled during pseudo-DMA transfers.  This
 59 *	    parameter comes from the NCR5380 code.  It is NOT unsafe with
 60 *	    the PAS16 and you should use it.  If you don't you will have
 61 *	    a problem with dropped characters during high speed
 62 *	    communications during SCSI transfers.  If you really don't
 63 *	    want to use UNSAFE you can try defining LIMIT_TRANSFERSIZE or
 64 *	    twiddle with the transfer size in the high level code.
 65 *
 66 * USLEEP - enable support for devices that don't disconnect.  Untested.
 67 *
 68 * The card is detected and initialized in one of several ways : 
 69 * 1.  Autoprobe (default) - There are many different models of
 70 *     the Pro Audio Spectrum/Studio 16, and I only have one of
 71 *     them, so this may require a little tweaking.  An interrupt
 72 *     is triggered to autoprobe for the interrupt line.  Note:
 73 *     with the newer model boards, the interrupt is set via
 74 *     software after reset using the default_irq for the
 75 *     current board number.
 76 *
 77 * 2.  With command line overrides - pas16=port,irq may be 
 78 *     used on the LILO command line to override the defaults.
 79 *
 80 * 3.  With the PAS16_OVERRIDE compile time define.  This is 
 81 *     specified as an array of address, irq tuples.  Ie, for
 82 *     one board at the default 0x388 address, IRQ10, I could say 
 83 *     -DPAS16_OVERRIDE={{0x388, 10}}
 84 *     NOTE:  Untested.
 85 *	
 86 * 4.  When included as a module, with arguments passed on the command line:
 87 *         pas16_irq=xx		the interrupt
 88 *         pas16_addr=xx	the port
 89 *     e.g. "modprobe pas16 pas16_addr=0x388 pas16_irq=5"
 90 *
 91 *     Note that if the override methods are used, place holders must
 92 *     be specified for other boards in the system.
 93 *
 94 *
 95 * Configuration notes :
 96 *   The current driver does not support interrupt sharing with the
 97 *   sound portion of the card.  If you use the same irq for the
 98 *   scsi port and sound you will have problems.  Either use
 99 *   a different irq for the scsi port or don't use interrupts
100 *   for the scsi port.
101 *
102 *   If you have problems with your card not being recognized, use
103 *   the LILO command line override.  Try to get it recognized without
104 *   interrupts.  Ie, for a board at the default 0x388 base port,
105 *   boot: linux pas16=0x388,255
106 *
107 *   SCSI_IRQ_NONE (255) should be specified for no interrupt,
108 *   IRQ_AUTO (254) to autoprobe for an IRQ line if overridden
109 *   on the command line.
110 *
111 *   (IRQ_AUTO == 254, SCSI_IRQ_NONE == 255 in NCR5380.h)
112 */
113 
114#include <linux/module.h>
115
116#include <linux/signal.h>
117#include <linux/proc_fs.h>
118#include <asm/io.h>
119#include <asm/dma.h>
120#include <linux/blkdev.h>
121#include <linux/delay.h>
122#include <linux/interrupt.h>
123#include <linux/stat.h>
124#include <linux/init.h>
125
126#include "scsi.h"
127#include <scsi/scsi_host.h>
128#include "pas16.h"
129#define AUTOPROBE_IRQ
130#include "NCR5380.h"
131
132
133static int pas_maxi = 0;
134static int pas_wmaxi = 0;
135static unsigned short pas16_addr = 0;
136static int pas16_irq = 0;
137 
138
139static const int scsi_irq_translate[] =
140	{ 0,  0,  1,  2,  3,  4,  5,  6, 0,  0,  7,  8,  9,  0, 10, 11 };
141
142/* The default_irqs array contains values used to set the irq into the
143 * board via software (as must be done on newer model boards without
144 * irq jumpers on the board).  The first value in the array will be
145 * assigned to logical board 0, the next to board 1, etc.
146 */
147static int default_irqs[] __initdata =
148	{  PAS16_DEFAULT_BOARD_1_IRQ,
149	   PAS16_DEFAULT_BOARD_2_IRQ,
150	   PAS16_DEFAULT_BOARD_3_IRQ,
151	   PAS16_DEFAULT_BOARD_4_IRQ
152	};
153
154static struct override {
155    unsigned short io_port;
156    int  irq;
157} overrides
158#ifdef PAS16_OVERRIDE
159    [] __initdata = PAS16_OVERRIDE;
160#else
161    [4] __initdata = {{0,IRQ_AUTO}, {0,IRQ_AUTO}, {0,IRQ_AUTO},
162	{0,IRQ_AUTO}};
163#endif
164
165#define NO_OVERRIDES ARRAY_SIZE(overrides)
166
167static struct base {
168    unsigned short io_port;
169    int noauto;
170} bases[] __initdata =
171	{ {PAS16_DEFAULT_BASE_1, 0},
172	  {PAS16_DEFAULT_BASE_2, 0},
173	  {PAS16_DEFAULT_BASE_3, 0},
174	  {PAS16_DEFAULT_BASE_4, 0}
175	};
176
177#define NO_BASES ARRAY_SIZE(bases)
178
179static const unsigned short  pas16_offset[ 8 ] =
180    {
181	0x1c00,    /* OUTPUT_DATA_REG */
182	0x1c01,    /* INITIATOR_COMMAND_REG */
183	0x1c02,    /* MODE_REG */
184	0x1c03,    /* TARGET_COMMAND_REG */
185	0x3c00,    /* STATUS_REG ro, SELECT_ENABLE_REG wo */
186	0x3c01,    /* BUS_AND_STATUS_REG ro, START_DMA_SEND_REG wo */
187	0x3c02,    /* INPUT_DATA_REGISTER ro, (N/A on PAS16 ?)
188		    * START_DMA_TARGET_RECEIVE_REG wo
189		    */
190	0x3c03,    /* RESET_PARITY_INTERRUPT_REG ro,
191		    * START_DMA_INITIATOR_RECEIVE_REG wo
192		    */
193    };
194/*----------------------------------------------------------------*/
195/* the following will set the monitor border color (useful to find
196 where something crashed or gets stuck at */
197/* 1 = blue
198 2 = green
199 3 = cyan
200 4 = red
201 5 = magenta
202 6 = yellow
203 7 = white
204*/
205#if 1
206#define rtrc(i) {inb(0x3da); outb(0x31, 0x3c0); outb((i), 0x3c0);}
207#else
208#define rtrc(i) {}
209#endif
210
211
212/*
213 * Function : enable_board( int  board_num, unsigned short port )
214 *
215 * Purpose :  set address in new model board
216 *
217 * Inputs : board_num - logical board number 0-3, port - base address
218 *
219 */
220
221static void __init
222	enable_board( int  board_num,  unsigned short port )
223{
224    outb( 0xbc + board_num, MASTER_ADDRESS_PTR );
225    outb( port >> 2, MASTER_ADDRESS_PTR );
226}
227
228
229
230/*
231 * Function : init_board( unsigned short port, int irq )
232 *
233 * Purpose :  Set the board up to handle the SCSI interface
234 *
235 * Inputs : port - base address of the board,
236 *	    irq - irq to assign to the SCSI port
237 *	    force_irq - set it even if it conflicts with sound driver
238 *
239 */
240
241static void __init 
242	init_board( unsigned short io_port, int irq, int force_irq )
243{
244	unsigned int	tmp;
245	unsigned int	pas_irq_code;
246
247	/* Initialize the SCSI part of the board */
248
249	outb( 0x30, io_port + P_TIMEOUT_COUNTER_REG );  /* Timeout counter */
250	outb( 0x01, io_port + P_TIMEOUT_STATUS_REG_OFFSET );   /* Reset TC */
251	outb( 0x01, io_port + WAIT_STATE );   /* 1 Wait state */
252
253	NCR5380_read( RESET_PARITY_INTERRUPT_REG );
254
255	/* Set the SCSI interrupt pointer without mucking up the sound
256	 * interrupt pointer in the same byte.
257	 */
258	pas_irq_code = ( irq < 16 ) ? scsi_irq_translate[irq] : 0;
259	tmp = inb( io_port + IO_CONFIG_3 );
260
261	if( (( tmp & 0x0f ) == pas_irq_code) && pas_irq_code > 0 
262	    && !force_irq )
263	{
264	    printk( "pas16: WARNING: Can't use same irq as sound "
265		    "driver -- interrupts disabled\n" );
266	    /* Set up the drive parameters, disable 5380 interrupts */
267	    outb( 0x4d, io_port + SYS_CONFIG_4 );
268	}
269	else
270	{
271	    tmp = (  tmp & 0x0f ) | ( pas_irq_code << 4 );
272	    outb( tmp, io_port + IO_CONFIG_3 );
273
274	    /* Set up the drive parameters and enable 5380 interrupts */
275	    outb( 0x6d, io_port + SYS_CONFIG_4 );
276	}
277}
278
279
280/*
281 * Function : pas16_hw_detect( unsigned short board_num )
282 *
283 * Purpose : determine if a pas16 board is present
284 * 
285 * Inputs : board_num - logical board number ( 0 - 3 )
286 *
287 * Returns : 0 if board not found, 1 if found.
288 */
289
290static int __init 
291     pas16_hw_detect( unsigned short  board_num )
292{
293    unsigned char	board_rev, tmp;
294    unsigned short	io_port = bases[ board_num ].io_port;
295
296    /* See if we can find a PAS16 board at the address associated
297     * with this logical board number.
298     */
299
300    /* First, attempt to take a newer model board out of reset and
301     * give it a base address.  This shouldn't affect older boards.
302     */
303    enable_board( board_num, io_port );
304
305    /* Now see if it looks like a PAS16 board */
306    board_rev = inb( io_port + PCB_CONFIG );
307
308    if( board_rev == 0xff )
309	return 0;
310
311    tmp = board_rev ^ 0xe0;
312
313    outb( tmp, io_port + PCB_CONFIG );
314    tmp = inb( io_port + PCB_CONFIG );
315    outb( board_rev, io_port + PCB_CONFIG );
316
317    if( board_rev != tmp ) 	/* Not a PAS-16 */
318	return 0;
319
320    if( ( inb( io_port + OPERATION_MODE_1 ) & 0x03 ) != 0x03 ) 
321	return 0;  	/* return if no SCSI interface found */
322
323    /* Mediavision has some new model boards that return ID bits
324     * that indicate a SCSI interface, but they're not (LMS).  We'll
325     * put in an additional test to try to weed them out.
326     */
327
328    outb( 0x01, io_port + WAIT_STATE ); 	/* 1 Wait state */
329    NCR5380_write( MODE_REG, 0x20 );		/* Is it really SCSI? */
330    if( NCR5380_read( MODE_REG ) != 0x20 )	/* Write to a reg.    */
331	return 0;				/* and try to read    */
332    NCR5380_write( MODE_REG, 0x00 );		/* it back.	      */
333    if( NCR5380_read( MODE_REG ) != 0x00 )
334	return 0;
335
336    return 1;
337}
338
339
340/*
341 * Function : pas16_setup(char *str, int *ints)
342 *
343 * Purpose : LILO command line initialization of the overrides array,
344 * 
345 * Inputs : str - unused, ints - array of integer parameters with ints[0]
346 *	equal to the number of ints.
347 *
348 */
349
350void __init pas16_setup(char *str, int *ints)
351{
352    static int commandline_current = 0;
353    int i;
354    if (ints[0] != 2) 
355	printk("pas16_setup : usage pas16=io_port,irq\n");
356    else 
357	if (commandline_current < NO_OVERRIDES) {
358	    overrides[commandline_current].io_port = (unsigned short) ints[1];
359	    overrides[commandline_current].irq = ints[2];
360	    for (i = 0; i < NO_BASES; ++i)
361		if (bases[i].io_port == (unsigned short) ints[1]) {
362 		    bases[i].noauto = 1;
363		    break;
364		}
365	    ++commandline_current;
366	}
367}
368
369/* 
370 * Function : int pas16_detect(struct scsi_host_template * tpnt)
371 *
372 * Purpose : detects and initializes PAS16 controllers
373 *	that were autoprobed, overridden on the LILO command line, 
374 *	or specified at compile time.
375 *
376 * Inputs : tpnt - template for this SCSI adapter.
377 * 
378 * Returns : 1 if a host adapter was found, 0 if not.
379 *
380 */
381
382int __init pas16_detect(struct scsi_host_template * tpnt)
383{
384    static int current_override = 0;
385    static unsigned short current_base = 0;
386    struct Scsi_Host *instance;
387    unsigned short io_port;
388    int  count;
389
390    tpnt->proc_name = "pas16";
391    tpnt->show_info = pas16_show_info;
392    tpnt->write_info = pas16_write_info;
393
394    if (pas16_addr != 0) {
395	overrides[0].io_port = pas16_addr;
396	/*
397	*  This is how we avoid seeing more than
398	*  one host adapter at the same I/O port.
399	*  Cribbed shamelessly from pas16_setup().
400	*/
401	for (count = 0; count < NO_BASES; ++count)
402	    if (bases[count].io_port == pas16_addr) {
403 		    bases[count].noauto = 1;
404		    break;
405	}
406    }
407    if (pas16_irq != 0)
408	overrides[0].irq = pas16_irq;
409
410    for (count = 0; current_override < NO_OVERRIDES; ++current_override) {
411	io_port = 0;
412
413	if (overrides[current_override].io_port)
414	{
415	    io_port = overrides[current_override].io_port;
416	    enable_board( current_override, io_port );
417	    init_board( io_port, overrides[current_override].irq, 1 );
418	}
419	else
420	    for (; !io_port && (current_base < NO_BASES); ++current_base) {
421#if (PDEBUG & PDEBUG_INIT)
422    printk("scsi-pas16 : probing io_port %04x\n", (unsigned int) bases[current_base].io_port);
423#endif
424		if ( !bases[current_base].noauto &&
425		     pas16_hw_detect( current_base ) ){
426			io_port = bases[current_base].io_port;
427			init_board( io_port, default_irqs[ current_base ], 0 ); 
428#if (PDEBUG & PDEBUG_INIT)
429			printk("scsi-pas16 : detected board.\n");
430#endif
431		}
432    }
433
434
435#if defined(PDEBUG) && (PDEBUG & PDEBUG_INIT)
436	printk("scsi-pas16 : io_port = %04x\n", (unsigned int) io_port);
437#endif
438
439	if (!io_port)
440	    break;
441
442	instance = scsi_register (tpnt, sizeof(struct NCR5380_hostdata));
443	if(instance == NULL)
444		break;
445		
446	instance->io_port = io_port;
447
448	NCR5380_init(instance, 0);
449
450	if (overrides[current_override].irq != IRQ_AUTO)
451	    instance->irq = overrides[current_override].irq;
452	else 
453	    instance->irq = NCR5380_probe_irq(instance, PAS16_IRQS);
454
455	if (instance->irq != SCSI_IRQ_NONE) 
456	    if (request_irq(instance->irq, pas16_intr, 0,
457			    "pas16", instance)) {
458		printk("scsi%d : IRQ%d not free, interrupts disabled\n", 
459		    instance->host_no, instance->irq);
460		instance->irq = SCSI_IRQ_NONE;
461	    } 
462
463	if (instance->irq == SCSI_IRQ_NONE) {
464	    printk("scsi%d : interrupts not enabled. for better interactive performance,\n", instance->host_no);
465	    printk("scsi%d : please jumper the board for a free IRQ.\n", instance->host_no);
466	    /* Disable 5380 interrupts, leave drive params the same */
467	    outb( 0x4d, io_port + SYS_CONFIG_4 );
468	    outb( (inb(io_port + IO_CONFIG_3) & 0x0f), io_port + IO_CONFIG_3 );
469	}
470
471#if defined(PDEBUG) && (PDEBUG & PDEBUG_INIT)
472	printk("scsi%d : irq = %d\n", instance->host_no, instance->irq);
473#endif
474
475	printk("scsi%d : at 0x%04x", instance->host_no, (int) 
476	    instance->io_port);
477	if (instance->irq == SCSI_IRQ_NONE)
478	    printk (" interrupts disabled");
479	else 
480	    printk (" irq %d", instance->irq);
481	printk(" options CAN_QUEUE=%d  CMD_PER_LUN=%d release=%d",
482	    CAN_QUEUE, CMD_PER_LUN, PAS16_PUBLIC_RELEASE);
483	NCR5380_print_options(instance);
484	printk("\n");
485
486	++current_override;
487	++count;
488    }
489    return count;
490}
491
492/*
493 * Function : int pas16_biosparam(Disk *disk, struct block_device *dev, int *ip)
494 *
495 * Purpose : Generates a BIOS / DOS compatible H-C-S mapping for 
496 *	the specified device / size.
497 * 
498 * Inputs : size = size of device in sectors (512 bytes), dev = block device
499 *	major / minor, ip[] = {heads, sectors, cylinders}  
500 *
501 * Returns : always 0 (success), initializes ip
502 *	
503 */
504
505/* 
506 * XXX Most SCSI boards use this mapping, I could be incorrect.  Some one
507 * using hard disks on a trantor should verify that this mapping corresponds
508 * to that used by the BIOS / ASPI driver by running the linux fdisk program
509 * and matching the H_C_S coordinates to what DOS uses.
510 */
511
512int pas16_biosparam(struct scsi_device *sdev, struct block_device *dev,
513		sector_t capacity, int * ip)
514{
515  int size = capacity;
516  ip[0] = 64;
517  ip[1] = 32;
518  ip[2] = size >> 11;		/* I think I have it as /(32*64) */
519  if( ip[2] > 1024 ) {		/* yes, >, not >= */
520	ip[0]=255;
521	ip[1]=63;
522	ip[2]=size/(63*255);
523	if( ip[2] > 1023 )	/* yes >1023... */
524		ip[2] = 1023;
525  }
526
527  return 0;
528}
529
530/*
531 * Function : int NCR5380_pread (struct Scsi_Host *instance, 
532 *	unsigned char *dst, int len)
533 *
534 * Purpose : Fast 5380 pseudo-dma read function, transfers len bytes to 
535 *	dst
536 * 
537 * Inputs : dst = destination, len = length in bytes
538 *
539 * Returns : 0 on success, non zero on a failure such as a watchdog 
540 * 	timeout.
541 */
542
543static inline int NCR5380_pread (struct Scsi_Host *instance, unsigned char *dst,
544    int len) {
545    register unsigned char  *d = dst;
546    register unsigned short reg = (unsigned short) (instance->io_port + 
547	P_DATA_REG_OFFSET);
548    register int i = len;
549    int ii = 0;
550
551    while ( !(inb(instance->io_port + P_STATUS_REG_OFFSET) & P_ST_RDY) )
552	 ++ii;
553
554    insb( reg, d, i );
555
556    if ( inb(instance->io_port + P_TIMEOUT_STATUS_REG_OFFSET) & P_TS_TIM) {
557	outb( P_TS_CT, instance->io_port + P_TIMEOUT_STATUS_REG_OFFSET);
558	printk("scsi%d : watchdog timer fired in NCR5380_pread()\n",
559	    instance->host_no);
560	return -1;
561    }
562   if (ii > pas_maxi)
563      pas_maxi = ii;
564    return 0;
565}
566
567/*
568 * Function : int NCR5380_pwrite (struct Scsi_Host *instance, 
569 *	unsigned char *src, int len)
570 *
571 * Purpose : Fast 5380 pseudo-dma write function, transfers len bytes from
572 *	src
573 * 
574 * Inputs : src = source, len = length in bytes
575 *
576 * Returns : 0 on success, non zero on a failure such as a watchdog 
577 * 	timeout.
578 */
579
580static inline int NCR5380_pwrite (struct Scsi_Host *instance, unsigned char *src,
581    int len) {
582    register unsigned char *s = src;
583    register unsigned short reg = (instance->io_port + P_DATA_REG_OFFSET);
584    register int i = len;
585    int ii = 0;
586
587    while ( !((inb(instance->io_port + P_STATUS_REG_OFFSET)) & P_ST_RDY) )
588	 ++ii;
589 
590    outsb( reg, s, i );
591
592    if (inb(instance->io_port + P_TIMEOUT_STATUS_REG_OFFSET) & P_TS_TIM) {
593	outb( P_TS_CT, instance->io_port + P_TIMEOUT_STATUS_REG_OFFSET);
594	printk("scsi%d : watchdog timer fired in NCR5380_pwrite()\n",
595	    instance->host_no);
596	return -1;
597    }
598    if (ii > pas_maxi)
599	 pas_wmaxi = ii;
600    return 0;
601}
602
603#include "NCR5380.c"
604
605static int pas16_release(struct Scsi_Host *shost)
606{
607	if (shost->irq)
608		free_irq(shost->irq, shost);
609	NCR5380_exit(shost);
610	if (shost->dma_channel != 0xff)
611		free_dma(shost->dma_channel);
612	if (shost->io_port && shost->n_io_port)
613		release_region(shost->io_port, shost->n_io_port);
614	scsi_unregister(shost);
615	return 0;
616}
617
618static struct scsi_host_template driver_template = {
619	.name           = "Pro Audio Spectrum-16 SCSI",
620	.detect         = pas16_detect,
621	.release        = pas16_release,
622	.queuecommand   = pas16_queue_command,
623	.eh_abort_handler = pas16_abort,
624	.eh_bus_reset_handler = pas16_bus_reset,
625	.bios_param     = pas16_biosparam, 
626	.can_queue      = CAN_QUEUE,
627	.this_id        = 7,
628	.sg_tablesize   = SG_ALL,
629	.cmd_per_lun    = CMD_PER_LUN,
630	.use_clustering = DISABLE_CLUSTERING,
631};
632#include "scsi_module.c"
633
634#ifdef MODULE
635module_param(pas16_addr, ushort, 0);
636module_param(pas16_irq, int, 0);
637#endif
638MODULE_LICENSE("GPL");