[deliverable/linux.git] / drivers / pci / hotplug / acpi_pcihp.c

/*
 * Common ACPI functions for hot plug platforms
 *
 * Copyright (C) 2006 Intel Corporation
 *
 * All rights reserved.
 *
 * 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, GOOD TITLE or
 * NON INFRINGEMENT.  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., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * Send feedback to <kristen.c.accardi@intel.com>
 *
 */

#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/kernel.h>
#include <linux/types.h>
#include <linux/pci.h>
#include <linux/pci_hotplug.h>
#include <linux/acpi.h>
#include <linux/pci-acpi.h>

#define MY_NAME	"acpi_pcihp"

#define dbg(fmt, arg...) do { if (debug_acpi) printk(KERN_DEBUG "%s: %s: " fmt , MY_NAME , __func__ , ## arg); } while (0)
#define err(format, arg...) printk(KERN_ERR "%s: " format , MY_NAME , ## arg)
#define info(format, arg...) printk(KERN_INFO "%s: " format , MY_NAME , ## arg)
#define warn(format, arg...) printk(KERN_WARNING "%s: " format , MY_NAME , ## arg)

#define	METHOD_NAME__SUN	"_SUN"
#define	METHOD_NAME__HPP	"_HPP"
#define	METHOD_NAME_OSHP	"OSHP"

static int debug_acpi;

static acpi_status
decode_type0_hpx_record(union acpi_object *record, struct hotplug_params *hpx)
{
	int i;
	union acpi_object *fields = record->package.elements;
	u32 revision = fields[1].integer.value;

	switch (revision) {
	case 1:
		if (record->package.count != 6)
			return AE_ERROR;
		for (i = 2; i < 6; i++)
			if (fields[i].type != ACPI_TYPE_INTEGER)
				return AE_ERROR;
		hpx->t0 = &hpx->type0_data;
		hpx->t0->revision        = revision;
		hpx->t0->cache_line_size = fields[2].integer.value;
		hpx->t0->latency_timer   = fields[3].integer.value;
		hpx->t0->enable_serr     = fields[4].integer.value;
		hpx->t0->enable_perr     = fields[5].integer.value;
		break;
	default:
		printk(KERN_WARNING
		       "%s: Type 0 Revision %d record not supported\n",
		       __func__, revision);
		return AE_ERROR;
	}
	return AE_OK;
}

static acpi_status
decode_type1_hpx_record(union acpi_object *record, struct hotplug_params *hpx)
{
	int i;
	union acpi_object *fields = record->package.elements;
	u32 revision = fields[1].integer.value;

	switch (revision) {
	case 1:
		if (record->package.count != 5)
			return AE_ERROR;
		for (i = 2; i < 5; i++)
			if (fields[i].type != ACPI_TYPE_INTEGER)
				return AE_ERROR;
		hpx->t1 = &hpx->type1_data;
		hpx->t1->revision      = revision;
		hpx->t1->max_mem_read  = fields[2].integer.value;
		hpx->t1->avg_max_split = fields[3].integer.value;
		hpx->t1->tot_max_split = fields[4].integer.value;
		break;
	default:
		printk(KERN_WARNING
		       "%s: Type 1 Revision %d record not supported\n",
		       __func__, revision);
		return AE_ERROR;
	}
	return AE_OK;
}

static acpi_status
decode_type2_hpx_record(union acpi_object *record, struct hotplug_params *hpx)
{
	int i;
	union acpi_object *fields = record->package.elements;
	u32 revision = fields[1].integer.value;

	switch (revision) {
	case 1:
		if (record->package.count != 18)
			return AE_ERROR;
		for (i = 2; i < 18; i++)
			if (fields[i].type != ACPI_TYPE_INTEGER)
				return AE_ERROR;
		hpx->t2 = &hpx->type2_data;
		hpx->t2->revision      = revision;
		hpx->t2->unc_err_mask_and      = fields[2].integer.value;
		hpx->t2->unc_err_mask_or       = fields[3].integer.value;
		hpx->t2->unc_err_sever_and     = fields[4].integer.value;
		hpx->t2->unc_err_sever_or      = fields[5].integer.value;
		hpx->t2->cor_err_mask_and      = fields[6].integer.value;
		hpx->t2->cor_err_mask_or       = fields[7].integer.value;
		hpx->t2->adv_err_cap_and       = fields[8].integer.value;
		hpx->t2->adv_err_cap_or        = fields[9].integer.value;
		hpx->t2->pci_exp_devctl_and    = fields[10].integer.value;
		hpx->t2->pci_exp_devctl_or     = fields[11].integer.value;
		hpx->t2->pci_exp_lnkctl_and    = fields[12].integer.value;
		hpx->t2->pci_exp_lnkctl_or     = fields[13].integer.value;
		hpx->t2->sec_unc_err_sever_and = fields[14].integer.value;
		hpx->t2->sec_unc_err_sever_or  = fields[15].integer.value;
		hpx->t2->sec_unc_err_mask_and  = fields[16].integer.value;
		hpx->t2->sec_unc_err_mask_or   = fields[17].integer.value;
		break;
	default:
		printk(KERN_WARNING
		       "%s: Type 2 Revision %d record not supported\n",
		       __func__, revision);
		return AE_ERROR;
	}
	return AE_OK;
}

