[net-next-2.6.git] / drivers / pci / pcie / portdrv_pci.c

/*
 * File:	portdrv_pci.c
 * Purpose:	PCI Express Port Bus Driver
 *
 * Copyright (C) 2004 Intel
 * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
 */

#include <linux/module.h>
#include <linux/pci.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/pm.h>
#include <linux/init.h>
#include <linux/pcieport_if.h>
#include <linux/aer.h>
#include <linux/dmi.h>
#include <linux/pci-aspm.h>

#include "portdrv.h"
#include "aer/aerdrv.h"

/*
 * Version Information
 */
#define DRIVER_VERSION "v1.0"
#define DRIVER_AUTHOR "tom.l.nguyen@intel.com"
#define DRIVER_DESC "PCIe Port Bus Driver"
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");

/* If this switch is set, PCIe port native services should not be enabled. */
bool pcie_ports_disabled;

/*
 * If this switch is set, ACPI _OSC will be used to determine whether or not to
 * enable PCIe port native services.
 */
bool pcie_ports_auto = true;

static int __init pcie_port_setup(char *str)
{
	if (!strncmp(str, "compat", 6)) {
		pcie_ports_disabled = true;
	} else if (!strncmp(str, "native", 6)) {
		pcie_ports_disabled = false;
		pcie_ports_auto = false;
	} else if (!strncmp(str, "auto", 4)) {
		pcie_ports_disabled = false;
		pcie_ports_auto = true;
	}

	return 1;
}
__setup("pcie_ports=", pcie_port_setup);

/* global data */

static int pcie_portdrv_restore_config(struct pci_dev *dev)
{
	int retval;

	retval = pci_enable_device(dev);
	if (retval)
		return retval;
	pci_set_master(dev);
	return 0;
}

#ifdef CONFIG_PM
static const struct dev_pm_ops pcie_portdrv_pm_ops = {
	.suspend	= pcie_port_device_suspend,
	.resume		= pcie_port_device_resume,
	.freeze		= pcie_port_device_suspend,
	.thaw		= pcie_port_device_resume,
	.poweroff	= pcie_port_device_suspend,
	.restore	= pcie_port_device_resume,
};

#define PCIE_PORTDRV_PM_OPS	(&pcie_portdrv_pm_ops)

#else /* !PM */

#define PCIE_PORTDRV_PM_OPS	NULL
#endif /* !PM */

/*
 * pcie_portdrv_probe - Probe PCI-Express port devices
 * @dev: PCI-Express port device being probed
 *
 * If detected invokes the pcie_port_device_register() method for
 * this port device.
 *
 */
static int __devinit pcie_portdrv_probe(struct pci_dev *dev,
					const struct pci_device_id *id)
{
	int status;

	if (!pci_is_pcie(dev) ||
	    ((dev->pcie_type != PCI_EXP_TYPE_ROOT_PORT) &&
	     (dev->pcie_type != PCI_EXP_TYPE_UPSTREAM) &&
	     (dev->pcie_type != PCI_EXP_TYPE_DOWNSTREAM)))
		return -ENODEV;

	if (!dev->irq && dev->pin) {
		dev_warn(&dev->dev, "device [%04x:%04x] has invalid IRQ; "
			 "check vendor BIOS\n", dev->vendor, dev->device);
	}
	status = pcie_port_device_register(dev);
	if (status)
		return status;

	pci_save_state(dev);

	return 0;
}

static void pcie_portdrv_remove(struct pci_dev *dev)
{
	pcie_port_device_remove(dev);
	pci_disable_device(dev);
}

static int error_detected_iter(struct device *device, void *data)
{
	struct pcie_device *pcie_device;
	struct pcie_port_service_driver *driver;
	struct aer_broadcast_data *result_data;
	pci_ers_result_t status;

	result_data = (struct aer_broadcast_data *) data;

	if (device->bus == &pcie_port_bus_type && device->driver) {
		driver = to_service_driver(device->driver);
		if (!driver ||
			!driver->err_handler ||
			!driver->err_handler->error_detected)
			return 0;

		pcie_device = to_pcie_device(device);

		/* Forward error detected message to service drivers */
		status = driver->err_handler->error_detected(
			pcie_device->port,
			result_data->state);
		result_data->result =
			merge_result(result_data->result, status);
	}

	return 0;
}

