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