2 * pnpbios -- PnP BIOS driver
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.
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>
18 * Ported to the PnP Layer and several additional improvements (C) 2002
19 * by Adam Belay <ambx1@neo.rr.com>
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
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.
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
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
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>
57 #include <asm/system.h>
59 #include <linux/smp.h>
61 #include <linux/slab.h>
62 #include <linux/kmod.h>
63 #include <linux/completion.h>
64 #include <linux/spinlock.h>
65 #include <asm/system.h>
66 #include <asm/byteorder.h>
77 static union pnp_bios_install_struct * pnp_bios_install = NULL;
79 int pnp_bios_present(void)
81 return (pnp_bios_install != NULL);
84 struct pnp_dev_node_info node_info;
86 void *pnpbios_kmalloc(size_t size, int f)
88 void *p = kmalloc( size, f );
90 printk(KERN_ERR "PnPBIOS: kmalloc() failed\n");
102 #ifdef CONFIG_HOTPLUG
104 static int unloading = 0;
105 static struct completion unload_sem;
108 * (Much of this belongs in a shared routine somewhere)
111 static int pnp_dock_event(int dock, struct pnp_docking_station_info *info)
113 char *argv [3], **envp, *buf, *scratch;
116 if (!hotplug_path [0])
118 if (!current->fs->root) {
121 if (!(envp = (char **) pnpbios_kmalloc (20 * sizeof (char *), GFP_KERNEL))) {
124 if (!(buf = pnpbios_kmalloc (256, GFP_KERNEL))) {
129 /* only one standardized param to hotplug command: type */
130 argv [0] = hotplug_path;
134 /* minimal command environment */
135 envp [i++] = "HOME=/";
136 envp [i++] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin";
139 /* hint that policy agent should enter no-stdout debug mode */
140 envp [i++] = "DEBUG=kernel";
142 /* extensible set of named bus-specific parameters,
143 * supporting multiple driver selection algorithms.
147 /* action: add, remove */
148 envp [i++] = scratch;
149 scratch += sprintf (scratch, "ACTION=%s", dock?"add":"remove") + 1;
151 /* Report the ident for the dock */
152 envp [i++] = scratch;
153 scratch += sprintf (scratch, "DOCK=%x/%x/%x",
154 info->location_id, info->serial, info->capabilities);
157 value = call_usermodehelper (argv [0], argv, envp, 0);
164 * Poll the PnP docking at regular intervals
166 static int pnp_dock_thread(void * unused)
168 static struct pnp_docking_station_info now;
169 int docked = -1, d = 0;
170 daemonize("kpnpbiosd");
171 allow_signal(SIGKILL);
172 while(!unloading && !signal_pending(current))
177 * Poll every 2 seconds
179 set_current_state(TASK_INTERRUPTIBLE);
180 schedule_timeout(HZ*2);
181 if(signal_pending(current))
184 status = pnp_bios_dock_station_info(&now);
191 case PNP_FUNCTION_NOT_SUPPORTED:
192 complete_and_exit(&unload_sem, 0);
193 case PNP_SYSTEM_NOT_DOCKED:
200 pnpbios_print_status( "pnp_dock_thread", status );
205 if(pnp_dock_event(d, &now)==0)
209 printk(KERN_INFO "PnPBIOS: Docking station %stached\n", docked?"at":"de");
214 complete_and_exit(&unload_sem, 0);
217 #endif /* CONFIG_HOTPLUG */
219 static int pnpbios_get_resources(struct pnp_dev * dev, struct pnp_resource_table * res)
221 u8 nodenum = dev->number;
222 struct pnp_bios_node * node;
225 if(!pnpbios_is_dynamic(dev))
228 node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
231 if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node)) {
235 pnpbios_read_resources_from_node(res, node);
236 dev->active = pnp_is_active(dev);
241 static int pnpbios_set_resources(struct pnp_dev * dev, struct pnp_resource_table * res)
243 u8 nodenum = dev->number;
244 struct pnp_bios_node * node;
248 if (!pnpbios_is_dynamic(dev))
251 node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
254 if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node))
256 if(pnpbios_write_resources_to_node(res, node)<0) {
260 ret = pnp_bios_set_dev_node(node->handle, (char)PNPMODE_DYNAMIC, node);
267 static void pnpbios_zero_data_stream(struct pnp_bios_node * node)
269 unsigned char * p = (char *)node->data;
270 unsigned char * end = (char *)(node->data + node->size);
273 while ((char *)p < (char *)end) {
274 if(p[0] & 0x80) { /* large tag */
275 len = (p[2] << 8) | p[1];
278 if (((p[0]>>3) & 0x0f) == 0x0f)
283 for (i = 0; i < len; i++)
287 printk(KERN_ERR "PnPBIOS: Resource structure did not contain an end tag.\n");
290 static int pnpbios_disable_resources(struct pnp_dev *dev)
292 struct pnp_bios_node * node;
293 u8 nodenum = dev->number;
297 if(dev->flags & PNPBIOS_NO_DISABLE || !pnpbios_is_dynamic(dev))
300 node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
304 if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node)) {
308 pnpbios_zero_data_stream(node);
310 ret = pnp_bios_set_dev_node(dev->number, (char)PNPMODE_DYNAMIC, node);
317 /* PnP Layer support */
319 struct pnp_protocol pnpbios_protocol = {
320 .name = "Plug and Play BIOS",
321 .get = pnpbios_get_resources,
322 .set = pnpbios_set_resources,
323 .disable = pnpbios_disable_resources,
326 static int insert_device(struct pnp_dev *dev, struct pnp_bios_node * node)
328 struct list_head * pos;
329 struct pnp_dev * pnp_dev;
330 struct pnp_id *dev_id;
333 /* check if the device is already added */
334 dev->number = node->handle;
335 list_for_each (pos, &pnpbios_protocol.devices){
336 pnp_dev = list_entry(pos, struct pnp_dev, protocol_list);
337 if (dev->number == pnp_dev->number)
341 /* set the initial values for the PnP device */
342 dev_id = pnpbios_kmalloc(sizeof(struct pnp_id), GFP_KERNEL);
345 pnpid32_to_pnpid(node->eisa_id,id);
346 memcpy(dev_id->id,id,7);
347 pnp_add_id(dev_id, dev);
348 pnpbios_parse_data_stream(dev, node);
349 dev->active = pnp_is_active(dev);
350 dev->flags = node->flags;
351 if (!(dev->flags & PNPBIOS_NO_CONFIG))
352 dev->capabilities |= PNP_CONFIGURABLE;
353 if (!(dev->flags & PNPBIOS_NO_DISABLE))
354 dev->capabilities |= PNP_DISABLE;
355 dev->capabilities |= PNP_READ;
356 if (pnpbios_is_dynamic(dev))
357 dev->capabilities |= PNP_WRITE;
358 if (dev->flags & PNPBIOS_REMOVABLE)
359 dev->capabilities |= PNP_REMOVABLE;
360 dev->protocol = &pnpbios_protocol;
362 /* clear out the damaged flags */
364 pnp_init_resource_table(&dev->res);
367 pnpbios_interface_attach_device(node);
372 static void __init build_devlist(void)
375 unsigned int nodes_got = 0;
376 unsigned int devs = 0;
377 struct pnp_bios_node *node;
380 node = pnpbios_kmalloc(node_info.max_node_size, GFP_KERNEL);
384 for(nodenum=0; nodenum<0xff; ) {
385 u8 thisnodenum = nodenum;
386 /* eventually we will want to use PNPMODE_STATIC here but for now
387 * dynamic will help us catch buggy bioses to add to the blacklist.
389 if (!pnpbios_dont_use_current_config) {
390 if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_DYNAMIC, node))
393 if (pnp_bios_get_dev_node(&nodenum, (char )PNPMODE_STATIC, node))
397 dev = pnpbios_kmalloc(sizeof (struct pnp_dev), GFP_KERNEL);
400 if(insert_device(dev,node)<0)
404 if (nodenum <= thisnodenum) {
405 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);
411 printk(KERN_INFO "PnPBIOS: %i node%s reported by PnP BIOS; %i recorded by driver\n",
412 nodes_got, nodes_got != 1 ? "s" : "", devs);
421 static int pnpbios_disabled; /* = 0 */
422 int pnpbios_dont_use_current_config; /* = 0 */
425 static int __init pnpbios_setup(char *str)
429 while ((str != NULL) && (*str != '\0')) {
430 if (strncmp(str, "off", 3) == 0)
432 if (strncmp(str, "on", 2) == 0)
434 invert = (strncmp(str, "no-", 3) == 0);
437 if (strncmp(str, "curr", 4) == 0)
438 pnpbios_dont_use_current_config = invert;
439 str = strchr(str, ',');
441 str += strspn(str, ", \t");
447 __setup("pnpbios=", pnpbios_setup);
450 /* PnP BIOS signature: "$PnP" */
451 #define PNP_SIGNATURE (('$' << 0) + ('P' << 8) + ('n' << 16) + ('P' << 24))
453 int __init pnpbios_probe_system(void)
455 union pnp_bios_install_struct *check;
459 printk(KERN_INFO "PnPBIOS: Scanning system for PnP BIOS support...\n");
462 * Search the defined area (0xf0000-0xffff0) for a valid PnP BIOS
463 * structure and, if one is found, sets up the selectors and
466 for (check = (union pnp_bios_install_struct *) __va(0xf0000);
467 check < (union pnp_bios_install_struct *) __va(0xffff0);
468 check = (void *)check + 16) {
469 if (check->fields.signature != PNP_SIGNATURE)
471 printk(KERN_INFO "PnPBIOS: Found PnP BIOS installation structure at 0x%p\n", check);
472 length = check->fields.length;
474 printk(KERN_ERR "PnPBIOS: installation structure is invalid, skipping\n");
477 for (sum = 0, i = 0; i < length; i++)
478 sum += check->chars[i];
480 printk(KERN_ERR "PnPBIOS: installation structure is corrupted, skipping\n");
483 if (check->fields.version < 0x10) {
484 printk(KERN_WARNING "PnPBIOS: PnP BIOS version %d.%d is not supported\n",
485 check->fields.version >> 4,
486 check->fields.version & 15);
489 printk(KERN_INFO "PnPBIOS: PnP BIOS version %d.%d, entry 0x%x:0x%x, dseg 0x%x\n",
490 check->fields.version >> 4, check->fields.version & 15,
491 check->fields.pm16cseg, check->fields.pm16offset,
492 check->fields.pm16dseg);
493 pnp_bios_install = check;
497 printk(KERN_INFO "PnPBIOS: PnP BIOS support was not detected.\n");
501 int __init pnpbios_init(void)
504 if(pnpbios_disabled || (dmi_broken & BROKEN_PNP_BIOS)) {
505 printk(KERN_INFO "PnPBIOS: Disabled\n");
509 /* scan the system for pnpbios support */
510 if (!pnpbios_probe_system())
513 /* make preparations for bios calls */
514 pnpbios_calls_init(pnp_bios_install);
516 /* read the node info */
517 ret = pnp_bios_dev_node_info(&node_info);
519 printk(KERN_ERR "PnPBIOS: Unable to get node info. Aborting.\n");
523 /* register with the pnp layer */
524 ret = pnp_register_protocol(&pnpbios_protocol);
526 printk(KERN_ERR "PnPBIOS: Unable to register driver. Aborting.\n");
530 /* start the proc interface */
531 ret = pnpbios_proc_init();
533 printk(KERN_ERR "PnPBIOS: Failed to create proc interface.\n");
535 /* scan for pnpbios devices */
541 subsys_initcall(pnpbios_init);
543 static int __init pnpbios_thread_init(void)
545 #ifdef CONFIG_HOTPLUG
546 init_completion(&unload_sem);
547 if (kernel_thread(pnp_dock_thread, NULL, CLONE_KERNEL) > 0)
555 /* init/main.c calls pnpbios_init early */
557 /* Start the kernel thread later: */
558 module_init(pnpbios_thread_init);
563 * N.B.: Building pnpbios as a module hasn't been fully implemented
566 MODULE_LICENSE("GPL");
568 static int __init pnpbios_init_all(void)
575 r = pnpbios_thread_init();
581 static void __exit pnpbios_exit(void)
583 #ifdef CONFIG_HOTPLUG
585 wait_for_completion(&unload_sem);
588 /* We ought to free resources here */
592 module_init(pnpbios_init_all);
593 module_exit(pnpbios_exit);
597 EXPORT_SYMBOL(pnpbios_protocol);