acdispat.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  1. /******************************************************************************
  2. *
  3. * Name: acdispat.h - dispatcher (parser to interpreter interface)
  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 _ACDISPAT_H_
  43. #define _ACDISPAT_H_
  44. #define NAMEOF_LOCAL_NTE "__L0"
  45. #define NAMEOF_ARG_NTE "__A0"
  46. /*
  47. * dsopcode - support for late evaluation
  48. */
  49. acpi_status
  50. acpi_ds_get_buffer_field_arguments(union acpi_operand_object *obj_desc);
  51. acpi_status acpi_ds_get_region_arguments(union acpi_operand_object *rgn_desc);
  52. acpi_status acpi_ds_get_buffer_arguments(union acpi_operand_object *obj_desc);
  53. acpi_status acpi_ds_get_package_arguments(union acpi_operand_object *obj_desc);
  54. acpi_status
  55. acpi_ds_eval_buffer_field_operands(struct acpi_walk_state *walk_state,
  56. union acpi_parse_object *op);
  57. acpi_status
  58. acpi_ds_eval_region_operands(struct acpi_walk_state *walk_state,
  59. union acpi_parse_object *op);
  60. acpi_status
  61. acpi_ds_eval_data_object_operands(struct acpi_walk_state *walk_state,
  62. union acpi_parse_object *op,
  63. union acpi_operand_object *obj_desc);
  64. acpi_status acpi_ds_initialize_region(acpi_handle obj_handle);
  65. /*
  66. * dsctrl - Parser/Interpreter interface, control stack routines
  67. */
  68. acpi_status
  69. acpi_ds_exec_begin_control_op(struct acpi_walk_state *walk_state,
  70. union acpi_parse_object *op);
  71. acpi_status
  72. acpi_ds_exec_end_control_op(struct acpi_walk_state *walk_state,
  73. union acpi_parse_object *op);
  74. /*
  75. * dsexec - Parser/Interpreter interface, method execution callbacks
  76. */
  77. acpi_status
  78. acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
  79. union acpi_operand_object *result_obj);
  80. acpi_status
  81. acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
  82. union acpi_parse_object **out_op);
  83. acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *state);
  84. /*
  85. * dsfield - Parser/Interpreter interface for AML fields
  86. */
  87. acpi_status
  88. acpi_ds_create_field(union acpi_parse_object *op,
  89. struct acpi_namespace_node *region_node,
  90. struct acpi_walk_state *walk_state);
  91. acpi_status
  92. acpi_ds_create_bank_field(union acpi_parse_object *op,
  93. struct acpi_namespace_node *region_node,
  94. struct acpi_walk_state *walk_state);
  95. acpi_status
  96. acpi_ds_create_index_field(union acpi_parse_object *op,
  97. struct acpi_namespace_node *region_node,
  98. struct acpi_walk_state *walk_state);
  99. acpi_status
  100. acpi_ds_create_buffer_field(union acpi_parse_object *op,
  101. struct acpi_walk_state *walk_state);
  102. acpi_status
  103. acpi_ds_init_field_objects(union acpi_parse_object *op,
  104. struct acpi_walk_state *walk_state);
  105. /*
  106. * dsload - Parser/Interpreter interface, namespace load callbacks
  107. */
  108. acpi_status
  109. acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state,
  110. union acpi_parse_object **out_op);
  111. acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state);
  112. acpi_status
  113. acpi_ds_load2_begin_op(struct acpi_walk_state *walk_state,
  114. union acpi_parse_object **out_op);
  115. acpi_status acpi_ds_load2_end_op(struct acpi_walk_state *walk_state);
  116. acpi_status
  117. acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number);
  118. /*
  119. * dsmthdat - method data (locals/args)
  120. */
  121. acpi_status
  122. acpi_ds_store_object_to_local(u16 opcode,
  123. u32 index,
  124. union acpi_operand_object *src_desc,
  125. struct acpi_walk_state *walk_state);
  126. acpi_status
  127. acpi_ds_method_data_get_entry(u16 opcode,
  128. u32 index,
  129. struct acpi_walk_state *walk_state,
  130. union acpi_operand_object ***node);
  131. void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state);
  132. u8 acpi_ds_is_method_value(union acpi_operand_object *obj_desc);
  133. acpi_status
  134. acpi_ds_method_data_get_value(u16 opcode,
  135. u32 index,
  136. struct acpi_walk_state *walk_state,
  137. union acpi_operand_object **dest_desc);
  138. acpi_status
  139. acpi_ds_method_data_init_args(union acpi_operand_object **params,
  140. u32 max_param_count,
  141. struct acpi_walk_state *walk_state);
  142. acpi_status
  143. acpi_ds_method_data_get_node(u16 opcode,
  144. u32 index,
  145. struct acpi_walk_state *walk_state,
  146. struct acpi_namespace_node **node);
  147. void acpi_ds_method_data_init(struct acpi_walk_state *walk_state);
  148. /*
  149. * dsmethod - Parser/Interpreter interface - control method parsing
  150. */
  151. acpi_status acpi_ds_parse_method(struct acpi_namespace_node *node);
  152. acpi_status
  153. acpi_ds_call_control_method(struct acpi_thread_state *thread,
  154. struct acpi_walk_state *walk_state,
  155. union acpi_parse_object *op);
  156. acpi_status
  157. acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
  158. union acpi_operand_object *return_desc);
  159. void
  160. acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
  161. struct acpi_walk_state *walk_state);
  162. acpi_status
  163. acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
  164. union acpi_operand_object *obj_desc,
  165. struct acpi_walk_state *walk_state);
  166. acpi_status
  167. acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state);
  168. /*
  169. * dsinit
  170. */
  171. acpi_status
  172. acpi_ds_initialize_objects(acpi_native_uint table_index,
  173. struct acpi_namespace_node *start_node);
  174. /*
  175. * dsobject - Parser/Interpreter interface - object initialization and conversion
  176. */
  177. acpi_status
  178. acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
  179. union acpi_parse_object *op,
  180. u32 buffer_length,
  181. union acpi_operand_object **obj_desc_ptr);
  182. acpi_status
  183. acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
  184. union acpi_parse_object *op,
  185. u32 package_length,
  186. union acpi_operand_object **obj_desc);
  187. acpi_status
  188. acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
  189. union acpi_parse_object *op,
  190. u16 opcode, union acpi_operand_object **obj_desc);
  191. acpi_status
  192. acpi_ds_create_node(struct acpi_walk_state *walk_state,
  193. struct acpi_namespace_node *node,
  194. union acpi_parse_object *op);
  195. /*
  196. * dsutils - Parser/Interpreter interface utility routines
  197. */
  198. void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state);
  199. u8
  200. acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
  201. struct acpi_walk_state *walk_state,
  202. u8 add_reference);
  203. u8
  204. acpi_ds_is_result_used(union acpi_parse_object *op,
  205. struct acpi_walk_state *walk_state);
  206. void
  207. acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
  208. union acpi_operand_object *result_obj,
  209. struct acpi_walk_state *walk_state);
  210. acpi_status
  211. acpi_ds_create_operand(struct acpi_walk_state *walk_state,
  212. union acpi_parse_object *arg, u32 args_remaining);
  213. acpi_status
  214. acpi_ds_create_operands(struct acpi_walk_state *walk_state,
  215. union acpi_parse_object *first_arg);
  216. acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state);
  217. void acpi_ds_clear_operands(struct acpi_walk_state *walk_state);
  218. /*
  219. * dswscope - Scope Stack manipulation
  220. */
  221. acpi_status
  222. acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
  223. acpi_object_type type,
  224. struct acpi_walk_state *walk_state);
  225. acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state);
  226. void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state);
  227. /*
  228. * dswstate - parser WALK_STATE management routines
  229. */
  230. acpi_status
  231. acpi_ds_obj_stack_push(void *object, struct acpi_walk_state *walk_state);
  232. acpi_status
  233. acpi_ds_obj_stack_pop(u32 pop_count, struct acpi_walk_state *walk_state);
  234. struct acpi_walk_state *acpi_ds_create_walk_state(acpi_owner_id owner_id,
  235. union acpi_parse_object
  236. *origin,
  237. union acpi_operand_object
  238. *mth_desc,
  239. struct acpi_thread_state
  240. *thread);
  241. acpi_status
  242. acpi_ds_init_aml_walk(struct acpi_walk_state *walk_state,
  243. union acpi_parse_object *op,
  244. struct acpi_namespace_node *method_node,
  245. u8 * aml_start,
  246. u32 aml_length,
  247. struct acpi_evaluate_info *info, u8 pass_number);
  248. acpi_status
  249. acpi_ds_obj_stack_pop_and_delete(u32 pop_count,
  250. struct acpi_walk_state *walk_state);
  251. void acpi_ds_delete_walk_state(struct acpi_walk_state *walk_state);
  252. struct acpi_walk_state *acpi_ds_pop_walk_state(struct acpi_thread_state
  253. *thread);
  254. void
  255. acpi_ds_push_walk_state(struct acpi_walk_state *walk_state,
  256. struct acpi_thread_state *thread);
  257. acpi_status acpi_ds_result_stack_pop(struct acpi_walk_state *walk_state);
  258. acpi_status acpi_ds_result_stack_push(struct acpi_walk_state *walk_state);
  259. acpi_status acpi_ds_result_stack_clear(struct acpi_walk_state *walk_state);
  260. struct acpi_walk_state *acpi_ds_get_current_walk_state(struct acpi_thread_state
  261. *thread);
  262. #ifdef ACPI_FUTURE_USAGE
  263. acpi_status
  264. acpi_ds_result_remove(union acpi_operand_object **object,
  265. u32 index, struct acpi_walk_state *walk_state);
  266. #endif
  267. acpi_status
  268. acpi_ds_result_pop(union acpi_operand_object **object,
  269. struct acpi_walk_state *walk_state);
  270. acpi_status
  271. acpi_ds_result_push(union acpi_operand_object *object,
  272. struct acpi_walk_state *walk_state);
  273. acpi_status
  274. acpi_ds_result_pop_from_bottom(union acpi_operand_object **object,
  275. struct acpi_walk_state *walk_state);
  276. #endif /* _ACDISPAT_H_ */