pata_pcmcia.c revision 5682ed33aae05d10a25c95633ef9d9c062825888
1/*
2 *   pata_pcmcia.c - PCMCIA PATA controller driver.
3 *   Copyright 2005-2006 Red Hat Inc <alan@redhat.com>, 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 <scsi/scsi_host.h>
33#include <linux/ata.h>
34#include <linux/libata.h>
35
36#include <pcmcia/cs_types.h>
37#include <pcmcia/cs.h>
38#include <pcmcia/cistpl.h>
39#include <pcmcia/ds.h>
40#include <pcmcia/cisreg.h>
41#include <pcmcia/ciscode.h>
42
43
44#define DRV_NAME "pata_pcmcia"
45#define DRV_VERSION "0.3.3"
46
47/*
48 *	Private data structure to glue stuff together
49 */
50
51struct ata_pcmcia_info {
52	struct pcmcia_device *pdev;
53	int		ndev;
54	dev_node_t	node;
55};
56
57/**
58 *	pcmcia_set_mode	-	PCMCIA specific mode setup
59 *	@link: link
60 *	@r_failed_dev: Return pointer for failed device
61 *
62 *	Perform the tuning and setup of the devices and timings, which
63 *	for PCMCIA is the same as any other controller. We wrap it however
64 *	as we need to spot hardware with incorrect or missing master/slave
65 *	decode, which alas is embarrassingly common in the PC world
66 */
67
68static int pcmcia_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
69{
70	struct ata_device *master = &link->device[0];
71	struct ata_device *slave = &link->device[1];
72
73	if (!ata_dev_enabled(master) || !ata_dev_enabled(slave))
74		return ata_do_set_mode(link, r_failed_dev);
75
76	if (memcmp(master->id + ATA_ID_FW_REV,  slave->id + ATA_ID_FW_REV,
77			   ATA_ID_FW_REV_LEN + ATA_ID_PROD_LEN) == 0) {
78		/* Suspicious match, but could be two cards from
79		   the same vendor - check serial */
80		if (memcmp(master->id + ATA_ID_SERNO, slave->id + ATA_ID_SERNO,
81			   ATA_ID_SERNO_LEN) == 0 && master->id[ATA_ID_SERNO] >> 8) {
82			ata_dev_printk(slave, KERN_WARNING, "is a ghost device, ignoring.\n");
83			ata_dev_disable(slave);
84		}
85	}
86	return ata_do_set_mode(link, r_failed_dev);
87}
88
89/**
90 *	pcmcia_set_mode_8bit	-	PCMCIA specific mode setup
91 *	@link: link
92 *	@r_failed_dev: Return pointer for failed device
93 *
94 *	For the simple emulated 8bit stuff the less we do the better.
95 */
96
97static int pcmcia_set_mode_8bit(struct ata_link *link,
98				struct ata_device **r_failed_dev)
99{
100	return 0;
101}
102
103/**
104 *	ata_data_xfer_8bit	 -	Transfer data by 8bit PIO
105 *	@dev: device to target
106 *	@buf: data buffer
107 *	@buflen: buffer length
108 *	@rw: read/write
109 *
110 *	Transfer data from/to the device data register by 8 bit PIO.
111 *
112 *	LOCKING:
113 *	Inherited from caller.
114 */
115
116static unsigned int ata_data_xfer_8bit(struct ata_device *dev,
117				unsigned char *buf, unsigned int buflen, int rw)
118{
119	struct ata_port *ap = dev->link->ap;
120
121	if (rw == READ)
122		ioread8_rep(ap->ioaddr.data_addr, buf, buflen);
123	else
124		iowrite8_rep(ap->ioaddr.data_addr, buf, buflen);
125
126	return buflen;
127}
128
129
130static struct scsi_host_template pcmcia_sht = {
131	ATA_PIO_SHT(DRV_NAME),
132};
133
134static struct ata_port_operations pcmcia_port_ops = {
135	.inherits	= &ata_sff_port_ops,
136	.sff_data_xfer	= ata_sff_data_xfer_noirq,
137	.cable_detect	= ata_cable_40wire,
138	.set_mode	= pcmcia_set_mode,
139};
140
141static struct ata_port_operations pcmcia_8bit_port_ops = {
142	.inherits	= &ata_sff_port_ops,
143	.sff_data_xfer	= ata_data_xfer_8bit,
144	.cable_detect	= ata_cable_40wire,
145	.set_mode	= pcmcia_set_mode_8bit,
146};
147
148#define CS_CHECK(fn, ret) \
149do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
150
151/**
152 *	pcmcia_init_one		-	attach a PCMCIA interface
153 *	@pdev: pcmcia device
154 *
155 *	Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
156 *	shared IRQ.
157 */
158
159static int pcmcia_init_one(struct pcmcia_device *pdev)
160{
161	struct ata_host *host;
162	struct ata_port *ap;
163	struct ata_pcmcia_info *info;
164	tuple_t tuple;
165	struct {
166		unsigned short buf[128];
167		cisparse_t parse;
168		config_info_t conf;
169		cistpl_cftable_entry_t dflt;
170	} *stk = NULL;
171	cistpl_cftable_entry_t *cfg;
172	int pass, last_ret = 0, last_fn = 0, is_kme = 0, ret = -ENOMEM, p;
173	unsigned long io_base, ctl_base;
174	void __iomem *io_addr, *ctl_addr;
175	int n_ports = 1;
176
177	struct ata_port_operations *ops = &pcmcia_port_ops;
178
179	info = kzalloc(sizeof(*info), GFP_KERNEL);
180	if (info == NULL)
181		return -ENOMEM;
182
183	/* Glue stuff together. FIXME: We may be able to get rid of info with care */
184	info->pdev = pdev;
185	pdev->priv = info;
186
187	/* Set up attributes in order to probe card and get resources */
188	pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
189	pdev->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
190	pdev->io.IOAddrLines = 3;
191	pdev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
192	pdev->irq.IRQInfo1 = IRQ_LEVEL_ID;
193	pdev->conf.Attributes = CONF_ENABLE_IRQ;
194	pdev->conf.IntType = INT_MEMORY_AND_IO;
195
196	/* Allocate resoure probing structures */
197
198	stk = kzalloc(sizeof(*stk), GFP_KERNEL);
199	if (!stk)
200		goto out1;
201
202	cfg = &stk->parse.cftable_entry;
203
204	/* Tuples we are walking */
205	tuple.TupleData = (cisdata_t *)&stk->buf;
206	tuple.TupleOffset = 0;
207	tuple.TupleDataMax = 255;
208	tuple.Attributes = 0;
209
210	/* See if we have a manufacturer identifier. Use it to set is_kme for
211	   vendor quirks */
212	is_kme = ((pdev->manf_id == MANFID_KME) &&
213		  ((pdev->card_id == PRODID_KME_KXLC005_A) ||
214		   (pdev->card_id == PRODID_KME_KXLC005_B)));
215
216	/* Not sure if this is right... look up the current Vcc */
217	CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(pdev, &stk->conf));
218/*	link->conf.Vcc = stk->conf.Vcc; */
219
220	pass = io_base = ctl_base = 0;
221	tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
222	tuple.Attributes = 0;
223	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
224
225	/* Now munch the resources looking for a suitable set */
226	while (1) {
227		if (pcmcia_get_tuple_data(pdev, &tuple) != 0)
228			goto next_entry;
229		if (pcmcia_parse_tuple(pdev, &tuple, &stk->parse) != 0)
230			goto next_entry;
231		/* Check for matching Vcc, unless we're desperate */
232		if (!pass) {
233			if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
234				if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
235					goto next_entry;
236			} else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
237				if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
238					goto next_entry;
239			}
240		}
241
242		if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
243			pdev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
244		else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
245			pdev->conf.Vpp = stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
246
247		if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
248			cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
249			pdev->conf.ConfigIndex = cfg->index;
250			pdev->io.BasePort1 = io->win[0].base;
251			pdev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
252			if (!(io->flags & CISTPL_IO_16BIT))
253				pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
254			if (io->nwin == 2) {
255				pdev->io.NumPorts1 = 8;
256				pdev->io.BasePort2 = io->win[1].base;
257				pdev->io.NumPorts2 = (is_kme) ? 2 : 1;
258				if (pcmcia_request_io(pdev, &pdev->io) != 0)
259					goto next_entry;
260				io_base = pdev->io.BasePort1;
261				ctl_base = pdev->io.BasePort2;
262			} else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
263				pdev->io.NumPorts1 = io->win[0].len;
264				pdev->io.NumPorts2 = 0;
265				if (pcmcia_request_io(pdev, &pdev->io) != 0)
266					goto next_entry;
267				io_base = pdev->io.BasePort1;
268				ctl_base = pdev->io.BasePort1 + 0x0e;
269			} else
270				goto next_entry;
271			/* If we've got this far, we're done */
272			break;
273		}
274next_entry:
275		if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
276			memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
277		if (pass) {
278			CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(pdev, &tuple));
279		} else if (pcmcia_get_next_tuple(pdev, &tuple) != 0) {
280			CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
281			memset(&stk->dflt, 0, sizeof(stk->dflt));
282			pass++;
283		}
284	}
285
286	CS_CHECK(RequestIRQ, pcmcia_request_irq(pdev, &pdev->irq));
287	CS_CHECK(RequestConfiguration, pcmcia_request_configuration(pdev, &pdev->conf));
288
289	/* iomap */
290	ret = -ENOMEM;
291	io_addr = devm_ioport_map(&pdev->dev, io_base, 8);
292	ctl_addr = devm_ioport_map(&pdev->dev, ctl_base, 1);
293	if (!io_addr || !ctl_addr)
294		goto failed;
295
296	/* Success. Disable the IRQ nIEN line, do quirks */
297	iowrite8(0x02, ctl_addr);
298	if (is_kme)
299		iowrite8(0x81, ctl_addr + 0x01);
300
301	/* FIXME: Could be more ports at base + 0x10 but we only deal with
302	   one right now */
303	if (pdev->io.NumPorts1 >= 0x20)
304		n_ports = 2;
305
306	if (pdev->manf_id == 0x0097 && pdev->card_id == 0x1620)
307		ops = &pcmcia_8bit_port_ops;
308	/*
309	 *	Having done the PCMCIA plumbing the ATA side is relatively
310	 *	sane.
311	 */
312	ret = -ENOMEM;
313	host = ata_host_alloc(&pdev->dev, n_ports);
314	if (!host)
315		goto failed;
316
317	for (p = 0; p < n_ports; p++) {
318		ap = host->ports[p];
319
320		ap->ops = ops;
321		ap->pio_mask = 1;		/* ISA so PIO 0 cycles */
322		ap->flags |= ATA_FLAG_SLAVE_POSS;
323		ap->ioaddr.cmd_addr = io_addr + 0x10 * p;
324		ap->ioaddr.altstatus_addr = ctl_addr + 0x10 * p;
325		ap->ioaddr.ctl_addr = ctl_addr + 0x10 * p;
326		ata_sff_std_ports(&ap->ioaddr);
327
328		ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx", io_base, ctl_base);
329	}
330
331	/* activate */
332	ret = ata_host_activate(host, pdev->irq.AssignedIRQ, ata_sff_interrupt,
333				IRQF_SHARED, &pcmcia_sht);
334	if (ret)
335		goto failed;
336
337	info->ndev = 1;
338	kfree(stk);
339	return 0;
340
341cs_failed:
342	cs_error(pdev, last_fn, last_ret);
343failed:
344	kfree(stk);
345	info->ndev = 0;
346	pcmcia_disable_device(pdev);
347out1:
348	kfree(info);
349	return ret;
350}
351
352/**
353 *	pcmcia_remove_one	-	unplug an pcmcia interface
354 *	@pdev: pcmcia device
355 *
356 *	A PCMCIA ATA device has been unplugged. Perform the needed
357 *	cleanup. Also called on module unload for any active devices.
358 */
359
360static void pcmcia_remove_one(struct pcmcia_device *pdev)
361{
362	struct ata_pcmcia_info *info = pdev->priv;
363	struct device *dev = &pdev->dev;
364
365	if (info != NULL) {
366		/* If we have attached the device to the ATA layer, detach it */
367		if (info->ndev) {
368			struct ata_host *host = dev_get_drvdata(dev);
369			ata_host_detach(host);
370		}
371		info->ndev = 0;
372		pdev->priv = NULL;
373	}
374	pcmcia_disable_device(pdev);
375	kfree(info);
376}
377
378static struct pcmcia_device_id pcmcia_devices[] = {
379	PCMCIA_DEVICE_FUNC_ID(4),
380	PCMCIA_DEVICE_MANF_CARD(0x0000, 0x0000),	/* Corsair */
381	PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),	/* Hitachi */
382	PCMCIA_DEVICE_MANF_CARD(0x000a, 0x0000),	/* I-O Data CFA */
383	PCMCIA_DEVICE_MANF_CARD(0x001c, 0x0001),	/* Mitsubishi CFA */
384	PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
385	PCMCIA_DEVICE_MANF_CARD(0x0032, 0x2904),
386	PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),	/* SanDisk CFA */
387	PCMCIA_DEVICE_MANF_CARD(0x0097, 0x1620), 	/* TI emulated */
388	PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),	/* Toshiba */
389	PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
390	PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),	/* Samsung */
391	PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),	/* Hitachi */
392	PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
393	PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0100),	/* Viking CFA */
394	PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),	/* Lexar, Viking CFA */
395	PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
396	PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
397	PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
398	PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
399	PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
400	PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
401	PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
402	PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
403	PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
404	PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
405	PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
406	PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
407	PCMCIA_DEVICE_PROD_ID12("Hyperstone", "Model1", 0x3d5b9ef5, 0xca6ab420),
408	PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
409	PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
410	PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
411	PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
412	PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF8GB", 0x2e6d1829, 0xacbe682e),
413	PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
414	PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
415	PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
416	PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
417	PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
418	PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
419	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
420	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
421	PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
422	PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
423	PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
424	PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
425	PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
426	PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
427	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
428	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS2GCF120", 0x709b1bf1, 0x969aa4f2),
429	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
430	PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
431	PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
432	PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
433	PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
434	PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
435	PCMCIA_DEVICE_NULL,
436};
437
438MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
439
440static struct pcmcia_driver pcmcia_driver = {
441	.owner		= THIS_MODULE,
442	.drv = {
443		.name		= DRV_NAME,
444	},
445	.id_table	= pcmcia_devices,
446	.probe		= pcmcia_init_one,
447	.remove		= pcmcia_remove_one,
448};
449
450static int __init pcmcia_init(void)
451{
452	return pcmcia_register_driver(&pcmcia_driver);
453}
454
455static void __exit pcmcia_exit(void)
456{
457	pcmcia_unregister_driver(&pcmcia_driver);
458}
459
460MODULE_AUTHOR("Alan Cox");
461MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
462MODULE_LICENSE("GPL");
463MODULE_VERSION(DRV_VERSION);
464
465module_init(pcmcia_init);
466module_exit(pcmcia_exit);
467