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