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