/******************************************************************************

 *

 * Name: aclocal.h - Internal data types used across the ACPI subsystem

 *

 *****************************************************************************/

/*

 * Copyright (C) 2000 - 2007, R. Byron Moore

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions, and the following disclaimer,

 *    without modification.

 * 2. Redistributions in binary form must reproduce at minimum a disclaimer

 *    substantially similar to the "NO WARRANTY" disclaimer below

 *    ("Disclaimer") and any redistribution must be conditioned upon

 *    including a substantially similar Disclaimer requirement for further

 *    binary redistribution.

 * 3. Neither the names of the above-listed copyright holders nor the names

 *    of any contributors may be used to endorse or promote products derived

 *    from this software without specific prior written permission.

 *

 * Alternatively, this software may be distributed under the terms of the

 * GNU General Public License ("GPL") version 2 as published by the Free

 * Software Foundation.

 *

 * NO WARRANTY

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING

 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

 * POSSIBILITY OF SUCH DAMAGES.

 */

#ifndef __ACLOCAL_H__

#define __ACLOCAL_H__

/* acpisrc:struct_defs -- for acpisrc conversion */

/*****************************************************************************

 *

 * Namespace typedefs and structs

 *

 ****************************************************************************/

union acpi_name_union {

  u32 integer;

  char ascii[4];

};

/*

 * ACPI Table Descriptor.  One per ACPI table

 */

struct acpi_table_desc {

  acpi_physical_address address;

  struct acpi_table_header *pointer;

  u32 length;   /* Length fixed at 32 bits */

  union acpi_name_union signature;

  u8 flags;

};

/* Flags for above */

#define ACPI_TABLE_ORIGIN_UNKNOWN       (0)

#define ACPI_TABLE_ORIGIN_MAPPED        (1)

#define ACPI_TABLE_ORIGIN_ALLOCATED     (2)

#define ACPI_TABLE_ORIGIN_MASK          (3)

#define ACPI_TABLE_IS_LOADED            (4)

/* One internal RSDT for table management */

struct acpi_internal_rsdt {

  struct acpi_table_desc *tables;

  u32 count;

  u32 size;

  u8 flags;

};

/* Flags for above */

#define ACPI_ROOT_ORIGIN_UNKNOWN        (0) /* ~ORIGIN_ALLOCATED */

#define ACPI_ROOT_ORIGIN_ALLOCATED      (1)

#define ACPI_ROOT_ALLOW_RESIZE          (2)

/* Predefined (fixed) table indexes */

#define ACPI_TABLE_INDEX_DSDT           (0)

#define ACPI_TABLE_INDEX_FACS           (1)

/*****************************************************************************

 *

 * Hardware (ACPI registers) and PNP

 *

 ****************************************************************************/

struct acpi_bit_register_info {

  u8 parent_register;

  u8 bit_position;

  u16 access_bit_mask;

};

/*

 * Some ACPI registers have bits that must be ignored -- meaning that they

 * must be preserved.

 */

#define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */

#define ACPI_PM1_CONTROL_PRESERVED_BITS         0x0200  /* Bit 9 (whatever) */

/*

 * Register IDs

 * These are the full ACPI registers

 */

#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

#define ACPI_REGISTER_SLEEP_CONTROL             0x0a

#define ACPI_REGISTER_SLEEP_STATUS              0x0b

/* 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_PCIEXP_WAKE_STATUS         0x4000  /* ACPI 3.0 */

#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_PCIEXP_WAKE_DISABLE        0x4000  /* ACPI 3.0 */

#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_PCIEXP_WAKE_STATUS     0x0E  /* ACPI 3.0 */

#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_PCIEXP_WAKE_DISABLE    0x0E  /* ACPI 3.0 */

#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

/*****************************************************************************

 *

 * Resource descriptors

 *

 ****************************************************************************/

/* resource_type values */

#define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0

#define ACPI_ADDRESS_TYPE_IO_RANGE              1

#define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2

#endif        /* __ACLOCAL_H__ */