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