xref: /linux/drivers/ata/pata_platform.c (revision 7f3edee81fbd49114c28057512906f169caa0bed)
1 /*
2  * Generic platform device PATA driver
3  *
4  * Copyright (C) 2006 - 2007  Paul Mundt
5  *
6  * Based on pata_pcmcia:
7  *
8  *   Copyright 2005-2006 Red Hat Inc <alan@redhat.com>, all rights reserved.
9  *
10  * This file is subject to the terms and conditions of the GNU General Public
11  * License.  See the file "COPYING" in the main directory of this archive
12  * for more details.
13  */
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/blkdev.h>
18 #include <scsi/scsi_host.h>
19 #include <linux/ata.h>
20 #include <linux/libata.h>
21 #include <linux/platform_device.h>
22 #include <linux/pata_platform.h>
23 
24 #define DRV_NAME "pata_platform"
25 #define DRV_VERSION "1.2"
26 
27 static int pio_mask = 1;
28 
29 /*
30  * Provide our own set_mode() as we don't want to change anything that has
31  * already been configured..
32  */
33 static int pata_platform_set_mode(struct ata_link *link, struct ata_device **unused)
34 {
35 	struct ata_device *dev;
36 
37 	ata_link_for_each_dev(dev, link) {
38 		if (ata_dev_enabled(dev)) {
39 			/* We don't really care */
40 			dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
41 			dev->xfer_shift = ATA_SHIFT_PIO;
42 			dev->flags |= ATA_DFLAG_PIO;
43 			ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
44 		}
45 	}
46 	return 0;
47 }
48 
49 static int ata_dummy_ret0(struct ata_port *ap)	{ return 0; }
50 
51 static struct scsi_host_template pata_platform_sht = {
52 	.module			= THIS_MODULE,
53 	.name			= DRV_NAME,
54 	.ioctl			= ata_scsi_ioctl,
55 	.queuecommand		= ata_scsi_queuecmd,
56 	.can_queue		= ATA_DEF_QUEUE,
57 	.this_id		= ATA_SHT_THIS_ID,
58 	.sg_tablesize		= LIBATA_MAX_PRD,
59 	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
60 	.emulated		= ATA_SHT_EMULATED,
61 	.use_clustering		= ATA_SHT_USE_CLUSTERING,
62 	.proc_name		= DRV_NAME,
63 	.dma_boundary		= ATA_DMA_BOUNDARY,
64 	.slave_configure	= ata_scsi_slave_config,
65 	.slave_destroy		= ata_scsi_slave_destroy,
66 	.bios_param		= ata_std_bios_param,
67 };
68 
69 static struct ata_port_operations pata_platform_port_ops = {
70 	.set_mode		= pata_platform_set_mode,
71 
72 	.tf_load		= ata_tf_load,
73 	.tf_read		= ata_tf_read,
74 	.check_status		= ata_check_status,
75 	.exec_command		= ata_exec_command,
76 	.dev_select		= ata_std_dev_select,
77 
78 	.freeze			= ata_bmdma_freeze,
79 	.thaw			= ata_bmdma_thaw,
80 	.error_handler		= ata_bmdma_error_handler,
81 	.post_internal_cmd	= ata_bmdma_post_internal_cmd,
82 	.cable_detect		= ata_cable_unknown,
83 
84 	.qc_prep		= ata_qc_prep,
85 	.qc_issue		= ata_qc_issue_prot,
86 
87 	.data_xfer		= ata_data_xfer_noirq,
88 
89 	.irq_clear		= ata_bmdma_irq_clear,
90 	.irq_on			= ata_irq_on,
91 
92 	.port_start		= ata_dummy_ret0,
93 };
94 
95 static void pata_platform_setup_port(struct ata_ioports *ioaddr,
96 				     struct pata_platform_info *info)
97 {
98 	unsigned int shift = 0;
99 
100 	/* Fixup the port shift for platforms that need it */
101 	if (info && info->ioport_shift)
102 		shift = info->ioport_shift;
103 
104 	ioaddr->data_addr	= ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
105 	ioaddr->error_addr	= ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
106 	ioaddr->feature_addr	= ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
107 	ioaddr->nsect_addr	= ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
108 	ioaddr->lbal_addr	= ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
109 	ioaddr->lbam_addr	= ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
110 	ioaddr->lbah_addr	= ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
111 	ioaddr->device_addr	= ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
112 	ioaddr->status_addr	= ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
113 	ioaddr->command_addr	= ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
114 }
115 
116 /**
117  *	pata_platform_probe		-	attach a platform interface
118  *	@pdev: platform device
119  *
120  *	Register a platform bus IDE interface. Such interfaces are PIO and we
121  *	assume do not support IRQ sharing.
122  *
123  *	Platform devices are expected to contain at least 2 resources per port:
124  *
125  *		- I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
126  *		- CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
127  *
128  *	and optionally:
129  *
130  *		- IRQ	   (IORESOURCE_IRQ)
131  *
132  *	If the base resources are both mem types, the ioremap() is handled
133  *	here. For IORESOURCE_IO, it's assumed that there's no remapping
134  *	necessary.
135  *
136  *	If no IRQ resource is present, PIO polling mode is used instead.
137  */
138 static int __devinit pata_platform_probe(struct platform_device *pdev)
139 {
140 	struct resource *io_res, *ctl_res;
141 	struct ata_host *host;
142 	struct ata_port *ap;
143 	struct pata_platform_info *pp_info;
144 	unsigned int mmio;
145 	int irq;
146 
147 	/*
148 	 * Simple resource validation ..
149 	 */
150 	if ((pdev->num_resources != 3) && (pdev->num_resources != 2)) {
151 		dev_err(&pdev->dev, "invalid number of resources\n");
152 		return -EINVAL;
153 	}
154 
155 	/*
156 	 * Get the I/O base first
157 	 */
158 	io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
159 	if (io_res == NULL) {
160 		io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
161 		if (unlikely(io_res == NULL))
162 			return -EINVAL;
163 	}
164 
165 	/*
166 	 * Then the CTL base
167 	 */
168 	ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
169 	if (ctl_res == NULL) {
170 		ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
171 		if (unlikely(ctl_res == NULL))
172 			return -EINVAL;
173 	}
174 
175 	/*
176 	 * Check for MMIO
177 	 */
178 	mmio = (( io_res->flags == IORESOURCE_MEM) &&
179 		(ctl_res->flags == IORESOURCE_MEM));
180 
181 	/*
182 	 * And the IRQ
183 	 */
184 	irq = platform_get_irq(pdev, 0);
185 	if (irq < 0)
186 		irq = 0;	/* no irq */
187 
188 	/*
189 	 * Now that that's out of the way, wire up the port..
190 	 */
191 	host = ata_host_alloc(&pdev->dev, 1);
192 	if (!host)
193 		return -ENOMEM;
194 	ap = host->ports[0];
195 
196 	ap->ops = &pata_platform_port_ops;
197 	ap->pio_mask = pio_mask;
198 	ap->flags |= ATA_FLAG_SLAVE_POSS;
199 
200 	/*
201 	 * Use polling mode if there's no IRQ
202 	 */
203 	if (!irq) {
204 		ap->flags |= ATA_FLAG_PIO_POLLING;
205 		ata_port_desc(ap, "no IRQ, using PIO polling");
206 	}
207 
208 	/*
209 	 * Handle the MMIO case
210 	 */
211 	if (mmio) {
212 		ap->ioaddr.cmd_addr = devm_ioremap(&pdev->dev, io_res->start,
213 				io_res->end - io_res->start + 1);
214 		ap->ioaddr.ctl_addr = devm_ioremap(&pdev->dev, ctl_res->start,
215 				ctl_res->end - ctl_res->start + 1);
216 	} else {
217 		ap->ioaddr.cmd_addr = devm_ioport_map(&pdev->dev, io_res->start,
218 				io_res->end - io_res->start + 1);
219 		ap->ioaddr.ctl_addr = devm_ioport_map(&pdev->dev, ctl_res->start,
220 				ctl_res->end - ctl_res->start + 1);
221 	}
222 	if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
223 		dev_err(&pdev->dev, "failed to map IO/CTL base\n");
224 		return -ENOMEM;
225 	}
226 
227 	ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
228 
229 	pp_info = pdev->dev.platform_data;
230 	pata_platform_setup_port(&ap->ioaddr, pp_info);
231 
232 	ata_port_desc(ap, "%s cmd 0x%llx ctl 0x%llx", mmio ? "mmio" : "ioport",
233 		      (unsigned long long)io_res->start,
234 		      (unsigned long long)ctl_res->start);
235 
236 	/* activate */
237 	return ata_host_activate(host, irq, irq ? ata_interrupt : NULL,
238 				 pp_info ? pp_info->irq_flags : 0,
239 				 &pata_platform_sht);
240 }
241 
242 /**
243  *	pata_platform_remove	-	unplug a platform interface
244  *	@pdev: platform device
245  *
246  *	A platform bus ATA device has been unplugged. Perform the needed
247  *	cleanup. Also called on module unload for any active devices.
248  */
249 static int __devexit pata_platform_remove(struct platform_device *pdev)
250 {
251 	struct device *dev = &pdev->dev;
252 	struct ata_host *host = dev_get_drvdata(dev);
253 
254 	ata_host_detach(host);
255 
256 	return 0;
257 }
258 
259 static struct platform_driver pata_platform_driver = {
260 	.probe		= pata_platform_probe,
261 	.remove		= __devexit_p(pata_platform_remove),
262 	.driver = {
263 		.name		= DRV_NAME,
264 		.owner		= THIS_MODULE,
265 	},
266 };
267 
268 static int __init pata_platform_init(void)
269 {
270 	return platform_driver_register(&pata_platform_driver);
271 }
272 
273 static void __exit pata_platform_exit(void)
274 {
275 	platform_driver_unregister(&pata_platform_driver);
276 }
277 module_init(pata_platform_init);
278 module_exit(pata_platform_exit);
279 
280 module_param(pio_mask, int, 0);
281 
282 MODULE_AUTHOR("Paul Mundt");
283 MODULE_DESCRIPTION("low-level driver for platform device ATA");
284 MODULE_LICENSE("GPL");
285 MODULE_VERSION(DRV_VERSION);
286