sys/powerpc/psim/ata_iobus.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright 2002 by Peter Grehan. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  22  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 /*
  34  * PSIM local bus ATA controller
  35  */
  36 #include <sys/param.h>
  37 #include <sys/systm.h>
  38 #include <sys/kernel.h>
  39 #include <sys/module.h>
  40 #include <sys/bus.h>
  41 #include <sys/malloc.h>
  42 #include <sys/sema.h>
  43 #include <sys/taskqueue.h>
  44 #include <machine/stdarg.h>
  45 #include <vm/uma.h>
  46 #include <machine/resource.h>
  47 #include <machine/bus.h>
  48 #include <sys/rman.h>
  49 #include <sys/ata.h>
  50 #include <dev/ata/ata-all.h>
  51 #include <ata_if.h>
  52
  53 #include <dev/ofw/openfirm.h>
  54 #include <powerpc/psim/iobusvar.h>
  55
  56 /*
  57  * Define the iobus ata bus attachment. This creates a pseudo-bus that
  58  * the ATA device can be attached to
  59  */
  60 static  int  ata_iobus_attach(device_t dev);
  61 static  int  ata_iobus_probe(device_t dev);
  62 static  int  ata_iobus_print_child(device_t dev, device_t child);
  63 struct resource *ata_iobus_alloc_resource(device_t, device_t, int, int *,
  64                                           rman_res_t, rman_res_t, rman_res_t,
  65                                           u_int);
  66 static int ata_iobus_release_resource(device_t, device_t, int, int,
  67                                       struct resource *);
  68
  69 static device_method_t ata_iobus_methods[] = {
  70         /* Device interface */
  71         DEVMETHOD(device_probe,         ata_iobus_probe),
  72         DEVMETHOD(device_attach,        ata_iobus_attach),
  73         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  74         DEVMETHOD(device_suspend,       bus_generic_suspend),
  75         DEVMETHOD(device_resume,        bus_generic_resume),
  76
  77         /* Bus methods */
  78         DEVMETHOD(bus_print_child,          ata_iobus_print_child),
  79         DEVMETHOD(bus_alloc_resource,       ata_iobus_alloc_resource),
  80         DEVMETHOD(bus_release_resource,     ata_iobus_release_resource),
  81         DEVMETHOD(bus_activate_resource,    bus_generic_activate_resource),
  82         DEVMETHOD(bus_deactivate_resource,  bus_generic_deactivate_resource),
  83         DEVMETHOD(bus_setup_intr,           bus_generic_setup_intr),
  84         DEVMETHOD(bus_teardown_intr,        bus_generic_teardown_intr),
  85
  86         DEVMETHOD_END
  87 };
  88
  89 static driver_t ata_iobus_driver = {
  90         "ataiobus",
  91         ata_iobus_methods,
  92         0,
  93 };
  94
  95 static devclass_t ata_iobus_devclass;
  96
  97 DRIVER_MODULE(ataiobus, iobus, ata_iobus_driver, ata_iobus_devclass, NULL,
  98     NULL);
  99 MODULE_DEPEND(ata, ata, 1, 1, 1);
 100
 101 static int
 102 ata_iobus_probe(device_t dev)
 103 {
 104         char *type = iobus_get_name(dev);
 105
 106         if (strncmp(type, "ata", 3) != 0)
 107                 return (ENXIO);
 108
 109         device_set_desc(dev, "PSIM ATA Controller");
 110         return (0);
 111 }
 112
 113 static int
 114 ata_iobus_attach(device_t dev)
 115 {
 116         /*
 117          * Add a single child per controller. Should be able
 118          * to add two
 119          */
 120         device_add_child(dev, "ata", -1);
 121         return (bus_generic_attach(dev));
 122 }
 123
 124 static int
 125 ata_iobus_print_child(device_t dev, device_t child)
 126 {
 127         int retval = 0;
 128
 129         retval += bus_print_child_header(dev, child);
 130         /* irq ? */
 131         retval += bus_print_child_footer(dev, child);
 132
 133         return (retval);
 134 }
 135
 136 struct resource *
 137 ata_iobus_alloc_resource(device_t dev, device_t child, int type, int *rid,
 138                          rman_res_t start, rman_res_t end, rman_res_t count,
 139                          u_int flags)
 140 {
 141         struct resource *res = NULL;
 142         int myrid;
 143         u_int *ofw_regs;
 144
 145         ofw_regs = iobus_get_regs(dev);
 146
 147         /*
 148          * The reg array for the PSIM ata device has 6 start/size entries:
 149          *  0 - unused
 150          *  1/2/3 - unused
 151          *  4/5/6 - primary command
 152          *  7/8/9 - secondary command
 153          *  10/11/12 - primary control
 154          *  13/14/15 - secondary control
 155          *  16/17/18 - primary/secondary dma registers, unimplemented
 156          *
 157          *  The resource values are calculated from these registers
 158          */
 159         if (type == SYS_RES_IOPORT) {
 160                 switch (*rid) {
 161                 case ATA_IOADDR_RID:
 162                         myrid = 0;
 163                         start = ofw_regs[4];
 164                         end = start + ATA_IOSIZE - 1;
 165                         count = ATA_IOSIZE;
 166                         res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
 167                                                  SYS_RES_MEMORY, &myrid,
 168                                                  start, end, count, flags);
 169                         break;
 170
 171                 case ATA_CTLADDR_RID:
 172                         myrid = 0;
 173                         start = ofw_regs[10];
 174                         end = start + ATA_CTLIOSIZE - 1;
 175                         count = ATA_CTLIOSIZE;
 176                         res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
 177                                                  SYS_RES_MEMORY, &myrid,
 178                                                  start, end, count, flags);
 179                         break;
 180
 181                 case ATA_BMADDR_RID:
 182                         /* DMA not properly supported by psim */
 183                         break;
 184                 }
 185                 return (res);
 186
 187         } else if (type == SYS_RES_IRQ && *rid == ATA_IRQ_RID) {
 188                 /*
 189                  * Pass this on to the parent
 190                  */
 191                 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
 192                                            SYS_RES_IRQ, rid, 0, ~0, 1, flags));
 193
 194         } else {
 195                 return (NULL);
 196         }
 197 }
 198
 199 static int
 200 ata_iobus_release_resource(device_t dev, device_t child, int type, int rid,
 201                            struct resource *r)
 202 {
 203         /* no hotplug... */
 204         return (0);
 205 }
 206
 207 /*
 208  * Define the actual ATA device. This is a sub-bus to the ata-iobus layer
 209  * to allow the higher layer bus to massage the resource allocation.
 210  */
 211
 212 static  int  ata_iobus_sub_probe(device_t dev);
 213 static  int  ata_iobus_sub_setmode(device_t dev, int target, int mode);
 214
 215 static device_method_t ata_iobus_sub_methods[] = {
 216         /* Device interface */
 217         DEVMETHOD(device_probe,     ata_iobus_sub_probe),
 218         DEVMETHOD(device_attach,    ata_attach),
 219         DEVMETHOD(device_detach,    ata_detach),
 220         DEVMETHOD(device_resume,    ata_resume),
 221
 222         /* ATA interface */
 223         DEVMETHOD(ata_setmode,      ata_iobus_sub_setmode),
 224         DEVMETHOD_END
 225 };
 226
 227 static driver_t ata_iobus_sub_driver = {
 228         "ata",
 229         ata_iobus_sub_methods,
 230         sizeof(struct ata_channel),
 231 };
 232
 233 DRIVER_MODULE(ata, ataiobus, ata_iobus_sub_driver, ata_devclass, NULL, NULL);
 234
 235 static int
 236 ata_iobus_sub_probe(device_t dev)
 237 {
 238         struct ata_channel *ch = device_get_softc(dev);
 239
 240         /* Only a single unit per controller thus far */
 241         ch->unit = 0;
 242         ch->flags = (ATA_USE_16BIT|ATA_NO_SLAVE);
 243         ata_generic_hw(dev);
 244
 245         return ata_probe(dev);
 246 }
 247
 248 static int
 249 ata_iobus_sub_setmode(device_t parent, int target, int mode)
 250 {
 251         /* Only ever PIO mode here... */
 252         return (ATA_PIO);
 253 }