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 proc_ide_write_config(struct file *file, const char __user *buffer,
78 unsigned long count, void *data)
80 ide_hwif_t *hwif = (ide_hwif_t *)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_read_config
262 (char *page, char **start, off_t off, int count, int *eof, void *data)
267 #ifdef CONFIG_BLK_DEV_IDEPCI
268 ide_hwif_t *hwif = (ide_hwif_t *)data;
269 struct pci_dev *dev = hwif->pci_dev;
270 if ((hwif->pci_dev && hwif->pci_dev->vendor) && dev && dev->bus) {
273 out += sprintf(out, "pci bus %02x device %02x vendor %04x "
274 "device %04x channel %d\n",
275 dev->bus->number, dev->devfn,
276 hwif->pci_dev->vendor, hwif->pci_dev->device,
280 int rc = pci_read_config_byte(dev, reg, &val);
282 printk("proc_ide_read_config: error %d reading"
283 " bus %02x dev %02x reg 0x%02x\n",
284 rc, dev->bus->number, dev->devfn, reg);
285 out += sprintf(out, "??%c",
286 (++reg & 0xf) ? ' ' : '\n');
288 out += sprintf(out, "%02x%c",
289 val, (++reg & 0xf) ? ' ' : '\n');
290 } while (reg < 0x100);
292 #endif /* CONFIG_BLK_DEV_IDEPCI */
293 out += sprintf(out, "(none)\n");
295 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
298 static int proc_ide_read_imodel
299 (char *page, char **start, off_t off, int count, int *eof, void *data)
301 ide_hwif_t *hwif = (ide_hwif_t *) data;
306 * Neither ide_unknown nor ide_forced should be set at this point.
308 switch (hwif->chipset) {
309 case ide_generic: name = "generic"; break;
310 case ide_pci: name = "pci"; break;
311 case ide_cmd640: name = "cmd640"; break;
312 case ide_dtc2278: name = "dtc2278"; break;
313 case ide_ali14xx: name = "ali14xx"; break;
314 case ide_qd65xx: name = "qd65xx"; break;
315 case ide_umc8672: name = "umc8672"; break;
316 case ide_ht6560b: name = "ht6560b"; break;
317 case ide_pdc4030: name = "pdc4030"; break;
318 case ide_rz1000: name = "rz1000"; break;
319 case ide_trm290: name = "trm290"; break;
320 case ide_cmd646: name = "cmd646"; break;
321 case ide_cy82c693: name = "cy82c693"; break;
322 case ide_4drives: name = "4drives"; break;
323 case ide_pmac: name = "mac-io"; break;
324 default: name = "(unknown)"; break;
326 len = sprintf(page, "%s\n", name);
327 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
330 static int proc_ide_read_mate
331 (char *page, char **start, off_t off, int count, int *eof, void *data)
333 ide_hwif_t *hwif = (ide_hwif_t *) data;
336 if (hwif && hwif->mate && hwif->mate->present)
337 len = sprintf(page, "%s\n", hwif->mate->name);
339 len = sprintf(page, "(none)\n");
340 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
343 static int proc_ide_read_channel
344 (char *page, char **start, off_t off, int count, int *eof, void *data)
346 ide_hwif_t *hwif = (ide_hwif_t *) data;
349 page[0] = hwif->channel ? '1' : '0';
352 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
355 static int proc_ide_read_identify
356 (char *page, char **start, off_t off, int count, int *eof, void *data)
358 ide_drive_t *drive = (ide_drive_t *)data;
362 len = sprintf(page, "\n");
366 unsigned short *val = (unsigned short *) page;
369 * The current code can't handle a driverless
370 * identify query taskfile. Now the right fix is
371 * to add a 'default' driver but that is a bit
374 * FIXME: this has to be fixed for hotswap devices
378 err = taskfile_lib_get_identify(drive, page);
379 else /* This relies on the ID changes */
380 val = (unsigned short *)drive->id;
384 char *out = ((char *)page) + (SECTOR_WORDS * 4);
387 out += sprintf(out, "%04x%c",
388 le16_to_cpu(*val), (++i & 7) ? ' ' : '\n');
390 } while (i < (SECTOR_WORDS * 2));
394 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
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 down(&ide_setting_sem);
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 if ((rc = ide_read_setting(drive, setting)) >= 0)
413 out += sprintf(out, "%-16d", rc * mul_factor / div_factor);
415 out += sprintf(out, "%-16s", "write-only");
416 out += sprintf(out, "%-16d%-16d", (setting->min * mul_factor + div_factor - 1) / div_factor, setting->max * mul_factor / div_factor);
417 if (setting->rw & SETTING_READ)
418 out += sprintf(out, "r");
419 if (setting->rw & SETTING_WRITE)
420 out += sprintf(out, "w");
421 out += sprintf(out, "\n");
422 setting = setting->next;
425 up(&ide_setting_sem);
426 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
431 static int proc_ide_write_settings(struct file *file, const char __user *buffer,
432 unsigned long count, void *data)
434 ide_drive_t *drive = (ide_drive_t *) data;
435 char name[MAX_LEN + 1];
438 ide_settings_t *setting;
441 if (!capable(CAP_SYS_ADMIN))
444 if (count >= PAGE_SIZE)
447 s = buf = (char *)__get_free_page(GFP_USER);
451 if (copy_from_user(buf, buffer, count)) {
452 free_page((unsigned long)buf);
459 * Skip over leading whitespace
461 while (count && isspace(*s)) {
466 * Do one full pass to verify all parameters,
467 * then do another to actually write the new settings.
476 while (n > 0 && *p != ':') {
484 memcpy(name, q, p - q);
493 val = simple_strtoul(p, &q, 10);
496 if (n > 0 && !isspace(*p))
498 while (n > 0 && isspace(*p)) {
503 down(&ide_setting_sem);
504 setting = ide_find_setting_by_name(drive, name);
507 up(&ide_setting_sem);
511 ide_write_setting(drive, setting, val * setting->div_factor / setting->mul_factor);
512 up(&ide_setting_sem);
514 } while (!for_real++);
515 free_page((unsigned long)buf);
518 free_page((unsigned long)buf);
519 printk("proc_ide_write_settings(): parse error\n");
523 int proc_ide_read_capacity
524 (char *page, char **start, off_t off, int count, int *eof, void *data)
526 ide_drive_t *drive = (ide_drive_t *) data;
529 len = sprintf(page,"%llu\n",
530 (long long) (DRIVER(drive)->capacity(drive)));
531 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
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 struct hd_driveid *id = drive->id;
559 len = sprintf(page, "%.40s\n",
560 (id && id->model[0]) ? (char *)id->model : "(none)");
561 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
564 static int proc_ide_read_driver
565 (char *page, char **start, off_t off, int count, int *eof, void *data)
567 ide_drive_t *drive = (ide_drive_t *) data;
568 ide_driver_t *driver = drive->driver;
571 len = sprintf(page, "%s version %s\n",
572 driver->name, driver->version);
573 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
576 static int proc_ide_write_driver
577 (struct file *file, const char __user *buffer, unsigned long count, void *data)
579 ide_drive_t *drive = (ide_drive_t *) data;
582 if (!capable(CAP_SYS_ADMIN))
586 if (copy_from_user(name, buffer, count))
589 if (ide_replace_subdriver(drive, name))
594 static int proc_ide_read_media
595 (char *page, char **start, off_t off, int count, int *eof, void *data)
597 ide_drive_t *drive = (ide_drive_t *) data;
601 switch (drive->media) {
602 case ide_disk: media = "disk\n";
604 case ide_cdrom: media = "cdrom\n";
606 case ide_tape: media = "tape\n";
608 case ide_floppy:media = "floppy\n";
610 default: media = "UNKNOWN\n";
615 PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
618 static ide_proc_entry_t generic_drive_entries[] = {
619 { "driver", S_IFREG|S_IRUGO, proc_ide_read_driver, proc_ide_write_driver },
620 { "identify", S_IFREG|S_IRUSR, proc_ide_read_identify, NULL },
621 { "media", S_IFREG|S_IRUGO, proc_ide_read_media, NULL },
622 { "model", S_IFREG|S_IRUGO, proc_ide_read_dmodel, NULL },
623 { "settings", S_IFREG|S_IRUSR|S_IWUSR,proc_ide_read_settings, proc_ide_write_settings },
624 { NULL, 0, NULL, NULL }
627 void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data)
629 struct proc_dir_entry *ent;
633 while (p->name != NULL) {
634 ent = create_proc_entry(p->name, p->mode, dir);
638 ent->read_proc = p->read_proc;
639 ent->write_proc = p->write_proc;
644 void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p)
648 while (p->name != NULL) {
649 remove_proc_entry(p->name, dir);
654 static void create_proc_ide_drives(ide_hwif_t *hwif)
657 struct proc_dir_entry *ent;
658 struct proc_dir_entry *parent = hwif->proc;
661 for (d = 0; d < MAX_DRIVES; d++) {
662 ide_drive_t *drive = &hwif->drives[d];
669 drive->proc = proc_mkdir(drive->name, parent);
671 ide_add_proc_entries(drive->proc, generic_drive_entries, drive);
672 sprintf(name,"ide%d/%s", (drive->name[2]-'a')/2, drive->name);
673 ent = proc_symlink(drive->name, proc_ide_root, name);
678 static void destroy_proc_ide_device(ide_hwif_t *hwif, ide_drive_t *drive)
680 ide_driver_t *driver = drive->driver;
683 ide_remove_proc_entries(drive->proc, driver->proc);
684 ide_remove_proc_entries(drive->proc, generic_drive_entries);
685 remove_proc_entry(drive->name, proc_ide_root);
686 remove_proc_entry(drive->name, hwif->proc);
691 void destroy_proc_ide_drives(ide_hwif_t *hwif)
695 for (d = 0; d < MAX_DRIVES; d++) {
696 ide_drive_t *drive = &hwif->drives[d];
698 destroy_proc_ide_device(hwif, drive);
702 static ide_proc_entry_t hwif_entries[] = {
703 { "channel", S_IFREG|S_IRUGO, proc_ide_read_channel, NULL },
704 { "config", S_IFREG|S_IRUGO|S_IWUSR,proc_ide_read_config, proc_ide_write_config },
705 { "mate", S_IFREG|S_IRUGO, proc_ide_read_mate, NULL },
706 { "model", S_IFREG|S_IRUGO, proc_ide_read_imodel, NULL },
707 { NULL, 0, NULL, NULL }
710 void create_proc_ide_interfaces(void)
714 for (h = 0; h < MAX_HWIFS; h++) {
715 ide_hwif_t *hwif = &ide_hwifs[h];
720 hwif->proc = proc_mkdir(hwif->name, proc_ide_root);
723 ide_add_proc_entries(hwif->proc, hwif_entries, hwif);
725 create_proc_ide_drives(hwif);
729 EXPORT_SYMBOL(create_proc_ide_interfaces);
731 #ifdef CONFIG_BLK_DEV_IDEPCI
732 void ide_pci_create_host_proc(const char *name, get_info_t *get_info)
734 create_proc_info_entry(name, 0, proc_ide_root, get_info);
737 EXPORT_SYMBOL_GPL(ide_pci_create_host_proc);
740 void destroy_proc_ide_interfaces(void)
744 for (h = 0; h < MAX_HWIFS; h++) {
745 ide_hwif_t *hwif = &ide_hwifs[h];
746 int exist = (hwif->proc != NULL);
752 destroy_proc_ide_drives(hwif);
753 ide_remove_proc_entries(hwif->proc, hwif_entries);
754 remove_proc_entry(hwif->name, proc_ide_root);
761 EXPORT_SYMBOL(destroy_proc_ide_interfaces);
763 extern struct seq_operations ide_drivers_op;
764 static int ide_drivers_open(struct inode *inode, struct file *file)
766 return seq_open(file, &ide_drivers_op);
768 static struct file_operations ide_drivers_operations = {
769 .open = ide_drivers_open,
772 .release = seq_release,
775 void proc_ide_create(void)
777 struct proc_dir_entry *entry;
782 create_proc_ide_interfaces();
784 entry = create_proc_entry("drivers", 0, proc_ide_root);
786 entry->proc_fops = &ide_drivers_operations;
789 void proc_ide_destroy(void)
791 remove_proc_entry("ide/drivers", proc_ide_root);
792 destroy_proc_ide_interfaces();
793 remove_proc_entry("ide", 0);