drivers/parport/procfs.c

   1 /* Sysctl interface for parport devices.
   2  *
   3  * Authors: David Campbell
   4  *          Tim Waugh <tim@cyberelk.demon.co.uk>
   5  *          Philip Blundell <philb@gnu.org>
   6  *          Andrea Arcangeli
   7  *          Riccardo Facchetti <fizban@tin.it>
   8  *
   9  * based on work by Grant Guenther <grant@torque.net>
  10  *              and Philip Blundell
  11  *
  12  * Cleaned up include files - Russell King <linux@arm.uk.linux.org>
  13  */
  14
  15 #include <linux/string.h>
  16 #include <linux/init.h>
  17 #include <linux/module.h>
  18 #include <linux/errno.h>
  19 #include <linux/kernel.h>
  20 #include <linux/slab.h>
  21 #include <linux/parport.h>
  22 #include <linux/ctype.h>
  23 #include <linux/sysctl.h>
  24
  25 #include <asm/uaccess.h>
  26
  27 #if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
  28
  29 #define PARPORT_MIN_TIMESLICE_VALUE 1ul
  30 #define PARPORT_MAX_TIMESLICE_VALUE ((unsigned long) HZ)
  31 #define PARPORT_MIN_SPINTIME_VALUE 1
  32 #define PARPORT_MAX_SPINTIME_VALUE 1000
  33
  34 static int do_active_device(ctl_table *table, int write, struct file *filp,
  35                       void __user *result, size_t *lenp, loff_t *ppos)
  36 {
  37         struct parport *port = (struct parport *)table->extra1;
  38         char buffer[256];
  39         struct pardevice *dev;
  40         int len = 0;
  41
  42         if (write)              /* can't happen anyway */
  43                 return -EACCES;
  44
  45         if (*ppos) {
  46                 *lenp = 0;
  47                 return 0;
  48         }
  49
  50         for (dev = port->devices; dev ; dev = dev->next) {
  51                 if(dev == port->cad) {
  52                         len += sprintf(buffer, "%s\n", dev->name);
  53                 }
  54         }
  55
  56         if(!len) {
  57                 len += sprintf(buffer, "%s\n", "none");
  58         }
  59
  60         if (len > *lenp)
  61                 len = *lenp;
  62         else
  63                 *lenp = len;
  64
  65         *ppos += len;
  66
  67         return copy_to_user(result, buffer, len) ? -EFAULT : 0;
  68 }
  69
  70 #ifdef CONFIG_PARPORT_1284
  71 static int do_autoprobe(ctl_table *table, int write, struct file *filp,
  72                         void __user *result, size_t *lenp, loff_t *ppos)
  73 {
  74         struct parport_device_info *info = table->extra2;
  75         const char *str;
  76         char buffer[256];
  77         int len = 0;
  78
  79         if (write) /* permissions stop this */
  80                 return -EACCES;
  81
  82         if (*ppos) {
  83                 *lenp = 0;
  84                 return 0;
  85         }
  86
  87         if ((str = info->class_name) != NULL)
  88                 len += sprintf (buffer + len, "CLASS:%s;\n", str);
  89
  90         if ((str = info->model) != NULL)
  91                 len += sprintf (buffer + len, "MODEL:%s;\n", str);
  92
  93         if ((str = info->mfr) != NULL)
  94                 len += sprintf (buffer + len, "MANUFACTURER:%s;\n", str);
  95
  96         if ((str = info->description) != NULL)
  97                 len += sprintf (buffer + len, "DESCRIPTION:%s;\n", str);
  98
  99         if ((str = info->cmdset) != NULL)
 100                 len += sprintf (buffer + len, "COMMAND SET:%s;\n", str);
 101
 102         if (len > *lenp)
 103                 len = *lenp;
 104         else
 105                 *lenp = len;
 106
 107         *ppos += len;
 108
 109         return copy_to_user (result, buffer, len) ? -EFAULT : 0;
 110 }
 111 #endif /* IEEE1284.3 support. */
 112
 113 static int do_hardware_base_addr (ctl_table *table, int write,
 114                                   struct file *filp, void __user *result,
 115                                   size_t *lenp, loff_t *ppos)
 116 {
 117         struct parport *port = (struct parport *)table->extra1;
 118         char buffer[20];
 119         int len = 0;
 120
 121         if (*ppos) {
 122                 *lenp = 0;
 123                 return 0;
 124         }
 125
 126         if (write) /* permissions prevent this anyway */
 127                 return -EACCES;
 128
 129         len += sprintf (buffer, "%lu\t%lu\n", port->base, port->base_hi);
 130
 131         if (len > *lenp)
 132                 len = *lenp;
 133         else
 134                 *lenp = len;
 135
 136         *ppos += len;
 137
 138         return copy_to_user(result, buffer, len) ? -EFAULT : 0;
 139 }
 140
 141 static int do_hardware_irq (ctl_table *table, int write,
 142                             struct file *filp, void __user *result,
 143                             size_t *lenp, loff_t *ppos)
 144 {
 145         struct parport *port = (struct parport *)table->extra1;
 146         char buffer[20];
 147         int len = 0;
 148
 149         if (*ppos) {
 150                 *lenp = 0;
 151                 return 0;
 152         }
 153
 154         if (write) /* permissions prevent this anyway */
 155                 return -EACCES;
 156
 157         len += sprintf (buffer, "%d\n", port->irq);
 158
 159         if (len > *lenp)
 160                 len = *lenp;
 161         else
 162                 *lenp = len;
 163
 164         *ppos += len;
 165
 166         return copy_to_user(result, buffer, len) ? -EFAULT : 0;
 167 }
 168
 169 static int do_hardware_dma (ctl_table *table, int write,
 170                             struct file *filp, void __user *result,
 171                             size_t *lenp, loff_t *ppos)
 172 {
 173         struct parport *port = (struct parport *)table->extra1;
 174         char buffer[20];
 175         int len = 0;
 176
 177         if (*ppos) {
 178                 *lenp = 0;
 179                 return 0;
 180         }
 181
 182         if (write) /* permissions prevent this anyway */
 183                 return -EACCES;
 184
 185         len += sprintf (buffer, "%d\n", port->dma);
 186
 187         if (len > *lenp)
 188                 len = *lenp;
 189         else
 190                 *lenp = len;
 191
 192         *ppos += len;
 193
 194         return copy_to_user(result, buffer, len) ? -EFAULT : 0;
 195 }
 196
 197 static int do_hardware_modes (ctl_table *table, int write,
 198                               struct file *filp, void __user *result,
 199                               size_t *lenp, loff_t *ppos)
 200 {
 201         struct parport *port = (struct parport *)table->extra1;
 202         char buffer[40];
 203         int len = 0;
 204
 205         if (*ppos) {
 206                 *lenp = 0;
 207                 return 0;
 208         }
 209
 210         if (write) /* permissions prevent this anyway */
 211                 return -EACCES;
 212
 213         {
 214 #define printmode(x) {if(port->modes&PARPORT_MODE_##x){len+=sprintf(buffer+len,"%s%s",f?",":"",#x);f++;}}
 215                 int f = 0;
 216                 printmode(PCSPP);
 217                 printmode(TRISTATE);
 218                 printmode(COMPAT);
 219                 printmode(EPP);
 220                 printmode(ECP);
 221                 printmode(DMA);
 222 #undef printmode
 223         }
 224         buffer[len++] = '\n';
 225
 226         if (len > *lenp)
 227                 len = *lenp;
 228         else
 229                 *lenp = len;
 230
 231         *ppos += len;
 232
 233         return copy_to_user(result, buffer, len) ? -EFAULT : 0;
 234 }
 235
 236 #define PARPORT_PORT_DIR(CHILD) { .ctl_name = 0, .procname = NULL, .mode = 0555, .child = CHILD }
 237 #define PARPORT_PARPORT_DIR(CHILD) { .ctl_name = DEV_PARPORT, .procname = "parport", \
 238                                      .mode = 0555, .child = CHILD }
 239 #define PARPORT_DEV_DIR(CHILD) { .ctl_name = CTL_DEV, .procname = "dev", .mode = 0555, .child = CHILD }
 240 #define PARPORT_DEVICES_ROOT_DIR  { .ctl_name = DEV_PARPORT_DEVICES, .procname = "devices", \
 241                                     .mode = 0555, .child = NULL }
 242
 243 static const unsigned long parport_min_timeslice_value =
 244 PARPORT_MIN_TIMESLICE_VALUE;
 245
 246 static const unsigned long parport_max_timeslice_value =
 247 PARPORT_MAX_TIMESLICE_VALUE;
 248
 249 static const  int parport_min_spintime_value =
 250 PARPORT_MIN_SPINTIME_VALUE;
 251
 252 static const int parport_max_spintime_value =
 253 PARPORT_MAX_SPINTIME_VALUE;
 254
 255
 256 struct parport_sysctl_table {
 257         struct ctl_table_header *sysctl_header;
 258         ctl_table vars[12];
 259         ctl_table device_dir[2];
 260         ctl_table port_dir[2];
 261         ctl_table parport_dir[2];
 262         ctl_table dev_dir[2];
 263 };
 264
 265 static const struct parport_sysctl_table parport_sysctl_template = {
 266         .sysctl_header = NULL,
 267         {
 268                 {
 269                         .ctl_name       = DEV_PARPORT_SPINTIME,
 270                         .procname       = "spintime",
 271                         .data           = NULL,
 272                         .maxlen         = sizeof(int),
 273                         .mode           = 0644,
 274                         .proc_handler   = &proc_dointvec_minmax,
 275                         .extra1         = (void*) &parport_min_spintime_value,
 276                         .extra2         = (void*) &parport_max_spintime_value
 277                 },
 278                 {
 279                         .ctl_name       = DEV_PARPORT_BASE_ADDR,
 280                         .procname       = "base-addr",
 281                         .data           = NULL,
 282                         .maxlen         = 0,
 283                         .mode           = 0444,
 284                         .proc_handler   = &do_hardware_base_addr
 285                 },
 286                 {
 287                         .ctl_name       = DEV_PARPORT_IRQ,
 288                         .procname       = "irq",
 289                         .data           = NULL,
 290                         .maxlen         = 0,
 291                         .mode           = 0444,
 292                         .proc_handler   = &do_hardware_irq
 293                 },
 294                 {
 295                         .ctl_name       = DEV_PARPORT_DMA,
 296                         .procname       = "dma",
 297                         .data           = NULL,
 298                         .maxlen         = 0,
 299                         .mode           = 0444,
 300                         .proc_handler   = &do_hardware_dma
 301                 },
 302                 {
 303                         .ctl_name       = DEV_PARPORT_MODES,
 304                         .procname       = "modes",
 305                         .data           = NULL,
 306                         .maxlen         = 0,
 307                         .mode           = 0444,
 308                         .proc_handler   = &do_hardware_modes
 309                 },
 310                 PARPORT_DEVICES_ROOT_DIR,
 311 #ifdef CONFIG_PARPORT_1284
 312                 {
 313                         .ctl_name       = DEV_PARPORT_AUTOPROBE,
 314                         .procname       = "autoprobe",
 315                         .data           = NULL,
 316                         .maxlen         = 0,
 317                         .mode           = 0444,
 318                         .proc_handler   = &do_autoprobe
 319                 },
 320                 {
 321                         .ctl_name       = DEV_PARPORT_AUTOPROBE + 1,
 322                         .procname       = "autoprobe0",
 323                         .data           = NULL,
 324                         .maxlen         = 0,
 325                         .mode           = 0444,
 326                         .proc_handler   =  &do_autoprobe
 327                 },
 328                 {
 329                         .ctl_name       = DEV_PARPORT_AUTOPROBE + 2,
 330                         .procname       = "autoprobe1",
 331                         .data           = NULL,
 332                         .maxlen         = 0,
 333                         .mode           = 0444,
 334                         .proc_handler   = &do_autoprobe
 335                 },
 336                 {
 337                         .ctl_name       = DEV_PARPORT_AUTOPROBE + 3,
 338                         .procname       = "autoprobe2",
 339                         .data           = NULL,
 340                         .maxlen         = 0,
 341                         .mode           = 0444,
 342                         .proc_handler   = &do_autoprobe
 343                 },
 344                 {
 345                         .ctl_name       = DEV_PARPORT_AUTOPROBE + 4,
 346                         .procname       = "autoprobe3",
 347                         .data           = NULL,
 348                         .maxlen         = 0,
 349                         .mode           = 0444,
 350                         .proc_handler   = &do_autoprobe
 351                 },
 352 #endif /* IEEE 1284 support */
 353                 {}
 354         },
 355         {
 356                 {
 357                         .ctl_name       = DEV_PARPORT_DEVICES_ACTIVE,
 358                         .procname       = "active",
 359                         .data           = NULL,
 360                         .maxlen         = 0,
 361                         .mode           = 0444,
 362                         .proc_handler   = &do_active_device
 363                 },
 364                 {}
 365         },
 366         {
 367                 PARPORT_PORT_DIR(NULL),
 368                 {}
 369         },
 370         {
 371                 PARPORT_PARPORT_DIR(NULL),
 372                 {}
 373         },
 374         {
 375                 PARPORT_DEV_DIR(NULL),
 376                 {}
 377         }
 378 };
 379
 380 struct parport_device_sysctl_table
 381 {
 382         struct ctl_table_header *sysctl_header;
 383         ctl_table vars[2];
 384         ctl_table device_dir[2];
 385         ctl_table devices_root_dir[2];
 386         ctl_table port_dir[2];
 387         ctl_table parport_dir[2];
 388         ctl_table dev_dir[2];
 389 };
 390
 391 static const struct parport_device_sysctl_table
 392 parport_device_sysctl_template = {
 393         .sysctl_header = NULL,
 394         {
 395                 {
 396                         .ctl_name       = DEV_PARPORT_DEVICE_TIMESLICE,
 397                         .procname       = "timeslice",
 398                         .data           = NULL,
 399                         .maxlen         = sizeof(int),
 400                         .mode           = 0644,
 401                         .proc_handler   = &proc_doulongvec_ms_jiffies_minmax,
 402                         .extra1         = (void*) &parport_min_timeslice_value,
 403                         .extra2         = (void*) &parport_max_timeslice_value
 404                 },
 405         },
 406         {
 407                 {
 408                         .ctl_name       = 0,
 409                         .procname       = NULL,
 410                         .data           = NULL,
 411                         .maxlen         = 0,
 412                         .mode           = 0555,
 413                         .child          = NULL
 414                 },
 415                 {}
 416         },
 417         {
 418                 PARPORT_DEVICES_ROOT_DIR,
 419                 {}
 420         },
 421         {
 422                 PARPORT_PORT_DIR(NULL),
 423                 {}
 424         },
 425         {
 426                 PARPORT_PARPORT_DIR(NULL),
 427                 {}
 428         },
 429         {
 430                 PARPORT_DEV_DIR(NULL),
 431                 {}
 432         }
 433 };
 434
 435 struct parport_default_sysctl_table
 436 {
 437         struct ctl_table_header *sysctl_header;
 438         ctl_table vars[3];
 439         ctl_table default_dir[2];
 440         ctl_table parport_dir[2];
 441         ctl_table dev_dir[2];
 442 };
 443
 444 extern unsigned long parport_default_timeslice;
 445 extern int parport_default_spintime;
 446
 447 static struct parport_default_sysctl_table
 448 parport_default_sysctl_table = {
 449         .sysctl_header  = NULL,
 450         {
 451                 {
 452                         .ctl_name       = DEV_PARPORT_DEFAULT_TIMESLICE,
 453                         .procname       = "timeslice",
 454                         .data           = &parport_default_timeslice,
 455                         .maxlen         = sizeof(parport_default_timeslice),
 456                         .mode           = 0644,
 457                         .proc_handler   = &proc_doulongvec_ms_jiffies_minmax,
 458                         .extra1         = (void*) &parport_min_timeslice_value,
 459                         .extra2         = (void*) &parport_max_timeslice_value
 460                 },
 461                 {
 462                         .ctl_name       = DEV_PARPORT_DEFAULT_SPINTIME,
 463                         .procname       = "spintime",
 464                         .data           = &parport_default_spintime,
 465                         .maxlen         = sizeof(parport_default_spintime),
 466                         .mode           = 0644,
 467                         .proc_handler   = &proc_dointvec_minmax,
 468                         .extra1         = (void*) &parport_min_spintime_value,
 469                         .extra2         = (void*) &parport_max_spintime_value
 470                 },
 471                 {}
 472         },
 473         {
 474                 {
 475                         .ctl_name       = DEV_PARPORT_DEFAULT,
 476                         .procname       = "default",
 477                         .mode           = 0555,
 478                         .child          = parport_default_sysctl_table.vars
 479                 },
 480                 {}
 481         },
 482         {
 483                 PARPORT_PARPORT_DIR(parport_default_sysctl_table.default_dir),
 484                 {}
 485         },
 486         {
 487                 PARPORT_DEV_DIR(parport_default_sysctl_table.parport_dir),
 488                 {}
 489         }
 490 };
 491
 492
 493 int parport_proc_register(struct parport *port)
 494 {
 495         struct parport_sysctl_table *t;
 496         int i;
 497
 498         t = kmalloc(sizeof(*t), GFP_KERNEL);
 499         if (t == NULL)
 500                 return -ENOMEM;
 501         memcpy(t, &parport_sysctl_template, sizeof(*t));
 502
 503         t->device_dir[0].extra1 = port;
 504
 505         for (i = 0; i < 8; i++)
 506                 t->vars[i].extra1 = port;
 507
 508         t->vars[0].data = &port->spintime;
 509         t->vars[5].child = t->device_dir;
 510
 511         for (i = 0; i < 5; i++)
 512                 t->vars[6 + i].extra2 = &port->probe_info[i];
 513
 514         t->port_dir[0].procname = port->name;
 515         t->port_dir[0].ctl_name = port->number + 1; /* nb 0 isn't legal here */
 516
 517         t->port_dir[0].child = t->vars;
 518         t->parport_dir[0].child = t->port_dir;
 519         t->dev_dir[0].child = t->parport_dir;
 520
 521         t->sysctl_header = register_sysctl_table(t->dev_dir);
 522         if (t->sysctl_header == NULL) {
 523                 kfree(t);
 524                 t = NULL;
 525         }
 526         port->sysctl_table = t;
 527         return 0;
 528 }
 529
 530 int parport_proc_unregister(struct parport *port)
 531 {
 532         if (port->sysctl_table) {
 533                 struct parport_sysctl_table *t = port->sysctl_table;
 534                 port->sysctl_table = NULL;
 535                 unregister_sysctl_table(t->sysctl_header);
 536                 kfree(t);
 537         }
 538         return 0;
 539 }
 540
 541 int parport_device_proc_register(struct pardevice *device)
 542 {
 543         struct parport_device_sysctl_table *t;
 544         struct parport * port = device->port;
 545
 546         t = kmalloc(sizeof(*t), GFP_KERNEL);
 547         if (t == NULL)
 548                 return -ENOMEM;
 549         memcpy(t, &parport_device_sysctl_template, sizeof(*t));
 550
 551         t->dev_dir[0].child = t->parport_dir;
 552         t->parport_dir[0].child = t->port_dir;
 553         t->port_dir[0].procname = port->name;
 554         t->port_dir[0].ctl_name = port->number + 1; /* nb 0 isn't legal here */
 555         t->port_dir[0].child = t->devices_root_dir;
 556         t->devices_root_dir[0].child = t->device_dir;
 557
 558 #ifdef CONFIG_PARPORT_1284
 559
 560         t->device_dir[0].ctl_name =
 561                 parport_device_num(port->number, port->muxport,
 562                                    device->daisy)
 563                 + 1;  /* nb 0 isn't legal here */
 564
 565 #else /* No IEEE 1284 support */
 566
 567         /* parport_device_num isn't available. */
 568         t->device_dir[0].ctl_name = 1;
 569
 570 #endif /* IEEE 1284 support or not */
 571
 572         t->device_dir[0].procname = device->name;
 573         t->device_dir[0].extra1 = device;
 574         t->device_dir[0].child = t->vars;
 575         t->vars[0].data = &device->timeslice;
 576
 577         t->sysctl_header = register_sysctl_table(t->dev_dir);
 578         if (t->sysctl_header == NULL) {
 579                 kfree(t);
 580                 t = NULL;
 581         }
 582         device->sysctl_table = t;
 583         return 0;
 584 }
 585
 586 int parport_device_proc_unregister(struct pardevice *device)
 587 {
 588         if (device->sysctl_table) {
 589                 struct parport_device_sysctl_table *t = device->sysctl_table;
 590                 device->sysctl_table = NULL;
 591                 unregister_sysctl_table(t->sysctl_header);
 592                 kfree(t);
 593         }
 594         return 0;
 595 }
 596
 597 static int __init parport_default_proc_register(void)
 598 {
 599         parport_default_sysctl_table.sysctl_header =
 600                 register_sysctl_table(parport_default_sysctl_table.dev_dir);
 601         return 0;
 602 }
 603
 604 static void __exit parport_default_proc_unregister(void)
 605 {
 606         if (parport_default_sysctl_table.sysctl_header) {
 607                 unregister_sysctl_table(parport_default_sysctl_table.
 608                                         sysctl_header);
 609                 parport_default_sysctl_table.sysctl_header = NULL;
 610         }
 611 }
 612
 613 #else /* no sysctl or no procfs*/
 614
 615 int parport_proc_register(struct parport *pp)
 616 {
 617         return 0;
 618 }
 619
 620 int parport_proc_unregister(struct parport *pp)
 621 {
 622         return 0;
 623 }
 624
 625 int parport_device_proc_register(struct pardevice *device)
 626 {
 627         return 0;
 628 }
 629
 630 int parport_device_proc_unregister(struct pardevice *device)
 631 {
 632         return 0;
 633 }
 634
 635 static int __init parport_default_proc_register (void)
 636 {
 637         return 0;
 638 }
 639
 640 static void __exit parport_default_proc_unregister (void)
 641 {
 642 }
 643 #endif
 644
 645 module_init(parport_default_proc_register)
 646 module_exit(parport_default_proc_unregister)