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