ACPI / processor_idle: Add support for Low Power Idle(LPI) states
[linux-2.6-block.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 *
1da177e4
LT
18 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19 */
20
21#ifndef _LINUX_ACPI_H
22#define _LINUX_ACPI_H
23
5133375b 24#include <linux/errno.h>
443dea72 25#include <linux/ioport.h> /* for struct resource */
90e97820 26#include <linux/resource_ext.h>
cf761af9 27#include <linux/device.h>
b31384fa 28#include <linux/property.h>
3f5948fa 29
1da177e4
LT
30#ifndef _LINUX
31#define _LINUX
32#endif
633adaba
LZ
33#include <acpi/acpi.h>
34
35#ifdef CONFIG_ACPI
1da177e4
LT
36
37#include <linux/list.h>
29b71a1c 38#include <linux/mod_devicetable.h>
45fef5b8 39#include <linux/dynamic_debug.h>
836d0830
LZ
40#include <linux/module.h>
41#include <linux/mutex.h>
1da177e4 42
1da177e4
LT
43#include <acpi/acpi_bus.h>
44#include <acpi/acpi_drivers.h>
762834e8 45#include <acpi/acpi_numa.h>
27d50c82 46#include <acpi/acpi_io.h>
1da177e4 47#include <asm/acpi.h>
1da177e4 48
7b199811
RW
49static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
50{
51 return adev ? adev->handle : NULL;
52}
53
3a7a2ab8 54#define ACPI_COMPANION(dev) to_acpi_device_node((dev)->fwnode)
97badf87
RW
55#define ACPI_COMPANION_SET(dev, adev) set_primary_fwnode(dev, (adev) ? \
56 acpi_fwnode_handle(adev) : NULL)
7b199811
RW
57#define ACPI_HANDLE(dev) acpi_device_handle(ACPI_COMPANION(dev))
58
26095a01
SS
59/**
60 * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
61 * the PCI-defined class-code information
62 *
63 * @_cls : the class, subclass, prog-if triple for this device
64 * @_msk : the class mask for this device
65 *
66 * This macro is used to create a struct acpi_device_id that matches a
67 * specific PCI class. The .id and .driver_data fields will be left
68 * initialized with the default value.
69 */
70#define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (_cls), .cls_msk = (_msk),
71
ca5b74d2
RW
72static inline bool has_acpi_companion(struct device *dev)
73{
3a7a2ab8 74 return is_acpi_device_node(dev->fwnode);
ca5b74d2
RW
75}
76
9c5ad36d
RW
77static inline void acpi_preset_companion(struct device *dev,
78 struct acpi_device *parent, u64 addr)
79{
80 ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
81}
82
45c42a7f
JN
83static inline const char *acpi_dev_name(struct acpi_device *adev)
84{
85 return dev_name(&adev->dev);
86}
87
1da177e4
LT
88enum acpi_irq_model_id {
89 ACPI_IRQ_MODEL_PIC = 0,
90 ACPI_IRQ_MODEL_IOAPIC,
91 ACPI_IRQ_MODEL_IOSAPIC,
3948ec94 92 ACPI_IRQ_MODEL_PLATFORM,
fbe61ec7 93 ACPI_IRQ_MODEL_GIC,
1da177e4
LT
94 ACPI_IRQ_MODEL_COUNT
95};
96
97extern enum acpi_irq_model_id acpi_irq_model;
98
1da177e4
LT
99enum acpi_interrupt_id {
100 ACPI_INTERRUPT_PMI = 1,
101 ACPI_INTERRUPT_INIT,
102 ACPI_INTERRUPT_CPEI,
103 ACPI_INTERRUPT_COUNT
104};
105
106#define ACPI_SPACE_MEM 0
107
1da177e4
LT
108enum acpi_address_range_id {
109 ACPI_ADDRESS_RANGE_MEMORY = 1,
110 ACPI_ADDRESS_RANGE_RESERVED = 2,
111 ACPI_ADDRESS_RANGE_ACPI = 3,
112 ACPI_ADDRESS_RANGE_NVS = 4,
113 ACPI_ADDRESS_RANGE_COUNT
114};
115
1da177e4 116
1da177e4
LT
117/* Table Handlers */
118
b43e1065 119typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
1da177e4 120
b43e1065
LZ
121typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
122 const unsigned long end);
1da177e4 123
836d0830
LZ
124/* Debugger support */
125
126struct acpi_debugger_ops {
127 int (*create_thread)(acpi_osd_exec_callback function, void *context);
128 ssize_t (*write_log)(const char *msg);
129 ssize_t (*read_cmd)(char *buffer, size_t length);
130 int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
131 int (*notify_command_complete)(void);
132};
133
134struct acpi_debugger {
135 const struct acpi_debugger_ops *ops;
136 struct module *owner;
137 struct mutex lock;
138};
139
140#ifdef CONFIG_ACPI_DEBUGGER
141int __init acpi_debugger_init(void);
142int acpi_register_debugger(struct module *owner,
143 const struct acpi_debugger_ops *ops);
144void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
145int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
146ssize_t acpi_debugger_write_log(const char *msg);
147ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
148int acpi_debugger_wait_command_ready(void);
149int acpi_debugger_notify_command_complete(void);
150#else
151static inline int acpi_debugger_init(void)
152{
153 return -ENODEV;
154}
155
156static inline int acpi_register_debugger(struct module *owner,
157 const struct acpi_debugger_ops *ops)
158{
159 return -ENODEV;
160}
161
162static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
163{
164}
165
166static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
167 void *context)
168{
169 return -ENODEV;
170}
171
172static inline int acpi_debugger_write_log(const char *msg)
173{
174 return -ENODEV;
175}
176
177static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
178{
179 return -ENODEV;
180}
181
182static inline int acpi_debugger_wait_command_ready(void)
183{
184 return -ENODEV;
185}
186
187static inline int acpi_debugger_notify_command_complete(void)
188{
189 return -ENODEV;
190}
191#endif
192
328281b1
HG
193#define BAD_MADT_ENTRY(entry, end) ( \
194 (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
195 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
196
9b3fedde
LA
197struct acpi_subtable_proc {
198 int id;
199 acpi_tbl_entry_handler handler;
200 int count;
201};
202
1da177e4 203char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
970ec1a8 204void __acpi_unmap_table(char *map, unsigned long size);
cbf9bd60 205int early_acpi_boot_init(void);
1da177e4 206int acpi_boot_init (void);
8558e394 207void acpi_boot_table_init (void);
3c999f14 208int acpi_mps_check (void);
1da177e4
LT
209int acpi_numa_init (void);
210
5ae74f2c 211void early_acpi_table_init(void *data, size_t size);
1da177e4 212int acpi_table_init (void);
b43e1065 213int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
f08bb472
AC
214int __init acpi_parse_entries(char *id, unsigned long table_size,
215 acpi_tbl_entry_handler handler,
216 struct acpi_table_header *table_header,
217 int entry_id, unsigned int max_entries);
6eb87fed 218int __init acpi_table_parse_entries(char *id, unsigned long table_size,
9b3fedde
LA
219 int entry_id,
220 acpi_tbl_entry_handler handler,
221 unsigned int max_entries);
222int __init acpi_table_parse_entries(char *id, unsigned long table_size,
223 int entry_id,
224 acpi_tbl_entry_handler handler,
225 unsigned int max_entries);
226int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
227 struct acpi_subtable_proc *proc, int proc_num,
228 unsigned int max_entries);
b43e1065
LZ
229int acpi_table_parse_madt(enum acpi_madt_type id,
230 acpi_tbl_entry_handler handler,
231 unsigned int max_entries);
ceb6c468 232int acpi_parse_mcfg (struct acpi_table_header *header);
5f3b1a8b 233void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
1da177e4
LT
234
235/* the following four functions are architecture-dependent */
236void acpi_numa_slit_init (struct acpi_table_slit *slit);
15a58ed1 237void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
7237d3de 238void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
095adbb6 239int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
1da177e4
LT
240void acpi_numa_arch_fixup(void);
241
828aef37
CM
242#ifndef PHYS_CPUID_INVALID
243typedef u32 phys_cpuid_t;
244#define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
245#endif
246
25956b66
HG
247static inline bool invalid_logical_cpuid(u32 cpuid)
248{
249 return (int)cpuid < 0;
250}
251
ddcc18f5
HG
252static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
253{
254 return phys_id == PHYS_CPUID_INVALID;
255}
256
1da177e4
LT
257#ifdef CONFIG_ACPI_HOTPLUG_CPU
258/* Arch dependent functions for cpu hotplug support */
828aef37 259int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, int *pcpu);
d02dc27d 260int acpi_unmap_cpu(int cpu);
1da177e4
LT
261#endif /* CONFIG_ACPI_HOTPLUG_CPU */
262
ecf5636d
YL
263#ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
264int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
265#endif
266
b1bb248a
KK
267int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
268int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
e89900c9 269int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
5229e87d 270void acpi_irq_stats_init(void);
5229e87d 271extern u32 acpi_irq_handled;
88bea188 272extern u32 acpi_irq_not_handled;
49e4b843 273extern unsigned int acpi_sci_irq;
13737181 274extern bool acpi_no_s5;
49e4b843
CY
275#define INVALID_ACPI_IRQ ((unsigned)-1)
276static inline bool acpi_sci_irq_valid(void)
277{
278 return acpi_sci_irq != INVALID_ACPI_IRQ;
279}
1da177e4 280
c255d844 281extern int sbf_port;
77afcf78 282extern unsigned long acpi_realmode_flags;
1da177e4 283
a2f809b0 284int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
1da177e4 285int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
2c2df841 286int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
1da177e4 287
2bc6eba4
MZ
288void acpi_set_irq_model(enum acpi_irq_model_id model,
289 struct fwnode_handle *fwnode);
290
61fd47e0 291#ifdef CONFIG_X86_IO_APIC
9a0a91bb 292extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
61fd47e0 293#else
9a0a91bb 294#define acpi_get_override_irq(gsi, trigger, polarity) (-1)
61fd47e0 295#endif
1da177e4
LT
296/*
297 * This function undoes the effect of one call to acpi_register_gsi().
298 * If this matches the last registration, any IRQ resources for gsi
299 * are freed.
300 */
1da177e4 301void acpi_unregister_gsi (u32 gsi);
1da177e4 302
1da177e4
LT
303struct pci_dev;
304
305int acpi_pci_irq_enable (struct pci_dev *dev);
c9c3e457 306void acpi_penalize_isa_irq(int irq, int active);
5ebc7603 307bool acpi_isa_irq_available(int irq);
1da177e4 308void acpi_pci_irq_disable (struct pci_dev *dev);
1da177e4 309
1da177e4
LT
310extern int ec_read(u8 addr, u8 *val);
311extern int ec_write(u8 addr, u8 val);
d7a76e4c
LP
312extern int ec_transaction(u8 command,
313 const u8 *wdata, unsigned wdata_len,
1cb7b1e0 314 u8 *rdata, unsigned rdata_len);
3e2abc5a 315extern acpi_handle ec_get_handle(void);
1da177e4 316
eec15edb
ZR
317extern bool acpi_is_pnp_device(struct acpi_device *);
318
bff431e4
CC
319#if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
320
321typedef void (*wmi_notify_handler) (u32 value, void *context);
322
323extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
324 u32 method_id,
325 const struct acpi_buffer *in,
326 struct acpi_buffer *out);
327extern acpi_status wmi_query_block(const char *guid, u8 instance,
328 struct acpi_buffer *out);
329extern acpi_status wmi_set_block(const char *guid, u8 instance,
330 const struct acpi_buffer *in);
331extern acpi_status wmi_install_notify_handler(const char *guid,
332 wmi_notify_handler handler, void *data);
333extern acpi_status wmi_remove_notify_handler(const char *guid);
334extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
335extern bool wmi_has_guid(const char *guid);
336
337#endif /* CONFIG_ACPI_WMI */
338
c3d6de69
TR
339#define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
340#define ACPI_VIDEO_DEVICE_POSTING 0x0002
341#define ACPI_VIDEO_ROM_AVAILABLE 0x0004
342#define ACPI_VIDEO_BACKLIGHT 0x0008
343#define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
344#define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
345#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
346#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
347#define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
348#define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
349#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
350#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
351
14ca7a47 352extern char acpi_video_backlight_string[];
d4e1a692 353extern long acpi_is_video_device(acpi_handle handle);
1da177e4 354extern int acpi_blacklisted(void);
d90aa92c 355extern void acpi_osi_setup(char *str);
a87878ba 356extern bool acpi_osi_is_win8(void);
1da177e4 357
1da177e4 358#ifdef CONFIG_ACPI_NUMA
99759869 359int acpi_map_pxm_to_online_node(int pxm);
486c79b5 360int acpi_get_node(acpi_handle handle);
1da177e4 361#else
99759869
TK
362static inline int acpi_map_pxm_to_online_node(int pxm)
363{
364 return 0;
365}
486c79b5 366static inline int acpi_get_node(acpi_handle handle)
1e3590e2
YG
367{
368 return 0;
369}
1da177e4 370#endif
1e3590e2 371extern int acpi_paddr_to_node(u64 start_addr, u64 size);
1da177e4
LT
372
373extern int pnpacpi_disabled;
374
3484d798 375#define PXM_INVAL (-1)
3484d798 376
046d9ce6
RW
377bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
378bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
379bool acpi_dev_resource_address_space(struct acpi_resource *ares,
a49170b5 380 struct resource_win *win);
046d9ce6 381bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
a49170b5 382 struct resource_win *win);
046d9ce6 383unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
55a93417 384unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
046d9ce6
RW
385bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
386 struct resource *res);
387
8e345c99
RW
388void acpi_dev_free_resource_list(struct list_head *list);
389int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
390 int (*preproc)(struct acpi_resource *, void *),
391 void *preproc_data);
62d1141f
JL
392int acpi_dev_filter_resource_type(struct acpi_resource *ares,
393 unsigned long types);
394
395static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
396 void *arg)
397{
398 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
399}
8e345c99 400
876fba43 401int acpi_check_resource_conflict(const struct resource *res);
443dea72 402
df92e695
TR
403int acpi_check_region(resource_size_t start, resource_size_t n,
404 const char *name);
df92e695 405
70dd6bea
JD
406int acpi_resources_are_enforced(void);
407
9743fdea 408#ifdef CONFIG_HIBERNATION
bdfe6b7c 409void __init acpi_no_s4_hw_signature(void);
9743fdea
YL
410#endif
411
412#ifdef CONFIG_PM_SLEEP
d8f3de0d 413void __init acpi_old_suspend_ordering(void);
72ad5d77 414void __init acpi_nvs_nosave(void);
1bad2f19 415void __init acpi_nvs_nosave_s3(void);
d8f3de0d 416#endif /* CONFIG_PM_SLEEP */
9f5404d8 417
70023de8 418struct acpi_osc_context {
c8678473 419 char *uuid_str; /* UUID string */
70023de8 420 int rev;
c8678473
BH
421 struct acpi_buffer cap; /* list of DWORD capabilities */
422 struct acpi_buffer ret; /* free by caller if success */
70023de8
SL
423};
424
4b3db708 425acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
70023de8
SL
426acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
427
b938a229
BH
428/* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
429#define OSC_QUERY_DWORD 0 /* DWORD 1 */
430#define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
431#define OSC_CONTROL_DWORD 2 /* DWORD 3 */
9f5404d8 432
dedf1e4d
BH
433/* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
434#define OSC_QUERY_ENABLE 0x00000001 /* input */
435#define OSC_REQUEST_ERROR 0x00000002 /* return */
436#define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
437#define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
438#define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
9f5404d8 439
dedf1e4d
BH
440/* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
441#define OSC_SB_PAD_SUPPORT 0x00000001
442#define OSC_SB_PPC_OST_SUPPORT 0x00000002
443#define OSC_SB_PR3_SUPPORT 0x00000004
444#define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
445#define OSC_SB_APEI_SUPPORT 0x00000010
446#define OSC_SB_CPC_SUPPORT 0x00000020
a36a7fec
SH
447#define OSC_SB_CPCV2_SUPPORT 0x00000040
448#define OSC_SB_PCLPI_SUPPORT 0x00000080
449#define OSC_SB_OSLPI_SUPPORT 0x00000100
3563ff96 450
eccddd32 451extern bool osc_sb_apei_support_acked;
a36a7fec 452extern bool osc_pc_lpi_support_confirmed;
eccddd32 453
dedf1e4d 454/* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
7dab9ef4
BH
455#define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
456#define OSC_PCI_ASPM_SUPPORT 0x00000002
457#define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
dedf1e4d 458#define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
7dab9ef4 459#define OSC_PCI_MSI_SUPPORT 0x00000010
dedf1e4d
BH
460#define OSC_PCI_SUPPORT_MASKS 0x0000001f
461
462/* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
463#define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
7dab9ef4 464#define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
dedf1e4d
BH
465#define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
466#define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
7dab9ef4 467#define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
335b1509 468#define OSC_PCI_CONTROL_MASKS 0x0000001f
d90116ea 469
5d98e61d
LT
470#define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
471#define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
472#define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
473#define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
474#define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
475#define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
476#define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
477#define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
478#define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
479#define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
480
75fb60f2
RW
481extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
482 u32 *mask, u32 req);
275c58d7
TK
483
484/* Enable _OST when all relevant hotplug operations are enabled */
485#if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
08f502c1 486 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
64fd7401 487 defined(CONFIG_ACPI_CONTAINER)
275c58d7
TK
488#define ACPI_HOTPLUG_OST
489#endif
490
491/* _OST Source Event Code (OSPM Action) */
492#define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
493#define ACPI_OST_EC_OSPM_EJECT 0x103
494#define ACPI_OST_EC_OSPM_INSERTION 0x200
495
496/* _OST General Processing Status Code */
497#define ACPI_OST_SC_SUCCESS 0x0
498#define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
499#define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
500
501/* _OST OS Shutdown Processing (0x100) Status Code */
502#define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
503#define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
504#define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
505#define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
506
507/* _OST Ejection Request (0x3, 0x103) Status Code */
508#define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
509#define ACPI_OST_SC_DEVICE_IN_USE 0x81
510#define ACPI_OST_SC_DEVICE_BUSY 0x82
511#define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
512#define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
513
514/* _OST Insertion Request (0x200) Status Code */
515#define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
516#define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
517#define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
518
4a7a16dc 519extern void acpi_early_init(void);
b064a8fa 520extern void acpi_subsystem_init(void);
4a7a16dc 521
b54ac6d2
HY
522extern int acpi_nvs_register(__u64 start, __u64 size);
523
524extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
525 void *data);
526
cf761af9
MW
527const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
528 const struct device *dev);
529
733e6251
MW
530extern bool acpi_driver_match_device(struct device *dev,
531 const struct device_driver *drv);
6eb2451f
ZR
532int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
533int acpi_device_modalias(struct device *, char *, int);
40e7fcb1 534void acpi_walk_dep_device_list(acpi_handle handle);
6eb2451f 535
083bf668 536struct platform_device *acpi_create_platform_device(struct acpi_device *);
cf761af9
MW
537#define ACPI_PTR(_ptr) (_ptr)
538
e55a5999
FT
539#else /* !CONFIG_ACPI */
540
541#define acpi_disabled 1
542
7b199811
RW
543#define ACPI_COMPANION(dev) (NULL)
544#define ACPI_COMPANION_SET(dev, adev) do { } while (0)
545#define ACPI_HANDLE(dev) (NULL)
26095a01 546#define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
7b199811 547
8a0662d9
RW
548struct fwnode_handle;
549
550static inline bool is_acpi_node(struct fwnode_handle *fwnode)
551{
552 return false;
553}
554
3a7a2ab8
RW
555static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
556{
557 return false;
558}
559
560static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
561{
562 return NULL;
563}
564
565static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
566{
567 return false;
568}
569
570static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
8a0662d9
RW
571{
572 return NULL;
573}
574
575static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
576{
577 return NULL;
578}
579
ca5b74d2
RW
580static inline bool has_acpi_companion(struct device *dev)
581{
582 return false;
583}
584
c0e5c445
DB
585static inline void acpi_preset_companion(struct device *dev,
586 struct acpi_device *parent, u64 addr)
587{
588}
589
45c42a7f
JN
590static inline const char *acpi_dev_name(struct acpi_device *adev)
591{
592 return NULL;
593}
594
5ae74f2c 595static inline void early_acpi_table_init(void *data, size_t size) { }
4a7a16dc 596static inline void acpi_early_init(void) { }
b064a8fa 597static inline void acpi_subsystem_init(void) { }
53de49f5 598
cbf9bd60
YL
599static inline int early_acpi_boot_init(void)
600{
601 return 0;
602}
53de49f5
AM
603static inline int acpi_boot_init(void)
604{
605 return 0;
606}
607
8558e394 608static inline void acpi_boot_table_init(void)
53de49f5 609{
8558e394 610 return;
53de49f5
AM
611}
612
3c999f14
YL
613static inline int acpi_mps_check(void)
614{
615 return 0;
616}
617
443dea72
TR
618static inline int acpi_check_resource_conflict(struct resource *res)
619{
620 return 0;
621}
622
df92e695
TR
623static inline int acpi_check_region(resource_size_t start, resource_size_t n,
624 const char *name)
625{
626 return 0;
627}
628
e55a5999
FT
629struct acpi_table_header;
630static inline int acpi_table_parse(char *id,
631 int (*handler)(struct acpi_table_header *))
632{
f8a571b2 633 return -ENODEV;
e55a5999 634}
6fed05c9 635
b54ac6d2 636static inline int acpi_nvs_register(__u64 start, __u64 size)
6fed05c9
RW
637{
638 return 0;
639}
b54ac6d2
HY
640
641static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
642 void *data)
643{
644 return 0;
645}
646
cf761af9
MW
647struct acpi_device_id;
648
649static inline const struct acpi_device_id *acpi_match_device(
650 const struct acpi_device_id *ids, const struct device *dev)
651{
652 return NULL;
653}
654
655static inline bool acpi_driver_match_device(struct device *dev,
656 const struct device_driver *drv)
657{
658 return false;
659}
660
6eb2451f
ZR
661static inline int acpi_device_uevent_modalias(struct device *dev,
662 struct kobj_uevent_env *env)
663{
664 return -ENODEV;
665}
666
667static inline int acpi_device_modalias(struct device *dev,
668 char *buf, int size)
669{
670 return -ENODEV;
671}
672
b84f196d 673static inline bool acpi_dma_supported(struct acpi_device *adev)
d0562674
SS
674{
675 return false;
676}
677
b84f196d
SS
678static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
679{
680 return DEV_DMA_NOT_SUPPORTED;
681}
682
cf761af9
MW
683#define ACPI_PTR(_ptr) (NULL)
684
b54ac6d2 685#endif /* !CONFIG_ACPI */
6fed05c9 686
09f98a82
TL
687#ifdef CONFIG_ACPI
688void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
689 u32 pm1a_ctrl, u32 pm1b_ctrl));
690
691acpi_status acpi_os_prepare_sleep(u8 sleep_state,
692 u32 pm1a_control, u32 pm1b_control);
d6b47b12
BG
693
694void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
695 u32 val_a, u32 val_b));
696
697acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
698 u32 val_a, u32 val_b);
699
385ddeac 700#ifdef CONFIG_X86
8e30524d
TR
701void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
702#else
703static inline void arch_reserve_mem_area(acpi_physical_address addr,
704 size_t size)
705{
706}
707#endif /* CONFIG_X86 */
09f98a82
TL
708#else
709#define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
710#endif
711
5de21bb9 712#if defined(CONFIG_ACPI) && defined(CONFIG_PM)
e5cc8ef3
RW
713int acpi_dev_runtime_suspend(struct device *dev);
714int acpi_dev_runtime_resume(struct device *dev);
715int acpi_subsys_runtime_suspend(struct device *dev);
716int acpi_subsys_runtime_resume(struct device *dev);
5de21bb9
RW
717struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
718int acpi_dev_pm_attach(struct device *dev, bool power_on);
e5cc8ef3
RW
719#else
720static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
721static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
722static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
723static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
5de21bb9
RW
724static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
725{
726 return NULL;
727}
728static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
729{
730 return -ENODEV;
731}
e5cc8ef3
RW
732#endif
733
d79beb39 734#if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
e5cc8ef3
RW
735int acpi_dev_suspend_late(struct device *dev);
736int acpi_dev_resume_early(struct device *dev);
737int acpi_subsys_prepare(struct device *dev);
4cf563c5 738void acpi_subsys_complete(struct device *dev);
e5cc8ef3
RW
739int acpi_subsys_suspend_late(struct device *dev);
740int acpi_subsys_resume_early(struct device *dev);
4cf563c5
HK
741int acpi_subsys_suspend(struct device *dev);
742int acpi_subsys_freeze(struct device *dev);
e5cc8ef3
RW
743#else
744static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
745static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
746static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
4cf563c5 747static inline void acpi_subsys_complete(struct device *dev) {}
e5cc8ef3
RW
748static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
749static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
4cf563c5
HK
750static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
751static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
e5cc8ef3
RW
752#endif
753
fbfddae6
TK
754#ifdef CONFIG_ACPI
755__printf(3, 4)
756void acpi_handle_printk(const char *level, acpi_handle handle,
757 const char *fmt, ...);
758#else /* !CONFIG_ACPI */
759static inline __printf(3, 4) void
760acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
761#endif /* !CONFIG_ACPI */
762
45fef5b8
BM
763#if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
764__printf(3, 4)
765void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
766#else
767#define __acpi_handle_debug(descriptor, handle, fmt, ...) \
768 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
769#endif
770
fbfddae6
TK
771/*
772 * acpi_handle_<level>: Print message with ACPI prefix and object path
773 *
774 * These interfaces acquire the global namespace mutex to obtain an object
775 * path. In interrupt context, it shows the object path as <n/a>.
776 */
777#define acpi_handle_emerg(handle, fmt, ...) \
778 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
779#define acpi_handle_alert(handle, fmt, ...) \
780 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
781#define acpi_handle_crit(handle, fmt, ...) \
782 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
783#define acpi_handle_err(handle, fmt, ...) \
784 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
785#define acpi_handle_warn(handle, fmt, ...) \
786 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
787#define acpi_handle_notice(handle, fmt, ...) \
788 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
789#define acpi_handle_info(handle, fmt, ...) \
790 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
791
45fef5b8 792#if defined(DEBUG)
fbfddae6
TK
793#define acpi_handle_debug(handle, fmt, ...) \
794 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
795#else
45fef5b8
BM
796#if defined(CONFIG_DYNAMIC_DEBUG)
797#define acpi_handle_debug(handle, fmt, ...) \
798do { \
799 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
800 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
801 __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt), \
802 ##__VA_ARGS__); \
803} while (0)
804#else
fbfddae6
TK
805#define acpi_handle_debug(handle, fmt, ...) \
806({ \
807 if (0) \
808 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
809 0; \
810})
811#endif
45fef5b8 812#endif
fbfddae6 813
f028d524
RW
814struct acpi_gpio_params {
815 unsigned int crs_entry_index;
816 unsigned int line_index;
817 bool active_low;
818};
819
820struct acpi_gpio_mapping {
821 const char *name;
822 const struct acpi_gpio_params *data;
823 unsigned int size;
824};
825
826#if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
827int acpi_dev_add_driver_gpios(struct acpi_device *adev,
828 const struct acpi_gpio_mapping *gpios);
829
830static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
831{
832 if (adev)
833 adev->driver_gpios = NULL;
834}
c884fbd4
MW
835
836int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
f028d524
RW
837#else
838static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
839 const struct acpi_gpio_mapping *gpios)
840{
841 return -ENXIO;
842}
843static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
c884fbd4
MW
844
845static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
846{
847 return -ENXIO;
848}
f028d524
RW
849#endif
850
ffdcd955
MW
851/* Device properties */
852
853#define MAX_ACPI_REFERENCE_ARGS 8
854struct acpi_reference_args {
855 struct acpi_device *adev;
856 size_t nargs;
857 u64 args[MAX_ACPI_REFERENCE_ARGS];
858};
859
860#ifdef CONFIG_ACPI
861int acpi_dev_get_property(struct acpi_device *adev, const char *name,
862 acpi_object_type type, const union acpi_object **obj);
504a3374
RW
863int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
864 const char *name, size_t index,
865 struct acpi_reference_args *args);
b31384fa 866
3a7a2ab8
RW
867int acpi_node_prop_get(struct fwnode_handle *fwnode, const char *propname,
868 void **valptr);
b31384fa
RW
869int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
870 enum dev_prop_type proptype, void *val);
3a7a2ab8
RW
871int acpi_node_prop_read(struct fwnode_handle *fwnode, const char *propname,
872 enum dev_prop_type proptype, void *val, size_t nval);
b31384fa
RW
873int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
874 enum dev_prop_type proptype, void *val, size_t nval);
8a0662d9 875
504a3374
RW
876struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
877 struct fwnode_handle *subnode);
e647b532
MZ
878
879struct acpi_probe_entry;
880typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
881 struct acpi_probe_entry *);
882
883#define ACPI_TABLE_ID_LEN 5
884
885/**
886 * struct acpi_probe_entry - boot-time probing entry
887 * @id: ACPI table name
888 * @type: Optional subtable type to match
889 * (if @id contains subtables)
890 * @subtable_valid: Optional callback to check the validity of
891 * the subtable
892 * @probe_table: Callback to the driver being probed when table
893 * match is successful
894 * @probe_subtbl: Callback to the driver being probed when table and
895 * subtable match (and optional callback is successful)
896 * @driver_data: Sideband data provided back to the driver
897 */
898struct acpi_probe_entry {
899 __u8 id[ACPI_TABLE_ID_LEN];
900 __u8 type;
901 acpi_probe_entry_validate_subtbl subtable_valid;
902 union {
903 acpi_tbl_table_handler probe_table;
904 acpi_tbl_entry_handler probe_subtbl;
905 };
906 kernel_ulong_t driver_data;
907};
908
909#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
910 static const struct acpi_probe_entry __acpi_probe_##name \
911 __used __section(__##table##_acpi_probe_table) \
912 = { \
913 .id = table_id, \
914 .type = subtable, \
915 .subtable_valid = valid, \
916 .probe_table = (acpi_tbl_table_handler)fn, \
917 .driver_data = data, \
918 }
919
920#define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
921#define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
922
923int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
924
925#define acpi_probe_device_table(t) \
926 ({ \
927 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
928 ACPI_PROBE_TABLE_END(t); \
929 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
930 (&ACPI_PROBE_TABLE_END(t) - \
931 &ACPI_PROBE_TABLE(t))); \
932 })
ffdcd955
MW
933#else
934static inline int acpi_dev_get_property(struct acpi_device *adev,
935 const char *name, acpi_object_type type,
936 const union acpi_object **obj)
937{
938 return -ENXIO;
939}
3a7a2ab8 940
504a3374 941static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
64031e3e
HG
942 const char *name, size_t index,
943 struct acpi_reference_args *args)
ffdcd955
MW
944{
945 return -ENXIO;
946}
b31384fa 947
3a7a2ab8
RW
948static inline int acpi_node_prop_get(struct fwnode_handle *fwnode,
949 const char *propname,
950 void **valptr)
ffdcd955
MW
951{
952 return -ENXIO;
953}
b31384fa
RW
954
955static inline int acpi_dev_prop_get(struct acpi_device *adev,
956 const char *propname,
957 void **valptr)
958{
959 return -ENXIO;
960}
961
962static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
963 const char *propname,
964 enum dev_prop_type proptype,
965 void *val)
966{
967 return -ENXIO;
968}
969
3a7a2ab8
RW
970static inline int acpi_node_prop_read(struct fwnode_handle *fwnode,
971 const char *propname,
972 enum dev_prop_type proptype,
973 void *val, size_t nval)
974{
975 return -ENXIO;
976}
977
b31384fa
RW
978static inline int acpi_dev_prop_read(struct acpi_device *adev,
979 const char *propname,
980 enum dev_prop_type proptype,
981 void *val, size_t nval)
982{
983 return -ENXIO;
984}
985
504a3374
RW
986static inline struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
987 struct fwnode_handle *subnode)
8a0662d9
RW
988{
989 return NULL;
990}
991
e647b532
MZ
992#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, validate, data, fn) \
993 static const void * __acpi_table_##name[] \
994 __attribute__((unused)) \
995 = { (void *) table_id, \
996 (void *) subtable, \
997 (void *) valid, \
998 (void *) fn, \
999 (void *) data }
1000
1001#define acpi_probe_device_table(t) ({ int __r = 0; __r;})
ffdcd955
MW
1002#endif
1003
25be5e6c 1004#endif /*_LINUX_ACPI_H*/