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 void
 106 acpi_dm_disassemble (
 107         struct acpi_walk_state          *walk_state,
 108         union acpi_parse_object         *origin,
 109         u32                             num_opcodes);
 110
 111
 112 /*
 113  * dmopcode
 114  */
 115 void
 116 acpi_dm_disassemble_one_op (
 117         struct acpi_walk_state          *walk_state,
 118         struct acpi_op_walk_info        *info,
 119         union acpi_parse_object         *op);
 120
 121 void
 122 acpi_dm_decode_internal_object (
 123         union acpi_operand_object       *obj_desc);
 124
 125 u32
 126 acpi_dm_list_type (
 127         union acpi_parse_object         *op);
 128
 129 void
 130 acpi_dm_method_flags (
 131         union acpi_parse_object         *op);
 132
 133 void
 134 acpi_dm_field_flags (
 135         union acpi_parse_object         *op);
 136
 137 void
 138 acpi_dm_address_space (
 139         u8                              space_id);
 140
 141 void
 142 acpi_dm_region_flags (
 143         union acpi_parse_object         *op);
 144
 145 void
 146 acpi_dm_match_op (
 147         union acpi_parse_object         *op);
 148
 149 u8
 150 acpi_dm_comma_if_list_member (
 151         union acpi_parse_object         *op);
 152
 153 void
 154 acpi_dm_comma_if_field_member (
 155         union acpi_parse_object         *op);
 156
 157
 158 /*
 159  * dmnames
 160  */
 161 u32
 162 acpi_dm_dump_name (
 163         char                            *name);
 164
 165 acpi_status
 166 acpi_ps_display_object_pathname (
 167         struct acpi_walk_state          *walk_state,
 168         union acpi_parse_object         *op);
 169
 170 void
 171 acpi_dm_namestring (
 172         char                            *name);
 173
 174
 175 /*
 176  * dmobject
 177  */
 178 void
 179 acpi_dm_display_internal_object (
 180         union acpi_operand_object       *obj_desc,
 181         struct acpi_walk_state          *walk_state);
 182
 183 void
 184 acpi_dm_display_arguments (
 185         struct acpi_walk_state          *walk_state);
 186
 187 void
 188 acpi_dm_display_locals (
 189         struct acpi_walk_state          *walk_state);
 190
 191 void
 192 acpi_dm_dump_method_info (
 193         acpi_status                     status,
 194         struct acpi_walk_state          *walk_state,
 195         union acpi_parse_object         *op);
 196
 197
 198 /*
 199  * dmbuffer
 200  */
 201 void
 202 acpi_dm_disasm_byte_list (
 203         u32                             level,
 204         u8                              *byte_data,
 205         u32                             byte_count);
 206
 207 void
 208 acpi_dm_byte_list (
 209         struct acpi_op_walk_info        *info,
 210         union acpi_parse_object         *op);
 211
 212 void
 213 acpi_is_eisa_id (
 214         union acpi_parse_object         *op);
 215
 216 void
 217 acpi_dm_eisa_id (
 218         u32                             encoded_id);
 219
 220 u8
 221 acpi_dm_is_unicode_buffer (
 222         union acpi_parse_object         *op);
 223
 224 u8
 225 acpi_dm_is_string_buffer (
 226         union acpi_parse_object         *op);
 227
 228
 229 /*
 230  * dmresrc
 231  */
 232 void
 233 acpi_dm_resource_descriptor (
 234         struct acpi_op_walk_info        *info,
 235         u8                              *byte_data,
 236         u32                             byte_count);
 237
 238 u8
 239 acpi_dm_is_resource_descriptor (
 240         union acpi_parse_object         *op);
 241
 242 void
 243 acpi_dm_indent (
 244         u32                             level);
 245
 246 void
 247 acpi_dm_bit_list (
 248         u16                             mask);
 249
 250 void
 251 acpi_dm_decode_attribute (
 252         u8                              attribute);
 253
 254
 255 /*
 256  * dmresrcl
 257  */
 258 void
 259 acpi_dm_word_descriptor (
 260         struct asl_word_address_desc    *resource,
 261         u32                             length,
 262         u32                             level);
 263
 264 void
 265 acpi_dm_dword_descriptor (
 266         struct asl_dword_address_desc   *resource,
 267         u32                             length,
 268         u32                             level);
 269
 270 void
 271 acpi_dm_extended_descriptor (
 272         struct asl_extended_address_desc   *resource,
 273         u32                             length,
 274         u32                             level);
 275
 276 void
 277 acpi_dm_qword_descriptor (
 278         struct asl_qword_address_desc   *resource,
 279         u32                             length,
 280         u32                             level);
 281
 282 void
 283 acpi_dm_memory24_descriptor (
 284         struct asl_memory_24_desc       *resource,
 285         u32                             length,
 286         u32                             level);
 287
 288 void
 289 acpi_dm_memory32_descriptor (
 290         struct asl_memory_32_desc       *resource,
 291         u32                             length,
 292         u32                             level);
 293
 294 void
 295 acpi_dm_fixed_mem32_descriptor (
 296         struct asl_fixed_memory_32_desc *resource,
 297         u32                             length,
 298         u32                             level);
 299
 300 void
 301 acpi_dm_generic_register_descriptor (
 302         struct asl_general_register_desc *resource,
 303         u32                             length,
 304         u32                             level);
 305
 306 void
 307 acpi_dm_interrupt_descriptor (
 308         struct asl_extended_xrupt_desc *resource,
 309         u32                             length,
 310         u32                             level);
 311
 312 void
 313 acpi_dm_vendor_large_descriptor (
 314         struct asl_large_vendor_desc    *resource,
 315         u32                             length,
 316         u32                             level);
 317
 318
 319 /*
 320  * dmresrcs
 321  */
 322 void
 323 acpi_dm_irq_descriptor (
 324         struct asl_irq_format_desc      *resource,
 325         u32                             length,
 326         u32                             level);
 327
 328 void
 329 acpi_dm_dma_descriptor (
 330         struct asl_dma_format_desc      *resource,
 331         u32                             length,
 332         u32                             level);
 333
 334 void
 335 acpi_dm_io_descriptor (
 336         struct asl_io_port_desc         *resource,
 337         u32                             length,
 338         u32                             level);
 339
 340 void
 341 acpi_dm_fixed_io_descriptor (
 342         struct asl_fixed_io_port_desc   *resource,
 343         u32                             length,
 344         u32                             level);
 345
 346 void
 347 acpi_dm_start_dependent_descriptor (
 348         struct asl_start_dependent_desc *resource,
 349         u32                             length,
 350         u32                             level);
 351
 352 void
 353 acpi_dm_end_dependent_descriptor (
 354         struct asl_start_dependent_desc *resource,
 355         u32                             length,
 356         u32                             level);
 357
 358 void
 359 acpi_dm_vendor_small_descriptor (
 360         struct asl_small_vendor_desc    *resource,
 361         u32                             length,
 362         u32                             level);
 363
 364
 365 /*
 366  * dmutils
 367  */
 368 void
 369 acpi_dm_add_to_external_list (
 370         char                            *path);
 371
 372 #endif  /* __ACDISASM_H__ */