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>
9 * This is the /proc/ide/ filesystem implementation.
11 * The major reason this exists is to provide sufficient access
12 * to driver and config data, such that user-mode programs can
13 * be developed to handle chipset tuning for most PCI interfaces.
14 * This should provide better utilities, and less kernel bloat.
16 * The entire pci config space for a PCI interface chipset can be
17 * retrieved by just reading it. e.g. "cat /proc/ide3/config"
19 * To modify registers *safely*, do something like:
20 * echo "P40:88" >/proc/ide/ide3/config
21 * That expression writes 0x88 to pci config register 0x40
22 * on the chip which controls ide3. Multiple tuples can be issued,
23 * and the writes will be completed as an atomic set:
24 * echo "P40:88 P41:35 P42:00 P43:00" >/proc/ide/ide3/config
26 * All numbers must be specified using pairs of ascii hex digits.
27 * It is important to note that these writes will be performed
28 * after waiting for the IDE controller (both interfaces)
29 * to be completely idle, to ensure no corruption of I/O in progress.
31 * Non-PCI registers can also be written, using "R" in place of "P"
32 * in the above examples. The size of the port transfer is determined
33 * by the number of pairs of hex digits given for the data. If a two
34 * digit value is given, the write will be a byte operation; if four
35 * digits are used, the write will be performed as a 16-bit operation;
36 * and if eight digits are specified, a 32-bit "dword" write will be
37 * performed. Odd numbers of digits are not permitted.
39 * If there is an error *anywhere* in the string of registers/data
40 * then *none* of the writes will be performed.
42 * Drive/Driver settings can be retrieved by reading the drive's
43 * "settings" files. e.g. "cat /proc/ide0/hda/settings"
44 * To write a new value "val" into a specific setting "name", use:
45 * echo "name:val" >/proc/ide/ide0/hda/settings
47 * Also useful, "cat /proc/ide0/hda/[identify, smart_values,
48 * smart_thresholds, capabilities]" will issue an IDENTIFY /
49 * PACKET_IDENTIFY / SMART_READ_VALUES / SMART_READ_THRESHOLDS /
50 * SENSE CAPABILITIES command to /dev/hda, and then dump out the
51 * returned data as 256 16-bit words. The "hdparm" utility will
52 * be updated someday soon to use this mechanism.
54 * Feel free to develop and distribute fancy GUI configuration
55 * utilities for your favorite PCI chipsets. I'll be working on
56 * one for the Promise 20246 someday soon. -ml
60 #include <linux/config.h>
61 #include <linux/module.h>
63 #include <asm/uaccess.h>
64 #include <linux/errno.h>
65 #include <linux/sched.h>
66 #include <linux/proc_fs.h>
67 #include <linux/stat.h>
69 #include <linux/pci.h>
70 #include <linux/ctype.h>
71 #include <linux/hdreg.h>
72 #include <linux/ide.h>
73 #include <linux/seq_file.h>
77 static int do_proc_ide_write_config(struct file *file, const char __user *buffer,
78 unsigned long count, void *data)
80 ide_hwif_t *hwif = ide_hwif_from_key(data);
81 ide_hwgroup_t *mygroup = (ide_hwgroup_t *)(hwif->hwgroup);
82 ide_hwgroup_t *mategroup = NULL;
83 unsigned long timeout;
85 const char *start = NULL, *msg = NULL;
86 struct entry { u32 val; u16 reg; u8 size; u8 pci; } *prog, *q, *r;
91 if (hwif->mate && hwif->mate->hwgroup)
92 mategroup = (ide_hwgroup_t *)(hwif->mate->hwgroup);
94 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
97 if (count >= PAGE_SIZE)
100 s = buf = (char *)__get_free_page(GFP_USER);
105 q = prog = (struct entry *)__get_free_page(GFP_USER);
110 if (copy_from_user(buf, buffer, count))
124 if ((char *)(q + 1) > (char *)prog + PAGE_SIZE) {
125 msg = "too many entries";
130 case 'R': q->pci = 0;
132 case 'P': q->pci = 1;
135 default: msg = "expected 'R' or 'P'";
139 q->reg = simple_strtoul(s, &p, 16);
141 if (!digits || digits > 4 || (q->pci && q->reg > 0xff)) {
142 msg = "bad/missing register number";
149 q->val = simple_strtoul(p, &s, 16);
151 if (digits != 2 && digits != 4 && digits != 8) {
152 msg = "bad data, 2/4/8 digits required";
155 q->size = digits / 2;
158 #ifdef CONFIG_BLK_DEV_IDEPCI
159 if (q->reg & (q->size - 1)) {
160 msg = "misaligned access";
164 msg = "not a PCI device";
166 #endif /* CONFIG_BLK_DEV_IDEPCI */
171 if (*s && !isspace(*s++)) {
172 msg = "expected whitespace after data";
180 * What follows below is fucking insane, even for IDE people.
181 * For now I've dealt with the obvious problems on the parsing
182 * side, but IMNSHO we should simply remove the write access
183 * to /proc/ide/.../config, killing that FPOS completely.
187 timeout = jiffies + (3 * HZ);
188 spin_lock_irqsave(&ide_lock, flags);
189 while (mygroup->busy ||
190 (mategroup && mategroup->busy)) {
191 spin_unlock_irqrestore(&ide_lock, flags);
192 if (time_after(jiffies, timeout)) {
193 printk("/proc/ide/%s/config: channel(s) busy, cannot write\n", hwif->name);
196 spin_lock_irqsave(&ide_lock, flags);
199 #ifdef CONFIG_BLK_DEV_IDEPCI
200 if (want_pci && (!hwif->pci_dev || hwif->pci_dev->vendor)) {
201 spin_unlock_irqrestore(&ide_lock, flags);
202 printk("proc_ide: PCI registers not accessible for %s\n",
207 #endif /* CONFIG_BLK_DEV_IDEPCI */
209 for (r = prog; r < q; r++) {
210 unsigned int reg = r->reg, val = r->val;
212 #ifdef CONFIG_BLK_DEV_IDEPCI
214 struct pci_dev *dev = hwif->pci_dev;
216 case 1: msg = "byte";
217 rc = pci_write_config_byte(dev, reg, val);
219 case 2: msg = "word";
220 rc = pci_write_config_word(dev, reg, val);
222 case 4: msg = "dword";
223 rc = pci_write_config_dword(dev, reg, val);
227 spin_unlock_irqrestore(&ide_lock, flags);
228 printk("proc_ide_write_config: error writing %s at bus %02x dev %02x reg 0x%x value 0x%x\n",
229 msg, dev->bus->number, dev->devfn, reg, val);
230 printk("proc_ide_write_config: error %d\n", rc);
234 #endif /* CONFIG_BLK_DEV_IDEPCI */
235 } else { /* not pci */
237 case 1: hwif->OUTB(val, reg);
239 case 2: hwif->OUTW(val, reg);
241 case 4: hwif->OUTL(val, reg);
246 spin_unlock_irqrestore(&ide_lock, flags);
249 free_page((unsigned long)prog);
251 free_page((unsigned long)buf);
255 printk("parse error\n");
256 printk("proc_ide: error: %s: '%s'\n", msg, start);
261 static int proc_ide_write_config(struct file *file, const char __user *buffer,
262 unsigned long count, void *data)
266 ret = do_proc_ide_write_config(file, buffer, count, data);
271 static int proc_ide_read_config
272 (char *page, char **start, off_t off, int count, int *eof, void *data)
277 #ifdef CONFIG_BLK_DEV_IDEPCI
278 ide_hwif_t *hwif = ide_hwif_from_key(data);
281 hwif = ide_hwif_from_key(data);
285 struct pci_dev *dev = hwif->pci_dev;
286 if ((hwif->pci_dev && hwif->pci_dev->vendor) && dev && dev->bus)
290 out += sprintf(out, "pci bus %02x device %02x vendor %04x "
291 "device %04x channel %d\n",
292 dev->bus->number, dev->devfn,
293 hwif->pci_dev->vendor, hwif->pci_dev->device,
297 int rc = pci_read_config_byte(dev, reg, &val);
299 printk("proc_ide_read_config: error %d reading"
300 " bus %02x dev %02x reg 0x%02x\n",
301 rc, dev->bus->number, dev->devfn, reg);
302 out += sprintf(out, "??%c",
303 (++reg & 0xf) ? ' ' : '\n');
305 out += sprintf(out, "%02x%c",
306 val, (++reg & 0xf) ? ' ' : '\n');
307 } while (reg < 0x100);
310 out += sprintf(out, "(none)\n");
312 #else /* CONFIG_BLK_DEV_IDEPCI */
313 out += sprintf(out, "(none)\n");
317 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
320 static int proc_ide_read_imodel
321 (char *page, char **start, off_t off, int count, int *eof, void *data)
325 const char *name = "";
328 hwif = ide_hwif_from_key(data);
332 * Neither ide_unknown nor ide_forced should be set at this point.
334 switch (hwif->chipset) {
335 case ide_generic: name = "generic"; break;
336 case ide_pci: name = "pci"; break;
337 case ide_cmd640: name = "cmd640"; break;
338 case ide_dtc2278: name = "dtc2278"; break;
339 case ide_ali14xx: name = "ali14xx"; break;
340 case ide_qd65xx: name = "qd65xx"; break;
341 case ide_umc8672: name = "umc8672"; break;
342 case ide_ht6560b: name = "ht6560b"; break;
343 case ide_pdc4030: name = "pdc4030"; break;
344 case ide_rz1000: name = "rz1000"; break;
345 case ide_trm290: name = "trm290"; break;
346 case ide_cmd646: name = "cmd646"; break;
347 case ide_cy82c693: name = "cy82c693"; break;
348 case ide_4drives: name = "4drives"; break;
349 case ide_pmac: name = "mac-io"; break;
350 default: name = "(unknown)"; break;
353 len = sprintf(page, "%s\n", name);
355 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
358 static int proc_ide_read_mate
359 (char *page, char **start, off_t off, int count, int *eof, void *data)
365 hwif = ide_hwif_from_key(data);
366 if (hwif && hwif->mate && hwif->mate->present)
367 len = sprintf(page, "%s\n", hwif->mate->name);
369 len = sprintf(page, "(none)\n");
371 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
374 static int proc_ide_read_channel
375 (char *page, char **start, off_t off, int count, int *eof, void *data)
381 hwif = ide_hwif_from_key(data);
383 page[0] = hwif->channel ? '1' : '0';
390 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
393 static int proc_ide_read_identify
394 (char *page, char **start, off_t off, int count, int *eof, void *data)
400 len = sprintf(page, "\n");
403 drive = ide_drive_from_key(data);
406 unsigned short *val = (unsigned short *) page;
408 BUG_ON(!drive->driver);
410 err = taskfile_lib_get_identify(drive, page);
412 char *out = ((char *)page) + (SECTOR_WORDS * 4);
415 out += sprintf(out, "%04x%c",
416 le16_to_cpu(*val), (++i & 7) ? ' ' : '\n');
418 } while (i < (SECTOR_WORDS * 2));
423 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
426 static int proc_ide_read_settings
427 (char *page, char **start, off_t off, int count, int *eof, void *data)
430 ide_settings_t *setting;
432 int len, rc, mul_factor, div_factor;
435 drive = ide_drive_from_key(data);
443 setting = (ide_settings_t *) drive->settings;
444 down(&ide_setting_sem);
445 out += sprintf(out, "name\t\t\tvalue\t\tmin\t\tmax\t\tmode\n");
446 out += sprintf(out, "----\t\t\t-----\t\t---\t\t---\t\t----\n");
448 mul_factor = setting->mul_factor;
449 div_factor = setting->div_factor;
450 out += sprintf(out, "%-24s", setting->name);
451 if ((rc = ide_read_setting(drive, setting)) >= 0)
452 out += sprintf(out, "%-16d", rc * mul_factor / div_factor);
454 out += sprintf(out, "%-16s", "write-only");
455 out += sprintf(out, "%-16d%-16d", (setting->min * mul_factor + div_factor - 1) / div_factor, setting->max * mul_factor / div_factor);
456 if (setting->rw & SETTING_READ)
457 out += sprintf(out, "r");
458 if (setting->rw & SETTING_WRITE)
459 out += sprintf(out, "w");
460 out += sprintf(out, "\n");
461 setting = setting->next;
464 up(&ide_setting_sem);
466 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
471 static int do_proc_ide_write_settings(struct file *file, const char __user *buffer,
472 unsigned long count, void *data)
474 ide_drive_t *drive = ide_drive_from_key(data);
475 char name[MAX_LEN + 1];
478 ide_settings_t *setting;
481 if (!capable(CAP_SYS_ADMIN))
487 if (count >= PAGE_SIZE)
490 s = buf = (char *)__get_free_page(GFP_USER);
494 if (copy_from_user(buf, buffer, count)) {
495 free_page((unsigned long)buf);
502 * Skip over leading whitespace
504 while (count && isspace(*s)) {
509 * Do one full pass to verify all parameters,
510 * then do another to actually write the new settings.
519 while (n > 0 && *p != ':') {
527 memcpy(name, q, p - q);
536 val = simple_strtoul(p, &q, 10);
539 if (n > 0 && !isspace(*p))
541 while (n > 0 && isspace(*p)) {
546 down(&ide_setting_sem);
547 setting = ide_find_setting_by_name(drive, name);
550 up(&ide_setting_sem);
554 ide_write_setting(drive, setting, val * setting->div_factor / setting->mul_factor);
555 up(&ide_setting_sem);
557 } while (!for_real++);
558 free_page((unsigned long)buf);
561 free_page((unsigned long)buf);
562 printk("proc_ide_write_settings(): parse error\n");
566 static int proc_ide_write_settings(struct file *file, const char __user *buffer,
567 unsigned long count, void *data)
572 ret = do_proc_ide_write_settings(file, buffer, count, data);
577 int proc_ide_read_capacity
578 (char *page, char **start, off_t off, int count, int *eof, void *data)
584 drive = ide_drive_from_key(data);
591 len = sprintf(page,"%llu\n",
592 (long long) (DRIVER(drive)->capacity(drive)));
594 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
597 int proc_ide_read_geometry
598 (char *page, char **start, off_t off, int count, int *eof, void *data)
605 drive = ide_drive_from_key(data);
612 out += sprintf(out,"physical %d/%d/%d\n",
613 drive->cyl, drive->head, drive->sect);
614 out += sprintf(out,"logical %d/%d/%d\n",
615 drive->bios_cyl, drive->bios_head, drive->bios_sect);
619 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
622 EXPORT_SYMBOL(proc_ide_read_geometry);
624 static int proc_ide_read_dmodel
625 (char *page, char **start, off_t off, int count, int *eof, void *data)
628 struct hd_driveid *id;
632 drive = ide_drive_from_key(data);
640 len = sprintf(page, "%.40s\n",
641 (id && id->model[0]) ? (char *)id->model : "(none)");
643 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
646 static int proc_ide_read_driver
647 (char *page, char **start, off_t off, int count, int *eof, void *data)
650 ide_driver_t *driver;
654 drive = ide_drive_from_key(data);
661 driver = drive->driver;
663 len = sprintf(page, "%s version %s\n",
664 driver->name, driver->version);
666 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
669 static int proc_ide_read_media
670 (char *page, char **start, off_t off, int count, int *eof, void *data)
677 drive = ide_drive_from_key(data);
684 switch (drive->media) {
685 case ide_disk: media = "disk\n";
687 case ide_cdrom: media = "cdrom\n";
689 case ide_tape: media = "tape\n";
691 case ide_floppy:media = "floppy\n";
693 default: media = "UNKNOWN\n";
699 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
702 static ide_proc_entry_t generic_drive_entries[] = {
703 { "driver", S_IFREG|S_IRUGO, proc_ide_read_driver, NULL },
704 { "identify", S_IFREG|S_IRUSR, proc_ide_read_identify, NULL },
705 { "media", S_IFREG|S_IRUGO, proc_ide_read_media, NULL },
706 { "model", S_IFREG|S_IRUGO, proc_ide_read_dmodel, NULL },
707 { "settings", S_IFREG|S_IRUSR|S_IWUSR,proc_ide_read_settings, proc_ide_write_settings },
708 { NULL, 0, NULL, NULL }
711 void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data)
713 struct proc_dir_entry *ent;
717 while (p->name != NULL) {
718 ent = create_proc_entry(p->name, p->mode, dir);
722 ent->read_proc = p->read_proc;
723 ent->write_proc = p->write_proc;
728 void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p)
732 while (p->name != NULL) {
733 remove_proc_entry(p->name, dir);
738 static void create_proc_ide_drives(ide_hwif_t *hwif)
741 struct proc_dir_entry *ent;
742 struct proc_dir_entry *parent = hwif->proc;
745 for (d = 0; d < MAX_DRIVES; d++) {
746 ide_drive_t *drive = &hwif->drives[d];
753 drive->proc = proc_mkdir(drive->name, parent);
755 ide_add_proc_entries(drive->proc, generic_drive_entries, ide_drive_to_key(drive));
756 sprintf(name,"ide%d/%s", (drive->name[2]-'a')/2, drive->name);
757 ent = proc_symlink(drive->name, proc_ide_root, name);
762 static void destroy_proc_ide_device(ide_hwif_t *hwif, ide_drive_t *drive)
764 ide_driver_t *driver = drive->driver;
767 ide_remove_proc_entries(drive->proc, driver->proc);
768 ide_remove_proc_entries(drive->proc, generic_drive_entries);
769 remove_proc_entry(drive->name, proc_ide_root);
770 remove_proc_entry(drive->name, hwif->proc);
775 void destroy_proc_ide_drives(ide_hwif_t *hwif)
779 for (d = 0; d < MAX_DRIVES; d++) {
780 ide_drive_t *drive = &hwif->drives[d];
782 destroy_proc_ide_device(hwif, drive);
786 static ide_proc_entry_t hwif_entries[] = {
787 { "channel", S_IFREG|S_IRUGO, proc_ide_read_channel, NULL },
788 { "config", S_IFREG|S_IRUGO|S_IWUSR,proc_ide_read_config, proc_ide_write_config },
789 { "mate", S_IFREG|S_IRUGO, proc_ide_read_mate, NULL },
790 { "model", S_IFREG|S_IRUGO, proc_ide_read_imodel, NULL },
791 { NULL, 0, NULL, NULL }
794 void create_proc_ide_interfaces(void)
798 for (h = 0; h < MAX_HWIFS; h++) {
799 ide_hwif_t *hwif = &ide_hwifs[h];
804 hwif->proc = proc_mkdir(hwif->name, proc_ide_root);
807 ide_add_proc_entries(hwif->proc, hwif_entries, ide_hwif_to_key(hwif));
809 create_proc_ide_drives(hwif);
813 EXPORT_SYMBOL(create_proc_ide_interfaces);
815 #ifdef CONFIG_BLK_DEV_IDEPCI
816 void ide_pci_create_host_proc(const char *name, get_info_t *get_info)
818 create_proc_info_entry(name, 0, proc_ide_root, get_info);
821 EXPORT_SYMBOL_GPL(ide_pci_create_host_proc);
824 void destroy_proc_ide_interface(ide_hwif_t *hwif)
826 int exist = (hwif->proc != NULL);
832 destroy_proc_ide_drives(hwif);
833 ide_remove_proc_entries(hwif->proc, hwif_entries);
834 remove_proc_entry(hwif->name, proc_ide_root);
839 EXPORT_SYMBOL(destroy_proc_ide_interface);
841 static void destroy_proc_ide_interfaces(void)
845 for (h = 0; h < MAX_HWIFS; h++) {
846 ide_hwif_t *hwif = &ide_hwifs[h];
847 destroy_proc_ide_interface(hwif);
851 extern struct seq_operations ide_drivers_op;
852 static int ide_drivers_open(struct inode *inode, struct file *file)
854 return seq_open(file, &ide_drivers_op);
856 static struct file_operations ide_drivers_operations = {
857 .open = ide_drivers_open,
860 .release = seq_release,
863 void proc_ide_create(void)
865 struct proc_dir_entry *entry;
870 create_proc_ide_interfaces();
872 entry = create_proc_entry("drivers", 0, proc_ide_root);
874 entry->proc_fops = &ide_drivers_operations;
877 void proc_ide_destroy(void)
879 remove_proc_entry("ide/drivers", proc_ide_root);
880 destroy_proc_ide_interfaces();
881 remove_proc_entry("ide", NULL);