xref: /openbmc/linux/drivers/ata/ata_generic.c (revision e190bfe5)
1 /*
2  *  ata_generic.c - Generic PATA/SATA controller driver.
3  *  Copyright 2005 Red Hat Inc, 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 enum {
36 	ATA_GEN_CLASS_MATCH		= (1 << 0),
37 	ATA_GEN_FORCE_DMA		= (1 << 1),
38 };
39 
40 /**
41  *	generic_set_mode	-	mode setting
42  *	@link: link to set up
43  *	@unused: returned device on error
44  *
45  *	Use a non standard set_mode function. We don't want to be tuned.
46  *	The BIOS configured everything. Our job is not to fiddle. We
47  *	read the dma enabled bits from the PCI configuration of the device
48  *	and respect them.
49  */
50 
51 static int generic_set_mode(struct ata_link *link, struct ata_device **unused)
52 {
53 	struct ata_port *ap = link->ap;
54 	const struct pci_device_id *id = ap->host->private_data;
55 	int dma_enabled = 0;
56 	struct ata_device *dev;
57 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
58 
59 	if (id->driver_data & ATA_GEN_FORCE_DMA) {
60 		dma_enabled = 0xff;
61 	} else if (ap->ioaddr.bmdma_addr) {
62 		/* Bits 5 and 6 indicate if DMA is active on master/slave */
63 		dma_enabled = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
64 	}
65 
66 	if (pdev->vendor == PCI_VENDOR_ID_CENATEK)
67 		dma_enabled = 0xFF;
68 
69 	ata_for_each_dev(dev, link, ENABLED) {
70 		/* We don't really care */
71 		dev->pio_mode = XFER_PIO_0;
72 		dev->dma_mode = XFER_MW_DMA_0;
73 		/* We do need the right mode information for DMA or PIO
74 		   and this comes from the current configuration flags */
75 		if (dma_enabled & (1 << (5 + dev->devno))) {
76 			unsigned int xfer_mask = ata_id_xfermask(dev->id);
77 			const char *name;
78 
79 			if (xfer_mask & (ATA_MASK_MWDMA | ATA_MASK_UDMA))
80 				name = ata_mode_string(xfer_mask);
81 			else {
82 				/* SWDMA perhaps? */
83 				name = "DMA";
84 				xfer_mask |= ata_xfer_mode2mask(XFER_MW_DMA_0);
85 			}
86 
87 			ata_dev_printk(dev, KERN_INFO, "configured for %s\n",
88 				       name);
89 
90 			dev->xfer_mode = ata_xfer_mask2mode(xfer_mask);
91 			dev->xfer_shift = ata_xfer_mode2shift(dev->xfer_mode);
92 			dev->flags &= ~ATA_DFLAG_PIO;
93 		} else {
94 			ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
95 			dev->xfer_mode = XFER_PIO_0;
96 			dev->xfer_shift = ATA_SHIFT_PIO;
97 			dev->flags |= ATA_DFLAG_PIO;
98 		}
99 	}
100 	return 0;
101 }
102 
103 static struct scsi_host_template generic_sht = {
104 	ATA_BMDMA_SHT(DRV_NAME),
105 };
106 
107 static struct ata_port_operations generic_port_ops = {
108 	.inherits	= &ata_bmdma_port_ops,
109 	.cable_detect	= ata_cable_unknown,
110 	.set_mode	= generic_set_mode,
111 };
112 
113 static int all_generic_ide;		/* Set to claim all devices */
114 
115 /**
116  *	ata_generic_init		-	attach generic IDE
117  *	@dev: PCI device found
118  *	@id: match entry
119  *
120  *	Called each time a matching IDE interface is found. We check if the
121  *	interface is one we wish to claim and if so we perform any chip
122  *	specific hacks then let the ATA layer do the heavy lifting.
123  */
124 
125 static int ata_generic_init_one(struct pci_dev *dev, const struct pci_device_id *id)
126 {
127 	u16 command;
128 	static const struct ata_port_info info = {
129 		.flags = ATA_FLAG_SLAVE_POSS,
130 		.pio_mask = ATA_PIO4,
131 		.mwdma_mask = ATA_MWDMA2,
132 		.udma_mask = ATA_UDMA5,
133 		.port_ops = &generic_port_ops
134 	};
135 	const struct ata_port_info *ppi[] = { &info, NULL };
136 
137 	/* Don't use the generic entry unless instructed to do so */
138 	if ((id->driver_data & ATA_GEN_CLASS_MATCH) && all_generic_ide == 0)
139 		return -ENODEV;
140 
141 	/* Devices that need care */
142 	if (dev->vendor == PCI_VENDOR_ID_UMC &&
143 	    dev->device == PCI_DEVICE_ID_UMC_UM8886A &&
144 	    (!(PCI_FUNC(dev->devfn) & 1)))
145 		return -ENODEV;
146 
147 	if (dev->vendor == PCI_VENDOR_ID_OPTI &&
148 	    dev->device == PCI_DEVICE_ID_OPTI_82C558 &&
149 	    (!(PCI_FUNC(dev->devfn) & 1)))
150 		return -ENODEV;
151 
152 	/* Don't re-enable devices in generic mode or we will break some
153 	   motherboards with disabled and unused IDE controllers */
154 	pci_read_config_word(dev, PCI_COMMAND, &command);
155 	if (!(command & PCI_COMMAND_IO))
156 		return -ENODEV;
157 
158 	if (dev->vendor == PCI_VENDOR_ID_AL)
159 		ata_pci_bmdma_clear_simplex(dev);
160 
161 	if (dev->vendor == PCI_VENDOR_ID_ATI) {
162 		int rc = pcim_enable_device(dev);
163 		if (rc < 0)
164 			return rc;
165 		pcim_pin_device(dev);
166 	}
167 	return ata_pci_bmdma_init_one(dev, ppi, &generic_sht, (void *)id, 0);
168 }
169 
170 static struct pci_device_id ata_generic[] = {
171 	{ PCI_DEVICE(PCI_VENDOR_ID_PCTECH, PCI_DEVICE_ID_PCTECH_SAMURAI_IDE), },
172 	{ PCI_DEVICE(PCI_VENDOR_ID_HOLTEK, PCI_DEVICE_ID_HOLTEK_6565), },
173 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8673F), },
174 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886A), },
175 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886BF), },
176 	{ PCI_DEVICE(PCI_VENDOR_ID_HINT,   PCI_DEVICE_ID_HINT_VXPROII_IDE), },
177 	{ PCI_DEVICE(PCI_VENDOR_ID_VIA,    PCI_DEVICE_ID_VIA_82C561), },
178 	{ PCI_DEVICE(PCI_VENDOR_ID_OPTI,   PCI_DEVICE_ID_OPTI_82C558), },
179 	{ PCI_DEVICE(PCI_VENDOR_ID_CENATEK,PCI_DEVICE_ID_CENATEK_IDE),
180 	  .driver_data = ATA_GEN_FORCE_DMA },
181 	/*
182 	 * For some reason, MCP89 on MacBook 7,1 doesn't work with
183 	 * ahci, use ata_generic instead.
184 	 */
185 	{ PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP89_SATA,
186 	  PCI_VENDOR_ID_APPLE, 0xcb89,
187 	  .driver_data = ATA_GEN_FORCE_DMA },
188 #if !defined(CONFIG_PATA_TOSHIBA) && !defined(CONFIG_PATA_TOSHIBA_MODULE)
189 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_1), },
190 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_2),  },
191 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_3),  },
192 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_5),  },
193 #endif
194 	/* Must come last. If you add entries adjust this table appropriately */
195 	{ PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL),
196 	  .driver_data = ATA_GEN_CLASS_MATCH },
197 	{ 0, },
198 };
199 
200 static struct pci_driver ata_generic_pci_driver = {
201 	.name 		= DRV_NAME,
202 	.id_table	= ata_generic,
203 	.probe 		= ata_generic_init_one,
204 	.remove		= ata_pci_remove_one,
205 #ifdef CONFIG_PM
206 	.suspend	= ata_pci_device_suspend,
207 	.resume		= ata_pci_device_resume,
208 #endif
209 };
210 
211 static int __init ata_generic_init(void)
212 {
213 	return pci_register_driver(&ata_generic_pci_driver);
214 }
215 
216 
217 static void __exit ata_generic_exit(void)
218 {
219 	pci_unregister_driver(&ata_generic_pci_driver);
220 }
221 
222 
223 MODULE_AUTHOR("Alan Cox");
224 MODULE_DESCRIPTION("low-level driver for generic ATA");
225 MODULE_LICENSE("GPL");
226 MODULE_DEVICE_TABLE(pci, ata_generic);
227 MODULE_VERSION(DRV_VERSION);
228 
229 module_init(ata_generic_init);
230 module_exit(ata_generic_exit);
231 
232 module_param(all_generic_ide, int, 0);
233