include/acpi/acdisasm.h

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