include/acpi/acdispat.h

   1 /******************************************************************************
   2  *
   3  * Name: acdispat.h - dispatcher (parser to interpreter interface)
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2007, R. Byron Moore
   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  * dsopcode - support for late evaluation
  52  */
  53 acpi_status
  54 acpi_ds_get_buffer_field_arguments(union acpi_operand_object *obj_desc);
  55
  56 acpi_status acpi_ds_get_region_arguments(union acpi_operand_object *rgn_desc);
  57
  58 acpi_status acpi_ds_get_buffer_arguments(union acpi_operand_object *obj_desc);
  59
  60 acpi_status acpi_ds_get_package_arguments(union acpi_operand_object *obj_desc);
  61
  62 acpi_status
  63 acpi_ds_eval_buffer_field_operands(struct acpi_walk_state *walk_state,
  64                                    union acpi_parse_object *op);
  65
  66 acpi_status
  67 acpi_ds_eval_region_operands(struct acpi_walk_state *walk_state,
  68                              union acpi_parse_object *op);
  69
  70 acpi_status
  71 acpi_ds_eval_table_region_operands(struct acpi_walk_state *walk_state,
  72                                    union acpi_parse_object *op);
  73
  74 acpi_status
  75 acpi_ds_eval_data_object_operands(struct acpi_walk_state *walk_state,
  76                                   union acpi_parse_object *op,
  77                                   union acpi_operand_object *obj_desc);
  78
  79 acpi_status acpi_ds_initialize_region(acpi_handle obj_handle);
  80
  81 /*
  82  * dsctrl - Parser/Interpreter interface, control stack routines
  83  */
  84 acpi_status
  85 acpi_ds_exec_begin_control_op(struct acpi_walk_state *walk_state,
  86                               union acpi_parse_object *op);
  87
  88 acpi_status
  89 acpi_ds_exec_end_control_op(struct acpi_walk_state *walk_state,
  90                             union acpi_parse_object *op);
  91
  92 /*
  93  * dsexec - Parser/Interpreter interface, method execution callbacks
  94  */
  95 acpi_status
  96 acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
  97                             union acpi_operand_object *result_obj);
  98
  99 acpi_status
 100 acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
 101                       union acpi_parse_object **out_op);
 102
 103 acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *state);
 104
 105 /*
 106  * dsfield - Parser/Interpreter interface for AML fields
 107  */
 108 acpi_status
 109 acpi_ds_create_field(union acpi_parse_object *op,
 110                      struct acpi_namespace_node *region_node,
 111                      struct acpi_walk_state *walk_state);
 112
 113 acpi_status
 114 acpi_ds_create_bank_field(union acpi_parse_object *op,
 115                           struct acpi_namespace_node *region_node,
 116                           struct acpi_walk_state *walk_state);
 117
 118 acpi_status
 119 acpi_ds_create_index_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_buffer_field(union acpi_parse_object *op,
 125                             struct acpi_walk_state *walk_state);
 126
 127 acpi_status
 128 acpi_ds_init_field_objects(union acpi_parse_object *op,
 129                            struct acpi_walk_state *walk_state);
 130
 131 /*
 132  * dsload - Parser/Interpreter interface, namespace load callbacks
 133  */
 134 acpi_status
 135 acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state,
 136                        union acpi_parse_object **out_op);
 137
 138 acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state);
 139
 140 acpi_status
 141 acpi_ds_load2_begin_op(struct acpi_walk_state *walk_state,
 142                        union acpi_parse_object **out_op);
 143
 144 acpi_status acpi_ds_load2_end_op(struct acpi_walk_state *walk_state);
 145
 146 acpi_status
 147 acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number);
 148
 149 /*
 150  * dsmthdat - method data (locals/args)
 151  */
 152 acpi_status
 153 acpi_ds_store_object_to_local(u16 opcode,
 154                               u32 index,
 155                               union acpi_operand_object *src_desc,
 156                               struct acpi_walk_state *walk_state);
 157
 158 acpi_status
 159 acpi_ds_method_data_get_entry(u16 opcode,
 160                               u32 index,
 161                               struct acpi_walk_state *walk_state,
 162                               union acpi_operand_object ***node);
 163
 164 void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state);
 165
 166 u8 acpi_ds_is_method_value(union acpi_operand_object *obj_desc);
 167
 168 acpi_status
 169 acpi_ds_method_data_get_value(u16 opcode,
 170                               u32 index,
 171                               struct acpi_walk_state *walk_state,
 172                               union acpi_operand_object **dest_desc);
 173
 174 acpi_status
 175 acpi_ds_method_data_init_args(union acpi_operand_object **params,
 176                               u32 max_param_count,
 177                               struct acpi_walk_state *walk_state);
 178
 179 acpi_status
 180 acpi_ds_method_data_get_node(u16 opcode,
 181                              u32 index,
 182                              struct acpi_walk_state *walk_state,
 183                              struct acpi_namespace_node **node);
 184
 185 void acpi_ds_method_data_init(struct acpi_walk_state *walk_state);
 186
 187 /*
 188  * dsmethod - Parser/Interpreter interface - control method parsing
 189  */
 190 acpi_status acpi_ds_parse_method(struct acpi_namespace_node *node);
 191
 192 acpi_status
 193 acpi_ds_call_control_method(struct acpi_thread_state *thread,
 194                             struct acpi_walk_state *walk_state,
 195                             union acpi_parse_object *op);
 196
 197 acpi_status
 198 acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
 199                                union acpi_operand_object *return_desc);
 200
 201 void
 202 acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
 203                                  struct acpi_walk_state *walk_state);
 204
 205 acpi_status
 206 acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
 207                                union acpi_operand_object *obj_desc,
 208                                struct acpi_walk_state *walk_state);
 209
 210 acpi_status
 211 acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state);
 212
 213 /*
 214  * dsinit
 215  */
 216 acpi_status
 217 acpi_ds_initialize_objects(acpi_native_uint table_index,
 218                            struct acpi_namespace_node *start_node);
 219
 220 /*
 221  * dsobject - Parser/Interpreter interface - object initialization and conversion
 222  */
 223 acpi_status
 224 acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
 225                                   union acpi_parse_object *op,
 226                                   u32 buffer_length,
 227                                   union acpi_operand_object **obj_desc_ptr);
 228
 229 acpi_status
 230 acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
 231                                    union acpi_parse_object *op,
 232                                    u32 package_length,
 233                                    union acpi_operand_object **obj_desc);
 234
 235 acpi_status
 236 acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
 237                             union acpi_parse_object *op,
 238                             u16 opcode, union acpi_operand_object **obj_desc);
 239
 240 acpi_status
 241 acpi_ds_create_node(struct acpi_walk_state *walk_state,
 242                     struct acpi_namespace_node *node,
 243                     union acpi_parse_object *op);
 244
 245 /*
 246  * dsutils - Parser/Interpreter interface utility routines
 247  */
 248 void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state);
 249
 250 u8
 251 acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
 252                            struct acpi_walk_state *walk_state,
 253                            u8 add_reference);
 254
 255 u8
 256 acpi_ds_is_result_used(union acpi_parse_object *op,
 257                        struct acpi_walk_state *walk_state);
 258
 259 void
 260 acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
 261                                   union acpi_operand_object *result_obj,
 262                                   struct acpi_walk_state *walk_state);
 263
 264 acpi_status
 265 acpi_ds_create_operand(struct acpi_walk_state *walk_state,
 266                        union acpi_parse_object *arg, u32 args_remaining);
 267
 268 acpi_status
 269 acpi_ds_create_operands(struct acpi_walk_state *walk_state,
 270                         union acpi_parse_object *first_arg);
 271
 272 acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state);
 273
 274 void acpi_ds_clear_operands(struct acpi_walk_state *walk_state);
 275
 276 acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state);
 277
 278 /*
 279  * dswscope - Scope Stack manipulation
 280  */
 281 acpi_status
 282 acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
 283                          acpi_object_type type,
 284                          struct acpi_walk_state *walk_state);
 285
 286 acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state);
 287
 288 void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state);
 289
 290 /*
 291  * dswstate - parser WALK_STATE management routines
 292  */
 293 acpi_status
 294 acpi_ds_obj_stack_push(void *object, struct acpi_walk_state *walk_state);
 295
 296 acpi_status
 297 acpi_ds_obj_stack_pop(u32 pop_count, struct acpi_walk_state *walk_state);
 298
 299 struct acpi_walk_state *acpi_ds_create_walk_state(acpi_owner_id owner_id, union acpi_parse_object
 300                                                   *origin, union acpi_operand_object
 301                                                   *mth_desc, struct acpi_thread_state
 302                                                   *thread);
 303
 304 acpi_status
 305 acpi_ds_init_aml_walk(struct acpi_walk_state *walk_state,
 306                       union acpi_parse_object *op,
 307                       struct acpi_namespace_node *method_node,
 308                       u8 * aml_start,
 309                       u32 aml_length,
 310                       struct acpi_evaluate_info *info, u8 pass_number);
 311
 312 void
 313 acpi_ds_obj_stack_pop_and_delete(u32 pop_count,
 314                                  struct acpi_walk_state *walk_state);
 315
 316 void acpi_ds_delete_walk_state(struct acpi_walk_state *walk_state);
 317
 318 struct acpi_walk_state *acpi_ds_pop_walk_state(struct acpi_thread_state
 319                                                *thread);
 320
 321 void
 322 acpi_ds_push_walk_state(struct acpi_walk_state *walk_state,
 323                         struct acpi_thread_state *thread);
 324
 325 acpi_status acpi_ds_result_stack_clear(struct acpi_walk_state *walk_state);
 326
 327 struct acpi_walk_state *acpi_ds_get_current_walk_state(struct acpi_thread_state
 328                                                        *thread);
 329
 330 acpi_status
 331 acpi_ds_result_pop(union acpi_operand_object **object,
 332                    struct acpi_walk_state *walk_state);
 333
 334 acpi_status
 335 acpi_ds_result_push(union acpi_operand_object *object,
 336                     struct acpi_walk_state *walk_state);
 337
 338 #endif                          /* _ACDISPAT_H_ */