acpiosxf.h 13 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2
/******************************************************************************
 *
3
 * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL). These
Linus Torvalds's avatar
Linus Torvalds committed
4 5 6 7 8 9
 *                    interfaces must be implemented by OSL to interface the
 *                    ACPI components to the host operating system.
 *
 *****************************************************************************/

/*
10
 * Copyright (C) 2000 - 2016, Intel Corp.
Linus Torvalds's avatar
Linus Torvalds committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
 * 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__

49 50
#include <acpi/platform/acenv.h>
#include <acpi/actypes.h>
Linus Torvalds's avatar
Linus Torvalds committed
51

Bob Moore's avatar
Bob Moore committed
52
/* Types for acpi_os_execute */
Linus Torvalds's avatar
Linus Torvalds committed
53

Bob Moore's avatar
Bob Moore committed
54 55 56 57
typedef enum {
	OSL_GLOBAL_LOCK_HANDLER,
	OSL_NOTIFY_HANDLER,
	OSL_GPE_HANDLER,
58 59
	OSL_DEBUGGER_MAIN_THREAD,
	OSL_DEBUGGER_EXEC_THREAD,
Bob Moore's avatar
Bob Moore committed
60
	OSL_EC_POLL_HANDLER,
Bob Moore's avatar
Bob Moore committed
61
	OSL_EC_BURST_HANDLER
Bob Moore's avatar
Bob Moore committed
62
} acpi_execute_type;
Linus Torvalds's avatar
Linus Torvalds committed
63 64 65 66 67 68 69 70 71

#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

72 73 74 75
struct acpi_signal_fatal_info {
	u32 type;
	u32 code;
	u32 argument;
Linus Torvalds's avatar
Linus Torvalds committed
76 77 78 79 80
};

/*
 * OSL Initialization and shutdown primitives
 */
81
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
82
acpi_status acpi_os_initialize(void);
83
#endif
Linus Torvalds's avatar
Linus Torvalds committed
84

85
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
86
acpi_status acpi_os_terminate(void);
87
#endif
Linus Torvalds's avatar
Linus Torvalds committed
88 89 90 91

/*
 * ACPI Table interfaces
 */
92
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_root_pointer
93
acpi_physical_address acpi_os_get_root_pointer(void);
94
#endif
Linus Torvalds's avatar
Linus Torvalds committed
95

96
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_predefined_override
Linus Torvalds's avatar
Linus Torvalds committed
97
acpi_status
98
acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
99
			    acpi_string *new_val);
100
#endif
Linus Torvalds's avatar
Linus Torvalds committed
101

102
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_table_override
Linus Torvalds's avatar
Linus Torvalds committed
103
acpi_status
104 105
acpi_os_table_override(struct acpi_table_header *existing_table,
		       struct acpi_table_header **new_table);
106
#endif
Linus Torvalds's avatar
Linus Torvalds committed
107

108
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_physical_table_override
109 110
acpi_status
acpi_os_physical_table_override(struct acpi_table_header *existing_table,
111
				acpi_physical_address *new_address,
112
				u32 *new_table_length);
113
#endif
114

Linus Torvalds's avatar
Linus Torvalds committed
115
/*
Bob Moore's avatar
Bob Moore committed
116 117
 * Spinlock primitives
 */
118
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
119
acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);
120
#endif
121

122
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_lock
Bob Moore's avatar
Bob Moore committed
123
void acpi_os_delete_lock(acpi_spinlock handle);
124
#endif
Bob Moore's avatar
Bob Moore committed
125

126
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_lock
Bob Moore's avatar
Bob Moore committed
127
acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
128
#endif
Bob Moore's avatar
Bob Moore committed
129

130
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_lock
Bob Moore's avatar
Bob Moore committed
131
void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
132
#endif
Bob Moore's avatar
Bob Moore committed
133 134 135

/*
 * Semaphore primitives
Linus Torvalds's avatar
Linus Torvalds committed
136
 */
137
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_semaphore
Linus Torvalds's avatar
Linus Torvalds committed
138
acpi_status
139
acpi_os_create_semaphore(u32 max_units,
Bob Moore's avatar
Bob Moore committed
140
			 u32 initial_units, acpi_semaphore * out_handle);
141
#endif
Linus Torvalds's avatar
Linus Torvalds committed
142

143
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_semaphore
Bob Moore's avatar
Bob Moore committed
144
acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
145
#endif
Linus Torvalds's avatar
Linus Torvalds committed
146

147
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_semaphore
Bob Moore's avatar
Bob Moore committed
148 149
acpi_status
acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
150
#endif
Bob Moore's avatar
Bob Moore committed
151

