aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Module Name: hwxface - Public ACPICA hardware interfaces
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers *****************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * All rights reserved.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Redistribution and use in source and binary forms, with or without
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * modification, are permitted provided that the following conditions
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 1. Redistributions of source code must retain the above copyright
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * notice, this list of conditions, and the following disclaimer,
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * without modification.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * substantially similar to the "NO WARRANTY" disclaimer below
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * ("Disclaimer") and any redistribution must be conditioned upon
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * including a substantially similar Disclaimer requirement for further
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * binary redistribution.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * of any contributors may be used to endorse or promote products derived
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * from this software without specific prior written permission.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Alternatively, this software may be distributed under the terms of the
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * GNU General Public License ("GPL") version 2 as published by the Free
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Software Foundation.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * NO WARRANTY
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * POSSIBILITY OF SUCH DAMAGES.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiReset
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: None
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Set reset register in memory or IO space. Note: Does not
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * support reset register in PCI config space, this must be
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * handled separately.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Check if the reset register is supported */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (!(AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER) ||
4cf02d40c1d09ad2a5a49f040d1c9fa191244416Saurabh Misra if (ResetReg->SpaceId == ACPI_ADR_SPACE_SYSTEM_IO)
4cf02d40c1d09ad2a5a49f040d1c9fa191244416Saurabh Misra * For I/O space, write directly to the OSL. This bypasses the port
4cf02d40c1d09ad2a5a49f040d1c9fa191244416Saurabh Misra * validation mechanism, which may block a valid write to the reset
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * The ACPI spec requires the reset register width to be 8, so we
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * hardcode it here and ignore the FADT value. This maintains
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * compatibility with other ACPI implementations that have allowed
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * BIOS code with bad register width values to go unnoticed.
4cf02d40c1d09ad2a5a49f040d1c9fa191244416Saurabh Misra Status = AcpiOsWritePort ((ACPI_IO_ADDRESS) ResetReg->Address,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiGbl_FADT.ResetValue, ACPI_RESET_REGISTER_WIDTH);
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Write the reset value to the reset register */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiHwWrite (AcpiGbl_FADT.ResetValue, ResetReg);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiRead
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Value - Where the value is returned
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Reg - GAS register structure
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Read from either memory or IO space.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * LIMITATIONS: <These limitations also apply to AcpiWrite>
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * BitWidth must be exactly 8, 16, 32, or 64.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * SpaceID must be SystemMemory or SystemIO.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * BitOffset and AccessWidth are currently ignored, as there has
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * not been a need to implement these.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Validate contents of the GAS register. Allow 64-bit transfers */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiHwValidateRegister (Reg, 64, &Address);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Two address spaces supported: Memory or I/O. PCI_Config is
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * not supported here because the GAS structure is insufficient
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers if (Reg->SpaceId == ACPI_ADR_SPACE_SYSTEM_MEMORY)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiOsReadMemory ((ACPI_PHYSICAL_ADDRESS)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers else /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Width = 32; /* Break into two 32-bit transfers */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Read the top 32 bits */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Set the return value only if status is AE_OK */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *ReturnValue = (ValueLo | ((UINT64) ValueHi << 32));
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Read: %8.8X%8.8X width %2d from %8.8X%8.8X (%s)\n",
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_FORMAT_UINT64 (*ReturnValue), Reg->BitWidth,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiWrite
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * PARAMETERS: Value - Value to be written
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Reg - GAS register structure
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Write to either memory or IO space.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Validate contents of the GAS register. Allow 64-bit transfers */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiHwValidateRegister (Reg, 64, &Address);
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * Two address spaces supported: Memory or IO. PCI_Config is
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * not supported here because the GAS structure is insufficient
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers if (Reg->SpaceId == ACPI_ADR_SPACE_SYSTEM_MEMORY)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiOsWriteMemory ((ACPI_PHYSICAL_ADDRESS)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers else /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Width = 32; /* Break into two 32-bit transfers */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Wrote: %8.8X%8.8X width %2d to %8.8X%8.8X (%s)\n",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiReadBitRegister
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: RegisterId - ID of ACPI Bit Register to access
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ReturnValue - Value that was read from the register,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * normalized to bit position zero.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status and the value read from the specified Register. Value
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * returned is normalized to bit0 (is shifted all the way right)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: ACPI BitRegister read function. Does not acquire the HW lock.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PM2 Control.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Note: The hardware lock is not required when reading the ACPI bit registers
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * since almost all of them are single bit and it does not matter that
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the parent hardware register can be split across two physical
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * registers. The only multi-bit field is SLP_TYP in the PM1 control
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * register, but this field does not cross an 8-bit boundary (nor does
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * it make much sense to actually read this field.)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_FUNCTION_TRACE_U32 (AcpiReadBitRegister, RegisterId);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Get the info structure corresponding to the requested ACPI Register */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers BitRegInfo = AcpiHwGetBitRegisterInfo (RegisterId);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Read the entire parent register */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiHwRegisterRead (BitRegInfo->ParentRegister,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Normalize the value that was read, mask off other bits */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Value = ((RegisterValue & BitRegInfo->AccessBitMask)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "BitReg %X, ParentReg %X, Actual %8.8X, ReturnValue %8.8X\n",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers RegisterId, BitRegInfo->ParentRegister, RegisterValue, Value));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiWriteBitRegister
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: RegisterId - ID of ACPI Bit Register to access
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Value - Value to write to the register, in bit
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * position zero. The bit is automatically
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * shifted to the correct position.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: ACPI Bit Register write function. Acquires the hardware lock
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * since most operations require a read/modify/write sequence.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PM2 Control.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Note that at this level, the fact that there may be actually two
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * hardware registers (A and B - and B may not exist) is abstracted.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_FUNCTION_TRACE_U32 (AcpiWriteBitRegister, RegisterId);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Get the info structure corresponding to the requested ACPI Register */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers BitRegInfo = AcpiHwGetBitRegisterInfo (RegisterId);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers LockFlags = AcpiOsAcquireLock (AcpiGbl_HardwareLock);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * At this point, we know that the parent register is one of the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * following: PM1 Status, PM1 Enable, PM1 Control, or PM2 Control
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (BitRegInfo->ParentRegister != ACPI_REGISTER_PM1_STATUS)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 1) Case for PM1 Enable, PM1 Control, and PM2 Control
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Perform a register read to preserve the bits that we are not
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * interested in
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiHwRegisterRead (BitRegInfo->ParentRegister,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Insert the input bit into the value that was just read
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * and write the register
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_REGISTER_INSERT_VALUE (RegisterValue, BitRegInfo->BitPosition,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiHwRegisterWrite (BitRegInfo->ParentRegister,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 2) Case for PM1 Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The Status register is different from the rest. Clear an event
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * by writing 1, writing 0 has no effect. So, the only relevant
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * information is the single bit we're interested in, all others
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * should be written as 0 so they will be left unchanged.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers RegisterValue = ACPI_REGISTER_PREPARE_BITS (Value,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers BitRegInfo->BitPosition, BitRegInfo->AccessBitMask);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* No need to write the register if value is all zeros */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_STATUS,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "BitReg %X, ParentReg %X, Value %8.8X, Actual %8.8X\n",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers RegisterId, BitRegInfo->ParentRegister, Value, RegisterValue));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers AcpiOsReleaseLock (AcpiGbl_HardwareLock, LockFlags);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#endif /* !ACPI_REDUCED_HARDWARE */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiGetSleepTypeData
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: SleepState - Numeric sleep state
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * *SleepTypeA - Where SLP_TYPa is returned
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * *SleepTypeB - Where SLP_TYPb is returned
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: Status
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Obtain the SLP_TYPa and SLP_TYPb values for the requested
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * sleep state via the appropriate \_Sx object.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * The sleep state package returned from the corresponding \_Sx_ object
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * must contain at least one integer.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * March 2005:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Added support for a package that contains two integers. This
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * goes against the ACPI specification which defines this object as a
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * package with one encoded DWORD integer. However, existing practice
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * by many BIOS vendors is to return a package with 2 or more integer
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * elements, at least one per sleep type (A/B).
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * January 2013:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Therefore, we must be prepared to accept a package with either a
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * single integer or multiple integers.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * The single integer DWORD format is as follows:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * BYTE 0 - Value for the PM1A SLP_TYP register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * BYTE 1 - Value for the PM1B SLP_TYP register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * BYTE 2-3 - Reserved
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * The dual integer format is as follows:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Integer 0 - Value for the PM1A SLP_TYP register
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Integer 1 - Value for the PM1A SLP_TYP register
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Validate parameters */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Allocate the evaluation information block */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Evaluate the \_Sx namespace object containing the register values
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * for this state
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Info->RelativePathname = AcpiGbl_SleepStateNames[SleepState];
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* The _Sx states are optional, ignore NOT_FOUND */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Must have a return object */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_ERROR ((AE_INFO, "No Sleep State object returned from [%s]",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Return object must be of type Package */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if (Info->ReturnObject->Common.Type != ACPI_TYPE_PACKAGE)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_ERROR ((AE_INFO, "Sleep State return object is not a Package"));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Any warnings about the package length or the object types have
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * already been issued by the predefined name module -- there is no
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * need to repeat them here.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Elements = Info->ReturnObject->Package.Elements;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if (Elements[0]->Common.Type != ACPI_TYPE_INTEGER)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* A valid _Sx_ package with one integer */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *SleepTypeA = (UINT8) Elements[0]->Integer.Value;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *SleepTypeB = (UINT8) (Elements[0]->Integer.Value >> 8);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if ((Elements[0]->Common.Type != ACPI_TYPE_INTEGER) ||
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek (Elements[1]->Common.Type != ACPI_TYPE_INTEGER))
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* A valid _Sx_ package with two integers */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *SleepTypeA = (UINT8) Elements[0]->Integer.Value;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *SleepTypeB = (UINT8) Elements[1]->Integer.Value;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "While evaluating Sleep State [%s]",