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