static pci_ers_result_t pcie_portdrv_error_detected(struct pci_dev *dev,
					enum pci_channel_state error)
{
	struct aer_broadcast_data data = {error, PCI_ERS_RESULT_CAN_RECOVER};
	int ret;

	/* can not fail */
	ret = device_for_each_child(&dev->dev, &data, error_detected_iter);

	return data.result;
}

static int mmio_enabled_iter(struct device *device, void *data)
{
	struct pcie_device *pcie_device;
	struct pcie_port_service_driver *driver;
	pci_ers_result_t status, *result;

	result = (pci_ers_result_t *) data;

	if (device->bus == &pcie_port_bus_type && device->driver) {
		driver = to_service_driver(device->driver);
		if (driver &&
			driver->err_handler &&
			driver->err_handler->mmio_enabled) {
			pcie_device = to_pcie_device(device);

			/* Forward error message to service drivers */
			status = driver->err_handler->mmio_enabled(
					pcie_device->port);
			*result = merge_result(*result, status);
		}
	}

	return 0;
}

static pci_ers_result_t pcie_portdrv_mmio_enabled(struct pci_dev *dev)
{
	pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
	int retval;

	/* get true return value from &status */
	retval = device_for_each_child(&dev->dev, &status, mmio_enabled_iter);
	return status;
}

static int slot_reset_iter(struct device *device, void *data)
{
	struct pcie_device *pcie_device;
	struct pcie_port_service_driver *driver;
	pci_ers_result_t status, *result;

	result = (pci_ers_result_t *) data;

	if (device->bus == &pcie_port_bus_type && device->driver) {
		driver = to_service_driver(device->driver);
		if (driver &&
			driver->err_handler &&
			driver->err_handler->slot_reset) {
			pcie_device = to_pcie_device(device);

			/* Forward error message to service drivers */
			status = driver->err_handler->slot_reset(
					pcie_device->port);
			*result = merge_result(*result, status);
		}
	}

	return 0;
}

static pci_ers_result_t pcie_portdrv_slot_reset(struct pci_dev *dev)
{
	pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
	int retval;

	/* If fatal, restore cfg space for possible link reset at upstream */
	if (dev->error_state == pci_channel_io_frozen) {
		dev->state_saved = true;
		pci_restore_state(dev);
		pcie_portdrv_restore_config(dev);
		pci_enable_pcie_error_reporting(dev);
	}

	/* get true return value from &status */
	retval = device_for_each_child(&dev->dev, &status, slot_reset_iter);

	return status;
}

static int resume_iter(struct device *device, void *data)
{
	struct pcie_device *pcie_device;
	struct pcie_port_service_driver *driver;

	if (device->bus == &pcie_port_bus_type && device->driver) {
		driver = to_service_driver(device->driver);
		if (driver &&
			driver->err_handler &&
			driver->err_handler->resume) {
			pcie_device = to_pcie_device(device);

			/* Forward error message to service drivers */
			driver->err_handler->resume(pcie_device->port);
		}
	}

	return 0;
}

static void pcie_portdrv_err_resume(struct pci_dev *dev)
{
	int retval;
	/* nothing to do with error value, if it ever happens */
	retval = device_for_each_child(&dev->dev, NULL, resume_iter);
}

/*
 * LINUX Device Driver Model
 */
static const struct pci_device_id port_pci_ids[] = { {
	/* handle any PCI-Express port */
	PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0),
	}, { /* end: all zeroes */ }
};
MODULE_DEVICE_TABLE(pci, port_pci_ids);

static struct pci_error_handlers pcie_portdrv_err_handler = {
		.error_detected = pcie_portdrv_error_detected,
		.mmio_enabled = pcie_portdrv_mmio_enabled,
		.slot_reset = pcie_portdrv_slot_reset,
		.resume = pcie_portdrv_err_resume,
};

