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                 return -ENODEV;
 257         if(pnpbios_write_resources_to_node(res, node)<0) {
 258                 kfree(node);
 259                 return -1;
 260         }
 261         ret = pnp_bios_set_dev_node(node->handle, (char)PNPMODE_DYNAMIC, node);
 262         kfree(node);
 263         if (ret > 0)
 264                 ret = -1;
 265         return ret;
 266 }
 267
 268 static void pnpbios_zero_data_stream(struct pnp_bios_node * node)
 269 {
 270         unsigned char * p = (char *)node->data;
 271         unsigned char * end = (char *)(node->data + node->size);
 272         unsigned int len;
 273         int i;
 274         while ((char *)p < (char *)end) {
 275                 if(p[0] & 0x80) { /* large tag */
 276                         len = (p[2] << 8) | p[1];
 277                         p += 3;
 278                 } else {
 279                         if (((p[0]>>3) & 0x0f) == 0x0f)
 280                                 return;
 281                         len = p[0] & 0x07;
 282                         p += 1;
 283                 }
 284                 for (i = 0; i < len; i++)
 285                         p[i] = 0;
 286                 p += len;
 287         }
 288         printk(KERN_ERR "PnPBIOS: Resource structure did not contain an end tag.\n");
 289 }
 290
 291 static int pnpbios_disable_resources(struct pnp_dev *dev)
 292 {
 293         struct pnp_bios_node * node;
 294         u8 nodenum = dev->number;
 295         int ret;
 296
 297         /* just in case */
 298         if(dev->flags & PNPBIOS_NO_DISABLE || !pnpbios_is_dynamic(dev))
 299                 return -EPERM;
 300
 301         node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
 302         if (!node)
 303                 return -ENOMEM;
 304
 305         if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node)) {
 306                 kfree(node);
 307                 return -ENODEV;
 308         }
 309         pnpbios_zero_data_stream(node);
 310
 311         ret = pnp_bios_set_dev_node(dev->number, (char)PNPMODE_DYNAMIC, node);
 312         kfree(node);
 313         if (ret > 0)
 314                 ret = -1;
 315         return ret;
 316 }
 317
 318 /* PnP Layer support */
 319
 320 struct pnp_protocol pnpbios_protocol = {
 321         .name   = "Plug and Play BIOS",
 322         .get    = pnpbios_get_resources,
 323         .set    = pnpbios_set_resources,
 324         .disable = pnpbios_disable_resources,
 325 };
 326
 327 static int insert_device(struct pnp_dev *dev, struct pnp_bios_node * node)
 328 {
 329         struct list_head * pos;
 330         struct pnp_dev * pnp_dev;
 331         struct pnp_id *dev_id;
 332         char id[8];
 333
 334         /* check if the device is already added */
 335         dev->number = node->handle;
 336         list_for_each (pos, &pnpbios_protocol.devices){
 337                 pnp_dev = list_entry(pos, struct pnp_dev, protocol_list);
 338                 if (dev->number == pnp_dev->number)
 339                         return -1;
 340         }
 341
 342         /* set the initial values for the PnP device */
 343         dev_id = pnpbios_kmalloc(sizeof(struct pnp_id), GFP_KERNEL);
 344         if (!dev_id)
 345                 return -1;
 346         pnpid32_to_pnpid(node->eisa_id,id);
 347         memcpy(dev_id->id,id,7);
 348         pnp_add_id(dev_id, dev);
 349         pnpbios_parse_data_stream(dev, node);
 350         dev->active = pnp_is_active(dev);
 351         dev->flags = node->flags;
 352         if (!(dev->flags & PNPBIOS_NO_CONFIG))
 353                 dev->capabilities |= PNP_CONFIGURABLE;
 354         if (!(dev->flags & PNPBIOS_NO_DISABLE))
 355                 dev->capabilities |= PNP_DISABLE;
 356         dev->capabilities |= PNP_READ;
 357         if (pnpbios_is_dynamic(dev))
 358                 dev->capabilities |= PNP_WRITE;
 359         if (dev->flags & PNPBIOS_REMOVABLE)
 360                 dev->capabilities |= PNP_REMOVABLE;
 361         dev->protocol = &pnpbios_protocol;
 362
 363         /* clear out the damaged flags */
 364         if (!dev->active)
 365                 pnp_init_resource_table(&dev->res);
 366
 367         pnp_add_device(dev);
 368         pnpbios_interface_attach_device(node);
 369
 370         return 0;
 371 }
 372
 373 static void __init build_devlist(void)
 374 {
 375         u8 nodenum;
 376         unsigned int nodes_got = 0;
 377         unsigned int devs = 0;
 378         struct pnp_bios_node *node;
 379         struct pnp_dev *dev;
 380
 381         node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
 382         if (!node)
 383                 return;
 384
 385         for(nodenum=0; nodenum<0xff; ) {
 386                 u8 thisnodenum = nodenum;
 387                 /* eventually we will want to use PNPMODE_STATIC here but for now
 388                  * dynamic will help us catch buggy bioses to add to the blacklist.
 389                  */
 390                 if (!pnpbios_dont_use_current_config) {
 391                         if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node))
 392                                 break;
 393                 } else {
 394                         if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_STATIC, node))
 395                                 break;
 396                 }
 397                 nodes_got++;
 398                 dev =  pnpbios_kmalloc(sizeof (struct pnp_dev), GFP_KERNEL);
 399                 if (!dev)
 400                         break;
 401                 if(insert_device(dev,node)<0)
 402                         kfree(dev);
 403                 else
 404                         devs++;
 405                 if (nodenum <= thisnodenum) {
 406                         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);
 407                         break;
 408                 }
 409         }
 410         kfree(node);
 411
 412         printk(KERN_INFO "PnPBIOS: %i node%s reported by PnP BIOS; %i recorded by driver\n",
 413                 nodes_got, nodes_got != 1 ? "s" : "", devs);
 414 }
 415
 416 /*
 417  *
 418  * INIT AND EXIT
 419  *
 420  */
 421
 422 static int pnpbios_disabled; /* = 0 */
 423 int pnpbios_dont_use_current_config; /* = 0 */
 424
 425 #ifndef MODULE
 426 static int __init pnpbios_setup(char *str)
 427 {
 428         int invert;
 429
 430         while ((str != NULL) && (*str != '\0')) {
 431                 if (strncmp(str, "off", 3) == 0)
 432                         pnpbios_disabled=1;
 433                 if (strncmp(str, "on", 2) == 0)
 434                         pnpbios_disabled=0;
 435                 invert = (strncmp(str, "no-", 3) == 0);
 436                 if (invert)
 437                         str += 3;
 438                 if (strncmp(str, "curr", 4) == 0)
 439                         pnpbios_dont_use_current_config = invert;
 440                 str = strchr(str, ',');
 441                 if (str != NULL)
 442                         str += strspn(str, ", \t");
 443         }
 444
 445         return 1;
 446 }
 447
 448 __setup("pnpbios=", pnpbios_setup);
 449 #endif
 450
 451 /* PnP BIOS signature: "$PnP" */
 452 #define PNP_SIGNATURE   (('$' << 0) + ('P' << 8) + ('n' << 16) + ('P' << 24))
 453
 454 int __init pnpbios_probe_system(void)
 455 {
 456         union pnp_bios_install_struct *check;
 457         u8 sum;
 458         int length, i;
 459
 460         printk(KERN_INFO "PnPBIOS: Scanning system for PnP BIOS support...\n");
 461
 462         /*
 463          * Search the defined area (0xf0000-0xffff0) for a valid PnP BIOS
 464          * structure and, if one is found, sets up the selectors and
 465          * entry points
 466          */
 467         for (check = (union pnp_bios_install_struct *) __va(0xf0000);
 468              check < (union pnp_bios_install_struct *) __va(0xffff0);
 469              check = (void *)check + 16) {
 470                 if (check->fields.signature != PNP_SIGNATURE)
 471                         continue;
 472                 printk(KERN_INFO "PnPBIOS: Found PnP BIOS installation structure at 0x%p\n", check);
 473                 length = check->fields.length;
 474                 if (!length) {
 475                         printk(KERN_ERR "PnPBIOS: installation structure is invalid, skipping\n");
 476                         continue;
 477                 }
 478                 for (sum = 0, i = 0; i < length; i++)
 479                         sum += check->chars[i];
 480                 if (sum) {
 481                         printk(KERN_ERR "PnPBIOS: installation structure is corrupted, skipping\n");
 482                         continue;
 483                 }
 484                 if (check->fields.version < 0x10) {
 485                         printk(KERN_WARNING "PnPBIOS: PnP BIOS version %d.%d is not supported\n",
 486                                check->fields.version >> 4,
 487                                check->fields.version & 15);
 488                         continue;
 489                 }
 490                 printk(KERN_INFO "PnPBIOS: PnP BIOS version %d.%d, entry 0x%x:0x%x, dseg 0x%x\n",
 491                        check->fields.version >> 4, check->fields.version & 15,
 492                        check->fields.pm16cseg, check->fields.pm16offset,
 493                        check->fields.pm16dseg);
 494                 pnp_bios_install = check;
 495                 return 1;
 496         }
 497
 498         printk(KERN_INFO "PnPBIOS: PnP BIOS support was not detected.\n");
 499         return 0;
 500 }
 501
 502 static int __init exploding_pnp_bios(struct dmi_system_id *d)
 503 {
 504         printk(KERN_WARNING "%s detected. Disabling PnPBIOS\n", d->ident);
 505         return 0;
 506 }
 507
 508 static struct dmi_system_id pnpbios_dmi_table[] = {
 509         {       /* PnPBIOS GPF on boot */
 510                 .callback = exploding_pnp_bios,
 511                 .ident = "Higraded P14H",
 512                 .matches = {
 513                         DMI_MATCH(DMI_BIOS_VENDOR, "American Megatrends Inc."),
 514                         DMI_MATCH(DMI_BIOS_VERSION, "07.00T"),
 515                         DMI_MATCH(DMI_SYS_VENDOR, "Higraded"),
 516                         DMI_MATCH(DMI_PRODUCT_NAME, "P14H"),
 517                 },
 518         },
 519         {       /* PnPBIOS GPF on boot */
 520                 .callback = exploding_pnp_bios,
 521                 .ident = "ASUS P4P800",
 522                 .matches = {
 523                         DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc."),
 524                         DMI_MATCH(DMI_BOARD_NAME, "P4P800"),
 525                 },
 526         },
 527         { }
 528 };
 529
 530 int __init pnpbios_init(void)
 531 {
 532         int ret;
 533
 534         if (pnpbios_disabled || dmi_check_system(pnpbios_dmi_table)) {
 535                 printk(KERN_INFO "PnPBIOS: Disabled\n");
 536                 return -ENODEV;
 537         }
 538
 539         /* scan the system for pnpbios support */
 540         if (!pnpbios_probe_system())
 541                 return -ENODEV;
 542
 543         /* make preparations for bios calls */
 544         pnpbios_calls_init(pnp_bios_install);
 545
 546         /* read the node info */
 547         ret = pnp_bios_dev_node_info(&node_info);
 548         if (ret) {
 549                 printk(KERN_ERR "PnPBIOS: Unable to get node info.  Aborting.\n");
 550                 return ret;
 551         }
 552
 553         /* register with the pnp layer */
 554         ret = pnp_register_protocol(&pnpbios_protocol);
 555         if (ret) {
 556                 printk(KERN_ERR "PnPBIOS: Unable to register driver.  Aborting.\n");
 557                 return ret;
 558         }
 559
 560         /* start the proc interface */
 561         ret = pnpbios_proc_init();
 562         if (ret)
 563                 printk(KERN_ERR "PnPBIOS: Failed to create proc interface.\n");
 564
 565         /* scan for pnpbios devices */
 566         build_devlist();
 567
 568         return 0;
 569 }
 570
 571 subsys_initcall(pnpbios_init);
 572
 573 static int __init pnpbios_thread_init(void)
 574 {
 575 #ifdef CONFIG_HOTPLUG
 576         init_completion(&unload_sem);
 577         if (kernel_thread(pnp_dock_thread, NULL, CLONE_KERNEL) > 0)
 578                 unloading = 0;
 579 #endif
 580         return 0;
 581 }
 582
 583 #ifndef MODULE
 584
 585 /* init/main.c calls pnpbios_init early */
 586
 587 /* Start the kernel thread later: */
 588 module_init(pnpbios_thread_init);
 589
 590 #else
 591
 592 /*
 593  * N.B.: Building pnpbios as a module hasn't been fully implemented
 594  */
 595
 596 MODULE_LICENSE("GPL");
 597
 598 static int __init pnpbios_init_all(void)
 599 {
 600         int r;
 601
 602         r = pnpbios_init();
 603         if (r)
 604                 return r;
 605         r = pnpbios_thread_init();
 606         if (r)
 607                 return r;
 608         return 0;
 609 }
 610
 611 static void __exit pnpbios_exit(void)
 612 {
 613 #ifdef CONFIG_HOTPLUG
 614         unloading = 1;
 615         wait_for_completion(&unload_sem);
 616 #endif
 617         pnpbios_proc_exit();
 618         /* We ought to free resources here */
 619         return;
 620 }
 621
 622 module_init(pnpbios_init_all);
 623 module_exit(pnpbios_exit);
 624
 625 #endif
 626
 627 EXPORT_SYMBOL(pnpbios_protocol);