aclocal.h 27.7 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3
/******************************************************************************
 *
 * Name: aclocal.h - Internal data types used across the ACPI subsystem
Andy Grover's avatar
Andy Grover committed
4
 *       $Revision: 168 $
Linus Torvalds's avatar
Linus Torvalds committed
5 6 7 8
 *
 *****************************************************************************/

/*
Andy Grover's avatar
Andy Grover committed
9
 *  Copyright (C) 2000 - 2002, R. Byron Moore
Linus Torvalds's avatar
Linus Torvalds committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __ACLOCAL_H__
#define __ACLOCAL_H__


Linus Torvalds's avatar
Linus Torvalds committed
30
#define WAIT_FOREVER                    ((u32) -1)
Linus Torvalds's avatar
Linus Torvalds committed
31

Linus Torvalds's avatar
Linus Torvalds committed
32
typedef void*                           acpi_mutex;
Linus Torvalds's avatar
Linus Torvalds committed
33
typedef u32                             ACPI_MUTEX_HANDLE;
Linus Torvalds's avatar
Linus Torvalds committed
34 35


36 37 38
/* Total number of aml opcodes defined */

#define AML_NUM_OPCODES                 0x7E
Linus Torvalds's avatar
Linus Torvalds committed
39 40 41 42 43 44 45 46 47 48 49


/*****************************************************************************
 *
 * Mutex typedefs and structs
 *
 ****************************************************************************/


/*
 * Predefined handles for the mutex objects used within the subsystem
Linus Torvalds's avatar
Linus Torvalds committed
50 51 52 53 54
 * All mutex objects are automatically created by Acpi_ut_mutex_initialize.
 *
 * The acquire/release ordering protocol is implied via this list.  Mutexes
 * with a lower value must be acquired before mutexes with a higher value.
 *
Linus Torvalds's avatar
Linus Torvalds committed
55 56 57
 * NOTE: any changes here must be reflected in the Acpi_gbl_Mutex_names table also!
 */

Linus Torvalds's avatar
Linus Torvalds committed
58 59 60 61 62 63 64 65 66 67 68 69 70
#define ACPI_MTX_EXECUTE                0
#define ACPI_MTX_INTERPRETER            1
#define ACPI_MTX_PARSER                 2
#define ACPI_MTX_DISPATCHER             3
#define ACPI_MTX_TABLES                 4
#define ACPI_MTX_OP_REGIONS             5
#define ACPI_MTX_NAMESPACE              6
#define ACPI_MTX_EVENTS                 7
#define ACPI_MTX_HARDWARE               8
#define ACPI_MTX_CACHES                 9
#define ACPI_MTX_MEMORY                 10
#define ACPI_MTX_DEBUG_CMD_COMPLETE     11
#define ACPI_MTX_DEBUG_CMD_READY        12
Linus Torvalds's avatar
Linus Torvalds committed
71

Linus Torvalds's avatar
Linus Torvalds committed
72 73
#define MAX_MTX                         12
#define NUM_MTX                         MAX_MTX+1
Linus Torvalds's avatar
Linus Torvalds committed
74 75


Linus Torvalds's avatar
Linus Torvalds committed
76
#if defined(ACPI_DEBUG) || defined(ENABLE_DEBUGGER)
Linus Torvalds's avatar
Linus Torvalds committed
77 78 79 80 81 82
#ifdef DEFINE_ACPI_GLOBALS

/* Names for the mutexes used in the subsystem */

static NATIVE_CHAR          *acpi_gbl_mutex_names[] =
{
Linus Torvalds's avatar
Linus Torvalds committed
83 84
	"ACPI_MTX_Execute",
	"ACPI_MTX_Interpreter",
Linus Torvalds's avatar
Linus Torvalds committed
85 86
	"ACPI_MTX_Parser",
	"ACPI_MTX_Dispatcher",
Linus Torvalds's avatar
Linus Torvalds committed
87 88
	"ACPI_MTX_Tables",
	"ACPI_MTX_Op_regions",
Linus Torvalds's avatar
Linus Torvalds committed
89 90
	"ACPI_MTX_Namespace",
	"ACPI_MTX_Events",
Linus Torvalds's avatar
Linus Torvalds committed
91 92 93 94
	"ACPI_MTX_Hardware",
	"ACPI_MTX_Caches",
	"ACPI_MTX_Memory",
	"ACPI_MTX_Debug_cmd_complete",
Linus Torvalds's avatar
Linus Torvalds committed
95 96 97 98 99 100 101 102 103 104 105
	"ACPI_MTX_Debug_cmd_ready",
};

#endif
#endif


/* Table for the global mutexes */

typedef struct acpi_mutex_info
{
Linus Torvalds's avatar
Linus Torvalds committed
106
	acpi_mutex                  mutex;
Linus Torvalds's avatar
Linus Torvalds committed
107
	u32                         use_count;
Linus Torvalds's avatar
Linus Torvalds committed
108
	u32                         owner_id;
Linus Torvalds's avatar
Linus Torvalds committed
109

Linus Torvalds's avatar
Linus Torvalds committed
110
} acpi_mutex_info;
Linus Torvalds's avatar
Linus Torvalds committed
111

Linus Torvalds's avatar
Linus Torvalds committed
112 113 114 115
/* This owner ID means that the mutex is not in use (unlocked) */

#define ACPI_MUTEX_NOT_ACQUIRED         (u32) (-1)

Linus Torvalds's avatar
Linus Torvalds committed
116 117 118

/* Lock flag parameter for various interfaces */

Linus Torvalds's avatar
Linus Torvalds committed
119 120
#define ACPI_MTX_DO_NOT_LOCK            0
#define ACPI_MTX_LOCK                   1
Linus Torvalds's avatar
Linus Torvalds committed
121 122


