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