[deliverable/linux.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/slab.h>
#include <linux/pcieport_if.h>
#include <linux/aer.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");

/* global data */
static const char device_name[] = "pcieport-driver";

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 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;

	status = pcie_port_device_probe(dev);
	if (status)
		return status;

        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 result_data =
			{error, PCI_ERS_RESULT_CAN_RECOVER};
	int retval;

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

	return result_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_NONE;
	int retval;

	/* If fatal, restore cfg space for possible link reset at upstream */
	if (dev->error_state == pci_channel_io_frozen) {
		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		= (char *)device_name,
	.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 pcie_portdrv_init(void)
{
	int retval;

	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;
}

static void __exit pcie_portdrv_exit(void) 
{
	pci_unregister_driver(&pcie_portdriver);
	pcie_port_bus_unregister();
}

module_init(pcie_portdrv_init);
module_exit(pcie_portdrv_exit);
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>
4e57b681	15	#include <linux/slab.h>
1da177e4	16	#include <linux/pcieport_if.h>
4bf3392e	17	#include <linux/aer.h>
1da177e4 LT	18
1da177e4 LT	19	#include "portdrv.h"
4bf3392e	20	#include "aer/aerdrv.h"
1da177e4 LT	21
	22	/*
	23	* Version Information
	24	*/
	25	#define DRIVER_VERSION "v1.0"
	26	#define DRIVER_AUTHOR "tom.l.nguyen@intel.com"
	27	#define DRIVER_DESC "PCIE Port Bus Driver"
	28	MODULE_AUTHOR(DRIVER_AUTHOR);
	29	MODULE_DESCRIPTION(DRIVER_DESC);
	30	MODULE_LICENSE("GPL");
	31
	32	/* global data */
	33	static const char device_name[] = "pcieport-driver";
	34
4bf3392e ZY	35	static int pcie_portdrv_restore_config(struct pci_dev *dev)
	36	{
	37	int retval;
	38
4bf3392e ZY	39	retval = pci_enable_device(dev);
	40	if (retval)
	41	return retval;
	42	pci_set_master(dev);
	43	return 0;
	44	}
	45
0bed208e	46	#ifdef CONFIG_PM
3a3c244c RW	47	static struct dev_pm_ops pcie_portdrv_pm_ops = {
	48	.suspend = pcie_port_device_suspend,
	49	.resume = pcie_port_device_resume,
	50	.freeze = pcie_port_device_suspend,
	51	.thaw = pcie_port_device_resume,
	52	.poweroff = pcie_port_device_suspend,
	53	.restore = pcie_port_device_resume,
	54	};
4bf3392e	55
3a3c244c	56	#define PCIE_PORTDRV_PM_OPS (&pcie_portdrv_pm_ops)
a79d682f	57
3a3c244c RW	58	#else /* !PM */
	59
	60	#define PCIE_PORTDRV_PM_OPS NULL
	61	#endif /* !PM */
4bf3392e	62
1da177e4 LT	63	/*
	64	* pcie_portdrv_probe - Probe PCI-Express port devices
	65	* @dev: PCI-Express port device being probed
	66	*
	67	* If detected invokes the pcie_port_device_register() method for
	68	* this port device.
	69	*
	70	*/
	71	static int __devinit pcie_portdrv_probe (struct pci_dev *dev,
	72	const struct pci_device_id *id )
	73	{
	74	int status;
	75
	76	status = pcie_port_device_probe(dev);
	77	if (status)
	78	return status;
	79
83e42bcd	80	if (!dev->irq && dev->pin) {
34a2e15e	81	dev_warn(&dev->dev, "device [%04x:%04x] has invalid IRQ; "
34438ba6	82	"check vendor BIOS\n", dev->vendor, dev->device);
1da177e4	83	}
f118c0c3 RW	84	status = pcie_port_device_register(dev);
	85	if (status)
	86	return status;
1da177e4	87
87d2e2ec	88	pci_save_state(dev);
4bf3392e	89
1da177e4 LT	90	return 0;
	91	}
	92
	93	static void pcie_portdrv_remove (struct pci_dev *dev)
	94	{
	95	pcie_port_device_remove(dev);
d8998719	96	pci_disable_device(dev);
1da177e4 LT	97	}
1da177e4 LT	98
4bf3392e	99	static int error_detected_iter(struct device device, void data)
60854838	100	{
4bf3392e ZY	101	struct pcie_device *pcie_device;
	102	struct pcie_port_service_driver *driver;
	103	struct aer_broadcast_data *result_data;
	104	pci_ers_result_t status;
	105
	106	result_data = (struct aer_broadcast_data *) data;
	107
	108	if (device->bus == &pcie_port_bus_type && device->driver) {
	109	driver = to_service_driver(device->driver);
	110	if (!driver \|\|
	111	!driver->err_handler \|\|
	112	!driver->err_handler->error_detected)
	113	return 0;
	114
	115	pcie_device = to_pcie_device(device);
	116
	117	/* Forward error detected message to service drivers */
	118	status = driver->err_handler->error_detected(
	119	pcie_device->port,
	120	result_data->state);
	121	result_data->result =
	122	merge_result(result_data->result, status);
	123	}
	124
	125	return 0;
60854838 HK	126	}
60854838 HK	127
4bf3392e ZY	128	static pci_ers_result_t pcie_portdrv_error_detected(struct pci_dev *dev,
4bf3392e ZY	129	enum pci_channel_state error)
60854838	130	{
4bf3392e ZY	131	struct aer_broadcast_data result_data =
4bf3392e ZY	132	{error, PCI_ERS_RESULT_CAN_RECOVER};
b19441af	133	int retval;
4bf3392e	134
b19441af GKH	135	/* can not fail */
b19441af GKH	136	retval = device_for_each_child(&dev->dev, &result_data, error_detected_iter);
4bf3392e ZY	137
	138	return result_data.result;
	139	}
	140
	141	static int mmio_enabled_iter(struct device device, void data)
	142	{
	143	struct pcie_device *pcie_device;
	144	struct pcie_port_service_driver *driver;
	145	pci_ers_result_t status, *result;
	146
	147	result = (pci_ers_result_t *) data;
	148
	149	if (device->bus == &pcie_port_bus_type && device->driver) {
	150	driver = to_service_driver(device->driver);
	151	if (driver &&
	152	driver->err_handler &&
	153	driver->err_handler->mmio_enabled) {
	154	pcie_device = to_pcie_device(device);
	155
	156	/* Forward error message to service drivers */
	157	status = driver->err_handler->mmio_enabled(
	158	pcie_device->port);
	159	result = merge_result(result, status);
	160	}
	161	}
60854838	162
60854838 HK	163	return 0;
	164	}
	165
4bf3392e	166	static pci_ers_result_t pcie_portdrv_mmio_enabled(struct pci_dev *dev)
1da177e4	167	{
4bf3392e	168	pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
b19441af	169	int retval;
5823d100	170
b19441af GKH	171	/* get true return value from &status */
b19441af GKH	172	retval = device_for_each_child(&dev->dev, &status, mmio_enabled_iter);
4bf3392e	173	return status;
1da177e4 LT	174	}
1da177e4 LT	175
4bf3392e	176	static int slot_reset_iter(struct device device, void data)
1da177e4	177	{
4bf3392e ZY	178	struct pcie_device *pcie_device;
	179	struct pcie_port_service_driver *driver;
	180	pci_ers_result_t status, *result;
	181
	182	result = (pci_ers_result_t *) data;
	183
	184	if (device->bus == &pcie_port_bus_type && device->driver) {
	185	driver = to_service_driver(device->driver);
	186	if (driver &&
	187	driver->err_handler &&
	188	driver->err_handler->slot_reset) {
	189	pcie_device = to_pcie_device(device);
	190
	191	/* Forward error message to service drivers */
	192	status = driver->err_handler->slot_reset(
	193	pcie_device->port);
	194	result = merge_result(result, status);
	195	}
	196	}
	197
	198	return 0;
	199	}
	200
	201	static pci_ers_result_t pcie_portdrv_slot_reset(struct pci_dev *dev)
	202	{
bf164410	203	pci_ers_result_t status = PCI_ERS_RESULT_NONE;
b19441af	204	int retval;
4bf3392e ZY	205
	206	/* If fatal, restore cfg space for possible link reset at upstream */
	207	if (dev->error_state == pci_channel_io_frozen) {
a79d682f	208	pci_restore_state(dev);
4bf3392e ZY	209	pcie_portdrv_restore_config(dev);
	210	pci_enable_pcie_error_reporting(dev);
	211	}
	212
b19441af GKH	213	/* get true return value from &status */
b19441af GKH	214	retval = device_for_each_child(&dev->dev, &status, slot_reset_iter);
4bf3392e ZY	215
	216	return status;
	217	}
	218
	219	static int resume_iter(struct device device, void data)
	220	{
	221	struct pcie_device *pcie_device;
	222	struct pcie_port_service_driver *driver;
	223
	224	if (device->bus == &pcie_port_bus_type && device->driver) {
	225	driver = to_service_driver(device->driver);
	226	if (driver &&
	227	driver->err_handler &&
	228	driver->err_handler->resume) {
	229	pcie_device = to_pcie_device(device);
	230
	231	/* Forward error message to service drivers */
	232	driver->err_handler->resume(pcie_device->port);
	233	}
	234	}
	235
	236	return 0;
	237	}
	238
	239	static void pcie_portdrv_err_resume(struct pci_dev *dev)
	240	{
b19441af GKH	241	int retval;
	242	/* nothing to do with error value, if it ever happens */
	243	retval = device_for_each_child(&dev->dev, NULL, resume_iter);
1da177e4	244	}
1da177e4 LT	245
	246	/*
	247	* LINUX Device Driver Model
	248	*/
	249	static const struct pci_device_id port_pci_ids[] = { {
	250	/* handle any PCI-Express port */
	251	PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) \| 0x00), ~0),
	252	}, { /* end: all zeroes */ }
	253	};
	254	MODULE_DEVICE_TABLE(pci, port_pci_ids);
	255