Linus Torvalds's avatar
Linus Torvalds committed
123
typedef u16                             acpi_owner_id;
Andy Grover's avatar
Andy Grover committed
124 125 126 127
#define ACPI_OWNER_TYPE_TABLE           0x0
#define ACPI_OWNER_TYPE_METHOD          0x1
#define ACPI_FIRST_METHOD_ID            0x0000
#define ACPI_FIRST_TABLE_ID             0x8000
Linus Torvalds's avatar
Linus Torvalds committed
128 129 130

/* TBD: [Restructure] get rid of the need for this! */

Linus Torvalds's avatar
Linus Torvalds committed
131
#define TABLE_ID_DSDT                   (acpi_owner_id) 0x8000
Linus Torvalds's avatar
Linus Torvalds committed
132 133 134 135 136 137 138 139


/* Field access granularities */

#define ACPI_FIELD_BYTE_GRANULARITY     1
#define ACPI_FIELD_WORD_GRANULARITY     2
#define ACPI_FIELD_DWORD_GRANULARITY    4
#define ACPI_FIELD_QWORD_GRANULARITY    8
Linus Torvalds's avatar
Linus Torvalds committed
140 141 142 143 144 145 146 147 148 149 150 151

/*****************************************************************************
 *
 * Namespace typedefs and structs
 *
 ****************************************************************************/


/* Operational modes of the AML interpreter/scanner */

typedef enum
{
Andy Grover's avatar
Andy Grover committed
152 153 154
	ACPI_IMODE_LOAD_PASS1               = 0x01,
	ACPI_IMODE_LOAD_PASS2               = 0x02,
	ACPI_IMODE_EXECUTE                  = 0x0E
Linus Torvalds's avatar
Linus Torvalds committed
155

Andy Grover's avatar
Andy Grover committed
156
} acpi_interpreter_mode;
Linus Torvalds's avatar
Linus Torvalds committed
157 158 159 160 161 162 163 164 165 166


/*
 * The Node describes a named object that appears in the AML
 * An Acpi_node is used to store Nodes.
 *
 * Data_type is used to differentiate between internal descriptors, and MUST
 * be the first byte in this structure.
 */

Andy Grover's avatar
Andy Grover committed
167 168 169 170 171 172
typedef union acpi_name_union
{
	u32                     integer;
	char                    ascii[4];
} ACPI_NAME_UNION;

Linus Torvalds's avatar
Linus Torvalds committed
173 174
typedef struct acpi_node
{
Andy Grover's avatar
Andy Grover committed
175
	u8                      descriptor;     /* Used to differentiate object descriptor types */
Linus Torvalds's avatar
Linus Torvalds committed
176 177
	u8                      type;           /* Type associated with this name */
	u16                     owner_id;
Andy Grover's avatar
Andy Grover committed
178
	ACPI_NAME_UNION         name;           /* ACPI Name, always 4 chars per ACPI spec */
Linus Torvalds's avatar
Linus Torvalds committed
179 180


Linus Torvalds's avatar
Linus Torvalds committed
181
	union acpi_operand_obj  *object;        /* Pointer to attached ACPI object (optional) */
Linus Torvalds's avatar
Linus Torvalds committed
182 183 184 185 186
	struct acpi_node        *child;         /* first child */
	struct acpi_node        *peer;          /* Next peer*/
	u16                     reference_count; /* Current count of references and children */
	u8                      flags;

Linus Torvalds's avatar
Linus Torvalds committed
187
} acpi_namespace_node;
Linus Torvalds's avatar
Linus Torvalds committed
188 189


Andy Grover's avatar
Andy Grover committed
190
#define ACPI_ENTRY_NOT_FOUND            NULL
Linus Torvalds's avatar
Linus Torvalds committed
191 192 193 194


/* Node flags */

Andy Grover's avatar
Andy Grover committed
195
#define ANOBJ_RESERVED                  0x01
Linus Torvalds's avatar
Linus Torvalds committed
196 197 198 199 200 201 202 203
#define ANOBJ_END_OF_PEER_LIST          0x02
#define ANOBJ_DATA_WIDTH_32             0x04     /* Parent table is 64-bits */
#define ANOBJ_METHOD_ARG                0x08
#define ANOBJ_METHOD_LOCAL              0x10
#define ANOBJ_METHOD_NO_RETVAL          0x20
#define ANOBJ_METHOD_SOME_NO_RETVAL     0x40

#define ANOBJ_IS_BIT_OFFSET             0x80
Linus Torvalds's avatar
Linus Torvalds committed
204 205 206 207 208 209 210 211 212 213


/*
 * ACPI Table Descriptor.  One per ACPI table
 */
typedef struct acpi_table_desc
{
	struct acpi_table_desc  *prev;
	struct acpi_table_desc  *next;
	struct acpi_table_desc  *installed_desc;
Linus Torvalds's avatar
Linus Torvalds committed
214
	acpi_table_header       *pointer;
Linus Torvalds's avatar
Linus Torvalds committed
215
	void                    *base_pointer;
Linus Torvalds's avatar
Linus Torvalds committed
216 217
	u8                      *aml_start;
	u64                     physical_address;
Linus Torvalds's avatar
Linus Torvalds committed
218
	u32                     aml_length;
219
	ACPI_SIZE               length;
Linus Torvalds's avatar
Linus Torvalds committed
220
	u32                     count;
Linus Torvalds's avatar
Linus Torvalds committed
221
	acpi_owner_id           table_id;
Linus Torvalds's avatar
Linus Torvalds committed
222 223 224 225
	u8                      type;
	u8                      allocation;
	u8                      loaded_into_namespace;

Linus Torvalds's avatar
Linus Torvalds committed
226
} acpi_table_desc;
Linus Torvalds's avatar
Linus Torvalds committed
227 228 229 230 231


