acpixf.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912
  1. /******************************************************************************
  2. *
  3. * Name: acpixf.h - External interfaces to the ACPI subsystem
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2014, Intel Corp.
  8. * All rights reserved.
  9. *
  10. * Redistribution and use in source and binary forms, with or without
  11. * modification, are permitted provided that the following conditions
  12. * are met:
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions, and the following disclaimer,
  15. * without modification.
  16. * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  17. * substantially similar to the "NO WARRANTY" disclaimer below
  18. * ("Disclaimer") and any redistribution must be conditioned upon
  19. * including a substantially similar Disclaimer requirement for further
  20. * binary redistribution.
  21. * 3. Neither the names of the above-listed copyright holders nor the names
  22. * of any contributors may be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * Alternatively, this software may be distributed under the terms of the
  26. * GNU General Public License ("GPL") version 2 as published by the Free
  27. * Software Foundation.
  28. *
  29. * NO WARRANTY
  30. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  31. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  32. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  33. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  34. * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  38. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  39. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40. * POSSIBILITY OF SUCH DAMAGES.
  41. */
  42. #ifndef __ACXFACE_H__
  43. #define __ACXFACE_H__
  44. /* Current ACPICA subsystem version in YYYYMMDD format */
  45. #define ACPI_CA_VERSION 0x20140926
  46. #include <acpi/acconfig.h>
  47. #include <acpi/actypes.h>
  48. #include <acpi/actbl.h>
  49. #include <acpi/acbuffer.h>
  50. /*****************************************************************************
  51. *
  52. * Macros used for ACPICA globals and configuration
  53. *
  54. ****************************************************************************/
  55. /*
  56. * Ensure that global variables are defined and initialized only once.
  57. *
  58. * The use of these macros allows for a single list of globals (here)
  59. * in order to simplify maintenance of the code.
  60. */
  61. #ifdef DEFINE_ACPI_GLOBALS
  62. #define ACPI_GLOBAL(type,name) \
  63. extern type name; \
  64. type name
  65. #define ACPI_INIT_GLOBAL(type,name,value) \
  66. type name=value
  67. #else
  68. #ifndef ACPI_GLOBAL
  69. #define ACPI_GLOBAL(type,name) \
  70. extern type name
  71. #endif
  72. #ifndef ACPI_INIT_GLOBAL
  73. #define ACPI_INIT_GLOBAL(type,name,value) \
  74. extern type name
  75. #endif
  76. #endif
  77. /*
  78. * These macros configure the various ACPICA interfaces. They are
  79. * useful for generating stub inline functions for features that are
  80. * configured out of the current kernel or ACPICA application.
  81. */
  82. #ifndef ACPI_EXTERNAL_RETURN_STATUS
  83. #define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
  84. prototype;
  85. #endif
  86. #ifndef ACPI_EXTERNAL_RETURN_OK
  87. #define ACPI_EXTERNAL_RETURN_OK(prototype) \
  88. prototype;
  89. #endif
  90. #ifndef ACPI_EXTERNAL_RETURN_VOID
  91. #define ACPI_EXTERNAL_RETURN_VOID(prototype) \
  92. prototype;
  93. #endif
  94. #ifndef ACPI_EXTERNAL_RETURN_UINT32
  95. #define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
  96. prototype;
  97. #endif
  98. #ifndef ACPI_EXTERNAL_RETURN_PTR
  99. #define ACPI_EXTERNAL_RETURN_PTR(prototype) \
  100. prototype;
  101. #endif
  102. /*****************************************************************************
  103. *
  104. * Public globals and runtime configuration options
  105. *
  106. ****************************************************************************/
  107. /*
  108. * Enable "slack mode" of the AML interpreter? Default is FALSE, and the
  109. * interpreter strictly follows the ACPI specification. Setting to TRUE
  110. * allows the interpreter to ignore certain errors and/or bad AML constructs.
  111. *
  112. * Currently, these features are enabled by this flag:
  113. *
  114. * 1) Allow "implicit return" of last value in a control method
  115. * 2) Allow access beyond the end of an operation region
  116. * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
  117. * 4) Allow ANY object type to be a source operand for the Store() operator
  118. * 5) Allow unresolved references (invalid target name) in package objects
  119. * 6) Enable warning messages for behavior that is not ACPI spec compliant
  120. */
  121. ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_interpreter_slack, FALSE);
  122. /*
  123. * Automatically serialize all methods that create named objects? Default
  124. * is TRUE, meaning that all non_serialized methods are scanned once at
  125. * table load time to determine those that create named objects. Methods
  126. * that create named objects are marked Serialized in order to prevent
  127. * possible run-time problems if they are entered by more than one thread.
  128. */
  129. ACPI_INIT_GLOBAL(u8, acpi_gbl_auto_serialize_methods, TRUE);
  130. /*
  131. * Create the predefined _OSI method in the namespace? Default is TRUE
  132. * because ACPICA is fully compatible with other ACPI implementations.
  133. * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
  134. */
  135. ACPI_INIT_GLOBAL(u8, acpi_gbl_create_osi_method, TRUE);
  136. /*
  137. * Optionally use default values for the ACPI register widths. Set this to
  138. * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
  139. */
  140. ACPI_INIT_GLOBAL(u8, acpi_gbl_use_default_register_widths, TRUE);
  141. /*
  142. * Whether or not to verify the table checksum before installation. Set
  143. * this to TRUE to verify the table checksum before install it to the table
  144. * manager. Note that enabling this option causes errors to happen in some
  145. * OSPMs during early initialization stages. Default behavior is to do such
  146. * verification.
  147. */
  148. ACPI_INIT_GLOBAL(u8, acpi_gbl_verify_table_checksum, TRUE);
  149. /*
  150. * Optionally enable output from the AML Debug Object.
  151. */
  152. ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_aml_debug_object, FALSE);
  153. /*
  154. * Optionally copy the entire DSDT to local memory (instead of simply
  155. * mapping it.) There are some BIOSs that corrupt or replace the original
  156. * DSDT, creating the need for this option. Default is FALSE, do not copy
  157. * the DSDT.
  158. */
  159. ACPI_INIT_GLOBAL(u8, acpi_gbl_copy_dsdt_locally, FALSE);
  160. /*
  161. * Optionally ignore an XSDT if present and use the RSDT instead.
  162. * Although the ACPI specification requires that an XSDT be used instead
  163. * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
  164. * some machines. Default behavior is to use the XSDT if present.
  165. */
  166. ACPI_INIT_GLOBAL(u8, acpi_gbl_do_not_use_xsdt, FALSE);
  167. /*
  168. * Optionally use 32-bit FADT addresses if and when there is a conflict
  169. * (address mismatch) between the 32-bit and 64-bit versions of the
  170. * address. Although ACPICA adheres to the ACPI specification which
  171. * requires the use of the corresponding 64-bit address if it is non-zero,
  172. * some machines have been found to have a corrupted non-zero 64-bit
  173. * address. Default is TRUE, favor the 32-bit addresses.
  174. */
  175. ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_fadt_addresses, TRUE);
  176. /*
  177. * Optionally truncate I/O addresses to 16 bits. Provides compatibility
  178. * with other ACPI implementations. NOTE: During ACPICA initialization,
  179. * this value is set to TRUE if any Windows OSI strings have been
  180. * requested by the BIOS.
  181. */
  182. ACPI_INIT_GLOBAL(u8, acpi_gbl_truncate_io_addresses, FALSE);
  183. /*
  184. * Disable runtime checking and repair of values returned by control methods.
  185. * Use only if the repair is causing a problem on a particular machine.
  186. */
  187. ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_auto_repair, FALSE);
  188. /*
  189. * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
  190. * This can be useful for debugging ACPI problems on some machines.
  191. */
  192. ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_ssdt_table_install, FALSE);
  193. /*
  194. * We keep track of the latest version of Windows that has been requested by
  195. * the BIOS. ACPI 5.0.
  196. */
  197. ACPI_INIT_GLOBAL(u8, acpi_gbl_osi_data, 0);
  198. /*
  199. * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
  200. * that the ACPI hardware is no longer required. A flag in the FADT indicates
  201. * a reduced HW machine, and that flag is duplicated here for convenience.
  202. */
  203. ACPI_INIT_GLOBAL(u8, acpi_gbl_reduced_hardware, FALSE);
  204. /*
  205. * This mechanism is used to trace a specified AML method. The method is
  206. * traced each time it is executed.
  207. */
  208. ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_flags, 0);
  209. ACPI_INIT_GLOBAL(acpi_name, acpi_gbl_trace_method_name, 0);
  210. /*
  211. * Runtime configuration of debug output control masks. We want the debug
  212. * switches statically initialized so they are already set when the debugger
  213. * is entered.
  214. */
  215. ACPI_INIT_GLOBAL(u32, acpi_dbg_level, ACPI_DEBUG_DEFAULT);
  216. ACPI_INIT_GLOBAL(u32, acpi_dbg_layer, 0);
  217. /*
  218. * Other miscellaneous globals
  219. */
  220. ACPI_GLOBAL(struct acpi_table_fadt, acpi_gbl_FADT);
  221. ACPI_GLOBAL(u32, acpi_current_gpe_count);
  222. ACPI_GLOBAL(u8, acpi_gbl_system_awake_and_running);
  223. /*****************************************************************************
  224. *
  225. * ACPICA public interface configuration.
  226. *
  227. * Interfaces that are configured out of the ACPICA build are replaced
  228. * by inlined stubs by default.
  229. *
  230. ****************************************************************************/
  231. /*
  232. * Hardware-reduced prototypes (default: Not hardware reduced).
  233. *
  234. * All ACPICA hardware-related interfaces that use these macros will be
  235. * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
  236. * is set to TRUE.
  237. *
  238. * Note: This static build option for reduced hardware is intended to
  239. * reduce ACPICA code size if desired or necessary. However, even if this
  240. * option is not specified, the runtime behavior of ACPICA is dependent
  241. * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
  242. * the flag will enable similar behavior -- ACPICA will not attempt
  243. * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
  244. */
  245. #if (!ACPI_REDUCED_HARDWARE)
  246. #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
  247. ACPI_EXTERNAL_RETURN_STATUS(prototype)
  248. #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
  249. ACPI_EXTERNAL_RETURN_OK(prototype)
  250. #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
  251. ACPI_EXTERNAL_RETURN_VOID(prototype)
  252. #else
  253. #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
  254. static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
  255. #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
  256. static ACPI_INLINE prototype {return(AE_OK);}
  257. #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
  258. static ACPI_INLINE prototype {return;}
  259. #endif /* !ACPI_REDUCED_HARDWARE */
  260. /*
  261. * Error message prototypes (default: error messages enabled).
  262. *
  263. * All interfaces related to error and warning messages
  264. * will be configured out of the ACPICA build if the
  265. * ACPI_NO_ERROR_MESSAGE flag is defined.
  266. */
  267. #ifndef ACPI_NO_ERROR_MESSAGES
  268. #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
  269. prototype;
  270. #else
  271. #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
  272. static ACPI_INLINE prototype {return;}
  273. #endif /* ACPI_NO_ERROR_MESSAGES */
  274. /*
  275. * Debugging output prototypes (default: no debug output).
  276. *
  277. * All interfaces related to debug output messages
  278. * will be configured out of the ACPICA build unless the
  279. * ACPI_DEBUG_OUTPUT flag is defined.
  280. */
  281. #ifdef ACPI_DEBUG_OUTPUT
  282. #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
  283. prototype;
  284. #else
  285. #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
  286. static ACPI_INLINE prototype {return;}
  287. #endif /* ACPI_DEBUG_OUTPUT */
  288. /*
  289. * Application prototypes
  290. *
  291. * All interfaces used by application will be configured
  292. * out of the ACPICA build unless the ACPI_APPLICATION
  293. * flag is defined.
  294. */
  295. #ifdef ACPI_APPLICATION
  296. #define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
  297. prototype;
  298. #else
  299. #define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
  300. static ACPI_INLINE prototype {return;}
  301. #endif /* ACPI_APPLICATION */
  302. /*****************************************************************************
  303. *
  304. * ACPICA public interface prototypes
  305. *
  306. ****************************************************************************/
  307. /*
  308. * Initialization
  309. */
  310. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
  311. acpi_initialize_tables(struct acpi_table_desc
  312. *initial_storage,
  313. u32 initial_table_count,
  314. u8 allow_resize))
  315. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_initialize_subsystem(void))
  316. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_enable_subsystem(u32 flags))
  317. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
  318. acpi_initialize_objects(u32 flags))
  319. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_terminate(void))
  320. /*
  321. * Miscellaneous global interfaces
  322. */
  323. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
  324. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
  325. #ifdef ACPI_FUTURE_USAGE
  326. ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_subsystem_status(void))
  327. #endif
  328. #ifdef ACPI_FUTURE_USAGE
  329. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  330. acpi_get_system_info(struct acpi_buffer
  331. *ret_buffer))
  332. #endif
  333. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  334. acpi_get_statistics(struct acpi_statistics *stats))
  335. ACPI_EXTERNAL_RETURN_PTR(const char
  336. *acpi_format_exception(acpi_status exception))
  337. ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_purge_cached_objects(void))
  338. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  339. acpi_install_interface(acpi_string interface_name))
  340. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  341. acpi_remove_interface(acpi_string interface_name))
  342. ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_update_interfaces(u8 action))
  343. ACPI_EXTERNAL_RETURN_UINT32(u32
  344. acpi_check_address_range(acpi_adr_space_type
  345. space_id,
  346. acpi_physical_address
  347. address, acpi_size length,
  348. u8 warn))
  349. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  350. acpi_decode_pld_buffer(u8 *in_buffer,
  351. acpi_size length,
  352. struct acpi_pld_info
  353. **return_buffer))
  354. /*
  355. * ACPI table load/unload interfaces
  356. */
  357. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
  358. acpi_install_table(acpi_physical_address address,
  359. u8 physical))
  360. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  361. acpi_load_table(struct acpi_table_header *table))
  362. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  363. acpi_unload_parent_table(acpi_handle object))
  364. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_load_tables(void))
  365. /*
  366. * ACPI table manipulation interfaces
  367. */
  368. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_reallocate_root_table(void))
  369. ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
  370. acpi_find_root_pointer(acpi_physical_address *
  371. rsdp_address))
  372. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  373. acpi_get_table_header(acpi_string signature,
  374. u32 instance,
  375. struct acpi_table_header
  376. *out_table_header))
  377. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  378. acpi_get_table(acpi_string signature, u32 instance,
  379. struct acpi_table_header
  380. **out_table))
  381. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  382. acpi_get_table_by_index(u32 table_index,
  383. struct acpi_table_header
  384. **out_table))
  385. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  386. acpi_install_table_handler(acpi_table_handler
  387. handler, void *context))
  388. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  389. acpi_remove_table_handler(acpi_table_handler
  390. handler))
  391. /*
  392. * Namespace and name interfaces
  393. */
  394. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  395. acpi_walk_namespace(acpi_object_type type,
  396. acpi_handle start_object,
  397. u32 max_depth,
  398. acpi_walk_callback
  399. descending_callback,
  400. acpi_walk_callback
  401. ascending_callback,
  402. void *context,
  403. void **return_value))
  404. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  405. acpi_get_devices(const char *HID,
  406. acpi_walk_callback user_function,
  407. void *context,
  408. void **return_value))
  409. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  410. acpi_get_name(acpi_handle object, u32 name_type,
  411. struct acpi_buffer *ret_path_ptr))
  412. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  413. acpi_get_handle(acpi_handle parent,
  414. acpi_string pathname,
  415. acpi_handle * ret_handle))
  416. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  417. acpi_attach_data(acpi_handle object,
  418. acpi_object_handler handler,
  419. void *data))
  420. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  421. acpi_detach_data(acpi_handle object,
  422. acpi_object_handler handler))
  423. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  424. acpi_get_data(acpi_handle object,
  425. acpi_object_handler handler,
  426. void **data))
  427. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  428. acpi_debug_trace(char *name, u32 debug_level,
  429. u32 debug_layer, u32 flags))
  430. /*
  431. * Object manipulation and enumeration
  432. */
  433. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  434. acpi_evaluate_object(acpi_handle object,
  435. acpi_string pathname,
  436. struct acpi_object_list
  437. *parameter_objects,
  438. struct acpi_buffer
  439. *return_object_buffer))
  440. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  441. acpi_evaluate_object_typed(acpi_handle object,
  442. acpi_string pathname,
  443. struct acpi_object_list
  444. *external_params,
  445. struct acpi_buffer
  446. *return_buffer,
  447. acpi_object_type
  448. return_type))
  449. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  450. acpi_get_object_info(acpi_handle object,
  451. struct acpi_device_info
  452. **return_buffer))
  453. ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_install_method(u8 *buffer))
  454. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  455. acpi_get_next_object(acpi_object_type type,
  456. acpi_handle parent,
  457. acpi_handle child,
  458. acpi_handle * out_handle))
  459. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  460. acpi_get_type(acpi_handle object,
  461. acpi_object_type * out_type))
  462. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  463. acpi_get_parent(acpi_handle object,
  464. acpi_handle * out_handle))
  465. /*
  466. * Handler interfaces
  467. */
  468. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  469. acpi_install_initialization_handler
  470. (acpi_init_handler handler, u32 function))
  471. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  472. acpi_install_sci_handler(acpi_sci_handler
  473. address,
  474. void *context))
  475. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  476. acpi_remove_sci_handler(acpi_sci_handler
  477. address))
  478. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  479. acpi_install_global_event_handler
  480. (acpi_gbl_event_handler handler,
  481. void *context))
  482. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  483. acpi_install_fixed_event_handler(u32
  484. acpi_event,
  485. acpi_event_handler
  486. handler,
  487. void
  488. *context))
  489. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  490. acpi_remove_fixed_event_handler(u32 acpi_event,
  491. acpi_event_handler
  492. handler))
  493. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  494. acpi_install_gpe_handler(acpi_handle
  495. gpe_device,
  496. u32 gpe_number,
  497. u32 type,
  498. acpi_gpe_handler
  499. address,
  500. void *context))
  501. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  502. acpi_remove_gpe_handler(acpi_handle gpe_device,
  503. u32 gpe_number,
  504. acpi_gpe_handler
  505. address))
  506. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  507. acpi_install_notify_handler(acpi_handle device,
  508. u32 handler_type,
  509. acpi_notify_handler
  510. handler,
  511. void *context))
  512. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  513. acpi_remove_notify_handler(acpi_handle device,
  514. u32 handler_type,
  515. acpi_notify_handler
  516. handler))
  517. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  518. acpi_install_address_space_handler(acpi_handle
  519. device,
  520. acpi_adr_space_type
  521. space_id,
  522. acpi_adr_space_handler
  523. handler,
  524. acpi_adr_space_setup
  525. setup,
  526. void *context))
  527. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  528. acpi_remove_address_space_handler(acpi_handle
  529. device,
  530. acpi_adr_space_type
  531. space_id,
  532. acpi_adr_space_handler
  533. handler))
  534. #ifdef ACPI_FUTURE_USAGE
  535. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  536. acpi_install_exception_handler
  537. (acpi_exception_handler handler))
  538. #endif
  539. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  540. acpi_install_interface_handler
  541. (acpi_interface_handler handler))
  542. /*
  543. * Global Lock interfaces
  544. */
  545. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  546. acpi_acquire_global_lock(u16 timeout,
  547. u32 *handle))
  548. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  549. acpi_release_global_lock(u32 handle))
  550. /*
  551. * Interfaces to AML mutex objects
  552. */
  553. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  554. acpi_acquire_mutex(acpi_handle handle,
  555. acpi_string pathname,
  556. u16 timeout))
  557. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  558. acpi_release_mutex(acpi_handle handle,
  559. acpi_string pathname))
  560. /*
  561. * Fixed Event interfaces
  562. */
  563. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  564. acpi_enable_event(u32 event, u32 flags))
  565. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  566. acpi_disable_event(u32 event, u32 flags))
  567. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
  568. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  569. acpi_get_event_status(u32 event,
  570. acpi_event_status
  571. *event_status))
  572. /*
  573. * General Purpose Event (GPE) Interfaces
  574. */
  575. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
  576. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  577. acpi_enable_gpe(acpi_handle gpe_device,
  578. u32 gpe_number))
  579. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  580. acpi_disable_gpe(acpi_handle gpe_device,
  581. u32 gpe_number))
  582. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  583. acpi_clear_gpe(acpi_handle gpe_device,
  584. u32 gpe_number))
  585. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  586. acpi_set_gpe(acpi_handle gpe_device,
  587. u32 gpe_number, u8 action))
  588. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  589. acpi_finish_gpe(acpi_handle gpe_device,
  590. u32 gpe_number))
  591. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  592. acpi_mark_gpe_for_wake(acpi_handle gpe_device,
  593. u32 gpe_number))
  594. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  595. acpi_setup_gpe_for_wake(acpi_handle
  596. parent_device,
  597. acpi_handle gpe_device,
  598. u32 gpe_number))
  599. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  600. acpi_set_gpe_wake_mask(acpi_handle gpe_device,
  601. u32 gpe_number,
  602. u8 action))
  603. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  604. acpi_get_gpe_status(acpi_handle gpe_device,
  605. u32 gpe_number,
  606. acpi_event_status
  607. *event_status))
  608. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
  609. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
  610. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_wakeup_gpes(void))
  611. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  612. acpi_get_gpe_device(u32 gpe_index,
  613. acpi_handle * gpe_device))
  614. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  615. acpi_install_gpe_block(acpi_handle gpe_device,
  616. struct
  617. acpi_generic_address
  618. *gpe_block_address,
  619. u32 register_count,
  620. u32 interrupt_number))
  621. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  622. acpi_remove_gpe_block(acpi_handle gpe_device))
  623. /*
  624. * Resource interfaces
  625. */
  626. typedef
  627. acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
  628. void *context);
  629. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  630. acpi_get_vendor_resource(acpi_handle device,
  631. char *name,
  632. struct acpi_vendor_uuid
  633. *uuid,
  634. struct acpi_buffer
  635. *ret_buffer))
  636. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  637. acpi_get_current_resources(acpi_handle device,
  638. struct acpi_buffer
  639. *ret_buffer))
  640. #ifdef ACPI_FUTURE_USAGE
  641. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  642. acpi_get_possible_resources(acpi_handle device,
  643. struct acpi_buffer
  644. *ret_buffer))
  645. #endif
  646. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  647. acpi_get_event_resources(acpi_handle device_handle,
  648. struct acpi_buffer
  649. *ret_buffer))
  650. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  651. acpi_walk_resource_buffer(struct acpi_buffer
  652. *buffer,
  653. acpi_walk_resource_callback
  654. user_function,
  655. void *context))
  656. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  657. acpi_walk_resources(acpi_handle device, char *name,
  658. acpi_walk_resource_callback
  659. user_function, void *context))
  660. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  661. acpi_set_current_resources(acpi_handle device,
  662. struct acpi_buffer
  663. *in_buffer))
  664. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  665. acpi_get_irq_routing_table(acpi_handle device,
  666. struct acpi_buffer
  667. *ret_buffer))
  668. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  669. acpi_resource_to_address64(struct acpi_resource
  670. *resource,
  671. struct
  672. acpi_resource_address64
  673. *out))
  674. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  675. acpi_buffer_to_resource(u8 *aml_buffer,
  676. u16 aml_buffer_length,
  677. struct acpi_resource
  678. **resource_ptr))
  679. /*
  680. * Hardware (ACPI device) interfaces
  681. */
  682. ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_reset(void))
  683. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  684. acpi_read(u64 *value,
  685. struct acpi_generic_address *reg))
  686. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  687. acpi_write(u64 value,
  688. struct acpi_generic_address *reg))
  689. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  690. acpi_read_bit_register(u32 register_id,
  691. u32 *return_value))
  692. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  693. acpi_write_bit_register(u32 register_id,
  694. u32 value))
  695. /*
  696. * Sleep/Wake interfaces
  697. */
  698. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  699. acpi_get_sleep_type_data(u8 sleep_state,
  700. u8 *slp_typ_a,
  701. u8 *slp_typ_b))
  702. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  703. acpi_enter_sleep_state_prep(u8 sleep_state))
  704. ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_enter_sleep_state(u8 sleep_state))
  705. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
  706. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  707. acpi_leave_sleep_state_prep(u8 sleep_state))
  708. ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_leave_sleep_state(u8 sleep_state))
  709. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  710. acpi_set_firmware_waking_vector(u32
  711. physical_address))
  712. #if ACPI_MACHINE_WIDTH == 64
  713. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  714. acpi_set_firmware_waking_vector64(u64
  715. physical_address))
  716. #endif
  717. /*
  718. * ACPI Timer interfaces
  719. */
  720. #ifdef ACPI_FUTURE_USAGE
  721. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  722. acpi_get_timer_resolution(u32 *resolution))
  723. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
  724. ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
  725. acpi_get_timer_duration(u32 start_ticks,
  726. u32 end_ticks,
  727. u32 *time_elapsed))
  728. #endif /* ACPI_FUTURE_USAGE */
  729. /*
  730. * Error/Warning output
  731. */
  732. ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
  733. void ACPI_INTERNAL_VAR_XFACE
  734. acpi_error(const char *module_name,
  735. u32 line_number,
  736. const char *format, ...))
  737. ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
  738. void ACPI_INTERNAL_VAR_XFACE
  739. acpi_exception(const char *module_name,
  740. u32 line_number,
  741. acpi_status status,
  742. const char *format, ...))
  743. ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
  744. void ACPI_INTERNAL_VAR_XFACE
  745. acpi_warning(const char *module_name,
  746. u32 line_number,
  747. const char *format, ...))
  748. ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
  749. void ACPI_INTERNAL_VAR_XFACE
  750. acpi_info(const char *module_name,
  751. u32 line_number,
  752. const char *format, ...))
  753. ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
  754. void ACPI_INTERNAL_VAR_XFACE
  755. acpi_bios_error(const char *module_name,
  756. u32 line_number,
  757. const char *format, ...))
  758. ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
  759. void ACPI_INTERNAL_VAR_XFACE
  760. acpi_bios_warning(const char *module_name,
  761. u32 line_number,
  762. const char *format, ...))
  763. /*
  764. * Debug output
  765. */
  766. ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
  767. void ACPI_INTERNAL_VAR_XFACE
  768. acpi_debug_print(u32 requested_debug_level,
  769. u32 line_number,
  770. const char *function_name,
  771. const char *module_name,
  772. u32 component_id,
  773. const char *format, ...))
  774. ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
  775. void ACPI_INTERNAL_VAR_XFACE
  776. acpi_debug_print_raw(u32 requested_debug_level,
  777. u32 line_number,
  778. const char *function_name,
  779. const char *module_name,
  780. u32 component_id,
  781. const char *format, ...))
  782. ACPI_APP_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(1)
  783. void ACPI_INTERNAL_VAR_XFACE
  784. acpi_log_error(const char *format, ...))
  785. /*
  786. * Divergences
  787. */
  788. ACPI_GLOBAL(u8, acpi_gbl_permanent_mmap);
  789. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  790. acpi_get_id(acpi_handle object,
  791. acpi_owner_id * out_type))
  792. ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_unload_table_id(acpi_owner_id id))
  793. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  794. acpi_get_table_with_size(acpi_string signature,
  795. u32 instance,
  796. struct acpi_table_header
  797. **out_table,
  798. acpi_size *tbl_size))
  799. ACPI_EXTERNAL_RETURN_STATUS(acpi_status
  800. acpi_get_data_full(acpi_handle object,
  801. acpi_object_handler handler,
  802. void **data,
  803. void (*callback)(void *)))
  804. #endif /* __ACXFACE_H__ */