acstruct.h 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. /******************************************************************************
  2. *
  3. * Name: acstruct.h - Internal structs
  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 __ACSTRUCT_H__
  43. #define __ACSTRUCT_H__
  44. /* acpisrc:struct_defs -- for acpisrc conversion */
  45. /*****************************************************************************
  46. *
  47. * Tree walking typedefs and structs
  48. *
  49. ****************************************************************************/
  50. /*
  51. * Walk state - current state of a parse tree walk. Used for both a leisurely
  52. * stroll through the tree (for whatever reason), and for control method
  53. * execution.
  54. */
  55. #define ACPI_NEXT_OP_DOWNWARD 1
  56. #define ACPI_NEXT_OP_UPWARD 2
  57. /*
  58. * Groups of definitions for walk_type used for different implementations of
  59. * walkers (never simultaneously) - flags for interpreter:
  60. */
  61. #define ACPI_WALK_NON_METHOD 0
  62. #define ACPI_WALK_METHOD 0x01
  63. #define ACPI_WALK_METHOD_RESTART 0x02
  64. /* Flags for i_aSL compiler only */
  65. #define ACPI_WALK_CONST_REQUIRED 0x10
  66. #define ACPI_WALK_CONST_OPTIONAL 0x20
  67. struct acpi_walk_state {
  68. struct acpi_walk_state *next; /* Next walk_state in list */
  69. u8 descriptor_type; /* To differentiate various internal objs */
  70. u8 walk_type;
  71. u16 opcode; /* Current AML opcode */
  72. u8 next_op_info; /* Info about next_op */
  73. u8 num_operands; /* Stack pointer for Operands[] array */
  74. acpi_owner_id owner_id; /* Owner of objects created during the walk */
  75. u8 last_predicate; /* Result of last predicate */
  76. u8 current_result;
  77. u8 return_used;
  78. u8 scope_depth;
  79. u8 pass_number; /* Parse pass during table load */
  80. u32 aml_offset;
  81. u32 arg_types;
  82. u32 method_breakpoint; /* For single stepping */
  83. u32 user_breakpoint; /* User AML breakpoint */
  84. u32 parse_flags;
  85. struct acpi_parse_state parser_state; /* Current state of parser */
  86. u32 prev_arg_types;
  87. u32 arg_count; /* push for fixed or var args */
  88. struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */
  89. struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
  90. union acpi_operand_object *operands[ACPI_OBJ_NUM_OPERANDS + 1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
  91. union acpi_operand_object **params;
  92. u8 *aml_last_while;
  93. union acpi_operand_object **caller_return_desc;
  94. union acpi_generic_state *control_state; /* List of control states (nested IFs) */
  95. struct acpi_namespace_node *deferred_node; /* Used when executing deferred opcodes */
  96. struct acpi_gpe_event_info *gpe_event_info; /* Info for GPE (_Lxx/_Exx methods only */
  97. union acpi_operand_object *implicit_return_obj;
  98. struct acpi_namespace_node *method_call_node; /* Called method Node */
  99. union acpi_parse_object *method_call_op; /* method_call Op if running a method */
  100. union acpi_operand_object *method_desc; /* Method descriptor if running a method */
  101. struct acpi_namespace_node *method_node; /* Method node if running a method. */
  102. union acpi_parse_object *op; /* Current parser op */
  103. const struct acpi_opcode_info *op_info; /* Info on current opcode */
  104. union acpi_parse_object *origin; /* Start of walk [Obsolete] */
  105. union acpi_operand_object *result_obj;
  106. union acpi_generic_state *results; /* Stack of accumulated results */
  107. union acpi_operand_object *return_desc; /* Return object, if any */
  108. union acpi_generic_state *scope_info; /* Stack of nested scopes */
  109. union acpi_parse_object *prev_op; /* Last op that was processed */
  110. union acpi_parse_object *next_op; /* next op to be processed */
  111. struct acpi_thread_state *thread;
  112. acpi_parse_downwards descending_callback;
  113. acpi_parse_upwards ascending_callback;
  114. };
  115. /* Info used by acpi_ps_init_objects */
  116. struct acpi_init_walk_info {
  117. u16 method_count;
  118. u16 device_count;
  119. u16 op_region_count;
  120. u16 field_count;
  121. u16 buffer_count;
  122. u16 package_count;
  123. u16 op_region_init;
  124. u16 field_init;
  125. u16 buffer_init;
  126. u16 package_init;
  127. u16 object_count;
  128. acpi_owner_id owner_id;
  129. acpi_native_uint table_index;
  130. };
  131. struct acpi_get_devices_info {
  132. acpi_walk_callback user_function;
  133. void *context;
  134. char *hid;
  135. };
  136. union acpi_aml_operands {
  137. union acpi_operand_object *operands[7];
  138. struct {
  139. struct acpi_object_integer *type;
  140. struct acpi_object_integer *code;
  141. struct acpi_object_integer *argument;
  142. } fatal;
  143. struct {
  144. union acpi_operand_object *source;
  145. struct acpi_object_integer *index;
  146. union acpi_operand_object *target;
  147. } index;
  148. struct {
  149. union acpi_operand_object *source;
  150. struct acpi_object_integer *index;
  151. struct acpi_object_integer *length;
  152. union acpi_operand_object *target;
  153. } mid;
  154. };
  155. /*
  156. * Structure used to pass object evaluation parameters.
  157. * Purpose is to reduce CPU stack use.
  158. */
  159. struct acpi_evaluate_info {
  160. struct acpi_namespace_node *prefix_node;
  161. char *pathname;
  162. union acpi_operand_object *obj_desc;
  163. union acpi_operand_object **parameters;
  164. struct acpi_namespace_node *resolved_node;
  165. union acpi_operand_object *return_object;
  166. u8 pass_number;
  167. u8 parameter_type;
  168. u8 return_object_type;
  169. u8 flags;
  170. };
  171. /* Types for parameter_type above */
  172. #define ACPI_PARAM_ARGS 0
  173. #define ACPI_PARAM_GPE 1
  174. /* Values for Flags above */
  175. #define ACPI_IGNORE_RETURN_VALUE 1
  176. /* Info used by acpi_ns_initialize_devices */
  177. struct acpi_device_walk_info {
  178. u16 device_count;
  179. u16 num_STA;
  180. u16 num_INI;
  181. struct acpi_table_desc *table_desc;
  182. struct acpi_evaluate_info *evaluate_info;
  183. };
  184. /* TBD: [Restructure] Merge with struct above */
  185. struct acpi_walk_info {
  186. u32 debug_level;
  187. u32 count;
  188. acpi_owner_id owner_id;
  189. u8 display_type;
  190. };
  191. /* Display Types */
  192. #define ACPI_DISPLAY_SUMMARY (u8) 0
  193. #define ACPI_DISPLAY_OBJECTS (u8) 1
  194. #define ACPI_DISPLAY_MASK (u8) 1
  195. #define ACPI_DISPLAY_SHORT (u8) 2
  196. #endif