Subversion Repositories or1k

/*
 *  linux/drivers/acorn/scsi/eesox.c
 *
 *  Copyright (C) 1997-2003 Russell King
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 *  This driver is based on experimentation.  Hence, it may have made
 *  assumptions about the particular card that I have available, and
 *  may not be reliable!
 *
 *  Changelog:
 *   01-10-1997	RMK		Created, READONLY version
 *   15-02-1998	RMK		READ/WRITE version
 *				added DMA support and hardware definitions
 *   14-03-1998	RMK		Updated DMA support
 *				Added terminator control
 *   15-04-1998	RMK		Only do PIO if FAS216 will allow it.
 *   27-06-1998	RMK		Changed asm/delay.h to linux/delay.h
 *   02-04-2000	RMK	0.0.3	Fixed NO_IRQ/NO_DMA problem, updated for new
 *				error handling code.
 */
#include <linux/module.h>
#include <linux/blk.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/ioport.h>
#include <linux/sched.h>
#include <linux/proc_fs.h>
#include <linux/delay.h>
#include <linux/pci.h>
#include <linux/init.h>
 
#include <asm/io.h>
#include <asm/irq.h>
#include <asm/dma.h>
#include <asm/ecard.h>
#include <asm/pgtable.h>
 
#include "../../scsi/sd.h"
#include "../../scsi/hosts.h"
#include "fas216.h"
#include "scsi.h"
 
#include <scsi/scsicam.h>
 
/*
 * List of devices that the driver will recognise
 */
#define EESOXSCSI_LIST	{ MANU_EESOX, PROD_EESOX_SCSI2 }
 
#define EESOX_FAS216_OFFSET	0xc00
#define EESOX_FAS216_SHIFT	3
 
#define EESOX_DMASTAT		0xa00
#define EESOX_STAT_INTR		0x01
#define EESOX_STAT_DMA		0x02
 
#define EESOX_CONTROL		0xa00
#define EESOX_INTR_ENABLE	0x04
#define EESOX_TERM_ENABLE	0x02
#define EESOX_RESET		0x01
 
#define EESOX_DMADATA		0xe00
 
/*
 * Version
 */
#define VERSION "1.10 (22/01/2003 2.4.19-rmk5)"
 
/*
 * Use term=0,1,0,0,0 to turn terminators on/off
 */
static int term[MAX_ECARDS] = { 1, 1, 1, 1, 1, 1, 1, 1 };
 
#define NR_SG	256
 
struct eesoxscsi_info {
	FAS216_Info		info;
	struct expansion_card	*ec;
 
	unsigned int		ctl_port;
	unsigned int		control;
	struct scatterlist	sg[NR_SG];	/* Scatter DMA list	*/
};
 
/* Prototype: void eesoxscsi_irqenable(ec, irqnr)
 * Purpose  : Enable interrupts on EESOX SCSI card
 * Params   : ec    - expansion card structure
 *          : irqnr - interrupt number
 */
static void
eesoxscsi_irqenable(struct expansion_card *ec, int irqnr)
{
	struct eesoxscsi_info *info = (struct eesoxscsi_info *)ec->irq_data;
 
	info->control |= EESOX_INTR_ENABLE;
 
	outb(info->control, info->ctl_port);
}
 
/* Prototype: void eesoxscsi_irqdisable(ec, irqnr)
 * Purpose  : Disable interrupts on EESOX SCSI card
 * Params   : ec    - expansion card structure
 *          : irqnr - interrupt number
 */
static void
eesoxscsi_irqdisable(struct expansion_card *ec, int irqnr)
{
	struct eesoxscsi_info *info = (struct eesoxscsi_info *)ec->irq_data;
 
	info->control &= ~EESOX_INTR_ENABLE;
 
	outb(info->control, info->ctl_port);
}
 
static const expansioncard_ops_t eesoxscsi_ops = {
	.irqenable	= eesoxscsi_irqenable,
	.irqdisable	= eesoxscsi_irqdisable,
};
 
/* Prototype: void eesoxscsi_terminator_ctl(*host, on_off)
 * Purpose  : Turn the EESOX SCSI terminators on or off
 * Params   : host   - card to turn on/off
 *          : on_off - !0 to turn on, 0 to turn off
 */
static void
eesoxscsi_terminator_ctl(struct Scsi_Host *host, int on_off)
{
	struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
	unsigned long flags;
 
	save_flags_cli(flags);
	if (on_off)
		info->control |= EESOX_TERM_ENABLE;
	else
		info->control &= ~EESOX_TERM_ENABLE;
 
	outb(info->control, info->ctl_port);
	restore_flags(flags);
}
 
