[mirror_ubuntu-artful-kernel.git] / drivers / acpi / acpica / acmacros.h

/******************************************************************************
 *
 * Name: acmacros.h - C macros for the entire subsystem.
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2015, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef __ACMACROS_H__
#define __ACMACROS_H__

/*
 * Extract data using a pointer. Any more than a byte and we
 * get into potential aligment issues -- see the STORE macros below.
 * Use with care.
 */
#define ACPI_CAST8(ptr)                 ACPI_CAST_PTR (u8, (ptr))
#define ACPI_CAST16(ptr)                ACPI_CAST_PTR (u16, (ptr))
#define ACPI_CAST32(ptr)                ACPI_CAST_PTR (u32, (ptr))
#define ACPI_CAST64(ptr)                ACPI_CAST_PTR (u64, (ptr))
#define ACPI_GET8(ptr)                  (*ACPI_CAST8 (ptr))
#define ACPI_GET16(ptr)                 (*ACPI_CAST16 (ptr))
#define ACPI_GET32(ptr)                 (*ACPI_CAST32 (ptr))
#define ACPI_GET64(ptr)                 (*ACPI_CAST64 (ptr))
#define ACPI_SET8(ptr, val)             (*ACPI_CAST8 (ptr) = (u8) (val))
#define ACPI_SET16(ptr, val)            (*ACPI_CAST16 (ptr) = (u16) (val))
#define ACPI_SET32(ptr, val)            (*ACPI_CAST32 (ptr) = (u32) (val))
#define ACPI_SET64(ptr, val)            (*ACPI_CAST64 (ptr) = (u64) (val))

/*
 * printf() format helpers. These macros are workarounds for the difficulties
 * with emitting 64-bit integers and 64-bit pointers with the same code
 * for both 32-bit and 64-bit hosts.
 */
#define ACPI_FORMAT_UINT64(i)           ACPI_HIDWORD(i), ACPI_LODWORD(i)

#if ACPI_MACHINE_WIDTH == 64
#define ACPI_FORMAT_NATIVE_UINT(i)      ACPI_FORMAT_UINT64(i)
#define ACPI_FORMAT_TO_UINT(i)          ACPI_FORMAT_UINT64(i)
#define ACPI_PRINTF_UINT                 "0x%8.8X%8.8X"

#else
#define ACPI_FORMAT_NATIVE_UINT(i)      0, (u32) (i)
#define ACPI_FORMAT_TO_UINT(i)          (u32) (i)
#define ACPI_PRINTF_UINT                 "0x%8.8X"
#endif

/*
 * Macros for moving data around to/from buffers that are possibly unaligned.
 * If the hardware supports the transfer of unaligned data, just do the store.
 * Otherwise, we have to move one byte at a time.
 */
#ifdef ACPI_BIG_ENDIAN
/*
 * Macros for big-endian machines
 */

/* These macros reverse the bytes during the move, converting little-endian to big endian */

	 /* Big Endian      <==        Little Endian */
	 /*  Hi...Lo                     Lo...Hi     */
/* 16-bit source, 16/32/64 destination */

#define ACPI_MOVE_16_TO_16(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
			  ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];}

#define ACPI_MOVE_16_TO_32(d, s)        {(*(u32 *)(void *)(d))=0;\
					  ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
					  ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}

#define ACPI_MOVE_16_TO_64(d, s)        {(*(u64 *)(void *)(d))=0;\
							   ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
							   ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}

/* 32-bit source, 16/32/64 destination */

#define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */

#define ACPI_MOVE_32_TO_32(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
									  ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\
									  ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
									  ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}

#define ACPI_MOVE_32_TO_64(d, s)        {(*(u64 *)(void *)(d))=0;\
										   ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
										   ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
										   ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
										   ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}

/* 64-bit source, 16/32/64 destination */

#define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */

#define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)	/* Truncate to 32 */

