xref: /linux/drivers/ata/pata_imx.c (revision e86c4b67feb2c984314eef71314f26cfe39fef36)
1 /*
2  * Freescale iMX PATA driver
3  *
4  * Copyright (C) 2011 Arnaud Patard <arnaud.patard@rtp-net.org>
5  *
6  * Based on pata_platform - Copyright (C) 2006 - 2007  Paul Mundt
7  *
8  * This file is subject to the terms and conditions of the GNU General Public
9  * License.  See the file "COPYING" in the main directory of this archive
10  * for more details.
11  *
12  * TODO:
13  * - dmaengine support
14  * - check if timing stuff needed
15  */
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/blkdev.h>
20 #include <scsi/scsi_host.h>
21 #include <linux/ata.h>
22 #include <linux/libata.h>
23 #include <linux/platform_device.h>
24 #include <linux/clk.h>
25 
26 #define DRV_NAME "pata_imx"
27 
28 #define PATA_IMX_ATA_CONTROL		0x24
29 #define PATA_IMX_ATA_CTRL_FIFO_RST_B	(1<<7)
30 #define PATA_IMX_ATA_CTRL_ATA_RST_B	(1<<6)
31 #define PATA_IMX_ATA_CTRL_IORDY_EN	(1<<0)
32 #define PATA_IMX_ATA_INT_EN		0x2C
33 #define PATA_IMX_ATA_INTR_ATA_INTRQ2	(1<<3)
34 #define PATA_IMX_DRIVE_DATA		0xA0
35 #define PATA_IMX_DRIVE_CONTROL		0xD8
36 
37 struct pata_imx_priv {
38 	struct clk *clk;
39 	/* timings/interrupt/control regs */
40 	void __iomem *host_regs;
41 	u32 ata_ctl;
42 };
43 
44 static int pata_imx_set_mode(struct ata_link *link, struct ata_device **unused)
45 {
46 	struct ata_device *dev;
47 	struct ata_port *ap = link->ap;
48 	struct pata_imx_priv *priv = ap->host->private_data;
49 	u32 val;
50 
51 	ata_for_each_dev(dev, link, ENABLED) {
52 		dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
53 		dev->xfer_shift = ATA_SHIFT_PIO;
54 		dev->flags |= ATA_DFLAG_PIO;
55 
56 		val = __raw_readl(priv->host_regs + PATA_IMX_ATA_CONTROL);
57 		if (ata_pio_need_iordy(dev))
58 			val |= PATA_IMX_ATA_CTRL_IORDY_EN;
59 		else
60 			val &= ~PATA_IMX_ATA_CTRL_IORDY_EN;
61 		__raw_writel(val, priv->host_regs + PATA_IMX_ATA_CONTROL);
62 
63 		ata_dev_info(dev, "configured for PIO\n");
64 	}
65 	return 0;
66 }
67 
68 static struct scsi_host_template pata_imx_sht = {
69 	ATA_PIO_SHT(DRV_NAME),
70 };
71 
72 static struct ata_port_operations pata_imx_port_ops = {
73 	.inherits		= &ata_sff_port_ops,
74 	.sff_data_xfer		= ata_sff_data_xfer_noirq,
75 	.cable_detect		= ata_cable_unknown,
76 	.set_mode		= pata_imx_set_mode,
77 };
78 
79 static void pata_imx_setup_port(struct ata_ioports *ioaddr)
80 {
81 	/* Fixup the port shift for platforms that need it */
82 	ioaddr->data_addr	= ioaddr->cmd_addr + (ATA_REG_DATA    << 2);
83 	ioaddr->error_addr	= ioaddr->cmd_addr + (ATA_REG_ERR     << 2);
84 	ioaddr->feature_addr	= ioaddr->cmd_addr + (ATA_REG_FEATURE << 2);
85 	ioaddr->nsect_addr	= ioaddr->cmd_addr + (ATA_REG_NSECT   << 2);
86 	ioaddr->lbal_addr	= ioaddr->cmd_addr + (ATA_REG_LBAL    << 2);
87 	ioaddr->lbam_addr	= ioaddr->cmd_addr + (ATA_REG_LBAM    << 2);
88 	ioaddr->lbah_addr	= ioaddr->cmd_addr + (ATA_REG_LBAH    << 2);
89 	ioaddr->device_addr	= ioaddr->cmd_addr + (ATA_REG_DEVICE  << 2);
90 	ioaddr->status_addr	= ioaddr->cmd_addr + (ATA_REG_STATUS  << 2);
91 	ioaddr->command_addr	= ioaddr->cmd_addr + (ATA_REG_CMD     << 2);
92 }
93 
94 static int pata_imx_probe(struct platform_device *pdev)
95 {
96 	struct ata_host *host;
97 	struct ata_port *ap;
98 	struct pata_imx_priv *priv;
99 	int irq = 0;
100 	struct resource *io_res;
101 	int ret;
102 
103 	io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
104 	if (io_res == NULL)
105 		return -EINVAL;
106 
107 	irq = platform_get_irq(pdev, 0);
108 	if (irq <= 0)
109 		return -EINVAL;
110 
111 	priv = devm_kzalloc(&pdev->dev,
112 				sizeof(struct pata_imx_priv), GFP_KERNEL);
113 	if (!priv)
114 		return -ENOMEM;
115 
116 	priv->clk = devm_clk_get(&pdev->dev, NULL);
117 	if (IS_ERR(priv->clk)) {
118 		dev_err(&pdev->dev, "Failed to get clock\n");
119 		return PTR_ERR(priv->clk);
120 	}
121 
122 	ret = clk_prepare_enable(priv->clk);
123 	if (ret)
124 		return ret;
125 
126 	host = ata_host_alloc(&pdev->dev, 1);
127 	if (!host) {
128 		ret = -ENOMEM;
129 		goto err;
130 	}
131 
132 	host->private_data = priv;
133 	ap = host->ports[0];
134 
135 	ap->ops = &pata_imx_port_ops;
136 	ap->pio_mask = ATA_PIO0;
137 	ap->flags |= ATA_FLAG_SLAVE_POSS;
138 
139 	priv->host_regs = devm_ioremap(&pdev->dev, io_res->start,
140 		resource_size(io_res));
141 	if (!priv->host_regs) {
142 		dev_err(&pdev->dev, "failed to map IO/CTL base\n");
143 		ret = -EBUSY;
144 		goto err;
145 	}
146 
147 	ap->ioaddr.cmd_addr = priv->host_regs + PATA_IMX_DRIVE_DATA;
148 	ap->ioaddr.ctl_addr = priv->host_regs + PATA_IMX_DRIVE_CONTROL;
149 
150 	ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
151 
152 	pata_imx_setup_port(&ap->ioaddr);
153 
154 	ata_port_desc(ap, "cmd 0x%llx ctl 0x%llx",
155 		(unsigned long long)io_res->start + PATA_IMX_DRIVE_DATA,
156 		(unsigned long long)io_res->start + PATA_IMX_DRIVE_CONTROL);
157 
158 	/* deassert resets */
159 	__raw_writel(PATA_IMX_ATA_CTRL_FIFO_RST_B |
160 			PATA_IMX_ATA_CTRL_ATA_RST_B,
161 			priv->host_regs + PATA_IMX_ATA_CONTROL);
162 	/* enable interrupts */
163 	__raw_writel(PATA_IMX_ATA_INTR_ATA_INTRQ2,
164 			priv->host_regs + PATA_IMX_ATA_INT_EN);
165 
166 	/* activate */
167 	ret = ata_host_activate(host, irq, ata_sff_interrupt, 0,
168 				&pata_imx_sht);
169 
170 	if (ret)
171 		goto err;
172 
173 	return 0;
174 err:
175 	clk_disable_unprepare(priv->clk);
176 
177 	return ret;
178 }
179 
180 static int pata_imx_remove(struct platform_device *pdev)
181 {
182 	struct ata_host *host = platform_get_drvdata(pdev);
183 	struct pata_imx_priv *priv = host->private_data;
184 
185 	ata_host_detach(host);
186 
187 	__raw_writel(0, priv->host_regs + PATA_IMX_ATA_INT_EN);
188 
189 	clk_disable_unprepare(priv->clk);
190 
191 	return 0;
192 }
193 
194 #ifdef CONFIG_PM
195 static int pata_imx_suspend(struct device *dev)
196 {
197 	struct ata_host *host = dev_get_drvdata(dev);
198 	struct pata_imx_priv *priv = host->private_data;
199 	int ret;
200 
201 	ret = ata_host_suspend(host, PMSG_SUSPEND);
202 	if (!ret) {
203 		__raw_writel(0, priv->host_regs + PATA_IMX_ATA_INT_EN);
204 		priv->ata_ctl =
205 			__raw_readl(priv->host_regs + PATA_IMX_ATA_CONTROL);
206 		clk_disable_unprepare(priv->clk);
207 	}
208 
209 	return ret;
210 }
211 
212 static int pata_imx_resume(struct device *dev)
213 {
214 	struct ata_host *host = dev_get_drvdata(dev);
215 	struct pata_imx_priv *priv = host->private_data;
216 
217 	int ret = clk_prepare_enable(priv->clk);
218 	if (ret)
219 		return ret;
220 
221 	__raw_writel(priv->ata_ctl, priv->host_regs + PATA_IMX_ATA_CONTROL);
222 
223 	__raw_writel(PATA_IMX_ATA_INTR_ATA_INTRQ2,
224 			priv->host_regs + PATA_IMX_ATA_INT_EN);
225 
226 	ata_host_resume(host);
227 
228 	return 0;
229 }
230 
231 static const struct dev_pm_ops pata_imx_pm_ops = {
232 	.suspend	= pata_imx_suspend,
233 	.resume		= pata_imx_resume,
234 };
235 #endif
236 
237 static const struct of_device_id imx_pata_dt_ids[] = {
238 	{
239 		.compatible = "fsl,imx27-pata",
240 	}, {
241 		/* sentinel */
242 	}
243 };
244 MODULE_DEVICE_TABLE(of, imx_pata_dt_ids);
245 
246 static struct platform_driver pata_imx_driver = {
247 	.probe		= pata_imx_probe,
248 	.remove		= pata_imx_remove,
249 	.driver = {
250 		.name		= DRV_NAME,
251 		.of_match_table	= imx_pata_dt_ids,
252 		.owner		= THIS_MODULE,
253 #ifdef CONFIG_PM
254 		.pm		= &pata_imx_pm_ops,
255 #endif
256 	},
257 };
258 
259 module_platform_driver(pata_imx_driver);
260 
261 MODULE_AUTHOR("Arnaud Patard <arnaud.patard@rtp-net.org>");
262 MODULE_DESCRIPTION("low-level driver for iMX PATA");
263 MODULE_LICENSE("GPL");
264 MODULE_ALIAS("platform:" DRV_NAME);
265