]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - include/linux/acpi.h
ACPI / platform: use ACPI device name instead of _HID._UID
[mirror_ubuntu-eoan-kernel.git] / include / linux / acpi.h
CommitLineData
1da177e4
LT
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
443dea72 28#include <linux/ioport.h> /* for struct resource */
cf761af9 29#include <linux/device.h>
3f5948fa 30
25be5e6c
LB
31#ifdef CONFIG_ACPI
32
1da177e4
LT
33#ifndef _LINUX
34#define _LINUX
35#endif
36
37#include <linux/list.h>
29b71a1c 38#include <linux/mod_devicetable.h>
1da177e4
LT
39
40#include <acpi/acpi.h>
41#include <acpi/acpi_bus.h>
42#include <acpi/acpi_drivers.h>
762834e8 43#include <acpi/acpi_numa.h>
1da177e4 44#include <asm/acpi.h>
1da177e4 45
1da177e4
LT
46enum acpi_irq_model_id {
47 ACPI_IRQ_MODEL_PIC = 0,
48 ACPI_IRQ_MODEL_IOAPIC,
49 ACPI_IRQ_MODEL_IOSAPIC,
3948ec94 50 ACPI_IRQ_MODEL_PLATFORM,
1da177e4
LT
51 ACPI_IRQ_MODEL_COUNT
52};
53
54extern enum acpi_irq_model_id acpi_irq_model;
55
1da177e4
LT
56enum acpi_interrupt_id {
57 ACPI_INTERRUPT_PMI = 1,
58 ACPI_INTERRUPT_INIT,
59 ACPI_INTERRUPT_CPEI,
60 ACPI_INTERRUPT_COUNT
61};
62
63#define ACPI_SPACE_MEM 0
64
1da177e4
LT
65enum acpi_address_range_id {
66 ACPI_ADDRESS_RANGE_MEMORY = 1,
67 ACPI_ADDRESS_RANGE_RESERVED = 2,
68 ACPI_ADDRESS_RANGE_ACPI = 3,
69 ACPI_ADDRESS_RANGE_NVS = 4,
70 ACPI_ADDRESS_RANGE_COUNT
71};
72
1da177e4 73
1da177e4
LT
74/* Table Handlers */
75
15a58ed1 76typedef int (*acpi_table_handler) (struct acpi_table_header *table);
1da177e4 77
5a8765a8 78typedef int (*acpi_table_entry_handler) (struct acpi_subtable_header *header, const unsigned long end);
1da177e4
LT
79
80char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
970ec1a8 81void __acpi_unmap_table(char *map, unsigned long size);
cbf9bd60 82int early_acpi_boot_init(void);
1da177e4 83int acpi_boot_init (void);
8558e394 84void acpi_boot_table_init (void);
3c999f14 85int acpi_mps_check (void);
1da177e4
LT
86int acpi_numa_init (void);
87
88int acpi_table_init (void);
ceb6c468 89int acpi_table_parse (char *id, acpi_table_handler handler);
6eb87fed
LB
90int __init acpi_table_parse_entries(char *id, unsigned long table_size,
91 int entry_id, acpi_table_entry_handler handler, unsigned int max_entries);
5a8765a8 92int acpi_table_parse_madt (enum acpi_madt_type id, acpi_table_entry_handler handler, unsigned int max_entries);
ceb6c468 93int acpi_parse_mcfg (struct acpi_table_header *header);
5f3b1a8b 94void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
1da177e4
LT
95
96/* the following four functions are architecture-dependent */
97void acpi_numa_slit_init (struct acpi_table_slit *slit);
15a58ed1 98void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
7237d3de 99void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
095adbb6 100int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
1da177e4
LT
101void acpi_numa_arch_fixup(void);
102
103#ifdef CONFIG_ACPI_HOTPLUG_CPU
104/* Arch dependent functions for cpu hotplug support */
105int acpi_map_lsapic(acpi_handle handle, int *pcpu);
106int acpi_unmap_lsapic(int cpu);
107#endif /* CONFIG_ACPI_HOTPLUG_CPU */
108
b1bb248a
KK
109int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
110int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
5229e87d 111void acpi_irq_stats_init(void);
5229e87d 112extern u32 acpi_irq_handled;
88bea188 113extern u32 acpi_irq_not_handled;
1da177e4 114
c255d844 115extern int sbf_port;
77afcf78 116extern unsigned long acpi_realmode_flags;
1da177e4 117
a2f809b0 118int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
1da177e4 119int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
2c2df841 120int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
1da177e4 121
61fd47e0 122#ifdef CONFIG_X86_IO_APIC
9a0a91bb 123extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
61fd47e0 124#else
9a0a91bb 125#define acpi_get_override_irq(gsi, trigger, polarity) (-1)
61fd47e0 126#endif
1da177e4
LT
127/*
128 * This function undoes the effect of one call to acpi_register_gsi().
129 * If this matches the last registration, any IRQ resources for gsi
130 * are freed.
131 */
1da177e4 132void acpi_unregister_gsi (u32 gsi);
1da177e4 133
1da177e4
LT
134struct pci_dev;
135
136int acpi_pci_irq_enable (struct pci_dev *dev);
c9c3e457 137void acpi_penalize_isa_irq(int irq, int active);
1da177e4 138
1da177e4 139void acpi_pci_irq_disable (struct pci_dev *dev);
1da177e4
LT
140
141struct acpi_pci_driver {
8ee5bdf3 142 struct list_head node;
55bfe3c0
TI
143 int (*add)(struct acpi_pci_root *root);
144 void (*remove)(struct acpi_pci_root *root);
1da177e4
LT
145};
146
147int acpi_pci_register_driver(struct acpi_pci_driver *driver);
148void acpi_pci_unregister_driver(struct acpi_pci_driver *driver);
149
1da177e4
LT
150extern int ec_read(u8 addr, u8 *val);
151extern int ec_write(u8 addr, u8 val);
d7a76e4c
LP
152extern int ec_transaction(u8 command,
153 const u8 *wdata, unsigned wdata_len,
1cb7b1e0 154 u8 *rdata, unsigned rdata_len);
3e2abc5a 155extern acpi_handle ec_get_handle(void);
1da177e4 156
bff431e4
CC
157#if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
158
159typedef void (*wmi_notify_handler) (u32 value, void *context);
160
161extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
162 u32 method_id,
163 const struct acpi_buffer *in,
164 struct acpi_buffer *out);
165extern acpi_status wmi_query_block(const char *guid, u8 instance,
166 struct acpi_buffer *out);
167extern acpi_status wmi_set_block(const char *guid, u8 instance,
168 const struct acpi_buffer *in);
169extern acpi_status wmi_install_notify_handler(const char *guid,
170 wmi_notify_handler handler, void *data);
171extern acpi_status wmi_remove_notify_handler(const char *guid);
172extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
173extern bool wmi_has_guid(const char *guid);
174
175#endif /* CONFIG_ACPI_WMI */
176
c3d6de69
TR
177#define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
178#define ACPI_VIDEO_DEVICE_POSTING 0x0002
179#define ACPI_VIDEO_ROM_AVAILABLE 0x0004
180#define ACPI_VIDEO_BACKLIGHT 0x0008
181#define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
182#define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
183#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
184#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
185#define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
186#define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
187#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
188#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
189
190#if defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE)
191
192extern long acpi_video_get_capabilities(acpi_handle graphics_dev_handle);
193extern long acpi_is_video_device(struct acpi_device *device);
f838eb5b
CC
194extern void acpi_video_dmi_promote_vendor(void);
195extern void acpi_video_dmi_demote_vendor(void);
c3d6de69
TR
196extern int acpi_video_backlight_support(void);
197extern int acpi_video_display_switch_support(void);
198
199#else
200
201static inline long acpi_video_get_capabilities(acpi_handle graphics_dev_handle)
202{
203 return 0;
204}
205
206static inline long acpi_is_video_device(struct acpi_device *device)
207{
208 return 0;
209}
210
f838eb5b
CC
211static inline void acpi_video_dmi_promote_vendor(void)
212{
213}
214
215static inline void acpi_video_dmi_demote_vendor(void)
216{
217}
218
c3d6de69
TR
219static inline int acpi_video_backlight_support(void)
220{
221 return 0;
222}
223
224static inline int acpi_video_display_switch_support(void)
225{
226 return 0;
227}
228
229#endif /* defined(CONFIG_ACPI_VIDEO) || defined(CONFIG_ACPI_VIDEO_MODULE) */
230
1da177e4 231extern int acpi_blacklisted(void);
d4b7dc49 232extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
d90aa92c 233extern void acpi_osi_setup(char *str);
1da177e4 234
1da177e4
LT
235#ifdef CONFIG_ACPI_NUMA
236int acpi_get_pxm(acpi_handle handle);
1e3590e2 237int acpi_get_node(acpi_handle *handle);
1da177e4
LT
238#else
239static inline int acpi_get_pxm(acpi_handle handle)
240{
241 return 0;
242}
1e3590e2
YG
243static inline int acpi_get_node(acpi_handle *handle)
244{
245 return 0;
246}
1da177e4 247#endif
1e3590e2 248extern int acpi_paddr_to_node(u64 start_addr, u64 size);
1da177e4
LT
249
250extern int pnpacpi_disabled;
251
3484d798 252#define PXM_INVAL (-1)
3484d798 253
876fba43 254int acpi_check_resource_conflict(const struct resource *res);
443dea72 255
df92e695
TR
256int acpi_check_region(resource_size_t start, resource_size_t n,
257 const char *name);
df92e695 258
70dd6bea
JD
259int acpi_resources_are_enforced(void);
260
d8f3de0d 261#ifdef CONFIG_PM_SLEEP
bdfe6b7c 262void __init acpi_no_s4_hw_signature(void);
d8f3de0d 263void __init acpi_old_suspend_ordering(void);
72ad5d77 264void __init acpi_nvs_nosave(void);
d8f3de0d 265#endif /* CONFIG_PM_SLEEP */
9f5404d8 266
70023de8
SL
267struct acpi_osc_context {
268 char *uuid_str; /* uuid string */
269 int rev;
270 struct acpi_buffer cap; /* arg2/arg3 */
271 struct acpi_buffer ret; /* free by caller if success */
272};
273
9f5404d8
KK
274#define OSC_QUERY_TYPE 0
275#define OSC_SUPPORT_TYPE 1
276#define OSC_CONTROL_TYPE 2
9f5404d8
KK
277
278/* _OSC DW0 Definition */
279#define OSC_QUERY_ENABLE 1
280#define OSC_REQUEST_ERROR 2
281#define OSC_INVALID_UUID_ERROR 4
282#define OSC_INVALID_REVISION_ERROR 8
283#define OSC_CAPABILITIES_MASK_ERROR 16
284
70023de8
SL
285acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
286
3563ff96
SL
287/* platform-wide _OSC bits */
288#define OSC_SB_PAD_SUPPORT 1
289#define OSC_SB_PPC_OST_SUPPORT 2
290#define OSC_SB_PR3_SUPPORT 4
275c58d7 291#define OSC_SB_HOTPLUG_OST_SUPPORT 8
3563ff96
SL
292#define OSC_SB_APEI_SUPPORT 16
293
eccddd32
HY
294extern bool osc_sb_apei_support_acked;
295
3a9622dc 296/* PCI defined _OSC bits */
9f5404d8
KK
297/* _OSC DW1 Definition (OS Support Fields) */
298#define OSC_EXT_PCI_CONFIG_SUPPORT 1
299#define OSC_ACTIVE_STATE_PWR_SUPPORT 2
300#define OSC_CLOCK_PWR_CAPABILITY_SUPPORT 4
301#define OSC_PCI_SEGMENT_GROUPS_SUPPORT 8
302#define OSC_MSI_SUPPORT 16
3a9622dc 303#define OSC_PCI_SUPPORT_MASKS 0x1f
9f5404d8
KK
304
305/* _OSC DW1 Definition (OS Control Fields) */
306#define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 1
307#define OSC_SHPC_NATIVE_HP_CONTROL 2
308#define OSC_PCI_EXPRESS_PME_CONTROL 4
309#define OSC_PCI_EXPRESS_AER_CONTROL 8
310#define OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL 16
311
3a9622dc 312#define OSC_PCI_CONTROL_MASKS (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL | \
9f5404d8
KK
313 OSC_SHPC_NATIVE_HP_CONTROL | \
314 OSC_PCI_EXPRESS_PME_CONTROL | \
315 OSC_PCI_EXPRESS_AER_CONTROL | \
316 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL)
d90116ea
RW
317
318#define OSC_PCI_NATIVE_HOTPLUG (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL | \
319 OSC_SHPC_NATIVE_HP_CONTROL)
320
75fb60f2
RW
321extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
322 u32 *mask, u32 req);
275c58d7
TK
323
324/* Enable _OST when all relevant hotplug operations are enabled */
325#if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
326 (defined(CONFIG_ACPI_HOTPLUG_MEMORY) || \
327 defined(CONFIG_ACPI_HOTPLUG_MEMORY_MODULE)) && \
328 (defined(CONFIG_ACPI_CONTAINER) || \
329 defined(CONFIG_ACPI_CONTAINER_MODULE))
330#define ACPI_HOTPLUG_OST
331#endif
332
333/* _OST Source Event Code (OSPM Action) */
334#define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
335#define ACPI_OST_EC_OSPM_EJECT 0x103
336#define ACPI_OST_EC_OSPM_INSERTION 0x200
337
338/* _OST General Processing Status Code */
339#define ACPI_OST_SC_SUCCESS 0x0
340#define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
341#define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
342
343/* _OST OS Shutdown Processing (0x100) Status Code */
344#define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
345#define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
346#define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
347#define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
348
349/* _OST Ejection Request (0x3, 0x103) Status Code */
350#define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
351#define ACPI_OST_SC_DEVICE_IN_USE 0x81
352#define ACPI_OST_SC_DEVICE_BUSY 0x82
353#define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
354#define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
355
356/* _OST Insertion Request (0x200) Status Code */
357#define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
358#define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
359#define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
360
4a7a16dc
LB
361extern void acpi_early_init(void);
362
b54ac6d2
HY
363extern int acpi_nvs_register(__u64 start, __u64 size);
364
365extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
366 void *data);
367
cf761af9
MW
368const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
369 const struct device *dev);
370
371static inline bool acpi_driver_match_device(struct device *dev,
372 const struct device_driver *drv)
373{
374 return !!acpi_match_device(drv->acpi_match_table, dev);
375}
376
377#define ACPI_PTR(_ptr) (_ptr)
378
e55a5999
FT
379#else /* !CONFIG_ACPI */
380
381#define acpi_disabled 1
382
4a7a16dc 383static inline void acpi_early_init(void) { }
53de49f5 384
cbf9bd60
YL
385static inline int early_acpi_boot_init(void)
386{
387 return 0;
388}
53de49f5
AM
389static inline int acpi_boot_init(void)
390{
391 return 0;
392}
393
8558e394 394static inline void acpi_boot_table_init(void)
53de49f5 395{
8558e394 396 return;
53de49f5
AM
397}
398
3c999f14
YL
399static inline int acpi_mps_check(void)
400{
401 return 0;
402}
403
443dea72
TR
404static inline int acpi_check_resource_conflict(struct resource *res)
405{
406 return 0;
407}
408
df92e695
TR
409static inline int acpi_check_region(resource_size_t start, resource_size_t n,
410 const char *name)
411{
412 return 0;
413}
414
e55a5999
FT
415struct acpi_table_header;
416static inline int acpi_table_parse(char *id,
417 int (*handler)(struct acpi_table_header *))
418{
419 return -1;
420}
6fed05c9 421
b54ac6d2 422static inline int acpi_nvs_register(__u64 start, __u64 size)
6fed05c9
RW
423{
424 return 0;
425}
b54ac6d2
HY
426
427static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
428 void *data)
429{
430 return 0;
431}
432
cf761af9
MW
433struct acpi_device_id;
434
435static inline const struct acpi_device_id *acpi_match_device(
436 const struct acpi_device_id *ids, const struct device *dev)
437{
438 return NULL;
439}
440
441static inline bool acpi_driver_match_device(struct device *dev,
442 const struct device_driver *drv)
443{
444 return false;
445}
446
447#define ACPI_PTR(_ptr) (NULL)
448
b54ac6d2 449#endif /* !CONFIG_ACPI */
6fed05c9 450
09f98a82
TL
451#ifdef CONFIG_ACPI
452void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
453 u32 pm1a_ctrl, u32 pm1b_ctrl));
454
455acpi_status acpi_os_prepare_sleep(u8 sleep_state,
456 u32 pm1a_control, u32 pm1b_control);
457#else
458#define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
459#endif
460
25be5e6c 461#endif /*_LINUX_ACPI_H*/