]> git.karo-electronics.de Git - karo-tx-linux.git/blob - include/acpi/acpixf.h
Merge remote-tracking branch 'spi/for-next'
[karo-tx-linux.git] / 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                 0x20130823
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_enable_interpreter_slack;
75 extern u8 acpi_gbl_all_methods_serialized;
76 extern u8 acpi_gbl_create_osi_method;
77 extern u8 acpi_gbl_use_default_register_widths;
78 extern acpi_name acpi_gbl_trace_method_name;
79 extern u32 acpi_gbl_trace_flags;
80 extern bool acpi_gbl_enable_aml_debug_object;
81 extern u8 acpi_gbl_copy_dsdt_locally;
82 extern u8 acpi_gbl_truncate_io_addresses;
83 extern u8 acpi_gbl_disable_auto_repair;
84 extern u8 acpi_gbl_disable_ssdt_table_load;
85
86 /*
87  * Hardware-reduced prototypes. All interfaces that use these macros will
88  * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
89  * is set to TRUE.
90  */
91 #if (!ACPI_REDUCED_HARDWARE)
92 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
93         prototype;
94
95 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
96         prototype;
97
98 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
99         prototype;
100
101 #else
102 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
103         static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
104
105 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
106         static ACPI_INLINE prototype {return(AE_OK);}
107
108 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
109         static ACPI_INLINE prototype {}
110
111 #endif                          /* !ACPI_REDUCED_HARDWARE */
112
113 extern u32 acpi_rsdt_forced;
114 /*
115  * Initialization
116  */
117 acpi_status
118 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
119                        u32 initial_table_count, u8 allow_resize);
120
121 acpi_status __init acpi_initialize_subsystem(void);
122
123 acpi_status acpi_enable_subsystem(u32 flags);
124
125 acpi_status acpi_initialize_objects(u32 flags);
126
127 acpi_status acpi_terminate(void);
128
129 /*
130  * Miscellaneous global interfaces
131  */
132 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
133 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
134 #ifdef ACPI_FUTURE_USAGE
135 acpi_status acpi_subsystem_status(void);
136 #endif
137
138 #ifdef ACPI_FUTURE_USAGE
139 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
140 #endif
141
142 const char *acpi_format_exception(acpi_status exception);
143
144 acpi_status acpi_purge_cached_objects(void);
145
146 acpi_status acpi_install_interface(acpi_string interface_name);
147
148 acpi_status acpi_remove_interface(acpi_string interface_name);
149
150 acpi_status acpi_update_interfaces(u8 action);
151
152 u32
153 acpi_check_address_range(acpi_adr_space_type space_id,
154                          acpi_physical_address address,
155                          acpi_size length, u8 warn);
156
157 acpi_status
158 acpi_decode_pld_buffer(u8 *in_buffer,
159                        acpi_size length, struct acpi_pld_info **return_buffer);
160
161 /*
162  * ACPI Memory management
163  */
164 void *acpi_allocate(u32 size);
165
166 void *acpi_callocate(u32 size);
167
168 void acpi_free(void *address);
169
170 /*
171  * ACPI table load/unload interfaces
172  */
173 acpi_status acpi_load_table(struct acpi_table_header *table);
174
175 acpi_status acpi_unload_parent_table(acpi_handle object);
176
177 acpi_status acpi_load_tables(void);
178
179 /*
180  * ACPI table manipulation interfaces
181  */
182 acpi_status acpi_reallocate_root_table(void);
183
184 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
185
186 acpi_status acpi_unload_table_id(acpi_owner_id id);
187
188 acpi_status
189 acpi_get_table_header(acpi_string signature,
190                       u32 instance, struct acpi_table_header *out_table_header);
191
192 acpi_status
193 acpi_get_table_with_size(acpi_string signature,
194                u32 instance, struct acpi_table_header **out_table,
195                acpi_size *tbl_size);
196 acpi_status
197 acpi_get_table(acpi_string signature,
198                u32 instance, struct acpi_table_header **out_table);
199
200 acpi_status
201 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
202
203 acpi_status
204 acpi_install_table_handler(acpi_table_handler handler, void *context);
205
206 acpi_status acpi_remove_table_handler(acpi_table_handler handler);
207
208 /*
209  * Namespace and name interfaces
210  */
211 acpi_status
212 acpi_walk_namespace(acpi_object_type type,
213                     acpi_handle start_object,
214                     u32 max_depth,
215                     acpi_walk_callback descending_callback,
216                     acpi_walk_callback ascending_callback,
217                     void *context, void **return_value);
218
219 acpi_status
220 acpi_get_devices(const char *HID,
221                  acpi_walk_callback user_function,
222                  void *context, void **return_value);
223
224 acpi_status
225 acpi_get_name(acpi_handle object,
226               u32 name_type, struct acpi_buffer *ret_path_ptr);
227
228 acpi_status
229 acpi_get_handle(acpi_handle parent,
230                 acpi_string pathname, acpi_handle * ret_handle);
231
232 acpi_status
233 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
234
235 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
236
237 acpi_status
238 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
239
240 acpi_status
241 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
242
243 /*
244  * Object manipulation and enumeration
245  */
246 acpi_status
247 acpi_evaluate_object(acpi_handle object,
248                      acpi_string pathname,
249                      struct acpi_object_list *parameter_objects,
250                      struct acpi_buffer *return_object_buffer);
251
252 acpi_status
253 acpi_evaluate_object_typed(acpi_handle object,
254                            acpi_string pathname,
255                            struct acpi_object_list *external_params,
256                            struct acpi_buffer *return_buffer,
257                            acpi_object_type return_type);
258
259 acpi_status
260 acpi_get_object_info(acpi_handle object,
261                      struct acpi_device_info **return_buffer);
262
263 acpi_status acpi_install_method(u8 *buffer);
264
265 acpi_status
266 acpi_get_next_object(acpi_object_type type,
267                      acpi_handle parent,
268                      acpi_handle child, acpi_handle * out_handle);
269
270 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
271
272 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
273
274 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
275
276 /*
277  * Handler interfaces
278  */
279 acpi_status
280 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
281
282 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
283                                 acpi_install_sci_handler(acpi_sci_handler
284                                                          address,
285                                                          void *context))
286 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
287                                  acpi_remove_sci_handler(acpi_sci_handler
288                                                          address))
289 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
290                                  acpi_install_global_event_handler
291                                  (acpi_gbl_event_handler handler,
292                                   void *context))
293 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
294                                  acpi_install_fixed_event_handler(u32
295                                                                   acpi_event,
296                                                                   acpi_event_handler
297                                                                   handler,
298                                                                   void
299                                                                   *context))
300 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
301                                  acpi_remove_fixed_event_handler(u32 acpi_event,
302                                                                  acpi_event_handler
303                                                                  handler))
304 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
305                                  acpi_install_gpe_handler(acpi_handle
306                                                           gpe_device,
307                                                           u32 gpe_number,
308                                                           u32 type,
309                                                           acpi_gpe_handler
310                                                           address,
311                                                           void *context))
312 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
313                                  acpi_remove_gpe_handler(acpi_handle gpe_device,
314                                                          u32 gpe_number,
315                                                          acpi_gpe_handler
316                                                          address))
317 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
318                                         acpi_notify_handler handler,
319                                         void *context);
320
321 acpi_status
322 acpi_remove_notify_handler(acpi_handle device,
323                            u32 handler_type, acpi_notify_handler handler);
324
325 acpi_status
326 acpi_install_address_space_handler(acpi_handle device,
327                                    acpi_adr_space_type space_id,
328                                    acpi_adr_space_handler handler,
329                                    acpi_adr_space_setup setup, void *context);
330
331 acpi_status
332 acpi_remove_address_space_handler(acpi_handle device,
333                                   acpi_adr_space_type space_id,
334                                   acpi_adr_space_handler handler);
335
336 #ifdef ACPI_FUTURE_USAGE
337 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
338 #endif
339
340 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
341
342 /*
343  * Global Lock interfaces
344  */
345 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
346                                 acpi_acquire_global_lock(u16 timeout,
347                                                          u32 *handle))
348 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
349                                 acpi_release_global_lock(u32 handle))
350
351 /*
352  * Interfaces to AML mutex objects
353  */
354 acpi_status
355 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
356
357 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
358
359 /*
360  * Fixed Event interfaces
361  */
362 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
363                                 acpi_enable_event(u32 event, u32 flags))
364
365 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
366                                 acpi_disable_event(u32 event, u32 flags))
367
368 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
369
370 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
371                                 acpi_get_event_status(u32 event,
372                                                       acpi_event_status
373                                                       *event_status))
374 /*
375  * General Purpose Event (GPE) Interfaces
376  */
377 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
378
379 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
380                                 acpi_enable_gpe(acpi_handle gpe_device,
381                                                 u32 gpe_number))
382
383 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
384                                 acpi_disable_gpe(acpi_handle gpe_device,
385                                                  u32 gpe_number))
386
387 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
388                                 acpi_clear_gpe(acpi_handle gpe_device,
389                                                u32 gpe_number))
390
391 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
392                                 acpi_set_gpe(acpi_handle gpe_device,
393                                              u32 gpe_number, u8 action))
394
395 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
396                                 acpi_finish_gpe(acpi_handle gpe_device,
397                                                 u32 gpe_number))
398
399 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
400                                 acpi_setup_gpe_for_wake(acpi_handle
401                                                         parent_device,
402                                                         acpi_handle gpe_device,
403                                                         u32 gpe_number))
404 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
405                                  acpi_set_gpe_wake_mask(acpi_handle gpe_device,
406                                                         u32 gpe_number,
407                                                         u8 action))
408 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
409                                  acpi_get_gpe_status(acpi_handle gpe_device,
410                                                      u32 gpe_number,
411                                                      acpi_event_status
412                                                      *event_status))
413
414 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
415
416 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
417
418 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
419                                 acpi_get_gpe_device(u32 gpe_index,
420                                                     acpi_handle * gpe_device))
421
422 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
423                                 acpi_install_gpe_block(acpi_handle gpe_device,
424                                                        struct
425                                                        acpi_generic_address
426                                                        *gpe_block_address,
427                                                        u32 register_count,
428                                                        u32 interrupt_number))
429 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
430                                  acpi_remove_gpe_block(acpi_handle gpe_device))
431
432 /*
433  * Resource interfaces
434  */
435 typedef
436 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
437                                            void *context);
438
439 acpi_status
440 acpi_get_vendor_resource(acpi_handle device,
441                          char *name,
442                          struct acpi_vendor_uuid *uuid,
443                          struct acpi_buffer *ret_buffer);
444
445 acpi_status
446 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
447
448 #ifdef ACPI_FUTURE_USAGE
449 acpi_status
450 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
451 #endif
452
453 acpi_status
454 acpi_get_event_resources(acpi_handle device_handle,
455                          struct acpi_buffer *ret_buffer);
456
457 acpi_status
458 acpi_walk_resource_buffer(struct acpi_buffer *buffer,
459                           acpi_walk_resource_callback user_function,
460                           void *context);
461
462 acpi_status
463 acpi_walk_resources(acpi_handle device,
464                     char *name,
465                     acpi_walk_resource_callback user_function, void *context);
466
467 acpi_status
468 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
469
470 acpi_status
471 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
472
473 acpi_status
474 acpi_resource_to_address64(struct acpi_resource *resource,
475                            struct acpi_resource_address64 *out);
476
477 acpi_status
478 acpi_buffer_to_resource(u8 *aml_buffer,
479                         u16 aml_buffer_length,
480                         struct acpi_resource **resource_ptr);
481
482 /*
483  * Hardware (ACPI device) interfaces
484  */
485 acpi_status acpi_reset(void);
486
487 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
488
489 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
490
491 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
492                                 acpi_read_bit_register(u32 register_id,
493                                                        u32 *return_value))
494
495 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
496                                 acpi_write_bit_register(u32 register_id,
497                                                         u32 value))
498
499 /*
500  * Sleep/Wake interfaces
501  */
502 acpi_status
503 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
504
505 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
506
507 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
508
509 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void))
510
511 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
512
513 acpi_status acpi_leave_sleep_state(u8 sleep_state);
514
515 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
516                                 acpi_set_firmware_waking_vector(u32
517                                                                 physical_address))
518
519 #if ACPI_MACHINE_WIDTH == 64
520 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
521                                 acpi_set_firmware_waking_vector64(u64
522                                                                   physical_address))
523 #endif
524 /*
525  * ACPI Timer interfaces
526  */
527 #ifdef ACPI_FUTURE_USAGE
528 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
529                                 acpi_get_timer_resolution(u32 *resolution))
530
531 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
532
533 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
534                                 acpi_get_timer_duration(u32 start_ticks,
535                                                         u32 end_ticks,
536                                                         u32 *time_elapsed))
537 #endif                          /* ACPI_FUTURE_USAGE */
538
539 /*
540  * Error/Warning output
541  */
542 void ACPI_INTERNAL_VAR_XFACE
543 acpi_error(const char *module_name,
544            u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
545
546 void ACPI_INTERNAL_VAR_XFACE
547 acpi_exception(const char *module_name,
548                u32 line_number,
549                acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
550
551 void ACPI_INTERNAL_VAR_XFACE
552 acpi_warning(const char *module_name,
553              u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
554
555 void ACPI_INTERNAL_VAR_XFACE
556 acpi_info(const char *module_name,
557           u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
558
559 void ACPI_INTERNAL_VAR_XFACE
560 acpi_bios_error(const char *module_name,
561                 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
562
563 void ACPI_INTERNAL_VAR_XFACE
564 acpi_bios_warning(const char *module_name,
565                   u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
566
567 /*
568  * Debug output
569  */
570 #ifdef ACPI_DEBUG_OUTPUT
571
572 void ACPI_INTERNAL_VAR_XFACE
573 acpi_debug_print(u32 requested_debug_level,
574                  u32 line_number,
575                  const char *function_name,
576                  const char *module_name,
577                  u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
578
579 void ACPI_INTERNAL_VAR_XFACE
580 acpi_debug_print_raw(u32 requested_debug_level,
581                      u32 line_number,
582                      const char *function_name,
583                      const char *module_name,
584                      u32 component_id,
585                      const char *format, ...) ACPI_PRINTF_LIKE(6);
586 #endif
587
588 #endif                          /* __ACXFACE_H__ */