Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d13bd5a6 authored by Lv Zheng's avatar Lv Zheng Committed by Rafael J. Wysocki
Browse files

ACPICA: Linux headers: Add <acpi/platform/aclinuxex.h> 



From ACPICA's perspective, <acpi/actypes.h> should be included after
inclusion of <acpi/platform/acenv.h>.  But currently in Linux,
<acpi/platform/aclinux.h> included by <acpi/platform/acenv.h> has
included <acpi/actypes.h> to find ACPICA types for inline functions.

This causes the following problem:
1. Redundant code in <asm/acpi.h> and <acpi/platform/aclinux.h>:
   Linux must be careful to keep conditions for <acpi/actypes.h> inclusion
   consistent with the conditions for <acpi/platform/aclinux.h> inclusion.
   Which finally leads to the issue that we have to keep many useless macro
   definitions in <acpi/platform/aclinux.h> or <asm/acpi.h>.
   Such conditions include:
     COMPILER_DEPENDENT_UINT64
     COMPILER_DEPENDENT_INT64
     ACPI_INLINE
     ACPI_SYSTEM_XFACE
     ACPI_EXTERNAL_XFACE
     ACPI_INTERNAL_XFACE
     ACPI_INTERNAL_VAR_XFACE
     ACPI_MUTEX_TYPE
     DEBUGGER_THREADING
     ACPI_ACQUIRE_GLOBAL_LOCK
     ACPI_RELEASE_GLOBAL_LOCK
     ACPI_FLUSH_CPU_CACHE
   They have default implementations in <include/acpi/platform/acenv.h>
   while Linux need to keep a copy in <asm/acpi.h> to avoid build errors.

This patch introduces <acpi/platform/aclinuxex.h> to fix this issue by
splitting conditions and declarations (most of them are inline functions)
into 2 header files so that the wrong inclusion of <acpi/actypes.h> can be
removed from <acpi/platform/aclinux.h>.

This patch also removes old ACPI_NATIVE_INTERFACE_HEADER mechanism which is
not preferred by Linux and adds the platform/acenvex.h to be the solution
to solve this issue.

Signed-off-by: default avatarLv Zheng <lv.zheng@intel.com>
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 636fcfef

include/acpi/acpi.h

+1 −3
Original line number Diff line number Diff line
@@ -62,8 +62,6 @@ 
#include <acpi/acrestyp.h>		/* Resource Descriptor structs */

#include <acpi/acpiosxf.h>		/* OSL interfaces (ACPICA-to-OS) */

#include <acpi/acpixf.h>		/* ACPI core subsystem external interfaces */

#ifdef ACPI_NATIVE_INTERFACE_HEADER

#include ACPI_NATIVE_INTERFACE_HEADER

#endif

#include <acpi/platform/acenvex.h>	/* Extra environment-specific items */



#endif				/* __ACPI_H__ */

include/acpi/platform/acenvex.h

0 → 100644
+63 −0
Original line number Diff line number Diff line 
/******************************************************************************

 *

 * Name: acenvex.h - Extra host and compiler configuration

 *

 *****************************************************************************/



/*

 * Copyright (C) 2000 - 2014, 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 __ACENVEX_H__

#define __ACENVEX_H__



/*! [Begin] no source code translation */



/******************************************************************************

 *

 * Extra host configuration files. All ACPICA headers are included before

 * including these files.

 *

 *****************************************************************************/



#if defined(_LINUX) || defined(__linux__)

#include <acpi/platform/aclinuxex.h>



#endif



/*! [End] no source code translation !*/



#endif				/* __ACENVEX_H__ */

include/acpi/platform/aclinux.h

+36 −118
Original line number Diff line number Diff line
@@ -114,6 +114,42 @@ 
#define acpi_spinlock                       spinlock_t *

#define acpi_cpu_flags                      unsigned long



/* Use native linux version of acpi_os_allocate_zeroed */



#define USE_NATIVE_ALLOCATE_ZEROED



/*

 * Overrides for in-kernel ACPICA

 */

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory



/*

 * OSL interfaces used by debugger/disassembler

 */

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable



/*

 * OSL interfaces used by utilities

 */

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory



#else				/* !__KERNEL__ */



#include <stdarg.h>
@@ -159,122 +195,4 @@ 


#include <acpi/platform/acgcc.h>



#ifdef __KERNEL__



/*

 * FIXME: Inclusion of actypes.h

 * Linux kernel need this before defining inline OSL interfaces as

 * actypes.h need to be included to find ACPICA type definitions.

 * Since from ACPICA's perspective, the actypes.h should be included after

 * acenv.h (aclinux.h), this leads to a inclusion mis-ordering issue.

 */

