docbooks: add/fix PCI kernel-doc
[linux-2.6/mini2440.git] / include / acpi / acpi_drivers.h
blob0352c8f0b05b5f89182a8f3cce886a0b33d94752
1 /*
2 * acpi_drivers.h ($Revision: 31 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #ifndef __ACPI_DRIVERS_H__
27 #define __ACPI_DRIVERS_H__
29 #include <linux/acpi.h>
30 #include <acpi/acpi_bus.h>
32 #define ACPI_MAX_STRING 80
35 * Please update drivers/acpi/debug.c and Documentation/acpi/debug.txt
36 * if you add to this list.
38 #define ACPI_BUS_COMPONENT 0x00010000
39 #define ACPI_AC_COMPONENT 0x00020000
40 #define ACPI_BATTERY_COMPONENT 0x00040000
41 #define ACPI_BUTTON_COMPONENT 0x00080000
42 #define ACPI_SBS_COMPONENT 0x00100000
43 #define ACPI_FAN_COMPONENT 0x00200000
44 #define ACPI_PCI_COMPONENT 0x00400000
45 #define ACPI_POWER_COMPONENT 0x00800000
46 #define ACPI_CONTAINER_COMPONENT 0x01000000
47 #define ACPI_SYSTEM_COMPONENT 0x02000000
48 #define ACPI_THERMAL_COMPONENT 0x04000000
49 #define ACPI_MEMORY_DEVICE_COMPONENT 0x08000000
50 #define ACPI_VIDEO_COMPONENT 0x10000000
51 #define ACPI_PROCESSOR_COMPONENT 0x20000000
54 * _HID definitions
55 * HIDs must conform to ACPI spec(6.1.4)
56 * Linux specific HIDs do not apply to this and begin with LNX:
59 #define ACPI_POWER_HID "LNXPOWER"
60 #define ACPI_PROCESSOR_OBJECT_HID "ACPI_CPU"
61 #define ACPI_PROCESSOR_HID "ACPI0007"
62 #define ACPI_SYSTEM_HID "LNXSYSTM"
63 #define ACPI_THERMAL_HID "LNXTHERM"
64 #define ACPI_BUTTON_HID_POWERF "LNXPWRBN"
65 #define ACPI_BUTTON_HID_SLEEPF "LNXSLPBN"
66 #define ACPI_VIDEO_HID "LNXVIDEO"
67 #define ACPI_BAY_HID "LNXIOBAY"
68 #define ACPI_DOCK_HID "LNXDOCK"
71 * For fixed hardware buttons, we fabricate acpi_devices with HID
72 * ACPI_BUTTON_HID_POWERF or ACPI_BUTTON_HID_SLEEPF. Fixed hardware
73 * signals only an event; it doesn't supply a notification value.
74 * To allow drivers to treat notifications from fixed hardware the
75 * same as those from real devices, we turn the events into this
76 * notification value.
78 #define ACPI_FIXED_HARDWARE_EVENT 0x100
80 /* --------------------------------------------------------------------------
81 PCI
82 -------------------------------------------------------------------------- */
85 /* ACPI PCI Interrupt Link (pci_link.c) */
87 int acpi_irq_penalty_init(void);
88 int acpi_pci_link_allocate_irq(acpi_handle handle, int index, int *triggering,
89 int *polarity, char **name);
90 int acpi_pci_link_free_irq(acpi_handle handle);
92 /* ACPI PCI Interrupt Routing (pci_irq.c) */
94 int acpi_pci_irq_add_prt(acpi_handle handle, int segment, int bus);
95 void acpi_pci_irq_del_prt(int segment, int bus);
97 /* ACPI PCI Device Binding (pci_bind.c) */
99 struct pci_bus;
101 acpi_status acpi_get_pci_id(acpi_handle handle, struct acpi_pci_id *id);
102 int acpi_pci_bind(struct acpi_device *device);
103 int acpi_pci_bind_root(struct acpi_device *device, struct acpi_pci_id *id,
104 struct pci_bus *bus);
106 /* Arch-defined function to add a bus to the system */
108 struct pci_bus *pci_acpi_scan_root(struct acpi_device *device, int domain,
109 int bus);
111 /* --------------------------------------------------------------------------
112 Processor
113 -------------------------------------------------------------------------- */
115 #define ACPI_PROCESSOR_LIMIT_NONE 0x00
116 #define ACPI_PROCESSOR_LIMIT_INCREMENT 0x01
117 #define ACPI_PROCESSOR_LIMIT_DECREMENT 0x02
119 int acpi_processor_set_thermal_limit(acpi_handle handle, int type);
121 /*--------------------------------------------------------------------------
122 Dock Station
123 -------------------------------------------------------------------------- */
124 struct acpi_dock_ops {
125 acpi_notify_handler handler;
126 acpi_notify_handler uevent;
129 #if defined(CONFIG_ACPI_DOCK) || defined(CONFIG_ACPI_DOCK_MODULE)
130 extern int is_dock_device(acpi_handle handle);
131 extern int register_dock_notifier(struct notifier_block *nb);
132 extern void unregister_dock_notifier(struct notifier_block *nb);
133 extern int register_hotplug_dock_device(acpi_handle handle,
134 struct acpi_dock_ops *ops,
135 void *context);
136 extern void unregister_hotplug_dock_device(acpi_handle handle);
137 #else
138 static inline int is_dock_device(acpi_handle handle)
140 return 0;
142 static inline int register_dock_notifier(struct notifier_block *nb)
144 return -ENODEV;
146 static inline void unregister_dock_notifier(struct notifier_block *nb)
149 static inline int register_hotplug_dock_device(acpi_handle handle,
150 struct acpi_dock_ops *ops,
151 void *context)
153 return -ENODEV;
155 static inline void unregister_hotplug_dock_device(acpi_handle handle)
158 #endif
160 #endif /*__ACPI_DRIVERS_H__*/