Sync usage with man page.
[netbsd-mini2440.git] / sys / arch / amiga / dev / bzivsc.c
blob90f4648382101f9054d63f28d08b1e4b4ce6e95a
1 /* $NetBSD: bzivsc.c,v 1.27 2009/10/21 23:53:38 snj Exp $ */
3 /*
4 * Copyright (c) 1997 Michael L. Hitch
5 * Copyright (c) 1982, 1990 The Regents of the University of California.
6 * All rights reserved.
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. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
34 #include <sys/cdefs.h>
35 __KERNEL_RCSID(0, "$NetBSD: bzivsc.c,v 1.27 2009/10/21 23:53:38 snj Exp $");
37 #include <sys/types.h>
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/errno.h>
42 #include <sys/ioctl.h>
43 #include <sys/device.h>
44 #include <sys/buf.h>
45 #include <sys/proc.h>
46 #include <sys/queue.h>
48 #include <uvm/uvm_extern.h>
50 #include <dev/scsipi/scsi_all.h>
51 #include <dev/scsipi/scsipi_all.h>
52 #include <dev/scsipi/scsiconf.h>
53 #include <dev/scsipi/scsi_message.h>
55 #include <machine/cpu.h>
56 #include <machine/param.h>
58 #include <dev/ic/ncr53c9xreg.h>
59 #include <dev/ic/ncr53c9xvar.h>
61 #include <amiga/amiga/isr.h>
62 #include <amiga/dev/bzivscvar.h>
63 #include <amiga/dev/zbusvar.h>
65 #ifdef __powerpc__
66 #define badaddr(a) badaddr_read(a, 2, NULL)
67 #endif
69 int bzivscmatch(device_t, cfdata_t, void *);
70 void bzivscattach(device_t, device_t, void *);
72 /* Linkup to the rest of the kernel */
73 CFATTACH_DECL_NEW(bzivsc, sizeof(struct bzivsc_softc),
74 bzivscmatch, bzivscattach, NULL, NULL);
77 * Functions and the switch for the MI code.
79 uint8_t bzivsc_read_reg(struct ncr53c9x_softc *, int);
80 void bzivsc_write_reg(struct ncr53c9x_softc *, int, uint8_t);
81 int bzivsc_dma_isintr(struct ncr53c9x_softc *);
82 void bzivsc_dma_reset(struct ncr53c9x_softc *);
83 int bzivsc_dma_intr(struct ncr53c9x_softc *);
84 int bzivsc_dma_setup(struct ncr53c9x_softc *, uint8_t **,
85 size_t *, int, size_t *);
86 void bzivsc_dma_go(struct ncr53c9x_softc *);
87 void bzivsc_dma_stop(struct ncr53c9x_softc *);
88 int bzivsc_dma_isactive(struct ncr53c9x_softc *);
90 struct ncr53c9x_glue bzivsc_glue = {
91 bzivsc_read_reg,
92 bzivsc_write_reg,
93 bzivsc_dma_isintr,
94 bzivsc_dma_reset,
95 bzivsc_dma_intr,
96 bzivsc_dma_setup,
97 bzivsc_dma_go,
98 bzivsc_dma_stop,
99 bzivsc_dma_isactive,
100 NULL,
103 /* Maximum DMA transfer length to reduce impact on high-speed serial input */
104 u_long bzivsc_max_dma = 1024;
105 extern int ser_open_speed;
107 u_long bzivsc_cnt_pio = 0; /* number of PIO transfers */
108 u_long bzivsc_cnt_dma = 0; /* number of DMA transfers */
109 u_long bzivsc_cnt_dma2 = 0; /* number of DMA transfers broken up */
110 u_long bzivsc_cnt_dma3 = 0; /* number of pages combined */
112 #ifdef DEBUG
113 struct {
114 uint8_t hardbits;
115 uint8_t status;
116 uint8_t xx;
117 uint8_t yy;
118 } bzivsc_trace[128];
119 int bzivsc_trace_ptr = 0;
120 int bzivsc_trace_enable = 1;
121 void bzivsc_dump(void);
122 #endif
125 * if we are a Phase5 Blizzard 12x0-IV
128 bzivscmatch(device_t parent, cfdata_t cf, void *aux)
130 struct zbus_args *zap;
131 volatile uint8_t *regs;
133 zap = aux;
134 if (zap->manid != 0x2140)
135 return 0; /* It's not Phase 5 */
136 if (zap->prodid != 11 && zap->prodid != 17)
137 return 0; /* Not Blizzard 12x0 */
138 if (!is_a1200())
139 return 0; /* And not A1200 */
140 regs = &((volatile u_char *)zap->va)[0x8000];
141 if (badaddr((void *)__UNVOLATILE(regs)))
142 return 0;
143 regs[NCR_CFG1 * 4] = 0;
144 regs[NCR_CFG1 * 4] = NCRCFG1_PARENB | 7;
145 delay(5);
146 if (regs[NCR_CFG1 * 4] != (NCRCFG1_PARENB | 7))
147 return 0;
148 return 1;
152 * Attach this instance, and then all the sub-devices
154 void
155 bzivscattach(device_t parent, device_t self, void *aux)
157 struct bzivsc_softc *bsc = device_private(self);
158 struct ncr53c9x_softc *sc = &bsc->sc_ncr53c9x;
159 struct zbus_args *zap;
160 extern u_long scsi_nosync;
161 extern int shift_nosync;
162 extern int ncr53c9x_debug;
165 * Set up the glue for MI code early; we use some of it here.
167 sc->sc_dev = self;
168 sc->sc_glue = &bzivsc_glue;
171 * Save the regs
173 zap = aux;
174 bsc->sc_reg = &((volatile uint8_t *)zap->va)[0x8000];
175 bsc->sc_dmabase = &bsc->sc_reg[0x8000];
177 sc->sc_freq = 40; /* Clocked at 40 MHz */
179 aprint_normal(": address %p", bsc->sc_reg);
181 sc->sc_id = 7;
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.
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;
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
202 sc->sc_minsync = 1000 / sc->sc_freq;
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.
209 device_cfdata(self)->cf_flags |= (scsi_nosync >> shift_nosync)
210 & 0xffff;
211 shift_nosync += 16;
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;
217 #if 1
218 if (((scsi_nosync >> shift_nosync) & 0xff00) == 0xff00)
219 sc->sc_minsync = 0;
220 #endif
222 /* Really no limit, but since we want to fit into the TCR... */
223 sc->sc_maxxfer = 64 * 1024;
226 * Configure interrupts.
228 bsc->sc_isr.isr_intr = ncr53c9x_intr;
229 bsc->sc_isr.isr_arg = sc;
230 bsc->sc_isr.isr_ipl = 2;
231 add_isr(&bsc->sc_isr);
234 * Now try to attach all the sub-devices
236 sc->sc_adapter.adapt_request = ncr53c9x_scsipi_request;
237 sc->sc_adapter.adapt_minphys = minphys;
238 ncr53c9x_attach(sc);
242 * Glue functions.
245 uint8_t
246 bzivsc_read_reg(struct ncr53c9x_softc *sc, int reg)
248 struct bzivsc_softc *bsc = (struct bzivsc_softc *)sc;
250 return bsc->sc_reg[reg * 4];
253 void
254 bzivsc_write_reg(struct ncr53c9x_softc *sc, int reg, uint8_t val)
256 struct bzivsc_softc *bsc = (struct bzivsc_softc *)sc;
257 uint8_t v = val;
259 bsc->sc_reg[reg * 4] = v;
260 #ifdef DEBUG
261 if (bzivsc_trace_enable/* && sc->sc_nexus && sc->sc_nexus->xs->xs_control & XS_CTL_POLL */ &&
262 reg == NCR_CMD/* && bsc->sc_active*/) {
263 bzivsc_trace[(bzivsc_trace_ptr - 1) & 127].yy = v;
264 /* printf(" cmd %x", v);*/
266 #endif
270 bzivsc_dma_isintr(struct ncr53c9x_softc *sc)
272 struct bzivsc_softc *bsc = (struct bzivsc_softc *)sc;
274 if ((bsc->sc_reg[NCR_STAT * 4] & NCRSTAT_INT) == 0)
275 return 0;
277 #ifdef DEBUG
278 if (/*sc->sc_nexus && sc->sc_nexus->xs->xs_control & XS_CTL_POLL &&*/ bzivsc_trace_enable) {
279 bzivsc_trace[bzivsc_trace_ptr].status = bsc->sc_reg[NCR_STAT * 4];
280 bzivsc_trace[bzivsc_trace_ptr].xx = bsc->sc_reg[NCR_CMD * 4];
281 bzivsc_trace[bzivsc_trace_ptr].yy = bsc->sc_active;
282 bzivsc_trace_ptr = (bzivsc_trace_ptr + 1) & 127;
284 #endif
285 return 1;
288 void
289 bzivsc_dma_reset(struct ncr53c9x_softc *sc)
291 struct bzivsc_softc *bsc = (struct bzivsc_softc *)sc;
293 bsc->sc_active = 0;
297 bzivsc_dma_intr(struct ncr53c9x_softc *sc)
299 register struct bzivsc_softc *bsc = (struct bzivsc_softc *)sc;
300 register int cnt;
302 NCR_DMA(("bzivsc_dma_intr: cnt %d int %x stat %x fifo %d ",
303 bsc->sc_dmasize, sc->sc_espintr, sc->sc_espstat,
304 bsc->sc_reg[NCR_FFLAG * 4] & NCRFIFO_FF));
305 if (bsc->sc_active == 0) {
306 printf("bzivsc_intr--inactive DMA\n");
307 return -1;
310 /* update sc_dmaaddr and sc_pdmalen */
311 cnt = bsc->sc_reg[NCR_TCL * 4];
312 cnt += bsc->sc_reg[NCR_TCM * 4] << 8;
313 cnt += bsc->sc_reg[NCR_TCH * 4] << 16;
314 if (!bsc->sc_datain) {
315 cnt += bsc->sc_reg[NCR_FFLAG * 4] & NCRFIFO_FF;
316 bsc->sc_reg[NCR_CMD * 4] = NCRCMD_FLUSH;
318 cnt = bsc->sc_dmasize - cnt; /* number of bytes transferred */
319 NCR_DMA(("DMA xferred %d\n", cnt));
320 if (bsc->sc_xfr_align) {
321 memcpy(*bsc->sc_dmaaddr, bsc->sc_alignbuf, cnt);
322 bsc->sc_xfr_align = 0;
324 *bsc->sc_dmaaddr += cnt;
325 *bsc->sc_pdmalen -= cnt;
326 bsc->sc_active = 0;
327 return 0;
331 bzivsc_dma_setup(struct ncr53c9x_softc *sc, uint8_t **addr, size_t *len,
332 int datain, size_t *dmasize)
334 struct bzivsc_softc *bsc = (struct bzivsc_softc *)sc;
335 paddr_t pa;
336 uint8_t *ptr;
337 size_t xfer;
339 bsc->sc_dmaaddr = addr;
340 bsc->sc_pdmalen = len;
341 bsc->sc_datain = datain;
342 bsc->sc_dmasize = *dmasize;
344 * DMA can be nasty for high-speed serial input, so limit the
345 * size of this DMA operation if the serial port is running at
346 * a high speed (higher than 19200 for now - should be adjusted
347 * based on CPU type and speed?).
348 * XXX - add serial speed check XXX
350 if (ser_open_speed > 19200 && bzivsc_max_dma != 0 &&
351 bsc->sc_dmasize > bzivsc_max_dma)
352 bsc->sc_dmasize = bzivsc_max_dma;
353 ptr = *addr; /* Kernel virtual address */
354 pa = kvtop(ptr); /* Physical address of DMA */
355 xfer = min(bsc->sc_dmasize, PAGE_SIZE - (pa & (PAGE_SIZE - 1)));
356 bsc->sc_xfr_align = 0;
358 * If output and unaligned, stuff odd byte into FIFO
360 if (datain == 0 && (int)ptr & 1) {
361 NCR_DMA(("bzivsc_dma_setup: align byte written to fifo\n"));
362 pa++;
363 xfer--; /* XXXX CHECK THIS !!!! XXXX */
364 bsc->sc_reg[NCR_FIFO * 4] = *ptr++;
367 * If unaligned address, read unaligned bytes into alignment buffer
369 else if ((int)ptr & 1) {
370 pa = kvtop((void *)&bsc->sc_alignbuf);
371 xfer = bsc->sc_dmasize = min(xfer, sizeof(bsc->sc_alignbuf));
372 NCR_DMA(("bzivsc_dma_setup: align read by %d bytes\n", xfer));
373 bsc->sc_xfr_align = 1;
375 ++bzivsc_cnt_dma; /* number of DMA operations */
377 while (xfer < bsc->sc_dmasize) {
378 if ((pa + xfer) != kvtop(*addr + xfer))
379 break;
380 if ((bsc->sc_dmasize - xfer) < PAGE_SIZE)
381 xfer = bsc->sc_dmasize;
382 else
383 xfer += PAGE_SIZE;
384 ++bzivsc_cnt_dma3;
386 if (xfer != *len)
387 ++bzivsc_cnt_dma2;
389 bsc->sc_dmasize = xfer;
390 *dmasize = bsc->sc_dmasize;
391 bsc->sc_pa = pa;
392 #if defined(M68040) || defined(M68060)
393 if (mmutype == MMU_68040) {
394 if (bsc->sc_xfr_align) {
395 dma_cachectl(bsc->sc_alignbuf,
396 sizeof(bsc->sc_alignbuf));
398 else
399 dma_cachectl(*bsc->sc_dmaaddr, bsc->sc_dmasize);
401 #endif
403 pa >>= 1;
404 if (!bsc->sc_datain)
405 pa |= 0x80000000;
406 bsc->sc_dmabase[0x8000] = (uint8_t)(pa >> 24);
407 bsc->sc_dmabase[0] = (uint8_t)(pa >> 24);
408 bsc->sc_dmabase[0] = (uint8_t)(pa >> 16);
409 bsc->sc_dmabase[0] = (uint8_t)(pa >> 8);
410 bsc->sc_dmabase[0] = (uint8_t)(pa);
411 bsc->sc_active = 1;
412 return 0;
415 void
416 bzivsc_dma_go(struct ncr53c9x_softc *sc)
420 void
421 bzivsc_dma_stop(struct ncr53c9x_softc *sc)
426 bzivsc_dma_isactive(struct ncr53c9x_softc *sc)
428 struct bzivsc_softc *bsc = (struct bzivsc_softc *)sc;
430 return bsc->sc_active;
433 #ifdef DEBUG
434 void
435 bzivsc_dump(void)
437 int i;
439 i = bzivsc_trace_ptr;
440 printf("bzivsc_trace dump: ptr %x\n", bzivsc_trace_ptr);
441 do {
442 if (bzivsc_trace[i].hardbits == 0) {
443 i = (i + 1) & 127;
444 continue;
446 printf("%02x%02x%02x%02x(", bzivsc_trace[i].hardbits,
447 bzivsc_trace[i].status, bzivsc_trace[i].xx, bzivsc_trace[i].yy);
448 if (bzivsc_trace[i].status & NCRSTAT_INT)
449 printf("NCRINT/");
450 if (bzivsc_trace[i].status & NCRSTAT_TC)
451 printf("NCRTC/");
452 switch(bzivsc_trace[i].status & NCRSTAT_PHASE) {
453 case 0:
454 printf("dataout"); break;
455 case 1:
456 printf("datain"); break;
457 case 2:
458 printf("cmdout"); break;
459 case 3:
460 printf("status"); break;
461 case 6:
462 printf("msgout"); break;
463 case 7:
464 printf("msgin"); break;
465 default:
466 printf("phase%d?", bzivsc_trace[i].status & NCRSTAT_PHASE);
468 printf(") ");
469 i = (i + 1) & 127;
470 } while (i != bzivsc_trace_ptr);
471 printf("\n");
473 #endif