[mirror_ubuntu-bionic-kernel.git] / drivers / scsi / imm.h


/*  Driver for the Iomega MatchMaker parallel port SCSI HBA embedded in 
 * the Iomega ZIP Plus drive
 * 
 * (c) 1998     David Campbell
 *
 * Please note that I live in Perth, Western Australia. GMT+0800
 */

#ifndef _IMM_H
#define _IMM_H

#define   IMM_VERSION   "2.05 (for Linux 2.4.0)"

/* 
 * 10 Apr 1998 (Good Friday) - Received EN144302 by email from Iomega.
 * Scarry thing is the level of support from one of their managers.
 * The onus is now on us (the developers) to shut up and start coding.
 *                                              11Apr98 [ 0.10 ]
 *
 * --- SNIP ---
 *
 * It manages to find the drive which is a good start. Writing data during
 * data phase is known to be broken (due to requirements of two byte writes).
 * Removing "Phase" debug messages.
 *
 * PS: Took four hours of coding after I bought a drive.
 *      ANZAC Day (Aus "War Veterans Holiday")  25Apr98 [ 0.14 ]
 *
 * Ten minutes later after a few fixes.... (LITERALLY!!!)
 * Have mounted disk, copied file, dismounted disk, remount disk, diff file
 *                    -----  It actually works!!! -----
 *                                              25Apr98 [ 0.15 ]
 *
 * Twenty minutes of mucking around, rearanged the IEEE negotiate mechanism.
 * Now have byte mode working (only EPP and ECP to go now... :=)
 *                                              26Apr98 [ 0.16 ]
 *
 * Thirty minutes of further coding results in EPP working on my machine.
 *                                              27Apr98 [ 0.17 ]
 *
 * Due to work commitments and inability to get a "true" ECP mode functioning
 * I have decided to code the parport support into imm.
 *                                              09Jun98 [ 0.18 ]
 *
 * Driver is now out of beta testing.
 * Support for parport has been added.
 * Now distributed with the ppa driver.
 *                                              12Jun98 [ 2.00 ]
 *
 * Err.. It appears that imm-2.00 was broken....
 *                                              18Jun98 [ 2.01 ]
 *
 * Patch applied to sync this against the Linux 2.1.x kernel code
 * Included qboot_zip.sh
 *                                              21Jun98 [ 2.02 ]
 *
 * Other clean ups include the follow changes:
 *    CONFIG_SCSI_PPA_HAVE_PEDANTIC => CONFIG_SCSI_IZIP_EPP16
 *    added CONFIG_SCSI_IZIP_SLOW_CTR option
 *                                                      [2.03]
 *  Fix kernel panic on scsi timeout.		20Aug00 [2.04]
 *
 *  Avoid io_request_lock problems.
 *  John Cavan <johncavan@home.com>		16Nov00 [2.05]
 */
/* ------ END OF USER CONFIGURABLE PARAMETERS ----- */

#include  <linux/stddef.h>
#include  <linux/module.h>
#include  <linux/kernel.h>
#include  <linux/ioport.h>
#include  <linux/delay.h>
#include  <linux/proc_fs.h>
#include  <linux/stat.h>
#include  <linux/blkdev.h>
#include  <linux/sched.h>
#include  <linux/interrupt.h>

#include  <asm/io.h>
#include  <scsi/scsi_host.h>
/* batteries not included :-) */

/*
 * modes in which the driver can operate 
 */
#define   IMM_AUTODETECT        0	/* Autodetect mode                */
#define   IMM_NIBBLE            1	/* work in standard 4 bit mode    */
#define   IMM_PS2               2	/* PS/2 byte mode         */
#define   IMM_EPP_8             3	/* EPP mode, 8 bit                */
#define   IMM_EPP_16            4	/* EPP mode, 16 bit               */
#define   IMM_EPP_32            5	/* EPP mode, 32 bit               */
#define   IMM_UNKNOWN           6	/* Just in case...                */

static char *IMM_MODE_STRING[] =
{
	[IMM_AUTODETECT] = "Autodetect",
	[IMM_NIBBLE]	 = "SPP",
	[IMM_PS2]	 = "PS/2",
	[IMM_EPP_8]	 = "EPP 8 bit",
	[IMM_EPP_16]	 = "EPP 16 bit",
#ifdef CONFIG_SCSI_IZIP_EPP16
	[IMM_EPP_32]	 = "EPP 16 bit",
#else
	[IMM_EPP_32]	 = "EPP 32 bit",
#endif
	[IMM_UNKNOWN]	 = "Unknown",
};

