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