7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Name: acbuffer.h - Support for buffers returned by ACPI predefined names
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *****************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * All rights reserved.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Redistribution and use in source and binary forms, with or without
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * modification, are permitted provided that the following conditions
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 1. Redistributions of source code must retain the above copyright
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * notice, this list of conditions, and the following disclaimer,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * without modification.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 2. Redistributions in binary form must reproduce at minimum a disclaimer
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * substantially similar to the "NO WARRANTY" disclaimer below
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * ("Disclaimer") and any redistribution must be conditioned upon
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * including a substantially similar Disclaimer requirement for further
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * binary redistribution.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 3. Neither the names of the above-listed copyright holders nor the names
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * of any contributors may be used to endorse or promote products derived
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * from this software without specific prior written permission.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Alternatively, this software may be distributed under the terms of the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * GNU General Public License ("GPL") version 2 as published by the Free
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Software Foundation.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * NO WARRANTY
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * POSSIBILITY OF SUCH DAMAGES.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Contains buffer structures for these predefined names:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * _FDE, _GRT, _GTM, _PLD, _SRT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: C bitfields are not used for this reason:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * "Bitfields are great and easy to read, but unfortunately the C language
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * does not specify the layout of bitfields in memory, which means they are
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * essentially useless for dealing with packed data in on-disk formats or
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * this decision was a design error in C. Ritchie could have picked an order
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * and stuck with it." Norman Ramsey.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * See http://stackoverflow.com/a/1053662/41661
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* _FDE return value */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * _GRT return value
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * _SRT input value
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* _GTM return value */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Formatted _PLD return value. The minimum size is a package containing
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * one buffer.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Revision 1: Buffer is 16 bytes (128 bits)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Revision 2: Buffer is 20 bytes (160 bits)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: This structure is returned from the AcpiDecodePldBuffer
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 1) Convert a _PLD buffer to internal ACPI_PLD_INFO format - ACPI_PLD_GET*
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * (Used by AcpiDecodePldBuffer)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 2) Construct a _PLD buffer - ACPI_PLD_SET*
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * (Intended for BIOS use only)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_REV1_BUFFER_SIZE 16 /* For Revision 1 of the buffer (From ACPI spec) */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_REV2_BUFFER_SIZE 20 /* For Revision 2 of the buffer (From ACPI spec) */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_BUFFER_SIZE 20 /* For Revision 2 of the buffer (From ACPI spec) */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* First 32-bit dword, bits 0:32 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_REVISION(dword) ACPI_GET_BITS (dword, 0, ACPI_7BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_REVISION(dword,value) ACPI_SET_BITS (dword, 0, ACPI_7BIT_MASK, value) /* Offset 0, Len 7 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_IGNORE_COLOR(dword) ACPI_GET_BITS (dword, 7, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_IGNORE_COLOR(dword,value) ACPI_SET_BITS (dword, 7, ACPI_1BIT_MASK, value) /* Offset 7, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_RED(dword) ACPI_GET_BITS (dword, 8, ACPI_8BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_RED(dword,value) ACPI_SET_BITS (dword, 8, ACPI_8BIT_MASK, value) /* Offset 8, Len 8 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_GREEN(dword) ACPI_GET_BITS (dword, 16, ACPI_8BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_GREEN(dword,value) ACPI_SET_BITS (dword, 16, ACPI_8BIT_MASK, value) /* Offset 16, Len 8 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_BLUE(dword) ACPI_GET_BITS (dword, 24, ACPI_8BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_BLUE(dword,value) ACPI_SET_BITS (dword, 24, ACPI_8BIT_MASK, value) /* Offset 24, Len 8 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* Second 32-bit dword, bits 33:63 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_WIDTH(dword) ACPI_GET_BITS (dword, 0, ACPI_16BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_WIDTH(dword,value) ACPI_SET_BITS (dword, 0, ACPI_16BIT_MASK, value) /* Offset 32+0=32, Len 16 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_HEIGHT(dword) ACPI_GET_BITS (dword, 16, ACPI_16BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_HEIGHT(dword,value) ACPI_SET_BITS (dword, 16, ACPI_16BIT_MASK, value) /* Offset 32+16=48, Len 16 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* Third 32-bit dword, bits 64:95 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_USER_VISIBLE(dword) ACPI_GET_BITS (dword, 0, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_USER_VISIBLE(dword,value) ACPI_SET_BITS (dword, 0, ACPI_1BIT_MASK, value) /* Offset 64+0=64, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_DOCK(dword) ACPI_GET_BITS (dword, 1, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_DOCK(dword,value) ACPI_SET_BITS (dword, 1, ACPI_1BIT_MASK, value) /* Offset 64+1=65, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_LID(dword) ACPI_GET_BITS (dword, 2, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_LID(dword,value) ACPI_SET_BITS (dword, 2, ACPI_1BIT_MASK, value) /* Offset 64+2=66, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_PANEL(dword) ACPI_GET_BITS (dword, 3, ACPI_3BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_PANEL(dword,value) ACPI_SET_BITS (dword, 3, ACPI_3BIT_MASK, value) /* Offset 64+3=67, Len 3 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_VERTICAL(dword) ACPI_GET_BITS (dword, 6, ACPI_2BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_VERTICAL(dword,value) ACPI_SET_BITS (dword, 6, ACPI_2BIT_MASK, value) /* Offset 64+6=70, Len 2 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_HORIZONTAL(dword) ACPI_GET_BITS (dword, 8, ACPI_2BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_HORIZONTAL(dword,value) ACPI_SET_BITS (dword, 8, ACPI_2BIT_MASK, value) /* Offset 64+8=72, Len 2 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_SHAPE(dword) ACPI_GET_BITS (dword, 10, ACPI_4BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_SHAPE(dword,value) ACPI_SET_BITS (dword, 10, ACPI_4BIT_MASK, value) /* Offset 64+10=74, Len 4 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_ORIENTATION(dword) ACPI_GET_BITS (dword, 14, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_ORIENTATION(dword,value) ACPI_SET_BITS (dword, 14, ACPI_1BIT_MASK, value) /* Offset 64+14=78, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_TOKEN(dword) ACPI_GET_BITS (dword, 15, ACPI_8BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_TOKEN(dword,value) ACPI_SET_BITS (dword, 15, ACPI_8BIT_MASK, value) /* Offset 64+15=79, Len 8 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_POSITION(dword) ACPI_GET_BITS (dword, 23, ACPI_8BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_POSITION(dword,value) ACPI_SET_BITS (dword, 23, ACPI_8BIT_MASK, value) /* Offset 64+23=87, Len 8 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_BAY(dword) ACPI_GET_BITS (dword, 31, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_BAY(dword,value) ACPI_SET_BITS (dword, 31, ACPI_1BIT_MASK, value) /* Offset 64+31=95, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* Fourth 32-bit dword, bits 96:127 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_EJECTABLE(dword) ACPI_GET_BITS (dword, 0, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_EJECTABLE(dword,value) ACPI_SET_BITS (dword, 0, ACPI_1BIT_MASK, value) /* Offset 96+0=96, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_OSPM_EJECT(dword) ACPI_GET_BITS (dword, 1, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_OSPM_EJECT(dword,value) ACPI_SET_BITS (dword, 1, ACPI_1BIT_MASK, value) /* Offset 96+1=97, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_CABINET(dword) ACPI_GET_BITS (dword, 2, ACPI_8BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_CABINET(dword,value) ACPI_SET_BITS (dword, 2, ACPI_8BIT_MASK, value) /* Offset 96+2=98, Len 8 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_CARD_CAGE(dword) ACPI_GET_BITS (dword, 10, ACPI_8BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_CARD_CAGE(dword,value) ACPI_SET_BITS (dword, 10, ACPI_8BIT_MASK, value) /* Offset 96+10=106, Len 8 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_REFERENCE(dword) ACPI_GET_BITS (dword, 18, ACPI_1BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_REFERENCE(dword,value) ACPI_SET_BITS (dword, 18, ACPI_1BIT_MASK, value) /* Offset 96+18=114, Len 1 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_ROTATION(dword) ACPI_GET_BITS (dword, 19, ACPI_4BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_ROTATION(dword,value) ACPI_SET_BITS (dword, 19, ACPI_4BIT_MASK, value) /* Offset 96+19=115, Len 4 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_ORDER(dword) ACPI_GET_BITS (dword, 23, ACPI_5BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_ORDER(dword,value) ACPI_SET_BITS (dword, 23, ACPI_5BIT_MASK, value) /* Offset 96+23=119, Len 5 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* Fifth 32-bit dword, bits 128:159 (Revision 2 of _PLD only) */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_VERT_OFFSET(dword) ACPI_GET_BITS (dword, 0, ACPI_16BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_VERT_OFFSET(dword,value) ACPI_SET_BITS (dword, 0, ACPI_16BIT_MASK, value) /* Offset 128+0=128, Len 16 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_GET_HORIZ_OFFSET(dword) ACPI_GET_BITS (dword, 16, ACPI_16BIT_MASK)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_PLD_SET_HORIZ_OFFSET(dword,value) ACPI_SET_BITS (dword, 16, ACPI_16BIT_MASK, value) /* Offset 128+16=144, Len 16 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#endif /* ACBUFFER_H */