xref: /openbmc/linux/drivers/ata/pata_pcmcia.c (revision 7e035230)
1 /*
2  *   pata_pcmcia.c - PCMCIA PATA controller driver.
3  *   Copyright 2005-2006 Red Hat Inc, all rights reserved.
4  *   PCMCIA ident update Copyright 2006 Marcin Juszkiewicz
5  *						<openembedded@hrw.one.pl>
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2, or (at your option)
10  *  any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; see the file COPYING.  If not, write to
19  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20  *
21  *   Heavily based upon ide-cs.c
22  *   The initial developer of the original code is David A. Hinds
23  *   <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
24  *   are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
25  */
26 
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/init.h>
30 #include <linux/blkdev.h>
31 #include <linux/delay.h>
32 #include <linux/slab.h>
33 #include <scsi/scsi_host.h>
34 #include <linux/ata.h>
35 #include <linux/libata.h>
36 
37 #include <pcmcia/cistpl.h>
38 #include <pcmcia/ds.h>
39 #include <pcmcia/cisreg.h>
40 #include <pcmcia/ciscode.h>
41 
42 
43 #define DRV_NAME "pata_pcmcia"
44 #define DRV_VERSION "0.3.5"
45 
46 /**
47  *	pcmcia_set_mode	-	PCMCIA specific mode setup
48  *	@link: link
49  *	@r_failed_dev: Return pointer for failed device
50  *
51  *	Perform the tuning and setup of the devices and timings, which
52  *	for PCMCIA is the same as any other controller. We wrap it however
53  *	as we need to spot hardware with incorrect or missing master/slave
54  *	decode, which alas is embarrassingly common in the PC world
55  */
56 
57 static int pcmcia_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
58 {
59 	struct ata_device *master = &link->device[0];
60 	struct ata_device *slave = &link->device[1];
61 
62 	if (!ata_dev_enabled(master) || !ata_dev_enabled(slave))
63 		return ata_do_set_mode(link, r_failed_dev);
64 
65 	if (memcmp(master->id + ATA_ID_FW_REV,  slave->id + ATA_ID_FW_REV,
66 			   ATA_ID_FW_REV_LEN + ATA_ID_PROD_LEN) == 0) {
67 		/* Suspicious match, but could be two cards from
68 		   the same vendor - check serial */
69 		if (memcmp(master->id + ATA_ID_SERNO, slave->id + ATA_ID_SERNO,
70 			   ATA_ID_SERNO_LEN) == 0 && master->id[ATA_ID_SERNO] >> 8) {
71 			ata_dev_warn(slave, "is a ghost device, ignoring\n");
72 			ata_dev_disable(slave);
73 		}
74 	}
75 	return ata_do_set_mode(link, r_failed_dev);
76 }
77 
78 /**
79  *	pcmcia_set_mode_8bit	-	PCMCIA specific mode setup
80  *	@link: link
81  *	@r_failed_dev: Return pointer for failed device
82  *
83  *	For the simple emulated 8bit stuff the less we do the better.
84  */
85 
86 static int pcmcia_set_mode_8bit(struct ata_link *link,
87 				struct ata_device **r_failed_dev)
88 {
89 	return 0;
90 }
91 
92 /**
93  *	ata_data_xfer_8bit	 -	Transfer data by 8bit PIO
94  *	@dev: device to target
95  *	@buf: data buffer
96  *	@buflen: buffer length
97  *	@rw: read/write
98  *
99  *	Transfer data from/to the device data register by 8 bit PIO.
100  *
101  *	LOCKING:
102  *	Inherited from caller.
103  */
104 
105 static unsigned int ata_data_xfer_8bit(struct ata_device *dev,
106 				unsigned char *buf, unsigned int buflen, int rw)
107 {
108 	struct ata_port *ap = dev->link->ap;
109 
110 	if (rw == READ)
111 		ioread8_rep(ap->ioaddr.data_addr, buf, buflen);
112 	else
113 		iowrite8_rep(ap->ioaddr.data_addr, buf, buflen);
114 
115 	return buflen;
116 }
117 
118 /**
119  *	pcmcia_8bit_drain_fifo - Stock FIFO drain logic for SFF controllers
120  *	@qc: command
121  *
122  *	Drain the FIFO and device of any stuck data following a command
123  *	failing to complete. In some cases this is necessary before a
124  *	reset will recover the device.
125  *
126  */
127 
128 static void pcmcia_8bit_drain_fifo(struct ata_queued_cmd *qc)
129 {
130 	int count;
131 	struct ata_port *ap;
132 
133 	/* We only need to flush incoming data when a command was running */
134 	if (qc == NULL || qc->dma_dir == DMA_TO_DEVICE)
135 		return;
136 
137 	ap = qc->ap;
138 
139 	/* Drain up to 64K of data before we give up this recovery method */
140 	for (count = 0; (ap->ops->sff_check_status(ap) & ATA_DRQ)
141 							&& count++ < 65536;)
142 		ioread8(ap->ioaddr.data_addr);
143 
144 	if (count)
145 		ata_port_warn(ap, "drained %d bytes to clear DRQ\n", count);
146 
147 }
148 
149 static struct scsi_host_template pcmcia_sht = {
150 	ATA_PIO_SHT(DRV_NAME),
151 };
152 
153 static struct ata_port_operations pcmcia_port_ops = {
154 	.inherits	= &ata_sff_port_ops,
155 	.sff_data_xfer	= ata_sff_data_xfer_noirq,
156 	.cable_detect	= ata_cable_40wire,
157 	.set_mode	= pcmcia_set_mode,
158 };
159 
160 static struct ata_port_operations pcmcia_8bit_port_ops = {
161 	.inherits	= &ata_sff_port_ops,
162 	.sff_data_xfer	= ata_data_xfer_8bit,
163 	.cable_detect	= ata_cable_40wire,
164 	.set_mode	= pcmcia_set_mode_8bit,
165 	.sff_drain_fifo	= pcmcia_8bit_drain_fifo,
166 };
167 
168 
169 static int pcmcia_check_one_config(struct pcmcia_device *pdev, void *priv_data)
170 {
171 	int *is_kme = priv_data;
172 
173 	if ((pdev->resource[0]->flags & IO_DATA_PATH_WIDTH)
174 	    != IO_DATA_PATH_WIDTH_8) {
175 		pdev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
176 		pdev->resource[0]->flags |= IO_DATA_PATH_WIDTH_AUTO;
177 	}
178 	pdev->resource[1]->flags &= ~IO_DATA_PATH_WIDTH;
179 	pdev->resource[1]->flags |= IO_DATA_PATH_WIDTH_8;
180 
181 	if (pdev->resource[1]->end) {
182 		pdev->resource[0]->end = 8;
183 		pdev->resource[1]->end = (*is_kme) ? 2 : 1;
184 	} else {
185 		if (pdev->resource[0]->end < 16)
186 			return -ENODEV;
187 	}
188 
189 	return pcmcia_request_io(pdev);
190 }
191 
192 /**
193  *	pcmcia_init_one		-	attach a PCMCIA interface
194  *	@pdev: pcmcia device
195  *
196  *	Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
197  *	shared IRQ.
198  */
199 
200 static int pcmcia_init_one(struct pcmcia_device *pdev)
201 {
202 	struct ata_host *host;
203 	struct ata_port *ap;
204 	int is_kme = 0, ret = -ENOMEM, p;
205 	unsigned long io_base, ctl_base;
206 	void __iomem *io_addr, *ctl_addr;
207 	int n_ports = 1;
208 	struct ata_port_operations *ops = &pcmcia_port_ops;
209 
210 	/* Set up attributes in order to probe card and get resources */
211 	pdev->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_IO |
212 		CONF_AUTO_SET_VPP | CONF_AUTO_CHECK_VCC;
213 
214 	/* See if we have a manufacturer identifier. Use it to set is_kme for
215 	   vendor quirks */
216 	is_kme = ((pdev->manf_id == MANFID_KME) &&
217 		  ((pdev->card_id == PRODID_KME_KXLC005_A) ||
218 		   (pdev->card_id == PRODID_KME_KXLC005_B)));
219 
220 	if (pcmcia_loop_config(pdev, pcmcia_check_one_config, &is_kme)) {
221 		pdev->config_flags &= ~CONF_AUTO_CHECK_VCC;
222 		if (pcmcia_loop_config(pdev, pcmcia_check_one_config, &is_kme))
223 			goto failed; /* No suitable config found */
224 	}
225 	io_base = pdev->resource[0]->start;
226 	if (pdev->resource[1]->end)
227 		ctl_base = pdev->resource[1]->start;
228 	else
229 		ctl_base = pdev->resource[0]->start + 0x0e;
230 
231 	if (!pdev->irq)
232 		goto failed;
233 
234 	ret = pcmcia_enable_device(pdev);
235 	if (ret)
236 		goto failed;
237 
238 	/* iomap */
239 	ret = -ENOMEM;
240 	io_addr = devm_ioport_map(&pdev->dev, io_base, 8);
241 	ctl_addr = devm_ioport_map(&pdev->dev, ctl_base, 1);
242 	if (!io_addr || !ctl_addr)
243 		goto failed;
244 
245 	/* Success. Disable the IRQ nIEN line, do quirks */
246 	iowrite8(0x02, ctl_addr);
247 	if (is_kme)
248 		iowrite8(0x81, ctl_addr + 0x01);
249 
250 	/* FIXME: Could be more ports at base + 0x10 but we only deal with
251 	   one right now */
252 	if (resource_size(pdev->resource[0]) >= 0x20)
253 		n_ports = 2;
254 
255 	if (pdev->manf_id == 0x0097 && pdev->card_id == 0x1620)
256 		ops = &pcmcia_8bit_port_ops;
257 	/*
258 	 *	Having done the PCMCIA plumbing the ATA side is relatively
259 	 *	sane.
260 	 */
261 	ret = -ENOMEM;
262 	host = ata_host_alloc(&pdev->dev, n_ports);
263 	if (!host)
264 		goto failed;
265 
266 	for (p = 0; p < n_ports; p++) {
267 		ap = host->ports[p];
268 
269 		ap->ops = ops;
270 		ap->pio_mask = ATA_PIO0;	/* ISA so PIO 0 cycles */
271 		ap->flags |= ATA_FLAG_SLAVE_POSS;
272 		ap->ioaddr.cmd_addr = io_addr + 0x10 * p;
273 		ap->ioaddr.altstatus_addr = ctl_addr + 0x10 * p;
274 		ap->ioaddr.ctl_addr = ctl_addr + 0x10 * p;
275 		ata_sff_std_ports(&ap->ioaddr);
276 
277 		ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx", io_base, ctl_base);
278 	}
279 
280 	/* activate */
281 	ret = ata_host_activate(host, pdev->irq, ata_sff_interrupt,
282 				IRQF_SHARED, &pcmcia_sht);
283 	if (ret)
284 		goto failed;
285 
286 	pdev->priv = host;
287 	return 0;
288 
289 failed:
290 	pcmcia_disable_device(pdev);
291 	return ret;
292 }
293 
294 /**
295  *	pcmcia_remove_one	-	unplug an pcmcia interface
296  *	@pdev: pcmcia device
297  *
298  *	A PCMCIA ATA device has been unplugged. Perform the needed
299  *	cleanup. Also called on module unload for any active devices.
300  */
301 
302 static void pcmcia_remove_one(struct pcmcia_device *pdev)
303 {
304 	struct ata_host *host = pdev->priv;
305 
306 	if (host)
307 		ata_host_detach(host);
308 
309 	pcmcia_disable_device(pdev);
310 }
311 
312 static const struct pcmcia_device_id pcmcia_devices[] = {
313 	PCMCIA_DEVICE_FUNC_ID(4),
314 	PCMCIA_DEVICE_MANF_CARD(0x0000, 0x0000),	/* Corsair */
315 	PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),	/* Hitachi */
316 	PCMCIA_DEVICE_MANF_CARD(0x000a, 0x0000),	/* I-O Data CFA */
317 	PCMCIA_DEVICE_MANF_CARD(0x001c, 0x0001),	/* Mitsubishi CFA */
318 	PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
319 	PCMCIA_DEVICE_MANF_CARD(0x0032, 0x2904),
320 	PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),	/* SanDisk CFA */
321 	PCMCIA_DEVICE_MANF_CARD(0x004f, 0x0000),	/* Kingston */
322 	PCMCIA_DEVICE_MANF_CARD(0x0097, 0x1620), 	/* TI emulated */
323 	PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),	/* Toshiba */
324 	PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
325 	PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),	/* Samsung */
326 	PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),	/* Hitachi */
327 	PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
328 	PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0100),	/* Viking CFA */
329 	PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),	/* Lexar, Viking CFA */
330 	PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
331 	PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
332 	PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
333 	PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
334 	PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
335 	PCMCIA_DEVICE_PROD_ID12("CNF   ", "CD-ROM", 0x46d7db81, 0x66536591),
336 	PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
337 	PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
338 	PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
339 	PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
340 	PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
341 	PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
342 	PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
343 	PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
344 	PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
345 	PCMCIA_DEVICE_PROD_ID12("Hyperstone", "Model1", 0x3d5b9ef5, 0xca6ab420),
346 	PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
347 	PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
348 	PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF CARD 1GB", 0x2e6d1829, 0x55d5bffb),
349 	PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF CARD 4GB", 0x2e6d1829, 0x531e7d10),
350 	PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF8GB", 0x2e6d1829, 0xacbe682e),
351 	PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
352 	PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
353 	PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
354 	PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
355 	PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF300", 0x7ed2ad87, 0x7e9e78ee),
356 	PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
357 	PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
358 	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
359 	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
360 	PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
361 	PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
362 	PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
363 	PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
364 	PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
365 	PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
366 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF45", 0x709b1bf1, 0xf68b6f32),
367 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
368 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS2GCF120", 0x709b1bf1, 0x969aa4f2),
369 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
370 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF133", 0x709b1bf1, 0x7558f133),
371 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS8GCF133", 0x709b1bf1, 0xb2f89b47),
372 	PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
373 	PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
374 	PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
375 	PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
376 	PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
377 	PCMCIA_DEVICE_PROD_ID2("Flash Card", 0x5a362506),
378 	PCMCIA_DEVICE_NULL,
379 };
380 
381 MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
382 
383 static struct pcmcia_driver pcmcia_driver = {
384 	.owner		= THIS_MODULE,
385 	.name		= DRV_NAME,
386 	.id_table	= pcmcia_devices,
387 	.probe		= pcmcia_init_one,
388 	.remove		= pcmcia_remove_one,
389 };
390 
391 static int __init pcmcia_init(void)
392 {
393 	return pcmcia_register_driver(&pcmcia_driver);
394 }
395 
396 static void __exit pcmcia_exit(void)
397 {
398 	pcmcia_unregister_driver(&pcmcia_driver);
399 }
400 
401 MODULE_AUTHOR("Alan Cox");
402 MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
403 MODULE_LICENSE("GPL");
404 MODULE_VERSION(DRV_VERSION);
405 
406 module_init(pcmcia_init);
407 module_exit(pcmcia_exit);
408