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 #define BLOCK_NONE              0
  50 #define BLOCK_PAREN             1
  51 #define BLOCK_BRACE             2
  52 #define BLOCK_COMMA_LIST        4
  53
  54 struct acpi_external_list {
  55         char *path;
  56         struct acpi_external_list *next;
  57 };
  58
  59 extern struct acpi_external_list *acpi_gbl_external_list;
  60 extern const char *acpi_gbl_io_decode[2];
  61 extern const char *acpi_gbl_word_decode[4];
  62 extern const char *acpi_gbl_consume_decode[2];
  63 extern const char *acpi_gbl_config_decode[4];
  64 extern const char *acpi_gbl_min_decode[2];
  65 extern const char *acpi_gbl_max_decode[2];
  66 extern const char *acpi_gbl_DECdecode[2];
  67 extern const char *acpi_gbl_RNGdecode[4];
  68 extern const char *acpi_gbl_MEMdecode[4];
  69 extern const char *acpi_gbl_RWdecode[2];
  70 extern const char *acpi_gbl_irq_decode[2];
  71 extern const char *acpi_gbl_HEdecode[2];
  72 extern const char *acpi_gbl_LLdecode[2];
  73 extern const char *acpi_gbl_SHRdecode[2];
  74 extern const char *acpi_gbl_TYPdecode[4];
  75 extern const char *acpi_gbl_BMdecode[2];
  76 extern const char *acpi_gbl_SIZdecode[4];
  77 extern const char *acpi_gbl_TTPdecode[2];
  78 extern const char *acpi_gbl_MTPdecode[4];
  79 extern const char *acpi_gbl_TRSdecode[2];
  80
  81 extern const char *acpi_gbl_lock_rule[ACPI_NUM_LOCK_RULES];
  82 extern const char *acpi_gbl_access_types[ACPI_NUM_ACCESS_TYPES];
  83 extern const char *acpi_gbl_update_rules[ACPI_NUM_UPDATE_RULES];
  84 extern const char *acpi_gbl_match_ops[ACPI_NUM_MATCH_OPS];
  85
  86 struct acpi_op_walk_info {
  87         u32 level;
  88         u32 bit_offset;
  89         struct acpi_walk_state *walk_state;
  90 };
  91
  92 typedef
  93 acpi_status(*asl_walk_callback) (union acpi_parse_object * op,
  94                                  u32 level, void *context);
  95
  96 /*
  97  * dmwalk
  98  */
  99 void
 100 acpi_dm_disassemble(struct acpi_walk_state *walk_state,
 101                     union acpi_parse_object *origin, u32 num_opcodes);
 102
 103 /*
 104  * dmopcode
 105  */
 106 void
 107 acpi_dm_disassemble_one_op(struct acpi_walk_state *walk_state,
 108                            struct acpi_op_walk_info *info,
 109                            union acpi_parse_object *op);
 110
 111 void acpi_dm_decode_internal_object(union acpi_operand_object *obj_desc);
 112
 113 u32 acpi_dm_list_type(union acpi_parse_object *op);
 114
 115 void acpi_dm_method_flags(union acpi_parse_object *op);
 116
 117 void acpi_dm_field_flags(union acpi_parse_object *op);
 118
 119 void acpi_dm_address_space(u8 space_id);
 120
 121 void acpi_dm_region_flags(union acpi_parse_object *op);
 122
 123 void acpi_dm_match_op(union acpi_parse_object *op);
 124
 125 u8 acpi_dm_comma_if_list_member(union acpi_parse_object *op);
 126
 127 void acpi_dm_comma_if_field_member(union acpi_parse_object *op);
 128
 129 /*
 130  * dmnames
 131  */
 132 u32 acpi_dm_dump_name(char *name);
 133
 134 acpi_status
 135 acpi_ps_display_object_pathname(struct acpi_walk_state *walk_state,
 136                                 union acpi_parse_object *op);
 137
 138 void acpi_dm_namestring(char *name);
 139
 140 /*
 141  * dmobject
 142  */
 143 void
 144 acpi_dm_display_internal_object(union acpi_operand_object *obj_desc,
 145                                 struct acpi_walk_state *walk_state);
 146
 147 void acpi_dm_display_arguments(struct acpi_walk_state *walk_state);
 148
 149 void acpi_dm_display_locals(struct acpi_walk_state *walk_state);
 150
 151 void
 152 acpi_dm_dump_method_info(acpi_status status,
 153                          struct acpi_walk_state *walk_state,
 154                          union acpi_parse_object *op);
 155
 156 /*
 157  * dmbuffer
 158  */
 159 void acpi_dm_disasm_byte_list(u32 level, u8 * byte_data, u32 byte_count);
 160
 161 void
 162 acpi_dm_byte_list(struct acpi_op_walk_info *info, union acpi_parse_object *op);
 163
 164 void acpi_dm_is_eisa_id(union acpi_parse_object *op);
 165
 166 void acpi_dm_eisa_id(u32 encoded_id);
 167
 168 u8 acpi_dm_is_unicode_buffer(union acpi_parse_object *op);
 169
 170 u8 acpi_dm_is_string_buffer(union acpi_parse_object *op);
 171
 172 /*
 173  * dmresrc
 174  */
 175 void acpi_dm_dump_integer8(u8 value, char *name);
 176
 177 void acpi_dm_dump_integer16(u16 value, char *name);
 178
 179 void acpi_dm_dump_integer32(u32 value, char *name);
 180
 181 void acpi_dm_dump_integer64(u64 value, char *name);
 182
 183 void
 184 acpi_dm_resource_template(struct acpi_op_walk_info *info,
 185                           u8 * byte_data, u32 byte_count);
 186
 187 u8 acpi_dm_is_resource_template(union acpi_parse_object *op);
 188
 189 void acpi_dm_indent(u32 level);
 190
 191 void acpi_dm_bit_list(u16 mask);
 192
 193 void acpi_dm_decode_attribute(u8 attribute);
 194
 195 /*
 196  * dmresrcl
 197  */
 198 void
 199 acpi_dm_word_descriptor(union aml_resource *resource, u32 length, u32 level);
 200
 201 void
 202 acpi_dm_dword_descriptor(union aml_resource *resource, u32 length, u32 level);
 203
 204 void
 205 acpi_dm_extended_descriptor(union aml_resource *resource,
 206                             u32 length, u32 level);
 207
 208 void
 209 acpi_dm_qword_descriptor(union aml_resource *resource, u32 length, u32 level);
 210
 211 void
 212 acpi_dm_memory24_descriptor(union aml_resource *resource,
 213                             u32 length, u32 level);
 214
 215 void
 216 acpi_dm_memory32_descriptor(union aml_resource *resource,
 217                             u32 length, u32 level);
 218
 219 void
 220 acpi_dm_fixed_memory32_descriptor(union aml_resource *resource,
 221                                   u32 length, u32 level);
 222
 223 void
 224 acpi_dm_generic_register_descriptor(union aml_resource *resource,
 225                                     u32 length, u32 level);
 226
 227 void
 228 acpi_dm_interrupt_descriptor(union aml_resource *resource,
 229                              u32 length, u32 level);
 230
 231 void
 232 acpi_dm_vendor_large_descriptor(union aml_resource *resource,
 233                                 u32 length, u32 level);
 234
 235 void acpi_dm_vendor_common(char *name, u8 * byte_data, u32 length, u32 level);
 236
 237 /*
 238  * dmresrcs
 239  */
 240 void
 241 acpi_dm_irq_descriptor(union aml_resource *resource, u32 length, u32 level);
 242
 243 void
 244 acpi_dm_dma_descriptor(union aml_resource *resource, u32 length, u32 level);
 245
 246 void acpi_dm_io_descriptor(union aml_resource *resource, u32 length, u32 level);
 247
 248 void
 249 acpi_dm_fixed_io_descriptor(union aml_resource *resource,
 250                             u32 length, u32 level);
 251
 252 void
 253 acpi_dm_start_dependent_descriptor(union aml_resource *resource,
 254                                    u32 length, u32 level);
 255
 256 void
 257 acpi_dm_end_dependent_descriptor(union aml_resource *resource,
 258                                  u32 length, u32 level);
 259
 260 void
 261 acpi_dm_vendor_small_descriptor(union aml_resource *resource,
 262                                 u32 length, u32 level);
 263
 264 /*
 265  * dmutils
 266  */
 267 void acpi_dm_add_to_external_list(char *path);
 268
 269 #endif                          /* __ACDISASM_H__ */