/* other options */
#define IMM_BURST_SIZE	512	/* data burst size */
#define IMM_SELECT_TMO  500	/* 500 how long to wait for target ? */
#define IMM_SPIN_TMO    5000	/* 50000 imm_wait loop limiter */
#define IMM_DEBUG	0	/* debugging option */
#define IN_EPP_MODE(x) (x == IMM_EPP_8 || x == IMM_EPP_16 || x == IMM_EPP_32)

/* args to imm_connect */
#define CONNECT_EPP_MAYBE 1
#define CONNECT_NORMAL  0

#define r_dtr(x)        (unsigned char)inb((x))
#define r_str(x)        (unsigned char)inb((x)+1)
#define r_ctr(x)        (unsigned char)inb((x)+2)
#define r_epp(x)        (unsigned char)inb((x)+4)
#define r_fifo(x)       (unsigned char)inb((x))   /* x must be base_hi */
					/* On PCI is: base+0x400 != base_hi */
#define r_ecr(x)        (unsigned char)inb((x)+2) /* x must be base_hi */

#define w_dtr(x,y)      outb(y, (x))
#define w_str(x,y)      outb(y, (x)+1)
#define w_epp(x,y)      outb(y, (x)+4)
#define w_fifo(x,y)     outb(y, (x))     /* x must be base_hi */
#define w_ecr(x,y)      outb(y, (x)+0x2) /* x must be base_hi */

#ifdef CONFIG_SCSI_IZIP_SLOW_CTR
#define w_ctr(x,y)      outb_p(y, (x)+2)
#else
#define w_ctr(x,y)      outb(y, (x)+2)
#endif

static int imm_engine(imm_struct *, struct scsi_cmnd *);

#endif				/* _IMM_H */
Commit	Line	Data
1da177e4 LT	1
	2	/* Driver for the Iomega MatchMaker parallel port SCSI HBA embedded in
	3	* the Iomega ZIP Plus drive
	4	*
bdca3f20	5	* (c) 1998 David Campbell
1da177e4 LT	6	*
	7	* Please note that I live in Perth, Western Australia. GMT+0800
	8	*/
	9
	10	#ifndef _IMM_H
	11	#define _IMM_H
	12
	13	#define IMM_VERSION "2.05 (for Linux 2.4.0)"
	14
	15	/*
	16	* 10 Apr 1998 (Good Friday) - Received EN144302 by email from Iomega.
	17	* Scarry thing is the level of support from one of their managers.
	18	* The onus is now on us (the developers) to shut up and start coding.
	19	* 11Apr98 [ 0.10 ]
	20	*
	21	* --- SNIP ---
	22	*
	23	* It manages to find the drive which is a good start. Writing data during
	24	* data phase is known to be broken (due to requirements of two byte writes).
	25	* Removing "Phase" debug messages.
	26	*
	27	* PS: Took four hours of coding after I bought a drive.
	28	* ANZAC Day (Aus "War Veterans Holiday") 25Apr98 [ 0.14 ]
	29	*
	30	* Ten minutes later after a few fixes.... (LITERALLY!!!)
	31	* Have mounted disk, copied file, dismounted disk, remount disk, diff file
	32	* ----- It actually works!!! -----
	33	* 25Apr98 [ 0.15 ]
	34	*
	35	* Twenty minutes of mucking around, rearanged the IEEE negotiate mechanism.
	36	* Now have byte mode working (only EPP and ECP to go now... :=)
	37	* 26Apr98 [ 0.16 ]
	38	*
	39	* Thirty minutes of further coding results in EPP working on my machine.
	40	* 27Apr98 [ 0.17 ]
	41	*
	42	* Due to work commitments and inability to get a "true" ECP mode functioning
	43	* I have decided to code the parport support into imm.
	44	* 09Jun98 [ 0.18 ]
	45	*
	46	* Driver is now out of beta testing.
	47	* Support for parport has been added.
	48	* Now distributed with the ppa driver.
	49	* 12Jun98 [ 2.00 ]
	50	*
	51	* Err.. It appears that imm-2.00 was broken....
	52	* 18Jun98 [ 2.01 ]
	53	*
	54	* Patch applied to sync this against the Linux 2.1.x kernel code
	55	* Included qboot_zip.sh
	56	* 21Jun98 [ 2.02 ]
	57	*
	58	* Other clean ups include the follow changes:
	59	* CONFIG_SCSI_PPA_HAVE_PEDANTIC => CONFIG_SCSI_IZIP_EPP16
	60	* added CONFIG_SCSI_IZIP_SLOW_CTR option
	61	* [2.03]
	62	* Fix kernel panic on scsi timeout. 20Aug00 [2.04]
	63	*
	64	* Avoid io_request_lock problems.
	65	* John Cavan <johncavan@home.com> 16Nov00 [2.05]
	66	*/
	67	/* ------ END OF USER CONFIGURABLE PARAMETERS ----- */
	68
