acutils.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792
  1. /******************************************************************************
  2. *
  3. * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2015, 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. #endif
  83. /*
  84. * For the iASL compiler case, the output is redirected to stderr so that
  85. * any of the various ACPI errors and warnings do not appear in the output
  86. * files, for either the compiler or disassembler portions of the tool.
  87. */
  88. #ifdef ACPI_ASL_COMPILER
  89. #include <stdio.h>
  90. #define ACPI_MSG_REDIRECT_BEGIN \
  91. FILE *output_file = acpi_gbl_output_file; \
  92. acpi_os_redirect_output (stderr);
  93. #define ACPI_MSG_REDIRECT_END \
  94. acpi_os_redirect_output (output_file);
  95. #else
  96. /*
  97. * non-iASL case - no redirection, nothing to do
  98. */
  99. #define ACPI_MSG_REDIRECT_BEGIN
  100. #define ACPI_MSG_REDIRECT_END
  101. #endif
  102. /*
  103. * Common error message prefixes
  104. */
  105. #define ACPI_MSG_ERROR "ACPI Error: "
  106. #define ACPI_MSG_EXCEPTION "ACPI Exception: "
  107. #define ACPI_MSG_WARNING "ACPI Warning: "
  108. #define ACPI_MSG_INFO "ACPI: "
  109. #define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
  110. #define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
  111. /*
  112. * Common message suffix
  113. */
  114. #define ACPI_MSG_SUFFIX \
  115. acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
  116. /* Types for Resource descriptor entries */
  117. #define ACPI_INVALID_RESOURCE 0
  118. #define ACPI_FIXED_LENGTH 1
  119. #define ACPI_VARIABLE_LENGTH 2
  120. #define ACPI_SMALL_VARIABLE_LENGTH 3
  121. typedef
  122. acpi_status(*acpi_walk_aml_callback) (u8 *aml,
  123. u32 length,
  124. u32 offset,
  125. u8 resource_index, void **context);
  126. typedef
  127. acpi_status(*acpi_pkg_callback) (u8 object_type,
  128. union acpi_operand_object *source_object,
  129. union acpi_generic_state * state,
  130. void *context);
  131. struct acpi_pkg_info {
  132. u8 *free_space;
  133. acpi_size length;
  134. u32 object_space;
  135. u32 num_packages;
  136. };
  137. /* Object reference counts */
  138. #define REF_INCREMENT (u16) 0
  139. #define REF_DECREMENT (u16) 1
  140. /* acpi_ut_dump_buffer */
  141. #define DB_BYTE_DISPLAY 1
  142. #define DB_WORD_DISPLAY 2
  143. #define DB_DWORD_DISPLAY 4
  144. #define DB_QWORD_DISPLAY 8
  145. /*
  146. * utglobal - Global data structures and procedures
  147. */
  148. acpi_status acpi_ut_init_globals(void);
  149. #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
  150. char *acpi_ut_get_mutex_name(u32 mutex_id);
  151. const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
  152. #endif
  153. char *acpi_ut_get_type_name(acpi_object_type type);
  154. char *acpi_ut_get_node_name(void *object);
  155. char *acpi_ut_get_descriptor_name(void *object);
  156. const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
  157. char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
  158. char *acpi_ut_get_region_name(u8 space_id);
  159. char *acpi_ut_get_event_name(u32 event_id);
  160. char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
  161. u8 acpi_ut_ascii_char_to_hex(int hex_char);
  162. u8 acpi_ut_valid_object_type(acpi_object_type type);
  163. /*
  164. * utinit - miscellaneous initialization and shutdown
  165. */
  166. acpi_status acpi_ut_hardware_initialize(void);
  167. void acpi_ut_subsystem_shutdown(void);
  168. /*
  169. * utclib - Local implementations of C library functions
  170. */
  171. #ifndef ACPI_USE_SYSTEM_CLIBRARY
  172. acpi_size acpi_ut_strlen(const char *string);
  173. char *acpi_ut_strchr(const char *string, int ch);
  174. char *acpi_ut_strcpy(char *dst_string, const char *src_string);
  175. char *acpi_ut_strncpy(char *dst_string,
  176. const char *src_string, acpi_size count);
  177. int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
  178. int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
  179. int acpi_ut_strcmp(const char *string1, const char *string2);
  180. char *acpi_ut_strcat(char *dst_string, const char *src_string);
  181. char *acpi_ut_strncat(char *dst_string,
  182. const char *src_string, acpi_size count);
  183. u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
  184. char *acpi_ut_strstr(char *string1, char *string2);
  185. void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
  186. void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
  187. int acpi_ut_to_upper(int c);
  188. int acpi_ut_to_lower(int c);
  189. extern const u8 _acpi_ctype[];
  190. #define _ACPI_XA 0x00 /* extra alphabetic - not supported */
  191. #define _ACPI_XS 0x40 /* extra space */
  192. #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
  193. #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
  194. #define _ACPI_DI 0x04 /* '0'-'9' */
  195. #define _ACPI_LO 0x02 /* 'a'-'z' */
  196. #define _ACPI_PU 0x10 /* punctuation */
  197. #define _ACPI_SP 0x08 /* space */
  198. #define _ACPI_UP 0x01 /* 'A'-'Z' */
  199. #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
  200. #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
  201. #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
  202. #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
  203. #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
  204. #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
  205. #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_XS | _ACPI_PU))
  206. #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
  207. #endif /* !ACPI_USE_SYSTEM_CLIBRARY */
  208. #define ACPI_IS_ASCII(c) ((c) < 0x80)
  209. /*
  210. * utcopy - Object construction and conversion interfaces
  211. */
  212. acpi_status
  213. acpi_ut_build_simple_object(union acpi_operand_object *obj,
  214. union acpi_object *user_obj,
  215. u8 *data_space, u32 *buffer_space_used);
  216. acpi_status
  217. acpi_ut_build_package_object(union acpi_operand_object *obj,
  218. u8 *buffer, u32 *space_used);
  219. acpi_status
  220. acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
  221. struct acpi_buffer *ret_buffer);
  222. acpi_status
  223. acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
  224. union acpi_operand_object **internal_obj);
  225. acpi_status
  226. acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
  227. union acpi_operand_object *dest_obj);
  228. acpi_status
  229. acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
  230. union acpi_operand_object **dest_desc,
  231. struct acpi_walk_state *walk_state);
  232. /*
  233. * utcreate - Object creation
  234. */
  235. acpi_status
  236. acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
  237. /*
  238. * utdebug - Debug interfaces
  239. */
  240. void acpi_ut_init_stack_ptr_trace(void);
  241. void acpi_ut_track_stack_ptr(void);
  242. void
  243. acpi_ut_trace(u32 line_number,
  244. const char *function_name,
  245. const char *module_name, u32 component_id);
  246. void
  247. acpi_ut_trace_ptr(u32 line_number,
  248. const char *function_name,
  249. const char *module_name, u32 component_id, void *pointer);
  250. void
  251. acpi_ut_trace_u32(u32 line_number,
  252. const char *function_name,
  253. const char *module_name, u32 component_id, u32 integer);
  254. void
  255. acpi_ut_trace_str(u32 line_number,
  256. const char *function_name,
  257. const char *module_name, u32 component_id, char *string);
  258. void
  259. acpi_ut_exit(u32 line_number,
  260. const char *function_name,
  261. const char *module_name, u32 component_id);
  262. void
  263. acpi_ut_status_exit(u32 line_number,
  264. const char *function_name,
  265. const char *module_name,
  266. u32 component_id, acpi_status status);
  267. void
  268. acpi_ut_value_exit(u32 line_number,
  269. const char *function_name,
  270. const char *module_name, u32 component_id, u64 value);
  271. void
  272. acpi_ut_ptr_exit(u32 line_number,
  273. const char *function_name,
  274. const char *module_name, u32 component_id, u8 *ptr);
  275. void
  276. acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
  277. void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
  278. #ifdef ACPI_APPLICATION
  279. void
  280. acpi_ut_dump_buffer_to_file(ACPI_FILE file,
  281. u8 *buffer,
  282. u32 count, u32 display, u32 base_offset);
  283. #endif
  284. void acpi_ut_report_error(char *module_name, u32 line_number);
  285. void acpi_ut_report_info(char *module_name, u32 line_number);
  286. void acpi_ut_report_warning(char *module_name, u32 line_number);
  287. /*
  288. * utdelete - Object deletion and reference counts
  289. */
  290. void acpi_ut_add_reference(union acpi_operand_object *object);
  291. void acpi_ut_remove_reference(union acpi_operand_object *object);
  292. void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
  293. void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
  294. void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
  295. /*
  296. * uteval - object evaluation
  297. */
  298. acpi_status
  299. acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
  300. char *path,
  301. u32 expected_return_btypes,
  302. union acpi_operand_object **return_desc);
  303. acpi_status
  304. acpi_ut_evaluate_numeric_object(char *object_name,
  305. struct acpi_namespace_node *device_node,
  306. u64 *value);
  307. acpi_status
  308. acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
  309. acpi_status
  310. acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
  311. const char **method_names,
  312. u8 method_count, u8 *out_values);
  313. /*
  314. * utfileio - file operations
  315. */
  316. #ifdef ACPI_APPLICATION
  317. acpi_status
  318. acpi_ut_read_table_from_file(char *filename, struct acpi_table_header **table);
  319. #endif
  320. /*
  321. * utids - device ID support
  322. */
  323. acpi_status
  324. acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
  325. struct acpi_pnp_device_id ** return_id);
  326. acpi_status
  327. acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
  328. struct acpi_pnp_device_id ** return_id);
  329. acpi_status
  330. acpi_ut_execute_SUB(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. /*
  336. * utlock - reader/writer locks
  337. */
  338. acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
  339. void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
  340. acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
  341. acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
  342. acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
  343. void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
  344. /*
  345. * utobject - internal object create/delete/cache routines
  346. */
  347. union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
  348. *module_name,
  349. u32 line_number,
  350. u32 component_id,
  351. acpi_object_type
  352. type);
  353. void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
  354. u32 line_number, u32 component_id);
  355. #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
  356. #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
  357. void acpi_ut_delete_object_desc(union acpi_operand_object *object);
  358. u8 acpi_ut_valid_internal_object(void *object);
  359. union acpi_operand_object *acpi_ut_create_package_object(u32 count);
  360. union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
  361. union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
  362. union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
  363. acpi_status
  364. acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
  365. /*
  366. * utosi - Support for the _OSI predefined control method
  367. */
  368. acpi_status acpi_ut_initialize_interfaces(void);
  369. acpi_status acpi_ut_interface_terminate(void);
  370. acpi_status acpi_ut_install_interface(acpi_string interface_name);
  371. acpi_status acpi_ut_remove_interface(acpi_string interface_name);
  372. acpi_status acpi_ut_update_interfaces(u8 action);
  373. struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
  374. acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
  375. /*
  376. * utpredef - support for predefined names
  377. */
  378. const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
  379. acpi_predefined_info
  380. *this_name);
  381. const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
  382. void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
  383. #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
  384. const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
  385. void
  386. acpi_ut_display_predefined_method(char *buffer,
  387. const union acpi_predefined_info *this_name,
  388. u8 multi_line);
  389. u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
  390. #endif
  391. /*
  392. * utstate - Generic state creation/cache routines
  393. */
  394. void
  395. acpi_ut_push_generic_state(union acpi_generic_state **list_head,
  396. union acpi_generic_state *state);
  397. union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
  398. **list_head);
  399. union acpi_generic_state *acpi_ut_create_generic_state(void);
  400. struct acpi_thread_state *acpi_ut_create_thread_state(void);
  401. union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
  402. *object, u16 action);
  403. union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
  404. void *external_object,
  405. u16 index);
  406. acpi_status
  407. acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
  408. u16 action,
  409. union acpi_generic_state **state_list);
  410. union acpi_generic_state *acpi_ut_create_control_state(void);
  411. void acpi_ut_delete_generic_state(union acpi_generic_state *state);
  412. /*
  413. * utmath
  414. */
  415. acpi_status
  416. acpi_ut_divide(u64 in_dividend,
  417. u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
  418. acpi_status
  419. acpi_ut_short_divide(u64 in_dividend,
  420. u32 divisor, u64 *out_quotient, u32 *out_remainder);
  421. /*
  422. * utmisc
  423. */
  424. const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
  425. status);
  426. u8 acpi_ut_is_pci_root_bridge(char *id);
  427. #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP)
  428. u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
  429. #endif
  430. acpi_status
  431. acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
  432. void *target_object,
  433. acpi_pkg_callback walk_callback, void *context);
  434. /* Values for Base above (16=Hex, 10=Decimal) */
  435. #define ACPI_ANY_BASE 0
  436. u32 acpi_ut_dword_byte_swap(u32 value);
  437. void acpi_ut_set_integer_width(u8 revision);
  438. #ifdef ACPI_DEBUG_OUTPUT
  439. void
  440. acpi_ut_display_init_pathname(u8 type,
  441. struct acpi_namespace_node *obj_handle,
  442. char *path);
  443. #endif
  444. /*
  445. * utownerid - Support for Table/Method Owner IDs
  446. */
  447. acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
  448. void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
  449. /*
  450. * utresrc
  451. */
  452. acpi_status
  453. acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
  454. u8 *aml,
  455. acpi_size aml_length,
  456. acpi_walk_aml_callback user_function,
  457. void **context);
  458. acpi_status
  459. acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
  460. void *aml, u8 *return_index);
  461. u32 acpi_ut_get_descriptor_length(void *aml);
  462. u16 acpi_ut_get_resource_length(void *aml);
  463. u8 acpi_ut_get_resource_header_length(void *aml);
  464. u8 acpi_ut_get_resource_type(void *aml);
  465. acpi_status
  466. acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
  467. /*
  468. * utstring - String and character utilities
  469. */
  470. void acpi_ut_strupr(char *src_string);
  471. #ifdef ACPI_ASL_COMPILER
  472. void acpi_ut_strlwr(char *src_string);
  473. int acpi_ut_stricmp(char *string1, char *string2);
  474. #endif
  475. acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
  476. void acpi_ut_print_string(char *string, u16 max_length);
  477. #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
  478. void ut_convert_backslashes(char *pathname);
  479. #endif
  480. u8 acpi_ut_valid_acpi_name(char *name);
  481. u8 acpi_ut_valid_acpi_char(char character, u32 position);
  482. void acpi_ut_repair_name(char *name);
  483. #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
  484. u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
  485. u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
  486. u8
  487. acpi_ut_safe_strncat(char *dest,
  488. acpi_size dest_size,
  489. char *source, acpi_size max_transfer_length);
  490. #endif
  491. /*
  492. * utmutex - mutex support
  493. */
  494. acpi_status acpi_ut_mutex_initialize(void);
  495. void acpi_ut_mutex_terminate(void);
  496. acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
  497. acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
  498. /*
  499. * utalloc - memory allocation and object caching
  500. */
  501. acpi_status acpi_ut_create_caches(void);
  502. acpi_status acpi_ut_delete_caches(void);
  503. acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
  504. acpi_status
  505. acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
  506. acpi_size required_length);
  507. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  508. void *acpi_ut_allocate_and_track(acpi_size size,
  509. u32 component, const char *module, u32 line);
  510. void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
  511. u32 component,
  512. const char *module, u32 line);
  513. void
  514. acpi_ut_free_and_track(void *address,
  515. u32 component, const char *module, u32 line);
  516. #ifdef ACPI_FUTURE_USAGE
  517. void acpi_ut_dump_allocation_info(void);
  518. #endif /* ACPI_FUTURE_USAGE */
  519. void acpi_ut_dump_allocations(u32 component, const char *module);
  520. acpi_status
  521. acpi_ut_create_list(char *list_name,
  522. u16 object_size, struct acpi_memory_list **return_cache);
  523. #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
  524. /*
  525. * utaddress - address range check
  526. */
  527. acpi_status
  528. acpi_ut_add_address_range(acpi_adr_space_type space_id,
  529. acpi_physical_address address,
  530. u32 length, struct acpi_namespace_node *region_node);
  531. void
  532. acpi_ut_remove_address_range(acpi_adr_space_type space_id,
  533. struct acpi_namespace_node *region_node);
  534. u32
  535. acpi_ut_check_address_range(acpi_adr_space_type space_id,
  536. acpi_physical_address address, u32 length, u8 warn);
  537. void acpi_ut_delete_address_lists(void);
  538. /*
  539. * utxferror - various error/warning output functions
  540. */
  541. void ACPI_INTERNAL_VAR_XFACE
  542. acpi_ut_predefined_warning(const char *module_name,
  543. u32 line_number,
  544. char *pathname,
  545. u8 node_flags, const char *format, ...);
  546. void ACPI_INTERNAL_VAR_XFACE
  547. acpi_ut_predefined_info(const char *module_name,
  548. u32 line_number,
  549. char *pathname, u8 node_flags, const char *format, ...);
  550. void ACPI_INTERNAL_VAR_XFACE
  551. acpi_ut_predefined_bios_error(const char *module_name,
  552. u32 line_number,
  553. char *pathname,
  554. u8 node_flags, const char *format, ...);
  555. void
  556. acpi_ut_namespace_error(const char *module_name,
  557. u32 line_number,
  558. const char *internal_name, acpi_status lookup_status);
  559. void
  560. acpi_ut_method_error(const char *module_name,
  561. u32 line_number,
  562. const char *message,
  563. struct acpi_namespace_node *node,
  564. const char *path, acpi_status lookup_status);
  565. /*
  566. * Utility functions for ACPI names and IDs
  567. */
  568. const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
  569. const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
  570. const char *acpi_ah_match_uuid(u8 *data);
  571. /*
  572. * utprint - printf/vprintf output functions
  573. */
  574. const char *acpi_ut_scan_number(const char *string, u64 *number_ptr);
  575. const char *acpi_ut_print_number(char *string, u64 number);
  576. int
  577. acpi_ut_vsnprintf(char *string,
  578. acpi_size size, const char *format, va_list args);
  579. int acpi_ut_snprintf(char *string, acpi_size size, const char *format, ...);
  580. #ifdef ACPI_APPLICATION
  581. int acpi_ut_file_vprintf(ACPI_FILE file, const char *format, va_list args);
  582. int acpi_ut_file_printf(ACPI_FILE file, const char *format, ...);
  583. #endif
  584. /*
  585. * utuuid -- UUID support functions
  586. */
  587. #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
  588. void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
  589. #endif
  590. #endif /* _ACUTILS_H */