1/*
2 *  ata_generic.c - Generic PATA/SATA controller driver.
3 *  Copyright 2005 Red Hat Inc <alan@redhat.com>, all rights reserved.
4 *
5 *  Elements from ide/pci/generic.c
6 *	    Copyright (C) 2001-2002	Andre Hedrick <andre@linux-ide.org>
7 *	    Portions (C) Copyright 2002  Red Hat Inc <alan@redhat.com>
8 *
9 *  May be copied or modified under the terms of the GNU General Public License
10 *
11 *  Driver for PCI IDE interfaces implementing the standard bus mastering
12 *  interface functionality. This assumes the BIOS did the drive set up and
13 *  tuning for us. By default we do not grab all IDE class devices as they
14 *  may have other drivers or need fixups to avoid problems. Instead we keep
15 *  a default list of stuff without documentation/driver that appears to
16 *  work.
17 */
18
19#include <linux/kernel.h>
20#include <linux/module.h>
21#include <linux/pci.h>
22#include <linux/init.h>
23#include <linux/blkdev.h>
24#include <linux/delay.h>
25#include <scsi/scsi_host.h>
26#include <linux/libata.h>
27
28#define DRV_NAME "ata_generic"
29#define DRV_VERSION "0.2.12"
30
31/*
32 *	A generic parallel ATA driver using libata
33 */
34
35/**
36 *	generic_set_mode	-	mode setting
37 *	@ap: interface to set up
38 *	@unused: returned device on error
39 *
40 *	Use a non standard set_mode function. We don't want to be tuned.
41 *	The BIOS configured everything. Our job is not to fiddle. We
42 *	read the dma enabled bits from the PCI configuration of the device
43 *	and respect them.
44 */
45
46static int generic_set_mode(struct ata_port *ap, struct ata_device **unused)
47{
48	int dma_enabled = 0;
49	int i;
50
51	/* Bits 5 and 6 indicate if DMA is active on master/slave */
52	if (ap->ioaddr.bmdma_addr)
53		dma_enabled = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
54
55	for (i = 0; i < ATA_MAX_DEVICES; i++) {
56		struct ata_device *dev = &ap->device[i];
57		if (ata_dev_enabled(dev)) {
58			/* We don't really care */
59			dev->pio_mode = XFER_PIO_0;
60			dev->dma_mode = XFER_MW_DMA_0;
61			/* We do need the right mode information for DMA or PIO
62			   and this comes from the current configuration flags */
63			if (dma_enabled & (1 << (5 + i))) {
64				ata_id_to_dma_mode(dev, XFER_MW_DMA_0);
65				dev->flags &= ~ATA_DFLAG_PIO;
66			} else {
67				ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
68				dev->xfer_mode = XFER_PIO_0;
69				dev->xfer_shift = ATA_SHIFT_PIO;
70				dev->flags |= ATA_DFLAG_PIO;
71			}
72		}
73	}
74	return 0;
75}
76
77static struct scsi_host_template generic_sht = {
78	.module			= THIS_MODULE,
79	.name			= DRV_NAME,
80	.ioctl			= ata_scsi_ioctl,
81	.queuecommand		= ata_scsi_queuecmd,
82	.can_queue		= ATA_DEF_QUEUE,
83	.this_id		= ATA_SHT_THIS_ID,
84	.sg_tablesize		= LIBATA_MAX_PRD,
85	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
86	.emulated		= ATA_SHT_EMULATED,
87	.use_clustering		= ATA_SHT_USE_CLUSTERING,
88	.proc_name		= DRV_NAME,
89	.dma_boundary		= ATA_DMA_BOUNDARY,
90	.slave_configure	= ata_scsi_slave_config,
91	.slave_destroy		= ata_scsi_slave_destroy,
92	.bios_param		= ata_std_bios_param,
93};
94
95static struct ata_port_operations generic_port_ops = {
96	.set_mode	= generic_set_mode,
97
98	.port_disable	= ata_port_disable,
99	.tf_load	= ata_tf_load,
100	.tf_read	= ata_tf_read,
101	.check_status 	= ata_check_status,
102	.exec_command	= ata_exec_command,
103	.dev_select 	= ata_std_dev_select,
104
105	.bmdma_setup 	= ata_bmdma_setup,
106	.bmdma_start 	= ata_bmdma_start,
107	.bmdma_stop	= ata_bmdma_stop,
108	.bmdma_status 	= ata_bmdma_status,
109
110	.data_xfer	= ata_data_xfer,
111
112	.freeze		= ata_bmdma_freeze,
113	.thaw		= ata_bmdma_thaw,
114	.error_handler	= ata_bmdma_error_handler,
115	.post_internal_cmd = ata_bmdma_post_internal_cmd,
116	.cable_detect	= ata_cable_unknown,
117
118	.qc_prep 	= ata_qc_prep,
119	.qc_issue	= ata_qc_issue_prot,
120
121	.irq_handler	= ata_interrupt,
122	.irq_clear	= ata_bmdma_irq_clear,
123	.irq_on		= ata_irq_on,
124	.irq_ack	= ata_irq_ack,
125
126	.port_start	= ata_port_start,
127};
128
129static int all_generic_ide;		/* Set to claim all devices */
130
131/**
132 *	ata_generic_init		-	attach generic IDE
133 *	@dev: PCI device found
134 *	@id: match entry
135 *
136 *	Called each time a matching IDE interface is found. We check if the
137 *	interface is one we wish to claim and if so we perform any chip
138 *	specific hacks then let the ATA layer do the heavy lifting.
139 */
140
141static int ata_generic_init_one(struct pci_dev *dev, const struct pci_device_id *id)
142{
143	u16 command;
144	static const struct ata_port_info info = {
145		.sht = &generic_sht,
146		.flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
147		.pio_mask = 0x1f,
148		.mwdma_mask = 0x07,
149		.udma_mask = 0x3f,
150		.port_ops = &generic_port_ops
151	};
152	const struct ata_port_info *ppi[] = { &info, NULL };
153
154	/* Don't use the generic entry unless instructed to do so */
155	if (id->driver_data == 1 && all_generic_ide == 0)
156		return -ENODEV;
157
158	/* Devices that need care */
159	if (dev->vendor == PCI_VENDOR_ID_UMC &&
160	    dev->device == PCI_DEVICE_ID_UMC_UM8886A &&
161	    (!(PCI_FUNC(dev->devfn) & 1)))
162		return -ENODEV;
163
164	if (dev->vendor == PCI_VENDOR_ID_OPTI &&
165	    dev->device == PCI_DEVICE_ID_OPTI_82C558 &&
166	    (!(PCI_FUNC(dev->devfn) & 1)))
167		return -ENODEV;
168
169	/* Don't re-enable devices in generic mode or we will break some
170	   motherboards with disabled and unused IDE controllers */
171	pci_read_config_word(dev, PCI_COMMAND, &command);
172	if (!(command & PCI_COMMAND_IO))
173		return -ENODEV;
174
175	if (dev->vendor == PCI_VENDOR_ID_AL)
176	    	ata_pci_clear_simplex(dev);
177
178	return ata_pci_init_one(dev, ppi);
179}
180
181static struct pci_device_id ata_generic[] = {
182	{ PCI_DEVICE(PCI_VENDOR_ID_PCTECH, PCI_DEVICE_ID_PCTECH_SAMURAI_IDE), },
183	{ PCI_DEVICE(PCI_VENDOR_ID_HOLTEK, PCI_DEVICE_ID_HOLTEK_6565), },
184	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8673F), },
185	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886A), },
186	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886BF), },
187	{ PCI_DEVICE(PCI_VENDOR_ID_HINT,   PCI_DEVICE_ID_HINT_VXPROII_IDE), },
188	{ PCI_DEVICE(PCI_VENDOR_ID_VIA,    PCI_DEVICE_ID_VIA_82C561), },
189	{ PCI_DEVICE(PCI_VENDOR_ID_OPTI,   PCI_DEVICE_ID_OPTI_82C558), },
190	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO), },
191	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_1), },
192	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_2),  },
193	/* Must come last. If you add entries adjust this table appropriately */
194	{ PCI_ANY_ID,		PCI_ANY_ID,			   PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL, 1},
195	{ 0, },
196};
197
198static struct pci_driver ata_generic_pci_driver = {
199	.name 		= DRV_NAME,
200	.id_table	= ata_generic,
201	.probe 		= ata_generic_init_one,
202	.remove		= ata_pci_remove_one,
203#ifdef CONFIG_PM
204	.suspend	= ata_pci_device_suspend,
205	.resume		= ata_pci_device_resume,
206#endif
207};
208
209static int __init ata_generic_init(void)
210{
211	return pci_register_driver(&ata_generic_pci_driver);
212}
213
214
215static void __exit ata_generic_exit(void)
216{
217	pci_unregister_driver(&ata_generic_pci_driver);
218}
219
220
221MODULE_AUTHOR("Alan Cox");
222MODULE_DESCRIPTION("low-level driver for generic ATA");
223MODULE_LICENSE("GPL");
224MODULE_DEVICE_TABLE(pci, ata_generic);
225MODULE_VERSION(DRV_VERSION);
226
227module_init(ata_generic_init);
228module_exit(ata_generic_exit);
229
230module_param(all_generic_ide, int, 0);
231