typedef struct
{
	NATIVE_CHAR             *search_for;
Linus Torvalds's avatar
Linus Torvalds committed
232
	acpi_handle             *list;
Linus Torvalds's avatar
Linus Torvalds committed
233 234
	u32                     *count;

Andy Grover's avatar
Andy Grover committed
235
} acpi_find_context;
Linus Torvalds's avatar
Linus Torvalds committed
236 237 238 239


typedef struct
{
Linus Torvalds's avatar
Linus Torvalds committed
240
	acpi_namespace_node     *node;
Andy Grover's avatar
Andy Grover committed
241
} acpi_ns_search_data;
Linus Torvalds's avatar
Linus Torvalds committed
242 243 244 245 246 247 248 249


/*
 * Predefined Namespace items
 */
typedef struct
{
	NATIVE_CHAR             *name;
Andy Grover's avatar
Andy Grover committed
250
	u8                      type;
Linus Torvalds's avatar
Linus Torvalds committed
251 252
	NATIVE_CHAR             *val;

Andy Grover's avatar
Andy Grover committed
253
} acpi_predefined_names;
Linus Torvalds's avatar
Linus Torvalds committed
254 255


Linus Torvalds's avatar
Linus Torvalds committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
/* Object types used during package copies */


#define ACPI_COPY_TYPE_SIMPLE           0
#define ACPI_COPY_TYPE_PACKAGE          1

/* Info structure used to convert external<->internal namestrings */

typedef struct acpi_namestring_info
{
	NATIVE_CHAR             *external_name;
	NATIVE_CHAR             *next_external_char;
	NATIVE_CHAR             *internal_name;
	u32                     length;
	u32                     num_segments;
	u32                     num_carats;
	u8                      fully_qualified;

Linus Torvalds's avatar
Linus Torvalds committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
} acpi_namestring_info;


/* Field creation info */

typedef struct
{
	acpi_namespace_node     *region_node;
	acpi_namespace_node     *field_node;
	acpi_namespace_node     *register_node;
	acpi_namespace_node     *data_register_node;
	u32                     bank_value;
	u32                     field_bit_position;
	u32                     field_bit_length;
	u8                      field_flags;
Andy Grover's avatar
Andy Grover committed
289
	u8                      attribute;
Linus Torvalds's avatar
Linus Torvalds committed
290 291 292 293
	u8                      field_type;

} ACPI_CREATE_FIELD_INFO;

Linus Torvalds's avatar
Linus Torvalds committed
294

Linus Torvalds's avatar
Linus Torvalds committed
295 296 297 298 299 300
/*****************************************************************************
 *
 * Event typedefs and structs
 *
 ****************************************************************************/

Andy Grover's avatar
Andy Grover committed
301
/* Information about each GPE register block */
Linus Torvalds's avatar
Linus Torvalds committed
302 303 304

typedef struct
{
Andy Grover's avatar
Andy Grover committed
305 306
	u8                      address_space_id;
	acpi_generic_address    *block_address;
Andy Grover's avatar
Andy Grover committed
307 308
	u16                     register_count;
	u8                      block_base_number;
Linus Torvalds's avatar
Linus Torvalds committed
309

Andy Grover's avatar
Andy Grover committed
310
} ACPI_GPE_BLOCK_INFO;
Linus Torvalds's avatar
Linus Torvalds committed
311

Andy Grover's avatar
Andy Grover committed
312
/* Information about a particular GPE register pair */
Linus Torvalds's avatar
Linus Torvalds committed
313 314 315

typedef struct
{
Andy Grover's avatar
Andy Grover committed
316 317
	acpi_generic_address    status_address; /* Address of status reg */
	acpi_generic_address    enable_address; /* Address of enable reg */
Linus Torvalds's avatar
Linus Torvalds committed
318 319 320
	u8                      status;         /* Current value of status reg */
	u8                      enable;         /* Current value of enable reg */
	u8                      wake_enable;    /* Mask of bits to keep enabled when sleeping */
Andy Grover's avatar
Andy Grover committed
321
	u8                      base_gpe_number; /* Base GPE number for this register */
Linus Torvalds's avatar
Linus Torvalds committed
322

Andy Grover's avatar
Andy Grover committed
323
} ACPI_GPE_REGISTER_INFO;
Linus Torvalds's avatar
Linus Torvalds committed
324 325


Linus Torvalds's avatar
Linus Torvalds committed
326 327
#define ACPI_GPE_LEVEL_TRIGGERED        1
#define ACPI_GPE_EDGE_TRIGGERED         2
Linus Torvalds's avatar
Linus Torvalds committed
328 329 330 331 332 333


/* Information about each particular GPE level */

typedef struct
{
Linus Torvalds's avatar
Linus Torvalds committed
334
	acpi_handle             method_handle;  /* Method handle for direct (fast) execution */
Linus Torvalds's avatar
Linus Torvalds committed
335
	acpi_gpe_handler        handler;        /* Address of handler, if any */
Linus Torvalds's avatar
Linus Torvalds committed
336
	void                    *context;       /* Context to be passed to handler */
Andy Grover's avatar
Andy Grover committed
337 338 339 340 341 342
	u8                      type;           /* Level or Edge */
	u8                      bit_mask;


} ACPI_GPE_NUMBER_INFO;

Linus Torvalds's avatar
Linus Torvalds committed
343

Andy Grover's avatar
Andy Grover committed
344 345 346
typedef struct
{
	u8                      number_index;
Linus Torvalds's avatar
Linus Torvalds committed
347

Andy Grover's avatar
Andy Grover committed
348
} ACPI_GPE_INDEX_INFO;
Linus Torvalds's avatar
Linus Torvalds committed
349 350 351 352 353

/* Information about each particular fixed event */

