xref: /linux/drivers/ata/pata_platform.c (revision a17627ef8833ac30622a7b39b7be390e1b174405)
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 "1.0"
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 int ata_dummy_ret0(struct ata_port *ap)	{ return 0; }
52 
53 static struct scsi_host_template pata_platform_sht = {
54 	.module			= THIS_MODULE,
55 	.name			= DRV_NAME,
56 	.ioctl			= ata_scsi_ioctl,
57 	.queuecommand		= ata_scsi_queuecmd,
58 	.can_queue		= ATA_DEF_QUEUE,
59 	.this_id		= ATA_SHT_THIS_ID,
60 	.sg_tablesize		= LIBATA_MAX_PRD,
61 	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
62 	.emulated		= ATA_SHT_EMULATED,
63 	.use_clustering		= ATA_SHT_USE_CLUSTERING,
64 	.proc_name		= DRV_NAME,
65 	.dma_boundary		= ATA_DMA_BOUNDARY,
66 	.slave_configure	= ata_scsi_slave_config,
67 	.slave_destroy		= ata_scsi_slave_destroy,
68 	.bios_param		= ata_std_bios_param,
69 };
70 
71 static struct ata_port_operations pata_platform_port_ops = {
72 	.set_mode		= pata_platform_set_mode,
73 
74 	.port_disable		= ata_port_disable,
75 	.tf_load		= ata_tf_load,
76 	.tf_read		= ata_tf_read,
77 	.check_status		= ata_check_status,
78 	.exec_command		= ata_exec_command,
79 	.dev_select		= ata_std_dev_select,
80 
81 	.freeze			= ata_bmdma_freeze,
82 	.thaw			= ata_bmdma_thaw,
83 	.error_handler		= ata_bmdma_error_handler,
84 	.post_internal_cmd	= ata_bmdma_post_internal_cmd,
85 	.cable_detect		= ata_cable_unknown,
86 
87 	.qc_prep		= ata_qc_prep,
88 	.qc_issue		= ata_qc_issue_prot,
89 
90 	.data_xfer		= ata_data_xfer_noirq,
91 
92 	.irq_clear		= ata_bmdma_irq_clear,
93 	.irq_on			= ata_irq_on,
94 	.irq_ack		= ata_irq_ack,
95 
96 	.port_start		= ata_dummy_ret0,
97 };
98 
99 static void pata_platform_setup_port(struct ata_ioports *ioaddr,
100 				     struct pata_platform_info *info)
101 {
102 	unsigned int shift = 0;
103 
104 	/* Fixup the port shift for platforms that need it */
105 	if (info && info->ioport_shift)
106 		shift = info->ioport_shift;
107 
108 	ioaddr->data_addr	= ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
109 	ioaddr->error_addr	= ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
110 	ioaddr->feature_addr	= ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
111 	ioaddr->nsect_addr	= ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
112 	ioaddr->lbal_addr	= ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
113 	ioaddr->lbam_addr	= ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
114 	ioaddr->lbah_addr	= ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
115 	ioaddr->device_addr	= ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
116 	ioaddr->status_addr	= ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
117 	ioaddr->command_addr	= ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
118 }
119 
120 /**
121  *	pata_platform_probe		-	attach a platform interface
122  *	@pdev: platform device
123  *
124  *	Register a platform bus IDE interface. Such interfaces are PIO and we
125  *	assume do not support IRQ sharing.
126  *
127  *	Platform devices are expected to contain 3 resources per port:
128  *
129  *		- I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
130  *		- CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
131  *		- IRQ	   (IORESOURCE_IRQ)
132  *
133  *	If the base resources are both mem types, the ioremap() is handled
134  *	here. For IORESOURCE_IO, it's assumed that there's no remapping
135  *	necessary.
136  */
137 static int __devinit pata_platform_probe(struct platform_device *pdev)
138 {
139 	struct resource *io_res, *ctl_res;
140 	struct ata_host *host;
141 	struct ata_port *ap;
142 	unsigned int mmio;
143 
144 	/*
145 	 * Simple resource validation ..
146 	 */
147 	if (unlikely(pdev->num_resources != 3)) {
148 		dev_err(&pdev->dev, "invalid number of resources\n");
149 		return -EINVAL;
150 	}
151 
152 	/*
153 	 * Get the I/O base first
154 	 */
155 	io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
156 	if (io_res == NULL) {
157 		io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
158 		if (unlikely(io_res == NULL))
159 			return -EINVAL;
160 	}
161 
162 	/*
163 	 * Then the CTL base
164 	 */
165 	ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
166 	if (ctl_res == NULL) {
167 		ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
168 		if (unlikely(ctl_res == NULL))
169 			return -EINVAL;
170 	}
171 
172 	/*
173 	 * Check for MMIO
174 	 */
175 	mmio = (( io_res->flags == IORESOURCE_MEM) &&
176 		(ctl_res->flags == IORESOURCE_MEM));
177 
178 	/*
179 	 * Now that that's out of the way, wire up the port..
180 	 */
181 	host = ata_host_alloc(&pdev->dev, 1);
182 	if (!host)
183 		return -ENOMEM;
184 	ap = host->ports[0];
185 
186 	ap->ops = &pata_platform_port_ops;
187 	ap->pio_mask = pio_mask;
188 	ap->flags |= ATA_FLAG_SLAVE_POSS;
189 
190 	/*
191 	 * Handle the MMIO case
192 	 */
193 	if (mmio) {
194 		ap->ioaddr.cmd_addr = devm_ioremap(&pdev->dev, io_res->start,
195 				io_res->end - io_res->start + 1);
196 		ap->ioaddr.ctl_addr = devm_ioremap(&pdev->dev, ctl_res->start,
197 				ctl_res->end - ctl_res->start + 1);
198 	} else {
199 		ap->ioaddr.cmd_addr = devm_ioport_map(&pdev->dev, io_res->start,
200 				io_res->end - io_res->start + 1);
201 		ap->ioaddr.ctl_addr = devm_ioport_map(&pdev->dev, ctl_res->start,
202 				ctl_res->end - ctl_res->start + 1);
203 	}
204 	if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
205 		dev_err(&pdev->dev, "failed to map IO/CTL base\n");
206 		return -ENOMEM;
207 	}
208 
209 	ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
210 
211 	pata_platform_setup_port(&ap->ioaddr, pdev->dev.platform_data);
212 
213 	/* activate */
214 	return ata_host_activate(host, platform_get_irq(pdev, 0), ata_interrupt,
215 				 0, &pata_platform_sht);
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