1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ 2 /****************************************************************************** 3 * 4 * Name: acbuffer.h - Support for buffers returned by ACPI predefined names 5 * 6 * Copyright (C) 2000 - 2023, Intel Corp. 7 * 8 *****************************************************************************/ 9 10 #ifndef __ACBUFFER_H__ 11 #define __ACBUFFER_H__ 12 13 /* 14 * Contains buffer structures for these predefined names: 15 * _FDE, _GRT, _GTM, _PLD, _SRT 16 */ 17 18 /* 19 * Note: C bitfields are not used for this reason: 20 * 21 * "Bitfields are great and easy to read, but unfortunately the C language 22 * does not specify the layout of bitfields in memory, which means they are 23 * essentially useless for dealing with packed data in on-disk formats or 24 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me, 25 * this decision was a design error in C. Ritchie could have picked an order 26 * and stuck with it." Norman Ramsey. 27 * See http://stackoverflow.com/a/1053662/41661 28 */ 29 30 /* _FDE return value */ 31 32 struct acpi_fde_info { 33 u32 floppy0; 34 u32 floppy1; 35 u32 floppy2; 36 u32 floppy3; 37 u32 tape; 38 }; 39 40 /* 41 * _GRT return value 42 * _SRT input value 43 */ 44 struct acpi_grt_info { 45 u16 year; 46 u8 month; 47 u8 day; 48 u8 hour; 49 u8 minute; 50 u8 second; 51 u8 valid; 52 u16 milliseconds; 53 u16 timezone; 54 u8 daylight; 55 u8 reserved[3]; 56 }; 57 58 /* _GTM return value */ 59 60 struct acpi_gtm_info { 61 u32 pio_speed0; 62 u32 dma_speed0; 63 u32 pio_speed1; 64 u32 dma_speed1; 65 u32 flags; 66 }; 67 68 /* 69 * Formatted _PLD return value. The minimum size is a package containing 70 * one buffer. 71 * Revision 1: Buffer is 16 bytes (128 bits) 72 * Revision 2: Buffer is 20 bytes (160 bits) 73 * 74 * Note: This structure is returned from the acpi_decode_pld_buffer 75 * interface. 76 */ 77 struct acpi_pld_info { 78 u8 revision; 79 u8 ignore_color; 80 u8 red; 81 u8 green; 82 u8 blue; 83 u16 width; 84 u16 height; 85 u8 user_visible; 86 u8 dock; 87 u8 lid; 88 u8 panel; 89 u8 vertical_position; 90 u8 horizontal_position; 91 u8 shape; 92 u8 group_orientation; 93 u8 group_token; 94 u8 group_position; 95 u8 bay; 96 u8 ejectable; 97 u8 ospm_eject_required; 98 u8 cabinet_number; 99 u8 card_cage_number; 100 u8 reference; 101 u8 rotation; 102 u8 order; 103 u8 reserved; 104 u16 vertical_offset; 105 u16 horizontal_offset; 106 }; 107 108 /* 109 * Macros to: 110 * 1) Convert a _PLD buffer to internal struct acpi_pld_info format - ACPI_PLD_GET* 111 * (Used by acpi_decode_pld_buffer) 112 * 2) Construct a _PLD buffer - ACPI_PLD_SET* 113 * (Intended for BIOS use only) 114 */ 115 #define ACPI_PLD_REV1_BUFFER_SIZE 16 /* For Revision 1 of the buffer (From ACPI spec) */ 116 #define ACPI_PLD_REV2_BUFFER_SIZE 20 /* For Revision 2 of the buffer (From ACPI spec) */ 117 #define ACPI_PLD_BUFFER_SIZE 20 /* For Revision 2 of the buffer (From ACPI spec) */ 118 119 /* First 32-bit dword, bits 0:32 */ 120 121 #define ACPI_PLD_GET_REVISION(dword) ACPI_GET_BITS (dword, 0, ACPI_7BIT_MASK) 122 #define ACPI_PLD_SET_REVISION(dword,value) ACPI_SET_BITS (dword, 0, ACPI_7BIT_MASK, value) /* Offset 0, Len 7 */ 123 124 #define ACPI_PLD_GET_IGNORE_COLOR(dword) ACPI_GET_BITS (dword, 7, ACPI_1BIT_MASK) 125 #define ACPI_PLD_SET_IGNORE_COLOR(dword,value) ACPI_SET_BITS (dword, 7, ACPI_1BIT_MASK, value) /* Offset 7, Len 1 */ 126 127 #define ACPI_PLD_GET_RED(dword) ACPI_GET_BITS (dword, 8, ACPI_8BIT_MASK) 128 #define ACPI_PLD_SET_RED(dword,value) ACPI_SET_BITS (dword, 8, ACPI_8BIT_MASK, value) /* Offset 8, Len 8 */ 129 130 #define ACPI_PLD_GET_GREEN(dword) ACPI_GET_BITS (dword, 16, ACPI_8BIT_MASK) 131 #define ACPI_PLD_SET_GREEN(dword,value) ACPI_SET_BITS (dword, 16, ACPI_8BIT_MASK, value) /* Offset 16, Len 8 */ 132 133 #define ACPI_PLD_GET_BLUE(dword) ACPI_GET_BITS (dword, 24, ACPI_8BIT_MASK) 134 #define ACPI_PLD_SET_BLUE(dword,value) ACPI_SET_BITS (dword, 24, ACPI_8BIT_MASK, value) /* Offset 24, Len 8 */ 135 136 /* Second 32-bit dword, bits 33:63 */ 137 138 #define ACPI_PLD_GET_WIDTH(dword) ACPI_GET_BITS (dword, 0, ACPI_16BIT_MASK) 139 #define ACPI_PLD_SET_WIDTH(dword,value) ACPI_SET_BITS (dword, 0, ACPI_16BIT_MASK, value) /* Offset 32+0=32, Len 16 */ 140 141 #define ACPI_PLD_GET_HEIGHT(dword) ACPI_GET_BITS (dword, 16, ACPI_16BIT_MASK) 142 #define ACPI_PLD_SET_HEIGHT(dword,value) ACPI_SET_BITS (dword, 16, ACPI_16BIT_MASK, value) /* Offset 32+16=48, Len 16 */ 143 144 /* Third 32-bit dword, bits 64:95 */ 145 146 #define ACPI_PLD_GET_USER_VISIBLE(dword) ACPI_GET_BITS (dword, 0, ACPI_1BIT_MASK) 147 #define ACPI_PLD_SET_USER_VISIBLE(dword,value) ACPI_SET_BITS (dword, 0, ACPI_1BIT_MASK, value) /* Offset 64+0=64, Len 1 */ 148 149 #define ACPI_PLD_GET_DOCK(dword) ACPI_GET_BITS (dword, 1, ACPI_1BIT_MASK) 150 #define ACPI_PLD_SET_DOCK(dword,value) ACPI_SET_BITS (dword, 1, ACPI_1BIT_MASK, value) /* Offset 64+1=65, Len 1 */ 151 152 #define ACPI_PLD_GET_LID(dword) ACPI_GET_BITS (dword, 2, ACPI_1BIT_MASK) 153 #define ACPI_PLD_SET_LID(dword,value) ACPI_SET_BITS (dword, 2, ACPI_1BIT_MASK, value) /* Offset 64+2=66, Len 1 */ 154 155 #define ACPI_PLD_GET_PANEL(dword) ACPI_GET_BITS (dword, 3, ACPI_3BIT_MASK) 156 #define ACPI_PLD_SET_PANEL(dword,value) ACPI_SET_BITS (dword, 3, ACPI_3BIT_MASK, value) /* Offset 64+3=67, Len 3 */ 157 158 #define ACPI_PLD_GET_VERTICAL(dword) ACPI_GET_BITS (dword, 6, ACPI_2BIT_MASK) 159 #define ACPI_PLD_SET_VERTICAL(dword,value) ACPI_SET_BITS (dword, 6, ACPI_2BIT_MASK, value) /* Offset 64+6=70, Len 2 */ 160 161 #define ACPI_PLD_GET_HORIZONTAL(dword) ACPI_GET_BITS (dword, 8, ACPI_2BIT_MASK) 162 #define ACPI_PLD_SET_HORIZONTAL(dword,value) ACPI_SET_BITS (dword, 8, ACPI_2BIT_MASK, value) /* Offset 64+8=72, Len 2 */ 163 164 #define ACPI_PLD_GET_SHAPE(dword) ACPI_GET_BITS (dword, 10, ACPI_4BIT_MASK) 165 #define ACPI_PLD_SET_SHAPE(dword,value) ACPI_SET_BITS (dword, 10, ACPI_4BIT_MASK, value) /* Offset 64+10=74, Len 4 */ 166 167 #define ACPI_PLD_GET_ORIENTATION(dword) ACPI_GET_BITS (dword, 14, ACPI_1BIT_MASK) 168 #define ACPI_PLD_SET_ORIENTATION(dword,value) ACPI_SET_BITS (dword, 14, ACPI_1BIT_MASK, value) /* Offset 64+14=78, Len 1 */ 169 170 #define ACPI_PLD_GET_TOKEN(dword) ACPI_GET_BITS (dword, 15, ACPI_8BIT_MASK) 171 #define ACPI_PLD_SET_TOKEN(dword,value) ACPI_SET_BITS (dword, 15, ACPI_8BIT_MASK, value) /* Offset 64+15=79, Len 8 */ 172 173 #define ACPI_PLD_GET_POSITION(dword) ACPI_GET_BITS (dword, 23, ACPI_8BIT_MASK) 174 #define ACPI_PLD_SET_POSITION(dword,value) ACPI_SET_BITS (dword, 23, ACPI_8BIT_MASK, value) /* Offset 64+23=87, Len 8 */ 175 176 #define ACPI_PLD_GET_BAY(dword) ACPI_GET_BITS (dword, 31, ACPI_1BIT_MASK) 177 #define ACPI_PLD_SET_BAY(dword,value) ACPI_SET_BITS (dword, 31, ACPI_1BIT_MASK, value) /* Offset 64+31=95, Len 1 */ 178 179 /* Fourth 32-bit dword, bits 96:127 */ 180 181 #define ACPI_PLD_GET_EJECTABLE(dword) ACPI_GET_BITS (dword, 0, ACPI_1BIT_MASK) 182 #define ACPI_PLD_SET_EJECTABLE(dword,value) ACPI_SET_BITS (dword, 0, ACPI_1BIT_MASK, value) /* Offset 96+0=96, Len 1 */ 183 184 #define ACPI_PLD_GET_OSPM_EJECT(dword) ACPI_GET_BITS (dword, 1, ACPI_1BIT_MASK) 185 #define ACPI_PLD_SET_OSPM_EJECT(dword,value) ACPI_SET_BITS (dword, 1, ACPI_1BIT_MASK, value) /* Offset 96+1=97, Len 1 */ 186 187 #define ACPI_PLD_GET_CABINET(dword) ACPI_GET_BITS (dword, 2, ACPI_8BIT_MASK) 188 #define ACPI_PLD_SET_CABINET(dword,value) ACPI_SET_BITS (dword, 2, ACPI_8BIT_MASK, value) /* Offset 96+2=98, Len 8 */ 189 190 #define ACPI_PLD_GET_CARD_CAGE(dword) ACPI_GET_BITS (dword, 10, ACPI_8BIT_MASK) 191 #define ACPI_PLD_SET_CARD_CAGE(dword,value) ACPI_SET_BITS (dword, 10, ACPI_8BIT_MASK, value) /* Offset 96+10=106, Len 8 */ 192 193 #define ACPI_PLD_GET_REFERENCE(dword) ACPI_GET_BITS (dword, 18, ACPI_1BIT_MASK) 194 #define ACPI_PLD_SET_REFERENCE(dword,value) ACPI_SET_BITS (dword, 18, ACPI_1BIT_MASK, value) /* Offset 96+18=114, Len 1 */ 195 196 #define ACPI_PLD_GET_ROTATION(dword) ACPI_GET_BITS (dword, 19, ACPI_4BIT_MASK) 197 #define ACPI_PLD_SET_ROTATION(dword,value) ACPI_SET_BITS (dword, 19, ACPI_4BIT_MASK, value) /* Offset 96+19=115, Len 4 */ 198 199 #define ACPI_PLD_GET_ORDER(dword) ACPI_GET_BITS (dword, 23, ACPI_5BIT_MASK) 200 #define ACPI_PLD_SET_ORDER(dword,value) ACPI_SET_BITS (dword, 23, ACPI_5BIT_MASK, value) /* Offset 96+23=119, Len 5 */ 201 202 /* Fifth 32-bit dword, bits 128:159 (Revision 2 of _PLD only) */ 203 204 #define ACPI_PLD_GET_VERT_OFFSET(dword) ACPI_GET_BITS (dword, 0, ACPI_16BIT_MASK) 205 #define ACPI_PLD_SET_VERT_OFFSET(dword,value) ACPI_SET_BITS (dword, 0, ACPI_16BIT_MASK, value) /* Offset 128+0=128, Len 16 */ 206 207 #define ACPI_PLD_GET_HORIZ_OFFSET(dword) ACPI_GET_BITS (dword, 16, ACPI_16BIT_MASK) 208 #define ACPI_PLD_SET_HORIZ_OFFSET(dword,value) ACPI_SET_BITS (dword, 16, ACPI_16BIT_MASK, value) /* Offset 128+16=144, Len 16 */ 209 210 /* Panel position defined in _PLD section of ACPI Specification 6.3 */ 211 212 #define ACPI_PLD_PANEL_TOP 0 213 #define ACPI_PLD_PANEL_BOTTOM 1 214 #define ACPI_PLD_PANEL_LEFT 2 215 #define ACPI_PLD_PANEL_RIGHT 3 216 #define ACPI_PLD_PANEL_FRONT 4 217 #define ACPI_PLD_PANEL_BACK 5 218 #define ACPI_PLD_PANEL_UNKNOWN 6 219 220 #endif /* ACBUFFER_H */ 221