Linux Audio

Check our new training course

Loading...
v3.1
  1/******************************************************************************
  2 *
  3 * Module Name: utxface - External interfaces for "global" ACPI functions
  4 *
  5 *****************************************************************************/
  6
  7/*
  8 * Copyright (C) 2000 - 2011, Intel Corp.
  9 * All rights reserved.
 10 *
 11 * Redistribution and use in source and binary forms, with or without
 12 * modification, are permitted provided that the following conditions
 13 * are met:
 14 * 1. Redistributions of source code must retain the above copyright
 15 *    notice, this list of conditions, and the following disclaimer,
 16 *    without modification.
 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 18 *    substantially similar to the "NO WARRANTY" disclaimer below
 19 *    ("Disclaimer") and any redistribution must be conditioned upon
 20 *    including a substantially similar Disclaimer requirement for further
 21 *    binary redistribution.
 22 * 3. Neither the names of the above-listed copyright holders nor the names
 23 *    of any contributors may be used to endorse or promote products derived
 24 *    from this software without specific prior written permission.
 25 *
 26 * Alternatively, this software may be distributed under the terms of the
 27 * GNU General Public License ("GPL") version 2 as published by the Free
 28 * Software Foundation.
 29 *
 30 * NO WARRANTY
 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 41 * POSSIBILITY OF SUCH DAMAGES.
 42 */
 43
 
 
 44#include <acpi/acpi.h>
 45#include "accommon.h"
 46#include "acevents.h"
 47#include "acnamesp.h"
 48#include "acdebug.h"
 49#include "actables.h"
 50
 51#define _COMPONENT          ACPI_UTILITIES
 52ACPI_MODULE_NAME("utxface")
 53
 54#ifndef ACPI_ASL_COMPILER
 55/*******************************************************************************
 56 *
 57 * FUNCTION:    acpi_initialize_subsystem
 58 *
 59 * PARAMETERS:  None
 60 *
 61 * RETURN:      Status
 62 *
 63 * DESCRIPTION: Initializes all global variables.  This is the first function
 64 *              called, so any early initialization belongs here.
 65 *
 66 ******************************************************************************/
 67acpi_status __init acpi_initialize_subsystem(void)
 68{
 69	acpi_status status;
 70
 71	ACPI_FUNCTION_TRACE(acpi_initialize_subsystem);
 72
 73	acpi_gbl_startup_flags = ACPI_SUBSYSTEM_INITIALIZE;
 74	ACPI_DEBUG_EXEC(acpi_ut_init_stack_ptr_trace());
 75
 76	/* Initialize the OS-Dependent layer */
 77
 78	status = acpi_os_initialize();
 79	if (ACPI_FAILURE(status)) {
 80		ACPI_EXCEPTION((AE_INFO, status, "During OSL initialization"));
 81		return_ACPI_STATUS(status);
 82	}
 83
 84	/* Initialize all globals used by the subsystem */
 85
 86	status = acpi_ut_init_globals();
 87	if (ACPI_FAILURE(status)) {
 88		ACPI_EXCEPTION((AE_INFO, status,
 89				"During initialization of globals"));
 90		return_ACPI_STATUS(status);
 91	}
 92
 93	/* Create the default mutex objects */
 94
 95	status = acpi_ut_mutex_initialize();
 96	if (ACPI_FAILURE(status)) {
 97		ACPI_EXCEPTION((AE_INFO, status,
 98				"During Global Mutex creation"));
 99		return_ACPI_STATUS(status);
100	}
101
102	/*
103	 * Initialize the namespace manager and
104	 * the root of the namespace tree
105	 */
106	status = acpi_ns_root_initialize();
107	if (ACPI_FAILURE(status)) {
108		ACPI_EXCEPTION((AE_INFO, status,
109				"During Namespace initialization"));
110		return_ACPI_STATUS(status);
111	}
112
113	/* Initialize the global OSI interfaces list with the static names */
114
115	status = acpi_ut_initialize_interfaces();
116	if (ACPI_FAILURE(status)) {
117		ACPI_EXCEPTION((AE_INFO, status,
118				"During OSI interfaces initialization"));
119		return_ACPI_STATUS(status);
120	}
121
122	/* If configured, initialize the AML debugger */
123
124	ACPI_DEBUGGER_EXEC(status = acpi_db_initialize());
125	return_ACPI_STATUS(status);
126}
127
128/*******************************************************************************
129 *
130 * FUNCTION:    acpi_enable_subsystem
131 *
132 * PARAMETERS:  Flags           - Init/enable Options
133 *
134 * RETURN:      Status
135 *
136 * DESCRIPTION: Completes the subsystem initialization including hardware.
137 *              Puts system into ACPI mode if it isn't already.
138 *
139 ******************************************************************************/
140acpi_status acpi_enable_subsystem(u32 flags)
141{
142	acpi_status status = AE_OK;
143
144	ACPI_FUNCTION_TRACE(acpi_enable_subsystem);
145
146	/* Enable ACPI mode */
147
148	if (!(flags & ACPI_NO_ACPI_ENABLE)) {
149		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
150				  "[Init] Going into ACPI mode\n"));
151
152		acpi_gbl_original_mode = acpi_hw_get_mode();
153
154		status = acpi_enable();
155		if (ACPI_FAILURE(status)) {
156			ACPI_WARNING((AE_INFO, "AcpiEnable failed"));
157			return_ACPI_STATUS(status);
158		}
159	}
160
161	/*
162	 * Obtain a permanent mapping for the FACS. This is required for the
163	 * Global Lock and the Firmware Waking Vector
164	 */
165	status = acpi_tb_initialize_facs();
166	if (ACPI_FAILURE(status)) {
167		ACPI_WARNING((AE_INFO, "Could not map the FACS table"));
168		return_ACPI_STATUS(status);
169	}
170
171	/*
172	 * Install the default op_region handlers. These are installed unless
173	 * other handlers have already been installed via the
174	 * install_address_space_handler interface.
175	 */
176	if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
177		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
178				  "[Init] Installing default address space handlers\n"));
179
180		status = acpi_ev_install_region_handlers();
181		if (ACPI_FAILURE(status)) {
182			return_ACPI_STATUS(status);
183		}
184	}
185
186	/*
187	 * Initialize ACPI Event handling (Fixed and General Purpose)
188	 *
189	 * Note1: We must have the hardware and events initialized before we can
190	 * execute any control methods safely. Any control method can require
191	 * ACPI hardware support, so the hardware must be fully initialized before
192	 * any method execution!
193	 *
194	 * Note2: Fixed events are initialized and enabled here. GPEs are
195	 * initialized, but cannot be enabled until after the hardware is
196	 * completely initialized (SCI and global_lock activated)
197	 */
198	if (!(flags & ACPI_NO_EVENT_INIT)) {
199		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
200				  "[Init] Initializing ACPI events\n"));
201
202		status = acpi_ev_initialize_events();
203		if (ACPI_FAILURE(status)) {
204			return_ACPI_STATUS(status);
205		}
206	}
207
208	/*
209	 * Install the SCI handler and Global Lock handler. This completes the
210	 * hardware initialization.
211	 */
212	if (!(flags & ACPI_NO_HANDLER_INIT)) {
213		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
214				  "[Init] Installing SCI/GL handlers\n"));
215
216		status = acpi_ev_install_xrupt_handlers();
217		if (ACPI_FAILURE(status)) {
218			return_ACPI_STATUS(status);
219		}
220	}
221
222	return_ACPI_STATUS(status);
223}
224
225ACPI_EXPORT_SYMBOL(acpi_enable_subsystem)
226
227/*******************************************************************************
228 *
229 * FUNCTION:    acpi_initialize_objects
230 *
231 * PARAMETERS:  Flags           - Init/enable Options
232 *
233 * RETURN:      Status
234 *
235 * DESCRIPTION: Completes namespace initialization by initializing device
236 *              objects and executing AML code for Regions, buffers, etc.
237 *
238 ******************************************************************************/
239acpi_status acpi_initialize_objects(u32 flags)
240{
241	acpi_status status = AE_OK;
242
243	ACPI_FUNCTION_TRACE(acpi_initialize_objects);
244
245	/*
246	 * Run all _REG methods
247	 *
248	 * Note: Any objects accessed by the _REG methods will be automatically
249	 * initialized, even if they contain executable AML (see the call to
250	 * acpi_ns_initialize_objects below).
251	 */
252	if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
253		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
254				  "[Init] Executing _REG OpRegion methods\n"));
255
256		status = acpi_ev_initialize_op_regions();
257		if (ACPI_FAILURE(status)) {
258			return_ACPI_STATUS(status);
259		}
260	}
261
262	/*
263	 * Execute any module-level code that was detected during the table load
264	 * phase. Although illegal since ACPI 2.0, there are many machines that
265	 * contain this type of code. Each block of detected executable AML code
266	 * outside of any control method is wrapped with a temporary control
267	 * method object and placed on a global list. The methods on this list
268	 * are executed below.
269	 */
270	acpi_ns_exec_module_code_list();
271
272	/*
273	 * Initialize the objects that remain uninitialized. This runs the
274	 * executable AML that may be part of the declaration of these objects:
275	 * operation_regions, buffer_fields, Buffers, and Packages.
276	 */
277	if (!(flags & ACPI_NO_OBJECT_INIT)) {
278		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
279				  "[Init] Completing Initialization of ACPI Objects\n"));
280
281		status = acpi_ns_initialize_objects();
282		if (ACPI_FAILURE(status)) {
283			return_ACPI_STATUS(status);
284		}
285	}
286
287	/*
288	 * Initialize all device objects in the namespace. This runs the device
289	 * _STA and _INI methods.
290	 */
291	if (!(flags & ACPI_NO_DEVICE_INIT)) {
292		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
293				  "[Init] Initializing ACPI Devices\n"));
294
295		status = acpi_ns_initialize_devices();
296		if (ACPI_FAILURE(status)) {
297			return_ACPI_STATUS(status);
298		}
299	}
300
301	/*
302	 * Empty the caches (delete the cached objects) on the assumption that
303	 * the table load filled them up more than they will be at runtime --
304	 * thus wasting non-paged memory.
305	 */
306	status = acpi_purge_cached_objects();
307
308	acpi_gbl_startup_flags |= ACPI_INITIALIZED_OK;
309	return_ACPI_STATUS(status);
310}
311
312ACPI_EXPORT_SYMBOL(acpi_initialize_objects)
313
314#endif
315/*******************************************************************************
316 *
317 * FUNCTION:    acpi_terminate
318 *
319 * PARAMETERS:  None
320 *
321 * RETURN:      Status
322 *
323 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
324 *
325 ******************************************************************************/
326acpi_status acpi_terminate(void)
327{
328	acpi_status status;
329
330	ACPI_FUNCTION_TRACE(acpi_terminate);
331
332	/* Just exit if subsystem is already shutdown */
333
334	if (acpi_gbl_shutdown) {
335		ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
336		return_ACPI_STATUS(AE_OK);
337	}
338
339	/* Subsystem appears active, go ahead and shut it down */
340
341	acpi_gbl_shutdown = TRUE;
342	acpi_gbl_startup_flags = 0;
343	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
344
345	/* Terminate the AML Debugger if present */
346
347	ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
348
349	/* Shutdown and free all resources */
350
351	acpi_ut_subsystem_shutdown();
352
353	/* Free the mutex objects */
354
355	acpi_ut_mutex_terminate();
356
357#ifdef ACPI_DEBUGGER
358
359	/* Shut down the debugger */
360
361	acpi_db_terminate();
362#endif
363
364	/* Now we can shutdown the OS-dependent layer */
365
366	status = acpi_os_terminate();
367	return_ACPI_STATUS(status);
368}
369
370ACPI_EXPORT_SYMBOL(acpi_terminate)
371
372#ifndef ACPI_ASL_COMPILER
373#ifdef ACPI_FUTURE_USAGE
374/*******************************************************************************
375 *
376 * FUNCTION:    acpi_subsystem_status
377 *
378 * PARAMETERS:  None
379 *
380 * RETURN:      Status of the ACPI subsystem
381 *
382 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
383 *              before making any other calls, to ensure the subsystem
384 *              initialized successfully.
385 *
386 ******************************************************************************/
387acpi_status acpi_subsystem_status(void)
388{
389
390	if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
391		return (AE_OK);
392	} else {
393		return (AE_ERROR);
394	}
395}
396
397ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
398
399/*******************************************************************************
400 *
401 * FUNCTION:    acpi_get_system_info
402 *
403 * PARAMETERS:  out_buffer      - A buffer to receive the resources for the
404 *                                device
405 *
406 * RETURN:      Status          - the status of the call
407 *
408 * DESCRIPTION: This function is called to get information about the current
409 *              state of the ACPI subsystem.  It will return system information
410 *              in the out_buffer.
411 *
412 *              If the function fails an appropriate status will be returned
413 *              and the value of out_buffer is undefined.
414 *
415 ******************************************************************************/
416acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
417{
418	struct acpi_system_info *info_ptr;
419	acpi_status status;
420
421	ACPI_FUNCTION_TRACE(acpi_get_system_info);
422
423	/* Parameter validation */
424
425	status = acpi_ut_validate_buffer(out_buffer);
426	if (ACPI_FAILURE(status)) {
427		return_ACPI_STATUS(status);
428	}
429
430	/* Validate/Allocate/Clear caller buffer */
431
432	status =
433	    acpi_ut_initialize_buffer(out_buffer,
434				      sizeof(struct acpi_system_info));
435	if (ACPI_FAILURE(status)) {
436		return_ACPI_STATUS(status);
437	}
438
439	/*
440	 * Populate the return buffer
441	 */
442	info_ptr = (struct acpi_system_info *)out_buffer->pointer;
443
444	info_ptr->acpi_ca_version = ACPI_CA_VERSION;
445
446	/* System flags (ACPI capabilities) */
447
448	info_ptr->flags = ACPI_SYS_MODE_ACPI;
449
450	/* Timer resolution - 24 or 32 bits  */
451
452	if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
453		info_ptr->timer_resolution = 24;
454	} else {
455		info_ptr->timer_resolution = 32;
456	}
457
458	/* Clear the reserved fields */
459
460	info_ptr->reserved1 = 0;
461	info_ptr->reserved2 = 0;
462
463	/* Current debug levels */
464
465	info_ptr->debug_layer = acpi_dbg_layer;
466	info_ptr->debug_level = acpi_dbg_level;
467
468	return_ACPI_STATUS(AE_OK);
469}
470
471ACPI_EXPORT_SYMBOL(acpi_get_system_info)
472
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
473/*****************************************************************************
474 *
475 * FUNCTION:    acpi_install_initialization_handler
476 *
477 * PARAMETERS:  Handler             - Callback procedure
478 *              Function            - Not (currently) used, see below
479 *
480 * RETURN:      Status
481 *
482 * DESCRIPTION: Install an initialization handler
483 *
484 * TBD: When a second function is added, must save the Function also.
485 *
486 ****************************************************************************/
487acpi_status
488acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
489{
490
491	if (!handler) {
492		return (AE_BAD_PARAMETER);
493	}
494
495	if (acpi_gbl_init_handler) {
496		return (AE_ALREADY_EXISTS);
497	}
498
499	acpi_gbl_init_handler = handler;
500	return AE_OK;
501}
502
503ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
504#endif				/*  ACPI_FUTURE_USAGE  */
505
506/*****************************************************************************
507 *
508 * FUNCTION:    acpi_purge_cached_objects
509 *
510 * PARAMETERS:  None
511 *
512 * RETURN:      Status
513 *
514 * DESCRIPTION: Empty all caches (delete the cached objects)
515 *
516 ****************************************************************************/
517acpi_status acpi_purge_cached_objects(void)
518{
519	ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
520
521	(void)acpi_os_purge_cache(acpi_gbl_state_cache);
522	(void)acpi_os_purge_cache(acpi_gbl_operand_cache);
523	(void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
524	(void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
 
525	return_ACPI_STATUS(AE_OK);
526}
527
528ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
529
530/*****************************************************************************
531 *
532 * FUNCTION:    acpi_install_interface
533 *
534 * PARAMETERS:  interface_name      - The interface to install
535 *
536 * RETURN:      Status
537 *
538 * DESCRIPTION: Install an _OSI interface to the global list
539 *
540 ****************************************************************************/
541acpi_status acpi_install_interface(acpi_string interface_name)
542{
543	acpi_status status;
544	struct acpi_interface_info *interface_info;
545
546	/* Parameter validation */
547
548	if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
549		return (AE_BAD_PARAMETER);
550	}
551
552	(void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
 
 
 
553
554	/* Check if the interface name is already in the global list */
555
556	interface_info = acpi_ut_get_interface(interface_name);
557	if (interface_info) {
558		/*
559		 * The interface already exists in the list. This is OK if the
560		 * interface has been marked invalid -- just clear the bit.
561		 */
562		if (interface_info->flags & ACPI_OSI_INVALID) {
563			interface_info->flags &= ~ACPI_OSI_INVALID;
564			status = AE_OK;
565		} else {
566			status = AE_ALREADY_EXISTS;
567		}
568	} else {
569		/* New interface name, install into the global list */
570
571		status = acpi_ut_install_interface(interface_name);
572	}
573
574	acpi_os_release_mutex(acpi_gbl_osi_mutex);
575	return (status);
576}
577
578ACPI_EXPORT_SYMBOL(acpi_install_interface)
579
580/*****************************************************************************
581 *
582 * FUNCTION:    acpi_remove_interface
583 *
584 * PARAMETERS:  interface_name      - The interface to remove
585 *
586 * RETURN:      Status
587 *
588 * DESCRIPTION: Remove an _OSI interface from the global list
589 *
590 ****************************************************************************/
591acpi_status acpi_remove_interface(acpi_string interface_name)
592{
593	acpi_status status;
594
595	/* Parameter validation */
596
597	if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
598		return (AE_BAD_PARAMETER);
599	}
600
601	(void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
 
 
 
602
603	status = acpi_ut_remove_interface(interface_name);
604
605	acpi_os_release_mutex(acpi_gbl_osi_mutex);
606	return (status);
607}
608
609ACPI_EXPORT_SYMBOL(acpi_remove_interface)
610
611/*****************************************************************************
612 *
613 * FUNCTION:    acpi_install_interface_handler
614 *
615 * PARAMETERS:  Handler             - The _OSI interface handler to install
616 *                                    NULL means "remove existing handler"
617 *
618 * RETURN:      Status
619 *
620 * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
621 *              invoked during execution of the internal implementation of
622 *              _OSI. A NULL handler simply removes any existing handler.
623 *
624 ****************************************************************************/
625acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
626{
627	acpi_status status = AE_OK;
628
629	(void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
 
 
 
630
631	if (handler && acpi_gbl_interface_handler) {
632		status = AE_ALREADY_EXISTS;
633	} else {
634		acpi_gbl_interface_handler = handler;
635	}
636
637	acpi_os_release_mutex(acpi_gbl_osi_mutex);
638	return (status);
639}
640
641ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
642#endif				/* !ACPI_ASL_COMPILER */
v3.15
  1/******************************************************************************
  2 *
  3 * Module Name: utxface - External interfaces, miscellaneous utility functions
  4 *
  5 *****************************************************************************/
  6
  7/*
  8 * Copyright (C) 2000 - 2014, Intel Corp.
  9 * All rights reserved.
 10 *
 11 * Redistribution and use in source and binary forms, with or without
 12 * modification, are permitted provided that the following conditions
 13 * are met:
 14 * 1. Redistributions of source code must retain the above copyright
 15 *    notice, this list of conditions, and the following disclaimer,
 16 *    without modification.
 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 18 *    substantially similar to the "NO WARRANTY" disclaimer below
 19 *    ("Disclaimer") and any redistribution must be conditioned upon
 20 *    including a substantially similar Disclaimer requirement for further
 21 *    binary redistribution.
 22 * 3. Neither the names of the above-listed copyright holders nor the names
 23 *    of any contributors may be used to endorse or promote products derived
 24 *    from this software without specific prior written permission.
 25 *
 26 * Alternatively, this software may be distributed under the terms of the
 27 * GNU General Public License ("GPL") version 2 as published by the Free
 28 * Software Foundation.
 29 *
 30 * NO WARRANTY
 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 41 * POSSIBILITY OF SUCH DAMAGES.
 42 */
 43
 44#define EXPORT_ACPI_INTERFACES
 45
 46#include <acpi/acpi.h>
 47#include "accommon.h"
 
 
 48#include "acdebug.h"
 
 49
 50#define _COMPONENT          ACPI_UTILITIES
 51ACPI_MODULE_NAME("utxface")
 52
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 53/*******************************************************************************
 54 *
 55 * FUNCTION:    acpi_terminate
 56 *
 57 * PARAMETERS:  None
 58 *
 59 * RETURN:      Status
 60 *
 61 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
 62 *
 63 ******************************************************************************/
 64acpi_status __init acpi_terminate(void)
 65{
 66	acpi_status status;
 67
 68	ACPI_FUNCTION_TRACE(acpi_terminate);
 69
 70	/* Just exit if subsystem is already shutdown */
 71
 72	if (acpi_gbl_shutdown) {
 73		ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
 74		return_ACPI_STATUS(AE_OK);
 75	}
 76
 77	/* Subsystem appears active, go ahead and shut it down */
 78
 79	acpi_gbl_shutdown = TRUE;
 80	acpi_gbl_startup_flags = 0;
 81	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
 82
 83	/* Terminate the AML Debugger if present */
 84
 85	ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
 86
 87	/* Shutdown and free all resources */
 88
 89	acpi_ut_subsystem_shutdown();
 90
 91	/* Free the mutex objects */
 92
 93	acpi_ut_mutex_terminate();
 94
 95#ifdef ACPI_DEBUGGER
 96
 97	/* Shut down the debugger */
 98
 99	acpi_db_terminate();
100#endif
101
102	/* Now we can shutdown the OS-dependent layer */
103
104	status = acpi_os_terminate();
105	return_ACPI_STATUS(status);
106}
107
108ACPI_EXPORT_SYMBOL_INIT(acpi_terminate)
109
110#ifndef ACPI_ASL_COMPILER
111#ifdef ACPI_FUTURE_USAGE
112/*******************************************************************************
113 *
114 * FUNCTION:    acpi_subsystem_status
115 *
116 * PARAMETERS:  None
117 *
118 * RETURN:      Status of the ACPI subsystem
119 *
120 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
121 *              before making any other calls, to ensure the subsystem
122 *              initialized successfully.
123 *
124 ******************************************************************************/
125acpi_status acpi_subsystem_status(void)
126{
127
128	if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
129		return (AE_OK);
130	} else {
131		return (AE_ERROR);
132	}
133}
134
135ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
136
137/*******************************************************************************
138 *
139 * FUNCTION:    acpi_get_system_info
140 *
141 * PARAMETERS:  out_buffer      - A buffer to receive the resources for the
142 *                                device
143 *
144 * RETURN:      status          - the status of the call
145 *
146 * DESCRIPTION: This function is called to get information about the current
147 *              state of the ACPI subsystem. It will return system information
148 *              in the out_buffer.
149 *
150 *              If the function fails an appropriate status will be returned
151 *              and the value of out_buffer is undefined.
152 *
153 ******************************************************************************/
154acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
155{
156	struct acpi_system_info *info_ptr;
157	acpi_status status;
158
159	ACPI_FUNCTION_TRACE(acpi_get_system_info);
160
161	/* Parameter validation */
162
163	status = acpi_ut_validate_buffer(out_buffer);
164	if (ACPI_FAILURE(status)) {
165		return_ACPI_STATUS(status);
166	}
167
168	/* Validate/Allocate/Clear caller buffer */
169
170	status =
171	    acpi_ut_initialize_buffer(out_buffer,
172				      sizeof(struct acpi_system_info));
173	if (ACPI_FAILURE(status)) {
174		return_ACPI_STATUS(status);
175	}
176
177	/*
178	 * Populate the return buffer
179	 */
180	info_ptr = (struct acpi_system_info *)out_buffer->pointer;
181
182	info_ptr->acpi_ca_version = ACPI_CA_VERSION;
183
184	/* System flags (ACPI capabilities) */
185
186	info_ptr->flags = ACPI_SYS_MODE_ACPI;
187
188	/* Timer resolution - 24 or 32 bits  */
189
190	if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
191		info_ptr->timer_resolution = 24;
192	} else {
193		info_ptr->timer_resolution = 32;
194	}
195
196	/* Clear the reserved fields */
197
198	info_ptr->reserved1 = 0;
199	info_ptr->reserved2 = 0;
200
201	/* Current debug levels */
202
203	info_ptr->debug_layer = acpi_dbg_layer;
204	info_ptr->debug_level = acpi_dbg_level;
205
206	return_ACPI_STATUS(AE_OK);
207}
208
209ACPI_EXPORT_SYMBOL(acpi_get_system_info)
210
211/*******************************************************************************
212 *
213 * FUNCTION:    acpi_get_statistics
214 *
215 * PARAMETERS:  stats           - Where the statistics are returned
216 *
217 * RETURN:      status          - the status of the call
218 *
219 * DESCRIPTION: Get the contents of the various system counters
220 *
221 ******************************************************************************/
222acpi_status acpi_get_statistics(struct acpi_statistics *stats)
223{
224	ACPI_FUNCTION_TRACE(acpi_get_statistics);
225
226	/* Parameter validation */
227
228	if (!stats) {
229		return_ACPI_STATUS(AE_BAD_PARAMETER);
230	}
231
232	/* Various interrupt-based event counters */
233
234	stats->sci_count = acpi_sci_count;
235	stats->gpe_count = acpi_gpe_count;
236
237	ACPI_MEMCPY(stats->fixed_event_count, acpi_fixed_event_count,
238		    sizeof(acpi_fixed_event_count));
239
240	/* Other counters */
241
242	stats->method_count = acpi_method_count;
243
244	return_ACPI_STATUS(AE_OK);
245}
246
247ACPI_EXPORT_SYMBOL(acpi_get_statistics)
248
249/*****************************************************************************
250 *
251 * FUNCTION:    acpi_install_initialization_handler
252 *
253 * PARAMETERS:  handler             - Callback procedure
254 *              function            - Not (currently) used, see below
255 *
256 * RETURN:      Status
257 *
258 * DESCRIPTION: Install an initialization handler
259 *
260 * TBD: When a second function is added, must save the Function also.
261 *
262 ****************************************************************************/
263acpi_status
264acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
265{
266
267	if (!handler) {
268		return (AE_BAD_PARAMETER);
269	}
270
271	if (acpi_gbl_init_handler) {
272		return (AE_ALREADY_EXISTS);
273	}
274
275	acpi_gbl_init_handler = handler;
276	return (AE_OK);
277}
278
279ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
280#endif				/*  ACPI_FUTURE_USAGE  */
281
282/*****************************************************************************
283 *
284 * FUNCTION:    acpi_purge_cached_objects
285 *
286 * PARAMETERS:  None
287 *
288 * RETURN:      Status
289 *
290 * DESCRIPTION: Empty all caches (delete the cached objects)
291 *
292 ****************************************************************************/
293acpi_status acpi_purge_cached_objects(void)
294{
295	ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
296
297	(void)acpi_os_purge_cache(acpi_gbl_state_cache);
298	(void)acpi_os_purge_cache(acpi_gbl_operand_cache);
299	(void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
300	(void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
301
302	return_ACPI_STATUS(AE_OK);
303}
304
305ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
306
307/*****************************************************************************
308 *
309 * FUNCTION:    acpi_install_interface
310 *
311 * PARAMETERS:  interface_name      - The interface to install
312 *
313 * RETURN:      Status
314 *
315 * DESCRIPTION: Install an _OSI interface to the global list
316 *
317 ****************************************************************************/
318acpi_status acpi_install_interface(acpi_string interface_name)
319{
320	acpi_status status;
321	struct acpi_interface_info *interface_info;
322
323	/* Parameter validation */
324
325	if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
326		return (AE_BAD_PARAMETER);
327	}
328
329	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
330	if (ACPI_FAILURE(status)) {
331		return (status);
332	}
333
334	/* Check if the interface name is already in the global list */
335
336	interface_info = acpi_ut_get_interface(interface_name);
337	if (interface_info) {
338		/*
339		 * The interface already exists in the list. This is OK if the
340		 * interface has been marked invalid -- just clear the bit.
341		 */
342		if (interface_info->flags & ACPI_OSI_INVALID) {
343			interface_info->flags &= ~ACPI_OSI_INVALID;
344			status = AE_OK;
345		} else {
346			status = AE_ALREADY_EXISTS;
347		}
348	} else {
349		/* New interface name, install into the global list */
350
351		status = acpi_ut_install_interface(interface_name);
352	}
353
354	acpi_os_release_mutex(acpi_gbl_osi_mutex);
355	return (status);
356}
357
358ACPI_EXPORT_SYMBOL(acpi_install_interface)
359
360/*****************************************************************************
361 *
362 * FUNCTION:    acpi_remove_interface
363 *
364 * PARAMETERS:  interface_name      - The interface to remove
365 *
366 * RETURN:      Status
367 *
368 * DESCRIPTION: Remove an _OSI interface from the global list
369 *
370 ****************************************************************************/
371acpi_status acpi_remove_interface(acpi_string interface_name)
372{
373	acpi_status status;
374
375	/* Parameter validation */
376
377	if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
378		return (AE_BAD_PARAMETER);
379	}
380
381	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
382	if (ACPI_FAILURE(status)) {
383		return (status);
384	}
385
386	status = acpi_ut_remove_interface(interface_name);
387
388	acpi_os_release_mutex(acpi_gbl_osi_mutex);
389	return (status);
390}
391
392ACPI_EXPORT_SYMBOL(acpi_remove_interface)
393
394/*****************************************************************************
395 *
396 * FUNCTION:    acpi_install_interface_handler
397 *
398 * PARAMETERS:  handler             - The _OSI interface handler to install
399 *                                    NULL means "remove existing handler"
400 *
401 * RETURN:      Status
402 *
403 * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
404 *              invoked during execution of the internal implementation of
405 *              _OSI. A NULL handler simply removes any existing handler.
406 *
407 ****************************************************************************/
408acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
409{
410	acpi_status status;
411
412	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
413	if (ACPI_FAILURE(status)) {
414		return (status);
415	}
416
417	if (handler && acpi_gbl_interface_handler) {
418		status = AE_ALREADY_EXISTS;
419	} else {
420		acpi_gbl_interface_handler = handler;
421	}
422
423	acpi_os_release_mutex(acpi_gbl_osi_mutex);
424	return (status);
425}
426
427ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)
428
429/*****************************************************************************
430 *
431 * FUNCTION:    acpi_update_interfaces
432 *
433 * PARAMETERS:  action              - Actions to be performed during the
434 *                                    update
435 *
436 * RETURN:      Status
437 *
438 * DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
439 *              string or/and feature group strings.
440 *
441 ****************************************************************************/
442acpi_status acpi_update_interfaces(u8 action)
443{
444	acpi_status status;
445
446	status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
447	if (ACPI_FAILURE(status)) {
448		return (status);
449	}
450
451	status = acpi_ut_update_interfaces(action);
452
453	acpi_os_release_mutex(acpi_gbl_osi_mutex);
454	return (status);
455}
456
457/*****************************************************************************
458 *
459 * FUNCTION:    acpi_check_address_range
460 *
461 * PARAMETERS:  space_id            - Address space ID
462 *              address             - Start address
463 *              length              - Length
464 *              warn                - TRUE if warning on overlap desired
465 *
466 * RETURN:      Count of the number of conflicts detected.
467 *
468 * DESCRIPTION: Check if the input address range overlaps any of the
469 *              ASL operation region address ranges.
470 *
471 ****************************************************************************/
472
473u32
474acpi_check_address_range(acpi_adr_space_type space_id,
475			 acpi_physical_address address,
476			 acpi_size length, u8 warn)
477{
478	u32 overlaps;
479	acpi_status status;
480
481	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
482	if (ACPI_FAILURE(status)) {
483		return (0);
484	}
485
486	overlaps = acpi_ut_check_address_range(space_id, address,
487					       (u32)length, warn);
488
489	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
490	return (overlaps);
491}
492
493ACPI_EXPORT_SYMBOL(acpi_check_address_range)
494#endif				/* !ACPI_ASL_COMPILER */
495/*******************************************************************************
496 *
497 * FUNCTION:    acpi_decode_pld_buffer
498 *
499 * PARAMETERS:  in_buffer           - Buffer returned by _PLD method
500 *              length              - Length of the in_buffer
501 *              return_buffer       - Where the decode buffer is returned
502 *
503 * RETURN:      Status and the decoded _PLD buffer. User must deallocate
504 *              the buffer via ACPI_FREE.
505 *
506 * DESCRIPTION: Decode the bit-packed buffer returned by the _PLD method into
507 *              a local struct that is much more useful to an ACPI driver.
508 *
509 ******************************************************************************/
510acpi_status
511acpi_decode_pld_buffer(u8 *in_buffer,
512		       acpi_size length, struct acpi_pld_info ** return_buffer)
513{
514	struct acpi_pld_info *pld_info;
515	u32 *buffer = ACPI_CAST_PTR(u32, in_buffer);
516	u32 dword;
517
518	/* Parameter validation */
519
520	if (!in_buffer || !return_buffer || (length < 16)) {
521		return (AE_BAD_PARAMETER);
522	}
523
524	pld_info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pld_info));
525	if (!pld_info) {
526		return (AE_NO_MEMORY);
527	}
528
529	/* First 32-bit DWord */
530
531	ACPI_MOVE_32_TO_32(&dword, &buffer[0]);
532	pld_info->revision = ACPI_PLD_GET_REVISION(&dword);
533	pld_info->ignore_color = ACPI_PLD_GET_IGNORE_COLOR(&dword);
534	pld_info->color = ACPI_PLD_GET_COLOR(&dword);
535
536	/* Second 32-bit DWord */
537
538	ACPI_MOVE_32_TO_32(&dword, &buffer[1]);
539	pld_info->width = ACPI_PLD_GET_WIDTH(&dword);
540	pld_info->height = ACPI_PLD_GET_HEIGHT(&dword);
541
542	/* Third 32-bit DWord */
543
544	ACPI_MOVE_32_TO_32(&dword, &buffer[2]);
545	pld_info->user_visible = ACPI_PLD_GET_USER_VISIBLE(&dword);
546	pld_info->dock = ACPI_PLD_GET_DOCK(&dword);
547	pld_info->lid = ACPI_PLD_GET_LID(&dword);
548	pld_info->panel = ACPI_PLD_GET_PANEL(&dword);
549	pld_info->vertical_position = ACPI_PLD_GET_VERTICAL(&dword);
550	pld_info->horizontal_position = ACPI_PLD_GET_HORIZONTAL(&dword);
551	pld_info->shape = ACPI_PLD_GET_SHAPE(&dword);
552	pld_info->group_orientation = ACPI_PLD_GET_ORIENTATION(&dword);
553	pld_info->group_token = ACPI_PLD_GET_TOKEN(&dword);
554	pld_info->group_position = ACPI_PLD_GET_POSITION(&dword);
555	pld_info->bay = ACPI_PLD_GET_BAY(&dword);
556
557	/* Fourth 32-bit DWord */
558
559	ACPI_MOVE_32_TO_32(&dword, &buffer[3]);
560	pld_info->ejectable = ACPI_PLD_GET_EJECTABLE(&dword);
561	pld_info->ospm_eject_required = ACPI_PLD_GET_OSPM_EJECT(&dword);
562	pld_info->cabinet_number = ACPI_PLD_GET_CABINET(&dword);
563	pld_info->card_cage_number = ACPI_PLD_GET_CARD_CAGE(&dword);
564	pld_info->reference = ACPI_PLD_GET_REFERENCE(&dword);
565	pld_info->rotation = ACPI_PLD_GET_ROTATION(&dword);
566	pld_info->order = ACPI_PLD_GET_ORDER(&dword);
567
568	if (length >= ACPI_PLD_BUFFER_SIZE) {
569
570		/* Fifth 32-bit DWord (Revision 2 of _PLD) */
571
572		ACPI_MOVE_32_TO_32(&dword, &buffer[4]);
573		pld_info->vertical_offset = ACPI_PLD_GET_VERT_OFFSET(&dword);
574		pld_info->horizontal_offset = ACPI_PLD_GET_HORIZ_OFFSET(&dword);
575	}
576
577	*return_buffer = pld_info;
578	return (AE_OK);
579}
580
581ACPI_EXPORT_SYMBOL(acpi_decode_pld_buffer)