mirror of
https://github.com/torvalds/linux.git
synced 2024-11-15 00:21:59 +00:00
7824f44ecf
This patch adds portable file IO to generic OSL to improve the portability of the applications. A portable application may use different file IO interfaces than the standard C library ones. This patch thus introduces an abstract file IO layer into the generic OSL. Note that this patch does not introduce users of such interfaces, further patches should introduce users one by one carefully with build tests performed. Lv Zheng. Signed-off-by: Lv Zheng <lv.zheng@intel.com> Signed-off-by: Bob Moore <robert.moore@intel.com> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
434 lines
12 KiB
C
434 lines
12 KiB
C
/******************************************************************************
|
|
*
|
|
* 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 - 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 __ACPIOSXF_H__
|
|
#define __ACPIOSXF_H__
|
|
|
|
#include <acpi/platform/acenv.h>
|
|
#include <acpi/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
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
|
|
acpi_status acpi_os_initialize(void);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
|
|
acpi_status acpi_os_terminate(void);
|
|
#endif
|
|
|
|
/*
|
|
* ACPI Table interfaces
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_root_pointer
|
|
acpi_physical_address acpi_os_get_root_pointer(void);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_predefined_override
|
|
acpi_status
|
|
acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
|
|
acpi_string * new_val);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_table_override
|
|
acpi_status
|
|
acpi_os_table_override(struct acpi_table_header *existing_table,
|
|
struct acpi_table_header **new_table);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_physical_table_override
|
|
acpi_status
|
|
acpi_os_physical_table_override(struct acpi_table_header *existing_table,
|
|
acpi_physical_address * new_address,
|
|
u32 *new_table_length);
|
|
#endif
|
|
|
|
/*
|
|
* Spinlock primitives
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
|
|
acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_lock
|
|
void acpi_os_delete_lock(acpi_spinlock handle);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_lock
|
|
acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_lock
|
|
void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
|
|
#endif
|
|
|
|
/*
|
|
* Semaphore primitives
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_semaphore
|
|
acpi_status
|
|
acpi_os_create_semaphore(u32 max_units,
|
|
u32 initial_units, acpi_semaphore * out_handle);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_semaphore
|
|
acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_semaphore
|
|
acpi_status
|
|
acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal_semaphore
|
|
acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
|
|
#endif
|
|
|
|
/*
|
|
* Mutex primitives. May be configured to use semaphores instead via
|
|
* ACPI_MUTEX_TYPE (see platform/acenv.h)
|
|
*/
|
|
#if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_mutex
|
|
acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_mutex
|
|
void acpi_os_delete_mutex(acpi_mutex handle);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_mutex
|
|
acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_mutex
|
|
void acpi_os_release_mutex(acpi_mutex handle);
|
|
#endif
|
|
|
|
#endif
|
|
|
|
/*
|
|
* Memory allocation and mapping
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
|
|
void *acpi_os_allocate(acpi_size size);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
|
|
void *acpi_os_allocate_zeroed(acpi_size size);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
|
|
void acpi_os_free(void *memory);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory
|
|
void *acpi_os_map_memory(acpi_physical_address where, acpi_size length);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory
|
|
void acpi_os_unmap_memory(void *logical_address, acpi_size size);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_physical_address
|
|
acpi_status
|
|
acpi_os_get_physical_address(void *logical_address,
|
|
acpi_physical_address * physical_address);
|
|
#endif
|
|
|
|
/*
|
|
* Memory/Object Cache
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_cache
|
|
acpi_status
|
|
acpi_os_create_cache(char *cache_name,
|
|
u16 object_size,
|
|
u16 max_depth, acpi_cache_t ** return_cache);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_cache
|
|
acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_purge_cache
|
|
acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
|
|
void *acpi_os_acquire_object(acpi_cache_t * cache);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_object
|
|
acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
|
|
#endif
|
|
|
|
/*
|
|
* Interrupt handlers
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_install_interrupt_handler
|
|
acpi_status
|
|
acpi_os_install_interrupt_handler(u32 interrupt_number,
|
|
acpi_osd_handler service_routine,
|
|
void *context);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_remove_interrupt_handler
|
|
acpi_status
|
|
acpi_os_remove_interrupt_handler(u32 interrupt_number,
|
|
acpi_osd_handler service_routine);
|
|
#endif
|
|
|
|
/*
|
|
* Threads and Scheduling
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
|
|
acpi_thread_id acpi_os_get_thread_id(void);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_execute
|
|
acpi_status
|
|
acpi_os_execute(acpi_execute_type type,
|
|
acpi_osd_exec_callback function, void *context);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_events_complete
|
|
void acpi_os_wait_events_complete(void);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_sleep
|
|
void acpi_os_sleep(u64 milliseconds);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_stall
|
|
void acpi_os_stall(u32 microseconds);
|
|
#endif
|
|
|
|
/*
|
|
* Platform and hardware-independent I/O interfaces
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_port
|
|
acpi_status acpi_os_read_port(acpi_io_address address, u32 *value, u32 width);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_port
|
|
acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
|
|
#endif
|
|
|
|
/*
|
|
* Platform and hardware-independent physical memory interfaces
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_memory
|
|
acpi_status
|
|
acpi_os_read_memory(acpi_physical_address address, u64 *value, u32 width);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_memory
|
|
acpi_status
|
|
acpi_os_write_memory(acpi_physical_address address, u64 value, u32 width);
|
|
#endif
|
|
|
|
/*
|
|
* Platform and hardware-independent PCI configuration space access
|
|
* Note: Can't use "Register" as a parameter, changed to "Reg" --
|
|
* certain compilers complain.
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_pci_configuration
|
|
acpi_status
|
|
acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
|
|
u32 reg, u64 *value, u32 width);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_pci_configuration
|
|
acpi_status
|
|
acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
|
|
u32 reg, u64 value, u32 width);
|
|
#endif
|
|
|
|
/*
|
|
* Miscellaneous
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
|
|
u8 acpi_os_readable(void *pointer, acpi_size length);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
|
|
u8 acpi_os_writable(void *pointer, acpi_size length);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_timer
|
|
u64 acpi_os_get_timer(void);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal
|
|
acpi_status acpi_os_signal(u32 function, void *info);
|
|
#endif
|
|
|
|
/*
|
|
* Debug print routines
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_printf
|
|
void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_vprintf
|
|
void acpi_os_vprintf(const char *format, va_list args);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
|
|
void acpi_os_redirect_output(void *destination);
|
|
#endif
|
|
|
|
/*
|
|
* Debug input
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line
|
|
acpi_status acpi_os_get_line(char *buffer, u32 buffer_length, u32 *bytes_read);
|
|
#endif
|
|
|
|
/*
|
|
* Obtain ACPI table(s)
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
|
|
acpi_status
|
|
acpi_os_get_table_by_name(char *signature,
|
|
u32 instance,
|
|
struct acpi_table_header **table,
|
|
acpi_physical_address * address);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
|
|
acpi_status
|
|
acpi_os_get_table_by_index(u32 index,
|
|
struct acpi_table_header **table,
|
|
u32 *instance, acpi_physical_address * address);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
|
|
acpi_status
|
|
acpi_os_get_table_by_address(acpi_physical_address address,
|
|
struct acpi_table_header **table);
|
|
#endif
|
|
|
|
/*
|
|
* Directory manipulation
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
|
|
void *acpi_os_open_directory(char *pathname,
|
|
char *wildcard_spec, char requested_file_type);
|
|
#endif
|
|
|
|
/* requeste_file_type values */
|
|
|
|
#define REQUEST_FILE_ONLY 0
|
|
#define REQUEST_DIR_ONLY 1
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
|
|
char *acpi_os_get_next_filename(void *dir_handle);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
|
|
void acpi_os_close_directory(void *dir_handle);
|
|
#endif
|
|
|
|
/*
|
|
* File I/O and related support
|
|
*/
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_file
|
|
ACPI_FILE acpi_os_open_file(const char *path, u8 modes);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_file
|
|
void acpi_os_close_file(ACPI_FILE file);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_file
|
|
int
|
|
acpi_os_read_file(ACPI_FILE file,
|
|
void *buffer, acpi_size size, acpi_size count);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_file
|
|
int
|
|
acpi_os_write_file(ACPI_FILE file,
|
|
void *buffer, acpi_size size, acpi_size count);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_file_offset
|
|
long acpi_os_get_file_offset(ACPI_FILE file);
|
|
#endif
|
|
|
|
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_set_file_offset
|
|
acpi_status acpi_os_set_file_offset(ACPI_FILE file, long offset, u8 from);
|
|
#endif
|
|
|
|
#endif /* __ACPIOSXF_H__ */
|