xref: /linux/drivers/ata/pata_platform.c (revision c537b994505099b7197e7d3125b942ecbcc51eb6)
1 /*
2  * Generic platform device PATA driver
3  *
4  * Copyright (C) 2006  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 "0.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_port *ap, struct ata_device **unused)
34 {
35 	int i;
36 
37 	for (i = 0; i < ATA_MAX_DEVICES; i++) {
38 		struct ata_device *dev = &ap->device[i];
39 
40 		if (ata_dev_enabled(dev)) {
41 			/* We don't really care */
42 			dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
43 			dev->xfer_shift = ATA_SHIFT_PIO;
44 			dev->flags |= ATA_DFLAG_PIO;
45 			ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
46 		}
47 	}
48 	return 0;
49 }
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 	.port_disable		= ata_port_disable,
73 	.tf_load		= ata_tf_load,
74 	.tf_read		= ata_tf_read,
75 	.check_status		= ata_check_status,
76 	.exec_command		= ata_exec_command,
77 	.dev_select		= ata_std_dev_select,
78 
79 	.freeze			= ata_bmdma_freeze,
80 	.thaw			= ata_bmdma_thaw,
81 	.error_handler		= ata_bmdma_error_handler,
82 	.post_internal_cmd	= ata_bmdma_post_internal_cmd,
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_handler		= ata_interrupt,
90 	.irq_clear		= ata_bmdma_irq_clear,
91 	.irq_on			= ata_irq_on,
92 	.irq_ack		= ata_irq_ack,
93 
94 	.port_start		= ata_port_start,
95 };
96 
97 static void pata_platform_setup_port(struct ata_ioports *ioaddr,
98 				     struct pata_platform_info *info)
99 {
100 	unsigned int shift = 0;
101 
102 	/* Fixup the port shift for platforms that need it */
103 	if (info && info->ioport_shift)
104 		shift = info->ioport_shift;
105 
106 	ioaddr->data_addr	= ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
107 	ioaddr->error_addr	= ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
108 	ioaddr->feature_addr	= ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
109 	ioaddr->nsect_addr	= ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
110 	ioaddr->lbal_addr	= ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
111 	ioaddr->lbam_addr	= ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
112 	ioaddr->lbah_addr	= ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
113 	ioaddr->device_addr	= ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
114 	ioaddr->status_addr	= ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
115 	ioaddr->command_addr	= ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
116 }
117 
118 /**
119  *	pata_platform_probe		-	attach a platform interface
120  *	@pdev: platform device
121  *
122  *	Register a platform bus IDE interface. Such interfaces are PIO and we
123  *	assume do not support IRQ sharing.
124  *
125  *	Platform devices are expected to contain 3 resources per port:
126  *
127  *		- I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
128  *		- CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
129  *		- IRQ	   (IORESOURCE_IRQ)
130  *
131  *	If the base resources are both mem types, the ioremap() is handled
132  *	here. For IORESOURCE_IO, it's assumed that there's no remapping
133  *	necessary.
134  */
135 static int __devinit pata_platform_probe(struct platform_device *pdev)
136 {
137 	struct resource *io_res, *ctl_res;
138 	struct ata_probe_ent ae;
139 	unsigned int mmio;
140 
141 	/*
142 	 * Simple resource validation ..
143 	 */
144 	if (unlikely(pdev->num_resources != 3)) {
145 		dev_err(&pdev->dev, "invalid number of resources\n");
146 		return -EINVAL;
147 	}
148 
149 	/*
150 	 * Get the I/O base first
151 	 */
152 	io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
153 	if (io_res == NULL) {
154 		io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
155 		if (unlikely(io_res == NULL))
156 			return -EINVAL;
157 	}
158 
159 	/*
160 	 * Then the CTL base
161 	 */
162 	ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
163 	if (ctl_res == NULL) {
164 		ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
165 		if (unlikely(ctl_res == NULL))
166 			return -EINVAL;
167 	}
168 
169 	/*
170 	 * Check for MMIO
171 	 */
172 	mmio = (( io_res->flags == IORESOURCE_MEM) &&
173 		(ctl_res->flags == IORESOURCE_MEM));
174 
175 	/*
176 	 * Now that that's out of the way, wire up the port..
177 	 */
178 	memset(&ae, 0, sizeof(struct ata_probe_ent));
179 	INIT_LIST_HEAD(&ae.node);
180 	ae.dev = &pdev->dev;
181 	ae.port_ops = &pata_platform_port_ops;
182 	ae.sht = &pata_platform_sht;
183 	ae.n_ports = 1;
184 	ae.pio_mask = pio_mask;
185 	ae.irq = platform_get_irq(pdev, 0);
186 	ae.irq_flags = 0;
187 	ae.port_flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST;
188 
189 	/*
190 	 * Handle the MMIO case
191 	 */
192 	if (mmio) {
193 		ae.port[0].cmd_addr = devm_ioremap(&pdev->dev, io_res->start,
194 				io_res->end - io_res->start + 1);
195 		ae.port[0].ctl_addr = devm_ioremap(&pdev->dev, ctl_res->start,
196 				ctl_res->end - ctl_res->start + 1);
197 	} else {
198 		ae.port[0].cmd_addr = devm_ioport_map(&pdev->dev, io_res->start,
199 				io_res->end - io_res->start + 1);
200 		ae.port[0].ctl_addr = devm_ioport_map(&pdev->dev, ctl_res->start,
201 				ctl_res->end - ctl_res->start + 1);
202 	}
203 	if (!ae.port[0].cmd_addr || !ae.port[0].ctl_addr) {
204 		dev_err(&pdev->dev, "failed to map IO/CTL base\n");
205 		return -ENOMEM;
206 	}
207 
208 	ae.port[0].altstatus_addr = ae.port[0].ctl_addr;
209 
210 	pata_platform_setup_port(&ae.port[0], pdev->dev.platform_data);
211 
212 	if (unlikely(ata_device_add(&ae) == 0))
213 		return -ENODEV;
214 
215 	return 0;
216 }
217 
218 /**
219  *	pata_platform_remove	-	unplug a platform interface
220  *	@pdev: platform device
221  *
222  *	A platform bus ATA device has been unplugged. Perform the needed
223  *	cleanup. Also called on module unload for any active devices.
224  */
225 static int __devexit pata_platform_remove(struct platform_device *pdev)
226 {
227 	struct device *dev = &pdev->dev;
228 	struct ata_host *host = dev_get_drvdata(dev);
229 
230 	ata_host_detach(host);
231 
232 	return 0;
233 }
234 
235 static struct platform_driver pata_platform_driver = {
236 	.probe		= pata_platform_probe,
237 	.remove		= __devexit_p(pata_platform_remove),
238 	.driver = {
239 		.name		= DRV_NAME,
240 		.owner		= THIS_MODULE,
241 	},
242 };
243 
244 static int __init pata_platform_init(void)
245 {
246 	return platform_driver_register(&pata_platform_driver);
247 }
248 
249 static void __exit pata_platform_exit(void)
250 {
251 	platform_driver_unregister(&pata_platform_driver);
252 }
253 module_init(pata_platform_init);
254 module_exit(pata_platform_exit);
255 
256 module_param(pio_mask, int, 0);
257 
258 MODULE_AUTHOR("Paul Mundt");
259 MODULE_DESCRIPTION("low-level driver for platform device ATA");
260 MODULE_LICENSE("GPL");
261 MODULE_VERSION(DRV_VERSION);
262