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