Home | History | Annotate | Line # | Download | only in include
acmacros.h revision 1.5.2.2
      1      1.1    jruoho /******************************************************************************
      2      1.1    jruoho  *
      3      1.1    jruoho  * Name: acmacros.h - C macros for the entire subsystem.
      4      1.1    jruoho  *
      5      1.1    jruoho  *****************************************************************************/
      6      1.1    jruoho 
      7      1.3    jruoho /*
      8  1.5.2.1     skrll  * Copyright (C) 2000 - 2015, Intel Corp.
      9      1.1    jruoho  * All rights reserved.
     10      1.1    jruoho  *
     11      1.3    jruoho  * Redistribution and use in source and binary forms, with or without
     12      1.3    jruoho  * modification, are permitted provided that the following conditions
     13      1.3    jruoho  * are met:
     14      1.3    jruoho  * 1. Redistributions of source code must retain the above copyright
     15      1.3    jruoho  *    notice, this list of conditions, and the following disclaimer,
     16      1.3    jruoho  *    without modification.
     17      1.3    jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18      1.3    jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
     19      1.3    jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
     20      1.3    jruoho  *    including a substantially similar Disclaimer requirement for further
     21      1.3    jruoho  *    binary redistribution.
     22      1.3    jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
     23      1.3    jruoho  *    of any contributors may be used to endorse or promote products derived
     24      1.3    jruoho  *    from this software without specific prior written permission.
     25      1.3    jruoho  *
     26      1.3    jruoho  * Alternatively, this software may be distributed under the terms of the
     27      1.3    jruoho  * GNU General Public License ("GPL") version 2 as published by the Free
     28      1.3    jruoho  * Software Foundation.
     29      1.3    jruoho  *
     30      1.3    jruoho  * NO WARRANTY
     31      1.3    jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32      1.3    jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33      1.3    jruoho  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34      1.3    jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35      1.3    jruoho  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36      1.3    jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37      1.3    jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38      1.3    jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39      1.3    jruoho  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40      1.3    jruoho  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41      1.3    jruoho  * POSSIBILITY OF SUCH DAMAGES.
     42      1.3    jruoho  */
     43      1.1    jruoho 
     44      1.1    jruoho #ifndef __ACMACROS_H__
     45      1.1    jruoho #define __ACMACROS_H__
     46      1.1    jruoho 
     47      1.1    jruoho 
     48      1.1    jruoho /*
     49      1.1    jruoho  * Extract data using a pointer. Any more than a byte and we
     50      1.1    jruoho  * get into potential aligment issues -- see the STORE macros below.
     51      1.1    jruoho  * Use with care.
     52      1.1    jruoho  */
     53      1.4  christos #define ACPI_CAST8(ptr)                 ACPI_CAST_PTR (UINT8, (ptr))
     54      1.4  christos #define ACPI_CAST16(ptr)                ACPI_CAST_PTR (UINT16, (ptr))
     55      1.4  christos #define ACPI_CAST32(ptr)                ACPI_CAST_PTR (UINT32, (ptr))
     56      1.4  christos #define ACPI_CAST64(ptr)                ACPI_CAST_PTR (UINT64, (ptr))
     57      1.4  christos #define ACPI_GET8(ptr)                  (*ACPI_CAST8 (ptr))
     58      1.4  christos #define ACPI_GET16(ptr)                 (*ACPI_CAST16 (ptr))
     59      1.4  christos #define ACPI_GET32(ptr)                 (*ACPI_CAST32 (ptr))
     60      1.4  christos #define ACPI_GET64(ptr)                 (*ACPI_CAST64 (ptr))
     61      1.4  christos #define ACPI_SET8(ptr, val)             (*ACPI_CAST8 (ptr) = (UINT8) (val))
     62      1.4  christos #define ACPI_SET16(ptr, val)            (*ACPI_CAST16 (ptr) = (UINT16) (val))
     63      1.4  christos #define ACPI_SET32(ptr, val)            (*ACPI_CAST32 (ptr) = (UINT32) (val))
     64      1.4  christos #define ACPI_SET64(ptr, val)            (*ACPI_CAST64 (ptr) = (UINT64) (val))
     65      1.1    jruoho 
     66      1.1    jruoho /*
     67  1.5.2.1     skrll  * printf() format helper. This macros is a workaround for the difficulties
     68      1.5  christos  * with emitting 64-bit integers and 64-bit pointers with the same code
     69      1.5  christos  * for both 32-bit and 64-bit hosts.
     70      1.1    jruoho  */
     71      1.1    jruoho #define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i), ACPI_LODWORD(i)
     72      1.1    jruoho 
     73      1.1    jruoho 
     74      1.1    jruoho /*
     75      1.1    jruoho  * Macros for moving data around to/from buffers that are possibly unaligned.
     76      1.1    jruoho  * If the hardware supports the transfer of unaligned data, just do the store.
     77      1.1    jruoho  * Otherwise, we have to move one byte at a time.
     78      1.1    jruoho  */
     79      1.1    jruoho #ifdef ACPI_BIG_ENDIAN
     80      1.1    jruoho /*
     81      1.1    jruoho  * Macros for big-endian machines
     82      1.1    jruoho  */
     83      1.1    jruoho 
     84      1.1    jruoho /* These macros reverse the bytes during the move, converting little-endian to big endian */
     85      1.1    jruoho 
     86      1.1    jruoho                                                      /* Big Endian      <==        Little Endian */
     87      1.1    jruoho                                                      /*  Hi...Lo                     Lo...Hi     */
     88      1.1    jruoho /* 16-bit source, 16/32/64 destination */
     89      1.1    jruoho 
     90      1.2    jruoho #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[1];\
     91      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[0];}
     92      1.1    jruoho 
     93      1.1    jruoho #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d))=0;\
     94      1.2    jruoho                                            ((UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[1];\
     95      1.2    jruoho                                            ((UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[0];}
     96      1.1    jruoho 
     97      1.1    jruoho #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
     98      1.2    jruoho                                            ((UINT8 *)(void *)(d))[6] = ((const UINT8 *)(const void *)(s))[1];\
     99      1.2    jruoho                                            ((UINT8 *)(void *)(d))[7] = ((const UINT8 *)(const void *)(s))[0];}
    100      1.1    jruoho 
    101      1.1    jruoho /* 32-bit source, 16/32/64 destination */
    102      1.1    jruoho 
    103      1.1    jruoho #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
    104      1.1    jruoho 
    105      1.2    jruoho #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[3];\
    106      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[2];\
    107      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[1];\
    108      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[0];}
    109      1.1    jruoho 
    110      1.1    jruoho #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
    111      1.2    jruoho                                            ((UINT8 *)(void *)(d))[4] = ((const UINT8 *)(const void *)(s))[3];\
    112      1.2    jruoho                                            ((UINT8 *)(void *)(d))[5] = ((const UINT8 *)(const void *)(s))[2];\
    113      1.2    jruoho                                            ((UINT8 *)(void *)(d))[6] = ((const UINT8 *)(const void *)(s))[1];\
    114      1.2    jruoho                                            ((UINT8 *)(void *)(d))[7] = ((const UINT8 *)(const void *)(s))[0];}
    115      1.1    jruoho 
    116      1.1    jruoho /* 64-bit source, 16/32/64 destination */
    117      1.1    jruoho 
    118      1.1    jruoho #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
    119      1.1    jruoho 
    120      1.1    jruoho #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
    121      1.1    jruoho 
    122      1.2    jruoho #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[7];\
    123      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[6];\
    124      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[5];\
    125      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[4];\
    126      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[4] = ((const UINT8 *)(const void *)(s))[3];\
    127      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[5] = ((const UINT8 *)(const void *)(s))[2];\
    128      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[6] = ((const UINT8 *)(const void *)(s))[1];\
    129      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[7] = ((const UINT8 *)(const void *)(s))[0];}
    130      1.1    jruoho #else
    131      1.1    jruoho /*
    132      1.1    jruoho  * Macros for little-endian machines
    133      1.1    jruoho  */
    134      1.1    jruoho 
    135      1.1    jruoho #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
    136      1.1    jruoho 
    137      1.1    jruoho /* The hardware supports unaligned transfers, just do the little-endian move */
    138      1.1    jruoho 
    139      1.1    jruoho /* 16-bit source, 16/32/64 destination */
    140      1.1    jruoho 
    141      1.2    jruoho #define ACPI_MOVE_16_TO_16(d, s)        *(UINT16 *)(void *)(d) = *(const UINT16 *)(const void *)(s)
    142      1.2    jruoho #define ACPI_MOVE_16_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(const UINT16 *)(const void *)(s)
    143      1.2    jruoho #define ACPI_MOVE_16_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(const UINT16 *)(const void *)(s)
    144      1.1    jruoho 
    145      1.1    jruoho /* 32-bit source, 16/32/64 destination */
    146      1.1    jruoho 
    147      1.1    jruoho #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
    148      1.2    jruoho #define ACPI_MOVE_32_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(const UINT32 *)(const void *)(s)
    149      1.2    jruoho #define ACPI_MOVE_32_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(const UINT32 *)(const void *)(s)
    150      1.1    jruoho 
    151      1.1    jruoho /* 64-bit source, 16/32/64 destination */
    152      1.1    jruoho 
    153      1.1    jruoho #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
    154      1.1    jruoho #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
    155      1.2    jruoho #define ACPI_MOVE_64_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(const UINT64 *)(const void *)(s)
    156      1.1    jruoho 
    157      1.1    jruoho #else
    158      1.1    jruoho /*
    159      1.1    jruoho  * The hardware does not support unaligned transfers. We must move the
    160      1.1    jruoho  * data one byte at a time. These macros work whether the source or
    161      1.1    jruoho  * the destination (or both) is/are unaligned. (Little-endian move)
    162      1.1    jruoho  */
    163      1.1    jruoho 
    164      1.1    jruoho /* 16-bit source, 16/32/64 destination */
    165      1.1    jruoho 
    166      1.2    jruoho #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[0];\
    167      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[1];}
    168      1.1    jruoho 
    169      1.1    jruoho #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
    170      1.1    jruoho #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
    171      1.1    jruoho 
    172      1.1    jruoho /* 32-bit source, 16/32/64 destination */
    173      1.1    jruoho 
    174      1.1    jruoho #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
    175      1.1    jruoho 
    176      1.2    jruoho #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[0];\
    177      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[1];\
    178      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[2];\
    179      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[3];}
    180      1.1    jruoho 
    181      1.1    jruoho #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
    182      1.1    jruoho 
    183      1.1    jruoho /* 64-bit source, 16/32/64 destination */
    184      1.1    jruoho 
    185      1.1    jruoho #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
    186      1.1    jruoho #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
    187      1.2    jruoho #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((const UINT8 *)(const void *)(s))[0];\
    188      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[1] = ((const UINT8 *)(const void *)(s))[1];\
    189      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[2] = ((const UINT8 *)(const void *)(s))[2];\
    190      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[3] = ((const UINT8 *)(const void *)(s))[3];\
    191      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[4] = ((const UINT8 *)(const void *)(s))[4];\
    192      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[5] = ((const UINT8 *)(const void *)(s))[5];\
    193      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[6] = ((const UINT8 *)(const void *)(s))[6];\
    194      1.2    jruoho                                          ((  UINT8 *)(void *)(d))[7] = ((const UINT8 *)(const void *)(s))[7];}
    195      1.1    jruoho #endif
    196      1.1    jruoho #endif
    197      1.1    jruoho 
    198      1.1    jruoho 
    199      1.1    jruoho /*
    200      1.1    jruoho  * Fast power-of-two math macros for non-optimized compilers
    201      1.1    jruoho  */
    202      1.1    jruoho #define _ACPI_DIV(value, PowerOf2)      ((UINT32) ((value) >> (PowerOf2)))
    203      1.1    jruoho #define _ACPI_MUL(value, PowerOf2)      ((UINT32) ((value) << (PowerOf2)))
    204      1.1    jruoho #define _ACPI_MOD(value, Divisor)       ((UINT32) ((value) & ((Divisor) -1)))
    205      1.1    jruoho 
    206      1.1    jruoho #define ACPI_DIV_2(a)                   _ACPI_DIV(a, 1)
    207      1.1    jruoho #define ACPI_MUL_2(a)                   _ACPI_MUL(a, 1)
    208      1.1    jruoho #define ACPI_MOD_2(a)                   _ACPI_MOD(a, 2)
    209      1.1    jruoho 
    210      1.1    jruoho #define ACPI_DIV_4(a)                   _ACPI_DIV(a, 2)
    211      1.1    jruoho #define ACPI_MUL_4(a)                   _ACPI_MUL(a, 2)
    212      1.1    jruoho #define ACPI_MOD_4(a)                   _ACPI_MOD(a, 4)
    213      1.1    jruoho 
    214      1.1    jruoho #define ACPI_DIV_8(a)                   _ACPI_DIV(a, 3)
    215      1.1    jruoho #define ACPI_MUL_8(a)                   _ACPI_MUL(a, 3)
    216      1.1    jruoho #define ACPI_MOD_8(a)                   _ACPI_MOD(a, 8)
    217      1.1    jruoho 
    218      1.1    jruoho #define ACPI_DIV_16(a)                  _ACPI_DIV(a, 4)
    219      1.1    jruoho #define ACPI_MUL_16(a)                  _ACPI_MUL(a, 4)
    220      1.1    jruoho #define ACPI_MOD_16(a)                  _ACPI_MOD(a, 16)
    221      1.1    jruoho 
    222      1.1    jruoho #define ACPI_DIV_32(a)                  _ACPI_DIV(a, 5)
    223      1.1    jruoho #define ACPI_MUL_32(a)                  _ACPI_MUL(a, 5)
    224      1.1    jruoho #define ACPI_MOD_32(a)                  _ACPI_MOD(a, 32)
    225      1.1    jruoho 
    226  1.5.2.2     skrll /* Test for ASCII character */
    227  1.5.2.2     skrll 
    228  1.5.2.2     skrll #define ACPI_IS_ASCII(c)                ((c) < 0x80)
    229  1.5.2.2     skrll 
    230  1.5.2.2     skrll /* Signed integers */
    231  1.5.2.2     skrll 
    232  1.5.2.2     skrll #define ACPI_SIGN_POSITIVE              0
    233  1.5.2.2     skrll #define ACPI_SIGN_NEGATIVE              1
    234  1.5.2.2     skrll 
    235  1.5.2.2     skrll 
    236      1.1    jruoho /*
    237      1.1    jruoho  * Rounding macros (Power of two boundaries only)
    238      1.1    jruoho  */
    239      1.1    jruoho #define ACPI_ROUND_DOWN(value, boundary)    (((ACPI_SIZE)(value)) & \
    240      1.1    jruoho                                                 (~(((ACPI_SIZE) boundary)-1)))
    241      1.1    jruoho 
    242      1.1    jruoho #define ACPI_ROUND_UP(value, boundary)      ((((ACPI_SIZE)(value)) + \
    243      1.1    jruoho                                                 (((ACPI_SIZE) boundary)-1)) & \
    244      1.1    jruoho                                                 (~(((ACPI_SIZE) boundary)-1)))
    245      1.1    jruoho 
    246      1.1    jruoho /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */
    247      1.1    jruoho 
    248      1.1    jruoho #define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a, 4)
    249      1.1    jruoho #define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a, 8)
    250      1.1    jruoho #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE))
    251      1.1    jruoho 
    252      1.1    jruoho #define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a, 4)
    253      1.1    jruoho #define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a, 8)
    254      1.1    jruoho #define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a, sizeof(ACPI_SIZE))
    255      1.1    jruoho 
    256      1.1    jruoho #define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
    257      1.1    jruoho #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))
    258      1.1    jruoho 
    259      1.1    jruoho #define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)
    260      1.1    jruoho 
    261      1.1    jruoho /* Generic (non-power-of-two) rounding */
    262      1.1    jruoho 
    263      1.1    jruoho #define ACPI_ROUND_UP_TO(value, boundary)   (((value) + ((boundary)-1)) / (boundary))
    264      1.1    jruoho 
    265      1.1    jruoho #define ACPI_IS_MISALIGNED(value)           (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1))
    266      1.1    jruoho 
    267      1.1    jruoho /*
    268      1.1    jruoho  * Bitmask creation
    269      1.1    jruoho  * Bit positions start at zero.
    270      1.1    jruoho  * MASK_BITS_ABOVE creates a mask starting AT the position and above
    271      1.1    jruoho  * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
    272      1.1    jruoho  */
    273      1.1    jruoho #define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_UINT64_MAX) << ((UINT32) (position))))
    274      1.1    jruoho #define ACPI_MASK_BITS_BELOW(position)      ((ACPI_UINT64_MAX) << ((UINT32) (position)))
    275      1.1    jruoho 
    276      1.1    jruoho /* Bitfields within ACPI registers */
    277      1.1    jruoho 
    278      1.4  christos #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \
    279      1.4  christos     ((Val << Pos) & Mask)
    280      1.1    jruoho 
    281      1.4  christos #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \
    282      1.4  christos     Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask)
    283      1.4  christos 
    284      1.4  christos #define ACPI_INSERT_BITS(Target, Mask, Source) \
    285      1.4  christos     Target = ((Target & (~(Mask))) | (Source & Mask))
    286      1.4  christos 
    287      1.4  christos /* Generic bitfield macros and masks */
    288      1.4  christos 
    289      1.4  christos #define ACPI_GET_BITS(SourcePtr, Position, Mask) \
    290      1.4  christos     ((*SourcePtr >> Position) & Mask)
    291      1.4  christos 
    292      1.4  christos #define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \
    293      1.4  christos     (*TargetPtr |= ((Value & Mask) << Position))
    294      1.4  christos 
    295      1.4  christos #define ACPI_1BIT_MASK      0x00000001
    296      1.4  christos #define ACPI_2BIT_MASK      0x00000003
    297      1.4  christos #define ACPI_3BIT_MASK      0x00000007
    298      1.4  christos #define ACPI_4BIT_MASK      0x0000000F
    299      1.4  christos #define ACPI_5BIT_MASK      0x0000001F
    300      1.4  christos #define ACPI_6BIT_MASK      0x0000003F
    301      1.4  christos #define ACPI_7BIT_MASK      0x0000007F
    302      1.4  christos #define ACPI_8BIT_MASK      0x000000FF
    303      1.4  christos #define ACPI_16BIT_MASK     0x0000FFFF
    304      1.4  christos #define ACPI_24BIT_MASK     0x00FFFFFF
    305      1.4  christos 
    306      1.4  christos /* Macros to extract flag bits from position zero */
    307      1.4  christos 
    308      1.4  christos #define ACPI_GET_1BIT_FLAG(Value)                   ((Value) & ACPI_1BIT_MASK)
    309      1.4  christos #define ACPI_GET_2BIT_FLAG(Value)                   ((Value) & ACPI_2BIT_MASK)
    310      1.4  christos #define ACPI_GET_3BIT_FLAG(Value)                   ((Value) & ACPI_3BIT_MASK)
    311      1.4  christos #define ACPI_GET_4BIT_FLAG(Value)                   ((Value) & ACPI_4BIT_MASK)
    312      1.4  christos 
    313      1.4  christos /* Macros to extract flag bits from position one and above */
    314      1.4  christos 
    315      1.4  christos #define ACPI_EXTRACT_1BIT_FLAG(Field, Position)     (ACPI_GET_1BIT_FLAG ((Field) >> Position))
    316      1.4  christos #define ACPI_EXTRACT_2BIT_FLAG(Field, Position)     (ACPI_GET_2BIT_FLAG ((Field) >> Position))
    317      1.4  christos #define ACPI_EXTRACT_3BIT_FLAG(Field, Position)     (ACPI_GET_3BIT_FLAG ((Field) >> Position))
    318      1.4  christos #define ACPI_EXTRACT_4BIT_FLAG(Field, Position)     (ACPI_GET_4BIT_FLAG ((Field) >> Position))
    319      1.4  christos 
    320      1.4  christos /* ACPI Pathname helpers */
    321      1.4  christos 
    322      1.4  christos #define ACPI_IS_ROOT_PREFIX(c)      ((c) == (UINT8) 0x5C) /* Backslash */
    323      1.4  christos #define ACPI_IS_PARENT_PREFIX(c)    ((c) == (UINT8) 0x5E) /* Carat */
    324      1.4  christos #define ACPI_IS_PATH_SEPARATOR(c)   ((c) == (UINT8) 0x2E) /* Period (dot) */
    325      1.1    jruoho 
    326      1.1    jruoho /*
    327      1.4  christos  * An object of type ACPI_NAMESPACE_NODE can appear in some contexts
    328      1.4  christos  * where a pointer to an object of type ACPI_OPERAND_OBJECT can also
    329      1.1    jruoho  * appear. This macro is used to distinguish them.
    330      1.1    jruoho  *
    331      1.4  christos  * The "DescriptorType" field is the second field in both structures.
    332      1.1    jruoho  */
    333      1.4  christos #define ACPI_GET_DESCRIPTOR_PTR(d)      (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer)
    334      1.4  christos #define ACPI_SET_DESCRIPTOR_PTR(d, p)   (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p))
    335      1.1    jruoho #define ACPI_GET_DESCRIPTOR_TYPE(d)     (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType)
    336      1.4  christos #define ACPI_SET_DESCRIPTOR_TYPE(d, t)  (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t))
    337      1.1    jruoho 
    338      1.1    jruoho /*
    339      1.1    jruoho  * Macros for the master AML opcode table
    340      1.1    jruoho  */
    341      1.1    jruoho #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
    342      1.1    jruoho #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
    343      1.1    jruoho     {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
    344      1.1    jruoho #else
    345      1.1    jruoho #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
    346      1.1    jruoho     {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
    347      1.1    jruoho #endif
    348      1.1    jruoho 
    349      1.1    jruoho #define ARG_TYPE_WIDTH                  5
    350      1.1    jruoho #define ARG_1(x)                        ((UINT32)(x))
    351      1.1    jruoho #define ARG_2(x)                        ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
    352      1.1    jruoho #define ARG_3(x)                        ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
    353      1.1    jruoho #define ARG_4(x)                        ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
    354      1.1    jruoho #define ARG_5(x)                        ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
    355      1.1    jruoho #define ARG_6(x)                        ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
    356      1.1    jruoho 
    357      1.1    jruoho #define ARGI_LIST1(a)                   (ARG_1(a))
    358      1.1    jruoho #define ARGI_LIST2(a, b)                (ARG_1(b)|ARG_2(a))
    359      1.1    jruoho #define ARGI_LIST3(a, b, c)             (ARG_1(c)|ARG_2(b)|ARG_3(a))
    360      1.1    jruoho #define ARGI_LIST4(a, b, c, d)          (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
    361      1.1    jruoho #define ARGI_LIST5(a, b, c, d, e)       (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
    362      1.1    jruoho #define ARGI_LIST6(a, b, c, d, e, f)    (ARG_1(f)|ARG_2(e)|ARG_3(d)|ARG_4(c)|ARG_5(b)|ARG_6(a))
    363      1.1    jruoho 
    364      1.1    jruoho #define ARGP_LIST1(a)                   (ARG_1(a))
    365      1.1    jruoho #define ARGP_LIST2(a, b)                (ARG_1(a)|ARG_2(b))
    366      1.1    jruoho #define ARGP_LIST3(a, b, c)             (ARG_1(a)|ARG_2(b)|ARG_3(c))
    367      1.1    jruoho #define ARGP_LIST4(a, b, c, d)          (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
    368      1.1    jruoho #define ARGP_LIST5(a, b, c, d, e)       (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
    369      1.1    jruoho #define ARGP_LIST6(a, b, c, d, e, f)    (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)|ARG_6(f))
    370      1.1    jruoho 
    371      1.1    jruoho #define GET_CURRENT_ARG_TYPE(List)      (List & ((UINT32) 0x1F))
    372      1.1    jruoho #define INCREMENT_ARG_LIST(List)        (List >>= ((UINT32) ARG_TYPE_WIDTH))
    373      1.1    jruoho 
    374      1.1    jruoho /*
    375      1.1    jruoho  * Ascii error messages can be configured out
    376      1.1    jruoho  */
    377      1.1    jruoho #ifndef ACPI_NO_ERROR_MESSAGES
    378      1.1    jruoho /*
    379      1.1    jruoho  * Error reporting. Callers module and line number are inserted by AE_INFO,
    380      1.1    jruoho  * the plist contains a set of parens to allow variable-length lists.
    381      1.1    jruoho  * These macros are used for both the debug and non-debug versions of the code.
    382      1.1    jruoho  */
    383      1.4  christos #define ACPI_ERROR_NAMESPACE(s, e)          AcpiUtNamespaceError (AE_INFO, s, e);
    384      1.4  christos #define ACPI_ERROR_METHOD(s, n, p, e)       AcpiUtMethodError (AE_INFO, s, n, p, e);
    385      1.4  christos #define ACPI_WARN_PREDEFINED(plist)         AcpiUtPredefinedWarning plist
    386      1.4  christos #define ACPI_INFO_PREDEFINED(plist)         AcpiUtPredefinedInfo plist
    387      1.4  christos #define ACPI_BIOS_ERROR_PREDEFINED(plist)   AcpiUtPredefinedBiosError plist
    388      1.1    jruoho 
    389      1.1    jruoho #else
    390      1.1    jruoho 
    391      1.1    jruoho /* No error messages */
    392      1.1    jruoho 
    393      1.1    jruoho #define ACPI_ERROR_NAMESPACE(s, e)
    394      1.1    jruoho #define ACPI_ERROR_METHOD(s, n, p, e)
    395      1.1    jruoho #define ACPI_WARN_PREDEFINED(plist)
    396      1.1    jruoho #define ACPI_INFO_PREDEFINED(plist)
    397      1.4  christos #define ACPI_BIOS_ERROR_PREDEFINED(plist)
    398      1.1    jruoho 
    399      1.1    jruoho #endif /* ACPI_NO_ERROR_MESSAGES */
    400      1.1    jruoho 
    401      1.4  christos #if (!ACPI_REDUCED_HARDWARE)
    402      1.4  christos #define ACPI_HW_OPTIONAL_FUNCTION(addr)     addr
    403      1.1    jruoho #else
    404      1.4  christos #define ACPI_HW_OPTIONAL_FUNCTION(addr)     NULL
    405      1.1    jruoho #endif
    406      1.1    jruoho 
    407      1.1    jruoho 
    408      1.1    jruoho /*
    409      1.1    jruoho  * Some code only gets executed when the debugger is built in.
    410      1.1    jruoho  * Note that this is entirely independent of whether the
    411      1.1    jruoho  * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
    412      1.1    jruoho  */
    413      1.1    jruoho #ifdef ACPI_DEBUGGER
    414      1.1    jruoho #define ACPI_DEBUGGER_EXEC(a)           a
    415      1.1    jruoho #else
    416      1.1    jruoho #define ACPI_DEBUGGER_EXEC(a)
    417      1.1    jruoho #endif
    418      1.1    jruoho 
    419      1.1    jruoho 
    420      1.1    jruoho /*
    421      1.1    jruoho  * Macros used for ACPICA utilities only
    422      1.1    jruoho  */
    423      1.1    jruoho 
    424      1.1    jruoho /* Generate a UUID */
    425      1.1    jruoho 
    426      1.1    jruoho #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
    427      1.1    jruoho     (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
    428      1.1    jruoho     (b) & 0xFF, ((b) >> 8) & 0xFF, \
    429      1.1    jruoho     (c) & 0xFF, ((c) >> 8) & 0xFF, \
    430      1.1    jruoho     (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
    431      1.1    jruoho 
    432      1.1    jruoho #define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))
    433      1.1    jruoho 
    434      1.1    jruoho 
    435      1.1    jruoho #endif /* ACMACROS_H */
    436