static struct pci_driver pcie_portdriver = {
	.name		= "pcieport",
	.id_table	= &port_pci_ids[0],

	.probe		= pcie_portdrv_probe,
	.remove		= pcie_portdrv_remove,

	.err_handler 	= &pcie_portdrv_err_handler,

	.driver.pm 	= PCIE_PORTDRV_PM_OPS,
};

static int __init dmi_pcie_pme_disable_msi(const struct dmi_system_id *d)
{
	pr_notice("%s detected: will not use MSI for PCIe PME signaling\n",
			d->ident);
	pcie_pme_disable_msi();
	return 0;
}

static struct dmi_system_id __initdata pcie_portdrv_dmi_table[] = {
	/*
	 * Boxes that should not use MSI for PCIe PME signaling.
	 */
	{
	 .callback = dmi_pcie_pme_disable_msi,
	 .ident = "MSI Wind U-100",
	 .matches = {
		     DMI_MATCH(DMI_SYS_VENDOR,
		     		"MICRO-STAR INTERNATIONAL CO., LTD"),
		     DMI_MATCH(DMI_PRODUCT_NAME, "U-100"),
		     },
	 },
	 {}
};

static int __init pcie_portdrv_init(void)
{
	int retval;

	if (pcie_ports_disabled) {
		pcie_no_aspm();
		return -EACCES;
	}

	dmi_check_system(pcie_portdrv_dmi_table);

	retval = pcie_port_bus_register();
	if (retval) {
		printk(KERN_WARNING "PCIE: bus_register error: %d\n", retval);
		goto out;
	}
	retval = pci_register_driver(&pcie_portdriver);
	if (retval)
		pcie_port_bus_unregister();
 out:
	return retval;
}

module_init(pcie_portdrv_init);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* File: portdrv_pci.c
	3	* Purpose: PCI Express Port Bus Driver
	4	*
	5	* Copyright (C) 2004 Intel
	6	* Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
	7	*/
	8
	9	#include <linux/module.h>
	10	#include <linux/pci.h>
	11	#include <linux/kernel.h>
	12	#include <linux/errno.h>
	13	#include <linux/pm.h>
	14	#include <linux/init.h>
	15	#include <linux/pcieport_if.h>
4bf3392e	16	#include <linux/aer.h>
c39fae14	17	#include <linux/dmi.h>
28eb5f27	18	#include <linux/pci-aspm.h>
1da177e4 LT	19
1da177e4 LT	20	#include "portdrv.h"
4bf3392e	21	#include "aer/aerdrv.h"
1da177e4 LT	22
	23	/*
	24	* Version Information
	25	*/
	26	#define DRIVER_VERSION "v1.0"
	27	#define DRIVER_AUTHOR "tom.l.nguyen@intel.com"
7e8af37a	28	#define DRIVER_DESC "PCIe Port Bus Driver"
1da177e4 LT	29	MODULE_AUTHOR(DRIVER_AUTHOR);
	30	MODULE_DESCRIPTION(DRIVER_DESC);
	31	MODULE_LICENSE("GPL");
	32
79dd9182 RW	33	/* If this switch is set, PCIe port native services should not be enabled. */
	34	bool pcie_ports_disabled;
	35
28eb5f27 RW	36	/*
	37	* If this switch is set, ACPI _OSC will be used to determine whether or not to
	38	* enable PCIe port native services.
	39	*/
	40	bool pcie_ports_auto = true;
	41
79dd9182 RW	42	static int __init pcie_port_setup(char *str)
79dd9182 RW	43	{
28eb5f27	44	if (!strncmp(str, "compat", 6)) {
79dd9182	45	pcie_ports_disabled = true;
28eb5f27 RW	46	} else if (!strncmp(str, "native", 6)) {
	47	pcie_ports_disabled = false;
	48	pcie_ports_auto = false;
	49	} else if (!strncmp(str, "auto", 4)) {
	50	pcie_ports_disabled = false;
	51	pcie_ports_auto = true;
	52	}
79dd9182 RW	53
	54	return 1;
	55	}
	56	__setup("pcie_ports=", pcie_port_setup);
	57
