sys/dev/ata/chipsets/ata-acerlabs.c

   1 /*-
   2  * Copyright (c) 1998 - 2008 Søren Schmidt <sos@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification, immediately at the beginning of the file.
  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  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_ata.h"
  31 #include <sys/param.h>
  32 #include <sys/module.h>
  33 #include <sys/systm.h>
  34 #include <sys/kernel.h>
  35 #include <sys/ata.h>
  36 #include <sys/bus.h>
  37 #include <sys/endian.h>
  38 #include <sys/malloc.h>
  39 #include <sys/lock.h>
  40 #include <sys/mutex.h>
  41 #include <sys/sema.h>
  42 #include <sys/taskqueue.h>
  43 #include <vm/uma.h>
  44 #include <machine/stdarg.h>
  45 #include <machine/resource.h>
  46 #include <machine/bus.h>
  47 #include <sys/rman.h>
  48 #include <dev/pci/pcivar.h>
  49 #include <dev/pci/pcireg.h>
  50 #include <dev/ata/ata-all.h>
  51 #include <dev/ata/ata-pci.h>
  52 #include <ata_if.h>
  53
  54 /* local prototypes */
  55 static int ata_ali_chipinit(device_t dev);
  56 static int ata_ali_ch_attach(device_t dev);
  57 static int ata_ali_sata_ch_attach(device_t dev);
  58 static void ata_ali_reset(device_t dev);
  59 static void ata_ali_setmode(device_t dev, int mode);
  60
  61 /* misc defines */
  62 #define ALI_OLD         0x01
  63 #define ALI_NEW         0x02
  64 #define ALI_SATA        0x04
  65
  66 struct ali_sata_resources {
  67         struct resource *bars[4];
  68 };
  69
  70 /*
  71  * Acer Labs Inc (ALI) chipset support functions
  72  */
  73 static int
  74 ata_ali_probe(device_t dev)
  75 {
  76     struct ata_pci_controller *ctlr = device_get_softc(dev);
  77     static struct ata_chip_id ids[] =
  78     {{ ATA_ALI_5289, 0x00, 2, ALI_SATA, ATA_SA150, "M5289" },
  79      { ATA_ALI_5288, 0x00, 4, ALI_SATA, ATA_SA300, "M5288" },
  80      { ATA_ALI_5287, 0x00, 4, ALI_SATA, ATA_SA150, "M5287" },
  81      { ATA_ALI_5281, 0x00, 2, ALI_SATA, ATA_SA150, "M5281" },
  82      { ATA_ALI_5229, 0xc5, 0, ALI_NEW,  ATA_UDMA6, "M5229" },
  83      { ATA_ALI_5229, 0xc4, 0, ALI_NEW,  ATA_UDMA5, "M5229" },
  84      { ATA_ALI_5229, 0xc2, 0, ALI_NEW,  ATA_UDMA4, "M5229" },
  85      { ATA_ALI_5229, 0x20, 0, ALI_OLD,  ATA_UDMA2, "M5229" },
  86      { ATA_ALI_5229, 0x00, 0, ALI_OLD,  ATA_WDMA2, "M5229" },
  87      { 0, 0, 0, 0, 0, 0}};
  88
  89     if (pci_get_vendor(dev) != ATA_ACER_LABS_ID)
  90         return ENXIO;
  91
  92     if (!(ctlr->chip = ata_match_chip(dev, ids)))
  93         return ENXIO;
  94
  95     ata_set_desc(dev);
  96     ctlr->chipinit = ata_ali_chipinit;
  97     return (BUS_PROBE_DEFAULT);
  98 }
  99
 100 static int
 101 ata_ali_chipinit(device_t dev)
 102 {
 103     struct ata_pci_controller *ctlr = device_get_softc(dev);
 104     struct ali_sata_resources *res;
 105     int i, rid;
 106
 107     if (ata_setup_interrupt(dev, ata_generic_intr))
 108         return ENXIO;
 109
 110     switch (ctlr->chip->cfg2) {
 111     case ALI_SATA:
 112         ctlr->channels = ctlr->chip->cfg1;
 113         ctlr->ch_attach = ata_ali_sata_ch_attach;
 114         ctlr->ch_detach = ata_pci_ch_detach;
 115         ctlr->setmode = ata_sata_setmode;
 116
 117         /* AHCI mode is correctly supported only on the ALi 5288. */
 118         if ((ctlr->chip->chipid == ATA_ALI_5288) &&
 119             (ata_ahci_chipinit(dev) != ENXIO))
 120             return 0;
 121
 122         /* Allocate resources for later use by channel attach routines. */
 123         res = malloc(sizeof(struct ali_sata_resources), M_TEMP, M_WAITOK);
 124         for (i = 0; i < 4; i++) {
 125                 rid = PCIR_BAR(i);
 126                 res->bars[i] = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
 127                     RF_ACTIVE);
 128                 if (res->bars[i] == NULL) {
 129                         device_printf(dev, "Failed to allocate BAR %d\n", i);
 130                         for (i--; i >=0; i--)
 131                                 bus_release_resource(dev, SYS_RES_IOPORT,
 132                                     PCIR_BAR(i), res->bars[i]);
 133                         free(res, M_TEMP);
 134                 }
 135         }
 136         ctlr->chipset_data = res;
 137         break;
 138
 139     case ALI_NEW:
 140         /* use device interrupt as byte count end */
 141         pci_write_config(dev, 0x4a, pci_read_config(dev, 0x4a, 1) | 0x20, 1);
 142
 143         /* enable cable detection and UDMA support on newer chips */
 144         pci_write_config(dev, 0x4b, pci_read_config(dev, 0x4b, 1) | 0x09, 1);
 145
 146         /* enable ATAPI UDMA mode */
 147         pci_write_config(dev, 0x53, pci_read_config(dev, 0x53, 1) | 0x01, 1);
 148
 149         /* only chips with revision > 0xc4 can do 48bit DMA */
 150         if (ctlr->chip->chiprev <= 0xc4)
 151             device_printf(dev,
 152                           "using PIO transfers above 137GB as workaround for "
 153                           "48bit DMA access bug, expect reduced performance\n");
 154         ctlr->ch_attach = ata_ali_ch_attach;
 155         ctlr->ch_detach = ata_pci_ch_detach;
 156         ctlr->reset = ata_ali_reset;
 157         ctlr->setmode = ata_ali_setmode;
 158         break;
 159
 160     case ALI_OLD:
 161         /* deactivate the ATAPI FIFO and enable ATAPI UDMA */
 162         pci_write_config(dev, 0x53, pci_read_config(dev, 0x53, 1) | 0x03, 1);
 163         ctlr->setmode = ata_ali_setmode;
 164         break;
 165     }
 166     return 0;
 167 }
 168
 169 static int
 170 ata_ali_ch_attach(device_t dev)
 171 {
 172     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
 173     struct ata_channel *ch = device_get_softc(dev);
 174
 175     /* setup the usual register normal pci style */
 176     if (ata_pci_ch_attach(dev))
 177         return ENXIO;
 178
 179     /* older chips can't do 48bit DMA transfers */
 180     if (ctlr->chip->chiprev <= 0xc4)
 181         ch->flags |= ATA_NO_48BIT_DMA;
 182
 183     return 0;
 184 }
 185
 186 static int
 187 ata_ali_sata_ch_attach(device_t dev)
 188 {
 189     device_t parent = device_get_parent(dev);
 190     struct ata_pci_controller *ctlr = device_get_softc(parent);
 191     struct ata_channel *ch = device_get_softc(dev);
 192     struct ali_sata_resources *res;
 193     struct resource *io = NULL, *ctlio = NULL;
 194     int unit01 = (ch->unit & 1), unit10 = (ch->unit & 2);
 195     int i;
 196
 197     res = ctlr->chipset_data;
 198     if (unit01) {
 199             io = res->bars[2];
 200             ctlio = res->bars[3];
 201     } else {
 202             io = res->bars[0];
 203             ctlio = res->bars[1];
 204     }
 205
 206     for (i = ATA_DATA; i <= ATA_COMMAND; i ++) {
 207         ch->r_io[i].res = io;
 208         ch->r_io[i].offset = i + (unit10 ? 8 : 0);
 209     }
 210     ch->r_io[ATA_CONTROL].res = ctlio;
 211     ch->r_io[ATA_CONTROL].offset = 2 + (unit10 ? 4 : 0);
 212     ch->r_io[ATA_IDX_ADDR].res = io;
 213     ata_default_registers(dev);
 214     if (ctlr->r_res1) {
 215         for (i = ATA_BMCMD_PORT; i <= ATA_BMDTP_PORT; i++) {
 216             ch->r_io[i].res = ctlr->r_res1;
 217             ch->r_io[i].offset = (i - ATA_BMCMD_PORT)+(ch->unit * ATA_BMIOSIZE);
 218         }
 219     }
 220     ch->flags |= ATA_NO_SLAVE;
 221
 222     /* XXX SOS PHY handling awkward in ALI chip not supported yet */
 223     ata_pci_hw(dev);
 224     return 0;
 225 }
 226
 227 static void
 228 ata_ali_reset(device_t dev)
 229 {
 230     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
 231     struct ata_channel *ch = device_get_softc(dev);
 232     device_t *children;
 233     int nchildren, i;
 234
 235     ata_generic_reset(dev);
 236
 237     /*
 238      * workaround for datacorruption bug found on at least SUN Blade-100
 239      * find the ISA function on the southbridge and disable then enable
 240      * the ATA channel tristate buffer
 241      */
 242     if (ctlr->chip->chiprev == 0xc3 || ctlr->chip->chiprev == 0xc2) {
 243         if (!device_get_children(GRANDPARENT(dev), &children, &nchildren)) {
 244             for (i = 0; i < nchildren; i++) {
 245                 if (pci_get_devid(children[i]) == ATA_ALI_1533) {
 246                     pci_write_config(children[i], 0x58,
 247                                      pci_read_config(children[i], 0x58, 1) &
 248                                      ~(0x04 << ch->unit), 1);
 249                     pci_write_config(children[i], 0x58,
 250                                      pci_read_config(children[i], 0x58, 1) |
 251                                      (0x04 << ch->unit), 1);
 252                     break;
 253                 }
 254             }
 255             free(children, M_TEMP);
 256         }
 257     }
 258 }
 259
 260 static void
 261 ata_ali_setmode(device_t dev, int mode)
 262 {
 263     device_t gparent = GRANDPARENT(dev);
 264     struct ata_pci_controller *ctlr = device_get_softc(gparent);
 265     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
 266     struct ata_device *atadev = device_get_softc(dev);
 267     int devno = (ch->unit << 1) + atadev->unit;
 268     int error;
 269
 270     mode = ata_limit_mode(dev, mode, ctlr->chip->max_dma);
 271
 272     if (ctlr->chip->cfg2 & ALI_NEW) {
 273         if (mode > ATA_UDMA2 &&
 274             pci_read_config(gparent, 0x4a, 1) & (1 << ch->unit)) {
 275             ata_print_cable(dev, "controller");
 276             mode = ATA_UDMA2;
 277         }
 278     }
 279     else
 280         mode = ata_check_80pin(dev, mode);
 281
 282     if (ctlr->chip->cfg2 & ALI_OLD) {
 283         /* doesn't support ATAPI DMA on write */
 284         ch->flags |= ATA_ATAPI_DMA_RO;
 285         if (ch->devices & ATA_ATAPI_MASTER && ch->devices & ATA_ATAPI_SLAVE) {
 286             /* doesn't support ATAPI DMA on two ATAPI devices */
 287             device_printf(dev, "two atapi devices on this channel, no DMA\n");
 288             mode = ata_limit_mode(dev, mode, ATA_PIO_MAX);
 289         }
 290     }
 291
 292     error = ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_SETXFER, 0, mode);
 293
 294     if (bootverbose)
 295         device_printf(dev, "%ssetting %s on %s chip\n",
 296                    (error) ? "FAILURE " : "",
 297                    ata_mode2str(mode), ctlr->chip->text);
 298     if (!error) {
 299         if (mode >= ATA_UDMA0) {
 300             u_int8_t udma[] = {0x0c, 0x0b, 0x0a, 0x09, 0x08, 0x0f, 0x0d};
 301             u_int32_t word54 = pci_read_config(gparent, 0x54, 4);
 302
 303             word54 &= ~(0x000f000f << (devno << 2));
 304             word54 |= (((udma[mode&ATA_MODE_MASK]<<16)|0x05)<<(devno<<2));
 305             pci_write_config(gparent, 0x54, word54, 4);
 306             pci_write_config(gparent, 0x58 + (ch->unit << 2),
 307                              0x00310001, 4);
 308         }
 309         else {
 310             u_int32_t piotimings[] =
 311                 { 0x006d0003, 0x00580002, 0x00440001, 0x00330001,
 312                   0x00310001, 0x00440001, 0x00330001, 0x00310001};
 313
 314             pci_write_config(gparent, 0x54, pci_read_config(gparent, 0x54, 4) &
 315                                             ~(0x0008000f << (devno << 2)), 4);
 316             pci_write_config(gparent, 0x58 + (ch->unit << 2),
 317                              piotimings[ata_mode2idx(mode)], 4);
 318         }
 319         atadev->mode = mode;
 320     }
 321 }
 322
 323 ATA_DECLARE_DRIVER(ata_ali);
 324 MODULE_DEPEND(ata_ali, ata_ahci, 1, 1, 1);