1/*
2 *  Copyright (C) 1994-1998	    Linus Torvalds & authors (see below)
3 *  Copyright (C) 2003-2005, 2007   Bartlomiej Zolnierkiewicz
4 */
5
6/*
7 *  Mostly written by Mark Lord  <mlord@pobox.com>
8 *                and Gadi Oxman <gadio@netvision.net.il>
9 *                and Andre Hedrick <andre@linux-ide.org>
10 *
11 *  See linux/MAINTAINERS for address of current maintainer.
12 *
13 * This is the multiple IDE interface driver, as evolved from hd.c.
14 * It supports up to MAX_HWIFS IDE interfaces, on one or more IRQs
15 *   (usually 14 & 15).
16 * There can be up to two drives per interface, as per the ATA-2 spec.
17 *
18 * ...
19 *
20 *  From hd.c:
21 *  |
22 *  | It traverses the request-list, using interrupts to jump between functions.
23 *  | As nearly all functions can be called within interrupts, we may not sleep.
24 *  | Special care is recommended.  Have Fun!
25 *  |
26 *  | modified by Drew Eckhardt to check nr of hd's from the CMOS.
27 *  |
28 *  | Thanks to Branko Lankester, lankeste@fwi.uva.nl, who found a bug
29 *  | in the early extended-partition checks and added DM partitions.
30 *  |
31 *  | Early work on error handling by Mika Liljeberg (liljeber@cs.Helsinki.FI).
32 *  |
33 *  | IRQ-unmask, drive-id, multiple-mode, support for ">16 heads",
34 *  | and general streamlining by Mark Lord (mlord@pobox.com).
35 *
36 *  October, 1994 -- Complete line-by-line overhaul for linux 1.1.x, by:
37 *
38 *	Mark Lord	(mlord@pobox.com)		(IDE Perf.Pkg)
39 *	Delman Lee	(delman@ieee.org)		("Mr. atdisk2")
40 *	Scott Snyder	(snyder@fnald0.fnal.gov)	(ATAPI IDE cd-rom)
41 *
42 *  This was a rewrite of just about everything from hd.c, though some original
43 *  code is still sprinkled about.  Think of it as a major evolution, with
44 *  inspiration from lots of linux users, esp.  hamish@zot.apana.org.au
45 */
46
47#include <linux/module.h>
48#include <linux/types.h>
49#include <linux/string.h>
50#include <linux/kernel.h>
51#include <linux/interrupt.h>
52#include <linux/major.h>
53#include <linux/errno.h>
54#include <linux/genhd.h>
55#include <linux/init.h>
56#include <linux/pci.h>
57#include <linux/ide.h>
58#include <linux/hdreg.h>
59#include <linux/completion.h>
60#include <linux/device.h>
61
62struct class *ide_port_class;
63
64/**
65 * ide_device_get	-	get an additional reference to a ide_drive_t
66 * @drive:	device to get a reference to
67 *
68 * Gets a reference to the ide_drive_t and increments the use count of the
69 * underlying LLDD module.
70 */
71int ide_device_get(ide_drive_t *drive)
72{
73	struct device *host_dev;
74	struct module *module;
75
76	if (!get_device(&drive->gendev))
77		return -ENXIO;
78
79	host_dev = drive->hwif->host->dev[0];
80	module = host_dev ? host_dev->driver->owner : NULL;
81
82	if (module && !try_module_get(module)) {
83		put_device(&drive->gendev);
84		return -ENXIO;
85	}
86
87	return 0;
88}
89EXPORT_SYMBOL_GPL(ide_device_get);
90
91/**
92 * ide_device_put	-	release a reference to a ide_drive_t
93 * @drive:	device to release a reference on
94 *
95 * Release a reference to the ide_drive_t and decrements the use count of
96 * the underlying LLDD module.
97 */
98void ide_device_put(ide_drive_t *drive)
99{
100#ifdef CONFIG_MODULE_UNLOAD
101	struct device *host_dev = drive->hwif->host->dev[0];
102	struct module *module = host_dev ? host_dev->driver->owner : NULL;
103
104	module_put(module);
105#endif
106	put_device(&drive->gendev);
107}
108EXPORT_SYMBOL_GPL(ide_device_put);
109
110static int ide_bus_match(struct device *dev, struct device_driver *drv)
111{
112	return 1;
113}
114
115static int ide_uevent(struct device *dev, struct kobj_uevent_env *env)
116{
117	ide_drive_t *drive = to_ide_device(dev);
118
119	add_uevent_var(env, "MEDIA=%s", ide_media_string(drive));
120	add_uevent_var(env, "DRIVENAME=%s", drive->name);
121	add_uevent_var(env, "MODALIAS=ide:m-%s", ide_media_string(drive));
122	return 0;
123}
124
125static int generic_ide_probe(struct device *dev)
126{
127	ide_drive_t *drive = to_ide_device(dev);
128	struct ide_driver *drv = to_ide_driver(dev->driver);
129
130	return drv->probe ? drv->probe(drive) : -ENODEV;
131}
132
133static int generic_ide_remove(struct device *dev)
134{
135	ide_drive_t *drive = to_ide_device(dev);
136	struct ide_driver *drv = to_ide_driver(dev->driver);
137
138	if (drv->remove)
139		drv->remove(drive);
140
141	return 0;
142}
143
144static void generic_ide_shutdown(struct device *dev)
145{
146	ide_drive_t *drive = to_ide_device(dev);
147	struct ide_driver *drv = to_ide_driver(dev->driver);
148
149	if (dev->driver && drv->shutdown)
150		drv->shutdown(drive);
151}
152
153struct bus_type ide_bus_type = {
154	.name		= "ide",
155	.match		= ide_bus_match,
156	.uevent		= ide_uevent,
157	.probe		= generic_ide_probe,
158	.remove		= generic_ide_remove,
159	.shutdown	= generic_ide_shutdown,
160	.dev_groups	= ide_dev_groups,
161	.suspend	= generic_ide_suspend,
162	.resume		= generic_ide_resume,
163};
164
165EXPORT_SYMBOL_GPL(ide_bus_type);
166
167int ide_vlb_clk;
168EXPORT_SYMBOL_GPL(ide_vlb_clk);
169
170module_param_named(vlb_clock, ide_vlb_clk, int, 0);
171MODULE_PARM_DESC(vlb_clock, "VLB clock frequency (in MHz)");
172
173int ide_pci_clk;
174EXPORT_SYMBOL_GPL(ide_pci_clk);
175
176module_param_named(pci_clock, ide_pci_clk, int, 0);
177MODULE_PARM_DESC(pci_clock, "PCI bus clock frequency (in MHz)");
178
179static int ide_set_dev_param_mask(const char *s, const struct kernel_param *kp)
180{
181	int a, b, i, j = 1;
182	unsigned int *dev_param_mask = (unsigned int *)kp->arg;
183
184	/* controller . device (0 or 1) [ : 1 (set) | 0 (clear) ] */
185	if (sscanf(s, "%d.%d:%d", &a, &b, &j) != 3 &&
186	    sscanf(s, "%d.%d", &a, &b) != 2)
187		return -EINVAL;
188
189	i = a * MAX_DRIVES + b;
190
191	if (i >= MAX_HWIFS * MAX_DRIVES || j < 0 || j > 1)
192		return -EINVAL;
193
194	if (j)
195		*dev_param_mask |= (1 << i);
196	else
197		*dev_param_mask &= ~(1 << i);
198
199	return 0;
200}
201
202static struct kernel_param_ops param_ops_ide_dev_mask = {
203	.set = ide_set_dev_param_mask
204};
205
206#define param_check_ide_dev_mask(name, p) param_check_uint(name, p)
207
208static unsigned int ide_nodma;
209
210module_param_named(nodma, ide_nodma, ide_dev_mask, 0);
211MODULE_PARM_DESC(nodma, "disallow DMA for a device");
212
213static unsigned int ide_noflush;
214
215module_param_named(noflush, ide_noflush, ide_dev_mask, 0);
216MODULE_PARM_DESC(noflush, "disable flush requests for a device");
217
218static unsigned int ide_nohpa;
219
220module_param_named(nohpa, ide_nohpa, ide_dev_mask, 0);
221MODULE_PARM_DESC(nohpa, "disable Host Protected Area for a device");
222
223static unsigned int ide_noprobe;
224
225module_param_named(noprobe, ide_noprobe, ide_dev_mask, 0);
226MODULE_PARM_DESC(noprobe, "skip probing for a device");
227
228static unsigned int ide_nowerr;
229
230module_param_named(nowerr, ide_nowerr, ide_dev_mask, 0);
231MODULE_PARM_DESC(nowerr, "ignore the ATA_DF bit for a device");
232
233static unsigned int ide_cdroms;
234
235module_param_named(cdrom, ide_cdroms, ide_dev_mask, 0);
236MODULE_PARM_DESC(cdrom, "force device as a CD-ROM");
237
238struct chs_geom {
239	unsigned int	cyl;
240	u8		head;
241	u8		sect;
242};
243
244static unsigned int ide_disks;
245static struct chs_geom ide_disks_chs[MAX_HWIFS * MAX_DRIVES];
246
247static int ide_set_disk_chs(const char *str, struct kernel_param *kp)
248{
249	int a, b, c = 0, h = 0, s = 0, i, j = 1;
250
251	/* controller . device (0 or 1) : Cylinders , Heads , Sectors */
252	/* controller . device (0 or 1) : 1 (use CHS) | 0 (ignore CHS) */
253	if (sscanf(str, "%d.%d:%d,%d,%d", &a, &b, &c, &h, &s) != 5 &&
254	    sscanf(str, "%d.%d:%d", &a, &b, &j) != 3)
255		return -EINVAL;
256
257	i = a * MAX_DRIVES + b;
258
259	if (i >= MAX_HWIFS * MAX_DRIVES || j < 0 || j > 1)
260		return -EINVAL;
261
262	if (c > INT_MAX || h > 255 || s > 255)
263		return -EINVAL;
264
265	if (j)
266		ide_disks |= (1 << i);
267	else
268		ide_disks &= ~(1 << i);
269
270	ide_disks_chs[i].cyl  = c;
271	ide_disks_chs[i].head = h;
272	ide_disks_chs[i].sect = s;
273
274	return 0;
275}
276
277module_param_call(chs, ide_set_disk_chs, NULL, NULL, 0);
278MODULE_PARM_DESC(chs, "force device as a disk (using CHS)");
279
280static void ide_dev_apply_params(ide_drive_t *drive, u8 unit)
281{
282	int i = drive->hwif->index * MAX_DRIVES + unit;
283
284	if (ide_nodma & (1 << i)) {
285		printk(KERN_INFO "ide: disallowing DMA for %s\n", drive->name);
286		drive->dev_flags |= IDE_DFLAG_NODMA;
287	}
288	if (ide_noflush & (1 << i)) {
289		printk(KERN_INFO "ide: disabling flush requests for %s\n",
290				 drive->name);
291		drive->dev_flags |= IDE_DFLAG_NOFLUSH;
292	}
293	if (ide_nohpa & (1 << i)) {
294		printk(KERN_INFO "ide: disabling Host Protected Area for %s\n",
295				 drive->name);
296		drive->dev_flags |= IDE_DFLAG_NOHPA;
297	}
298	if (ide_noprobe & (1 << i)) {
299		printk(KERN_INFO "ide: skipping probe for %s\n", drive->name);
300		drive->dev_flags |= IDE_DFLAG_NOPROBE;
301	}
302	if (ide_nowerr & (1 << i)) {
303		printk(KERN_INFO "ide: ignoring the ATA_DF bit for %s\n",
304				 drive->name);
305		drive->bad_wstat = BAD_R_STAT;
306	}
307	if (ide_cdroms & (1 << i)) {
308		printk(KERN_INFO "ide: forcing %s as a CD-ROM\n", drive->name);
309		drive->dev_flags |= IDE_DFLAG_PRESENT;
310		drive->media = ide_cdrom;
311		/* an ATAPI device ignores DRDY */
312		drive->ready_stat = 0;
313	}
314	if (ide_disks & (1 << i)) {
315		drive->cyl  = drive->bios_cyl  = ide_disks_chs[i].cyl;
316		drive->head = drive->bios_head = ide_disks_chs[i].head;
317		drive->sect = drive->bios_sect = ide_disks_chs[i].sect;
318
319		printk(KERN_INFO "ide: forcing %s as a disk (%d/%d/%d)\n",
320				 drive->name,
321				 drive->cyl, drive->head, drive->sect);
322
323		drive->dev_flags |= IDE_DFLAG_FORCED_GEOM | IDE_DFLAG_PRESENT;
324		drive->media = ide_disk;
325		drive->ready_stat = ATA_DRDY;
326	}
327}
328
329static unsigned int ide_ignore_cable;
330
331static int ide_set_ignore_cable(const char *s, struct kernel_param *kp)
332{
333	int i, j = 1;
334
335	/* controller (ignore) */
336	/* controller : 1 (ignore) | 0 (use) */
337	if (sscanf(s, "%d:%d", &i, &j) != 2 && sscanf(s, "%d", &i) != 1)
338		return -EINVAL;
339
340	if (i >= MAX_HWIFS || j < 0 || j > 1)
341		return -EINVAL;
342
343	if (j)
344		ide_ignore_cable |= (1 << i);
345	else
346		ide_ignore_cable &= ~(1 << i);
347
348	return 0;
349}
350
351module_param_call(ignore_cable, ide_set_ignore_cable, NULL, NULL, 0);
352MODULE_PARM_DESC(ignore_cable, "ignore cable detection");
353
354void ide_port_apply_params(ide_hwif_t *hwif)
355{
356	ide_drive_t *drive;
357	int i;
358
359	if (ide_ignore_cable & (1 << hwif->index)) {
360		printk(KERN_INFO "ide: ignoring cable detection for %s\n",
361				 hwif->name);
362		hwif->cbl = ATA_CBL_PATA40_SHORT;
363	}
364
365	ide_port_for_each_dev(i, drive, hwif)
366		ide_dev_apply_params(drive, i);
367}
368
369/*
370 * This is gets invoked once during initialization, to set *everything* up
371 */
372static int __init ide_init(void)
373{
374	int ret;
375
376	printk(KERN_INFO "Uniform Multi-Platform E-IDE driver\n");
377
378	ret = bus_register(&ide_bus_type);
379	if (ret < 0) {
380		printk(KERN_WARNING "IDE: bus_register error: %d\n", ret);
381		return ret;
382	}
383
384	ide_port_class = class_create(THIS_MODULE, "ide_port");
385	if (IS_ERR(ide_port_class)) {
386		ret = PTR_ERR(ide_port_class);
387		goto out_port_class;
388	}
389
390	ide_acpi_init();
391
392	proc_ide_create();
393
394	return 0;
395
396out_port_class:
397	bus_unregister(&ide_bus_type);
398
399	return ret;
400}
401
402static void __exit ide_exit(void)
403{
404	proc_ide_destroy();
405
406	class_destroy(ide_port_class);
407
408	bus_unregister(&ide_bus_type);
409}
410
411module_init(ide_init);
412module_exit(ide_exit);
413
414MODULE_LICENSE("GPL");
415