1da177e4	58	/* global data */
1da177e4	59
4bf3392e ZY	60	static int pcie_portdrv_restore_config(struct pci_dev *dev)
	61	{
	62	int retval;
	63
4bf3392e ZY	64	retval = pci_enable_device(dev);
	65	if (retval)
	66	return retval;
	67	pci_set_master(dev);
	68	return 0;
	69	}
	70
0bed208e	71	#ifdef CONFIG_PM
47145210	72	static const struct dev_pm_ops pcie_portdrv_pm_ops = {
3a3c244c RW	73	.suspend = pcie_port_device_suspend,
	74	.resume = pcie_port_device_resume,
	75	.freeze = pcie_port_device_suspend,
	76	.thaw = pcie_port_device_resume,
	77	.poweroff = pcie_port_device_suspend,
	78	.restore = pcie_port_device_resume,
	79	};
4bf3392e	80
3a3c244c	81	#define PCIE_PORTDRV_PM_OPS (&pcie_portdrv_pm_ops)
a79d682f	82
3a3c244c RW	83	#else /* !PM */
	84
	85	#define PCIE_PORTDRV_PM_OPS NULL
	86	#endif /* !PM */
4bf3392e	87
1da177e4 LT	88	/*
	89	* pcie_portdrv_probe - Probe PCI-Express port devices
	90	* @dev: PCI-Express port device being probed
	91	*
40da4186	92	* If detected invokes the pcie_port_device_register() method for
1da177e4 LT	93	* this port device.
	94	*
	95	*/
898294c9 KK	96	static int __devinit pcie_portdrv_probe(struct pci_dev *dev,
898294c9 KK	97	const struct pci_device_id *id)
1da177e4	98	{
898294c9	99	int status;
1da177e4	100
898294c9 KK	101	if (!pci_is_pcie(dev) \|\|
	102	((dev->pcie_type != PCI_EXP_TYPE_ROOT_PORT) &&
	103	(dev->pcie_type != PCI_EXP_TYPE_UPSTREAM) &&
	104	(dev->pcie_type != PCI_EXP_TYPE_DOWNSTREAM)))
	105	return -ENODEV;
1da177e4	106
40da4186	107	if (!dev->irq && dev->pin) {
34a2e15e	108	dev_warn(&dev->dev, "device [%04x:%04x] has invalid IRQ; "
34438ba6	109	"check vendor BIOS\n", dev->vendor, dev->device);
1da177e4	110	}
f118c0c3 RW	111	status = pcie_port_device_register(dev);
	112	if (status)
	113	return status;
1da177e4	114
87d2e2ec	115	pci_save_state(dev);
4bf3392e	116
1da177e4 LT	117	return 0;
	118	}
	119
