acparser.h 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. /******************************************************************************
  2. *
  3. * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
  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 __ACPARSER_H__
  43. #define __ACPARSER_H__
  44. #define OP_HAS_RETURN_VALUE 1
  45. /* Variable number of arguments. This field must be 32 bits */
  46. #define ACPI_VAR_ARGS ACPI_UINT32_MAX
  47. #define ACPI_PARSE_DELETE_TREE 0x0001
  48. #define ACPI_PARSE_NO_TREE_DELETE 0x0000
  49. #define ACPI_PARSE_TREE_MASK 0x0001
  50. #define ACPI_PARSE_LOAD_PASS1 0x0010
  51. #define ACPI_PARSE_LOAD_PASS2 0x0020
  52. #define ACPI_PARSE_EXECUTE 0x0030
  53. #define ACPI_PARSE_MODE_MASK 0x0030
  54. #define ACPI_PARSE_DEFERRED_OP 0x0100
  55. #define ACPI_PARSE_DISASSEMBLE 0x0200
  56. /******************************************************************************
  57. *
  58. * Parser interfaces
  59. *
  60. *****************************************************************************/
  61. /*
  62. * psxface - Parser external interfaces
  63. */
  64. acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info);
  65. /*
  66. * psargs - Parse AML opcode arguments
  67. */
  68. u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state);
  69. char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state);
  70. void
  71. acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
  72. u32 arg_type, union acpi_parse_object *arg);
  73. acpi_status
  74. acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state,
  75. struct acpi_parse_state *parser_state,
  76. union acpi_parse_object *arg, u8 method_call);
  77. acpi_status
  78. acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
  79. struct acpi_parse_state *parser_state,
  80. u32 arg_type, union acpi_parse_object **return_arg);
  81. /*
  82. * psfind
  83. */
  84. union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope,
  85. u32 name, u32 opcode);
  86. union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op);
  87. /*
  88. * psopcode - AML Opcode information
  89. */
  90. const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);
  91. char *acpi_ps_get_opcode_name(u16 opcode);
  92. /*
  93. * psparse - top level parsing routines
  94. */
  95. acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);
  96. u32 acpi_ps_get_opcode_size(u32 opcode);
  97. u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);
  98. acpi_status
  99. acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
  100. union acpi_parse_object *op);
  101. acpi_status
  102. acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
  103. union acpi_parse_object *op,
  104. acpi_status callback_status);
  105. /*
  106. * psloop - main parse loop
  107. */
  108. acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);
  109. /*
  110. * psscope - Scope stack management routines
  111. */
  112. acpi_status
  113. acpi_ps_init_scope(struct acpi_parse_state *parser_state,
  114. union acpi_parse_object *root);
  115. union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
  116. *state);
  117. u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);
  118. void
  119. acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
  120. union acpi_parse_object **op,
  121. u32 * arg_list, u32 * arg_count);
  122. acpi_status
  123. acpi_ps_push_scope(struct acpi_parse_state *parser_state,
  124. union acpi_parse_object *op,
  125. u32 remaining_args, u32 arg_count);
  126. void acpi_ps_cleanup_scope(struct acpi_parse_state *state);
  127. /*
  128. * pstree - parse tree manipulation routines
  129. */
  130. void
  131. acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);
  132. union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
  133. char *path, u16 opcode, u32 create);
  134. union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);
  135. #ifdef ACPI_FUTURE_USAGE
  136. union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
  137. union acpi_parse_object *op);
  138. #endif /* ACPI_FUTURE_USAGE */
  139. /*
  140. * pswalk - parse tree walk routines
  141. */
  142. acpi_status
  143. acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op,
  144. union acpi_parse_object *end_op,
  145. union acpi_operand_object *mth_desc,
  146. struct acpi_namespace_node *start_node,
  147. union acpi_operand_object **params,
  148. union acpi_operand_object **caller_return_desc,
  149. acpi_owner_id owner_id,
  150. acpi_parse_downwards descending_callback,
  151. acpi_parse_upwards ascending_callback);
  152. acpi_status
  153. acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
  154. union acpi_parse_object *op,
  155. acpi_parse_upwards ascending_callback);
  156. acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);
  157. void acpi_ps_delete_parse_tree(union acpi_parse_object *root);
  158. /*
  159. * psutils - parser utilities
  160. */
  161. union acpi_parse_object *acpi_ps_create_scope_op(void);
  162. void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);
  163. union acpi_parse_object *acpi_ps_alloc_op(u16 opcode);
  164. void acpi_ps_free_op(union acpi_parse_object *op);
  165. u8 acpi_ps_is_leading_char(u32 c);
  166. u8 acpi_ps_is_prefix_char(u32 c);
  167. #ifdef ACPI_FUTURE_USAGE
  168. u32 acpi_ps_get_name(union acpi_parse_object *op);
  169. #endif /* ACPI_FUTURE_USAGE */
  170. void acpi_ps_set_name(union acpi_parse_object *op, u32 name);
  171. /*
  172. * psdump - display parser tree
  173. */
  174. u32
  175. acpi_ps_sprint_path(char *buffer_start,
  176. u32 buffer_size, union acpi_parse_object *op);
  177. u32
  178. acpi_ps_sprint_op(char *buffer_start,
  179. u32 buffer_size, union acpi_parse_object *op);
  180. void acpi_ps_show(union acpi_parse_object *op);
  181. #endif /* __ACPARSER_H__ */