xref: /openbmc/linux/drivers/ata/pata_platform.c (revision 293d5b43)
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  *	@sht: scsi_host_template to use when registering
82  *
83  *	Register a platform bus IDE interface. Such interfaces are PIO and we
84  *	assume do not support IRQ sharing.
85  *
86  *	Platform devices are expected to contain at least 2 resources per port:
87  *
88  *		- I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
89  *		- CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
90  *
91  *	and optionally:
92  *
93  *		- IRQ	   (IORESOURCE_IRQ)
94  *
95  *	If the base resources are both mem types, the ioremap() is handled
96  *	here. For IORESOURCE_IO, it's assumed that there's no remapping
97  *	necessary.
98  *
99  *	If no IRQ resource is present, PIO polling mode is used instead.
100  */
101 int __pata_platform_probe(struct device *dev, struct resource *io_res,
102 			  struct resource *ctl_res, struct resource *irq_res,
103 			  unsigned int ioport_shift, int __pio_mask,
104 			  struct scsi_host_template *sht)
105 {
106 	struct ata_host *host;
107 	struct ata_port *ap;
108 	unsigned int mmio;
109 	int irq = 0;
110 	int irq_flags = 0;
111 
112 	/*
113 	 * Check for MMIO
114 	 */
115 	mmio = (( io_res->flags == IORESOURCE_MEM) &&
116 		(ctl_res->flags == IORESOURCE_MEM));
117 
118 	/*
119 	 * And the IRQ
120 	 */
121 	if (irq_res && irq_res->start > 0) {
122 		irq = irq_res->start;
123 		irq_flags = irq_res->flags & IRQF_TRIGGER_MASK;
124 	}
125 
126 	/*
127 	 * Now that that's out of the way, wire up the port..
128 	 */
129 	host = ata_host_alloc(dev, 1);
130 	if (!host)
131 		return -ENOMEM;
132 	ap = host->ports[0];
133 
134 	ap->ops = &pata_platform_port_ops;
135 	ap->pio_mask = __pio_mask;
136 	ap->flags |= ATA_FLAG_SLAVE_POSS;
137 
138 	/*
139 	 * Use polling mode if there's no IRQ
140 	 */
141 	if (!irq) {
142 		ap->flags |= ATA_FLAG_PIO_POLLING;
143 		ata_port_desc(ap, "no IRQ, using PIO polling");
144 	}
145 
146 	/*
147 	 * Handle the MMIO case
148 	 */
149 	if (mmio) {
150 		ap->ioaddr.cmd_addr = devm_ioremap(dev, io_res->start,
151 				resource_size(io_res));
152 		ap->ioaddr.ctl_addr = devm_ioremap(dev, ctl_res->start,
153 				resource_size(ctl_res));
154 	} else {
155 		ap->ioaddr.cmd_addr = devm_ioport_map(dev, io_res->start,
156 				resource_size(io_res));
157 		ap->ioaddr.ctl_addr = devm_ioport_map(dev, ctl_res->start,
158 				resource_size(ctl_res));
159 	}
160 	if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
161 		dev_err(dev, "failed to map IO/CTL base\n");
162 		return -ENOMEM;
163 	}
164 
165 	ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
166 
167 	pata_platform_setup_port(&ap->ioaddr, ioport_shift);
168 
169 	ata_port_desc(ap, "%s cmd 0x%llx ctl 0x%llx", mmio ? "mmio" : "ioport",
170 		      (unsigned long long)io_res->start,
171 		      (unsigned long long)ctl_res->start);
172 
173 	/* activate */
174 	return ata_host_activate(host, irq, irq ? ata_sff_interrupt : NULL,
175 				 irq_flags, sht);
176 }
177 EXPORT_SYMBOL_GPL(__pata_platform_probe);
178 
179 static int pata_platform_probe(struct platform_device *pdev)
180 {
181 	struct resource *io_res;
182 	struct resource *ctl_res;
183 	struct resource *irq_res;
184 	struct pata_platform_info *pp_info = dev_get_platdata(&pdev->dev);
185 
186 	/*
187 	 * Simple resource validation ..
188 	 */
189 	if ((pdev->num_resources != 3) && (pdev->num_resources != 2)) {
190 		dev_err(&pdev->dev, "invalid number of resources\n");
191 		return -EINVAL;
192 	}
193 
194 	/*
195 	 * Get the I/O base first
196 	 */
197 	io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
198 	if (io_res == NULL) {
199 		io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
200 		if (unlikely(io_res == NULL))
201 			return -EINVAL;
202 	}
203 
204 	/*
205 	 * Then the CTL base
206 	 */
207 	ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
208 	if (ctl_res == NULL) {
209 		ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
210 		if (unlikely(ctl_res == NULL))
211 			return -EINVAL;
212 	}
213 
214 	/*
215 	 * And the IRQ
216 	 */
217 	irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 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, &pata_platform_sht);
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 	},
230 };
231 
232 module_platform_driver(pata_platform_driver);
233 
234 module_param(pio_mask, int, 0);
235 
236 MODULE_AUTHOR("Paul Mundt");
237 MODULE_DESCRIPTION("low-level driver for platform device ATA");
238 MODULE_LICENSE("GPL");
239 MODULE_VERSION(DRV_VERSION);
240 MODULE_ALIAS("platform:" DRV_NAME);
241