40da4186	120	static void pcie_portdrv_remove(struct pci_dev *dev)
1da177e4 LT	121	{
1da177e4 LT	122	pcie_port_device_remove(dev);
d8998719	123	pci_disable_device(dev);
1da177e4 LT	124	}
1da177e4 LT	125
4bf3392e	126	static int error_detected_iter(struct device device, void data)
60854838	127	{
4bf3392e ZY	128	struct pcie_device *pcie_device;
	129	struct pcie_port_service_driver *driver;
	130	struct aer_broadcast_data *result_data;
	131	pci_ers_result_t status;
	132
	133	result_data = (struct aer_broadcast_data *) data;
	134
	135	if (device->bus == &pcie_port_bus_type && device->driver) {
	136	driver = to_service_driver(device->driver);
	137	if (!driver \|\|
	138	!driver->err_handler \|\|
	139	!driver->err_handler->error_detected)
	140	return 0;
	141
	142	pcie_device = to_pcie_device(device);
	143
	144	/* Forward error detected message to service drivers */
	145	status = driver->err_handler->error_detected(
	146	pcie_device->port,
	147	result_data->state);
	148	result_data->result =
	149	merge_result(result_data->result, status);
	150	}
	151
	152	return 0;
60854838 HK	153	}
60854838 HK	154
4bf3392e ZY	155	static pci_ers_result_t pcie_portdrv_error_detected(struct pci_dev *dev,
4bf3392e ZY	156	enum pci_channel_state error)
60854838	157	{
40da4186 HS	158	struct aer_broadcast_data data = {error, PCI_ERS_RESULT_CAN_RECOVER};
40da4186 HS	159	int ret;
4bf3392e	160
b19441af	161	/* can not fail */
40da4186	162	ret = device_for_each_child(&dev->dev, &data, error_detected_iter);
4bf3392e	163
40da4186	164	return data.result;
4bf3392e ZY	165	}
	166
	167	static int mmio_enabled_iter(struct device device, void data)
	168	{
	169	struct pcie_device *pcie_device;
	170	struct pcie_port_service_driver *driver;
	171	pci_ers_result_t status, *result;
	172
	173	result = (pci_ers_result_t *) data;
	174
	175	if (device->bus == &pcie_port_bus_type && device->driver) {
	176	driver = to_service_driver(device->driver);
	177	if (driver &&
	178	driver->err_handler &&
	179	driver->err_handler->mmio_enabled) {
	180	pcie_device = to_pcie_device(device);
	181
	182	/* Forward error message to service drivers */
	183	status = driver->err_handler->mmio_enabled(
	184	pcie_device->port);
	185	result = merge_result(result, status);
	186	}
	187	}
60854838	188
60854838 HK	189	return 0;
	190	}
	191
4bf3392e	192	static pci_ers_result_t pcie_portdrv_mmio_enabled(struct pci_dev *dev)
1da177e4	193	{
4bf3392e	194	pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
b19441af	195	int retval;
5823d100	196
b19441af GKH	197	/* get true return value from &status */
b19441af GKH	198	retval = device_for_each_child(&dev->dev, &status, mmio_enabled_iter);
4bf3392e	199	return status;
1da177e4 LT	200	}
1da177e4 LT	201
4bf3392e	202	static int slot_reset_iter(struct device device, void data)
1da177e4	203	{
4bf3392e ZY	204	struct pcie_device *pcie_device;
	205	struct pcie_port_service_driver *driver;
	206	pci_ers_result_t status, *result;
	207
	208	result = (pci_ers_result_t *) data;
	209
	210	if (device->bus == &pcie_port_bus_type && device->driver) {
	211	driver = to_service_driver(device->driver);
	212	if (driver &&
	213	driver->err_handler &&
	214	driver->err_handler->slot_reset) {
	215	pcie_device = to_pcie_device(device);
	216
	217	/* Forward error message to service drivers */
	218	status = driver->err_handler->slot_reset(
	219	pcie_device->port);
	220	result = merge_result(result, status);
	221	}
	222	}
	223
	224	return 0;
	225	}
	226
	227	static pci_ers_result_t pcie_portdrv_slot_reset(struct pci_dev *dev)
	228	{
029091df	229	pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
b19441af	230	int retval;
4bf3392e ZY	231
	232	/* If fatal, restore cfg space for possible link reset at upstream */
	233	if (dev->error_state == pci_channel_io_frozen) {
e9d82888	234	dev->state_saved = true;
a79d682f	235	pci_restore_state(dev);
4bf3392e ZY	236	pcie_portdrv_restore_config(dev);
	237	pci_enable_pcie_error_reporting(dev);
	238	}
	239
b19441af GKH	240	/* get true return value from &status */
b19441af GKH	241	retval = device_for_each_child(&dev->dev, &status, slot_reset_iter);
4bf3392e ZY	242
	243	return status;
	244	}
	245
	246	static int resume_iter(struct device device, void data)
	247	{
	248	struct pcie_device *pcie_device;
	249	struct pcie_port_service_driver *driver;
	250
	251	if (device->bus == &pcie_port_bus_type && device->driver) {
	252	driver = to_service_driver(device->driver);
	253	if (driver &&
	254	driver->err_handler &&
	255	driver->err_handler->resume) {
	256	pcie_device = to_pcie_device(device);
	257
	258	/* Forward error message to service drivers */
	259	driver->err_handler->resume(pcie_device->port);
	260	}
	261	}
	262
	263	return 0;
	264	}
	265
	266	static void pcie_portdrv_err_resume(struct pci_dev *dev)
	267	{
b19441af GKH	268	int retval;
	269	/* nothing to do with error value, if it ever happens */
	270	retval = device_for_each_child(&dev->dev, NULL, resume_iter);
1da177e4	271	}
1da177e4 LT	272
	273	/*
	274	* LINUX Device Driver Model
	275	*/
	276	static const struct pci_device_id port_pci_ids[] = { {
	277	/* handle any PCI-Express port */
	278	PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) \| 0x00), ~0),
	279	}, { /* end: all zeroes */ }
	280	};
	281	MODULE_DEVICE_TABLE(pci, port_pci_ids);
	282
