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