]> Pileus Git - ~andy/linux/blob - include/acpi/acpixf.h
ACPICA: Update version to 20131218.
[~andy/linux] / include / acpi / acpixf.h
1 /******************************************************************************
2  *
3  * Name: acpixf.h - External interfaces to the ACPI subsystem
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2013, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43
44 #ifndef __ACXFACE_H__
45 #define __ACXFACE_H__
46
47 /* Current ACPICA subsystem version in YYYYMMDD format */
48
49 #define ACPI_CA_VERSION                 0x20131218
50
51 #include <acpi/acconfig.h>
52 #include <acpi/actypes.h>
53 #include <acpi/actbl.h>
54 #include <acpi/acbuffer.h>
55
56 extern u8 acpi_gbl_permanent_mmap;
57
58 /*
59  * Globals that are publically available
60  */
61 extern u32 acpi_current_gpe_count;
62 extern struct acpi_table_fadt acpi_gbl_FADT;
63 extern u8 acpi_gbl_system_awake_and_running;
64 extern u8 acpi_gbl_reduced_hardware;    /* ACPI 5.0 */
65 extern u8 acpi_gbl_osi_data;
66
67 /* Runtime configuration of debug print levels */
68
69 extern u32 acpi_dbg_level;
70 extern u32 acpi_dbg_layer;
71
72 /* ACPICA runtime options */
73
74 extern u8 acpi_gbl_all_methods_serialized;
75 extern u8 acpi_gbl_copy_dsdt_locally;
76 extern u8 acpi_gbl_create_osi_method;
77 extern u8 acpi_gbl_disable_auto_repair;
78 extern u8 acpi_gbl_disable_ssdt_table_load;
79 extern u8 acpi_gbl_do_not_use_xsdt;
80 extern bool acpi_gbl_enable_aml_debug_object;
81 extern u8 acpi_gbl_enable_interpreter_slack;
82 extern u32 acpi_gbl_trace_flags;
83 extern acpi_name acpi_gbl_trace_method_name;
84 extern u8 acpi_gbl_truncate_io_addresses;
85 extern u8 acpi_gbl_use32_bit_fadt_addresses;
86 extern u8 acpi_gbl_use_default_register_widths;
87
88 /*
89  * Hardware-reduced prototypes. All interfaces that use these macros will
90  * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
91  * is set to TRUE.
92  */
93 #if (!ACPI_REDUCED_HARDWARE)
94 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
95         prototype;
96
97 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
98         prototype;
99
100 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
101         prototype;
102
103 #else
104 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
105         static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
106
107 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
108         static ACPI_INLINE prototype {return(AE_OK);}
109
110 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
111         static ACPI_INLINE prototype {return;}
112
113 #endif                          /* !ACPI_REDUCED_HARDWARE */
114
115 /*
116  * Initialization
117  */
118 acpi_status __init
119 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
120                        u32 initial_table_count, u8 allow_resize);
121
122 acpi_status __init acpi_initialize_subsystem(void);
123
124 acpi_status __init acpi_enable_subsystem(u32 flags);
125
126 acpi_status __init acpi_initialize_objects(u32 flags);
127
128 acpi_status __init acpi_terminate(void);
129
130 /*
131  * Miscellaneous global interfaces
132  */
133 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
134 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
135 #ifdef ACPI_FUTURE_USAGE
136 acpi_status acpi_subsystem_status(void);
137 #endif
138
139 #ifdef ACPI_FUTURE_USAGE
140 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
141 #endif
142
143 acpi_status acpi_get_statistics(struct acpi_statistics *stats);
144
145 const char *acpi_format_exception(acpi_status exception);
146
147 acpi_status acpi_purge_cached_objects(void);
148
149 acpi_status acpi_install_interface(acpi_string interface_name);
150
151 acpi_status acpi_remove_interface(acpi_string interface_name);
152
153 acpi_status acpi_update_interfaces(u8 action);
154
155 u32
156 acpi_check_address_range(acpi_adr_space_type space_id,
157                          acpi_physical_address address,
158                          acpi_size length, u8 warn);
159
160 acpi_status
161 acpi_decode_pld_buffer(u8 *in_buffer,
162                        acpi_size length, struct acpi_pld_info **return_buffer);
163
164 /*
165  * ACPI table load/unload interfaces
166  */
167 acpi_status acpi_load_table(struct acpi_table_header *table);
168
169 acpi_status acpi_unload_parent_table(acpi_handle object);
170
171 acpi_status __init acpi_load_tables(void);
172
173 /*
174  * ACPI table manipulation interfaces
175  */
176 acpi_status __init acpi_reallocate_root_table(void);
177
178 acpi_status __init acpi_find_root_pointer(acpi_size *rsdp_address);
179
180 acpi_status acpi_unload_table_id(acpi_owner_id id);
181
182 acpi_status
183 acpi_get_table_header(acpi_string signature,
184                       u32 instance, struct acpi_table_header *out_table_header);
185
186 acpi_status
187 acpi_get_table_with_size(acpi_string signature,
188                u32 instance, struct acpi_table_header **out_table,
189                acpi_size *tbl_size);
190
191 acpi_status
192 acpi_get_table(acpi_string signature,
193                u32 instance, struct acpi_table_header **out_table);
194
195 acpi_status
196 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
197
198 acpi_status
199 acpi_install_table_handler(acpi_table_handler handler, void *context);
200
201 acpi_status acpi_remove_table_handler(acpi_table_handler handler);
202
203 /*
204  * Namespace and name interfaces
205  */
206 acpi_status
207 acpi_walk_namespace(acpi_object_type type,
208                     acpi_handle start_object,
209                     u32 max_depth,
210                     acpi_walk_callback descending_callback,
211                     acpi_walk_callback ascending_callback,
212                     void *context, void **return_value);
213
214 acpi_status
215 acpi_get_devices(const char *HID,
216                  acpi_walk_callback user_function,
217                  void *context, void **return_value);
218
219 acpi_status
220 acpi_get_name(acpi_handle object,
221               u32 name_type, struct acpi_buffer *ret_path_ptr);
222
223 acpi_status
224 acpi_get_handle(acpi_handle parent,
225                 acpi_string pathname, acpi_handle * ret_handle);
226
227 acpi_status
228 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
229
230 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
231
232 acpi_status
233 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
234
235 acpi_status
236 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
237
238 /*
239  * Object manipulation and enumeration
240  */
241 acpi_status
242 acpi_evaluate_object(acpi_handle object,
243                      acpi_string pathname,
244                      struct acpi_object_list *parameter_objects,
245                      struct acpi_buffer *return_object_buffer);
246
247 acpi_status
248 acpi_evaluate_object_typed(acpi_handle object,
249                            acpi_string pathname,
250                            struct acpi_object_list *external_params,
251                            struct acpi_buffer *return_buffer,
252                            acpi_object_type return_type);
253
254 acpi_status
255 acpi_get_object_info(acpi_handle object,
256                      struct acpi_device_info **return_buffer);
257
258 acpi_status acpi_install_method(u8 *buffer);
259
260 acpi_status
261 acpi_get_next_object(acpi_object_type type,
262                      acpi_handle parent,
263                      acpi_handle child, acpi_handle * out_handle);
264
265 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
266
267 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
268
269 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
270
271 /*
272  * Handler interfaces
273  */
274 acpi_status
275 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
276
277 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
278                                 acpi_install_sci_handler(acpi_sci_handler
279                                                          address,
280                                                          void *context))
281 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
282                                  acpi_remove_sci_handler(acpi_sci_handler
283                                                          address))
284 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
285                                  acpi_install_global_event_handler
286                                  (acpi_gbl_event_handler handler,
287                                   void *context))
288 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
289                                  acpi_install_fixed_event_handler(u32
290                                                                   acpi_event,
291                                                                   acpi_event_handler
292                                                                   handler,
293                                                                   void
294                                                                   *context))
295 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
296                                  acpi_remove_fixed_event_handler(u32 acpi_event,
297                                                                  acpi_event_handler
298                                                                  handler))
299 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
300                                  acpi_install_gpe_handler(acpi_handle
301                                                           gpe_device,
302                                                           u32 gpe_number,
303                                                           u32 type,
304                                                           acpi_gpe_handler
305                                                           address,
306                                                           void *context))
307 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
308                                  acpi_remove_gpe_handler(acpi_handle gpe_device,
309                                                          u32 gpe_number,
310                                                          acpi_gpe_handler
311                                                          address))
312 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
313                                          acpi_notify_handler handler,
314                                          void *context);
315
316 acpi_status
317 acpi_remove_notify_handler(acpi_handle device,
318                            u32 handler_type, acpi_notify_handler handler);
319
320 acpi_status
321 acpi_install_address_space_handler(acpi_handle device,
322                                    acpi_adr_space_type space_id,
323                                    acpi_adr_space_handler handler,
324                                    acpi_adr_space_setup setup, void *context);
325
326 acpi_status
327 acpi_remove_address_space_handler(acpi_handle device,
328                                   acpi_adr_space_type space_id,
329                                   acpi_adr_space_handler handler);
330
331 #ifdef ACPI_FUTURE_USAGE
332 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
333 #endif
334
335 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
336
337 /*
338  * Global Lock interfaces
339  */
340 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
341                                 acpi_acquire_global_lock(u16 timeout,
342                                                          u32 *handle))
343
344 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
345                                 acpi_release_global_lock(u32 handle))
346
347 /*
348  * Interfaces to AML mutex objects
349  */
350 acpi_status
351 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
352
353 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
354
355 /*
356  * Fixed Event interfaces
357  */
358 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
359                                 acpi_enable_event(u32 event, u32 flags))
360
361 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
362                                 acpi_disable_event(u32 event, u32 flags))
363 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
364
365 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
366                                 acpi_get_event_status(u32 event,
367                                                       acpi_event_status
368                                                       *event_status))
369
370 /*
371  * General Purpose Event (GPE) Interfaces
372  */
373 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
374
375 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
376                                 acpi_enable_gpe(acpi_handle gpe_device,
377                                                 u32 gpe_number))
378
379 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
380                                 acpi_disable_gpe(acpi_handle gpe_device,
381                                                  u32 gpe_number))
382
383 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
384                                 acpi_clear_gpe(acpi_handle gpe_device,
385                                                u32 gpe_number))
386
387 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
388                                 acpi_set_gpe(acpi_handle gpe_device,
389                                              u32 gpe_number, u8 action))
390
391 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
392                                 acpi_finish_gpe(acpi_handle gpe_device,
393                                                 u32 gpe_number))
394
395 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
396                                 acpi_setup_gpe_for_wake(acpi_handle
397                                                         parent_device,
398                                                         acpi_handle gpe_device,
399                                                         u32 gpe_number))
400 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
401                                  acpi_set_gpe_wake_mask(acpi_handle gpe_device,
402                                                         u32 gpe_number,
403                                                         u8 action))
404 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
405                                  acpi_get_gpe_status(acpi_handle gpe_device,
406                                                      u32 gpe_number,
407                                                      acpi_event_status
408                                                      *event_status))
409 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
410 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
411
412 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
413                                 acpi_get_gpe_device(u32 gpe_index,
414                                                     acpi_handle * gpe_device))
415
416 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
417                                 acpi_install_gpe_block(acpi_handle gpe_device,
418                                                        struct
419                                                        acpi_generic_address
420                                                        *gpe_block_address,
421                                                        u32 register_count,
422                                                        u32 interrupt_number))
423 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
424                                  acpi_remove_gpe_block(acpi_handle gpe_device))
425
426 /*
427  * Resource interfaces
428  */
429 typedef
430 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
431                                            void *context);
432
433 acpi_status
434 acpi_get_vendor_resource(acpi_handle device,
435                          char *name,
436                          struct acpi_vendor_uuid *uuid,
437                          struct acpi_buffer *ret_buffer);
438
439 acpi_status
440 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
441
442 #ifdef ACPI_FUTURE_USAGE
443 acpi_status
444 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
445 #endif
446
447 acpi_status
448 acpi_get_event_resources(acpi_handle device_handle,
449                          struct acpi_buffer *ret_buffer);
450
451 acpi_status
452 acpi_walk_resource_buffer(struct acpi_buffer *buffer,
453                           acpi_walk_resource_callback user_function,
454                           void *context);
455
456 acpi_status
457 acpi_walk_resources(acpi_handle device,
458                     char *name,
459                     acpi_walk_resource_callback user_function, void *context);
460
461 acpi_status
462 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
463
464 acpi_status
465 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
466
467 acpi_status
468 acpi_resource_to_address64(struct acpi_resource *resource,
469                            struct acpi_resource_address64 *out);
470
471 acpi_status
472 acpi_buffer_to_resource(u8 *aml_buffer,
473                         u16 aml_buffer_length,
474                         struct acpi_resource **resource_ptr);
475
476 /*
477  * Hardware (ACPI device) interfaces
478  */
479 acpi_status acpi_reset(void);
480
481 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
482
483 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
484
485 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
486                                 acpi_read_bit_register(u32 register_id,
487                                                        u32 *return_value))
488
489 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
490                                 acpi_write_bit_register(u32 register_id,
491                                                         u32 value))
492
493 /*
494  * Sleep/Wake interfaces
495  */
496 acpi_status
497 acpi_get_sleep_type_data(u8 sleep_state, u8 *slp_typ_a, u8 *slp_typ_b);
498
499 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
500
501 acpi_status acpi_enter_sleep_state(u8 sleep_state);
502
503 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
504
505 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
506
507 acpi_status acpi_leave_sleep_state(u8 sleep_state);
508
509 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
510                                 acpi_set_firmware_waking_vector(u32
511                                                                 physical_address))
512 #if ACPI_MACHINE_WIDTH == 64
513 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
514                                 acpi_set_firmware_waking_vector64(u64
515                                                                   physical_address))
516 #endif
517 /*
518  * ACPI Timer interfaces
519  */
520 #ifdef ACPI_FUTURE_USAGE
521 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
522                                 acpi_get_timer_resolution(u32 *resolution))
523 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
524
525 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
526                                 acpi_get_timer_duration(u32 start_ticks,
527                                                         u32 end_ticks,
528                                                         u32 *time_elapsed))
529 #endif                          /* ACPI_FUTURE_USAGE */
530
531 /*
532  * Error/Warning output
533  */
534 ACPI_PRINTF_LIKE(3)
535 void ACPI_INTERNAL_VAR_XFACE
536 acpi_error(const char *module_name, u32 line_number, const char *format, ...);
537
538 ACPI_PRINTF_LIKE(4)
539 void ACPI_INTERNAL_VAR_XFACE
540 acpi_exception(const char *module_name,
541                u32 line_number, acpi_status status, const char *format, ...);
542
543 ACPI_PRINTF_LIKE(3)
544 void ACPI_INTERNAL_VAR_XFACE
545 acpi_warning(const char *module_name, u32 line_number, const char *format, ...);
546
547 ACPI_PRINTF_LIKE(3)
548 void ACPI_INTERNAL_VAR_XFACE
549 acpi_info(const char *module_name, u32 line_number, const char *format, ...);
550
551 ACPI_PRINTF_LIKE(3)
552 void ACPI_INTERNAL_VAR_XFACE
553 acpi_bios_error(const char *module_name,
554                 u32 line_number, const char *format, ...);
555
556 ACPI_PRINTF_LIKE(3)
557 void ACPI_INTERNAL_VAR_XFACE
558 acpi_bios_warning(const char *module_name,
559                   u32 line_number, const char *format, ...);
560
561 /*
562  * Debug output
563  */
564 #ifdef ACPI_DEBUG_OUTPUT
565
566 ACPI_PRINTF_LIKE(6)
567 void ACPI_INTERNAL_VAR_XFACE
568 acpi_debug_print(u32 requested_debug_level,
569                  u32 line_number,
570                  const char *function_name,
571                  const char *module_name,
572                  u32 component_id, const char *format, ...);
573
574 ACPI_PRINTF_LIKE(6)
575 void ACPI_INTERNAL_VAR_XFACE
576 acpi_debug_print_raw(u32 requested_debug_level,
577                      u32 line_number,
578                      const char *function_name,
579                      const char *module_name,
580                      u32 component_id, const char *format, ...);
581 #endif
582
583 #endif                          /* __ACXFACE_H__ */