drivers/acpi/include/acdispat.h

   1 /******************************************************************************
   2  *
   3  * Name: acdispat.h - dispatcher (parser to interpreter interface)
   4  *       $Revision: 33 $
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  *  Copyright (C) 2000 R. Byron Moore
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; if not, write to the Free Software
  23  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26
  27 #ifndef _ACDISPAT_H_
  28 #define _ACDISPAT_H_
  29
  30
  31 #define NAMEOF_LOCAL_NTE    "__L0"
  32 #define NAMEOF_ARG_NTE      "__A0"
  33
  34
  35 /* For Acpi_ds_method_data_set_value */
  36
  37 #define MTH_TYPE_LOCAL              0
  38 #define MTH_TYPE_ARG                1
  39
  40
  41 /* Common interfaces */
  42
  43 ACPI_STATUS
  44 acpi_ds_obj_stack_push (
  45         void                    *object,
  46         ACPI_WALK_STATE         *walk_state);
  47
  48 ACPI_STATUS
  49 acpi_ds_obj_stack_pop (
  50         u32                     pop_count,
  51         ACPI_WALK_STATE         *walk_state);
  52
  53 void *
  54 acpi_ds_obj_stack_get_value (
  55         u32                     index,
  56         ACPI_WALK_STATE         *walk_state);
  57
  58 ACPI_STATUS
  59 acpi_ds_obj_stack_pop_object (
  60         ACPI_OPERAND_OBJECT     **object,
  61         ACPI_WALK_STATE         *walk_state);
  62
  63
  64 /* dsopcode - support for late evaluation */
  65
  66 ACPI_STATUS
  67 acpi_ds_get_field_unit_arguments (
  68         ACPI_OPERAND_OBJECT     *obj_desc);
  69
  70 ACPI_STATUS
  71 acpi_ds_get_region_arguments (
  72         ACPI_OPERAND_OBJECT     *rgn_desc);
  73
  74
  75 /* dsctrl - Parser/Interpreter interface, control stack routines */
  76
  77
  78 ACPI_STATUS
  79 acpi_ds_exec_begin_control_op (
  80         ACPI_WALK_STATE         *walk_state,
  81         ACPI_PARSE_OBJECT       *op);
  82
  83 ACPI_STATUS
  84 acpi_ds_exec_end_control_op (
  85         ACPI_WALK_STATE         *walk_state,
  86         ACPI_PARSE_OBJECT       *op);
  87
  88
  89 /* dsexec - Parser/Interpreter interface, method execution callbacks */
  90
  91
  92 ACPI_STATUS
  93 acpi_ds_get_predicate_value (
  94         ACPI_WALK_STATE         *walk_state,
  95         ACPI_PARSE_OBJECT       *op,
  96         u32                     has_result_obj);
  97
  98 ACPI_STATUS
  99 acpi_ds_exec_begin_op (
 100         u16                     opcode,
 101         ACPI_PARSE_OBJECT       *op,
 102         ACPI_WALK_STATE         *walk_state,
 103         ACPI_PARSE_OBJECT       **out_op);
 104
 105 ACPI_STATUS
 106 acpi_ds_exec_end_op (
 107         ACPI_WALK_STATE         *state,
 108         ACPI_PARSE_OBJECT       *op);
 109
 110
 111 /* dsfield - Parser/Interpreter interface for AML fields */
 112
 113
 114 ACPI_STATUS
 115 acpi_ds_create_field (
 116         ACPI_PARSE_OBJECT       *op,
 117         ACPI_NAMESPACE_NODE     *region_node,
 118         ACPI_WALK_STATE         *walk_state);
 119
 120 ACPI_STATUS
 121 acpi_ds_create_bank_field (
 122         ACPI_PARSE_OBJECT       *op,
 123         ACPI_NAMESPACE_NODE     *region_node,
 124         ACPI_WALK_STATE         *walk_state);
 125
 126 ACPI_STATUS
 127 acpi_ds_create_index_field (
 128         ACPI_PARSE_OBJECT       *op,
 129         ACPI_HANDLE             region_node,
 130         ACPI_WALK_STATE         *walk_state);
 131
 132
 133 /* dsload - Parser/Interpreter interface, namespace load callbacks */
 134
 135 ACPI_STATUS
 136 acpi_ds_load1_begin_op (
 137         u16                     opcode,
 138         ACPI_PARSE_OBJECT       *op,
 139         ACPI_WALK_STATE         *walk_state,
 140         ACPI_PARSE_OBJECT       **out_op);
 141
 142 ACPI_STATUS
 143 acpi_ds_load1_end_op (
 144         ACPI_WALK_STATE         *walk_state,
 145         ACPI_PARSE_OBJECT       *op);
 146
 147 ACPI_STATUS
 148 acpi_ds_load2_begin_op (
 149         u16                     opcode,
 150         ACPI_PARSE_OBJECT       *op,
 151         ACPI_WALK_STATE         *walk_state,
 152         ACPI_PARSE_OBJECT       **out_op);
 153
 154 ACPI_STATUS
 155 acpi_ds_load2_end_op (
 156         ACPI_WALK_STATE         *state,
 157         ACPI_PARSE_OBJECT       *op);
 158
 159 ACPI_STATUS
 160 acpi_ds_load3_begin_op (
 161         u16                     opcode,
 162         ACPI_PARSE_OBJECT       *op,
 163         ACPI_WALK_STATE         *walk_state,
 164         ACPI_PARSE_OBJECT       **out_op);
 165
 166 ACPI_STATUS
 167 acpi_ds_load3_end_op (
 168         ACPI_WALK_STATE         *state,
 169         ACPI_PARSE_OBJECT       *op);
 170
 171
 172 /* dsmthdat - method data (locals/args) */
 173
 174
 175 ACPI_STATUS
 176 acpi_ds_method_data_get_entry (
 177         u32                     type,
 178         u32                     index,
 179         ACPI_WALK_STATE         *walk_state,
 180         ACPI_OPERAND_OBJECT     ***node);
 181
 182 ACPI_STATUS
 183 acpi_ds_method_data_delete_all (
 184         ACPI_WALK_STATE         *walk_state);
 185
 186 u8
 187 acpi_ds_is_method_value (
 188         ACPI_OPERAND_OBJECT     *obj_desc);
 189
 190 OBJECT_TYPE_INTERNAL
 191 acpi_ds_method_data_get_type (
 192         u32                     type,
 193         u32                     index,
 194         ACPI_WALK_STATE         *walk_state);
 195
 196 ACPI_STATUS
 197 acpi_ds_method_data_get_value (
 198         u32                     type,
 199         u32                     index,
 200         ACPI_WALK_STATE         *walk_state,
 201         ACPI_OPERAND_OBJECT     **dest_desc);
 202
 203 ACPI_STATUS
 204 acpi_ds_method_data_set_value (
 205         u32                     type,
 206         u32                     index,
 207         ACPI_OPERAND_OBJECT     *src_desc,
 208         ACPI_WALK_STATE         *walk_state);
 209
 210 ACPI_STATUS
 211 acpi_ds_method_data_delete_value (
 212         u32                     type,
 213         u32                     index,
 214         ACPI_WALK_STATE         *walk_state);
 215
 216 ACPI_STATUS
 217 acpi_ds_method_data_init_args (
 218         ACPI_OPERAND_OBJECT     **params,
 219         u32                     max_param_count,
 220         ACPI_WALK_STATE         *walk_state);
 221
 222 ACPI_NAMESPACE_NODE *
 223 acpi_ds_method_data_get_nte (
 224         u32                     type,
 225         u32                     index,
 226         ACPI_WALK_STATE         *walk_state);
 227
 228 ACPI_STATUS
 229 acpi_ds_method_data_init (
 230         ACPI_WALK_STATE         *walk_state);
 231
 232 ACPI_STATUS
 233 acpi_ds_method_data_set_entry (
 234         u32                     type,
 235         u32                     index,
 236         ACPI_OPERAND_OBJECT     *object,
 237         ACPI_WALK_STATE         *walk_state);
 238
 239
 240 /* dsmethod - Parser/Interpreter interface - control method parsing */
 241
 242 ACPI_STATUS
 243 acpi_ds_parse_method (
 244         ACPI_HANDLE             obj_handle);
 245
 246 ACPI_STATUS
 247 acpi_ds_call_control_method (
 248         ACPI_WALK_LIST          *walk_list,
 249         ACPI_WALK_STATE         *walk_state,
 250         ACPI_PARSE_OBJECT       *op);
 251
 252 ACPI_STATUS
 253 acpi_ds_restart_control_method (
 254         ACPI_WALK_STATE         *walk_state,
 255         ACPI_OPERAND_OBJECT     *return_desc);
 256
 257 ACPI_STATUS
 258 acpi_ds_terminate_control_method (
 259         ACPI_WALK_STATE         *walk_state);
 260
 261 ACPI_STATUS
 262 acpi_ds_begin_method_execution (
 263         ACPI_NAMESPACE_NODE     *method_node,
 264         ACPI_OPERAND_OBJECT     *obj_desc);
 265
 266
 267 /* dsobj - Parser/Interpreter interface - object initialization and conversion */
 268
 269 ACPI_STATUS
 270 acpi_ds_init_one_object (
 271         ACPI_HANDLE             obj_handle,
 272         u32                     level,
 273         void                    *context,
 274         void                    **return_value);
 275
 276 ACPI_STATUS
 277 acpi_ds_initialize_objects (
 278         ACPI_TABLE_DESC         *table_desc,
 279         ACPI_NAMESPACE_NODE     *start_node);
 280
 281 ACPI_STATUS
 282 acpi_ds_build_internal_package_obj (
 283         ACPI_WALK_STATE         *walk_state,
 284         ACPI_PARSE_OBJECT       *op,
 285         ACPI_OPERAND_OBJECT     **obj_desc);
 286
 287 ACPI_STATUS
 288 acpi_ds_build_internal_object (
 289         ACPI_WALK_STATE         *walk_state,
 290         ACPI_PARSE_OBJECT       *op,
 291         ACPI_OPERAND_OBJECT     **obj_desc_ptr);
 292
 293 ACPI_STATUS
 294 acpi_ds_init_object_from_op (
 295         ACPI_WALK_STATE         *walk_state,
 296         ACPI_PARSE_OBJECT       *op,
 297         u16                     opcode,
 298         ACPI_OPERAND_OBJECT     **obj_desc);
 299
 300 ACPI_STATUS
 301 acpi_ds_create_node (
 302         ACPI_WALK_STATE         *walk_state,
 303         ACPI_NAMESPACE_NODE     *node,
 304         ACPI_PARSE_OBJECT       *op);
 305
 306
 307 /* dsregn - Parser/Interpreter interface - Op Region parsing */
 308
 309 ACPI_STATUS
 310 acpi_ds_eval_field_unit_operands (
 311         ACPI_WALK_STATE         *walk_state,
 312         ACPI_PARSE_OBJECT       *op);
 313
 314 ACPI_STATUS
 315 acpi_ds_eval_region_operands (
 316         ACPI_WALK_STATE         *walk_state,
 317         ACPI_PARSE_OBJECT       *op);
 318
 319 ACPI_STATUS
 320 acpi_ds_initialize_region (
 321         ACPI_HANDLE             obj_handle);
 322
 323
 324 /* dsutils - Parser/Interpreter interface utility routines */
 325
 326 u8
 327 acpi_ds_is_result_used (
 328         ACPI_PARSE_OBJECT       *op,
 329         ACPI_WALK_STATE         *walk_state);
 330
 331 void
 332 acpi_ds_delete_result_if_not_used (
 333         ACPI_PARSE_OBJECT       *op,
 334         ACPI_OPERAND_OBJECT     *result_obj,
 335         ACPI_WALK_STATE         *walk_state);
 336
 337 ACPI_STATUS
 338 acpi_ds_create_operand (
 339         ACPI_WALK_STATE         *walk_state,
 340         ACPI_PARSE_OBJECT       *arg,
 341         u32                     args_remaining);
 342
 343 ACPI_STATUS
 344 acpi_ds_create_operands (
 345         ACPI_WALK_STATE         *walk_state,
 346         ACPI_PARSE_OBJECT       *first_arg);
 347
 348 ACPI_STATUS
 349 acpi_ds_resolve_operands (
 350         ACPI_WALK_STATE         *walk_state);
 351
 352 OBJECT_TYPE_INTERNAL
 353 acpi_ds_map_opcode_to_data_type (
 354         u16                     opcode,
 355         u32                     *out_flags);
 356
 357 OBJECT_TYPE_INTERNAL
 358 acpi_ds_map_named_opcode_to_data_type (
 359         u16                     opcode);
 360
 361
 362 /*
 363  * dswscope - Scope Stack manipulation
 364  */
 365
 366 ACPI_STATUS
 367 acpi_ds_scope_stack_push (
 368         ACPI_NAMESPACE_NODE     *node,
 369         OBJECT_TYPE_INTERNAL    type,
 370         ACPI_WALK_STATE         *walk_state);
 371
 372
 373 ACPI_STATUS
 374 acpi_ds_scope_stack_pop (
 375         ACPI_WALK_STATE         *walk_state);
 376
 377 void
 378 acpi_ds_scope_stack_clear (
 379         ACPI_WALK_STATE         *walk_state);
 380
 381
 382 /* Acpi_dswstate - parser WALK_STATE management routines */
 383
 384 ACPI_WALK_STATE *
 385 acpi_ds_create_walk_state (
 386         ACPI_OWNER_ID           owner_id,
 387         ACPI_PARSE_OBJECT       *origin,
 388         ACPI_OPERAND_OBJECT     *mth_desc,
 389         ACPI_WALK_LIST          *walk_list);
 390
 391 ACPI_STATUS
 392 acpi_ds_obj_stack_delete_all (
 393         ACPI_WALK_STATE         *walk_state);
 394
 395 ACPI_STATUS
 396 acpi_ds_obj_stack_pop_and_delete (
 397         u32                     pop_count,
 398         ACPI_WALK_STATE         *walk_state);
 399
 400 void
 401 acpi_ds_delete_walk_state (
 402         ACPI_WALK_STATE         *walk_state);
 403
 404 ACPI_WALK_STATE *
 405 acpi_ds_pop_walk_state (
 406         ACPI_WALK_LIST          *walk_list);
 407
 408 ACPI_STATUS
 409 acpi_ds_result_stack_pop (
 410         ACPI_WALK_STATE         *walk_state);
 411
 412 ACPI_STATUS
 413 acpi_ds_result_stack_push (
 414         ACPI_WALK_STATE         *walk_state);
 415
 416 ACPI_STATUS
 417 acpi_ds_result_stack_clear (
 418         ACPI_WALK_STATE         *walk_state);
 419
 420 ACPI_WALK_STATE *
 421 acpi_ds_get_current_walk_state (
 422         ACPI_WALK_LIST          *walk_list);
 423
 424 void
 425 acpi_ds_delete_walk_state_cache (
 426         void);
 427
 428 ACPI_STATUS
 429 acpi_ds_result_insert (
 430         void                    *object,
 431         u32                     index,
 432         ACPI_WALK_STATE         *walk_state);
 433
 434 ACPI_STATUS
 435 acpi_ds_result_remove (
 436         ACPI_OPERAND_OBJECT     **object,
 437         u32                     index,
 438         ACPI_WALK_STATE         *walk_state);
 439
 440 ACPI_STATUS
 441 acpi_ds_result_pop (
 442         ACPI_OPERAND_OBJECT     **object,
 443         ACPI_WALK_STATE         *walk_state);
 444
 445 ACPI_STATUS
 446 acpi_ds_result_push (
 447         ACPI_OPERAND_OBJECT     *object,
 448         ACPI_WALK_STATE         *walk_state);
 449
 450 ACPI_STATUS
 451 acpi_ds_result_pop_from_bottom (
 452         ACPI_OPERAND_OBJECT     **object,
 453         ACPI_WALK_STATE         *walk_state);
 454
 455 #endif /* _ACDISPAT_H_ */