static acpi_status
acpi_run_hpx(acpi_handle handle, struct hotplug_params *hpx)
{
	acpi_status status;
	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	union acpi_object *package, *record, *fields;
	u32 type;
	int i;

	/* Clear the return buffer with zeros */
	memset(hpx, 0, sizeof(struct hotplug_params));

	status = acpi_evaluate_object(handle, "_HPX", NULL, &buffer);
	if (ACPI_FAILURE(status))
		return status;

	package = (union acpi_object *)buffer.pointer;
	if (package->type != ACPI_TYPE_PACKAGE) {
		status = AE_ERROR;
		goto exit;
	}

	for (i = 0; i < package->package.count; i++) {
		record = &package->package.elements[i];
		if (record->type != ACPI_TYPE_PACKAGE) {
			status = AE_ERROR;
			goto exit;
		}

		fields = record->package.elements;
		if (fields[0].type != ACPI_TYPE_INTEGER ||
		    fields[1].type != ACPI_TYPE_INTEGER) {
			status = AE_ERROR;
			goto exit;
		}

		type = fields[0].integer.value;
		switch (type) {
		case 0:
			status = decode_type0_hpx_record(record, hpx);
			if (ACPI_FAILURE(status))
				goto exit;
			break;
		case 1:
			status = decode_type1_hpx_record(record, hpx);
			if (ACPI_FAILURE(status))
				goto exit;
			break;
		case 2:
			status = decode_type2_hpx_record(record, hpx);
			if (ACPI_FAILURE(status))
				goto exit;
			break;
		default:
			printk(KERN_ERR "%s: Type %d record not supported\n",
			       __func__, type);
			status = AE_ERROR;
			goto exit;
		}
	}
 exit:
	kfree(buffer.pointer);
	return status;
}

static acpi_status
acpi_run_hpp(acpi_handle handle, struct hotplug_params *hpp)
{
	acpi_status		status;
	u8			nui[4];
	struct acpi_buffer	ret_buf = { 0, NULL};
	struct acpi_buffer	string = { ACPI_ALLOCATE_BUFFER, NULL };
	union acpi_object	*ext_obj, *package;
	int			i, len = 0;

	acpi_get_name(handle, ACPI_FULL_PATHNAME, &string);

	/* Clear the return buffer with zeros */
	memset(hpp, 0, sizeof(struct hotplug_params));

	/* get _hpp */
	status = acpi_evaluate_object(handle, METHOD_NAME__HPP, NULL, &ret_buf);
	switch (status) {
	case AE_BUFFER_OVERFLOW:
		ret_buf.pointer = kmalloc (ret_buf.length, GFP_KERNEL);
		if (!ret_buf.pointer) {
			printk(KERN_ERR "%s:%s alloc for _HPP fail\n",
				__func__, (char *)string.pointer);
			kfree(string.pointer);
			return AE_NO_MEMORY;
		}
		status = acpi_evaluate_object(handle, METHOD_NAME__HPP,
				NULL, &ret_buf);
		if (ACPI_SUCCESS(status))
			break;
	default:
		if (ACPI_FAILURE(status)) {
			pr_debug("%s:%s _HPP fail=0x%x\n", __func__,
				(char *)string.pointer, status);
			kfree(string.pointer);
			return status;
		}
	}

	ext_obj = (union acpi_object *) ret_buf.pointer;
	if (ext_obj->type != ACPI_TYPE_PACKAGE) {
		printk(KERN_ERR "%s:%s _HPP obj not a package\n", __func__,
				(char *)string.pointer);
		status = AE_ERROR;
		goto free_and_return;
	}

	len = ext_obj->package.count;
	package = (union acpi_object *) ret_buf.pointer;
	for ( i = 0; (i < len) || (i < 4); i++) {
		ext_obj = (union acpi_object *) &package->package.elements[i];
		switch (ext_obj->type) {
		case ACPI_TYPE_INTEGER:
			nui[i] = (u8)ext_obj->integer.value;
			break;
		default:
			printk(KERN_ERR "%s:%s _HPP obj type incorrect\n",
				__func__, (char *)string.pointer);
			status = AE_ERROR;
			goto free_and_return;
		}
	}

	hpp->t0 = &hpp->type0_data;
	hpp->t0->cache_line_size = nui[0];
	hpp->t0->latency_timer = nui[1];
	hpp->t0->enable_serr = nui[2];
	hpp->t0->enable_perr = nui[3];

	pr_debug("  _HPP: cache_line_size=0x%x\n", hpp->t0->cache_line_size);
	pr_debug("  _HPP: latency timer  =0x%x\n", hpp->t0->latency_timer);
	pr_debug("  _HPP: enable SERR    =0x%x\n", hpp->t0->enable_serr);
	pr_debug("  _HPP: enable PERR    =0x%x\n", hpp->t0->enable_perr);

free_and_return:
	kfree(string.pointer);
	kfree(ret_buf.pointer);
	return status;
}


/* acpi_run_oshp - get control of hotplug from the firmware
 *
 * @handle - the handle of the hotplug controller.
 */
static acpi_status acpi_run_oshp(acpi_handle handle)
{
	acpi_status		status;
	struct acpi_buffer	string = { ACPI_ALLOCATE_BUFFER, NULL };

	acpi_get_name(handle, ACPI_FULL_PATHNAME, &string);

	/* run OSHP */
	status = acpi_evaluate_object(handle, METHOD_NAME_OSHP, NULL, NULL);
	if (ACPI_FAILURE(status))
		if (status != AE_NOT_FOUND)
			printk(KERN_ERR "%s:%s OSHP fails=0x%x\n",
			       __func__, (char *)string.pointer, status);
		else
			dbg("%s:%s OSHP not found\n",
			    __func__, (char *)string.pointer);
	else
		pr_debug("%s:%s OSHP passes\n", __func__,
			(char *)string.pointer);

	kfree(string.pointer);
	return status;
}