#define ACPI_MOVE_64_TO_64(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
										 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\
										 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\
										 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\
										 ((  u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
										 ((  u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
										 ((  u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
										 ((  u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
#else
/*
 * Macros for little-endian machines
 */

#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED

/* The hardware supports unaligned transfers, just do the little-endian move */

/* 16-bit source, 16/32/64 destination */

#define ACPI_MOVE_16_TO_16(d, s)        *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
#define ACPI_MOVE_16_TO_32(d, s)        *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
#define ACPI_MOVE_16_TO_64(d, s)        *(u64 *)(void *)(d) = *(u16 *)(void *)(s)

/* 32-bit source, 16/32/64 destination */

#define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
#define ACPI_MOVE_32_TO_32(d, s)        *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
#define ACPI_MOVE_32_TO_64(d, s)        *(u64 *)(void *)(d) = *(u32 *)(void *)(s)

/* 64-bit source, 16/32/64 destination */

#define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
#define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)	/* Truncate to 32 */
#define ACPI_MOVE_64_TO_64(d, s)        *(u64 *)(void *)(d) = *(u64 *)(void *)(s)

#else
/*
 * The hardware does not support unaligned transfers. We must move the
 * data one byte at a time. These macros work whether the source or
 * the destination (or both) is/are unaligned. (Little-endian move)
 */

/* 16-bit source, 16/32/64 destination */

#define ACPI_MOVE_16_TO_16(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
										 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}

#define ACPI_MOVE_16_TO_32(d, s)        {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
#define ACPI_MOVE_16_TO_64(d, s)        {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}

/* 32-bit source, 16/32/64 destination */

#define ACPI_MOVE_32_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */

#define ACPI_MOVE_32_TO_32(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
										 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
										 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
										 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];}

#define ACPI_MOVE_32_TO_64(d, s)        {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}

/* 64-bit source, 16/32/64 destination */

#define ACPI_MOVE_64_TO_16(d, s)        ACPI_MOVE_16_TO_16(d, s)	/* Truncate to 16 */
#define ACPI_MOVE_64_TO_32(d, s)        ACPI_MOVE_32_TO_32(d, s)	/* Truncate to 32 */
#define ACPI_MOVE_64_TO_64(d, s)        {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
										 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
										 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
										 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\
										 ((  u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\
										 ((  u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\
										 ((  u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\
										 ((  u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];}
#endif
#endif

/*
 * Fast power-of-two math macros for non-optimized compilers
 */
#define _ACPI_DIV(value, power_of2)     ((u32) ((value) >> (power_of2)))
#define _ACPI_MUL(value, power_of2)     ((u32) ((value) << (power_of2)))
#define _ACPI_MOD(value, divisor)       ((u32) ((value) & ((divisor) -1)))

#define ACPI_DIV_2(a)                   _ACPI_DIV(a, 1)
#define ACPI_MUL_2(a)                   _ACPI_MUL(a, 1)
#define ACPI_MOD_2(a)                   _ACPI_MOD(a, 2)

#define ACPI_DIV_4(a)                   _ACPI_DIV(a, 2)
#define ACPI_MUL_4(a)                   _ACPI_MUL(a, 2)
#define ACPI_MOD_4(a)                   _ACPI_MOD(a, 4)

#define ACPI_DIV_8(a)                   _ACPI_DIV(a, 3)
#define ACPI_MUL_8(a)                   _ACPI_MUL(a, 3)
#define ACPI_MOD_8(a)                   _ACPI_MOD(a, 8)

#define ACPI_DIV_16(a)                  _ACPI_DIV(a, 4)
#define ACPI_MUL_16(a)                  _ACPI_MUL(a, 4)
#define ACPI_MOD_16(a)                  _ACPI_MOD(a, 16)

#define ACPI_DIV_32(a)                  _ACPI_DIV(a, 5)
#define ACPI_MUL_32(a)                  _ACPI_MUL(a, 5)
#define ACPI_MOD_32(a)                  _ACPI_MOD(a, 32)

/*
 * Rounding macros (Power of two boundaries only)
 */
#define ACPI_ROUND_DOWN(value, boundary)    (((acpi_size)(value)) & \
												(~(((acpi_size) boundary)-1)))

#define ACPI_ROUND_UP(value, boundary)      ((((acpi_size)(value)) + \
												(((acpi_size) boundary)-1)) & \
												(~(((acpi_size) boundary)-1)))

/* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */

#define ACPI_ROUND_DOWN_TO_32BIT(a)         ACPI_ROUND_DOWN(a, 4)
#define ACPI_ROUND_DOWN_TO_64BIT(a)         ACPI_ROUND_DOWN(a, 8)
#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)   ACPI_ROUND_DOWN(a, sizeof(acpi_size))

#define ACPI_ROUND_UP_TO_32BIT(a)           ACPI_ROUND_UP(a, 4)
#define ACPI_ROUND_UP_TO_64BIT(a)           ACPI_ROUND_UP(a, 8)
#define ACPI_ROUND_UP_TO_NATIVE_WORD(a)     ACPI_ROUND_UP(a, sizeof(acpi_size))

#define ACPI_ROUND_BITS_UP_TO_BYTES(a)      ACPI_DIV_8((a) + 7)
#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)    ACPI_DIV_8((a))

#define ACPI_ROUND_UP_TO_1K(a)              (((a) + 1023) >> 10)

/* Generic (non-power-of-two) rounding */

#define ACPI_ROUND_UP_TO(value, boundary)   (((value) + ((boundary)-1)) / (boundary))

#define ACPI_IS_MISALIGNED(value)           (((acpi_size) value) & (sizeof(acpi_size)-1))

/*
 * Bitmask creation
 * Bit positions start at zero.
 * MASK_BITS_ABOVE creates a mask starting AT the position and above
 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
 */
#define ACPI_MASK_BITS_ABOVE(position)      (~((ACPI_UINT64_MAX) << ((u32) (position))))
#define ACPI_MASK_BITS_BELOW(position)      ((ACPI_UINT64_MAX) << ((u32) (position)))

/* Bitfields within ACPI registers */

#define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) \
	((val << pos) & mask)

#define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) \
	reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)

#define ACPI_INSERT_BITS(target, mask, source) \
	target = ((target & (~(mask))) | (source & mask))

/* Generic bitfield macros and masks */

#define ACPI_GET_BITS(source_ptr, position, mask) \
	((*source_ptr >> position) & mask)

#define ACPI_SET_BITS(target_ptr, position, mask, value) \
	(*target_ptr |= ((value & mask) << position))

#define ACPI_1BIT_MASK      0x00000001
#define ACPI_2BIT_MASK      0x00000003
#define ACPI_3BIT_MASK      0x00000007
#define ACPI_4BIT_MASK      0x0000000F
#define ACPI_5BIT_MASK      0x0000001F
#define ACPI_6BIT_MASK      0x0000003F
#define ACPI_7BIT_MASK      0x0000007F
#define ACPI_8BIT_MASK      0x000000FF
#define ACPI_16BIT_MASK     0x0000FFFF
#define ACPI_24BIT_MASK     0x00FFFFFF

/* Macros to extract flag bits from position zero */

#define ACPI_GET_1BIT_FLAG(value)                   ((value) & ACPI_1BIT_MASK)
#define ACPI_GET_2BIT_FLAG(value)                   ((value) & ACPI_2BIT_MASK)
#define ACPI_GET_3BIT_FLAG(value)                   ((value) & ACPI_3BIT_MASK)
#define ACPI_GET_4BIT_FLAG(value)                   ((value) & ACPI_4BIT_MASK)

/* Macros to extract flag bits from position one and above */

#define ACPI_EXTRACT_1BIT_FLAG(field, position)     (ACPI_GET_1BIT_FLAG ((field) >> position))
#define ACPI_EXTRACT_2BIT_FLAG(field, position)     (ACPI_GET_2BIT_FLAG ((field) >> position))
#define ACPI_EXTRACT_3BIT_FLAG(field, position)     (ACPI_GET_3BIT_FLAG ((field) >> position))
#define ACPI_EXTRACT_4BIT_FLAG(field, position)     (ACPI_GET_4BIT_FLAG ((field) >> position))

/* ACPI Pathname helpers */

#define ACPI_IS_ROOT_PREFIX(c)      ((c) == (u8) 0x5C)	/* Backslash */
#define ACPI_IS_PARENT_PREFIX(c)    ((c) == (u8) 0x5E)	/* Carat */
#define ACPI_IS_PATH_SEPARATOR(c)   ((c) == (u8) 0x2E)	/* Period (dot) */

/*
 * An object of type struct acpi_namespace_node can appear in some contexts
 * where a pointer to an object of type union acpi_operand_object can also
 * appear. This macro is used to distinguish them.
 *
 * The "DescriptorType" field is the second field in both structures.
 */
#define ACPI_GET_DESCRIPTOR_PTR(d)      (((union acpi_descriptor *)(void *)(d))->common.common_pointer)
#define ACPI_SET_DESCRIPTOR_PTR(d, p)   (((union acpi_descriptor *)(void *)(d))->common.common_pointer = (p))
#define ACPI_GET_DESCRIPTOR_TYPE(d)     (((union acpi_descriptor *)(void *)(d))->common.descriptor_type)
#define ACPI_SET_DESCRIPTOR_TYPE(d, t)  (((union acpi_descriptor *)(void *)(d))->common.descriptor_type = (t))

/*
 * Macros for the master AML opcode table
 */
#if defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
	{name, (u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
#else
#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
	{(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
#endif

#define ARG_TYPE_WIDTH                  5
#define ARG_1(x)                        ((u32)(x))
#define ARG_2(x)                        ((u32)(x) << (1 * ARG_TYPE_WIDTH))
#define ARG_3(x)                        ((u32)(x) << (2 * ARG_TYPE_WIDTH))
#define ARG_4(x)                        ((u32)(x) << (3 * ARG_TYPE_WIDTH))
#define ARG_5(x)                        ((u32)(x) << (4 * ARG_TYPE_WIDTH))
#define ARG_6(x)                        ((u32)(x) << (5 * ARG_TYPE_WIDTH))

#define ARGI_LIST1(a)                   (ARG_1(a))
#define ARGI_LIST2(a, b)                (ARG_1(b)|ARG_2(a))
#define ARGI_LIST3(a, b, c)             (ARG_1(c)|ARG_2(b)|ARG_3(a))
#define ARGI_LIST4(a, b, c, d)          (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
#define ARGI_LIST5(a, b, c, d, e)       (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
#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))

#define ARGP_LIST1(a)                   (ARG_1(a))
#define ARGP_LIST2(a, b)                (ARG_1(a)|ARG_2(b))
#define ARGP_LIST3(a, b, c)             (ARG_1(a)|ARG_2(b)|ARG_3(c))
#define ARGP_LIST4(a, b, c, d)          (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
#define ARGP_LIST5(a, b, c, d, e)       (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
#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))

#define GET_CURRENT_ARG_TYPE(list)      (list & ((u32) 0x1F))
#define INCREMENT_ARG_LIST(list)        (list >>= ((u32) ARG_TYPE_WIDTH))

/*
 * Ascii error messages can be configured out
 */
#ifndef ACPI_NO_ERROR_MESSAGES
/*
 * Error reporting. Callers module and line number are inserted by AE_INFO,
 * the plist contains a set of parens to allow variable-length lists.
 * These macros are used for both the debug and non-debug versions of the code.
 */
#define ACPI_ERROR_NAMESPACE(s, e)          acpi_ut_namespace_error (AE_INFO, s, e);
#define ACPI_ERROR_METHOD(s, n, p, e)       acpi_ut_method_error (AE_INFO, s, n, p, e);
#define ACPI_WARN_PREDEFINED(plist)         acpi_ut_predefined_warning plist
#define ACPI_INFO_PREDEFINED(plist)         acpi_ut_predefined_info plist
#define ACPI_BIOS_ERROR_PREDEFINED(plist)   acpi_ut_predefined_bios_error plist

#else

/* No error messages */

#define ACPI_ERROR_NAMESPACE(s, e)
#define ACPI_ERROR_METHOD(s, n, p, e)
#define ACPI_WARN_PREDEFINED(plist)
#define ACPI_INFO_PREDEFINED(plist)
#define ACPI_BIOS_ERROR_PREDEFINED(plist)

#endif				/* ACPI_NO_ERROR_MESSAGES */

#if (!ACPI_REDUCED_HARDWARE)
#define ACPI_HW_OPTIONAL_FUNCTION(addr)     addr
#else
#define ACPI_HW_OPTIONAL_FUNCTION(addr)     NULL
#endif

/*
 * Some code only gets executed when the debugger is built in.
 * Note that this is entirely independent of whether the
 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
 */
#ifdef ACPI_DEBUGGER
#define ACPI_DEBUGGER_EXEC(a)           a
#else
#define ACPI_DEBUGGER_EXEC(a)
#endif

/*
 * Macros used for ACPICA utilities only
 */

/* Generate a UUID */

#define ACPI_INIT_UUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
	(a) & 0xFF, ((a) >> 8) & 0xFF, ((a) >> 16) & 0xFF, ((a) >> 24) & 0xFF, \
	(b) & 0xFF, ((b) >> 8) & 0xFF, \
	(c) & 0xFF, ((c) >> 8) & 0xFF, \
	(d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7)

#define ACPI_IS_OCTAL_DIGIT(d)              (((char)(d) >= '0') && ((char)(d) <= '7'))

#endif				/* ACMACROS_H */
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Name: acmacros.h - C macros for the entire subsystem.
	4	*
	5	*****************************************************************************/
	6
	7	/*
82a80941	8	* Copyright (C) 2000 - 2015, Intel Corp.
1da177e4 LT	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
1da177e4	47	/*
c9bdd805	48	* Extract data using a pointer. Any more than a byte and we
defba1d8 BM	49	* get into potential aligment issues -- see the STORE macros below.
defba1d8 BM	50	* Use with care.
1da177e4	51	*/
57bf6aef LZ	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))
1da177e4	64
7823665e	65	/*
c03775c0 BM	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.
7823665e	69	*/
c9bdd805	70	#define ACPI_FORMAT_UINT64(i) ACPI_HIDWORD(i), ACPI_LODWORD(i)
7823665e BM	71
	72	#if ACPI_MACHINE_WIDTH == 64
	73	#define ACPI_FORMAT_NATIVE_UINT(i) ACPI_FORMAT_UINT64(i)
c03775c0 BM	74	#define ACPI_FORMAT_TO_UINT(i) ACPI_FORMAT_UINT64(i)
	75	#define ACPI_PRINTF_UINT "0x%8.8X%8.8X"
	76
7823665e	77	#else
c03775c0 BM	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"
7823665e BM	81	#endif
7823665e BM	82
1da177e4 LT	83	/*
	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
1da177e4 LT	93	/* These macros reverse the bytes during the move, converting little-endian to big endian */
1da177e4 LT	94
86ff0e50 LZ	95	/* Big Endian <== Little Endian */
86ff0e50 LZ	96	/* Hi...Lo Lo...Hi */
1da177e4 LT	97	/* 16-bit source, 16/32/64 destination */
1da177e4 LT	98
c9bdd805	99	#define ACPI_MOVE_16_TO_16(d, s) {(( u8 )(void )(d))[0] = ((u8 )(void )(s))[1];\
86ff0e50	100	(( u8 )(void )(d))[1] = ((u8 )(void )(s))[0];}
1da177e4	101
c9bdd805	102	#define ACPI_MOVE_16_TO_32(d, s) {((u32 )(void *)(d))=0;\
86ff0e50 LZ	103	((u8 )(void )(d))[2] = ((u8 )(void )(s))[1];\
86ff0e50 LZ	104	((u8 )(void )(d))[3] = ((u8 )(void )(s))[0];}
1da177e4	105
c9bdd805	106	#define ACPI_MOVE_16_TO_64(d, s) {((u64 )(void *)(d))=0;\
86ff0e50 LZ	107	((u8 )(void )(d))[6] = ((u8 )(void )(s))[1];\
86ff0e50 LZ	108	((u8 )(void )(d))[7] = ((u8 )(void )(s))[0];}
1da177e4 LT	109
	110	/* 32-bit source, 16/32/64 destination */
	111
c9bdd805	112	#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
1da177e4	113
c9bdd805	114	#define ACPI_MOVE_32_TO_32(d, s) {(( u8 )(void )(d))[0] = ((u8 )(void )(s))[3];\
86ff0e50 LZ	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];}
1da177e4	118
c9bdd805	119	#define ACPI_MOVE_32_TO_64(d, s) {((u64 )(void *)(d))=0;\
1da177e4 LT	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
c9bdd805	127	#define ACPI_MOVE_64_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
1da177e4	128
c9bdd805	129	#define ACPI_MOVE_64_TO_32(d, s) ACPI_MOVE_32_TO_32(d, s) /* Truncate to 32 */
1da177e4	130
c9bdd805	131	#define ACPI_MOVE_64_TO_64(d, s) {(( u8 )(void )(d))[0] = ((u8 )(void )(s))[7];\
1da177e4 LT	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
0897831b	144	#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
1da177e4 LT	145
	146	/* The hardware supports unaligned transfers, just do the little-endian move */
	147
1da177e4 LT	148	/* 16-bit source, 16/32/64 destination */
1da177e4 LT	149
c9bdd805 BM	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)
1da177e4 LT	153
	154	/* 32-bit source, 16/32/64 destination */
	155
c9bdd805 BM	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)
1da177e4 LT	159
	160	/* 64-bit source, 16/32/64 destination */
	161
c9bdd805 BM	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)
1da177e4 LT	165
	166	#else
	167	/*
c9bdd805 BM	168	* The hardware does not support unaligned transfers. We must move the
c9bdd805 BM	169	* data one byte at a time. These macros work whether the source or
50df4d8b	170	* the destination (or both) is/are unaligned. (Little-endian move)
1da177e4 LT	171	*/
	172
	173	/* 16-bit source, 16/32/64 destination */
	174
c9bdd805	175	#define ACPI_MOVE_16_TO_16(d, s) {(( u8 )(void )(d))[0] = ((u8 )(void )(s))[0];\
1da177e4 LT	176	(( u8 )(void )(d))[1] = ((u8 )(void )(s))[1];}
1da177e4 LT	177
c9bdd805 BM	178	#define ACPI_MOVE_16_TO_32(d, s) {((u32 )(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
c9bdd805 BM	179	#define ACPI_MOVE_16_TO_64(d, s) {((u64 )(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d, s);}
1da177e4 LT	180
	181	/* 32-bit source, 16/32/64 destination */
	182
