drivers/acpi/acpica/acparser.h

   1 /******************************************************************************
   2  *
   3  * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2016, 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,
  96                           u8 possible_method_call);
  97
  98 /* Values for u8 above */
  99
 100 #define ACPI_NOT_METHOD_CALL            FALSE
 101 #define ACPI_POSSIBLE_METHOD_CALL       TRUE
 102
 103 acpi_status
 104 acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
 105                      struct acpi_parse_state *parser_state,
 106                      u32 arg_type, union acpi_parse_object **return_arg);
 107
 108 /*
 109  * psfind
 110  */
 111 union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope,
 112                                            u32 name, u32 opcode);
 113
 114 union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op);
 115
 116 /*
 117  * psobject - support for parse object processing
 118  */
 119 acpi_status
 120 acpi_ps_build_named_op(struct acpi_walk_state *walk_state,
 121                        u8 *aml_op_start,
 122                        union acpi_parse_object *unnamed_op,
 123                        union acpi_parse_object **op);
 124
 125 acpi_status
 126 acpi_ps_create_op(struct acpi_walk_state *walk_state,
 127                   u8 *aml_op_start, union acpi_parse_object **new_op);
 128
 129 acpi_status
 130 acpi_ps_complete_op(struct acpi_walk_state *walk_state,
 131                     union acpi_parse_object **op, acpi_status status);
 132
 133 acpi_status
 134 acpi_ps_complete_final_op(struct acpi_walk_state *walk_state,
 135                           union acpi_parse_object *op, acpi_status status);
 136
 137 /*
 138  * psopinfo - AML Opcode information
 139  */
 140 const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);
 141
 142 const char *acpi_ps_get_opcode_name(u16 opcode);
 143
 144 u8 acpi_ps_get_argument_count(u32 op_type);
 145
 146 /*
 147  * psparse - top level parsing routines
 148  */
 149 acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);
 150
 151 u32 acpi_ps_get_opcode_size(u32 opcode);
 152
 153 u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);
 154
 155 acpi_status
 156 acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
 157                          union acpi_parse_object *op);
 158
 159 acpi_status
 160 acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
 161                          union acpi_parse_object *op,
 162                          acpi_status callback_status);
 163
 164 /*
 165  * psloop - main parse loop
 166  */
 167 acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);
 168
 169 /*
 170  * psscope - Scope stack management routines
 171  */
 172 acpi_status
 173 acpi_ps_init_scope(struct acpi_parse_state *parser_state,
 174                    union acpi_parse_object *root);
 175
 176 union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
 177                                                   *state);
 178
 179 u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);
 180
 181 void
 182 acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
 183                   union acpi_parse_object **op, u32 *arg_list, u32 *arg_count);
 184
 185 acpi_status
 186 acpi_ps_push_scope(struct acpi_parse_state *parser_state,
 187                    union acpi_parse_object *op,
 188                    u32 remaining_args, u32 arg_count);
 189
 190 void acpi_ps_cleanup_scope(struct acpi_parse_state *state);
 191
 192 /*
 193  * pstree - parse tree manipulation routines
 194  */
 195 void
 196 acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);
 197
 198 union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
 199                                       char *path, u16 opcode, u32 create);
 200
 201 union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);
 202
 203 union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
 204                                                 union acpi_parse_object *op);
 205
 206 /*
 207  * pswalk - parse tree walk routines
 208  */
 209 acpi_status
 210 acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op,
 211                         union acpi_parse_object *end_op,
 212                         union acpi_operand_object *mth_desc,
 213                         struct acpi_namespace_node *start_node,
 214                         union acpi_operand_object **params,
 215                         union acpi_operand_object **caller_return_desc,
 216                         acpi_owner_id owner_id,
 217                         acpi_parse_downwards descending_callback,
 218                         acpi_parse_upwards ascending_callback);
 219
 220 acpi_status
 221 acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
 222                          union acpi_parse_object *op,
 223                          acpi_parse_upwards ascending_callback);
 224
 225 acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);
 226
 227 void acpi_ps_delete_parse_tree(union acpi_parse_object *root);
 228
 229 /*
 230  * psutils - parser utilities
 231  */
 232 union acpi_parse_object *acpi_ps_create_scope_op(u8 *aml);
 233
 234 void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);
 235
 236 union acpi_parse_object *acpi_ps_alloc_op(u16 opcode, u8 *aml);
 237
 238 void acpi_ps_free_op(union acpi_parse_object *op);
 239
 240 u8 acpi_ps_is_leading_char(u32 c);
 241
 242 u32 acpi_ps_get_name(union acpi_parse_object *op);
 243
 244 void acpi_ps_set_name(union acpi_parse_object *op, u32 name);
 245
 246 /*
 247  * psdump - display parser tree
 248  */
 249 u32
 250 acpi_ps_sprint_path(char *buffer_start,
 251                     u32 buffer_size, union acpi_parse_object *op);
 252
 253 u32
 254 acpi_ps_sprint_op(char *buffer_start,
 255                   u32 buffer_size, union acpi_parse_object *op);
 256
 257 void acpi_ps_show(union acpi_parse_object *op);
 258
 259 #endif                          /* __ACPARSER_H__ */