xref: /openbmc/linux/drivers/ata/pata_pcmcia.c (revision c21b37f6)
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.1"
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  *	@ap: Port
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_port *ap, struct ata_device **r_failed_dev)
69 {
70 	struct ata_device *master = &ap->device[0];
71 	struct ata_device *slave = &ap->device[1];
72 
73 	if (!ata_dev_enabled(master) || !ata_dev_enabled(slave))
74 		return ata_do_set_mode(ap, 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(ap, 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 	.port_disable	= ata_port_disable,
111 	.tf_load	= ata_tf_load,
112 	.tf_read	= ata_tf_read,
113 	.check_status 	= ata_check_status,
114 	.exec_command	= ata_exec_command,
115 	.dev_select 	= ata_std_dev_select,
116 
117 	.freeze		= ata_bmdma_freeze,
118 	.thaw		= ata_bmdma_thaw,
119 	.error_handler	= ata_bmdma_error_handler,
120 	.post_internal_cmd = ata_bmdma_post_internal_cmd,
121 	.cable_detect	= ata_cable_40wire,
122 
123 	.qc_prep 	= ata_qc_prep,
124 	.qc_issue	= ata_qc_issue_prot,
125 
126 	.data_xfer	= ata_data_xfer_noirq,
127 
128 	.irq_clear	= ata_bmdma_irq_clear,
129 	.irq_on		= ata_irq_on,
130 	.irq_ack	= ata_irq_ack,
131 
132 	.port_start	= ata_sff_port_start,
133 };
134 
135 #define CS_CHECK(fn, ret) \
136 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
137 
138 /**
139  *	pcmcia_init_one		-	attach a PCMCIA interface
140  *	@pdev: pcmcia device
141  *
142  *	Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
143  *	shared IRQ.
144  */
145 
146 static int pcmcia_init_one(struct pcmcia_device *pdev)
147 {
148 	struct ata_host *host;
149 	struct ata_port *ap;
150 	struct ata_pcmcia_info *info;
151 	tuple_t tuple;
152 	struct {
153 		unsigned short buf[128];
154 		cisparse_t parse;
155 		config_info_t conf;
156 		cistpl_cftable_entry_t dflt;
157 	} *stk = NULL;
158 	cistpl_cftable_entry_t *cfg;
159 	int pass, last_ret = 0, last_fn = 0, is_kme = 0, ret = -ENOMEM;
160 	unsigned long io_base, ctl_base;
161 	void __iomem *io_addr, *ctl_addr;
162 
163 	info = kzalloc(sizeof(*info), GFP_KERNEL);
164 	if (info == NULL)
165 		return -ENOMEM;
166 
167 	/* Glue stuff together. FIXME: We may be able to get rid of info with care */
168 	info->pdev = pdev;
169 	pdev->priv = info;
170 
171 	/* Set up attributes in order to probe card and get resources */
172 	pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
173 	pdev->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
174 	pdev->io.IOAddrLines = 3;
175 	pdev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
176 	pdev->irq.IRQInfo1 = IRQ_LEVEL_ID;
177 	pdev->conf.Attributes = CONF_ENABLE_IRQ;
178 	pdev->conf.IntType = INT_MEMORY_AND_IO;
179 
180 	/* Allocate resoure probing structures */
181 
182 	stk = kzalloc(sizeof(*stk), GFP_KERNEL);
183 	if (!stk)
184 		goto out1;
185 
186 	cfg = &stk->parse.cftable_entry;
187 
188 	/* Tuples we are walking */
189 	tuple.TupleData = (cisdata_t *)&stk->buf;
190 	tuple.TupleOffset = 0;
191 	tuple.TupleDataMax = 255;
192 	tuple.Attributes = 0;
193 
194 	/* See if we have a manufacturer identifier. Use it to set is_kme for
195 	   vendor quirks */
196 	is_kme = ((pdev->manf_id == MANFID_KME) &&
197 		  ((pdev->card_id == PRODID_KME_KXLC005_A) ||
198 		   (pdev->card_id == PRODID_KME_KXLC005_B)));
199 
200 	/* Not sure if this is right... look up the current Vcc */
201 	CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(pdev, &stk->conf));
202 /*	link->conf.Vcc = stk->conf.Vcc; */
203 
204 	pass = io_base = ctl_base = 0;
205 	tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
206 	tuple.Attributes = 0;
207 	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
208 
209 	/* Now munch the resources looking for a suitable set */
210 	while (1) {
211 		if (pcmcia_get_tuple_data(pdev, &tuple) != 0)
212 			goto next_entry;
213 		if (pcmcia_parse_tuple(pdev, &tuple, &stk->parse) != 0)
214 			goto next_entry;
215 		/* Check for matching Vcc, unless we're desperate */
216 		if (!pass) {
217 			if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
218 				if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
219 					goto next_entry;
220 			} else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
221 				if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
222 					goto next_entry;
223 			}
224 		}
225 
226 		if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
227 			pdev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
228 		else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
229 			pdev->conf.Vpp = stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
230 
231 		if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
232 			cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
233 			pdev->conf.ConfigIndex = cfg->index;
234 			pdev->io.BasePort1 = io->win[0].base;
235 			pdev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
236 			if (!(io->flags & CISTPL_IO_16BIT))
237 				pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
238 			if (io->nwin == 2) {
239 				pdev->io.NumPorts1 = 8;
240 				pdev->io.BasePort2 = io->win[1].base;
241 				pdev->io.NumPorts2 = (is_kme) ? 2 : 1;
242 				if (pcmcia_request_io(pdev, &pdev->io) != 0)
243 					goto next_entry;
244 				io_base = pdev->io.BasePort1;
245 				ctl_base = pdev->io.BasePort2;
246 			} else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
247 				pdev->io.NumPorts1 = io->win[0].len;
248 				pdev->io.NumPorts2 = 0;
249 				if (pcmcia_request_io(pdev, &pdev->io) != 0)
250 					goto next_entry;
251 				io_base = pdev->io.BasePort1;
252 				ctl_base = pdev->io.BasePort1 + 0x0e;
253 			} else goto next_entry;
254 			/* If we've got this far, we're done */
255 			break;
256 		}
257 next_entry:
258 		if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
259 			memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
260 		if (pass) {
261 			CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(pdev, &tuple));
262 		} else if (pcmcia_get_next_tuple(pdev, &tuple) != 0) {
263 			CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
264 			memset(&stk->dflt, 0, sizeof(stk->dflt));
265 			pass++;
266 		}
267 	}
268 
269 	CS_CHECK(RequestIRQ, pcmcia_request_irq(pdev, &pdev->irq));
270 	CS_CHECK(RequestConfiguration, pcmcia_request_configuration(pdev, &pdev->conf));
271 
272 	/* iomap */
273 	ret = -ENOMEM;
274 	io_addr = devm_ioport_map(&pdev->dev, io_base, 8);
275 	ctl_addr = devm_ioport_map(&pdev->dev, ctl_base, 1);
276 	if (!io_addr || !ctl_addr)
277 		goto failed;
278 
279 	/* Success. Disable the IRQ nIEN line, do quirks */
280 	iowrite8(0x02, ctl_addr);
281 	if (is_kme)
282 		iowrite8(0x81, ctl_addr + 0x01);
283 
284 	/* FIXME: Could be more ports at base + 0x10 but we only deal with
285 	   one right now */
286 	if (pdev->io.NumPorts1 >= 0x20)
287 		printk(KERN_WARNING DRV_NAME ": second channel not yet supported.\n");
288 
289 	/*
290  	 *	Having done the PCMCIA plumbing the ATA side is relatively
291  	 *	sane.
292 	 */
293 	ret = -ENOMEM;
294 	host = ata_host_alloc(&pdev->dev, 1);
295 	if (!host)
296 		goto failed;
297 	ap = host->ports[0];
298 
299 	ap->ops = &pcmcia_port_ops;
300 	ap->pio_mask = 1;		/* ISA so PIO 0 cycles */
301 	ap->flags |= ATA_FLAG_SLAVE_POSS;
302 	ap->ioaddr.cmd_addr = io_addr;
303 	ap->ioaddr.altstatus_addr = ctl_addr;
304 	ap->ioaddr.ctl_addr = ctl_addr;
305 	ata_std_ports(&ap->ioaddr);
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(0x0007, 0x0000),	/* Hitachi */
357 	PCMCIA_DEVICE_MANF_CARD(0x000a, 0x0000),	/* I-O Data CFA */
358 	PCMCIA_DEVICE_MANF_CARD(0x001c, 0x0001),	/* Mitsubishi CFA */
359 	PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
360 	PCMCIA_DEVICE_MANF_CARD(0x0032, 0x2904),
361 	PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),	/* SanDisk CFA */
362 	PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),	/* Toshiba */
363 	PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
364 	PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),	/* Samsung */
365  	PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),	/* Hitachi */
366 	PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
367 	PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0100),	/* Viking CFA */
368 	PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),	/* Lexar, Viking CFA */
369 	PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
370 	PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
371 	PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
372 	PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
373 	PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
374 	PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
375 	PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
376 	PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
377 	PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
378 	PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
379 	PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
380 	PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
381 	PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
382 	PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
383 	PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
384 	PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
385 	PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF8GB", 0x2e6d1829, 0xacbe682e),
386 	PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
387 	PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
388 	PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
389 	PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
390 	PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
391 	PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
392 	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
393 	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
394 	PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
395 	PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
396 	PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
397 	PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
398 	PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
399 	PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
400 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
401 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS2GCF120", 0x709b1bf1, 0x969aa4f2),
402 	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
403 	PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
404 	PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
405 	PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
406 	PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
407 	PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
408 	PCMCIA_DEVICE_NULL,
409 };
410 
411 MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
412 
413 static struct pcmcia_driver pcmcia_driver = {
414 	.owner		= THIS_MODULE,
415 	.drv = {
416 		.name		= DRV_NAME,
417 	},
418 	.id_table	= pcmcia_devices,
419 	.probe		= pcmcia_init_one,
420 	.remove		= pcmcia_remove_one,
421 };
422 
423 static int __init pcmcia_init(void)
424 {
425 	return pcmcia_register_driver(&pcmcia_driver);
426 }
427 
428 static void __exit pcmcia_exit(void)
429 {
430 	pcmcia_unregister_driver(&pcmcia_driver);
431 }
432 
433 MODULE_AUTHOR("Alan Cox");
434 MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
435 MODULE_LICENSE("GPL");
436 MODULE_VERSION(DRV_VERSION);
437 
438 module_init(pcmcia_init);
439 module_exit(pcmcia_exit);
440