2 * Copyright (C) 1997-1998 Mark Lord
3 * Copyright (C) 2003 Red Hat <alan@redhat.com>
5 * Some code was moved here from ide.c, see it for original copyrights.
9 * This is the /proc/ide/ filesystem implementation.
11 * Drive/Driver settings can be retrieved by reading the drive's
12 * "settings" files. e.g. "cat /proc/ide0/hda/settings"
13 * To write a new value "val" into a specific setting "name", use:
14 * echo "name:val" >/proc/ide/ide0/hda/settings
17 #include <linux/module.h>
19 #include <asm/uaccess.h>
20 #include <linux/errno.h>
21 #include <linux/proc_fs.h>
22 #include <linux/stat.h>
24 #include <linux/pci.h>
25 #include <linux/ctype.h>
26 #include <linux/hdreg.h>
27 #include <linux/ide.h>
28 #include <linux/seq_file.h>
32 static struct proc_dir_entry *proc_ide_root;
34 static int proc_ide_read_imodel
35 (char *page, char **start, off_t off, int count, int *eof, void *data)
37 ide_hwif_t *hwif = (ide_hwif_t *) data;
41 switch (hwif->chipset) {
42 case ide_generic: name = "generic"; break;
43 case ide_pci: name = "pci"; break;
44 case ide_cmd640: name = "cmd640"; break;
45 case ide_dtc2278: name = "dtc2278"; break;
46 case ide_ali14xx: name = "ali14xx"; break;
47 case ide_qd65xx: name = "qd65xx"; break;
48 case ide_umc8672: name = "umc8672"; break;
49 case ide_ht6560b: name = "ht6560b"; break;
50 case ide_rz1000: name = "rz1000"; break;
51 case ide_trm290: name = "trm290"; break;
52 case ide_cmd646: name = "cmd646"; break;
53 case ide_cy82c693: name = "cy82c693"; break;
54 case ide_4drives: name = "4drives"; break;
55 case ide_pmac: name = "mac-io"; break;
56 case ide_au1xxx: name = "au1xxx"; break;
57 case ide_palm3710: name = "palm3710"; break;
58 case ide_acorn: name = "acorn"; break;
59 default: name = "(unknown)"; break;
61 len = sprintf(page, "%s\n", name);
62 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
65 static int proc_ide_read_mate
66 (char *page, char **start, off_t off, int count, int *eof, void *data)
68 ide_hwif_t *hwif = (ide_hwif_t *) data;
71 if (hwif && hwif->mate)
72 len = sprintf(page, "%s\n", hwif->mate->name);
74 len = sprintf(page, "(none)\n");
75 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
78 static int proc_ide_read_channel
79 (char *page, char **start, off_t off, int count, int *eof, void *data)
81 ide_hwif_t *hwif = (ide_hwif_t *) data;
84 page[0] = hwif->channel ? '1' : '0';
87 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
90 static int proc_ide_read_identify
91 (char *page, char **start, off_t off, int count, int *eof, void *data)
93 ide_drive_t *drive = (ide_drive_t *)data;
97 len = sprintf(page, "\n");
100 __le16 *val = (__le16 *)page;
102 err = taskfile_lib_get_identify(drive, page);
104 char *out = ((char *)page) + (SECTOR_WORDS * 4);
107 out += sprintf(out, "%04x%c",
108 le16_to_cpup(val), (++i & 7) ? ' ' : '\n');
110 } while (i < (SECTOR_WORDS * 2));
114 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
118 * __ide_add_setting - add an ide setting option
119 * @drive: drive to use
120 * @name: setting name
121 * @rw: true if the function is read write
122 * @data_type: type of data
123 * @min: range minimum
124 * @max: range maximum
125 * @mul_factor: multiplication scale
126 * @div_factor: divison scale
127 * @data: private data field
129 * @auto_remove: setting auto removal flag
131 * Removes the setting named from the device if it is present.
132 * The function takes the settings_lock to protect against
133 * parallel changes. This function must not be called from IRQ
134 * context. Returns 0 on success or -1 on failure.
136 * BUGS: This code is seriously over-engineered. There is also
137 * magic about how the driver specific features are setup. If
138 * a driver is attached we assume the driver settings are auto
142 static int __ide_add_setting(ide_drive_t *drive, const char *name, int rw, int data_type, int min, int max, int mul_factor, int div_factor, void *data, ide_procset_t *set, int auto_remove)
144 ide_settings_t **p = (ide_settings_t **) &drive->settings, *setting = NULL;
146 mutex_lock(&ide_setting_mtx);
147 while ((*p) && strcmp((*p)->name, name) < 0)
149 if ((setting = kzalloc(sizeof(*setting), GFP_KERNEL)) == NULL)
151 if ((setting->name = kmalloc(strlen(name) + 1, GFP_KERNEL)) == NULL)
153 strcpy(setting->name, name);
155 setting->data_type = data_type;
158 setting->mul_factor = mul_factor;
159 setting->div_factor = div_factor;
160 setting->data = data;
165 setting->auto_remove = 1;
167 mutex_unlock(&ide_setting_mtx);
170 mutex_unlock(&ide_setting_mtx);
175 int ide_add_setting(ide_drive_t *drive, const char *name, int rw, int data_type, int min, int max, int mul_factor, int div_factor, void *data, ide_procset_t *set)
177 return __ide_add_setting(drive, name, rw, data_type, min, max, mul_factor, div_factor, data, set, 1);
180 EXPORT_SYMBOL(ide_add_setting);
183 * __ide_remove_setting - remove an ide setting option
184 * @drive: drive to use
185 * @name: setting name
187 * Removes the setting named from the device if it is present.
188 * The caller must hold the setting semaphore.
191 static void __ide_remove_setting(ide_drive_t *drive, char *name)
193 ide_settings_t **p, *setting;
195 p = (ide_settings_t **) &drive->settings;
197 while ((*p) && strcmp((*p)->name, name))
203 (*p) = setting->next;
205 kfree(setting->name);
210 * auto_remove_settings - remove driver specific settings
213 * Automatically remove all the driver specific settings for this
214 * drive. This function may not be called from IRQ context. The
215 * caller must hold ide_setting_mtx.
218 static void auto_remove_settings(ide_drive_t *drive)
220 ide_settings_t *setting;
222 setting = drive->settings;
224 if (setting->auto_remove) {
225 __ide_remove_setting(drive, setting->name);
228 setting = setting->next;
233 * ide_find_setting_by_name - find a drive specific setting
234 * @drive: drive to scan
235 * @name: setting name
237 * Scan's the device setting table for a matching entry and returns
238 * this or NULL if no entry is found. The caller must hold the
242 static ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name)
244 ide_settings_t *setting = drive->settings;
247 if (strcmp(setting->name, name) == 0)
249 setting = setting->next;
255 * ide_read_setting - read an IDE setting
256 * @drive: drive to read from
257 * @setting: drive setting
259 * Read a drive setting and return the value. The caller
260 * must hold the ide_setting_mtx when making this call.
262 * BUGS: the data return and error are the same return value
263 * so an error -EINVAL and true return of the same value cannot
267 static int ide_read_setting(ide_drive_t *drive, ide_settings_t *setting)
272 if ((setting->rw & SETTING_READ)) {
273 spin_lock_irqsave(&ide_lock, flags);
274 switch (setting->data_type) {
276 val = *((u8 *) setting->data);
279 val = *((u16 *) setting->data);
282 val = *((u32 *) setting->data);
285 spin_unlock_irqrestore(&ide_lock, flags);
291 * ide_write_setting - read an IDE setting
292 * @drive: drive to read from
293 * @setting: drive setting
296 * Write a drive setting if it is possible. The caller
297 * must hold the ide_setting_mtx when making this call.
299 * BUGS: the data return and error are the same return value
300 * so an error -EINVAL and true return of the same value cannot
303 * FIXME: This should be changed to enqueue a special request
304 * to the driver to change settings, and then wait on a sema for completion.
305 * The current scheme of polling is kludgy, though safe enough.
308 static int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val)
310 if (!capable(CAP_SYS_ADMIN))
313 return setting->set(drive, val);
314 if (!(setting->rw & SETTING_WRITE))
316 if (val < setting->min || val > setting->max)
318 if (ide_spin_wait_hwgroup(drive))
320 switch (setting->data_type) {
322 *((u8 *) setting->data) = val;
325 *((u16 *) setting->data) = val;
328 *((u32 *) setting->data) = val;
331 spin_unlock_irq(&ide_lock);
335 static int set_xfer_rate (ide_drive_t *drive, int arg)
340 if (arg < XFER_PIO_0 || arg > XFER_UDMA_6)
343 memset(&task, 0, sizeof(task));
344 task.tf.command = ATA_CMD_SET_FEATURES;
345 task.tf.feature = SETFEATURES_XFER;
346 task.tf.nsect = (u8)arg;
347 task.tf_flags = IDE_TFLAG_OUT_FEATURE | IDE_TFLAG_OUT_NSECT |
350 err = ide_no_data_taskfile(drive, &task);
353 ide_set_xfer_rate(drive, (u8) arg);
354 ide_driveid_update(drive);
360 * ide_add_generic_settings - generic ide settings
361 * @drive: drive being configured
363 * Add the generic parts of the system settings to the /proc files.
364 * The caller must not be holding the ide_setting_mtx.
367 void ide_add_generic_settings (ide_drive_t *drive)
370 * drive setting name read/write access data type min max mul_factor div_factor data pointer set function
372 __ide_add_setting(drive, "io_32bit", drive->no_io_32bit ? SETTING_READ : SETTING_RW, TYPE_BYTE, 0, 1 + (SUPPORT_VLB_SYNC << 1), 1, 1, &drive->io_32bit, set_io_32bit, 0);
373 __ide_add_setting(drive, "keepsettings", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->keep_settings, NULL, 0);
374 __ide_add_setting(drive, "nice1", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->nice1, NULL, 0);
375 __ide_add_setting(drive, "pio_mode", SETTING_WRITE, TYPE_BYTE, 0, 255, 1, 1, NULL, set_pio_mode, 0);
376 __ide_add_setting(drive, "unmaskirq", drive->no_unmask ? SETTING_READ : SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->unmask, NULL, 0);
377 __ide_add_setting(drive, "using_dma", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->using_dma, set_using_dma, 0);
378 __ide_add_setting(drive, "init_speed", SETTING_RW, TYPE_BYTE, 0, 70, 1, 1, &drive->init_speed, NULL, 0);
379 __ide_add_setting(drive, "current_speed", SETTING_RW, TYPE_BYTE, 0, 70, 1, 1, &drive->current_speed, set_xfer_rate, 0);
380 __ide_add_setting(drive, "number", SETTING_RW, TYPE_BYTE, 0, 3, 1, 1, &drive->dn, NULL, 0);
383 static void proc_ide_settings_warn(void)
390 printk(KERN_WARNING "Warning: /proc/ide/hd?/settings interface is "
391 "obsolete, and will be removed soon!\n");
395 static int proc_ide_read_settings
396 (char *page, char **start, off_t off, int count, int *eof, void *data)
398 ide_drive_t *drive = (ide_drive_t *) data;
399 ide_settings_t *setting = (ide_settings_t *) drive->settings;
401 int len, rc, mul_factor, div_factor;
403 proc_ide_settings_warn();
405 mutex_lock(&ide_setting_mtx);
406 out += sprintf(out, "name\t\t\tvalue\t\tmin\t\tmax\t\tmode\n");
407 out += sprintf(out, "----\t\t\t-----\t\t---\t\t---\t\t----\n");
409 mul_factor = setting->mul_factor;
410 div_factor = setting->div_factor;
411 out += sprintf(out, "%-24s", setting->name);
412 rc = ide_read_setting(drive, setting);
414 out += sprintf(out, "%-16d", rc * mul_factor / div_factor);
416 out += sprintf(out, "%-16s", "write-only");
417 out += sprintf(out, "%-16d%-16d", (setting->min * mul_factor + div_factor - 1) / div_factor, setting->max * mul_factor / div_factor);
418 if (setting->rw & SETTING_READ)
419 out += sprintf(out, "r");
420 if (setting->rw & SETTING_WRITE)
421 out += sprintf(out, "w");
422 out += sprintf(out, "\n");
423 setting = setting->next;
426 mutex_unlock(&ide_setting_mtx);
427 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
432 static int proc_ide_write_settings(struct file *file, const char __user *buffer,
433 unsigned long count, void *data)
435 ide_drive_t *drive = (ide_drive_t *) data;
436 char name[MAX_LEN + 1];
439 ide_settings_t *setting;
442 if (!capable(CAP_SYS_ADMIN))
445 proc_ide_settings_warn();
447 if (count >= PAGE_SIZE)
450 s = buf = (char *)__get_free_page(GFP_USER);
454 if (copy_from_user(buf, buffer, count)) {
455 free_page((unsigned long)buf);
462 * Skip over leading whitespace
464 while (count && isspace(*s)) {
469 * Do one full pass to verify all parameters,
470 * then do another to actually write the new settings.
479 while (n > 0 && *p != ':') {
487 memcpy(name, q, p - q);
496 val = simple_strtoul(p, &q, 10);
499 if (n > 0 && !isspace(*p))
501 while (n > 0 && isspace(*p)) {
506 mutex_lock(&ide_setting_mtx);
507 setting = ide_find_setting_by_name(drive, name);
509 mutex_unlock(&ide_setting_mtx);
513 ide_write_setting(drive, setting, val * setting->div_factor / setting->mul_factor);
514 mutex_unlock(&ide_setting_mtx);
516 } while (!for_real++);
517 free_page((unsigned long)buf);
520 free_page((unsigned long)buf);
521 printk("proc_ide_write_settings(): parse error\n");
525 int proc_ide_read_capacity
526 (char *page, char **start, off_t off, int count, int *eof, void *data)
528 int len = sprintf(page, "%llu\n", (long long)0x7fffffff);
529 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
532 EXPORT_SYMBOL_GPL(proc_ide_read_capacity);
534 int proc_ide_read_geometry
535 (char *page, char **start, off_t off, int count, int *eof, void *data)
537 ide_drive_t *drive = (ide_drive_t *) data;
541 out += sprintf(out, "physical %d/%d/%d\n",
542 drive->cyl, drive->head, drive->sect);
543 out += sprintf(out, "logical %d/%d/%d\n",
544 drive->bios_cyl, drive->bios_head, drive->bios_sect);
547 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
550 EXPORT_SYMBOL(proc_ide_read_geometry);
552 static int proc_ide_read_dmodel
553 (char *page, char **start, off_t off, int count, int *eof, void *data)
555 ide_drive_t *drive = (ide_drive_t *) data;
556 char *m = (char *)&drive->id[ATA_ID_PROD];
559 len = sprintf(page, "%.40s\n", m[0] ? m : "(none)");
560 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
563 static int proc_ide_read_driver
564 (char *page, char **start, off_t off, int count, int *eof, void *data)
566 ide_drive_t *drive = (ide_drive_t *) data;
567 struct device *dev = &drive->gendev;
568 ide_driver_t *ide_drv;
572 ide_drv = container_of(dev->driver, ide_driver_t, gen_driver);
573 len = sprintf(page, "%s version %s\n",
574 dev->driver->name, ide_drv->version);
576 len = sprintf(page, "ide-default version 0.9.newide\n");
577 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
580 static int ide_replace_subdriver(ide_drive_t *drive, const char *driver)
582 struct device *dev = &drive->gendev;
586 device_release_driver(dev);
587 /* FIXME: device can still be in use by previous driver */
588 strlcpy(drive->driver_req, driver, sizeof(drive->driver_req));
589 err = device_attach(dev);
591 printk(KERN_WARNING "IDE: %s: device_attach error: %d\n",
593 drive->driver_req[0] = 0;
594 if (dev->driver == NULL) {
595 err = device_attach(dev);
598 "IDE: %s: device_attach(2) error: %d\n",
601 if (dev->driver && !strcmp(dev->driver->name, driver))
607 static int proc_ide_write_driver
608 (struct file *file, const char __user *buffer, unsigned long count, void *data)
610 ide_drive_t *drive = (ide_drive_t *) data;
613 if (!capable(CAP_SYS_ADMIN))
617 if (copy_from_user(name, buffer, count))
620 if (ide_replace_subdriver(drive, name))
625 static int proc_ide_read_media
626 (char *page, char **start, off_t off, int count, int *eof, void *data)
628 ide_drive_t *drive = (ide_drive_t *) data;
632 switch (drive->media) {
633 case ide_disk: media = "disk\n"; break;
634 case ide_cdrom: media = "cdrom\n"; break;
635 case ide_tape: media = "tape\n"; break;
636 case ide_floppy: media = "floppy\n"; break;
637 case ide_optical: media = "optical\n"; break;
638 default: media = "UNKNOWN\n"; break;
642 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
645 static ide_proc_entry_t generic_drive_entries[] = {
646 { "driver", S_IFREG|S_IRUGO, proc_ide_read_driver,
647 proc_ide_write_driver },
648 { "identify", S_IFREG|S_IRUSR, proc_ide_read_identify, NULL },
649 { "media", S_IFREG|S_IRUGO, proc_ide_read_media, NULL },
650 { "model", S_IFREG|S_IRUGO, proc_ide_read_dmodel, NULL },
651 { "settings", S_IFREG|S_IRUSR|S_IWUSR, proc_ide_read_settings,
652 proc_ide_write_settings },
653 { NULL, 0, NULL, NULL }
656 static void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data)
658 struct proc_dir_entry *ent;
662 while (p->name != NULL) {
663 ent = create_proc_entry(p->name, p->mode, dir);
666 ent->read_proc = p->read_proc;
667 ent->write_proc = p->write_proc;
672 static void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p)
676 while (p->name != NULL) {
677 remove_proc_entry(p->name, dir);
682 void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver)
684 ide_add_proc_entries(drive->proc, driver->proc, drive);
687 EXPORT_SYMBOL(ide_proc_register_driver);
690 * ide_proc_unregister_driver - remove driver specific data
694 * Clean up the driver specific /proc files and IDE settings
697 * Takes ide_setting_mtx and ide_lock.
698 * Caller must hold none of the locks.
701 void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver)
705 ide_remove_proc_entries(drive->proc, driver->proc);
707 mutex_lock(&ide_setting_mtx);
708 spin_lock_irqsave(&ide_lock, flags);
710 * ide_setting_mtx protects the settings list
711 * ide_lock protects the use of settings
713 * so we need to hold both, ide_settings_sem because we want to
714 * modify the settings list, and ide_lock because we cannot take
715 * a setting out that is being used.
717 * OTOH both ide_{read,write}_setting are only ever used under
720 auto_remove_settings(drive);
721 spin_unlock_irqrestore(&ide_lock, flags);
722 mutex_unlock(&ide_setting_mtx);
724 EXPORT_SYMBOL(ide_proc_unregister_driver);
726 void ide_proc_port_register_devices(ide_hwif_t *hwif)
729 struct proc_dir_entry *ent;
730 struct proc_dir_entry *parent = hwif->proc;
733 for (d = 0; d < MAX_DRIVES; d++) {
734 ide_drive_t *drive = &hwif->drives[d];
741 drive->proc = proc_mkdir(drive->name, parent);
743 ide_add_proc_entries(drive->proc, generic_drive_entries, drive);
744 sprintf(name, "ide%d/%s", (drive->name[2]-'a')/2, drive->name);
745 ent = proc_symlink(drive->name, proc_ide_root, name);
750 void ide_proc_unregister_device(ide_drive_t *drive)
753 ide_remove_proc_entries(drive->proc, generic_drive_entries);
754 remove_proc_entry(drive->name, proc_ide_root);
755 remove_proc_entry(drive->name, drive->hwif->proc);
760 static ide_proc_entry_t hwif_entries[] = {
761 { "channel", S_IFREG|S_IRUGO, proc_ide_read_channel, NULL },
762 { "mate", S_IFREG|S_IRUGO, proc_ide_read_mate, NULL },
763 { "model", S_IFREG|S_IRUGO, proc_ide_read_imodel, NULL },
764 { NULL, 0, NULL, NULL }
767 void ide_proc_register_port(ide_hwif_t *hwif)
770 hwif->proc = proc_mkdir(hwif->name, proc_ide_root);
775 ide_add_proc_entries(hwif->proc, hwif_entries, hwif);
779 void ide_proc_unregister_port(ide_hwif_t *hwif)
782 ide_remove_proc_entries(hwif->proc, hwif_entries);
783 remove_proc_entry(hwif->name, proc_ide_root);
788 static int proc_print_driver(struct device_driver *drv, void *data)
790 ide_driver_t *ide_drv = container_of(drv, ide_driver_t, gen_driver);
791 struct seq_file *s = data;
793 seq_printf(s, "%s version %s\n", drv->name, ide_drv->version);
798 static int ide_drivers_show(struct seq_file *s, void *p)
802 err = bus_for_each_drv(&ide_bus_type, NULL, s, proc_print_driver);
804 printk(KERN_WARNING "IDE: %s: bus_for_each_drv error: %d\n",
809 static int ide_drivers_open(struct inode *inode, struct file *file)
811 return single_open(file, &ide_drivers_show, NULL);
814 static const struct file_operations ide_drivers_operations = {
815 .owner = THIS_MODULE,
816 .open = ide_drivers_open,
819 .release = single_release,
822 void proc_ide_create(void)
824 proc_ide_root = proc_mkdir("ide", NULL);
829 proc_create("drivers", 0, proc_ide_root, &ide_drivers_operations);
832 void proc_ide_destroy(void)
834 remove_proc_entry("drivers", proc_ide_root);
835 remove_proc_entry("ide", NULL);