acutils.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765
  1. /******************************************************************************
  2. *
  3. * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2017, 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 _ACUTILS_H
  43. #define _ACUTILS_H
  44. extern const u8 acpi_gbl_resource_aml_sizes[];
  45. extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
  46. /* Strings used by the disassembler and debugger resource dump routines */
  47. #if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
  48. extern const char *acpi_gbl_bm_decode[];
  49. extern const char *acpi_gbl_config_decode[];
  50. extern const char *acpi_gbl_consume_decode[];
  51. extern const char *acpi_gbl_dec_decode[];
  52. extern const char *acpi_gbl_he_decode[];
  53. extern const char *acpi_gbl_io_decode[];
  54. extern const char *acpi_gbl_ll_decode[];
  55. extern const char *acpi_gbl_max_decode[];
  56. extern const char *acpi_gbl_mem_decode[];
  57. extern const char *acpi_gbl_min_decode[];
  58. extern const char *acpi_gbl_mtp_decode[];
  59. extern const char *acpi_gbl_rng_decode[];
  60. extern const char *acpi_gbl_rw_decode[];
  61. extern const char *acpi_gbl_shr_decode[];
  62. extern const char *acpi_gbl_siz_decode[];
  63. extern const char *acpi_gbl_trs_decode[];
  64. extern const char *acpi_gbl_ttp_decode[];
  65. extern const char *acpi_gbl_typ_decode[];
  66. extern const char *acpi_gbl_ppc_decode[];
  67. extern const char *acpi_gbl_ior_decode[];
  68. extern const char *acpi_gbl_dts_decode[];
  69. extern const char *acpi_gbl_ct_decode[];
  70. extern const char *acpi_gbl_sbt_decode[];
  71. extern const char *acpi_gbl_am_decode[];
  72. extern const char *acpi_gbl_sm_decode[];
  73. extern const char *acpi_gbl_wm_decode[];
  74. extern const char *acpi_gbl_cph_decode[];
  75. extern const char *acpi_gbl_cpo_decode[];
  76. extern const char *acpi_gbl_dp_decode[];
  77. extern const char *acpi_gbl_ed_decode[];
  78. extern const char *acpi_gbl_bpb_decode[];
  79. extern const char *acpi_gbl_sb_decode[];
  80. extern const char *acpi_gbl_fc_decode[];
  81. extern const char *acpi_gbl_pt_decode[];
  82. extern const char *acpi_gbl_ptyp_decode[];
  83. #endif
  84. /*
  85. * For the iASL compiler case, the output is redirected to stderr so that
  86. * any of the various ACPI errors and warnings do not appear in the output
  87. * files, for either the compiler or disassembler portions of the tool.
  88. */
  89. #ifdef ACPI_ASL_COMPILER
  90. #include <stdio.h>
  91. #define ACPI_MSG_REDIRECT_BEGIN \
  92. FILE *output_file = acpi_gbl_output_file; \
  93. acpi_os_redirect_output (stderr);
  94. #define ACPI_MSG_REDIRECT_END \
  95. acpi_os_redirect_output (output_file);
  96. #else
  97. /*
  98. * non-iASL case - no redirection, nothing to do
  99. */
  100. #define ACPI_MSG_REDIRECT_BEGIN
  101. #define ACPI_MSG_REDIRECT_END
  102. #endif
  103. /*
  104. * Common error message prefixes
  105. */
  106. #ifndef ACPI_MSG_ERROR
  107. #define ACPI_MSG_ERROR "ACPI Error: "
  108. #endif
  109. #ifndef ACPI_MSG_EXCEPTION
  110. #define ACPI_MSG_EXCEPTION "ACPI Exception: "
  111. #endif
  112. #ifndef ACPI_MSG_WARNING
  113. #define ACPI_MSG_WARNING "ACPI Warning: "
  114. #endif
  115. #ifndef ACPI_MSG_INFO
  116. #define ACPI_MSG_INFO "ACPI: "
  117. #endif
  118. #ifndef ACPI_MSG_BIOS_ERROR
  119. #define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
  120. #endif
  121. #ifndef ACPI_MSG_BIOS_WARNING
  122. #define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
  123. #endif
  124. /*
  125. * Common message suffix
  126. */
  127. #define ACPI_MSG_SUFFIX \
  128. acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
  129. /* Flags to indicate implicit or explicit string-to-integer conversion */
  130. #define ACPI_IMPLICIT_CONVERSION TRUE
  131. #define ACPI_NO_IMPLICIT_CONVERSION FALSE
  132. /* Types for Resource descriptor entries */
  133. #define ACPI_INVALID_RESOURCE 0
  134. #define ACPI_FIXED_LENGTH 1
  135. #define ACPI_VARIABLE_LENGTH 2
  136. #define ACPI_SMALL_VARIABLE_LENGTH 3
  137. typedef
  138. acpi_status (*acpi_walk_aml_callback) (u8 *aml,
  139. u32 length,
  140. u32 offset,
  141. u8 resource_index, void **context);
  142. typedef
  143. acpi_status (*acpi_pkg_callback) (u8 object_type,
  144. union acpi_operand_object * source_object,
  145. union acpi_generic_state * state,
  146. void *context);
  147. struct acpi_pkg_info {
  148. u8 *free_space;
  149. acpi_size length;
  150. u32 object_space;
  151. u32 num_packages;
  152. };
  153. /* Object reference counts */
  154. #define REF_INCREMENT (u16) 0
  155. #define REF_DECREMENT (u16) 1
  156. /* acpi_ut_dump_buffer */
  157. #define DB_BYTE_DISPLAY 1
  158. #define DB_WORD_DISPLAY 2
  159. #define DB_DWORD_DISPLAY 4
  160. #define DB_QWORD_DISPLAY 8
  161. /*
  162. * utascii - ASCII utilities
  163. */
  164. u8 acpi_ut_valid_nameseg(char *signature);
  165. u8 acpi_ut_valid_name_char(char character, u32 position);
  166. void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count);
  167. /*
  168. * utnonansi - Non-ANSI C library functions
  169. */
  170. void acpi_ut_strupr(char *src_string);
  171. void acpi_ut_strlwr(char *src_string);
  172. int acpi_ut_stricmp(char *string1, char *string2);
  173. /*
  174. * utstrsuppt - string-to-integer conversion support functions
  175. */
  176. acpi_status acpi_ut_convert_octal_string(char *string, u64 *return_value);
  177. acpi_status acpi_ut_convert_decimal_string(char *string, u64 *return_value_ptr);
  178. acpi_status acpi_ut_convert_hex_string(char *string, u64 *return_value_ptr);
  179. char acpi_ut_remove_leading_zeros(char **string);
  180. u8 acpi_ut_detect_hex_prefix(char **string);
  181. u8 acpi_ut_detect_octal_prefix(char **string);
  182. /*
  183. * utstrtoul64 - string-to-integer conversion functions
  184. */
  185. acpi_status acpi_ut_strtoul64(char *string, u64 *ret_integer);
  186. u64 acpi_ut_explicit_strtoul64(char *string);
  187. u64 acpi_ut_implicit_strtoul64(char *string);
  188. /*
  189. * utglobal - Global data structures and procedures
  190. */
  191. acpi_status acpi_ut_init_globals(void);
  192. #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
  193. const char *acpi_ut_get_mutex_name(u32 mutex_id);
  194. const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
  195. #endif
  196. const char *acpi_ut_get_type_name(acpi_object_type type);
  197. const char *acpi_ut_get_node_name(void *object);
  198. const char *acpi_ut_get_descriptor_name(void *object);
  199. const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
  200. const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
  201. const char *acpi_ut_get_region_name(u8 space_id);
  202. const char *acpi_ut_get_event_name(u32 event_id);
  203. const char *acpi_ut_get_argument_type_name(u32 arg_type);
  204. char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
  205. acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
  206. u8 acpi_ut_ascii_char_to_hex(int hex_char);
  207. u8 acpi_ut_valid_object_type(acpi_object_type type);
  208. /*
  209. * utinit - miscellaneous initialization and shutdown
  210. */
  211. acpi_status acpi_ut_hardware_initialize(void);
  212. void acpi_ut_subsystem_shutdown(void);
  213. /*
  214. * utcopy - Object construction and conversion interfaces
  215. */
  216. acpi_status
  217. acpi_ut_build_simple_object(union acpi_operand_object *obj,
  218. union acpi_object *user_obj,
  219. u8 *data_space, u32 *buffer_space_used);
  220. acpi_status
  221. acpi_ut_build_package_object(union acpi_operand_object *obj,
  222. u8 *buffer, u32 *space_used);
  223. acpi_status
  224. acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
  225. struct acpi_buffer *ret_buffer);
  226. acpi_status
  227. acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
  228. union acpi_operand_object **internal_obj);
  229. acpi_status
  230. acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
  231. union acpi_operand_object *dest_obj);
  232. acpi_status
  233. acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
  234. union acpi_operand_object **dest_desc,
  235. struct acpi_walk_state *walk_state);
  236. /*
  237. * utcreate - Object creation
  238. */
  239. acpi_status
  240. acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
  241. /*
  242. * utdebug - Debug interfaces
  243. */
  244. void acpi_ut_init_stack_ptr_trace(void);
  245. void acpi_ut_track_stack_ptr(void);
  246. void
  247. acpi_ut_trace(u32 line_number,
  248. const char *function_name,
  249. const char *module_name, u32 component_id);
  250. void
  251. acpi_ut_trace_ptr(u32 line_number,
  252. const char *function_name,
  253. const char *module_name,
  254. u32 component_id, const void *pointer);
  255. void
  256. acpi_ut_trace_u32(u32 line_number,
  257. const char *function_name,
  258. const char *module_name, u32 component_id, u32 integer);
  259. void
  260. acpi_ut_trace_str(u32 line_number,
  261. const char *function_name,
  262. const char *module_name,
  263. u32 component_id, const char *string);
  264. void
  265. acpi_ut_exit(u32 line_number,
  266. const char *function_name,
  267. const char *module_name, u32 component_id);
  268. void
  269. acpi_ut_status_exit(u32 line_number,
  270. const char *function_name,
  271. const char *module_name,
  272. u32 component_id, acpi_status status);
  273. void
  274. acpi_ut_value_exit(u32 line_number,
  275. const char *function_name,
  276. const char *module_name, u32 component_id, u64 value);
  277. void
  278. acpi_ut_ptr_exit(u32 line_number,
  279. const char *function_name,
  280. const char *module_name, u32 component_id, u8 *ptr);
  281. void
  282. acpi_ut_str_exit(u32 line_number,
  283. const char *function_name,
  284. const char *module_name, u32 component_id, const char *string);
  285. void
  286. acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
  287. void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
  288. #ifdef ACPI_APPLICATION
  289. void
  290. acpi_ut_dump_buffer_to_file(ACPI_FILE file,
  291. u8 *buffer,
  292. u32 count, u32 display, u32 base_offset);
  293. #endif
  294. void acpi_ut_report_error(char *module_name, u32 line_number);
  295. void acpi_ut_report_info(char *module_name, u32 line_number);
  296. void acpi_ut_report_warning(char *module_name, u32 line_number);
  297. /*
  298. * utdelete - Object deletion and reference counts
  299. */
  300. void acpi_ut_add_reference(union acpi_operand_object *object);
  301. void acpi_ut_remove_reference(union acpi_operand_object *object);
  302. void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
  303. void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
  304. void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
  305. /*
  306. * uteval - object evaluation
  307. */
  308. acpi_status
  309. acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
  310. const char *path,
  311. u32 expected_return_btypes,
  312. union acpi_operand_object **return_desc);
  313. acpi_status
  314. acpi_ut_evaluate_numeric_object(const char *object_name,
  315. struct acpi_namespace_node *device_node,
  316. u64 *value);
  317. acpi_status
  318. acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
  319. acpi_status
  320. acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
  321. const char **method_names,
  322. u8 method_count, u8 *out_values);
  323. /*
  324. * utids - device ID support
  325. */
  326. acpi_status
  327. acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
  328. struct acpi_pnp_device_id ** return_id);
  329. acpi_status
  330. acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
  331. struct acpi_pnp_device_id ** return_id);
  332. acpi_status
  333. acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
  334. struct acpi_pnp_device_id_list ** return_cid_list);
  335. acpi_status
  336. acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
  337. struct acpi_pnp_device_id **return_id);
  338. /*
  339. * utlock - reader/writer locks
  340. */
  341. acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
  342. void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
  343. acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
  344. acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
  345. acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
  346. void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
  347. /*
  348. * utobject - internal object create/delete/cache routines
  349. */
  350. union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
  351. *module_name,
  352. u32 line_number,
  353. u32 component_id,
  354. acpi_object_type
  355. type);
  356. void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
  357. u32 line_number, u32 component_id);
  358. #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
  359. #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
  360. void acpi_ut_delete_object_desc(union acpi_operand_object *object);
  361. u8 acpi_ut_valid_internal_object(void *object);
  362. union acpi_operand_object *acpi_ut_create_package_object(u32 count);
  363. union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
  364. union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
  365. union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
  366. acpi_status
  367. acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
  368. /*
  369. * utosi - Support for the _OSI predefined control method
  370. */
  371. acpi_status acpi_ut_initialize_interfaces(void);
  372. acpi_status acpi_ut_interface_terminate(void);
  373. acpi_status acpi_ut_install_interface(acpi_string interface_name);
  374. acpi_status acpi_ut_remove_interface(acpi_string interface_name);
  375. acpi_status acpi_ut_update_interfaces(u8 action);
  376. struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
  377. acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
  378. /*
  379. * utpredef - support for predefined names
  380. */
  381. const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
  382. acpi_predefined_info
  383. *this_name);
  384. const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
  385. void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
  386. #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
  387. const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
  388. void
  389. acpi_ut_display_predefined_method(char *buffer,
  390. const union acpi_predefined_info *this_name,
  391. u8 multi_line);
  392. u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
  393. #endif
  394. /*
  395. * utstate - Generic state creation/cache routines
  396. */
  397. void
  398. acpi_ut_push_generic_state(union acpi_generic_state **list_head,
  399. union acpi_generic_state *state);
  400. union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
  401. **list_head);
  402. union acpi_generic_state *acpi_ut_create_generic_state(void);
  403. struct acpi_thread_state *acpi_ut_create_thread_state(void);
  404. union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
  405. *object, u16 action);
  406. union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
  407. void *external_object,
  408. u32 index);
  409. acpi_status
  410. acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
  411. u16 action,
  412. union acpi_generic_state **state_list);
  413. union acpi_generic_state *acpi_ut_create_control_state(void);
  414. void acpi_ut_delete_generic_state(union acpi_generic_state *state);
  415. /*
  416. * utmath
  417. */
  418. acpi_status
  419. acpi_ut_divide(u64 in_dividend,
  420. u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
  421. acpi_status
  422. acpi_ut_short_divide(u64 in_dividend,
  423. u32 divisor, u64 *out_quotient, u32 *out_remainder);
  424. acpi_status
  425. acpi_ut_short_multiply(u64 in_multiplicand, u32 multiplier, u64 *outproduct);
  426. acpi_status acpi_ut_short_shift_left(u64 operand, u32 count, u64 *out_result);
  427. acpi_status acpi_ut_short_shift_right(u64 operand, u32 count, u64 *out_result);
  428. /*
  429. * utmisc
  430. */
  431. const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
  432. status);
  433. u8 acpi_ut_is_pci_root_bridge(char *id);
  434. #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
  435. u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
  436. #endif
  437. acpi_status
  438. acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
  439. void *target_object,
  440. acpi_pkg_callback walk_callback, void *context);
  441. /* Values for Base above (16=Hex, 10=Decimal) */
  442. #define ACPI_ANY_BASE 0
  443. u32 acpi_ut_dword_byte_swap(u32 value);
  444. void acpi_ut_set_integer_width(u8 revision);
  445. #ifdef ACPI_DEBUG_OUTPUT
  446. void
  447. acpi_ut_display_init_pathname(u8 type,
  448. struct acpi_namespace_node *obj_handle,
  449. const char *path);
  450. #endif
  451. /*
  452. * utownerid - Support for Table/Method Owner IDs
  453. */
  454. acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
  455. void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
  456. /*
  457. * utresrc
  458. */
  459. acpi_status
  460. acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
  461. u8 *aml,
  462. acpi_size aml_length,
  463. acpi_walk_aml_callback user_function,
  464. void **context);
  465. acpi_status
  466. acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
  467. void *aml, u8 *return_index);
  468. u32 acpi_ut_get_descriptor_length(void *aml);
  469. u16 acpi_ut_get_resource_length(void *aml);
  470. u8 acpi_ut_get_resource_header_length(void *aml);
  471. u8 acpi_ut_get_resource_type(void *aml);
  472. acpi_status
  473. acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
  474. /*
  475. * utstring - String and character utilities
  476. */
  477. void acpi_ut_print_string(char *string, u16 max_length);
  478. #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
  479. void ut_convert_backslashes(char *pathname);
  480. #endif
  481. void acpi_ut_repair_name(char *name);
  482. #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
  483. u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
  484. u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
  485. u8
  486. acpi_ut_safe_strncat(char *dest,
  487. acpi_size dest_size,
  488. char *source, acpi_size max_transfer_length);
  489. #endif
  490. /*
  491. * utmutex - mutex support
  492. */
  493. acpi_status acpi_ut_mutex_initialize(void);
  494. void acpi_ut_mutex_terminate(void);
  495. acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
  496. acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
  497. /*
  498. * utalloc - memory allocation and object caching
  499. */
  500. acpi_status acpi_ut_create_caches(void);
  501. acpi_status acpi_ut_delete_caches(void);
  502. acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
  503. acpi_status
  504. acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
  505. acpi_size required_length);
  506. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  507. void *acpi_ut_allocate_and_track(acpi_size size,
  508. u32 component, const char *module, u32 line);
  509. void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
  510. u32 component,
  511. const char *module, u32 line);
  512. void
  513. acpi_ut_free_and_track(void *address,
  514. u32 component, const char *module, u32 line);
  515. void acpi_ut_dump_allocation_info(void);
  516. void acpi_ut_dump_allocations(u32 component, const char *module);
  517. acpi_status
  518. acpi_ut_create_list(const char *list_name,
  519. u16 object_size, struct acpi_memory_list **return_cache);
  520. #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
  521. /*
  522. * utaddress - address range check
  523. */
  524. acpi_status
  525. acpi_ut_add_address_range(acpi_adr_space_type space_id,
  526. acpi_physical_address address,
  527. u32 length, struct acpi_namespace_node *region_node);
  528. void
  529. acpi_ut_remove_address_range(acpi_adr_space_type space_id,
  530. struct acpi_namespace_node *region_node);
  531. u32
  532. acpi_ut_check_address_range(acpi_adr_space_type space_id,
  533. acpi_physical_address address, u32 length, u8 warn);
  534. void acpi_ut_delete_address_lists(void);
  535. /*
  536. * utxferror - various error/warning output functions
  537. */
  538. void ACPI_INTERNAL_VAR_XFACE
  539. acpi_ut_predefined_warning(const char *module_name,
  540. u32 line_number,
  541. char *pathname,
  542. u8 node_flags, const char *format, ...);
  543. void ACPI_INTERNAL_VAR_XFACE
  544. acpi_ut_predefined_info(const char *module_name,
  545. u32 line_number,
  546. char *pathname, u8 node_flags, const char *format, ...);
  547. void ACPI_INTERNAL_VAR_XFACE
  548. acpi_ut_predefined_bios_error(const char *module_name,
  549. u32 line_number,
  550. char *pathname,
  551. u8 node_flags, const char *format, ...);
  552. void
  553. acpi_ut_namespace_error(const char *module_name,
  554. u32 line_number,
  555. const char *internal_name, acpi_status lookup_status);
  556. void
  557. acpi_ut_method_error(const char *module_name,
  558. u32 line_number,
  559. const char *message,
  560. struct acpi_namespace_node *node,
  561. const char *path, acpi_status lookup_status);
  562. /*
  563. * Utility functions for ACPI names and IDs
  564. */
  565. const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
  566. const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
  567. const char *acpi_ah_match_uuid(u8 *data);
  568. /*
  569. * utuuid -- UUID support functions
  570. */
  571. #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
  572. void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
  573. #endif
  574. #endif /* _ACUTILS_H */