Linux 5.16-rc1
[linux-block.git] / include / linux / acpi.h
CommitLineData
c942fddf 1/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4
LT
2/*
3 * acpi.h - ACPI Interface
4 *
5 * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
1da177e4
LT
6 */
7
8#ifndef _LINUX_ACPI_H
9#define _LINUX_ACPI_H
10
5133375b 11#include <linux/errno.h>
443dea72 12#include <linux/ioport.h> /* for struct resource */
621dc2fd 13#include <linux/irqdomain.h>
90e97820 14#include <linux/resource_ext.h>
cf761af9 15#include <linux/device.h>
b31384fa 16#include <linux/property.h>
bcbc2265 17#include <linux/uuid.h>
3f5948fa 18
1da177e4
LT
19#ifndef _LINUX
20#define _LINUX
21#endif
633adaba
LZ
22#include <acpi/acpi.h>
23
24#ifdef CONFIG_ACPI
1da177e4
LT
25
26#include <linux/list.h>
29b71a1c 27#include <linux/mod_devicetable.h>
45fef5b8 28#include <linux/dynamic_debug.h>
836d0830
LZ
29#include <linux/module.h>
30#include <linux/mutex.h>
1da177e4 31
1da177e4
LT
32#include <acpi/acpi_bus.h>
33#include <acpi/acpi_drivers.h>
762834e8 34#include <acpi/acpi_numa.h>
27d50c82 35#include <acpi/acpi_io.h>
1da177e4 36#include <asm/acpi.h>
1da177e4 37
7b199811
RW
38static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
39{
40 return adev ? adev->handle : NULL;
41}
42
3a7a2ab8 43#define ACPI_COMPANION(dev) to_acpi_device_node((dev)->fwnode)
97badf87
RW
44#define ACPI_COMPANION_SET(dev, adev) set_primary_fwnode(dev, (adev) ? \
45 acpi_fwnode_handle(adev) : NULL)
7b199811 46#define ACPI_HANDLE(dev) acpi_device_handle(ACPI_COMPANION(dev))
7c6c57f2
MW
47#define ACPI_HANDLE_FWNODE(fwnode) \
48 acpi_device_handle(to_acpi_device_node(fwnode))
7b199811 49
027b25b2
LP
50static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
51{
52 struct fwnode_handle *fwnode;
53
54 fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
55 if (!fwnode)
56 return NULL;
57
2ab695aa 58 fwnode_init(fwnode, &acpi_static_fwnode_ops);
027b25b2
LP
59
60 return fwnode;
61}
62
63static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
64{
db3e50f3 65 if (WARN_ON(!is_acpi_static_node(fwnode)))
027b25b2
LP
66 return;
67
68 kfree(fwnode);
69}
70
26095a01
SS
71/**
72 * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
73 * the PCI-defined class-code information
74 *
75 * @_cls : the class, subclass, prog-if triple for this device
76 * @_msk : the class mask for this device
77 *
78 * This macro is used to create a struct acpi_device_id that matches a
79 * specific PCI class. The .id and .driver_data fields will be left
80 * initialized with the default value.
81 */
82#define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (_cls), .cls_msk = (_msk),
83
ca5b74d2
RW
84static inline bool has_acpi_companion(struct device *dev)
85{
3a7a2ab8 86 return is_acpi_device_node(dev->fwnode);
ca5b74d2
RW
87}
88
9c5ad36d
RW
89static inline void acpi_preset_companion(struct device *dev,
90 struct acpi_device *parent, u64 addr)
91{
f8c6d140 92 ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, false));
9c5ad36d
RW
93}
94
45c42a7f
JN
95static inline const char *acpi_dev_name(struct acpi_device *adev)
96{
97 return dev_name(&adev->dev);
98}
99
daae45ca
LW
100struct device *acpi_get_first_physical_node(struct acpi_device *adev);
101
1da177e4
LT
102enum acpi_irq_model_id {
103 ACPI_IRQ_MODEL_PIC = 0,
104 ACPI_IRQ_MODEL_IOAPIC,
105 ACPI_IRQ_MODEL_IOSAPIC,
3948ec94 106 ACPI_IRQ_MODEL_PLATFORM,
fbe61ec7 107 ACPI_IRQ_MODEL_GIC,
1da177e4
LT
108 ACPI_IRQ_MODEL_COUNT
109};
110
111extern enum acpi_irq_model_id acpi_irq_model;
112
1da177e4
LT
113enum acpi_interrupt_id {
114 ACPI_INTERRUPT_PMI = 1,
115 ACPI_INTERRUPT_INIT,
116 ACPI_INTERRUPT_CPEI,
117 ACPI_INTERRUPT_COUNT
118};
119
120#define ACPI_SPACE_MEM 0
121
1da177e4
LT
122enum acpi_address_range_id {
123 ACPI_ADDRESS_RANGE_MEMORY = 1,
124 ACPI_ADDRESS_RANGE_RESERVED = 2,
125 ACPI_ADDRESS_RANGE_ACPI = 3,
126 ACPI_ADDRESS_RANGE_NVS = 4,
127 ACPI_ADDRESS_RANGE_COUNT
128};
129
1da177e4 130
1da177e4 131/* Table Handlers */
60574d1e
KB
132union acpi_subtable_headers {
133 struct acpi_subtable_header common;
3bc0e8eb 134 struct acpi_hmat_structure hmat;
cefc7ca4 135 struct acpi_prmt_module_header prmt;
60574d1e 136};
1da177e4 137
b43e1065 138typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
1da177e4 139
60574d1e 140typedef int (*acpi_tbl_entry_handler)(union acpi_subtable_headers *header,
b43e1065 141 const unsigned long end);
1da177e4 142
836d0830
LZ
143/* Debugger support */
144
145struct acpi_debugger_ops {
146 int (*create_thread)(acpi_osd_exec_callback function, void *context);
147 ssize_t (*write_log)(const char *msg);
148 ssize_t (*read_cmd)(char *buffer, size_t length);
149 int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
150 int (*notify_command_complete)(void);
151};
152
153struct acpi_debugger {
154 const struct acpi_debugger_ops *ops;
155 struct module *owner;
156 struct mutex lock;
157};
158
159#ifdef CONFIG_ACPI_DEBUGGER
160int __init acpi_debugger_init(void);
161int acpi_register_debugger(struct module *owner,
162 const struct acpi_debugger_ops *ops);
163void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
164int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
165ssize_t acpi_debugger_write_log(const char *msg);
166ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
167int acpi_debugger_wait_command_ready(void);
168int acpi_debugger_notify_command_complete(void);
169#else
170static inline int acpi_debugger_init(void)
171{
172 return -ENODEV;
173}
174
175static inline int acpi_register_debugger(struct module *owner,
176 const struct acpi_debugger_ops *ops)
177{
178 return -ENODEV;
179}
180
181static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
182{
183}
184
185static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
186 void *context)
187{
188 return -ENODEV;
189}
190
191static inline int acpi_debugger_write_log(const char *msg)
192{
193 return -ENODEV;
194}
195
196static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
197{
198 return -ENODEV;
199}
200
201static inline int acpi_debugger_wait_command_ready(void)
202{
203 return -ENODEV;
204}
205
206static inline int acpi_debugger_notify_command_complete(void)
207{
208 return -ENODEV;
209}
210#endif
211
328281b1
HG
212#define BAD_MADT_ENTRY(entry, end) ( \
213 (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
214 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
215
9b3fedde
LA
216struct acpi_subtable_proc {
217 int id;
218 acpi_tbl_entry_handler handler;
219 int count;
220};
221
6c9a58e8
AS
222void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
223void __acpi_unmap_table(void __iomem *map, unsigned long size);
cbf9bd60 224int early_acpi_boot_init(void);
1da177e4 225int acpi_boot_init (void);
1a1c130a 226void acpi_boot_table_prepare (void);
8558e394 227void acpi_boot_table_init (void);
3c999f14 228int acpi_mps_check (void);
1da177e4
LT
229int acpi_numa_init (void);
230
1a1c130a
RW
231int acpi_locate_initial_tables (void);
232void acpi_reserve_initial_tables (void);
233void acpi_table_init_complete (void);
1da177e4 234int acpi_table_init (void);
b43e1065 235int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
6eb87fed 236int __init acpi_table_parse_entries(char *id, unsigned long table_size,
9b3fedde
LA
237 int entry_id,
238 acpi_tbl_entry_handler handler,
239 unsigned int max_entries);
9b3fedde
LA
240int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
241 struct acpi_subtable_proc *proc, int proc_num,
242 unsigned int max_entries);
b43e1065
LZ
243int acpi_table_parse_madt(enum acpi_madt_type id,
244 acpi_tbl_entry_handler handler,
245 unsigned int max_entries);
ceb6c468 246int acpi_parse_mcfg (struct acpi_table_header *header);
5f3b1a8b 247void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
1da177e4 248
4bac6fa7 249/* the following numa functions are architecture-dependent */
1da177e4 250void acpi_numa_slit_init (struct acpi_table_slit *slit);
4bac6fa7 251
b1121e2a 252#if defined(CONFIG_X86) || defined(CONFIG_IA64) || defined(CONFIG_LOONGARCH)
15a58ed1 253void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
4bac6fa7
HG
254#else
255static inline void
256acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
257#endif
258
7237d3de 259void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
4bac6fa7
HG
260
261#ifdef CONFIG_ARM64
262void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
db59e1b6 263void acpi_arch_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size);
4bac6fa7
HG
264#else
265static inline void
266acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
db59e1b6
JPB
267static inline void
268acpi_arch_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size) { }
4bac6fa7
HG
269#endif
270
095adbb6 271int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
1da177e4 272
828aef37
CM
273#ifndef PHYS_CPUID_INVALID
274typedef u32 phys_cpuid_t;
275#define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
276#endif
277
25956b66
HG
278static inline bool invalid_logical_cpuid(u32 cpuid)
279{
280 return (int)cpuid < 0;
281}
282
ddcc18f5
HG
283static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
284{
285 return phys_id == PHYS_CPUID_INVALID;
286}
287
fd74da21 288/* Validate the processor object's proc_id */
a77d6cd9 289bool acpi_duplicate_processor_id(int proc_id);
bc946388 290/* Processor _CTS control */
77fb4e0a
RW
291struct acpi_processor_power;
292
bc946388
RW
293#ifdef CONFIG_ACPI_PROCESSOR_CSTATE
294bool acpi_processor_claim_cst_control(void);
77fb4e0a
RW
295int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
296 struct acpi_processor_power *info);
bc946388
RW
297#else
298static inline bool acpi_processor_claim_cst_control(void) { return false; }
77fb4e0a
RW
299static inline int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
300 struct acpi_processor_power *info)
301{
302 return -ENODEV;
303}
bc946388 304#endif
fd74da21 305
1da177e4
LT
306#ifdef CONFIG_ACPI_HOTPLUG_CPU
307/* Arch dependent functions for cpu hotplug support */
febf2407
VK
308int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
309 int *pcpu);
d02dc27d 310int acpi_unmap_cpu(int cpu);
1da177e4
LT
311#endif /* CONFIG_ACPI_HOTPLUG_CPU */
312
ecf5636d
YL
313#ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
314int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
315#endif
316
b1bb248a
KK
317int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
318int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
e89900c9 319int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
5229e87d 320void acpi_irq_stats_init(void);
5229e87d 321extern u32 acpi_irq_handled;
88bea188 322extern u32 acpi_irq_not_handled;
49e4b843 323extern unsigned int acpi_sci_irq;
13737181 324extern bool acpi_no_s5;
49e4b843
CY
325#define INVALID_ACPI_IRQ ((unsigned)-1)
326static inline bool acpi_sci_irq_valid(void)
327{
328 return acpi_sci_irq != INVALID_ACPI_IRQ;
329}
1da177e4 330
c255d844 331extern int sbf_port;
77afcf78 332extern unsigned long acpi_realmode_flags;
1da177e4 333
a2f809b0 334int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
1da177e4 335int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
2c2df841 336int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
1da177e4 337
2bc6eba4
MZ
338void acpi_set_irq_model(enum acpi_irq_model_id model,
339 struct fwnode_handle *fwnode);
340
621dc2fd
AB
341struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
342 unsigned int size,
343 struct fwnode_handle *fwnode,
344 const struct irq_domain_ops *ops,
345 void *host_data);
346
61fd47e0 347#ifdef CONFIG_X86_IO_APIC
9a0a91bb 348extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
61fd47e0 349#else
dfd6f9ad
AB
350static inline int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity)
351{
352 return -1;
353}
61fd47e0 354#endif
1da177e4
LT
355/*
356 * This function undoes the effect of one call to acpi_register_gsi().
357 * If this matches the last registration, any IRQ resources for gsi
358 * are freed.
359 */
1da177e4 360void acpi_unregister_gsi (u32 gsi);
1da177e4 361
1da177e4
LT
362struct pci_dev;
363
364int acpi_pci_irq_enable (struct pci_dev *dev);
c9c3e457 365void acpi_penalize_isa_irq(int irq, int active);
5ebc7603 366bool acpi_isa_irq_available(int irq);
5d32a665 367#ifdef CONFIG_PCI
f1caa61d 368void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
5d32a665
SK
369#else
370static inline void acpi_penalize_sci_irq(int irq, int trigger,
371 int polarity)
372{
373}
374#endif
1da177e4 375void acpi_pci_irq_disable (struct pci_dev *dev);
1da177e4 376
1da177e4
LT
377extern int ec_read(u8 addr, u8 *val);
378extern int ec_write(u8 addr, u8 val);
d7a76e4c
LP
379extern int ec_transaction(u8 command,
380 const u8 *wdata, unsigned wdata_len,
1cb7b1e0 381 u8 *rdata, unsigned rdata_len);
3e2abc5a 382extern acpi_handle ec_get_handle(void);
1da177e4 383
eec15edb
ZR
384extern bool acpi_is_pnp_device(struct acpi_device *);
385
bff431e4
CC
386#if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
387
388typedef void (*wmi_notify_handler) (u32 value, void *context);
389
390extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
391 u32 method_id,
392 const struct acpi_buffer *in,
393 struct acpi_buffer *out);
394extern acpi_status wmi_query_block(const char *guid, u8 instance,
395 struct acpi_buffer *out);
396extern acpi_status wmi_set_block(const char *guid, u8 instance,
397 const struct acpi_buffer *in);
398extern acpi_status wmi_install_notify_handler(const char *guid,
399 wmi_notify_handler handler, void *data);
400extern acpi_status wmi_remove_notify_handler(const char *guid);
401extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
402extern bool wmi_has_guid(const char *guid);
e7488e58 403extern char *wmi_get_acpi_device_uid(const char *guid);
bff431e4
CC
404
405#endif /* CONFIG_ACPI_WMI */
406
c3d6de69
TR
407#define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
408#define ACPI_VIDEO_DEVICE_POSTING 0x0002
409#define ACPI_VIDEO_ROM_AVAILABLE 0x0004
410#define ACPI_VIDEO_BACKLIGHT 0x0008
411#define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
412#define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
413#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
414#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
415#define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
416#define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
417#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
418#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
419
14ca7a47 420extern char acpi_video_backlight_string[];
d4e1a692 421extern long acpi_is_video_device(acpi_handle handle);
1da177e4 422extern int acpi_blacklisted(void);
d90aa92c 423extern void acpi_osi_setup(char *str);
a87878ba 424extern bool acpi_osi_is_win8(void);
1da177e4 425
1da177e4 426#ifdef CONFIG_ACPI_NUMA
8fc5c735 427int acpi_map_pxm_to_node(int pxm);
486c79b5 428int acpi_get_node(acpi_handle handle);
b2ca916c
DW
429
430/**
4eb3723f 431 * pxm_to_online_node - Map proximity ID to online node
b2ca916c
DW
432 * @pxm: ACPI proximity ID
433 *
4eb3723f 434 * This is similar to pxm_to_node(), but always returns an online
b2ca916c
DW
435 * node. When the mapped node from a given proximity ID is offline, it
436 * looks up the node distance table and returns the nearest online node.
437 *
438 * ACPI device drivers, which are called after the NUMA initialization has
439 * completed in the kernel, can call this interface to obtain their device
440 * NUMA topology from ACPI tables. Such drivers do not have to deal with
fe205d98
JC
441 * offline nodes. A node may be offline when SRAT memory entry does not exist,
442 * or NUMA is disabled, ex. "numa=off" on x86.
b2ca916c 443 */
4eb3723f 444static inline int pxm_to_online_node(int pxm)
b2ca916c 445{
fe205d98 446 int node = pxm_to_node(pxm);
b2ca916c
DW
447
448 return numa_map_to_online_node(node);
449}
1da177e4 450#else
4eb3723f 451static inline int pxm_to_online_node(int pxm)
99759869
TK
452{
453 return 0;
454}
8fc5c735
DW
455static inline int acpi_map_pxm_to_node(int pxm)
456{
457 return 0;
458}
486c79b5 459static inline int acpi_get_node(acpi_handle handle)
1e3590e2
YG
460{
461 return 0;
462}
1da177e4 463#endif
1e3590e2 464extern int acpi_paddr_to_node(u64 start_addr, u64 size);
1da177e4
LT
465
466extern int pnpacpi_disabled;
467
3484d798 468#define PXM_INVAL (-1)
3484d798 469
046d9ce6
RW
470bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
471bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
472bool acpi_dev_resource_address_space(struct acpi_resource *ares,
a49170b5 473 struct resource_win *win);
046d9ce6 474bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
a49170b5 475 struct resource_win *win);
046d9ce6 476unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
55a93417 477unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
046d9ce6
RW
478bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
479 struct resource *res);
480
8e345c99
RW
481void acpi_dev_free_resource_list(struct list_head *list);
482int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
483 int (*preproc)(struct acpi_resource *, void *),
484 void *preproc_data);
c04ac679
LP
485int acpi_dev_get_dma_resources(struct acpi_device *adev,
486 struct list_head *list);
62d1141f
JL
487int acpi_dev_filter_resource_type(struct acpi_resource *ares,
488 unsigned long types);
489
490static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
491 void *arg)
492{
493 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
494}
8e345c99 495
00710984
BH
496struct acpi_device *acpi_resource_consumer(struct resource *res);
497
876fba43 498int acpi_check_resource_conflict(const struct resource *res);
443dea72 499
df92e695
TR
500int acpi_check_region(resource_size_t start, resource_size_t n,
501 const char *name);
df92e695 502
d2d2e3c4
HK
503acpi_status acpi_release_memory(acpi_handle handle, struct resource *res,
504 u32 level);
505
70dd6bea
JD
506int acpi_resources_are_enforced(void);
507
9743fdea 508#ifdef CONFIG_HIBERNATION
bdfe6b7c 509void __init acpi_no_s4_hw_signature(void);
9743fdea
YL
510#endif
511
512#ifdef CONFIG_PM_SLEEP
d8f3de0d 513void __init acpi_old_suspend_ordering(void);
72ad5d77 514void __init acpi_nvs_nosave(void);
1bad2f19 515void __init acpi_nvs_nosave_s3(void);
57044031 516void __init acpi_sleep_no_blacklist(void);
d8f3de0d 517#endif /* CONFIG_PM_SLEEP */
9f5404d8 518
ddfd9dcf
HG
519int acpi_register_wakeup_handler(
520 int wake_irq, bool (*wakeup)(void *context), void *context);
521void acpi_unregister_wakeup_handler(
522 bool (*wakeup)(void *context), void *context);
523
70023de8 524struct acpi_osc_context {
c8678473 525 char *uuid_str; /* UUID string */
70023de8 526 int rev;
c8678473
BH
527 struct acpi_buffer cap; /* list of DWORD capabilities */
528 struct acpi_buffer ret; /* free by caller if success */
70023de8
SL
529};
530
70023de8
SL
531acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
532
b938a229
BH
533/* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
534#define OSC_QUERY_DWORD 0 /* DWORD 1 */
535#define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
536#define OSC_CONTROL_DWORD 2 /* DWORD 3 */
9f5404d8 537
dedf1e4d
BH
538/* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
539#define OSC_QUERY_ENABLE 0x00000001 /* input */
540#define OSC_REQUEST_ERROR 0x00000002 /* return */
541#define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
542#define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
543#define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
9f5404d8 544
dedf1e4d
BH
545/* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
546#define OSC_SB_PAD_SUPPORT 0x00000001
547#define OSC_SB_PPC_OST_SUPPORT 0x00000002
548#define OSC_SB_PR3_SUPPORT 0x00000004
549#define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
550#define OSC_SB_APEI_SUPPORT 0x00000010
551#define OSC_SB_CPC_SUPPORT 0x00000020
a36a7fec
SH
552#define OSC_SB_CPCV2_SUPPORT 0x00000040
553#define OSC_SB_PCLPI_SUPPORT 0x00000080
554#define OSC_SB_OSLPI_SUPPORT 0x00000100
8b533a0e 555#define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT 0x00001000
01aabca2 556#define OSC_SB_GENERIC_INITIATOR_SUPPORT 0x00002000
5a6a2c0f 557#define OSC_SB_NATIVE_USB4_SUPPORT 0x00040000
bd7a94c0 558#define OSC_SB_PRM_SUPPORT 0x00200000
3563ff96 559
eccddd32 560extern bool osc_sb_apei_support_acked;
a36a7fec 561extern bool osc_pc_lpi_support_confirmed;
5a6a2c0f
MW
562extern bool osc_sb_native_usb4_support_confirmed;
563
564/* USB4 Capabilities */
565#define OSC_USB_USB3_TUNNELING 0x00000001
566#define OSC_USB_DP_TUNNELING 0x00000002
567#define OSC_USB_PCIE_TUNNELING 0x00000004
568#define OSC_USB_XDOMAIN 0x00000008
569
570extern u32 osc_sb_native_usb4_control;
eccddd32 571
dedf1e4d 572/* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
7dab9ef4
BH
573#define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
574#define OSC_PCI_ASPM_SUPPORT 0x00000002
575#define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
dedf1e4d 576#define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
7dab9ef4 577#define OSC_PCI_MSI_SUPPORT 0x00000010
ac1c8e35 578#define OSC_PCI_EDR_SUPPORT 0x00000080
ba11edc6 579#define OSC_PCI_HPX_TYPE_3_SUPPORT 0x00000100
dedf1e4d
BH
580
581/* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
582#define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
7dab9ef4 583#define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
dedf1e4d
BH
584#define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
585#define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
7dab9ef4 586#define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
af8bb9f8 587#define OSC_PCI_EXPRESS_LTR_CONTROL 0x00000020
ac1c8e35 588#define OSC_PCI_EXPRESS_DPC_CONTROL 0x00000080
d90116ea 589
5d98e61d
LT
590#define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
591#define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
592#define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
593#define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
594#define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
595#define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
596#define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
597#define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
598#define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
599#define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
600
275c58d7
TK
601/* Enable _OST when all relevant hotplug operations are enabled */
602#if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
08f502c1 603 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
64fd7401 604 defined(CONFIG_ACPI_CONTAINER)
275c58d7
TK
605#define ACPI_HOTPLUG_OST
606#endif
607
608/* _OST Source Event Code (OSPM Action) */
609#define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
610#define ACPI_OST_EC_OSPM_EJECT 0x103
611#define ACPI_OST_EC_OSPM_INSERTION 0x200
612
613/* _OST General Processing Status Code */
614#define ACPI_OST_SC_SUCCESS 0x0
615#define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
616#define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
617
618/* _OST OS Shutdown Processing (0x100) Status Code */
619#define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
620#define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
621#define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
622#define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
623
624/* _OST Ejection Request (0x3, 0x103) Status Code */
625#define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
626#define ACPI_OST_SC_DEVICE_IN_USE 0x81
627#define ACPI_OST_SC_DEVICE_BUSY 0x82
628#define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
629#define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
630
631/* _OST Insertion Request (0x200) Status Code */
632#define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
633#define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
634#define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
635
5aa5911a
TK
636enum acpi_predicate {
637 all_versions,
638 less_than_or_equal,
639 equal,
640 greater_than_or_equal,
641};
642
643/* Table must be terminted by a NULL entry */
644struct acpi_platform_list {
645 char oem_id[ACPI_OEM_ID_SIZE+1];
646 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
647 u32 oem_revision;
648 char *table;
649 enum acpi_predicate pred;
650 char *reason;
651 u32 data;
652};
653int acpi_match_platform_list(const struct acpi_platform_list *plat);
654
4a7a16dc 655extern void acpi_early_init(void);
b064a8fa 656extern void acpi_subsystem_init(void);
63fab697 657extern void arch_post_acpi_subsys_init(void);
4a7a16dc 658
b54ac6d2
HY
659extern int acpi_nvs_register(__u64 start, __u64 size);
660
661extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
662 void *data);
663
cf761af9
MW
664const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
665 const struct device *dev);
666
67dcc26d 667const void *acpi_device_get_match_data(const struct device *dev);
733e6251
MW
668extern bool acpi_driver_match_device(struct device *dev,
669 const struct device_driver *drv);
6eb2451f
ZR
670int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
671int acpi_device_modalias(struct device *, char *, int);
672
1571875b
HK
673struct platform_device *acpi_create_platform_device(struct acpi_device *,
674 struct property_entry *);
cf761af9
MW
675#define ACPI_PTR(_ptr) (_ptr)
676
10c7e20b
OP
677static inline void acpi_device_set_enumerated(struct acpi_device *adev)
678{
679 adev->flags.visited = true;
680}
681
682static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
683{
684 adev->flags.visited = false;
685}
686
68bdb677
OP
687enum acpi_reconfig_event {
688 ACPI_RECONFIG_DEVICE_ADD = 0,
689 ACPI_RECONFIG_DEVICE_REMOVE,
690};
691
692int acpi_reconfig_notifier_register(struct notifier_block *nb);
693int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
694
5f1ae4eb
FW
695#ifdef CONFIG_ACPI_GTDT
696int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
697int acpi_gtdt_map_ppi(int type);
698bool acpi_gtdt_c3stop(int type);
a712c3ed 699int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
5f1ae4eb
FW
700#endif
701
41fa1ee9
JB
702#ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
703static inline void acpi_arch_set_root_pointer(u64 addr)
704{
705}
706#endif
707
dfc9327a
JG
708#ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
709static inline u64 acpi_arch_get_root_pointer(void)
710{
711 return 0;
712}
713#endif
714
7ec16433
CJ
715int acpi_get_local_address(acpi_handle handle, u32 *addr);
716
e55a5999
FT
717#else /* !CONFIG_ACPI */
718
719#define acpi_disabled 1
720
7b199811
RW
721#define ACPI_COMPANION(dev) (NULL)
722#define ACPI_COMPANION_SET(dev, adev) do { } while (0)
723#define ACPI_HANDLE(dev) (NULL)
7c6c57f2 724#define ACPI_HANDLE_FWNODE(fwnode) (NULL)
26095a01 725#define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
7b199811 726
3b0d3101
DW
727#include <acpi/acpi_numa.h>
728
8a0662d9
RW
729struct fwnode_handle;
730
6eb17e0d
KY
731static inline bool acpi_dev_found(const char *hid)
732{
733 return false;
734}
735
8661423e
HG
736static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
737{
738 return false;
739}
740
35009c80
AS
741struct acpi_device;
742
743static inline bool
744acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2)
745{
746 return false;
747}
748
817b4d64
AS
749static inline struct acpi_device *
750acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
751{
752 return NULL;
753}
754
8eb99e9a
HG
755static inline bool acpi_reduced_hardware(void)
756{
757 return false;
758}
759
fe066621
Y
760static inline void acpi_dev_put(struct acpi_device *adev) {}
761
ff70784a 762static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
8a0662d9
RW
763{
764 return false;
765}
766
ff70784a 767static inline bool is_acpi_device_node(const struct fwnode_handle *fwnode)
3a7a2ab8
RW
768{
769 return false;
770}
771
5c1a72a0 772static inline struct acpi_device *to_acpi_device_node(const struct fwnode_handle *fwnode)
3a7a2ab8
RW
773{
774 return NULL;
775}
776
ff70784a 777static inline bool is_acpi_data_node(const struct fwnode_handle *fwnode)
3a7a2ab8
RW
778{
779 return false;
780}
781
5c1a72a0 782static inline struct acpi_data_node *to_acpi_data_node(const struct fwnode_handle *fwnode)
8a0662d9
RW
783{
784 return NULL;
785}
786
5c1a72a0 787static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
613e9721
AT
788 const char *name)
789{
790 return false;
791}
792
8a0662d9
RW
793static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
794{
795 return NULL;
796}
797
ca5b74d2
RW
798static inline bool has_acpi_companion(struct device *dev)
799{
800 return false;
801}
802
c0e5c445
DB
803static inline void acpi_preset_companion(struct device *dev,
804 struct acpi_device *parent, u64 addr)
805{
806}
807
45c42a7f
JN
808static inline const char *acpi_dev_name(struct acpi_device *adev)
809{
810 return NULL;
811}
812
daae45ca
LW
813static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
814{
815 return NULL;
816}
817
4a7a16dc 818static inline void acpi_early_init(void) { }
b064a8fa 819static inline void acpi_subsystem_init(void) { }
53de49f5 820
cbf9bd60
YL
821static inline int early_acpi_boot_init(void)
822{
823 return 0;
824}
53de49f5
AM
825static inline int acpi_boot_init(void)
826{
827 return 0;
828}
829
1a1c130a
RW
830static inline void acpi_boot_table_prepare(void)
831{
832}
833
8558e394 834static inline void acpi_boot_table_init(void)
53de49f5 835{
53de49f5
AM
836}
837
3c999f14
YL
838static inline int acpi_mps_check(void)
839{
840 return 0;
841}
842
443dea72
TR
843static inline int acpi_check_resource_conflict(struct resource *res)
844{
845 return 0;
846}
847
df92e695
TR
848static inline int acpi_check_region(resource_size_t start, resource_size_t n,
849 const char *name)
850{
851 return 0;
852}
853
e55a5999
FT
854struct acpi_table_header;
855static inline int acpi_table_parse(char *id,
856 int (*handler)(struct acpi_table_header *))
857{
f8a571b2 858 return -ENODEV;
e55a5999 859}
6fed05c9 860
b54ac6d2 861static inline int acpi_nvs_register(__u64 start, __u64 size)
6fed05c9
RW
862{
863 return 0;
864}
b54ac6d2
HY
865
866static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
867 void *data)
868{
869 return 0;
870}
871
cf761af9
MW
872struct acpi_device_id;
873
874static inline const struct acpi_device_id *acpi_match_device(
875 const struct acpi_device_id *ids, const struct device *dev)
80212a16
SK
876{
877 return NULL;
878}
879
67dcc26d 880static inline const void *acpi_device_get_match_data(const struct device *dev)
cf761af9
MW
881{
882 return NULL;
883}
884
885static inline bool acpi_driver_match_device(struct device *dev,
886 const struct device_driver *drv)
887{
888 return false;
889}
890
4ae39924 891static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
94116f81 892 const guid_t *guid,
1e0cb59d 893 u64 rev, u64 func,
4ae39924
KY
894 union acpi_object *argv4)
895{
896 return NULL;
897}
898
6eb2451f
ZR
899static inline int acpi_device_uevent_modalias(struct device *dev,
900 struct kobj_uevent_env *env)
901{
902 return -ENODEV;
903}
904
905static inline int acpi_device_modalias(struct device *dev,
906 char *buf, int size)
907{
908 return -ENODEV;
909}
910
ee61cfd9
SG
911static inline struct platform_device *
912acpi_create_platform_device(struct acpi_device *adev,
913 struct property_entry *properties)
914{
915 return NULL;
916}
917
3d7c821c 918static inline bool acpi_dma_supported(const struct acpi_device *adev)
d0562674
SS
919{
920 return false;
921}
922
b84f196d
SS
923static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
924{
925 return DEV_DMA_NOT_SUPPORTED;
926}
927
c04ac679
LP
928static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
929 u64 *offset, u64 *size)
930{
931 return -ENODEV;
932}
933
5a1bb638
S
934static inline int acpi_dma_configure(struct device *dev,
935 enum dev_dma_attr attr)
936{
937 return 0;
938}
d760a1ba 939
b8e069a2
LP
940static inline int acpi_dma_configure_id(struct device *dev,
941 enum dev_dma_attr attr,
942 const u32 *input_id)
943{
944 return 0;
945}
946
cf761af9
MW
947#define ACPI_PTR(_ptr) (NULL)
948
10c7e20b
OP
949static inline void acpi_device_set_enumerated(struct acpi_device *adev)
950{
951}
952
953static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
954{
955}
956
68bdb677
OP
957static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
958{
959 return -EINVAL;
960}
961
962static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
963{
964 return -EINVAL;
965}
966
00710984
BH
967static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
968{
969 return NULL;
970}
971
7ec16433
CJ
972static inline int acpi_get_local_address(acpi_handle handle, u32 *addr)
973{
974 return -ENODEV;
975}
976
b54ac6d2 977#endif /* !CONFIG_ACPI */
6fed05c9 978
fe7bd58f
RW
979#ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
980int acpi_ioapic_add(acpi_handle root);
981#else
982static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
983#endif
984
09f98a82
TL
985#ifdef CONFIG_ACPI
986void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
987 u32 pm1a_ctrl, u32 pm1b_ctrl));
988
989acpi_status acpi_os_prepare_sleep(u8 sleep_state,
990 u32 pm1a_control, u32 pm1b_control);
d6b47b12
BG
991
992void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
993 u32 val_a, u32 val_b));
994
995acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
996 u32 val_a, u32 val_b);
997
a509a66a 998#ifndef CONFIG_IA64
8e30524d
TR
999void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1000#else
1001static inline void arch_reserve_mem_area(acpi_physical_address addr,
1002 size_t size)
1003{
1004}
1005#endif /* CONFIG_X86 */
09f98a82
TL
1006#else
1007#define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1008#endif
1009
5de21bb9 1010#if defined(CONFIG_ACPI) && defined(CONFIG_PM)
cbe25ce3 1011int acpi_dev_suspend(struct device *dev, bool wakeup);
63705c40 1012int acpi_dev_resume(struct device *dev);
e5cc8ef3
RW
1013int acpi_subsys_runtime_suspend(struct device *dev);
1014int acpi_subsys_runtime_resume(struct device *dev);
5de21bb9 1015int acpi_dev_pm_attach(struct device *dev, bool power_on);
2744d7a0 1016bool acpi_storage_d3(struct device *dev);
b82a7df4 1017bool acpi_dev_state_d0(struct device *dev);
e5cc8ef3 1018#else
e5cc8ef3
RW
1019static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1020static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
5de21bb9
RW
1021static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1022{
919b7308 1023 return 0;
5de21bb9 1024}
2744d7a0
ML
1025static inline bool acpi_storage_d3(struct device *dev)
1026{
1027 return false;
1028}
b82a7df4
SA
1029static inline bool acpi_dev_state_d0(struct device *dev)
1030{
1031 return true;
1032}
e5cc8ef3
RW
1033#endif
1034
d79beb39 1035#if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
e5cc8ef3 1036int acpi_subsys_prepare(struct device *dev);
4cf563c5 1037void acpi_subsys_complete(struct device *dev);
e5cc8ef3 1038int acpi_subsys_suspend_late(struct device *dev);
05087360 1039int acpi_subsys_suspend_noirq(struct device *dev);
4cf563c5
HK
1040int acpi_subsys_suspend(struct device *dev);
1041int acpi_subsys_freeze(struct device *dev);
c95b7595 1042int acpi_subsys_poweroff(struct device *dev);
10a08fd6
RW
1043void acpi_ec_mark_gpe_for_wake(void);
1044void acpi_ec_set_gpe_wake_mask(u8 action);
e5cc8ef3 1045#else
e5cc8ef3 1046static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
4cf563c5 1047static inline void acpi_subsys_complete(struct device *dev) {}
e5cc8ef3 1048static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
05087360 1049static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
4cf563c5
HK
1050static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1051static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
c95b7595 1052static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
10a08fd6
RW
1053static inline void acpi_ec_mark_gpe_for_wake(void) {}
1054static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
e5cc8ef3
RW
1055#endif
1056
fbfddae6
TK
1057#ifdef CONFIG_ACPI
1058__printf(3, 4)
1059void acpi_handle_printk(const char *level, acpi_handle handle,
1060 const char *fmt, ...);
4c324548
RW
1061void acpi_evaluation_failure_warn(acpi_handle handle, const char *name,
1062 acpi_status status);
fbfddae6
TK
1063#else /* !CONFIG_ACPI */
1064static inline __printf(3, 4) void
1065acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
4c324548
RW
1066static inline void acpi_evaluation_failure_warn(acpi_handle handle,
1067 const char *name,
1068 acpi_status status) {}
fbfddae6
TK
1069#endif /* !CONFIG_ACPI */
1070
45fef5b8
BM
1071#if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1072__printf(3, 4)
1073void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
45fef5b8
BM
1074#endif
1075
fbfddae6
TK
1076/*
1077 * acpi_handle_<level>: Print message with ACPI prefix and object path
1078 *
1079 * These interfaces acquire the global namespace mutex to obtain an object
1080 * path. In interrupt context, it shows the object path as <n/a>.
1081 */
1082#define acpi_handle_emerg(handle, fmt, ...) \
1083 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1084#define acpi_handle_alert(handle, fmt, ...) \
1085 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1086#define acpi_handle_crit(handle, fmt, ...) \
1087 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1088#define acpi_handle_err(handle, fmt, ...) \
1089 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1090#define acpi_handle_warn(handle, fmt, ...) \
1091 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1092#define acpi_handle_notice(handle, fmt, ...) \
1093 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1094#define acpi_handle_info(handle, fmt, ...) \
1095 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1096
45fef5b8 1097#if defined(DEBUG)
fbfddae6
TK
1098#define acpi_handle_debug(handle, fmt, ...) \
1099 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1100#else
45fef5b8
BM
1101#if defined(CONFIG_DYNAMIC_DEBUG)
1102#define acpi_handle_debug(handle, fmt, ...) \
f1ebe04f
RV
1103 _dynamic_func_call(fmt, __acpi_handle_debug, \
1104 handle, pr_fmt(fmt), ##__VA_ARGS__)
45fef5b8 1105#else
fbfddae6
TK
1106#define acpi_handle_debug(handle, fmt, ...) \
1107({ \
1108 if (0) \
1109 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1110 0; \
1111})
1112#endif
45fef5b8 1113#endif
fbfddae6 1114
f028d524 1115#if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
25e3ef89
AS
1116bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1117 struct acpi_resource_gpio **agpio);
043d7f09
DS
1118bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1119 struct acpi_resource_gpio **agpio);
80939021 1120int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index);
f028d524 1121#else
25e3ef89
AS
1122static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1123 struct acpi_resource_gpio **agpio)
1124{
1125 return false;
1126}
043d7f09
DS
1127static inline bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1128 struct acpi_resource_gpio **agpio)
1129{
1130 return false;
1131}
80939021
AS
1132static inline int acpi_dev_gpio_irq_get_by(struct acpi_device *adev,
1133 const char *name, int index)
c884fbd4
MW
1134{
1135 return -ENXIO;
1136}
f028d524
RW
1137#endif
1138
80939021
AS
1139static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1140{
1141 return acpi_dev_gpio_irq_get_by(adev, NULL, index);
1142}
1143
ffdcd955
MW
1144/* Device properties */
1145
ffdcd955 1146#ifdef CONFIG_ACPI
99a85464 1147int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
ffdcd955 1148 acpi_object_type type, const union acpi_object **obj);
99a85464 1149int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
b60e4ea4 1150 const char *name, size_t index, size_t num_args,
977d5ad3 1151 struct fwnode_reference_args *args);
b60e4ea4 1152
99a85464
SA
1153static inline int acpi_node_get_property_reference(
1154 const struct fwnode_handle *fwnode,
b60e4ea4 1155 const char *name, size_t index,
977d5ad3 1156 struct fwnode_reference_args *args)
b60e4ea4
MW
1157{
1158 return __acpi_node_get_property_reference(fwnode, name, index,
977d5ad3 1159 NR_FWNODE_REFERENCE_ARGS, args);
b60e4ea4 1160}
b31384fa 1161
5f5e4890
MW
1162static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1163{
1164 return !list_empty(&adev->data.properties);
1165}
1166
1167struct acpi_device_properties *
1168acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1169 const union acpi_object *properties);
1170
99a85464 1171int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
3a7a2ab8 1172 void **valptr);
8a0662d9 1173
37ba983c 1174struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
34055190 1175 struct fwnode_handle *child);
37ba983c 1176struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode);
e647b532
MZ
1177
1178struct acpi_probe_entry;
1179typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1180 struct acpi_probe_entry *);
1181
1182#define ACPI_TABLE_ID_LEN 5
1183
1184/**
1185 * struct acpi_probe_entry - boot-time probing entry
1186 * @id: ACPI table name
1187 * @type: Optional subtable type to match
1188 * (if @id contains subtables)
1189 * @subtable_valid: Optional callback to check the validity of
1190 * the subtable
1191 * @probe_table: Callback to the driver being probed when table
1192 * match is successful
1193 * @probe_subtbl: Callback to the driver being probed when table and
1194 * subtable match (and optional callback is successful)
1195 * @driver_data: Sideband data provided back to the driver
1196 */
1197struct acpi_probe_entry {
1198 __u8 id[ACPI_TABLE_ID_LEN];
1199 __u8 type;
1200 acpi_probe_entry_validate_subtbl subtable_valid;
1201 union {
1202 acpi_tbl_table_handler probe_table;
1203 acpi_tbl_entry_handler probe_subtbl;
1204 };
1205 kernel_ulong_t driver_data;
1206};
1207
8ebf642f
OC
1208#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, \
1209 valid, data, fn) \
e647b532 1210 static const struct acpi_probe_entry __acpi_probe_##name \
33def849 1211 __used __section("__" #table "_acpi_probe_table") = { \
e647b532
MZ
1212 .id = table_id, \
1213 .type = subtable, \
1214 .subtable_valid = valid, \
8ebf642f
OC
1215 .probe_table = fn, \
1216 .driver_data = data, \
1217 }
e647b532 1218
89778093
OC
1219#define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id, \
1220 subtable, valid, data, fn) \
1221 static const struct acpi_probe_entry __acpi_probe_##name \
33def849 1222 __used __section("__" #table "_acpi_probe_table") = { \
89778093
OC
1223 .id = table_id, \
1224 .type = subtable, \
1225 .subtable_valid = valid, \
1226 .probe_subtbl = fn, \
1227 .driver_data = data, \
1228 }
e647b532
MZ
1229
1230#define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1231#define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1232
1233int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1234
1235#define acpi_probe_device_table(t) \
1236 ({ \
1237 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1238 ACPI_PROBE_TABLE_END(t); \
1239 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1240 (&ACPI_PROBE_TABLE_END(t) - \
1241 &ACPI_PROBE_TABLE(t))); \
1242 })
ffdcd955
MW
1243#else
1244static inline int acpi_dev_get_property(struct acpi_device *adev,
1245 const char *name, acpi_object_type type,
1246 const union acpi_object **obj)
1247{
1248 return -ENXIO;
1249}
3a7a2ab8 1250
b60e4ea4 1251static inline int
99a85464 1252__acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
b60e4ea4 1253 const char *name, size_t index, size_t num_args,
977d5ad3 1254 struct fwnode_reference_args *args)
b60e4ea4
MW
1255{
1256 return -ENXIO;
1257}
1258
99a85464
SA
1259static inline int
1260acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1261 const char *name, size_t index,
977d5ad3 1262 struct fwnode_reference_args *args)
ffdcd955
MW
1263{
1264 return -ENXIO;
1265}
b31384fa 1266
99a85464 1267static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
3a7a2ab8
RW
1268 const char *propname,
1269 void **valptr)
ffdcd955
MW
1270{
1271 return -ENXIO;
1272}
b31384fa 1273
34055190 1274static inline struct fwnode_handle *
37ba983c
SA
1275acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1276 struct fwnode_handle *child)
8a0662d9
RW
1277{
1278 return NULL;
1279}
1280
dfa672fb 1281static inline struct fwnode_handle *
37ba983c 1282acpi_node_get_parent(const struct fwnode_handle *fwnode)
dfa672fb
MW
1283{
1284 return NULL;
1285}
1286
79389a83 1287static inline struct fwnode_handle *
37ba983c 1288acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
79389a83
MW
1289 struct fwnode_handle *prev)
1290{
1291 return ERR_PTR(-ENXIO);
1292}
1293
1294static inline int
37ba983c 1295acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
79389a83
MW
1296 struct fwnode_handle **remote,
1297 struct fwnode_handle **port,
1298 struct fwnode_handle **endpoint)
1299{
1300 return -ENXIO;
1301}
1302
3feab13c 1303#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
e647b532
MZ
1304 static const void * __acpi_table_##name[] \
1305 __attribute__((unused)) \
1306 = { (void *) table_id, \
1307 (void *) subtable, \
1308 (void *) valid, \
1309 (void *) fn, \
1310 (void *) data }
1311
1312#define acpi_probe_device_table(t) ({ int __r = 0; __r;})
ffdcd955
MW
1313#endif
1314
da3d3f98
AM
1315#ifdef CONFIG_ACPI_TABLE_UPGRADE
1316void acpi_table_upgrade(void);
1317#else
1318static inline void acpi_table_upgrade(void) { }
1319#endif
1320
058dfc76
MW
1321#if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1322extern bool acpi_has_watchdog(void);
1323#else
1324static inline bool acpi_has_watchdog(void) { return false; }
1325#endif
1326
ad1696f6 1327#ifdef CONFIG_ACPI_SPCR_TABLE
37ef38f3 1328extern bool qdf2400_e44_present;
0231d000 1329int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
ad1696f6 1330#else
0231d000
PB
1331static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1332{
1333 return 0;
1334}
ad1696f6
AM
1335#endif
1336
d44fa3d4
AVF
1337#if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1338int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1339#else
1340static inline
1341int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1342{
1343 return -EINVAL;
1344}
1345#endif
1346
eeb2d80d
SP
1347#ifdef CONFIG_ACPI_LPIT
1348int lpit_read_residency_count_address(u64 *address);
1349#else
1350static inline int lpit_read_residency_count_address(u64 *address)
1351{
1352 return -EINVAL;
1353}
1354#endif
1355
2520e627 1356#ifdef CONFIG_ACPI_PPTT
bbd1b706 1357int acpi_pptt_cpu_is_thread(unsigned int cpu);
2bd00bcd 1358int find_acpi_cpu_topology(unsigned int cpu, int level);
c5e22fef 1359int find_acpi_cpu_topology_cluster(unsigned int cpu);
2bd00bcd 1360int find_acpi_cpu_topology_package(unsigned int cpu);
56855a99 1361int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
2bd00bcd 1362int find_acpi_cpu_cache_topology(unsigned int cpu, int level);
2520e627 1363#else
bbd1b706
JL
1364static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1365{
1366 return -EINVAL;
1367}
2520e627
SH
1368static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1369{
1370 return -EINVAL;
1371}
c5e22fef
JC
1372static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1373{
1374 return -EINVAL;
1375}
2520e627
SH
1376static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1377{
1378 return -EINVAL;
1379}
56855a99
JL
1380static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1381{
1382 return -EINVAL;
1383}
2520e627
SH
1384static inline int find_acpi_cpu_cache_topology(unsigned int cpu, int level)
1385{
1386 return -EINVAL;
1387}
1388#endif
2bd00bcd 1389
7847a145 1390#ifdef CONFIG_ACPI
d0b8e398
RW
1391extern void acpi_device_notify(struct device *dev);
1392extern void acpi_device_notify_remove(struct device *dev);
7847a145 1393#else
d0b8e398
RW
1394static inline void acpi_device_notify(struct device *dev) { }
1395static inline void acpi_device_notify_remove(struct device *dev) { }
7847a145
HK
1396#endif
1397
25be5e6c 1398#endif /*_LINUX_ACPI_H*/