xref: /openbmc/linux/drivers/ata/pata_platform.c (revision 275876e2)
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, 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/blkdev.h>
17 #include <scsi/scsi_host.h>
18 #include <linux/ata.h>
19 #include <linux/libata.h>
20 #include <linux/platform_device.h>
21 #include <linux/ata_platform.h>
22 
23 #define DRV_NAME "pata_platform"
24 #define DRV_VERSION "1.2"
25 
26 static int pio_mask = 1;
27 
28 /*
29  * Provide our own set_mode() as we don't want to change anything that has
30  * already been configured..
31  */
32 static int pata_platform_set_mode(struct ata_link *link, struct ata_device **unused)
33 {
34 	struct ata_device *dev;
35 
36 	ata_for_each_dev(dev, link, ENABLED) {
37 		/* We don't really care */
38 		dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
39 		dev->xfer_shift = ATA_SHIFT_PIO;
40 		dev->flags |= ATA_DFLAG_PIO;
41 		ata_dev_info(dev, "configured for PIO\n");
42 	}
43 	return 0;
44 }
45 
46 static struct scsi_host_template pata_platform_sht = {
47 	ATA_PIO_SHT(DRV_NAME),
48 };
49 
50 static struct ata_port_operations pata_platform_port_ops = {
51 	.inherits		= &ata_sff_port_ops,
52 	.sff_data_xfer		= ata_sff_data_xfer_noirq,
53 	.cable_detect		= ata_cable_unknown,
54 	.set_mode		= pata_platform_set_mode,
55 };
56 
57 static void pata_platform_setup_port(struct ata_ioports *ioaddr,
58 				     unsigned int shift)
59 {
60 	/* Fixup the port shift for platforms that need it */
61 	ioaddr->data_addr	= ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
62 	ioaddr->error_addr	= ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
63 	ioaddr->feature_addr	= ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
64 	ioaddr->nsect_addr	= ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
65 	ioaddr->lbal_addr	= ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
66 	ioaddr->lbam_addr	= ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
67 	ioaddr->lbah_addr	= ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
68 	ioaddr->device_addr	= ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
69 	ioaddr->status_addr	= ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
70 	ioaddr->command_addr	= ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
71 }
72 
73 /**
74  *	__pata_platform_probe		-	attach a platform interface
75  *	@dev: device
76  *	@io_res: Resource representing I/O base
77  *	@ctl_res: Resource representing CTL base
78  *	@irq_res: Resource representing IRQ and its flags
79  *	@ioport_shift: I/O port shift
80  *	@__pio_mask: PIO mask
81  *
82  *	Register a platform bus IDE interface. Such interfaces are PIO and we
83  *	assume do not support IRQ sharing.
84  *
85  *	Platform devices are expected to contain at least 2 resources per port:
86  *
87  *		- I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
88  *		- CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
89  *
90  *	and optionally:
91  *
92  *		- IRQ	   (IORESOURCE_IRQ)
93  *
94  *	If the base resources are both mem types, the ioremap() is handled
95  *	here. For IORESOURCE_IO, it's assumed that there's no remapping
96  *	necessary.
97  *
98  *	If no IRQ resource is present, PIO polling mode is used instead.
99  */
100 int __pata_platform_probe(struct device *dev, struct resource *io_res,
101 			  struct resource *ctl_res, struct resource *irq_res,
102 			  unsigned int ioport_shift, int __pio_mask)
103 {
104 	struct ata_host *host;
105 	struct ata_port *ap;
106 	unsigned int mmio;
107 	int irq = 0;
108 	int irq_flags = 0;
109 
110 	/*
111 	 * Check for MMIO
112 	 */
113 	mmio = (( io_res->flags == IORESOURCE_MEM) &&
114 		(ctl_res->flags == IORESOURCE_MEM));
115 
116 	/*
117 	 * And the IRQ
118 	 */
119 	if (irq_res && irq_res->start > 0) {
120 		irq = irq_res->start;
121 		irq_flags = irq_res->flags;
122 	}
123 
124 	/*
125 	 * Now that that's out of the way, wire up the port..
126 	 */
127 	host = ata_host_alloc(dev, 1);
128 	if (!host)
129 		return -ENOMEM;
130 	ap = host->ports[0];
131 
132 	ap->ops = &pata_platform_port_ops;
133 	ap->pio_mask = __pio_mask;
134 	ap->flags |= ATA_FLAG_SLAVE_POSS;
135 
136 	/*
137 	 * Use polling mode if there's no IRQ
138 	 */
139 	if (!irq) {
140 		ap->flags |= ATA_FLAG_PIO_POLLING;
141 		ata_port_desc(ap, "no IRQ, using PIO polling");
142 	}
143 
144 	/*
145 	 * Handle the MMIO case
146 	 */
147 	if (mmio) {
148 		ap->ioaddr.cmd_addr = devm_ioremap(dev, io_res->start,
149 				resource_size(io_res));
150 		ap->ioaddr.ctl_addr = devm_ioremap(dev, ctl_res->start,
151 				resource_size(ctl_res));
152 	} else {
153 		ap->ioaddr.cmd_addr = devm_ioport_map(dev, io_res->start,
154 				resource_size(io_res));
155 		ap->ioaddr.ctl_addr = devm_ioport_map(dev, ctl_res->start,
156 				resource_size(ctl_res));
157 	}
158 	if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
159 		dev_err(dev, "failed to map IO/CTL base\n");
160 		return -ENOMEM;
161 	}
162 
163 	ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
164 
165 	pata_platform_setup_port(&ap->ioaddr, ioport_shift);
166 
167 	ata_port_desc(ap, "%s cmd 0x%llx ctl 0x%llx", mmio ? "mmio" : "ioport",
168 		      (unsigned long long)io_res->start,
169 		      (unsigned long long)ctl_res->start);
170 
171 	/* activate */
172 	return ata_host_activate(host, irq, irq ? ata_sff_interrupt : NULL,
173 				 irq_flags, &pata_platform_sht);
174 }
175 EXPORT_SYMBOL_GPL(__pata_platform_probe);
176 
177 static int pata_platform_probe(struct platform_device *pdev)
178 {
179 	struct resource *io_res;
180 	struct resource *ctl_res;
181 	struct resource *irq_res;
182 	struct pata_platform_info *pp_info = dev_get_platdata(&pdev->dev);
183 
184 	/*
185 	 * Simple resource validation ..
186 	 */
187 	if ((pdev->num_resources != 3) && (pdev->num_resources != 2)) {
188 		dev_err(&pdev->dev, "invalid number of resources\n");
189 		return -EINVAL;
190 	}
191 
192 	/*
193 	 * Get the I/O base first
194 	 */
195 	io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
196 	if (io_res == NULL) {
197 		io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
198 		if (unlikely(io_res == NULL))
199 			return -EINVAL;
200 	}
201 
202 	/*
203 	 * Then the CTL base
204 	 */
205 	ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
206 	if (ctl_res == NULL) {
207 		ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
208 		if (unlikely(ctl_res == NULL))
209 			return -EINVAL;
210 	}
211 
212 	/*
213 	 * And the IRQ
214 	 */
215 	irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
216 	if (irq_res)
217 		irq_res->flags = pp_info ? pp_info->irq_flags : 0;
218 
219 	return __pata_platform_probe(&pdev->dev, io_res, ctl_res, irq_res,
220 				     pp_info ? pp_info->ioport_shift : 0,
221 				     pio_mask);
222 }
223 
224 static struct platform_driver pata_platform_driver = {
225 	.probe		= pata_platform_probe,
226 	.remove		= ata_platform_remove_one,
227 	.driver = {
228 		.name		= DRV_NAME,
229 		.owner		= THIS_MODULE,
230 	},
231 };
232 
233 module_platform_driver(pata_platform_driver);
234 
235 module_param(pio_mask, int, 0);
236 
237 MODULE_AUTHOR("Paul Mundt");
238 MODULE_DESCRIPTION("low-level driver for platform device ATA");
239 MODULE_LICENSE("GPL");
240 MODULE_VERSION(DRV_VERSION);
241 MODULE_ALIAS("platform:" DRV_NAME);
242