#include <acpi/actypes.h>



/*

 * Overrides for in-kernel ACPICA

 */

acpi_status __init acpi_os_initialize(void);

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize



acpi_status acpi_os_terminate(void);

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate



/*

 * Memory allocation/deallocation

 */



/*

 * The irqs_disabled() check is for resume from RAM.

 * Interrupts are off during resume, just like they are for boot.

 * However, boot has  (system_state != SYSTEM_RUNNING)

 * to quiet __might_sleep() in kmalloc() and resume does not.

 */

static inline void *acpi_os_allocate(acpi_size size)

{

	return kmalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);

}



#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate



/* Use native linux version of acpi_os_allocate_zeroed */



static inline void *acpi_os_allocate_zeroed(acpi_size size)

{

	return kzalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);

}



#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed

#define USE_NATIVE_ALLOCATE_ZEROED



static inline void acpi_os_free(void *memory)

{

	kfree(memory);

}



#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free



static inline void *acpi_os_acquire_object(acpi_cache_t * cache)

{

	return kmem_cache_zalloc(cache,

				 irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);

}



#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object



static inline acpi_thread_id acpi_os_get_thread_id(void)

{

	return (acpi_thread_id) (unsigned long)current;

}



#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id



/*

 * When lockdep is enabled, the spin_lock_init() macro stringifies it's

 * argument and uses that as a name for the lock in debugging.

 * By executing spin_lock_init() in a macro the key changes from "lock" for

 * all locks to the name of the argument of acpi_os_create_lock(), which

 * prevents lockdep from reporting false positives for ACPICA locks.

 */

#define acpi_os_create_lock(__handle) \

	({ \

		spinlock_t *lock = ACPI_ALLOCATE(sizeof(*lock)); \

		if (lock) { \

			*(__handle) = lock; \

			spin_lock_init(*(__handle)); \

		} \

		lock ? AE_OK : AE_NO_MEMORY; \

	})

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock



void __iomem *acpi_os_map_memory(acpi_physical_address where, acpi_size length);

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory



void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory



/*

 * OSL interfaces used by debugger/disassembler

 */

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable



/*

 * OSL interfaces used by utilities

 */

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename

#define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory



/*

 * OSL interfaces added by Linux

 */

void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);



#endif				/* __KERNEL__ */



#endif				/* __ACLINUX_H__ */

include/acpi/platform/aclinuxex.h

0 → 100644
+116 −0
Original line number Diff line number Diff line 
/******************************************************************************

 *

 * Name: aclinuxex.h - Extra OS specific defines, etc. for Linux

 *

 *****************************************************************************/



/*

 * Copyright (C) 2000 - 2014, 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 __ACLINUXEX_H__

#define __ACLINUXEX_H__



#ifdef __KERNEL__



/*

 * Overrides for in-kernel ACPICA

 */

acpi_status __init acpi_os_initialize(void);



acpi_status acpi_os_terminate(void);



/*

 * The irqs_disabled() check is for resume from RAM.

 * Interrupts are off during resume, just like they are for boot.

 * However, boot has  (system_state != SYSTEM_RUNNING)

 * to quiet __might_sleep() in kmalloc() and resume does not.

 */

static inline void *acpi_os_allocate(acpi_size size)

{

	return kmalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);

}



static inline void *acpi_os_allocate_zeroed(acpi_size size)

{

	return kzalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);

}



static inline void acpi_os_free(void *memory)

{

	kfree(memory);

}



static inline void *acpi_os_acquire_object(acpi_cache_t * cache)

{

	return kmem_cache_zalloc(cache,

				 irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);

}



static inline acpi_thread_id acpi_os_get_thread_id(void)

{

	return (acpi_thread_id) (unsigned long)current;

}



/*

 * When lockdep is enabled, the spin_lock_init() macro stringifies it's

 * argument and uses that as a name for the lock in debugging.

 * By executing spin_lock_init() in a macro the key changes from "lock" for

 * all locks to the name of the argument of acpi_os_create_lock(), which

 * prevents lockdep from reporting false positives for ACPICA locks.

 */

#define acpi_os_create_lock(__handle) \

	({ \

		spinlock_t *lock = ACPI_ALLOCATE(sizeof(*lock)); \

		if (lock) { \

			*(__handle) = lock; \

			spin_lock_init(*(__handle)); \

		} \

		lock ? AE_OK : AE_NO_MEMORY; \

	})



void __iomem *acpi_os_map_memory(acpi_physical_address where, acpi_size length);



void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);



/*

 * OSL interfaces added by Linux

 */

void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);



#endif				/* __KERNEL__ */



#endif				/* __ACLINUXEX_H__ */