[mirror_ubuntu-jammy-kernel.git] / drivers / pci / hotplug / pciehprm_acpi.c

/*
 * PCIEHPRM ACPI: PHP Resource Manager for ACPI platform
 *
 * Copyright (C) 2003-2004 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/kernel.h>
#include <linux/types.h>
#include <linux/pci.h>
#include <linux/acpi.h>
#include <linux/pci-acpi.h>
#include <acpi/acpi_bus.h>
#include <acpi/actypes.h>
#include "pciehp.h"

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

static u8 * acpi_path_name( acpi_handle	handle)
{
	acpi_status		status;
	static u8		path_name[ACPI_PATHNAME_MAX];
	struct acpi_buffer	ret_buf = { ACPI_PATHNAME_MAX, path_name };

	memset(path_name, 0, sizeof (path_name));
	status = acpi_get_name(handle, ACPI_FULL_PATHNAME, &ret_buf);

	if (ACPI_FAILURE(status))
		return NULL;
	else
		return path_name;	
}

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};
	union acpi_object	*ext_obj, *package;
	u8			*path_name = acpi_path_name(handle);
	int			i, len = 0;

	/* 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) {
			err ("%s:%s alloc for _HPP fail\n", __FUNCTION__,
					path_name);
			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)) {
			dbg("%s:%s _HPP fail=0x%x\n", __FUNCTION__,
					path_name, status);
			return status;
		}
	}

	ext_obj = (union acpi_object *) ret_buf.pointer;
	if (ext_obj->type != ACPI_TYPE_PACKAGE) {
		err ("%s:%s _HPP obj not a package\n", __FUNCTION__,
				path_name);
		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:
			err ("%s:%s _HPP obj type incorrect\n", __FUNCTION__,
					path_name);
			status = AE_ERROR;
			goto free_and_return;
		}
	}

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

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

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

static acpi_status acpi_run_oshp(acpi_handle handle)
{
	acpi_status		status;
	u8			*path_name = acpi_path_name(handle);

	/* run OSHP */
	status = acpi_evaluate_object(handle, METHOD_NAME_OSHP, NULL, NULL);
	if (ACPI_FAILURE(status)) {
		dbg("%s:%s OSHP fails=0x%x\n", __FUNCTION__, path_name,
				status);
	} else {
		dbg("%s:%s OSHP passes\n", __FUNCTION__, path_name);
	}
	return status;
}

static int is_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)) {
			acpi_os_free(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)) {
					acpi_os_free(buffer.pointer);
					return 1;
				}
			}
		}
	}
	return 0;
}

int pciehp_get_hp_hw_control_from_firmware(struct pci_dev *dev)
{
	acpi_status status;
	acpi_handle chandle, handle = DEVICE_ACPI_HANDLE(&(dev->dev));
	struct pci_dev *pdev = dev;
	struct pci_bus *parent;
	u8 *path_name;

	/*
	 * 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 and OSHP
	 * within the scope of the hotplug controller and its parents, upto
	 * the host bridge under which this controller exists.
	 */
	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) {
		path_name = acpi_path_name(handle);
		dbg("Trying to get hotplug control for %s \n", path_name);
		status = pci_osc_control_set(handle,
				OSC_PCI_EXPRESS_NATIVE_HP_CONTROL);
		if (status == AE_NOT_FOUND)
			status = acpi_run_oshp(handle);
		if (ACPI_SUCCESS(status)) {
			dbg("Gained control for hotplug HW for pci %s (%s)\n",
				pci_name(dev), path_name);
			return 0;
		}
		if (is_root_bridge(handle))
			break;
		chandle = handle;
		status = acpi_get_parent(chandle, &handle);
		if (ACPI_FAILURE(status))
			break;
	}

	err("Cannot get control of hotplug hardware for pci %s\n",
			pci_name(dev));
	return -1;
}

void pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
		struct hotplug_params *hpp)
{
	acpi_status status = AE_NOT_FOUND;
	struct pci_dev *pdev = dev;

