acpiosxf.h 7.8 KB

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