1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun epat.c (c) 1997-8 Grant R. Guenther <grant@torque.net>
3*4882a593Smuzhiyun Under the terms of the GNU General Public License.
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun This is the low level protocol driver for the EPAT parallel
6*4882a593Smuzhiyun to IDE adapter from Shuttle Technologies. This adapter is
7*4882a593Smuzhiyun used in many popular parallel port disk products such as the
8*4882a593Smuzhiyun SyQuest EZ drives, the Avatar Shark and the Imation SuperDisk.
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun */
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun /* Changes:
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun 1.01 GRG 1998.05.06 init_proto, release_proto
15*4882a593Smuzhiyun 1.02 Joshua b. Jore CPP(renamed), epat_connect, epat_disconnect
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun */
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun #define EPAT_VERSION "1.02"
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #include <linux/module.h>
22*4882a593Smuzhiyun #include <linux/init.h>
23*4882a593Smuzhiyun #include <linux/delay.h>
24*4882a593Smuzhiyun #include <linux/kernel.h>
25*4882a593Smuzhiyun #include <linux/types.h>
26*4882a593Smuzhiyun #include <linux/wait.h>
27*4882a593Smuzhiyun #include <asm/io.h>
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun #include "paride.h"
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun #define j44(a,b) (((a>>4)&0x0f)+(b&0xf0))
32*4882a593Smuzhiyun #define j53(a,b) (((a>>3)&0x1f)+((b<<4)&0xe0))
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun static int epatc8;
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun module_param(epatc8, int, 0);
37*4882a593Smuzhiyun MODULE_PARM_DESC(epatc8, "support for the Shuttle EP1284 chip, "
38*4882a593Smuzhiyun "used in any recent Imation SuperDisk (LS-120) drive.");
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun /* cont = 0 IDE register file
41*4882a593Smuzhiyun cont = 1 IDE control registers
42*4882a593Smuzhiyun cont = 2 internal EPAT registers
43*4882a593Smuzhiyun */
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun static int cont_map[3] = { 0x18, 0x10, 0 };
46*4882a593Smuzhiyun
epat_write_regr(PIA * pi,int cont,int regr,int val)47*4882a593Smuzhiyun static void epat_write_regr( PIA *pi, int cont, int regr, int val)
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun { int r;
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun r = regr + cont_map[cont];
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun switch (pi->mode) {
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun case 0:
56*4882a593Smuzhiyun case 1:
57*4882a593Smuzhiyun case 2: w0(0x60+r); w2(1); w0(val); w2(4);
58*4882a593Smuzhiyun break;
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun case 3:
61*4882a593Smuzhiyun case 4:
62*4882a593Smuzhiyun case 5: w3(0x40+r); w4(val);
63*4882a593Smuzhiyun break;
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun }
66*4882a593Smuzhiyun }
67*4882a593Smuzhiyun
epat_read_regr(PIA * pi,int cont,int regr)68*4882a593Smuzhiyun static int epat_read_regr( PIA *pi, int cont, int regr )
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun { int a, b, r;
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun r = regr + cont_map[cont];
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun switch (pi->mode) {
75*4882a593Smuzhiyun
76*4882a593Smuzhiyun case 0: w0(r); w2(1); w2(3);
77*4882a593Smuzhiyun a = r1(); w2(4); b = r1();
78*4882a593Smuzhiyun return j44(a,b);
79*4882a593Smuzhiyun
80*4882a593Smuzhiyun case 1: w0(0x40+r); w2(1); w2(4);
81*4882a593Smuzhiyun a = r1(); b = r2(); w0(0xff);
82*4882a593Smuzhiyun return j53(a,b);
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun case 2: w0(0x20+r); w2(1); w2(0x25);
85*4882a593Smuzhiyun a = r0(); w2(4);
86*4882a593Smuzhiyun return a;
87*4882a593Smuzhiyun
88*4882a593Smuzhiyun case 3:
89*4882a593Smuzhiyun case 4:
90*4882a593Smuzhiyun case 5: w3(r); w2(0x24); a = r4(); w2(4);
91*4882a593Smuzhiyun return a;
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun }
94*4882a593Smuzhiyun return -1; /* never gets here */
95*4882a593Smuzhiyun }
96*4882a593Smuzhiyun
epat_read_block(PIA * pi,char * buf,int count)97*4882a593Smuzhiyun static void epat_read_block( PIA *pi, char * buf, int count )
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun { int k, ph, a, b;
100*4882a593Smuzhiyun
101*4882a593Smuzhiyun switch (pi->mode) {
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun case 0: w0(7); w2(1); w2(3); w0(0xff);
104*4882a593Smuzhiyun ph = 0;
105*4882a593Smuzhiyun for(k=0;k<count;k++) {
106*4882a593Smuzhiyun if (k == count-1) w0(0xfd);
107*4882a593Smuzhiyun w2(6+ph); a = r1();
108*4882a593Smuzhiyun if (a & 8) b = a;
109*4882a593Smuzhiyun else { w2(4+ph); b = r1(); }
110*4882a593Smuzhiyun buf[k] = j44(a,b);
111*4882a593Smuzhiyun ph = 1 - ph;
112*4882a593Smuzhiyun }
113*4882a593Smuzhiyun w0(0); w2(4);
114*4882a593Smuzhiyun break;
115*4882a593Smuzhiyun
116*4882a593Smuzhiyun case 1: w0(0x47); w2(1); w2(5); w0(0xff);
117*4882a593Smuzhiyun ph = 0;
118*4882a593Smuzhiyun for(k=0;k<count;k++) {
119*4882a593Smuzhiyun if (k == count-1) w0(0xfd);
120*4882a593Smuzhiyun w2(4+ph);
121*4882a593Smuzhiyun a = r1(); b = r2();
122*4882a593Smuzhiyun buf[k] = j53(a,b);
123*4882a593Smuzhiyun ph = 1 - ph;
124*4882a593Smuzhiyun }
125*4882a593Smuzhiyun w0(0); w2(4);
126*4882a593Smuzhiyun break;
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun case 2: w0(0x27); w2(1); w2(0x25); w0(0);
129*4882a593Smuzhiyun ph = 0;
130*4882a593Smuzhiyun for(k=0;k<count-1;k++) {
131*4882a593Smuzhiyun w2(0x24+ph);
132*4882a593Smuzhiyun buf[k] = r0();
133*4882a593Smuzhiyun ph = 1 - ph;
134*4882a593Smuzhiyun }
135*4882a593Smuzhiyun w2(0x26); w2(0x27); buf[count-1] = r0();
136*4882a593Smuzhiyun w2(0x25); w2(4);
137*4882a593Smuzhiyun break;
138*4882a593Smuzhiyun
139*4882a593Smuzhiyun case 3: w3(0x80); w2(0x24);
140*4882a593Smuzhiyun for(k=0;k<count-1;k++) buf[k] = r4();
141*4882a593Smuzhiyun w2(4); w3(0xa0); w2(0x24); buf[count-1] = r4();
142*4882a593Smuzhiyun w2(4);
143*4882a593Smuzhiyun break;
144*4882a593Smuzhiyun
145*4882a593Smuzhiyun case 4: w3(0x80); w2(0x24);
146*4882a593Smuzhiyun for(k=0;k<(count/2)-1;k++) ((u16 *)buf)[k] = r4w();
147*4882a593Smuzhiyun buf[count-2] = r4();
148*4882a593Smuzhiyun w2(4); w3(0xa0); w2(0x24); buf[count-1] = r4();
149*4882a593Smuzhiyun w2(4);
150*4882a593Smuzhiyun break;
151*4882a593Smuzhiyun
152*4882a593Smuzhiyun case 5: w3(0x80); w2(0x24);
153*4882a593Smuzhiyun for(k=0;k<(count/4)-1;k++) ((u32 *)buf)[k] = r4l();
154*4882a593Smuzhiyun for(k=count-4;k<count-1;k++) buf[k] = r4();
155*4882a593Smuzhiyun w2(4); w3(0xa0); w2(0x24); buf[count-1] = r4();
156*4882a593Smuzhiyun w2(4);
157*4882a593Smuzhiyun break;
158*4882a593Smuzhiyun
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun
epat_write_block(PIA * pi,char * buf,int count)162*4882a593Smuzhiyun static void epat_write_block( PIA *pi, char * buf, int count )
163*4882a593Smuzhiyun
164*4882a593Smuzhiyun { int ph, k;
165*4882a593Smuzhiyun
166*4882a593Smuzhiyun switch (pi->mode) {
167*4882a593Smuzhiyun
168*4882a593Smuzhiyun case 0:
169*4882a593Smuzhiyun case 1:
170*4882a593Smuzhiyun case 2: w0(0x67); w2(1); w2(5);
171*4882a593Smuzhiyun ph = 0;
172*4882a593Smuzhiyun for(k=0;k<count;k++) {
173*4882a593Smuzhiyun w0(buf[k]);
174*4882a593Smuzhiyun w2(4+ph);
175*4882a593Smuzhiyun ph = 1 - ph;
176*4882a593Smuzhiyun }
177*4882a593Smuzhiyun w2(7); w2(4);
178*4882a593Smuzhiyun break;
179*4882a593Smuzhiyun
180*4882a593Smuzhiyun case 3: w3(0xc0);
181*4882a593Smuzhiyun for(k=0;k<count;k++) w4(buf[k]);
182*4882a593Smuzhiyun w2(4);
183*4882a593Smuzhiyun break;
184*4882a593Smuzhiyun
185*4882a593Smuzhiyun case 4: w3(0xc0);
186*4882a593Smuzhiyun for(k=0;k<(count/2);k++) w4w(((u16 *)buf)[k]);
187*4882a593Smuzhiyun w2(4);
188*4882a593Smuzhiyun break;
189*4882a593Smuzhiyun
190*4882a593Smuzhiyun case 5: w3(0xc0);
191*4882a593Smuzhiyun for(k=0;k<(count/4);k++) w4l(((u32 *)buf)[k]);
192*4882a593Smuzhiyun w2(4);
193*4882a593Smuzhiyun break;
194*4882a593Smuzhiyun
195*4882a593Smuzhiyun }
196*4882a593Smuzhiyun }
197*4882a593Smuzhiyun
198*4882a593Smuzhiyun /* these macros access the EPAT registers in native addressing */
199*4882a593Smuzhiyun
200*4882a593Smuzhiyun #define WR(r,v) epat_write_regr(pi,2,r,v)
201*4882a593Smuzhiyun #define RR(r) (epat_read_regr(pi,2,r))
202*4882a593Smuzhiyun
203*4882a593Smuzhiyun /* and these access the IDE task file */
204*4882a593Smuzhiyun
205*4882a593Smuzhiyun #define WRi(r,v) epat_write_regr(pi,0,r,v)
206*4882a593Smuzhiyun #define RRi(r) (epat_read_regr(pi,0,r))
207*4882a593Smuzhiyun
208*4882a593Smuzhiyun /* FIXME: the CPP stuff should be fixed to handle multiple EPATs on a chain */
209*4882a593Smuzhiyun
210*4882a593Smuzhiyun #define CPP(x) w2(4);w0(0x22);w0(0xaa);w0(0x55);w0(0);w0(0xff);\
211*4882a593Smuzhiyun w0(0x87);w0(0x78);w0(x);w2(4);w2(5);w2(4);w0(0xff);
212*4882a593Smuzhiyun
epat_connect(PIA * pi)213*4882a593Smuzhiyun static void epat_connect ( PIA *pi )
214*4882a593Smuzhiyun
215*4882a593Smuzhiyun { pi->saved_r0 = r0();
216*4882a593Smuzhiyun pi->saved_r2 = r2();
217*4882a593Smuzhiyun
218*4882a593Smuzhiyun /* Initialize the chip */
219*4882a593Smuzhiyun CPP(0);
220*4882a593Smuzhiyun
221*4882a593Smuzhiyun if (epatc8) {
222*4882a593Smuzhiyun CPP(0x40);CPP(0xe0);
223*4882a593Smuzhiyun w0(0);w2(1);w2(4);
224*4882a593Smuzhiyun WR(0x8,0x12);WR(0xc,0x14);WR(0x12,0x10);
225*4882a593Smuzhiyun WR(0xe,0xf);WR(0xf,4);
226*4882a593Smuzhiyun /* WR(0xe,0xa);WR(0xf,4); */
227*4882a593Smuzhiyun WR(0xe,0xd);WR(0xf,0);
228*4882a593Smuzhiyun /* CPP(0x30); */
229*4882a593Smuzhiyun }
230*4882a593Smuzhiyun
231*4882a593Smuzhiyun /* Connect to the chip */
232*4882a593Smuzhiyun CPP(0xe0);
233*4882a593Smuzhiyun w0(0);w2(1);w2(4); /* Idle into SPP */
234*4882a593Smuzhiyun if (pi->mode >= 3) {
235*4882a593Smuzhiyun w0(0);w2(1);w2(4);w2(0xc);
236*4882a593Smuzhiyun /* Request EPP */
237*4882a593Smuzhiyun w0(0x40);w2(6);w2(7);w2(4);w2(0xc);w2(4);
238*4882a593Smuzhiyun }
239*4882a593Smuzhiyun
240*4882a593Smuzhiyun if (!epatc8) {
241*4882a593Smuzhiyun WR(8,0x10); WR(0xc,0x14); WR(0xa,0x38); WR(0x12,0x10);
242*4882a593Smuzhiyun }
243*4882a593Smuzhiyun }
244*4882a593Smuzhiyun
epat_disconnect(PIA * pi)245*4882a593Smuzhiyun static void epat_disconnect (PIA *pi)
246*4882a593Smuzhiyun { CPP(0x30);
247*4882a593Smuzhiyun w0(pi->saved_r0);
248*4882a593Smuzhiyun w2(pi->saved_r2);
249*4882a593Smuzhiyun }
250*4882a593Smuzhiyun
epat_test_proto(PIA * pi,char * scratch,int verbose)251*4882a593Smuzhiyun static int epat_test_proto( PIA *pi, char * scratch, int verbose )
252*4882a593Smuzhiyun
253*4882a593Smuzhiyun { int k, j, f, cc;
254*4882a593Smuzhiyun int e[2] = {0,0};
255*4882a593Smuzhiyun
256*4882a593Smuzhiyun epat_connect(pi);
257*4882a593Smuzhiyun cc = RR(0xd);
258*4882a593Smuzhiyun epat_disconnect(pi);
259*4882a593Smuzhiyun
260*4882a593Smuzhiyun epat_connect(pi);
261*4882a593Smuzhiyun for (j=0;j<2;j++) {
262*4882a593Smuzhiyun WRi(6,0xa0+j*0x10);
263*4882a593Smuzhiyun for (k=0;k<256;k++) {
264*4882a593Smuzhiyun WRi(2,k^0xaa);
265*4882a593Smuzhiyun WRi(3,k^0x55);
266*4882a593Smuzhiyun if (RRi(2) != (k^0xaa)) e[j]++;
267*4882a593Smuzhiyun }
268*4882a593Smuzhiyun }
269*4882a593Smuzhiyun epat_disconnect(pi);
270*4882a593Smuzhiyun
271*4882a593Smuzhiyun f = 0;
272*4882a593Smuzhiyun epat_connect(pi);
273*4882a593Smuzhiyun WR(0x13,1); WR(0x13,0); WR(0xa,0x11);
274*4882a593Smuzhiyun epat_read_block(pi,scratch,512);
275*4882a593Smuzhiyun
276*4882a593Smuzhiyun for (k=0;k<256;k++) {
277*4882a593Smuzhiyun if ((scratch[2*k] & 0xff) != k) f++;
278*4882a593Smuzhiyun if ((scratch[2*k+1] & 0xff) != (0xff-k)) f++;
279*4882a593Smuzhiyun }
280*4882a593Smuzhiyun epat_disconnect(pi);
281*4882a593Smuzhiyun
282*4882a593Smuzhiyun if (verbose) {
283*4882a593Smuzhiyun printk("%s: epat: port 0x%x, mode %d, ccr %x, test=(%d,%d,%d)\n",
284*4882a593Smuzhiyun pi->device,pi->port,pi->mode,cc,e[0],e[1],f);
285*4882a593Smuzhiyun }
286*4882a593Smuzhiyun
287*4882a593Smuzhiyun return (e[0] && e[1]) || f;
288*4882a593Smuzhiyun }
289*4882a593Smuzhiyun
epat_log_adapter(PIA * pi,char * scratch,int verbose)290*4882a593Smuzhiyun static void epat_log_adapter( PIA *pi, char * scratch, int verbose )
291*4882a593Smuzhiyun
292*4882a593Smuzhiyun { int ver;
293*4882a593Smuzhiyun char *mode_string[6] =
294*4882a593Smuzhiyun {"4-bit","5/3","8-bit","EPP-8","EPP-16","EPP-32"};
295*4882a593Smuzhiyun
296*4882a593Smuzhiyun epat_connect(pi);
297*4882a593Smuzhiyun WR(0xa,0x38); /* read the version code */
298*4882a593Smuzhiyun ver = RR(0xb);
299*4882a593Smuzhiyun epat_disconnect(pi);
300*4882a593Smuzhiyun
301*4882a593Smuzhiyun printk("%s: epat %s, Shuttle EPAT chip %x at 0x%x, ",
302*4882a593Smuzhiyun pi->device,EPAT_VERSION,ver,pi->port);
303*4882a593Smuzhiyun printk("mode %d (%s), delay %d\n",pi->mode,
304*4882a593Smuzhiyun mode_string[pi->mode],pi->delay);
305*4882a593Smuzhiyun
306*4882a593Smuzhiyun }
307*4882a593Smuzhiyun
308*4882a593Smuzhiyun static struct pi_protocol epat = {
309*4882a593Smuzhiyun .owner = THIS_MODULE,
310*4882a593Smuzhiyun .name = "epat",
311*4882a593Smuzhiyun .max_mode = 6,
312*4882a593Smuzhiyun .epp_first = 3,
313*4882a593Smuzhiyun .default_delay = 1,
314*4882a593Smuzhiyun .max_units = 1,
315*4882a593Smuzhiyun .write_regr = epat_write_regr,
316*4882a593Smuzhiyun .read_regr = epat_read_regr,
317*4882a593Smuzhiyun .write_block = epat_write_block,
318*4882a593Smuzhiyun .read_block = epat_read_block,
319*4882a593Smuzhiyun .connect = epat_connect,
320*4882a593Smuzhiyun .disconnect = epat_disconnect,
321*4882a593Smuzhiyun .test_proto = epat_test_proto,
322*4882a593Smuzhiyun .log_adapter = epat_log_adapter,
323*4882a593Smuzhiyun };
324*4882a593Smuzhiyun
epat_init(void)325*4882a593Smuzhiyun static int __init epat_init(void)
326*4882a593Smuzhiyun {
327*4882a593Smuzhiyun #ifdef CONFIG_PARIDE_EPATC8
328*4882a593Smuzhiyun epatc8 = 1;
329*4882a593Smuzhiyun #endif
330*4882a593Smuzhiyun return paride_register(&epat);
331*4882a593Smuzhiyun }
332*4882a593Smuzhiyun
epat_exit(void)333*4882a593Smuzhiyun static void __exit epat_exit(void)
334*4882a593Smuzhiyun {
335*4882a593Smuzhiyun paride_unregister(&epat);
336*4882a593Smuzhiyun }
337*4882a593Smuzhiyun
338*4882a593Smuzhiyun MODULE_LICENSE("GPL");
339*4882a593Smuzhiyun module_init(epat_init)
340*4882a593Smuzhiyun module_exit(epat_exit)
341