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