1 /******************************************************************************
3 * Module Name: utxface - External interfaces, miscellaneous utility functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <linux/export.h>
45 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_UTILITIES
50 ACPI_MODULE_NAME("utxface")
52 /*******************************************************************************
54 * FUNCTION: acpi_terminate
60 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
62 ******************************************************************************/
63 acpi_status acpi_terminate(void)
67 ACPI_FUNCTION_TRACE(acpi_terminate);
69 /* Just exit if subsystem is already shutdown */
71 if (acpi_gbl_shutdown) {
72 ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
73 return_ACPI_STATUS(AE_OK);
76 /* Subsystem appears active, go ahead and shut it down */
78 acpi_gbl_shutdown = TRUE;
79 acpi_gbl_startup_flags = 0;
80 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
82 /* Terminate the AML Debugger if present */
84 ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
86 /* Shutdown and free all resources */
88 acpi_ut_subsystem_shutdown();
90 /* Free the mutex objects */
92 acpi_ut_mutex_terminate();
96 /* Shut down the debugger */
101 /* Now we can shutdown the OS-dependent layer */
103 status = acpi_os_terminate();
104 return_ACPI_STATUS(status);
107 ACPI_EXPORT_SYMBOL(acpi_terminate)
109 #ifndef ACPI_ASL_COMPILER
110 #ifdef ACPI_FUTURE_USAGE
111 /*******************************************************************************
113 * FUNCTION: acpi_subsystem_status
117 * RETURN: Status of the ACPI subsystem
119 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
120 * before making any other calls, to ensure the subsystem
121 * initialized successfully.
123 ******************************************************************************/
124 acpi_status acpi_subsystem_status(void)
127 if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
134 ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
136 /*******************************************************************************
138 * FUNCTION: acpi_get_system_info
140 * PARAMETERS: out_buffer - A buffer to receive the resources for the
143 * RETURN: status - the status of the call
145 * DESCRIPTION: This function is called to get information about the current
146 * state of the ACPI subsystem. It will return system information
149 * If the function fails an appropriate status will be returned
150 * and the value of out_buffer is undefined.
152 ******************************************************************************/
153 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
155 struct acpi_system_info *info_ptr;
158 ACPI_FUNCTION_TRACE(acpi_get_system_info);
160 /* Parameter validation */
162 status = acpi_ut_validate_buffer(out_buffer);
163 if (ACPI_FAILURE(status)) {
164 return_ACPI_STATUS(status);
167 /* Validate/Allocate/Clear caller buffer */
170 acpi_ut_initialize_buffer(out_buffer,
171 sizeof(struct acpi_system_info));
172 if (ACPI_FAILURE(status)) {
173 return_ACPI_STATUS(status);
177 * Populate the return buffer
179 info_ptr = (struct acpi_system_info *)out_buffer->pointer;
181 info_ptr->acpi_ca_version = ACPI_CA_VERSION;
183 /* System flags (ACPI capabilities) */
185 info_ptr->flags = ACPI_SYS_MODE_ACPI;
187 /* Timer resolution - 24 or 32 bits */
189 if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
190 info_ptr->timer_resolution = 24;
192 info_ptr->timer_resolution = 32;
195 /* Clear the reserved fields */
197 info_ptr->reserved1 = 0;
198 info_ptr->reserved2 = 0;
200 /* Current debug levels */
202 info_ptr->debug_layer = acpi_dbg_layer;
203 info_ptr->debug_level = acpi_dbg_level;
205 return_ACPI_STATUS(AE_OK);
208 ACPI_EXPORT_SYMBOL(acpi_get_system_info)
210 /*****************************************************************************
212 * FUNCTION: acpi_install_initialization_handler
214 * PARAMETERS: handler - Callback procedure
215 * function - Not (currently) used, see below
219 * DESCRIPTION: Install an initialization handler
221 * TBD: When a second function is added, must save the Function also.
223 ****************************************************************************/
225 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
229 return (AE_BAD_PARAMETER);
232 if (acpi_gbl_init_handler) {
233 return (AE_ALREADY_EXISTS);
236 acpi_gbl_init_handler = handler;
240 ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
241 #endif /* ACPI_FUTURE_USAGE */
243 /*****************************************************************************
245 * FUNCTION: acpi_purge_cached_objects
251 * DESCRIPTION: Empty all caches (delete the cached objects)
253 ****************************************************************************/
254 acpi_status acpi_purge_cached_objects(void)
256 ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
258 (void)acpi_os_purge_cache(acpi_gbl_state_cache);
259 (void)acpi_os_purge_cache(acpi_gbl_operand_cache);
260 (void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
261 (void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
263 return_ACPI_STATUS(AE_OK);
266 ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
268 /*****************************************************************************
270 * FUNCTION: acpi_install_interface
272 * PARAMETERS: interface_name - The interface to install
276 * DESCRIPTION: Install an _OSI interface to the global list
278 ****************************************************************************/
279 acpi_status acpi_install_interface(acpi_string interface_name)
282 struct acpi_interface_info *interface_info;
284 /* Parameter validation */
286 if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
287 return (AE_BAD_PARAMETER);
290 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
291 if (ACPI_FAILURE(status)) {
295 /* Check if the interface name is already in the global list */
297 interface_info = acpi_ut_get_interface(interface_name);
298 if (interface_info) {
300 * The interface already exists in the list. This is OK if the
301 * interface has been marked invalid -- just clear the bit.
303 if (interface_info->flags & ACPI_OSI_INVALID) {
304 interface_info->flags &= ~ACPI_OSI_INVALID;
307 status = AE_ALREADY_EXISTS;
310 /* New interface name, install into the global list */
312 status = acpi_ut_install_interface(interface_name);
315 acpi_os_release_mutex(acpi_gbl_osi_mutex);
319 ACPI_EXPORT_SYMBOL(acpi_install_interface)
321 /*****************************************************************************
323 * FUNCTION: acpi_remove_interface
325 * PARAMETERS: interface_name - The interface to remove
329 * DESCRIPTION: Remove an _OSI interface from the global list
331 ****************************************************************************/
332 acpi_status acpi_remove_interface(acpi_string interface_name)
336 /* Parameter validation */
338 if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
339 return (AE_BAD_PARAMETER);
342 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
343 if (ACPI_FAILURE(status)) {
347 status = acpi_ut_remove_interface(interface_name);
349 acpi_os_release_mutex(acpi_gbl_osi_mutex);
353 ACPI_EXPORT_SYMBOL(acpi_remove_interface)
355 /*****************************************************************************
357 * FUNCTION: acpi_install_interface_handler
359 * PARAMETERS: handler - The _OSI interface handler to install
360 * NULL means "remove existing handler"
364 * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
365 * invoked during execution of the internal implementation of
366 * _OSI. A NULL handler simply removes any existing handler.
368 ****************************************************************************/
369 acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
373 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
374 if (ACPI_FAILURE(status)) {
378 if (handler && acpi_gbl_interface_handler) {
379 status = AE_ALREADY_EXISTS;
381 acpi_gbl_interface_handler = handler;
384 acpi_os_release_mutex(acpi_gbl_osi_mutex);
388 ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)
390 /*****************************************************************************
392 * FUNCTION: acpi_check_address_range
394 * PARAMETERS: space_id - Address space ID
395 * address - Start address
397 * warn - TRUE if warning on overlap desired
399 * RETURN: Count of the number of conflicts detected.
401 * DESCRIPTION: Check if the input address range overlaps any of the
402 * ASL operation region address ranges.
404 ****************************************************************************/
406 acpi_check_address_range(acpi_adr_space_type space_id,
407 acpi_physical_address address,
408 acpi_size length, u8 warn)
413 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
414 if (ACPI_FAILURE(status)) {
418 overlaps = acpi_ut_check_address_range(space_id, address,
421 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
425 ACPI_EXPORT_SYMBOL(acpi_check_address_range)
426 #endif /* !ACPI_ASL_COMPILER */
427 /*******************************************************************************
429 * FUNCTION: acpi_decode_pld_buffer
431 * PARAMETERS: in_buffer - Buffer returned by _PLD method
432 * length - Length of the in_buffer
433 * return_buffer - Where the decode buffer is returned
435 * RETURN: Status and the decoded _PLD buffer. User must deallocate
436 * the buffer via ACPI_FREE.
438 * DESCRIPTION: Decode the bit-packed buffer returned by the _PLD method into
439 * a local struct that is much more useful to an ACPI driver.
441 ******************************************************************************/
443 acpi_decode_pld_buffer(u8 *in_buffer,
444 acpi_size length, struct acpi_pld_info ** return_buffer)
446 struct acpi_pld_info *pld_info;
447 u32 *buffer = ACPI_CAST_PTR(u32, in_buffer);
450 /* Parameter validation */
452 if (!in_buffer || !return_buffer || (length < 16)) {
453 return (AE_BAD_PARAMETER);
456 pld_info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pld_info));
458 return (AE_NO_MEMORY);
461 /* First 32-bit DWord */
463 ACPI_MOVE_32_TO_32(&dword, &buffer[0]);
464 pld_info->revision = ACPI_PLD_GET_REVISION(&dword);
465 pld_info->ignore_color = ACPI_PLD_GET_IGNORE_COLOR(&dword);
466 pld_info->color = ACPI_PLD_GET_COLOR(&dword);
468 /* Second 32-bit DWord */
470 ACPI_MOVE_32_TO_32(&dword, &buffer[1]);
471 pld_info->width = ACPI_PLD_GET_WIDTH(&dword);
472 pld_info->height = ACPI_PLD_GET_HEIGHT(&dword);
474 /* Third 32-bit DWord */
476 ACPI_MOVE_32_TO_32(&dword, &buffer[2]);
477 pld_info->user_visible = ACPI_PLD_GET_USER_VISIBLE(&dword);
478 pld_info->dock = ACPI_PLD_GET_DOCK(&dword);
479 pld_info->lid = ACPI_PLD_GET_LID(&dword);
480 pld_info->panel = ACPI_PLD_GET_PANEL(&dword);
481 pld_info->vertical_position = ACPI_PLD_GET_VERTICAL(&dword);
482 pld_info->horizontal_position = ACPI_PLD_GET_HORIZONTAL(&dword);
483 pld_info->shape = ACPI_PLD_GET_SHAPE(&dword);
484 pld_info->group_orientation = ACPI_PLD_GET_ORIENTATION(&dword);
485 pld_info->group_token = ACPI_PLD_GET_TOKEN(&dword);
486 pld_info->group_position = ACPI_PLD_GET_POSITION(&dword);
487 pld_info->bay = ACPI_PLD_GET_BAY(&dword);
489 /* Fourth 32-bit DWord */
491 ACPI_MOVE_32_TO_32(&dword, &buffer[3]);
492 pld_info->ejectable = ACPI_PLD_GET_EJECTABLE(&dword);
493 pld_info->ospm_eject_required = ACPI_PLD_GET_OSPM_EJECT(&dword);
494 pld_info->cabinet_number = ACPI_PLD_GET_CABINET(&dword);
495 pld_info->card_cage_number = ACPI_PLD_GET_CARD_CAGE(&dword);
496 pld_info->reference = ACPI_PLD_GET_REFERENCE(&dword);
497 pld_info->rotation = ACPI_PLD_GET_ROTATION(&dword);
498 pld_info->order = ACPI_PLD_GET_ORDER(&dword);
500 if (length >= ACPI_PLD_BUFFER_SIZE) {
502 /* Fifth 32-bit DWord (Revision 2 of _PLD) */
504 ACPI_MOVE_32_TO_32(&dword, &buffer[4]);
505 pld_info->vertical_offset = ACPI_PLD_GET_VERT_OFFSET(&dword);
506 pld_info->horizontal_offset = ACPI_PLD_GET_HORIZ_OFFSET(&dword);
509 *return_buffer = pld_info;
513 ACPI_EXPORT_SYMBOL(acpi_decode_pld_buffer)