	/*
	 * _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 (pdev && (ACPI_FAILURE(status))) {
		acpi_handle handle = DEVICE_ACPI_HANDLE(&(pdev->dev));
		if (!handle)
			break;
		status = acpi_run_hpp(handle, hpp);
		if (!(pdev->bus->parent))
			break;
		/* Check if a parent object supports _HPP */
		pdev = pdev->bus->parent->self;
	}
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* PCIEHPRM ACPI: PHP Resource Manager for ACPI platform
	3	*
	4	* Copyright (C) 2003-2004 Intel Corporation
	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 LT	27	#include <linux/module.h>
	28	#include <linux/kernel.h>
	29	#include <linux/types.h>
	30	#include <linux/pci.h>
1da177e4	31	#include <linux/acpi.h>
1da177e4	32	#include <linux/pci-acpi.h>
1da177e4 LT	33	#include <acpi/acpi_bus.h>
	34	#include <acpi/actypes.h>
	35	#include "pciehp.h"
1da177e4 LT	36
	37	#define METHOD_NAME__SUN "_SUN"
	38	#define METHOD_NAME__HPP "_HPP"
	39	#define METHOD_NAME_OSHP "OSHP"
	40
1da177e4 LT	41	static u8 * acpi_path_name( acpi_handle handle)
	42	{
	43	acpi_status status;
	44	static u8 path_name[ACPI_PATHNAME_MAX];
	45	struct acpi_buffer ret_buf = { ACPI_PATHNAME_MAX, path_name };
	46
	47	memset(path_name, 0, sizeof (path_name));
	48	status = acpi_get_name(handle, ACPI_FULL_PATHNAME, &ret_buf);
	49
	50	if (ACPI_FAILURE(status))
	51	return NULL;
	52	else
	53	return path_name;
	54	}
	55
