drivers/pnp/pnpbios/core.c

   1 /*
   2  * pnpbios -- PnP BIOS driver
   3  *
   4  * This driver provides access to Plug-'n'-Play services provided by
   5  * the PnP BIOS firmware, described in the following documents:
   6  *   Plug and Play BIOS Specification, Version 1.0A, 5 May 1994
   7  *   Plug and Play BIOS Clarification Paper, 6 October 1994
   8  *     Compaq Computer Corporation, Phoenix Technologies Ltd., Intel Corp.
   9  *
  10  * Originally (C) 1998 Christian Schmidt <schmidt@digadd.de>
  11  * Modifications (C) 1998 Tom Lees <tom@lpsg.demon.co.uk>
  12  * Minor reorganizations by David Hinds <dahinds@users.sourceforge.net>
  13  * Further modifications (C) 2001, 2002 by:
  14  *   Alan Cox <alan@redhat.com>
  15  *   Thomas Hood <jdthood@mail.com>
  16  *   Brian Gerst <bgerst@didntduck.org>
  17  *
  18  * Ported to the PnP Layer and several additional improvements (C) 2002
  19  * by Adam Belay <ambx1@neo.rr.com>
  20  *
  21  * This program is free software; you can redistribute it and/or modify it
  22  * under the terms of the GNU General Public License as published by the
  23  * Free Software Foundation; either version 2, or (at your option) any
  24  * later version.
  25  *
  26  * This program is distributed in the hope that it will be useful, but
  27  * WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  29  * General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program; if not, write to the Free Software
  33  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  34  */
  35
  36 /* Change Log
  37  *
  38  * Adam Belay - <ambx1@neo.rr.com> - March 16, 2003
  39  * rev 1.01     Only call pnp_bios_dev_node_info once
  40  *              Added pnpbios_print_status
  41  *              Added several new error messages and info messages
  42  *              Added pnpbios_interface_attach_device
  43  *              integrated core and proc init system
  44  *              Introduced PNPMODE flags
  45  *              Removed some useless includes
  46  */
  47
  48 #include <linux/types.h>
  49 #include <linux/module.h>
  50 #include <linux/init.h>
  51 #include <linux/linkage.h>
  52 #include <linux/kernel.h>
  53 #include <linux/pnpbios.h>
  54 #include <linux/device.h>
  55 #include <linux/pnp.h>
  56 #include <linux/mm.h>
  57 #include <linux/smp.h>
  58 #include <linux/slab.h>
  59 #include <linux/kmod.h>
  60 #include <linux/completion.h>
  61 #include <linux/spinlock.h>
  62 #include <linux/dmi.h>
  63
  64 #include <asm/page.h>
  65 #include <asm/desc.h>
  66 #include <asm/system.h>
  67 #include <asm/byteorder.h>
  68
  69 #include "pnpbios.h"
  70
  71
  72 /*
  73  *
  74  * PnP BIOS INTERFACE
  75  *
  76  */
  77
  78 static union pnp_bios_install_struct * pnp_bios_install = NULL;
  79
  80 int pnp_bios_present(void)
  81 {
  82         return (pnp_bios_install != NULL);
  83 }
  84
  85 struct pnp_dev_node_info node_info;
  86
  87 void *pnpbios_kmalloc(size_t size, int f)
  88 {
  89         void *p = kmalloc( size, f );
  90         if ( p == NULL )
  91                 printk(KERN_ERR "PnPBIOS: kmalloc() failed\n");
  92         else
  93                 memset(p, 0, size);
  94         return p;
  95 }
  96
  97 /*
  98  *
  99  * DOCKING FUNCTIONS
 100  *
 101  */
 102
 103 #ifdef CONFIG_HOTPLUG
 104
 105 static int unloading = 0;
 106 static struct completion unload_sem;
 107
 108 /*
 109  * (Much of this belongs in a shared routine somewhere)
 110  */
 111
 112 static int pnp_dock_event(int dock, struct pnp_docking_station_info *info)
 113 {
 114         char *argv [3], **envp, *buf, *scratch;
 115         int i = 0, value;
 116
 117         if (!hotplug_path [0])
 118                 return -ENOENT;
 119         if (!current->fs->root) {
 120                 return -EAGAIN;
 121         }
 122         if (!(envp = (char **) pnpbios_kmalloc (20 * sizeof (char *), GFP_KERNEL))) {
 123                 return -ENOMEM;
 124         }
 125         if (!(buf = pnpbios_kmalloc (256, GFP_KERNEL))) {
 126                 kfree (envp);
 127                 return -ENOMEM;
 128         }
 129
 130         /* only one standardized param to hotplug command: type */
 131         argv [0] = hotplug_path;
 132         argv [1] = "dock";
 133         argv [2] = NULL;
 134
 135         /* minimal command environment */
 136         envp [i++] = "HOME=/";
 137         envp [i++] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin";
 138
 139 #ifdef  DEBUG
 140         /* hint that policy agent should enter no-stdout debug mode */
 141         envp [i++] = "DEBUG=kernel";
 142 #endif
 143         /* extensible set of named bus-specific parameters,
 144          * supporting multiple driver selection algorithms.
 145          */
 146         scratch = buf;
 147
 148         /* action:  add, remove */
 149         envp [i++] = scratch;
 150         scratch += sprintf (scratch, "ACTION=%s", dock?"add":"remove") + 1;
 151
 152         /* Report the ident for the dock */
 153         envp [i++] = scratch;
 154         scratch += sprintf (scratch, "DOCK=%x/%x/%x",
 155                 info->location_id, info->serial, info->capabilities);
 156         envp[i] = NULL;
 157
 158         value = call_usermodehelper (argv [0], argv, envp, 0);
 159         kfree (buf);
 160         kfree (envp);
 161         return 0;
 162 }
 163
 164 /*
 165  * Poll the PnP docking at regular intervals
 166  */
 167 static int pnp_dock_thread(void * unused)
 168 {
 169         static struct pnp_docking_station_info now;
 170         int docked = -1, d = 0;
 171         daemonize("kpnpbiosd");
 172         allow_signal(SIGKILL);
 173         while(!unloading && !signal_pending(current))
 174         {
 175                 int status;
 176
 177                 /*
 178                  * Poll every 2 seconds
 179                  */
 180                 set_current_state(TASK_INTERRUPTIBLE);
 181                 schedule_timeout(HZ*2);
 182                 if(signal_pending(current))
 183                         break;
 184
 185                 status = pnp_bios_dock_station_info(&now);
 186
 187                 switch(status)
 188                 {
 189                         /*
 190                          * No dock to manage
 191                          */
 192                         case PNP_FUNCTION_NOT_SUPPORTED:
 193                                 complete_and_exit(&unload_sem, 0);
 194                         case PNP_SYSTEM_NOT_DOCKED:
 195                                 d = 0;
 196                                 break;
 197                         case PNP_SUCCESS:
 198                                 d = 1;
 199                                 break;
 200                         default:
 201                                 pnpbios_print_status( "pnp_dock_thread", status );
 202                                 continue;
 203                 }
 204                 if(d != docked)
 205                 {
 206                         if(pnp_dock_event(d, &now)==0)
 207                         {
 208                                 docked = d;
 209 #if 0
 210                                 printk(KERN_INFO "PnPBIOS: Docking station %stached\n", docked?"at":"de");
 211 #endif
 212                         }
 213                 }
 214         }
 215         complete_and_exit(&unload_sem, 0);
 216 }
 217
 218 #endif   /* CONFIG_HOTPLUG */
 219
 220 static int pnpbios_get_resources(struct pnp_dev * dev, struct pnp_resource_table * res)
 221 {
 222         u8 nodenum = dev->number;
 223         struct pnp_bios_node * node;
 224
 225         /* just in case */
 226         if(!pnpbios_is_dynamic(dev))
 227                 return -EPERM;
 228
 229         node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
 230         if (!node)
 231                 return -1;
 232         if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node)) {
 233                 kfree(node);
 234                 return -ENODEV;
 235         }
 236         pnpbios_read_resources_from_node(res, node);
 237         dev->active = pnp_is_active(dev);
 238         kfree(node);
 239         return 0;
 240 }
 241
 242 static int pnpbios_set_resources(struct pnp_dev * dev, struct pnp_resource_table * res)
 243 {
 244         u8 nodenum = dev->number;
 245         struct pnp_bios_node * node;
 246         int ret;
 247
 248         /* just in case */
 249         if (!pnpbios_is_dynamic(dev))
 250                 return -EPERM;
 251
 252         node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
 253         if (!node)
 254                 return -1;
 255         if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node)) {
 256                 kfree(node);
 257                 return -ENODEV;
 258         }
 259         if(pnpbios_write_resources_to_node(res, node)<0) {
 260                 kfree(node);
 261                 return -1;
 262         }
 263         ret = pnp_bios_set_dev_node(node->handle, (char)PNPMODE_DYNAMIC, node);
 264         kfree(node);
 265         if (ret > 0)
 266                 ret = -1;
 267         return ret;
 268 }
 269
 270 static void pnpbios_zero_data_stream(struct pnp_bios_node * node)
 271 {
 272         unsigned char * p = (char *)node->data;
 273         unsigned char * end = (char *)(node->data + node->size);
 274         unsigned int len;
 275         int i;
 276         while ((char *)p < (char *)end) {
 277                 if(p[0] & 0x80) { /* large tag */
 278                         len = (p[2] << 8) | p[1];
 279                         p += 3;
 280                 } else {
 281                         if (((p[0]>>3) & 0x0f) == 0x0f)
 282                                 return;
 283                         len = p[0] & 0x07;
 284                         p += 1;
 285                 }
 286                 for (i = 0; i < len; i++)
 287                         p[i] = 0;
 288                 p += len;
 289         }
 290         printk(KERN_ERR "PnPBIOS: Resource structure did not contain an end tag.\n");
 291 }
 292
 293 static int pnpbios_disable_resources(struct pnp_dev *dev)
 294 {
 295         struct pnp_bios_node * node;
 296         u8 nodenum = dev->number;
 297         int ret;
 298
 299         /* just in case */
 300         if(dev->flags & PNPBIOS_NO_DISABLE || !pnpbios_is_dynamic(dev))
 301                 return -EPERM;
 302
 303         node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
 304         if (!node)
 305                 return -ENOMEM;
 306
 307         if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node)) {
 308                 kfree(node);
 309                 return -ENODEV;
 310         }
 311         pnpbios_zero_data_stream(node);
 312
 313         ret = pnp_bios_set_dev_node(dev->number, (char)PNPMODE_DYNAMIC, node);
 314         kfree(node);
 315         if (ret > 0)
 316                 ret = -1;
 317         return ret;
 318 }
 319
 320 /* PnP Layer support */
 321
 322 struct pnp_protocol pnpbios_protocol = {
 323         .name   = "Plug and Play BIOS",
 324         .get    = pnpbios_get_resources,
 325         .set    = pnpbios_set_resources,
 326         .disable = pnpbios_disable_resources,
 327 };
 328
 329 static int insert_device(struct pnp_dev *dev, struct pnp_bios_node * node)
 330 {
 331         struct list_head * pos;
 332         struct pnp_dev * pnp_dev;
 333         struct pnp_id *dev_id;
 334         char id[8];
 335
 336         /* check if the device is already added */
 337         dev->number = node->handle;
 338         list_for_each (pos, &pnpbios_protocol.devices){
 339                 pnp_dev = list_entry(pos, struct pnp_dev, protocol_list);
 340                 if (dev->number == pnp_dev->number)
 341                         return -1;
 342         }
 343
 344         /* set the initial values for the PnP device */
 345         dev_id = pnpbios_kmalloc(sizeof(struct pnp_id), GFP_KERNEL);
 346         if (!dev_id)
 347                 return -1;
 348         pnpid32_to_pnpid(node->eisa_id,id);
 349         memcpy(dev_id->id,id,7);
 350         pnp_add_id(dev_id, dev);
 351         pnpbios_parse_data_stream(dev, node);
 352         dev->active = pnp_is_active(dev);
 353         dev->flags = node->flags;
 354         if (!(dev->flags & PNPBIOS_NO_CONFIG))
 355                 dev->capabilities |= PNP_CONFIGURABLE;
 356         if (!(dev->flags & PNPBIOS_NO_DISABLE))
 357                 dev->capabilities |= PNP_DISABLE;
 358         dev->capabilities |= PNP_READ;
 359         if (pnpbios_is_dynamic(dev))
 360                 dev->capabilities |= PNP_WRITE;
 361         if (dev->flags & PNPBIOS_REMOVABLE)
 362                 dev->capabilities |= PNP_REMOVABLE;
 363         dev->protocol = &pnpbios_protocol;
 364
 365         /* clear out the damaged flags */
 366         if (!dev->active)
 367                 pnp_init_resource_table(&dev->res);
 368
 369         pnp_add_device(dev);
 370         pnpbios_interface_attach_device(node);
 371
 372         return 0;
 373 }
 374
 375 static void __init build_devlist(void)
 376 {
 377         u8 nodenum;
 378         unsigned int nodes_got = 0;
 379         unsigned int devs = 0;
 380         struct pnp_bios_node *node;
 381         struct pnp_dev *dev;
 382
 383         node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
 384         if (!node)
 385                 return;
 386
 387         for(nodenum=0; nodenum<0xff; ) {
 388                 u8 thisnodenum = nodenum;
 389                 /* eventually we will want to use PNPMODE_STATIC here but for now
 390                  * dynamic will help us catch buggy bioses to add to the blacklist.
 391                  */
 392                 if (!pnpbios_dont_use_current_config) {
 393                         if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node))
 394                                 break;
 395                 } else {
 396                         if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_STATIC, node))
 397                                 break;
 398                 }
 399                 nodes_got++;
 400                 dev =  pnpbios_kmalloc(sizeof (struct pnp_dev), GFP_KERNEL);
 401                 if (!dev)
 402                         break;
 403                 if(insert_device(dev,node)<0)
 404                         kfree(dev);
 405                 else
 406                         devs++;
 407                 if (nodenum <= thisnodenum) {
 408                         printk(KERN_ERR "PnPBIOS: build_devlist: Node number 0x%x is out of sequence following node 0x%x. Aborting.\n", (unsigned int)nodenum, (unsigned int)thisnodenum);
 409                         break;
 410                 }
 411         }
 412         kfree(node);
 413
 414         printk(KERN_INFO "PnPBIOS: %i node%s reported by PnP BIOS; %i recorded by driver\n",
 415                 nodes_got, nodes_got != 1 ? "s" : "", devs);
 416 }
 417
 418 /*
 419  *
 420  * INIT AND EXIT
 421  *
 422  */
 423
 424 static int pnpbios_disabled; /* = 0 */
 425 int pnpbios_dont_use_current_config; /* = 0 */
 426
 427 #ifndef MODULE
 428 static int __init pnpbios_setup(char *str)
 429 {
 430         int invert;
 431
 432         while ((str != NULL) && (*str != '\0')) {
 433                 if (strncmp(str, "off", 3) == 0)
 434                         pnpbios_disabled=1;
 435                 if (strncmp(str, "on", 2) == 0)
 436                         pnpbios_disabled=0;
 437                 invert = (strncmp(str, "no-", 3) == 0);
 438                 if (invert)
 439                         str += 3;
 440                 if (strncmp(str, "curr", 4) == 0)
 441                         pnpbios_dont_use_current_config = invert;
 442                 str = strchr(str, ',');
 443                 if (str != NULL)
 444                         str += strspn(str, ", \t");
 445         }
 446
 447         return 1;
 448 }
 449
 450 __setup("pnpbios=", pnpbios_setup);
 451 #endif
 452
 453 /* PnP BIOS signature: "$PnP" */
 454 #define PNP_SIGNATURE   (('$' << 0) + ('P' << 8) + ('n' << 16) + ('P' << 24))
 455
 456 int __init pnpbios_probe_system(void)
 457 {
 458         union pnp_bios_install_struct *check;
 459         u8 sum;
 460         int length, i;
 461
 462         printk(KERN_INFO "PnPBIOS: Scanning system for PnP BIOS support...\n");
 463
 464         /*
 465          * Search the defined area (0xf0000-0xffff0) for a valid PnP BIOS
 466          * structure and, if one is found, sets up the selectors and
 467          * entry points
 468          */
 469         for (check = (union pnp_bios_install_struct *) __va(0xf0000);
 470              check < (union pnp_bios_install_struct *) __va(0xffff0);
 471              check = (void *)check + 16) {
 472                 if (check->fields.signature != PNP_SIGNATURE)
 473                         continue;
 474                 printk(KERN_INFO "PnPBIOS: Found PnP BIOS installation structure at 0x%p\n", check);
 475                 length = check->fields.length;
 476                 if (!length) {
 477                         printk(KERN_ERR "PnPBIOS: installation structure is invalid, skipping\n");
 478                         continue;
 479                 }
 480                 for (sum = 0, i = 0; i < length; i++)
 481                         sum += check->chars[i];
 482                 if (sum) {
 483                         printk(KERN_ERR "PnPBIOS: installation structure is corrupted, skipping\n");
 484                         continue;
 485                 }
 486                 if (check->fields.version < 0x10) {
 487                         printk(KERN_WARNING "PnPBIOS: PnP BIOS version %d.%d is not supported\n",
 488                                check->fields.version >> 4,
 489                                check->fields.version & 15);
 490                         continue;
 491                 }
 492                 printk(KERN_INFO "PnPBIOS: PnP BIOS version %d.%d, entry 0x%x:0x%x, dseg 0x%x\n",
 493                        check->fields.version >> 4, check->fields.version & 15,
 494                        check->fields.pm16cseg, check->fields.pm16offset,
 495                        check->fields.pm16dseg);
 496                 pnp_bios_install = check;
 497                 return 1;
 498         }
 499
 500         printk(KERN_INFO "PnPBIOS: PnP BIOS support was not detected.\n");
 501         return 0;
 502 }
 503
 504 static int __init exploding_pnp_bios(struct dmi_system_id *d)
 505 {
 506         printk(KERN_WARNING "%s detected. Disabling PnPBIOS\n", d->ident);
 507         return 0;
 508 }
 509
 510 static struct dmi_system_id pnpbios_dmi_table[] = {
 511         {       /* PnPBIOS GPF on boot */
 512                 .callback = exploding_pnp_bios,
 513                 .ident = "Higraded P14H",
 514                 .matches = {
 515                         DMI_MATCH(DMI_BIOS_VENDOR, "American Megatrends Inc."),
 516                         DMI_MATCH(DMI_BIOS_VERSION, "07.00T"),
 517                         DMI_MATCH(DMI_SYS_VENDOR, "Higraded"),
 518                         DMI_MATCH(DMI_PRODUCT_NAME, "P14H"),
 519                 },
 520         },
 521         {       /* PnPBIOS GPF on boot */
 522                 .callback = exploding_pnp_bios,
 523                 .ident = "ASUS P4P800",
 524                 .matches = {
 525                         DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc."),
 526                         DMI_MATCH(DMI_BOARD_NAME, "P4P800"),
 527                 },
 528         },
 529         { }
 530 };
 531
 532 int __init pnpbios_init(void)
 533 {
 534         int ret;
 535
 536         if (pnpbios_disabled || dmi_check_system(pnpbios_dmi_table)) {
 537                 printk(KERN_INFO "PnPBIOS: Disabled\n");
 538                 return -ENODEV;
 539         }
 540
 541         /* scan the system for pnpbios support */
 542         if (!pnpbios_probe_system())
 543                 return -ENODEV;
 544
 545         /* make preparations for bios calls */
 546         pnpbios_calls_init(pnp_bios_install);
 547
 548         /* read the node info */
 549         ret = pnp_bios_dev_node_info(&node_info);
 550         if (ret) {
 551                 printk(KERN_ERR "PnPBIOS: Unable to get node info.  Aborting.\n");
 552                 return ret;
 553         }
 554
 555         /* register with the pnp layer */
 556         ret = pnp_register_protocol(&pnpbios_protocol);
 557         if (ret) {
 558                 printk(KERN_ERR "PnPBIOS: Unable to register driver.  Aborting.\n");
 559                 return ret;
 560         }
 561
 562         /* start the proc interface */
 563         ret = pnpbios_proc_init();
 564         if (ret)
 565                 printk(KERN_ERR "PnPBIOS: Failed to create proc interface.\n");
 566
 567         /* scan for pnpbios devices */
 568         build_devlist();
 569
 570         return 0;
 571 }
 572
 573 subsys_initcall(pnpbios_init);
 574
 575 static int __init pnpbios_thread_init(void)
 576 {
 577 #ifdef CONFIG_HOTPLUG
 578         init_completion(&unload_sem);
 579         if (kernel_thread(pnp_dock_thread, NULL, CLONE_KERNEL) > 0)
 580                 unloading = 0;
 581 #endif
 582         return 0;
 583 }
 584
 585 #ifndef MODULE
 586
 587 /* init/main.c calls pnpbios_init early */
 588
 589 /* Start the kernel thread later: */
 590 module_init(pnpbios_thread_init);
 591
 592 #else
 593
 594 /*
 595  * N.B.: Building pnpbios as a module hasn't been fully implemented
 596  */
 597
 598 MODULE_LICENSE("GPL");
 599
 600 static int __init pnpbios_init_all(void)
 601 {
 602         int r;
 603
 604         r = pnpbios_init();
 605         if (r)
 606                 return r;
 607         r = pnpbios_thread_init();
 608         if (r)
 609                 return r;
 610         return 0;
 611 }
 612
 613 static void __exit pnpbios_exit(void)
 614 {
 615 #ifdef CONFIG_HOTPLUG
 616         unloading = 1;
 617         wait_for_completion(&unload_sem);
 618 #endif
 619         pnpbios_proc_exit();
 620         /* We ought to free resources here */
 621         return;
 622 }
 623
 624 module_init(pnpbios_init_all);
 625 module_exit(pnpbios_exit);
 626
 627 #endif
 628
 629 EXPORT_SYMBOL(pnpbios_protocol);