152
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal_semaphore
Bob Moore's avatar
Bob Moore committed
153
acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
154
#endif
Bob Moore's avatar
Bob Moore committed
155 156

/*
157 158
 * Mutex primitives. May be configured to use semaphores instead via
 * ACPI_MUTEX_TYPE (see platform/acenv.h)
Bob Moore's avatar
Bob Moore committed
159
 */
160 161
#if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)

162
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_mutex
Bob Moore's avatar
Bob Moore committed
163
acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
164
#endif
Linus Torvalds's avatar
Linus Torvalds committed
165

166
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_mutex
Bob Moore's avatar
Bob Moore committed
167
void acpi_os_delete_mutex(acpi_mutex handle);
168
#endif
Linus Torvalds's avatar
Linus Torvalds committed
169

170
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_mutex
Bob Moore's avatar
Bob Moore committed
171
acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
172
#endif
Linus Torvalds's avatar
Linus Torvalds committed
173

174
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_mutex
Bob Moore's avatar
Bob Moore committed
175
void acpi_os_release_mutex(acpi_mutex handle);
176
#endif
Linus Torvalds's avatar
Linus Torvalds committed
177

178 179
#endif

Linus Torvalds's avatar
Linus Torvalds committed
180 181 182
/*
 * Memory allocation and mapping
 */
183
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
184
void *acpi_os_allocate(acpi_size size);
185
#endif
Linus Torvalds's avatar
Linus Torvalds committed
186

187
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
188
void *acpi_os_allocate_zeroed(acpi_size size);
189
#endif
190

191
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
192
void acpi_os_free(void *memory);
193
#endif
194

195
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory
196
void *acpi_os_map_memory(acpi_physical_address where, acpi_size length);
197
#endif
Linus Torvalds's avatar
Linus Torvalds committed
198

199
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory
200
void acpi_os_unmap_memory(void *logical_address, acpi_size size);
201
#endif
Linus Torvalds's avatar
Linus Torvalds committed
202

203
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_physical_address
Linus Torvalds's avatar
Linus Torvalds committed
204
acpi_status
205
acpi_os_get_physical_address(void *logical_address,
206
			     acpi_physical_address *physical_address);
Linus Torvalds's avatar
Linus Torvalds committed
207 208
#endif

209 210 211
/*
 * Memory/Object Cache
 */
212
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_cache
213
acpi_status
214 215 216
acpi_os_create_cache(char *cache_name,
		     u16 object_size,
		     u16 max_depth, acpi_cache_t ** return_cache);
217
#endif
218

219
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_cache
220
acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
221
#endif
222

223
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_purge_cache
224
acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
225
#endif
226

227
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
228
void *acpi_os_acquire_object(acpi_cache_t * cache);
229
#endif
230

231
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_object
232
acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
233
#endif
234

Linus Torvalds's avatar
Linus Torvalds committed
235 236 237
/*
 * Interrupt handlers
 */
238
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_install_interrupt_handler
Linus Torvalds's avatar
Linus Torvalds committed
239
acpi_status
240
acpi_os_install_interrupt_handler(u32 interrupt_number,
241 242
				  acpi_osd_handler service_routine,
				  void *context);
243
#endif
Linus Torvalds's avatar
Linus Torvalds committed
244

245
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_remove_interrupt_handler
Linus Torvalds's avatar
Linus Torvalds committed
246
acpi_status
247 248
acpi_os_remove_interrupt_handler(u32 interrupt_number,
				 acpi_osd_handler service_routine);
249
#endif
Linus Torvalds's avatar
Linus Torvalds committed
250 251 252 253

/*
 * Threads and Scheduling
 */
254
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
Bob Moore's avatar
Bob Moore committed
255
acpi_thread_id acpi_os_get_thread_id(void);
256
#endif
Linus Torvalds's avatar
Linus Torvalds committed
257

258
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_execute
Linus Torvalds's avatar
Linus Torvalds committed
259
acpi_status
Bob Moore's avatar
Bob Moore committed
260 261
acpi_os_execute(acpi_execute_type type,
		acpi_osd_exec_callback function, void *context);
262
#endif
Linus Torvalds's avatar
Linus Torvalds committed
263

264
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_events_complete
265
void acpi_os_wait_events_complete(void);
266
#endif
Linus Torvalds's avatar
Linus Torvalds committed
267

268
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_sleep
269
void acpi_os_sleep(u64 milliseconds);
270
#endif
Linus Torvalds's avatar
Linus Torvalds committed
271