a8a2be94 RS	56	static acpi_status
a8a2be94 RS	57	acpi_run_hpp(acpi_handle handle, struct hotplug_params *hpp)
1da177e4 LT	58	{
	59	acpi_status status;
	60	u8 nui[4];
	61	struct acpi_buffer ret_buf = { 0, NULL};
	62	union acpi_object ext_obj, package;
a8a2be94	63	u8 *path_name = acpi_path_name(handle);
1da177e4 LT	64	int i, len = 0;
	65
	66	/* get _hpp */
a8a2be94	67	status = acpi_evaluate_object(handle, METHOD_NAME__HPP, NULL, &ret_buf);
1da177e4 LT	68	switch (status) {
	69	case AE_BUFFER_OVERFLOW:
	70	ret_buf.pointer = kmalloc (ret_buf.length, GFP_KERNEL);
	71	if (!ret_buf.pointer) {
a8a2be94 RS	72	err ("%s:%s alloc for _HPP fail\n", __FUNCTION__,
	73	path_name);
	74	return AE_NO_MEMORY;
1da177e4	75	}
a8a2be94 RS	76	status = acpi_evaluate_object(handle, METHOD_NAME__HPP,
a8a2be94 RS	77	NULL, &ret_buf);
1da177e4 LT	78	if (ACPI_SUCCESS(status))
	79	break;
	80	default:
	81	if (ACPI_FAILURE(status)) {
a8a2be94 RS	82	dbg("%s:%s _HPP fail=0x%x\n", __FUNCTION__,
	83	path_name, status);
	84	return status;
1da177e4 LT	85	}
	86	}
	87
	88	ext_obj = (union acpi_object *) ret_buf.pointer;
	89	if (ext_obj->type != ACPI_TYPE_PACKAGE) {
a8a2be94 RS	90	err ("%s:%s _HPP obj not a package\n", __FUNCTION__,
	91	path_name);
	92	status = AE_ERROR;
1da177e4 LT	93	goto free_and_return;
	94	}
	95
	96	len = ext_obj->package.count;
	97	package = (union acpi_object *) ret_buf.pointer;
	98	for ( i = 0; (i < len) \|\| (i < 4); i++) {
	99	ext_obj = (union acpi_object *) &package->package.elements[i];
	100	switch (ext_obj->type) {
	101	case ACPI_TYPE_INTEGER:
	102	nui[i] = (u8)ext_obj->integer.value;
	103	break;
	104	default:
a8a2be94 RS	105	err ("%s:%s _HPP obj type incorrect\n", __FUNCTION__,
	106	path_name);
	107	status = AE_ERROR;
1da177e4 LT	108	goto free_and_return;
	109	}
	110	}
	111
a8a2be94 RS	112	hpp->cache_line_size = nui[0];
	113	hpp->latency_timer = nui[1];
	114	hpp->enable_serr = nui[2];
	115	hpp->enable_perr = nui[3];
1da177e4	116
a8a2be94 RS	117	dbg(" _HPP: cache_line_size=0x%x\n", hpp->cache_line_size);
	118	dbg(" _HPP: latency timer =0x%x\n", hpp->latency_timer);
	119	dbg(" _HPP: enable SERR =0x%x\n", hpp->enable_serr);
	120	dbg(" _HPP: enable PERR =0x%x\n", hpp->enable_perr);
1da177e4 LT	121
	122	free_and_return:
	123	kfree(ret_buf.pointer);
a8a2be94	124	return status;
1da177e4 LT	125	}
1da177e4 LT	126
a8a2be94	127	static acpi_status acpi_run_oshp(acpi_handle handle)
1da177e4 LT	128	{
1da177e4 LT	129	acpi_status status;
a8a2be94	130	u8 *path_name = acpi_path_name(handle);
1da177e4 LT	131
1da177e4 LT	132	/* run OSHP */
a8a2be94	133	status = acpi_evaluate_object(handle, METHOD_NAME_OSHP, NULL, NULL);
1da177e4	134	if (ACPI_FAILURE(status)) {
a3a45ec8	135	dbg("%s:%s OSHP fails=0x%x\n", __FUNCTION__, path_name,
a8a2be94	136	status);
1da177e4	137	} else {
a8a2be94	138	dbg("%s:%s OSHP passes\n", __FUNCTION__, path_name);
1da177e4	139	}
a8a2be94	140	return status;
1da177e4 LT	141	}
1da177e4 LT	142
a3a45ec8 RS	143	static int is_root_bridge(acpi_handle handle)
	144	{
	145	acpi_status status;
	146	struct acpi_device_info *info;
	147	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	148	int i;
	149
	150	status = acpi_get_object_info(handle, &buffer);
	151	if (ACPI_SUCCESS(status)) {
	152	info = buffer.pointer;
	153	if ((info->valid & ACPI_VALID_HID) &&
	154	!strcmp(PCI_ROOT_HID_STRING,
	155	info->hardware_id.value)) {
	156	acpi_os_free(buffer.pointer);
	157	return 1;
	158	}
	159	if (info->valid & ACPI_VALID_CID) {
	160	for (i=0; i < info->compatibility_id.count; i++) {
	161	if (!strcmp(PCI_ROOT_HID_STRING,
	162	info->compatibility_id.id[i].value)) {
	163	acpi_os_free(buffer.pointer);
	164	return 1;
	165	}
	166	}
	167	}
	168	}
	169	return 0;
	170	}
	171