c9bdd805	183	#define ACPI_MOVE_32_TO_16(d, s) ACPI_MOVE_16_TO_16(d, s) /* Truncate to 16 */
1da177e4	184
c9bdd805	185	#define ACPI_MOVE_32_TO_32(d, s) {(( u8 )(void )(d))[0] = ((u8 )(void )(s))[0];\
1da177e4 LT	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
c9bdd805	190	#define ACPI_MOVE_32_TO_64(d, s) {((u64 )(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d, s);}
1da177e4 LT	191
	192	/* 64-bit source, 16/32/64 destination */
	193
c9bdd805 BM	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];\
1da177e4 LT	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
1da177e4 LT	207	/*
	208	* Fast power-of-two math macros for non-optimized compilers
	209	*/
86ff0e50 LZ	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)))
1da177e4	213
c9bdd805 BM	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)
1da177e4	217
c9bdd805 BM	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)
1da177e4	221
c9bdd805 BM	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)
1da177e4	225
c9bdd805 BM	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)
1da177e4	229
c9bdd805 BM	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)
28f55ebc	233
1da177e4 LT	234	/*
	235	* Rounding macros (Power of two boundaries only)
	236	*/
86ff0e50 LZ	237	#define ACPI_ROUND_DOWN(value, boundary) (((acpi_size)(value)) & \
86ff0e50 LZ	238	(~(((acpi_size) boundary)-1)))
b8e4d893	239
86ff0e50 LZ	240	#define ACPI_ROUND_UP(value, boundary) ((((acpi_size)(value)) + \
	241	(((acpi_size) boundary)-1)) & \
	242	(~(((acpi_size) boundary)-1)))
