LXR linux/include/acpi/acpiosxf.h

   1
   2/******************************************************************************
   3 *
   4 * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL).  These
   5 *                    interfaces must be implemented by OSL to interface the
   6 *                    ACPI components to the host operating system.
   7 *
   8 *****************************************************************************/
   9
  10/*
  11 * Copyright (C) 2000 - 2008, Intel Corp.
  12 * All rights reserved.
  13 *
  14 * Redistribution and use in source and binary forms, with or without
  15 * modification, are permitted provided that the following conditions
  16 * are met:
  17 * 1. Redistributions of source code must retain the above copyright
  18 *    notice, this list of conditions, and the following disclaimer,
  19 *    without modification.
  20 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  21 *    substantially similar to the "NO WARRANTY" disclaimer below
  22 *    ("Disclaimer") and any redistribution must be conditioned upon
  23 *    including a substantially similar Disclaimer requirement for further
  24 *    binary redistribution.
  25 * 3. Neither the names of the above-listed copyright holders nor the names
  26 *    of any contributors may be used to endorse or promote products derived
  27 *    from this software without specific prior written permission.
  28 *
  29 * Alternatively, this software may be distributed under the terms of the
  30 * GNU General Public License ("GPL") version 2 as published by the Free
  31 * Software Foundation.
  32 *
  33 * NO WARRANTY
  34 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  35 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  36 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  37 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  38 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  39 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  40 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  41 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  42 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  43 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  44 * POSSIBILITY OF SUCH DAMAGES.
  45 */
  46
  47#ifndef __ACPIOSXF_H__
  48#define __ACPIOSXF_H__
  49
  50#include "platform/acenv.h"
  51#include "actypes.h"
  52
  53/* Types for acpi_os_execute */
  54
  55typedef enum {
  56        OSL_GLOBAL_LOCK_HANDLER,
  57        OSL_NOTIFY_HANDLER,
  58        OSL_GPE_HANDLER,
  59        OSL_DEBUGGER_THREAD,
  60        OSL_EC_POLL_HANDLER,
  61        OSL_EC_BURST_HANDLER
  62} acpi_execute_type;
  63
  64#define ACPI_NO_UNIT_LIMIT          ((u32) -1)
  65#define ACPI_MUTEX_SEM              1
  66
  67/* Functions for acpi_os_signal */
  68
  69#define ACPI_SIGNAL_FATAL           0
  70#define ACPI_SIGNAL_BREAKPOINT      1
  71
  72struct acpi_signal_fatal_info {
  73        u32 type;
  74        u32 code;
  75        u32 argument;
  76};
  77
  78/*
  79 * OSL Initialization and shutdown primitives
  80 */
  81acpi_status __initdata acpi_os_initialize(void);
  82
  83acpi_status acpi_os_terminate(void);
  84
  85/*
  86 * ACPI Table interfaces
  87 */
  88acpi_physical_address acpi_os_get_root_pointer(void);
  89
  90acpi_status
  91acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
  92                            acpi_string * new_val);
  93
  94acpi_status
  95acpi_os_table_override(struct acpi_table_header *existing_table,
  96                       struct acpi_table_header **new_table);
  97
  98/*
  99 * Spinlock primitives
 100 */
 101acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);
 102
 103void acpi_os_delete_lock(acpi_spinlock handle);
 104
 105acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
 106
 107void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
 108
 109/*
 110 * Semaphore primitives
 111 */
 112acpi_status
 113acpi_os_create_semaphore(u32 max_units,
 114                         u32 initial_units, acpi_semaphore * out_handle);
 115
 116acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
 117
 118acpi_status
 119acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
 120
 121acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
 122
 123/*
 124 * Mutex primitives. May be configured to use semaphores instead via
 125 * ACPI_MUTEX_TYPE (see platform/acenv.h)
 126 */
 127#if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
 128
 129acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
 130
 131void acpi_os_delete_mutex(acpi_mutex handle);
 132
 133acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
 134
 135void acpi_os_release_mutex(acpi_mutex handle);
 136#endif
 137
 138/*
 139 * Memory allocation and mapping
 140 */
 141void *acpi_os_allocate(acpi_size size);
 142
 143void __iomem *acpi_os_map_memory(acpi_physical_address where,
 144                                acpi_size length);
 145
 146void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
 147void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);
 148
 149#ifdef ACPI_FUTURE_USAGE
 150acpi_status
 151acpi_os_get_physical_address(void *logical_address,
 152                             acpi_physical_address * physical_address);
 153#endif
 154
 155/*
 156 * Memory/Object Cache
 157 */
 158acpi_status
 159acpi_os_create_cache(char *cache_name,
 160                     u16 object_size,
 161                     u16 max_depth, acpi_cache_t ** return_cache);
 162
 163acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
 164
 165acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
 166
 167void *acpi_os_acquire_object(acpi_cache_t * cache);
 168
 169acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
 170
 171/*
 172 * Interrupt handlers
 173 */
 174acpi_status
 175acpi_os_install_interrupt_handler(u32 gsi,
 176                                  acpi_osd_handler service_routine,
 177                                  void *context);
 178
 179acpi_status
 180acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);
 181
 182void acpi_os_gpe_count(u32 gpe_number);
 183void acpi_os_fixed_event_count(u32 fixed_event_number);
 184
 185/*
 186 * Threads and Scheduling
 187 */
 188acpi_thread_id acpi_os_get_thread_id(void);
 189
 190acpi_status
 191acpi_os_execute(acpi_execute_type type,
 192                acpi_osd_exec_callback function, void *context);
 193
 194acpi_status
 195acpi_os_hotplug_execute(acpi_osd_exec_callback function, void *context);
 196
 197void acpi_os_wait_events_complete(void *context);
 198
 199void acpi_os_sleep(acpi_integer milliseconds);
 200
 201void acpi_os_stall(u32 microseconds);
 202
 203/*
 204 * Platform and hardware-independent I/O interfaces
 205 */
 206acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
 207
 208acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
 209
 210/*
 211 * Platform and hardware-independent physical memory interfaces
 212 */
 213acpi_status
 214acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);
 215
 216acpi_status
 217acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);
 218
 219/*
 220 * Platform and hardware-independent PCI configuration space access
 221 * Note: Can't use "Register" as a parameter, changed to "Reg" --
 222 * certain compilers complain.
 223 */
 224acpi_status
 225acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
 226                               u32 reg, u32 *value, u32 width);
 227
 228acpi_status
 229acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
 230                                u32 reg, acpi_integer value, u32 width);
 231
 232/*
 233 * Interim function needed for PCI IRQ routing
 234 */
 235void
 236acpi_os_derive_pci_id(acpi_handle rhandle,
 237                      acpi_handle chandle, struct acpi_pci_id **pci_id);
 238
 239/*
 240 * Miscellaneous
 241 */
 242acpi_status acpi_os_validate_interface(char *interface);
 243acpi_status acpi_osi_invalidate(char* interface);
 244
 245acpi_status
 246acpi_os_validate_address(u8 space_id, acpi_physical_address address,
 247                         acpi_size length, char *name);
 248acpi_status
 249acpi_os_invalidate_address(u8 space_id, acpi_physical_address address,
 250                         acpi_size length);
 251
 252u64 acpi_os_get_timer(void);
 253
 254acpi_status acpi_os_signal(u32 function, void *info);
 255
 256/*
 257 * Debug print routines
 258 */
 259void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
 260
 261void acpi_os_vprintf(const char *format, va_list args);
 262
 263void acpi_os_redirect_output(void *destination);
 264
 265#ifdef ACPI_FUTURE_USAGE
 266/*
 267 * Debug input
 268 */
 269u32 acpi_os_get_line(char *buffer);
 270#endif
 271
 272/*
 273 * Directory manipulation
 274 */
 275void *acpi_os_open_directory(char *pathname,
 276                             char *wildcard_spec, char requested_file_type);
 277
 278/* requeste_file_type values */
 279
 280#define REQUEST_FILE_ONLY                   0
 281#define REQUEST_DIR_ONLY                    1
 282
 283char *acpi_os_get_next_filename(void *dir_handle);
 284
 285void acpi_os_close_directory(void *dir_handle);
 286
 287#endif                          /* __ACPIOSXF_H__ */
 288