diff options
Diffstat (limited to 'include/acpi/acpiosxf.h')
| -rw-r--r-- | include/acpi/acpiosxf.h | 281 |
1 files changed, 281 insertions, 0 deletions
diff --git a/include/acpi/acpiosxf.h b/include/acpi/acpiosxf.h new file mode 100644 index 00000000..4543b6f7 --- /dev/null +++ b/include/acpi/acpiosxf.h @@ -0,0 +1,281 @@ + +/****************************************************************************** + * + * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL). These + * interfaces must be implemented by OSL to interface the + * ACPI components to the host operating system. + * + *****************************************************************************/ + +/* + * Copyright (C) 2000 - 2011, 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 __ACPIOSXF_H__ +#define __ACPIOSXF_H__ + +#include "platform/acenv.h" +#include "actypes.h" + +/* Types for acpi_os_execute */ + +typedef enum { + OSL_GLOBAL_LOCK_HANDLER, + OSL_NOTIFY_HANDLER, + OSL_GPE_HANDLER, + OSL_DEBUGGER_THREAD, + OSL_EC_POLL_HANDLER, + OSL_EC_BURST_HANDLER +} acpi_execute_type; + +#define ACPI_NO_UNIT_LIMIT ((u32) -1) +#define ACPI_MUTEX_SEM 1 + +/* Functions for acpi_os_signal */ + +#define ACPI_SIGNAL_FATAL 0 +#define ACPI_SIGNAL_BREAKPOINT 1 + +struct acpi_signal_fatal_info { + u32 type; + u32 code; + u32 argument; +}; + +/* + * OSL Initialization and shutdown primitives + */ +acpi_status __initdata acpi_os_initialize(void); + +acpi_status acpi_os_terminate(void); + +/* + * ACPI Table interfaces + */ +acpi_physical_address acpi_os_get_root_pointer(void); + +acpi_status +acpi_os_predefined_override(const struct acpi_predefined_names *init_val, + acpi_string * new_val); + +acpi_status +acpi_os_table_override(struct acpi_table_header *existing_table, + struct acpi_table_header **new_table); + +/* + * Spinlock primitives + */ + +#ifndef acpi_os_create_lock +acpi_status +acpi_os_create_lock(acpi_spinlock *out_handle); +#endif + +void acpi_os_delete_lock(acpi_spinlock handle); + +acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle); + +void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags); + +/* + * Semaphore primitives + */ +acpi_status +acpi_os_create_semaphore(u32 max_units, + u32 initial_units, acpi_semaphore * out_handle); + +acpi_status acpi_os_delete_semaphore(acpi_semaphore handle); + +acpi_status +acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout); + +acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units); + +/* + * Mutex primitives. May be configured to use semaphores instead via + * ACPI_MUTEX_TYPE (see platform/acenv.h) + */ +#if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE) + +acpi_status acpi_os_create_mutex(acpi_mutex * out_handle); + +void acpi_os_delete_mutex(acpi_mutex handle); + +acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout); + +void acpi_os_release_mutex(acpi_mutex handle); +#endif + +/* + * Memory allocation and mapping + */ +void *acpi_os_allocate(acpi_size size); + +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); +void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size); + +#ifdef ACPI_FUTURE_USAGE +acpi_status +acpi_os_get_physical_address(void *logical_address, + acpi_physical_address * physical_address); +#endif + +/* + * Memory/Object Cache + */ +acpi_status +acpi_os_create_cache(char *cache_name, + u16 object_size, + u16 max_depth, acpi_cache_t ** return_cache); + +acpi_status acpi_os_delete_cache(acpi_cache_t * cache); + +acpi_status acpi_os_purge_cache(acpi_cache_t * cache); + +void *acpi_os_acquire_object(acpi_cache_t * cache); + +acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object); + +/* + * Interrupt handlers + */ +acpi_status +acpi_os_install_interrupt_handler(u32 gsi, + acpi_osd_handler service_routine, + void *context); + +acpi_status +acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine); + +void acpi_os_gpe_count(u32 gpe_number); +void acpi_os_fixed_event_count(u32 fixed_event_number); + +/* + * Threads and Scheduling + */ +acpi_thread_id acpi_os_get_thread_id(void); + +acpi_status +acpi_os_execute(acpi_execute_type type, + acpi_osd_exec_callback function, void *context); + +acpi_status +acpi_os_hotplug_execute(acpi_osd_exec_callback function, void *context); + +void acpi_os_wait_events_complete(void *context); + +void acpi_os_sleep(u64 milliseconds); + +void acpi_os_stall(u32 microseconds); + +/* + * Platform and hardware-independent I/O interfaces + */ +acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width); + +acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width); + +/* + * Platform and hardware-independent physical memory interfaces + */ +acpi_status +acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width); + +acpi_status +acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width); + +/* + * Platform and hardware-independent PCI configuration space access + * Note: Can't use "Register" as a parameter, changed to "Reg" -- + * certain compilers complain. + */ +acpi_status +acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id, + u32 reg, u64 *value, u32 width); + +acpi_status +acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id, + u32 reg, u64 value, u32 width); + +/* + * Miscellaneous + */ +acpi_status +acpi_os_validate_address(u8 space_id, acpi_physical_address address, + acpi_size length, char *name); +acpi_status +acpi_os_invalidate_address(u8 space_id, acpi_physical_address address, + acpi_size length); + +u64 acpi_os_get_timer(void); + +acpi_status acpi_os_signal(u32 function, void *info); + +/* + * Debug print routines + */ +void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...); + +void acpi_os_vprintf(const char *format, va_list args); + +void acpi_os_redirect_output(void *destination); + +#ifdef ACPI_FUTURE_USAGE +/* + * Debug input + */ +u32 acpi_os_get_line(char *buffer); +#endif + +/* + * Directory manipulation + */ +void *acpi_os_open_directory(char *pathname, + char *wildcard_spec, char requested_file_type); + +/* requeste_file_type values */ + +#define REQUEST_FILE_ONLY 0 +#define REQUEST_DIR_ONLY 1 + +char *acpi_os_get_next_filename(void *dir_handle); + +void acpi_os_close_directory(void *dir_handle); + +#endif /* __ACPIOSXF_H__ */ |