6560aa5c	172	int pciehp_get_hp_hw_control_from_firmware(struct pci_dev *dev)
1da177e4	173	{
a8a2be94	174	acpi_status status;
a3a45ec8 RS	175	acpi_handle chandle, handle = DEVICE_ACPI_HANDLE(&(dev->dev));
a3a45ec8 RS	176	struct pci_dev *pdev = dev;
c2dea655	177	struct pci_bus *parent;
a3a45ec8	178	u8 *path_name;
c2dea655	179
a8a2be94 RS	180	/*
a8a2be94 RS	181	* Per PCI firmware specification, we should run the ACPI _OSC
a3a45ec8 RS	182	* method to get control of hotplug hardware before using it.
	183	* If an _OSC is missing, we look for an OSHP to do the same thing.
	184	* To handle different BIOS behavior, we look for _OSC and OSHP
	185	* within the scope of the hotplug controller and its parents, upto
	186	* the host bridge under which this controller exists.
a8a2be94	187	*/
a3a45ec8	188	while (!handle) {
a8a2be94	189	/*
a3a45ec8 RS	190	* This hotplug controller was not listed in the ACPI name
a3a45ec8 RS	191	* space at all. Try to get acpi handle of parent pci bus.
a8a2be94	192	*/
a3a45ec8 RS	193	if (!pdev \|\| !pdev->bus->parent)
a3a45ec8 RS	194	break;
c2dea655	195	parent = pdev->bus->parent;
a3a45ec8 RS	196	dbg("Could not find %s in acpi namespace, trying parent\n",
a3a45ec8 RS	197	pci_name(pdev));
c2dea655	198	if (!parent->self)
a3a45ec8 RS	199	/* Parent must be a host bridge */
a3a45ec8 RS	200	handle = acpi_get_pci_rootbridge_handle(
c2dea655 JJ	201	pci_domain_nr(parent),
c2dea655 JJ	202	parent->number);
a3a45ec8 RS	203	else
a3a45ec8 RS	204	handle = DEVICE_ACPI_HANDLE(
c2dea655 JJ	205	&(parent->self->dev));
c2dea655 JJ	206	pdev = parent->self;
1da177e4	207	}
a3a45ec8 RS	208
	209	while (handle) {
	210	path_name = acpi_path_name(handle);
	211	dbg("Trying to get hotplug control for %s \n", path_name);
	212	status = pci_osc_control_set(handle,
	213	OSC_PCI_EXPRESS_NATIVE_HP_CONTROL);
	214	if (status == AE_NOT_FOUND)
	215	status = acpi_run_oshp(handle);
	216	if (ACPI_SUCCESS(status)) {
	217	dbg("Gained control for hotplug HW for pci %s (%s)\n",
	218	pci_name(dev), path_name);
	219	return 0;
	220	}
	221	if (is_root_bridge(handle))
	222	break;
	223	chandle = handle;
	224	status = acpi_get_parent(chandle, &handle);
	225	if (ACPI_FAILURE(status))
	226	break;
1da177e4 LT	227	}
1da177e4 LT	228
a3a45ec8 RS	229	err("Cannot get control of hotplug hardware for pci %s\n",
	230	pci_name(dev));
	231	return -1;
1da177e4 LT	232	}
1da177e4 LT	233
6560aa5c	234	void pciehp_get_hp_params_from_firmware(struct pci_dev *dev,
a8a2be94	235	struct hotplug_params *hpp)
1da177e4	236	{
a8a2be94 RS	237	acpi_status status = AE_NOT_FOUND;
a8a2be94 RS	238	struct pci_dev *pdev = dev;
1da177e4 LT	239
1da177e4 LT	240	/*
a8a2be94 RS	241	* _HPP settings apply to all child buses, until another _HPP is
	242	* encountered. If we don't find an _HPP for the input pci dev,
	243	* look for it in the parent device scope since that would apply to
	244	* this pci dev. If we don't find any _HPP, use hardcoded defaults
1da177e4	245	*/
a8a2be94 RS	246	while (pdev && (ACPI_FAILURE(status))) {
	247	acpi_handle handle = DEVICE_ACPI_HANDLE(&(pdev->dev));
	248	if (!handle)
	249	break;
	250	status = acpi_run_hpp(handle, hpp);
	251	if (!(pdev->bus->parent))
	252	break;
	253	/* Check if a parent object supports _HPP */
	254	pdev = pdev->bus->parent->self;
1da177e4	255	}
1da177e4 LT	256	}
1da177e4 LT	257