ufshcd-pci.c revision 9baa3c34ac4e27f7e062f266f50cc5dbea26a6c1 
1/*
2 * Universal Flash Storage Host controller PCI glue driver
3 *
4 * This code is based on drivers/scsi/ufs/ufshcd-pci.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 "ufshcd.h"
37#include <linux/pci.h>
38#include <linux/pm_runtime.h>
39
40#ifdef CONFIG_PM
41/**
42 * ufshcd_pci_suspend - suspend power management function
43 * @pdev: pointer to PCI device handle
44 * @state: power state
45 *
46 * Returns -ENOSYS
47 */
48static int ufshcd_pci_suspend(struct device *dev)
49{
50	/*
51	 * TODO:
52	 * 1. Call ufshcd_suspend
53	 * 2. Do bus specific power management
54	 */
55
56	return -ENOSYS;
57}
58
59/**
60 * ufshcd_pci_resume - resume power management function
61 * @pdev: pointer to PCI device handle
62 *
63 * Returns -ENOSYS
64 */
65static int ufshcd_pci_resume(struct device *dev)
66{
67	/*
68	 * TODO:
69	 * 1. Call ufshcd_resume.
70	 * 2. Do bus specific wake up
71	 */
72
73	return -ENOSYS;
74}
75#else
76#define ufshcd_pci_suspend	NULL
77#define ufshcd_pci_resume	NULL
78#endif /* CONFIG_PM */
79
80#ifdef CONFIG_PM_RUNTIME
81static int ufshcd_pci_runtime_suspend(struct device *dev)
82{
83	struct ufs_hba *hba = dev_get_drvdata(dev);
84
85	if (!hba)
86		return 0;
87
88	return ufshcd_runtime_suspend(hba);
89}
90static int ufshcd_pci_runtime_resume(struct device *dev)
91{
92	struct ufs_hba *hba = dev_get_drvdata(dev);
93
94	if (!hba)
95		return 0;
96
97	return ufshcd_runtime_resume(hba);
98}
99static int ufshcd_pci_runtime_idle(struct device *dev)
100{
101	struct ufs_hba *hba = dev_get_drvdata(dev);
102
103	if (!hba)
104		return 0;
105
106	return ufshcd_runtime_idle(hba);
107}
108#else /* !CONFIG_PM_RUNTIME */
109#define ufshcd_pci_runtime_suspend	NULL
110#define ufshcd_pci_runtime_resume	NULL
111#define ufshcd_pci_runtime_idle	NULL
112#endif /* CONFIG_PM_RUNTIME */
113
114/**
115 * ufshcd_pci_shutdown - main function to put the controller in reset state
116 * @pdev: pointer to PCI device handle
117 */
118static void ufshcd_pci_shutdown(struct pci_dev *pdev)
119{
120	ufshcd_hba_stop((struct ufs_hba *)pci_get_drvdata(pdev));
121}
122
123/**
124 * ufshcd_pci_remove - de-allocate PCI/SCSI host and host memory space
125 *		data structure memory
126 * @pdev - pointer to PCI handle
127 */
128static void ufshcd_pci_remove(struct pci_dev *pdev)
129{
130	struct ufs_hba *hba = pci_get_drvdata(pdev);
131
132	pm_runtime_forbid(&pdev->dev);
133	pm_runtime_get_noresume(&pdev->dev);
134	ufshcd_remove(hba);
135}
136
137/**
138 * ufshcd_pci_probe - probe routine of the driver
139 * @pdev: pointer to PCI device handle
140 * @id: PCI device id
141 *
142 * Returns 0 on success, non-zero value on failure
143 */
144static int
145ufshcd_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
146{
147	struct ufs_hba *hba;
148	void __iomem *mmio_base;
149	int err;
150
151	err = pcim_enable_device(pdev);
152	if (err) {
153		dev_err(&pdev->dev, "pcim_enable_device failed\n");
154		return err;
155	}
156
157	pci_set_master(pdev);
158
159	err = pcim_iomap_regions(pdev, 1 << 0, UFSHCD);
160	if (err < 0) {
161		dev_err(&pdev->dev, "request and iomap failed\n");
162		return err;
163	}
164
165	mmio_base = pcim_iomap_table(pdev)[0];
166
167	err = ufshcd_init(&pdev->dev, &hba, mmio_base, pdev->irq);
168	if (err) {
169		dev_err(&pdev->dev, "Initialization failed\n");
170		return err;
171	}
172
173	pci_set_drvdata(pdev, hba);
174	pm_runtime_put_noidle(&pdev->dev);
175	pm_runtime_allow(&pdev->dev);
176
177	return 0;
178}
179
180static const struct dev_pm_ops ufshcd_pci_pm_ops = {
181	.suspend	= ufshcd_pci_suspend,
182	.resume		= ufshcd_pci_resume,
183	.runtime_suspend = ufshcd_pci_runtime_suspend,
184	.runtime_resume  = ufshcd_pci_runtime_resume,
185	.runtime_idle    = ufshcd_pci_runtime_idle,
186};
187
188static const struct pci_device_id ufshcd_pci_tbl[] = {
189	{ PCI_VENDOR_ID_SAMSUNG, 0xC00C, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
190	{ }	/* terminate list */
191};
192
193MODULE_DEVICE_TABLE(pci, ufshcd_pci_tbl);
194
195static struct pci_driver ufshcd_pci_driver = {
196	.name = UFSHCD,
197	.id_table = ufshcd_pci_tbl,
198	.probe = ufshcd_pci_probe,
199	.remove = ufshcd_pci_remove,
200	.shutdown = ufshcd_pci_shutdown,
201	.driver = {
202		.pm = &ufshcd_pci_pm_ops
203	},
204};
205
206module_pci_driver(ufshcd_pci_driver);
207
208MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
209MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
210MODULE_DESCRIPTION("UFS host controller PCI glue driver");
211MODULE_LICENSE("GPL");
212MODULE_VERSION(UFSHCD_DRIVER_VERSION);
213