/* acpi_get_hp_params_from_firmware
 *
 * @bus - the pci_bus of the bus on which the device is newly added
 * @hpp - allocated by the caller
 */
acpi_status acpi_get_hp_params_from_firmware(struct pci_bus *bus,
		struct hotplug_params *hpp)
{
	acpi_status status = AE_NOT_FOUND;
	acpi_handle handle, phandle;
	struct pci_bus *pbus = bus;
	struct pci_dev *pdev;

	do {
		pdev = pbus->self;
		if (!pdev) {
			handle = acpi_get_pci_rootbridge_handle(
				pci_domain_nr(pbus), pbus->number);
			break;
		}
		handle = DEVICE_ACPI_HANDLE(&(pdev->dev));
		pbus = pbus->parent;
	} while (!handle);

	/*
	 * _HPP settings apply to all child buses, until another _HPP is
	 * encountered. If we don't find an _HPP for the input pci dev,
	 * look for it in the parent device scope since that would apply to
	 * this pci dev. If we don't find any _HPP, use hardcoded defaults
	 */
	while (handle) {
		status = acpi_run_hpx(handle, hpp);
		if (ACPI_SUCCESS(status))
			break;
		status = acpi_run_hpp(handle, hpp);
		if (ACPI_SUCCESS(status))
			break;
		if (acpi_root_bridge(handle))
			break;
		status = acpi_get_parent(handle, &phandle);
		if (ACPI_FAILURE(status))
			break;
		handle = phandle;
	}
	return status;
}
EXPORT_SYMBOL_GPL(acpi_get_hp_params_from_firmware);

/**
 * acpi_get_hp_hw_control_from_firmware
 * @dev: the pci_dev of the bridge that has a hotplug controller
 * @flags: requested control bits for _OSC
 *
 * Attempt to take hotplug control from firmware.
 */
int acpi_get_hp_hw_control_from_firmware(struct pci_dev *dev, u32 flags)
{
	acpi_status status;
	acpi_handle chandle, handle;
	struct pci_dev *pdev = dev;
	struct pci_bus *parent;
	struct acpi_buffer string = { ACPI_ALLOCATE_BUFFER, NULL };

	flags &= (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL |
		  OSC_SHPC_NATIVE_HP_CONTROL |
		  OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL);
	if (!flags) {
		err("Invalid flags %u specified!\n", flags);
		return -EINVAL;
	}

	/*
	 * Per PCI firmware specification, we should run the ACPI _OSC
	 * method to get control of hotplug hardware before using it. If
	 * an _OSC is missing, we look for an OSHP to do the same thing.
	 * To handle different BIOS behavior, we look for _OSC on a root
	 * bridge preferentially (according to PCI fw spec). Later for
	 * OSHP within the scope of the hotplug controller and its parents,
	 * upto the host bridge under which this controller exists.
	 */
	handle = acpi_find_root_bridge_handle(pdev);
	if (handle) {
		acpi_get_name(handle, ACPI_FULL_PATHNAME, &string);
		dbg("Trying to get hotplug control for %s\n",
				(char *)string.pointer);
		status = acpi_pci_osc_control_set(handle, flags);
		if (ACPI_SUCCESS(status))
			goto got_one;
		kfree(string.pointer);
		string = (struct acpi_buffer){ ACPI_ALLOCATE_BUFFER, NULL };
	}

	pdev = dev;
	handle = DEVICE_ACPI_HANDLE(&dev->dev);
	while (!handle) {
		/*
		 * This hotplug controller was not listed in the ACPI name
		 * space at all. Try to get acpi handle of parent pci bus.
		 */
		if (!pdev || !pdev->bus->parent)
			break;
		parent = pdev->bus->parent;
		dbg("Could not find %s in acpi namespace, trying parent\n",
		    pci_name(pdev));
		if (!parent->self)
			/* Parent must be a host bridge */
			handle = acpi_get_pci_rootbridge_handle(
					pci_domain_nr(parent),
					parent->number);
		else
			handle = DEVICE_ACPI_HANDLE(&(parent->self->dev));
		pdev = parent->self;
	}

	while (handle) {
		acpi_get_name(handle, ACPI_FULL_PATHNAME, &string);
		dbg("Trying to get hotplug control for %s \n",
		    (char *)string.pointer);
		status = acpi_run_oshp(handle);
		if (ACPI_SUCCESS(status))
			goto got_one;
		if (acpi_root_bridge(handle))
			break;
		chandle = handle;
		status = acpi_get_parent(chandle, &handle);
		if (ACPI_FAILURE(status))
			break;
	}

	dbg("Cannot get control of hotplug hardware for pci %s\n",
	    pci_name(dev));

	kfree(string.pointer);
	return -ENODEV;
got_one:
	dbg("Gained control for hotplug HW for pci %s (%s)\n", pci_name(dev),
			(char *)string.pointer);
	kfree(string.pointer);
	return 0;
}
EXPORT_SYMBOL(acpi_get_hp_hw_control_from_firmware);

/* acpi_root_bridge - check to see if this acpi object is a root bridge
 *
 * @handle - the acpi object in question.
 */
int acpi_root_bridge(acpi_handle handle)
{
	acpi_status status;
	struct acpi_device_info *info;
	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	int i;

	status = acpi_get_object_info(handle, &buffer);
	if (ACPI_SUCCESS(status)) {
		info = buffer.pointer;
		if ((info->valid & ACPI_VALID_HID) &&
			!strcmp(PCI_ROOT_HID_STRING,
					info->hardware_id.value)) {
			kfree(buffer.pointer);
			return 1;
		}
		if (info->valid & ACPI_VALID_CID) {
			for (i=0; i < info->compatibility_id.count; i++) {
				if (!strcmp(PCI_ROOT_HID_STRING,
					info->compatibility_id.id[i].value)) {
					kfree(buffer.pointer);
					return 1;
				}
			}
		}
		kfree(buffer.pointer);
	}
	return 0;
}
EXPORT_SYMBOL_GPL(acpi_root_bridge);


