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 #define EXPORT_ACPI_INTERFACES
46 #include <acpi/acpi.h>
50 #define _COMPONENT ACPI_UTILITIES
51 ACPI_MODULE_NAME("utxface")
53 /*******************************************************************************
55 * FUNCTION: acpi_terminate
61 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
63 ******************************************************************************/
64 acpi_status acpi_terminate(void)
68 ACPI_FUNCTION_TRACE(acpi_terminate);
70 /* Just exit if subsystem is already shutdown */
72 if (acpi_gbl_shutdown) {
73 ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
74 return_ACPI_STATUS(AE_OK);
77 /* Subsystem appears active, go ahead and shut it down */
79 acpi_gbl_shutdown = TRUE;
80 acpi_gbl_startup_flags = 0;
81 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
83 /* Terminate the AML Debugger if present */
85 ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
87 /* Shutdown and free all resources */
89 acpi_ut_subsystem_shutdown();
91 /* Free the mutex objects */
93 acpi_ut_mutex_terminate();
97 /* Shut down the debugger */
102 /* Now we can shutdown the OS-dependent layer */
104 status = acpi_os_terminate();
105 return_ACPI_STATUS(status);
108 ACPI_EXPORT_SYMBOL(acpi_terminate)
110 #ifndef ACPI_ASL_COMPILER
111 #ifdef ACPI_FUTURE_USAGE
112 /*******************************************************************************
114 * FUNCTION: acpi_subsystem_status
118 * RETURN: Status of the ACPI subsystem
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.
124 ******************************************************************************/
125 acpi_status acpi_subsystem_status(void)
128 if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
135 ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
137 /*******************************************************************************
139 * FUNCTION: acpi_get_system_info
141 * PARAMETERS: out_buffer - A buffer to receive the resources for the
144 * RETURN: status - the status of the call
146 * DESCRIPTION: This function is called to get information about the current
147 * state of the ACPI subsystem. It will return system information
150 * If the function fails an appropriate status will be returned
151 * and the value of out_buffer is undefined.
153 ******************************************************************************/
154 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
156 struct acpi_system_info *info_ptr;
159 ACPI_FUNCTION_TRACE(acpi_get_system_info);
161 /* Parameter validation */
163 status = acpi_ut_validate_buffer(out_buffer);
164 if (ACPI_FAILURE(status)) {
165 return_ACPI_STATUS(status);
168 /* Validate/Allocate/Clear caller buffer */
171 acpi_ut_initialize_buffer(out_buffer,
172 sizeof(struct acpi_system_info));
173 if (ACPI_FAILURE(status)) {
174 return_ACPI_STATUS(status);
178 * Populate the return buffer
180 info_ptr = (struct acpi_system_info *)out_buffer->pointer;
182 info_ptr->acpi_ca_version = ACPI_CA_VERSION;
184 /* System flags (ACPI capabilities) */
186 info_ptr->flags = ACPI_SYS_MODE_ACPI;
188 /* Timer resolution - 24 or 32 bits */
190 if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
191 info_ptr->timer_resolution = 24;
193 info_ptr->timer_resolution = 32;
196 /* Clear the reserved fields */
198 info_ptr->reserved1 = 0;
199 info_ptr->reserved2 = 0;
201 /* Current debug levels */
203 info_ptr->debug_layer = acpi_dbg_layer;
204 info_ptr->debug_level = acpi_dbg_level;
206 return_ACPI_STATUS(AE_OK);
209 ACPI_EXPORT_SYMBOL(acpi_get_system_info)
211 /*****************************************************************************
213 * FUNCTION: acpi_install_initialization_handler
215 * PARAMETERS: handler - Callback procedure
216 * function - Not (currently) used, see below
220 * DESCRIPTION: Install an initialization handler
222 * TBD: When a second function is added, must save the Function also.
224 ****************************************************************************/
226 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
230 return (AE_BAD_PARAMETER);
233 if (acpi_gbl_init_handler) {
234 return (AE_ALREADY_EXISTS);
237 acpi_gbl_init_handler = handler;
241 ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
242 #endif /* ACPI_FUTURE_USAGE */
244 /*****************************************************************************
246 * FUNCTION: acpi_purge_cached_objects
252 * DESCRIPTION: Empty all caches (delete the cached objects)
254 ****************************************************************************/
255 acpi_status acpi_purge_cached_objects(void)
257 ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
259 (void)acpi_os_purge_cache(acpi_gbl_state_cache);
260 (void)acpi_os_purge_cache(acpi_gbl_operand_cache);
261 (void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
262 (void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
264 return_ACPI_STATUS(AE_OK);
267 ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
269 /*****************************************************************************
271 * FUNCTION: acpi_install_interface
273 * PARAMETERS: interface_name - The interface to install
277 * DESCRIPTION: Install an _OSI interface to the global list
279 ****************************************************************************/
280 acpi_status acpi_install_interface(acpi_string interface_name)
283 struct acpi_interface_info *interface_info;
285 /* Parameter validation */
287 if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
288 return (AE_BAD_PARAMETER);
291 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
292 if (ACPI_FAILURE(status)) {
296 /* Check if the interface name is already in the global list */
298 interface_info = acpi_ut_get_interface(interface_name);
299 if (interface_info) {
301 * The interface already exists in the list. This is OK if the
302 * interface has been marked invalid -- just clear the bit.
304 if (interface_info->flags & ACPI_OSI_INVALID) {
305 interface_info->flags &= ~ACPI_OSI_INVALID;
308 status = AE_ALREADY_EXISTS;
311 /* New interface name, install into the global list */
313 status = acpi_ut_install_interface(interface_name);
316 acpi_os_release_mutex(acpi_gbl_osi_mutex);
320 ACPI_EXPORT_SYMBOL(acpi_install_interface)
322 /*****************************************************************************
324 * FUNCTION: acpi_remove_interface
326 * PARAMETERS: interface_name - The interface to remove
330 * DESCRIPTION: Remove an _OSI interface from the global list
332 ****************************************************************************/
333 acpi_status acpi_remove_interface(acpi_string interface_name)
337 /* Parameter validation */
339 if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
340 return (AE_BAD_PARAMETER);
343 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
344 if (ACPI_FAILURE(status)) {
348 status = acpi_ut_remove_interface(interface_name);
350 acpi_os_release_mutex(acpi_gbl_osi_mutex);
354 ACPI_EXPORT_SYMBOL(acpi_remove_interface)
356 /*****************************************************************************
358 * FUNCTION: acpi_install_interface_handler
360 * PARAMETERS: handler - The _OSI interface handler to install
361 * NULL means "remove existing handler"
365 * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
366 * invoked during execution of the internal implementation of
367 * _OSI. A NULL handler simply removes any existing handler.
369 ****************************************************************************/
370 acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
374 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
375 if (ACPI_FAILURE(status)) {
379 if (handler && acpi_gbl_interface_handler) {
380 status = AE_ALREADY_EXISTS;
382 acpi_gbl_interface_handler = handler;
385 acpi_os_release_mutex(acpi_gbl_osi_mutex);
389 ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)
391 /*****************************************************************************
393 * FUNCTION: acpi_update_interfaces
395 * PARAMETERS: action - Actions to be performed during the
400 * DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
401 * string or/and feature group strings.
403 ****************************************************************************/
404 acpi_status acpi_update_interfaces(u8 action)
408 status = acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
409 if (ACPI_FAILURE(status)) {
413 status = acpi_ut_update_interfaces(action);
415 acpi_os_release_mutex(acpi_gbl_osi_mutex);
419 /*****************************************************************************
421 * FUNCTION: acpi_check_address_range
423 * PARAMETERS: space_id - Address space ID
424 * address - Start address
426 * warn - TRUE if warning on overlap desired
428 * RETURN: Count of the number of conflicts detected.
430 * DESCRIPTION: Check if the input address range overlaps any of the
431 * ASL operation region address ranges.
433 ****************************************************************************/
436 acpi_check_address_range(acpi_adr_space_type space_id,
437 acpi_physical_address address,
438 acpi_size length, u8 warn)
443 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
444 if (ACPI_FAILURE(status)) {
448 overlaps = acpi_ut_check_address_range(space_id, address,
451 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
455 ACPI_EXPORT_SYMBOL(acpi_check_address_range)
456 #endif /* !ACPI_ASL_COMPILER */
457 /*******************************************************************************
459 * FUNCTION: acpi_decode_pld_buffer
461 * PARAMETERS: in_buffer - Buffer returned by _PLD method
462 * length - Length of the in_buffer
463 * return_buffer - Where the decode buffer is returned
465 * RETURN: Status and the decoded _PLD buffer. User must deallocate
466 * the buffer via ACPI_FREE.
468 * DESCRIPTION: Decode the bit-packed buffer returned by the _PLD method into
469 * a local struct that is much more useful to an ACPI driver.
471 ******************************************************************************/
473 acpi_decode_pld_buffer(u8 *in_buffer,
474 acpi_size length, struct acpi_pld_info ** return_buffer)
476 struct acpi_pld_info *pld_info;
477 u32 *buffer = ACPI_CAST_PTR(u32, in_buffer);
480 /* Parameter validation */
482 if (!in_buffer || !return_buffer || (length < 16)) {
483 return (AE_BAD_PARAMETER);
486 pld_info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pld_info));
488 return (AE_NO_MEMORY);
491 /* First 32-bit DWord */
493 ACPI_MOVE_32_TO_32(&dword, &buffer[0]);
494 pld_info->revision = ACPI_PLD_GET_REVISION(&dword);
495 pld_info->ignore_color = ACPI_PLD_GET_IGNORE_COLOR(&dword);
496 pld_info->color = ACPI_PLD_GET_COLOR(&dword);
498 /* Second 32-bit DWord */
500 ACPI_MOVE_32_TO_32(&dword, &buffer[1]);
501 pld_info->width = ACPI_PLD_GET_WIDTH(&dword);
502 pld_info->height = ACPI_PLD_GET_HEIGHT(&dword);
504 /* Third 32-bit DWord */
506 ACPI_MOVE_32_TO_32(&dword, &buffer[2]);
507 pld_info->user_visible = ACPI_PLD_GET_USER_VISIBLE(&dword);
508 pld_info->dock = ACPI_PLD_GET_DOCK(&dword);
509 pld_info->lid = ACPI_PLD_GET_LID(&dword);
510 pld_info->panel = ACPI_PLD_GET_PANEL(&dword);
511 pld_info->vertical_position = ACPI_PLD_GET_VERTICAL(&dword);
512 pld_info->horizontal_position = ACPI_PLD_GET_HORIZONTAL(&dword);
513 pld_info->shape = ACPI_PLD_GET_SHAPE(&dword);
514 pld_info->group_orientation = ACPI_PLD_GET_ORIENTATION(&dword);
515 pld_info->group_token = ACPI_PLD_GET_TOKEN(&dword);
516 pld_info->group_position = ACPI_PLD_GET_POSITION(&dword);
517 pld_info->bay = ACPI_PLD_GET_BAY(&dword);
519 /* Fourth 32-bit DWord */
521 ACPI_MOVE_32_TO_32(&dword, &buffer[3]);
522 pld_info->ejectable = ACPI_PLD_GET_EJECTABLE(&dword);
523 pld_info->ospm_eject_required = ACPI_PLD_GET_OSPM_EJECT(&dword);
524 pld_info->cabinet_number = ACPI_PLD_GET_CABINET(&dword);
525 pld_info->card_cage_number = ACPI_PLD_GET_CARD_CAGE(&dword);
526 pld_info->reference = ACPI_PLD_GET_REFERENCE(&dword);
527 pld_info->rotation = ACPI_PLD_GET_ROTATION(&dword);
528 pld_info->order = ACPI_PLD_GET_ORDER(&dword);
530 if (length >= ACPI_PLD_BUFFER_SIZE) {
532 /* Fifth 32-bit DWord (Revision 2 of _PLD) */
534 ACPI_MOVE_32_TO_32(&dword, &buffer[4]);
535 pld_info->vertical_offset = ACPI_PLD_GET_VERT_OFFSET(&dword);
536 pld_info->horizontal_offset = ACPI_PLD_GET_HORIZ_OFFSET(&dword);
539 *return_buffer = pld_info;
543 ACPI_EXPORT_SYMBOL(acpi_decode_pld_buffer)