typedef struct
{
Linus Torvalds's avatar
Linus Torvalds committed
354
	acpi_event_handler      handler;        /* Address of handler. */
Linus Torvalds's avatar
Linus Torvalds committed
355 356
	void                    *context;       /* Context to be passed to handler */

Andy Grover's avatar
Andy Grover committed
357 358 359 360 361 362 363 364 365
} ACPI_FIXED_EVENT_HANDLER;


typedef struct
{
	u8                      status_register_id;
	u8                      enable_register_id;
	u16                     status_bit_mask;
	u16                     enable_bit_mask;
Linus Torvalds's avatar
Linus Torvalds committed
366

Andy Grover's avatar
Andy Grover committed
367
} acpi_fixed_event_info;
Linus Torvalds's avatar
Linus Torvalds committed
368 369 370 371 372 373 374 375 376

/* Information used during field processing */

typedef struct
{
	u8                      skip_field;
	u8                      field_flag;
	u32                     pkg_length;

Linus Torvalds's avatar
Linus Torvalds committed
377
} acpi_field_info;
Linus Torvalds's avatar
Linus Torvalds committed
378 379 380 381 382 383 384 385 386


/*****************************************************************************
 *
 * Generic "state" object for stacks
 *
 ****************************************************************************/


Andy Grover's avatar
Andy Grover committed
387 388 389 390 391
#define ACPI_CONTROL_NORMAL                  0xC0
#define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
#define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
#define ACPI_CONTROL_PREDICATE_FALSE         0xC3
#define ACPI_CONTROL_PREDICATE_TRUE          0xC4
Linus Torvalds's avatar
Linus Torvalds committed
392 393


Linus Torvalds's avatar
Linus Torvalds committed
394
/* Forward declarations */
Linus Torvalds's avatar
Linus Torvalds committed
395
struct acpi_walk_state;
Linus Torvalds's avatar
Linus Torvalds committed
396
struct acpi_obj_mutex;
397
union acpi_parse_obj;
Linus Torvalds's avatar
Linus Torvalds committed
398 399 400 401


#define ACPI_STATE_COMMON                  /* Two 32-bit fields and a pointer */\
	u8                      data_type;          /* To differentiate various internal objs */\
Andy Grover's avatar
Andy Grover committed
402 403 404 405 406
	u8                      flags;      \
	u16                     value;      \
	u16                     state;      \
	u16                     reserved;   \
	void                    *next;      \
Linus Torvalds's avatar
Linus Torvalds committed
407 408 409 410

typedef struct acpi_common_state
{
	ACPI_STATE_COMMON
Linus Torvalds's avatar
Linus Torvalds committed
411
} acpi_common_state;
Linus Torvalds's avatar
Linus Torvalds committed
412 413 414 415 416 417 418 419 420 421


/*
 * Update state - used to traverse complex objects such as packages
 */
typedef struct acpi_update_state
{
	ACPI_STATE_COMMON
	union acpi_operand_obj  *object;

Linus Torvalds's avatar
Linus Torvalds committed
422
} acpi_update_state;
Linus Torvalds's avatar
Linus Torvalds committed
423

Linus Torvalds's avatar
Linus Torvalds committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437

/*
 * Pkg state - used to traverse nested package structures
 */
typedef struct acpi_pkg_state
{
	ACPI_STATE_COMMON
	union acpi_operand_obj  *source_object;
	union acpi_operand_obj  *dest_object;
	struct acpi_walk_state  *walk_state;
	void                    *this_target_obj;
	u32                     num_packages;
	u16                     index;

Linus Torvalds's avatar
Linus Torvalds committed
438
} acpi_pkg_state;
Linus Torvalds's avatar
Linus Torvalds committed
439 440


Linus Torvalds's avatar
Linus Torvalds committed
441 442 443 444 445 446 447
/*
 * Control state - one per if/else and while constructs.
 * Allows nesting of these constructs
 */
typedef struct acpi_control_state
{
	ACPI_STATE_COMMON
448
	union acpi_parse_obj    *predicate_op;
Andy Grover's avatar
Andy Grover committed
449 450 451
	u8                      *aml_predicate_start;   /* Start of if/while predicate */
	u8                      *package_end;           /* End of if/while block */
	u16                     opcode;
Linus Torvalds's avatar
Linus Torvalds committed
452

Linus Torvalds's avatar
Linus Torvalds committed
453
} acpi_control_state;
Linus Torvalds's avatar
Linus Torvalds committed
454 455 456 457 458 459 460 461


/*
 * Scope state - current scope during namespace lookups
 */
typedef struct acpi_scope_state
{
	ACPI_STATE_COMMON
Linus Torvalds's avatar
Linus Torvalds committed
462
	acpi_namespace_node     *node;
Linus Torvalds's avatar
Linus Torvalds committed
463

Linus Torvalds's avatar
Linus Torvalds committed
464
} acpi_scope_state;
Linus Torvalds's avatar
Linus Torvalds committed
465 466 467 468 469


typedef struct acpi_pscope_state
{
	ACPI_STATE_COMMON
470
	union acpi_parse_obj    *op;                    /* current op being parsed */
Andy Grover's avatar
Andy Grover committed
471 472 473 474
	u8                      *arg_end;               /* current argument end */
	u8                      *pkg_end;               /* current package end */
	u32                     arg_list;               /* next argument to parse */
	u32                     arg_count;              /* Number of fixed arguments */
Linus Torvalds's avatar
Linus Torvalds committed
475

Linus Torvalds's avatar
Linus Torvalds committed
476
} acpi_pscope_state;
Linus Torvalds's avatar
Linus Torvalds committed
477 478


Andy Grover's avatar
Andy Grover committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
/*
 * Thread state - one per thread across multiple walk states.  Multiple walk
 * states are created when there are nested control methods executing.
 */
typedef struct acpi_thread_state
{
	ACPI_STATE_COMMON
	struct acpi_walk_state  *walk_state_list;       /* Head of list of Walk_states for this thread */
	union acpi_operand_obj  *acquired_mutex_list;   /* List of all currently acquired mutexes */
	u32                     thread_id;              /* Running thread ID */
	u16                     current_sync_level;     /* Mutex Sync (nested acquire) level */

} ACPI_THREAD_STATE;