static int is_ejectable(acpi_handle handle)
{
	acpi_status status;
	acpi_handle tmp;
	unsigned long long removable;
	status = acpi_get_handle(handle, "_ADR", &tmp);
	if (ACPI_FAILURE(status))
		return 0;
	status = acpi_get_handle(handle, "_EJ0", &tmp);
	if (ACPI_SUCCESS(status))
		return 1;
	status = acpi_evaluate_integer(handle, "_RMV", NULL, &removable);
	if (ACPI_SUCCESS(status) && removable)
		return 1;
	return 0;
}

/**
 * acpi_pcihp_check_ejectable - check if handle is ejectable ACPI PCI slot
 * @pbus: the PCI bus of the PCI slot corresponding to 'handle'
 * @handle: ACPI handle to check
 *
 * Return 1 if handle is ejectable PCI slot, 0 otherwise.
 */
int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle)
{
	acpi_handle bridge_handle, parent_handle;

	if (!(bridge_handle = acpi_pci_get_bridge_handle(pbus)))
		return 0;
	if ((ACPI_FAILURE(acpi_get_parent(handle, &parent_handle))))
		return 0;
	if (bridge_handle != parent_handle)
		return 0;
	return is_ejectable(handle);
}
EXPORT_SYMBOL_GPL(acpi_pci_check_ejectable);

static acpi_status
check_hotplug(acpi_handle handle, u32 lvl, void *context, void **rv)
{
	int *found = (int *)context;
	if (is_ejectable(handle)) {
		*found = 1;
		return AE_CTRL_TERMINATE;
	}
	return AE_OK;
}

/**
 * acpi_pci_detect_ejectable - check if the PCI bus has ejectable slots
 * @pbus - PCI bus to scan
 *
 * Returns 1 if the PCI bus has ACPI based ejectable slots, 0 otherwise.
 */
int acpi_pci_detect_ejectable(struct pci_bus *pbus)
{
	acpi_handle handle;
	int found = 0;

	if (!(handle = acpi_pci_get_bridge_handle(pbus)))
		return 0;
	acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, (u32)1,
			    check_hotplug, (void *)&found, NULL);
	return found;
}
EXPORT_SYMBOL_GPL(acpi_pci_detect_ejectable);

module_param(debug_acpi, bool, 0644);
MODULE_PARM_DESC(debug_acpi, "Debugging mode for ACPI enabled or not");
Commit	Line	Data
1da177e4	1	/*
783c49fc	2	* Common ACPI functions for hot plug platforms
1da177e4	3	*
783c49fc	4	* Copyright (C) 2006 Intel Corporation
1da177e4 LT	5	*
	6	* All rights reserved.
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or (at
	11	* your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
	16	* NON INFRINGEMENT. See the GNU General Public License for more
	17	* details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	22	*
8cf4c195	23	* Send feedback to <kristen.c.accardi@intel.com>
1da177e4 LT	24	*
	25	*/
	26
1da177e4	27	#include <linux/module.h>
aad20cab	28	#include <linux/moduleparam.h>
1da177e4 LT	29	#include <linux/kernel.h>
	30	#include <linux/types.h>
	31	#include <linux/pci.h>
7a54f25c	32	#include <linux/pci_hotplug.h>
9f5404d8	33	#include <linux/acpi.h>
ac9c052d	34	#include <linux/pci-acpi.h>
1da177e4	35
aad20cab KK	36	#define MY_NAME "acpi_pcihp"
aad20cab KK	37
66bef8c0	38	#define dbg(fmt, arg...) do { if (debug_acpi) printk(KERN_DEBUG "%s: %s: " fmt , MY_NAME , __func__ , ## arg); } while (0)
aad20cab KK	39	#define err(format, arg...) printk(KERN_ERR "%s: " format , MY_NAME , ## arg)
	40	#define info(format, arg...) printk(KERN_INFO "%s: " format , MY_NAME , ## arg)
	41	#define warn(format, arg...) printk(KERN_WARNING "%s: " format , MY_NAME , ## arg)
	42
1da177e4 LT	43	#define METHOD_NAME__SUN "_SUN"
	44	#define METHOD_NAME__HPP "_HPP"
	45	#define METHOD_NAME_OSHP "OSHP"
	46
