Subversion Repositories or1k

/*******************************************************************************

 *

 * Module Name: nsxfobj - Public interfaces to the ACPI subsystem

 *                         ACPI Object oriented interfaces

 *

 ******************************************************************************/

/*

 * Copyright (C) 2000 - 2004, R. Byron Moore

 * 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.

 */

#include <acpi/acpi.h>

#include <acpi/acnamesp.h>

#define _COMPONENT          ACPI_NAMESPACE

         ACPI_MODULE_NAME    ("nsxfobj")

/*******************************************************************************

 *

 * FUNCTION:    acpi_get_type

 *

 * PARAMETERS:  Handle          - Handle of object whose type is desired

 *              *ret_type       - Where the type will be placed

 *

 * RETURN:      Status

 *

 * DESCRIPTION: This routine returns the type associatd with a particular handle

 *

 ******************************************************************************/

acpi_status

acpi_get_type (

        acpi_handle                     handle,

        acpi_object_type                *ret_type)

{

        struct acpi_namespace_node      *node;

        acpi_status                     status;

        /* Parameter Validation */

        if (!ret_type) {

                return (AE_BAD_PARAMETER);

        }

        /*

         * Special case for the predefined Root Node

         * (return type ANY)

         */

        if (handle == ACPI_ROOT_OBJECT) {

                *ret_type = ACPI_TYPE_ANY;

                return (AE_OK);

        }

        status = acpi_ut_acquire_mutex (ACPI_MTX_NAMESPACE);

        if (ACPI_FAILURE (status)) {

                return (status);

        }

        /* Convert and validate the handle */

        node = acpi_ns_map_handle_to_node (handle);

        if (!node) {

                (void) acpi_ut_release_mutex (ACPI_MTX_NAMESPACE);

                return (AE_BAD_PARAMETER);

        }

        *ret_type = node->type;

        status = acpi_ut_release_mutex (ACPI_MTX_NAMESPACE);

        return (status);

}

/*******************************************************************************

 *

 * FUNCTION:    acpi_get_parent

 *

 * PARAMETERS:  Handle          - Handle of object whose parent is desired

 *              ret_handle      - Where the parent handle will be placed

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Returns a handle to the parent of the object represented by

 *              Handle.

 *

 ******************************************************************************/

acpi_status

acpi_get_parent (

        acpi_handle                     handle,

        acpi_handle                     *ret_handle)

{

        struct acpi_namespace_node      *node;

        acpi_status                     status;

        if (!ret_handle) {

                return (AE_BAD_PARAMETER);

        }

        /* Special case for the predefined Root Node (no parent) */

        if (handle == ACPI_ROOT_OBJECT) {

                return (AE_NULL_ENTRY);

        }

        status = acpi_ut_acquire_mutex (ACPI_MTX_NAMESPACE);

        if (ACPI_FAILURE (status)) {

                return (status);

        }

        /* Convert and validate the handle */

        node = acpi_ns_map_handle_to_node (handle);

        if (!node) {

                status = AE_BAD_PARAMETER;

                goto unlock_and_exit;

        }

        /* Get the parent entry */

        *ret_handle =

                acpi_ns_convert_entry_to_handle (acpi_ns_get_parent_node (node));

        /* Return exception if parent is null */

        if (!acpi_ns_get_parent_node (node)) {

                status = AE_NULL_ENTRY;

        }

unlock_and_exit:

        (void) acpi_ut_release_mutex (ACPI_MTX_NAMESPACE);

        return (status);

}

/*******************************************************************************

 *

 * FUNCTION:    acpi_get_next_object

 *

 * PARAMETERS:  Type            - Type of object to be searched for

 *              Parent          - Parent object whose children we are getting

 *              last_child      - Previous child that was found.

 *                                The NEXT child will be returned

 *              ret_handle      - Where handle to the next object is placed

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Return the next peer object within the namespace.  If Handle is

 *              valid, Scope is ignored.  Otherwise, the first object within

 *              Scope is returned.

 *

 ******************************************************************************/

acpi_status

acpi_get_next_object (

        acpi_object_type                type,

        acpi_handle                     parent,

        acpi_handle                     child,

        acpi_handle                     *ret_handle)

{

        acpi_status                     status;

        struct acpi_namespace_node      *node;

        struct acpi_namespace_node      *parent_node = NULL;

        struct acpi_namespace_node      *child_node = NULL;

        /* Parameter validation */

        if (type > ACPI_TYPE_EXTERNAL_MAX) {

                return (AE_BAD_PARAMETER);

        }

        status = acpi_ut_acquire_mutex (ACPI_MTX_NAMESPACE);

        if (ACPI_FAILURE (status)) {

                return (status);

        }

        /* If null handle, use the parent */

        if (!child) {

                /* Start search at the beginning of the specified scope */

                parent_node = acpi_ns_map_handle_to_node (parent);

                if (!parent_node) {

                        status = AE_BAD_PARAMETER;

                        goto unlock_and_exit;

                }

        }

        else {

                /* Non-null handle, ignore the parent */

                /* Convert and validate the handle */

                child_node = acpi_ns_map_handle_to_node (child);

                if (!child_node) {

                        status = AE_BAD_PARAMETER;

                        goto unlock_and_exit;

                }

        }

        /* Internal function does the real work */

        node = acpi_ns_get_next_node (type, parent_node, child_node);

        if (!node) {

                status = AE_NOT_FOUND;

                goto unlock_and_exit;

        }

        if (ret_handle) {

                *ret_handle = acpi_ns_convert_entry_to_handle (node);

        }

unlock_and_exit:

        (void) acpi_ut_release_mutex (ACPI_MTX_NAMESPACE);

        return (status);

}