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
16 * Also useful, "cat /proc/ide0/hda/[identify, smart_values,
17 * smart_thresholds, capabilities]" will issue an IDENTIFY /
18 * PACKET_IDENTIFY / SMART_READ_VALUES / SMART_READ_THRESHOLDS /
19 * SENSE CAPABILITIES command to /dev/hda, and then dump out the
20 * returned data as 256 16-bit words. The "hdparm" utility will
21 * be updated someday soon to use this mechanism.
25 #include <linux/module.h>
27 #include <asm/uaccess.h>
28 #include <linux/errno.h>
29 #include <linux/proc_fs.h>
30 #include <linux/stat.h>
32 #include <linux/pci.h>
33 #include <linux/ctype.h>
34 #include <linux/hdreg.h>
35 #include <linux/ide.h>
36 #include <linux/seq_file.h>
40 static struct proc_dir_entry *proc_ide_root;
42 static int proc_ide_read_imodel
43 (char *page, char **start, off_t off, int count, int *eof, void *data)
45 ide_hwif_t *hwif = (ide_hwif_t *) data;
49 switch (hwif->chipset) {
50 case ide_generic: name = "generic"; break;
51 case ide_pci: name = "pci"; break;
52 case ide_cmd640: name = "cmd640"; break;
53 case ide_dtc2278: name = "dtc2278"; break;
54 case ide_ali14xx: name = "ali14xx"; break;
55 case ide_qd65xx: name = "qd65xx"; break;
56 case ide_umc8672: name = "umc8672"; break;
57 case ide_ht6560b: name = "ht6560b"; break;
58 case ide_rz1000: name = "rz1000"; break;
59 case ide_trm290: name = "trm290"; break;
60 case ide_cmd646: name = "cmd646"; break;
61 case ide_cy82c693: name = "cy82c693"; break;
62 case ide_4drives: name = "4drives"; break;
63 case ide_pmac: name = "mac-io"; break;
64 case ide_au1xxx: name = "au1xxx"; break;
65 case ide_palm3710: name = "palm3710"; break;
66 case ide_acorn: name = "acorn"; break;
67 default: name = "(unknown)"; break;
69 len = sprintf(page, "%s\n", name);
70 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
73 static int proc_ide_read_mate
74 (char *page, char **start, off_t off, int count, int *eof, void *data)
76 ide_hwif_t *hwif = (ide_hwif_t *) data;
79 if (hwif && hwif->mate)
80 len = sprintf(page, "%s\n", hwif->mate->name);
82 len = sprintf(page, "(none)\n");
83 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
86 static int proc_ide_read_channel
87 (char *page, char **start, off_t off, int count, int *eof, void *data)
89 ide_hwif_t *hwif = (ide_hwif_t *) data;
92 page[0] = hwif->channel ? '1' : '0';
95 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
98 static int proc_ide_read_identify
99 (char *page, char **start, off_t off, int count, int *eof, void *data)
101 ide_drive_t *drive = (ide_drive_t *)data;
105 len = sprintf(page, "\n");
108 __le16 *val = (__le16 *)page;
110 err = taskfile_lib_get_identify(drive, page);
112 char *out = ((char *)page) + (SECTOR_WORDS * 4);
115 out += sprintf(out, "%04x%c",
116 le16_to_cpup(val), (++i & 7) ? ' ' : '\n');
118 } while (i < (SECTOR_WORDS * 2));
122 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
126 * __ide_add_setting - add an ide setting option
127 * @drive: drive to use
128 * @name: setting name
129 * @rw: true if the function is read write
130 * @data_type: type of data
131 * @min: range minimum
132 * @max: range maximum
133 * @mul_factor: multiplication scale
134 * @div_factor: divison scale
135 * @data: private data field
137 * @auto_remove: setting auto removal flag
139 * Removes the setting named from the device if it is present.
140 * The function takes the settings_lock to protect against
141 * parallel changes. This function must not be called from IRQ
142 * context. Returns 0 on success or -1 on failure.
144 * BUGS: This code is seriously over-engineered. There is also
145 * magic about how the driver specific features are setup. If
146 * a driver is attached we assume the driver settings are auto
150 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)
152 ide_settings_t **p = (ide_settings_t **) &drive->settings, *setting = NULL;
154 mutex_lock(&ide_setting_mtx);
155 while ((*p) && strcmp((*p)->name, name) < 0)
157 if ((setting = kzalloc(sizeof(*setting), GFP_KERNEL)) == NULL)
159 if ((setting->name = kmalloc(strlen(name) + 1, GFP_KERNEL)) == NULL)
161 strcpy(setting->name, name);
163 setting->data_type = data_type;
166 setting->mul_factor = mul_factor;
167 setting->div_factor = div_factor;
168 setting->data = data;
173 setting->auto_remove = 1;
175 mutex_unlock(&ide_setting_mtx);
178 mutex_unlock(&ide_setting_mtx);
183 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)
185 return __ide_add_setting(drive, name, rw, data_type, min, max, mul_factor, div_factor, data, set, 1);
188 EXPORT_SYMBOL(ide_add_setting);
191 * __ide_remove_setting - remove an ide setting option
192 * @drive: drive to use
193 * @name: setting name
195 * Removes the setting named from the device if it is present.
196 * The caller must hold the setting semaphore.
199 static void __ide_remove_setting(ide_drive_t *drive, char *name)
201 ide_settings_t **p, *setting;
203 p = (ide_settings_t **) &drive->settings;
205 while ((*p) && strcmp((*p)->name, name))
211 (*p) = setting->next;
213 kfree(setting->name);
218 * auto_remove_settings - remove driver specific settings
221 * Automatically remove all the driver specific settings for this
222 * drive. This function may not be called from IRQ context. The
223 * caller must hold ide_setting_mtx.
226 static void auto_remove_settings(ide_drive_t *drive)
228 ide_settings_t *setting;
230 setting = drive->settings;
232 if (setting->auto_remove) {
233 __ide_remove_setting(drive, setting->name);
236 setting = setting->next;
241 * ide_find_setting_by_name - find a drive specific setting
242 * @drive: drive to scan
243 * @name: setting name
245 * Scan's the device setting table for a matching entry and returns
246 * this or NULL if no entry is found. The caller must hold the
250 static ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name)
252 ide_settings_t *setting = drive->settings;
255 if (strcmp(setting->name, name) == 0)
257 setting = setting->next;
263 * ide_read_setting - read an IDE setting
264 * @drive: drive to read from
265 * @setting: drive setting
267 * Read a drive setting and return the value. The caller
268 * must hold the ide_setting_mtx when making this call.
270 * BUGS: the data return and error are the same return value
271 * so an error -EINVAL and true return of the same value cannot
275 static int ide_read_setting(ide_drive_t *drive, ide_settings_t *setting)
280 if ((setting->rw & SETTING_READ)) {
281 spin_lock_irqsave(&ide_lock, flags);
282 switch (setting->data_type) {
284 val = *((u8 *) setting->data);
287 val = *((u16 *) setting->data);
290 val = *((u32 *) setting->data);
293 spin_unlock_irqrestore(&ide_lock, flags);
299 * ide_write_setting - read an IDE setting
300 * @drive: drive to read from
301 * @setting: drive setting
304 * Write a drive setting if it is possible. The caller
305 * must hold the ide_setting_mtx when making this call.
307 * BUGS: the data return and error are the same return value
308 * so an error -EINVAL and true return of the same value cannot
311 * FIXME: This should be changed to enqueue a special request
312 * to the driver to change settings, and then wait on a sema for completion.
313 * The current scheme of polling is kludgy, though safe enough.
316 static int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val)
318 if (!capable(CAP_SYS_ADMIN))
321 return setting->set(drive, val);
322 if (!(setting->rw & SETTING_WRITE))
324 if (val < setting->min || val > setting->max)
326 if (ide_spin_wait_hwgroup(drive))
328 switch (setting->data_type) {
330 *((u8 *) setting->data) = val;
333 *((u16 *) setting->data) = val;
336 *((u32 *) setting->data) = val;
339 spin_unlock_irq(&ide_lock);
343 static int set_xfer_rate (ide_drive_t *drive, int arg)
348 if (arg < XFER_PIO_0 || arg > XFER_UDMA_6)
351 memset(&task, 0, sizeof(task));
352 task.tf.command = WIN_SETFEATURES;
353 task.tf.feature = SETFEATURES_XFER;
354 task.tf.nsect = (u8)arg;
355 task.tf_flags = IDE_TFLAG_OUT_FEATURE | IDE_TFLAG_OUT_NSECT |
358 err = ide_no_data_taskfile(drive, &task);
361 ide_set_xfer_rate(drive, (u8) arg);
362 ide_driveid_update(drive);
368 * ide_add_generic_settings - generic ide settings
369 * @drive: drive being configured
371 * Add the generic parts of the system settings to the /proc files.
372 * The caller must not be holding the ide_setting_mtx.
375 void ide_add_generic_settings (ide_drive_t *drive)
378 * drive setting name read/write access data type min max mul_factor div_factor data pointer set function
380 __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);
381 __ide_add_setting(drive, "keepsettings", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->keep_settings, NULL, 0);
382 __ide_add_setting(drive, "nice1", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->nice1, NULL, 0);
383 __ide_add_setting(drive, "pio_mode", SETTING_WRITE, TYPE_BYTE, 0, 255, 1, 1, NULL, set_pio_mode, 0);
384 __ide_add_setting(drive, "unmaskirq", drive->no_unmask ? SETTING_READ : SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->unmask, NULL, 0);
385 __ide_add_setting(drive, "using_dma", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->using_dma, set_using_dma, 0);
386 __ide_add_setting(drive, "init_speed", SETTING_RW, TYPE_BYTE, 0, 70, 1, 1, &drive->init_speed, NULL, 0);
387 __ide_add_setting(drive, "current_speed", SETTING_RW, TYPE_BYTE, 0, 70, 1, 1, &drive->current_speed, set_xfer_rate, 0);
388 __ide_add_setting(drive, "number", SETTING_RW, TYPE_BYTE, 0, 3, 1, 1, &drive->dn, NULL, 0);
391 static void proc_ide_settings_warn(void)
398 printk(KERN_WARNING "Warning: /proc/ide/hd?/settings interface is "
399 "obsolete, and will be removed soon!\n");
403 static int proc_ide_read_settings
404 (char *page, char **start, off_t off, int count, int *eof, void *data)
406 ide_drive_t *drive = (ide_drive_t *) data;
407 ide_settings_t *setting = (ide_settings_t *) drive->settings;
409 int len, rc, mul_factor, div_factor;
411 proc_ide_settings_warn();
413 mutex_lock(&ide_setting_mtx);
414 out += sprintf(out, "name\t\t\tvalue\t\tmin\t\tmax\t\tmode\n");
415 out += sprintf(out, "----\t\t\t-----\t\t---\t\t---\t\t----\n");
417 mul_factor = setting->mul_factor;
418 div_factor = setting->div_factor;
419 out += sprintf(out, "%-24s", setting->name);
420 rc = ide_read_setting(drive, setting);
422 out += sprintf(out, "%-16d", rc * mul_factor / div_factor);
424 out += sprintf(out, "%-16s", "write-only");
425 out += sprintf(out, "%-16d%-16d", (setting->min * mul_factor + div_factor - 1) / div_factor, setting->max * mul_factor / div_factor);
426 if (setting->rw & SETTING_READ)
427 out += sprintf(out, "r");
428 if (setting->rw & SETTING_WRITE)
429 out += sprintf(out, "w");
430 out += sprintf(out, "\n");
431 setting = setting->next;
434 mutex_unlock(&ide_setting_mtx);
435 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
440 static int proc_ide_write_settings(struct file *file, const char __user *buffer,
441 unsigned long count, void *data)
443 ide_drive_t *drive = (ide_drive_t *) data;
444 char name[MAX_LEN + 1];
447 ide_settings_t *setting;
450 if (!capable(CAP_SYS_ADMIN))
453 proc_ide_settings_warn();
455 if (count >= PAGE_SIZE)
458 s = buf = (char *)__get_free_page(GFP_USER);
462 if (copy_from_user(buf, buffer, count)) {
463 free_page((unsigned long)buf);
470 * Skip over leading whitespace
472 while (count && isspace(*s)) {
477 * Do one full pass to verify all parameters,
478 * then do another to actually write the new settings.
487 while (n > 0 && *p != ':') {
495 memcpy(name, q, p - q);
504 val = simple_strtoul(p, &q, 10);
507 if (n > 0 && !isspace(*p))
509 while (n > 0 && isspace(*p)) {
514 mutex_lock(&ide_setting_mtx);
515 setting = ide_find_setting_by_name(drive, name);
517 mutex_unlock(&ide_setting_mtx);
521 ide_write_setting(drive, setting, val * setting->div_factor / setting->mul_factor);
522 mutex_unlock(&ide_setting_mtx);
524 } while (!for_real++);
525 free_page((unsigned long)buf);
528 free_page((unsigned long)buf);
529 printk("proc_ide_write_settings(): parse error\n");
533 int proc_ide_read_capacity
534 (char *page, char **start, off_t off, int count, int *eof, void *data)
536 int len = sprintf(page, "%llu\n", (long long)0x7fffffff);
537 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
540 EXPORT_SYMBOL_GPL(proc_ide_read_capacity);
542 int proc_ide_read_geometry
543 (char *page, char **start, off_t off, int count, int *eof, void *data)
545 ide_drive_t *drive = (ide_drive_t *) data;
549 out += sprintf(out, "physical %d/%d/%d\n",
550 drive->cyl, drive->head, drive->sect);
551 out += sprintf(out, "logical %d/%d/%d\n",
552 drive->bios_cyl, drive->bios_head, drive->bios_sect);
555 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
558 EXPORT_SYMBOL(proc_ide_read_geometry);
560 static int proc_ide_read_dmodel
561 (char *page, char **start, off_t off, int count, int *eof, void *data)
563 ide_drive_t *drive = (ide_drive_t *) data;
564 struct hd_driveid *id = drive->id;
567 len = sprintf(page, "%.40s\n",
568 (id && id->model[0]) ? (char *)id->model : "(none)");
569 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
572 static int proc_ide_read_driver
573 (char *page, char **start, off_t off, int count, int *eof, void *data)
575 ide_drive_t *drive = (ide_drive_t *) data;
576 struct device *dev = &drive->gendev;
577 ide_driver_t *ide_drv;
581 ide_drv = container_of(dev->driver, ide_driver_t, gen_driver);
582 len = sprintf(page, "%s version %s\n",
583 dev->driver->name, ide_drv->version);
585 len = sprintf(page, "ide-default version 0.9.newide\n");
586 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
589 static int ide_replace_subdriver(ide_drive_t *drive, const char *driver)
591 struct device *dev = &drive->gendev;
595 device_release_driver(dev);
596 /* FIXME: device can still be in use by previous driver */
597 strlcpy(drive->driver_req, driver, sizeof(drive->driver_req));
598 err = device_attach(dev);
600 printk(KERN_WARNING "IDE: %s: device_attach error: %d\n",
602 drive->driver_req[0] = 0;
603 if (dev->driver == NULL) {
604 err = device_attach(dev);
607 "IDE: %s: device_attach(2) error: %d\n",
610 if (dev->driver && !strcmp(dev->driver->name, driver))
616 static int proc_ide_write_driver
617 (struct file *file, const char __user *buffer, unsigned long count, void *data)
619 ide_drive_t *drive = (ide_drive_t *) data;
622 if (!capable(CAP_SYS_ADMIN))
626 if (copy_from_user(name, buffer, count))
629 if (ide_replace_subdriver(drive, name))
634 static int proc_ide_read_media
635 (char *page, char **start, off_t off, int count, int *eof, void *data)
637 ide_drive_t *drive = (ide_drive_t *) data;
641 switch (drive->media) {
642 case ide_disk: media = "disk\n"; break;
643 case ide_cdrom: media = "cdrom\n"; break;
644 case ide_tape: media = "tape\n"; break;
645 case ide_floppy: media = "floppy\n"; break;
646 case ide_optical: media = "optical\n"; break;
647 default: media = "UNKNOWN\n"; break;
651 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
654 static ide_proc_entry_t generic_drive_entries[] = {
655 { "driver", S_IFREG|S_IRUGO, proc_ide_read_driver,
656 proc_ide_write_driver },
657 { "identify", S_IFREG|S_IRUSR, proc_ide_read_identify, NULL },
658 { "media", S_IFREG|S_IRUGO, proc_ide_read_media, NULL },
659 { "model", S_IFREG|S_IRUGO, proc_ide_read_dmodel, NULL },
660 { "settings", S_IFREG|S_IRUSR|S_IWUSR, proc_ide_read_settings,
661 proc_ide_write_settings },
662 { NULL, 0, NULL, NULL }
665 static void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data)
667 struct proc_dir_entry *ent;
671 while (p->name != NULL) {
672 ent = create_proc_entry(p->name, p->mode, dir);
675 ent->read_proc = p->read_proc;
676 ent->write_proc = p->write_proc;
681 static void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p)
685 while (p->name != NULL) {
686 remove_proc_entry(p->name, dir);
691 void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver)
693 ide_add_proc_entries(drive->proc, driver->proc, drive);
696 EXPORT_SYMBOL(ide_proc_register_driver);
699 * ide_proc_unregister_driver - remove driver specific data
703 * Clean up the driver specific /proc files and IDE settings
706 * Takes ide_setting_mtx and ide_lock.
707 * Caller must hold none of the locks.
710 void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver)
714 ide_remove_proc_entries(drive->proc, driver->proc);
716 mutex_lock(&ide_setting_mtx);
717 spin_lock_irqsave(&ide_lock, flags);
719 * ide_setting_mtx protects the settings list
720 * ide_lock protects the use of settings
722 * so we need to hold both, ide_settings_sem because we want to
723 * modify the settings list, and ide_lock because we cannot take
724 * a setting out that is being used.
726 * OTOH both ide_{read,write}_setting are only ever used under
729 auto_remove_settings(drive);
730 spin_unlock_irqrestore(&ide_lock, flags);
731 mutex_unlock(&ide_setting_mtx);
733 EXPORT_SYMBOL(ide_proc_unregister_driver);
735 void ide_proc_port_register_devices(ide_hwif_t *hwif)
738 struct proc_dir_entry *ent;
739 struct proc_dir_entry *parent = hwif->proc;
742 for (d = 0; d < MAX_DRIVES; d++) {
743 ide_drive_t *drive = &hwif->drives[d];
750 drive->proc = proc_mkdir(drive->name, parent);
752 ide_add_proc_entries(drive->proc, generic_drive_entries, drive);
753 sprintf(name, "ide%d/%s", (drive->name[2]-'a')/2, drive->name);
754 ent = proc_symlink(drive->name, proc_ide_root, name);
759 void ide_proc_unregister_device(ide_drive_t *drive)
762 ide_remove_proc_entries(drive->proc, generic_drive_entries);
763 remove_proc_entry(drive->name, proc_ide_root);
764 remove_proc_entry(drive->name, drive->hwif->proc);
769 static ide_proc_entry_t hwif_entries[] = {
770 { "channel", S_IFREG|S_IRUGO, proc_ide_read_channel, NULL },
771 { "mate", S_IFREG|S_IRUGO, proc_ide_read_mate, NULL },
772 { "model", S_IFREG|S_IRUGO, proc_ide_read_imodel, NULL },
773 { NULL, 0, NULL, NULL }
776 void ide_proc_register_port(ide_hwif_t *hwif)
779 hwif->proc = proc_mkdir(hwif->name, proc_ide_root);
784 ide_add_proc_entries(hwif->proc, hwif_entries, hwif);
788 void ide_proc_unregister_port(ide_hwif_t *hwif)
791 ide_remove_proc_entries(hwif->proc, hwif_entries);
792 remove_proc_entry(hwif->name, proc_ide_root);
797 static int proc_print_driver(struct device_driver *drv, void *data)
799 ide_driver_t *ide_drv = container_of(drv, ide_driver_t, gen_driver);
800 struct seq_file *s = data;
802 seq_printf(s, "%s version %s\n", drv->name, ide_drv->version);
807 static int ide_drivers_show(struct seq_file *s, void *p)
811 err = bus_for_each_drv(&ide_bus_type, NULL, s, proc_print_driver);
813 printk(KERN_WARNING "IDE: %s: bus_for_each_drv error: %d\n",
818 static int ide_drivers_open(struct inode *inode, struct file *file)
820 return single_open(file, &ide_drivers_show, NULL);
823 static const struct file_operations ide_drivers_operations = {
824 .owner = THIS_MODULE,
825 .open = ide_drivers_open,
828 .release = single_release,
831 void proc_ide_create(void)
833 proc_ide_root = proc_mkdir("ide", NULL);
838 proc_create("drivers", 0, proc_ide_root, &ide_drivers_operations);
841 void proc_ide_destroy(void)
843 remove_proc_entry("drivers", proc_ide_root);
844 remove_proc_entry("ide", NULL);