xref: /netbsd-src/sys/arch/amiga/dev/cbiisc.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: cbiisc.c,v 1.26 2007/10/17 19:53:15 garbled Exp $ */
2 
3 /*
4  * Copyright (c) 1997 Michael L. Hitch
5  * Copyright (c) 1982, 1990 The Regents of the University of California.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product contains software written by Michael L. Hitch for
19  *	the NetBSD project.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  */
37 
38 #include <sys/cdefs.h>
39 __KERNEL_RCSID(0, "$NetBSD: cbiisc.c,v 1.26 2007/10/17 19:53:15 garbled Exp $");
40 
41 #include <sys/types.h>
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/errno.h>
46 #include <sys/ioctl.h>
47 #include <sys/device.h>
48 #include <sys/buf.h>
49 #include <sys/proc.h>
50 #include <sys/user.h>
51 #include <sys/queue.h>
52 
53 #include <uvm/uvm_extern.h>
54 
55 #include <dev/scsipi/scsi_all.h>
56 #include <dev/scsipi/scsipi_all.h>
57 #include <dev/scsipi/scsiconf.h>
58 #include <dev/scsipi/scsi_message.h>
59 
60 #include <machine/cpu.h>
61 #include <machine/param.h>
62 
63 #include <dev/ic/ncr53c9xreg.h>
64 #include <dev/ic/ncr53c9xvar.h>
65 
66 #include <amiga/amiga/isr.h>
67 #include <amiga/dev/cbiiscvar.h>
68 #include <amiga/dev/zbusvar.h>
69 
70 #ifdef __powerpc__
71 #define badaddr(a)      badaddr_read(a, 2, NULL)
72 #endif
73 
74 void	cbiiscattach(struct device *, struct device *, void *);
75 int	cbiiscmatch(struct device *, struct cfdata *, void *);
76 
77 /* Linkup to the rest of the kernel */
78 CFATTACH_DECL(cbiisc, sizeof(struct cbiisc_softc),
79     cbiiscmatch, cbiiscattach, NULL, NULL);
80 
81 /*
82  * Functions and the switch for the MI code.
83  */
84 u_char	cbiisc_read_reg(struct ncr53c9x_softc *, int);
85 void	cbiisc_write_reg(struct ncr53c9x_softc *, int, u_char);
86 int	cbiisc_dma_isintr(struct ncr53c9x_softc *);
87 void	cbiisc_dma_reset(struct ncr53c9x_softc *);
88 int	cbiisc_dma_intr(struct ncr53c9x_softc *);
89 int	cbiisc_dma_setup(struct ncr53c9x_softc *, void **,
90 	    size_t *, int, size_t *);
91 void	cbiisc_dma_go(struct ncr53c9x_softc *);
92 void	cbiisc_dma_stop(struct ncr53c9x_softc *);
93 int	cbiisc_dma_isactive(struct ncr53c9x_softc *);
94 
95 struct ncr53c9x_glue cbiisc_glue = {
96 	cbiisc_read_reg,
97 	cbiisc_write_reg,
98 	cbiisc_dma_isintr,
99 	cbiisc_dma_reset,
100 	cbiisc_dma_intr,
101 	cbiisc_dma_setup,
102 	cbiisc_dma_go,
103 	cbiisc_dma_stop,
104 	cbiisc_dma_isactive,
105 	0,
106 };
107 
108 /* Maximum DMA transfer length to reduce impact on high-speed serial input */
109 u_long cbiisc_max_dma = 1024;
110 extern int ser_open_speed;
111 
112 u_long cbiisc_cnt_pio = 0;	/* number of PIO transfers */
113 u_long cbiisc_cnt_dma = 0;	/* number of DMA transfers */
114 u_long cbiisc_cnt_dma2 = 0;	/* number of DMA transfers broken up */
115 u_long cbiisc_cnt_dma3 = 0;	/* number of pages combined */
116 
117 #ifdef DEBUG
118 struct {
119 	u_char hardbits;
120 	u_char status;
121 	u_char xx;
122 	u_char yy;
123 } cbiisc_trace[128];
124 int cbiisc_trace_ptr = 0;
125 int cbiisc_trace_enable = 1;
126 void cbiisc_dump(void);
127 #endif
128 
129 /*
130  * if we are a Phase5 CyberSCSI II
131  */
132 int
133 cbiiscmatch(struct device *parent, struct cfdata *cf, void *aux)
134 {
135 	struct zbus_args *zap;
136 	volatile u_char *regs;
137 
138 	zap = aux;
139 	if (zap->manid != 0x2140 || zap->prodid != 25)
140 		return(0);
141 	regs = &((volatile u_char *)zap->va)[0x1ff03];
142 	if (badaddr((void *)__UNVOLATILE(regs)))
143 		return(0);
144 	regs[NCR_CFG1 * 4] = 0;
145 	regs[NCR_CFG1 * 4] = NCRCFG1_PARENB | 7;
146 	delay(5);
147 	if (regs[NCR_CFG1 * 4] != (NCRCFG1_PARENB | 7))
148 		return(0);
149 	return(1);
150 }
151 
152 /*
153  * Attach this instance, and then all the sub-devices
154  */
155 void
156 cbiiscattach(struct device *parent, struct device *self, void *aux)
157 {
158 	struct cbiisc_softc *csc = (void *)self;
159 	struct ncr53c9x_softc *sc = &csc->sc_ncr53c9x;
160 	struct zbus_args  *zap;
161 	extern u_long scsi_nosync;
162 	extern int shift_nosync;
163 	extern int ncr53c9x_debug;
164 
165 	/*
166 	 * Set up the glue for MI code early; we use some of it here.
167 	 */
168 	sc->sc_glue = &cbiisc_glue;
169 
170 	/*
171 	 * Save the regs
172 	 */
173 	zap = aux;
174 	csc->sc_reg = &((volatile u_char *)zap->va)[0x1ff03];
175 	csc->sc_dmabase = &csc->sc_reg[0x80];
176 
177 	sc->sc_freq = 40;		/* Clocked at 40 MHz */
178 
179 	printf(": address %p", csc->sc_reg);
180 
181 	sc->sc_id = 7;
182 
183 	/*
184 	 * It is necessary to try to load the 2nd config register here,
185 	 * to find out what rev the FAS chip is, else the ncr53c9x_reset
186 	 * will not set up the defaults correctly.
187 	 */
188 	sc->sc_cfg1 = sc->sc_id | NCRCFG1_PARENB;
189 	sc->sc_cfg2 = NCRCFG2_SCSI2 | NCRCFG2_FE;
190 	sc->sc_cfg3 = 0x08 /*FCLK*/ | NCRESPCFG3_FSCSI | NCRESPCFG3_CDB;
191 	sc->sc_rev = NCR_VARIANT_FAS216;
192 
193 	/*
194 	 * This is the value used to start sync negotiations
195 	 * Note that the NCR register "SYNCTP" is programmed
196 	 * in "clocks per byte", and has a minimum value of 4.
197 	 * The SCSI period used in negotiation is one-fourth
198 	 * of the time (in nanoseconds) needed to transfer one byte.
199 	 * Since the chip's clock is given in MHz, we have the following
200 	 * formula: 4 * period = (1000 / freq) * 4
201 	 */
202 	sc->sc_minsync = 1000 / sc->sc_freq;
203 
204 	/*
205 	 * get flags from -I argument and set cf_flags.
206 	 * NOTE: low 8 bits are to disable disconnect, and the next
207 	 *       8 bits are to disable sync.
208 	 */
209 	device_cfdata(&sc->sc_dev)->cf_flags |= (scsi_nosync >> shift_nosync)
210 	    & 0xffff;
211 	shift_nosync += 16;
212 
213 	/* Use next 16 bits of -I argument to set ncr53c9x_debug flags */
214 	ncr53c9x_debug |= (scsi_nosync >> shift_nosync) & 0xffff;
215 	shift_nosync += 16;
216 
217 #if 1
218 	if (((scsi_nosync >> shift_nosync) & 0xff00) == 0xff00)
219 		sc->sc_minsync = 0;
220 #endif
221 
222 	/* Really no limit, but since we want to fit into the TCR... */
223 	sc->sc_maxxfer = 64 * 1024;
224 
225 	/*
226 	 * Configure interrupts.
227 	 */
228 	csc->sc_isr.isr_intr = ncr53c9x_intr;
229 	csc->sc_isr.isr_arg  = sc;
230 	csc->sc_isr.isr_ipl  = 2;
231 	add_isr(&csc->sc_isr);
232 
233 	/*
234 	 * Now try to attach all the sub-devices
235 	 */
236 	sc->sc_adapter.adapt_request = ncr53c9x_scsipi_request;
237 	sc->sc_adapter.adapt_minphys = minphys;
238 	ncr53c9x_attach(sc);
239 }
240 
241 /*
242  * Glue functions.
243  */
244 
245 u_char
246 cbiisc_read_reg(struct ncr53c9x_softc *sc, int reg)
247 {
248 	struct cbiisc_softc *csc = (struct cbiisc_softc *)sc;
249 
250 	return csc->sc_reg[reg * 4];
251 }
252 
253 void
254 cbiisc_write_reg(struct ncr53c9x_softc *sc, int reg, u_char val)
255 {
256 	struct cbiisc_softc *csc = (struct cbiisc_softc *)sc;
257 	u_char v = val;
258 
259 	csc->sc_reg[reg * 4] = v;
260 #ifdef DEBUG
261 if (cbiisc_trace_enable/* && sc->sc_nexus && sc->sc_nexus->xs->xs_control & XS_CTL_POLL*/ &&
262   reg == NCR_CMD/* && csc->sc_active*/) {
263   cbiisc_trace[(cbiisc_trace_ptr - 1) & 127].yy = v;
264 /*  printf(" cmd %x", v);*/
265 }
266 #endif
267 }
268 
269 int
270 cbiisc_dma_isintr(struct ncr53c9x_softc *sc)
271 {
272 	struct cbiisc_softc *csc = (struct cbiisc_softc *)sc;
273 
274 	if ((csc->sc_reg[NCR_STAT * 4] & NCRSTAT_INT) == 0)
275 		return 0;
276 
277 	if (sc->sc_state == NCR_CONNECTED)
278 		csc->sc_reg[0x40] = CBIISC_PB_LED;
279 	else
280 		csc->sc_reg[0x40] = 0;
281 
282 #ifdef DEBUG
283 if (/*sc->sc_nexus && sc->sc_nexus->xs->xs_control & XS_CTL_POLL &&*/ cbiisc_trace_enable) {
284   cbiisc_trace[cbiisc_trace_ptr].status = csc->sc_reg[NCR_STAT * 4];
285   cbiisc_trace[cbiisc_trace_ptr].xx = csc->sc_reg[NCR_CMD * 4];
286   cbiisc_trace[cbiisc_trace_ptr].yy = csc->sc_active;
287   cbiisc_trace_ptr = (cbiisc_trace_ptr + 1) & 127;
288 }
289 #endif
290 	return 1;
291 }
292 
293 void
294 cbiisc_dma_reset(struct ncr53c9x_softc *sc)
295 {
296 	struct cbiisc_softc *csc = (struct cbiisc_softc *)sc;
297 
298 	csc->sc_active = 0;
299 }
300 
301 int
302 cbiisc_dma_intr(struct ncr53c9x_softc *sc)
303 {
304 	register struct cbiisc_softc *csc = (struct cbiisc_softc *)sc;
305 	register int	cnt;
306 
307 	NCR_DMA(("cbiisc_dma_intr: cnt %d int %x stat %x fifo %d ",
308 	    csc->sc_dmasize, sc->sc_espintr, sc->sc_espstat,
309 	    csc->sc_reg[NCR_FFLAG * 4] & NCRFIFO_FF));
310 	if (csc->sc_active == 0) {
311 		printf("cbiisc_intr--inactive DMA\n");
312 		return -1;
313 	}
314 
315 	/* update sc_dmaaddr and sc_pdmalen */
316 	cnt = csc->sc_reg[NCR_TCL * 4];
317 	cnt += csc->sc_reg[NCR_TCM * 4] << 8;
318 	cnt += csc->sc_reg[NCR_TCH * 4] << 16;
319 	if (!csc->sc_datain) {
320 		cnt += csc->sc_reg[NCR_FFLAG * 4] & NCRFIFO_FF;
321 		csc->sc_reg[NCR_CMD * 4] = NCRCMD_FLUSH;
322 	}
323 	cnt = csc->sc_dmasize - cnt;	/* number of bytes transferred */
324 	NCR_DMA(("DMA xferred %d\n", cnt));
325 	if (csc->sc_xfr_align) {
326 		bcopy(csc->sc_alignbuf, *csc->sc_dmaaddr, cnt);
327 		csc->sc_xfr_align = 0;
328 	}
329 	*csc->sc_dmaaddr += cnt;
330 	*csc->sc_pdmalen -= cnt;
331 	csc->sc_active = 0;
332 	return 0;
333 }
334 
335 int
336 cbiisc_dma_setup(struct ncr53c9x_softc *sc, void **addr, size_t *len,
337                  int datain, size_t *dmasize)
338 {
339 	struct cbiisc_softc *csc = (struct cbiisc_softc *)sc;
340 	paddr_t pa;
341 	u_char *ptr;
342 	size_t xfer;
343 
344 	csc->sc_dmaaddr = (char **)addr;
345 	csc->sc_pdmalen = len;
346 	csc->sc_datain = datain;
347 	csc->sc_dmasize = *dmasize;
348 	/*
349 	 * DMA can be nasty for high-speed serial input, so limit the
350 	 * size of this DMA operation if the serial port is running at
351 	 * a high speed (higher than 19200 for now - should be adjusted
352 	 * based on CPU type and speed?).
353 	 * XXX - add serial speed check XXX
354 	 */
355 	if (ser_open_speed > 19200 && cbiisc_max_dma != 0 &&
356 	    csc->sc_dmasize > cbiisc_max_dma)
357 		csc->sc_dmasize = cbiisc_max_dma;
358 	ptr = *addr;			/* Kernel virtual address */
359 	pa = kvtop(ptr);		/* Physical address of DMA */
360 	xfer = min(csc->sc_dmasize, PAGE_SIZE - (pa & (PAGE_SIZE - 1)));
361 	csc->sc_xfr_align = 0;
362 	/*
363 	 * If output and unaligned, stuff odd byte into FIFO
364 	 */
365 	if (datain == 0 && (int)ptr & 1) {
366 		NCR_DMA(("cbiisc_dma_setup: align byte written to fifo\n"));
367 		pa++;
368 		xfer--;			/* XXXX CHECK THIS !!!! XXXX */
369 		csc->sc_reg[NCR_FIFO * 4] = *ptr++;
370 	}
371 	/*
372 	 * If unaligned address, read unaligned bytes into alignment buffer
373 	 */
374 	else if ((int)ptr & 1) {
375 		pa = kvtop((void *)&csc->sc_alignbuf);
376 		xfer = csc->sc_dmasize = min(xfer, sizeof (csc->sc_alignbuf));
377 		NCR_DMA(("cbiisc_dma_setup: align read by %d bytes\n", xfer));
378 		csc->sc_xfr_align = 1;
379 	}
380 ++cbiisc_cnt_dma;		/* number of DMA operations */
381 
382 	while (xfer < csc->sc_dmasize) {
383 		if ((pa + xfer) != kvtop((char*)*addr + xfer))
384 			break;
385 		if ((csc->sc_dmasize - xfer) < PAGE_SIZE)
386 			xfer = csc->sc_dmasize;
387 		else
388 			xfer += PAGE_SIZE;
389 ++cbiisc_cnt_dma3;
390 	}
391 if (xfer != *len)
392   ++cbiisc_cnt_dma2;
393 
394 	csc->sc_dmasize = xfer;
395 	*dmasize = csc->sc_dmasize;
396 	csc->sc_pa = pa;
397 #if defined(M68040) || defined(M68060)
398 	if (mmutype == MMU_68040) {
399 		if (csc->sc_xfr_align) {
400 			dma_cachectl(csc->sc_alignbuf,
401 			    sizeof(csc->sc_alignbuf));
402 		}
403 		else
404 			dma_cachectl(*csc->sc_dmaaddr, csc->sc_dmasize);
405 	}
406 #endif
407 
408 	if (csc->sc_datain)
409 		pa &= ~1;
410 	else
411 		pa |= 1;
412 	csc->sc_dmabase[0] = (u_int8_t)(pa >> 24);
413 	csc->sc_dmabase[4] = (u_int8_t)(pa >> 16);
414 	csc->sc_dmabase[8] = (u_int8_t)(pa >> 8);
415 	csc->sc_dmabase[12] = (u_int8_t)(pa);
416 	csc->sc_active = 1;
417 	return 0;
418 }
419 
420 void
421 cbiisc_dma_go(struct ncr53c9x_softc *sc)
422 {
423 }
424 
425 void
426 cbiisc_dma_stop(struct ncr53c9x_softc *sc)
427 {
428 }
429 
430 int
431 cbiisc_dma_isactive(struct ncr53c9x_softc *sc)
432 {
433 	struct cbiisc_softc *csc = (struct cbiisc_softc *)sc;
434 
435 	return csc->sc_active;
436 }
437 
438 #ifdef DEBUG
439 void
440 cbiisc_dump(void)
441 {
442 	int i;
443 
444 	i = cbiisc_trace_ptr;
445 	printf("cbiisc_trace dump: ptr %x\n", cbiisc_trace_ptr);
446 	do {
447 		if (cbiisc_trace[i].hardbits == 0) {
448 			i = (i + 1) & 127;
449 			continue;
450 		}
451 		printf("%02x%02x%02x%02x(", cbiisc_trace[i].hardbits,
452 		    cbiisc_trace[i].status, cbiisc_trace[i].xx, cbiisc_trace[i].yy);
453 		if (cbiisc_trace[i].status & NCRSTAT_INT)
454 			printf("NCRINT/");
455 		if (cbiisc_trace[i].status & NCRSTAT_TC)
456 			printf("NCRTC/");
457 		switch(cbiisc_trace[i].status & NCRSTAT_PHASE) {
458 		case 0:
459 			printf("dataout"); break;
460 		case 1:
461 			printf("datain"); break;
462 		case 2:
463 			printf("cmdout"); break;
464 		case 3:
465 			printf("status"); break;
466 		case 6:
467 			printf("msgout"); break;
468 		case 7:
469 			printf("msgin"); break;
470 		default:
471 			printf("phase%d?", cbiisc_trace[i].status & NCRSTAT_PHASE);
472 		}
473 		printf(") ");
474 		i = (i + 1) & 127;
475 	} while (i != cbiisc_trace_ptr);
476 	printf("\n");
477 }
478 #endif
479