4bf3392e ZY	283	static struct pci_error_handlers pcie_portdrv_err_handler = {
	284	.error_detected = pcie_portdrv_error_detected,
	285	.mmio_enabled = pcie_portdrv_mmio_enabled,
	286	.slot_reset = pcie_portdrv_slot_reset,
	287	.resume = pcie_portdrv_err_resume,
	288	};
	289
3603a6a3	290	static struct pci_driver pcie_portdriver = {
e3fb20f9	291	.name = "pcieport",
1da177e4 LT	292	.id_table = &port_pci_ids[0],
	293
	294	.probe = pcie_portdrv_probe,
	295	.remove = pcie_portdrv_remove,
	296
4bf3392e	297	.err_handler = &pcie_portdrv_err_handler,
3a3c244c RW	298
3a3c244c RW	299	.driver.pm = PCIE_PORTDRV_PM_OPS,
1da177e4 LT	300	};
1da177e4 LT	301
c39fae14 RW	302	static int __init dmi_pcie_pme_disable_msi(const struct dmi_system_id *d)
	303	{
	304	pr_notice("%s detected: will not use MSI for PCIe PME signaling\n",
	305	d->ident);
	306	pcie_pme_disable_msi();
	307	return 0;
	308	}
	309
	310	static struct dmi_system_id __initdata pcie_portdrv_dmi_table[] = {
	311	/*
	312	* Boxes that should not use MSI for PCIe PME signaling.
	313	*/
	314	{
	315	.callback = dmi_pcie_pme_disable_msi,
	316	.ident = "MSI Wind U-100",
	317	.matches = {
	318	DMI_MATCH(DMI_SYS_VENDOR,
	319	"MICRO-STAR INTERNATIONAL CO., LTD"),
	320	DMI_MATCH(DMI_PRODUCT_NAME, "U-100"),
	321	},
	322	},
	323	{}
	324	};
	325
1da177e4 LT	326	static int __init pcie_portdrv_init(void)
1da177e4 LT	327	{
20d51660	328	int retval;
1da177e4	329
28eb5f27 RW	330	if (pcie_ports_disabled) {
28eb5f27 RW	331	pcie_no_aspm();
79dd9182	332	return -EACCES;
28eb5f27	333	}
79dd9182	334
c39fae14 RW	335	dmi_check_system(pcie_portdrv_dmi_table);
c39fae14 RW	336
20d51660 RD	337	retval = pcie_port_bus_register();
	338	if (retval) {
	339	printk(KERN_WARNING "PCIE: bus_register error: %d\n", retval);
	340	goto out;
	341	}
3603a6a3	342	retval = pci_register_driver(&pcie_portdriver);
1da177e4 LT	343	if (retval)
1da177e4 LT	344	pcie_port_bus_unregister();
20d51660	345	out:
1da177e4 LT	346	return retval;
	347	}
	348
1da177e4	349	module_init(pcie_portdrv_init);