2 * linux/drivers/ide/ide-proc.c Version 1.05 Mar 05, 2003
4 * Copyright (C) 1997-1998 Mark Lord
5 * Copyright (C) 2003 Red Hat <alan@redhat.com>
7 * Some code was moved here from ide.c, see it for original copyrights.
11 * This is the /proc/ide/ filesystem implementation.
13 * Drive/Driver settings can be retrieved by reading the drive's
14 * "settings" files. e.g. "cat /proc/ide0/hda/settings"
15 * To write a new value "val" into a specific setting "name", use:
16 * echo "name:val" >/proc/ide/ide0/hda/settings
18 * Also useful, "cat /proc/ide0/hda/[identify, smart_values,
19 * smart_thresholds, capabilities]" will issue an IDENTIFY /
20 * PACKET_IDENTIFY / SMART_READ_VALUES / SMART_READ_THRESHOLDS /
21 * SENSE CAPABILITIES command to /dev/hda, and then dump out the
22 * returned data as 256 16-bit words. The "hdparm" utility will
23 * be updated someday soon to use this mechanism.
27 #include <linux/module.h>
29 #include <asm/uaccess.h>
30 #include <linux/errno.h>
31 #include <linux/proc_fs.h>
32 #include <linux/stat.h>
34 #include <linux/pci.h>
35 #include <linux/ctype.h>
36 #include <linux/hdreg.h>
37 #include <linux/ide.h>
38 #include <linux/seq_file.h>
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;
50 * Neither ide_unknown nor ide_forced should be set at this point.
52 switch (hwif->chipset) {
53 case ide_generic: name = "generic"; break;
54 case ide_pci: name = "pci"; break;
55 case ide_cmd640: name = "cmd640"; break;
56 case ide_dtc2278: name = "dtc2278"; break;
57 case ide_ali14xx: name = "ali14xx"; break;
58 case ide_qd65xx: name = "qd65xx"; break;
59 case ide_umc8672: name = "umc8672"; break;
60 case ide_ht6560b: name = "ht6560b"; break;
61 case ide_rz1000: name = "rz1000"; break;
62 case ide_trm290: name = "trm290"; break;
63 case ide_cmd646: name = "cmd646"; break;
64 case ide_cy82c693: name = "cy82c693"; break;
65 case ide_4drives: name = "4drives"; break;
66 case ide_pmac: name = "mac-io"; break;
67 case ide_au1xxx: name = "au1xxx"; 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 down(&ide_setting_sem);
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 up(&ide_setting_sem);
179 up(&ide_setting_sem);
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))
208 if ((setting = (*p)) == NULL)
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_sem.
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_sem 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_sem 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)
347 if (arg < 0 || arg > 70)
350 err = ide_wait_cmd(drive,
351 WIN_SETFEATURES, (u8) arg,
352 SETFEATURES_XFER, 0, NULL);
355 ide_set_xfer_rate(drive, (u8) arg);
356 ide_driveid_update(drive);
362 * ide_add_generic_settings - generic ide settings
363 * @drive: drive being configured
365 * Add the generic parts of the system settings to the /proc files.
366 * The caller must not be holding the ide_setting_sem.
369 void ide_add_generic_settings (ide_drive_t *drive)
372 * drive setting name read/write access data type min max mul_factor div_factor data pointer set function
374 __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);
375 __ide_add_setting(drive, "keepsettings", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->keep_settings, NULL, 0);
376 __ide_add_setting(drive, "nice1", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->nice1, NULL, 0);
377 __ide_add_setting(drive, "pio_mode", SETTING_WRITE, TYPE_BYTE, 0, 255, 1, 1, NULL, set_pio_mode, 0);
378 __ide_add_setting(drive, "unmaskirq", drive->no_unmask ? SETTING_READ : SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->unmask, NULL, 0);
379 __ide_add_setting(drive, "using_dma", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1, &drive->using_dma, set_using_dma, 0);
380 __ide_add_setting(drive, "init_speed", SETTING_RW, TYPE_BYTE, 0, 70, 1, 1, &drive->init_speed, NULL, 0);
381 __ide_add_setting(drive, "current_speed", SETTING_RW, TYPE_BYTE, 0, 70, 1, 1, &drive->current_speed, set_xfer_rate, 0);
382 __ide_add_setting(drive, "number", SETTING_RW, TYPE_BYTE, 0, 3, 1, 1, &drive->dn, NULL, 0);
385 static void proc_ide_settings_warn(void)
387 static int warned = 0;
392 printk(KERN_WARNING "Warning: /proc/ide/hd?/settings interface is "
393 "obsolete, and will be removed soon!\n");
397 static int proc_ide_read_settings
398 (char *page, char **start, off_t off, int count, int *eof, void *data)
400 ide_drive_t *drive = (ide_drive_t *) data;
401 ide_settings_t *setting = (ide_settings_t *) drive->settings;
403 int len, rc, mul_factor, div_factor;
405 proc_ide_settings_warn();
407 down(&ide_setting_sem);
408 out += sprintf(out, "name\t\t\tvalue\t\tmin\t\tmax\t\tmode\n");
409 out += sprintf(out, "----\t\t\t-----\t\t---\t\t---\t\t----\n");
411 mul_factor = setting->mul_factor;
412 div_factor = setting->div_factor;
413 out += sprintf(out, "%-24s", setting->name);
414 if ((rc = ide_read_setting(drive, setting)) >= 0)
415 out += sprintf(out, "%-16d", rc * mul_factor / div_factor);
417 out += sprintf(out, "%-16s", "write-only");
418 out += sprintf(out, "%-16d%-16d", (setting->min * mul_factor + div_factor - 1) / div_factor, setting->max * mul_factor / div_factor);
419 if (setting->rw & SETTING_READ)
420 out += sprintf(out, "r");
421 if (setting->rw & SETTING_WRITE)
422 out += sprintf(out, "w");
423 out += sprintf(out, "\n");
424 setting = setting->next;
427 up(&ide_setting_sem);
428 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
433 static int proc_ide_write_settings(struct file *file, const char __user *buffer,
434 unsigned long count, void *data)
436 ide_drive_t *drive = (ide_drive_t *) data;
437 char name[MAX_LEN + 1];
440 ide_settings_t *setting;
443 if (!capable(CAP_SYS_ADMIN))
446 proc_ide_settings_warn();
448 if (count >= PAGE_SIZE)
451 s = buf = (char *)__get_free_page(GFP_USER);
455 if (copy_from_user(buf, buffer, count)) {
456 free_page((unsigned long)buf);
463 * Skip over leading whitespace
465 while (count && isspace(*s)) {
470 * Do one full pass to verify all parameters,
471 * then do another to actually write the new settings.
480 while (n > 0 && *p != ':') {
488 memcpy(name, q, p - q);
497 val = simple_strtoul(p, &q, 10);
500 if (n > 0 && !isspace(*p))
502 while (n > 0 && isspace(*p)) {
507 down(&ide_setting_sem);
508 setting = ide_find_setting_by_name(drive, name);
511 up(&ide_setting_sem);
515 ide_write_setting(drive, setting, val * setting->div_factor / setting->mul_factor);
516 up(&ide_setting_sem);
518 } while (!for_real++);
519 free_page((unsigned long)buf);
522 free_page((unsigned long)buf);
523 printk("proc_ide_write_settings(): parse error\n");
527 int proc_ide_read_capacity
528 (char *page, char **start, off_t off, int count, int *eof, void *data)
530 int len = sprintf(page,"%llu\n", (long long)0x7fffffff);
531 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
534 EXPORT_SYMBOL_GPL(proc_ide_read_capacity);
536 int proc_ide_read_geometry
537 (char *page, char **start, off_t off, int count, int *eof, void *data)
539 ide_drive_t *drive = (ide_drive_t *) data;
543 out += sprintf(out,"physical %d/%d/%d\n",
544 drive->cyl, drive->head, drive->sect);
545 out += sprintf(out,"logical %d/%d/%d\n",
546 drive->bios_cyl, drive->bios_head, drive->bios_sect);
549 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
552 EXPORT_SYMBOL(proc_ide_read_geometry);
554 static int proc_ide_read_dmodel
555 (char *page, char **start, off_t off, int count, int *eof, void *data)
557 ide_drive_t *drive = (ide_drive_t *) data;
558 struct hd_driveid *id = drive->id;
561 len = sprintf(page, "%.40s\n",
562 (id && id->model[0]) ? (char *)id->model : "(none)");
563 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
566 static int proc_ide_read_driver
567 (char *page, char **start, off_t off, int count, int *eof, void *data)
569 ide_drive_t *drive = (ide_drive_t *) data;
570 struct device *dev = &drive->gendev;
571 ide_driver_t *ide_drv;
575 ide_drv = container_of(dev->driver, ide_driver_t, gen_driver);
576 len = sprintf(page, "%s version %s\n",
577 dev->driver->name, ide_drv->version);
579 len = sprintf(page, "ide-default version 0.9.newide\n");
580 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
583 static int ide_replace_subdriver(ide_drive_t *drive, const char *driver)
585 struct device *dev = &drive->gendev;
589 device_release_driver(dev);
590 /* FIXME: device can still be in use by previous driver */
591 strlcpy(drive->driver_req, driver, sizeof(drive->driver_req));
592 err = device_attach(dev);
594 printk(KERN_WARNING "IDE: %s: device_attach error: %d\n",
596 drive->driver_req[0] = 0;
597 if (dev->driver == NULL) {
598 err = device_attach(dev);
601 "IDE: %s: device_attach(2) error: %d\n",
604 if (dev->driver && !strcmp(dev->driver->name, driver))
610 static int proc_ide_write_driver
611 (struct file *file, const char __user *buffer, unsigned long count, void *data)
613 ide_drive_t *drive = (ide_drive_t *) data;
616 if (!capable(CAP_SYS_ADMIN))
620 if (copy_from_user(name, buffer, count))
623 if (ide_replace_subdriver(drive, name))
628 static int proc_ide_read_media
629 (char *page, char **start, off_t off, int count, int *eof, void *data)
631 ide_drive_t *drive = (ide_drive_t *) data;
635 switch (drive->media) {
636 case ide_disk: media = "disk\n";
638 case ide_cdrom: media = "cdrom\n";
640 case ide_tape: media = "tape\n";
642 case ide_floppy:media = "floppy\n";
644 case ide_optical:media = "optical\n";
646 default: media = "UNKNOWN\n";
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, proc_ide_write_driver },
656 { "identify", S_IFREG|S_IRUSR, proc_ide_read_identify, NULL },
657 { "media", S_IFREG|S_IRUGO, proc_ide_read_media, NULL },
658 { "model", S_IFREG|S_IRUGO, proc_ide_read_dmodel, NULL },
659 { "settings", S_IFREG|S_IRUSR|S_IWUSR,proc_ide_read_settings, proc_ide_write_settings },
660 { NULL, 0, NULL, NULL }
663 static void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data)
665 struct proc_dir_entry *ent;
669 while (p->name != NULL) {
670 ent = create_proc_entry(p->name, p->mode, dir);
673 ent->read_proc = p->read_proc;
674 ent->write_proc = p->write_proc;
679 static void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p)
683 while (p->name != NULL) {
684 remove_proc_entry(p->name, dir);
689 void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver)
691 ide_add_proc_entries(drive->proc, driver->proc, drive);
694 EXPORT_SYMBOL(ide_proc_register_driver);
697 * ide_proc_unregister_driver - remove driver specific data
701 * Clean up the driver specific /proc files and IDE settings
704 * Takes ide_setting_sem and ide_lock.
705 * Caller must hold none of the locks.
708 void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver)
712 ide_remove_proc_entries(drive->proc, driver->proc);
714 down(&ide_setting_sem);
715 spin_lock_irqsave(&ide_lock, flags);
717 * ide_setting_sem protects the settings list
718 * ide_lock protects the use of settings
720 * so we need to hold both, ide_settings_sem because we want to
721 * modify the settings list, and ide_lock because we cannot take
722 * a setting out that is being used.
724 * OTOH both ide_{read,write}_setting are only ever used under
727 auto_remove_settings(drive);
728 spin_unlock_irqrestore(&ide_lock, flags);
729 up(&ide_setting_sem);
732 EXPORT_SYMBOL(ide_proc_unregister_driver);
734 static void create_proc_ide_drives(ide_hwif_t *hwif)
737 struct proc_dir_entry *ent;
738 struct proc_dir_entry *parent = hwif->proc;
741 for (d = 0; d < MAX_DRIVES; d++) {
742 ide_drive_t *drive = &hwif->drives[d];
749 drive->proc = proc_mkdir(drive->name, parent);
751 ide_add_proc_entries(drive->proc, generic_drive_entries, drive);
752 sprintf(name,"ide%d/%s", (drive->name[2]-'a')/2, drive->name);
753 ent = proc_symlink(drive->name, proc_ide_root, name);
758 static void destroy_proc_ide_device(ide_hwif_t *hwif, ide_drive_t *drive)
761 ide_remove_proc_entries(drive->proc, generic_drive_entries);
762 remove_proc_entry(drive->name, proc_ide_root);
763 remove_proc_entry(drive->name, hwif->proc);
768 static void destroy_proc_ide_drives(ide_hwif_t *hwif)
772 for (d = 0; d < MAX_DRIVES; d++) {
773 ide_drive_t *drive = &hwif->drives[d];
775 destroy_proc_ide_device(hwif, drive);
779 static ide_proc_entry_t hwif_entries[] = {
780 { "channel", S_IFREG|S_IRUGO, proc_ide_read_channel, NULL },
781 { "mate", S_IFREG|S_IRUGO, proc_ide_read_mate, NULL },
782 { "model", S_IFREG|S_IRUGO, proc_ide_read_imodel, NULL },
783 { NULL, 0, NULL, NULL }
786 void create_proc_ide_interfaces(void)
790 for (h = 0; h < MAX_HWIFS; h++) {
791 ide_hwif_t *hwif = &ide_hwifs[h];
796 hwif->proc = proc_mkdir(hwif->name, proc_ide_root);
799 ide_add_proc_entries(hwif->proc, hwif_entries, hwif);
801 create_proc_ide_drives(hwif);
805 EXPORT_SYMBOL(create_proc_ide_interfaces);
807 #ifdef CONFIG_BLK_DEV_IDEPCI
808 void ide_pci_create_host_proc(const char *name, get_info_t *get_info)
810 create_proc_info_entry(name, 0, proc_ide_root, get_info);
813 EXPORT_SYMBOL_GPL(ide_pci_create_host_proc);
816 void destroy_proc_ide_interface(ide_hwif_t *hwif)
819 destroy_proc_ide_drives(hwif);
820 ide_remove_proc_entries(hwif->proc, hwif_entries);
821 remove_proc_entry(hwif->name, proc_ide_root);
826 static int proc_print_driver(struct device_driver *drv, void *data)
828 ide_driver_t *ide_drv = container_of(drv, ide_driver_t, gen_driver);
829 struct seq_file *s = data;
831 seq_printf(s, "%s version %s\n", drv->name, ide_drv->version);
836 static int ide_drivers_show(struct seq_file *s, void *p)
840 err = bus_for_each_drv(&ide_bus_type, NULL, s, proc_print_driver);
842 printk(KERN_WARNING "IDE: %s: bus_for_each_drv error: %d\n",
847 static int ide_drivers_open(struct inode *inode, struct file *file)
849 return single_open(file, &ide_drivers_show, NULL);
852 static const struct file_operations ide_drivers_operations = {
853 .open = ide_drivers_open,
856 .release = single_release,
859 void proc_ide_create(void)
861 struct proc_dir_entry *entry;
866 create_proc_ide_interfaces();
868 entry = create_proc_entry("drivers", 0, proc_ide_root);
870 entry->proc_fops = &ide_drivers_operations;
873 void proc_ide_destroy(void)
875 remove_proc_entry("drivers", proc_ide_root);
876 remove_proc_entry("ide", NULL);