acutils.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568
  1. /******************************************************************************
  2. *
  3. * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2007, R. Byron Moore
  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. /* Strings used by the disassembler and debugger resource dump routines */
  46. #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
  47. extern const char *acpi_gbl_bm_decode[];
  48. extern const char *acpi_gbl_config_decode[];
  49. extern const char *acpi_gbl_consume_decode[];
  50. extern const char *acpi_gbl_dec_decode[];
  51. extern const char *acpi_gbl_he_decode[];
  52. extern const char *acpi_gbl_io_decode[];
  53. extern const char *acpi_gbl_ll_decode[];
  54. extern const char *acpi_gbl_max_decode[];
  55. extern const char *acpi_gbl_mem_decode[];
  56. extern const char *acpi_gbl_min_decode[];
  57. extern const char *acpi_gbl_mtp_decode[];
  58. extern const char *acpi_gbl_rng_decode[];
  59. extern const char *acpi_gbl_rw_decode[];
  60. extern const char *acpi_gbl_shr_decode[];
  61. extern const char *acpi_gbl_siz_decode[];
  62. extern const char *acpi_gbl_trs_decode[];
  63. extern const char *acpi_gbl_ttp_decode[];
  64. extern const char *acpi_gbl_typ_decode[];
  65. #endif
  66. /* Types for Resource descriptor entries */
  67. #define ACPI_INVALID_RESOURCE 0
  68. #define ACPI_FIXED_LENGTH 1
  69. #define ACPI_VARIABLE_LENGTH 2
  70. #define ACPI_SMALL_VARIABLE_LENGTH 3
  71. typedef
  72. acpi_status(*acpi_walk_aml_callback) (u8 * aml,
  73. u32 length,
  74. u32 offset,
  75. u8 resource_index, void **context);
  76. typedef
  77. acpi_status(*acpi_pkg_callback) (u8 object_type,
  78. union acpi_operand_object * source_object,
  79. union acpi_generic_state * state,
  80. void *context);
  81. struct acpi_pkg_info {
  82. u8 *free_space;
  83. acpi_size length;
  84. u32 object_space;
  85. u32 num_packages;
  86. };
  87. #define REF_INCREMENT (u16) 0
  88. #define REF_DECREMENT (u16) 1
  89. #define REF_FORCE_DELETE (u16) 2
  90. /* acpi_ut_dump_buffer */
  91. #define DB_BYTE_DISPLAY 1
  92. #define DB_WORD_DISPLAY 2
  93. #define DB_DWORD_DISPLAY 4
  94. #define DB_QWORD_DISPLAY 8
  95. /*
  96. * utglobal - Global data structures and procedures
  97. */
  98. void acpi_ut_init_globals(void);
  99. #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
  100. char *acpi_ut_get_mutex_name(u32 mutex_id);
  101. #endif
  102. char *acpi_ut_get_type_name(acpi_object_type type);
  103. char *acpi_ut_get_node_name(void *object);
  104. char *acpi_ut_get_descriptor_name(void *object);
  105. char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
  106. char *acpi_ut_get_region_name(u8 space_id);
  107. char *acpi_ut_get_event_name(u32 event_id);
  108. char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position);
  109. u8 acpi_ut_valid_object_type(acpi_object_type type);
  110. /*
  111. * utinit - miscellaneous initialization and shutdown
  112. */
  113. acpi_status acpi_ut_hardware_initialize(void);
  114. void acpi_ut_subsystem_shutdown(void);
  115. /*
  116. * utclib - Local implementations of C library functions
  117. */
  118. #ifndef ACPI_USE_SYSTEM_CLIBRARY
  119. acpi_size acpi_ut_strlen(const char *string);
  120. char *acpi_ut_strcpy(char *dst_string, const char *src_string);
  121. char *acpi_ut_strncpy(char *dst_string,
  122. const char *src_string, acpi_size count);
  123. int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
  124. int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
  125. int acpi_ut_strcmp(const char *string1, const char *string2);
  126. char *acpi_ut_strcat(char *dst_string, const char *src_string);
  127. char *acpi_ut_strncat(char *dst_string,
  128. const char *src_string, acpi_size count);
  129. u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
  130. char *acpi_ut_strstr(char *string1, char *string2);
  131. void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
  132. void *acpi_ut_memset(void *dest, acpi_native_uint value, acpi_size count);
  133. int acpi_ut_to_upper(int c);
  134. int acpi_ut_to_lower(int c);
  135. extern const u8 _acpi_ctype[];
  136. #define _ACPI_XA 0x00 /* extra alphabetic - not supported */
  137. #define _ACPI_XS 0x40 /* extra space */
  138. #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
  139. #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
  140. #define _ACPI_DI 0x04 /* '0'-'9' */
  141. #define _ACPI_LO 0x02 /* 'a'-'z' */
  142. #define _ACPI_PU 0x10 /* punctuation */
  143. #define _ACPI_SP 0x08 /* space */
  144. #define _ACPI_UP 0x01 /* 'A'-'Z' */
  145. #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
  146. #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
  147. #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
  148. #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
  149. #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
  150. #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
  151. #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
  152. #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
  153. #endif /* ACPI_USE_SYSTEM_CLIBRARY */
  154. /*
  155. * utcopy - Object construction and conversion interfaces
  156. */
  157. acpi_status
  158. acpi_ut_build_simple_object(union acpi_operand_object *obj,
  159. union acpi_object *user_obj,
  160. u8 * data_space, u32 * buffer_space_used);
  161. acpi_status
  162. acpi_ut_build_package_object(union acpi_operand_object *obj,
  163. u8 * buffer, u32 * space_used);
  164. acpi_status
  165. acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
  166. struct acpi_buffer *ret_buffer);
  167. acpi_status
  168. acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
  169. union acpi_operand_object **internal_obj);
  170. acpi_status
  171. acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
  172. union acpi_operand_object *dest_obj);
  173. acpi_status
  174. acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
  175. union acpi_operand_object **dest_desc,
  176. struct acpi_walk_state *walk_state);
  177. /*
  178. * utcreate - Object creation
  179. */
  180. acpi_status
  181. acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
  182. /*
  183. * utdebug - Debug interfaces
  184. */
  185. void acpi_ut_init_stack_ptr_trace(void);
  186. void acpi_ut_track_stack_ptr(void);
  187. void
  188. acpi_ut_trace(u32 line_number,
  189. const char *function_name, char *module_name, u32 component_id);
  190. void
  191. acpi_ut_trace_ptr(u32 line_number,
  192. const char *function_name,
  193. char *module_name, u32 component_id, void *pointer);
  194. void
  195. acpi_ut_trace_u32(u32 line_number,
  196. const char *function_name,
  197. char *module_name, u32 component_id, u32 integer);
  198. void
  199. acpi_ut_trace_str(u32 line_number,
  200. const char *function_name,
  201. char *module_name, u32 component_id, char *string);
  202. void
  203. acpi_ut_exit(u32 line_number,
  204. const char *function_name, char *module_name, u32 component_id);
  205. void
  206. acpi_ut_status_exit(u32 line_number,
  207. const char *function_name,
  208. char *module_name, u32 component_id, acpi_status status);
  209. void
  210. acpi_ut_value_exit(u32 line_number,
  211. const char *function_name,
  212. char *module_name, u32 component_id, acpi_integer value);
  213. void
  214. acpi_ut_ptr_exit(u32 line_number,
  215. const char *function_name,
  216. char *module_name, u32 component_id, u8 * ptr);
  217. void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
  218. void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display);
  219. void acpi_ut_report_error(char *module_name, u32 line_number);
  220. void acpi_ut_report_info(char *module_name, u32 line_number);
  221. void acpi_ut_report_warning(char *module_name, u32 line_number);
  222. /* Error and message reporting interfaces */
  223. void ACPI_INTERNAL_VAR_XFACE
  224. acpi_ut_debug_print(u32 requested_debug_level,
  225. u32 line_number,
  226. const char *function_name,
  227. char *module_name,
  228. u32 component_id, char *format, ...) ACPI_PRINTF_LIKE(6);
  229. void ACPI_INTERNAL_VAR_XFACE
  230. acpi_ut_debug_print_raw(u32 requested_debug_level,
  231. u32 line_number,
  232. const char *function_name,
  233. char *module_name,
  234. u32 component_id,
  235. char *format, ...) ACPI_PRINTF_LIKE(6);
  236. void ACPI_INTERNAL_VAR_XFACE
  237. acpi_ut_error(char *module_name,
  238. u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
  239. void ACPI_INTERNAL_VAR_XFACE
  240. acpi_ut_exception(char *module_name,
  241. u32 line_number,
  242. acpi_status status, char *format, ...) ACPI_PRINTF_LIKE(4);
  243. void ACPI_INTERNAL_VAR_XFACE
  244. acpi_ut_warning(char *module_name,
  245. u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
  246. void ACPI_INTERNAL_VAR_XFACE
  247. acpi_ut_info(char *module_name,
  248. u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
  249. /*
  250. * utdelete - Object deletion and reference counts
  251. */
  252. void acpi_ut_add_reference(union acpi_operand_object *object);
  253. void acpi_ut_remove_reference(union acpi_operand_object *object);
  254. void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
  255. void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
  256. void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
  257. /*
  258. * uteval - object evaluation
  259. */
  260. acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
  261. acpi_status
  262. acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
  263. char *path,
  264. u32 expected_return_btypes,
  265. union acpi_operand_object **return_desc);
  266. acpi_status
  267. acpi_ut_evaluate_numeric_object(char *object_name,
  268. struct acpi_namespace_node *device_node,
  269. acpi_integer * address);
  270. acpi_status
  271. acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
  272. struct acpi_device_id *hid);
  273. acpi_status
  274. acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
  275. struct acpi_compatible_id_list **return_cid_list);
  276. acpi_status
  277. acpi_ut_execute_STA(struct acpi_namespace_node *device_node,
  278. u32 * status_flags);
  279. acpi_status
  280. acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
  281. struct acpi_device_id *uid);
  282. acpi_status
  283. acpi_ut_execute_sxds(struct acpi_namespace_node *device_node, u8 * highest);
  284. /*
  285. * utobject - internal object create/delete/cache routines
  286. */
  287. union acpi_operand_object *acpi_ut_create_internal_object_dbg(char *module_name,
  288. u32 line_number,
  289. u32 component_id,
  290. acpi_object_type
  291. type);
  292. void *acpi_ut_allocate_object_desc_dbg(char *module_name,
  293. u32 line_number, u32 component_id);
  294. #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
  295. #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
  296. void acpi_ut_delete_object_desc(union acpi_operand_object *object);
  297. u8 acpi_ut_valid_internal_object(void *object);
  298. union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
  299. union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
  300. acpi_status
  301. acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
  302. /*
  303. * utstate - Generic state creation/cache routines
  304. */
  305. void
  306. acpi_ut_push_generic_state(union acpi_generic_state **list_head,
  307. union acpi_generic_state *state);
  308. union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
  309. **list_head);
  310. union acpi_generic_state *acpi_ut_create_generic_state(void);
  311. struct acpi_thread_state *acpi_ut_create_thread_state(void);
  312. union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
  313. *object, u16 action);
  314. union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
  315. void *external_object,
  316. u16 index);
  317. acpi_status
  318. acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
  319. u16 action,
  320. union acpi_generic_state **state_list);
  321. #ifdef ACPI_FUTURE_USAGE
  322. acpi_status
  323. acpi_ut_create_pkg_state_and_push(void *internal_object,
  324. void *external_object,
  325. u16 index,
  326. union acpi_generic_state **state_list);
  327. #endif /* ACPI_FUTURE_USAGE */
  328. union acpi_generic_state *acpi_ut_create_control_state(void);
  329. void acpi_ut_delete_generic_state(union acpi_generic_state *state);
  330. /*
  331. * utmath
  332. */
  333. acpi_status
  334. acpi_ut_divide(acpi_integer in_dividend,
  335. acpi_integer in_divisor,
  336. acpi_integer * out_quotient, acpi_integer * out_remainder);
  337. acpi_status
  338. acpi_ut_short_divide(acpi_integer in_dividend,
  339. u32 divisor,
  340. acpi_integer * out_quotient, u32 * out_remainder);
  341. /*
  342. * utmisc
  343. */
  344. const char *acpi_ut_validate_exception(acpi_status status);
  345. u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
  346. acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
  347. void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
  348. acpi_status
  349. acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
  350. void *target_object,
  351. acpi_pkg_callback walk_callback, void *context);
  352. void acpi_ut_strupr(char *src_string);
  353. void acpi_ut_print_string(char *string, u8 max_length);
  354. u8 acpi_ut_valid_acpi_name(u32 name);
  355. acpi_name acpi_ut_repair_name(char *name);
  356. u8 acpi_ut_valid_acpi_char(char character, acpi_native_uint position);
  357. acpi_status
  358. acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer);
  359. /* Values for Base above (16=Hex, 10=Decimal) */
  360. #define ACPI_ANY_BASE 0
  361. u32 acpi_ut_dword_byte_swap(u32 value);
  362. void acpi_ut_set_integer_width(u8 revision);
  363. #ifdef ACPI_DEBUG_OUTPUT
  364. void
  365. acpi_ut_display_init_pathname(u8 type,
  366. struct acpi_namespace_node *obj_handle,
  367. char *path);
  368. #endif
  369. /*
  370. * utresrc
  371. */
  372. acpi_status
  373. acpi_ut_walk_aml_resources(u8 * aml,
  374. acpi_size aml_length,
  375. acpi_walk_aml_callback user_function, void **context);
  376. acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
  377. u32 acpi_ut_get_descriptor_length(void *aml);
  378. u16 acpi_ut_get_resource_length(void *aml);
  379. u8 acpi_ut_get_resource_header_length(void *aml);
  380. u8 acpi_ut_get_resource_type(void *aml);
  381. acpi_status
  382. acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
  383. u8 ** end_tag);
  384. /*
  385. * utmutex - mutex support
  386. */
  387. acpi_status acpi_ut_mutex_initialize(void);
  388. void acpi_ut_mutex_terminate(void);
  389. acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
  390. acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
  391. /*
  392. * utalloc - memory allocation and object caching
  393. */
  394. acpi_status acpi_ut_create_caches(void);
  395. acpi_status acpi_ut_delete_caches(void);
  396. acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
  397. acpi_status
  398. acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
  399. acpi_size required_length);
  400. void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line);
  401. void *acpi_ut_allocate_zeroed(acpi_size size,
  402. u32 component, char *module, u32 line);
  403. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  404. void *acpi_ut_allocate_and_track(acpi_size size,
  405. u32 component, char *module, u32 line);
  406. void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
  407. u32 component, char *module, u32 line);
  408. void
  409. acpi_ut_free_and_track(void *address, u32 component, char *module, u32 line);
  410. #ifdef ACPI_FUTURE_USAGE
  411. void acpi_ut_dump_allocation_info(void);
  412. #endif /* ACPI_FUTURE_USAGE */
  413. void acpi_ut_dump_allocations(u32 component, char *module);
  414. acpi_status
  415. acpi_ut_create_list(char *list_name,
  416. u16 object_size, struct acpi_memory_list **return_cache);
  417. #endif
  418. #endif /* _ACUTILS_H */