/* Prototype: void eesoxscsi_intr(irq, *dev_id, *regs)
 * Purpose  : handle interrupts from EESOX SCSI card
 * Params   : irq    - interrupt number
 *	      dev_id - user-defined (Scsi_Host structure)
 *	      regs   - processor registers at interrupt
 */
static void
eesoxscsi_intr(int irq, void *dev_id, struct pt_regs *regs)
{
	fas216_intr(dev_id);
}
 
/* Prototype: fasdmatype_t eesoxscsi_dma_setup(host, SCpnt, direction, min_type)
 * Purpose  : initialises DMA/PIO
 * Params   : host      - host
 *	      SCpnt     - command
 *	      direction - DMA on to/off of card
 *	      min_type  - minimum DMA support that we must have for this transfer
 * Returns  : type of transfer to be performed
 */
static fasdmatype_t
eesoxscsi_dma_setup(struct Scsi_Host *host, Scsi_Pointer *SCp,
		       fasdmadir_t direction, fasdmatype_t min_type)
{
	struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
	int dmach = host->dma_channel;
 
	if (dmach != NO_DMA &&
	    (min_type == fasdma_real_all || SCp->this_residual >= 512)) {
		int bufs, map_dir, dma_dir;
 
		bufs = copy_SCp_to_sg(&info->sg[0], SCp, NR_SG);
 
		if (direction == DMA_OUT)
			map_dir = PCI_DMA_TODEVICE,
			dma_dir = DMA_MODE_WRITE;
		else
			map_dir = PCI_DMA_FROMDEVICE,
			dma_dir = DMA_MODE_READ;
 
		pci_map_sg(NULL, info->sg, bufs, map_dir);
 
		disable_dma(dmach);
		set_dma_sg(dmach, info->sg, bufs);
		set_dma_mode(dmach, dma_dir);
		enable_dma(dmach);
		return fasdma_real_all;
	}
	/*
	 * We don't do DMA, we only do slow PIO
	 *
	 * Some day, we will do Pseudo DMA
	 */
	return fasdma_pseudo;
}
 
static void eesoxscsi_buffer_in(void *buf, int length, unsigned long base)
{
	const unsigned long reg_fas = base + EESOX_FAS216_OFFSET;
	const unsigned long reg_dmastat = base + EESOX_DMASTAT;
	const unsigned long reg_dmadata = base + EESOX_DMADATA;
 
	do {
		unsigned int status;
 
		/*
		 * Interrupt request?
		 */
		status = inb(reg_fas + (REG_STAT << EESOX_FAS216_SHIFT));
		if (status & STAT_INT)
			break;
 
		/*
		 * DMA request active?
		 */
		status = inb(reg_dmastat);
		if (!(status & EESOX_STAT_DMA))
			continue;
 
		/*
		 * Get number of bytes in FIFO
		 */
		status = inb(reg_fas + (REG_CFIS << EESOX_FAS216_SHIFT)) & CFIS_CF;
		if (status > 16)
			status = 16;
		if (status > length)
			status = length;
 
		/*
		 * Align buffer.
		 */
		if (((u32)buf) & 2 && status >= 2) {
			*((u16 *)buf)++ = inw(reg_dmadata);
			status -= 2;
			length -= 2;
		}
 
		if (status >= 8) {
			unsigned long l1, l2;
 
			l1 = inw(reg_dmadata);
			l1 |= inw(reg_dmadata) << 16;
			l2 = inw(reg_dmadata);
			l2 |= inw(reg_dmadata) << 16;
			*((u32 *)buf)++ = l1;
			*((u32 *)buf)++ = l2;
			length -= 8;
			continue;
		}
 
		if (status >= 4) {
			unsigned long l1;
 
			l1 = inw(reg_dmadata);
			l1 |= inw(reg_dmadata) << 16;
			*((u32 *)buf)++ = l1;
			length -= 4;
			continue;
		}
 
		if (status >= 2) {
			*((u16 *)buf)++ = inw(reg_dmadata);
			length -= 2;
		}
	} while (length);
}
 
