include/acpi/acbuffer.h

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