hwxface.c revision 26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0
/******************************************************************************
*
* Module Name: hwxface - Public ACPICA hardware interfaces
*
*****************************************************************************/
/*
* Copyright (C) 2000 - 2011, Intel Corp.
* 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.h"
#include "accommon.h"
#include "acnamesp.h"
#define _COMPONENT ACPI_HARDWARE
ACPI_MODULE_NAME ("hwxface")
/******************************************************************************
*
* FUNCTION: AcpiReset
*
* PARAMETERS: None
*
* RETURN: Status
*
* DESCRIPTION: Set reset register in memory or IO space. Note: Does not
* support reset register in PCI config space, this must be
* handled separately.
*
******************************************************************************/
void)
{
/* Check if the reset register is supported */
{
}
{
/*
* For I/O space, write directly to the OSL. This bypasses the port
* validation mechanism, which may block a valid write to the reset
* register.
*/
}
else
{
/* Write the reset value to the reset register */
}
}
/******************************************************************************
*
* FUNCTION: AcpiRead
*
* PARAMETERS: Value - Where the value is returned
* Reg - GAS register structure
*
* RETURN: Status
*
* DESCRIPTION: Read from either memory or IO space.
*
* LIMITATIONS: <These limitations also apply to AcpiWrite>
* BitWidth must be exactly 8, 16, 32, or 64.
* SpaceID must be SystemMemory or SystemIO.
* BitOffset and AccessWidth are currently ignored, as there has
* not been a need to implement these.
*
******************************************************************************/
AcpiRead (
{
if (!ReturnValue)
{
return (AE_BAD_PARAMETER);
}
/* Validate contents of the GAS register. Allow 64-bit transfers */
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (Width == 64)
{
}
/* Initialize entire 64-bit return value to zero */
*ReturnValue = 0;
Value = 0;
/*
* Two address spaces supported: Memory or IO. PCI_Config is
* not supported here because the GAS structure is insufficient
*/
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
*ReturnValue = Value;
{
/* Read the top 32 bits */
if (ACPI_FAILURE (Status))
{
return (Status);
}
}
}
else /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
*ReturnValue = Value;
{
/* Read the top 32 bits */
if (ACPI_FAILURE (Status))
{
return (Status);
}
}
}
"Read: %8.8X%8.8X width %2d from %8.8X%8.8X (%s)\n",
return (Status);
}
/******************************************************************************
*
* FUNCTION: AcpiWrite
*
* PARAMETERS: Value - Value to be written
* Reg - GAS register structure
*
* RETURN: Status
*
* DESCRIPTION: Write to either memory or IO space.
*
******************************************************************************/
{
/* Validate contents of the GAS register. Allow 64-bit transfers */
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (Width == 64)
{
}
/*
* Two address spaces supported: Memory or IO. PCI_Config is
* not supported here because the GAS structure is insufficient
*/
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
}
}
else /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
}
}
"Wrote: %8.8X%8.8X width %2d to %8.8X%8.8X (%s)\n",
return (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiReadBitRegister
*
* PARAMETERS: RegisterId - ID of ACPI Bit Register to access
* ReturnValue - Value that was read from the register,
* normalized to bit position zero.
*
* RETURN: Status and the value read from the specified Register. Value
* returned is normalized to bit0 (is shifted all the way right)
*
* DESCRIPTION: ACPI BitRegister read function. Does not acquire the HW lock.
*
* SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
* PM2 Control.
*
* Note: The hardware lock is not required when reading the ACPI bit registers
* since almost all of them are single bit and it does not matter that
* the parent hardware register can be split across two physical
* registers. The only multi-bit field is SLP_TYP in the PM1 control
* register, but this field does not cross an 8-bit boundary (nor does
* it make much sense to actually read this field.)
*
******************************************************************************/
{
/* Get the info structure corresponding to the requested ACPI Register */
if (!BitRegInfo)
{
}
/* Read the entire parent register */
if (ACPI_FAILURE (Status))
{
}
/* Normalize the value that was read, mask off other bits */
>> BitRegInfo->BitPosition);
"BitReg %X, ParentReg %X, Actual %8.8X, ReturnValue %8.8X\n",
*ReturnValue = Value;
}
/*******************************************************************************
*
* FUNCTION: AcpiWriteBitRegister
*
* PARAMETERS: RegisterId - ID of ACPI Bit Register to access
* Value - Value to write to the register, in bit
* position zero. The bit is automaticallly
* shifted to the correct position.
*
* RETURN: Status
*
* DESCRIPTION: ACPI Bit Register write function. Acquires the hardware lock
*
* SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
* PM2 Control.
*
* Note that at this level, the fact that there may be actually two
* hardware registers (A and B - and B may not exist) is abstracted.
*
******************************************************************************/
{
/* Get the info structure corresponding to the requested ACPI Register */
if (!BitRegInfo)
{
}
/*
* At this point, we know that the parent register is one of the
* following: PM1 Status, PM1 Enable, PM1 Control, or PM2 Control
*/
{
/*
* 1) Case for PM1 Enable, PM1 Control, and PM2 Control
*
* Perform a register read to preserve the bits that we are not
* interested in
*/
if (ACPI_FAILURE (Status))
{
goto UnlockAndExit;
}
/*
* Insert the input bit into the value that was just read
* and write the register
*/
}
else
{
/*
* 2) Case for PM1 Status
*
* The Status register is different from the rest. Clear an event
* by writing 1, writing 0 has no effect. So, the only relevant
* information is the single bit we're interested in, all others
* should be written as 0 so they will be left unchanged.
*/
/* No need to write the register if value is all zeros */
if (RegisterValue)
{
}
}
"BitReg %X, ParentReg %X, Value %8.8X, Actual %8.8X\n",
}
/*******************************************************************************
*
* FUNCTION: AcpiGetSleepTypeData
*
* PARAMETERS: SleepState - Numeric sleep state
* *SleepTypeA - Where SLP_TYPa is returned
* *SleepTypeB - Where SLP_TYPb is returned
*
* RETURN: Status - ACPI status
*
* DESCRIPTION: Obtain the SLP_TYPa and SLP_TYPb values for the requested sleep
* state.
*
******************************************************************************/
{
/* Validate parameters */
if ((SleepState > ACPI_S_STATES_MAX) ||
!SleepTypeA ||
{
}
/* Allocate the evaluation information block */
if (!Info)
{
}
/* Evaluate the namespace object containing the values for this state */
if (ACPI_FAILURE (Status))
{
"%s while evaluating SleepState [%s]\n",
goto Cleanup;
}
/* Must have a return object */
if (!Info->ReturnObject)
{
}
/* It must be of type Package */
{
}
/*
* The package must have at least two elements. NOTE (March 2005): This
* goes against the current ACPI spec which defines this object as a
* package with one encoded DWORD element. However, existing practice
* by BIOS vendors seems to be to have 2 or more elements, at least
* one per sleep type (A/B).
*/
{
"Sleep State return package does not have at least two elements"));
}
/* The first two elements must both be of type Integer */
!= ACPI_TYPE_INTEGER) ||
!= ACPI_TYPE_INTEGER))
{
"Sleep State return package elements are not both Integers "
"(%s, %s)",
}
else
{
/* Valid _Sx_ package size, type, and value */
*SleepTypeA = (UINT8)
*SleepTypeB = (UINT8)
}
if (ACPI_FAILURE (Status))
{
"While evaluating SleepState [%s], bad Sleep object %p type %s",
}
}