aad20cab KK	47	static int debug_acpi;
aad20cab KK	48
e22b7350 KK	49	static acpi_status
	50	decode_type0_hpx_record(union acpi_object record, struct hotplug_params hpx)
	51	{
	52	int i;
	53	union acpi_object *fields = record->package.elements;
	54	u32 revision = fields[1].integer.value;
	55
	56	switch (revision) {
	57	case 1:
	58	if (record->package.count != 6)
	59	return AE_ERROR;
	60	for (i = 2; i < 6; i++)
	61	if (fields[i].type != ACPI_TYPE_INTEGER)
	62	return AE_ERROR;
	63	hpx->t0 = &hpx->type0_data;
	64	hpx->t0->revision = revision;
	65	hpx->t0->cache_line_size = fields[2].integer.value;
	66	hpx->t0->latency_timer = fields[3].integer.value;
	67	hpx->t0->enable_serr = fields[4].integer.value;
	68	hpx->t0->enable_perr = fields[5].integer.value;
	69	break;
	70	default:
	71	printk(KERN_WARNING
	72	"%s: Type 0 Revision %d record not supported\n",
66bef8c0	73	__func__, revision);
e22b7350 KK	74	return AE_ERROR;
	75	}
	76	return AE_OK;
	77	}
	78
	79	static acpi_status
	80	decode_type1_hpx_record(union acpi_object record, struct hotplug_params hpx)
	81	{
	82	int i;
	83	union acpi_object *fields = record->package.elements;
	84	u32 revision = fields[1].integer.value;
	85
	86	switch (revision) {
	87	case 1:
	88	if (record->package.count != 5)
	89	return AE_ERROR;
	90	for (i = 2; i < 5; i++)
	91	if (fields[i].type != ACPI_TYPE_INTEGER)
	92	return AE_ERROR;
	93	hpx->t1 = &hpx->type1_data;
	94	hpx->t1->revision = revision;
	95	hpx->t1->max_mem_read = fields[2].integer.value;
	96	hpx->t1->avg_max_split = fields[3].integer.value;
	97	hpx->t1->tot_max_split = fields[4].integer.value;
	98	break;
	99	default:
	100	printk(KERN_WARNING
	101	"%s: Type 1 Revision %d record not supported\n",
66bef8c0	102	__func__, revision);
e22b7350 KK	103	return AE_ERROR;
	104	}
	105	return AE_OK;
	106	}
	107
	108	static acpi_status
	109	decode_type2_hpx_record(union acpi_object record, struct hotplug_params hpx)
	110	{
	111	int i;
	112	union acpi_object *fields = record->package.elements;
	113	u32 revision = fields[1].integer.value;
	114
	115	switch (revision) {
	116	case 1:
	117	if (record->package.count != 18)
	118	return AE_ERROR;
	119	for (i = 2; i < 18; i++)
	120	if (fields[i].type != ACPI_TYPE_INTEGER)
	121	return AE_ERROR;
	122	hpx->t2 = &hpx->type2_data;
	123	hpx->t2->revision = revision;
	124	hpx->t2->unc_err_mask_and = fields[2].integer.value;
	125	hpx->t2->unc_err_mask_or = fields[3].integer.value;
	126	hpx->t2->unc_err_sever_and = fields[4].integer.value;
	127	hpx->t2->unc_err_sever_or = fields[5].integer.value;
	128	hpx->t2->cor_err_mask_and = fields[6].integer.value;
	129	hpx->t2->cor_err_mask_or = fields[7].integer.value;
	130	hpx->t2->adv_err_cap_and = fields[8].integer.value;
	131	hpx->t2->adv_err_cap_or = fields[9].integer.value;
	132	hpx->t2->pci_exp_devctl_and = fields[10].integer.value;
	133	hpx->t2->pci_exp_devctl_or = fields[11].integer.value;
	134	hpx->t2->pci_exp_lnkctl_and = fields[12].integer.value;
	135	hpx->t2->pci_exp_lnkctl_or = fields[13].integer.value;
	136	hpx->t2->sec_unc_err_sever_and = fields[14].integer.value;
	137	hpx->t2->sec_unc_err_sever_or = fields[15].integer.value;
	138	hpx->t2->sec_unc_err_mask_and = fields[16].integer.value;
	139	hpx->t2->sec_unc_err_mask_or = fields[17].integer.value;
	140	break;
	141	default:
	142	printk(KERN_WARNING
	143	"%s: Type 2 Revision %d record not supported\n",
66bef8c0	144	__func__, revision);
e22b7350 KK	145	return AE_ERROR;
	146	}
	147	return AE_OK;
	148	}
	149
	150	static acpi_status
	151	acpi_run_hpx(acpi_handle handle, struct hotplug_params *hpx)
	152	{
	153	acpi_status status;
	154	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	155	union acpi_object package, record, *fields;
	156	u32 type;
	157	int i;
	158
	159	/* Clear the return buffer with zeros */
	160	memset(hpx, 0, sizeof(struct hotplug_params));
	161
	162	status = acpi_evaluate_object(handle, "_HPX", NULL, &buffer);
	163	if (ACPI_FAILURE(status))
	164	return status;
	165
	166	package = (union acpi_object *)buffer.pointer;
	167	if (package->type != ACPI_TYPE_PACKAGE) {
	168	status = AE_ERROR;
	169	goto exit;
	170	}
	171
	172	for (i = 0; i < package->package.count; i++) {
	173	record = &package->package.elements[i];
	174	if (record->type != ACPI_TYPE_PACKAGE) {
	175	status = AE_ERROR;
	176	goto exit;
	177	}
	178
	179	fields = record->package.elements;
	180	if (fields[0].type != ACPI_TYPE_INTEGER \|\|
	181	fields[1].type != ACPI_TYPE_INTEGER) {
	182	status = AE_ERROR;
	183	goto exit;
	184	}
	185
	186	type = fields[0].integer.value;
	187	switch (type) {
	188	case 0:
	189	status = decode_type0_hpx_record(record, hpx);
	190	if (ACPI_FAILURE(status))
	191	goto exit;
	192	break;
	193	case 1:
	194	status = decode_type1_hpx_record(record, hpx);
	195	if (ACPI_FAILURE(status))
	196	goto exit;
	197	break;
	198	case 2:
	199	status = decode_type2_hpx_record(record, hpx);
	200	if (ACPI_FAILURE(status))
	201	goto exit;
	202	break;
	203	default:
	204	printk(KERN_ERR "%s: Type %d record not supported\n",
66bef8c0	205	__func__, type);
e22b7350 KK	206	status = AE_ERROR;
	207	goto exit;
	208	}
	209	}
	210	exit:
	211	kfree(buffer.pointer);
	212	return status;
	213	}