Linus Torvalds's avatar
Linus Torvalds committed
494 495 496 497 498 499 500 501 502 503 504
/*
 * Result values - used to accumulate the results of nested
 * AML arguments
 */
typedef struct acpi_result_values
{
	ACPI_STATE_COMMON
	union acpi_operand_obj  *obj_desc [OBJ_NUM_OPERANDS];
	u8                      num_results;
	u8                      last_insert;

Linus Torvalds's avatar
Linus Torvalds committed
505 506 507 508 509 510
} acpi_result_values;


typedef
acpi_status (*acpi_parse_downwards) (
	struct acpi_walk_state  *walk_state,
511
	union acpi_parse_obj    **out_op);
Linus Torvalds's avatar
Linus Torvalds committed
512 513 514 515

typedef
acpi_status (*acpi_parse_upwards) (
	struct acpi_walk_state  *walk_state);
Linus Torvalds's avatar
Linus Torvalds committed
516 517


Linus Torvalds's avatar
Linus Torvalds committed
518 519 520 521 522 523 524
/*
 * Notify info - used to pass info to the deferred notify
 * handler/dispatcher.
 */
typedef struct acpi_notify_info
{
	ACPI_STATE_COMMON
Linus Torvalds's avatar
Linus Torvalds committed
525
	acpi_namespace_node     *node;
Linus Torvalds's avatar
Linus Torvalds committed
526 527
	union acpi_operand_obj  *handler_obj;

Linus Torvalds's avatar
Linus Torvalds committed
528
} acpi_notify_info;
Linus Torvalds's avatar
Linus Torvalds committed
529 530


Linus Torvalds's avatar
Linus Torvalds committed
531 532 533 534
/* Generic state is union of structs above */

typedef union acpi_gen_state
{
Linus Torvalds's avatar
Linus Torvalds committed
535 536 537 538 539 540
	acpi_common_state       common;
	acpi_control_state      control;
	acpi_update_state       update;
	acpi_scope_state        scope;
	acpi_pscope_state       parse_scope;
	acpi_pkg_state          pkg;
Andy Grover's avatar
Andy Grover committed
541
	ACPI_THREAD_STATE       thread;
Linus Torvalds's avatar
Linus Torvalds committed
542 543
	acpi_result_values      results;
	acpi_notify_info        notify;
Linus Torvalds's avatar
Linus Torvalds committed
544

Linus Torvalds's avatar
Linus Torvalds committed
545
} acpi_generic_state;
Linus Torvalds's avatar
Linus Torvalds committed
546 547


Linus Torvalds's avatar
Linus Torvalds committed
548 549 550 551 552
/*****************************************************************************
 *
 * Interpreter typedefs and structs
 *
 ****************************************************************************/
Linus Torvalds's avatar
Linus Torvalds committed
553 554

typedef
Linus Torvalds's avatar
Linus Torvalds committed
555 556
acpi_status (*ACPI_EXECUTE_OP) (
	struct acpi_walk_state  *walk_state);
Linus Torvalds's avatar
Linus Torvalds committed
557 558 559 560 561 562 563 564 565 566 567 568 569


/*****************************************************************************
 *
 * Parser typedefs and structs
 *
 ****************************************************************************/

/*
 * AML opcode, name, and argument layout
 */
typedef struct acpi_opcode_info
{
Andy Grover's avatar
Andy Grover committed
570 571 572
#ifdef _OPCODE_NAMES
	NATIVE_CHAR             *name;          /* Opcode name (debug only) */
#endif
Linus Torvalds's avatar
Linus Torvalds committed
573 574
	u32                     parse_args;     /* Grammar/Parse time arguments */
	u32                     runtime_args;   /* Interpret time arguments */
Andy Grover's avatar
Andy Grover committed
575 576
	u32                     flags;          /* Misc flags */
	u8                      object_type;    /* Corresponding internal object type */
Linus Torvalds's avatar
Linus Torvalds committed
577 578
	u8                      class;          /* Opcode class */
	u8                      type;           /* Opcode type */
Linus Torvalds's avatar
Linus Torvalds committed
579

Linus Torvalds's avatar
Linus Torvalds committed
580
} acpi_opcode_info;
Linus Torvalds's avatar
Linus Torvalds committed
581 582 583 584


typedef union acpi_parse_val
{
Linus Torvalds's avatar
Linus Torvalds committed
585 586 587 588 589
	acpi_integer            integer;        /* integer constant (Up to 64 bits) */
	uint64_struct           integer64;      /* Structure overlay for 2 32-bit Dwords */
	u32                     integer32;      /* integer constant, 32 bits only */
	u16                     integer16;      /* integer constant, 16 bits only */
	u8                      integer8;       /* integer constant, 8 bits only */
Linus Torvalds's avatar
Linus Torvalds committed
590 591 592 593
	u32                     size;           /* bytelist or field size */
	NATIVE_CHAR             *string;        /* NULL terminated string */
	u8                      *buffer;        /* buffer or string */
	NATIVE_CHAR             *name;          /* NULL terminated string */
594
	union acpi_parse_obj    *arg;           /* arguments and contained ops */
Linus Torvalds's avatar
Linus Torvalds committed
595

Linus Torvalds's avatar
Linus Torvalds committed
596
} acpi_parse_value;
Linus Torvalds's avatar
Linus Torvalds committed
597 598 599 600 601


#define ACPI_PARSE_COMMON \
	u8                      data_type;      /* To differentiate various internal objs */\
	u8                      flags;          /* Type of Op */\
602
	u16                     aml_opcode;     /* AML opcode */\
