/******************************************************************************
 *
 * Module Name: nsxfname - Public interfaces to the ACPI subsystem
 *                         ACPI Namespace oriented interfaces
 *
 *****************************************************************************/

/*
 *  Copyright (C) 2000 R. Byron Moore
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "acpi.h"
#include "interp.h"
#include "namesp.h"
#include "amlcode.h"
#include "parser.h"
#include "dispatch.h"
#include "events.h"


#define _COMPONENT          NAMESPACE
	 MODULE_NAME         ("nsxfname");


/******************************************************************************
 *
 * FUNCTION:    Acpi_load_namespace
 *
 * PARAMETERS:  Display_aml_during_load
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
 *              (DSDT points to either the BIOS or a buffer.)
 *
 ******************************************************************************/

ACPI_STATUS
acpi_load_namespace (
	void)
{
	ACPI_STATUS             status;


	/* There must be at least a DSDT installed */

	if (acpi_gbl_DSDT == NULL) {
		return (AE_NO_ACPI_TABLES);
	}


	/* Init the hardware */

	/*
	 * TBD: [Restructure] Should this should be moved elsewhere,
	 * like Acpi_enable! ??
	 */

	/* we need to be able to call this interface repeatedly! */
	/* Does H/W require init before loading the namespace? */

	status = acpi_cm_hardware_initialize ();
	if (ACPI_FAILURE (status)) {
		return (status);
	}

	/*
	 * Load the namespace.  The DSDT is required,
	 * but the SSDT and PSDT tables are optional.
	 */

	status = acpi_ns_load_table_by_type (ACPI_TABLE_DSDT);
	if (ACPI_FAILURE (status)) {
		return (status);
	}

	/* Ignore exceptions from these */

	acpi_ns_load_table_by_type (ACPI_TABLE_SSDT);
	acpi_ns_load_table_by_type (ACPI_TABLE_PSDT);


	/*
	 * Install the default Op_region handlers, ignore the return
	 * code right now.
	 */

	acpi_ev_install_default_address_space_handlers ();

	return (status);
}


/****************************************************************************
 *
 * FUNCTION:    Acpi_get_handle
 *
 * PARAMETERS:  Parent          - Object to search under (search scope).
 *              Path_name       - Pointer to an asciiz string containing the
 *                                  name
 *              Ret_handle      - Where the return handle is placed
 *
 * RETURN:      Status
 *
 * DESCRIPTION: This routine will search for a caller specified name in the
 *              name space.  The caller can restrict the search region by
 *              specifying a non NULL parent.  The parent value is itself a
 *              namespace handle.
 *
 ******************************************************************************/

ACPI_STATUS
acpi_get_handle (
	ACPI_HANDLE             parent,
	ACPI_STRING             pathname,
	ACPI_HANDLE             *ret_handle)
{
	ACPI_STATUS             status;
	ACPI_NAMED_OBJECT       *this_entry;
	ACPI_NAME_TABLE         *scope = NULL;


	if (!ret_handle || !pathname) {
		return AE_BAD_PARAMETER;
	}

	if (parent) {
		acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE);

		this_entry = acpi_ns_convert_handle_to_entry (parent);
		if (!this_entry) {
			acpi_cm_release_mutex (ACPI_MTX_NAMESPACE);
			return AE_BAD_PARAMETER;
		}

		scope = this_entry->child_table;
		acpi_cm_release_mutex (ACPI_MTX_NAMESPACE);
	}

	/* Special case for root, since we can't search for it */
	/* TBD: [Investigate] Check for both forward and backslash?? */

	if (STRCMP (pathname, NS_ROOT_PATH) == 0) {
		*ret_handle = acpi_ns_convert_entry_to_handle (acpi_gbl_root_object);
		return AE_OK;
	}

	/*
	 *  Find the Nte and convert to the user format
	 */
	this_entry = NULL;
	status = acpi_ns_get_named_object (pathname, scope, &this_entry);

   *ret_handle = acpi_ns_convert_entry_to_handle (this_entry);

	return (status);
}


/****************************************************************************
 *
 * FUNCTION:    Acpi_get_pathname
 *
 * PARAMETERS:  Handle          - Handle to be converted to a pathname
 *              Name_type       - Full pathname or single segment
 *              Ret_path_ptr    - Buffer for returned path
 *
 * RETURN:      Pointer to a string containing the fully qualified Name.
 *
 * DESCRIPTION: This routine returns the fully qualified name associated with
 *              the Handle parameter.  This and the Acpi_pathname_to_handle are
 *              complementary functions.
 *
 ******************************************************************************/