4bf3392e ZY	256	static struct pci_error_handlers pcie_portdrv_err_handler = {
	257	.error_detected = pcie_portdrv_error_detected,
	258	.mmio_enabled = pcie_portdrv_mmio_enabled,
	259	.slot_reset = pcie_portdrv_slot_reset,
	260	.resume = pcie_portdrv_err_resume,
	261	};
	262
3603a6a3	263	static struct pci_driver pcie_portdriver = {
1da177e4 LT	264	.name = (char *)device_name,
	265	.id_table = &port_pci_ids[0],
	266
	267	.probe = pcie_portdrv_probe,
	268	.remove = pcie_portdrv_remove,
	269
4bf3392e	270	.err_handler = &pcie_portdrv_err_handler,
3a3c244c RW	271
3a3c244c RW	272	.driver.pm = PCIE_PORTDRV_PM_OPS,
1da177e4 LT	273	};
	274
	275	static int __init pcie_portdrv_init(void)
	276	{
20d51660	277	int retval;
1da177e4	278
20d51660 RD	279	retval = pcie_port_bus_register();
	280	if (retval) {
	281	printk(KERN_WARNING "PCIE: bus_register error: %d\n", retval);
	282	goto out;
	283	}
3603a6a3	284	retval = pci_register_driver(&pcie_portdriver);
1da177e4 LT	285	if (retval)
1da177e4 LT	286	pcie_port_bus_unregister();
20d51660	287	out:
1da177e4 LT	288	return retval;
	289	}
	290
	291	static void __exit pcie_portdrv_exit(void)
	292	{
3603a6a3	293	pci_unregister_driver(&pcie_portdriver);
1da177e4 LT	294	pcie_port_bus_unregister();
	295	}
	296
	297	module_init(pcie_portdrv_init);
	298	module_exit(pcie_portdrv_exit);