static void eesoxscsi_buffer_out(void *buf, int length, unsigned long base)
{
	const unsigned long reg_fas = base + EESOX_FAS216_OFFSET;
	const unsigned long reg_dmastat = base + EESOX_DMASTAT;
	const unsigned long reg_dmadata = base + EESOX_DMADATA;
 
	do {
		unsigned int status;
 
		/*
		 * Interrupt request?
		 */
		status = inb(reg_fas + (REG_STAT << EESOX_FAS216_SHIFT));
		if (status & STAT_INT)
			break;
 
		/*
		 * DMA request active?
		 */
		status = inb(reg_dmastat);
		if (!(status & EESOX_STAT_DMA))
			continue;
 
		/*
		 * Get number of bytes in FIFO
		 */
		status = inb(reg_fas + (REG_CFIS << EESOX_FAS216_SHIFT)) & CFIS_CF;
		if (status > 16)
			status = 16;
		status = 16 - status;
		if (status > length)
			status = length;
 
		/*
		 * Align buffer.
		 */
		if (((u32)buf) & 2 && status >= 2) {
			outw(*((u16 *)buf)++, reg_dmadata);
			status -= 2;
			length -= 2;
		}
 
		if (status >= 8) {
			unsigned long l1, l2;
 
			l1 = *((u32 *)buf)++;
			l2 = *((u32 *)buf)++;
 
			outw(l1, reg_dmadata);
			outw(l1 >> 16, reg_dmadata);
			outw(l2, reg_dmadata);
			outw(l2 >> 16, reg_dmadata);
			status -= 8;
			length -= 8;
			continue;
		}
 
		if (status >= 4) {
			unsigned long l1;
 
			l1 = *((u32 *)buf)++;
			outw(l1, reg_dmadata);
			outw(l1 >> 16, reg_dmadata);
			status -= 4;
			length -= 4;
			continue;
		}
 
		if (status >= 2) {
			outw(*((u16 *)buf)++, reg_dmadata);
			length -= 2;
		}
	} while (length);
}
 
static void
eesoxscsi_dma_pseudo(struct Scsi_Host *host, Scsi_Pointer *SCp,
		     fasdmadir_t dir, int transfer_size)
{
	unsigned int base = host->io_port;
	if (dir == DMA_IN) {
		eesoxscsi_buffer_in(SCp->ptr, SCp->this_residual, base);
	} else {
		eesoxscsi_buffer_out(SCp->ptr, SCp->this_residual, base);
	}
}
 
/* Prototype: int eesoxscsi_dma_stop(host, SCpnt)
 * Purpose  : stops DMA/PIO
 * Params   : host  - host
 *	      SCpnt - command
 */
static void
eesoxscsi_dma_stop(struct Scsi_Host *host, Scsi_Pointer *SCp)
{
	if (host->dma_channel != NO_DMA)
		disable_dma(host->dma_channel);
}
 
/* Prototype: const char *eesoxscsi_info(struct Scsi_Host * host)
 * Purpose  : returns a descriptive string about this interface,
 * Params   : host - driver host structure to return info for.
 * Returns  : pointer to a static buffer containing null terminated string.
 */
const char *eesoxscsi_info(struct Scsi_Host *host)
{
	struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
	static char string[150];
 
	sprintf(string, "%s (%s) in slot %d v%s terminators o%s",
		host->hostt->name, info->info.scsi.type, info->ec->slot_no,
		VERSION, info->control & EESOX_TERM_ENABLE ? "n" : "ff");
 
	return string;
}
 
/* Prototype: int eesoxscsi_set_proc_info(struct Scsi_Host *host, char *buffer, int length)
 * Purpose  : Set a driver specific function
 * Params   : host   - host to setup
 *          : buffer - buffer containing string describing operation
 *          : length - length of string
 * Returns  : -EINVAL, or 0
 */
static int
eesoxscsi_set_proc_info(struct Scsi_Host *host, char *buffer, int length)
{
	int ret = length;
 
	if (length >= 9 && strncmp(buffer, "EESOXSCSI", 9) == 0) {
		buffer += 9;
		length -= 9;
 
		if (length >= 5 && strncmp(buffer, "term=", 5) == 0) {
			if (buffer[5] == '1')
				eesoxscsi_terminator_ctl(host, 1);
			else if (buffer[5] == '0')
				eesoxscsi_terminator_ctl(host, 0);
			else
				ret = -EINVAL;
		} else
			ret = -EINVAL;
	} else
		ret = -EINVAL;
 
	return ret;
}
 
/* Prototype: int eesoxscsi_proc_info(char *buffer, char **start, off_t offset,
 *				      int length, int host_no, int inout)
 * Purpose  : Return information about the driver to a user process accessing
 *	      the /proc filesystem.
 * Params   : buffer - a buffer to write information to
 *	      start  - a pointer into this buffer set by this routine to the start
 *		       of the required information.
 *	      offset - offset into information that we have read upto.
 *	      length - length of buffer
 *	      host_no - host number to return information for
 *	      inout  - 0 for reading, 1 for writing.
 * Returns  : length of data written to buffer.
 */