1da177e4	243
67a119f9	244	/* Note: sizeof(acpi_size) evaluates to either 4 or 8 (32- vs 64-bit mode) */
1da177e4	245
c9bdd805 BM	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))
1da177e4	249
c9bdd805 BM	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))
1da177e4	253
ea936b78 BM	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)
1da177e4 LT	258
	259	/* Generic (non-power-of-two) rounding */
	260
c9bdd805	261	#define ACPI_ROUND_UP_TO(value, boundary) (((value) + ((boundary)-1)) / (boundary))
ea936b78	262
86ff0e50	263	#define ACPI_IS_MISALIGNED(value) (((acpi_size) value) & (sizeof(acpi_size)-1))
1da177e4 LT	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	*/
5df7e6cb BM	271	#define ACPI_MASK_BITS_ABOVE(position) (~((ACPI_UINT64_MAX) << ((u32) (position))))
5df7e6cb BM	272	#define ACPI_MASK_BITS_BELOW(position) ((ACPI_UINT64_MAX) << ((u32) (position)))
1da177e4	273
1da177e4 LT	274	/* Bitfields within ACPI registers */
1da177e4 LT	275
be030a57 BM	276	#define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) \
be030a57 BM	277	((val << pos) & mask)
1da177e4	278
be030a57 BM	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
967440e3	303
2f3faaba BM	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
04a81dce BM	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
1da177e4	324	/*
cf48958e BM	325	* An object of type struct acpi_namespace_node can appear in some contexts
cf48958e BM	326	* where a pointer to an object of type union acpi_operand_object can also
c9bdd805	327	* appear. This macro is used to distinguish them.
1da177e4	328	*
1af89271	329	* The "DescriptorType" field is the second field in both structures.
1da177e4	330	*/
1af89271	331	#define ACPI_GET_DESCRIPTOR_PTR(d) (((union acpi_descriptor )(void )(d))->common.common_pointer)
f1778eb1	332	#define ACPI_SET_DESCRIPTOR_PTR(d, p) (((union acpi_descriptor )(void )(d))->common.common_pointer = (p))
61686124	333	#define ACPI_GET_DESCRIPTOR_TYPE(d) (((union acpi_descriptor )(void )(d))->common.descriptor_type)
f1778eb1	334	#define ACPI_SET_DESCRIPTOR_TYPE(d, t) (((union acpi_descriptor )(void )(d))->common.descriptor_type = (t))
1da177e4	335
1da177e4 LT	336	/*
	337	* Macros for the master AML opcode table
	338	*/
