acbuffer.h revision 1.1.1.1.10.2
1 1.1.1.1.10.2 tls /****************************************************************************** 2 1.1.1.1.10.2 tls * 3 1.1.1.1.10.2 tls * Name: acbuffer.h - Support for buffers returned by ACPI predefined names 4 1.1.1.1.10.2 tls * 5 1.1.1.1.10.2 tls *****************************************************************************/ 6 1.1.1.1.10.2 tls 7 1.1.1.1.10.2 tls /* 8 1.1.1.1.10.2 tls * Copyright (C) 2000 - 2013, Intel Corp. 9 1.1.1.1.10.2 tls * All rights reserved. 10 1.1.1.1.10.2 tls * 11 1.1.1.1.10.2 tls * Redistribution and use in source and binary forms, with or without 12 1.1.1.1.10.2 tls * modification, are permitted provided that the following conditions 13 1.1.1.1.10.2 tls * are met: 14 1.1.1.1.10.2 tls * 1. Redistributions of source code must retain the above copyright 15 1.1.1.1.10.2 tls * notice, this list of conditions, and the following disclaimer, 16 1.1.1.1.10.2 tls * without modification. 17 1.1.1.1.10.2 tls * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 1.1.1.1.10.2 tls * substantially similar to the "NO WARRANTY" disclaimer below 19 1.1.1.1.10.2 tls * ("Disclaimer") and any redistribution must be conditioned upon 20 1.1.1.1.10.2 tls * including a substantially similar Disclaimer requirement for further 21 1.1.1.1.10.2 tls * binary redistribution. 22 1.1.1.1.10.2 tls * 3. Neither the names of the above-listed copyright holders nor the names 23 1.1.1.1.10.2 tls * of any contributors may be used to endorse or promote products derived 24 1.1.1.1.10.2 tls * from this software without specific prior written permission. 25 1.1.1.1.10.2 tls * 26 1.1.1.1.10.2 tls * Alternatively, this software may be distributed under the terms of the 27 1.1.1.1.10.2 tls * GNU General Public License ("GPL") version 2 as published by the Free 28 1.1.1.1.10.2 tls * Software Foundation. 29 1.1.1.1.10.2 tls * 30 1.1.1.1.10.2 tls * NO WARRANTY 31 1.1.1.1.10.2 tls * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 1.1.1.1.10.2 tls * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 1.1.1.1.10.2 tls * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 1.1.1.1.10.2 tls * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 1.1.1.1.10.2 tls * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 1.1.1.1.10.2 tls * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 1.1.1.1.10.2 tls * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 1.1.1.1.10.2 tls * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 1.1.1.1.10.2 tls * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 1.1.1.1.10.2 tls * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 1.1.1.1.10.2 tls * POSSIBILITY OF SUCH DAMAGES. 42 1.1.1.1.10.2 tls */ 43 1.1.1.1.10.2 tls 44 1.1.1.1.10.2 tls #ifndef __ACBUFFER_H__ 45 1.1.1.1.10.2 tls #define __ACBUFFER_H__ 46 1.1.1.1.10.2 tls 47 1.1.1.1.10.2 tls /* 48 1.1.1.1.10.2 tls * Contains buffer structures for these predefined names: 49 1.1.1.1.10.2 tls * _FDE, _GRT, _GTM, _PLD, _SRT 50 1.1.1.1.10.2 tls */ 51 1.1.1.1.10.2 tls 52 1.1.1.1.10.2 tls /* 53 1.1.1.1.10.2 tls * Note: C bitfields are not used for this reason: 54 1.1.1.1.10.2 tls * 55 1.1.1.1.10.2 tls * "Bitfields are great and easy to read, but unfortunately the C language 56 1.1.1.1.10.2 tls * does not specify the layout of bitfields in memory, which means they are 57 1.1.1.1.10.2 tls * essentially useless for dealing with packed data in on-disk formats or 58 1.1.1.1.10.2 tls * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me, 59 1.1.1.1.10.2 tls * this decision was a design error in C. Ritchie could have picked an order 60 1.1.1.1.10.2 tls * and stuck with it." Norman Ramsey. 61 1.1.1.1.10.2 tls * See http://stackoverflow.com/a/1053662/41661 62 1.1.1.1.10.2 tls */ 63 1.1.1.1.10.2 tls 64 1.1.1.1.10.2 tls 65 1.1.1.1.10.2 tls /* _FDE return value */ 66 1.1.1.1.10.2 tls 67 1.1.1.1.10.2 tls typedef struct acpi_fde_info 68 1.1.1.1.10.2 tls { 69 1.1.1.1.10.2 tls UINT32 Floppy0; 70 1.1.1.1.10.2 tls UINT32 Floppy1; 71 1.1.1.1.10.2 tls UINT32 Floppy2; 72 1.1.1.1.10.2 tls UINT32 Floppy3; 73 1.1.1.1.10.2 tls UINT32 Tape; 74 1.1.1.1.10.2 tls 75 1.1.1.1.10.2 tls } ACPI_FDE_INFO; 76 1.1.1.1.10.2 tls 77 1.1.1.1.10.2 tls /* 78 1.1.1.1.10.2 tls * _GRT return value 79 1.1.1.1.10.2 tls * _SRT input value 80 1.1.1.1.10.2 tls */ 81 1.1.1.1.10.2 tls typedef struct acpi_grt_info 82 1.1.1.1.10.2 tls { 83 1.1.1.1.10.2 tls UINT16 Year; 84 1.1.1.1.10.2 tls UINT8 Month; 85 1.1.1.1.10.2 tls UINT8 Day; 86 1.1.1.1.10.2 tls UINT8 Hour; 87 1.1.1.1.10.2 tls UINT8 Minute; 88 1.1.1.1.10.2 tls UINT8 Second; 89 1.1.1.1.10.2 tls UINT8 Valid; 90 1.1.1.1.10.2 tls UINT16 Milliseconds; 91 1.1.1.1.10.2 tls UINT16 Timezone; 92 1.1.1.1.10.2 tls UINT8 Daylight; 93 1.1.1.1.10.2 tls UINT8 Reserved[3]; 94 1.1.1.1.10.2 tls 95 1.1.1.1.10.2 tls } ACPI_GRT_INFO; 96 1.1.1.1.10.2 tls 97 1.1.1.1.10.2 tls /* _GTM return value */ 98 1.1.1.1.10.2 tls 99 1.1.1.1.10.2 tls typedef struct acpi_gtm_info 100 1.1.1.1.10.2 tls { 101 1.1.1.1.10.2 tls UINT32 PioSpeed0; 102 1.1.1.1.10.2 tls UINT32 DmaSpeed0; 103 1.1.1.1.10.2 tls UINT32 PioSpeed1; 104 1.1.1.1.10.2 tls UINT32 DmaSpeed1; 105 1.1.1.1.10.2 tls UINT32 Flags; 106 1.1.1.1.10.2 tls 107 1.1.1.1.10.2 tls } ACPI_GTM_INFO; 108 1.1.1.1.10.2 tls 109 1.1.1.1.10.2 tls /* 110 1.1.1.1.10.2 tls * Formatted _PLD return value. The minimum size is a package containing 111 1.1.1.1.10.2 tls * one buffer. 112 1.1.1.1.10.2 tls * Revision 1: Buffer is 16 bytes (128 bits) 113 1.1.1.1.10.2 tls * Revision 2: Buffer is 20 bytes (160 bits) 114 1.1.1.1.10.2 tls * 115 1.1.1.1.10.2 tls * Note: This structure is returned from the AcpiDecodePldBuffer 116 1.1.1.1.10.2 tls * interface. 117 1.1.1.1.10.2 tls */ 118 1.1.1.1.10.2 tls typedef struct acpi_pld_info 119 1.1.1.1.10.2 tls { 120 1.1.1.1.10.2 tls UINT8 Revision; 121 1.1.1.1.10.2 tls UINT8 IgnoreColor; 122 1.1.1.1.10.2 tls UINT32 Color; 123 1.1.1.1.10.2 tls UINT16 Width; 124 1.1.1.1.10.2 tls UINT16 Height; 125 1.1.1.1.10.2 tls UINT8 UserVisible; 126 1.1.1.1.10.2 tls UINT8 Dock; 127 1.1.1.1.10.2 tls UINT8 Lid; 128 1.1.1.1.10.2 tls UINT8 Panel; 129 1.1.1.1.10.2 tls UINT8 VerticalPosition; 130 1.1.1.1.10.2 tls UINT8 HorizontalPosition; 131 1.1.1.1.10.2 tls UINT8 Shape; 132 1.1.1.1.10.2 tls UINT8 GroupOrientation; 133 1.1.1.1.10.2 tls UINT8 GroupToken; 134 1.1.1.1.10.2 tls UINT8 GroupPosition; 135 1.1.1.1.10.2 tls UINT8 Bay; 136 1.1.1.1.10.2 tls UINT8 Ejectable; 137 1.1.1.1.10.2 tls UINT8 OspmEjectRequired; 138 1.1.1.1.10.2 tls UINT8 CabinetNumber; 139 1.1.1.1.10.2 tls UINT8 CardCageNumber; 140 1.1.1.1.10.2 tls UINT8 Reference; 141 1.1.1.1.10.2 tls UINT8 Rotation; 142 1.1.1.1.10.2 tls UINT8 Order; 143 1.1.1.1.10.2 tls UINT8 Reserved; 144 1.1.1.1.10.2 tls UINT16 VerticalOffset; 145 1.1.1.1.10.2 tls UINT16 HorizontalOffset; 146 1.1.1.1.10.2 tls 147 1.1.1.1.10.2 tls } ACPI_PLD_INFO; 148 1.1.1.1.10.2 tls 149 1.1.1.1.10.2 tls 150 1.1.1.1.10.2 tls /* 151 1.1.1.1.10.2 tls * Macros to: 152 1.1.1.1.10.2 tls * 1) Convert a _PLD buffer to internal ACPI_PLD_INFO format - ACPI_PLD_GET* 153 1.1.1.1.10.2 tls * (Used by AcpiDecodePldBuffer) 154 1.1.1.1.10.2 tls * 2) Construct a _PLD buffer - ACPI_PLD_SET* 155 1.1.1.1.10.2 tls * (Intended for BIOS use only) 156 1.1.1.1.10.2 tls */ 157 1.1.1.1.10.2 tls #define ACPI_PLD_REV1_BUFFER_SIZE 16 /* For Revision 1 of the buffer (From ACPI spec) */ 158 1.1.1.1.10.2 tls #define ACPI_PLD_BUFFER_SIZE 20 /* For Revision 2 of the buffer (From ACPI spec) */ 159 1.1.1.1.10.2 tls 160 1.1.1.1.10.2 tls /* First 32-bit dword, bits 0:32 */ 161 1.1.1.1.10.2 tls 162 1.1.1.1.10.2 tls #define ACPI_PLD_GET_REVISION(dword) ACPI_GET_BITS (dword, 0, ACPI_7BIT_MASK) 163 1.1.1.1.10.2 tls #define ACPI_PLD_SET_REVISION(dword,value) ACPI_SET_BITS (dword, 0, ACPI_7BIT_MASK, value) /* Offset 0, Len 7 */ 164 1.1.1.1.10.2 tls 165 1.1.1.1.10.2 tls #define ACPI_PLD_GET_IGNORE_COLOR(dword) ACPI_GET_BITS (dword, 7, ACPI_1BIT_MASK) 166 1.1.1.1.10.2 tls #define ACPI_PLD_SET_IGNORE_COLOR(dword,value) ACPI_SET_BITS (dword, 7, ACPI_1BIT_MASK, value) /* Offset 7, Len 1 */ 167 1.1.1.1.10.2 tls 168 1.1.1.1.10.2 tls #define ACPI_PLD_GET_COLOR(dword) ACPI_GET_BITS (dword, 8, ACPI_24BIT_MASK) 169 1.1.1.1.10.2 tls #define ACPI_PLD_SET_COLOR(dword,value) ACPI_SET_BITS (dword, 8, ACPI_24BIT_MASK, value) /* Offset 8, Len 24 */ 170 1.1.1.1.10.2 tls 171 1.1.1.1.10.2 tls /* Second 32-bit dword, bits 33:63 */ 172 1.1.1.1.10.2 tls 173 1.1.1.1.10.2 tls #define ACPI_PLD_GET_WIDTH(dword) ACPI_GET_BITS (dword, 0, ACPI_16BIT_MASK) 174 1.1.1.1.10.2 tls #define ACPI_PLD_SET_WIDTH(dword,value) ACPI_SET_BITS (dword, 0, ACPI_16BIT_MASK, value) /* Offset 32+0=32, Len 16 */ 175 1.1.1.1.10.2 tls 176 1.1.1.1.10.2 tls #define ACPI_PLD_GET_HEIGHT(dword) ACPI_GET_BITS (dword, 16, ACPI_16BIT_MASK) 177 1.1.1.1.10.2 tls #define ACPI_PLD_SET_HEIGHT(dword,value) ACPI_SET_BITS (dword, 16, ACPI_16BIT_MASK, value) /* Offset 32+16=48, Len 16 */ 178 1.1.1.1.10.2 tls 179 1.1.1.1.10.2 tls /* Third 32-bit dword, bits 64:95 */ 180 1.1.1.1.10.2 tls 181 1.1.1.1.10.2 tls #define ACPI_PLD_GET_USER_VISIBLE(dword) ACPI_GET_BITS (dword, 0, ACPI_1BIT_MASK) 182 1.1.1.1.10.2 tls #define ACPI_PLD_SET_USER_VISIBLE(dword,value) ACPI_SET_BITS (dword, 0, ACPI_1BIT_MASK, value) /* Offset 64+0=64, Len 1 */ 183 1.1.1.1.10.2 tls 184 1.1.1.1.10.2 tls #define ACPI_PLD_GET_DOCK(dword) ACPI_GET_BITS (dword, 1, ACPI_1BIT_MASK) 185 1.1.1.1.10.2 tls #define ACPI_PLD_SET_DOCK(dword,value) ACPI_SET_BITS (dword, 1, ACPI_1BIT_MASK, value) /* Offset 64+1=65, Len 1 */ 186 1.1.1.1.10.2 tls 187 1.1.1.1.10.2 tls #define ACPI_PLD_GET_LID(dword) ACPI_GET_BITS (dword, 2, ACPI_1BIT_MASK) 188 1.1.1.1.10.2 tls #define ACPI_PLD_SET_LID(dword,value) ACPI_SET_BITS (dword, 2, ACPI_1BIT_MASK, value) /* Offset 64+2=66, Len 1 */ 189 1.1.1.1.10.2 tls 190 1.1.1.1.10.2 tls #define ACPI_PLD_GET_PANEL(dword) ACPI_GET_BITS (dword, 3, ACPI_3BIT_MASK) 191 1.1.1.1.10.2 tls #define ACPI_PLD_SET_PANEL(dword,value) ACPI_SET_BITS (dword, 3, ACPI_3BIT_MASK, value) /* Offset 64+3=67, Len 3 */ 192 1.1.1.1.10.2 tls 193 1.1.1.1.10.2 tls #define ACPI_PLD_GET_VERTICAL(dword) ACPI_GET_BITS (dword, 6, ACPI_2BIT_MASK) 194 1.1.1.1.10.2 tls #define ACPI_PLD_SET_VERTICAL(dword,value) ACPI_SET_BITS (dword, 6, ACPI_2BIT_MASK, value) /* Offset 64+6=70, Len 2 */ 195 1.1.1.1.10.2 tls 196 1.1.1.1.10.2 tls #define ACPI_PLD_GET_HORIZONTAL(dword) ACPI_GET_BITS (dword, 8, ACPI_2BIT_MASK) 197 1.1.1.1.10.2 tls #define ACPI_PLD_SET_HORIZONTAL(dword,value) ACPI_SET_BITS (dword, 8, ACPI_2BIT_MASK, value) /* Offset 64+8=72, Len 2 */ 198 1.1.1.1.10.2 tls 199 1.1.1.1.10.2 tls #define ACPI_PLD_GET_SHAPE(dword) ACPI_GET_BITS (dword, 10, ACPI_4BIT_MASK) 200 1.1.1.1.10.2 tls #define ACPI_PLD_SET_SHAPE(dword,value) ACPI_SET_BITS (dword, 10, ACPI_4BIT_MASK, value) /* Offset 64+10=74, Len 4 */ 201 1.1.1.1.10.2 tls 202 1.1.1.1.10.2 tls #define ACPI_PLD_GET_ORIENTATION(dword) ACPI_GET_BITS (dword, 14, ACPI_1BIT_MASK) 203 1.1.1.1.10.2 tls #define ACPI_PLD_SET_ORIENTATION(dword,value) ACPI_SET_BITS (dword, 14, ACPI_1BIT_MASK, value) /* Offset 64+14=78, Len 1 */ 204 1.1.1.1.10.2 tls 205 1.1.1.1.10.2 tls #define ACPI_PLD_GET_TOKEN(dword) ACPI_GET_BITS (dword, 15, ACPI_8BIT_MASK) 206 1.1.1.1.10.2 tls #define ACPI_PLD_SET_TOKEN(dword,value) ACPI_SET_BITS (dword, 15, ACPI_8BIT_MASK, value) /* Offset 64+15=79, Len 8 */ 207 1.1.1.1.10.2 tls 208 1.1.1.1.10.2 tls #define ACPI_PLD_GET_POSITION(dword) ACPI_GET_BITS (dword, 23, ACPI_8BIT_MASK) 209 1.1.1.1.10.2 tls #define ACPI_PLD_SET_POSITION(dword,value) ACPI_SET_BITS (dword, 23, ACPI_8BIT_MASK, value) /* Offset 64+23=87, Len 8 */ 210 1.1.1.1.10.2 tls 211 1.1.1.1.10.2 tls #define ACPI_PLD_GET_BAY(dword) ACPI_GET_BITS (dword, 31, ACPI_1BIT_MASK) 212 1.1.1.1.10.2 tls #define ACPI_PLD_SET_BAY(dword,value) ACPI_SET_BITS (dword, 31, ACPI_1BIT_MASK, value) /* Offset 64+31=95, Len 1 */ 213 1.1.1.1.10.2 tls 214 1.1.1.1.10.2 tls /* Fourth 32-bit dword, bits 96:127 */ 215 1.1.1.1.10.2 tls 216 1.1.1.1.10.2 tls #define ACPI_PLD_GET_EJECTABLE(dword) ACPI_GET_BITS (dword, 0, ACPI_1BIT_MASK) 217 1.1.1.1.10.2 tls #define ACPI_PLD_SET_EJECTABLE(dword,value) ACPI_SET_BITS (dword, 0, ACPI_1BIT_MASK, value) /* Offset 96+0=96, Len 1 */ 218 1.1.1.1.10.2 tls 219 1.1.1.1.10.2 tls #define ACPI_PLD_GET_OSPM_EJECT(dword) ACPI_GET_BITS (dword, 1, ACPI_1BIT_MASK) 220 1.1.1.1.10.2 tls #define ACPI_PLD_SET_OSPM_EJECT(dword,value) ACPI_SET_BITS (dword, 1, ACPI_1BIT_MASK, value) /* Offset 96+1=97, Len 1 */ 221 1.1.1.1.10.2 tls 222 1.1.1.1.10.2 tls #define ACPI_PLD_GET_CABINET(dword) ACPI_GET_BITS (dword, 2, ACPI_8BIT_MASK) 223 1.1.1.1.10.2 tls #define ACPI_PLD_SET_CABINET(dword,value) ACPI_SET_BITS (dword, 2, ACPI_8BIT_MASK, value) /* Offset 96+2=98, Len 8 */ 224 1.1.1.1.10.2 tls 225 1.1.1.1.10.2 tls #define ACPI_PLD_GET_CARD_CAGE(dword) ACPI_GET_BITS (dword, 10, ACPI_8BIT_MASK) 226 1.1.1.1.10.2 tls #define ACPI_PLD_SET_CARD_CAGE(dword,value) ACPI_SET_BITS (dword, 10, ACPI_8BIT_MASK, value) /* Offset 96+10=106, Len 8 */ 227 1.1.1.1.10.2 tls 228 1.1.1.1.10.2 tls #define ACPI_PLD_GET_REFERENCE(dword) ACPI_GET_BITS (dword, 18, ACPI_1BIT_MASK) 229 1.1.1.1.10.2 tls #define ACPI_PLD_SET_REFERENCE(dword,value) ACPI_SET_BITS (dword, 18, ACPI_1BIT_MASK, value) /* Offset 96+18=114, Len 1 */ 230 1.1.1.1.10.2 tls 231 1.1.1.1.10.2 tls #define ACPI_PLD_GET_ROTATION(dword) ACPI_GET_BITS (dword, 19, ACPI_4BIT_MASK) 232 1.1.1.1.10.2 tls #define ACPI_PLD_SET_ROTATION(dword,value) ACPI_SET_BITS (dword, 19, ACPI_4BIT_MASK, value) /* Offset 96+19=115, Len 4 */ 233 1.1.1.1.10.2 tls 234 1.1.1.1.10.2 tls #define ACPI_PLD_GET_ORDER(dword) ACPI_GET_BITS (dword, 23, ACPI_5BIT_MASK) 235 1.1.1.1.10.2 tls #define ACPI_PLD_SET_ORDER(dword,value) ACPI_SET_BITS (dword, 23, ACPI_5BIT_MASK, value) /* Offset 96+23=119, Len 5 */ 236 1.1.1.1.10.2 tls 237 1.1.1.1.10.2 tls /* Fifth 32-bit dword, bits 128:159 (Revision 2 of _PLD only) */ 238 1.1.1.1.10.2 tls 239 1.1.1.1.10.2 tls #define ACPI_PLD_GET_VERT_OFFSET(dword) ACPI_GET_BITS (dword, 0, ACPI_16BIT_MASK) 240 1.1.1.1.10.2 tls #define ACPI_PLD_SET_VERT_OFFSET(dword,value) ACPI_SET_BITS (dword, 0, ACPI_16BIT_MASK, value) /* Offset 128+0=128, Len 16 */ 241 1.1.1.1.10.2 tls 242 1.1.1.1.10.2 tls #define ACPI_PLD_GET_HORIZ_OFFSET(dword) ACPI_GET_BITS (dword, 16, ACPI_16BIT_MASK) 243 1.1.1.1.10.2 tls #define ACPI_PLD_SET_HORIZ_OFFSET(dword,value) ACPI_SET_BITS (dword, 16, ACPI_16BIT_MASK, value) /* Offset 128+16=144, Len 16 */ 244 1.1.1.1.10.2 tls 245 1.1.1.1.10.2 tls 246 1.1.1.1.10.2 tls #endif /* ACBUFFER_H */ 247
Indexes created Fri Oct 03 02:09:57 GMT 2025