xref: /titanic_44/usr/src/uts/intel/sys/acpi/acmacros.h (revision cb56572868bfc488bbd3ab847b09db2a25554d44)
17c478bd9Sstevel@tonic-gate /******************************************************************************
27c478bd9Sstevel@tonic-gate  *
37c478bd9Sstevel@tonic-gate  * Name: acmacros.h - C macros for the entire subsystem.
47c478bd9Sstevel@tonic-gate  *
57c478bd9Sstevel@tonic-gate  *****************************************************************************/
67c478bd9Sstevel@tonic-gate 
726f3cdf0SGordon Ross /*
8*cb565728SJerry Jelinek  * Copyright (C) 2000 - 2016, Intel Corp.
97c478bd9Sstevel@tonic-gate  * All rights reserved.
107c478bd9Sstevel@tonic-gate  *
1126f3cdf0SGordon Ross  * Redistribution and use in source and binary forms, with or without
1226f3cdf0SGordon Ross  * modification, are permitted provided that the following conditions
1326f3cdf0SGordon Ross  * are met:
1426f3cdf0SGordon Ross  * 1. Redistributions of source code must retain the above copyright
1526f3cdf0SGordon Ross  *    notice, this list of conditions, and the following disclaimer,
1626f3cdf0SGordon Ross  *    without modification.
1726f3cdf0SGordon Ross  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1826f3cdf0SGordon Ross  *    substantially similar to the "NO WARRANTY" disclaimer below
1926f3cdf0SGordon Ross  *    ("Disclaimer") and any redistribution must be conditioned upon
2026f3cdf0SGordon Ross  *    including a substantially similar Disclaimer requirement for further
2126f3cdf0SGordon Ross  *    binary redistribution.
2226f3cdf0SGordon Ross  * 3. Neither the names of the above-listed copyright holders nor the names
2326f3cdf0SGordon Ross  *    of any contributors may be used to endorse or promote products derived
2426f3cdf0SGordon Ross  *    from this software without specific prior written permission.
257c478bd9Sstevel@tonic-gate  *
2626f3cdf0SGordon Ross  * Alternatively, this software may be distributed under the terms of the
2726f3cdf0SGordon Ross  * GNU General Public License ("GPL") version 2 as published by the Free
2826f3cdf0SGordon Ross  * Software Foundation.
297c478bd9Sstevel@tonic-gate  *
3026f3cdf0SGordon Ross  * NO WARRANTY
3126f3cdf0SGordon Ross  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
3226f3cdf0SGordon Ross  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
3326f3cdf0SGordon Ross  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
3426f3cdf0SGordon Ross  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
3526f3cdf0SGordon Ross  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
3626f3cdf0SGordon Ross  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3726f3cdf0SGordon Ross  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3826f3cdf0SGordon Ross  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
3926f3cdf0SGordon Ross  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
4026f3cdf0SGordon Ross  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
4126f3cdf0SGordon Ross  * POSSIBILITY OF SUCH DAMAGES.
4226f3cdf0SGordon Ross  */
437c478bd9Sstevel@tonic-gate 
447c478bd9Sstevel@tonic-gate #ifndef __ACMACROS_H__
457c478bd9Sstevel@tonic-gate #define __ACMACROS_H__
467c478bd9Sstevel@tonic-gate 
477c478bd9Sstevel@tonic-gate 
487c478bd9Sstevel@tonic-gate /*
4930082d0cSmyers  * Extract data using a pointer. Any more than a byte and we
5030082d0cSmyers  * get into potential aligment issues -- see the STORE macros below.
5130082d0cSmyers  * Use with care.
527c478bd9Sstevel@tonic-gate  */
53*cb565728SJerry Jelinek #define ACPI_CAST8(ptr)                 ACPI_CAST_PTR (UINT8, (ptr))
54*cb565728SJerry Jelinek #define ACPI_CAST16(ptr)                ACPI_CAST_PTR (UINT16, (ptr))
55*cb565728SJerry Jelinek #define ACPI_CAST32(ptr)                ACPI_CAST_PTR (UINT32, (ptr))
56*cb565728SJerry Jelinek #define ACPI_CAST64(ptr)                ACPI_CAST_PTR (UINT64, (ptr))
57*cb565728SJerry Jelinek #define ACPI_GET8(ptr)                  (*ACPI_CAST8 (ptr))
58*cb565728SJerry Jelinek #define ACPI_GET16(ptr)                 (*ACPI_CAST16 (ptr))
59*cb565728SJerry Jelinek #define ACPI_GET32(ptr)                 (*ACPI_CAST32 (ptr))
60*cb565728SJerry Jelinek #define ACPI_GET64(ptr)                 (*ACPI_CAST64 (ptr))
61*cb565728SJerry Jelinek #define ACPI_SET8(ptr, val)             (*ACPI_CAST8 (ptr) = (UINT8) (val))
62*cb565728SJerry Jelinek #define ACPI_SET16(ptr, val)            (*ACPI_CAST16 (ptr) = (UINT16) (val))
63*cb565728SJerry Jelinek #define ACPI_SET32(ptr, val)            (*ACPI_CAST32 (ptr) = (UINT32) (val))
64*cb565728SJerry Jelinek #define ACPI_SET64(ptr, val)            (*ACPI_CAST64 (ptr) = (UINT64) (val))
657c478bd9Sstevel@tonic-gate 
6630082d0cSmyers /*
67*cb565728SJerry Jelinek  * printf() format helper. This macros is a workaround for the difficulties
68*cb565728SJerry Jelinek  * with emitting 64-bit integers and 64-bit pointers with the same code
69*cb565728SJerry Jelinek  * for both 32-bit and 64-bit hosts.
70db2bae30SDana Myers  */
71db2bae30SDana Myers #define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i), ACPI_LODWORD(i)
72db2bae30SDana Myers 
73db2bae30SDana Myers 
74db2bae30SDana Myers /*
757c478bd9Sstevel@tonic-gate  * Macros for moving data around to/from buffers that are possibly unaligned.
767c478bd9Sstevel@tonic-gate  * If the hardware supports the transfer of unaligned data, just do the store.
777c478bd9Sstevel@tonic-gate  * Otherwise, we have to move one byte at a time.
787c478bd9Sstevel@tonic-gate  */
797c478bd9Sstevel@tonic-gate #ifdef ACPI_BIG_ENDIAN
807c478bd9Sstevel@tonic-gate /*
817c478bd9Sstevel@tonic-gate  * Macros for big-endian machines
827c478bd9Sstevel@tonic-gate  */
837c478bd9Sstevel@tonic-gate 
847c478bd9Sstevel@tonic-gate /* These macros reverse the bytes during the move, converting little-endian to big endian */
857c478bd9Sstevel@tonic-gate 
867c478bd9Sstevel@tonic-gate                                                      /* Big Endian      <==        Little Endian */
877c478bd9Sstevel@tonic-gate                                                      /*  Hi...Lo                     Lo...Hi     */
887c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */
897c478bd9Sstevel@tonic-gate 
907c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[1];\
917c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[0];}
927c478bd9Sstevel@tonic-gate 
937c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d))=0;\
947c478bd9Sstevel@tonic-gate                                            ((UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
957c478bd9Sstevel@tonic-gate                                            ((UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
967c478bd9Sstevel@tonic-gate 
977c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
987c478bd9Sstevel@tonic-gate                                            ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
997c478bd9Sstevel@tonic-gate                                            ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
1007c478bd9Sstevel@tonic-gate 
1017c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */
1027c478bd9Sstevel@tonic-gate 
1037c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
1047c478bd9Sstevel@tonic-gate 
1057c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[3];\
1067c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[2];\
1077c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[1];\
1087c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[0];}
1097c478bd9Sstevel@tonic-gate 
1107c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d))=0;\
1117c478bd9Sstevel@tonic-gate                                            ((UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
1127c478bd9Sstevel@tonic-gate                                            ((UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
1137c478bd9Sstevel@tonic-gate                                            ((UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
1147c478bd9Sstevel@tonic-gate                                            ((UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
1157c478bd9Sstevel@tonic-gate 
1167c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */
1177c478bd9Sstevel@tonic-gate 
1187c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
1197c478bd9Sstevel@tonic-gate 
1207c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
1217c478bd9Sstevel@tonic-gate 
1227c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[7];\
1237c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[6];\
1247c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[5];\
1257c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[4];\
1267c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[3];\
1277c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[2];\
1287c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[1];\
1297c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[0];}
1307c478bd9Sstevel@tonic-gate #else
1317c478bd9Sstevel@tonic-gate /*
1327c478bd9Sstevel@tonic-gate  * Macros for little-endian machines
1337c478bd9Sstevel@tonic-gate  */
1347c478bd9Sstevel@tonic-gate 
13530082d0cSmyers #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
1367c478bd9Sstevel@tonic-gate 
1377c478bd9Sstevel@tonic-gate /* The hardware supports unaligned transfers, just do the little-endian move */
1387c478bd9Sstevel@tonic-gate 
1397c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */
1407c478bd9Sstevel@tonic-gate 
1417c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_16(d, s)        *(UINT16 *)(void *)(d) = *(UINT16 *)(void *)(s)
1427c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT16 *)(void *)(s)
1437c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT16 *)(void *)(s)
1447c478bd9Sstevel@tonic-gate 
1457c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */
1467c478bd9Sstevel@tonic-gate 
1477c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
1487c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_32(d, s)        *(UINT32 *)(void *)(d) = *(UINT32 *)(void *)(s)
1497c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT32 *)(void *)(s)
1507c478bd9Sstevel@tonic-gate 
1517c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */
1527c478bd9Sstevel@tonic-gate 
1537c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
1547c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
1557c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_64(d, s)        *(UINT64 *)(void *)(d) = *(UINT64 *)(void *)(s)
1567c478bd9Sstevel@tonic-gate 
1577c478bd9Sstevel@tonic-gate #else
1587c478bd9Sstevel@tonic-gate /*
1597c478bd9Sstevel@tonic-gate  * The hardware does not support unaligned transfers. We must move the
1607c478bd9Sstevel@tonic-gate  * data one byte at a time. These macros work whether the source or
1617c478bd9Sstevel@tonic-gate  * the destination (or both) is/are unaligned. (Little-endian move)
1627c478bd9Sstevel@tonic-gate  */
1637c478bd9Sstevel@tonic-gate 
1647c478bd9Sstevel@tonic-gate /* 16-bit source, 16/32/64 destination */
1657c478bd9Sstevel@tonic-gate 
1667c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_16(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
1677c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];}
1687c478bd9Sstevel@tonic-gate 
1697c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_32(d, s)        {(*(UINT32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
1707c478bd9Sstevel@tonic-gate #define ACPI_MOVE_16_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
1717c478bd9Sstevel@tonic-gate 
1727c478bd9Sstevel@tonic-gate /* 32-bit source, 16/32/64 destination */
1737c478bd9Sstevel@tonic-gate 
1747c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
1757c478bd9Sstevel@tonic-gate 
1767c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_32(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
1777c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
1787c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
1797c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];}
1807c478bd9Sstevel@tonic-gate 
1817c478bd9Sstevel@tonic-gate #define ACPI_MOVE_32_TO_64(d, s)        {(*(UINT64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
1827c478bd9Sstevel@tonic-gate 
1837c478bd9Sstevel@tonic-gate /* 64-bit source, 16/32/64 destination */
1847c478bd9Sstevel@tonic-gate 
1857c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)    /* Truncate to 16 */
1867c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)    /* Truncate to 32 */
1877c478bd9Sstevel@tonic-gate #define ACPI_MOVE_64_TO_64(d, s)        {((  UINT8 *)(void *)(d))[0] = ((UINT8 *)(void *)(s))[0];\
1887c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[1] = ((UINT8 *)(void *)(s))[1];\
1897c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[2] = ((UINT8 *)(void *)(s))[2];\
1907c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[3] = ((UINT8 *)(void *)(s))[3];\
1917c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[4] = ((UINT8 *)(void *)(s))[4];\
1927c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[5] = ((UINT8 *)(void *)(s))[5];\
1937c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[6] = ((UINT8 *)(void *)(s))[6];\
1947c478bd9Sstevel@tonic-gate                                          ((  UINT8 *)(void *)(d))[7] = ((UINT8 *)(void *)(s))[7];}
1957c478bd9Sstevel@tonic-gate #endif
1967c478bd9Sstevel@tonic-gate #endif
1977c478bd9Sstevel@tonic-gate 
1987c478bd9Sstevel@tonic-gate 
1997c478bd9Sstevel@tonic-gate /*
2007c478bd9Sstevel@tonic-gate  * Fast power-of-two math macros for non-optimized compilers
2017c478bd9Sstevel@tonic-gate  */
2027c478bd9Sstevel@tonic-gate #define _ACPI_DIV(value, PowerOf2)      ((UINT32) ((value) >> (PowerOf2)))
2037c478bd9Sstevel@tonic-gate #define _ACPI_MUL(value, PowerOf2)      ((UINT32) ((value) << (PowerOf2)))
2047c478bd9Sstevel@tonic-gate #define _ACPI_MOD(value, Divisor)       ((UINT32) ((value) & ((Divisor) -1)))
2057c478bd9Sstevel@tonic-gate 
2067c478bd9Sstevel@tonic-gate #define ACPI_DIV_2(a)                   _ACPI_DIV(a, 1)
2077c478bd9Sstevel@tonic-gate #define ACPI_MUL_2(a)                   _ACPI_MUL(a, 1)
2087c478bd9Sstevel@tonic-gate #define ACPI_MOD_2(a)                   _ACPI_MOD(a, 2)
2097c478bd9Sstevel@tonic-gate 
2107c478bd9Sstevel@tonic-gate #define ACPI_DIV_4(a)                   _ACPI_DIV(a, 2)
2117c478bd9Sstevel@tonic-gate #define ACPI_MUL_4(a)                   _ACPI_MUL(a, 2)
2127c478bd9Sstevel@tonic-gate #define ACPI_MOD_4(a)                   _ACPI_MOD(a, 4)
2137c478bd9Sstevel@tonic-gate 
2147c478bd9Sstevel@tonic-gate #define ACPI_DIV_8(a)                   _ACPI_DIV(a, 3)
2157c478bd9Sstevel@tonic-gate #define ACPI_MUL_8(a)                   _ACPI_MUL(a, 3)
2167c478bd9Sstevel@tonic-gate #define ACPI_MOD_8(a)                   _ACPI_MOD(a, 8)
2177c478bd9Sstevel@tonic-gate 
2187c478bd9Sstevel@tonic-gate #define ACPI_DIV_16(a)                  _ACPI_DIV(a, 4)
2197c478bd9Sstevel@tonic-gate #define ACPI_MUL_16(a)                  _ACPI_MUL(a, 4)
2207c478bd9Sstevel@tonic-gate #define ACPI_MOD_16(a)                  _ACPI_MOD(a, 16)
2217c478bd9Sstevel@tonic-gate 
22230082d0cSmyers #define ACPI_DIV_32(a)                  _ACPI_DIV(a, 5)
22330082d0cSmyers #define ACPI_MUL_32(a)                  _ACPI_MUL(a, 5)
22430082d0cSmyers #define ACPI_MOD_32(a)                  _ACPI_MOD(a, 32)
2257c478bd9Sstevel@tonic-gate 
226*cb565728SJerry Jelinek /* Test for ASCII character */
227*cb565728SJerry Jelinek 
228*cb565728SJerry Jelinek #define ACPI_IS_ASCII(c)                ((c) < 0x80)
229*cb565728SJerry Jelinek 
230*cb565728SJerry Jelinek /* Signed integers */
231*cb565728SJerry Jelinek 
232*cb565728SJerry Jelinek #define ACPI_SIGN_POSITIVE              0
233*cb565728SJerry Jelinek #define ACPI_SIGN_NEGATIVE              1
234*cb565728SJerry Jelinek 
235*cb565728SJerry Jelinek 
2367c478bd9Sstevel@tonic-gate /*
2377c478bd9Sstevel@tonic-gate  * Rounding macros (Power of two boundaries only)
2387c478bd9Sstevel@tonic-gate  */
239db2bae30SDana Myers #define ACPI_ROUND_DOWN(value, boundary)    (((ACPI_SIZE)(value)) & \
240db2bae30SDana Myers                                                 (~(((ACPI_SIZE) boundary)-1)))
2417c478bd9Sstevel@tonic-gate 
242db2bae30SDana Myers #define ACPI_ROUND_UP(value, boundary)      ((((ACPI_SIZE)(value)) + \
243db2bae30SDana Myers                                                 (((ACPI_SIZE) boundary)-1)) & \
244db2bae30SDana Myers                                                 (~(((ACPI_SIZE) boundary)-1)))
2457c478bd9Sstevel@tonic-gate 
246db2bae30SDana Myers /* Note: sizeof(ACPI_SIZE) evaluates to either 4 or 8 (32- vs 64-bit mode) */
2477c478bd9Sstevel@tonic-gate 
24830082d0cSmyers #define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a, 4)
24930082d0cSmyers #define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a, 8)
250db2bae30SDana Myers #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a, sizeof(ACPI_SIZE))
25130082d0cSmyers 
25230082d0cSmyers #define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a, 4)
25330082d0cSmyers #define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a, 8)
254db2bae30SDana Myers #define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a, sizeof(ACPI_SIZE))
2557c478bd9Sstevel@tonic-gate 
2567c478bd9Sstevel@tonic-gate #define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
2577c478bd9Sstevel@tonic-gate #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))
2587c478bd9Sstevel@tonic-gate 
2597c478bd9Sstevel@tonic-gate #define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)
2607c478bd9Sstevel@tonic-gate 
2617c478bd9Sstevel@tonic-gate /* Generic (non-power-of-two) rounding */
2627c478bd9Sstevel@tonic-gate 
2637c478bd9Sstevel@tonic-gate #define ACPI_ROUND_UP_TO(value, boundary)   (((value) + ((boundary)-1)) / (boundary))
2647c478bd9Sstevel@tonic-gate 
265db2bae30SDana Myers #define ACPI_IS_MISALIGNED(value)           (((ACPI_SIZE) value) & (sizeof(ACPI_SIZE)-1))
26630082d0cSmyers 
2677c478bd9Sstevel@tonic-gate /*
2687c478bd9Sstevel@tonic-gate  * Bitmask creation
2697c478bd9Sstevel@tonic-gate  * Bit positions start at zero.
2707c478bd9Sstevel@tonic-gate  * MASK_BITS_ABOVE creates a mask starting AT the position and above
2717c478bd9Sstevel@tonic-gate  * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
2727c478bd9Sstevel@tonic-gate  */
27326f3cdf0SGordon Ross #define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_UINT64_MAX) << ((UINT32) (position))))
27426f3cdf0SGordon Ross #define ACPI_MASK_BITS_BELOW(position)      ((ACPI_UINT64_MAX) << ((UINT32) (position)))
2757c478bd9Sstevel@tonic-gate 
2767c478bd9Sstevel@tonic-gate /* Bitfields within ACPI registers */
2777c478bd9Sstevel@tonic-gate 
278*cb565728SJerry Jelinek #define ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask) \
279*cb565728SJerry Jelinek     ((Val << Pos) & Mask)
2807c478bd9Sstevel@tonic-gate 
281*cb565728SJerry Jelinek #define ACPI_REGISTER_INSERT_VALUE(Reg, Pos, Mask, Val) \
282*cb565728SJerry Jelinek     Reg = (Reg & (~(Mask))) | ACPI_REGISTER_PREPARE_BITS(Val, Pos, Mask)
283*cb565728SJerry Jelinek 
284*cb565728SJerry Jelinek #define ACPI_INSERT_BITS(Target, Mask, Source) \
285*cb565728SJerry Jelinek     Target = ((Target & (~(Mask))) | (Source & Mask))
286*cb565728SJerry Jelinek 
287*cb565728SJerry Jelinek /* Generic bitfield macros and masks */
288*cb565728SJerry Jelinek 
289*cb565728SJerry Jelinek #define ACPI_GET_BITS(SourcePtr, Position, Mask) \
290*cb565728SJerry Jelinek     ((*(SourcePtr) >> (Position)) & (Mask))
291*cb565728SJerry Jelinek 
292*cb565728SJerry Jelinek #define ACPI_SET_BITS(TargetPtr, Position, Mask, Value) \
293*cb565728SJerry Jelinek     (*(TargetPtr) |= (((Value) & (Mask)) << (Position)))
294*cb565728SJerry Jelinek 
295*cb565728SJerry Jelinek #define ACPI_1BIT_MASK      0x00000001
296*cb565728SJerry Jelinek #define ACPI_2BIT_MASK      0x00000003
297*cb565728SJerry Jelinek #define ACPI_3BIT_MASK      0x00000007
298*cb565728SJerry Jelinek #define ACPI_4BIT_MASK      0x0000000F
299*cb565728SJerry Jelinek #define ACPI_5BIT_MASK      0x0000001F
300*cb565728SJerry Jelinek #define ACPI_6BIT_MASK      0x0000003F
301*cb565728SJerry Jelinek #define ACPI_7BIT_MASK      0x0000007F
302*cb565728SJerry Jelinek #define ACPI_8BIT_MASK      0x000000FF
303*cb565728SJerry Jelinek #define ACPI_16BIT_MASK     0x0000FFFF
304*cb565728SJerry Jelinek #define ACPI_24BIT_MASK     0x00FFFFFF
305*cb565728SJerry Jelinek 
306*cb565728SJerry Jelinek /* Macros to extract flag bits from position zero */
307*cb565728SJerry Jelinek 
308*cb565728SJerry Jelinek #define ACPI_GET_1BIT_FLAG(Value)                   ((Value) & ACPI_1BIT_MASK)
309*cb565728SJerry Jelinek #define ACPI_GET_2BIT_FLAG(Value)                   ((Value) & ACPI_2BIT_MASK)
310*cb565728SJerry Jelinek #define ACPI_GET_3BIT_FLAG(Value)                   ((Value) & ACPI_3BIT_MASK)
311*cb565728SJerry Jelinek #define ACPI_GET_4BIT_FLAG(Value)                   ((Value) & ACPI_4BIT_MASK)
312*cb565728SJerry Jelinek 
313*cb565728SJerry Jelinek /* Macros to extract flag bits from position one and above */
314*cb565728SJerry Jelinek 
315*cb565728SJerry Jelinek #define ACPI_EXTRACT_1BIT_FLAG(Field, Position)     (ACPI_GET_1BIT_FLAG ((Field) >> Position))
316*cb565728SJerry Jelinek #define ACPI_EXTRACT_2BIT_FLAG(Field, Position)     (ACPI_GET_2BIT_FLAG ((Field) >> Position))
317*cb565728SJerry Jelinek #define ACPI_EXTRACT_3BIT_FLAG(Field, Position)     (ACPI_GET_3BIT_FLAG ((Field) >> Position))
318*cb565728SJerry Jelinek #define ACPI_EXTRACT_4BIT_FLAG(Field, Position)     (ACPI_GET_4BIT_FLAG ((Field) >> Position))
319*cb565728SJerry Jelinek 
320*cb565728SJerry Jelinek /* ACPI Pathname helpers */
321*cb565728SJerry Jelinek 
322*cb565728SJerry Jelinek #define ACPI_IS_ROOT_PREFIX(c)      ((c) == (UINT8) 0x5C) /* Backslash */
323*cb565728SJerry Jelinek #define ACPI_IS_PARENT_PREFIX(c)    ((c) == (UINT8) 0x5E) /* Carat */
324*cb565728SJerry Jelinek #define ACPI_IS_PATH_SEPARATOR(c)   ((c) == (UINT8) 0x2E) /* Period (dot) */
32527f7c583Smyers 
3267c478bd9Sstevel@tonic-gate /*
327*cb565728SJerry Jelinek  * An object of type ACPI_NAMESPACE_NODE can appear in some contexts
328*cb565728SJerry Jelinek  * where a pointer to an object of type ACPI_OPERAND_OBJECT can also
3297c478bd9Sstevel@tonic-gate  * appear. This macro is used to distinguish them.
3307c478bd9Sstevel@tonic-gate  *
331*cb565728SJerry Jelinek  * The "DescriptorType" field is the second field in both structures.
3327c478bd9Sstevel@tonic-gate  */
333*cb565728SJerry Jelinek #define ACPI_GET_DESCRIPTOR_PTR(d)      (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer)
334*cb565728SJerry Jelinek #define ACPI_SET_DESCRIPTOR_PTR(d, p)   (((ACPI_DESCRIPTOR *)(void *)(d))->Common.CommonPointer = (p))
33527f7c583Smyers #define ACPI_GET_DESCRIPTOR_TYPE(d)     (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType)
336*cb565728SJerry Jelinek #define ACPI_SET_DESCRIPTOR_TYPE(d, t)  (((ACPI_DESCRIPTOR *)(void *)(d))->Common.DescriptorType = (t))
3377c478bd9Sstevel@tonic-gate 
3387c478bd9Sstevel@tonic-gate /*
3397c478bd9Sstevel@tonic-gate  * Macros for the master AML opcode table
3407c478bd9Sstevel@tonic-gate  */
3417c478bd9Sstevel@tonic-gate #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
342db2bae30SDana Myers #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
343db2bae30SDana Myers     {Name, (UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
3447c478bd9Sstevel@tonic-gate #else
345db2bae30SDana Myers #define ACPI_OP(Name, PArgs, IArgs, ObjType, Class, Type, Flags) \
346db2bae30SDana Myers     {(UINT32)(PArgs), (UINT32)(IArgs), (UINT32)(Flags), ObjType, Class, Type}
3477c478bd9Sstevel@tonic-gate #endif
3487c478bd9Sstevel@tonic-gate 
3497c478bd9Sstevel@tonic-gate #define ARG_TYPE_WIDTH                  5
3507c478bd9Sstevel@tonic-gate #define ARG_1(x)                        ((UINT32)(x))
3517c478bd9Sstevel@tonic-gate #define ARG_2(x)                        ((UINT32)(x) << (1 * ARG_TYPE_WIDTH))
3527c478bd9Sstevel@tonic-gate #define ARG_3(x)                        ((UINT32)(x) << (2 * ARG_TYPE_WIDTH))
3537c478bd9Sstevel@tonic-gate #define ARG_4(x)                        ((UINT32)(x) << (3 * ARG_TYPE_WIDTH))
3547c478bd9Sstevel@tonic-gate #define ARG_5(x)                        ((UINT32)(x) << (4 * ARG_TYPE_WIDTH))
3557c478bd9Sstevel@tonic-gate #define ARG_6(x)                        ((UINT32)(x) << (5 * ARG_TYPE_WIDTH))
3567c478bd9Sstevel@tonic-gate 
3577c478bd9Sstevel@tonic-gate #define ARGI_LIST1(a)                   (ARG_1(a))
3587c478bd9Sstevel@tonic-gate #define ARGI_LIST2(a, b)                (ARG_1(b)|ARG_2(a))
3597c478bd9Sstevel@tonic-gate #define ARGI_LIST3(a, b, c)             (ARG_1(c)|ARG_2(b)|ARG_3(a))
3607c478bd9Sstevel@tonic-gate #define ARGI_LIST4(a, b, c, d)          (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
3617c478bd9Sstevel@tonic-gate #define ARGI_LIST5(a, b, c, d, e)       (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
3627c478bd9Sstevel@tonic-gate #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))
3637c478bd9Sstevel@tonic-gate 
3647c478bd9Sstevel@tonic-gate #define ARGP_LIST1(a)                   (ARG_1(a))
3657c478bd9Sstevel@tonic-gate #define ARGP_LIST2(a, b)                (ARG_1(a)|ARG_2(b))
3667c478bd9Sstevel@tonic-gate #define ARGP_LIST3(a, b, c)             (ARG_1(a)|ARG_2(b)|ARG_3(c))
3677c478bd9Sstevel@tonic-gate #define ARGP_LIST4(a, b, c, d)          (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
3687c478bd9Sstevel@tonic-gate #define ARGP_LIST5(a, b, c, d, e)       (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
3697c478bd9Sstevel@tonic-gate #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))
3707c478bd9Sstevel@tonic-gate 
3717c478bd9Sstevel@tonic-gate #define GET_CURRENT_ARG_TYPE(List)      (List & ((UINT32) 0x1F))
3727c478bd9Sstevel@tonic-gate #define INCREMENT_ARG_LIST(List)        (List >>= ((UINT32) ARG_TYPE_WIDTH))
3737c478bd9Sstevel@tonic-gate 
37430082d0cSmyers /*
37530082d0cSmyers  * Ascii error messages can be configured out
37630082d0cSmyers  */
37730082d0cSmyers #ifndef ACPI_NO_ERROR_MESSAGES
37830082d0cSmyers /*
37930082d0cSmyers  * Error reporting. Callers module and line number are inserted by AE_INFO,
38030082d0cSmyers  * the plist contains a set of parens to allow variable-length lists.
38130082d0cSmyers  * These macros are used for both the debug and non-debug versions of the code.
38230082d0cSmyers  */
38326f3cdf0SGordon Ross #define ACPI_ERROR_NAMESPACE(s, e)          AcpiUtNamespaceError (AE_INFO, s, e);
38426f3cdf0SGordon Ross #define ACPI_ERROR_METHOD(s, n, p, e)       AcpiUtMethodError (AE_INFO, s, n, p, e);
38557190917SDana Myers #define ACPI_WARN_PREDEFINED(plist)         AcpiUtPredefinedWarning plist
38657190917SDana Myers #define ACPI_INFO_PREDEFINED(plist)         AcpiUtPredefinedInfo plist
387*cb565728SJerry Jelinek #define ACPI_BIOS_ERROR_PREDEFINED(plist)   AcpiUtPredefinedBiosError plist
38830082d0cSmyers 
38930082d0cSmyers #else
39030082d0cSmyers 
39130082d0cSmyers /* No error messages */
39230082d0cSmyers 
39330082d0cSmyers #define ACPI_ERROR_NAMESPACE(s, e)
39430082d0cSmyers #define ACPI_ERROR_METHOD(s, n, p, e)
39557190917SDana Myers #define ACPI_WARN_PREDEFINED(plist)
39657190917SDana Myers #define ACPI_INFO_PREDEFINED(plist)
397*cb565728SJerry Jelinek #define ACPI_BIOS_ERROR_PREDEFINED(plist)
398aa2aa9a6SDana Myers 
399aa2aa9a6SDana Myers #endif /* ACPI_NO_ERROR_MESSAGES */
4007c478bd9Sstevel@tonic-gate 
401*cb565728SJerry Jelinek #if (!ACPI_REDUCED_HARDWARE)
402*cb565728SJerry Jelinek #define ACPI_HW_OPTIONAL_FUNCTION(addr)     addr
4037c478bd9Sstevel@tonic-gate #else
404*cb565728SJerry Jelinek #define ACPI_HW_OPTIONAL_FUNCTION(addr)     NULL
4057c478bd9Sstevel@tonic-gate #endif
4067c478bd9Sstevel@tonic-gate 
407db2bae30SDana Myers 
408db2bae30SDana Myers /*
409db2bae30SDana Myers  * Macros used for ACPICA utilities only
410db2bae30SDana Myers  */
411db2bae30SDana Myers 
412db2bae30SDana Myers /* Generate a UUID */
413db2bae30SDana Myers 
414db2bae30SDana Myers #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
415db2bae30SDana Myers     (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
416db2bae30SDana Myers     (b) & 0xFF, ((b) >> 8) & 0xFF, \
417db2bae30SDana Myers     (c) & 0xFF, ((c) >> 8) & 0xFF, \
418db2bae30SDana Myers     (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)
419db2bae30SDana Myers 
420db2bae30SDana Myers #define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))
421db2bae30SDana Myers 
422db2bae30SDana Myers 
4237c478bd9Sstevel@tonic-gate #endif /* ACMACROS_H */
424