1da177e4	214
a8a2be94	215	static acpi_status
a8a2be94	216	acpi_run_hpp(acpi_handle handle, struct hotplug_params *hpp)
1da177e4 LT	217	{
	218	acpi_status status;
	219	u8 nui[4];
	220	struct acpi_buffer ret_buf = { 0, NULL};
b2e6e3ba	221	struct acpi_buffer string = { ACPI_ALLOCATE_BUFFER, NULL };
1da177e4	222	union acpi_object ext_obj, package;
1da177e4 LT	223	int i, len = 0;
1da177e4 LT	224
b2e6e3ba MT	225	acpi_get_name(handle, ACPI_FULL_PATHNAME, &string);
b2e6e3ba MT	226
e22b7350 KK	227	/* Clear the return buffer with zeros */
	228	memset(hpp, 0, sizeof(struct hotplug_params));
	229
1da177e4	230	/* get _hpp */
a8a2be94	231	status = acpi_evaluate_object(handle, METHOD_NAME__HPP, NULL, &ret_buf);
1da177e4 LT	232	switch (status) {
	233	case AE_BUFFER_OVERFLOW:
	234	ret_buf.pointer = kmalloc (ret_buf.length, GFP_KERNEL);
	235	if (!ret_buf.pointer) {
783c49fc	236	printk(KERN_ERR "%s:%s alloc for _HPP fail\n",
66bef8c0	237	__func__, (char *)string.pointer);
81b26bca	238	kfree(string.pointer);
a8a2be94	239	return AE_NO_MEMORY;
1da177e4	240	}
a8a2be94	241	status = acpi_evaluate_object(handle, METHOD_NAME__HPP,
a8a2be94	242	NULL, &ret_buf);
1da177e4 LT	243	if (ACPI_SUCCESS(status))
	244	break;
	245	default:
	246	if (ACPI_FAILURE(status)) {
66bef8c0	247	pr_debug("%s:%s _HPP fail=0x%x\n", __func__,
b2e6e3ba	248	(char *)string.pointer, status);
81b26bca	249	kfree(string.pointer);
a8a2be94	250	return status;
1da177e4 LT	251	}
	252	}
	253
	254	ext_obj = (union acpi_object *) ret_buf.pointer;
	255	if (ext_obj->type != ACPI_TYPE_PACKAGE) {
66bef8c0	256	printk(KERN_ERR "%s:%s _HPP obj not a package\n", __func__,
b2e6e3ba	257	(char *)string.pointer);
a8a2be94	258	status = AE_ERROR;
1da177e4 LT	259	goto free_and_return;
	260	}
	261
	262	len = ext_obj->package.count;
	263	package = (union acpi_object *) ret_buf.pointer;
	264	for ( i = 0; (i < len) \|\| (i < 4); i++) {
	265	ext_obj = (union acpi_object *) &package->package.elements[i];
	266	switch (ext_obj->type) {
	267	case ACPI_TYPE_INTEGER:
	268	nui[i] = (u8)ext_obj->integer.value;
	269	break;
	270	default:
783c49fc	271	printk(KERN_ERR "%s:%s _HPP obj type incorrect\n",
66bef8c0	272	__func__, (char *)string.pointer);
a8a2be94	273	status = AE_ERROR;
1da177e4 LT	274	goto free_and_return;
	275	}
	276	}
	277
e22b7350 KK	278	hpp->t0 = &hpp->type0_data;
	279	hpp->t0->cache_line_size = nui[0];
	280	hpp->t0->latency_timer = nui[1];
	281	hpp->t0->enable_serr = nui[2];
	282	hpp->t0->enable_perr = nui[3];
1da177e4	283
e22b7350 KK	284	pr_debug(" _HPP: cache_line_size=0x%x\n", hpp->t0->cache_line_size);
	285	pr_debug(" _HPP: latency timer =0x%x\n", hpp->t0->latency_timer);
	286	pr_debug(" _HPP: enable SERR =0x%x\n", hpp->t0->enable_serr);
	287	pr_debug(" _HPP: enable PERR =0x%x\n", hpp->t0->enable_perr);
1da177e4 LT	288
1da177e4 LT	289	free_and_return:
81b26bca KA	290	kfree(string.pointer);
81b26bca KA	291	kfree(ret_buf.pointer);
a8a2be94	292	return status;
1da177e4 LT	293	}
1da177e4 LT	294
783c49fc KA	295
	296
	297	/* acpi_run_oshp - get control of hotplug from the firmware
	298	*
	299	* @handle - the handle of the hotplug controller.
	300	*/