c9bdd805 BM	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}
1da177e4	342	#else
c9bdd805 BM	343	#define ACPI_OP(name, Pargs, Iargs, obj_type, class, type, flags) \
c9bdd805 BM	344	{(u32)(Pargs), (u32)(Iargs), (u32)(flags), obj_type, class, type}
1da177e4 LT	345	#endif
1da177e4 LT	346
1da177e4 LT	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))
c9bdd805 BM	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))
1da177e4 LT	361
1da177e4 LT	362	#define ARGP_LIST1(a) (ARG_1(a))
c9bdd805 BM	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))
1da177e4 LT	368
	369	#define GET_CURRENT_ARG_TYPE(list) (list & ((u32) 0x1F))
	370	#define INCREMENT_ARG_LIST(list) (list >>= ((u32) ARG_TYPE_WIDTH))
	371
1da177e4	372	/*
4a90c7e8	373	* Ascii error messages can be configured out
1da177e4	374	*/
4a90c7e8	375	#ifndef ACPI_NO_ERROR_MESSAGES
4a90c7e8	376	/*
b8e4d893 BM	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.
4a90c7e8	380	*/
e1405ca5 BM	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
b8e4d893	386
1da177e4 LT	387	#else
1da177e4 LT	388
4a90c7e8	389	/* No error messages */
1da177e4	390
c9bdd805 BM	391	#define ACPI_ERROR_NAMESPACE(s, e)
c9bdd805 BM	392	#define ACPI_ERROR_METHOD(s, n, p, e)
0444e8f6	393	#define ACPI_WARN_PREDEFINED(plist)
7df200cd	394	#define ACPI_INFO_PREDEFINED(plist)
e1405ca5	395	#define ACPI_BIOS_ERROR_PREDEFINED(plist)
7df200cd	396
86ff0e50	397	#endif /* ACPI_NO_ERROR_MESSAGES */
1da177e4	398
72a8887a BM	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
1da177e4 LT	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
86ff0e50 LZ	416	/*
	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'))
8bd108d1	429
4be44fcd	430	#endif /* ACMACROS_H */