Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /******************************************************************************
0003  *
0004  * Name: aclocal.h - Internal data types used across the ACPI subsystem
0005  *
0006  * Copyright (C) 2000 - 2022, Intel Corp.
0007  *
0008  *****************************************************************************/
0009 
0010 #ifndef __ACLOCAL_H__
0011 #define __ACLOCAL_H__
0012 
0013 /* acpisrc:struct_defs -- for acpisrc conversion */
0014 
0015 #define ACPI_SERIALIZED                 0xFF
0016 
0017 typedef u32 acpi_mutex_handle;
0018 #define ACPI_GLOBAL_LOCK                (acpi_semaphore) (-1)
0019 
0020 /* Total number of aml opcodes defined */
0021 
0022 #define AML_NUM_OPCODES                 0x83
0023 
0024 /* Forward declarations */
0025 
0026 struct acpi_walk_state;
0027 struct acpi_obj_mutex;
0028 union acpi_parse_object;
0029 
0030 /*****************************************************************************
0031  *
0032  * Mutex typedefs and structs
0033  *
0034  ****************************************************************************/
0035 
0036 /*
0037  * Predefined handles for the mutex objects used within the subsystem
0038  * All mutex objects are automatically created by acpi_ut_mutex_initialize.
0039  *
0040  * The acquire/release ordering protocol is implied via this list. Mutexes
0041  * with a lower value must be acquired before mutexes with a higher value.
0042  *
0043  * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
0044  * table below also!
0045  */
0046 #define ACPI_MTX_INTERPRETER            0   /* AML Interpreter, main lock */
0047 #define ACPI_MTX_NAMESPACE              1   /* ACPI Namespace */
0048 #define ACPI_MTX_TABLES                 2   /* Data for ACPI tables */
0049 #define ACPI_MTX_EVENTS                 3   /* Data for ACPI events */
0050 #define ACPI_MTX_CACHES                 4   /* Internal caches, general purposes */
0051 #define ACPI_MTX_MEMORY                 5   /* Debug memory tracking lists */
0052 
0053 #define ACPI_MAX_MUTEX                  5
0054 #define ACPI_NUM_MUTEX                  (ACPI_MAX_MUTEX+1)
0055 
0056 /* Lock structure for reader/writer interfaces */
0057 
0058 struct acpi_rw_lock {
0059     acpi_mutex writer_mutex;
0060     acpi_mutex reader_mutex;
0061     u32 num_readers;
0062 };
0063 
0064 /*
0065  * Predefined handles for spinlocks used within the subsystem.
0066  * These spinlocks are created by acpi_ut_mutex_initialize
0067  */
0068 #define ACPI_LOCK_GPES                  0
0069 #define ACPI_LOCK_HARDWARE              1
0070 
0071 #define ACPI_MAX_LOCK                   1
0072 #define ACPI_NUM_LOCK                   (ACPI_MAX_LOCK+1)
0073 
0074 /* This Thread ID means that the mutex is not in use (unlocked) */
0075 
0076 #define ACPI_MUTEX_NOT_ACQUIRED         ((acpi_thread_id) 0)
0077 
0078 /* This Thread ID means an invalid thread ID */
0079 
0080 #ifdef ACPI_OS_INVALID_THREAD_ID
0081 #define ACPI_INVALID_THREAD_ID          ACPI_OS_INVALID_THREAD_ID
0082 #else
0083 #define ACPI_INVALID_THREAD_ID          ((acpi_thread_id) 0xFFFFFFFF)
0084 #endif
0085 
0086 /* Table for the global mutexes */
0087 
0088 struct acpi_mutex_info {
0089     acpi_mutex mutex;
0090     u32 use_count;
0091     acpi_thread_id thread_id;
0092 };
0093 
0094 /* Lock flag parameter for various interfaces */
0095 
0096 #define ACPI_MTX_DO_NOT_LOCK            0
0097 #define ACPI_MTX_LOCK                   1
0098 
0099 /* Field access granularities */
0100 
0101 #define ACPI_FIELD_BYTE_GRANULARITY     1
0102 #define ACPI_FIELD_WORD_GRANULARITY     2
0103 #define ACPI_FIELD_DWORD_GRANULARITY    4
0104 #define ACPI_FIELD_QWORD_GRANULARITY    8
0105 
0106 #define ACPI_ENTRY_NOT_FOUND            NULL
0107 
0108 /*****************************************************************************
0109  *
0110  * Namespace typedefs and structs
0111  *
0112  ****************************************************************************/
0113 
0114 /* Operational modes of the AML interpreter/scanner */
0115 
0116 typedef enum {
0117     ACPI_IMODE_LOAD_PASS1 = 0x01,
0118     ACPI_IMODE_LOAD_PASS2 = 0x02,
0119     ACPI_IMODE_EXECUTE = 0x03
0120 } acpi_interpreter_mode;
0121 
0122 /*
0123  * The Namespace Node describes a named object that appears in the AML.
0124  * descriptor_type is used to differentiate between internal descriptors.
0125  *
0126  * The node is optimized for both 32-bit and 64-bit platforms:
0127  * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
0128  *
0129  * Note: The descriptor_type and Type fields must appear in the identical
0130  * position in both the struct acpi_namespace_node and union acpi_operand_object
0131  * structures.
0132  */
0133 struct acpi_namespace_node {
0134     union acpi_operand_object *object;  /* Interpreter object */
0135     u8 descriptor_type; /* Differentiate object descriptor types */
0136     u8 type;        /* ACPI Type associated with this name */
0137     u16 flags;      /* Miscellaneous flags */
0138     union acpi_name_union name; /* ACPI Name, always 4 chars per ACPI spec */
0139     struct acpi_namespace_node *parent; /* Parent node */
0140     struct acpi_namespace_node *child;  /* First child */
0141     struct acpi_namespace_node *peer;   /* First peer */
0142     acpi_owner_id owner_id; /* Node creator */
0143 
0144     /*
0145      * The following fields are used by the ASL compiler and disassembler only
0146      */
0147 #ifdef ACPI_LARGE_NAMESPACE_NODE
0148     union acpi_parse_object *op;
0149     void *method_locals;
0150     void *method_args;
0151     u32 value;
0152     u32 length;
0153     u8 arg_count;
0154 
0155 #endif
0156 };
0157 
0158 /* Namespace Node flags */
0159 
0160 #define ANOBJ_RESERVED                  0x01    /* Available for use */
0161 #define ANOBJ_TEMPORARY                 0x02    /* Node is create by a method and is temporary */
0162 #define ANOBJ_METHOD_ARG                0x04    /* Node is a method argument */
0163 #define ANOBJ_METHOD_LOCAL              0x08    /* Node is a method local */
0164 #define ANOBJ_SUBTREE_HAS_INI           0x10    /* Used to optimize device initialization */
0165 #define ANOBJ_EVALUATED                 0x20    /* Set on first evaluation of node */
0166 #define ANOBJ_ALLOCATED_BUFFER          0x40    /* Method AML buffer is dynamic (install_method) */
0167 #define ANOBJ_NODE_EARLY_INIT           0x80    /* acpi_exec only: Node was create via init file (-fi) */
0168 
0169 #define ANOBJ_IS_EXTERNAL               0x08    /* iASL only: This object created via External() */
0170 #define ANOBJ_METHOD_NO_RETVAL          0x10    /* iASL only: Method has no return value */
0171 #define ANOBJ_METHOD_SOME_NO_RETVAL     0x20    /* iASL only: Method has at least one return value */
0172 #define ANOBJ_IS_REFERENCED             0x80    /* iASL only: Object was referenced */
0173 
0174 /* Internal ACPI table management - master table list */
0175 
0176 struct acpi_table_list {
0177     struct acpi_table_desc *tables; /* Table descriptor array */
0178     u32 current_table_count;    /* Tables currently in the array */
0179     u32 max_table_count;    /* Max tables array will hold */
0180     u8 flags;
0181 };
0182 
0183 /* Flags for above */
0184 
0185 #define ACPI_ROOT_ORIGIN_UNKNOWN        (0) /* ~ORIGIN_ALLOCATED */
0186 #define ACPI_ROOT_ORIGIN_ALLOCATED      (1)
0187 #define ACPI_ROOT_ALLOW_RESIZE          (2)
0188 
0189 /* List to manage incoming ACPI tables */
0190 
0191 struct acpi_new_table_desc {
0192     struct acpi_table_header *table;
0193     struct acpi_new_table_desc *next;
0194 };
0195 
0196 /* Predefined table indexes */
0197 
0198 #define ACPI_INVALID_TABLE_INDEX        (0xFFFFFFFF)
0199 
0200 struct acpi_find_context {
0201     char *search_for;
0202     acpi_handle *list;
0203     u32 *count;
0204 };
0205 
0206 struct acpi_ns_search_data {
0207     struct acpi_namespace_node *node;
0208 };
0209 
0210 /* Object types used during package copies */
0211 
0212 #define ACPI_COPY_TYPE_SIMPLE           0
0213 #define ACPI_COPY_TYPE_PACKAGE          1
0214 
0215 /* Info structure used to convert external<->internal namestrings */
0216 
0217 struct acpi_namestring_info {
0218     const char *external_name;
0219     const char *next_external_char;
0220     char *internal_name;
0221     u32 length;
0222     u32 num_segments;
0223     u32 num_carats;
0224     u8 fully_qualified;
0225 };
0226 
0227 /* Field creation info */
0228 
0229 struct acpi_create_field_info {
0230     struct acpi_namespace_node *region_node;
0231     struct acpi_namespace_node *field_node;
0232     struct acpi_namespace_node *register_node;
0233     struct acpi_namespace_node *data_register_node;
0234     struct acpi_namespace_node *connection_node;
0235     u8 *resource_buffer;
0236     u32 bank_value;
0237     u32 field_bit_position;
0238     u32 field_bit_length;
0239     u16 resource_length;
0240     u16 pin_number_index;
0241     u8 field_flags;
0242     u8 attribute;
0243     u8 field_type;
0244     u8 access_length;
0245 };
0246 
0247 typedef
0248 acpi_status (*acpi_internal_method) (struct acpi_walk_state * walk_state);
0249 
0250 /*
0251  * Bitmapped ACPI types. Used internally only
0252  */
0253 #define ACPI_BTYPE_ANY                  0x00000000
0254 #define ACPI_BTYPE_INTEGER              0x00000001
0255 #define ACPI_BTYPE_STRING               0x00000002
0256 #define ACPI_BTYPE_BUFFER               0x00000004
0257 #define ACPI_BTYPE_PACKAGE              0x00000008
0258 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
0259 #define ACPI_BTYPE_DEVICE               0x00000020
0260 #define ACPI_BTYPE_EVENT                0x00000040
0261 #define ACPI_BTYPE_METHOD               0x00000080
0262 #define ACPI_BTYPE_MUTEX                0x00000100
0263 #define ACPI_BTYPE_REGION               0x00000200
0264 #define ACPI_BTYPE_POWER                0x00000400
0265 #define ACPI_BTYPE_PROCESSOR            0x00000800
0266 #define ACPI_BTYPE_THERMAL              0x00001000
0267 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
0268 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
0269 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
0270 #define ACPI_BTYPE_REFERENCE_OBJECT     0x00010000  /* From Index(), ref_of(), etc (type6_opcodes) */
0271 #define ACPI_BTYPE_RESOURCE             0x00020000
0272 #define ACPI_BTYPE_NAMED_REFERENCE      0x00040000  /* Generic unresolved Name or Namepath */
0273 
0274 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
0275 
0276 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
0277 
0278     /* Used by Copy, de_ref_of, Store, Printf, Fprintf */
0279 
0280 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE_OBJECT | ACPI_BTYPE_DDB_HANDLE)
0281 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
0282 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF  /* ARG or LOCAL */
0283 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
0284 
0285 #pragma pack(1)
0286 
0287 /*
0288  * Information structure for ACPI predefined names.
0289  * Each entry in the table contains the following items:
0290  *
0291  * name                 - The ACPI reserved name
0292  * param_count          - Number of arguments to the method
0293  * expected_return_btypes - Allowed type(s) for the return value
0294  */
0295 struct acpi_name_info {
0296     char name[ACPI_NAMESEG_SIZE];
0297     u16 argument_list;
0298     u8 expected_btypes;
0299 };
0300 
0301 /*
0302  * Secondary information structures for ACPI predefined objects that return
0303  * package objects. This structure appears as the next entry in the table
0304  * after the NAME_INFO structure above.
0305  *
0306  * The reason for this is to minimize the size of the predefined name table.
0307  */
0308 
0309 /*
0310  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
0311  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
0312  * ACPI_PTYPE2_FIX_VAR
0313  */
0314 struct acpi_package_info {
0315     u8 type;
0316     u8 object_type1;
0317     u8 count1;
0318     u8 object_type2;
0319     u8 count2;
0320     u16 reserved;
0321 };
0322 
0323 /* Used for ACPI_PTYPE2_FIXED */
0324 
0325 struct acpi_package_info2 {
0326     u8 type;
0327     u8 count;
0328     u8 object_type[4];
0329     u8 reserved;
0330 };
0331 
0332 /* Used for ACPI_PTYPE1_OPTION */
0333 
0334 struct acpi_package_info3 {
0335     u8 type;
0336     u8 count;
0337     u8 object_type[2];
0338     u8 tail_object_type;
0339     u16 reserved;
0340 };
0341 
0342 struct acpi_package_info4 {
0343     u8 type;
0344     u8 object_type1;
0345     u8 count1;
0346     u8 sub_object_types;
0347     u8 pkg_count;
0348     u16 reserved;
0349 };
0350 
0351 union acpi_predefined_info {
0352     struct acpi_name_info info;
0353     struct acpi_package_info ret_info;
0354     struct acpi_package_info2 ret_info2;
0355     struct acpi_package_info3 ret_info3;
0356     struct acpi_package_info4 ret_info4;
0357 };
0358 
0359 /* Reset to default packing */
0360 
0361 #pragma pack()
0362 
0363 /* Return object auto-repair info */
0364 
0365 typedef acpi_status (*acpi_object_converter) (struct acpi_namespace_node *
0366                           scope,
0367                           union acpi_operand_object *
0368                           original_object,
0369                           union acpi_operand_object **
0370                           converted_object);
0371 
0372 struct acpi_simple_repair_info {
0373     char name[ACPI_NAMESEG_SIZE];
0374     u32 unexpected_btypes;
0375     u32 package_index;
0376     acpi_object_converter object_converter;
0377 };
0378 
0379 /*
0380  * Bitmapped return value types
0381  * Note: the actual data types must be contiguous, a loop in nspredef.c
0382  * depends on this.
0383  */
0384 #define ACPI_RTYPE_ANY                  0x00
0385 #define ACPI_RTYPE_NONE                 0x01
0386 #define ACPI_RTYPE_INTEGER              0x02
0387 #define ACPI_RTYPE_STRING               0x04
0388 #define ACPI_RTYPE_BUFFER               0x08
0389 #define ACPI_RTYPE_PACKAGE              0x10
0390 #define ACPI_RTYPE_REFERENCE            0x20
0391 #define ACPI_RTYPE_ALL                  0x3F
0392 
0393 #define ACPI_NUM_RTYPES                 5   /* Number of actual object types */
0394 
0395 /* Info for running the _REG methods */
0396 
0397 struct acpi_reg_walk_info {
0398     u32 function;
0399     u32 reg_run_count;
0400     acpi_adr_space_type space_id;
0401 };
0402 
0403 /*****************************************************************************
0404  *
0405  * Event typedefs and structs
0406  *
0407  ****************************************************************************/
0408 
0409 /* Dispatch info for each host-installed SCI handler */
0410 
0411 struct acpi_sci_handler_info {
0412     struct acpi_sci_handler_info *next;
0413     acpi_sci_handler address;   /* Address of handler */
0414     void *context;      /* Context to be passed to handler */
0415 };
0416 
0417 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
0418 
0419 struct acpi_gpe_handler_info {
0420     acpi_gpe_handler address;   /* Address of handler, if any */
0421     void *context;      /* Context to be passed to handler */
0422     struct acpi_namespace_node *method_node;    /* Method node for this GPE level (saved) */
0423     u8 original_flags;  /* Original (pre-handler) GPE info */
0424     u8 originally_enabled;  /* True if GPE was originally enabled */
0425 };
0426 
0427 /* Notify info for implicit notify, multiple device objects */
0428 
0429 struct acpi_gpe_notify_info {
0430     struct acpi_namespace_node *device_node;    /* Device to be notified */
0431     struct acpi_gpe_notify_info *next;
0432 };
0433 
0434 /*
0435  * GPE dispatch info. At any time, the GPE can have at most one type
0436  * of dispatch - Method, Handler, or Implicit Notify.
0437  */
0438 union acpi_gpe_dispatch_info {
0439     struct acpi_namespace_node *method_node;    /* Method node for this GPE level */
0440     struct acpi_gpe_handler_info *handler;  /* Installed GPE handler */
0441     struct acpi_gpe_notify_info *notify_list;   /* List of _PRW devices for implicit notifies */
0442 };
0443 
0444 /*
0445  * Information about a GPE, one per each GPE in an array.
0446  * NOTE: Important to keep this struct as small as possible.
0447  */
0448 struct acpi_gpe_event_info {
0449     union acpi_gpe_dispatch_info dispatch;  /* Either Method, Handler, or notify_list */
0450     struct acpi_gpe_register_info *register_info;   /* Backpointer to register info */
0451     u8 flags;       /* Misc info about this GPE */
0452     u8 gpe_number;      /* This GPE */
0453     u8 runtime_count;   /* References to a run GPE */
0454     u8 disable_for_dispatch;    /* Masked during dispatching */
0455 };
0456 
0457 /* GPE register address */
0458 
0459 struct acpi_gpe_address {
0460     u8 space_id;    /* Address space where the register exists */
0461     u64 address;    /* 64-bit address of the register */
0462 };
0463 
0464 /* Information about a GPE register pair, one per each status/enable pair in an array */
0465 
0466 struct acpi_gpe_register_info {
0467     struct acpi_gpe_address status_address; /* Address of status reg */
0468     struct acpi_gpe_address enable_address; /* Address of enable reg */
0469     u16 base_gpe_number;    /* Base GPE number for this register */
0470     u8 enable_for_wake; /* GPEs to keep enabled when sleeping */
0471     u8 enable_for_run;  /* GPEs to keep enabled when running */
0472     u8 mask_for_run;    /* GPEs to keep masked when running */
0473     u8 enable_mask;     /* Current mask of enabled GPEs */
0474 };
0475 
0476 /*
0477  * Information about a GPE register block, one per each installed block --
0478  * GPE0, GPE1, and one per each installed GPE Block Device.
0479  */
0480 struct acpi_gpe_block_info {
0481     struct acpi_namespace_node *node;
0482     struct acpi_gpe_block_info *previous;
0483     struct acpi_gpe_block_info *next;
0484     struct acpi_gpe_xrupt_info *xrupt_block;    /* Backpointer to interrupt block */
0485     struct acpi_gpe_register_info *register_info;   /* One per GPE register pair */
0486     struct acpi_gpe_event_info *event_info; /* One for each GPE */
0487     u64 address;        /* Base address of the block */
0488     u32 register_count; /* Number of register pairs in block */
0489     u16 gpe_count;      /* Number of individual GPEs in block */
0490     u16 block_base_number;  /* Base GPE number for this block */
0491     u8 space_id;
0492     u8 initialized;     /* TRUE if this block is initialized */
0493 };
0494 
0495 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
0496 
0497 struct acpi_gpe_xrupt_info {
0498     struct acpi_gpe_xrupt_info *previous;
0499     struct acpi_gpe_xrupt_info *next;
0500     struct acpi_gpe_block_info *gpe_block_list_head;    /* List of GPE blocks for this xrupt */
0501     u32 interrupt_number;   /* System interrupt number */
0502 };
0503 
0504 struct acpi_gpe_walk_info {
0505     struct acpi_namespace_node *gpe_device;
0506     struct acpi_gpe_block_info *gpe_block;
0507     u16 count;
0508     acpi_owner_id owner_id;
0509     u8 execute_by_owner_id;
0510 };
0511 
0512 struct acpi_gpe_device_info {
0513     u32 index;
0514     u32 next_block_base_index;
0515     acpi_status status;
0516     struct acpi_namespace_node *gpe_device;
0517 };
0518 
0519 typedef acpi_status (*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
0520                       gpe_xrupt_info,
0521                       struct acpi_gpe_block_info *
0522                       gpe_block, void *context);
0523 
0524 /* Information about each particular fixed event */
0525 
0526 struct acpi_fixed_event_handler {
0527     acpi_event_handler handler; /* Address of handler. */
0528     void *context;      /* Context to be passed to handler */
0529 };
0530 
0531 struct acpi_fixed_event_info {
0532     u8 status_register_id;
0533     u8 enable_register_id;
0534     u16 status_bit_mask;
0535     u16 enable_bit_mask;
0536 };
0537 
0538 /* Information used during field processing */
0539 
0540 struct acpi_field_info {
0541     u8 skip_field;
0542     u8 field_flag;
0543     u32 pkg_length;
0544 };
0545 
0546 /*****************************************************************************
0547  *
0548  * Generic "state" object for stacks
0549  *
0550  ****************************************************************************/
0551 
0552 #define ACPI_CONTROL_NORMAL                  0xC0
0553 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
0554 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
0555 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
0556 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
0557 
0558 #define ACPI_STATE_COMMON \
0559     void                            *next; \
0560     u8                              descriptor_type; /* To differentiate various internal objs */\
0561     u8                              flags; \
0562     u16                             value; \
0563     u16                             state;
0564 
0565     /* There are 2 bytes available here until the next natural alignment boundary */
0566 
0567 struct acpi_common_state {
0568 ACPI_STATE_COMMON};
0569 
0570 /*
0571  * Update state - used to traverse complex objects such as packages
0572  */
0573 struct acpi_update_state {
0574     ACPI_STATE_COMMON union acpi_operand_object *object;
0575 };
0576 
0577 /*
0578  * Pkg state - used to traverse nested package structures
0579  */
0580 struct acpi_pkg_state {
0581     ACPI_STATE_COMMON u32 index;
0582     union acpi_operand_object *source_object;
0583     union acpi_operand_object *dest_object;
0584     struct acpi_walk_state *walk_state;
0585     void *this_target_obj;
0586     u32 num_packages;
0587 };
0588 
0589 /*
0590  * Control state - one per if/else and while constructs.
0591  * Allows nesting of these constructs
0592  */
0593 struct acpi_control_state {
0594     ACPI_STATE_COMMON u16 opcode;
0595     union acpi_parse_object *predicate_op;
0596     u8 *aml_predicate_start;    /* Start of if/while predicate */
0597     u8 *package_end;    /* End of if/while block */
0598     u64 loop_timeout;   /* While() loop timeout */
0599 };
0600 
0601 /*
0602  * Scope state - current scope during namespace lookups
0603  */
0604 struct acpi_scope_state {
0605     ACPI_STATE_COMMON struct acpi_namespace_node *node;
0606 };
0607 
0608 struct acpi_pscope_state {
0609     ACPI_STATE_COMMON u32 arg_count;    /* Number of fixed arguments */
0610     union acpi_parse_object *op;    /* Current op being parsed */
0611     u8 *arg_end;        /* Current argument end */
0612     u8 *pkg_end;        /* Current package end */
0613     u32 arg_list;       /* Next argument to parse */
0614 };
0615 
0616 /*
0617  * Thread state - one per thread across multiple walk states. Multiple walk
0618  * states are created when there are nested control methods executing.
0619  */
0620 struct acpi_thread_state {
0621     ACPI_STATE_COMMON u8 current_sync_level;    /* Mutex Sync (nested acquire) level */
0622     struct acpi_walk_state *walk_state_list;    /* Head of list of walk_states for this thread */
0623     union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
0624     acpi_thread_id thread_id;   /* Running thread ID */
0625 };
0626 
0627 /*
0628  * Result values - used to accumulate the results of nested
0629  * AML arguments
0630  */
0631 struct acpi_result_values {
0632     ACPI_STATE_COMMON
0633         union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
0634 };
0635 
0636 typedef
0637 acpi_status (*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
0638                      union acpi_parse_object ** out_op);
0639 
0640 typedef
0641 acpi_status (*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
0642 
0643 /* Global handlers for AML Notifies */
0644 
0645 struct acpi_global_notify_handler {
0646     acpi_notify_handler handler;
0647     void *context;
0648 };
0649 
0650 /*
0651  * Notify info - used to pass info to the deferred notify
0652  * handler/dispatcher.
0653  */
0654 struct acpi_notify_info {
0655     ACPI_STATE_COMMON u8 handler_list_id;
0656     struct acpi_namespace_node *node;
0657     union acpi_operand_object *handler_list_head;
0658     struct acpi_global_notify_handler *global;
0659 };
0660 
0661 /* Generic state is union of structs above */
0662 
0663 union acpi_generic_state {
0664     struct acpi_common_state common;
0665     struct acpi_control_state control;
0666     struct acpi_update_state update;
0667     struct acpi_scope_state scope;
0668     struct acpi_pscope_state parse_scope;
0669     struct acpi_pkg_state pkg;
0670     struct acpi_thread_state thread;
0671     struct acpi_result_values results;
0672     struct acpi_notify_info notify;
0673 };
0674 
0675 /*****************************************************************************
0676  *
0677  * Interpreter typedefs and structs
0678  *
0679  ****************************************************************************/
0680 
0681 typedef
0682 acpi_status (*acpi_execute_op) (struct acpi_walk_state * walk_state);
0683 
0684 /* Address Range info block */
0685 
0686 struct acpi_address_range {
0687     struct acpi_address_range *next;
0688     struct acpi_namespace_node *region_node;
0689     acpi_physical_address start_address;
0690     acpi_physical_address end_address;
0691 };
0692 
0693 /*****************************************************************************
0694  *
0695  * Parser typedefs and structs
0696  *
0697  ****************************************************************************/
0698 
0699 /*
0700  * AML opcode, name, and argument layout
0701  */
0702 struct acpi_opcode_info {
0703 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
0704     char *name;     /* Opcode name (disassembler/debug only) */
0705 #endif
0706     u32 parse_args;     /* Grammar/Parse time arguments */
0707     u32 runtime_args;   /* Interpret time arguments */
0708     u16 flags;      /* Misc flags */
0709     u8 object_type;     /* Corresponding internal object type */
0710     u8 class;       /* Opcode class */
0711     u8 type;        /* Opcode type */
0712 };
0713 
0714 /* Value associated with the parse object */
0715 
0716 union acpi_parse_value {
0717     u64 integer;        /* Integer constant (Up to 64 bits) */
0718     u32 size;       /* bytelist or field size */
0719     char *string;       /* NULL terminated string */
0720     u8 *buffer;     /* buffer or string */
0721     char *name;     /* NULL terminated string */
0722     union acpi_parse_object *arg;   /* arguments and contained ops */
0723 };
0724 
0725 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
0726 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
0727 #else
0728 #define ACPI_DISASM_ONLY_MEMBERS(a)
0729 #endif
0730 
0731 #if defined(ACPI_ASL_COMPILER)
0732 #define ACPI_CONVERTER_ONLY_MEMBERS(a)  a;
0733 #else
0734 #define ACPI_CONVERTER_ONLY_MEMBERS(a)
0735 #endif
0736 
0737 #define ACPI_PARSE_COMMON \
0738     union acpi_parse_object         *parent;            /* Parent op */\
0739     u8                              descriptor_type;    /* To differentiate various internal objs */\
0740     u8                              flags;              /* Type of Op */\
0741     u16                             aml_opcode;         /* AML opcode */\
0742     u8                              *aml;               /* Address of declaration in AML */\
0743     union acpi_parse_object         *next;              /* Next op */\
0744     struct acpi_namespace_node      *node;              /* For use by interpreter */\
0745     union acpi_parse_value          value;              /* Value or args associated with the opcode */\
0746     u8                              arg_list_length;    /* Number of elements in the arg list */\
0747      ACPI_DISASM_ONLY_MEMBERS (\
0748     u16                             disasm_flags;       /* Used during AML disassembly */\
0749     u8                              disasm_opcode;      /* Subtype used for disassembly */\
0750     char                            *operator_symbol;   /* Used for C-style operator name strings */\
0751     char                            aml_op_name[16])    /* Op name (debug only) */\
0752      ACPI_CONVERTER_ONLY_MEMBERS (\
0753     char                            *inline_comment;    /* Inline comment */\
0754     char                            *end_node_comment;  /* End of node comment */\
0755     char                            *name_comment;      /* Comment associated with the first parameter of the name node */\
0756     char                            *close_brace_comment; /* Comments that come after } on the same as } */\
0757     struct acpi_comment_node        *comment_list;      /* comments that appears before this node */\
0758     struct acpi_comment_node        *end_blk_comment;   /* comments that at the end of a block but before ) or } */\
0759     char                            *cv_filename;       /* Filename associated with this node. Used for ASL/ASL+ converter */\
0760     char                            *cv_parent_filename)    /* Parent filename associated with this node. Used for ASL/ASL+ converter */
0761 
0762 /* categories of comments */
0763 
0764 typedef enum {
0765     STANDARD_COMMENT = 1,
0766     INLINE_COMMENT,
0767     ENDNODE_COMMENT,
0768     OPENBRACE_COMMENT,
0769     CLOSE_BRACE_COMMENT,
0770     STD_DEFBLK_COMMENT,
0771     END_DEFBLK_COMMENT,
0772     FILENAME_COMMENT,
0773     PARENTFILENAME_COMMENT,
0774     ENDBLK_COMMENT,
0775     INCLUDE_COMMENT
0776 } asl_comment_types;
0777 
0778 /* Internal opcodes for disasm_opcode field above */
0779 
0780 #define ACPI_DASM_BUFFER                0x00    /* Buffer is a simple data buffer */
0781 #define ACPI_DASM_RESOURCE              0x01    /* Buffer is a Resource Descriptor */
0782 #define ACPI_DASM_STRING                0x02    /* Buffer is a ASCII string */
0783 #define ACPI_DASM_UNICODE               0x03    /* Buffer is a Unicode string */
0784 #define ACPI_DASM_PLD_METHOD            0x04    /* Buffer is a _PLD method bit-packed buffer */
0785 #define ACPI_DASM_UUID                  0x05    /* Buffer is a UUID/GUID */
0786 #define ACPI_DASM_EISAID                0x06    /* Integer is an EISAID */
0787 #define ACPI_DASM_MATCHOP               0x07    /* Parent opcode is a Match() operator */
0788 #define ACPI_DASM_LNOT_PREFIX           0x08    /* Start of a Lnot_equal (etc.) pair of opcodes */
0789 #define ACPI_DASM_LNOT_SUFFIX           0x09    /* End  of a Lnot_equal (etc.) pair of opcodes */
0790 #define ACPI_DASM_HID_STRING            0x0A    /* String is a _HID or _CID */
0791 #define ACPI_DASM_IGNORE_SINGLE         0x0B    /* Ignore the opcode but not it's children */
0792 #define ACPI_DASM_SWITCH                0x0C    /* While is a Switch */
0793 #define ACPI_DASM_SWITCH_PREDICATE      0x0D    /* Object is a predicate for a Switch or Case block */
0794 #define ACPI_DASM_CASE                  0x0E    /* If/Else is a Case in a Switch/Case block */
0795 #define ACPI_DASM_DEFAULT               0x0F    /* Else is a Default in a Switch/Case block */
0796 
0797 /*
0798  * List struct used in the -ca option
0799  */
0800 struct acpi_comment_node {
0801     char *comment;
0802     struct acpi_comment_node *next;
0803 };
0804 
0805 struct acpi_comment_addr_node {
0806     u8 *addr;
0807     struct acpi_comment_addr_node *next;
0808 };
0809 
0810 /*
0811  * File node - used for "Include" operator file stack and
0812  * dependency tree for the -ca option
0813  */
0814 struct acpi_file_node {
0815     void *file;
0816     char *filename;
0817     char *file_start;   /* Points to AML and indicates when the AML for this particular file starts. */
0818     char *file_end;     /* Points to AML and indicates when the AML for this particular file ends. */
0819     struct acpi_file_node *next;
0820     struct acpi_file_node *parent;
0821     u8 include_written;
0822     struct acpi_comment_node *include_comment;
0823 };
0824 
0825 /*
0826  * Generic operation (for example:  If, While, Store)
0827  */
0828 struct acpi_parse_obj_common {
0829 ACPI_PARSE_COMMON};
0830 
0831 /*
0832  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
0833  * and bytelists.
0834  */
0835 struct acpi_parse_obj_named {
0836     ACPI_PARSE_COMMON char *path;
0837     u8 *data;       /* AML body or bytelist data */
0838     u32 length;     /* AML length */
0839     u32 name;       /* 4-byte name or zero if no name */
0840 };
0841 
0842 /* This version is used by the iASL compiler only */
0843 
0844 #define ACPI_MAX_PARSEOP_NAME       20
0845 
0846 struct acpi_parse_obj_asl {
0847     ACPI_PARSE_COMMON union acpi_parse_object *child;
0848     union acpi_parse_object *parent_method;
0849     char *filename;
0850     u8 file_changed;
0851     char *parent_filename;
0852     char *external_name;
0853     char *namepath;
0854     char name_seg[4];
0855     u32 extra_value;
0856     u32 column;
0857     u32 line_number;
0858     u32 logical_line_number;
0859     u32 logical_byte_offset;
0860     u32 end_line;
0861     u32 end_logical_line;
0862     u32 acpi_btype;
0863     u32 aml_length;
0864     u32 aml_subtree_length;
0865     u32 final_aml_length;
0866     u32 final_aml_offset;
0867     u32 compile_flags;
0868     u16 parse_opcode;
0869     u8 aml_opcode_length;
0870     u8 aml_pkg_len_bytes;
0871     u8 extra;
0872     char parse_op_name[ACPI_MAX_PARSEOP_NAME];
0873 };
0874 
0875 union acpi_parse_object {
0876     struct acpi_parse_obj_common common;
0877     struct acpi_parse_obj_named named;
0878     struct acpi_parse_obj_asl asl;
0879 };
0880 
0881 struct asl_comment_state {
0882     u8 comment_type;
0883     u32 spaces_before;
0884     union acpi_parse_object *latest_parse_op;
0885     union acpi_parse_object *parsing_paren_brace_node;
0886     u8 capture_comments;
0887 };
0888 
0889 /*
0890  * Parse state - one state per parser invocation and each control
0891  * method.
0892  */
0893 struct acpi_parse_state {
0894     u8 *aml_start;      /* First AML byte */
0895     u8 *aml;        /* Next AML byte */
0896     u8 *aml_end;        /* (last + 1) AML byte */
0897     u8 *pkg_start;      /* Current package begin */
0898     u8 *pkg_end;        /* Current package end */
0899     union acpi_parse_object *start_op;  /* Root of parse tree */
0900     struct acpi_namespace_node *start_node;
0901     union acpi_generic_state *scope;    /* Current scope */
0902     union acpi_parse_object *start_scope;
0903     u32 aml_size;
0904 };
0905 
0906 /* Parse object flags */
0907 
0908 #define ACPI_PARSEOP_GENERIC                0x01
0909 #define ACPI_PARSEOP_NAMED_OBJECT           0x02
0910 #define ACPI_PARSEOP_DEFERRED               0x04
0911 #define ACPI_PARSEOP_BYTELIST               0x08
0912 #define ACPI_PARSEOP_IN_STACK               0x10
0913 #define ACPI_PARSEOP_TARGET                 0x20
0914 #define ACPI_PARSEOP_IN_CACHE               0x80
0915 
0916 /* Parse object disasm_flags */
0917 
0918 #define ACPI_PARSEOP_IGNORE                 0x0001
0919 #define ACPI_PARSEOP_PARAMETER_LIST         0x0002
0920 #define ACPI_PARSEOP_EMPTY_TERMLIST         0x0004
0921 #define ACPI_PARSEOP_PREDEFINED_CHECKED     0x0008
0922 #define ACPI_PARSEOP_CLOSING_PAREN          0x0010
0923 #define ACPI_PARSEOP_COMPOUND_ASSIGNMENT    0x0020
0924 #define ACPI_PARSEOP_ASSIGNMENT             0x0040
0925 #define ACPI_PARSEOP_ELSEIF                 0x0080
0926 #define ACPI_PARSEOP_LEGACY_ASL_ONLY        0x0100
0927 
0928 /*****************************************************************************
0929  *
0930  * Hardware (ACPI registers) and PNP
0931  *
0932  ****************************************************************************/
0933 
0934 struct acpi_bit_register_info {
0935     u8 parent_register;
0936     u8 bit_position;
0937     u16 access_bit_mask;
0938 };
0939 
0940 /*
0941  * Some ACPI registers have bits that must be ignored -- meaning that they
0942  * must be preserved.
0943  */
0944 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
0945 
0946 /* Write-only bits must be zeroed by software */
0947 
0948 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
0949 
0950 /* For control registers, both ignored and reserved bits must be preserved */
0951 
0952 /*
0953  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
0954  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
0955  * bit position", section 4.7.3.2.1. However, on some machines the OS must
0956  * write a one to this bit after resume for the machine to work properly.
0957  * To enable this, we no longer attempt to preserve this bit. No machines
0958  * are known to fail if the bit is not preserved. (May 2009)
0959  */
0960 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
0961 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
0962 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
0963            (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
0964 
0965 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE  /* All except bit 0 */
0966 
0967 /*
0968  * Register IDs
0969  * These are the full ACPI registers
0970  */
0971 #define ACPI_REGISTER_PM1_STATUS                0x01
0972 #define ACPI_REGISTER_PM1_ENABLE                0x02
0973 #define ACPI_REGISTER_PM1_CONTROL               0x03
0974 #define ACPI_REGISTER_PM2_CONTROL               0x04
0975 #define ACPI_REGISTER_PM_TIMER                  0x05
0976 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
0977 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
0978 
0979 /* Masks used to access the bit_registers */
0980 
0981 #define ACPI_BITMASK_TIMER_STATUS               0x0001
0982 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
0983 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
0984 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
0985 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
0986 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
0987 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000  /* ACPI 3.0 */
0988 #define ACPI_BITMASK_WAKE_STATUS                0x8000
0989 
0990 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
0991     ACPI_BITMASK_TIMER_STATUS          | \
0992     ACPI_BITMASK_BUS_MASTER_STATUS     | \
0993     ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
0994     ACPI_BITMASK_POWER_BUTTON_STATUS   | \
0995     ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
0996     ACPI_BITMASK_RT_CLOCK_STATUS       | \
0997     ACPI_BITMASK_PCIEXP_WAKE_STATUS    | \
0998     ACPI_BITMASK_WAKE_STATUS)
0999 
1000 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
1001 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
1002 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
1003 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
1004 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
1005 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000  /* ACPI 3.0 */
1006 
1007 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
1008 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
1009 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
1010 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
1011 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
1012 
1013 #define ACPI_BITMASK_ARB_DISABLE                0x0001
1014 
1015 /* Raw bit position of each bit_register */
1016 
1017 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
1018 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
1019 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
1020 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
1021 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
1022 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
1023 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
1024 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
1025 
1026 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
1027 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
1028 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
1029 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
1030 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
1031 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
1032 
1033 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
1034 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
1035 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
1036 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
1037 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
1038 
1039 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
1040 
1041 /* Structs and definitions for _OSI support and I/O port validation */
1042 
1043 #define ACPI_ALWAYS_ILLEGAL             0x00
1044 
1045 struct acpi_interface_info {
1046     char *name;
1047     struct acpi_interface_info *next;
1048     u8 flags;
1049     u8 value;
1050 };
1051 
1052 #define ACPI_OSI_INVALID                0x01
1053 #define ACPI_OSI_DYNAMIC                0x02
1054 #define ACPI_OSI_FEATURE                0x04
1055 #define ACPI_OSI_DEFAULT_INVALID        0x08
1056 #define ACPI_OSI_OPTIONAL_FEATURE       (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID)
1057 
1058 struct acpi_port_info {
1059     char *name;
1060     u16 start;
1061     u16 end;
1062     u8 osi_dependency;
1063 };
1064 
1065 /*****************************************************************************
1066  *
1067  * Resource descriptors
1068  *
1069  ****************************************************************************/
1070 
1071 /* resource_type values */
1072 
1073 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
1074 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
1075 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
1076 
1077 /* Resource descriptor types and masks */
1078 
1079 #define ACPI_RESOURCE_NAME_LARGE                0x80
1080 #define ACPI_RESOURCE_NAME_SMALL                0x00
1081 
1082 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78    /* Bits 6:3 contain the type */
1083 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07    /* Bits 2:0 contain the length */
1084 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F    /* Bits 6:0 contain the type */
1085 
1086 /*
1087  * Small resource descriptor "names" as defined by the ACPI specification.
1088  * Note: Bits 2:0 are used for the descriptor length
1089  */
1090 #define ACPI_RESOURCE_NAME_IRQ                  0x20
1091 #define ACPI_RESOURCE_NAME_DMA                  0x28
1092 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
1093 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
1094 #define ACPI_RESOURCE_NAME_IO                   0x40
1095 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
1096 #define ACPI_RESOURCE_NAME_FIXED_DMA            0x50
1097 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
1098 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
1099 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
1100 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
1101 #define ACPI_RESOURCE_NAME_END_TAG              0x78
1102 
1103 /*
1104  * Large resource descriptor "names" as defined by the ACPI specification.
1105  * Note: includes the Large Descriptor bit in bit[7]
1106  */
1107 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
1108 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
1109 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
1110 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
1111 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
1112 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
1113 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
1114 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
1115 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
1116 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
1117 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
1118 #define ACPI_RESOURCE_NAME_GPIO                 0x8C
1119 #define ACPI_RESOURCE_NAME_PIN_FUNCTION         0x8D
1120 #define ACPI_RESOURCE_NAME_SERIAL_BUS           0x8E
1121 #define ACPI_RESOURCE_NAME_PIN_CONFIG           0x8F
1122 #define ACPI_RESOURCE_NAME_PIN_GROUP            0x90
1123 #define ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION   0x91
1124 #define ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG     0x92
1125 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x92
1126 
1127 /*****************************************************************************
1128  *
1129  * Miscellaneous
1130  *
1131  ****************************************************************************/
1132 
1133 #define ACPI_ASCII_ZERO                 0x30
1134 
1135 /*****************************************************************************
1136  *
1137  * Disassembler
1138  *
1139  ****************************************************************************/
1140 
1141 struct acpi_external_list {
1142     char *path;
1143     char *internal_path;
1144     struct acpi_external_list *next;
1145     u32 value;
1146     u16 length;
1147     u16 flags;
1148     u8 type;
1149 };
1150 
1151 /* Values for Flags field above */
1152 
1153 #define ACPI_EXT_RESOLVED_REFERENCE         0x01    /* Object was resolved during cross ref */
1154 #define ACPI_EXT_ORIGIN_FROM_FILE           0x02    /* External came from a file */
1155 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED    0x04    /* Deallocate internal path on completion */
1156 #define ACPI_EXT_EXTERNAL_EMITTED           0x08    /* External() statement has been emitted */
1157 #define ACPI_EXT_ORIGIN_FROM_OPCODE         0x10    /* External came from a External() opcode */
1158 #define ACPI_EXT_CONFLICTING_DECLARATION    0x20    /* External has a conflicting declaration within AML */
1159 
1160 struct acpi_external_file {
1161     char *path;
1162     struct acpi_external_file *next;
1163 };
1164 
1165 struct acpi_parse_object_list {
1166     union acpi_parse_object *op;
1167     struct acpi_parse_object_list *next;
1168 };
1169 
1170 /*****************************************************************************
1171  *
1172  * Debugger
1173  *
1174  ****************************************************************************/
1175 
1176 struct acpi_db_method_info {
1177     acpi_handle method;
1178     acpi_handle main_thread_gate;
1179     acpi_handle thread_complete_gate;
1180     acpi_handle info_gate;
1181     acpi_thread_id *threads;
1182     u32 num_threads;
1183     u32 num_created;
1184     u32 num_completed;
1185 
1186     char *name;
1187     u32 flags;
1188     u32 num_loops;
1189     char pathname[ACPI_DB_LINE_BUFFER_SIZE];
1190     char **args;
1191     acpi_object_type *types;
1192 
1193     /*
1194      * Arguments to be passed to method for the commands Threads and
1195      * Background. Note, ACPI specifies a maximum of 7 arguments (0 - 6).
1196      *
1197      * For the Threads command, the Number of threads, ID of current
1198      * thread and Index of current thread inside all them created.
1199      */
1200     char init_args;
1201 #ifdef ACPI_DEBUGGER
1202     acpi_object_type arg_types[ACPI_METHOD_NUM_ARGS];
1203 #endif
1204     char *arguments[ACPI_METHOD_NUM_ARGS];
1205     char num_threads_str[11];
1206     char id_of_thread_str[11];
1207     char index_of_thread_str[11];
1208 };
1209 
1210 struct acpi_integrity_info {
1211     u32 nodes;
1212     u32 objects;
1213 };
1214 
1215 #define ACPI_DB_DISABLE_OUTPUT          0x00
1216 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1217 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1218 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1219 
1220 struct acpi_object_info {
1221     u32 types[ACPI_TOTAL_TYPES];
1222 };
1223 
1224 /*****************************************************************************
1225  *
1226  * Debug
1227  *
1228  ****************************************************************************/
1229 
1230 /* Entry for a memory allocation (debug only) */
1231 
1232 #define ACPI_MEM_MALLOC                 0
1233 #define ACPI_MEM_CALLOC                 1
1234 #define ACPI_MAX_MODULE_NAME            16
1235 
1236 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1237     struct acpi_debug_mem_block     *previous; \
1238     struct acpi_debug_mem_block     *next; \
1239     u32                             size; \
1240     u32                             component; \
1241     u32                             line; \
1242     char                            module[ACPI_MAX_MODULE_NAME]; \
1243     u8                              alloc_type;
1244 
1245 struct acpi_debug_mem_header {
1246 ACPI_COMMON_DEBUG_MEM_HEADER};
1247 
1248 struct acpi_debug_mem_block {
1249     ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1250 };
1251 
1252 #define ACPI_MEM_LIST_GLOBAL            0
1253 #define ACPI_MEM_LIST_NSNODE            1
1254 #define ACPI_MEM_LIST_MAX               1
1255 #define ACPI_NUM_MEM_LISTS              2
1256 
1257 /*****************************************************************************
1258  *
1259  * Info/help support
1260  *
1261  ****************************************************************************/
1262 
1263 struct ah_predefined_name {
1264     char *name;
1265     char *description;
1266 #ifndef ACPI_ASL_COMPILER
1267     char *action;
1268 #endif
1269 };
1270 
1271 struct ah_device_id {
1272     char *name;
1273     char *description;
1274 };
1275 
1276 struct ah_uuid {
1277     char *description;
1278     char *string;
1279 };
1280 
1281 struct ah_table {
1282     char *signature;
1283     char *description;
1284 };
1285 
1286 #endif              /* __ACLOCAL_H__ */