xref: /linux/drivers/ata/ata_generic.c (revision 1b8b67503725fa6deb3a4f00ea61f982bd00c152)
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/blkdev.h>
23 #include <linux/delay.h>
24 #include <scsi/scsi_host.h>
25 #include <linux/libata.h>
26 
27 #define DRV_NAME "ata_generic"
28 #define DRV_VERSION "0.2.15"
29 
30 /*
31  *	A generic parallel ATA driver using libata
32  */
33 
34 enum {
35 	ATA_GEN_CLASS_MATCH		= (1 << 0),
36 	ATA_GEN_FORCE_DMA		= (1 << 1),
37 	ATA_GEN_INTEL_IDER		= (1 << 2),
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 	unsigned long driver_data = (unsigned long)ap->host->private_data;
55 	int dma_enabled = 0;
56 	struct ata_device *dev;
57 
58 	if (driver_data & ATA_GEN_FORCE_DMA) {
59 		dma_enabled = 0xff;
60 	} else if (ap->ioaddr.bmdma_addr) {
61 		/* Bits 5 and 6 indicate if DMA is active on master/slave */
62 		dma_enabled = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
63 	}
64 
65 	ata_for_each_dev(dev, link, ENABLED) {
66 		/* We don't really care */
67 		dev->pio_mode = XFER_PIO_0;
68 		dev->dma_mode = XFER_MW_DMA_0;
69 		/* We do need the right mode information for DMA or PIO
70 		   and this comes from the current configuration flags */
71 		if (dma_enabled & (1 << (5 + dev->devno))) {
72 			unsigned int xfer_mask = ata_id_xfermask(dev->id);
73 			const char *name;
74 
75 			if (xfer_mask & (ATA_MASK_MWDMA | ATA_MASK_UDMA))
76 				name = ata_mode_string(xfer_mask);
77 			else {
78 				/* SWDMA perhaps? */
79 				name = "DMA";
80 				xfer_mask |= ata_xfer_mode2mask(XFER_MW_DMA_0);
81 			}
82 
83 			ata_dev_info(dev, "configured for %s\n", name);
84 
85 			dev->xfer_mode = ata_xfer_mask2mode(xfer_mask);
86 			dev->xfer_shift = ata_xfer_mode2shift(dev->xfer_mode);
87 			dev->flags &= ~ATA_DFLAG_PIO;
88 		} else {
89 			ata_dev_info(dev, "configured for PIO\n");
90 			dev->xfer_mode = XFER_PIO_0;
91 			dev->xfer_shift = ATA_SHIFT_PIO;
92 			dev->flags |= ATA_DFLAG_PIO;
93 		}
94 	}
95 	return 0;
96 }
97 
98 static const struct scsi_host_template generic_sht = {
99 	ATA_BMDMA_SHT(DRV_NAME),
100 };
101 
102 static struct ata_port_operations generic_port_ops = {
103 	.inherits	= &ata_bmdma_port_ops,
104 	.cable_detect	= ata_cable_unknown,
105 	.set_mode	= generic_set_mode,
106 };
107 
108 static int all_generic_ide;		/* Set to claim all devices */
109 
110 /**
111  *	is_intel_ider		-	identify intel IDE-R devices
112  *	@dev: PCI device
113  *
114  *	Distinguish Intel IDE-R controller devices from other Intel IDE
115  *	devices. IDE-R devices have no timing registers and are in
116  *	most respects virtual. They should be driven by the ata_generic
117  *	driver.
118  *
119  *	IDE-R devices have PCI offset 0xF8.L as zero, later Intel ATA has
120  *	it non zero. All Intel ATA has 0x40 writable (timing), but it is
121  *	not writable on IDE-R devices (this is guaranteed).
122  */
123 
124 static int is_intel_ider(struct pci_dev *dev)
125 {
126 	/* For Intel IDE the value at 0xF8 is only zero on IDE-R
127 	   interfaces */
128 	u32 r;
129 	u16 t;
130 
131 	/* Check the manufacturing ID, it will be zero for IDE-R */
132 	pci_read_config_dword(dev, 0xF8, &r);
133 	/* Not IDE-R: punt so that ata_(old)piix gets it */
134 	if (r != 0)
135 		return 0;
136 	/* 0xF8 will also be zero on some early Intel IDE devices
137 	   but they will have a sane timing register */
138 	pci_read_config_word(dev, 0x40, &t);
139 	if (t != 0)
140 		return 0;
141 	/* Finally check if the timing register is writable so that
142 	   we eliminate any early devices hot-docked in a docking
143 	   station */
144 	pci_write_config_word(dev, 0x40, 1);
145 	pci_read_config_word(dev, 0x40, &t);
146 	if (t) {
147 		pci_write_config_word(dev, 0x40, 0);
148 		return 0;
149 	}
150 	return 1;
151 }
152 
153 /* Forward declaration for the pci_match_id() call in ata_generic_init_one() */
154 static const struct pci_device_id ata_generic[];
155 
156 /**
157  *	ata_generic_init_one		-	attach generic IDE
158  *	@dev: PCI device found
159  *	@id: match entry
160  *
161  *	Called each time a matching IDE interface is found. We check if the
162  *	interface is one we wish to claim and if so we perform any chip
163  *	specific hacks then let the ATA layer do the heavy lifting.
164  */
165 
166 static int ata_generic_init_one(struct pci_dev *dev, const struct pci_device_id *id)
167 {
168 	u16 command;
169 	static const struct ata_port_info info = {
170 		.flags = ATA_FLAG_SLAVE_POSS,
171 		.pio_mask = ATA_PIO4,
172 		.mwdma_mask = ATA_MWDMA2,
173 		.udma_mask = ATA_UDMA5,
174 		.port_ops = &generic_port_ops
175 	};
176 	const struct ata_port_info *ppi[] = { &info, NULL };
177 
178 	/*
179 	 * A device matched through driver_override or through an ID added
180 	 * with new_id does not come from our ID table, so pci_match_device()
181 	 * hands us a synthetic ID with no driver_data and none of the checks
182 	 * below apply. Probing maps BAR0 and BAR1 as the ATA command and
183 	 * control blocks and writes to the device control register, so only
184 	 * continue for devices which report the IDE class or which we list
185 	 * ourselves.
186 	 */
187 	if (!pci_match_id(ata_generic, dev) &&
188 	    (dev->class >> 8) != PCI_CLASS_STORAGE_IDE)
189 		return -ENODEV;
190 
191 	/* Don't use the generic entry unless instructed to do so */
192 	if ((id->driver_data & ATA_GEN_CLASS_MATCH) && all_generic_ide == 0)
193 		return -ENODEV;
194 
195 	if ((id->driver_data & ATA_GEN_INTEL_IDER) && !all_generic_ide)
196 		if (!is_intel_ider(dev))
197 			return -ENODEV;
198 
199 	/* Devices that need care */
200 	if (dev->vendor == PCI_VENDOR_ID_UMC &&
201 	    dev->device == PCI_DEVICE_ID_UMC_UM8886A &&
202 	    (!(PCI_FUNC(dev->devfn) & 1)))
203 		return -ENODEV;
204 
205 	if (dev->vendor == PCI_VENDOR_ID_OPTI &&
206 	    dev->device == PCI_DEVICE_ID_OPTI_82C558 &&
207 	    (!(PCI_FUNC(dev->devfn) & 1)))
208 		return -ENODEV;
209 
210 	/* Don't re-enable devices in generic mode or we will break some
211 	   motherboards with disabled and unused IDE controllers */
212 	pci_read_config_word(dev, PCI_COMMAND, &command);
213 	if (!(command & PCI_COMMAND_IO))
214 		return -ENODEV;
215 
216 	if (dev->vendor == PCI_VENDOR_ID_AL)
217 		ata_pci_bmdma_clear_simplex(dev);
218 
219 	if (dev->vendor == PCI_VENDOR_ID_ATI) {
220 		int rc = pcim_enable_device(dev);
221 		if (rc < 0)
222 			return rc;
223 		pcim_pin_device(dev);
224 	}
225 	return ata_pci_bmdma_init_one(dev, ppi, &generic_sht, (void *)id->driver_data, 0);
226 }
227 
228 static const struct pci_device_id ata_generic[] = {
229 	{ PCI_DEVICE(PCI_VENDOR_ID_PCTECH, PCI_DEVICE_ID_PCTECH_SAMURAI_IDE), },
230 	{ PCI_DEVICE(PCI_VENDOR_ID_HOLTEK, PCI_DEVICE_ID_HOLTEK_6565), },
231 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8673F), },
232 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886A), },
233 	{ PCI_DEVICE(PCI_VENDOR_ID_UMC,    PCI_DEVICE_ID_UMC_UM8886BF), },
234 	{ PCI_DEVICE(PCI_VENDOR_ID_HINT,   PCI_DEVICE_ID_HINT_VXPROII_IDE), },
235 	{ PCI_DEVICE(PCI_VENDOR_ID_VIA,    PCI_DEVICE_ID_VIA_82C561), },
236 	{ PCI_DEVICE(PCI_VENDOR_ID_OPTI,   PCI_DEVICE_ID_OPTI_82C558), },
237 	{ PCI_DEVICE(PCI_VENDOR_ID_CENATEK,PCI_DEVICE_ID_CENATEK_IDE),
238 	  .driver_data = ATA_GEN_FORCE_DMA },
239 #if !defined(CONFIG_PATA_TOSHIBA) && !defined(CONFIG_PATA_TOSHIBA_MODULE)
240 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_1), },
241 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_2),  },
242 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_3),  },
243 	{ PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA,PCI_DEVICE_ID_TOSHIBA_PICCOLO_5),  },
244 #endif
245 	/* Intel, IDE class device */
246 	{ PCI_VENDOR_ID_INTEL, PCI_ANY_ID, PCI_ANY_ID, PCI_ANY_ID,
247 	  PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL,
248 	  .driver_data = ATA_GEN_INTEL_IDER },
249 	/* Must come last. If you add entries adjust this table appropriately */
250 	{ PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_IDE << 8, 0xFFFFFF00UL),
251 	  .driver_data = ATA_GEN_CLASS_MATCH },
252 	{ 0, },
253 };
254 
255 static struct pci_driver ata_generic_pci_driver = {
256 	.name 		= DRV_NAME,
257 	.id_table	= ata_generic,
258 	.probe 		= ata_generic_init_one,
259 	.remove		= ata_pci_remove_one,
260 #ifdef CONFIG_PM_SLEEP
261 	.suspend	= ata_pci_device_suspend,
262 	.resume		= ata_pci_device_resume,
263 #endif
264 };
265 
266 module_pci_driver(ata_generic_pci_driver);
267 
268 MODULE_AUTHOR("Alan Cox");
269 MODULE_DESCRIPTION("low-level driver for generic ATA");
270 MODULE_LICENSE("GPL");
271 MODULE_DEVICE_TABLE(pci, ata_generic);
272 MODULE_VERSION(DRV_VERSION);
273 
274 module_param(all_generic_ide, int, 0);
275