Linus Torvalds's avatar
Linus Torvalds committed
603
	u32                     aml_offset;     /* offset of declaration in AML */\
604 605
	union acpi_parse_obj    *parent;        /* parent op */\
	union acpi_parse_obj    *next;          /* next op */\
Andy Grover's avatar
Andy Grover committed
606
	ACPI_DEBUG_ONLY_MEMBERS (\
607
	NATIVE_CHAR             aml_op_name[16]) /* op name (debug only) */\
Linus Torvalds's avatar
Linus Torvalds committed
608
			  /* NON-DEBUG members below: */\
Linus Torvalds's avatar
Linus Torvalds committed
609
	acpi_namespace_node     *node;          /* for use by interpreter */\
Linus Torvalds's avatar
Linus Torvalds committed
610
	acpi_parse_value        value;          /* Value or args associated with the opcode */\
Linus Torvalds's avatar
Linus Torvalds committed
611 612 613 614 615


/*
 * generic operation (eg. If, While, Store)
 */
616
typedef struct acpi_parseobj_common
Linus Torvalds's avatar
Linus Torvalds committed
617 618
{
	ACPI_PARSE_COMMON
619
} ACPI_PARSE_OBJ_COMMON;
Linus Torvalds's avatar
Linus Torvalds committed
620 621 622 623 624 625


/*
 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and Op_regions),
 * and bytelists.
 */
626
typedef struct acpi_parseobj_named
Linus Torvalds's avatar
Linus Torvalds committed
627 628 629 630 631 632
{
	ACPI_PARSE_COMMON
	u8                      *data;          /* AML body or bytelist data */
	u32                     length;         /* AML length */
	u32                     name;           /* 4-byte name or zero if no name */

633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
} ACPI_PARSE_OBJ_NAMED;


/* The parse node is the fundamental element of the parse tree */

typedef struct acpi_parseobj_asl
{
	ACPI_PARSE_COMMON

	union acpi_parse_obj        *child;


	union acpi_parse_obj        *parent_method;
	char                        *filename;
	char                        *external_name;
	char                        *namepath;
	u32                         extra_value;
	u32                         column;
	u32                         line_number;
	u32                         logical_line_number;
	u32                         logical_byte_offset;
	u32                         end_line;
	u32                         end_logical_line;
	u16                         parse_opcode;
	u32                         acpi_btype;
	u32                         aml_length;
	u32                         aml_subtree_length;
	u32                         final_aml_length;
	u32                         final_aml_offset;
	u8                          aml_opcode_length;
	u8                          aml_pkg_len_bytes;
	u16                         compile_flags;
	u8                          extra;
	char                        parse_op_name[12];

} ACPI_PARSE_OBJ_ASL;


typedef union acpi_parse_obj
{
	ACPI_PARSE_OBJ_COMMON       common;
	ACPI_PARSE_OBJ_NAMED        named;
	ACPI_PARSE_OBJ_ASL          asl;

} acpi_parse_object;
Linus Torvalds's avatar
Linus Torvalds committed
678 679 680 681 682 683 684 685


/*
 * Parse state - one state per parser invocation and each control
 * method.
 */
typedef struct acpi_parse_state
{
Linus Torvalds's avatar
Linus Torvalds committed
686
	u32                     aml_size;
Linus Torvalds's avatar
Linus Torvalds committed
687 688 689 690 691
	u8                      *aml_start;     /* first AML byte */
	u8                      *aml;           /* next AML byte */
	u8                      *aml_end;       /* (last + 1) AML byte */
	u8                      *pkg_start;     /* current package begin */
	u8                      *pkg_end;       /* current package end */
692
	union acpi_parse_obj    *start_op;      /* root of parse tree */
Linus Torvalds's avatar
Linus Torvalds committed
693
	struct acpi_node        *start_node;
Linus Torvalds's avatar
Linus Torvalds committed
694
	union acpi_gen_state    *scope;         /* current scope */
695
	union acpi_parse_obj    *start_scope;
Linus Torvalds's avatar
Linus Torvalds committed
696

Andy Grover's avatar
Andy Grover committed
697
} acpi_parse_state;
Linus Torvalds's avatar
Linus Torvalds committed
698 699


Andy Grover's avatar
Andy Grover committed
700
/* Parse object flags */
Linus Torvalds's avatar
Linus Torvalds committed
701

Andy Grover's avatar
Andy Grover committed
702 703 704 705 706
#define ACPI_PARSEOP_GENERIC                    0x01
#define ACPI_PARSEOP_NAMED                      0x02
#define ACPI_PARSEOP_DEFERRED                   0x04
#define ACPI_PARSEOP_BYTELIST                   0x08
#define ACPI_PARSEOP_IN_CACHE                   0x80
Linus Torvalds's avatar
Linus Torvalds committed
707 708 709 710


/*****************************************************************************
 *
Andy Grover's avatar
Andy Grover committed
711
 * Hardware (ACPI registers) and PNP
Linus Torvalds's avatar
Linus Torvalds committed
712 713 714
 *
 ****************************************************************************/

Andy Grover's avatar
Andy Grover committed
715
#define PCI_ROOT_HID_STRING         "PNP0A03"
Linus Torvalds's avatar
Linus Torvalds committed
716

Andy Grover's avatar
Andy Grover committed
717 718 719 720 721
typedef struct
{
	u8                      parent_register;
	u8                      bit_position;
	u16                     access_bit_mask;
Linus Torvalds's avatar
Linus Torvalds committed
722

Andy Grover's avatar
Andy Grover committed
723
} ACPI_BIT_REGISTER_INFO;
Linus Torvalds's avatar
Linus Torvalds committed
724 725 726


/*
Andy Grover's avatar
Andy Grover committed
727 728
 * Register IDs
 * These are the full ACPI registers
Linus Torvalds's avatar
Linus Torvalds committed
729
 */
