/******************************************************************************
*
* Module Name: tbfadt - FADT table utilities
*
*****************************************************************************/
/*
* Copyright (C) 2000 - 2006, 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.
*/
#include <acpi/acpi.h>
#include <acpi/actables.h>
#define _COMPONENT ACPI_TABLES
ACPI_MODULE_NAME("tbfadt")
/* Local prototypes */
static void inline
acpi_tb_init_generic_address(struct acpi_generic_address *new_gas_struct,
u8 bit_width, u64 address);
static void acpi_tb_fadt_register_error(char *register_name, u32 value);
static void acpi_tb_convert_fadt(void);
static void acpi_tb_validate_fadt(void);
/* Table used for conversion of FADT to common format */
typedef struct acpi_fadt_conversion {
u8 target;
u8 source;
u8 length;
} acpi_fadt_conversion;
static struct acpi_fadt_conversion fadt_conversion_table[] = {
{ACPI_FADT_OFFSET(xpm1a_event_block),
ACPI_FADT_OFFSET(pm1a_event_block),
ACPI_FADT_OFFSET(pm1_event_length)},
{ACPI_FADT_OFFSET(xpm1b_event_block),
ACPI_FADT_OFFSET(pm1b_event_block),
ACPI_FADT_OFFSET(pm1_event_length)},
{ACPI_FADT_OFFSET(xpm1a_control_block),
ACPI_FADT_OFFSET(pm1a_control_block),
ACPI_FADT_OFFSET(pm1_control_length)},
{ACPI_FADT_OFFSET(xpm1b_control_block),
ACPI_FADT_OFFSET(pm1b_control_block),
ACPI_FADT_OFFSET(pm1_control_length)},
{ACPI_FADT_OFFSET(xpm2_control_block),
ACPI_FADT_OFFSET(pm2_control_block),
ACPI_FADT_OFFSET(pm2_control_length)},
{ACPI_FADT_OFFSET(xpm_timer_block), ACPI_FADT_OFFSET(pm_timer_block),
ACPI_FADT_OFFSET(pm_timer_length)},
{ACPI_FADT_OFFSET(xgpe0_block), ACPI_FADT_OFFSET(gpe0_block),
ACPI_FADT_OFFSET(gpe0_block_length)},
{ACPI_FADT_OFFSET(xgpe1_block), ACPI_FADT_OFFSET(gpe1_block),
ACPI_FADT_OFFSET(gpe1_block_length)}
};
#define ACPI_FADT_CONVERSION_ENTRIES (sizeof (fadt_conversion_table) / sizeof (struct acpi_fadt_conversion))
/*******************************************************************************
*
* FUNCTION: acpi_tb_init_generic_address
*
* PARAMETERS: new_gas_struct - GAS struct to be initialized
* bit_width - Width of this register
* Address - Address of the register
*
* RETURN: None
*
* DESCRIPTION: Initialize a GAS structure.
*
******************************************************************************/
static void inline
acpi_tb_init_generic_address(struct acpi_generic_address *new_gas_struct,
u8 bit_width, u64 address)
{
ACPI_MOVE_64_TO_64(&new_gas_struct->address, &address);
new_gas_struct->space_id = ACPI_ADR_SPACE_SYSTEM_IO;
new_gas_struct->bit_width = bit_width;
new_gas_struct->bit_offset = 0;
new_gas_struct->access_width = 0;
}
/*******************************************************************************
*
* FUNCTION: acpi_tb_parse_fadt
*
* PARAMETERS: table_index - Index for the FADT
* Flags - Flags
*
* RETURN: None
*
* DESCRIPTION: Initialize the FADT, DSDT and FACS tables
* (FADT contains the addresses of the DSDT and FACS)
*
******************************************************************************/
void acpi_tb_parse_fadt(acpi_native_uint table_index, u8 flags)
{
u32 length;
struct acpi_table_header *table;
/*
* Special case for the FADT because of multiple versions and the fact
* that it contains pointers to both the DSDT and FACS tables.
*
* Get a local copy of the FADT and convert it to a common format
* Map entire FADT, assumed to be smaller than one page.
*/
length = acpi_gbl_root_table_list.tables[table_index].length;
table =
acpi_os_map_memory(acpi_gbl_root_table_list.tables[table_index].
address, length);
if (!table) {
return;
}
/*
* Validate the FADT checksum before we copy the table. Ignore
* checksum error as we want to try to get the DSDT and FACS.
*/
(void)acpi_tb_verify_checksum(table, length);
/* Copy the entire FADT locally */
ACPI_MEMSET(&acpi_gbl_FADT, 0, sizeof(struct acpi_table_fadt));
ACPI_MEMCPY(&acpi_gbl_FADT, table,
ACPI_MIN(length, sizeof(struct acpi_table_fadt)));
acpi_os_unmap_memory(table, length);
/* Convert local FADT to the common internal format */
acpi_tb_convert_fadt();
/* Extract the DSDT and FACS tables from the FADT */
acpi_tb_install_table((acpi_physical_address) acpi_gbl_FADT.Xdsdt,
flags, ACPI_SIG_DSDT, ACPI_TABLE_INDEX_DSDT);
acpi_tb_install_table((acpi_physical_address) acpi_gbl_FADT.Xfacs,
flags, ACPI_SIG_FACS, ACPI_TABLE_INDEX_FACS);
/* Validate important FADT values */
acpi_tb_validate_fadt();
}
/*******************************************************************************
*
* FUNCTION: acpi_tb_convert_fadt
*
* PARAMETERS: None, uses acpi_gbl_FADT
*
* RETURN: None
*
* DESCRIPTION: Converts all versions of the FADT to a common internal format.
*
* NOTE: acpi_gbl_FADT must be of size (struct acpi_table_fadt), and must contain
* a copy of the actual FADT.
*
* ACPICA will use the "X" fields of the FADT for all addresses.
*
* "X" fields are optional extensions to the original V1.0 fields. Even if
* they are present in the structure, they can be optionally not used by
* setting them to zero. Therefore, we must selectively expand V1.0 fields
* if the corresponding X field is zero.
*
* For ACPI 1.0 FADTs, all address fields are expanded to the corresponding
* "X" fields.
*
* For ACPI 2.0 FADTs, any "X" fields that are NULL are filled in by
* expanding the corresponding ACPI 1.0 field.
*
******************************************************************************/
static void acpi_tb_convert_fadt(void)
{
u8 pm1_register_length;
struct acpi_generic_address *target;
acpi_native_uint i;
/* Expand the FACS and DSDT addresses as necessary */
if (!acpi_gbl_FADT.Xfacs) {
acpi_gbl_FADT.Xfacs = (u64) acpi_gbl_FADT.facs;
}
if (!acpi_gbl_FADT.Xdsdt) {
acpi_gbl_FADT.Xdsdt = (u64) acpi_gbl_FADT.dsdt;
}
/*
* Expand the 32-bit V1.0 addresses to the 64-bit "X" generic address
* structures as necessary.
*/
for (i = 0; i < ACPI_FADT_CONVERSION_ENTRIES; i++) {
target =
ACPI_ADD_PTR(struct acpi_generic_address, &acpi_gbl_FADT,
fadt_conversion_table[i].target);
/* Expand only if the X target is null */
if (!target->address) {
acpi_tb_init_generic_address(target,
*ACPI_ADD_PTR(u8,
&acpi_gbl_FADT,
fadt_conversion_table
[i].length),
(u64) * ACPI_ADD_PTR(u32,
&acpi_gbl_FADT,
fadt_conversion_table
[i].
source));
}
}
/*
* Calculate separate GAS structs for the PM1 Enable registers.
* These addresses do not appear (directly) in the FADT, so it is
* useful to calculate them once, here.
*
* The PM event blocks are split into two register blocks, first is the
* PM Status Register block, followed immediately by the PM Enable Register
* block. Each is of length (pm1_event_length/2)
*/
pm1_register_length = (u8) ACPI_DIV_2(acpi_gbl_FADT.pm1_event_length);
/* PM1A is required */
acpi_tb_init_generic_address(&acpi_gbl_xpm1a_enable,
pm1_register_length,
(acpi_gbl_FADT.xpm1a_event_block.address +
pm1_register_length));
/* PM1B is optional; leave null if not present */
if (acpi_gbl_FADT.xpm1b_event_block.address) {
acpi_tb_init_generic_address(&acpi_gbl_xpm1b_enable,
pm1_register_length,
(acpi_gbl_FADT.xpm1b_event_block.
address + pm1_register_length));
}
/* Global FADT is the new common V2.0 FADT */
acpi_gbl_FADT.header.length = sizeof(struct acpi_table_fadt);
}
/******************************************************************************
*
* FUNCTION: acpi_tb_validate_fadt
*
* PARAMETERS: None
*
* RETURN: Status
*
* DESCRIPTION: Validate various ACPI registers in the FADT
*
******************************************************************************/
static void acpi_tb_validate_fadt(void)
{
/* These length fields have a minimum value */
if (acpi_gbl_FADT.pm1_event_length < 4) {
acpi_tb_fadt_register_error("Pm1EventLength",
(u32) acpi_gbl_FADT.
pm1_event_length);
}
if (acpi_gbl_FADT.pm_timer_length < 4) {
acpi_tb_fadt_register_error("PmTimerLength",
(u32) acpi_gbl_FADT.
pm_timer_length);
}
/* These length and address fields must be non-zero */
if (!acpi_gbl_FADT.pm1_control_length) {
acpi_tb_fadt_register_error("Pm1ControlLength", 0);
}
if (!acpi_gbl_FADT.xpm1a_event_block.address) {
acpi_tb_fadt_register_error("XPm1aEventBlock.Address", 0);
}
if (!acpi_gbl_FADT.xpm1a_control_block.address) {
acpi_tb_fadt_register_error("XPm1aControlBlock.Address", 0);
}
if (!acpi_gbl_FADT.xpm_timer_block.address) {
acpi_tb_fadt_register_error("XPmTimerBlock.Address", 0);
}
/* If PM2 block is present, must have non-zero length */
if ((acpi_gbl_FADT.xpm2_control_block.address &&
!acpi_gbl_FADT.pm2_control_length)) {
acpi_tb_fadt_register_error("Pm2ControlLength",
(u32) acpi_gbl_FADT.
pm2_control_length);
}
/* Length of any valid GPE blocks must be a multiple of 2 */
if (acpi_gbl_FADT.xgpe0_block.address &&
(acpi_gbl_FADT.gpe0_block_length & 1)) {
acpi_tb_fadt_register_error("Gpe0BlockLength",
(u32) acpi_gbl_FADT.
gpe0_block_length);
}
if (acpi_gbl_FADT.xgpe1_block.address &&
(acpi_gbl_FADT.gpe1_block_length & 1)) {
acpi_tb_fadt_register_error("Gpe1BlockLength",
(u32) acpi_gbl_FADT.
gpe1_block_length);
}
}
/*******************************************************************************
*
* FUNCTION: acpi_tb_fadt_register_error
*
* PARAMETERS: register_name - Pointer to string identifying register
* Value - Actual register contents value
*
* RETURN: None
*
* DESCRIPTION: Display FADT warning message
*
******************************************************************************/
static void acpi_tb_fadt_register_error(char *register_name, u32 value)
{
ACPI_WARNING((AE_INFO, "Invalid FADT value \"%s\" = %X",
register_name, value));
}
