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