Subversion Repositories Kolibri OS

Rev

Go to most recent revision | Blame | Last modification | View Log | Download | RSS feed

  1. /******************************************************************************
  2.  *
  3.  * Name: acdispat.h - dispatcher (parser to interpreter interface)
  4.  *
  5.  *****************************************************************************/
  6.  
  7. /*
  8.  * Copyright (C) 2000 - 2015, Intel Corp.
  9.  * All rights reserved.
  10.  *
  11.  * Redistribution and use in source and binary forms, with or without
  12.  * modification, are permitted provided that the following conditions
  13.  * are met:
  14.  * 1. Redistributions of source code must retain the above copyright
  15.  *    notice, this list of conditions, and the following disclaimer,
  16.  *    without modification.
  17.  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18.  *    substantially similar to the "NO WARRANTY" disclaimer below
  19.  *    ("Disclaimer") and any redistribution must be conditioned upon
  20.  *    including a substantially similar Disclaimer requirement for further
  21.  *    binary redistribution.
  22.  * 3. Neither the names of the above-listed copyright holders nor the names
  23.  *    of any contributors may be used to endorse or promote products derived
  24.  *    from this software without specific prior written permission.
  25.  *
  26.  * Alternatively, this software may be distributed under the terms of the
  27.  * GNU General Public License ("GPL") version 2 as published by the Free
  28.  * Software Foundation.
  29.  *
  30.  * NO WARRANTY
  31.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35.  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40.  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41.  * POSSIBILITY OF SUCH DAMAGES.
  42.  */
  43.  
  44. #ifndef _ACDISPAT_H_
  45. #define _ACDISPAT_H_
  46.  
  47. #define NAMEOF_LOCAL_NTE    "__L0"
  48. #define NAMEOF_ARG_NTE      "__A0"
  49.  
  50. /*
  51.  * dsargs - execution of dynamic arguments for static objects
  52.  */
  53. acpi_status
  54. acpi_ds_get_buffer_field_arguments(union acpi_operand_object *obj_desc);
  55.  
  56. acpi_status
  57. acpi_ds_get_bank_field_arguments(union acpi_operand_object *obj_desc);
  58.  
  59. acpi_status acpi_ds_get_region_arguments(union acpi_operand_object *rgn_desc);
  60.  
  61. acpi_status acpi_ds_get_buffer_arguments(union acpi_operand_object *obj_desc);
  62.  
  63. acpi_status acpi_ds_get_package_arguments(union acpi_operand_object *obj_desc);
  64.  
  65. /*
  66.  * dscontrol - support for execution control opcodes
  67.  */
  68. acpi_status
  69. acpi_ds_exec_begin_control_op(struct acpi_walk_state *walk_state,
  70.                               union acpi_parse_object *op);
  71.  
  72. acpi_status
  73. acpi_ds_exec_end_control_op(struct acpi_walk_state *walk_state,
  74.                             union acpi_parse_object *op);
  75.  
  76. /*
  77.  * dsopcode - support for late operand evaluation
  78.  */
  79. acpi_status
  80. acpi_ds_eval_buffer_field_operands(struct acpi_walk_state *walk_state,
  81.                                    union acpi_parse_object *op);
  82.  
  83. acpi_status
  84. acpi_ds_eval_region_operands(struct acpi_walk_state *walk_state,
  85.                              union acpi_parse_object *op);
  86.  
  87. acpi_status
  88. acpi_ds_eval_table_region_operands(struct acpi_walk_state *walk_state,
  89.                                    union acpi_parse_object *op);
  90.  
  91. acpi_status
  92. acpi_ds_eval_data_object_operands(struct acpi_walk_state *walk_state,
  93.                                   union acpi_parse_object *op,
  94.                                   union acpi_operand_object *obj_desc);
  95.  
  96. acpi_status
  97. acpi_ds_eval_bank_field_operands(struct acpi_walk_state *walk_state,
  98.                                  union acpi_parse_object *op);
  99.  
  100. acpi_status acpi_ds_initialize_region(acpi_handle obj_handle);
  101.  
  102. /*
  103.  * dsexec - Parser/Interpreter interface, method execution callbacks
  104.  */
  105. acpi_status
  106. acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
  107.                             union acpi_operand_object *result_obj);
  108.  
  109. acpi_status
  110. acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
  111.                       union acpi_parse_object **out_op);
  112.  
  113. acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *state);
  114.  
  115. /*
  116.  * dsfield - Parser/Interpreter interface for AML fields
  117.  */
  118. acpi_status
  119. acpi_ds_create_field(union acpi_parse_object *op,
  120.                      struct acpi_namespace_node *region_node,
  121.                      struct acpi_walk_state *walk_state);
  122.  
  123. acpi_status
  124. acpi_ds_create_bank_field(union acpi_parse_object *op,
  125.                           struct acpi_namespace_node *region_node,
  126.                           struct acpi_walk_state *walk_state);
  127.  
  128. acpi_status
  129. acpi_ds_create_index_field(union acpi_parse_object *op,
  130.                            struct acpi_namespace_node *region_node,
  131.                            struct acpi_walk_state *walk_state);
  132.  
  133. acpi_status
  134. acpi_ds_create_buffer_field(union acpi_parse_object *op,
  135.                             struct acpi_walk_state *walk_state);
  136.  
  137. acpi_status
  138. acpi_ds_init_field_objects(union acpi_parse_object *op,
  139.                            struct acpi_walk_state *walk_state);
  140.  
  141. /*
  142.  * dsload - Parser/Interpreter interface
  143.  */
  144. acpi_status
  145. acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number);
  146.  
  147. /* dsload - pass 1 namespace load callbacks */
  148.  
  149. acpi_status
  150. acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state,
  151.                        union acpi_parse_object **out_op);
  152.  
  153. acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state);
  154.  
  155. /* dsload - pass 2 namespace load callbacks */
  156.  
  157. acpi_status
  158. acpi_ds_load2_begin_op(struct acpi_walk_state *walk_state,
  159.                        union acpi_parse_object **out_op);
  160.  
  161. acpi_status acpi_ds_load2_end_op(struct acpi_walk_state *walk_state);
  162.  
  163. /*
  164.  * dsmthdat - method data (locals/args)
  165.  */
  166. acpi_status
  167. acpi_ds_store_object_to_local(u8 type,
  168.                               u32 index,
  169.                               union acpi_operand_object *src_desc,
  170.                               struct acpi_walk_state *walk_state);
  171.  
  172. acpi_status
  173. acpi_ds_method_data_get_entry(u16 opcode,
  174.                               u32 index,
  175.                               struct acpi_walk_state *walk_state,
  176.                               union acpi_operand_object ***node);
  177.  
  178. void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state);
  179.  
  180. u8 acpi_ds_is_method_value(union acpi_operand_object *obj_desc);
  181.  
  182. acpi_status
  183. acpi_ds_method_data_get_value(u8 type,
  184.                               u32 index,
  185.                               struct acpi_walk_state *walk_state,
  186.                               union acpi_operand_object **dest_desc);
  187.  
  188. acpi_status
  189. acpi_ds_method_data_init_args(union acpi_operand_object **params,
  190.                               u32 max_param_count,
  191.                               struct acpi_walk_state *walk_state);
  192.  
  193. acpi_status
  194. acpi_ds_method_data_get_node(u8 type,
  195.                              u32 index,
  196.                              struct acpi_walk_state *walk_state,
  197.                              struct acpi_namespace_node **node);
  198.  
  199. void acpi_ds_method_data_init(struct acpi_walk_state *walk_state);
  200.  
  201. /*
  202.  * dsmethod - Parser/Interpreter interface - control method parsing
  203.  */
  204. acpi_status
  205. acpi_ds_auto_serialize_method(struct acpi_namespace_node *node,
  206.                               union acpi_operand_object *obj_desc);
  207.  
  208. acpi_status
  209. acpi_ds_call_control_method(struct acpi_thread_state *thread,
  210.                             struct acpi_walk_state *walk_state,
  211.                             union acpi_parse_object *op);
  212.  
  213. acpi_status
  214. acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
  215.                                union acpi_operand_object *return_desc);
  216.  
  217. void
  218. acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
  219.                                  struct acpi_walk_state *walk_state);
  220.  
  221. acpi_status
  222. acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
  223.                                union acpi_operand_object *obj_desc,
  224.                                struct acpi_walk_state *walk_state);
  225.  
  226. acpi_status
  227. acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state);
  228.  
  229. /*
  230.  * dsinit
  231.  */
  232. acpi_status
  233. acpi_ds_initialize_objects(u32 table_index,
  234.                            struct acpi_namespace_node *start_node);
  235.  
  236. /*
  237.  * dsobject - Parser/Interpreter interface - object initialization and conversion
  238.  */
  239. acpi_status
  240. acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
  241.                                   union acpi_parse_object *op,
  242.                                   u32 buffer_length,
  243.                                   union acpi_operand_object **obj_desc_ptr);
  244.  
  245. acpi_status
  246. acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
  247.                                    union acpi_parse_object *op,
  248.                                    u32 package_length,
  249.                                    union acpi_operand_object **obj_desc);
  250.  
  251. acpi_status
  252. acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
  253.                             union acpi_parse_object *op,
  254.                             u16 opcode, union acpi_operand_object **obj_desc);
  255.  
  256. acpi_status
  257. acpi_ds_create_node(struct acpi_walk_state *walk_state,
  258.                     struct acpi_namespace_node *node,
  259.                     union acpi_parse_object *op);
  260.  
  261. /*
  262.  * dsutils - Parser/Interpreter interface utility routines
  263.  */
  264. void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state);
  265.  
  266. u8
  267. acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
  268.                            struct acpi_walk_state *walk_state,
  269.                            u8 add_reference);
  270.  
  271. u8
  272. acpi_ds_is_result_used(union acpi_parse_object *op,
  273.                        struct acpi_walk_state *walk_state);
  274.  
  275. void
  276. acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
  277.                                   union acpi_operand_object *result_obj,
  278.                                   struct acpi_walk_state *walk_state);
  279.  
  280. acpi_status
  281. acpi_ds_create_operand(struct acpi_walk_state *walk_state,
  282.                        union acpi_parse_object *arg, u32 args_remaining);
  283.  
  284. acpi_status
  285. acpi_ds_create_operands(struct acpi_walk_state *walk_state,
  286.                         union acpi_parse_object *first_arg);
  287.  
  288. acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state);
  289.  
  290. void acpi_ds_clear_operands(struct acpi_walk_state *walk_state);
  291.  
  292. acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state);
  293.  
  294. /*
  295.  * dswscope - Scope Stack manipulation
  296.  */
  297. acpi_status
  298. acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
  299.                          acpi_object_type type,
  300.                          struct acpi_walk_state *walk_state);
  301.  
  302. acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state);
  303.  
  304. void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state);
  305.  
  306. /*
  307.  * dswstate - parser WALK_STATE management routines
  308.  */
  309. acpi_status
  310. acpi_ds_obj_stack_push(void *object, struct acpi_walk_state *walk_state);
  311.  
  312. acpi_status
  313. acpi_ds_obj_stack_pop(u32 pop_count, struct acpi_walk_state *walk_state);
  314.  
  315. struct acpi_walk_state * acpi_ds_create_walk_state(acpi_owner_id owner_id,
  316.                                                    union acpi_parse_object
  317.                                                    *origin,
  318.                                                    union acpi_operand_object
  319.                                                    *mth_desc,
  320.                                                    struct acpi_thread_state
  321.                                                    *thread);
  322.  
  323. acpi_status
  324. acpi_ds_init_aml_walk(struct acpi_walk_state *walk_state,
  325.                       union acpi_parse_object *op,
  326.                       struct acpi_namespace_node *method_node,
  327.                       u8 * aml_start,
  328.                       u32 aml_length,
  329.                       struct acpi_evaluate_info *info, u8 pass_number);
  330.  
  331. void
  332. acpi_ds_obj_stack_pop_and_delete(u32 pop_count,
  333.                                  struct acpi_walk_state *walk_state);
  334.  
  335. void acpi_ds_delete_walk_state(struct acpi_walk_state *walk_state);
  336.  
  337. struct acpi_walk_state *acpi_ds_pop_walk_state(struct acpi_thread_state
  338.                                                *thread);
  339.  
  340. void
  341. acpi_ds_push_walk_state(struct acpi_walk_state *walk_state,
  342.                         struct acpi_thread_state *thread);
  343.  
  344. acpi_status acpi_ds_result_stack_clear(struct acpi_walk_state *walk_state);
  345.  
  346. struct acpi_walk_state *acpi_ds_get_current_walk_state(struct acpi_thread_state
  347.                                                        *thread);
  348.  
  349. acpi_status
  350. acpi_ds_result_pop(union acpi_operand_object **object,
  351.                    struct acpi_walk_state *walk_state);
  352.  
  353. acpi_status
  354. acpi_ds_result_push(union acpi_operand_object *object,
  355.                     struct acpi_walk_state *walk_state);
  356.  
  357. /*
  358.  * dsdebug - parser debugging routines
  359.  */
  360. void
  361. acpi_ds_dump_method_stack(acpi_status status,
  362.                           struct acpi_walk_state *walk_state,
  363.                           union acpi_parse_object *op);
  364.  
  365. #endif                          /* _ACDISPAT_H_ */
  366.