1 /* $NetBSD: rapide.c,v 1.23 2005/12/11 12:16:05 christos 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 * Card driver and probe and attach functions to use generic IDE driver 34 * for the RapIDE podule 35 */ 36 37 /* 38 * Thanks to Chris Honey at Raymond Datalink for providing information on 39 * addressing the RapIDE podule. 40 * RapIDE32 is Copyright (C) 1995,1996 Raymond Datalink. RapIDE32 is 41 * manufactured under license by Yellowstone Educational Solutions. 42 */ 43 44 /* 45 * At present this driver only supports the Issue 2 RapIDE podule. 46 */ 47 48 /* 49 * A small amount of work is required for Issue 1 podule support. 50 * The primary differences are the register addresses. 51 * Things are eased by the fact that we can identify the card by register 52 * the same register on both issues of the podule. 53 * Once we kmnow the issue we must change all our addresses accordingly. 54 * All the control registers are mapped the same between cards. 55 * The interrupt handler needs to take note that the issue 1 card needs 56 * the interrupt to be cleared via the interrupt clear register. 57 * This means we share addresses for the mapping of the control block and 58 * thus the card driver does not need to know about the differences. 59 * The differences show up a the controller level. 60 * A structure is used to hold the information about the addressing etc. 61 * An array of these structures holds the information for the primary and 62 * secondary connectors. This needs to be extended to hold this information 63 * for both issues. Then the indexing of these structures will use the 64 * card version number. 65 * 66 * Opps just noticed a mistake. The interrupt request register is different 67 * between cards so the card level attach routine will need to consider this. 68 */ 69 70 #include <sys/cdefs.h> 71 __KERNEL_RCSID(0, "$NetBSD: rapide.c,v 1.23 2005/12/11 12:16:05 christos Exp $"); 72 73 #include <sys/param.h> 74 #include <sys/systm.h> 75 #include <sys/conf.h> 76 #include <sys/device.h> 77 #include <sys/malloc.h> 78 79 #include <machine/intr.h> 80 #include <machine/io.h> 81 #include <machine/bus.h> 82 #include <machine/bootconfig.h> 83 #include <arm/iomd/iomdreg.h> 84 #include <arm/iomd/iomdvar.h> 85 #include <acorn32/podulebus/podulebus.h> 86 #include <acorn32/podulebus/rapidereg.h> 87 88 #include <dev/ata/atavar.h> 89 #include <dev/ic/wdcreg.h> 90 #include <dev/ic/wdcvar.h> 91 #include <dev/podulebus/podules.h> 92 93 94 /* 95 * RapIDE podule device. 96 * 97 * This probes and attaches the top level RapIDE device to the podulebus. 98 * It then configures any children of the RapIDE device. 99 * The attach args specify whether it is configuring the primary or 100 * secondary channel. 101 * The children are expected to be wdc devices using rapide attachments. 102 */ 103 104 /* 105 * RapIDE card softc structure. 106 * 107 * Contains the device node, podule information and global information 108 * required by the driver such as the card version and the interrupt mask. 109 */ 110 111 struct rapide_softc { 112 struct wdc_softc sc_wdcdev; /* common wdc definitions */ 113 struct ata_channel *sc_chanarray[2]; /* channels definition */ 114 podule_t *sc_podule; /* Our podule info */ 115 int sc_podule_number; /* Our podule number */ 116 int sc_intr_enable_mask; /* Global intr mask */ 117 int sc_version; /* Card version */ 118 bus_space_tag_t sc_ctliot; /* Bus tag */ 119 bus_space_handle_t sc_ctlioh; /* control handler */ 120 struct rapide_channel { 121 struct ata_channel rc_channel; /* generic part */ 122 struct ata_queue rc_chqueue; /* channel queue */ 123 irqhandler_t rc_ih; /* interrupt handler */ 124 int rc_irqmask; /* IRQ mask for this channel */ 125 } rapide_channels[2]; 126 struct wdc_regs sc_wdc_regs[2]; 127 }; 128 129 int rapide_probe __P((struct device *, struct cfdata *, void *)); 130 void rapide_attach __P((struct device *, struct device *, void *)); 131 void rapide_shutdown __P((void *arg)); 132 int rapide_intr __P((void *)); 133 134 CFATTACH_DECL(rapide, sizeof(struct rapide_softc), 135 rapide_probe, rapide_attach, NULL, NULL); 136 137 /* 138 * We have a private bus space tag. 139 * This is created by copying the podulebus tag and then replacing 140 * a couple of the transfer functions. 141 */ 142 143 static struct bus_space rapide_bs_tag; 144 145 bs_rm_4_proto(rapide); 146 bs_wm_4_proto(rapide); 147 148 /* 149 * Create an array of address structures. These define the addresses and 150 * masks needed for the different channels for the card. 151 * 152 * XXX - Needs some work for issue 1 cards. 153 */ 154 155 struct { 156 u_int registers; 157 u_int aux_register; 158 u_int data_register; 159 u_int irq_mask; 160 } rapide_info[] = { 161 { PRIMARY_DRIVE_REGISTERS_OFFSET, PRIMARY_AUX_REGISTER_OFFSET, 162 PRIMARY_DATA_REGISTER_OFFSET, PRIMARY_IRQ_MASK }, 163 { SECONDARY_DRIVE_REGISTERS_OFFSET, SECONDARY_AUX_REGISTER_OFFSET, 164 SECONDARY_DATA_REGISTER_OFFSET, SECONDARY_IRQ_MASK } 165 }; 166 167 168 /* 169 * Card probe function 170 * 171 * Just match the manufacturer and podule ID's 172 */ 173 174 int 175 rapide_probe(parent, cf, aux) 176 struct device *parent; 177 struct cfdata *cf; 178 void *aux; 179 { 180 struct podule_attach_args *pa = (void *)aux; 181 182 return (pa->pa_product == PODULE_RAPIDE); 183 } 184 185 /* 186 * Card attach function 187 * 188 * Identify the card version and configure any children. 189 * Install a shutdown handler to kill interrupts on shutdown 190 */ 191 192 void 193 rapide_attach(parent, self, aux) 194 struct device *parent, *self; 195 void *aux; 196 { 197 struct rapide_softc *sc = (void *)self; 198 struct podule_attach_args *pa = (void *)aux; 199 bus_space_tag_t iot; 200 bus_space_handle_t ctlioh; 201 u_int iobase; 202 int channel, i; 203 struct rapide_channel *rcp; 204 struct ata_channel *cp; 205 struct wdc_regs *wdr; 206 irqhandler_t *ihp; 207 208 /* Note the podule number and validate */ 209 if (pa->pa_podule_number == -1) 210 panic("Podule has disappeared !"); 211 212 sc->sc_podule_number = pa->pa_podule_number; 213 sc->sc_podule = pa->pa_podule; 214 podules[sc->sc_podule_number].attached = 1; 215 216 sc->sc_wdcdev.regs = sc->sc_wdc_regs; 217 218 set_easi_cycle_type(sc->sc_podule_number, EASI_CYCLE_TYPE_C); 219 220 /* 221 * Duplicate the podule bus space tag and provide alternative 222 * bus_space_read_multi_4() and bus_space_write_multi_4() 223 * functions. 224 */ 225 rapide_bs_tag = *pa->pa_iot; 226 rapide_bs_tag.bs_rm_4 = rapide_bs_rm_4; 227 rapide_bs_tag.bs_wm_4 = rapide_bs_wm_4; 228 sc->sc_ctliot = iot = &rapide_bs_tag; 229 230 if (bus_space_map(iot, pa->pa_podule->easi_base + 231 CONTROL_REGISTERS_OFFSET, CONTROL_REGISTER_SPACE, 0, &ctlioh)) 232 panic("%s: Cannot map control registers", self->dv_xname); 233 234 sc->sc_ctlioh = ctlioh; 235 sc->sc_version = bus_space_read_1(iot, ctlioh, VERSION_REGISTER_OFFSET) & VERSION_REGISTER_MASK; 236 /* bus_space_unmap(iot, ctl_ioh, CONTROL_REGISTER_SPACE);*/ 237 238 printf(": Issue %d\n", sc->sc_version + 1); 239 if (sc->sc_version != VERSION_2_ID) 240 return; 241 242 if (shutdownhook_establish(rapide_shutdown, (void *)sc) == NULL) 243 panic("%s: Cannot install shutdown handler", self->dv_xname); 244 245 /* Set the interrupt info for this podule */ 246 sc->sc_podule->irq_addr = pa->pa_podule->easi_base 247 + CONTROL_REGISTERS_OFFSET + IRQ_REQUEST_REGISTER_BYTE_OFFSET; 248 sc->sc_podule->irq_mask = IRQ_MASK; 249 250 iobase = pa->pa_podule->easi_base; 251 252 /* Fill in wdc and channel infos */ 253 sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA32; 254 sc->sc_wdcdev.sc_atac.atac_pio_cap = 0; 255 sc->sc_wdcdev.sc_atac.atac_channels = sc->sc_chanarray; 256 sc->sc_wdcdev.sc_atac.atac_nchannels = 2; 257 for (channel = 0 ; channel < 2; channel++) { 258 rcp = &sc->rapide_channels[channel]; 259 sc->sc_chanarray[channel] = &rcp->rc_channel; 260 cp = &rcp->rc_channel; 261 wdr = &sc->sc_wdc_regs[channel]; 262 263 cp->ch_channel = channel; 264 cp->ch_atac = &sc->sc_wdcdev.sc_atac; 265 cp->ch_queue = &rcp->rc_chqueue; 266 wdr->cmd_iot = iot; 267 wdr->ctl_iot = iot; 268 wdr->data32iot = iot; 269 270 if (bus_space_map(iot, iobase + rapide_info[channel].registers, 271 DRIVE_REGISTERS_SPACE, 0, &wdr->cmd_baseioh)) 272 continue; 273 for (i = 0; i < DRIVE_REGISTERS_SPACE; i++) { 274 if (bus_space_subregion(wdr->cmd_iot, wdr->cmd_baseioh, 275 i, i == 0 ? 4 : 1, &wdr->cmd_iohs[i]) != 0) { 276 bus_space_unmap(iot, wdr->cmd_baseioh, 277 DRIVE_REGISTERS_SPACE); 278 continue; 279 } 280 } 281 wdc_init_shadow_regs(cp); 282 if (bus_space_map(iot, iobase + 283 rapide_info[channel].aux_register, 4, 0, &wdr->ctl_ioh)) { 284 bus_space_unmap(iot, wdr->cmd_baseioh, 285 DRIVE_REGISTERS_SPACE); 286 continue; 287 } 288 if (bus_space_map(iot, iobase + 289 rapide_info[channel].data_register, 4, 0, &wdr->data32ioh)) { 290 bus_space_unmap(iot, wdr->cmd_baseioh, 291 DRIVE_REGISTERS_SPACE); 292 bus_space_unmap(iot, wdr->ctl_ioh, 4); 293 continue; 294 } 295 /* Disable interrupts and clear any pending interrupts */ 296 rcp->rc_irqmask = rapide_info[channel].irq_mask; 297 sc->sc_intr_enable_mask &= ~rcp->rc_irqmask; 298 bus_space_write_1(iot, sc->sc_ctlioh, IRQ_MASK_REGISTER_OFFSET, 299 sc->sc_intr_enable_mask); 300 /* XXX - Issue 1 cards will need to clear any pending interrupts */ 301 ihp = &rcp->rc_ih; 302 ihp->ih_func = rapide_intr; 303 ihp->ih_arg = rcp; 304 ihp->ih_level = IPL_BIO; 305 ihp->ih_name = "rapide"; 306 ihp->ih_maskaddr = pa->pa_podule->irq_addr; 307 ihp->ih_maskbits = rcp->rc_irqmask; 308 if (irq_claim(sc->sc_podule->interrupt, ihp)) 309 panic("%s: Cannot claim interrupt %d", 310 self->dv_xname, sc->sc_podule->interrupt); 311 /* clear any pending interrupts and enable interrupts */ 312 sc->sc_intr_enable_mask |= rcp->rc_irqmask; 313 bus_space_write_1(iot, sc->sc_ctlioh, 314 IRQ_MASK_REGISTER_OFFSET, sc->sc_intr_enable_mask); 315 /* XXX - Issue 1 cards will need to clear any pending interrupts */ 316 wdcattach(cp); 317 } 318 } 319 320 /* 321 * Card shutdown function 322 * 323 * Called via do_shutdown_hooks() during kernel shutdown. 324 * Clear the cards's interrupt mask to stop any podule interrupts. 325 */ 326 327 void 328 rapide_shutdown(arg) 329 void *arg; 330 { 331 struct rapide_softc *sc = arg; 332 333 /* Disable card interrupts */ 334 bus_space_write_1(sc->sc_ctliot, sc->sc_ctlioh, 335 IRQ_MASK_REGISTER_OFFSET, 0); 336 } 337 338 /* 339 * Podule interrupt handler 340 * 341 * If the interrupt was from our card pass it on to the wdc interrupt handler 342 */ 343 344 int 345 rapide_intr(arg) 346 void *arg; 347 { 348 struct rapide_channel *rcp = arg; 349 irqhandler_t *ihp = &rcp->rc_ih; 350 volatile u_char *intraddr = (volatile u_char *)ihp->ih_maskaddr; 351 352 /* XXX - Issue 1 cards will need to clear the interrupt */ 353 354 /* XXX - not bus space yet - should really be handled by podulebus */ 355 if ((*intraddr) & ihp->ih_maskbits) 356 wdcintr(&rcp->rc_channel); 357 358 return(0); 359 } 360