sys/dev/ata/chipsets/ata-via.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_via_chipinit(device_t dev);
  56 static int ata_via_ch_attach(device_t dev);
  57 static int ata_via_ch_detach(device_t dev);
  58 static void ata_via_reset(device_t dev);
  59 static void ata_via_old_setmode(device_t dev, int mode);
  60 static void ata_via_southbridge_fixup(device_t dev);
  61 static void ata_via_new_setmode(device_t dev, int mode);
  62
  63 /* misc defines */
  64 #define VIA33           0
  65 #define VIA66           1
  66 #define VIA100          2
  67 #define VIA133          3
  68
  69 #define VIACLK          0x01
  70 #define VIABUG          0x02
  71 #define VIABAR          0x04
  72 #define VIAAHCI         0x08
  73
  74
  75 /*
  76  * VIA Technologies Inc. chipset support functions
  77  */
  78 static int
  79 ata_via_probe(device_t dev)
  80 {
  81     struct ata_pci_controller *ctlr = device_get_softc(dev);
  82     static struct ata_chip_id ids[] =
  83     {{ ATA_VIA82C586, 0x02, VIA33,  0x00,    ATA_UDMA2, "82C586B" },
  84      { ATA_VIA82C586, 0x00, VIA33,  0x00,    ATA_WDMA2, "82C586" },
  85      { ATA_VIA82C596, 0x12, VIA66,  VIACLK,  ATA_UDMA4, "82C596B" },
  86      { ATA_VIA82C596, 0x00, VIA33,  0x00,    ATA_UDMA2, "82C596" },
  87      { ATA_VIA82C686, 0x40, VIA100, VIABUG,  ATA_UDMA5, "82C686B"},
  88      { ATA_VIA82C686, 0x10, VIA66,  VIACLK,  ATA_UDMA4, "82C686A" },
  89      { ATA_VIA82C686, 0x00, VIA33,  0x00,    ATA_UDMA2, "82C686" },
  90      { ATA_VIA8231,   0x00, VIA100, VIABUG,  ATA_UDMA5, "8231" },
  91      { ATA_VIA8233,   0x00, VIA100, 0x00,    ATA_UDMA5, "8233" },
  92      { ATA_VIA8233C,  0x00, VIA100, 0x00,    ATA_UDMA5, "8233C" },
  93      { ATA_VIA8233A,  0x00, VIA133, 0x00,    ATA_UDMA6, "8233A" },
  94      { ATA_VIA8235,   0x00, VIA133, 0x00,    ATA_UDMA6, "8235" },
  95      { ATA_VIA8237,   0x00, VIA133, 0x00,    ATA_UDMA6, "8237" },
  96      { ATA_VIA8237A,  0x00, VIA133, 0x00,    ATA_UDMA6, "8237A" },
  97      { ATA_VIA8237S,  0x00, VIA133, 0x00,    ATA_UDMA6, "8237S" },
  98      { ATA_VIA8251,   0x00, VIA133, 0x00,    ATA_UDMA6, "8251" },
  99      { 0, 0, 0, 0, 0, 0 }};
 100     static struct ata_chip_id new_ids[] =
 101     {{ ATA_VIA6410,   0x00, 0,      0x00,    ATA_UDMA6, "6410" },
 102      { ATA_VIA6420,   0x00, 7,      0x00,    ATA_SA150, "6420" },
 103      { ATA_VIA6421,   0x00, 6,      VIABAR,  ATA_SA150, "6421" },
 104      { ATA_VIA8237A,  0x00, 7,      0x00,    ATA_SA150, "8237A" },
 105      { ATA_VIA8237S,  0x00, 7,      0x00,    ATA_SA150, "8237S" },
 106      { ATA_VIA8251,   0x00, 0,      VIAAHCI, ATA_SA300, "8251" },
 107      { 0, 0, 0, 0, 0, 0 }};
 108
 109     if (pci_get_vendor(dev) != ATA_VIA_ID)
 110         return ENXIO;
 111
 112     if (pci_get_devid(dev) == ATA_VIA82C571) {
 113         if (!(ctlr->chip = ata_find_chip(dev, ids, -99)))
 114             return ENXIO;
 115     }
 116     else {
 117         if (!(ctlr->chip = ata_match_chip(dev, new_ids)))
 118             return ENXIO;
 119     }
 120
 121     ata_set_desc(dev);
 122     ctlr->chipinit = ata_via_chipinit;
 123     return (BUS_PROBE_DEFAULT);
 124 }
 125
 126 static int
 127 ata_via_chipinit(device_t dev)
 128 {
 129     struct ata_pci_controller *ctlr = device_get_softc(dev);
 130
 131     if (ata_setup_interrupt(dev, ata_generic_intr))
 132         return ENXIO;
 133
 134     if (ctlr->chip->max_dma >= ATA_SA150) {
 135         /* do we have AHCI capability ? */
 136         if ((ctlr->chip->cfg2 == VIAAHCI) && ata_ahci_chipinit(dev) != ENXIO)
 137             return 0;
 138
 139         ctlr->r_type2 = SYS_RES_IOPORT;
 140         ctlr->r_rid2 = PCIR_BAR(5);
 141         if ((ctlr->r_res2 = bus_alloc_resource_any(dev, ctlr->r_type2,
 142                                                    &ctlr->r_rid2, RF_ACTIVE))) {
 143             ctlr->ch_attach = ata_via_ch_attach;
 144             ctlr->ch_detach = ata_via_ch_detach;
 145             ctlr->reset = ata_via_reset;
 146         }
 147
 148         if (ctlr->chip->cfg2 & VIABAR) {
 149             ctlr->channels = 3;
 150             ctlr->setmode = ata_via_new_setmode;
 151         }
 152         else
 153             ctlr->setmode = ata_sata_setmode;
 154         return 0;
 155     }
 156
 157     /* prepare for ATA-66 on the 82C686a and 82C596b */
 158     if (ctlr->chip->cfg2 & VIACLK)
 159         pci_write_config(dev, 0x50, 0x030b030b, 4);
 160
 161     /* the southbridge might need the data corruption fix */
 162     if (ctlr->chip->cfg2 & VIABUG)
 163         ata_via_southbridge_fixup(dev);
 164
 165     /* set fifo configuration half'n'half */
 166     pci_write_config(dev, 0x43,
 167                      (pci_read_config(dev, 0x43, 1) & 0x90) | 0x2a, 1);
 168
 169     /* set status register read retry */
 170     pci_write_config(dev, 0x44, pci_read_config(dev, 0x44, 1) | 0x08, 1);
 171
 172     /* set DMA read & end-of-sector fifo flush */
 173     pci_write_config(dev, 0x46,
 174                      (pci_read_config(dev, 0x46, 1) & 0x0c) | 0xf0, 1);
 175
 176     /* set sector size */
 177     pci_write_config(dev, 0x60, DEV_BSIZE, 2);
 178     pci_write_config(dev, 0x68, DEV_BSIZE, 2);
 179
 180     ctlr->setmode = ata_via_old_setmode;
 181     return 0;
 182 }
 183
 184 static int
 185 ata_via_ch_attach(device_t dev)
 186 {
 187     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
 188     struct ata_channel *ch = device_get_softc(dev);
 189
 190     /* newer SATA chips has resources in one BAR for each channel */
 191     if (ctlr->chip->cfg2 & VIABAR) {
 192         struct resource *r_io;
 193         int i, rid;
 194
 195         ata_pci_dmainit(dev);
 196
 197         rid = PCIR_BAR(ch->unit);
 198         if (!(r_io = bus_alloc_resource_any(device_get_parent(dev),
 199                                             SYS_RES_IOPORT,
 200                                             &rid, RF_ACTIVE)))
 201             return ENXIO;
 202
 203         for (i = ATA_DATA; i <= ATA_COMMAND; i ++) {
 204             ch->r_io[i].res = r_io;
 205             ch->r_io[i].offset = i;
 206         }
 207         ch->r_io[ATA_CONTROL].res = r_io;
 208         ch->r_io[ATA_CONTROL].offset = 2 + ATA_IOSIZE;
 209         ch->r_io[ATA_IDX_ADDR].res = r_io;
 210         ata_default_registers(dev);
 211         for (i = ATA_BMCMD_PORT; i <= ATA_BMDTP_PORT; i++) {
 212             ch->r_io[i].res = ctlr->r_res1;
 213             ch->r_io[i].offset = (i - ATA_BMCMD_PORT)+(ch->unit * ATA_BMIOSIZE);
 214         }
 215         ata_pci_hw(dev);
 216         if (ch->unit >= 2)
 217             return 0;
 218     }
 219     else {
 220         /* setup the usual register normal pci style */
 221         if (ata_pci_ch_attach(dev))
 222             return ENXIO;
 223     }
 224
 225     ch->r_io[ATA_SSTATUS].res = ctlr->r_res2;
 226     ch->r_io[ATA_SSTATUS].offset = (ch->unit << ctlr->chip->cfg1);
 227     ch->r_io[ATA_SERROR].res = ctlr->r_res2;
 228     ch->r_io[ATA_SERROR].offset = 0x04 + (ch->unit << ctlr->chip->cfg1);
 229     ch->r_io[ATA_SCONTROL].res = ctlr->r_res2;
 230     ch->r_io[ATA_SCONTROL].offset = 0x08 + (ch->unit << ctlr->chip->cfg1);
 231     ch->flags |= ATA_NO_SLAVE;
 232
 233     /* XXX SOS PHY hotplug handling missing in VIA chip ?? */
 234     /* XXX SOS unknown how to enable PHY state change interrupt */
 235     return 0;
 236 }
 237
 238 static int
 239 ata_via_ch_detach(device_t dev)
 240 {
 241     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
 242     struct ata_channel *ch = device_get_softc(dev);
 243
 244     /* newer SATA chips has resources in one BAR for each channel */
 245     if (ctlr->chip->cfg2 & VIABAR) {
 246         int rid;
 247
 248         rid = PCIR_BAR(ch->unit);
 249         bus_release_resource(device_get_parent(dev),
 250             SYS_RES_IOPORT, rid, ch->r_io[ATA_CONTROL].res);
 251
 252         ata_pci_dmafini(dev);
 253     }
 254     else {
 255         /* setup the usual register normal pci style */
 256         if (ata_pci_ch_detach(dev))
 257             return ENXIO;
 258     }
 259
 260     return 0;
 261 }
 262
 263 static void
 264 ata_via_reset(device_t dev)
 265 {
 266     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
 267     struct ata_channel *ch = device_get_softc(dev);
 268
 269     if ((ctlr->chip->cfg2 & VIABAR) && (ch->unit > 1))
 270         ata_generic_reset(dev);
 271     else
 272         if (ata_sata_phy_reset(dev, -1, 1))
 273             ata_generic_reset(dev);
 274 }
 275
 276 static void
 277 ata_via_new_setmode(device_t dev, int mode)
 278 {
 279     device_t gparent = GRANDPARENT(dev);
 280     struct ata_pci_controller *ctlr = device_get_softc(gparent);
 281     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
 282     struct ata_device *atadev = device_get_softc(dev);
 283     int error;
 284
 285     if ((ctlr->chip->cfg2 & VIABAR) && (ch->unit > 1)) {
 286         u_int8_t pio_timings[] = { 0xa8, 0x65, 0x65, 0x32, 0x20,
 287                                    0x65, 0x32, 0x20,
 288                                    0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20 };
 289         u_int8_t dma_timings[] = { 0xee, 0xe8, 0xe6, 0xe4, 0xe2, 0xe1, 0xe0 };
 290
 291         mode = ata_check_80pin(dev, ata_limit_mode(dev, mode, ATA_UDMA6));
 292         error = ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_SETXFER, 0, mode);
 293         if (bootverbose)
 294             device_printf(dev, "%ssetting %s on %s chip\n",
 295                           (error) ? "FAILURE " : "", ata_mode2str(mode),
 296                           ctlr->chip->text);
 297         if (!error) {
 298             pci_write_config(gparent, 0xab, pio_timings[ata_mode2idx(mode)], 1);
 299             if (mode >= ATA_UDMA0)
 300                 pci_write_config(gparent, 0xb3,
 301                                  dma_timings[mode & ATA_MODE_MASK], 1);
 302             atadev->mode = mode;
 303         }
 304     }
 305     else
 306         ata_sata_setmode(dev, mode);
 307 }
 308
 309 static void
 310 ata_via_old_setmode(device_t dev, int mode)
 311 {
 312     device_t gparent = GRANDPARENT(dev);
 313     struct ata_pci_controller *ctlr = device_get_softc(gparent);
 314     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
 315     struct ata_device *atadev = device_get_softc(dev);
 316     u_int8_t timings[] = { 0xa8, 0x65, 0x42, 0x22, 0x20, 0x42, 0x22, 0x20,
 317                            0x20, 0x20, 0x20, 0x20, 0x20, 0x20, 0x20 };
 318     int modes[][7] = {
 319         { 0xc2, 0xc1, 0xc0, 0x00, 0x00, 0x00, 0x00 },   /* VIA ATA33 */
 320         { 0xee, 0xec, 0xea, 0xe9, 0xe8, 0x00, 0x00 },   /* VIA ATA66 */
 321         { 0xf7, 0xf6, 0xf4, 0xf2, 0xf1, 0xf0, 0x00 },   /* VIA ATA100 */
 322         { 0xf7, 0xf7, 0xf6, 0xf4, 0xf2, 0xf1, 0xf0 } }; /* VIA ATA133 */
 323     int devno = (ch->unit << 1) + atadev->unit;
 324     int reg = 0x53 - devno;
 325     int error;
 326
 327     mode = ata_limit_mode(dev, mode, ctlr->chip->max_dma);
 328     mode = ata_check_80pin(dev, mode);
 329
 330     error = ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_SETXFER, 0, mode);
 331     if (bootverbose)
 332         device_printf(dev, "%ssetting %s on %s chip\n",
 333                       (error) ? "FAILURE " : "", ata_mode2str(mode),
 334                       ctlr->chip->text);
 335     if (!error) {
 336         if (ctlr->chip->cfg1 != VIA133)
 337             pci_write_config(gparent, reg - 0x08,timings[ata_mode2idx(mode)],1);
 338         if (mode >= ATA_UDMA0)
 339             pci_write_config(gparent, reg,
 340                              modes[ctlr->chip->cfg1][mode & ATA_MODE_MASK], 1);
 341         else
 342             pci_write_config(gparent, reg, 0x8b, 1);
 343         atadev->mode = mode;
 344     }
 345 }
 346
 347 static void
 348 ata_via_southbridge_fixup(device_t dev)
 349 {
 350     device_t *children;
 351     int nchildren, i;
 352
 353     if (device_get_children(device_get_parent(dev), &children, &nchildren))
 354         return;
 355
 356     for (i = 0; i < nchildren; i++) {
 357         if (pci_get_devid(children[i]) == ATA_VIA8363 ||
 358             pci_get_devid(children[i]) == ATA_VIA8371 ||
 359             pci_get_devid(children[i]) == ATA_VIA8662 ||
 360             pci_get_devid(children[i]) == ATA_VIA8361) {
 361             u_int8_t reg76 = pci_read_config(children[i], 0x76, 1);
 362
 363             if ((reg76 & 0xf0) != 0xd0) {
 364                 device_printf(dev,
 365                 "Correcting VIA config for southbridge data corruption bug\n");
 366                 pci_write_config(children[i], 0x75, 0x80, 1);
 367                 pci_write_config(children[i], 0x76, (reg76 & 0x0f) | 0xd0, 1);
 368             }
 369             break;
 370         }
 371     }
 372     free(children, M_TEMP);
 373 }
 374
 375 ATA_DECLARE_DRIVER(ata_via);
 376 MODULE_DEPEND(ata_via, ata_ahci, 1, 1, 1);