linux/drivers/ata/pata_atp867x.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * pata_atp867x.c - ARTOP 867X 64bit 4-channel UDMA133 ATA controller driver
   4 *
   5 *      (C) 2009 Google Inc. John(Jung-Ik) Lee <jilee@google.com>
   6 *
   7 * Per Atp867 data sheet rev 1.2, Acard.
   8 * Based in part on early ide code from
   9 *      2003-2004 by Eric Uhrhane, Google, Inc.
  10 *
  11 * TODO:
  12 *   1. RAID features [comparison, XOR, striping, mirroring, etc.]
  13 */
  14
  15#include <linux/kernel.h>
  16#include <linux/module.h>
  17#include <linux/pci.h>
  18#include <linux/blkdev.h>
  19#include <linux/delay.h>
  20#include <linux/device.h>
  21#include <linux/gfp.h>
  22#include <scsi/scsi_host.h>
  23#include <linux/libata.h>
  24
  25#define DRV_NAME        "pata_atp867x"
  26#define DRV_VERSION     "0.7.5"
  27
  28/*
  29 * IO Registers
  30 * Note that all runtime hot priv ports are cached in ap private_data
  31 */
  32
  33enum {
  34        ATP867X_IO_CHANNEL_OFFSET       = 0x10,
  35
  36        /*
  37         * IO Register Bitfields
  38         */
  39
  40        ATP867X_IO_PIOSPD_ACTIVE_SHIFT  = 4,
  41        ATP867X_IO_PIOSPD_RECOVER_SHIFT = 0,
  42
  43        ATP867X_IO_DMAMODE_MSTR_SHIFT   = 0,
  44        ATP867X_IO_DMAMODE_MSTR_MASK    = 0x07,
  45        ATP867X_IO_DMAMODE_SLAVE_SHIFT  = 4,
  46        ATP867X_IO_DMAMODE_SLAVE_MASK   = 0x70,
  47
  48        ATP867X_IO_DMAMODE_UDMA_6       = 0x07,
  49        ATP867X_IO_DMAMODE_UDMA_5       = 0x06,
  50        ATP867X_IO_DMAMODE_UDMA_4       = 0x05,
  51        ATP867X_IO_DMAMODE_UDMA_3       = 0x04,
  52        ATP867X_IO_DMAMODE_UDMA_2       = 0x03,
  53        ATP867X_IO_DMAMODE_UDMA_1       = 0x02,
  54        ATP867X_IO_DMAMODE_UDMA_0       = 0x01,
  55        ATP867X_IO_DMAMODE_DISABLE      = 0x00,
  56
  57        ATP867X_IO_SYS_INFO_66MHZ       = 0x04,
  58        ATP867X_IO_SYS_INFO_SLOW_UDMA5  = 0x02,
  59        ATP867X_IO_SYS_MASK_RESERVED    = (~0xf1),
  60
  61        ATP867X_IO_PORTSPD_VAL          = 0x1143,
  62        ATP867X_PREREAD_VAL             = 0x0200,
  63
  64        ATP867X_NUM_PORTS               = 4,
  65        ATP867X_BAR_IOBASE              = 0,
  66        ATP867X_BAR_ROMBASE             = 6,
  67};
  68
  69#define ATP867X_IOBASE(ap)              ((ap)->host->iomap[0])
  70#define ATP867X_SYS_INFO(ap)            (0x3F + ATP867X_IOBASE(ap))
  71
  72#define ATP867X_IO_PORTBASE(ap, port)   (0x00 + ATP867X_IOBASE(ap) + \
  73                                        (port) * ATP867X_IO_CHANNEL_OFFSET)
  74#define ATP867X_IO_DMABASE(ap, port)    (0x40 + \
  75                                        ATP867X_IO_PORTBASE((ap), (port)))
  76
  77#define ATP867X_IO_STATUS(ap, port)     (0x07 + \
  78                                        ATP867X_IO_PORTBASE((ap), (port)))
  79#define ATP867X_IO_ALTSTATUS(ap, port)  (0x0E + \
  80                                        ATP867X_IO_PORTBASE((ap), (port)))
  81
  82/*
  83 * hot priv ports
  84 */
  85#define ATP867X_IO_MSTRPIOSPD(ap, port) (0x08 + \
  86                                        ATP867X_IO_DMABASE((ap), (port)))
  87#define ATP867X_IO_SLAVPIOSPD(ap, port) (0x09 + \
  88                                        ATP867X_IO_DMABASE((ap), (port)))
  89#define ATP867X_IO_8BPIOSPD(ap, port)   (0x0A + \
  90                                        ATP867X_IO_DMABASE((ap), (port)))
  91#define ATP867X_IO_DMAMODE(ap, port)    (0x0B + \
  92                                        ATP867X_IO_DMABASE((ap), (port)))
  93
  94#define ATP867X_IO_PORTSPD(ap, port)    (0x4A + \
  95                                        ATP867X_IO_PORTBASE((ap), (port)))
  96#define ATP867X_IO_PREREAD(ap, port)    (0x4C + \
  97                                        ATP867X_IO_PORTBASE((ap), (port)))
  98
  99struct atp867x_priv {
 100        void __iomem *dma_mode;
 101        void __iomem *mstr_piospd;
 102        void __iomem *slave_piospd;
 103        void __iomem *eightb_piospd;
 104        int             pci66mhz;
 105};
 106
 107static void atp867x_set_dmamode(struct ata_port *ap, struct ata_device *adev)
 108{
 109        struct pci_dev *pdev    = to_pci_dev(ap->host->dev);
 110        struct atp867x_priv *dp = ap->private_data;
 111        u8 speed = adev->dma_mode;
 112        u8 b;
 113        u8 mode = speed - XFER_UDMA_0 + 1;
 114
 115        /*
 116         * Doc 6.6.9: decrease the udma mode value by 1 for safer UDMA speed
 117         * on 66MHz bus
 118         *   rev-A: UDMA_1~4 (5, 6 no change)
 119         *   rev-B: all UDMA modes
 120         *   UDMA_0 stays not to disable UDMA
 121         */
 122        if (dp->pci66mhz && mode > ATP867X_IO_DMAMODE_UDMA_0  &&
 123           (pdev->device == PCI_DEVICE_ID_ARTOP_ATP867B ||
 124            mode < ATP867X_IO_DMAMODE_UDMA_5))
 125                mode--;
 126
 127        b = ioread8(dp->dma_mode);
 128        if (adev->devno & 1) {
 129                b = (b & ~ATP867X_IO_DMAMODE_SLAVE_MASK) |
 130                        (mode << ATP867X_IO_DMAMODE_SLAVE_SHIFT);
 131        } else {
 132                b = (b & ~ATP867X_IO_DMAMODE_MSTR_MASK) |
 133                        (mode << ATP867X_IO_DMAMODE_MSTR_SHIFT);
 134        }
 135        iowrite8(b, dp->dma_mode);
 136}
 137
 138static int atp867x_get_active_clocks_shifted(struct ata_port *ap,
 139        unsigned int clk)
 140{
 141        struct atp867x_priv *dp = ap->private_data;
 142        unsigned char clocks = clk;
 143
 144        /*
 145         * Doc 6.6.9: increase the clock value by 1 for safer PIO speed
 146         * on 66MHz bus
 147         */
 148        if (dp->pci66mhz)
 149                clocks++;
 150
 151        switch (clocks) {
 152        case 0:
 153                clocks = 1;
 154                break;
 155        case 1 ... 6:
 156                break;
 157        default:
 158                printk(KERN_WARNING "ATP867X: active %dclk is invalid. "
 159                        "Using 12clk.\n", clk);
 160                fallthrough;
 161        case 9 ... 12:
 162                clocks = 7;     /* 12 clk */
 163                break;
 164        case 7:
 165        case 8: /* default 8 clk */
 166                clocks = 0;
 167                goto active_clock_shift_done;
 168        }
 169
 170active_clock_shift_done:
 171        return clocks << ATP867X_IO_PIOSPD_ACTIVE_SHIFT;
 172}
 173
 174static int atp867x_get_recover_clocks_shifted(unsigned int clk)
 175{
 176        unsigned char clocks = clk;
 177
 178        switch (clocks) {
 179        case 0:
 180                clocks = 1;
 181                break;
 182        case 1 ... 11:
 183                break;
 184        case 13:
 185        case 14:
 186                --clocks;       /* by the spec */
 187                break;
 188        case 15:
 189                break;
 190        default:
 191                printk(KERN_WARNING "ATP867X: recover %dclk is invalid. "
 192                        "Using default 12clk.\n", clk);
 193                fallthrough;
 194        case 12:        /* default 12 clk */
 195                clocks = 0;
 196                break;
 197        }
 198
 199        return clocks << ATP867X_IO_PIOSPD_RECOVER_SHIFT;
 200}
 201
 202static void atp867x_set_piomode(struct ata_port *ap, struct ata_device *adev)
 203{
 204        struct ata_device *peer = ata_dev_pair(adev);
 205        struct atp867x_priv *dp = ap->private_data;
 206        u8 speed = adev->pio_mode;
 207        struct ata_timing t, p;
 208        int T, UT;
 209        u8 b;
 210
 211        T = 1000000000 / 33333;
 212        UT = T / 4;
 213
 214        ata_timing_compute(adev, speed, &t, T, UT);
 215        if (peer && peer->pio_mode) {
 216                ata_timing_compute(peer, peer->pio_mode, &p, T, UT);
 217                ata_timing_merge(&p, &t, &t, ATA_TIMING_8BIT);
 218        }
 219
 220        b = ioread8(dp->dma_mode);
 221        if (adev->devno & 1)
 222                b = (b & ~ATP867X_IO_DMAMODE_SLAVE_MASK);
 223        else
 224                b = (b & ~ATP867X_IO_DMAMODE_MSTR_MASK);
 225        iowrite8(b, dp->dma_mode);
 226
 227        b = atp867x_get_active_clocks_shifted(ap, t.active) |
 228            atp867x_get_recover_clocks_shifted(t.recover);
 229
 230        if (adev->devno & 1)
 231                iowrite8(b, dp->slave_piospd);
 232        else
 233                iowrite8(b, dp->mstr_piospd);
 234
 235        b = atp867x_get_active_clocks_shifted(ap, t.act8b) |
 236            atp867x_get_recover_clocks_shifted(t.rec8b);
 237
 238        iowrite8(b, dp->eightb_piospd);
 239}
 240
 241static int atp867x_cable_override(struct pci_dev *pdev)
 242{
 243        if (pdev->subsystem_vendor == PCI_VENDOR_ID_ARTOP &&
 244                (pdev->subsystem_device == PCI_DEVICE_ID_ARTOP_ATP867A ||
 245                 pdev->subsystem_device == PCI_DEVICE_ID_ARTOP_ATP867B)) {
 246                return 1;
 247        }
 248        return 0;
 249}
 250
 251static int atp867x_cable_detect(struct ata_port *ap)
 252{
 253        struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 254
 255        if (atp867x_cable_override(pdev))
 256                return ATA_CBL_PATA40_SHORT;
 257
 258        return ATA_CBL_PATA_UNK;
 259}
 260
 261static struct scsi_host_template atp867x_sht = {
 262        ATA_BMDMA_SHT(DRV_NAME),
 263};
 264
 265static struct ata_port_operations atp867x_ops = {
 266        .inherits               = &ata_bmdma_port_ops,
 267        .cable_detect           = atp867x_cable_detect,
 268        .set_piomode            = atp867x_set_piomode,
 269        .set_dmamode            = atp867x_set_dmamode,
 270};
 271
 272
 273#ifdef  ATP867X_DEBUG
 274static void atp867x_check_res(struct pci_dev *pdev)
 275{
 276        int i;
 277        unsigned long start, len;
 278
 279        /* Check the PCI resources for this channel are enabled */
 280        for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
 281                start = pci_resource_start(pdev, i);
 282                len   = pci_resource_len(pdev, i);
 283                printk(KERN_DEBUG "ATP867X: resource start:len=%lx:%lx\n",
 284                        start, len);
 285        }
 286}
 287
 288static void atp867x_check_ports(struct ata_port *ap, int port)
 289{
 290        struct ata_ioports *ioaddr = &ap->ioaddr;
 291        struct atp867x_priv *dp = ap->private_data;
 292
 293        printk(KERN_DEBUG "ATP867X: port[%d] addresses\n"
 294                "  cmd_addr     =0x%llx, 0x%llx\n"
 295                "  ctl_addr     =0x%llx, 0x%llx\n"
 296                "  bmdma_addr   =0x%llx, 0x%llx\n"
 297                "  data_addr    =0x%llx\n"
 298                "  error_addr   =0x%llx\n"
 299                "  feature_addr =0x%llx\n"
 300                "  nsect_addr   =0x%llx\n"
 301                "  lbal_addr    =0x%llx\n"
 302                "  lbam_addr    =0x%llx\n"
 303                "  lbah_addr    =0x%llx\n"
 304                "  device_addr  =0x%llx\n"
 305                "  status_addr  =0x%llx\n"
 306                "  command_addr =0x%llx\n"
 307                "  dp->dma_mode =0x%llx\n"
 308                "  dp->mstr_piospd      =0x%llx\n"
 309                "  dp->slave_piospd     =0x%llx\n"
 310                "  dp->eightb_piospd    =0x%llx\n"
 311                "  dp->pci66mhz         =0x%lx\n",
 312                port,
 313                (unsigned long long)ioaddr->cmd_addr,
 314                (unsigned long long)ATP867X_IO_PORTBASE(ap, port),
 315                (unsigned long long)ioaddr->ctl_addr,
 316                (unsigned long long)ATP867X_IO_ALTSTATUS(ap, port),
 317                (unsigned long long)ioaddr->bmdma_addr,
 318                (unsigned long long)ATP867X_IO_DMABASE(ap, port),
 319                (unsigned long long)ioaddr->data_addr,
 320                (unsigned long long)ioaddr->error_addr,
 321                (unsigned long long)ioaddr->feature_addr,
 322                (unsigned long long)ioaddr->nsect_addr,
 323                (unsigned long long)ioaddr->lbal_addr,
 324                (unsigned long long)ioaddr->lbam_addr,
 325                (unsigned long long)ioaddr->lbah_addr,
 326                (unsigned long long)ioaddr->device_addr,
 327                (unsigned long long)ioaddr->status_addr,
 328                (unsigned long long)ioaddr->command_addr,
 329                (unsigned long long)dp->dma_mode,
 330                (unsigned long long)dp->mstr_piospd,
 331                (unsigned long long)dp->slave_piospd,
 332                (unsigned long long)dp->eightb_piospd,
 333                (unsigned long)dp->pci66mhz);
 334}
 335#endif
 336
 337static int atp867x_set_priv(struct ata_port *ap)
 338{
 339        struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 340        struct atp867x_priv *dp;
 341        int port = ap->port_no;
 342
 343        dp = ap->private_data =
 344                devm_kzalloc(&pdev->dev, sizeof(*dp), GFP_KERNEL);
 345        if (dp == NULL)
 346                return -ENOMEM;
 347
 348        dp->dma_mode     = ATP867X_IO_DMAMODE(ap, port);
 349        dp->mstr_piospd  = ATP867X_IO_MSTRPIOSPD(ap, port);
 350        dp->slave_piospd = ATP867X_IO_SLAVPIOSPD(ap, port);
 351        dp->eightb_piospd = ATP867X_IO_8BPIOSPD(ap, port);
 352
 353        dp->pci66mhz =
 354                ioread8(ATP867X_SYS_INFO(ap)) & ATP867X_IO_SYS_INFO_66MHZ;
 355
 356        return 0;
 357}
 358
 359static void atp867x_fixup(struct ata_host *host)
 360{
 361        struct pci_dev *pdev = to_pci_dev(host->dev);
 362        struct ata_port *ap = host->ports[0];
 363        int i;
 364        u8 v;
 365
 366        /*
 367         * Broken BIOS might not set latency high enough
 368         */
 369        pci_read_config_byte(pdev, PCI_LATENCY_TIMER, &v);
 370        if (v < 0x80) {
 371                v = 0x80;
 372                pci_write_config_byte(pdev, PCI_LATENCY_TIMER, v);
 373                printk(KERN_DEBUG "ATP867X: set latency timer of device %s"
 374                        " to %d\n", pci_name(pdev), v);
 375        }
 376
 377        /*
 378         * init 8bit io ports speed(0aaarrrr) to 43h and
 379         * init udma modes of master/slave to 0/0(11h)
 380         */
 381        for (i = 0; i < ATP867X_NUM_PORTS; i++)
 382                iowrite16(ATP867X_IO_PORTSPD_VAL, ATP867X_IO_PORTSPD(ap, i));
 383
 384        /*
 385         * init PreREAD counts
 386         */
 387        for (i = 0; i < ATP867X_NUM_PORTS; i++)
 388                iowrite16(ATP867X_PREREAD_VAL, ATP867X_IO_PREREAD(ap, i));
 389
 390        v = ioread8(ATP867X_IOBASE(ap) + 0x28);
 391        v &= 0xcf;      /* Enable INTA#: bit4=0 means enable */
 392        v |= 0xc0;      /* Enable PCI burst, MRM & not immediate interrupts */
 393        iowrite8(v, ATP867X_IOBASE(ap) + 0x28);
 394
 395        /*
 396         * Turn off the over clocked udma5 mode, only for Rev-B
 397         */
 398        v = ioread8(ATP867X_SYS_INFO(ap));
 399        v &= ATP867X_IO_SYS_MASK_RESERVED;
 400        if (pdev->device == PCI_DEVICE_ID_ARTOP_ATP867B)
 401                v |= ATP867X_IO_SYS_INFO_SLOW_UDMA5;
 402        iowrite8(v, ATP867X_SYS_INFO(ap));
 403}
 404
 405static int atp867x_ata_pci_sff_init_host(struct ata_host *host)
 406{
 407        struct device *gdev = host->dev;
 408        struct pci_dev *pdev = to_pci_dev(gdev);
 409        unsigned int mask = 0;
 410        int i, rc;
 411
 412        /*
 413         * do not map rombase
 414         */
 415        rc = pcim_iomap_regions(pdev, 1 << ATP867X_BAR_IOBASE, DRV_NAME);
 416        if (rc == -EBUSY)
 417                pcim_pin_device(pdev);
 418        if (rc)
 419                return rc;
 420        host->iomap = pcim_iomap_table(pdev);
 421
 422#ifdef  ATP867X_DEBUG
 423        atp867x_check_res(pdev);
 424
 425        for (i = 0; i < PCI_STD_NUM_BARS; i++)
 426                printk(KERN_DEBUG "ATP867X: iomap[%d]=0x%llx\n", i,
 427                        (unsigned long long)(host->iomap[i]));
 428#endif
 429
 430        /*
 431         * request, iomap BARs and init port addresses accordingly
 432         */
 433        for (i = 0; i < host->n_ports; i++) {
 434                struct ata_port *ap = host->ports[i];
 435                struct ata_ioports *ioaddr = &ap->ioaddr;
 436
 437                ioaddr->cmd_addr = ATP867X_IO_PORTBASE(ap, i);
 438                ioaddr->ctl_addr = ioaddr->altstatus_addr
 439                                 = ATP867X_IO_ALTSTATUS(ap, i);
 440                ioaddr->bmdma_addr = ATP867X_IO_DMABASE(ap, i);
 441
 442                ata_sff_std_ports(ioaddr);
 443                rc = atp867x_set_priv(ap);
 444                if (rc)
 445                        return rc;
 446
 447#ifdef  ATP867X_DEBUG
 448                atp867x_check_ports(ap, i);
 449#endif
 450                ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx",
 451                        (unsigned long)ioaddr->cmd_addr,
 452                        (unsigned long)ioaddr->ctl_addr);
 453                ata_port_desc(ap, "bmdma 0x%lx",
 454                        (unsigned long)ioaddr->bmdma_addr);
 455
 456                mask |= 1 << i;
 457        }
 458
 459        if (!mask) {
 460                dev_err(gdev, "no available native port\n");
 461                return -ENODEV;
 462        }
 463
 464        atp867x_fixup(host);
 465
 466        return dma_set_mask_and_coherent(&pdev->dev, ATA_DMA_MASK);
 467}
 468
 469static int atp867x_init_one(struct pci_dev *pdev,
 470        const struct pci_device_id *id)
 471{
 472        static const struct ata_port_info info_867x = {
 473                .flags          = ATA_FLAG_SLAVE_POSS,
 474                .pio_mask       = ATA_PIO4,
 475                .udma_mask      = ATA_UDMA6,
 476                .port_ops       = &atp867x_ops,
 477        };
 478
 479        struct ata_host *host;
 480        const struct ata_port_info *ppi[] = { &info_867x, NULL };
 481        int rc;
 482
 483        ata_print_version_once(&pdev->dev, DRV_VERSION);
 484
 485        rc = pcim_enable_device(pdev);
 486        if (rc)
 487                return rc;
 488
 489        printk(KERN_INFO "ATP867X: ATP867 ATA UDMA133 controller (rev %02X)",
 490                pdev->device);
 491
 492        host = ata_host_alloc_pinfo(&pdev->dev, ppi, ATP867X_NUM_PORTS);
 493        if (!host) {
 494                dev_err(&pdev->dev, "failed to allocate ATA host\n");
 495                rc = -ENOMEM;
 496                goto err_out;
 497        }
 498
 499        rc = atp867x_ata_pci_sff_init_host(host);
 500        if (rc) {
 501                dev_err(&pdev->dev, "failed to init host\n");
 502                goto err_out;
 503        }
 504
 505        pci_set_master(pdev);
 506
 507        rc = ata_host_activate(host, pdev->irq, ata_bmdma_interrupt,
 508                                IRQF_SHARED, &atp867x_sht);
 509        if (rc)
 510                dev_err(&pdev->dev, "failed to activate host\n");
 511
 512err_out:
 513        return rc;
 514}
 515
 516#ifdef CONFIG_PM_SLEEP
 517static int atp867x_reinit_one(struct pci_dev *pdev)
 518{
 519        struct ata_host *host = pci_get_drvdata(pdev);
 520        int rc;
 521
 522        rc = ata_pci_device_do_resume(pdev);
 523        if (rc)
 524                return rc;
 525
 526        atp867x_fixup(host);
 527
 528        ata_host_resume(host);
 529        return 0;
 530}
 531#endif
 532
 533static struct pci_device_id atp867x_pci_tbl[] = {
 534        { PCI_VDEVICE(ARTOP, PCI_DEVICE_ID_ARTOP_ATP867A),      0 },
 535        { PCI_VDEVICE(ARTOP, PCI_DEVICE_ID_ARTOP_ATP867B),      0 },
 536        { },
 537};
 538
 539static struct pci_driver atp867x_driver = {
 540        .name           = DRV_NAME,
 541        .id_table       = atp867x_pci_tbl,
 542        .probe          = atp867x_init_one,
 543        .remove         = ata_pci_remove_one,
 544#ifdef CONFIG_PM_SLEEP
 545        .suspend        = ata_pci_device_suspend,
 546        .resume         = atp867x_reinit_one,
 547#endif
 548};
 549
 550module_pci_driver(atp867x_driver);
 551
 552MODULE_AUTHOR("John(Jung-Ik) Lee, Google Inc.");
 553MODULE_DESCRIPTION("low level driver for Artop/Acard 867x ATA controller");
 554MODULE_LICENSE("GPL");
 555MODULE_DEVICE_TABLE(pci, atp867x_pci_tbl);
 556MODULE_VERSION(DRV_VERSION);
 557