int eesoxscsi_proc_info(char *buffer, char **start, off_t offset,
			    int length, int host_no, int inout)
{
	int pos, begin;
	struct Scsi_Host *host;
	struct eesoxscsi_info *info;
	Scsi_Device *scd;
 
	host = scsi_host_hn_get(host_no);
	if (!host)
		return 0;
 
	if (inout == 1)
		return eesoxscsi_set_proc_info(host, buffer, length);
 
	info = (struct eesoxscsi_info *)host->hostdata;
 
	begin = 0;
	pos = sprintf(buffer, "EESOX SCSI driver v%s\n", VERSION);
	pos += fas216_print_host(&info->info, buffer + pos);
	pos += sprintf(buffer + pos, "Term    : o%s\n",
			info->control & EESOX_TERM_ENABLE ? "n" : "ff");
 
	pos += fas216_print_stats(&info->info, buffer + pos);
 
	pos += sprintf(buffer+pos, "\nAttached devices:\n");
 
	for (scd = host->host_queue; scd; scd = scd->next) {
		int len;
 
		proc_print_scsidevice(scd, buffer, &len, pos);
		pos += len;
		pos += sprintf(buffer+pos, "Extensions: ");
		if (scd->tagged_supported)
			pos += sprintf(buffer+pos, "TAG %sabled [%d] ",
					scd->tagged_queue ? "en" : "dis",
					scd->current_tag);
		pos += sprintf (buffer+pos, "\n");
 
		if (pos + begin < offset) {
			begin += pos;
			pos = 0;
		}
	}
	*start = buffer + (offset - begin);
	pos -= offset - begin;
	if (pos > length)
		pos = length;
 
	return pos;
}
 
static int eesoxscsi_probe(struct expansion_card *ec);
 
/* Prototype: int eesoxscsi_detect(Scsi_Host_Template * tpnt)
 * Purpose  : initialises EESOX SCSI driver
 * Params   : tpnt - template for this SCSI adapter
 * Returns  : >0 if host found, 0 otherwise.
 */
static int eesoxscsi_detect(Scsi_Host_Template *tpnt)
{
	static const card_ids eesoxscsi_cids[] =
			{ EESOXSCSI_LIST, { 0xffff, 0xffff} };
	struct expansion_card *ec;
	int count = 0, ret;
 
	ecard_startfind();
 
	while(1) {
		ec = ecard_find(0, eesoxscsi_cids);
		if (!ec)
			break;
 
		ecard_claim(ec);
 
		ret = eesoxscsi_probe(ec);
		if (ret) {
			ecard_release(ec);
			break;
		}
		++count;
	}
	return count;
}
 
static void eesoxscsi_remove(struct Scsi_Host *host);
 
/* Prototype: int eesoxscsi_release(struct Scsi_Host * host)
 * Purpose  : releases all resources used by this adapter
 * Params   : host - driver host structure to return info for.
 */
static int eesoxscsi_release(struct Scsi_Host *host)
{
	eesoxscsi_remove(host);
	return 0;
}
 
static Scsi_Host_Template eesox_template = {
	.module				= THIS_MODULE,
	.proc_info			= eesoxscsi_proc_info,
	.name				= "EESOX SCSI",
	.detect				= eesoxscsi_detect,
	.release			= eesoxscsi_release,
	.info				= eesoxscsi_info,
	.bios_param			= scsicam_bios_param,
	.command			= fas216_command,
	.queuecommand			= fas216_queue_command,
	.eh_host_reset_handler		= fas216_eh_host_reset,
	.eh_bus_reset_handler		= fas216_eh_bus_reset,
	.eh_device_reset_handler	= fas216_eh_device_reset,
	.eh_abort_handler		= fas216_eh_abort,
	.use_new_eh_code		= 1,
 
	.can_queue			= 1,
	.this_id			= 7,
	.sg_tablesize			= SG_ALL,
	.cmd_per_lun			= 1,
	.use_clustering			= DISABLE_CLUSTERING,
	.proc_name			= "eesox",
};
 