Andy Grover's avatar
Andy Grover committed
730 731 732 733 734 735 736 737 738
#define ACPI_REGISTER_PM1_STATUS                0x01
#define ACPI_REGISTER_PM1_ENABLE                0x02
#define ACPI_REGISTER_PM1_CONTROL               0x03
#define ACPI_REGISTER_PM1A_CONTROL              0x04
#define ACPI_REGISTER_PM1B_CONTROL              0x05
#define ACPI_REGISTER_PM2_CONTROL               0x06
#define ACPI_REGISTER_PM_TIMER                  0x07
#define ACPI_REGISTER_PROCESSOR_BLOCK           0x08
#define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x09
Linus Torvalds's avatar
Linus Torvalds committed
739 740


Andy Grover's avatar
Andy Grover committed
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
/* Masks used to access the Bit_registers */

#define ACPI_BITMASK_TIMER_STATUS               0x0001
#define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
#define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
#define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
#define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
#define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
#define ACPI_BITMASK_WAKE_STATUS                0x8000

#define ACPI_BITMASK_ALL_FIXED_STATUS           (ACPI_BITMASK_TIMER_STATUS          | \
			 ACPI_BITMASK_BUS_MASTER_STATUS     | \
			 ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
			 ACPI_BITMASK_POWER_BUTTON_STATUS   | \
			 ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
			 ACPI_BITMASK_RT_CLOCK_STATUS       | \
			 ACPI_BITMASK_WAKE_STATUS)

#define ACPI_BITMASK_TIMER_ENABLE               0x0001
#define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
#define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
#define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
#define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400

#define ACPI_BITMASK_SCI_ENABLE                 0x0001
#define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
#define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
#define ACPI_BITMASK_SLEEP_TYPE_X               0x1C00
#define ACPI_BITMASK_SLEEP_ENABLE               0x2000

#define ACPI_BITMASK_ARB_DISABLE                0x0001


/* Raw bit position of each Bit_register */

#define ACPI_BITPOSITION_TIMER_STATUS           0x00
#define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
#define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
#define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
#define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
#define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
#define ACPI_BITPOSITION_WAKE_STATUS            0x0F

#define ACPI_BITPOSITION_TIMER_ENABLE           0x00
#define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
#define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
#define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
#define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A

#define ACPI_BITPOSITION_SCI_ENABLE             0x00
#define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
#define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
#define ACPI_BITPOSITION_SLEEP_TYPE_X           0x0A
#define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D

#define ACPI_BITPOSITION_ARB_DISABLE            0x00
Linus Torvalds's avatar
Linus Torvalds committed
797 798


Linus Torvalds's avatar
Linus Torvalds committed
799 800 801 802 803 804
/*****************************************************************************
 *
 * Resource descriptors
 *
 ****************************************************************************/

Linus Torvalds's avatar
Linus Torvalds committed
805

Linus Torvalds's avatar
Linus Torvalds committed
806
/* Resource_type values */
Linus Torvalds's avatar
Linus Torvalds committed
807

Andy Grover's avatar
Andy Grover committed
808 809 810
#define ACPI_RESOURCE_TYPE_MEMORY_RANGE         0
#define ACPI_RESOURCE_TYPE_IO_RANGE             1
#define ACPI_RESOURCE_TYPE_BUS_NUMBER_RANGE     2
Linus Torvalds's avatar
Linus Torvalds committed
811

Linus Torvalds's avatar
Linus Torvalds committed
812
/* Resource descriptor types and masks */
Linus Torvalds's avatar
Linus Torvalds committed
813

Andy Grover's avatar
Andy Grover committed
814 815
#define ACPI_RDESC_TYPE_LARGE                   0x80
#define ACPI_RDESC_TYPE_SMALL                   0x00
Linus Torvalds's avatar
Linus Torvalds committed
816

Andy Grover's avatar
Andy Grover committed
817 818
#define ACPI_RDESC_TYPE_MASK                    0x80
#define ACPI_RDESC_SMALL_MASK                   0x78 /* Only bits 6:3 contain the type */
Linus Torvalds's avatar
Linus Torvalds committed
819 820


Linus Torvalds's avatar
Linus Torvalds committed
821 822 823 824
/*
 * Small resource descriptor types
 * Note: The 3 length bits (2:0) must be zero
 */
Andy Grover's avatar
Andy Grover committed
825 826 827 828 829 830 831 832
#define ACPI_RDESC_TYPE_IRQ_FORMAT              0x20
#define ACPI_RDESC_TYPE_DMA_FORMAT              0x28
#define ACPI_RDESC_TYPE_START_DEPENDENT         0x30
#define ACPI_RDESC_TYPE_END_DEPENDENT           0x38
#define ACPI_RDESC_TYPE_IO_PORT                 0x40
#define ACPI_RDESC_TYPE_FIXED_IO_PORT           0x48
#define ACPI_RDESC_TYPE_SMALL_VENDOR            0x70
#define ACPI_RDESC_TYPE_END_TAG                 0x78
Linus Torvalds's avatar
Linus Torvalds committed
833 834 835 836

/*
 * Large resource descriptor types
 */
Linus Torvalds's avatar
Linus Torvalds committed
837

Andy Grover's avatar
Andy Grover committed
838 839 840 841 842 843 844 845 846
#define ACPI_RDESC_TYPE_MEMORY_24               0x81
#define ACPI_RDESC_TYPE_GENERAL_REGISTER        0x82
#define ACPI_RDESC_TYPE_LARGE_VENDOR            0x84
#define ACPI_RDESC_TYPE_MEMORY_32               0x85
#define ACPI_RDESC_TYPE_FIXED_MEMORY_32         0x86
#define ACPI_RDESC_TYPE_DWORD_ADDRESS_SPACE     0x87
#define ACPI_RDESC_TYPE_WORD_ADDRESS_SPACE      0x88
#define ACPI_RDESC_TYPE_EXTENDED_XRUPT          0x89
#define ACPI_RDESC_TYPE_QWORD_ADDRESS_SPACE     0x8A
Linus Torvalds's avatar
Linus Torvalds committed
847 848 849 850 851


