drivers/ata/ahci_sunxi.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Allwinner sunxi AHCI SATA platform driver
   4  * Copyright 2013 Olliver Schinagl <oliver@schinagl.nl>
   5  * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
   6  *
   7  * based on the AHCI SATA platform driver by Jeff Garzik and Anton Vorontsov
   8  * Based on code from Allwinner Technology Co., Ltd. <www.allwinnertech.com>,
   9  * Daniel Wang <danielwang@allwinnertech.com>
  10  */
  11
  12 #include <linux/ahci_platform.h>
  13 #include <linux/clk.h>
  14 #include <linux/errno.h>
  15 #include <linux/kernel.h>
  16 #include <linux/module.h>
  17 #include <linux/of_device.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/regulator/consumer.h>
  20 #include "ahci.h"
  21
  22 #define DRV_NAME "ahci-sunxi"
  23
  24 /* Insmod parameters */
  25 static bool enable_pmp;
  26 module_param(enable_pmp, bool, 0);
  27 MODULE_PARM_DESC(enable_pmp,
  28         "Enable support for sata port multipliers, only use if you use a pmp!");
  29
  30 #define AHCI_BISTAFR    0x00a0
  31 #define AHCI_BISTCR     0x00a4
  32 #define AHCI_BISTFCTR   0x00a8
  33 #define AHCI_BISTSR     0x00ac
  34 #define AHCI_BISTDECR   0x00b0
  35 #define AHCI_DIAGNR0    0x00b4
  36 #define AHCI_DIAGNR1    0x00b8
  37 #define AHCI_OOBR       0x00bc
  38 #define AHCI_PHYCS0R    0x00c0
  39 #define AHCI_PHYCS1R    0x00c4
  40 #define AHCI_PHYCS2R    0x00c8
  41 #define AHCI_TIMER1MS   0x00e0
  42 #define AHCI_GPARAM1R   0x00e8
  43 #define AHCI_GPARAM2R   0x00ec
  44 #define AHCI_PPARAMR    0x00f0
  45 #define AHCI_TESTR      0x00f4
  46 #define AHCI_VERSIONR   0x00f8
  47 #define AHCI_IDR        0x00fc
  48 #define AHCI_RWCR       0x00fc
  49 #define AHCI_P0DMACR    0x0170
  50 #define AHCI_P0PHYCR    0x0178
  51 #define AHCI_P0PHYSR    0x017c
  52
  53 static void sunxi_clrbits(void __iomem *reg, u32 clr_val)
  54 {
  55         u32 reg_val;
  56
  57         reg_val = readl(reg);
  58         reg_val &= ~(clr_val);
  59         writel(reg_val, reg);
  60 }
  61
  62 static void sunxi_setbits(void __iomem *reg, u32 set_val)
  63 {
  64         u32 reg_val;
  65
  66         reg_val = readl(reg);
  67         reg_val |= set_val;
  68         writel(reg_val, reg);
  69 }
  70
  71 static void sunxi_clrsetbits(void __iomem *reg, u32 clr_val, u32 set_val)
  72 {
  73         u32 reg_val;
  74
  75         reg_val = readl(reg);
  76         reg_val &= ~(clr_val);
  77         reg_val |= set_val;
  78         writel(reg_val, reg);
  79 }
  80
  81 static u32 sunxi_getbits(void __iomem *reg, u8 mask, u8 shift)
  82 {
  83         return (readl(reg) >> shift) & mask;
  84 }
  85
  86 static int ahci_sunxi_phy_init(struct device *dev, void __iomem *reg_base)
  87 {
  88         u32 reg_val;
  89         int timeout;
  90
  91         /* This magic is from the original code */
  92         writel(0, reg_base + AHCI_RWCR);
  93         msleep(5);
  94
  95         sunxi_setbits(reg_base + AHCI_PHYCS1R, BIT(19));
  96         sunxi_clrsetbits(reg_base + AHCI_PHYCS0R,
  97                          (0x7 << 24),
  98                          (0x5 << 24) | BIT(23) | BIT(18));
  99         sunxi_clrsetbits(reg_base + AHCI_PHYCS1R,
 100                          (0x3 << 16) | (0x1f << 8) | (0x3 << 6),
 101                          (0x2 << 16) | (0x6 << 8) | (0x2 << 6));
 102         sunxi_setbits(reg_base + AHCI_PHYCS1R, BIT(28) | BIT(15));
 103         sunxi_clrbits(reg_base + AHCI_PHYCS1R, BIT(19));
 104         sunxi_clrsetbits(reg_base + AHCI_PHYCS0R,
 105                          (0x7 << 20), (0x3 << 20));
 106         sunxi_clrsetbits(reg_base + AHCI_PHYCS2R,
 107                          (0x1f << 5), (0x19 << 5));
 108         msleep(5);
 109
 110         sunxi_setbits(reg_base + AHCI_PHYCS0R, (0x1 << 19));
 111
 112         timeout = 250; /* Power up takes aprox 50 us */
 113         do {
 114                 reg_val = sunxi_getbits(reg_base + AHCI_PHYCS0R, 0x7, 28);
 115                 if (reg_val == 0x02)
 116                         break;
 117
 118                 if (--timeout == 0) {
 119                         dev_err(dev, "PHY power up failed.\n");
 120                         return -EIO;
 121                 }
 122                 udelay(1);
 123         } while (1);
 124
 125         sunxi_setbits(reg_base + AHCI_PHYCS2R, (0x1 << 24));
 126
 127         timeout = 100; /* Calibration takes aprox 10 us */
 128         do {
 129                 reg_val = sunxi_getbits(reg_base + AHCI_PHYCS2R, 0x1, 24);
 130                 if (reg_val == 0x00)
 131                         break;
 132
 133                 if (--timeout == 0) {
 134                         dev_err(dev, "PHY calibration failed.\n");
 135                         return -EIO;
 136                 }
 137                 udelay(1);
 138         } while (1);
 139
 140         msleep(15);
 141
 142         writel(0x7, reg_base + AHCI_RWCR);
 143
 144         return 0;
 145 }
 146
 147 static void ahci_sunxi_start_engine(struct ata_port *ap)
 148 {
 149         void __iomem *port_mmio = ahci_port_base(ap);
 150         struct ahci_host_priv *hpriv = ap->host->private_data;
 151
 152         /* Setup DMA before DMA start */
 153         sunxi_clrsetbits(hpriv->mmio + AHCI_P0DMACR, 0x0000ff00, 0x00004400);
 154
 155         /* Start DMA */
 156         sunxi_setbits(port_mmio + PORT_CMD, PORT_CMD_START);
 157 }
 158
 159 static const struct ata_port_info ahci_sunxi_port_info = {
 160         .flags          = AHCI_FLAG_COMMON | ATA_FLAG_NCQ,
 161         .pio_mask       = ATA_PIO4,
 162         .udma_mask      = ATA_UDMA6,
 163         .port_ops       = &ahci_platform_ops,
 164 };
 165
 166 static struct scsi_host_template ahci_platform_sht = {
 167         AHCI_SHT(DRV_NAME),
 168 };
 169
 170 static int ahci_sunxi_probe(struct platform_device *pdev)
 171 {
 172         struct device *dev = &pdev->dev;
 173         struct ahci_host_priv *hpriv;
 174         int rc;
 175
 176         hpriv = ahci_platform_get_resources(pdev, AHCI_PLATFORM_GET_RESETS);
 177         if (IS_ERR(hpriv))
 178                 return PTR_ERR(hpriv);
 179
 180         hpriv->start_engine = ahci_sunxi_start_engine;
 181
 182         rc = ahci_platform_enable_resources(hpriv);
 183         if (rc)
 184                 return rc;
 185
 186         rc = ahci_sunxi_phy_init(dev, hpriv->mmio);
 187         if (rc)
 188                 goto disable_resources;
 189
 190         hpriv->flags = AHCI_HFLAG_32BIT_ONLY | AHCI_HFLAG_NO_MSI |
 191                        AHCI_HFLAG_YES_NCQ;
 192
 193         /*
 194          * The sunxi sata controller seems to be unable to successfully do a
 195          * soft reset if no pmp is attached, so disable pmp use unless
 196          * requested, otherwise directly attached disks do not work.
 197          */
 198         if (!enable_pmp)
 199                 hpriv->flags |= AHCI_HFLAG_NO_PMP;
 200
 201         rc = ahci_platform_init_host(pdev, hpriv, &ahci_sunxi_port_info,
 202                                      &ahci_platform_sht);
 203         if (rc)
 204                 goto disable_resources;
 205
 206         return 0;
 207
 208 disable_resources:
 209         ahci_platform_disable_resources(hpriv);
 210         return rc;
 211 }
 212
 213 #ifdef CONFIG_PM_SLEEP
 214 static int ahci_sunxi_resume(struct device *dev)
 215 {
 216         struct ata_host *host = dev_get_drvdata(dev);
 217         struct ahci_host_priv *hpriv = host->private_data;
 218         int rc;
 219
 220         rc = ahci_platform_enable_resources(hpriv);
 221         if (rc)
 222                 return rc;
 223
 224         rc = ahci_sunxi_phy_init(dev, hpriv->mmio);
 225         if (rc)
 226                 goto disable_resources;
 227
 228         rc = ahci_platform_resume_host(dev);
 229         if (rc)
 230                 goto disable_resources;
 231
 232         return 0;
 233
 234 disable_resources:
 235         ahci_platform_disable_resources(hpriv);
 236         return rc;
 237 }
 238 #endif
 239
 240 static SIMPLE_DEV_PM_OPS(ahci_sunxi_pm_ops, ahci_platform_suspend,
 241                          ahci_sunxi_resume);
 242
 243 static const struct of_device_id ahci_sunxi_of_match[] = {
 244         { .compatible = "allwinner,sun4i-a10-ahci", },
 245         { .compatible = "allwinner,sun8i-r40-ahci", },
 246         { },
 247 };
 248 MODULE_DEVICE_TABLE(of, ahci_sunxi_of_match);
 249
 250 static struct platform_driver ahci_sunxi_driver = {
 251         .probe = ahci_sunxi_probe,
 252         .remove = ata_platform_remove_one,
 253         .driver = {
 254                 .name = DRV_NAME,
 255                 .of_match_table = ahci_sunxi_of_match,
 256                 .pm = &ahci_sunxi_pm_ops,
 257         },
 258 };
 259 module_platform_driver(ahci_sunxi_driver);
 260
 261 MODULE_DESCRIPTION("Allwinner sunxi AHCI SATA driver");
 262 MODULE_AUTHOR("Olliver Schinagl <oliver@schinagl.nl>");
 263 MODULE_LICENSE("GPL");