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 int ata_via_old_setmode(device_t dev, int target, int mode);
  60 static void ata_via_southbridge_fixup(device_t dev);
  61 static int ata_via_new_setmode(device_t dev, int target, 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_VIA8237_5372, 0x00, VIA133, 0x00, ATA_UDMA6, "8237" },
  99      { ATA_VIA8237_7372, 0x00, VIA133, 0x00, ATA_UDMA6, "8237" },
 100      { ATA_VIA8251,   0x00, VIA133, 0x00,    ATA_UDMA6, "8251" },
 101      { 0, 0, 0, 0, 0, 0 }};
 102     static struct ata_chip_id new_ids[] =
 103     {{ ATA_VIA6410,   0x00, 0,      0x00,    ATA_UDMA6, "6410" },
 104      { ATA_VIA6420,   0x00, 7,      0x00,    ATA_SA150, "6420" },
 105      { ATA_VIA6421,   0x00, 6,      VIABAR,  ATA_SA150, "6421" },
 106      { ATA_VIA8237A,  0x00, 7,      0x00,    ATA_SA150, "8237A" },
 107      { ATA_VIA8237S,  0x00, 7,      0x00,    ATA_SA150, "8237S" },
 108      { ATA_VIA8237_5372, 0x00, 7,   0x00,    ATA_SA300, "8237" },
 109      { ATA_VIA8237_7372, 0x00, 7,   0x00,    ATA_SA300, "8237" },
 110      { ATA_VIA8251,   0x00, 0,      VIAAHCI, ATA_SA300, "8251" },
 111      { 0, 0, 0, 0, 0, 0 }};
 112
 113     if (pci_get_vendor(dev) != ATA_VIA_ID)
 114         return ENXIO;
 115
 116     if (pci_get_devid(dev) == ATA_VIA82C571) {
 117         if (!(ctlr->chip = ata_find_chip(dev, ids, -99)))
 118             return ENXIO;
 119     }
 120     else {
 121         if (!(ctlr->chip = ata_match_chip(dev, new_ids)))
 122             return ENXIO;
 123     }
 124
 125     ata_set_desc(dev);
 126     ctlr->chipinit = ata_via_chipinit;
 127     return (BUS_PROBE_DEFAULT);
 128 }
 129
 130 static int
 131 ata_via_chipinit(device_t dev)
 132 {
 133     struct ata_pci_controller *ctlr = device_get_softc(dev);
 134
 135     if (ata_setup_interrupt(dev, ata_generic_intr))
 136         return ENXIO;
 137
 138     if (ctlr->chip->max_dma >= ATA_SA150) {
 139         /* do we have AHCI capability ? */
 140         if ((ctlr->chip->cfg2 == VIAAHCI) && ata_ahci_chipinit(dev) != ENXIO)
 141             return 0;
 142
 143         ctlr->r_type2 = SYS_RES_IOPORT;
 144         ctlr->r_rid2 = PCIR_BAR(5);
 145         if ((ctlr->r_res2 = bus_alloc_resource_any(dev, ctlr->r_type2,
 146                                                    &ctlr->r_rid2, RF_ACTIVE))) {
 147             ctlr->ch_attach = ata_via_ch_attach;
 148             ctlr->ch_detach = ata_via_ch_detach;
 149             ctlr->reset = ata_via_reset;
 150         }
 151
 152         if (ctlr->chip->cfg2 & VIABAR) {
 153             ctlr->channels = 3;
 154             ctlr->setmode = ata_via_new_setmode;
 155         } else
 156             ctlr->setmode = ata_sata_setmode;
 157         ctlr->getrev = ata_sata_getrev;
 158         return 0;
 159     }
 160
 161     /* prepare for ATA-66 on the 82C686a and 82C596b */
 162     if (ctlr->chip->cfg2 & VIACLK)
 163         pci_write_config(dev, 0x50, 0x030b030b, 4);
 164
 165     /* the southbridge might need the data corruption fix */
 166     if (ctlr->chip->cfg2 & VIABUG)
 167         ata_via_southbridge_fixup(dev);
 168
 169     /* set fifo configuration half'n'half */
 170     pci_write_config(dev, 0x43,
 171                      (pci_read_config(dev, 0x43, 1) & 0x90) | 0x2a, 1);
 172
 173     /* set status register read retry */
 174     pci_write_config(dev, 0x44, pci_read_config(dev, 0x44, 1) | 0x08, 1);
 175
 176     /* set DMA read & end-of-sector fifo flush */
 177     pci_write_config(dev, 0x46,
 178                      (pci_read_config(dev, 0x46, 1) & 0x0c) | 0xf0, 1);
 179
 180     /* set sector size */
 181     pci_write_config(dev, 0x60, DEV_BSIZE, 2);
 182     pci_write_config(dev, 0x68, DEV_BSIZE, 2);
 183
 184     ctlr->setmode = ata_via_old_setmode;
 185     return 0;
 186 }
 187
 188 static int
 189 ata_via_ch_attach(device_t dev)
 190 {
 191     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
 192     struct ata_channel *ch = device_get_softc(dev);
 193
 194     /* newer SATA chips has resources in one BAR for each channel */
 195     if (ctlr->chip->cfg2 & VIABAR) {
 196         struct resource *r_io;
 197         int i, rid;
 198
 199         ata_pci_dmainit(dev);
 200
 201         rid = PCIR_BAR(ch->unit);
 202         if (!(r_io = bus_alloc_resource_any(device_get_parent(dev),
 203                                             SYS_RES_IOPORT,
 204                                             &rid, RF_ACTIVE)))
 205             return ENXIO;
 206
 207         for (i = ATA_DATA; i <= ATA_COMMAND; i ++) {
 208             ch->r_io[i].res = r_io;
 209             ch->r_io[i].offset = i;
 210         }
 211         ch->r_io[ATA_CONTROL].res = r_io;
 212         ch->r_io[ATA_CONTROL].offset = 2 + ATA_IOSIZE;
 213         ch->r_io[ATA_IDX_ADDR].res = r_io;
 214         ata_default_registers(dev);
 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         ata_pci_hw(dev);
 220         if (ch->unit >= 2)
 221             return 0;
 222     }
 223     else {
 224         /* setup the usual register normal pci style */
 225         if (ata_pci_ch_attach(dev))
 226             return ENXIO;
 227     }
 228
 229     ch->r_io[ATA_SSTATUS].res = ctlr->r_res2;
 230     ch->r_io[ATA_SSTATUS].offset = (ch->unit << ctlr->chip->cfg1);
 231     ch->r_io[ATA_SERROR].res = ctlr->r_res2;
 232     ch->r_io[ATA_SERROR].offset = 0x04 + (ch->unit << ctlr->chip->cfg1);
 233     ch->r_io[ATA_SCONTROL].res = ctlr->r_res2;
 234     ch->r_io[ATA_SCONTROL].offset = 0x08 + (ch->unit << ctlr->chip->cfg1);
 235     ch->flags |= ATA_NO_SLAVE;
 236     ch->flags |= ATA_SATA;
 237
 238     /* XXX SOS PHY hotplug handling missing in VIA chip ?? */
 239     /* XXX SOS unknown how to enable PHY state change interrupt */
 240     return 0;
 241 }
 242
 243 static int
 244 ata_via_ch_detach(device_t dev)
 245 {
 246     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
 247     struct ata_channel *ch = device_get_softc(dev);
 248
 249     /* newer SATA chips has resources in one BAR for each channel */
 250     if (ctlr->chip->cfg2 & VIABAR) {
 251         int rid;
 252
 253         rid = PCIR_BAR(ch->unit);
 254         bus_release_resource(device_get_parent(dev),
 255             SYS_RES_IOPORT, rid, ch->r_io[ATA_CONTROL].res);
 256
 257         ata_pci_dmafini(dev);
 258     }
 259     else {
 260         /* setup the usual register normal pci style */
 261         if (ata_pci_ch_detach(dev))
 262             return ENXIO;
 263     }
 264
 265     return 0;
 266 }
 267
 268 static void
 269 ata_via_reset(device_t dev)
 270 {
 271     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
 272     struct ata_channel *ch = device_get_softc(dev);
 273
 274     if ((ctlr->chip->cfg2 & VIABAR) && (ch->unit > 1))
 275         ata_generic_reset(dev);
 276     else
 277         if (ata_sata_phy_reset(dev, -1, 1))
 278             ata_generic_reset(dev);
 279 }
 280
 281 static int
 282 ata_via_new_setmode(device_t dev, int target, int mode)
 283 {
 284         device_t parent = device_get_parent(dev);
 285         struct ata_pci_controller *ctlr = device_get_softc(parent);
 286         struct ata_channel *ch = device_get_softc(dev);
 287
 288         if ((ctlr->chip->cfg2 & VIABAR) && (ch->unit > 1)) {
 289             int piomode;
 290             u_int8_t pio_timings[] = { 0xa8, 0x65, 0x65, 0x32, 0x20 };
 291             u_int8_t dma_timings[] = { 0xee, 0xe8, 0xe6, 0xe4, 0xe2, 0xe1, 0xe0 };
 292
 293             /* This chip can't do WDMA. */
 294             if (mode >= ATA_WDMA0 && mode < ATA_UDMA0)
 295                 mode = ATA_PIO4;
 296             if (mode >= ATA_UDMA0) {
 297                 pci_write_config(parent, 0xb3,
 298                                  dma_timings[mode & ATA_MODE_MASK], 1);
 299                 piomode = ATA_PIO4;
 300             } else
 301                 piomode = mode;
 302             pci_write_config(parent, 0xab, pio_timings[ata_mode2idx(piomode)], 1);
 303         } else
 304                 mode = ata_sata_setmode(dev, target, mode);
 305         return (mode);
 306 }
 307
 308 static int
 309 ata_via_old_setmode(device_t dev, int target, int mode)
 310 {
 311         device_t parent = device_get_parent(dev);
 312         struct ata_pci_controller *ctlr = device_get_softc(parent);
 313         struct ata_channel *ch = device_get_softc(dev);
 314         int devno = (ch->unit << 1) + target;
 315         int reg = 0x53 - devno;
 316         int piomode;
 317         uint8_t timings[] = { 0xa8, 0x65, 0x42, 0x22, 0x20, 0xa8, 0x22, 0x20 };
 318         uint8_t 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
 324         mode = min(mode, ctlr->chip->max_dma);
 325         /* Set UDMA timings */
 326         if (mode >= ATA_UDMA0) {
 327             pci_write_config(parent, reg,
 328                              modes[ctlr->chip->cfg1][mode & ATA_MODE_MASK], 1);
 329             piomode = ATA_PIO4;
 330         } else {
 331             pci_write_config(parent, reg, 0x8b, 1);
 332             piomode = mode;
 333         }
 334         /* Set WDMA/PIO timings */
 335         if (ctlr->chip->cfg1 != VIA133)
 336             pci_write_config(parent, reg - 0x08,timings[ata_mode2idx(piomode)], 1);
 337         return (mode);
 338 }
 339
 340 static void
 341 ata_via_southbridge_fixup(device_t dev)
 342 {
 343     device_t *children;
 344     int nchildren, i;
 345
 346     if (device_get_children(device_get_parent(dev), &children, &nchildren))
 347         return;
 348
 349     for (i = 0; i < nchildren; i++) {
 350         if (pci_get_devid(children[i]) == ATA_VIA8363 ||
 351             pci_get_devid(children[i]) == ATA_VIA8371 ||
 352             pci_get_devid(children[i]) == ATA_VIA8662 ||
 353             pci_get_devid(children[i]) == ATA_VIA8361) {
 354             u_int8_t reg76 = pci_read_config(children[i], 0x76, 1);
 355
 356             if ((reg76 & 0xf0) != 0xd0) {
 357                 device_printf(dev,
 358                 "Correcting VIA config for southbridge data corruption bug\n");
 359                 pci_write_config(children[i], 0x75, 0x80, 1);
 360                 pci_write_config(children[i], 0x76, (reg76 & 0x0f) | 0xd0, 1);
 361             }
 362             break;
 363         }
 364     }
 365     free(children, M_TEMP);
 366 }
 367
 368 ATA_DECLARE_DRIVER(ata_via);
 369 MODULE_DEPEND(ata_via, ata_ahci, 1, 1, 1);