xref: /linux/drivers/ata/ata_generic.c (revision c537b994505099b7197e7d3125b942ecbcc51eb6)
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.11"
30 
31 /*
32  *	A generic parallel ATA driver using libata
33  */
34 
35 /**
36  *	generic_pre_reset		-	probe begin
37  *	@ap: ATA port
38  *
39  *	Set up cable type and use generic probe init
40  */
41 
42 static int generic_pre_reset(struct ata_port *ap)
43 {
44 	ap->cbl = ATA_CBL_PATA80;
45 	return ata_std_prereset(ap);
46 }
47 
48 
49 /**
50  *	generic_error_handler - Probe specified port on PATA host controller
51  *	@ap: Port to probe
52  *	@classes:
53  *
54  *	LOCKING:
55  *	None (inherited from caller).
56  */
57 
58 
59 static void generic_error_handler(struct ata_port *ap)
60 {
61 	ata_bmdma_drive_eh(ap, generic_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
62 }
63 
64 /**
65  *	generic_set_mode	-	mode setting
66  *	@ap: interface to set up
67  *	@unused: returned device on error
68  *
69  *	Use a non standard set_mode function. We don't want to be tuned.
70  *	The BIOS configured everything. Our job is not to fiddle. We
71  *	read the dma enabled bits from the PCI configuration of the device
72  *	and respect them.
73  */
74 
75 static int generic_set_mode(struct ata_port *ap, struct ata_device **unused)
76 {
77 	int dma_enabled = 0;
78 	int i;
79 
80 	/* Bits 5 and 6 indicate if DMA is active on master/slave */
81 	if (ap->ioaddr.bmdma_addr)
82 		dma_enabled = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
83 
84 	for (i = 0; i < ATA_MAX_DEVICES; i++) {
85 		struct ata_device *dev = &ap->device[i];
86 		if (ata_dev_ready(dev)) {
87 			/* We don't really care */
88 			dev->pio_mode = XFER_PIO_0;
89 			dev->dma_mode = XFER_MW_DMA_0;
90 			/* We do need the right mode information for DMA or PIO
91 			   and this comes from the current configuration flags */
92 			if (dma_enabled & (1 << (5 + i))) {
93 				ata_id_to_dma_mode(dev, XFER_MW_DMA_0);
94 				dev->flags &= ~ATA_DFLAG_PIO;
95 			} else {
96 				ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
97 				dev->xfer_mode = XFER_PIO_0;
98 				dev->xfer_shift = ATA_SHIFT_PIO;
99 				dev->flags |= ATA_DFLAG_PIO;
100 			}
101 		}
102 	}
103 	return 0;
104 }
105 
106 static struct scsi_host_template generic_sht = {
107 	.module			= THIS_MODULE,
108 	.name			= DRV_NAME,
109 	.ioctl			= ata_scsi_ioctl,
110 	.queuecommand		= ata_scsi_queuecmd,
111 	.can_queue		= ATA_DEF_QUEUE,
112 	.this_id		= ATA_SHT_THIS_ID,
113 	.sg_tablesize		= LIBATA_MAX_PRD,
114 	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
115 	.emulated		= ATA_SHT_EMULATED,
116 	.use_clustering		= ATA_SHT_USE_CLUSTERING,
117 	.proc_name		= DRV_NAME,
118 	.dma_boundary		= ATA_DMA_BOUNDARY,
119 	.slave_configure	= ata_scsi_slave_config,
120 	.slave_destroy		= ata_scsi_slave_destroy,
121 	.bios_param		= ata_std_bios_param,
122 #ifdef CONFIG_PM
123 	.resume			= ata_scsi_device_resume,
124 	.suspend		= ata_scsi_device_suspend,
125 #endif
126 };
127 
128 static struct ata_port_operations generic_port_ops = {
129 	.set_mode	= generic_set_mode,
130 
131 	.port_disable	= ata_port_disable,
132 	.tf_load	= ata_tf_load,
133 	.tf_read	= ata_tf_read,
134 	.check_status 	= ata_check_status,
135 	.exec_command	= ata_exec_command,
136 	.dev_select 	= ata_std_dev_select,
137 
138 	.bmdma_setup 	= ata_bmdma_setup,
139 	.bmdma_start 	= ata_bmdma_start,
140 	.bmdma_stop	= ata_bmdma_stop,
141 	.bmdma_status 	= ata_bmdma_status,
142 
143 	.data_xfer	= ata_data_xfer,
144 
145 	.freeze		= ata_bmdma_freeze,
146 	.thaw		= ata_bmdma_thaw,
147 	.error_handler	= generic_error_handler,
148 	.post_internal_cmd = ata_bmdma_post_internal_cmd,
149 
150 	.qc_prep 	= ata_qc_prep,
151 	.qc_issue	= ata_qc_issue_prot,
152 
153 	.irq_handler	= ata_interrupt,
154 	.irq_clear	= ata_bmdma_irq_clear,
155 	.irq_on		= ata_irq_on,
156 	.irq_ack	= ata_irq_ack,
157 
158 	.port_start	= ata_port_start,
159 };
160 
161 static int all_generic_ide;		/* Set to claim all devices */
162 
163 /**
164  *	ata_generic_init		-	attach generic IDE
165  *	@dev: PCI device found
166  *	@id: match entry
167  *
168  *	Called each time a matching IDE interface is found. We check if the
169  *	interface is one we wish to claim and if so we perform any chip
170  *	specific hacks then let the ATA layer do the heavy lifting.
171  */
172 
173 static int ata_generic_init_one(struct pci_dev *dev, const struct pci_device_id *id)
174 {
175 	u16 command;
176 	static struct ata_port_info info = {
177 		.sht = &generic_sht,
178 		.flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
179 		.pio_mask = 0x1f,
180 		.mwdma_mask = 0x07,
181 		.udma_mask = 0x3f,
182 		.port_ops = &generic_port_ops
183 	};
184 	static struct ata_port_info *port_info[2] = { &info, &info };
185 
186 	/* Don't use the generic entry unless instructed to do so */
187 	if (id->driver_data == 1 && all_generic_ide == 0)
188 		return -ENODEV;
189 
190 	/* Devices that need care */
191 	if (dev->vendor == PCI_VENDOR_ID_UMC &&
192 	    dev->device == PCI_DEVICE_ID_UMC_UM8886A &&
193 	    (!(PCI_FUNC(dev->devfn) & 1)))
194 		return -ENODEV;
195 
196 	if (dev->vendor == PCI_VENDOR_ID_OPTI &&
197 	    dev->device == PCI_DEVICE_ID_OPTI_82C558 &&
198 	    (!(PCI_FUNC(dev->devfn) & 1)))
199 		return -ENODEV;
200 
201 	/* Don't re-enable devices in generic mode or we will break some
202 	   motherboards with disabled and unused IDE controllers */
203 	pci_read_config_word(dev, PCI_COMMAND, &command);
204 	if (!(command & PCI_COMMAND_IO))
205 		return -ENODEV;
206 
207 	if (dev->vendor == PCI_VENDOR_ID_AL)
208 	    	ata_pci_clear_simplex(dev);
209 
210 	return ata_pci_init_one(dev, port_info, 2);
211 }
212 
213 static struct pci_device_id ata_generic[] = {
214 	{ PCI_DEVICE(PCI_VENDOR_ID_PCTECH, PCI_DEVICE_ID_PCTECH_SAMURAI_IDE), },
215 	{ PCI_DEVICE(PCI_VENDOR_ID_HOLTEK, PCI_DEVICE_ID_HOLTEK_6565), },
216 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8673F), },
217 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886A), },
218 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886BF), },
219 	{ PCI_DEVICE(PCI_VENDOR_ID_HINT,   PCI_DEVICE_ID_HINT_VXPROII_IDE), },
220 	{ PCI_DEVICE(PCI_VENDOR_ID_VIA,    PCI_DEVICE_ID_VIA_82C561), },
221 	{ PCI_DEVICE(PCI_VENDOR_ID_OPTI,   PCI_DEVICE_ID_OPTI_82C558), },
222 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO), },
223 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_1), },
224 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_2),  },
225 	/* Must come last. If you add entries adjust this table appropriately */
226 	{ PCI_ANY_ID,		PCI_ANY_ID,			   PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL, 1},
227 	{ 0, },
228 };
229 
230 static struct pci_driver ata_generic_pci_driver = {
231 	.name 		= DRV_NAME,
232 	.id_table	= ata_generic,
233 	.probe 		= ata_generic_init_one,
234 	.remove		= ata_pci_remove_one,
235 #ifdef CONFIG_PM
236 	.suspend	= ata_pci_device_suspend,
237 	.resume		= ata_pci_device_resume,
238 #endif
239 };
240 
241 static int __init ata_generic_init(void)
242 {
243 	return pci_register_driver(&ata_generic_pci_driver);
244 }
245 
246 
247 static void __exit ata_generic_exit(void)
248 {
249 	pci_unregister_driver(&ata_generic_pci_driver);
250 }
251 
252 
253 MODULE_AUTHOR("Alan Cox");
254 MODULE_DESCRIPTION("low-level driver for generic ATA");
255 MODULE_LICENSE("GPL");
256 MODULE_DEVICE_TABLE(pci, ata_generic);
257 MODULE_VERSION(DRV_VERSION);
258 
259 module_init(ata_generic_init);
260 module_exit(ata_generic_exit);
261 
262 module_param(all_generic_ide, int, 0);
263