1*166f9fdfSbjh21 /* $NetBSD: icside.c,v 1.5 2002/09/15 11:00:11 bjh21 Exp $ */ 27d4a1addSreinoud 37d4a1addSreinoud /* 47d4a1addSreinoud * Copyright (c) 1997-1998 Mark Brinicombe 57d4a1addSreinoud * Copyright (c) 1997-1998 Causality Limited 67d4a1addSreinoud * 77d4a1addSreinoud * Redistribution and use in source and binary forms, with or without 87d4a1addSreinoud * modification, are permitted provided that the following conditions 97d4a1addSreinoud * are met: 107d4a1addSreinoud * 1. Redistributions of source code must retain the above copyright 117d4a1addSreinoud * notice, this list of conditions and the following disclaimer. 127d4a1addSreinoud * 2. Redistributions in binary form must reproduce the above copyright 137d4a1addSreinoud * notice, this list of conditions and the following disclaimer in the 147d4a1addSreinoud * documentation and/or other materials provided with the distribution. 157d4a1addSreinoud * 3. All advertising materials mentioning features or use of this software 167d4a1addSreinoud * must display the following acknowledgement: 177d4a1addSreinoud * This product includes software developed by Mark Brinicombe 187d4a1addSreinoud * for the NetBSD Project. 197d4a1addSreinoud * 4. The name of the author may not be used to endorse or promote products 207d4a1addSreinoud * derived from this software without specific prior written permission. 217d4a1addSreinoud * 227d4a1addSreinoud * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 237d4a1addSreinoud * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 247d4a1addSreinoud * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 257d4a1addSreinoud * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 267d4a1addSreinoud * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 277d4a1addSreinoud * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 287d4a1addSreinoud * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 297d4a1addSreinoud * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 307d4a1addSreinoud * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 317d4a1addSreinoud * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 327d4a1addSreinoud * 337d4a1addSreinoud * Probe and attach functions to use generic IDE driver for the ICS IDE podule 347d4a1addSreinoud */ 357d4a1addSreinoud 367d4a1addSreinoud /* 377d4a1addSreinoud * Thanks to David Baildon for loaning an IDE card for the development 387d4a1addSreinoud * of this driver. 397d4a1addSreinoud * Thanks to Ian Copestake and David Baildon for providing register mapping 407d4a1addSreinoud * information 417d4a1addSreinoud */ 427d4a1addSreinoud 439da7134dSbjh21 /* 449da7134dSbjh21 * BUGS: 459da7134dSbjh21 * Cold boot (hard reset or power-on) booting straight to NetBSD: 469da7134dSbjh21 * panic: wdcstart: channel waiting for irq 479da7134dSbjh21 * Booting via desktop avoinds this. 489da7134dSbjh21 */ 499da7134dSbjh21 507d4a1addSreinoud #include <sys/param.h> 517d4a1addSreinoud #include <sys/systm.h> 527d4a1addSreinoud #include <sys/conf.h> 537d4a1addSreinoud #include <sys/device.h> 547d4a1addSreinoud #include <sys/malloc.h> 557d4a1addSreinoud 56ce1401feSthorpej #include <machine/intr.h> 577d4a1addSreinoud #include <machine/io.h> 587d4a1addSreinoud #include <machine/bus.h> 597d4a1addSreinoud #include <acorn32/podulebus/podulebus.h> 607d4a1addSreinoud #include <acorn32/podulebus/icsidereg.h> 617d4a1addSreinoud 627d4a1addSreinoud #include <dev/ata/atavar.h> 637d4a1addSreinoud #include <dev/ic/wdcvar.h> 647d4a1addSreinoud #include <dev/podulebus/podules.h> 657d4a1addSreinoud 667d4a1addSreinoud /* 677d4a1addSreinoud * ICS IDE podule device. 687d4a1addSreinoud * 697d4a1addSreinoud * This probes and attaches the top level ICS IDE device to the podulebus. 707d4a1addSreinoud * It then configures any children of the ICS IDE device. 717d4a1addSreinoud * The child is expected to be a wdc device using icside attachments. 727d4a1addSreinoud */ 737d4a1addSreinoud 747d4a1addSreinoud /* 757d4a1addSreinoud * ICS IDE card softc structure. 767d4a1addSreinoud * 777d4a1addSreinoud * Contains the device node and podule information. 787d4a1addSreinoud */ 797d4a1addSreinoud 807d4a1addSreinoud struct icside_softc { 817d4a1addSreinoud struct wdc_softc sc_wdcdev; /* common wdc definitions */ 827d4a1addSreinoud podule_t *sc_podule; /* Our podule */ 837d4a1addSreinoud int sc_podule_number; /* Our podule number */ 847d4a1addSreinoud struct bus_space sc_tag; /* custom tag */ 857d4a1addSreinoud struct podule_attach_args *sc_pa; /* podule info */ 869da7134dSbjh21 bus_space_tag_t sc_latchiot; /* EEPROM page latch etc */ 879da7134dSbjh21 bus_space_handle_t sc_latchioh; 889da7134dSbjh21 void *sc_shutdownhook; 89*166f9fdfSbjh21 struct channel_softc *sc_chp[ICSIDE_MAX_CHANNELS]; 907d4a1addSreinoud struct icside_channel { 917d4a1addSreinoud struct channel_softc wdc_channel; /* generic part */ 927d4a1addSreinoud void *ic_ih; /* interrupt handler */ 937d4a1addSreinoud struct evcnt ic_intrcnt; /* interrupt count */ 947d4a1addSreinoud u_int ic_irqaddr; /* interrupt flag */ 957d4a1addSreinoud u_int ic_irqmask; /* location */ 967d4a1addSreinoud bus_space_tag_t ic_irqiot; /* Bus space tag */ 977d4a1addSreinoud bus_space_handle_t ic_irqioh; /* handle for IRQ */ 98*166f9fdfSbjh21 } sc_chan[ICSIDE_MAX_CHANNELS]; 997d4a1addSreinoud }; 1007d4a1addSreinoud 1017d4a1addSreinoud int icside_probe __P((struct device *, struct cfdata *, void *)); 1027d4a1addSreinoud void icside_attach __P((struct device *, struct device *, void *)); 1037d4a1addSreinoud int icside_intr __P((void *)); 1049da7134dSbjh21 void icside_v6_shutdown(void *); 1057d4a1addSreinoud 1067d4a1addSreinoud struct cfattach icside_ca = { 1077d4a1addSreinoud sizeof(struct icside_softc), icside_probe, icside_attach 1087d4a1addSreinoud }; 1097d4a1addSreinoud 1107d4a1addSreinoud /* 1117d4a1addSreinoud * Define prototypes for custom bus space functions. 1127d4a1addSreinoud */ 1137d4a1addSreinoud 1147d4a1addSreinoud bs_rm_2_proto(icside); 1157d4a1addSreinoud bs_wm_2_proto(icside); 1167d4a1addSreinoud 1177d4a1addSreinoud #define MAX_CHANNELS 2 1187d4a1addSreinoud 1197d4a1addSreinoud /* 1207d4a1addSreinoud * Define a structure for describing the different card versions 1217d4a1addSreinoud */ 1227d4a1addSreinoud struct ide_version { 1237d4a1addSreinoud int id; /* IDE card ID */ 1247d4a1addSreinoud int modspace; /* Type of podule space */ 1257d4a1addSreinoud int channels; /* Number of channels */ 1267d4a1addSreinoud const char *name; /* name */ 1279da7134dSbjh21 int latchreg; /* EEPROM latch register */ 1287d4a1addSreinoud int ideregs[MAX_CHANNELS]; /* IDE registers */ 1297d4a1addSreinoud int auxregs[MAX_CHANNELS]; /* AUXSTAT register */ 1307d4a1addSreinoud int irqregs[MAX_CHANNELS]; /* IRQ register */ 1317d4a1addSreinoud int irqstatregs[MAX_CHANNELS]; 1327d4a1addSreinoud } ide_versions[] = { 1337d4a1addSreinoud /* A3IN - Unsupported */ 1347d4a1addSreinoud /* { 0, 0, 0, NULL, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 } },*/ 1357d4a1addSreinoud /* A3USER - Unsupported */ 1367d4a1addSreinoud /* { 1, 0, 0, NULL, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 } },*/ 1377d4a1addSreinoud /* ARCIN V6 - Supported */ 1389da7134dSbjh21 { 3, 0, 2, "ARCIN V6", V6_ADDRLATCH, 1397d4a1addSreinoud { V6_P_IDE_BASE, V6_S_IDE_BASE }, 1407d4a1addSreinoud { V6_P_AUX_BASE, V6_S_AUX_BASE }, 1417d4a1addSreinoud { V6_P_IRQ_BASE, V6_S_IRQ_BASE }, 1427d4a1addSreinoud { V6_P_IRQSTAT_BASE, V6_S_IRQSTAT_BASE } 1437d4a1addSreinoud }, 1447d4a1addSreinoud /* ARCIN V5 - Supported (ID reg not supported so reads as 15) */ 1459da7134dSbjh21 { 15, 1, 1, "ARCIN V5", -1, 1469da7134dSbjh21 { V5_IDE_BASE, -1 }, 1479da7134dSbjh21 { V5_AUX_BASE, -1 }, 1489da7134dSbjh21 { V5_IRQ_BASE, -1 }, 1499da7134dSbjh21 { V5_IRQSTAT_BASE, -1 } 1507d4a1addSreinoud } 1517d4a1addSreinoud }; 1527d4a1addSreinoud 1537d4a1addSreinoud /* 1547d4a1addSreinoud * Card probe function 1557d4a1addSreinoud * 1567d4a1addSreinoud * Just match the manufacturer and podule ID's 1577d4a1addSreinoud */ 1587d4a1addSreinoud 1597d4a1addSreinoud int 1607d4a1addSreinoud icside_probe(parent, cf, aux) 1617d4a1addSreinoud struct device *parent; 1627d4a1addSreinoud struct cfdata *cf; 1637d4a1addSreinoud void *aux; 1647d4a1addSreinoud { 1657d4a1addSreinoud struct podule_attach_args *pa = (void *)aux; 16620518673Sbjh21 return (pa->pa_product == PODULE_ICS_IDE); 1677d4a1addSreinoud } 1687d4a1addSreinoud 1697d4a1addSreinoud /* 1707d4a1addSreinoud * Card attach function 1717d4a1addSreinoud * 1727d4a1addSreinoud * Identify the card version and configure any children. 1737d4a1addSreinoud */ 1747d4a1addSreinoud 1757d4a1addSreinoud void 1767d4a1addSreinoud icside_attach(parent, self, aux) 1777d4a1addSreinoud struct device *parent, *self; 1787d4a1addSreinoud void *aux; 1797d4a1addSreinoud { 1807d4a1addSreinoud struct icside_softc *sc = (void *)self; 1817d4a1addSreinoud struct podule_attach_args *pa = (void *)aux; 1827d4a1addSreinoud bus_space_tag_t iot; 1837d4a1addSreinoud bus_space_handle_t ioh; 1847d4a1addSreinoud struct ide_version *ide = NULL; 1857d4a1addSreinoud u_int iobase; 1867d4a1addSreinoud int channel; 1877d4a1addSreinoud struct icside_channel *icp; 1887d4a1addSreinoud struct channel_softc *cp; 1897d4a1addSreinoud int loop; 1907d4a1addSreinoud int id; 1917d4a1addSreinoud 1927d4a1addSreinoud /* Note the podule number and validate */ 1937d4a1addSreinoud 1947d4a1addSreinoud if (pa->pa_podule_number == -1) 1957d4a1addSreinoud panic("Podule has disappeared !"); 1967d4a1addSreinoud 1977d4a1addSreinoud sc->sc_podule_number = pa->pa_podule_number; 1987d4a1addSreinoud sc->sc_podule = pa->pa_podule; 1997d4a1addSreinoud podules[sc->sc_podule_number].attached = 1; 2007d4a1addSreinoud 2017d4a1addSreinoud /* The ID register if present is always in FAST podule space */ 2027d4a1addSreinoud iot = pa->pa_iot; 2037d4a1addSreinoud if (bus_space_map(iot, pa->pa_podule->fast_base + 2047d4a1addSreinoud ID_REGISTER_OFFSET, ID_REGISTER_SPACE, 0, &ioh)) { 2057d4a1addSreinoud printf("%s: cannot map ID register\n", self->dv_xname); 2067d4a1addSreinoud return; 2077d4a1addSreinoud } 2087d4a1addSreinoud 2097d4a1addSreinoud for (id = 0, loop = 0; loop < 4; ++loop) 2107d4a1addSreinoud id |= (bus_space_read_1(iot, ioh, loop) & 1) << loop; 2117d4a1addSreinoud 2127d4a1addSreinoud /* Do we recognise the ID ? */ 2137d4a1addSreinoud for (loop = 0; loop < sizeof(ide_versions) / sizeof(struct ide_version); 2147d4a1addSreinoud ++loop) { 2157d4a1addSreinoud if (ide_versions[loop].id == id) { 2167d4a1addSreinoud ide = &ide_versions[loop]; 2177d4a1addSreinoud break; 2187d4a1addSreinoud } 2197d4a1addSreinoud } 2207d4a1addSreinoud 2217d4a1addSreinoud /* Report the version and name */ 2227d4a1addSreinoud if (ide == NULL || ide->name == NULL) { 2237d4a1addSreinoud printf(": rev %d is unsupported\n", id); 2247d4a1addSreinoud return; 2257d4a1addSreinoud } else 2267d4a1addSreinoud printf(": %s\n", ide->name); 2277d4a1addSreinoud 2289da7134dSbjh21 if (ide->latchreg != -1) { 2299da7134dSbjh21 sc->sc_latchiot = pa->pa_iot; 2309da7134dSbjh21 if (bus_space_map(iot, pa->pa_podule->fast_base + 2319da7134dSbjh21 ide->latchreg, 1, 0, &sc->sc_latchioh)) { 2329da7134dSbjh21 printf("%s: cannot map latch register\n", 2339da7134dSbjh21 self->dv_xname); 2349da7134dSbjh21 return; 2359da7134dSbjh21 } 2369da7134dSbjh21 sc->sc_shutdownhook = 2379da7134dSbjh21 shutdownhook_establish(icside_v6_shutdown, sc); 2389da7134dSbjh21 } 2399da7134dSbjh21 2407d4a1addSreinoud /* 2417d4a1addSreinoud * Ok we need our own bus tag as the register spacing 2427d4a1addSreinoud * is not the default. 2437d4a1addSreinoud * 2447d4a1addSreinoud * For the podulebus the bus tag cookie is the shift 2457d4a1addSreinoud * to apply to registers 2467d4a1addSreinoud * So duplicate the bus space tag and change the 2477d4a1addSreinoud * cookie. 2487d4a1addSreinoud * 2497d4a1addSreinoud * Also while we are at it replace the default 2507d4a1addSreinoud * read/write mulitple short functions with 2517d4a1addSreinoud * optimised versions 2527d4a1addSreinoud */ 2537d4a1addSreinoud 2547d4a1addSreinoud sc->sc_tag = *pa->pa_iot; 2557d4a1addSreinoud sc->sc_tag.bs_cookie = (void *) REGISTER_SPACING_SHIFT; 2567d4a1addSreinoud sc->sc_tag.bs_rm_2 = icside_bs_rm_2; 2577d4a1addSreinoud sc->sc_tag.bs_wm_2 = icside_bs_wm_2; 2587d4a1addSreinoud 2597d4a1addSreinoud /* Initialize wdc struct */ 260*166f9fdfSbjh21 sc->sc_wdcdev.channels = sc->sc_chp; 2617d4a1addSreinoud sc->sc_wdcdev.nchannels = ide->channels; 2627d4a1addSreinoud sc->sc_wdcdev.cap |= WDC_CAPABILITY_DATA16; 2637d4a1addSreinoud sc->sc_wdcdev.PIO_cap = 0; 2647d4a1addSreinoud sc->sc_pa = pa; 2657d4a1addSreinoud 2667d4a1addSreinoud for (channel = 0; channel < ide->channels; ++channel) { 267*166f9fdfSbjh21 icp = &sc->sc_chan[channel]; 2687d4a1addSreinoud sc->sc_wdcdev.channels[channel] = &icp->wdc_channel; 2697d4a1addSreinoud cp = &icp->wdc_channel; 2707d4a1addSreinoud 2717d4a1addSreinoud cp->channel = channel; 2727d4a1addSreinoud cp->wdc = &sc->sc_wdcdev; 2737d4a1addSreinoud cp->ch_queue = malloc(sizeof(struct channel_queue), M_DEVBUF, 2747d4a1addSreinoud M_NOWAIT); 2757d4a1addSreinoud if (cp->ch_queue == NULL) { 276*166f9fdfSbjh21 printf("%s:%d: " 2777d4a1addSreinoud "can't allocate memory for command queue", 278*166f9fdfSbjh21 sc->sc_wdcdev.sc_dev.dv_xname, channel); 2797d4a1addSreinoud continue; 2807d4a1addSreinoud } 2817d4a1addSreinoud cp->cmd_iot = &sc->sc_tag; 2827d4a1addSreinoud cp->ctl_iot = &sc->sc_tag; 2837d4a1addSreinoud if (ide->modspace) 2847d4a1addSreinoud iobase = pa->pa_podule->mod_base; 2857d4a1addSreinoud else 2867d4a1addSreinoud iobase = pa->pa_podule->fast_base; 2877d4a1addSreinoud 2887d4a1addSreinoud if (bus_space_map(iot, iobase + ide->ideregs[channel], 2897d4a1addSreinoud IDE_REGISTER_SPACE, 0, &cp->cmd_ioh)) 2907d4a1addSreinoud return; 2917d4a1addSreinoud if (bus_space_map(iot, iobase + ide->auxregs[channel], 2927d4a1addSreinoud AUX_REGISTER_SPACE, 0, &cp->ctl_ioh)) 2937d4a1addSreinoud return; 2947d4a1addSreinoud icp->ic_irqiot = iot; 2957d4a1addSreinoud if (bus_space_map(iot, iobase + ide->irqregs[channel], 2967d4a1addSreinoud IRQ_REGISTER_SPACE, 0, &icp->ic_irqioh)) 2977d4a1addSreinoud return; 2987d4a1addSreinoud /* Disable interrupts */ 2997d4a1addSreinoud (void)bus_space_read_1(iot, icp->ic_irqioh, 0); 3007d4a1addSreinoud /* Call common attach routines */ 3017d4a1addSreinoud wdcattach(cp); 3027d4a1addSreinoud /* Disable interrupts */ 3037d4a1addSreinoud (void)bus_space_read_1(iot, icp->ic_irqioh, 0); 3047d4a1addSreinoud pa->pa_podule->irq_addr = iobase + ide->irqstatregs[channel]; 3057d4a1addSreinoud pa->pa_podule->irq_mask = IRQ_STATUS_REGISTER_MASK; 3067d4a1addSreinoud icp->ic_irqaddr = pa->pa_podule->irq_addr; 3077d4a1addSreinoud icp->ic_irqmask = pa->pa_podule->irq_mask; 3087d4a1addSreinoud evcnt_attach_dynamic(&icp->ic_intrcnt, EVCNT_TYPE_INTR, NULL, 3097d4a1addSreinoud self->dv_xname, "intr"); 3107d4a1addSreinoud icp->ic_ih = podulebus_irq_establish(pa->pa_ih, IPL_BIO, 3117d4a1addSreinoud icside_intr, icp, &icp->ic_intrcnt); 3127d4a1addSreinoud if (icp->ic_ih == NULL) { 3137d4a1addSreinoud printf("%s: Cannot claim interrupt %d\n", 3147d4a1addSreinoud sc->sc_wdcdev.sc_dev.dv_xname, 3157d4a1addSreinoud pa->pa_podule->interrupt); 3167d4a1addSreinoud continue; 3177d4a1addSreinoud } 3187d4a1addSreinoud /* Enable interrupts */ 3197d4a1addSreinoud bus_space_write_1(iot, icp->ic_irqioh, 0, 0); 3207d4a1addSreinoud } 3217d4a1addSreinoud } 3227d4a1addSreinoud 3237d4a1addSreinoud /* 3249da7134dSbjh21 * Shutdown handler -- try to restore the card to a state where 3259da7134dSbjh21 * RISC OS will see it. 3269da7134dSbjh21 */ 3279da7134dSbjh21 void 3289da7134dSbjh21 icside_v6_shutdown(void *arg) 3299da7134dSbjh21 { 3309da7134dSbjh21 struct icside_softc *sc = arg; 3319da7134dSbjh21 3329da7134dSbjh21 bus_space_write_1(sc->sc_latchiot, sc->sc_latchioh, 0, 0); 3339da7134dSbjh21 } 3349da7134dSbjh21 3359da7134dSbjh21 /* 3367d4a1addSreinoud * Podule interrupt handler 3377d4a1addSreinoud * 3387d4a1addSreinoud * If the interrupt was from our card pass it on to the wdc interrupt handler 3397d4a1addSreinoud */ 3407d4a1addSreinoud int 3417d4a1addSreinoud icside_intr(arg) 3427d4a1addSreinoud void *arg; 3437d4a1addSreinoud { 3447d4a1addSreinoud struct icside_channel *icp = arg; 3457d4a1addSreinoud volatile u_char *intraddr = (volatile u_char *)icp->ic_irqaddr; 3467d4a1addSreinoud 3477d4a1addSreinoud /* XXX - not bus space yet - should really be handled by podulebus */ 3487d4a1addSreinoud if ((*intraddr) & icp->ic_irqmask) 3497d4a1addSreinoud wdcintr(&icp->wdc_channel); 3507d4a1addSreinoud return(0); 3517d4a1addSreinoud } 352