1da177e4 LT	69	#include <linux/stddef.h>
	70	#include <linux/module.h>
	71	#include <linux/kernel.h>
	72	#include <linux/ioport.h>
	73	#include <linux/delay.h>
	74	#include <linux/proc_fs.h>
	75	#include <linux/stat.h>
	76	#include <linux/blkdev.h>
	77	#include <linux/sched.h>
	78	#include <linux/interrupt.h>
	79
	80	#include <asm/io.h>
	81	#include <scsi/scsi_host.h>
	82	/* batteries not included :-) */
	83
	84	/*
	85	* modes in which the driver can operate
	86	*/
	87	#define IMM_AUTODETECT 0 /* Autodetect mode */
	88	#define IMM_NIBBLE 1 /* work in standard 4 bit mode */
	89	#define IMM_PS2 2 /* PS/2 byte mode */
	90	#define IMM_EPP_8 3 /* EPP mode, 8 bit */
	91	#define IMM_EPP_16 4 /* EPP mode, 16 bit */
	92	#define IMM_EPP_32 5 /* EPP mode, 32 bit */
	93	#define IMM_UNKNOWN 6 /* Just in case... */
	94
	95	static char *IMM_MODE_STRING[] =
	96	{
	97	[IMM_AUTODETECT] = "Autodetect",
	98	[IMM_NIBBLE] = "SPP",
	99	[IMM_PS2] = "PS/2",
	100	[IMM_EPP_8] = "EPP 8 bit",
	101	[IMM_EPP_16] = "EPP 16 bit",
	102	#ifdef CONFIG_SCSI_IZIP_EPP16
	103	[IMM_EPP_32] = "EPP 16 bit",
	104	#else
	105	[IMM_EPP_32] = "EPP 32 bit",
	106	#endif
	107	[IMM_UNKNOWN] = "Unknown",
	108	};
	109
	110	/* other options */
	111	#define IMM_BURST_SIZE 512 /* data burst size */
	112	#define IMM_SELECT_TMO 500 /* 500 how long to wait for target ? */
	113	#define IMM_SPIN_TMO 5000 /* 50000 imm_wait loop limiter */
	114	#define IMM_DEBUG 0 /* debugging option */
	115	#define IN_EPP_MODE(x) (x == IMM_EPP_8 \|\| x == IMM_EPP_16 \|\| x == IMM_EPP_32)
	116
	117	/* args to imm_connect */
	118	#define CONNECT_EPP_MAYBE 1
	119	#define CONNECT_NORMAL 0
	120
	121	#define r_dtr(x) (unsigned char)inb((x))
	122	#define r_str(x) (unsigned char)inb((x)+1)
	123	#define r_ctr(x) (unsigned char)inb((x)+2)
	124	#define r_epp(x) (unsigned char)inb((x)+4)
	125	#define r_fifo(x) (unsigned char)inb((x)) /* x must be base_hi */
	126	/* On PCI is: base+0x400 != base_hi */
	127	#define r_ecr(x) (unsigned char)inb((x)+2) /* x must be base_hi */
	128
	129	#define w_dtr(x,y) outb(y, (x))
	130	#define w_str(x,y) outb(y, (x)+1)
	131	#define w_epp(x,y) outb(y, (x)+4)
	132	#define w_fifo(x,y) outb(y, (x)) /* x must be base_hi */
133	#define w_ecr(x,y) outb(y, (x)+0x2) /* x must be base_hi */
134
135	#ifdef CONFIG_SCSI_IZIP_SLOW_CTR
136	#define w_ctr(x,y) outb_p(y, (x)+2)
137	#else
138	#define w_ctr(x,y) outb(y, (x)+2)
139	#endif
140
141	static int imm_engine(imm_struct , struct scsi_cmnd );
142
143	#endif /* _IMM_H */