include/acpi/acdisasm.h

   1 /******************************************************************************
   2  *
   3  * Name: acdisasm.h - AML disassembler
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, 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 __ACDISASM_H__
  45 #define __ACDISASM_H__
  46
  47 #include "amlresrc.h"
  48
  49
  50 #define BLOCK_NONE              0
  51 #define BLOCK_PAREN             1
  52 #define BLOCK_BRACE             2
  53 #define BLOCK_COMMA_LIST        4
  54
  55 struct acpi_external_list
  56 {
  57         char                                *path;
  58         struct acpi_external_list           *next;
  59 };
  60
  61 extern struct acpi_external_list        *acpi_gbl_external_list;
  62 extern const char                       *acpi_gbl_io_decode[2];
  63 extern const char                       *acpi_gbl_word_decode[4];
  64 extern const char                       *acpi_gbl_consume_decode[2];
  65 extern const char                       *acpi_gbl_min_decode[2];
  66 extern const char                       *acpi_gbl_max_decode[2];
  67 extern const char                       *acpi_gbl_DECdecode[2];
  68 extern const char                       *acpi_gbl_RNGdecode[4];
  69 extern const char                       *acpi_gbl_MEMdecode[4];
  70 extern const char                       *acpi_gbl_RWdecode[2];
  71 extern const char                       *acpi_gbl_irq_decode[2];
  72 extern const char                       *acpi_gbl_HEdecode[2];
  73 extern const char                       *acpi_gbl_LLdecode[2];
  74 extern const char                       *acpi_gbl_SHRdecode[2];
  75 extern const char                       *acpi_gbl_TYPdecode[4];
  76 extern const char                       *acpi_gbl_BMdecode[2];
  77 extern const char                       *acpi_gbl_SIZdecode[4];
  78 extern const char                       *acpi_gbl_TTPdecode[2];
  79 extern const char                       *acpi_gbl_MTPdecode[4];
  80 extern const char                       *acpi_gbl_TRSdecode[2];
  81
  82
  83 extern const char                       *acpi_gbl_lock_rule[ACPI_NUM_LOCK_RULES];
  84 extern const char                       *acpi_gbl_access_types[ACPI_NUM_ACCESS_TYPES];
  85 extern const char                       *acpi_gbl_update_rules[ACPI_NUM_UPDATE_RULES];
  86 extern const char                       *acpi_gbl_match_ops[ACPI_NUM_MATCH_OPS];
  87
  88
  89 struct acpi_op_walk_info
  90 {
  91         u32                             level;
  92         u32                             bit_offset;
  93 };
  94
  95 typedef
  96 acpi_status (*asl_walk_callback) (
  97         union acpi_parse_object             *op,
  98         u32                                 level,
  99         void                                *context);
 100
 101
 102 /*
 103  * dmwalk
 104  */
 105
 106 void
 107 acpi_dm_walk_parse_tree (
 108         union acpi_parse_object         *op,
 109         asl_walk_callback               descending_callback,
 110         asl_walk_callback               ascending_callback,
 111         void                            *context);
 112
 113 acpi_status
 114 acpi_dm_descending_op (
 115         union acpi_parse_object         *op,
 116         u32                             level,
 117         void                            *context);
 118
 119 acpi_status
 120 acpi_dm_ascending_op (
 121         union acpi_parse_object         *op,
 122         u32                             level,
 123         void                            *context);
 124
 125
 126 /*
 127  * dmopcode
 128  */
 129
 130 void
 131 acpi_dm_validate_name (
 132         char                            *name,
 133         union acpi_parse_object         *op);
 134
 135 u32
 136 acpi_dm_dump_name (
 137         char                            *name);
 138
 139 void
 140 acpi_dm_unicode (
 141         union acpi_parse_object         *op);
 142
 143 void
 144 acpi_dm_disassemble (
 145         struct acpi_walk_state          *walk_state,
 146         union acpi_parse_object         *origin,
 147         u32                             num_opcodes);
 148
 149 void
 150 acpi_dm_namestring (
 151         char                            *name);
 152
 153 void
 154 acpi_dm_display_path (
 155         union acpi_parse_object         *op);
 156
 157 void
 158 acpi_dm_disassemble_one_op (
 159         struct acpi_walk_state          *walk_state,
 160         struct acpi_op_walk_info        *info,
 161         union acpi_parse_object         *op);
 162
 163 void
 164 acpi_dm_decode_internal_object (
 165         union acpi_operand_object       *obj_desc);
 166
 167 u32
 168 acpi_dm_block_type (
 169         union acpi_parse_object         *op);
 170
 171 u32
 172 acpi_dm_list_type (
 173         union acpi_parse_object         *op);
 174
 175 acpi_status
 176 acpi_ps_display_object_pathname (
 177         struct acpi_walk_state          *walk_state,
 178         union acpi_parse_object         *op);
 179
 180 void
 181 acpi_dm_method_flags (
 182         union acpi_parse_object         *op);
 183
 184 void
 185 acpi_dm_field_flags (
 186         union acpi_parse_object         *op);
 187
 188 void
 189 acpi_dm_address_space (
 190         u8                              space_id);
 191
 192 void
 193 acpi_dm_region_flags (
 194         union acpi_parse_object         *op);
 195
 196 void
 197 acpi_dm_match_op (
 198         union acpi_parse_object         *op);
 199
 200 void
 201 acpi_dm_match_keyword (
 202         union acpi_parse_object         *op);
 203
 204 u8
 205 acpi_dm_comma_if_list_member (
 206         union acpi_parse_object         *op);
 207
 208 void
 209 acpi_dm_comma_if_field_member (
 210         union acpi_parse_object         *op);
 211
 212
 213 /*
 214  * dmobject
 215  */
 216
 217 void
 218 acpi_dm_decode_node (
 219         struct acpi_namespace_node      *node);
 220
 221 void
 222 acpi_dm_display_internal_object (
 223         union acpi_operand_object       *obj_desc,
 224         struct acpi_walk_state          *walk_state);
 225
 226 void
 227 acpi_dm_display_arguments (
 228         struct acpi_walk_state          *walk_state);
 229
 230 void
 231 acpi_dm_display_locals (
 232         struct acpi_walk_state          *walk_state);
 233
 234 void
 235 acpi_dm_dump_method_info (
 236         acpi_status                     status,
 237         struct acpi_walk_state          *walk_state,
 238         union acpi_parse_object         *op);
 239
 240
 241 /*
 242  * dmbuffer
 243  */
 244
 245 void
 246 acpi_is_eisa_id (
 247         union acpi_parse_object         *op);
 248
 249 void
 250 acpi_dm_eisa_id (
 251         u32                             encoded_id);
 252
 253 u8
 254 acpi_dm_is_unicode_buffer (
 255         union acpi_parse_object         *op);
 256
 257 u8
 258 acpi_dm_is_string_buffer (
 259         union acpi_parse_object         *op);
 260
 261
 262 /*
 263  * dmresrc
 264  */
 265
 266 void
 267 acpi_dm_disasm_byte_list (
 268         u32                             level,
 269         u8                              *byte_data,
 270         u32                             byte_count);
 271
 272 void
 273 acpi_dm_byte_list (
 274         struct acpi_op_walk_info        *info,
 275         union acpi_parse_object         *op);
 276
 277 void
 278 acpi_dm_resource_descriptor (
 279         struct acpi_op_walk_info        *info,
 280         u8                              *byte_data,
 281         u32                             byte_count);
 282
 283 u8
 284 acpi_dm_is_resource_descriptor (
 285         union acpi_parse_object         *op);
 286
 287 void
 288 acpi_dm_indent (
 289         u32                             level);
 290
 291 void
 292 acpi_dm_bit_list (
 293         u16                             mask);
 294
 295 void
 296 acpi_dm_decode_attribute (
 297         u8                              attribute);
 298
 299 /*
 300  * dmresrcl
 301  */
 302
 303 void
 304 acpi_dm_io_flags (
 305                 u8                          flags);
 306
 307 void
 308 acpi_dm_memory_flags (
 309         u8                              flags,
 310         u8                              specific_flags);
 311
 312 void
 313 acpi_dm_word_descriptor (
 314         struct asl_word_address_desc    *resource,
 315         u32                             length,
 316         u32                             level);
 317
 318 void
 319 acpi_dm_dword_descriptor (
 320         struct asl_dword_address_desc   *resource,
 321         u32                             length,
 322         u32                             level);
 323
 324 void
 325 acpi_dm_extended_descriptor (
 326         struct asl_extended_address_desc   *resource,
 327         u32                             length,
 328         u32                             level);
 329
 330 void
 331 acpi_dm_qword_descriptor (
 332         struct asl_qword_address_desc   *resource,
 333         u32                             length,
 334         u32                             level);
 335
 336 void
 337 acpi_dm_memory24_descriptor (
 338         struct asl_memory_24_desc       *resource,
 339         u32                             length,
 340         u32                             level);
 341
 342 void
 343 acpi_dm_memory32_descriptor (
 344         struct asl_memory_32_desc       *resource,
 345         u32                             length,
 346         u32                             level);
 347
 348 void
 349 acpi_dm_fixed_mem32_descriptor (
 350         struct asl_fixed_memory_32_desc *resource,
 351         u32                             length,
 352         u32                             level);
 353
 354 void
 355 acpi_dm_generic_register_descriptor (
 356         struct asl_general_register_desc *resource,
 357         u32                             length,
 358         u32                             level);
 359
 360 void
 361 acpi_dm_interrupt_descriptor (
 362         struct asl_extended_xrupt_desc *resource,
 363         u32                             length,
 364         u32                             level);
 365
 366 void
 367 acpi_dm_vendor_large_descriptor (
 368         struct asl_large_vendor_desc    *resource,
 369         u32                             length,
 370         u32                             level);
 371
 372
 373 /*
 374  * dmresrcs
 375  */
 376
 377 void
 378 acpi_dm_irq_descriptor (
 379         struct asl_irq_format_desc      *resource,
 380         u32                             length,
 381         u32                             level);
 382
 383 void
 384 acpi_dm_dma_descriptor (
 385         struct asl_dma_format_desc      *resource,
 386         u32                             length,
 387         u32                             level);
 388
 389 void
 390 acpi_dm_io_descriptor (
 391         struct asl_io_port_desc         *resource,
 392         u32                             length,
 393         u32                             level);
 394
 395 void
 396 acpi_dm_fixed_io_descriptor (
 397         struct asl_fixed_io_port_desc   *resource,
 398         u32                             length,
 399         u32                             level);
 400
 401 void
 402 acpi_dm_start_dependent_descriptor (
 403         struct asl_start_dependent_desc *resource,
 404         u32                             length,
 405         u32                             level);
 406
 407 void
 408 acpi_dm_end_dependent_descriptor (
 409         struct asl_start_dependent_desc *resource,
 410         u32                             length,
 411         u32                             level);
 412
 413 void
 414 acpi_dm_vendor_small_descriptor (
 415         struct asl_small_vendor_desc    *resource,
 416         u32                             length,
 417         u32                             level);
 418
 419
 420 /*
 421  * dmutils
 422  */
 423
 424 void
 425 acpi_dm_add_to_external_list (
 426         char                            *path);
 427
 428 #endif  /* __ACDISASM_H__ */