ACPI_STATUS
acpi_get_name (
	ACPI_HANDLE             handle,
	u32                     name_type,
	ACPI_BUFFER             *ret_path_ptr)
{
	ACPI_STATUS             status;
	ACPI_NAMED_OBJECT       *obj_entry;


	/* Buffer pointer must be valid always */

	if (!ret_path_ptr || (name_type > ACPI_NAME_TYPE_MAX)) {
		return AE_BAD_PARAMETER;
	}

	/* Allow length to be zero and ignore the pointer */

	if ((ret_path_ptr->length) &&
	   (!ret_path_ptr->pointer))
	{
		return AE_BAD_PARAMETER;
	}

	if (name_type == ACPI_FULL_PATHNAME) {
		/* Get the full pathname (From the namespace root) */

		status = acpi_ns_handle_to_pathname (handle, &ret_path_ptr->length,
				   ret_path_ptr->pointer);
		return status;
	}

	/*
	 * Wants the single segment ACPI name.
	 * Validate handle and convert to an NTE
	 */

	acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE);
	obj_entry = acpi_ns_convert_handle_to_entry (handle);
	if (!obj_entry) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

	/* Check if name will fit in buffer */

	if (ret_path_ptr->length < PATH_SEGMENT_LENGTH) {
		ret_path_ptr->length = PATH_SEGMENT_LENGTH;
		status = AE_BUFFER_OVERFLOW;
		goto unlock_and_exit;
	}

	/* Just copy the ACPI name from the NTE and zero terminate it */

	STRNCPY (ret_path_ptr->pointer, (char *) &obj_entry->name,
			 ACPI_NAME_SIZE);
	((char *) ret_path_ptr->pointer) [ACPI_NAME_SIZE] = 0;
	status = AE_OK;


unlock_and_exit:

	acpi_cm_release_mutex (ACPI_MTX_NAMESPACE);
	return status;
}


/****************************************************************************
 *
 * FUNCTION:    Acpi_get_object_info
 *
 * PARAMETERS:  Handle          - Object Handle
 *              Info            - Where the info is returned
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Returns information about an object as gleaned from running
 *              several standard control methods.
 *
 ******************************************************************************/

ACPI_STATUS
acpi_get_object_info (
	ACPI_HANDLE             device,
	ACPI_DEVICE_INFO        *info)
{
	DEVICE_ID               hid;
	DEVICE_ID               uid;
	ACPI_STATUS             status;
	u32                     device_status = 0;
	u32                     address = 0;
	ACPI_NAMED_OBJECT       *device_entry;


	/* Parameter validation */

	if (!device || !info) {
		return AE_BAD_PARAMETER;
	}

	acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE);

	device_entry = acpi_ns_convert_handle_to_entry (device);
	if (!device_entry) {
		acpi_cm_release_mutex (ACPI_MTX_NAMESPACE);
		return AE_BAD_PARAMETER;
	}

	info->type      = device_entry->type;
	info->name      = device_entry->name;
	info->parent    =
		acpi_ns_convert_entry_to_handle (acpi_ns_get_parent_entry (device_entry));

	acpi_cm_release_mutex (ACPI_MTX_NAMESPACE);

	/*
	 * If not a device, we are all done.
	 */
	if (info->type != ACPI_TYPE_DEVICE) {
		return AE_OK;
	}


	/* Get extra info for ACPI devices */

	info->valid     = 0;

	/* Execute the _HID method and save the result */

	status = acpi_cm_execute_HID (device_entry, &hid);
	if (ACPI_SUCCESS (status)) {
		if (hid.type == STRING_PTR_DEVICE_ID) {
			STRCPY (info->hardware_id, hid.data.string_ptr);
		}
		else {
			STRCPY (info->hardware_id, hid.data.buffer);
		}

		info->valid |= ACPI_VALID_HID;
	}

	/* Execute the _UID method and save the result */

	status = acpi_cm_execute_UID (device_entry, &uid);
	if (ACPI_SUCCESS (status)) {
		if (hid.type == STRING_PTR_DEVICE_ID) {
			STRCPY (info->unique_id, uid.data.string_ptr);
		}
		else {
			STRCPY (info->unique_id, uid.data.buffer);
		}

		info->valid |= ACPI_VALID_UID;
	}

	/*
	 * Execute the _STA method and save the result
	 * _STA is not always present
	 */

	status = acpi_cm_execute_STA (device_entry, &device_status);
	if (ACPI_SUCCESS (status)) {
		info->current_status = device_status;
		info->valid |= ACPI_VALID_STA;
	}

	/*
	 * Execute the _ADR method and save result if successful
	 * _ADR is not always present
	 */

	status = acpi_cm_evaluate_numeric_object (METHOD_NAME__ADR,
			  device_entry, &address);

	if (ACPI_SUCCESS (status)) {
		info->address = address;
		info->valid |= ACPI_VALID_ADR;
	}

	return AE_OK;
}