Subversion Repositories Kolibri OS

Rev

Blame | Last modification | View Log | Download | RSS feed

  1. /******************************************************************************
  2.  *
  3.  * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
  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 __ACPARSER_H__
  45. #define __ACPARSER_H__
  46.  
  47. #define OP_HAS_RETURN_VALUE             1
  48.  
  49. /* Variable number of arguments. This field must be 32 bits */
  50.  
  51. #define ACPI_VAR_ARGS                   ACPI_UINT32_MAX
  52.  
  53. #define ACPI_PARSE_DELETE_TREE          0x0001
  54. #define ACPI_PARSE_NO_TREE_DELETE       0x0000
  55. #define ACPI_PARSE_TREE_MASK            0x0001
  56.  
  57. #define ACPI_PARSE_LOAD_PASS1           0x0010
  58. #define ACPI_PARSE_LOAD_PASS2           0x0020
  59. #define ACPI_PARSE_EXECUTE              0x0030
  60. #define ACPI_PARSE_MODE_MASK            0x0030
  61.  
  62. #define ACPI_PARSE_DEFERRED_OP          0x0100
  63. #define ACPI_PARSE_DISASSEMBLE          0x0200
  64.  
  65. #define ACPI_PARSE_MODULE_LEVEL         0x0400
  66.  
  67. /******************************************************************************
  68.  *
  69.  * Parser interfaces
  70.  *
  71.  *****************************************************************************/
  72.  
  73. extern const u8 acpi_gbl_short_op_index[];
  74. extern const u8 acpi_gbl_long_op_index[];
  75.  
  76. /*
  77.  * psxface - Parser external interfaces
  78.  */
  79. acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info);
  80.  
  81. /*
  82.  * psargs - Parse AML opcode arguments
  83.  */
  84. u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state);
  85.  
  86. char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state);
  87.  
  88. void
  89. acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
  90.                             u32 arg_type, union acpi_parse_object *arg);
  91.  
  92. acpi_status
  93. acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state,
  94.                           struct acpi_parse_state *parser_state,
  95.                           union acpi_parse_object *arg, u8 method_call);
  96.  
  97. acpi_status
  98. acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
  99.                      struct acpi_parse_state *parser_state,
  100.                      u32 arg_type, union acpi_parse_object **return_arg);
  101.  
  102. /*
  103.  * psfind
  104.  */
  105. union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope,
  106.                                            u32 name, u32 opcode);
  107.  
  108. union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op);
  109.  
  110. /*
  111.  * psobject - support for parse object processing
  112.  */
  113. acpi_status
  114. acpi_ps_build_named_op(struct acpi_walk_state *walk_state,
  115.                        u8 *aml_op_start,
  116.                        union acpi_parse_object *unnamed_op,
  117.                        union acpi_parse_object **op);
  118.  
  119. acpi_status
  120. acpi_ps_create_op(struct acpi_walk_state *walk_state,
  121.                   u8 *aml_op_start, union acpi_parse_object **new_op);
  122.  
  123. acpi_status
  124. acpi_ps_complete_op(struct acpi_walk_state *walk_state,
  125.                     union acpi_parse_object **op, acpi_status status);
  126.  
  127. acpi_status
  128. acpi_ps_complete_final_op(struct acpi_walk_state *walk_state,
  129.                           union acpi_parse_object *op, acpi_status status);
  130.  
  131. /*
  132.  * psopinfo - AML Opcode information
  133.  */
  134. const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);
  135.  
  136. char *acpi_ps_get_opcode_name(u16 opcode);
  137.  
  138. u8 acpi_ps_get_argument_count(u32 op_type);
  139.  
  140. /*
  141.  * psparse - top level parsing routines
  142.  */
  143. acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);
  144.  
  145. u32 acpi_ps_get_opcode_size(u32 opcode);
  146.  
  147. u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);
  148.  
  149. acpi_status
  150. acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
  151.                          union acpi_parse_object *op);
  152.  
  153. acpi_status
  154. acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
  155.                          union acpi_parse_object *op,
  156.                          acpi_status callback_status);
  157.  
  158. /*
  159.  * psloop - main parse loop
  160.  */
  161. acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);
  162.  
  163. /*
  164.  * psscope - Scope stack management routines
  165.  */
  166. acpi_status
  167. acpi_ps_init_scope(struct acpi_parse_state *parser_state,
  168.                    union acpi_parse_object *root);
  169.  
  170. union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
  171.                                                   *state);
  172.  
  173. u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);
  174.  
  175. void
  176. acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
  177.                   union acpi_parse_object **op, u32 *arg_list, u32 *arg_count);
  178.  
  179. acpi_status
  180. acpi_ps_push_scope(struct acpi_parse_state *parser_state,
  181.                    union acpi_parse_object *op,
  182.                    u32 remaining_args, u32 arg_count);
  183.  
  184. void acpi_ps_cleanup_scope(struct acpi_parse_state *state);
  185.  
  186. /*
  187.  * pstree - parse tree manipulation routines
  188.  */
  189. void
  190. acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);
  191.  
  192. union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
  193.                                       char *path, u16 opcode, u32 create);
  194.  
  195. union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);
  196.  
  197. union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
  198.                                                 union acpi_parse_object *op);
  199.  
  200. /*
  201.  * pswalk - parse tree walk routines
  202.  */
  203. acpi_status
  204. acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op,
  205.                         union acpi_parse_object *end_op,
  206.                         union acpi_operand_object *mth_desc,
  207.                         struct acpi_namespace_node *start_node,
  208.                         union acpi_operand_object **params,
  209.                         union acpi_operand_object **caller_return_desc,
  210.                         acpi_owner_id owner_id,
  211.                         acpi_parse_downwards descending_callback,
  212.                         acpi_parse_upwards ascending_callback);
  213.  
  214. acpi_status
  215. acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
  216.                          union acpi_parse_object *op,
  217.                          acpi_parse_upwards ascending_callback);
  218.  
  219. acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);
  220.  
  221. void acpi_ps_delete_parse_tree(union acpi_parse_object *root);
  222.  
  223. /*
  224.  * psutils - parser utilities
  225.  */
  226. union acpi_parse_object *acpi_ps_create_scope_op(u8 *aml);
  227.  
  228. void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);
  229.  
  230. union acpi_parse_object *acpi_ps_alloc_op(u16 opcode, u8 *aml);
  231.  
  232. void acpi_ps_free_op(union acpi_parse_object *op);
  233.  
  234. u8 acpi_ps_is_leading_char(u32 c);
  235.  
  236. u32 acpi_ps_get_name(union acpi_parse_object *op);
  237.  
  238. void acpi_ps_set_name(union acpi_parse_object *op, u32 name);
  239.  
  240. /*
  241.  * psdump - display parser tree
  242.  */
  243. u32
  244. acpi_ps_sprint_path(char *buffer_start,
  245.                     u32 buffer_size, union acpi_parse_object *op);
  246.  
  247. u32
  248. acpi_ps_sprint_op(char *buffer_start,
  249.                   u32 buffer_size, union acpi_parse_object *op);
  250.  
  251. void acpi_ps_show(union acpi_parse_object *op);
  252.  
  253. #endif                          /* __ACPARSER_H__ */
  254.