xref: /openbmc/linux/include/acpi/acpi_drivers.h (revision 5bd8e16d)
1 /*
2  *  acpi_drivers.h  ($Revision: 31 $)
3  *
4  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6  *
7  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8  *
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.
13  *
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.
18  *
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.
22  *
23  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24  */
25 
26 #ifndef __ACPI_DRIVERS_H__
27 #define __ACPI_DRIVERS_H__
28 
29 #include <linux/acpi.h>
30 #include <acpi/acpi_bus.h>
31 
32 #define ACPI_MAX_STRING			80
33 
34 /*
35  * Please update drivers/acpi/debug.c and Documentation/acpi/debug.txt
36  * if you add to this list.
37  */
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
52 
53 /*
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:
57  */
58 
59 #define ACPI_POWER_HID			"LNXPOWER"
60 #define ACPI_PROCESSOR_OBJECT_HID	"LNXCPU"
61 #define ACPI_SYSTEM_HID			"LNXSYSTM"
62 #define ACPI_THERMAL_HID		"LNXTHERM"
63 #define ACPI_BUTTON_HID_POWERF		"LNXPWRBN"
64 #define ACPI_BUTTON_HID_SLEEPF		"LNXSLPBN"
65 #define ACPI_VIDEO_HID			"LNXVIDEO"
66 #define ACPI_BAY_HID			"LNXIOBAY"
67 #define ACPI_DOCK_HID			"LNXDOCK"
68 /* Quirk for broken IBM BIOSes */
69 #define ACPI_SMBUS_IBM_HID		"SMBUSIBM"
70 
71 /*
72  * For fixed hardware buttons, we fabricate acpi_devices with HID
73  * ACPI_BUTTON_HID_POWERF or ACPI_BUTTON_HID_SLEEPF.  Fixed hardware
74  * signals only an event; it doesn't supply a notification value.
75  * To allow drivers to treat notifications from fixed hardware the
76  * same as those from real devices, we turn the events into this
77  * notification value.
78  */
79 #define ACPI_FIXED_HARDWARE_EVENT	0x100
80 
81 /* --------------------------------------------------------------------------
82                                        PCI
83    -------------------------------------------------------------------------- */
84 
85 
86 /* ACPI PCI Interrupt Link (pci_link.c) */
87 
88 int acpi_irq_penalty_init(void);
89 int acpi_pci_link_allocate_irq(acpi_handle handle, int index, int *triggering,
90 			       int *polarity, char **name);
91 int acpi_pci_link_free_irq(acpi_handle handle);
92 
93 /* ACPI PCI Device Binding (pci_bind.c) */
94 
95 struct pci_bus;
96 
97 struct pci_dev *acpi_get_pci_dev(acpi_handle);
98 
99 /* Arch-defined function to add a bus to the system */
100 
101 struct pci_bus *pci_acpi_scan_root(struct acpi_pci_root *root);
102 void pci_acpi_crs_quirks(void);
103 
104 /* --------------------------------------------------------------------------
105                                     Processor
106    -------------------------------------------------------------------------- */
107 
108 #define ACPI_PROCESSOR_LIMIT_NONE	0x00
109 #define ACPI_PROCESSOR_LIMIT_INCREMENT	0x01
110 #define ACPI_PROCESSOR_LIMIT_DECREMENT	0x02
111 
112 /*--------------------------------------------------------------------------
113                                   Dock Station
114   -------------------------------------------------------------------------- */
115 struct acpi_dock_ops {
116 	acpi_notify_handler fixup;
117 	acpi_notify_handler handler;
118 	acpi_notify_handler uevent;
119 };
120 
121 #ifdef CONFIG_ACPI_DOCK
122 extern int is_dock_device(acpi_handle handle);
123 extern int register_hotplug_dock_device(acpi_handle handle,
124 					const struct acpi_dock_ops *ops,
125 					void *context,
126 					void (*init)(void *),
127 					void (*release)(void *));
128 extern void unregister_hotplug_dock_device(acpi_handle handle);
129 #else
130 static inline int is_dock_device(acpi_handle handle)
131 {
132 	return 0;
133 }
134 static inline int register_hotplug_dock_device(acpi_handle handle,
135 					       const struct acpi_dock_ops *ops,
136 					       void *context,
137 					       void (*init)(void *),
138 					       void (*release)(void *))
139 {
140 	return -ENODEV;
141 }
142 static inline void unregister_hotplug_dock_device(acpi_handle handle)
143 {
144 }
145 #endif /* CONFIG_ACPI_DOCK */
146 
147 #endif /*__ACPI_DRIVERS_H__*/
148