drivers/mmc/host/sdhci-of-arasan.c

   1 /*
   2  * Arasan Secure Digital Host Controller Interface.
   3  * Copyright (C) 2011 - 2012 Michal Simek <monstr@monstr.eu>
   4  * Copyright (c) 2012 Wind River Systems, Inc.
   5  * Copyright (C) 2013 Pengutronix e.K.
   6  * Copyright (C) 2013 Xilinx Inc.
   7  *
   8  * Based on sdhci-of-esdhc.c
   9  *
  10  * Copyright (c) 2007 Freescale Semiconductor, Inc.
  11  * Copyright (c) 2009 MontaVista Software, Inc.
  12  *
  13  * Authors: Xiaobo Xie <X.Xie@freescale.com>
  14  *          Anton Vorontsov <avorontsov@ru.mvista.com>
  15  *
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 2 of the License, or (at
  19  * your option) any later version.
  20  */
  21
  22 #include <linux/module.h>
  23 #include <linux/of_device.h>
  24 #include <linux/phy/phy.h>
  25 #include "sdhci-pltfm.h"
  26
  27 #define SDHCI_ARASAN_CLK_CTRL_OFFSET    0x2c
  28
  29 #define CLK_CTRL_TIMEOUT_SHIFT          16
  30 #define CLK_CTRL_TIMEOUT_MASK           (0xf << CLK_CTRL_TIMEOUT_SHIFT)
  31 #define CLK_CTRL_TIMEOUT_MIN_EXP        13
  32
  33 /**
  34  * struct sdhci_arasan_data
  35  * @clk_ahb:    Pointer to the AHB clock
  36  * @phy: Pointer to the generic phy
  37  */
  38 struct sdhci_arasan_data {
  39         struct clk      *clk_ahb;
  40         struct phy      *phy;
  41 };
  42
  43 static unsigned int sdhci_arasan_get_timeout_clock(struct sdhci_host *host)
  44 {
  45         u32 div;
  46         unsigned long freq;
  47         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
  48
  49         div = readl(host->ioaddr + SDHCI_ARASAN_CLK_CTRL_OFFSET);
  50         div = (div & CLK_CTRL_TIMEOUT_MASK) >> CLK_CTRL_TIMEOUT_SHIFT;
  51
  52         freq = clk_get_rate(pltfm_host->clk);
  53         freq /= 1 << (CLK_CTRL_TIMEOUT_MIN_EXP + div);
  54
  55         return freq;
  56 }
  57
  58 static void sdhci_arasan_set_clock(struct sdhci_host *host, unsigned int clock)
  59 {
  60         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
  61         struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
  62         bool ctrl_phy = false;
  63
  64         if (clock > MMC_HIGH_52_MAX_DTR && (!IS_ERR(sdhci_arasan->phy)))
  65                 ctrl_phy = true;
  66
  67         if (ctrl_phy)
  68                 phy_power_off(sdhci_arasan->phy);
  69
  70         sdhci_set_clock(host, clock);
  71
  72         if (ctrl_phy)
  73                 phy_power_on(sdhci_arasan->phy);
  74 }
  75
  76 static struct sdhci_ops sdhci_arasan_ops = {
  77         .set_clock = sdhci_arasan_set_clock,
  78         .get_max_clock = sdhci_pltfm_clk_get_max_clock,
  79         .get_timeout_clock = sdhci_arasan_get_timeout_clock,
  80         .set_bus_width = sdhci_set_bus_width,
  81         .reset = sdhci_reset,
  82         .set_uhs_signaling = sdhci_set_uhs_signaling,
  83 };
  84
  85 static struct sdhci_pltfm_data sdhci_arasan_pdata = {
  86         .ops = &sdhci_arasan_ops,
  87         .quirks = SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN,
  88         .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN |
  89                         SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN,
  90 };
  91
  92 #ifdef CONFIG_PM_SLEEP
  93 /**
  94  * sdhci_arasan_suspend - Suspend method for the driver
  95  * @dev:        Address of the device structure
  96  * Return: 0 on success and error value on error
  97  *
  98  * Put the device in a low power state.
  99  */
 100 static int sdhci_arasan_suspend(struct device *dev)
 101 {
 102         struct platform_device *pdev = to_platform_device(dev);
 103         struct sdhci_host *host = platform_get_drvdata(pdev);
 104         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
 105         struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
 106         int ret;
 107
 108         ret = sdhci_suspend_host(host);
 109         if (ret)
 110                 return ret;
 111
 112         if (!IS_ERR(sdhci_arasan->phy)) {
 113                 ret = phy_power_off(sdhci_arasan->phy);
 114                 if (ret) {
 115                         dev_err(dev, "Cannot power off phy.\n");
 116                         sdhci_resume_host(host);
 117                         return ret;
 118                 }
 119         }
 120
 121         clk_disable(pltfm_host->clk);
 122         clk_disable(sdhci_arasan->clk_ahb);
 123
 124         return 0;
 125 }
 126
 127 /**
 128  * sdhci_arasan_resume - Resume method for the driver
 129  * @dev:        Address of the device structure
 130  * Return: 0 on success and error value on error
 131  *
 132  * Resume operation after suspend
 133  */
 134 static int sdhci_arasan_resume(struct device *dev)
 135 {
 136         struct platform_device *pdev = to_platform_device(dev);
 137         struct sdhci_host *host = platform_get_drvdata(pdev);
 138         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
 139         struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
 140         int ret;
 141
 142         ret = clk_enable(sdhci_arasan->clk_ahb);
 143         if (ret) {
 144                 dev_err(dev, "Cannot enable AHB clock.\n");
 145                 return ret;
 146         }
 147
 148         ret = clk_enable(pltfm_host->clk);
 149         if (ret) {
 150                 dev_err(dev, "Cannot enable SD clock.\n");
 151                 return ret;
 152         }
 153
 154         if (!IS_ERR(sdhci_arasan->phy)) {
 155                 ret = phy_power_on(sdhci_arasan->phy);
 156                 if (ret) {
 157                         dev_err(dev, "Cannot power on phy.\n");
 158                         return ret;
 159                 }
 160         }
 161
 162         return sdhci_resume_host(host);
 163 }
 164 #endif /* ! CONFIG_PM_SLEEP */
 165
 166 static SIMPLE_DEV_PM_OPS(sdhci_arasan_dev_pm_ops, sdhci_arasan_suspend,
 167                          sdhci_arasan_resume);
 168
 169 static int sdhci_arasan_probe(struct platform_device *pdev)
 170 {
 171         int ret;
 172         struct clk *clk_xin;
 173         struct sdhci_host *host;
 174         struct sdhci_pltfm_host *pltfm_host;
 175         struct sdhci_arasan_data *sdhci_arasan;
 176
 177         sdhci_arasan = devm_kzalloc(&pdev->dev, sizeof(*sdhci_arasan),
 178                         GFP_KERNEL);
 179         if (!sdhci_arasan)
 180                 return -ENOMEM;
 181
 182         sdhci_arasan->clk_ahb = devm_clk_get(&pdev->dev, "clk_ahb");
 183         if (IS_ERR(sdhci_arasan->clk_ahb)) {
 184                 dev_err(&pdev->dev, "clk_ahb clock not found.\n");
 185                 ret = PTR_ERR(sdhci_arasan->clk_ahb);
 186                 goto err_pltfm_free;
 187         }
 188
 189         clk_xin = devm_clk_get(&pdev->dev, "clk_xin");
 190         if (IS_ERR(clk_xin)) {
 191                 dev_err(&pdev->dev, "clk_xin clock not found.\n");
 192                 ret = PTR_ERR(clk_xin);
 193                 goto err_pltfm_free;
 194         }
 195
 196         ret = clk_prepare_enable(sdhci_arasan->clk_ahb);
 197         if (ret) {
 198                 dev_err(&pdev->dev, "Unable to enable AHB clock.\n");
 199                 goto err_pltfm_free;
 200         }
 201
 202         ret = clk_prepare_enable(clk_xin);
 203         if (ret) {
 204                 dev_err(&pdev->dev, "Unable to enable SD clock.\n");
 205                 goto clk_dis_ahb;
 206         }
 207
 208         host = sdhci_pltfm_init(pdev, &sdhci_arasan_pdata, 0);
 209         if (IS_ERR(host)) {
 210                 ret = PTR_ERR(host);
 211                 goto clk_disable_all;
 212         }
 213
 214         if (of_device_is_compatible(pdev->dev.of_node, "arasan,sdhci-4.9a")) {
 215                 host->quirks |= SDHCI_QUIRK_NO_HISPD_BIT;
 216                 host->quirks2 |= SDHCI_QUIRK2_HOST_NO_CMD23;
 217         }
 218
 219         sdhci_get_of_property(pdev);
 220         pltfm_host = sdhci_priv(host);
 221         pltfm_host->priv = sdhci_arasan;
 222         pltfm_host->clk = clk_xin;
 223
 224         ret = mmc_of_parse(host->mmc);
 225         if (ret) {
 226                 dev_err(&pdev->dev, "parsing dt failed (%u)\n", ret);
 227                 goto clk_disable_all;
 228         }
 229
 230         sdhci_arasan->phy = ERR_PTR(-ENODEV);
 231         if (of_device_is_compatible(pdev->dev.of_node,
 232                                     "arasan,sdhci-5.1")) {
 233                 sdhci_arasan->phy = devm_phy_get(&pdev->dev,
 234                                                  "phy_arasan");
 235                 if (IS_ERR(sdhci_arasan->phy)) {
 236                         ret = PTR_ERR(sdhci_arasan->phy);
 237                         dev_err(&pdev->dev, "No phy for arasan,sdhci-5.1.\n");
 238                         goto clk_disable_all;
 239                 }
 240
 241                 ret = phy_init(sdhci_arasan->phy);
 242                 if (ret < 0) {
 243                         dev_err(&pdev->dev, "phy_init err.\n");
 244                         goto clk_disable_all;
 245                 }
 246
 247                 ret = phy_power_on(sdhci_arasan->phy);
 248                 if (ret < 0) {
 249                         dev_err(&pdev->dev, "phy_power_on err.\n");
 250                         goto err_phy_power;
 251                 }
 252         }
 253
 254         ret = sdhci_add_host(host);
 255         if (ret)
 256                 goto err_add_host;
 257
 258         return 0;
 259
 260 err_add_host:
 261         if (!IS_ERR(sdhci_arasan->phy))
 262                 phy_power_off(sdhci_arasan->phy);
 263 err_phy_power:
 264         if (!IS_ERR(sdhci_arasan->phy))
 265                 phy_exit(sdhci_arasan->phy);
 266 clk_disable_all:
 267         clk_disable_unprepare(clk_xin);
 268 clk_dis_ahb:
 269         clk_disable_unprepare(sdhci_arasan->clk_ahb);
 270 err_pltfm_free:
 271         sdhci_pltfm_free(pdev);
 272         return ret;
 273 }
 274
 275 static int sdhci_arasan_remove(struct platform_device *pdev)
 276 {
 277         int ret;
 278         struct sdhci_host *host = platform_get_drvdata(pdev);
 279         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
 280         struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
 281
 282         if (!IS_ERR(sdhci_arasan->phy)) {
 283                 phy_power_off(sdhci_arasan->phy);
 284                 phy_exit(sdhci_arasan->phy);
 285         }
 286
 287         ret = sdhci_pltfm_unregister(pdev);
 288
 289         clk_disable_unprepare(sdhci_arasan->clk_ahb);
 290
 291         return ret;
 292 }
 293
 294 static const struct of_device_id sdhci_arasan_of_match[] = {
 295         { .compatible = "arasan,sdhci-8.9a" },
 296         { .compatible = "arasan,sdhci-5.1" },
 297         { .compatible = "arasan,sdhci-4.9a" },
 298         { }
 299 };
 300 MODULE_DEVICE_TABLE(of, sdhci_arasan_of_match);
 301
 302 static struct platform_driver sdhci_arasan_driver = {
 303         .driver = {
 304                 .name = "sdhci-arasan",
 305                 .of_match_table = sdhci_arasan_of_match,
 306                 .pm = &sdhci_arasan_dev_pm_ops,
 307         },
 308         .probe = sdhci_arasan_probe,
 309         .remove = sdhci_arasan_remove,
 310 };
 311
 312 module_platform_driver(sdhci_arasan_driver);
 313
 314 MODULE_DESCRIPTION("Driver for the Arasan SDHCI Controller");
 315 MODULE_AUTHOR("Soeren Brinkmann <soren.brinkmann@xilinx.com>");
 316 MODULE_LICENSE("GPL");