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         char *internal_path;
  58         struct acpi_external_list *next;
  59         u32 value;
  60         u16 length;
  61         u8 type;
  62 };
  63
  64 extern struct acpi_external_list *acpi_gbl_external_list;
  65
  66 typedef const struct acpi_dmtable_info {
  67         u8 opcode;
  68         u8 offset;
  69         char *name;
  70
  71 } acpi_dmtable_info;
  72
  73 /*
  74  * Values for Opcode above.
  75  * Note: 0-7 must not change, used as a flag shift value
  76  */
  77 #define ACPI_DMT_FLAG0                  0
  78 #define ACPI_DMT_FLAG1                  1
  79 #define ACPI_DMT_FLAG2                  2
  80 #define ACPI_DMT_FLAG3                  3
  81 #define ACPI_DMT_FLAG4                  4
  82 #define ACPI_DMT_FLAG5                  5
  83 #define ACPI_DMT_FLAG6                  6
  84 #define ACPI_DMT_FLAG7                  7
  85 #define ACPI_DMT_FLAGS0                 8
  86 #define ACPI_DMT_FLAGS2                 9
  87 #define ACPI_DMT_UINT8                  10
  88 #define ACPI_DMT_UINT16                 11
  89 #define ACPI_DMT_UINT24                 12
  90 #define ACPI_DMT_UINT32                 13
  91 #define ACPI_DMT_UINT56                 14
  92 #define ACPI_DMT_UINT64                 15
  93 #define ACPI_DMT_STRING                 16
  94 #define ACPI_DMT_NAME4                  17
  95 #define ACPI_DMT_NAME6                  18
  96 #define ACPI_DMT_NAME8                  19
  97 #define ACPI_DMT_CHKSUM                 20
  98 #define ACPI_DMT_SPACEID                21
  99 #define ACPI_DMT_GAS                    22
 100 #define ACPI_DMT_DMAR                   23
 101 #define ACPI_DMT_MADT                   24
 102 #define ACPI_DMT_SRAT                   25
 103 #define ACPI_DMT_EXIT                   26
 104
 105 typedef
 106 void (*ACPI_TABLE_HANDLER) (struct acpi_table_header * table);
 107
 108 struct acpi_dmtable_data {
 109         char *signature;
 110         struct acpi_dmtable_info *table_info;
 111         ACPI_TABLE_HANDLER table_handler;
 112 };
 113
 114 struct acpi_op_walk_info {
 115         u32 level;
 116         u32 last_level;
 117         u32 count;
 118         u32 bit_offset;
 119         u32 flags;
 120         struct acpi_walk_state *walk_state;
 121 };
 122
 123 typedef
 124 acpi_status(*asl_walk_callback) (union acpi_parse_object * op,
 125                                  u32 level, void *context);
 126
 127 struct acpi_resource_tag {
 128         u32 bit_index;
 129         char *tag;
 130 };
 131
 132 /* Strings used for decoding flags to ASL keywords */
 133
 134 extern const char *acpi_gbl_word_decode[];
 135 extern const char *acpi_gbl_irq_decode[];
 136 extern const char *acpi_gbl_lock_rule[];
 137 extern const char *acpi_gbl_access_types[];
 138 extern const char *acpi_gbl_update_rules[];
 139 extern const char *acpi_gbl_match_ops[];
 140
 141 extern struct acpi_dmtable_info acpi_dm_table_info_asf0[];
 142 extern struct acpi_dmtable_info acpi_dm_table_info_asf1[];
 143 extern struct acpi_dmtable_info acpi_dm_table_info_asf1a[];
 144 extern struct acpi_dmtable_info acpi_dm_table_info_asf2[];
 145 extern struct acpi_dmtable_info acpi_dm_table_info_asf2a[];
 146 extern struct acpi_dmtable_info acpi_dm_table_info_asf3[];
 147 extern struct acpi_dmtable_info acpi_dm_table_info_asf4[];
 148 extern struct acpi_dmtable_info acpi_dm_table_info_asf_hdr[];
 149 extern struct acpi_dmtable_info acpi_dm_table_info_boot[];
 150 extern struct acpi_dmtable_info acpi_dm_table_info_cpep[];
 151 extern struct acpi_dmtable_info acpi_dm_table_info_cpep0[];
 152 extern struct acpi_dmtable_info acpi_dm_table_info_dbgp[];
 153 extern struct acpi_dmtable_info acpi_dm_table_info_dmar[];
 154 extern struct acpi_dmtable_info acpi_dm_table_info_dmar_hdr[];
 155 extern struct acpi_dmtable_info acpi_dm_table_info_dmar_scope[];
 156 extern struct acpi_dmtable_info acpi_dm_table_info_dmar0[];
 157 extern struct acpi_dmtable_info acpi_dm_table_info_dmar1[];
 158 extern struct acpi_dmtable_info acpi_dm_table_info_ecdt[];
 159 extern struct acpi_dmtable_info acpi_dm_table_info_facs[];
 160 extern struct acpi_dmtable_info acpi_dm_table_info_fadt1[];
 161 extern struct acpi_dmtable_info acpi_dm_table_info_fadt2[];
 162 extern struct acpi_dmtable_info acpi_dm_table_info_gas[];
 163 extern struct acpi_dmtable_info acpi_dm_table_info_header[];
 164 extern struct acpi_dmtable_info acpi_dm_table_info_hpet[];
 165 extern struct acpi_dmtable_info acpi_dm_table_info_madt[];
 166 extern struct acpi_dmtable_info acpi_dm_table_info_madt0[];
 167 extern struct acpi_dmtable_info acpi_dm_table_info_madt1[];
 168 extern struct acpi_dmtable_info acpi_dm_table_info_madt2[];
 169 extern struct acpi_dmtable_info acpi_dm_table_info_madt3[];
 170 extern struct acpi_dmtable_info acpi_dm_table_info_madt4[];
 171 extern struct acpi_dmtable_info acpi_dm_table_info_madt5[];
 172 extern struct acpi_dmtable_info acpi_dm_table_info_madt6[];
 173 extern struct acpi_dmtable_info acpi_dm_table_info_madt7[];
 174 extern struct acpi_dmtable_info acpi_dm_table_info_madt8[];
 175 extern struct acpi_dmtable_info acpi_dm_table_info_madt_hdr[];
 176 extern struct acpi_dmtable_info acpi_dm_table_info_mcfg[];
 177 extern struct acpi_dmtable_info acpi_dm_table_info_mcfg0[];
 178 extern struct acpi_dmtable_info acpi_dm_table_info_rsdp1[];
 179 extern struct acpi_dmtable_info acpi_dm_table_info_rsdp2[];
 180 extern struct acpi_dmtable_info acpi_dm_table_info_sbst[];
 181 extern struct acpi_dmtable_info acpi_dm_table_info_slit[];
 182 extern struct acpi_dmtable_info acpi_dm_table_info_spcr[];
 183 extern struct acpi_dmtable_info acpi_dm_table_info_spmi[];
 184 extern struct acpi_dmtable_info acpi_dm_table_info_srat[];
 185 extern struct acpi_dmtable_info acpi_dm_table_info_srat0[];
 186 extern struct acpi_dmtable_info acpi_dm_table_info_srat1[];
 187 extern struct acpi_dmtable_info acpi_dm_table_info_tcpa[];
 188 extern struct acpi_dmtable_info acpi_dm_table_info_wdrt[];
 189
 190 /*
 191  * dmtable
 192  */
 193 void acpi_dm_dump_data_table(struct acpi_table_header *table);
 194
 195 void
 196 acpi_dm_dump_table(u32 table_length,
 197                    u32 table_offset,
 198                    void *table,
 199                    u32 sub_table_length, struct acpi_dmtable_info *info);
 200
 201 void acpi_dm_line_header(u32 offset, u32 byte_length, char *name);
 202
 203 void acpi_dm_line_header2(u32 offset, u32 byte_length, char *name, u32 value);
 204
 205 /*
 206  * dmtbdump
 207  */
 208 void acpi_dm_dump_asf(struct acpi_table_header *table);
 209
 210 void acpi_dm_dump_cpep(struct acpi_table_header *table);
 211
 212 void acpi_dm_dump_dmar(struct acpi_table_header *table);
 213
 214 void acpi_dm_dump_fadt(struct acpi_table_header *table);
 215
 216 void acpi_dm_dump_srat(struct acpi_table_header *table);
 217
 218 void acpi_dm_dump_mcfg(struct acpi_table_header *table);
 219
 220 void acpi_dm_dump_madt(struct acpi_table_header *table);
 221
 222 u32 acpi_dm_dump_rsdp(struct acpi_table_header *table);
 223
 224 void acpi_dm_dump_rsdt(struct acpi_table_header *table);
 225
 226 void acpi_dm_dump_slit(struct acpi_table_header *table);
 227
 228 void acpi_dm_dump_xsdt(struct acpi_table_header *table);
 229
 230 /*
 231  * dmwalk
 232  */
 233 void
 234 acpi_dm_disassemble(struct acpi_walk_state *walk_state,
 235                     union acpi_parse_object *origin, u32 num_opcodes);
 236
 237 void
 238 acpi_dm_walk_parse_tree(union acpi_parse_object *op,
 239                         asl_walk_callback descending_callback,
 240                         asl_walk_callback ascending_callback, void *context);
 241
 242 /*
 243  * dmopcode
 244  */
 245 void
 246 acpi_dm_disassemble_one_op(struct acpi_walk_state *walk_state,
 247                            struct acpi_op_walk_info *info,
 248                            union acpi_parse_object *op);
 249
 250 void acpi_dm_decode_internal_object(union acpi_operand_object *obj_desc);
 251
 252 u32 acpi_dm_list_type(union acpi_parse_object *op);
 253
 254 void acpi_dm_method_flags(union acpi_parse_object *op);
 255
 256 void acpi_dm_field_flags(union acpi_parse_object *op);
 257
 258 void acpi_dm_address_space(u8 space_id);
 259
 260 void acpi_dm_region_flags(union acpi_parse_object *op);
 261
 262 void acpi_dm_match_op(union acpi_parse_object *op);
 263
 264 u8 acpi_dm_comma_if_list_member(union acpi_parse_object *op);
 265
 266 void acpi_dm_comma_if_field_member(union acpi_parse_object *op);
 267
 268 /*
 269  * dmnames
 270  */
 271 u32 acpi_dm_dump_name(char *name);
 272
 273 acpi_status
 274 acpi_ps_display_object_pathname(struct acpi_walk_state *walk_state,
 275                                 union acpi_parse_object *op);
 276
 277 void acpi_dm_namestring(char *name);
 278
 279 /*
 280  * dmobject
 281  */
 282 void
 283 acpi_dm_display_internal_object(union acpi_operand_object *obj_desc,
 284                                 struct acpi_walk_state *walk_state);
 285
 286 void acpi_dm_display_arguments(struct acpi_walk_state *walk_state);
 287
 288 void acpi_dm_display_locals(struct acpi_walk_state *walk_state);
 289
 290 void
 291 acpi_dm_dump_method_info(acpi_status status,
 292                          struct acpi_walk_state *walk_state,
 293                          union acpi_parse_object *op);
 294
 295 /*
 296  * dmbuffer
 297  */
 298 void acpi_dm_disasm_byte_list(u32 level, u8 * byte_data, u32 byte_count);
 299
 300 void
 301 acpi_dm_byte_list(struct acpi_op_walk_info *info, union acpi_parse_object *op);
 302
 303 void acpi_dm_is_eisa_id(union acpi_parse_object *op);
 304
 305 void acpi_dm_eisa_id(u32 encoded_id);
 306
 307 u8 acpi_dm_is_unicode_buffer(union acpi_parse_object *op);
 308
 309 u8 acpi_dm_is_string_buffer(union acpi_parse_object *op);
 310
 311 /*
 312  * dmresrc
 313  */
 314 void acpi_dm_dump_integer8(u8 value, char *name);
 315
 316 void acpi_dm_dump_integer16(u16 value, char *name);
 317
 318 void acpi_dm_dump_integer32(u32 value, char *name);
 319
 320 void acpi_dm_dump_integer64(u64 value, char *name);
 321
 322 void
 323 acpi_dm_resource_template(struct acpi_op_walk_info *info,
 324                           union acpi_parse_object *op,
 325                           u8 * byte_data, u32 byte_count);
 326
 327 acpi_status acpi_dm_is_resource_template(union acpi_parse_object *op);
 328
 329 void acpi_dm_indent(u32 level);
 330
 331 void acpi_dm_bit_list(u16 mask);
 332
 333 void acpi_dm_decode_attribute(u8 attribute);
 334
 335 void acpi_dm_descriptor_name(void);
 336
 337 /*
 338  * dmresrcl
 339  */
 340 void
 341 acpi_dm_word_descriptor(union aml_resource *resource, u32 length, u32 level);
 342
 343 void
 344 acpi_dm_dword_descriptor(union aml_resource *resource, u32 length, u32 level);
 345
 346 void
 347 acpi_dm_extended_descriptor(union aml_resource *resource,
 348                             u32 length, u32 level);
 349
 350 void
 351 acpi_dm_qword_descriptor(union aml_resource *resource, u32 length, u32 level);
 352
 353 void
 354 acpi_dm_memory24_descriptor(union aml_resource *resource,
 355                             u32 length, u32 level);
 356
 357 void
 358 acpi_dm_memory32_descriptor(union aml_resource *resource,
 359                             u32 length, u32 level);
 360
 361 void
 362 acpi_dm_fixed_memory32_descriptor(union aml_resource *resource,
 363                                   u32 length, u32 level);
 364
 365 void
 366 acpi_dm_generic_register_descriptor(union aml_resource *resource,
 367                                     u32 length, u32 level);
 368
 369 void
 370 acpi_dm_interrupt_descriptor(union aml_resource *resource,
 371                              u32 length, u32 level);
 372
 373 void
 374 acpi_dm_vendor_large_descriptor(union aml_resource *resource,
 375                                 u32 length, u32 level);
 376
 377 void acpi_dm_vendor_common(char *name, u8 * byte_data, u32 length, u32 level);
 378
 379 /*
 380  * dmresrcs
 381  */
 382 void
 383 acpi_dm_irq_descriptor(union aml_resource *resource, u32 length, u32 level);
 384
 385 void
 386 acpi_dm_dma_descriptor(union aml_resource *resource, u32 length, u32 level);
 387
 388 void acpi_dm_io_descriptor(union aml_resource *resource, u32 length, u32 level);
 389
 390 void
 391 acpi_dm_fixed_io_descriptor(union aml_resource *resource,
 392                             u32 length, u32 level);
 393
 394 void
 395 acpi_dm_start_dependent_descriptor(union aml_resource *resource,
 396                                    u32 length, u32 level);
 397
 398 void
 399 acpi_dm_end_dependent_descriptor(union aml_resource *resource,
 400                                  u32 length, u32 level);
 401
 402 void
 403 acpi_dm_vendor_small_descriptor(union aml_resource *resource,
 404                                 u32 length, u32 level);
 405
 406 /*
 407  * dmutils
 408  */
 409 void acpi_dm_add_to_external_list(char *path, u8 type, u32 value);
 410
 411 /*
 412  * dmrestag
 413  */
 414 void acpi_dm_find_resources(union acpi_parse_object *root);
 415
 416 void
 417 acpi_dm_check_resource_reference(union acpi_parse_object *op,
 418                                  struct acpi_walk_state *walk_state);
 419
 420 #endif                          /* __ACDISASM_H__ */