ACPI/PCI: Negotiate _OSC control bits before requesting them
[linux-2.6.git] / include / linux / acpi.h
1 /*
2  * acpi.h - ACPI Interface
3  *
4  * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
5  *
6  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23  */
24
25 #ifndef _LINUX_ACPI_H
26 #define _LINUX_ACPI_H
27
28 #include <linux/ioport.h>       /* for struct resource */
29
30 #ifdef  CONFIG_ACPI
31
32 #ifndef _LINUX
33 #define _LINUX
34 #endif
35
36 #include <linux/list.h>
37 #include <linux/mod_devicetable.h>
38
39 #include <acpi/acpi.h>
40 #include <acpi/acpi_bus.h>
41 #include <acpi/acpi_drivers.h>
42 #include <acpi/acpi_numa.h>
43 #include <asm/acpi.h>
44
45 enum acpi_irq_model_id {
46         ACPI_IRQ_MODEL_PIC = 0,
47         ACPI_IRQ_MODEL_IOAPIC,
48         ACPI_IRQ_MODEL_IOSAPIC,
49         ACPI_IRQ_MODEL_PLATFORM,
50         ACPI_IRQ_MODEL_COUNT
51 };
52
53 extern enum acpi_irq_model_id   acpi_irq_model;
54
55 enum acpi_interrupt_id {
56         ACPI_INTERRUPT_PMI      = 1,
57         ACPI_INTERRUPT_INIT,
58         ACPI_INTERRUPT_CPEI,
59         ACPI_INTERRUPT_COUNT
60 };
61
62 #define ACPI_SPACE_MEM          0
63
64 enum acpi_address_range_id {
65         ACPI_ADDRESS_RANGE_MEMORY = 1,
66         ACPI_ADDRESS_RANGE_RESERVED = 2,
67         ACPI_ADDRESS_RANGE_ACPI = 3,
68         ACPI_ADDRESS_RANGE_NVS  = 4,
69         ACPI_ADDRESS_RANGE_COUNT
70 };
71
72
73 /* Table Handlers */
74
75 typedef int (*acpi_table_handler) (struct acpi_table_header *table);
76
77 typedef int (*acpi_table_entry_handler) (struct acpi_subtable_header *header, const unsigned long end);
78
79 char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
80 void __acpi_unmap_table(char *map, unsigned long size);
81 int early_acpi_boot_init(void);
82 int acpi_boot_init (void);
83 void acpi_boot_table_init (void);
84 int acpi_mps_check (void);
85 int acpi_numa_init (void);
86
87 int acpi_table_init (void);
88 int acpi_table_parse (char *id, acpi_table_handler handler);
89 int __init acpi_table_parse_entries(char *id, unsigned long table_size,
90         int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
91 int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
92 int acpi_parse_mcfg (struct acpi_table_header *header);
93 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
94
95 /* the following four functions are architecture-dependent */
96 void acpi_numa_slit_init (struct acpi_table_slit *slit);
97 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
98 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
99 void acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
100 void acpi_numa_arch_fixup(void);
101
102 #ifdef CONFIG_ACPI_HOTPLUG_CPU
103 /* Arch dependent functions for cpu hotplug support */
104 int acpi_map_lsapic(acpi_handle handle, int *pcpu);
105 int acpi_unmap_lsapic(int cpu);
106 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
107
108 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
109 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
110 void acpi_irq_stats_init(void);
111 extern u32 acpi_irq_handled;
112 extern u32 acpi_irq_not_handled;
113
114 extern int sbf_port;
115 extern unsigned long acpi_realmode_flags;
116
117 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
118 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
119 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
120
121 #ifdef CONFIG_X86_IO_APIC
122 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
123 #else
124 #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
125 #endif
126 /*
127  * This function undoes the effect of one call to acpi_register_gsi().
128  * If this matches the last registration, any IRQ resources for gsi
129  * are freed.
130  */
131 void acpi_unregister_gsi (u32 gsi);
132
133 struct pci_dev;
134
135 int acpi_pci_irq_enable (struct pci_dev *dev);
136 void acpi_penalize_isa_irq(int irq, int active);
137
138 void acpi_pci_irq_disable (struct pci_dev *dev);
139
140 struct acpi_pci_driver {
141         struct acpi_pci_driver *next;
142         int (*add)(acpi_handle handle);
143         void (*remove)(acpi_handle handle);
144 };
145
146 int acpi_pci_register_driver(struct acpi_pci_driver *driver);
147 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
148
149 extern int ec_read(u8 addr, u8 *val);
150 extern int ec_write(u8 addr, u8 val);
151 extern int ec_transaction(u8 command,
152                           const u8 *wdata, unsigned wdata_len,
153                           u8 *rdata, unsigned rdata_len,
154                           int force_poll);
155
156 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
157
158 typedef void (*wmi_notify_handler) (u32 value, void *context);
159
160 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
161                                         u32 method_id,
162                                         const struct acpi_buffer *in,
163                                         struct acpi_buffer *out);
164 extern acpi_status wmi_query_block(const char *guid, u8 instance,
165                                         struct acpi_buffer *out);
166 extern acpi_status wmi_set_block(const char *guid, u8 instance,
167                                         const struct acpi_buffer *in);
168 extern acpi_status wmi_install_notify_handler(const char *guid,
169                                         wmi_notify_handler handler, void *data);
170 extern acpi_status wmi_remove_notify_handler(const char *guid);
171 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
172 extern bool wmi_has_guid(const char *guid);
173
174 #endif  /* CONFIG_ACPI_WMI */
175
176 #define ACPI_VIDEO_OUTPUT_SWITCHING                     0x0001
177 #define ACPI_VIDEO_DEVICE_POSTING                       0x0002
178 #define ACPI_VIDEO_ROM_AVAILABLE                        0x0004
179 #define ACPI_VIDEO_BACKLIGHT                            0x0008
180 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR               0x0010
181 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO                0x0020
182 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR        0x0040
183 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO         0x0080
184 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR                 0x0100
185 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO                  0x0200
186 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR          0x0400
187 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO           0x0800
188
189 #if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
190
191 extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle);
192 extern long acpi_is_video_device(struct acpi_device *device);
193 extern int acpi_video_backlight_support(void);
194 extern int acpi_video_display_switch_support(void);
195
196 #else
197
198 static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle)
199 {
200         return 0;
201 }
202
203 static inline long acpi_is_video_device(struct acpi_device *device)
204 {
205         return 0;
206 }
207
208 static inline int acpi_video_backlight_support(void)
209 {
210         return 0;
211 }
212
213 static inline int acpi_video_display_switch_support(void)
214 {
215         return 0;
216 }
217
218 #endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
219
220 extern int acpi_blacklisted(void);
221 extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
222 extern int acpi_osi_setup(char *str);
223
224 #ifdef CONFIG_ACPI_NUMA
225 int acpi_get_pxm(acpi_handle handle);
226 int acpi_get_node(acpi_handle *handle);
227 #else
228 static inline int acpi_get_pxm(acpi_handle handle)
229 {
230         return 0;
231 }
232 static inline int acpi_get_node(acpi_handle *handle)
233 {
234         return 0;
235 }
236 #endif
237 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
238
239 extern int pnpacpi_disabled;
240
241 #define PXM_INVAL       (-1)
242 #define NID_INVAL       (-1)
243
244 int acpi_check_resource_conflict(const struct resource *res);
245
246 int acpi_check_region(resource_size_t start, resource_size_t n,
247                       const char *name);
248 int acpi_check_mem_region(resource_size_t start, resource_size_t n,
249                       const char *name);
250
251 int acpi_resources_are_enforced(void);
252
253 #ifdef CONFIG_PM_SLEEP
254 void __init acpi_no_s4_hw_signature(void);
255 void __init acpi_old_suspend_ordering(void);
256 void __init acpi_nvs_nosave(void);
257 #endif /* CONFIG_PM_SLEEP */
258
259 struct acpi_osc_context {
260         char *uuid_str; /* uuid string */
261         int rev;
262         struct acpi_buffer cap; /* arg2/arg3 */
263         struct acpi_buffer ret; /* free by caller if success */
264 };
265
266 #define OSC_QUERY_TYPE                  0
267 #define OSC_SUPPORT_TYPE                1
268 #define OSC_CONTROL_TYPE                2
269
270 /* _OSC DW0 Definition */
271 #define OSC_QUERY_ENABLE                1
272 #define OSC_REQUEST_ERROR               2
273 #define OSC_INVALID_UUID_ERROR          4
274 #define OSC_INVALID_REVISION_ERROR      8
275 #define OSC_CAPABILITIES_MASK_ERROR     16
276
277 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
278
279 /* platform-wide _OSC bits */
280 #define OSC_SB_PAD_SUPPORT              1
281 #define OSC_SB_PPC_OST_SUPPORT          2
282 #define OSC_SB_PR3_SUPPORT              4
283 #define OSC_SB_CPUHP_OST_SUPPORT        8
284 #define OSC_SB_APEI_SUPPORT             16
285
286 /* PCI defined _OSC bits */
287 /* _OSC DW1 Definition (OS Support Fields) */
288 #define OSC_EXT_PCI_CONFIG_SUPPORT              1
289 #define OSC_ACTIVE_STATE_PWR_SUPPORT            2
290 #define OSC_CLOCK_PWR_CAPABILITY_SUPPORT        4
291 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          8
292 #define OSC_MSI_SUPPORT                         16
293 #define OSC_PCI_SUPPORT_MASKS                   0x1f
294
295 /* _OSC DW1 Definition (OS Control Fields) */
296 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       1
297 #define OSC_SHPC_NATIVE_HP_CONTROL              2
298 #define OSC_PCI_EXPRESS_PME_CONTROL             4
299 #define OSC_PCI_EXPRESS_AER_CONTROL             8
300 #define OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL   16
301
302 #define OSC_PCI_CONTROL_MASKS   (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |    \
303                                 OSC_SHPC_NATIVE_HP_CONTROL |            \
304                                 OSC_PCI_EXPRESS_PME_CONTROL |           \
305                                 OSC_PCI_EXPRESS_AER_CONTROL |           \
306                                 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL)
307 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
308                                              u32 *mask, u32 req);
309 extern void acpi_early_init(void);
310
311 #else   /* !CONFIG_ACPI */
312
313 #define acpi_disabled 1
314
315 static inline void acpi_early_init(void) { }
316
317 static inline int early_acpi_boot_init(void)
318 {
319         return 0;
320 }
321 static inline int acpi_boot_init(void)
322 {
323         return 0;
324 }
325
326 static inline void acpi_boot_table_init(void)
327 {
328         return;
329 }
330
331 static inline int acpi_mps_check(void)
332 {
333         return 0;
334 }
335
336 static inline int acpi_check_resource_conflict(struct resource *res)
337 {
338         return 0;
339 }
340
341 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
342                                     const char *name)
343 {
344         return 0;
345 }
346
347 static inline int acpi_check_mem_region(resource_size_t start,
348                                         resource_size_t n, const char *name)
349 {
350         return 0;
351 }
352
353 struct acpi_table_header;
354 static inline int acpi_table_parse(char *id,
355                                 int (*handler)(struct acpi_table_header *))
356 {
357         return -1;
358 }
359 #endif  /* !CONFIG_ACPI */
360 #endif  /*_LINUX_ACPI_H*/