1
2/*  Driver for the Iomega MatchMaker parallel port SCSI HBA embedded in
3 * the Iomega ZIP Plus drive
4 *
5 * (c) 1998     David Campbell     campbell@torque.net
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
69#ifdef IMM_CODE
70#include  <linux/config.h>
71#include  <linux/stddef.h>
72#include  <linux/module.h>
73#include  <linux/kernel.h>
74#include  <linux/tqueue.h>
75#include  <linux/ioport.h>
76#include  <linux/delay.h>
77#include  <linux/proc_fs.h>
78#include  <linux/stat.h>
79#include  <linux/blk.h>
80#include  <linux/sched.h>
81#include  <linux/interrupt.h>
82
83#include  <asm/io.h>
84#include  "sd.h"
85#include  "hosts.h"
86/* batteries not included :-) */
87
88/*
89 * modes in which the driver can operate
90 */
91#define   IMM_AUTODETECT        0	/* Autodetect mode                */
92#define   IMM_NIBBLE            1	/* work in standard 4 bit mode    */
93#define   IMM_PS2               2	/* PS/2 byte mode         */
94#define   IMM_EPP_8             3	/* EPP mode, 8 bit                */
95#define   IMM_EPP_16            4	/* EPP mode, 16 bit               */
96#define   IMM_EPP_32            5	/* EPP mode, 32 bit               */
97#define   IMM_UNKNOWN           6	/* Just in case...                */
98
99static char *IMM_MODE_STRING[] =
100{
101    "Autodetect",
102    "SPP",
103    "PS/2",
104    "EPP 8 bit",
105    "EPP 16 bit",
106#ifdef CONFIG_SCSI_IZIP_EPP16
107    "EPP 16 bit",
108#else
109    "EPP 32 bit",
110#endif
111    "Unknown"};
112
113/* This is a global option */
114int imm_sg = SG_ALL;		/* enable/disable scatter-gather. */
115
116/* other options */
117#define IMM_CAN_QUEUE   1	/* use "queueing" interface */
118#define IMM_BURST_SIZE	512	/* data burst size */
119#define IMM_SELECT_TMO  500	/* 500 how long to wait for target ? */
120#define IMM_SPIN_TMO    5000	/* 50000 imm_wait loop limiter */
121#define IMM_DEBUG	0	/* debugging option */
122#define IN_EPP_MODE(x) (x == IMM_EPP_8 || x == IMM_EPP_16 || x == IMM_EPP_32)
123
124/* args to imm_connect */
125#define CONNECT_EPP_MAYBE 1
126#define CONNECT_NORMAL  0
127
128#define r_dtr(x)        (unsigned char)inb((x))
129#define r_str(x)        (unsigned char)inb((x)+1)
130#define r_ctr(x)        (unsigned char)inb((x)+2)
131#define r_epp(x)        (unsigned char)inb((x)+4)
132#define r_fifo(x)       (unsigned char)inb((x))   /* x must be base_hi */
133					/* On PCI is: base+0x400 != base_hi */
134#define r_ecr(x)        (unsigned char)inb((x)+2) /* x must be base_hi */
135
136#define w_dtr(x,y)      outb(y, (x))
137#define w_str(x,y)      outb(y, (x)+1)
138#define w_epp(x,y)      outb(y, (x)+4)
139#define w_fifo(x,y)     outb(y, (x))     /* x must be base_hi */
140#define w_ecr(x,y)      outb(y, (x)+0x2) /* x must be base_hi */
141
142#ifdef CONFIG_SCSI_IZIP_SLOW_CTR
143#define w_ctr(x,y)      outb_p(y, (x)+2)
144#else
145#define w_ctr(x,y)      outb(y, (x)+2)
146#endif
147
148static int imm_engine(imm_struct *, Scsi_Cmnd *);
149static int imm_in(int, char *, int);
150static int imm_init(int);
151static void imm_interrupt(void *);
152static int imm_out(int, char *, int);
153
154#else
155#define imm_release 0
156#endif
157
158int imm_detect(Scsi_Host_Template *);
159const char *imm_info(struct Scsi_Host *);
160int imm_command(Scsi_Cmnd *);
161int imm_queuecommand(Scsi_Cmnd *, void (*done) (Scsi_Cmnd *));
162int imm_abort(Scsi_Cmnd *);
163int imm_reset(Scsi_Cmnd *);
164int imm_proc_info(char *, char **, off_t, int, int, int);
165int imm_biosparam(Disk *, kdev_t, int *);
166
167#define IMM {	proc_name:			"imm",			\
168		proc_info:			imm_proc_info,		\
169		name:				"Iomega VPI2 (imm) interface",\
170		detect:				imm_detect,		\
171		release:			imm_release,		\
172		command:			imm_command,		\
173		queuecommand:			imm_queuecommand,	\
174                eh_abort_handler:               imm_abort,              \
175                eh_device_reset_handler:        NULL,                   \
176                eh_bus_reset_handler:           imm_reset,              \
177                eh_host_reset_handler:          imm_reset,              \
178		use_new_eh_code:		1,			\
179		bios_param:		        imm_biosparam,		\
180		this_id:			7,			\
181		sg_tablesize:			SG_ALL,			\
182		cmd_per_lun:			1,			\
183		use_clustering:			ENABLE_CLUSTERING	\
184}
185#endif				/* _IMM_H */
186