ac9c052d	301	static acpi_status acpi_run_oshp(acpi_handle handle)
1da177e4 LT	302	{
1da177e4 LT	303	acpi_status status;
b2e6e3ba MT	304	struct acpi_buffer string = { ACPI_ALLOCATE_BUFFER, NULL };
	305
	306	acpi_get_name(handle, ACPI_FULL_PATHNAME, &string);
1da177e4 LT	307
1da177e4 LT	308	/* run OSHP */
a8a2be94	309	status = acpi_evaluate_object(handle, METHOD_NAME_OSHP, NULL, NULL);
783c49fc	310	if (ACPI_FAILURE(status))
aad20cab KK	311	if (status != AE_NOT_FOUND)
aad20cab KK	312	printk(KERN_ERR "%s:%s OSHP fails=0x%x\n",
66bef8c0	313	__func__, (char *)string.pointer, status);
aad20cab KK	314	else
aad20cab KK	315	dbg("%s:%s OSHP not found\n",
66bef8c0	316	__func__, (char *)string.pointer);
783c49fc	317	else
66bef8c0	318	pr_debug("%s:%s OSHP passes\n", __func__,
b2e6e3ba MT	319	(char *)string.pointer);
b2e6e3ba MT	320
81b26bca	321	kfree(string.pointer);
783c49fc KA	322	return status;
783c49fc KA	323	}
783c49fc KA	324
	325	/* acpi_get_hp_params_from_firmware
	326	*
7430e34c	327	* @bus - the pci_bus of the bus on which the device is newly added
783c49fc KA	328	* @hpp - allocated by the caller
783c49fc KA	329	*/
7430e34c	330	acpi_status acpi_get_hp_params_from_firmware(struct pci_bus *bus,
783c49fc KA	331	struct hotplug_params *hpp)
	332	{
	333	acpi_status status = AE_NOT_FOUND;
7430e34c KK	334	acpi_handle handle, phandle;
	335	struct pci_bus *pbus = bus;
	336	struct pci_dev *pdev;
	337
	338	do {
	339	pdev = pbus->self;
	340	if (!pdev) {
	341	handle = acpi_get_pci_rootbridge_handle(
	342	pci_domain_nr(pbus), pbus->number);
	343	break;
	344	}
	345	handle = DEVICE_ACPI_HANDLE(&(pdev->dev));
	346	pbus = pbus->parent;
	347	} while (!handle);
783c49fc KA	348
	349	/*
	350	* _HPP settings apply to all child buses, until another _HPP is
	351	* encountered. If we don't find an _HPP for the input pci dev,
	352	* look for it in the parent device scope since that would apply to
	353	* this pci dev. If we don't find any _HPP, use hardcoded defaults
	354	*/
7430e34c	355	while (handle) {
e22b7350 KK	356	status = acpi_run_hpx(handle, hpp);
	357	if (ACPI_SUCCESS(status))
	358	break;
783c49fc	359	status = acpi_run_hpp(handle, hpp);
7430e34c KK	360	if (ACPI_SUCCESS(status))
	361	break;
	362	if (acpi_root_bridge(handle))
	363	break;
	364	status = acpi_get_parent(handle, &phandle);
	365	if (ACPI_FAILURE(status))
783c49fc	366	break;
7430e34c	367	handle = phandle;
1da177e4	368	}
a8a2be94	369	return status;
1da177e4	370	}
783c49fc KA	371	EXPORT_SYMBOL_GPL(acpi_get_hp_params_from_firmware);
783c49fc KA	372
ac9c052d KK	373	/**
	374	* acpi_get_hp_hw_control_from_firmware
	375	* @dev: the pci_dev of the bridge that has a hotplug controller
	376	* @flags: requested control bits for _OSC
	377	*
	378	* Attempt to take hotplug control from firmware.
	379	*/
	380	int acpi_get_hp_hw_control_from_firmware(struct pci_dev *dev, u32 flags)
	381	{
	382	acpi_status status;
e0d94bee	383	acpi_handle chandle, handle;
ac9c052d KK	384	struct pci_dev *pdev = dev;
	385	struct pci_bus *parent;
	386	struct acpi_buffer string = { ACPI_ALLOCATE_BUFFER, NULL };
	387
	388	flags &= (OSC_PCI_EXPRESS_NATIVE_HP_CONTROL \|
	389	OSC_SHPC_NATIVE_HP_CONTROL \|
	390	OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL);
	391	if (!flags) {
	392	err("Invalid flags %u specified!\n", flags);
	393	return -EINVAL;
	394	}
	395
	396	/*
	397	* Per PCI firmware specification, we should run the ACPI _OSC
	398	* method to get control of hotplug hardware before using it. If
	399	* an _OSC is missing, we look for an OSHP to do the same thing.
e0d94bee JS	400	* To handle different BIOS behavior, we look for _OSC on a root
	401	* bridge preferentially (according to PCI fw spec). Later for
	402	* OSHP within the scope of the hotplug controller and its parents,
ac9c052d KK	403	* upto the host bridge under which this controller exists.
ac9c052d KK	404	*/
056c58e8	405	handle = acpi_find_root_bridge_handle(pdev);
e0d94bee JS	406	if (handle) {
	407	acpi_get_name(handle, ACPI_FULL_PATHNAME, &string);
	408	dbg("Trying to get hotplug control for %s\n",
	409	(char *)string.pointer);
9f5404d8	410	status = acpi_pci_osc_control_set(handle, flags);
e0d94bee JS	411	if (ACPI_SUCCESS(status))
	412	goto got_one;
	413	kfree(string.pointer);
	414	string = (struct acpi_buffer){ ACPI_ALLOCATE_BUFFER, NULL };
	415	}
	416
	417	pdev = dev;
	418	handle = DEVICE_ACPI_HANDLE(&dev->dev);
ac9c052d KK	419	while (!handle) {
	420	/*
	421	* This hotplug controller was not listed in the ACPI name
	422	* space at all. Try to get acpi handle of parent pci bus.
	423	*/
	424	if (!pdev \|\| !pdev->bus->parent)
	425	break;
	426	parent = pdev->bus->parent;
	427	dbg("Could not find %s in acpi namespace, trying parent\n",
	428	pci_name(pdev));
	429	if (!parent->self)
	430	/* Parent must be a host bridge */
	431	handle = acpi_get_pci_rootbridge_handle(
	432	pci_domain_nr(parent),
	433	parent->number);
	434	else
	435	handle = DEVICE_ACPI_HANDLE(&(parent->self->dev));
	436	pdev = parent->self;
	437	}
	438
	439	while (handle) {
	440	acpi_get_name(handle, ACPI_FULL_PATHNAME, &string);
	441	dbg("Trying to get hotplug control for %s \n",
	442	(char *)string.pointer);
e0d94bee JS	443	status = acpi_run_oshp(handle);
	444	if (ACPI_SUCCESS(status))
	445	goto got_one;
ac9c052d KK	446	if (acpi_root_bridge(handle))
	447	break;
	448	chandle = handle;
	449	status = acpi_get_parent(chandle, &handle);
	450	if (ACPI_FAILURE(status))
	451	break;
	452	}
	453
	454	dbg("Cannot get control of hotplug hardware for pci %s\n",
	455	pci_name(dev));
	456
	457	kfree(string.pointer);
	458	return -ENODEV;
e0d94bee JS	459	got_one:
	460	dbg("Gained control for hotplug HW for pci %s (%s)\n", pci_name(dev),
	461	(char *)string.pointer);
	462	kfree(string.pointer);
	463	return 0;
ac9c052d KK	464	}
ac9c052d KK	465	EXPORT_SYMBOL(acpi_get_hp_hw_control_from_firmware);
1da177e4	466
783c49fc KA	467	/* acpi_root_bridge - check to see if this acpi object is a root bridge
	468	*
	469	* @handle - the acpi object in question.
	470	*/
	471	int acpi_root_bridge(acpi_handle handle)
