]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/linux/acpi.h
Merge branch 'sched-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[mirror_ubuntu-artful-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_pci_irq_disable (struct pci_dev *dev);
330
331 extern int ec_read(u8 addr, u8 *val);
332 extern int ec_write(u8 addr, u8 val);
333 extern int ec_transaction(u8 command,
334 const u8 *wdata, unsigned wdata_len,
335 u8 *rdata, unsigned rdata_len);
336 extern acpi_handle ec_get_handle(void);
337
338 extern bool acpi_is_pnp_device(struct acpi_device *);
339
340 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
341
342 typedef void (*wmi_notify_handler) (u32 value, void *context);
343
344 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
345 u32 method_id,
346 const struct acpi_buffer *in,
347 struct acpi_buffer *out);
348 extern acpi_status wmi_query_block(const char *guid, u8 instance,
349 struct acpi_buffer *out);
350 extern acpi_status wmi_set_block(const char *guid, u8 instance,
351 const struct acpi_buffer *in);
352 extern acpi_status wmi_install_notify_handler(const char *guid,
353 wmi_notify_handler handler, void *data);
354 extern acpi_status wmi_remove_notify_handler(const char *guid);
355 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
356 extern bool wmi_has_guid(const char *guid);
357
358 #endif /* CONFIG_ACPI_WMI */
359
360 #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
361 #define ACPI_VIDEO_DEVICE_POSTING 0x0002
362 #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
363 #define ACPI_VIDEO_BACKLIGHT 0x0008
364 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
365 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
366 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
367 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
368 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
369 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
370 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
371 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
372
373 extern char acpi_video_backlight_string[];
374 extern long acpi_is_video_device(acpi_handle handle);
375 extern int acpi_blacklisted(void);
376 extern void acpi_osi_setup(char *str);
377 extern bool acpi_osi_is_win8(void);
378
379 #ifdef CONFIG_ACPI_NUMA
380 int acpi_map_pxm_to_online_node(int pxm);
381 int acpi_get_node(acpi_handle handle);
382 #else
383 static inline int acpi_map_pxm_to_online_node(int pxm)
384 {
385 return 0;
386 }
387 static inline int acpi_get_node(acpi_handle handle)
388 {
389 return 0;
390 }
391 #endif
392 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
393
394 extern int pnpacpi_disabled;
395
396 #define PXM_INVAL (-1)
397
398 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
399 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
400 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
401 struct resource_win *win);
402 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
403 struct resource_win *win);
404 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
405 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
406 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
407 struct resource *res);
408
409 void acpi_dev_free_resource_list(struct list_head *list);
410 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
411 int (*preproc)(struct acpi_resource *, void *),
412 void *preproc_data);
413 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
414 unsigned long types);
415
416 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
417 void *arg)
418 {
419 return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
420 }
421
422 int acpi_check_resource_conflict(const struct resource *res);
423
424 int acpi_check_region(resource_size_t start, resource_size_t n,
425 const char *name);
426
427 int acpi_resources_are_enforced(void);
428
429 #ifdef CONFIG_HIBERNATION
430 void __init acpi_no_s4_hw_signature(void);
431 #endif
432
433 #ifdef CONFIG_PM_SLEEP
434 void __init acpi_old_suspend_ordering(void);
435 void __init acpi_nvs_nosave(void);
436 void __init acpi_nvs_nosave_s3(void);
437 #endif /* CONFIG_PM_SLEEP */
438
439 struct acpi_osc_context {
440 char *uuid_str; /* UUID string */
441 int rev;
442 struct acpi_buffer cap; /* list of DWORD capabilities */
443 struct acpi_buffer ret; /* free by caller if success */
444 };
445
446 acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
447 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
448
449 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
450 #define OSC_QUERY_DWORD 0 /* DWORD 1 */
451 #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
452 #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
453
454 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
455 #define OSC_QUERY_ENABLE 0x00000001 /* input */
456 #define OSC_REQUEST_ERROR 0x00000002 /* return */
457 #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
458 #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
459 #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
460
461 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
462 #define OSC_SB_PAD_SUPPORT 0x00000001
463 #define OSC_SB_PPC_OST_SUPPORT 0x00000002
464 #define OSC_SB_PR3_SUPPORT 0x00000004
465 #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
466 #define OSC_SB_APEI_SUPPORT 0x00000010
467 #define OSC_SB_CPC_SUPPORT 0x00000020
468 #define OSC_SB_CPCV2_SUPPORT 0x00000040
469 #define OSC_SB_PCLPI_SUPPORT 0x00000080
470 #define OSC_SB_OSLPI_SUPPORT 0x00000100
471
472 extern bool osc_sb_apei_support_acked;
473 extern bool osc_pc_lpi_support_confirmed;
474
475 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
476 #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
477 #define OSC_PCI_ASPM_SUPPORT 0x00000002
478 #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
479 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
480 #define OSC_PCI_MSI_SUPPORT 0x00000010
481 #define OSC_PCI_SUPPORT_MASKS 0x0000001f
482
483 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
484 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
485 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
486 #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
487 #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
488 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
489 #define OSC_PCI_CONTROL_MASKS 0x0000001f
490
491 #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
492 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
493 #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
494 #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
495 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
496 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
497 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
498 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
499 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
500 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
501
502 extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
503 u32 *mask, u32 req);
504
505 /* Enable _OST when all relevant hotplug operations are enabled */
506 #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
507 defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
508 defined(CONFIG_ACPI_CONTAINER)
509 #define ACPI_HOTPLUG_OST
510 #endif
511
512 /* _OST Source Event Code (OSPM Action) */
513 #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
514 #define ACPI_OST_EC_OSPM_EJECT 0x103
515 #define ACPI_OST_EC_OSPM_INSERTION 0x200
516
517 /* _OST General Processing Status Code */
518 #define ACPI_OST_SC_SUCCESS 0x0
519 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
520 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
521
522 /* _OST OS Shutdown Processing (0x100) Status Code */
523 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
524 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
525 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
526 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
527
528 /* _OST Ejection Request (0x3, 0x103) Status Code */
529 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
530 #define ACPI_OST_SC_DEVICE_IN_USE 0x81
531 #define ACPI_OST_SC_DEVICE_BUSY 0x82
532 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
533 #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
534
535 /* _OST Insertion Request (0x200) Status Code */
536 #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
537 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
538 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
539
540 extern void acpi_early_init(void);
541 extern void acpi_subsystem_init(void);
542
543 extern int acpi_nvs_register(__u64 start, __u64 size);
544
545 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
546 void *data);
547
548 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
549 const struct device *dev);
550
551 extern bool acpi_driver_match_device(struct device *dev,
552 const struct device_driver *drv);
553 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
554 int acpi_device_modalias(struct device *, char *, int);
555 void acpi_walk_dep_device_list(acpi_handle handle);
556
557 struct platform_device *acpi_create_platform_device(struct acpi_device *);
558 #define ACPI_PTR(_ptr) (_ptr)
559
560 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
561 {
562 adev->flags.visited = true;
563 }
564
565 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
566 {
567 adev->flags.visited = false;
568 }
569
570 enum acpi_reconfig_event {
571 ACPI_RECONFIG_DEVICE_ADD = 0,
572 ACPI_RECONFIG_DEVICE_REMOVE,
573 };
574
575 int acpi_reconfig_notifier_register(struct notifier_block *nb);
576 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
577
578 #else /* !CONFIG_ACPI */
579
580 #define acpi_disabled 1
581
582 #define ACPI_COMPANION(dev) (NULL)
583 #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
584 #define ACPI_HANDLE(dev) (NULL)
585 #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
586
587 struct fwnode_handle;
588
589 static inline bool acpi_dev_found(const char *hid)
590 {
591 return false;
592 }
593
594 static inline bool is_acpi_node(struct fwnode_handle *fwnode)
595 {
596 return false;
597 }
598
599 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
600 {
601 return false;
602 }
603
604 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
605 {
606 return NULL;
607 }
608
609 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
610 {
611 return false;
612 }
613
614 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
615 {
616 return NULL;
617 }
618
619 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode,
620 const char *name)
621 {
622 return false;
623 }
624
625 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
626 {
627 return NULL;
628 }
629
630 static inline bool has_acpi_companion(struct device *dev)
631 {
632 return false;
633 }
634
635 static inline void acpi_preset_companion(struct device *dev,
636 struct acpi_device *parent, u64 addr)
637 {
638 }
639
640 static inline const char *acpi_dev_name(struct acpi_device *adev)
641 {
642 return NULL;
643 }
644
645 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
646 {
647 return NULL;
648 }
649
650 static inline void acpi_early_init(void) { }
651 static inline void acpi_subsystem_init(void) { }
652
653 static inline int early_acpi_boot_init(void)
654 {
655 return 0;
656 }
657 static inline int acpi_boot_init(void)
658 {
659 return 0;
660 }
661
662 static inline void acpi_boot_table_init(void)
663 {
664 return;
665 }
666
667 static inline int acpi_mps_check(void)
668 {
669 return 0;
670 }
671
672 static inline int acpi_check_resource_conflict(struct resource *res)
673 {
674 return 0;
675 }
676
677 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
678 const char *name)
679 {
680 return 0;
681 }
682
683 struct acpi_table_header;
684 static inline int acpi_table_parse(char *id,
685 int (*handler)(struct acpi_table_header *))
686 {
687 return -ENODEV;
688 }
689
690 static inline int acpi_nvs_register(__u64 start, __u64 size)
691 {
692 return 0;
693 }
694
695 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
696 void *data)
697 {
698 return 0;
699 }
700
701 struct acpi_device_id;
702
703 static inline const struct acpi_device_id *acpi_match_device(
704 const struct acpi_device_id *ids, const struct device *dev)
705 {
706 return NULL;
707 }
708
709 static inline bool acpi_driver_match_device(struct device *dev,
710 const struct device_driver *drv)
711 {
712 return false;
713 }
714
715 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
716 const u8 *uuid,
717 int rev, int func,
718 union acpi_object *argv4)
719 {
720 return NULL;
721 }
722
723 static inline int acpi_device_uevent_modalias(struct device *dev,
724 struct kobj_uevent_env *env)
725 {
726 return -ENODEV;
727 }
728
729 static inline int acpi_device_modalias(struct device *dev,
730 char *buf, int size)
731 {
732 return -ENODEV;
733 }
734
735 static inline bool acpi_dma_supported(struct acpi_device *adev)
736 {
737 return false;
738 }
739
740 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
741 {
742 return DEV_DMA_NOT_SUPPORTED;
743 }
744
745 #define ACPI_PTR(_ptr) (NULL)
746
747 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
748 {
749 }
750
751 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
752 {
753 }
754
755 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
756 {
757 return -EINVAL;
758 }
759
760 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
761 {
762 return -EINVAL;
763 }
764
765 #endif /* !CONFIG_ACPI */
766
767 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
768 int acpi_ioapic_add(acpi_handle root);
769 #else
770 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
771 #endif
772
773 #ifdef CONFIG_ACPI
774 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
775 u32 pm1a_ctrl, u32 pm1b_ctrl));
776
777 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
778 u32 pm1a_control, u32 pm1b_control);
779
780 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
781 u32 val_a, u32 val_b));
782
783 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
784 u32 val_a, u32 val_b);
785
786 #ifdef CONFIG_X86
787 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
788 #else
789 static inline void arch_reserve_mem_area(acpi_physical_address addr,
790 size_t size)
791 {
792 }
793 #endif /* CONFIG_X86 */
794 #else
795 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
796 #endif
797
798 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
799 int acpi_dev_runtime_suspend(struct device *dev);
800 int acpi_dev_runtime_resume(struct device *dev);
801 int acpi_subsys_runtime_suspend(struct device *dev);
802 int acpi_subsys_runtime_resume(struct device *dev);
803 struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
804 int acpi_dev_pm_attach(struct device *dev, bool power_on);
805 #else
806 static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
807 static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
808 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
809 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
810 static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
811 {
812 return NULL;
813 }
814 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
815 {
816 return -ENODEV;
817 }
818 #endif
819
820 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
821 int acpi_dev_suspend_late(struct device *dev);
822 int acpi_dev_resume_early(struct device *dev);
823 int acpi_subsys_prepare(struct device *dev);
824 void acpi_subsys_complete(struct device *dev);
825 int acpi_subsys_suspend_late(struct device *dev);
826 int acpi_subsys_resume_early(struct device *dev);
827 int acpi_subsys_suspend(struct device *dev);
828 int acpi_subsys_freeze(struct device *dev);
829 #else
830 static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
831 static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
832 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
833 static inline void acpi_subsys_complete(struct device *dev) {}
834 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
835 static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
836 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
837 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
838 #endif
839
840 #ifdef CONFIG_ACPI
841 __printf(3, 4)
842 void acpi_handle_printk(const char *level, acpi_handle handle,
843 const char *fmt, ...);
844 #else /* !CONFIG_ACPI */
845 static inline __printf(3, 4) void
846 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
847 #endif /* !CONFIG_ACPI */
848
849 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
850 __printf(3, 4)
851 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
852 #else
853 #define __acpi_handle_debug(descriptor, handle, fmt, ...) \
854 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
855 #endif
856
857 /*
858 * acpi_handle_<level>: Print message with ACPI prefix and object path
859 *
860 * These interfaces acquire the global namespace mutex to obtain an object
861 * path. In interrupt context, it shows the object path as <n/a>.
862 */
863 #define acpi_handle_emerg(handle, fmt, ...) \
864 acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
865 #define acpi_handle_alert(handle, fmt, ...) \
866 acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
867 #define acpi_handle_crit(handle, fmt, ...) \
868 acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
869 #define acpi_handle_err(handle, fmt, ...) \
870 acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
871 #define acpi_handle_warn(handle, fmt, ...) \
872 acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
873 #define acpi_handle_notice(handle, fmt, ...) \
874 acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
875 #define acpi_handle_info(handle, fmt, ...) \
876 acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
877
878 #if defined(DEBUG)
879 #define acpi_handle_debug(handle, fmt, ...) \
880 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
881 #else
882 #if defined(CONFIG_DYNAMIC_DEBUG)
883 #define acpi_handle_debug(handle, fmt, ...) \
884 do { \
885 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
886 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
887 __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt), \
888 ##__VA_ARGS__); \
889 } while (0)
890 #else
891 #define acpi_handle_debug(handle, fmt, ...) \
892 ({ \
893 if (0) \
894 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
895 0; \
896 })
897 #endif
898 #endif
899
900 struct acpi_gpio_params {
901 unsigned int crs_entry_index;
902 unsigned int line_index;
903 bool active_low;
904 };
905
906 struct acpi_gpio_mapping {
907 const char *name;
908 const struct acpi_gpio_params *data;
909 unsigned int size;
910 };
911
912 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
913 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
914 const struct acpi_gpio_mapping *gpios);
915
916 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
917 {
918 if (adev)
919 adev->driver_gpios = NULL;
920 }
921
922 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
923 #else
924 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
925 const struct acpi_gpio_mapping *gpios)
926 {
927 return -ENXIO;
928 }
929 static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
930
931 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
932 {
933 return -ENXIO;
934 }
935 #endif
936
937 /* Device properties */
938
939 #define MAX_ACPI_REFERENCE_ARGS 8
940 struct acpi_reference_args {
941 struct acpi_device *adev;
942 size_t nargs;
943 u64 args[MAX_ACPI_REFERENCE_ARGS];
944 };
945
946 #ifdef CONFIG_ACPI
947 int acpi_dev_get_property(struct acpi_device *adev, const char *name,
948 acpi_object_type type, const union acpi_object **obj);
949 int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
950 const char *name, size_t index,
951 struct acpi_reference_args *args);
952
953 int acpi_node_prop_get(struct fwnode_handle *fwnode, const char *propname,
954 void **valptr);
955 int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
956 enum dev_prop_type proptype, void *val);
957 int acpi_node_prop_read(struct fwnode_handle *fwnode, const char *propname,
958 enum dev_prop_type proptype, void *val, size_t nval);
959 int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
960 enum dev_prop_type proptype, void *val, size_t nval);
961
962 struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
963 struct fwnode_handle *subnode);
964
965 struct acpi_probe_entry;
966 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
967 struct acpi_probe_entry *);
968
969 #define ACPI_TABLE_ID_LEN 5
970
971 /**
972 * struct acpi_probe_entry - boot-time probing entry
973 * @id: ACPI table name
974 * @type: Optional subtable type to match
975 * (if @id contains subtables)
976 * @subtable_valid: Optional callback to check the validity of
977 * the subtable
978 * @probe_table: Callback to the driver being probed when table
979 * match is successful
980 * @probe_subtbl: Callback to the driver being probed when table and
981 * subtable match (and optional callback is successful)
982 * @driver_data: Sideband data provided back to the driver
983 */
984 struct acpi_probe_entry {
985 __u8 id[ACPI_TABLE_ID_LEN];
986 __u8 type;
987 acpi_probe_entry_validate_subtbl subtable_valid;
988 union {
989 acpi_tbl_table_handler probe_table;
990 acpi_tbl_entry_handler probe_subtbl;
991 };
992 kernel_ulong_t driver_data;
993 };
994
995 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
996 static const struct acpi_probe_entry __acpi_probe_##name \
997 __used __section(__##table##_acpi_probe_table) \
998 = { \
999 .id = table_id, \
1000 .type = subtable, \
1001 .subtable_valid = valid, \
1002 .probe_table = (acpi_tbl_table_handler)fn, \
1003 .driver_data = data, \
1004 }
1005
1006 #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
1007 #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
1008
1009 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1010
1011 #define acpi_probe_device_table(t) \
1012 ({ \
1013 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1014 ACPI_PROBE_TABLE_END(t); \
1015 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
1016 (&ACPI_PROBE_TABLE_END(t) - \
1017 &ACPI_PROBE_TABLE(t))); \
1018 })
1019 #else
1020 static inline int acpi_dev_get_property(struct acpi_device *adev,
1021 const char *name, acpi_object_type type,
1022 const union acpi_object **obj)
1023 {
1024 return -ENXIO;
1025 }
1026
1027 static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
1028 const char *name, size_t index,
1029 struct acpi_reference_args *args)
1030 {
1031 return -ENXIO;
1032 }
1033
1034 static inline int acpi_node_prop_get(struct fwnode_handle *fwnode,
1035 const char *propname,
1036 void **valptr)
1037 {
1038 return -ENXIO;
1039 }
1040
1041 static inline int acpi_dev_prop_get(struct acpi_device *adev,
1042 const char *propname,
1043 void **valptr)
1044 {
1045 return -ENXIO;
1046 }
1047
1048 static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
1049 const char *propname,
1050 enum dev_prop_type proptype,
1051 void *val)
1052 {
1053 return -ENXIO;
1054 }
1055
1056 static inline int acpi_node_prop_read(struct fwnode_handle *fwnode,
1057 const char *propname,
1058 enum dev_prop_type proptype,
1059 void *val, size_t nval)
1060 {
1061 return -ENXIO;
1062 }
1063
1064 static inline int acpi_dev_prop_read(struct acpi_device *adev,
1065 const char *propname,
1066 enum dev_prop_type proptype,
1067 void *val, size_t nval)
1068 {
1069 return -ENXIO;
1070 }
1071
1072 static inline struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
1073 struct fwnode_handle *subnode)
1074 {
1075 return NULL;
1076 }
1077
1078 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1079 static const void * __acpi_table_##name[] \
1080 __attribute__((unused)) \
1081 = { (void *) table_id, \
1082 (void *) subtable, \
1083 (void *) valid, \
1084 (void *) fn, \
1085 (void *) data }
1086
1087 #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
1088 #endif
1089
1090 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1091 void acpi_table_upgrade(void);
1092 #else
1093 static inline void acpi_table_upgrade(void) { }
1094 #endif
1095
1096 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1097 extern bool acpi_has_watchdog(void);
1098 #else
1099 static inline bool acpi_has_watchdog(void) { return false; }
1100 #endif
1101
1102 #ifdef CONFIG_ACPI_SPCR_TABLE
1103 int parse_spcr(bool earlycon);
1104 #else
1105 static inline int parse_spcr(bool earlycon) { return 0; }
1106 #endif
1107
1108 #endif /*_LINUX_ACPI_H*/