pata_pcmcia.c revision cb48cab7f363014e0a5dc21f7b4892c15d626d41
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.0"
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
57static struct scsi_host_template pcmcia_sht = {
58	.module			= THIS_MODULE,
59	.name			= DRV_NAME,
60	.ioctl			= ata_scsi_ioctl,
61	.queuecommand		= ata_scsi_queuecmd,
62	.can_queue		= ATA_DEF_QUEUE,
63	.this_id		= ATA_SHT_THIS_ID,
64	.sg_tablesize		= LIBATA_MAX_PRD,
65	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
66	.emulated		= ATA_SHT_EMULATED,
67	.use_clustering		= ATA_SHT_USE_CLUSTERING,
68	.proc_name		= DRV_NAME,
69	.dma_boundary		= ATA_DMA_BOUNDARY,
70	.slave_configure	= ata_scsi_slave_config,
71	.slave_destroy		= ata_scsi_slave_destroy,
72	.bios_param		= ata_std_bios_param,
73};
74
75static struct ata_port_operations pcmcia_port_ops = {
76	.port_disable	= ata_port_disable,
77	.tf_load	= ata_tf_load,
78	.tf_read	= ata_tf_read,
79	.check_status 	= ata_check_status,
80	.exec_command	= ata_exec_command,
81	.dev_select 	= ata_std_dev_select,
82
83	.freeze		= ata_bmdma_freeze,
84	.thaw		= ata_bmdma_thaw,
85	.error_handler	= ata_bmdma_error_handler,
86	.post_internal_cmd = ata_bmdma_post_internal_cmd,
87
88	.qc_prep 	= ata_qc_prep,
89	.qc_issue	= ata_qc_issue_prot,
90
91	.data_xfer	= ata_data_xfer_noirq,
92
93	.irq_handler	= ata_interrupt,
94	.irq_clear	= ata_bmdma_irq_clear,
95	.irq_on		= ata_irq_on,
96	.irq_ack	= ata_irq_ack,
97
98	.port_start	= ata_port_start,
99};
100
101#define CS_CHECK(fn, ret) \
102do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
103
104/**
105 *	pcmcia_init_one		-	attach a PCMCIA interface
106 *	@pdev: pcmcia device
107 *
108 *	Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
109 *	shared IRQ.
110 */
111
112static int pcmcia_init_one(struct pcmcia_device *pdev)
113{
114	struct ata_probe_ent ae;
115	struct ata_pcmcia_info *info;
116	tuple_t tuple;
117	struct {
118		unsigned short buf[128];
119		cisparse_t parse;
120		config_info_t conf;
121		cistpl_cftable_entry_t dflt;
122	} *stk = NULL;
123	cistpl_cftable_entry_t *cfg;
124	int pass, last_ret = 0, last_fn = 0, is_kme = 0, ret = -ENOMEM;
125	unsigned long io_base, ctl_base;
126	void __iomem *io_addr, *ctl_addr;
127
128	info = kzalloc(sizeof(*info), GFP_KERNEL);
129	if (info == NULL)
130		return -ENOMEM;
131
132	/* Glue stuff together. FIXME: We may be able to get rid of info with care */
133	info->pdev = pdev;
134	pdev->priv = info;
135
136	/* Set up attributes in order to probe card and get resources */
137	pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
138	pdev->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
139	pdev->io.IOAddrLines = 3;
140	pdev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
141	pdev->irq.IRQInfo1 = IRQ_LEVEL_ID;
142	pdev->conf.Attributes = CONF_ENABLE_IRQ;
143	pdev->conf.IntType = INT_MEMORY_AND_IO;
144
145	/* Allocate resoure probing structures */
146
147	stk = kzalloc(sizeof(*stk), GFP_KERNEL);
148	if (!stk)
149		goto out1;
150
151	cfg = &stk->parse.cftable_entry;
152
153	/* Tuples we are walking */
154	tuple.TupleData = (cisdata_t *)&stk->buf;
155	tuple.TupleOffset = 0;
156	tuple.TupleDataMax = 255;
157	tuple.Attributes = 0;
158
159	/* See if we have a manufacturer identifier. Use it to set is_kme for
160	   vendor quirks */
161	is_kme = ((pdev->manf_id == MANFID_KME) &&
162		  ((pdev->card_id == PRODID_KME_KXLC005_A) ||
163		   (pdev->card_id == PRODID_KME_KXLC005_B)));
164
165	/* Not sure if this is right... look up the current Vcc */
166	CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(pdev, &stk->conf));
167/*	link->conf.Vcc = stk->conf.Vcc; */
168
169	pass = io_base = ctl_base = 0;
170	tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
171	tuple.Attributes = 0;
172	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
173
174	/* Now munch the resources looking for a suitable set */
175	while (1) {
176		if (pcmcia_get_tuple_data(pdev, &tuple) != 0)
177			goto next_entry;
178		if (pcmcia_parse_tuple(pdev, &tuple, &stk->parse) != 0)
179			goto next_entry;
180		/* Check for matching Vcc, unless we're desperate */
181		if (!pass) {
182			if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
183				if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
184					goto next_entry;
185			} else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
186				if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
187					goto next_entry;
188			}
189		}
190
191		if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
192			pdev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
193		else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
194			pdev->conf.Vpp = stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
195
196		if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
197			cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
198			pdev->conf.ConfigIndex = cfg->index;
199			pdev->io.BasePort1 = io->win[0].base;
200			pdev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
201			if (!(io->flags & CISTPL_IO_16BIT))
202				pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
203			if (io->nwin == 2) {
204				pdev->io.NumPorts1 = 8;
205				pdev->io.BasePort2 = io->win[1].base;
206				pdev->io.NumPorts2 = (is_kme) ? 2 : 1;
207				if (pcmcia_request_io(pdev, &pdev->io) != 0)
208					goto next_entry;
209				io_base = pdev->io.BasePort1;
210				ctl_base = pdev->io.BasePort2;
211			} else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
212				pdev->io.NumPorts1 = io->win[0].len;
213				pdev->io.NumPorts2 = 0;
214				if (pcmcia_request_io(pdev, &pdev->io) != 0)
215					goto next_entry;
216				io_base = pdev->io.BasePort1;
217				ctl_base = pdev->io.BasePort1 + 0x0e;
218			} else goto next_entry;
219			/* If we've got this far, we're done */
220			break;
221		}
222next_entry:
223		if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
224			memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
225		if (pass) {
226			CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(pdev, &tuple));
227		} else if (pcmcia_get_next_tuple(pdev, &tuple) != 0) {
228			CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
229			memset(&stk->dflt, 0, sizeof(stk->dflt));
230			pass++;
231		}
232	}
233
234	CS_CHECK(RequestIRQ, pcmcia_request_irq(pdev, &pdev->irq));
235	CS_CHECK(RequestConfiguration, pcmcia_request_configuration(pdev, &pdev->conf));
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 (pdev->io.NumPorts1 >= 0x20)
252		printk(KERN_WARNING DRV_NAME ": second channel not yet supported.\n");
253
254	/*
255 	 *	Having done the PCMCIA plumbing the ATA side is relatively
256 	 *	sane.
257	 */
258
259	memset(&ae, 0, sizeof(struct ata_probe_ent));
260	INIT_LIST_HEAD(&ae.node);
261	ae.dev = &pdev->dev;
262	ae.port_ops = &pcmcia_port_ops;
263	ae.sht = &pcmcia_sht;
264	ae.n_ports = 1;
265	ae.pio_mask = 1;		/* ISA so PIO 0 cycles */
266	ae.irq = pdev->irq.AssignedIRQ;
267	ae.irq_flags = IRQF_SHARED;
268	ae.port_flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST;
269	ae.port[0].cmd_addr = io_addr;
270	ae.port[0].altstatus_addr = ctl_addr;
271	ae.port[0].ctl_addr = ctl_addr;
272	ata_std_ports(&ae.port[0]);
273
274	ret = -ENODEV;
275	if (ata_device_add(&ae) == 0)
276		goto failed;
277
278	info->ndev = 1;
279	kfree(stk);
280	return 0;
281
282cs_failed:
283	cs_error(pdev, last_fn, last_ret);
284failed:
285	kfree(stk);
286	info->ndev = 0;
287	pcmcia_disable_device(pdev);
288out1:
289	kfree(info);
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_pcmcia_info *info = pdev->priv;
304	struct device *dev = &pdev->dev;
305
306	if (info != NULL) {
307		/* If we have attached the device to the ATA layer, detach it */
308		if (info->ndev) {
309			struct ata_host *host = dev_get_drvdata(dev);
310			ata_host_detach(host);
311		}
312		info->ndev = 0;
313		pdev->priv = NULL;
314	}
315	pcmcia_disable_device(pdev);
316	kfree(info);
317}
318
319static struct pcmcia_device_id pcmcia_devices[] = {
320	PCMCIA_DEVICE_FUNC_ID(4),
321	PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),	/* Hitachi */
322	PCMCIA_DEVICE_MANF_CARD(0x000a, 0x0000),	/* I-O Data CFA */
323	PCMCIA_DEVICE_MANF_CARD(0x001c, 0x0001),	/* Mitsubishi CFA */
324	PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
325	PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),	/* SanDisk CFA */
326	PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),	/* Toshiba */
327	PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
328	PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),	/* Samsung */
329 	PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),	/* Hitachi */
330	PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
331	PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0100),	/* Viking CFA */
332	PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),	/* Lexar, Viking CFA */
333	PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
334	PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
335	PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
336	PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
337	PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
338	PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
339	PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
340	PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
341	PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
342	PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
343	PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
344	PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
345	PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
346	PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
347	PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
348	PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
349	PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
350	PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
351	PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
352	PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
353	PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
354	PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
355	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
356	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
357	PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
358	PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
359	PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
360	PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
361	PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
362	PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
363	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
364	PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
365	PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
366	PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
367	PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
368	PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
369	PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
370	PCMCIA_DEVICE_NULL,
371};
372
373MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
374
375static struct pcmcia_driver pcmcia_driver = {
376	.owner		= THIS_MODULE,
377	.drv = {
378		.name		= DRV_NAME,
379	},
380	.id_table	= pcmcia_devices,
381	.probe		= pcmcia_init_one,
382	.remove		= pcmcia_remove_one,
383};
384
385static int __init pcmcia_init(void)
386{
387	return pcmcia_register_driver(&pcmcia_driver);
388}
389
390static void __exit pcmcia_exit(void)
391{
392	pcmcia_unregister_driver(&pcmcia_driver);
393}
394
395MODULE_AUTHOR("Alan Cox");
396MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
397MODULE_LICENSE("GPL");
398MODULE_VERSION(DRV_VERSION);
399
400module_init(pcmcia_init);
401module_exit(pcmcia_exit);
402