driver core: move klist_children into private structure
[linux-2.6] / drivers / ide / ide-proc.c
1 /*
2  *  Copyright (C) 1997-1998     Mark Lord
3  *  Copyright (C) 2003          Red Hat
4  *
5  *  Some code was moved here from ide.c, see it for original copyrights.
6  */
7
8 /*
9  * This is the /proc/ide/ filesystem implementation.
10  *
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
15  */
16
17 #include <linux/module.h>
18
19 #include <asm/uaccess.h>
20 #include <linux/errno.h>
21 #include <linux/proc_fs.h>
22 #include <linux/stat.h>
23 #include <linux/mm.h>
24 #include <linux/pci.h>
25 #include <linux/ctype.h>
26 #include <linux/ide.h>
27 #include <linux/seq_file.h>
28
29 #include <asm/io.h>
30
31 static struct proc_dir_entry *proc_ide_root;
32
33 static int proc_ide_read_imodel
34         (char *page, char **start, off_t off, int count, int *eof, void *data)
35 {
36         ide_hwif_t      *hwif = (ide_hwif_t *) data;
37         int             len;
38         const char      *name;
39
40         switch (hwif->chipset) {
41         case ide_generic:       name = "generic";       break;
42         case ide_pci:           name = "pci";           break;
43         case ide_cmd640:        name = "cmd640";        break;
44         case ide_dtc2278:       name = "dtc2278";       break;
45         case ide_ali14xx:       name = "ali14xx";       break;
46         case ide_qd65xx:        name = "qd65xx";        break;
47         case ide_umc8672:       name = "umc8672";       break;
48         case ide_ht6560b:       name = "ht6560b";       break;
49         case ide_4drives:       name = "4drives";       break;
50         case ide_pmac:          name = "mac-io";        break;
51         case ide_au1xxx:        name = "au1xxx";        break;
52         case ide_palm3710:      name = "palm3710";      break;
53         case ide_acorn:         name = "acorn";         break;
54         default:                name = "(unknown)";     break;
55         }
56         len = sprintf(page, "%s\n", name);
57         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
58 }
59
60 static int proc_ide_read_mate
61         (char *page, char **start, off_t off, int count, int *eof, void *data)
62 {
63         ide_hwif_t      *hwif = (ide_hwif_t *) data;
64         int             len;
65
66         if (hwif && hwif->mate)
67                 len = sprintf(page, "%s\n", hwif->mate->name);
68         else
69                 len = sprintf(page, "(none)\n");
70         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
71 }
72
73 static int proc_ide_read_channel
74         (char *page, char **start, off_t off, int count, int *eof, void *data)
75 {
76         ide_hwif_t      *hwif = (ide_hwif_t *) data;
77         int             len;
78
79         page[0] = hwif->channel ? '1' : '0';
80         page[1] = '\n';
81         len = 2;
82         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
83 }
84
85 static int proc_ide_read_identify
86         (char *page, char **start, off_t off, int count, int *eof, void *data)
87 {
88         ide_drive_t     *drive = (ide_drive_t *)data;
89         int             len = 0, i = 0;
90         int             err = 0;
91
92         len = sprintf(page, "\n");
93
94         if (drive) {
95                 __le16 *val = (__le16 *)page;
96
97                 err = taskfile_lib_get_identify(drive, page);
98                 if (!err) {
99                         char *out = (char *)page + SECTOR_SIZE;
100
101                         page = out;
102                         do {
103                                 out += sprintf(out, "%04x%c",
104                                         le16_to_cpup(val), (++i & 7) ? ' ' : '\n');
105                                 val += 1;
106                         } while (i < SECTOR_SIZE / 2);
107                         len = out - page;
108                 }
109         }
110         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
111 }
112
113 /**
114  *      ide_find_setting        -       find a specific setting
115  *      @st: setting table pointer
116  *      @name: setting name
117  *
118  *      Scan's the setting table for a matching entry and returns
119  *      this or NULL if no entry is found. The caller must hold the
120  *      setting semaphore
121  */
122
123 static
124 const struct ide_proc_devset *ide_find_setting(const struct ide_proc_devset *st,
125                                                char *name)
126 {
127         while (st->name) {
128                 if (strcmp(st->name, name) == 0)
129                         break;
130                 st++;
131         }
132         return st->name ? st : NULL;
133 }
134
135 /**
136  *      ide_read_setting        -       read an IDE setting
137  *      @drive: drive to read from
138  *      @setting: drive setting
139  *
140  *      Read a drive setting and return the value. The caller
141  *      must hold the ide_setting_mtx when making this call.
142  *
143  *      BUGS: the data return and error are the same return value
144  *      so an error -EINVAL and true return of the same value cannot
145  *      be told apart
146  */
147
148 static int ide_read_setting(ide_drive_t *drive,
149                             const struct ide_proc_devset *setting)
150 {
151         const struct ide_devset *ds = setting->setting;
152         int val = -EINVAL;
153
154         if (ds->get)
155                 val = ds->get(drive);
156
157         return val;
158 }
159
160 /**
161  *      ide_write_setting       -       read an IDE setting
162  *      @drive: drive to read from
163  *      @setting: drive setting
164  *      @val: value
165  *
166  *      Write a drive setting if it is possible. The caller
167  *      must hold the ide_setting_mtx when making this call.
168  *
169  *      BUGS: the data return and error are the same return value
170  *      so an error -EINVAL and true return of the same value cannot
171  *      be told apart
172  *
173  *      FIXME:  This should be changed to enqueue a special request
174  *      to the driver to change settings, and then wait on a sema for completion.
175  *      The current scheme of polling is kludgy, though safe enough.
176  */
177
178 static int ide_write_setting(ide_drive_t *drive,
179                              const struct ide_proc_devset *setting, int val)
180 {
181         const struct ide_devset *ds = setting->setting;
182
183         if (!capable(CAP_SYS_ADMIN))
184                 return -EACCES;
185         if (!ds->set)
186                 return -EPERM;
187         if ((ds->flags & DS_SYNC)
188             && (val < setting->min || val > setting->max))
189                 return -EINVAL;
190         return ide_devset_execute(drive, ds, val);
191 }
192
193 ide_devset_get(xfer_rate, current_speed);
194
195 static int set_xfer_rate (ide_drive_t *drive, int arg)
196 {
197         ide_task_t task;
198         int err;
199
200         if (arg < XFER_PIO_0 || arg > XFER_UDMA_6)
201                 return -EINVAL;
202
203         memset(&task, 0, sizeof(task));
204         task.tf.command = ATA_CMD_SET_FEATURES;
205         task.tf.feature = SETFEATURES_XFER;
206         task.tf.nsect   = (u8)arg;
207         task.tf_flags = IDE_TFLAG_OUT_FEATURE | IDE_TFLAG_OUT_NSECT |
208                         IDE_TFLAG_IN_NSECT;
209
210         err = ide_no_data_taskfile(drive, &task);
211
212         if (!err) {
213                 ide_set_xfer_rate(drive, (u8) arg);
214                 ide_driveid_update(drive);
215         }
216         return err;
217 }
218
219 ide_devset_rw(current_speed, xfer_rate);
220 ide_devset_rw_field(init_speed, init_speed);
221 ide_devset_rw_flag(nice1, IDE_DFLAG_NICE1);
222 ide_devset_rw_field(number, dn);
223
224 static const struct ide_proc_devset ide_generic_settings[] = {
225         IDE_PROC_DEVSET(current_speed, 0, 70),
226         IDE_PROC_DEVSET(init_speed, 0, 70),
227         IDE_PROC_DEVSET(io_32bit,  0, 1 + (SUPPORT_VLB_SYNC << 1)),
228         IDE_PROC_DEVSET(keepsettings, 0, 1),
229         IDE_PROC_DEVSET(nice1, 0, 1),
230         IDE_PROC_DEVSET(number, 0, 3),
231         IDE_PROC_DEVSET(pio_mode, 0, 255),
232         IDE_PROC_DEVSET(unmaskirq, 0, 1),
233         IDE_PROC_DEVSET(using_dma, 0, 1),
234         { 0 },
235 };
236
237 static void proc_ide_settings_warn(void)
238 {
239         static int warned;
240
241         if (warned)
242                 return;
243
244         printk(KERN_WARNING "Warning: /proc/ide/hd?/settings interface is "
245                             "obsolete, and will be removed soon!\n");
246         warned = 1;
247 }
248
249 static int proc_ide_read_settings
250         (char *page, char **start, off_t off, int count, int *eof, void *data)
251 {
252         const struct ide_proc_devset *setting, *g, *d;
253         const struct ide_devset *ds;
254         ide_drive_t     *drive = (ide_drive_t *) data;
255         char            *out = page;
256         int             len, rc, mul_factor, div_factor;
257
258         proc_ide_settings_warn();
259
260         mutex_lock(&ide_setting_mtx);
261         g = ide_generic_settings;
262         d = drive->settings;
263         out += sprintf(out, "name\t\t\tvalue\t\tmin\t\tmax\t\tmode\n");
264         out += sprintf(out, "----\t\t\t-----\t\t---\t\t---\t\t----\n");
265         while (g->name || (d && d->name)) {
266                 /* read settings in the alphabetical order */
267                 if (g->name && d && d->name) {
268                         if (strcmp(d->name, g->name) < 0)
269                                 setting = d++;
270                         else
271                                 setting = g++;
272                 } else if (d && d->name) {
273                         setting = d++;
274                 } else
275                         setting = g++;
276                 mul_factor = setting->mulf ? setting->mulf(drive) : 1;
277                 div_factor = setting->divf ? setting->divf(drive) : 1;
278                 out += sprintf(out, "%-24s", setting->name);
279                 rc = ide_read_setting(drive, setting);
280                 if (rc >= 0)
281                         out += sprintf(out, "%-16d", rc * mul_factor / div_factor);
282                 else
283                         out += sprintf(out, "%-16s", "write-only");
284                 out += sprintf(out, "%-16d%-16d", (setting->min * mul_factor + div_factor - 1) / div_factor, setting->max * mul_factor / div_factor);
285                 ds = setting->setting;
286                 if (ds->get)
287                         out += sprintf(out, "r");
288                 if (ds->set)
289                         out += sprintf(out, "w");
290                 out += sprintf(out, "\n");
291         }
292         len = out - page;
293         mutex_unlock(&ide_setting_mtx);
294         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
295 }
296
297 #define MAX_LEN 30
298
299 static int proc_ide_write_settings(struct file *file, const char __user *buffer,
300                                    unsigned long count, void *data)
301 {
302         ide_drive_t     *drive = (ide_drive_t *) data;
303         char            name[MAX_LEN + 1];
304         int             for_real = 0, mul_factor, div_factor;
305         unsigned long   n;
306
307         const struct ide_proc_devset *setting;
308         char *buf, *s;
309
310         if (!capable(CAP_SYS_ADMIN))
311                 return -EACCES;
312
313         proc_ide_settings_warn();
314
315         if (count >= PAGE_SIZE)
316                 return -EINVAL;
317
318         s = buf = (char *)__get_free_page(GFP_USER);
319         if (!buf)
320                 return -ENOMEM;
321
322         if (copy_from_user(buf, buffer, count)) {
323                 free_page((unsigned long)buf);
324                 return -EFAULT;
325         }
326
327         buf[count] = '\0';
328
329         /*
330          * Skip over leading whitespace
331          */
332         while (count && isspace(*s)) {
333                 --count;
334                 ++s;
335         }
336         /*
337          * Do one full pass to verify all parameters,
338          * then do another to actually write the new settings.
339          */
340         do {
341                 char *p = s;
342                 n = count;
343                 while (n > 0) {
344                         unsigned val;
345                         char *q = p;
346
347                         while (n > 0 && *p != ':') {
348                                 --n;
349                                 p++;
350                         }
351                         if (*p != ':')
352                                 goto parse_error;
353                         if (p - q > MAX_LEN)
354                                 goto parse_error;
355                         memcpy(name, q, p - q);
356                         name[p - q] = 0;
357
358                         if (n > 0) {
359                                 --n;
360                                 p++;
361                         } else
362                                 goto parse_error;
363
364                         val = simple_strtoul(p, &q, 10);
365                         n -= q - p;
366                         p = q;
367                         if (n > 0 && !isspace(*p))
368                                 goto parse_error;
369                         while (n > 0 && isspace(*p)) {
370                                 --n;
371                                 ++p;
372                         }
373
374                         mutex_lock(&ide_setting_mtx);
375                         /* generic settings first, then driver specific ones */
376                         setting = ide_find_setting(ide_generic_settings, name);
377                         if (!setting) {
378                                 if (drive->settings)
379                                         setting = ide_find_setting(drive->settings, name);
380                                 if (!setting) {
381                                         mutex_unlock(&ide_setting_mtx);
382                                         goto parse_error;
383                                 }
384                         }
385                         if (for_real) {
386                                 mul_factor = setting->mulf ? setting->mulf(drive) : 1;
387                                 div_factor = setting->divf ? setting->divf(drive) : 1;
388                                 ide_write_setting(drive, setting, val * div_factor / mul_factor);
389                         }
390                         mutex_unlock(&ide_setting_mtx);
391                 }
392         } while (!for_real++);
393         free_page((unsigned long)buf);
394         return count;
395 parse_error:
396         free_page((unsigned long)buf);
397         printk("proc_ide_write_settings(): parse error\n");
398         return -EINVAL;
399 }
400
401 int proc_ide_read_capacity
402         (char *page, char **start, off_t off, int count, int *eof, void *data)
403 {
404         int len = sprintf(page, "%llu\n", (long long)0x7fffffff);
405         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
406 }
407
408 EXPORT_SYMBOL_GPL(proc_ide_read_capacity);
409
410 int proc_ide_read_geometry
411         (char *page, char **start, off_t off, int count, int *eof, void *data)
412 {
413         ide_drive_t     *drive = (ide_drive_t *) data;
414         char            *out = page;
415         int             len;
416
417         out += sprintf(out, "physical     %d/%d/%d\n",
418                         drive->cyl, drive->head, drive->sect);
419         out += sprintf(out, "logical      %d/%d/%d\n",
420                         drive->bios_cyl, drive->bios_head, drive->bios_sect);
421
422         len = out - page;
423         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
424 }
425
426 EXPORT_SYMBOL(proc_ide_read_geometry);
427
428 static int proc_ide_read_dmodel
429         (char *page, char **start, off_t off, int count, int *eof, void *data)
430 {
431         ide_drive_t     *drive = (ide_drive_t *) data;
432         char            *m = (char *)&drive->id[ATA_ID_PROD];
433         int             len;
434
435         len = sprintf(page, "%.40s\n", m[0] ? m : "(none)");
436         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
437 }
438
439 static int proc_ide_read_driver
440         (char *page, char **start, off_t off, int count, int *eof, void *data)
441 {
442         ide_drive_t     *drive = (ide_drive_t *) data;
443         struct device   *dev = &drive->gendev;
444         ide_driver_t    *ide_drv;
445         int             len;
446
447         if (dev->driver) {
448                 ide_drv = container_of(dev->driver, ide_driver_t, gen_driver);
449                 len = sprintf(page, "%s version %s\n",
450                                 dev->driver->name, ide_drv->version);
451         } else
452                 len = sprintf(page, "ide-default version 0.9.newide\n");
453         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
454 }
455
456 static int ide_replace_subdriver(ide_drive_t *drive, const char *driver)
457 {
458         struct device *dev = &drive->gendev;
459         int ret = 1;
460         int err;
461
462         device_release_driver(dev);
463         /* FIXME: device can still be in use by previous driver */
464         strlcpy(drive->driver_req, driver, sizeof(drive->driver_req));
465         err = device_attach(dev);
466         if (err < 0)
467                 printk(KERN_WARNING "IDE: %s: device_attach error: %d\n",
468                         __func__, err);
469         drive->driver_req[0] = 0;
470         if (dev->driver == NULL) {
471                 err = device_attach(dev);
472                 if (err < 0)
473                         printk(KERN_WARNING
474                                 "IDE: %s: device_attach(2) error: %d\n",
475                                 __func__, err);
476         }
477         if (dev->driver && !strcmp(dev->driver->name, driver))
478                 ret = 0;
479
480         return ret;
481 }
482
483 static int proc_ide_write_driver
484         (struct file *file, const char __user *buffer, unsigned long count, void *data)
485 {
486         ide_drive_t     *drive = (ide_drive_t *) data;
487         char name[32];
488
489         if (!capable(CAP_SYS_ADMIN))
490                 return -EACCES;
491         if (count > 31)
492                 count = 31;
493         if (copy_from_user(name, buffer, count))
494                 return -EFAULT;
495         name[count] = '\0';
496         if (ide_replace_subdriver(drive, name))
497                 return -EINVAL;
498         return count;
499 }
500
501 static int proc_ide_read_media
502         (char *page, char **start, off_t off, int count, int *eof, void *data)
503 {
504         ide_drive_t     *drive = (ide_drive_t *) data;
505         const char      *media;
506         int             len;
507
508         switch (drive->media) {
509         case ide_disk:          media = "disk\n";       break;
510         case ide_cdrom:         media = "cdrom\n";      break;
511         case ide_tape:          media = "tape\n";       break;
512         case ide_floppy:        media = "floppy\n";     break;
513         case ide_optical:       media = "optical\n";    break;
514         default:                media = "UNKNOWN\n";    break;
515         }
516         strcpy(page, media);
517         len = strlen(media);
518         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
519 }
520
521 static ide_proc_entry_t generic_drive_entries[] = {
522         { "driver",     S_IFREG|S_IRUGO,         proc_ide_read_driver,
523                                                  proc_ide_write_driver },
524         { "identify",   S_IFREG|S_IRUSR,         proc_ide_read_identify, NULL },
525         { "media",      S_IFREG|S_IRUGO,         proc_ide_read_media,    NULL },
526         { "model",      S_IFREG|S_IRUGO,         proc_ide_read_dmodel,   NULL },
527         { "settings",   S_IFREG|S_IRUSR|S_IWUSR, proc_ide_read_settings,
528                                                  proc_ide_write_settings },
529         { NULL, 0, NULL, NULL }
530 };
531
532 static void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data)
533 {
534         struct proc_dir_entry *ent;
535
536         if (!dir || !p)
537                 return;
538         while (p->name != NULL) {
539                 ent = create_proc_entry(p->name, p->mode, dir);
540                 if (!ent) return;
541                 ent->data = data;
542                 ent->read_proc = p->read_proc;
543                 ent->write_proc = p->write_proc;
544                 p++;
545         }
546 }
547
548 static void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p)
549 {
550         if (!dir || !p)
551                 return;
552         while (p->name != NULL) {
553                 remove_proc_entry(p->name, dir);
554                 p++;
555         }
556 }
557
558 void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver)
559 {
560         mutex_lock(&ide_setting_mtx);
561         drive->settings = driver->proc_devsets(drive);
562         mutex_unlock(&ide_setting_mtx);
563
564         ide_add_proc_entries(drive->proc, driver->proc_entries(drive), drive);
565 }
566
567 EXPORT_SYMBOL(ide_proc_register_driver);
568
569 /**
570  *      ide_proc_unregister_driver      -       remove driver specific data
571  *      @drive: drive
572  *      @driver: driver
573  *
574  *      Clean up the driver specific /proc files and IDE settings
575  *      for a given drive.
576  *
577  *      Takes ide_setting_mtx.
578  */
579
580 void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver)
581 {
582         ide_remove_proc_entries(drive->proc, driver->proc_entries(drive));
583
584         mutex_lock(&ide_setting_mtx);
585         /*
586          * ide_setting_mtx protects both the settings list and the use
587          * of settings (we cannot take a setting out that is being used).
588          */
589         drive->settings = NULL;
590         mutex_unlock(&ide_setting_mtx);
591 }
592 EXPORT_SYMBOL(ide_proc_unregister_driver);
593
594 void ide_proc_port_register_devices(ide_hwif_t *hwif)
595 {
596         int     d;
597         struct proc_dir_entry *ent;
598         struct proc_dir_entry *parent = hwif->proc;
599         char name[64];
600
601         for (d = 0; d < MAX_DRIVES; d++) {
602                 ide_drive_t *drive = &hwif->drives[d];
603
604                 if ((drive->dev_flags & IDE_DFLAG_PRESENT) == 0 || drive->proc)
605                         continue;
606
607                 drive->proc = proc_mkdir(drive->name, parent);
608                 if (drive->proc)
609                         ide_add_proc_entries(drive->proc, generic_drive_entries, drive);
610                 sprintf(name, "ide%d/%s", (drive->name[2]-'a')/2, drive->name);
611                 ent = proc_symlink(drive->name, proc_ide_root, name);
612                 if (!ent) return;
613         }
614 }
615
616 void ide_proc_unregister_device(ide_drive_t *drive)
617 {
618         if (drive->proc) {
619                 ide_remove_proc_entries(drive->proc, generic_drive_entries);
620                 remove_proc_entry(drive->name, proc_ide_root);
621                 remove_proc_entry(drive->name, drive->hwif->proc);
622                 drive->proc = NULL;
623         }
624 }
625
626 static ide_proc_entry_t hwif_entries[] = {
627         { "channel",    S_IFREG|S_IRUGO,        proc_ide_read_channel,  NULL },
628         { "mate",       S_IFREG|S_IRUGO,        proc_ide_read_mate,     NULL },
629         { "model",      S_IFREG|S_IRUGO,        proc_ide_read_imodel,   NULL },
630         { NULL, 0, NULL, NULL }
631 };
632
633 void ide_proc_register_port(ide_hwif_t *hwif)
634 {
635         if (!hwif->proc) {
636                 hwif->proc = proc_mkdir(hwif->name, proc_ide_root);
637
638                 if (!hwif->proc)
639                         return;
640
641                 ide_add_proc_entries(hwif->proc, hwif_entries, hwif);
642         }
643 }
644
645 void ide_proc_unregister_port(ide_hwif_t *hwif)
646 {
647         if (hwif->proc) {
648                 ide_remove_proc_entries(hwif->proc, hwif_entries);
649                 remove_proc_entry(hwif->name, proc_ide_root);
650                 hwif->proc = NULL;
651         }
652 }
653
654 static int proc_print_driver(struct device_driver *drv, void *data)
655 {
656         ide_driver_t *ide_drv = container_of(drv, ide_driver_t, gen_driver);
657         struct seq_file *s = data;
658
659         seq_printf(s, "%s version %s\n", drv->name, ide_drv->version);
660
661         return 0;
662 }
663
664 static int ide_drivers_show(struct seq_file *s, void *p)
665 {
666         int err;
667
668         err = bus_for_each_drv(&ide_bus_type, NULL, s, proc_print_driver);
669         if (err < 0)
670                 printk(KERN_WARNING "IDE: %s: bus_for_each_drv error: %d\n",
671                         __func__, err);
672         return 0;
673 }
674
675 static int ide_drivers_open(struct inode *inode, struct file *file)
676 {
677         return single_open(file, &ide_drivers_show, NULL);
678 }
679
680 static const struct file_operations ide_drivers_operations = {
681         .owner          = THIS_MODULE,
682         .open           = ide_drivers_open,
683         .read           = seq_read,
684         .llseek         = seq_lseek,
685         .release        = single_release,
686 };
687
688 void proc_ide_create(void)
689 {
690         proc_ide_root = proc_mkdir("ide", NULL);
691
692         if (!proc_ide_root)
693                 return;
694
695         proc_create("drivers", 0, proc_ide_root, &ide_drivers_operations);
696 }
697
698 void proc_ide_destroy(void)
699 {
700         remove_proc_entry("drivers", proc_ide_root);
701         remove_proc_entry("ide", NULL);
702 }