1 /* $NetBSD: icside.c,v 1.36 2023/12/20 06:13:59 thorpej Exp $ */
2
3 /*
4 * Copyright (c) 1997-1998 Mark Brinicombe
5 * Copyright (c) 1997-1998 Causality Limited
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Mark Brinicombe
18 * for the NetBSD Project.
19 * 4. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *
33 * Probe and attach functions to use generic IDE driver for the ICS IDE podule
34 */
35
36 /*
37 * Thanks to David Baildon for loaning an IDE card for the development
38 * of this driver.
39 * Thanks to Ian Copestake and David Baildon for providing register mapping
40 * information
41 */
42
43 #include <sys/param.h>
44
45 __KERNEL_RCSID(0, "$NetBSD: icside.c,v 1.36 2023/12/20 06:13:59 thorpej Exp $");
46
47 #include <sys/systm.h>
48 #include <sys/conf.h>
49 #include <sys/device.h>
50 #include <sys/bus.h>
51
52 #include <machine/intr.h>
53 #include <machine/io.h>
54 #include <acorn32/podulebus/podulebus.h>
55 #include <acorn32/podulebus/icsidereg.h>
56
57 #include <dev/ata/atavar.h>
58 #include <dev/ic/wdcreg.h>
59 #include <dev/ic/wdcvar.h>
60 #include <dev/podulebus/podules.h>
61
62 /*
63 * ICS IDE podule device.
64 *
65 * This probes and attaches the top level ICS IDE device to the podulebus.
66 * It then configures any children of the ICS IDE device.
67 * The child is expected to be a wdc device using icside attachments.
68 */
69
70 /*
71 * ICS IDE card softc structure.
72 *
73 * Contains the device node and podule information.
74 */
75
76 struct icside_softc {
77 struct wdc_softc sc_wdcdev; /* common wdc definitions */
78 podule_t *sc_podule; /* Our podule */
79 int sc_podule_number; /* Our podule number */
80 struct bus_space sc_tag; /* custom tag */
81 struct podule_attach_args *sc_pa; /* podule info */
82 bus_space_tag_t sc_latchiot; /* EEPROM page latch etc */
83 bus_space_handle_t sc_latchioh;
84 void *sc_shutdownhook;
85 struct ata_channel *sc_chp[ICSIDE_MAX_CHANNELS];
86 struct icside_channel {
87 struct ata_channel ic_channel; /* generic part */
88 void *ic_ih; /* interrupt handler */
89 struct evcnt ic_intrcnt; /* interrupt count */
90 u_int ic_irqaddr; /* interrupt flag */
91 u_int ic_irqmask; /* location */
92 bus_space_tag_t ic_irqiot; /* Bus space tag */
93 bus_space_handle_t ic_irqioh; /* handle for IRQ */
94 } sc_chan[ICSIDE_MAX_CHANNELS];
95 struct wdc_regs sc_wdc_regs[ICSIDE_MAX_CHANNELS];
96 };
97
98 int icside_probe(device_t, cfdata_t, void *);
99 void icside_attach(device_t, device_t, void *);
100 int icside_intr(void *);
101 void icside_v6_shutdown(void *);
102
103 CFATTACH_DECL_NEW(icside, sizeof(struct icside_softc),
104 icside_probe, icside_attach, NULL, NULL);
105
106 /*
107 * Define prototypes for custom bus space functions.
108 */
109
110 bs_rm_2_proto(icside);
111 bs_wm_2_proto(icside);
112
113 #define MAX_CHANNELS 2
114
115 /*
116 * Define a structure for describing the different card versions
117 */
118 struct ide_version {
119 int id; /* IDE card ID */
120 int modspace; /* Type of podule space */
121 int channels; /* Number of channels */
122 const char *name; /* name */
123 int latchreg; /* EEPROM latch register */
124 int ideregs[MAX_CHANNELS]; /* IDE registers */
125 int auxregs[MAX_CHANNELS]; /* AUXSTAT register */
126 int irqregs[MAX_CHANNELS]; /* IRQ register */
127 int irqstatregs[MAX_CHANNELS];
128 } const ide_versions[] = {
129 /* A3IN - Unsupported */
130 /* { 0, 0, 0, NULL, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 } },*/
131 /* A3USER - Unsupported */
132 /* { 1, 0, 0, NULL, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 } },*/
133 /* ARCIN V6 - Supported */
134 { 3, 0, 2, "ARCIN V6", V6_ADDRLATCH,
135 { V6_P_IDE_BASE, V6_S_IDE_BASE },
136 { V6_P_AUX_BASE, V6_S_AUX_BASE },
137 { V6_P_IRQ_BASE, V6_S_IRQ_BASE },
138 { V6_P_IRQSTAT_BASE, V6_S_IRQSTAT_BASE }
139 },
140 /* ARCIN V5 - Supported (ID reg not supported so reads as 15) */
141 { 15, 1, 1, "ARCIN V5", -1,
142 { V5_IDE_BASE, -1 },
143 { V5_AUX_BASE, -1 },
144 { V5_IRQ_BASE, -1 },
145 { V5_IRQSTAT_BASE, -1 }
146 }
147 };
148
149 /*
150 * Card probe function
151 *
152 * Just match the manufacturer and podule ID's
153 */
154
155 int
icside_probe(device_t parent,cfdata_t cf,void * aux)156 icside_probe(device_t parent, cfdata_t cf, void *aux)
157 {
158 struct podule_attach_args *pa = (void *)aux;
159
160 return (pa->pa_product == PODULE_ICS_IDE);
161 }
162
163 /*
164 * Card attach function
165 *
166 * Identify the card version and configure any children.
167 */
168
169 void
icside_attach(device_t parent,device_t self,void * aux)170 icside_attach(device_t parent, device_t self, void *aux)
171 {
172 struct icside_softc *sc = device_private(self);
173 struct podule_attach_args *pa = (void *)aux;
174 bus_space_tag_t iot;
175 bus_space_handle_t ioh;
176 const struct ide_version *ide = NULL;
177 u_int iobase;
178 int channel, i;
179 struct icside_channel *icp;
180 struct ata_channel *cp;
181 struct wdc_regs *wdr;
182 int loop;
183 int id;
184
185 /* Note the podule number and validate */
186
187 if (pa->pa_podule_number == -1)
188 panic("Podule has disappeared !");
189
190 sc->sc_wdcdev.sc_atac.atac_dev = self;
191 sc->sc_podule_number = pa->pa_podule_number;
192 sc->sc_podule = pa->pa_podule;
193 podules[sc->sc_podule_number].attached = 1;
194
195 sc->sc_wdcdev.regs = sc->sc_wdc_regs;
196
197 /* The ID register if present is always in FAST podule space */
198 iot = pa->pa_iot;
199 if (bus_space_map(iot, pa->pa_podule->fast_base +
200 ID_REGISTER_OFFSET, ID_REGISTER_SPACE, 0, &ioh)) {
201 aprint_error_dev(self, "cannot map ID register\n");
202 return;
203 }
204
205 for (id = 0, loop = 0; loop < 4; ++loop)
206 id |= (bus_space_read_1(iot, ioh, loop) & 1) << loop;
207
208 /* Do we recognise the ID ? */
209 for (loop = 0; loop < sizeof(ide_versions) / sizeof(struct ide_version);
210 ++loop) {
211 if (ide_versions[loop].id == id) {
212 ide = &ide_versions[loop];
213 break;
214 }
215 }
216
217 /* Report the version and name */
218 if (ide == NULL || ide->name == NULL) {
219 aprint_error(": rev %d is unsupported\n", id);
220 return;
221 } else
222 aprint_normal(": %s\n", ide->name);
223
224 if (ide->latchreg != -1) {
225 sc->sc_latchiot = pa->pa_iot;
226 if (bus_space_map(iot, pa->pa_podule->fast_base +
227 ide->latchreg, 1, 0, &sc->sc_latchioh)) {
228 aprint_error_dev(self,
229 "cannot map latch register\n");
230 return;
231 }
232 sc->sc_shutdownhook =
233 shutdownhook_establish(icside_v6_shutdown, sc);
234 }
235
236 /*
237 * Ok we need our own bus tag as the register spacing
238 * is not the default.
239 *
240 * For the podulebus the bus tag cookie is the shift
241 * to apply to registers
242 * So duplicate the bus space tag and change the
243 * cookie.
244 *
245 * Also while we are at it replace the default
246 * read/write multiple short functions with
247 * optimised versions
248 */
249
250 sc->sc_tag = *pa->pa_iot;
251 sc->sc_tag.bs_cookie = (void *) REGISTER_SPACING_SHIFT;
252 sc->sc_tag.bs_rm_2 = icside_bs_rm_2;
253 sc->sc_tag.bs_wm_2 = icside_bs_wm_2;
254
255 /* Initialize wdc struct */
256 sc->sc_wdcdev.sc_atac.atac_channels = sc->sc_chp;
257 sc->sc_wdcdev.sc_atac.atac_nchannels = ide->channels;
258 sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA16;
259 sc->sc_wdcdev.sc_atac.atac_pio_cap = 0;
260 sc->sc_wdcdev.wdc_maxdrives = 2;
261 sc->sc_pa = pa;
262
263 for (channel = 0; channel < ide->channels; ++channel) {
264 icp = &sc->sc_chan[channel];
265 sc->sc_wdcdev.sc_atac.atac_channels[channel] = &icp->ic_channel;
266 cp = &icp->ic_channel;
267 wdr = &sc->sc_wdc_regs[channel];
268
269 cp->ch_channel = channel;
270 cp->ch_atac = &sc->sc_wdcdev.sc_atac;
271 wdr->cmd_iot = &sc->sc_tag;
272 wdr->ctl_iot = &sc->sc_tag;
273 if (ide->modspace)
274 iobase = pa->pa_podule->mod_base;
275 else
276 iobase = pa->pa_podule->fast_base;
277
278 if (bus_space_map(iot, iobase + ide->ideregs[channel],
279 IDE_REGISTER_SPACE, 0, &wdr->cmd_baseioh))
280 return;
281 for (i = 0; i < WDC_NREG; i++) {
282 if (bus_space_subregion(wdr->cmd_iot, wdr->cmd_baseioh,
283 i, i == 0 ? 4 : 1, &wdr->cmd_iohs[i]) != 0)
284 return;
285 }
286 wdc_init_shadow_regs(wdr);
287 if (bus_space_map(iot, iobase + ide->auxregs[channel],
288 AUX_REGISTER_SPACE, 0, &wdr->ctl_ioh))
289 return;
290 icp->ic_irqiot = iot;
291 if (bus_space_map(iot, iobase + ide->irqregs[channel],
292 IRQ_REGISTER_SPACE, 0, &icp->ic_irqioh))
293 return;
294 /* Disable interrupts */
295 (void)bus_space_read_1(iot, icp->ic_irqioh, 0);
296 pa->pa_podule->irq_addr = iobase + ide->irqstatregs[channel];
297 pa->pa_podule->irq_mask = IRQ_STATUS_REGISTER_MASK;
298 icp->ic_irqaddr = pa->pa_podule->irq_addr;
299 icp->ic_irqmask = pa->pa_podule->irq_mask;
300 evcnt_attach_dynamic(&icp->ic_intrcnt, EVCNT_TYPE_INTR, NULL,
301 device_xname(self), "intr");
302 icp->ic_ih = podulebus_irq_establish(pa->pa_ih, IPL_BIO,
303 icside_intr, icp, &icp->ic_intrcnt);
304 if (icp->ic_ih == NULL) {
305 aprint_error_dev(self, "Cannot claim interrupt %d\n",
306 pa->pa_podule->interrupt);
307 continue;
308 }
309 /* Enable interrupts */
310 bus_space_write_1(iot, icp->ic_irqioh, 0, 0);
311 /* Call common attach routines */
312 wdcattach(cp);
313
314 }
315 }
316
317 /*
318 * Shutdown handler -- try to restore the card to a state where
319 * RISC OS will see it.
320 */
321 void
icside_v6_shutdown(void * arg)322 icside_v6_shutdown(void *arg)
323 {
324 struct icside_softc *sc = arg;
325
326 bus_space_write_1(sc->sc_latchiot, sc->sc_latchioh, 0, 0);
327 }
328
329 /*
330 * Podule interrupt handler
331 *
332 * If the interrupt was from our card pass it on to the wdc interrupt handler
333 */
334 int
icside_intr(void * arg)335 icside_intr(void *arg)
336 {
337 struct icside_channel *icp = arg;
338 volatile u_char *intraddr = (volatile u_char *)icp->ic_irqaddr;
339
340 /* XXX - not bus space yet - should really be handled by podulebus */
341 if ((*intraddr) & icp->ic_irqmask)
342 wdcintr(&icp->ic_channel);
343 return(0);
344 }
345