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