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