drivers/scsi/ufs/ufshcd-pltfrm.c

   1 /*
   2  * Universal Flash Storage Host controller Platform bus based glue driver
   3  *
   4  * This code is based on drivers/scsi/ufs/ufshcd-pltfrm.c
   5  * Copyright (C) 2011-2013 Samsung India Software Operations
   6  *
   7  * Authors:
   8  *      Santosh Yaraganavi <santosh.sy@samsung.com>
   9  *      Vinayak Holikatti <h.vinayak@samsung.com>
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  * See the COPYING file in the top-level directory or visit
  16  * <http://www.gnu.org/licenses/gpl-2.0.html>
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * This program is provided "AS IS" and "WITH ALL FAULTS" and
  24  * without warranty of any kind. You are solely responsible for
  25  * determining the appropriateness of using and distributing
  26  * the program and assume all risks associated with your exercise
  27  * of rights with respect to the program, including but not limited
  28  * to infringement of third party rights, the risks and costs of
  29  * program errors, damage to or loss of data, programs or equipment,
  30  * and unavailability or interruption of operations. Under no
  31  * circumstances will the contributor of this Program be liable for
  32  * any damages of any kind arising from your use or distribution of
  33  * this program.
  34  */
  35
  36 #include <linux/platform_device.h>
  37 #include <linux/pm_runtime.h>
  38
  39 #include "ufshcd.h"
  40
  41 #ifdef CONFIG_PM
  42 /**
  43  * ufshcd_pltfrm_suspend - suspend power management function
  44  * @dev: pointer to device handle
  45  *
  46  *
  47  * Returns 0
  48  */
  49 static int ufshcd_pltfrm_suspend(struct device *dev)
  50 {
  51         struct platform_device *pdev = to_platform_device(dev);
  52         struct ufs_hba *hba =  platform_get_drvdata(pdev);
  53
  54         /*
  55          * TODO:
  56          * 1. Call ufshcd_suspend
  57          * 2. Do bus specific power management
  58          */
  59
  60         disable_irq(hba->irq);
  61
  62         return 0;
  63 }
  64
  65 /**
  66  * ufshcd_pltfrm_resume - resume power management function
  67  * @dev: pointer to device handle
  68  *
  69  * Returns 0
  70  */
  71 static int ufshcd_pltfrm_resume(struct device *dev)
  72 {
  73         struct platform_device *pdev = to_platform_device(dev);
  74         struct ufs_hba *hba =  platform_get_drvdata(pdev);
  75
  76         /*
  77          * TODO:
  78          * 1. Call ufshcd_resume.
  79          * 2. Do bus specific wake up
  80          */
  81
  82         enable_irq(hba->irq);
  83
  84         return 0;
  85 }
  86 #else
  87 #define ufshcd_pltfrm_suspend   NULL
  88 #define ufshcd_pltfrm_resume    NULL
  89 #endif
  90
  91 #ifdef CONFIG_PM_RUNTIME
  92 static int ufshcd_pltfrm_runtime_suspend(struct device *dev)
  93 {
  94         struct ufs_hba *hba =  dev_get_drvdata(dev);
  95
  96         if (!hba)
  97                 return 0;
  98
  99         return ufshcd_runtime_suspend(hba);
 100 }
 101 static int ufshcd_pltfrm_runtime_resume(struct device *dev)
 102 {
 103         struct ufs_hba *hba =  dev_get_drvdata(dev);
 104
 105         if (!hba)
 106                 return 0;
 107
 108         return ufshcd_runtime_resume(hba);
 109 }
 110 static int ufshcd_pltfrm_runtime_idle(struct device *dev)
 111 {
 112         struct ufs_hba *hba =  dev_get_drvdata(dev);
 113
 114         if (!hba)
 115                 return 0;
 116
 117         return ufshcd_runtime_idle(hba);
 118 }
 119 #else /* !CONFIG_PM_RUNTIME */
 120 #define ufshcd_pltfrm_runtime_suspend   NULL
 121 #define ufshcd_pltfrm_runtime_resume    NULL
 122 #define ufshcd_pltfrm_runtime_idle      NULL
 123 #endif /* CONFIG_PM_RUNTIME */
 124
 125 /**
 126  * ufshcd_pltfrm_probe - probe routine of the driver
 127  * @pdev: pointer to Platform device handle
 128  *
 129  * Returns 0 on success, non-zero value on failure
 130  */
 131 static int ufshcd_pltfrm_probe(struct platform_device *pdev)
 132 {
 133         struct ufs_hba *hba;
 134         void __iomem *mmio_base;
 135         struct resource *mem_res;
 136         int irq, err;
 137         struct device *dev = &pdev->dev;
 138
 139         mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 140         mmio_base = devm_ioremap_resource(dev, mem_res);
 141         if (IS_ERR(mmio_base)) {
 142                 err = PTR_ERR(mmio_base);
 143                 goto out;
 144         }
 145
 146         irq = platform_get_irq(pdev, 0);
 147         if (irq < 0) {
 148                 dev_err(dev, "IRQ resource not available\n");
 149                 err = -ENODEV;
 150                 goto out;
 151         }
 152
 153         pm_runtime_set_active(&pdev->dev);
 154         pm_runtime_enable(&pdev->dev);
 155
 156         err = ufshcd_init(dev, &hba, mmio_base, irq);
 157         if (err) {
 158                 dev_err(dev, "Intialization failed\n");
 159                 goto out_disable_rpm;
 160         }
 161
 162         platform_set_drvdata(pdev, hba);
 163
 164         return 0;
 165
 166 out_disable_rpm:
 167         pm_runtime_disable(&pdev->dev);
 168         pm_runtime_set_suspended(&pdev->dev);
 169 out:
 170         return err;
 171 }
 172
 173 /**
 174  * ufshcd_pltfrm_remove - remove platform driver routine
 175  * @pdev: pointer to platform device handle
 176  *
 177  * Returns 0 on success, non-zero value on failure
 178  */
 179 static int ufshcd_pltfrm_remove(struct platform_device *pdev)
 180 {
 181         struct ufs_hba *hba =  platform_get_drvdata(pdev);
 182
 183         pm_runtime_get_sync(&(pdev)->dev);
 184         ufshcd_remove(hba);
 185         return 0;
 186 }
 187
 188 static const struct of_device_id ufs_of_match[] = {
 189         { .compatible = "jedec,ufs-1.1"},
 190         {},
 191 };
 192
 193 static const struct dev_pm_ops ufshcd_dev_pm_ops = {
 194         .suspend        = ufshcd_pltfrm_suspend,
 195         .resume         = ufshcd_pltfrm_resume,
 196         .runtime_suspend = ufshcd_pltfrm_runtime_suspend,
 197         .runtime_resume  = ufshcd_pltfrm_runtime_resume,
 198         .runtime_idle    = ufshcd_pltfrm_runtime_idle,
 199 };
 200
 201 static struct platform_driver ufshcd_pltfrm_driver = {
 202         .probe  = ufshcd_pltfrm_probe,
 203         .remove = ufshcd_pltfrm_remove,
 204         .driver = {
 205                 .name   = "ufshcd",
 206                 .owner  = THIS_MODULE,
 207                 .pm     = &ufshcd_dev_pm_ops,
 208                 .of_match_table = ufs_of_match,
 209         },
 210 };
 211
 212 module_platform_driver(ufshcd_pltfrm_driver);
 213
 214 MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
 215 MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
 216 MODULE_DESCRIPTION("UFS host controller Pltform bus based glue driver");
 217 MODULE_LICENSE("GPL");
 218 MODULE_VERSION(UFSHCD_DRIVER_VERSION);