drivers/ide/ide-proc.c

   1 /*
   2  *  linux/drivers/ide/ide-proc.c        Version 1.05    Mar 05, 2003
   3  *
   4  *  Copyright (C) 1997-1998     Mark Lord
   5  *  Copyright (C) 2003          Red Hat <alan@redhat.com>
   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  * 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.
  22  *
  23  */
  24
  25 #include <linux/module.h>
  26
  27 #include <asm/uaccess.h>
  28 #include <linux/errno.h>
  29 #include <linux/sched.h>
  30 #include <linux/proc_fs.h>
  31 #include <linux/stat.h>
  32 #include <linux/mm.h>
  33 #include <linux/pci.h>
  34 #include <linux/ctype.h>
  35 #include <linux/hdreg.h>
  36 #include <linux/ide.h>
  37 #include <linux/seq_file.h>
  38
  39 #include <asm/io.h>
  40
  41 static int proc_ide_read_imodel
  42         (char *page, char **start, off_t off, int count, int *eof, void *data)
  43 {
  44         ide_hwif_t      *hwif = (ide_hwif_t *) data;
  45         int             len;
  46         const char      *name;
  47
  48         /*
  49          * Neither ide_unknown nor ide_forced should be set at this point.
  50          */
  51         switch (hwif->chipset) {
  52                 case ide_generic:       name = "generic";       break;
  53                 case ide_pci:           name = "pci";           break;
  54                 case ide_cmd640:        name = "cmd640";        break;
  55                 case ide_dtc2278:       name = "dtc2278";       break;
  56                 case ide_ali14xx:       name = "ali14xx";       break;
  57                 case ide_qd65xx:        name = "qd65xx";        break;
  58                 case ide_umc8672:       name = "umc8672";       break;
  59                 case ide_ht6560b:       name = "ht6560b";       break;
  60                 case ide_rz1000:        name = "rz1000";        break;
  61                 case ide_trm290:        name = "trm290";        break;
  62                 case ide_cmd646:        name = "cmd646";        break;
  63                 case ide_cy82c693:      name = "cy82c693";      break;
  64                 case ide_4drives:       name = "4drives";       break;
  65                 case ide_pmac:          name = "mac-io";        break;
  66                 case ide_au1xxx:        name = "au1xxx";        break;
  67                 default:                name = "(unknown)";     break;
  68         }
  69         len = sprintf(page, "%s\n", name);
  70         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
  71 }
  72
  73 static int proc_ide_read_mate
  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         if (hwif && hwif->mate && hwif->mate->present)
  80                 len = sprintf(page, "%s\n", hwif->mate->name);
  81         else
  82                 len = sprintf(page, "(none)\n");
  83         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
  84 }
  85
  86 static int proc_ide_read_channel
  87         (char *page, char **start, off_t off, int count, int *eof, void *data)
  88 {
  89         ide_hwif_t      *hwif = (ide_hwif_t *) data;
  90         int             len;
  91
  92         page[0] = hwif->channel ? '1' : '0';
  93         page[1] = '\n';
  94         len = 2;
  95         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
  96 }
  97
  98 static int proc_ide_read_identify
  99         (char *page, char **start, off_t off, int count, int *eof, void *data)
 100 {
 101         ide_drive_t     *drive = (ide_drive_t *)data;
 102         int             len = 0, i = 0;
 103         int             err = 0;
 104
 105         len = sprintf(page, "\n");
 106
 107         if (drive) {
 108                 unsigned short *val = (unsigned short *) page;
 109
 110                 err = taskfile_lib_get_identify(drive, page);
 111                 if (!err) {
 112                         char *out = ((char *)page) + (SECTOR_WORDS * 4);
 113                         page = out;
 114                         do {
 115                                 out += sprintf(out, "%04x%c",
 116                                         le16_to_cpu(*val), (++i & 7) ? ' ' : '\n');
 117                                 val += 1;
 118                         } while (i < (SECTOR_WORDS * 2));
 119                         len = out - page;
 120                 }
 121         }
 122         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
 123 }
 124
 125 static void proc_ide_settings_warn(void)
 126 {
 127         static int warned = 0;
 128
 129         if (warned)
 130                 return;
 131
 132         printk(KERN_WARNING "Warning: /proc/ide/hd?/settings interface is "
 133                             "obsolete, and will be removed soon!\n");
 134         warned = 1;
 135 }
 136
 137 static int proc_ide_read_settings
 138         (char *page, char **start, off_t off, int count, int *eof, void *data)
 139 {
 140         ide_drive_t     *drive = (ide_drive_t *) data;
 141         ide_settings_t  *setting = (ide_settings_t *) drive->settings;
 142         char            *out = page;
 143         int             len, rc, mul_factor, div_factor;
 144
 145         proc_ide_settings_warn();
 146
 147         down(&ide_setting_sem);
 148         out += sprintf(out, "name\t\t\tvalue\t\tmin\t\tmax\t\tmode\n");
 149         out += sprintf(out, "----\t\t\t-----\t\t---\t\t---\t\t----\n");
 150         while(setting) {
 151                 mul_factor = setting->mul_factor;
 152                 div_factor = setting->div_factor;
 153                 out += sprintf(out, "%-24s", setting->name);
 154                 if ((rc = ide_read_setting(drive, setting)) >= 0)
 155                         out += sprintf(out, "%-16d", rc * mul_factor / div_factor);
 156                 else
 157                         out += sprintf(out, "%-16s", "write-only");
 158                 out += sprintf(out, "%-16d%-16d", (setting->min * mul_factor + div_factor - 1) / div_factor, setting->max * mul_factor / div_factor);
 159                 if (setting->rw & SETTING_READ)
 160                         out += sprintf(out, "r");
 161                 if (setting->rw & SETTING_WRITE)
 162                         out += sprintf(out, "w");
 163                 out += sprintf(out, "\n");
 164                 setting = setting->next;
 165         }
 166         len = out - page;
 167         up(&ide_setting_sem);
 168         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
 169 }
 170
 171 #define MAX_LEN 30
 172
 173 static int proc_ide_write_settings(struct file *file, const char __user *buffer,
 174                                    unsigned long count, void *data)
 175 {
 176         ide_drive_t     *drive = (ide_drive_t *) data;
 177         char            name[MAX_LEN + 1];
 178         int             for_real = 0;
 179         unsigned long   n;
 180         ide_settings_t  *setting;
 181         char *buf, *s;
 182
 183         if (!capable(CAP_SYS_ADMIN))
 184                 return -EACCES;
 185
 186         proc_ide_settings_warn();
 187
 188         if (count >= PAGE_SIZE)
 189                 return -EINVAL;
 190
 191         s = buf = (char *)__get_free_page(GFP_USER);
 192         if (!buf)
 193                 return -ENOMEM;
 194
 195         if (copy_from_user(buf, buffer, count)) {
 196                 free_page((unsigned long)buf);
 197                 return -EFAULT;
 198         }
 199
 200         buf[count] = '\0';
 201
 202         /*
 203          * Skip over leading whitespace
 204          */
 205         while (count && isspace(*s)) {
 206                 --count;
 207                 ++s;
 208         }
 209         /*
 210          * Do one full pass to verify all parameters,
 211          * then do another to actually write the new settings.
 212          */
 213         do {
 214                 char *p = s;
 215                 n = count;
 216                 while (n > 0) {
 217                         unsigned val;
 218                         char *q = p;
 219
 220                         while (n > 0 && *p != ':') {
 221                                 --n;
 222                                 p++;
 223                         }
 224                         if (*p != ':')
 225                                 goto parse_error;
 226                         if (p - q > MAX_LEN)
 227                                 goto parse_error;
 228                         memcpy(name, q, p - q);
 229                         name[p - q] = 0;
 230
 231                         if (n > 0) {
 232                                 --n;
 233                                 p++;
 234                         } else
 235                                 goto parse_error;
 236
 237                         val = simple_strtoul(p, &q, 10);
 238                         n -= q - p;
 239                         p = q;
 240                         if (n > 0 && !isspace(*p))
 241                                 goto parse_error;
 242                         while (n > 0 && isspace(*p)) {
 243                                 --n;
 244                                 ++p;
 245                         }
 246
 247                         down(&ide_setting_sem);
 248                         setting = ide_find_setting_by_name(drive, name);
 249                         if (!setting)
 250                         {
 251                                 up(&ide_setting_sem);
 252                                 goto parse_error;
 253                         }
 254                         if (for_real)
 255                                 ide_write_setting(drive, setting, val * setting->div_factor / setting->mul_factor);
 256                         up(&ide_setting_sem);
 257                 }
 258         } while (!for_real++);
 259         free_page((unsigned long)buf);
 260         return count;
 261 parse_error:
 262         free_page((unsigned long)buf);
 263         printk("proc_ide_write_settings(): parse error\n");
 264         return -EINVAL;
 265 }
 266
 267 int proc_ide_read_capacity
 268         (char *page, char **start, off_t off, int count, int *eof, void *data)
 269 {
 270         int len = sprintf(page,"%llu\n", (long long)0x7fffffff);
 271         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
 272 }
 273
 274 EXPORT_SYMBOL_GPL(proc_ide_read_capacity);
 275
 276 int proc_ide_read_geometry
 277         (char *page, char **start, off_t off, int count, int *eof, void *data)
 278 {
 279         ide_drive_t     *drive = (ide_drive_t *) data;
 280         char            *out = page;
 281         int             len;
 282
 283         out += sprintf(out,"physical     %d/%d/%d\n",
 284                         drive->cyl, drive->head, drive->sect);
 285         out += sprintf(out,"logical      %d/%d/%d\n",
 286                         drive->bios_cyl, drive->bios_head, drive->bios_sect);
 287
 288         len = out - page;
 289         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
 290 }
 291
 292 EXPORT_SYMBOL(proc_ide_read_geometry);
 293
 294 static int proc_ide_read_dmodel
 295         (char *page, char **start, off_t off, int count, int *eof, void *data)
 296 {
 297         ide_drive_t     *drive = (ide_drive_t *) data;
 298         struct hd_driveid *id = drive->id;
 299         int             len;
 300
 301         len = sprintf(page, "%.40s\n",
 302                 (id && id->model[0]) ? (char *)id->model : "(none)");
 303         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
 304 }
 305
 306 static int proc_ide_read_driver
 307         (char *page, char **start, off_t off, int count, int *eof, void *data)
 308 {
 309         ide_drive_t     *drive = (ide_drive_t *) data;
 310         struct device   *dev = &drive->gendev;
 311         ide_driver_t    *ide_drv;
 312         int             len;
 313
 314         down_read(&dev->bus->subsys.rwsem);
 315         if (dev->driver) {
 316                 ide_drv = container_of(dev->driver, ide_driver_t, gen_driver);
 317                 len = sprintf(page, "%s version %s\n",
 318                                 dev->driver->name, ide_drv->version);
 319         } else
 320                 len = sprintf(page, "ide-default version 0.9.newide\n");
 321         up_read(&dev->bus->subsys.rwsem);
 322         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
 323 }
 324
 325 static int ide_replace_subdriver(ide_drive_t *drive, const char *driver)
 326 {
 327         struct device *dev = &drive->gendev;
 328         int ret = 1;
 329         int err;
 330
 331         down_write(&dev->bus->subsys.rwsem);
 332         device_release_driver(dev);
 333         /* FIXME: device can still be in use by previous driver */
 334         strlcpy(drive->driver_req, driver, sizeof(drive->driver_req));
 335         err = device_attach(dev);
 336         if (err < 0)
 337                 printk(KERN_WARNING "IDE: %s: device_attach error: %d\n",
 338                         __FUNCTION__, err);
 339         drive->driver_req[0] = 0;
 340         if (dev->driver == NULL) {
 341                 err = device_attach(dev);
 342                 if (err < 0)
 343                         printk(KERN_WARNING
 344                                 "IDE: %s: device_attach(2) error: %d\n",
 345                                 __FUNCTION__, err);
 346         }
 347         if (dev->driver && !strcmp(dev->driver->name, driver))
 348                 ret = 0;
 349         up_write(&dev->bus->subsys.rwsem);
 350
 351         return ret;
 352 }
 353
 354 static int proc_ide_write_driver
 355         (struct file *file, const char __user *buffer, unsigned long count, void *data)
 356 {
 357         ide_drive_t     *drive = (ide_drive_t *) data;
 358         char name[32];
 359
 360         if (!capable(CAP_SYS_ADMIN))
 361                 return -EACCES;
 362         if (count > 31)
 363                 count = 31;
 364         if (copy_from_user(name, buffer, count))
 365                 return -EFAULT;
 366         name[count] = '\0';
 367         if (ide_replace_subdriver(drive, name))
 368                 return -EINVAL;
 369         return count;
 370 }
 371
 372 static int proc_ide_read_media
 373         (char *page, char **start, off_t off, int count, int *eof, void *data)
 374 {
 375         ide_drive_t     *drive = (ide_drive_t *) data;
 376         const char      *media;
 377         int             len;
 378
 379         switch (drive->media) {
 380                 case ide_disk:  media = "disk\n";
 381                                 break;
 382                 case ide_cdrom: media = "cdrom\n";
 383                                 break;
 384                 case ide_tape:  media = "tape\n";
 385                                 break;
 386                 case ide_floppy:media = "floppy\n";
 387                                 break;
 388                 case ide_optical:media = "optical\n";
 389                                 break;
 390                 default:        media = "UNKNOWN\n";
 391                                 break;
 392         }
 393         strcpy(page,media);
 394         len = strlen(media);
 395         PROC_IDE_READ_RETURN(page,start,off,count,eof,len);
 396 }
 397
 398 static ide_proc_entry_t generic_drive_entries[] = {
 399         { "driver",     S_IFREG|S_IRUGO,        proc_ide_read_driver,   proc_ide_write_driver },
 400         { "identify",   S_IFREG|S_IRUSR,        proc_ide_read_identify, NULL },
 401         { "media",      S_IFREG|S_IRUGO,        proc_ide_read_media,    NULL },
 402         { "model",      S_IFREG|S_IRUGO,        proc_ide_read_dmodel,   NULL },
 403         { "settings",   S_IFREG|S_IRUSR|S_IWUSR,proc_ide_read_settings, proc_ide_write_settings },
 404         { NULL, 0, NULL, NULL }
 405 };
 406
 407 void ide_add_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p, void *data)
 408 {
 409         struct proc_dir_entry *ent;
 410
 411         if (!dir || !p)
 412                 return;
 413         while (p->name != NULL) {
 414                 ent = create_proc_entry(p->name, p->mode, dir);
 415                 if (!ent) return;
 416                 ent->nlink = 1;
 417                 ent->data = data;
 418                 ent->read_proc = p->read_proc;
 419                 ent->write_proc = p->write_proc;
 420                 p++;
 421         }
 422 }
 423
 424 void ide_remove_proc_entries(struct proc_dir_entry *dir, ide_proc_entry_t *p)
 425 {
 426         if (!dir || !p)
 427                 return;
 428         while (p->name != NULL) {
 429                 remove_proc_entry(p->name, dir);
 430                 p++;
 431         }
 432 }
 433
 434 static void create_proc_ide_drives(ide_hwif_t *hwif)
 435 {
 436         int     d;
 437         struct proc_dir_entry *ent;
 438         struct proc_dir_entry *parent = hwif->proc;
 439         char name[64];
 440
 441         for (d = 0; d < MAX_DRIVES; d++) {
 442                 ide_drive_t *drive = &hwif->drives[d];
 443
 444                 if (!drive->present)
 445                         continue;
 446                 if (drive->proc)
 447                         continue;
 448
 449                 drive->proc = proc_mkdir(drive->name, parent);
 450                 if (drive->proc)
 451                         ide_add_proc_entries(drive->proc, generic_drive_entries, drive);
 452                 sprintf(name,"ide%d/%s", (drive->name[2]-'a')/2, drive->name);
 453                 ent = proc_symlink(drive->name, proc_ide_root, name);
 454                 if (!ent) return;
 455         }
 456 }
 457
 458 static void destroy_proc_ide_device(ide_hwif_t *hwif, ide_drive_t *drive)
 459 {
 460         if (drive->proc) {
 461                 ide_remove_proc_entries(drive->proc, generic_drive_entries);
 462                 remove_proc_entry(drive->name, proc_ide_root);
 463                 remove_proc_entry(drive->name, hwif->proc);
 464                 drive->proc = NULL;
 465         }
 466 }
 467
 468 static void destroy_proc_ide_drives(ide_hwif_t *hwif)
 469 {
 470         int     d;
 471
 472         for (d = 0; d < MAX_DRIVES; d++) {
 473                 ide_drive_t *drive = &hwif->drives[d];
 474                 if (drive->proc)
 475                         destroy_proc_ide_device(hwif, drive);
 476         }
 477 }
 478
 479 static ide_proc_entry_t hwif_entries[] = {
 480         { "channel",    S_IFREG|S_IRUGO,        proc_ide_read_channel,  NULL },
 481         { "mate",       S_IFREG|S_IRUGO,        proc_ide_read_mate,     NULL },
 482         { "model",      S_IFREG|S_IRUGO,        proc_ide_read_imodel,   NULL },
 483         { NULL, 0, NULL, NULL }
 484 };
 485
 486 void create_proc_ide_interfaces(void)
 487 {
 488         int     h;
 489
 490         for (h = 0; h < MAX_HWIFS; h++) {
 491                 ide_hwif_t *hwif = &ide_hwifs[h];
 492
 493                 if (!hwif->present)
 494                         continue;
 495                 if (!hwif->proc) {
 496                         hwif->proc = proc_mkdir(hwif->name, proc_ide_root);
 497                         if (!hwif->proc)
 498                                 return;
 499                         ide_add_proc_entries(hwif->proc, hwif_entries, hwif);
 500                 }
 501                 create_proc_ide_drives(hwif);
 502         }
 503 }
 504
 505 EXPORT_SYMBOL(create_proc_ide_interfaces);
 506
 507 #ifdef CONFIG_BLK_DEV_IDEPCI
 508 void ide_pci_create_host_proc(const char *name, get_info_t *get_info)
 509 {
 510         create_proc_info_entry(name, 0, proc_ide_root, get_info);
 511 }
 512
 513 EXPORT_SYMBOL_GPL(ide_pci_create_host_proc);
 514 #endif
 515
 516 void destroy_proc_ide_interface(ide_hwif_t *hwif)
 517 {
 518         if (hwif->proc) {
 519                 destroy_proc_ide_drives(hwif);
 520                 ide_remove_proc_entries(hwif->proc, hwif_entries);
 521                 remove_proc_entry(hwif->name, proc_ide_root);
 522                 hwif->proc = NULL;
 523         }
 524 }
 525
 526 static int proc_print_driver(struct device_driver *drv, void *data)
 527 {
 528         ide_driver_t *ide_drv = container_of(drv, ide_driver_t, gen_driver);
 529         struct seq_file *s = data;
 530
 531         seq_printf(s, "%s version %s\n", drv->name, ide_drv->version);
 532
 533         return 0;
 534 }
 535
 536 static int ide_drivers_show(struct seq_file *s, void *p)
 537 {
 538         int err;
 539
 540         err = bus_for_each_drv(&ide_bus_type, NULL, s, proc_print_driver);
 541         if (err < 0)
 542                 printk(KERN_WARNING "IDE: %s: bus_for_each_drv error: %d\n",
 543                         __FUNCTION__, err);
 544         return 0;
 545 }
 546
 547 static int ide_drivers_open(struct inode *inode, struct file *file)
 548 {
 549         return single_open(file, &ide_drivers_show, NULL);
 550 }
 551
 552 static struct file_operations ide_drivers_operations = {
 553         .open           = ide_drivers_open,
 554         .read           = seq_read,
 555         .llseek         = seq_lseek,
 556         .release        = single_release,
 557 };
 558
 559 void proc_ide_create(void)
 560 {
 561         struct proc_dir_entry *entry;
 562
 563         if (!proc_ide_root)
 564                 return;
 565
 566         create_proc_ide_interfaces();
 567
 568         entry = create_proc_entry("drivers", 0, proc_ide_root);
 569         if (entry)
 570                 entry->proc_fops = &ide_drivers_operations;
 571 }
 572
 573 void proc_ide_destroy(void)
 574 {
 575         remove_proc_entry("drivers", proc_ide_root);
 576         remove_proc_entry("ide", NULL);
 577 }