1/*	$NetBSD: sc_mbmem.c,v 1.16 2023/08/04 11:18:18 rin Exp $	*/
2
3/*-
4 * Copyright (c) 1996 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Adam Glass, David Jones, Gordon W. Ross, and Matthew Fredette.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32/*
33 * This file contains only the machine-dependent parts of the
34 * Sun-2 SCSI driver.  (Autoconfig stuff and DMA functions.)
35 * The machine-independent parts are in sunscpal.c
36 *
37 * Supported hardware includes:
38 * Sun SCSI-2 on Multibus (Sun2/120,Sun2/170)
39 * Sun SCSI-2 on VME (Sun2/50,Sun3/160,Sun3/260,others?)
40 *
41 * Credits, history:
42 *
43 * Matthew Fredette took revision 1.15 of si_vme.c, and then heavily
44 * modified it to support the Sun sc.  The remaining credits
45 * are from si_vme.c:
46 *
47 * David Jones wrote the initial version of this module, which
48 * included support for the VME adapter only. (no reselection).
49 *
50 * Gordon Ross added support for the OBIO adapter, and re-worked
51 * both the VME and OBIO code to support disconnect/reselect.
52 * (Required figuring out the hardware "features" noted above.)
53 *
54 * The autoconfiguration boilerplate came from Adam Glass.
55 */
56
57/*****************************************************************
58 * Multibus functions for sc
59 ****************************************************************/
60
61#include <sys/cdefs.h>
62__KERNEL_RCSID(0, "$NetBSD: sc_mbmem.c,v 1.16 2023/08/04 11:18:18 rin Exp $");
63
64#include <sys/param.h>
65#include <sys/systm.h>
66#include <sys/errno.h>
67#include <sys/kernel.h>
68#include <sys/kmem.h>
69#include <sys/device.h>
70#include <sys/buf.h>
71#include <sys/proc.h>
72
73#include <dev/scsipi/scsi_all.h>
74#include <dev/scsipi/scsipi_all.h>
75#include <dev/scsipi/scsipi_debug.h>
76#include <dev/scsipi/scsiconf.h>
77
78#include <machine/autoconf.h>
79#include <machine/bus.h>
80
81/* #define DEBUG XXX */
82
83#include <dev/ic/sunscpalreg.h>
84#include <dev/ic/sunscpalvar.h>
85
86/* Yes, we use a VME header file. */
87#include <dev/vme/screg.h>
88
89/*
90 * Transfers smaller than this are done using PIO
91 * (on assumption they're not worth DMA overhead)
92 */
93#define	MIN_DMA_LEN 128
94
95/*
96 * New-style autoconfig attachment
97 */
98
99static int	sunsc_mbmem_match(device_t, cfdata_t, void *);
100static void	sunsc_mbmem_attach(device_t, device_t, void *);
101static int	sunsc_mbmem_intr(void *);
102
103CFATTACH_DECL_NEW(sc_mbmem, sizeof(struct sunscpal_softc),
104    sunsc_mbmem_match, sunsc_mbmem_attach, NULL, NULL);
105
106/*
107 * Options for parity, DMA, and interrupts.
108 */
109int sunsc_mbmem_options = 0x00;
110
111static int
112sunsc_mbmem_match(device_t parent, cfdata_t cf, void *aux)
113{
114	struct mbmem_attach_args *mbma = aux;
115	bus_space_handle_t bh;
116	bool matched;
117
118	/* No default Multibus address. */
119	if (mbma->mbma_paddr == -1)
120		return 0;
121
122	/* Make sure there is something there... */
123	if (bus_space_map(mbma->mbma_bustag, mbma->mbma_paddr, SCREG_BANK_SZ,
124	    0, &bh))
125		return 0;
126	matched =
127	    (bus_space_peek_2(mbma->mbma_bustag, bh, SCREG_ICR, NULL) == 0);
128	bus_space_unmap(mbma->mbma_bustag, bh, SCREG_BANK_SZ);
129	if (!matched)
130		return 0;
131
132	/* Default interrupt priority. */
133	if (mbma->mbma_pri == -1)
134		mbma->mbma_pri = 2;
135
136	return 1;
137}
138
139static void
140sunsc_mbmem_attach(device_t parent, device_t self, void *args)
141{
142	struct sunscpal_softc *sc = device_private(self);
143	struct cfdata *cf = device_cfdata(self);
144	struct mbmem_attach_args *mbma = args;
145	int i;
146
147	sc->sc_dev = self;
148
149	/* Map in the device. */
150	sc->sunscpal_regt = mbma->mbma_bustag;
151	sc->sunscpal_dmat = mbma->mbma_dmatag;
152	if (bus_space_map(mbma->mbma_bustag, mbma->mbma_paddr, SCREG_BANK_SZ,
153	    0, &sc->sunscpal_regh))
154		panic("%s: can't map", __func__);
155
156	/* Device register offsets. */
157	sc->sunscpal_data = SCREG_DATA;
158	sc->sunscpal_cmd_stat = SCREG_CMD_STAT;
159	sc->sunscpal_icr = SCREG_ICR;
160	sc->sunscpal_dma_addr_h = SCREG_DMA_ADDR_H;
161	sc->sunscpal_dma_addr_l = SCREG_DMA_ADDR_L;
162	sc->sunscpal_dma_count = SCREG_DMA_COUNT;
163	sc->sunscpal_intvec = SCREG_INTVEC;
164
165	/* Allocate DMA handles. */
166	i = SUNSCPAL_OPENINGS * sizeof(struct sunscpal_dma_handle);
167	sc->sc_dma_handles = kmem_zalloc(i, KM_SLEEP);
168	for (i = 0; i < SUNSCPAL_OPENINGS; i++)
169		if (bus_dmamap_create(sc->sunscpal_dmat, SUNSCPAL_MAX_DMA_LEN,
170		    1, SUNSCPAL_MAX_DMA_LEN,
171		    0, BUS_DMA_WAITOK, &sc->sc_dma_handles[i].dh_dmamap) != 0)
172			panic("sc: DMA map create failed");
173
174	/* Miscellaneous. */
175	sc->sc_min_dma_len = MIN_DMA_LEN;
176	sc->sc_rev = SUNSCPAL_VARIANT_501_1006;
177
178	/* Attach interrupt handler. */
179	bus_intr_establish(mbma->mbma_bustag, mbma->mbma_pri, IPL_BIO, 0,
180	    sunsc_mbmem_intr, sc);
181
182	/* Do the common attach stuff. */
183	sunscpal_attach(sc, cf->cf_flags ? cf->cf_flags : sunsc_mbmem_options);
184}
185
186static int
187sunsc_mbmem_intr(void *arg)
188{
189	struct sunscpal_softc *sc = arg;
190	int claimed;
191
192	claimed = sunscpal_intr(sc);
193#ifdef	DEBUG
194	if (claimed == 0) {
195		printf("%s: spurious from SBC\n", __func__);
196	}
197#endif
198	/* Yes, we DID cause this interrupt. */
199	claimed = 1;
200
201	return claimed;
202}
203