static int
eesoxscsi_probe(struct expansion_card *ec)
{
	struct Scsi_Host *host;
	struct eesoxscsi_info *info;
	unsigned long base;
	int ret;
 
	base = ecard_address(ec, ECARD_IOC, ECARD_FAST);
 
	if (!request_region(base + EESOX_FAS216_OFFSET,
			    16 << EESOX_FAS216_SHIFT, "eesox2-fas")) {
		ret = -EBUSY;
		goto out;
	}
 
	host = scsi_register(&eesox_template,
			     sizeof(struct eesoxscsi_info));
	if (!host) {
		ret = -ENOMEM;
		goto out_region;
	}
 
	host->io_port	  = base;
	host->irq	  = ec->irq;
	host->dma_channel = ec->dma;
 
	info = (struct eesoxscsi_info *)host->hostdata;
	info->ec	= ec;
	info->ctl_port	= base + EESOX_CONTROL;
	info->control	= term[ec->slot_no] ? EESOX_TERM_ENABLE : 0;
	outb(info->control, info->ctl_port);
 
	ec->irqaddr	= (unsigned char *)ioaddr(base + EESOX_DMASTAT);
	ec->irqmask	= EESOX_STAT_INTR;
	ec->irq_data	= info;
	ec->ops		= (expansioncard_ops_t *)&eesoxscsi_ops;
 
	info->info.scsi.io_port		= base + EESOX_FAS216_OFFSET;
	info->info.scsi.io_shift	= EESOX_FAS216_SHIFT;
	info->info.scsi.irq		= host->irq;
	info->info.ifcfg.clockrate	= 40; /* MHz */
	info->info.ifcfg.select_timeout	= 255;
	info->info.ifcfg.asyncperiod	= 200; /* ns */
	info->info.ifcfg.sync_max_depth	= 7;
	info->info.ifcfg.cntl3		= CNTL3_FASTSCSI | CNTL3_FASTCLK;
	info->info.ifcfg.disconnect_ok	= 1;
	info->info.ifcfg.wide_max_size	= 0;
	info->info.ifcfg.capabilities	= FASCAP_PSEUDODMA;
	info->info.dma.setup		= eesoxscsi_dma_setup;
	info->info.dma.pseudo		= eesoxscsi_dma_pseudo;
	info->info.dma.stop		= eesoxscsi_dma_stop;
 
	ret = fas216_init(host);
	if (ret)
		goto out_free;
 
	ret = request_irq(host->irq, eesoxscsi_intr, 0, "eesox", &info->info);
	if (ret) {
		printk("scsi%d: IRQ%d not free: %d\n",
		       host->host_no, host->irq, ret);
		goto out_remove;
	}
 
	if (host->dma_channel != NO_DMA) {
		if (request_dma(host->dma_channel, "eesox")) {
			printk("scsi%d: DMA%d not free, DMA disabled\n",
			       host->host_no, host->dma_channel);
			host->dma_channel = NO_DMA;
		} else {
			set_dma_speed(host->dma_channel, 180);
			info->info.ifcfg.capabilities |= FASCAP_DMA;
			info->info.ifcfg.cntl3 |= CNTL3_BS8;
		}
	}
 
	ret = fas216_add(host);
	if (ret == 0)
		goto out;
 
	if (host->dma_channel != NO_DMA)
		free_dma(host->dma_channel);
	free_irq(host->irq, host);
 
 out_remove:
	fas216_remove(host);
 
 out_free:
	scsi_unregister(host);
 
 out_region:
	release_region(base + EESOX_FAS216_OFFSET, 16 << EESOX_FAS216_SHIFT);
 
 out:
	return ret;
}
 
static void eesoxscsi_remove(struct Scsi_Host *host)
{
	struct eesoxscsi_info *info = (struct eesoxscsi_info *)host->hostdata;
 
	fas216_remove(host);
 
	if (host->dma_channel != NO_DMA)
		free_dma(host->dma_channel);
	free_irq(host->irq, host);
 
	release_region(host->io_port + EESOX_FAS216_OFFSET, 16 << EESOX_FAS216_SHIFT);
 
	fas216_release(host);
	ecard_release(info->ec);
}
 
static int __init eesox_init(void)
{
	scsi_register_module(MODULE_SCSI_HA, &eesox_template);
	if (eesox_template.present)
		return 0;
 
	scsi_unregister_module(MODULE_SCSI_HA, &eesox_template);
	return -ENODEV;
}
 
static void __exit eesox_exit(void)
{
	scsi_unregister_module(MODULE_SCSI_HA, &eesox_template);
}
 
module_init(eesox_init);
module_exit(eesox_exit);
 
MODULE_AUTHOR("Russell King");
MODULE_DESCRIPTION("EESOX 'Fast' SCSI driver for Acorn machines");
MODULE_PARM(term, "1-8i");
MODULE_PARM_DESC(term, "SCSI bus termination");
MODULE_LICENSE("GPL");
EXPORT_NO_SYMBOLS;