Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /****************************************************************************** |
| 2 | * |
| 3 | * Name: acmacros.h - C macros for the entire subsystem. |
| 4 | * |
| 5 | *****************************************************************************/ |
| 6 | |
| 7 | /* |
Bob Moore | fbb7a2d | 2014-02-08 09:42:25 +0800 | [diff] [blame] | 8 | * Copyright (C) 2000 - 2014, Intel Corp. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 __ACMACROS_H__ |
| 45 | #define __ACMACROS_H__ |
| 46 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 47 | /* |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 48 | * Extract data using a pointer. Any more than a byte and we |
Bob Moore | defba1d | 2005-12-16 17:05:00 -0500 | [diff] [blame] | 49 | * get into potential aligment issues -- see the STORE macros below. |
| 50 | * Use with care. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 51 | */ |
Lv Zheng | 57bf6ae | 2012-12-19 05:38:24 +0000 | [diff] [blame] | 52 | #define ACPI_CAST8(ptr) ACPI_CAST_PTR (u8, (ptr)) |
| 53 | #define ACPI_CAST16(ptr) ACPI_CAST_PTR (u16, (ptr)) |
| 54 | #define ACPI_CAST32(ptr) ACPI_CAST_PTR (u32, (ptr)) |
| 55 | #define ACPI_CAST64(ptr) ACPI_CAST_PTR (u64, (ptr)) |
| 56 | #define ACPI_GET8(ptr) (*ACPI_CAST8 (ptr)) |
| 57 | #define ACPI_GET16(ptr) (*ACPI_CAST16 (ptr)) |
| 58 | #define ACPI_GET32(ptr) (*ACPI_CAST32 (ptr)) |
| 59 | #define ACPI_GET64(ptr) (*ACPI_CAST64 (ptr)) |
| 60 | #define ACPI_SET8(ptr, val) (*ACPI_CAST8 (ptr) = (u8) (val)) |
| 61 | #define ACPI_SET16(ptr, val) (*ACPI_CAST16 (ptr) = (u16) (val)) |
| 62 | #define ACPI_SET32(ptr, val) (*ACPI_CAST32 (ptr) = (u32) (val)) |
| 63 | #define ACPI_SET64(ptr, val) (*ACPI_CAST64 (ptr) = (u64) (val)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 64 | |
Bob Moore | defba1d | 2005-12-16 17:05:00 -0500 | [diff] [blame] | 65 | /* |
Bob Moore | c03775c | 2014-02-08 09:42:01 +0800 | [diff] [blame] | 66 | * printf() format helpers. These macros are workarounds for the difficulties |
| 67 | * with emitting 64-bit integers and 64-bit pointers with the same code |
| 68 | * for both 32-bit and 64-bit hosts. |
Bob Moore | 7823665 | 2008-04-10 19:06:42 +0400 | [diff] [blame] | 69 | */ |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 70 | #define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i) |
Bob Moore | 7823665 | 2008-04-10 19:06:42 +0400 | [diff] [blame] | 71 | |
| 72 | #if ACPI_MACHINE_WIDTH == 64 |
| 73 | #define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i) |
Bob Moore | c03775c | 2014-02-08 09:42:01 +0800 | [diff] [blame] | 74 | #define ACPI_FORMAT_TO_UINT(i) ACPI_FORMAT_UINT64(i) |
| 75 | #define ACPI_PRINTF_UINT "0x%8.8X%8.8X" |
| 76 | |
Bob Moore | 7823665 | 2008-04-10 19:06:42 +0400 | [diff] [blame] | 77 | #else |
Bob Moore | c03775c | 2014-02-08 09:42:01 +0800 | [diff] [blame] | 78 | #define ACPI_FORMAT_NATIVE_UINT(i) 0, (u32) (i) |
| 79 | #define ACPI_FORMAT_TO_UINT(i) (u32) (i) |
| 80 | #define ACPI_PRINTF_UINT "0x%8.8X" |
Bob Moore | 7823665 | 2008-04-10 19:06:42 +0400 | [diff] [blame] | 81 | #endif |
| 82 | |
| 83 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 84 | * Macros for moving data around to/from buffers that are possibly unaligned. |
| 85 | * If the hardware supports the transfer of unaligned data, just do the store. |
| 86 | * Otherwise, we have to move one byte at a time. |
| 87 | */ |
| 88 | #ifdef ACPI_BIG_ENDIAN |
| 89 | /* |
| 90 | * Macros for big-endian machines |
| 91 | */ |
| 92 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 93 | /* These macros reverse the bytes during the move, converting little-endian to big endian */ |
| 94 | |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 95 | /* Big Endian <== Little Endian */ |
| 96 | /* Hi...Lo Lo...Hi */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 97 | /* 16-bit source, 16/32/64 destination */ |
| 98 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 99 | #define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\ |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 100 | (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 102 | #define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d))=0;\ |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 103 | ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\ |
| 104 | ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 106 | #define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\ |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 107 | ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\ |
| 108 | ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | |
| 110 | /* 32-bit source, 16/32/64 destination */ |
| 111 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 112 | #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 114 | #define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\ |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 115 | (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\ |
| 116 | (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\ |
| 117 | (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 119 | #define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d))=0;\ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\ |
| 121 | ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\ |
| 122 | ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\ |
| 123 | ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];} |
| 124 | |
| 125 | /* 64-bit source, 16/32/64 destination */ |
| 126 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 127 | #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 128 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 129 | #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 131 | #define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 132 | (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\ |
| 133 | (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\ |
| 134 | (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\ |
| 135 | (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\ |
| 136 | (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\ |
| 137 | (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\ |
| 138 | (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];} |
| 139 | #else |
| 140 | /* |
| 141 | * Macros for little-endian machines |
| 142 | */ |
| 143 | |
Bob Moore | 0897831 | 2005-10-21 00:00:00 -0400 | [diff] [blame] | 144 | #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | |
| 146 | /* The hardware supports unaligned transfers, just do the little-endian move */ |
| 147 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 148 | /* 16-bit source, 16/32/64 destination */ |
| 149 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 150 | #define ACPI_MOVE_16_TO_16(d, s) *(u16 *)(void *)(d) = *(u16 *)(void *)(s) |
| 151 | #define ACPI_MOVE_16_TO_32(d, s) *(u32 *)(void *)(d) = *(u16 *)(void *)(s) |
| 152 | #define ACPI_MOVE_16_TO_64(d, s) *(u64 *)(void *)(d) = *(u16 *)(void *)(s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | |
| 154 | /* 32-bit source, 16/32/64 destination */ |
| 155 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 156 | #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ |
| 157 | #define ACPI_MOVE_32_TO_32(d, s) *(u32 *)(void *)(d) = *(u32 *)(void *)(s) |
| 158 | #define ACPI_MOVE_32_TO_64(d, s) *(u64 *)(void *)(d) = *(u32 *)(void *)(s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | |
| 160 | /* 64-bit source, 16/32/64 destination */ |
| 161 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 162 | #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ |
| 163 | #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ |
| 164 | #define ACPI_MOVE_64_TO_64(d, s) *(u64 *)(void *)(d) = *(u64 *)(void *)(s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | |
| 166 | #else |
| 167 | /* |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 168 | * The hardware does not support unaligned transfers. We must move the |
| 169 | * data one byte at a time. These macros work whether the source or |
Bob Moore | 50df4d8 | 2008-12-31 03:01:23 +0800 | [diff] [blame] | 170 | * the destination (or both) is/are unaligned. (Little-endian move) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | */ |
| 172 | |
| 173 | /* 16-bit source, 16/32/64 destination */ |
| 174 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 175 | #define ACPI_MOVE_16_TO_16(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 176 | (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];} |
| 177 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 178 | #define ACPI_MOVE_16_TO_32(d, s) {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} |
| 179 | #define ACPI_MOVE_16_TO_64(d, s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 180 | |
| 181 | /* 32-bit source, 16/32/64 destination */ |
| 182 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 183 | #define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 184 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 185 | #define ACPI_MOVE_32_TO_32(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 186 | (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\ |
| 187 | (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\ |
| 188 | (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];} |
| 189 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 190 | #define ACPI_MOVE_32_TO_64(d, s) {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | |
| 192 | /* 64-bit source, 16/32/64 destination */ |
| 193 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 194 | #define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */ |
| 195 | #define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */ |
| 196 | #define ACPI_MOVE_64_TO_64(d, s) {(( u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 197 | (( u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\ |
| 198 | (( u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\ |
| 199 | (( u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\ |
| 200 | (( u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\ |
| 201 | (( u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\ |
| 202 | (( u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\ |
| 203 | (( u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];} |
| 204 | #endif |
| 205 | #endif |
| 206 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | /* |
| 208 | * Fast power-of-two math macros for non-optimized compilers |
| 209 | */ |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 210 | #define _ACPI_DIV(value, power_of2) ((u32) ((value) >> (power_of2))) |
| 211 | #define _ACPI_MUL(value, power_of2) ((u32) ((value) << (power_of2))) |
| 212 | #define _ACPI_MOD(value, divisor) ((u32) ((value) & ((divisor) -1))) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 213 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 214 | #define ACPI_DIV_2(a) _ACPI_DIV(a, 1) |
| 215 | #define ACPI_MUL_2(a) _ACPI_MUL(a, 1) |
| 216 | #define ACPI_MOD_2(a) _ACPI_MOD(a, 2) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 217 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 218 | #define ACPI_DIV_4(a) _ACPI_DIV(a, 2) |
| 219 | #define ACPI_MUL_4(a) _ACPI_MUL(a, 2) |
| 220 | #define ACPI_MOD_4(a) _ACPI_MOD(a, 4) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 221 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 222 | #define ACPI_DIV_8(a) _ACPI_DIV(a, 3) |
| 223 | #define ACPI_MUL_8(a) _ACPI_MUL(a, 3) |
| 224 | #define ACPI_MOD_8(a) _ACPI_MOD(a, 8) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 225 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 226 | #define ACPI_DIV_16(a) _ACPI_DIV(a, 4) |
| 227 | #define ACPI_MUL_16(a) _ACPI_MUL(a, 4) |
| 228 | #define ACPI_MOD_16(a) _ACPI_MOD(a, 16) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 229 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 230 | #define ACPI_DIV_32(a) _ACPI_DIV(a, 5) |
| 231 | #define ACPI_MUL_32(a) _ACPI_MUL(a, 5) |
| 232 | #define ACPI_MOD_32(a) _ACPI_MOD(a, 32) |
Bob Moore | 28f55eb | 2005-12-02 18:27:00 -0500 | [diff] [blame] | 233 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 234 | /* |
| 235 | * Rounding macros (Power of two boundaries only) |
| 236 | */ |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 237 | #define ACPI_ROUND_DOWN(value, boundary) (((acpi_size)(value)) & \ |
| 238 | (~(((acpi_size) boundary)-1))) |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 239 | |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 240 | #define ACPI_ROUND_UP(value, boundary) ((((acpi_size)(value)) + \ |
| 241 | (((acpi_size) boundary)-1)) & \ |
| 242 | (~(((acpi_size) boundary)-1))) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 243 | |
Bob Moore | 67a119f | 2008-06-10 13:42:13 +0800 | [diff] [blame] | 244 | /* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 245 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 246 | #define ACPI_ROUND_DOWN_TO_32BIT(a) ACPI_ROUND_DOWN(a, 4) |
| 247 | #define ACPI_ROUND_DOWN_TO_64BIT(a) ACPI_ROUND_DOWN(a, 8) |
| 248 | #define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a) ACPI_ROUND_DOWN(a, sizeof(acpi_size)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 249 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 250 | #define ACPI_ROUND_UP_TO_32BIT(a) ACPI_ROUND_UP(a, 4) |
| 251 | #define ACPI_ROUND_UP_TO_64BIT(a) ACPI_ROUND_UP(a, 8) |
| 252 | #define ACPI_ROUND_UP_TO_NATIVE_WORD(a) ACPI_ROUND_UP(a, sizeof(acpi_size)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 253 | |
Bob Moore | ea936b7 | 2006-02-17 00:00:00 -0500 | [diff] [blame] | 254 | #define ACPI_ROUND_BITS_UP_TO_BYTES(a) ACPI_DIV_8((a) + 7) |
| 255 | #define ACPI_ROUND_BITS_DOWN_TO_BYTES(a) ACPI_DIV_8((a)) |
| 256 | |
| 257 | #define ACPI_ROUND_UP_TO_1K(a) (((a) + 1023) >> 10) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 258 | |
| 259 | /* Generic (non-power-of-two) rounding */ |
| 260 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 261 | #define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary)) |
Bob Moore | ea936b7 | 2006-02-17 00:00:00 -0500 | [diff] [blame] | 262 | |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 263 | #define ACPI_IS_MISALIGNED(value) (((acpi_size) value) & (sizeof(acpi_size)-1)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 264 | |
| 265 | /* |
| 266 | * Bitmask creation |
| 267 | * Bit positions start at zero. |
| 268 | * MASK_BITS_ABOVE creates a mask starting AT the position and above |
| 269 | * MASK_BITS_BELOW creates a mask starting one bit BELOW the position |
| 270 | */ |
Bob Moore | 5df7e6c | 2010-01-21 10:06:32 +0800 | [diff] [blame] | 271 | #define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((u32) (position)))) |
| 272 | #define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((u32) (position))) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 273 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 274 | /* Bitfields within ACPI registers */ |
| 275 | |
Bob Moore | be030a5 | 2012-08-17 13:07:54 +0800 | [diff] [blame] | 276 | #define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) \ |
| 277 | ((val << pos) & mask) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 278 | |
Bob Moore | be030a5 | 2012-08-17 13:07:54 +0800 | [diff] [blame] | 279 | #define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) \ |
| 280 | reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask) |
| 281 | |
| 282 | #define ACPI_INSERT_BITS(target, mask, source) \ |
| 283 | target = ((target & (~(mask))) | (source & mask)) |
| 284 | |
| 285 | /* Generic bitfield macros and masks */ |
| 286 | |
| 287 | #define ACPI_GET_BITS(source_ptr, position, mask) \ |
| 288 | ((*source_ptr >> position) & mask) |
| 289 | |
| 290 | #define ACPI_SET_BITS(target_ptr, position, mask, value) \ |
| 291 | (*target_ptr |= ((value & mask) << position)) |
| 292 | |
| 293 | #define ACPI_1BIT_MASK 0x00000001 |
| 294 | #define ACPI_2BIT_MASK 0x00000003 |
| 295 | #define ACPI_3BIT_MASK 0x00000007 |
| 296 | #define ACPI_4BIT_MASK 0x0000000F |
| 297 | #define ACPI_5BIT_MASK 0x0000001F |
| 298 | #define ACPI_6BIT_MASK 0x0000003F |
| 299 | #define ACPI_7BIT_MASK 0x0000007F |
| 300 | #define ACPI_8BIT_MASK 0x000000FF |
| 301 | #define ACPI_16BIT_MASK 0x0000FFFF |
| 302 | #define ACPI_24BIT_MASK 0x00FFFFFF |
Bob Moore | 967440e3 | 2006-06-23 17:04:00 -0400 | [diff] [blame] | 303 | |
Bob Moore | 2f3faab | 2012-12-19 05:38:18 +0000 | [diff] [blame] | 304 | /* Macros to extract flag bits from position zero */ |
| 305 | |
| 306 | #define ACPI_GET_1BIT_FLAG(value) ((value) & ACPI_1BIT_MASK) |
| 307 | #define ACPI_GET_2BIT_FLAG(value) ((value) & ACPI_2BIT_MASK) |
| 308 | #define ACPI_GET_3BIT_FLAG(value) ((value) & ACPI_3BIT_MASK) |
| 309 | #define ACPI_GET_4BIT_FLAG(value) ((value) & ACPI_4BIT_MASK) |
| 310 | |
| 311 | /* Macros to extract flag bits from position one and above */ |
| 312 | |
| 313 | #define ACPI_EXTRACT_1BIT_FLAG(field, position) (ACPI_GET_1BIT_FLAG ((field) >> position)) |
| 314 | #define ACPI_EXTRACT_2BIT_FLAG(field, position) (ACPI_GET_2BIT_FLAG ((field) >> position)) |
| 315 | #define ACPI_EXTRACT_3BIT_FLAG(field, position) (ACPI_GET_3BIT_FLAG ((field) >> position)) |
| 316 | #define ACPI_EXTRACT_4BIT_FLAG(field, position) (ACPI_GET_4BIT_FLAG ((field) >> position)) |
| 317 | |
Bob Moore | 04a81dc | 2012-12-31 00:05:17 +0000 | [diff] [blame] | 318 | /* ACPI Pathname helpers */ |
| 319 | |
| 320 | #define ACPI_IS_ROOT_PREFIX(c) ((c) == (u8) 0x5C) /* Backslash */ |
| 321 | #define ACPI_IS_PARENT_PREFIX(c) ((c) == (u8) 0x5E) /* Carat */ |
| 322 | #define ACPI_IS_PATH_SEPARATOR(c) ((c) == (u8) 0x2E) /* Period (dot) */ |
| 323 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 324 | /* |
Bob Moore | cf48958 | 2012-07-16 09:52:27 +0800 | [diff] [blame] | 325 | * An object of type struct acpi_namespace_node can appear in some contexts |
| 326 | * where a pointer to an object of type union acpi_operand_object can also |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 327 | * appear. This macro is used to distinguish them. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 328 | * |
Jung-uk Kim | 1af8927 | 2013-03-08 09:21:54 +0000 | [diff] [blame] | 329 | * The "DescriptorType" field is the second field in both structures. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 330 | */ |
Jung-uk Kim | 1af8927 | 2013-03-08 09:21:54 +0000 | [diff] [blame] | 331 | #define ACPI_GET_DESCRIPTOR_PTR(d) (((union acpi_descriptor *)(void *)(d))->common.common_pointer) |
Bob Moore | f1778eb | 2013-03-08 09:22:03 +0000 | [diff] [blame] | 332 | #define ACPI_SET_DESCRIPTOR_PTR(d, p) (((union acpi_descriptor *)(void *)(d))->common.common_pointer = (p)) |
Bob Moore | 61686124 | 2006-03-17 16:44:00 -0500 | [diff] [blame] | 333 | #define ACPI_GET_DESCRIPTOR_TYPE(d) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type) |
Bob Moore | f1778eb | 2013-03-08 09:22:03 +0000 | [diff] [blame] | 334 | #define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = (t)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 335 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 336 | /* |
| 337 | * Macros for the master AML opcode table |
| 338 | */ |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 339 | #if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT) |
| 340 | #define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \ |
| 341 | {name, (u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 342 | #else |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 343 | #define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \ |
| 344 | {(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type} |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 345 | #endif |
| 346 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 347 | #define ARG_TYPE_WIDTH 5 |
| 348 | #define ARG_1(x) ((u32)(x)) |
| 349 | #define ARG_2(x) ((u32)(x) << (1 * ARG_TYPE_WIDTH)) |
| 350 | #define ARG_3(x) ((u32)(x) << (2 * ARG_TYPE_WIDTH)) |
| 351 | #define ARG_4(x) ((u32)(x) << (3 * ARG_TYPE_WIDTH)) |
| 352 | #define ARG_5(x) ((u32)(x) << (4 * ARG_TYPE_WIDTH)) |
| 353 | #define ARG_6(x) ((u32)(x) << (5 * ARG_TYPE_WIDTH)) |
| 354 | |
| 355 | #define ARGI_LIST1(a) (ARG_1(a)) |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 356 | #define ARGI_LIST2(a, b) (ARG_1(b)|ARG_2(a)) |
| 357 | #define ARGI_LIST3(a, b, c) (ARG_1(c)|ARG_2(b)|ARG_3(a)) |
| 358 | #define ARGI_LIST4(a, b, c, d) (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a)) |
| 359 | #define ARGI_LIST5(a, b, c, d, e) (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a)) |
| 360 | #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)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 361 | |
| 362 | #define ARGP_LIST1(a) (ARG_1(a)) |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 363 | #define ARGP_LIST2(a, b) (ARG_1(a)|ARG_2(b)) |
| 364 | #define ARGP_LIST3(a, b, c) (ARG_1(a)|ARG_2(b)|ARG_3(c)) |
| 365 | #define ARGP_LIST4(a, b, c, d) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)) |
| 366 | #define ARGP_LIST5(a, b, c, d, e) (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)) |
| 367 | #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)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 368 | |
| 369 | #define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F)) |
| 370 | #define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH)) |
| 371 | |
Bob Moore | 4a90c7e | 2006-01-13 16:22:00 -0500 | [diff] [blame] | 372 | /* |
| 373 | * Ascii error messages can be configured out |
| 374 | */ |
| 375 | #ifndef ACPI_NO_ERROR_MESSAGES |
Bob Moore | 4a90c7e | 2006-01-13 16:22:00 -0500 | [diff] [blame] | 376 | /* |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 377 | * Error reporting. Callers module and line number are inserted by AE_INFO, |
| 378 | * the plist contains a set of parens to allow variable-length lists. |
| 379 | * These macros are used for both the debug and non-debug versions of the code. |
Bob Moore | 4a90c7e | 2006-01-13 16:22:00 -0500 | [diff] [blame] | 380 | */ |
Bob Moore | e1405ca | 2013-05-30 09:59:21 +0800 | [diff] [blame] | 381 | #define ACPI_ERROR_NAMESPACE(s, e) acpi_ut_namespace_error (AE_INFO, s, e); |
| 382 | #define ACPI_ERROR_METHOD(s, n, p, e) acpi_ut_method_error (AE_INFO, s, n, p, e); |
| 383 | #define ACPI_WARN_PREDEFINED(plist) acpi_ut_predefined_warning plist |
| 384 | #define ACPI_INFO_PREDEFINED(plist) acpi_ut_predefined_info plist |
| 385 | #define ACPI_BIOS_ERROR_PREDEFINED(plist) acpi_ut_predefined_bios_error plist |
Bob Moore | 4a90c7e | 2006-01-13 16:22:00 -0500 | [diff] [blame] | 386 | |
Bob Moore | 4a90c7e | 2006-01-13 16:22:00 -0500 | [diff] [blame] | 387 | #else |
| 388 | |
| 389 | /* No error messages */ |
| 390 | |
Bob Moore | c9bdd80 | 2008-08-04 09:54:17 +0800 | [diff] [blame] | 391 | #define ACPI_ERROR_NAMESPACE(s, e) |
| 392 | #define ACPI_ERROR_METHOD(s, n, p, e) |
Bob Moore | 0444e8f | 2009-06-24 13:38:02 +0800 | [diff] [blame] | 393 | #define ACPI_WARN_PREDEFINED(plist) |
Bob Moore | 7df200c | 2009-11-12 09:18:45 +0800 | [diff] [blame] | 394 | #define ACPI_INFO_PREDEFINED(plist) |
Bob Moore | e1405ca | 2013-05-30 09:59:21 +0800 | [diff] [blame] | 395 | #define ACPI_BIOS_ERROR_PREDEFINED(plist) |
Bob Moore | 7df200c | 2009-11-12 09:18:45 +0800 | [diff] [blame] | 396 | |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 397 | #endif /* ACPI_NO_ERROR_MESSAGES */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 398 | |
Bob Moore | 72a8887 | 2012-02-14 18:57:13 +0800 | [diff] [blame] | 399 | #if (!ACPI_REDUCED_HARDWARE) |
| 400 | #define ACPI_HW_OPTIONAL_FUNCTION(addr) addr |
| 401 | #else |
| 402 | #define ACPI_HW_OPTIONAL_FUNCTION(addr) NULL |
| 403 | #endif |
| 404 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 405 | /* |
| 406 | * Some code only gets executed when the debugger is built in. |
| 407 | * Note that this is entirely independent of whether the |
| 408 | * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not. |
| 409 | */ |
| 410 | #ifdef ACPI_DEBUGGER |
| 411 | #define ACPI_DEBUGGER_EXEC(a) a |
| 412 | #else |
| 413 | #define ACPI_DEBUGGER_EXEC(a) |
| 414 | #endif |
| 415 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 416 | /* |
Lv Zheng | 86ff0e5 | 2012-10-31 02:25:52 +0000 | [diff] [blame] | 417 | * Macros used for ACPICA utilities only |
| 418 | */ |
| 419 | |
| 420 | /* Generate a UUID */ |
| 421 | |
| 422 | #define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ |
| 423 | (a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \ |
| 424 | (b) & 0xFF, ((b) >> 8) & 0xFF, \ |
| 425 | (c) & 0xFF, ((c) >> 8) & 0xFF, \ |
| 426 | (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) |
| 427 | |
| 428 | #define ACPI_IS_OCTAL_DIGIT(d) (((char)(d) >= '0') && ((char)(d) <= '7')) |
Alexey Starikovskiy | 8bd108d | 2008-09-25 21:40:30 +0400 | [diff] [blame] | 429 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 430 | #endif /* ACMACROS_H */ |