Merge branch 'clockevents/fixes' of git://git.linaro.org/people/daniel.lezcano/linux...
[linux-drm-fsl-dcu.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                 0x20131115
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 extern u32 acpi_rsdt_forced;
58
59 /*
60  * Globals that are publically available
61  */
62 extern u32 acpi_current_gpe_count;
63 extern struct acpi_table_fadt acpi_gbl_FADT;
64 extern u8 acpi_gbl_system_awake_and_running;
65 extern u8 acpi_gbl_reduced_hardware;    /* ACPI 5.0 */
66 extern u8 acpi_gbl_osi_data;
67
68 /* Runtime configuration of debug print levels */
69
70 extern u32 acpi_dbg_level;
71 extern u32 acpi_dbg_layer;
72
73 /* ACPICA runtime options */
74
75 extern u8 acpi_gbl_enable_interpreter_slack;
76 extern u8 acpi_gbl_all_methods_serialized;
77 extern u8 acpi_gbl_create_osi_method;
78 extern u8 acpi_gbl_use_default_register_widths;
79 extern acpi_name acpi_gbl_trace_method_name;
80 extern u32 acpi_gbl_trace_flags;
81 extern bool acpi_gbl_enable_aml_debug_object;
82 extern u8 acpi_gbl_copy_dsdt_locally;
83 extern u8 acpi_gbl_truncate_io_addresses;
84 extern u8 acpi_gbl_disable_auto_repair;
85 extern u8 acpi_gbl_disable_ssdt_table_load;
86
87 /*
88  * Hardware-reduced prototypes. All interfaces that use these macros will
89  * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
90  * is set to TRUE.
91  */
92 #if (!ACPI_REDUCED_HARDWARE)
93 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
94         prototype;
95
96 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
97         prototype;
98
99 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
100         prototype;
101
102 #else
103 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
104         static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
105
106 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
107         static ACPI_INLINE prototype {return(AE_OK);}
108
109 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
110         static ACPI_INLINE prototype {return;}
111
112 #endif                          /* !ACPI_REDUCED_HARDWARE */
113
114 /*
115  * Initialization
116  */
117 acpi_status __init
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 __init acpi_enable_subsystem(u32 flags);
124
125 acpi_status __init acpi_initialize_objects(u32 flags);
126
127 acpi_status __init acpi_terminate(void);
128
129 /*
130  * Miscellaneous global interfaces
131  */
132 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
133
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
282 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
283                                  acpi_remove_sci_handler(acpi_sci_handler
284                                                          address))
285
286 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
287                                  acpi_install_global_event_handler
288                                  (acpi_gbl_event_handler handler,
289                                   void *context))
290
291 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
292                                  acpi_install_fixed_event_handler(u32
293                                                                   acpi_event,
294                                                                   acpi_event_handler
295                                                                   handler,
296                                                                   void
297                                                                   *context))
298
299 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
300                                  acpi_remove_fixed_event_handler(u32 acpi_event,
301                                                                  acpi_event_handler
302                                                                  handler))
303
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
313 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
314                                  acpi_remove_gpe_handler(acpi_handle gpe_device,
315                                                          u32 gpe_number,
316                                                          acpi_gpe_handler
317                                                          address))
318 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
319                                         acpi_notify_handler handler,
320                                         void *context);
321
322 acpi_status
323 acpi_remove_notify_handler(acpi_handle device,
324                            u32 handler_type, acpi_notify_handler handler);
325
326 acpi_status
327 acpi_install_address_space_handler(acpi_handle device,
328                                    acpi_adr_space_type space_id,
329                                    acpi_adr_space_handler handler,
330                                    acpi_adr_space_setup setup, void *context);
331
332 acpi_status
333 acpi_remove_address_space_handler(acpi_handle device,
334                                   acpi_adr_space_type space_id,
335                                   acpi_adr_space_handler handler);
336
337 #ifdef ACPI_FUTURE_USAGE
338 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
339 #endif
340
341 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
342
343 /*
344  * Global Lock interfaces
345  */
346 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
347                                 acpi_acquire_global_lock(u16 timeout,
348                                                          u32 *handle))
349
350 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
351                                 acpi_release_global_lock(u32 handle))
352
353 /*
354  * Interfaces to AML mutex objects
355  */
356 acpi_status
357 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
358
359 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
360
361 /*
362  * Fixed Event interfaces
363  */
364 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
365                                 acpi_enable_event(u32 event, u32 flags))
366
367 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
368                                 acpi_disable_event(u32 event, u32 flags))
369
370 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
371
372 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
373                                 acpi_get_event_status(u32 event,
374                                                       acpi_event_status
375                                                       *event_status))
376
377 /*
378  * General Purpose Event (GPE) Interfaces
379  */
380 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
381
382 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
383                                 acpi_enable_gpe(acpi_handle gpe_device,
384                                                 u32 gpe_number))
385
386 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
387                                 acpi_disable_gpe(acpi_handle gpe_device,
388                                                  u32 gpe_number))
389
390 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
391                                 acpi_clear_gpe(acpi_handle gpe_device,
392                                                u32 gpe_number))
393
394 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
395                                 acpi_set_gpe(acpi_handle gpe_device,
396                                              u32 gpe_number, u8 action))
397
398 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
399                                 acpi_finish_gpe(acpi_handle gpe_device,
400                                                 u32 gpe_number))
401
402 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
403                                 acpi_setup_gpe_for_wake(acpi_handle
404                                                         parent_device,
405                                                         acpi_handle gpe_device,
406                                                         u32 gpe_number))
407
408 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
409                                  acpi_set_gpe_wake_mask(acpi_handle gpe_device,
410                                                         u32 gpe_number,
411                                                         u8 action))
412
413 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
414                                  acpi_get_gpe_status(acpi_handle gpe_device,
415                                                      u32 gpe_number,
416                                                      acpi_event_status
417                                                      *event_status))
418
419 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
420
421 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
422
423 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
424                                 acpi_get_gpe_device(u32 gpe_index,
425                                                     acpi_handle * gpe_device))
426
427 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
428                                 acpi_install_gpe_block(acpi_handle gpe_device,
429                                                        struct
430                                                        acpi_generic_address
431                                                        *gpe_block_address,
432                                                        u32 register_count,
433                                                        u32 interrupt_number))
434
435 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
436                                  acpi_remove_gpe_block(acpi_handle gpe_device))
437
438 /*
439  * Resource interfaces
440  */
441 typedef
442 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
443                                            void *context);
444
445 acpi_status
446 acpi_get_vendor_resource(acpi_handle device,
447                          char *name,
448                          struct acpi_vendor_uuid *uuid,
449                          struct acpi_buffer *ret_buffer);
450
451 acpi_status
452 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
453
454 #ifdef ACPI_FUTURE_USAGE
455 acpi_status
456 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
457 #endif
458
459 acpi_status
460 acpi_get_event_resources(acpi_handle device_handle,
461                          struct acpi_buffer *ret_buffer);
462
463 acpi_status
464 acpi_walk_resource_buffer(struct acpi_buffer *buffer,
465                           acpi_walk_resource_callback user_function,
466                           void *context);
467
468 acpi_status
469 acpi_walk_resources(acpi_handle device,
470                     char *name,
471                     acpi_walk_resource_callback user_function, void *context);
472
473 acpi_status
474 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
475
476 acpi_status
477 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
478
479 acpi_status
480 acpi_resource_to_address64(struct acpi_resource *resource,
481                            struct acpi_resource_address64 *out);
482
483 acpi_status
484 acpi_buffer_to_resource(u8 *aml_buffer,
485                         u16 aml_buffer_length,
486                         struct acpi_resource **resource_ptr);
487
488 /*
489  * Hardware (ACPI device) interfaces
490  */
491 acpi_status acpi_reset(void);
492
493 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
494
495 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
496
497 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
498                                 acpi_read_bit_register(u32 register_id,
499                                                        u32 *return_value))
500
501 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
502                                 acpi_write_bit_register(u32 register_id,
503                                                         u32 value))
504
505 /*
506  * Sleep/Wake interfaces
507  */
508 acpi_status
509 acpi_get_sleep_type_data(u8 sleep_state, u8 *slp_typ_a, u8 *slp_typ_b);
510
511 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
512
513 acpi_status acpi_enter_sleep_state(u8 sleep_state);
514
515 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
516
517 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
518
519 acpi_status acpi_leave_sleep_state(u8 sleep_state);
520
521 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
522                                 acpi_set_firmware_waking_vector(u32
523                                                                 physical_address))
524 #if ACPI_MACHINE_WIDTH == 64
525 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
526                                 acpi_set_firmware_waking_vector64(u64
527                                                                   physical_address))
528 #endif
529 /*
530  * ACPI Timer interfaces
531  */
532 #ifdef ACPI_FUTURE_USAGE
533 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
534                                 acpi_get_timer_resolution(u32 *resolution))
535
536 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
537
538 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
539                                 acpi_get_timer_duration(u32 start_ticks,
540                                                         u32 end_ticks,
541                                                         u32 *time_elapsed))
542 #endif                          /* ACPI_FUTURE_USAGE */
543
544 /*
545  * Error/Warning output
546  */
547 ACPI_PRINTF_LIKE(3)
548 void ACPI_INTERNAL_VAR_XFACE
549 acpi_error(const char *module_name, u32 line_number, const char *format, ...);
550
551 ACPI_PRINTF_LIKE(4)
552 void ACPI_INTERNAL_VAR_XFACE
553 acpi_exception(const char *module_name,
554                u32 line_number, acpi_status status, const char *format, ...);
555
556 ACPI_PRINTF_LIKE(3)
557 void ACPI_INTERNAL_VAR_XFACE
558 acpi_warning(const char *module_name, u32 line_number, const char *format, ...);
559
560 ACPI_PRINTF_LIKE(3)
561 void ACPI_INTERNAL_VAR_XFACE
562 acpi_info(const char *module_name, u32 line_number, const char *format, ...);
563
564 ACPI_PRINTF_LIKE(3)
565 void ACPI_INTERNAL_VAR_XFACE
566 acpi_bios_error(const char *module_name,
567                 u32 line_number, const char *format, ...);
568
569 ACPI_PRINTF_LIKE(3)
570 void ACPI_INTERNAL_VAR_XFACE
571 acpi_bios_warning(const char *module_name,
572                   u32 line_number, const char *format, ...);
573
574 /*
575  * Debug output
576  */
577 #ifdef ACPI_DEBUG_OUTPUT
578
579 ACPI_PRINTF_LIKE(6)
580 void ACPI_INTERNAL_VAR_XFACE
581 acpi_debug_print(u32 requested_debug_level,
582                  u32 line_number,
583                  const char *function_name,
584                  const char *module_name,
585                  u32 component_id, const char *format, ...);
586
587 ACPI_PRINTF_LIKE(6)
588 void ACPI_INTERNAL_VAR_XFACE
589 acpi_debug_print_raw(u32 requested_debug_level,
590                      u32 line_number,
591                      const char *function_name,
592                      const char *module_name,
593                      u32 component_id, const char *format, ...);
594 #endif
595
596 #endif                          /* __ACXFACE_H__ */