/* String version of device HIDs and UIDs */

#define ACPI_DEVICE_ID_LENGTH                   0x09
Linus Torvalds's avatar
Linus Torvalds committed
852 853 854

typedef struct
{
Linus Torvalds's avatar
Linus Torvalds committed
855
	char            buffer[ACPI_DEVICE_ID_LENGTH];
Linus Torvalds's avatar
Linus Torvalds committed
856

Linus Torvalds's avatar
Linus Torvalds committed
857
} acpi_device_id;
Linus Torvalds's avatar
Linus Torvalds committed
858 859


Linus Torvalds's avatar
Linus Torvalds committed
860 861 862 863 864 865
/*****************************************************************************
 *
 * Miscellaneous
 *
 ****************************************************************************/

Andy Grover's avatar
Andy Grover committed
866
#define ACPI_ASCII_ZERO                      0x30
Linus Torvalds's avatar
Linus Torvalds committed
867

868

Linus Torvalds's avatar
Linus Torvalds committed
869 870 871 872 873 874 875 876
/*****************************************************************************
 *
 * Debugger
 *
 ****************************************************************************/

typedef struct dbmethodinfo
{
Linus Torvalds's avatar
Linus Torvalds committed
877
	acpi_handle             thread_gate;
Linus Torvalds's avatar
Linus Torvalds committed
878 879 880 881 882
	NATIVE_CHAR             *name;
	NATIVE_CHAR             **args;
	u32                     flags;
	u32                     num_loops;
	NATIVE_CHAR             pathname[128];
Linus Torvalds's avatar
Linus Torvalds committed
883

Andy Grover's avatar
Andy Grover committed
884 885 886 887 888 889
} acpi_db_method_info;


#define ACPI_DB_REDIRECTABLE_OUTPUT  0x01
#define ACPI_DB_CONSOLE_OUTPUT       0x02
#define ACPI_DB_DUPLICATE_OUTPUT     0x03
Linus Torvalds's avatar
Linus Torvalds committed
890 891 892 893 894 895 896 897


/*****************************************************************************
 *
 * Debug
 *
 ****************************************************************************/

Linus Torvalds's avatar
Linus Torvalds committed
898 899 900 901 902 903
typedef struct
{
	u32                     component_id;
	NATIVE_CHAR             *proc_name;
	NATIVE_CHAR             *module_name;

Linus Torvalds's avatar
Linus Torvalds committed
904
} acpi_debug_print_info;
Linus Torvalds's avatar
Linus Torvalds committed
905

Linus Torvalds's avatar
Linus Torvalds committed
906 907 908

/* Entry for a memory allocation (debug only) */

Andy Grover's avatar
Andy Grover committed
909 910 911
#define ACPI_MEM_MALLOC                      0
#define ACPI_MEM_CALLOC                      1
#define ACPI_MAX_MODULE_NAME                 16
Linus Torvalds's avatar
Linus Torvalds committed
912

Linus Torvalds's avatar
Linus Torvalds committed
913 914 915 916 917 918
#define ACPI_COMMON_DEBUG_MEM_HEADER \
	struct acpi_debug_mem_block *previous; \
	struct acpi_debug_mem_block *next; \
	u32                         size; \
	u32                         component; \
	u32                         line; \
Andy Grover's avatar
Andy Grover committed
919
	NATIVE_CHAR                 module[ACPI_MAX_MODULE_NAME]; \
Linus Torvalds's avatar
Linus Torvalds committed
920 921
	u8                          alloc_type;

Linus Torvalds's avatar
Linus Torvalds committed
922 923 924 925
typedef struct
{
	ACPI_COMMON_DEBUG_MEM_HEADER

Linus Torvalds's avatar
Linus Torvalds committed
926
} acpi_debug_mem_header;
Linus Torvalds's avatar
Linus Torvalds committed
927 928 929 930

typedef struct acpi_debug_mem_block
{
	ACPI_COMMON_DEBUG_MEM_HEADER
Linus Torvalds's avatar
Linus Torvalds committed
931
	u64                         user_space;
Linus Torvalds's avatar
Linus Torvalds committed
932

Linus Torvalds's avatar
Linus Torvalds committed
933
} acpi_debug_mem_block;
Linus Torvalds's avatar
Linus Torvalds committed
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966


#define ACPI_MEM_LIST_GLOBAL            0
#define ACPI_MEM_LIST_NSNODE            1

#define ACPI_MEM_LIST_FIRST_CACHE_LIST  2
#define ACPI_MEM_LIST_STATE             2
#define ACPI_MEM_LIST_PSNODE            3
#define ACPI_MEM_LIST_PSNODE_EXT        4
#define ACPI_MEM_LIST_OPERAND           5
#define ACPI_MEM_LIST_WALK              6
#define ACPI_MEM_LIST_MAX               6
#define ACPI_NUM_MEM_LISTS              7


typedef struct
{
	void                        *list_head;
	u16                         link_offset;
	u16                         max_cache_depth;
	u16                         cache_depth;
	u16                         object_size;

#ifdef ACPI_DBG_TRACK_ALLOCATIONS

	/* Statistics for debug memory tracking only */

	u32                         total_allocated;
	u32                         total_freed;
	u32                         current_total_size;
	u32                         cache_requests;
	u32                         cache_hits;
	char                        *list_name;
Linus Torvalds's avatar
Linus Torvalds committed
967 968
#endif

Linus Torvalds's avatar
Linus Torvalds committed
969 970 971
} ACPI_MEMORY_LIST;


Linus Torvalds's avatar
Linus Torvalds committed
972
#endif /* __ACLOCAL_H__ */