10d02842fSSascha Wildner /****************************************************************************** 20d02842fSSascha Wildner * 30d02842fSSascha Wildner * Name: acbuffer.h - Support for buffers returned by ACPI predefined names 40d02842fSSascha Wildner * 50d02842fSSascha Wildner *****************************************************************************/ 60d02842fSSascha Wildner 70d02842fSSascha Wildner /* 820294b7eSSascha Wildner * Copyright (C) 2000 - 2014, Intel Corp. 90d02842fSSascha Wildner * All rights reserved. 100d02842fSSascha Wildner * 110d02842fSSascha Wildner * Redistribution and use in source and binary forms, with or without 120d02842fSSascha Wildner * modification, are permitted provided that the following conditions 130d02842fSSascha Wildner * are met: 140d02842fSSascha Wildner * 1. Redistributions of source code must retain the above copyright 150d02842fSSascha Wildner * notice, this list of conditions, and the following disclaimer, 160d02842fSSascha Wildner * without modification. 170d02842fSSascha Wildner * 2. Redistributions in binary form must reproduce at minimum a disclaimer 180d02842fSSascha Wildner * substantially similar to the "NO WARRANTY" disclaimer below 190d02842fSSascha Wildner * ("Disclaimer") and any redistribution must be conditioned upon 200d02842fSSascha Wildner * including a substantially similar Disclaimer requirement for further 210d02842fSSascha Wildner * binary redistribution. 220d02842fSSascha Wildner * 3. Neither the names of the above-listed copyright holders nor the names 230d02842fSSascha Wildner * of any contributors may be used to endorse or promote products derived 240d02842fSSascha Wildner * from this software without specific prior written permission. 250d02842fSSascha Wildner * 260d02842fSSascha Wildner * Alternatively, this software may be distributed under the terms of the 270d02842fSSascha Wildner * GNU General Public License ("GPL") version 2 as published by the Free 280d02842fSSascha Wildner * Software Foundation. 290d02842fSSascha Wildner * 300d02842fSSascha Wildner * NO WARRANTY 310d02842fSSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 320d02842fSSascha Wildner * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 330d02842fSSascha Wildner * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 340d02842fSSascha Wildner * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 350d02842fSSascha Wildner * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 360d02842fSSascha Wildner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 370d02842fSSascha Wildner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 380d02842fSSascha Wildner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 390d02842fSSascha Wildner * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 400d02842fSSascha Wildner * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 410d02842fSSascha Wildner * POSSIBILITY OF SUCH DAMAGES. 420d02842fSSascha Wildner */ 430d02842fSSascha Wildner 440d02842fSSascha Wildner #ifndef __ACBUFFER_H__ 450d02842fSSascha Wildner #define __ACBUFFER_H__ 460d02842fSSascha Wildner 470d02842fSSascha Wildner /* 480d02842fSSascha Wildner * Contains buffer structures for these predefined names: 490d02842fSSascha Wildner * _FDE, _GRT, _GTM, _PLD, _SRT 500d02842fSSascha Wildner */ 510d02842fSSascha Wildner 520d02842fSSascha Wildner /* 530d02842fSSascha Wildner * Note: C bitfields are not used for this reason: 540d02842fSSascha Wildner * 550d02842fSSascha Wildner * "Bitfields are great and easy to read, but unfortunately the C language 560d02842fSSascha Wildner * does not specify the layout of bitfields in memory, which means they are 570d02842fSSascha Wildner * essentially useless for dealing with packed data in on-disk formats or 580d02842fSSascha Wildner * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me, 590d02842fSSascha Wildner * this decision was a design error in C. Ritchie could have picked an order 600d02842fSSascha Wildner * and stuck with it." Norman Ramsey. 610d02842fSSascha Wildner * See http://stackoverflow.com/a/1053662/41661 620d02842fSSascha Wildner */ 630d02842fSSascha Wildner 640d02842fSSascha Wildner 650d02842fSSascha Wildner /* _FDE return value */ 660d02842fSSascha Wildner 670d02842fSSascha Wildner typedef struct acpi_fde_info 680d02842fSSascha Wildner { 690d02842fSSascha Wildner UINT32 Floppy0; 700d02842fSSascha Wildner UINT32 Floppy1; 710d02842fSSascha Wildner UINT32 Floppy2; 720d02842fSSascha Wildner UINT32 Floppy3; 730d02842fSSascha Wildner UINT32 Tape; 740d02842fSSascha Wildner 750d02842fSSascha Wildner } ACPI_FDE_INFO; 760d02842fSSascha Wildner 770d02842fSSascha Wildner /* 780d02842fSSascha Wildner * _GRT return value 790d02842fSSascha Wildner * _SRT input value 800d02842fSSascha Wildner */ 810d02842fSSascha Wildner typedef struct acpi_grt_info 820d02842fSSascha Wildner { 830d02842fSSascha Wildner UINT16 Year; 840d02842fSSascha Wildner UINT8 Month; 850d02842fSSascha Wildner UINT8 Day; 860d02842fSSascha Wildner UINT8 Hour; 870d02842fSSascha Wildner UINT8 Minute; 880d02842fSSascha Wildner UINT8 Second; 890d02842fSSascha Wildner UINT8 Valid; 900d02842fSSascha Wildner UINT16 Milliseconds; 910d02842fSSascha Wildner UINT16 Timezone; 920d02842fSSascha Wildner UINT8 Daylight; 930d02842fSSascha Wildner UINT8 Reserved[3]; 940d02842fSSascha Wildner 950d02842fSSascha Wildner } ACPI_GRT_INFO; 960d02842fSSascha Wildner 970d02842fSSascha Wildner /* _GTM return value */ 980d02842fSSascha Wildner 990d02842fSSascha Wildner typedef struct acpi_gtm_info 1000d02842fSSascha Wildner { 1010d02842fSSascha Wildner UINT32 PioSpeed0; 1020d02842fSSascha Wildner UINT32 DmaSpeed0; 1030d02842fSSascha Wildner UINT32 PioSpeed1; 1040d02842fSSascha Wildner UINT32 DmaSpeed1; 1050d02842fSSascha Wildner UINT32 Flags; 1060d02842fSSascha Wildner 1070d02842fSSascha Wildner } ACPI_GTM_INFO; 1080d02842fSSascha Wildner 1090d02842fSSascha Wildner /* 1100d02842fSSascha Wildner * Formatted _PLD return value. The minimum size is a package containing 1110d02842fSSascha Wildner * one buffer. 1120d02842fSSascha Wildner * Revision 1: Buffer is 16 bytes (128 bits) 1130d02842fSSascha Wildner * Revision 2: Buffer is 20 bytes (160 bits) 1140d02842fSSascha Wildner * 1150d02842fSSascha Wildner * Note: This structure is returned from the AcpiDecodePldBuffer 1160d02842fSSascha Wildner * interface. 1170d02842fSSascha Wildner */ 1180d02842fSSascha Wildner typedef struct acpi_pld_info 1190d02842fSSascha Wildner { 1200d02842fSSascha Wildner UINT8 Revision; 1210d02842fSSascha Wildner UINT8 IgnoreColor; 122*2e2672b8SSascha Wildner UINT8 Red; 123*2e2672b8SSascha Wildner UINT8 Green; 124*2e2672b8SSascha Wildner UINT8 Blue; 1250d02842fSSascha Wildner UINT16 Width; 1260d02842fSSascha Wildner UINT16 Height; 1270d02842fSSascha Wildner UINT8 UserVisible; 1280d02842fSSascha Wildner UINT8 Dock; 1290d02842fSSascha Wildner UINT8 Lid; 1300d02842fSSascha Wildner UINT8 Panel; 1310d02842fSSascha Wildner UINT8 VerticalPosition; 1320d02842fSSascha Wildner UINT8 HorizontalPosition; 1330d02842fSSascha Wildner UINT8 Shape; 1340d02842fSSascha Wildner UINT8 GroupOrientation; 1350d02842fSSascha Wildner UINT8 GroupToken; 1360d02842fSSascha Wildner UINT8 GroupPosition; 1370d02842fSSascha Wildner UINT8 Bay; 1380d02842fSSascha Wildner UINT8 Ejectable; 1390d02842fSSascha Wildner UINT8 OspmEjectRequired; 1400d02842fSSascha Wildner UINT8 CabinetNumber; 1410d02842fSSascha Wildner UINT8 CardCageNumber; 1420d02842fSSascha Wildner UINT8 Reference; 1430d02842fSSascha Wildner UINT8 Rotation; 1440d02842fSSascha Wildner UINT8 Order; 1450d02842fSSascha Wildner UINT8 Reserved; 1460d02842fSSascha Wildner UINT16 VerticalOffset; 1470d02842fSSascha Wildner UINT16 HorizontalOffset; 1480d02842fSSascha Wildner 1490d02842fSSascha Wildner } ACPI_PLD_INFO; 1500d02842fSSascha Wildner 1510d02842fSSascha Wildner 1520d02842fSSascha Wildner /* 1530d02842fSSascha Wildner * Macros to: 1540d02842fSSascha Wildner * 1) Convert a _PLD buffer to internal ACPI_PLD_INFO format - ACPI_PLD_GET* 1550d02842fSSascha Wildner * (Used by AcpiDecodePldBuffer) 1560d02842fSSascha Wildner * 2) Construct a _PLD buffer - ACPI_PLD_SET* 1570d02842fSSascha Wildner * (Intended for BIOS use only) 1580d02842fSSascha Wildner */ 1590d02842fSSascha Wildner #define ACPI_PLD_REV1_BUFFER_SIZE 16 /* For Revision 1 of the buffer (From ACPI spec) */ 1600d02842fSSascha Wildner #define ACPI_PLD_BUFFER_SIZE 20 /* For Revision 2 of the buffer (From ACPI spec) */ 1610d02842fSSascha Wildner 1620d02842fSSascha Wildner /* First 32-bit dword, bits 0:32 */ 1630d02842fSSascha Wildner 1640d02842fSSascha Wildner #define ACPI_PLD_GET_REVISION(dword) ACPI_GET_BITS (dword, 0, ACPI_7BIT_MASK) 1650d02842fSSascha Wildner #define ACPI_PLD_SET_REVISION(dword,value) ACPI_SET_BITS (dword, 0, ACPI_7BIT_MASK, value) /* Offset 0, Len 7 */ 1660d02842fSSascha Wildner 1670d02842fSSascha Wildner #define ACPI_PLD_GET_IGNORE_COLOR(dword) ACPI_GET_BITS (dword, 7, ACPI_1BIT_MASK) 1680d02842fSSascha Wildner #define ACPI_PLD_SET_IGNORE_COLOR(dword,value) ACPI_SET_BITS (dword, 7, ACPI_1BIT_MASK, value) /* Offset 7, Len 1 */ 1690d02842fSSascha Wildner 170*2e2672b8SSascha Wildner #define ACPI_PLD_GET_RED(dword) ACPI_GET_BITS (dword, 8, ACPI_8BIT_MASK) 171*2e2672b8SSascha Wildner #define ACPI_PLD_SET_RED(dword,value) ACPI_SET_BITS (dword, 8, ACPI_8BIT_MASK, value) /* Offset 8, Len 8 */ 172*2e2672b8SSascha Wildner 173*2e2672b8SSascha Wildner #define ACPI_PLD_GET_GREEN(dword) ACPI_GET_BITS (dword, 16, ACPI_8BIT_MASK) 174*2e2672b8SSascha Wildner #define ACPI_PLD_SET_GREEN(dword,value) ACPI_SET_BITS (dword, 16, ACPI_8BIT_MASK, value) /* Offset 16, Len 8 */ 175*2e2672b8SSascha Wildner 176*2e2672b8SSascha Wildner #define ACPI_PLD_GET_BLUE(dword) ACPI_GET_BITS (dword, 24, ACPI_8BIT_MASK) 177*2e2672b8SSascha Wildner #define ACPI_PLD_SET_BLUE(dword,value) ACPI_SET_BITS (dword, 24, ACPI_8BIT_MASK, value) /* Offset 24, Len 8 */ 1780d02842fSSascha Wildner 1790d02842fSSascha Wildner /* Second 32-bit dword, bits 33:63 */ 1800d02842fSSascha Wildner 1810d02842fSSascha Wildner #define ACPI_PLD_GET_WIDTH(dword) ACPI_GET_BITS (dword, 0, ACPI_16BIT_MASK) 1820d02842fSSascha Wildner #define ACPI_PLD_SET_WIDTH(dword,value) ACPI_SET_BITS (dword, 0, ACPI_16BIT_MASK, value) /* Offset 32+0=32, Len 16 */ 1830d02842fSSascha Wildner 1840d02842fSSascha Wildner #define ACPI_PLD_GET_HEIGHT(dword) ACPI_GET_BITS (dword, 16, ACPI_16BIT_MASK) 1850d02842fSSascha Wildner #define ACPI_PLD_SET_HEIGHT(dword,value) ACPI_SET_BITS (dword, 16, ACPI_16BIT_MASK, value) /* Offset 32+16=48, Len 16 */ 1860d02842fSSascha Wildner 1870d02842fSSascha Wildner /* Third 32-bit dword, bits 64:95 */ 1880d02842fSSascha Wildner 1890d02842fSSascha Wildner #define ACPI_PLD_GET_USER_VISIBLE(dword) ACPI_GET_BITS (dword, 0, ACPI_1BIT_MASK) 1900d02842fSSascha Wildner #define ACPI_PLD_SET_USER_VISIBLE(dword,value) ACPI_SET_BITS (dword, 0, ACPI_1BIT_MASK, value) /* Offset 64+0=64, Len 1 */ 1910d02842fSSascha Wildner 1920d02842fSSascha Wildner #define ACPI_PLD_GET_DOCK(dword) ACPI_GET_BITS (dword, 1, ACPI_1BIT_MASK) 1930d02842fSSascha Wildner #define ACPI_PLD_SET_DOCK(dword,value) ACPI_SET_BITS (dword, 1, ACPI_1BIT_MASK, value) /* Offset 64+1=65, Len 1 */ 1940d02842fSSascha Wildner 1950d02842fSSascha Wildner #define ACPI_PLD_GET_LID(dword) ACPI_GET_BITS (dword, 2, ACPI_1BIT_MASK) 1960d02842fSSascha Wildner #define ACPI_PLD_SET_LID(dword,value) ACPI_SET_BITS (dword, 2, ACPI_1BIT_MASK, value) /* Offset 64+2=66, Len 1 */ 1970d02842fSSascha Wildner 1980d02842fSSascha Wildner #define ACPI_PLD_GET_PANEL(dword) ACPI_GET_BITS (dword, 3, ACPI_3BIT_MASK) 1990d02842fSSascha Wildner #define ACPI_PLD_SET_PANEL(dword,value) ACPI_SET_BITS (dword, 3, ACPI_3BIT_MASK, value) /* Offset 64+3=67, Len 3 */ 2000d02842fSSascha Wildner 2010d02842fSSascha Wildner #define ACPI_PLD_GET_VERTICAL(dword) ACPI_GET_BITS (dword, 6, ACPI_2BIT_MASK) 2020d02842fSSascha Wildner #define ACPI_PLD_SET_VERTICAL(dword,value) ACPI_SET_BITS (dword, 6, ACPI_2BIT_MASK, value) /* Offset 64+6=70, Len 2 */ 2030d02842fSSascha Wildner 2040d02842fSSascha Wildner #define ACPI_PLD_GET_HORIZONTAL(dword) ACPI_GET_BITS (dword, 8, ACPI_2BIT_MASK) 2050d02842fSSascha Wildner #define ACPI_PLD_SET_HORIZONTAL(dword,value) ACPI_SET_BITS (dword, 8, ACPI_2BIT_MASK, value) /* Offset 64+8=72, Len 2 */ 2060d02842fSSascha Wildner 2070d02842fSSascha Wildner #define ACPI_PLD_GET_SHAPE(dword) ACPI_GET_BITS (dword, 10, ACPI_4BIT_MASK) 2080d02842fSSascha Wildner #define ACPI_PLD_SET_SHAPE(dword,value) ACPI_SET_BITS (dword, 10, ACPI_4BIT_MASK, value) /* Offset 64+10=74, Len 4 */ 2090d02842fSSascha Wildner 2100d02842fSSascha Wildner #define ACPI_PLD_GET_ORIENTATION(dword) ACPI_GET_BITS (dword, 14, ACPI_1BIT_MASK) 2110d02842fSSascha Wildner #define ACPI_PLD_SET_ORIENTATION(dword,value) ACPI_SET_BITS (dword, 14, ACPI_1BIT_MASK, value) /* Offset 64+14=78, Len 1 */ 2120d02842fSSascha Wildner 2130d02842fSSascha Wildner #define ACPI_PLD_GET_TOKEN(dword) ACPI_GET_BITS (dword, 15, ACPI_8BIT_MASK) 2140d02842fSSascha Wildner #define ACPI_PLD_SET_TOKEN(dword,value) ACPI_SET_BITS (dword, 15, ACPI_8BIT_MASK, value) /* Offset 64+15=79, Len 8 */ 2150d02842fSSascha Wildner 2160d02842fSSascha Wildner #define ACPI_PLD_GET_POSITION(dword) ACPI_GET_BITS (dword, 23, ACPI_8BIT_MASK) 2170d02842fSSascha Wildner #define ACPI_PLD_SET_POSITION(dword,value) ACPI_SET_BITS (dword, 23, ACPI_8BIT_MASK, value) /* Offset 64+23=87, Len 8 */ 2180d02842fSSascha Wildner 2190d02842fSSascha Wildner #define ACPI_PLD_GET_BAY(dword) ACPI_GET_BITS (dword, 31, ACPI_1BIT_MASK) 2200d02842fSSascha Wildner #define ACPI_PLD_SET_BAY(dword,value) ACPI_SET_BITS (dword, 31, ACPI_1BIT_MASK, value) /* Offset 64+31=95, Len 1 */ 2210d02842fSSascha Wildner 2220d02842fSSascha Wildner /* Fourth 32-bit dword, bits 96:127 */ 2230d02842fSSascha Wildner 2240d02842fSSascha Wildner #define ACPI_PLD_GET_EJECTABLE(dword) ACPI_GET_BITS (dword, 0, ACPI_1BIT_MASK) 2250d02842fSSascha Wildner #define ACPI_PLD_SET_EJECTABLE(dword,value) ACPI_SET_BITS (dword, 0, ACPI_1BIT_MASK, value) /* Offset 96+0=96, Len 1 */ 2260d02842fSSascha Wildner 2270d02842fSSascha Wildner #define ACPI_PLD_GET_OSPM_EJECT(dword) ACPI_GET_BITS (dword, 1, ACPI_1BIT_MASK) 2280d02842fSSascha Wildner #define ACPI_PLD_SET_OSPM_EJECT(dword,value) ACPI_SET_BITS (dword, 1, ACPI_1BIT_MASK, value) /* Offset 96+1=97, Len 1 */ 2290d02842fSSascha Wildner 2300d02842fSSascha Wildner #define ACPI_PLD_GET_CABINET(dword) ACPI_GET_BITS (dword, 2, ACPI_8BIT_MASK) 2310d02842fSSascha Wildner #define ACPI_PLD_SET_CABINET(dword,value) ACPI_SET_BITS (dword, 2, ACPI_8BIT_MASK, value) /* Offset 96+2=98, Len 8 */ 2320d02842fSSascha Wildner 2330d02842fSSascha Wildner #define ACPI_PLD_GET_CARD_CAGE(dword) ACPI_GET_BITS (dword, 10, ACPI_8BIT_MASK) 2340d02842fSSascha Wildner #define ACPI_PLD_SET_CARD_CAGE(dword,value) ACPI_SET_BITS (dword, 10, ACPI_8BIT_MASK, value) /* Offset 96+10=106, Len 8 */ 2350d02842fSSascha Wildner 2360d02842fSSascha Wildner #define ACPI_PLD_GET_REFERENCE(dword) ACPI_GET_BITS (dword, 18, ACPI_1BIT_MASK) 2370d02842fSSascha Wildner #define ACPI_PLD_SET_REFERENCE(dword,value) ACPI_SET_BITS (dword, 18, ACPI_1BIT_MASK, value) /* Offset 96+18=114, Len 1 */ 2380d02842fSSascha Wildner 2390d02842fSSascha Wildner #define ACPI_PLD_GET_ROTATION(dword) ACPI_GET_BITS (dword, 19, ACPI_4BIT_MASK) 2400d02842fSSascha Wildner #define ACPI_PLD_SET_ROTATION(dword,value) ACPI_SET_BITS (dword, 19, ACPI_4BIT_MASK, value) /* Offset 96+19=115, Len 4 */ 2410d02842fSSascha Wildner 2420d02842fSSascha Wildner #define ACPI_PLD_GET_ORDER(dword) ACPI_GET_BITS (dword, 23, ACPI_5BIT_MASK) 2430d02842fSSascha Wildner #define ACPI_PLD_SET_ORDER(dword,value) ACPI_SET_BITS (dword, 23, ACPI_5BIT_MASK, value) /* Offset 96+23=119, Len 5 */ 2440d02842fSSascha Wildner 2450d02842fSSascha Wildner /* Fifth 32-bit dword, bits 128:159 (Revision 2 of _PLD only) */ 2460d02842fSSascha Wildner 2470d02842fSSascha Wildner #define ACPI_PLD_GET_VERT_OFFSET(dword) ACPI_GET_BITS (dword, 0, ACPI_16BIT_MASK) 2480d02842fSSascha Wildner #define ACPI_PLD_SET_VERT_OFFSET(dword,value) ACPI_SET_BITS (dword, 0, ACPI_16BIT_MASK, value) /* Offset 128+0=128, Len 16 */ 2490d02842fSSascha Wildner 2500d02842fSSascha Wildner #define ACPI_PLD_GET_HORIZ_OFFSET(dword) ACPI_GET_BITS (dword, 16, ACPI_16BIT_MASK) 2510d02842fSSascha Wildner #define ACPI_PLD_SET_HORIZ_OFFSET(dword,value) ACPI_SET_BITS (dword, 16, ACPI_16BIT_MASK, value) /* Offset 128+16=144, Len 16 */ 2520d02842fSSascha Wildner 2530d02842fSSascha Wildner 2540d02842fSSascha Wildner #endif /* ACBUFFER_H */ 255