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_etrax100: name = "etrax100"; break;
67 case ide_acorn: name = "acorn"; break;
68 default: name = "(unknown)"; break;
70 len = sprintf(page, "%s\n", name);
71 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
74 static int proc_ide_read_mate
75 (char *page, char **start, off_t off, int count, int *eof, void *data)
77 ide_hwif_t *hwif = (ide_hwif_t *) data;
80 if (hwif && hwif->mate && hwif->mate->present)
81 len = sprintf(page, "%s\n", hwif->mate->name);
83 len = sprintf(page, "(none)\n");
84 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
87 static int proc_ide_read_channel
88 (char *page, char **start, off_t off, int count, int *eof, void *data)
90 ide_hwif_t *hwif = (ide_hwif_t *) data;
93 page[0] = hwif->channel ? '1' : '0';
96 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
99 static int proc_ide_read_identify
100 (char *page, char **start, off_t off, int count, int *eof, void *data)
102 ide_drive_t *drive = (ide_drive_t *)data;
106 len = sprintf(page, "\n");
109 unsigned short *val = (unsigned short *) page;
111 err = taskfile_lib_get_identify(drive, page);
113 char *out = ((char *)page) + (SECTOR_WORDS * 4);
116 out += sprintf(out, "%04x%c",
117 le16_to_cpu(*val), (++i & 7) ? ' ' : '\n');
119 } while (i < (SECTOR_WORDS * 2));
123 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
127 * __ide_add_setting - add an ide setting option
128 * @drive: drive to use
129 * @name: setting name
130 * @rw: true if the function is read write
131 * @data_type: type of data
132 * @min: range minimum
133 * @max: range maximum
134 * @mul_factor: multiplication scale
135 * @div_factor: divison scale
136 * @data: private data field
138 * @auto_remove: setting auto removal flag
140 * Removes the setting named from the device if it is present.
141 * The function takes the settings_lock to protect against
142 * parallel changes. This function must not be called from IRQ
143 * context. Returns 0 on success or -1 on failure.
145 * BUGS: This code is seriously over-engineered. There is also
146 * magic about how the driver specific features are setup. If
147 * a driver is attached we assume the driver settings are auto
151 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)
153 ide_settings_t **p = (ide_settings_t **) &drive->settings, *setting = NULL;
155 mutex_lock(&ide_setting_mtx);
156 while ((*p) && strcmp((*p)->name, name) < 0)
158 if ((setting = kzalloc(sizeof(*setting), GFP_KERNEL)) == NULL)
160 if ((setting->name = kmalloc(strlen(name) + 1, GFP_KERNEL)) == NULL)
162 strcpy(setting->name, name);
164 setting->data_type = data_type;
167 setting->mul_factor = mul_factor;
168 setting->div_factor = div_factor;
169 setting->data = data;
174 setting->auto_remove = 1;
176 mutex_unlock(&ide_setting_mtx);
179 mutex_unlock(&ide_setting_mtx);
184 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)
186 return __ide_add_setting(drive, name, rw, data_type, min, max, mul_factor, div_factor, data, set, 1);
189 EXPORT_SYMBOL(ide_add_setting);
192 * __ide_remove_setting - remove an ide setting option
193 * @drive: drive to use
194 * @name: setting name
196 * Removes the setting named from the device if it is present.
197 * The caller must hold the setting semaphore.
200 static void __ide_remove_setting(ide_drive_t *drive, char *name)
202 ide_settings_t **p, *setting;
204 p = (ide_settings_t **) &drive->settings;
206 while ((*p) && strcmp((*p)->name, name))
212 (*p) = setting->next;
214 kfree(setting->name);
219 * auto_remove_settings - remove driver specific settings
222 * Automatically remove all the driver specific settings for this
223 * drive. This function may not be called from IRQ context. The
224 * caller must hold ide_setting_mtx.
227 static void auto_remove_settings(ide_drive_t *drive)
229 ide_settings_t *setting;
231 setting = drive->settings;
233 if (setting->auto_remove) {
234 __ide_remove_setting(drive, setting->name);
237 setting = setting->next;
242 * ide_find_setting_by_name - find a drive specific setting
243 * @drive: drive to scan
244 * @name: setting name
246 * Scan's the device setting table for a matching entry and returns
247 * this or NULL if no entry is found. The caller must hold the
251 static ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name)
253 ide_settings_t *setting = drive->settings;
256 if (strcmp(setting->name, name) == 0)
258 setting = setting->next;
264 * ide_read_setting - read an IDE setting
265 * @drive: drive to read from
266 * @setting: drive setting
268 * Read a drive setting and return the value. The caller
269 * must hold the ide_setting_mtx when making this call.
271 * BUGS: the data return and error are the same return value
272 * so an error -EINVAL and true return of the same value cannot
276 static int ide_read_setting(ide_drive_t *drive, ide_settings_t *setting)
281 if ((setting->rw & SETTING_READ)) {
282 spin_lock_irqsave(&ide_lock, flags);
283 switch (setting->data_type) {
285 val = *((u8 *) setting->data);
288 val = *((u16 *) setting->data);
291 val = *((u32 *) setting->data);
294 spin_unlock_irqrestore(&ide_lock, flags);
300 * ide_write_setting - read an IDE setting
301 * @drive: drive to read from
302 * @setting: drive setting
305 * Write a drive setting if it is possible. The caller
306 * must hold the ide_setting_mtx when making this call.
308 * BUGS: the data return and error are the same return value
309 * so an error -EINVAL and true return of the same value cannot
312 * FIXME: This should be changed to enqueue a special request
313 * to the driver to change settings, and then wait on a sema for completion.
314 * The current scheme of polling is kludgy, though safe enough.
317 static int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val)
319 if (!capable(CAP_SYS_ADMIN))
322 return setting->set(drive, val);
323 if (!(setting->rw & SETTING_WRITE))
325 if (val < setting->min || val > setting->max)
327 if (ide_spin_wait_hwgroup(drive))
329 switch (setting->data_type) {
331 *((u8 *) setting->data) = val;
334 *((u16 *) setting->data) = val;
337 *((u32 *) setting->data) = val;
340 spin_unlock_irq(&ide_lock);
344 static int set_xfer_rate (ide_drive_t *drive, int arg)
349 if (arg < 0 || arg > 70)
352 memset(&task, 0, sizeof(task));
353 task.tf.command = WIN_SETFEATURES;
354 task.tf.feature = SETFEATURES_XFER;
355 task.tf.nsect = (u8)arg;
356 task.tf_flags = IDE_TFLAG_OUT_FEATURE | IDE_TFLAG_OUT_NSECT |
359 err = ide_no_data_taskfile(drive, &task);
362 ide_set_xfer_rate(drive, (u8) arg);
363 ide_driveid_update(drive);
369 * ide_add_generic_settings - generic ide settings
370 * @drive: drive being configured
372 * Add the generic parts of the system settings to the /proc files.
373 * The caller must not be holding the ide_setting_mtx.
376 void ide_add_generic_settings (ide_drive_t *drive)
379 * drive setting name read/write access data type min max mul_factor div_factor data pointer set function
381 __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);
382 __ide_add_setting(drive, "keepsettings", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->keep_settings, NULL, 0);
383 __ide_add_setting(drive, "nice1", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->nice1, NULL, 0);
384 __ide_add_setting(drive, "pio_mode", SETTING_WRITE, TYPE_BYTE, 0, 255, 1, 1, NULL, set_pio_mode, 0);
385 __ide_add_setting(drive, "unmaskirq", drive->no_unmask ? SETTING_READ : SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->unmask, NULL, 0);
386 __ide_add_setting(drive, "using_dma", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->using_dma, set_using_dma, 0);
387 __ide_add_setting(drive, "init_speed", SETTING_RW, TYPE_BYTE, 0, 70, 1, 1, &drive->init_speed, NULL, 0);
388 __ide_add_setting(drive, "current_speed", SETTING_RW, TYPE_BYTE, 0, 70, 1, 1, &drive->current_speed, set_xfer_rate, 0);
389 __ide_add_setting(drive, "number", SETTING_RW, TYPE_BYTE, 0, 3, 1, 1, &drive->dn, NULL, 0);
392 static void proc_ide_settings_warn(void)
399 printk(KERN_WARNING "Warning: /proc/ide/hd?/settings interface is "
400 "obsolete, and will be removed soon!\n");
404 static int proc_ide_read_settings
405 (char *page, char **start, off_t off, int count, int *eof, void *data)
407 ide_drive_t *drive = (ide_drive_t *) data;
408 ide_settings_t *setting = (ide_settings_t *) drive->settings;
410 int len, rc, mul_factor, div_factor;
412 proc_ide_settings_warn();
414 mutex_lock(&ide_setting_mtx);
415 out += sprintf(out, "name\t\t\tvalue\t\tmin\t\tmax\t\tmode\n");
416 out += sprintf(out, "----\t\t\t-----\t\t---\t\t---\t\t----\n");
418 mul_factor = setting->mul_factor;
419 div_factor = setting->div_factor;
420 out += sprintf(out, "%-24s", setting->name);
421 rc = ide_read_setting(drive, setting);
423 out += sprintf(out, "%-16d", rc * mul_factor / div_factor);
425 out += sprintf(out, "%-16s", "write-only");
426 out += sprintf(out, "%-16d%-16d", (setting->min * mul_factor + div_factor - 1) / div_factor, setting->max * mul_factor / div_factor);
427 if (setting->rw & SETTING_READ)
428 out += sprintf(out, "r");
429 if (setting->rw & SETTING_WRITE)
430 out += sprintf(out, "w");
431 out += sprintf(out, "\n");
432 setting = setting->next;
435 mutex_unlock(&ide_setting_mtx);
436 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
441 static int proc_ide_write_settings(struct file *file, const char __user *buffer,
442 unsigned long count, void *data)
444 ide_drive_t *drive = (ide_drive_t *) data;
445 char name[MAX_LEN + 1];
448 ide_settings_t *setting;
451 if (!capable(CAP_SYS_ADMIN))
454 proc_ide_settings_warn();
456 if (count >= PAGE_SIZE)
459 s = buf = (char *)__get_free_page(GFP_USER);
463 if (copy_from_user(buf, buffer, count)) {
464 free_page((unsigned long)buf);
471 * Skip over leading whitespace
473 while (count && isspace(*s)) {
478 * Do one full pass to verify all parameters,
479 * then do another to actually write the new settings.
488 while (n > 0 && *p != ':') {
496 memcpy(name, q, p - q);
505 val = simple_strtoul(p, &q, 10);
508 if (n > 0 && !isspace(*p))
510 while (n > 0 && isspace(*p)) {
515 mutex_lock(&ide_setting_mtx);
516 setting = ide_find_setting_by_name(drive, name);
518 mutex_unlock(&ide_setting_mtx);
522 ide_write_setting(drive, setting, val * setting->div_factor / setting->mul_factor);
523 mutex_unlock(&ide_setting_mtx);
525 } while (!for_real++);
526 free_page((unsigned long)buf);
529 free_page((unsigned long)buf);
530 printk("proc_ide_write_settings(): parse error\n");
534 int proc_ide_read_capacity
535 (char *page, char **start, off_t off, int count, int *eof, void *data)
537 int len = sprintf(page, "%llu\n", (long long)0x7fffffff);
538 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
541 EXPORT_SYMBOL_GPL(proc_ide_read_capacity);
543 int proc_ide_read_geometry
544 (char *page, char **start, off_t off, int count, int *eof, void *data)
546 ide_drive_t *drive = (ide_drive_t *) data;
550 out += sprintf(out, "physical %d/%d/%d\n",
551 drive->cyl, drive->head, drive->sect);
552 out += sprintf(out, "logical %d/%d/%d\n",
553 drive->bios_cyl, drive->bios_head, drive->bios_sect);
556 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
559 EXPORT_SYMBOL(proc_ide_read_geometry);
561 static int proc_ide_read_dmodel
562 (char *page, char **start, off_t off, int count, int *eof, void *data)
564 ide_drive_t *drive = (ide_drive_t *) data;
565 struct hd_driveid *id = drive->id;
568 len = sprintf(page, "%.40s\n",
569 (id && id->model[0]) ? (char *)id->model : "(none)");
570 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
573 static int proc_ide_read_driver
574 (char *page, char **start, off_t off, int count, int *eof, void *data)
576 ide_drive_t *drive = (ide_drive_t *) data;
577 struct device *dev = &drive->gendev;
578 ide_driver_t *ide_drv;
582 ide_drv = container_of(dev->driver, ide_driver_t, gen_driver);
583 len = sprintf(page, "%s version %s\n",
584 dev->driver->name, ide_drv->version);
586 len = sprintf(page, "ide-default version 0.9.newide\n");
587 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
590 static int ide_replace_subdriver(ide_drive_t *drive, const char *driver)
592 struct device *dev = &drive->gendev;
596 device_release_driver(dev);
597 /* FIXME: device can still be in use by previous driver */
598 strlcpy(drive->driver_req, driver, sizeof(drive->driver_req));
599 err = device_attach(dev);
601 printk(KERN_WARNING "IDE: %s: device_attach error: %d\n",
603 drive->driver_req[0] = 0;
604 if (dev->driver == NULL) {
605 err = device_attach(dev);
608 "IDE: %s: device_attach(2) error: %d\n",
611 if (dev->driver && !strcmp(dev->driver->name, driver))
617 static int proc_ide_write_driver
618 (struct file *file, const char __user *buffer, unsigned long count, void *data)
620 ide_drive_t *drive = (ide_drive_t *) data;
623 if (!capable(CAP_SYS_ADMIN))
627 if (copy_from_user(name, buffer, count))
630 if (ide_replace_subdriver(drive, name))
635 static int proc_ide_read_media
636 (char *page, char **start, off_t off, int count, int *eof, void *data)
638 ide_drive_t *drive = (ide_drive_t *) data;
642 switch (drive->media) {
643 case ide_disk: media = "disk\n"; break;
644 case ide_cdrom: media = "cdrom\n"; break;
645 case ide_tape: media = "tape\n"; break;
646 case ide_floppy: media = "floppy\n"; break;
647 case ide_optical: media = "optical\n"; break;
648 default: media = "UNKNOWN\n"; break;
652 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
655 static ide_proc_entry_t generic_drive_entries[] = {
656 { "driver", S_IFREG|S_IRUGO, proc_ide_read_driver,
657 proc_ide_write_driver },
658 { "identify", S_IFREG|S_IRUSR, proc_ide_read_identify, NULL },
659 { "media", S_IFREG|S_IRUGO, proc_ide_read_media, NULL },
660 { "model", S_IFREG|S_IRUGO, proc_ide_read_dmodel, NULL },
661 { "settings", S_IFREG|S_IRUSR|S_IWUSR, proc_ide_read_settings,
662 proc_ide_write_settings },
663 { NULL, 0, NULL, NULL }
666 static void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data)
668 struct proc_dir_entry *ent;
672 while (p->name != NULL) {
673 ent = create_proc_entry(p->name, p->mode, dir);
676 ent->read_proc = p->read_proc;
677 ent->write_proc = p->write_proc;
682 static void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p)
686 while (p->name != NULL) {
687 remove_proc_entry(p->name, dir);
692 void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver)
694 ide_add_proc_entries(drive->proc, driver->proc, drive);
697 EXPORT_SYMBOL(ide_proc_register_driver);
700 * ide_proc_unregister_driver - remove driver specific data
704 * Clean up the driver specific /proc files and IDE settings
707 * Takes ide_setting_mtx and ide_lock.
708 * Caller must hold none of the locks.
711 void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver)
715 ide_remove_proc_entries(drive->proc, driver->proc);
717 mutex_lock(&ide_setting_mtx);
718 spin_lock_irqsave(&ide_lock, flags);
720 * ide_setting_mtx protects the settings list
721 * ide_lock protects the use of settings
723 * so we need to hold both, ide_settings_sem because we want to
724 * modify the settings list, and ide_lock because we cannot take
725 * a setting out that is being used.
727 * OTOH both ide_{read,write}_setting are only ever used under
730 auto_remove_settings(drive);
731 spin_unlock_irqrestore(&ide_lock, flags);
732 mutex_unlock(&ide_setting_mtx);
734 EXPORT_SYMBOL(ide_proc_unregister_driver);
736 void ide_proc_port_register_devices(ide_hwif_t *hwif)
739 struct proc_dir_entry *ent;
740 struct proc_dir_entry *parent = hwif->proc;
743 for (d = 0; d < MAX_DRIVES; d++) {
744 ide_drive_t *drive = &hwif->drives[d];
751 drive->proc = proc_mkdir(drive->name, parent);
753 ide_add_proc_entries(drive->proc, generic_drive_entries, drive);
754 sprintf(name, "ide%d/%s", (drive->name[2]-'a')/2, drive->name);
755 ent = proc_symlink(drive->name, proc_ide_root, name);
760 void ide_proc_unregister_device(ide_drive_t *drive)
763 ide_remove_proc_entries(drive->proc, generic_drive_entries);
764 remove_proc_entry(drive->name, proc_ide_root);
765 remove_proc_entry(drive->name, drive->hwif->proc);
770 static ide_proc_entry_t hwif_entries[] = {
771 { "channel", S_IFREG|S_IRUGO, proc_ide_read_channel, NULL },
772 { "mate", S_IFREG|S_IRUGO, proc_ide_read_mate, NULL },
773 { "model", S_IFREG|S_IRUGO, proc_ide_read_imodel, NULL },
774 { NULL, 0, NULL, NULL }
777 void ide_proc_register_port(ide_hwif_t *hwif)
780 hwif->proc = proc_mkdir(hwif->name, proc_ide_root);
785 ide_add_proc_entries(hwif->proc, hwif_entries, hwif);
789 #ifdef CONFIG_BLK_DEV_IDEPCI
790 void ide_pci_create_host_proc(const char *name, get_info_t *get_info)
792 create_proc_info_entry(name, 0, proc_ide_root, get_info);
794 EXPORT_SYMBOL_GPL(ide_pci_create_host_proc);
797 void ide_proc_unregister_port(ide_hwif_t *hwif)
800 ide_remove_proc_entries(hwif->proc, hwif_entries);
801 remove_proc_entry(hwif->name, proc_ide_root);
806 static int proc_print_driver(struct device_driver *drv, void *data)
808 ide_driver_t *ide_drv = container_of(drv, ide_driver_t, gen_driver);
809 struct seq_file *s = data;
811 seq_printf(s, "%s version %s\n", drv->name, ide_drv->version);
816 static int ide_drivers_show(struct seq_file *s, void *p)
820 err = bus_for_each_drv(&ide_bus_type, NULL, s, proc_print_driver);
822 printk(KERN_WARNING "IDE: %s: bus_for_each_drv error: %d\n",
827 static int ide_drivers_open(struct inode *inode, struct file *file)
829 return single_open(file, &ide_drivers_show, NULL);
832 static const struct file_operations ide_drivers_operations = {
833 .open = ide_drivers_open,
836 .release = single_release,
839 void proc_ide_create(void)
841 struct proc_dir_entry *entry;
843 proc_ide_root = proc_mkdir("ide", NULL);
848 entry = create_proc_entry("drivers", 0, proc_ide_root);
850 entry->proc_fops = &ide_drivers_operations;
853 void proc_ide_destroy(void)
855 remove_proc_entry("drivers", proc_ide_root);
856 remove_proc_entry("ide", NULL);