272
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_stall
273
void acpi_os_stall(u32 microseconds);
274
#endif
Linus Torvalds's avatar
Linus Torvalds committed
275 276 277 278

/*
 * Platform and hardware-independent I/O interfaces
 */
279 280 281
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_port
acpi_status acpi_os_read_port(acpi_io_address address, u32 *value, u32 width);
#endif
Linus Torvalds's avatar
Linus Torvalds committed
282

283
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_port
284
acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
285
#endif
Linus Torvalds's avatar
Linus Torvalds committed
286 287 288 289

/*
 * Platform and hardware-independent physical memory interfaces
 */
290
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_memory
Linus Torvalds's avatar
Linus Torvalds committed
291
acpi_status
292
acpi_os_read_memory(acpi_physical_address address, u64 *value, u32 width);
293
#endif
Linus Torvalds's avatar
Linus Torvalds committed
294

295
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_memory
Linus Torvalds's avatar
Linus Torvalds committed
296
acpi_status
297
acpi_os_write_memory(acpi_physical_address address, u64 value, u32 width);
298
#endif
Linus Torvalds's avatar
Linus Torvalds committed
299 300 301 302 303 304

/*
 * Platform and hardware-independent PCI configuration space access
 * Note: Can't use "Register" as a parameter, changed to "Reg" --
 * certain compilers complain.
 */
305
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_pci_configuration
Linus Torvalds's avatar
Linus Torvalds committed
306
acpi_status
307
acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
308
			       u32 reg, u64 *value, u32 width);
309
#endif
Linus Torvalds's avatar
Linus Torvalds committed
310

311
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_pci_configuration
Linus Torvalds's avatar
Linus Torvalds committed
312
acpi_status
313
acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
314
				u32 reg, u64 value, u32 width);
315
#endif
Linus Torvalds's avatar
Linus Torvalds committed
316 317 318 319

/*
 * Miscellaneous
 */
320 321 322 323 324 325 326 327 328
#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
329
u64 acpi_os_get_timer(void);
330
#endif
Linus Torvalds's avatar
Linus Torvalds committed
331

332
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal
333
acpi_status acpi_os_signal(u32 function, void *info);
334
#endif
Linus Torvalds's avatar
Linus Torvalds committed
335 336 337 338

/*
 * Debug print routines
 */
339
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_printf
340
void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
341
#endif
Linus Torvalds's avatar
Linus Torvalds committed
342

343
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_vprintf
344
void acpi_os_vprintf(const char *format, va_list args);
345
#endif
Linus Torvalds's avatar
Linus Torvalds committed
346

347
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
348
void acpi_os_redirect_output(void *destination);
349
#endif
Linus Torvalds's avatar
Linus Torvalds committed
350 351

/*
352
 * Debug IO
Linus Torvalds's avatar
Linus Torvalds committed
353
 */
354 355 356 357
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line
acpi_status acpi_os_get_line(char *buffer, u32 buffer_length, u32 *bytes_read);
#endif

358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize_command_signals
acpi_status acpi_os_initialize_command_signals(void);
#endif

#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate_command_signals
void acpi_os_terminate_command_signals(void);
#endif

#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_command_ready
acpi_status acpi_os_wait_command_ready(void);
#endif

#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_notify_command_complete
acpi_status acpi_os_notify_command_complete(void);
#endif

374 375 376 377 378 379 380 381
/*
 * 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,
382
			  acpi_physical_address *address);
383 384 385 386 387 388
#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,
389
			   u32 *instance, acpi_physical_address *address);
390 391 392 393 394 395
#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);
Linus Torvalds's avatar
Linus Torvalds committed
396 397 398 399 400
#endif

/*
 * Directory manipulation
 */
401
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
402 403
void *acpi_os_open_directory(char *pathname,
			     char *wildcard_spec, char requested_file_type);
404
#endif
Linus Torvalds's avatar
Linus Torvalds committed
405 406 407 408 409 410

/* requeste_file_type values */

#define REQUEST_FILE_ONLY                   0
#define REQUEST_DIR_ONLY                    1

411
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
412
char *acpi_os_get_next_filename(void *dir_handle);
413
#endif
Linus Torvalds's avatar
Linus Torvalds committed
414

415
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
416
void acpi_os_close_directory(void *dir_handle);
417
#endif
Linus Torvalds's avatar
Linus Torvalds committed
418

419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
/*
 * 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

450 451 452 453 454 455
#ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_trace_point
void
acpi_os_trace_point(acpi_trace_event_type type,
		    u8 begin, u8 *aml, char *pathname);
#endif

456
#endif				/* __ACPIOSXF_H__ */