a3a45ec8	472	{
	473	acpi_status status;
	474	struct acpi_device_info *info;
	475	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	476	int i;
	477
	478	status = acpi_get_object_info(handle, &buffer);
	479	if (ACPI_SUCCESS(status)) {
	480	info = buffer.pointer;
	481	if ((info->valid & ACPI_VALID_HID) &&
	482	!strcmp(PCI_ROOT_HID_STRING,
	483	info->hardware_id.value)) {
81b26bca	484	kfree(buffer.pointer);
a3a45ec8	485	return 1;
	486	}
	487	if (info->valid & ACPI_VALID_CID) {
	488	for (i=0; i < info->compatibility_id.count; i++) {
	489	if (!strcmp(PCI_ROOT_HID_STRING,
	490	info->compatibility_id.id[i].value)) {
81b26bca	491	kfree(buffer.pointer);
a3a45ec8	492	return 1;
	493	}
	494	}
	495	}
81b26bca	496	kfree(buffer.pointer);
a3a45ec8	497	}
	498	return 0;
	499	}
783c49fc	500	EXPORT_SYMBOL_GPL(acpi_root_bridge);
aad20cab	501
e8c331e9 KK	502
	503	static int is_ejectable(acpi_handle handle)
	504	{
	505	acpi_status status;
	506	acpi_handle tmp;
	507	unsigned long long removable;
	508	status = acpi_get_handle(handle, "_ADR", &tmp);
	509	if (ACPI_FAILURE(status))
	510	return 0;
	511	status = acpi_get_handle(handle, "_EJ0", &tmp);
	512	if (ACPI_SUCCESS(status))
	513	return 1;
	514	status = acpi_evaluate_integer(handle, "_RMV", NULL, &removable);
	515	if (ACPI_SUCCESS(status) && removable)
	516	return 1;
	517	return 0;
	518	}
	519
	520	/**
	521	* acpi_pcihp_check_ejectable - check if handle is ejectable ACPI PCI slot
	522	* @pbus: the PCI bus of the PCI slot corresponding to 'handle'
	523	* @handle: ACPI handle to check
	524	*
	525	* Return 1 if handle is ejectable PCI slot, 0 otherwise.
	526	*/
	527	int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle)
	528	{
	529	acpi_handle bridge_handle, parent_handle;
	530
	531	if (!(bridge_handle = acpi_pci_get_bridge_handle(pbus)))
	532	return 0;
	533	if ((ACPI_FAILURE(acpi_get_parent(handle, &parent_handle))))
	534	return 0;
	535	if (bridge_handle != parent_handle)
	536	return 0;
	537	return is_ejectable(handle);
	538	}
	539	EXPORT_SYMBOL_GPL(acpi_pci_check_ejectable);
	540
	541	static acpi_status
	542	check_hotplug(acpi_handle handle, u32 lvl, void context, void *rv)
	543	{
	544	int found = (int )context;
	545	if (is_ejectable(handle)) {
	546	*found = 1;
	547	return AE_CTRL_TERMINATE;
	548	}
	549	return AE_OK;
	550	}
	551
	552	/**
	553	* acpi_pci_detect_ejectable - check if the PCI bus has ejectable slots
	554	* @pbus - PCI bus to scan
	555	*
	556	* Returns 1 if the PCI bus has ACPI based ejectable slots, 0 otherwise.
	557	*/
	558	int acpi_pci_detect_ejectable(struct pci_bus *pbus)
	559	{
	560	acpi_handle handle;
	561	int found = 0;
	562
	563	if (!(handle = acpi_pci_get_bridge_handle(pbus)))
	564	return 0;
	565	acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, (u32)1,
566	check_hotplug, (void *)&found, NULL);
567	return found;
568	}
569	EXPORT_SYMBOL_GPL(acpi_pci_detect_ejectable);
570
aad20cab KK	571	module_param(debug_acpi, bool, 0644);
aad20cab KK	572	MODULE_PARM_DESC(debug_acpi, "Debugging mode for ACPI enabled or not");