[net-next-2.6.git] / drivers / pci / hotplug / pci_hotplug_core.c

/*
 * PCI HotPlug Controller Core
 *
 * Copyright (C) 2001-2002 Greg Kroah-Hartman (greg@kroah.com)
 * Copyright (C) 2001-2002 IBM Corp.
 *
 * 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/list.h>
#include <linux/kobject.h>
#include <linux/sysfs.h>
#include <linux/pagemap.h>
#include <linux/init.h>
#include <linux/mount.h>
#include <linux/namei.h>
#include <linux/mutex.h>
#include <linux/pci.h>
#include <linux/pci_hotplug.h>
#include <asm/uaccess.h>
#include "../pci.h"

#define MY_NAME	"pci_hotplug"

#define dbg(fmt, arg...) do { if (debug) 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)


/* local variables */
static int debug;

#define DRIVER_VERSION	"0.5"
#define DRIVER_AUTHOR	"Greg Kroah-Hartman <greg@kroah.com>, Scott Murray <scottm@somanetworks.com>"
#define DRIVER_DESC	"PCI Hot Plug PCI Core"


//////////////////////////////////////////////////////////////////

static LIST_HEAD(pci_hotplug_slot_list);
static DEFINE_MUTEX(pci_hp_mutex);

#ifdef CONFIG_HOTPLUG_PCI_CPCI
extern int cpci_hotplug_init(int debug);
extern void cpci_hotplug_exit(void);
#else
static inline int cpci_hotplug_init(int debug) { return 0; }
static inline void cpci_hotplug_exit(void) { }
#endif

/* Weee, fun with macros... */
#define GET_STATUS(name,type)	\
static int get_##name (struct hotplug_slot *slot, type *value)		\
{									\
	struct hotplug_slot_ops *ops = slot->ops;			\
	int retval = 0;							\
	if (!try_module_get(ops->owner))				\
		return -ENODEV;						\
	if (ops->get_##name)						\
		retval = ops->get_##name(slot, value);			\
	else								\
		*value = slot->info->name;				\
	module_put(ops->owner);						\
	return retval;							\
}

GET_STATUS(power_status, u8)
GET_STATUS(attention_status, u8)
GET_STATUS(latch_status, u8)
GET_STATUS(adapter_status, u8)

static ssize_t power_read_file(struct pci_slot *slot, char *buf)
{
	int retval;
	u8 value;

	retval = get_power_status(slot->hotplug, &value);
	if (retval)
		goto exit;
	retval = sprintf (buf, "%d\n", value);
exit:
	return retval;
}

static ssize_t power_write_file(struct pci_slot *pci_slot, const char *buf,
		size_t count)
{
	struct hotplug_slot *slot = pci_slot->hotplug;
	unsigned long lpower;
	u8 power;
	int retval = 0;

	lpower = simple_strtoul (buf, NULL, 10);
	power = (u8)(lpower & 0xff);
	dbg ("power = %d\n", power);

	if (!try_module_get(slot->ops->owner)) {
		retval = -ENODEV;
		goto exit;
	}
	switch (power) {
		case 0:
			if (slot->ops->disable_slot)
				retval = slot->ops->disable_slot(slot);
			break;

		case 1:
			if (slot->ops->enable_slot)
				retval = slot->ops->enable_slot(slot);
			break;

		default:
			err ("Illegal value specified for power\n");
			retval = -EINVAL;
	}
	module_put(slot->ops->owner);

exit:	
	if (retval)
		return retval;
	return count;
}

static struct pci_slot_attribute hotplug_slot_attr_power = {
	.attr = {.name = "power", .mode = S_IFREG | S_IRUGO | S_IWUSR},
	.show = power_read_file,
	.store = power_write_file
};

static ssize_t attention_read_file(struct pci_slot *slot, char *buf)
{
	int retval;
	u8 value;

	retval = get_attention_status(slot->hotplug, &value);
	if (retval)
		goto exit;
	retval = sprintf(buf, "%d\n", value);

exit:
	return retval;
}

static ssize_t attention_write_file(struct pci_slot *slot, const char *buf,
		size_t count)
{
	struct hotplug_slot_ops *ops = slot->hotplug->ops;
	unsigned long lattention;
	u8 attention;
	int retval = 0;

	lattention = simple_strtoul (buf, NULL, 10);
	attention = (u8)(lattention & 0xff);
	dbg (" - attention = %d\n", attention);

	if (!try_module_get(ops->owner)) {
		retval = -ENODEV;
		goto exit;
	}
	if (ops->set_attention_status)
		retval = ops->set_attention_status(slot->hotplug, attention);
	module_put(ops->owner);

exit:	
	if (retval)
		return retval;
	return count;
}

static struct pci_slot_attribute hotplug_slot_attr_attention = {
	.attr = {.name = "attention", .mode = S_IFREG | S_IRUGO | S_IWUSR},
	.show = attention_read_file,
	.store = attention_write_file
};

static ssize_t latch_read_file(struct pci_slot *slot, char *buf)
{
	int retval;
	u8 value;

	retval = get_latch_status(slot->hotplug, &value);
	if (retval)
		goto exit;
	retval = sprintf (buf, "%d\n", value);

exit:
	return retval;
}

static struct pci_slot_attribute hotplug_slot_attr_latch = {
	.attr = {.name = "latch", .mode = S_IFREG | S_IRUGO},
	.show = latch_read_file,
};

static ssize_t presence_read_file(struct pci_slot *slot, char *buf)
{
	int retval;
	u8 value;

	retval = get_adapter_status(slot->hotplug, &value);
	if (retval)
		goto exit;
	retval = sprintf (buf, "%d\n", value);

exit:
	return retval;
}

static struct pci_slot_attribute hotplug_slot_attr_presence = {
	.attr = {.name = "adapter", .mode = S_IFREG | S_IRUGO},
	.show = presence_read_file,
};

static ssize_t test_write_file(struct pci_slot *pci_slot, const char *buf,
		size_t count)
{
	struct hotplug_slot *slot = pci_slot->hotplug;
	unsigned long ltest;
	u32 test;
	int retval = 0;

	ltest = simple_strtoul (buf, NULL, 10);
	test = (u32)(ltest & 0xffffffff);
	dbg ("test = %d\n", test);

	if (!try_module_get(slot->ops->owner)) {
		retval = -ENODEV;
		goto exit;
	}
	if (slot->ops->hardware_test)
		retval = slot->ops->hardware_test(slot, test);
	module_put(slot->ops->owner);

exit:	
	if (retval)
		return retval;
	return count;
}

static struct pci_slot_attribute hotplug_slot_attr_test = {
	.attr = {.name = "test", .mode = S_IFREG | S_IRUGO | S_IWUSR},
	.store = test_write_file
};

static bool has_power_file(struct pci_slot *pci_slot)
{
	struct hotplug_slot *slot = pci_slot->hotplug;
	if ((!slot) || (!slot->ops))
		return false;
	if ((slot->ops->enable_slot) ||
	    (slot->ops->disable_slot) ||
	    (slot->ops->get_power_status))
		return true;
	return false;
}

static bool has_attention_file(struct pci_slot *pci_slot)
{
	struct hotplug_slot *slot = pci_slot->hotplug;
	if ((!slot) || (!slot->ops))
		return false;
	if ((slot->ops->set_attention_status) ||
	    (slot->ops->get_attention_status))
		return true;
	return false;
}

static bool has_latch_file(struct pci_slot *pci_slot)
{
	struct hotplug_slot *slot = pci_slot->hotplug;
	if ((!slot) || (!slot->ops))
		return false;
	if (slot->ops->get_latch_status)
		return true;
	return false;
}

static bool has_adapter_file(struct pci_slot *pci_slot)
{
	struct hotplug_slot *slot = pci_slot->hotplug;
	if ((!slot) || (!slot->ops))
		return false;
	if (slot->ops->get_adapter_status)
		return true;
	return false;
}

static bool has_test_file(struct pci_slot *pci_slot)
{
	struct hotplug_slot *slot = pci_slot->hotplug;
	if ((!slot) || (!slot->ops))
		return false;
	if (slot->ops->hardware_test)
		return true;
	return false;
}

static int fs_add_slot(struct pci_slot *slot)
{
	int retval = 0;

	/* Create symbolic link to the hotplug driver module */
	pci_hp_create_module_link(slot);

	if (has_power_file(slot)) {
		retval = sysfs_create_file(&slot->kobj,
					   &hotplug_slot_attr_power.attr);
		if (retval)
			goto exit_power;
	}

	if (has_attention_file(slot)) {
		retval = sysfs_create_file(&slot->kobj,
					   &hotplug_slot_attr_attention.attr);
		if (retval)
			goto exit_attention;
	}

	if (has_latch_file(slot)) {
		retval = sysfs_create_file(&slot->kobj,
					   &hotplug_slot_attr_latch.attr);
		if (retval)
			goto exit_latch;
	}

	if (has_adapter_file(slot)) {
		retval = sysfs_create_file(&slot->kobj,
					   &hotplug_slot_attr_presence.attr);
		if (retval)
			goto exit_adapter;
	}

	if (has_test_file(slot)) {
		retval = sysfs_create_file(&slot->kobj,
					   &hotplug_slot_attr_test.attr);
		if (retval)
			goto exit_test;
	}

	goto exit;

exit_test:
	if (has_adapter_file(slot))
		sysfs_remove_file(&slot->kobj,
				  &hotplug_slot_attr_presence.attr);
exit_adapter:
	if (has_latch_file(slot))
		sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_latch.attr);
exit_latch:
	if (has_attention_file(slot))
		sysfs_remove_file(&slot->kobj,
				  &hotplug_slot_attr_attention.attr);
exit_attention:
	if (has_power_file(slot))
		sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_power.attr);
exit_power:
	pci_hp_remove_module_link(slot);
exit:
	return retval;
}

static void fs_remove_slot(struct pci_slot *slot)
{
	if (has_power_file(slot))
		sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_power.attr);

	if (has_attention_file(slot))
		sysfs_remove_file(&slot->kobj,
				  &hotplug_slot_attr_attention.attr);

	if (has_latch_file(slot))
		sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_latch.attr);

	if (has_adapter_file(slot))
		sysfs_remove_file(&slot->kobj,
				  &hotplug_slot_attr_presence.attr);

	if (has_test_file(slot))
		sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_test.attr);

	pci_hp_remove_module_link(slot);
}

static struct hotplug_slot *get_slot_from_name (const char *name)
{
	struct hotplug_slot *slot;
	struct list_head *tmp;

	list_for_each (tmp, &pci_hotplug_slot_list) {
		slot = list_entry (tmp, struct hotplug_slot, slot_list);
		if (strcmp(hotplug_slot_name(slot), name) == 0)
			return slot;
	}
	return NULL;
}

/**
 * __pci_hp_register - register a hotplug_slot with the PCI hotplug subsystem
 * @bus: bus this slot is on
 * @slot: pointer to the &struct hotplug_slot to register
 * @devnr: device number
 * @name: name registered with kobject core
 * @owner: caller module owner
 * @mod_name: caller module name
 *
 * Registers a hotplug slot with the pci hotplug subsystem, which will allow
 * userspace interaction to the slot.
 *
 * Returns 0 if successful, anything else for an error.
 */
int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *bus,
		      int devnr, const char *name,
		      struct module *owner, const char *mod_name)
{
	int result;
	struct pci_slot *pci_slot;

	if (slot == NULL)
		return -ENODEV;
	if ((slot->info == NULL) || (slot->ops == NULL))
		return -EINVAL;
	if (slot->release == NULL) {
		dbg("Why are you trying to register a hotplug slot "
		    "without a proper release function?\n");
		return -EINVAL;
	}

	slot->ops->owner = owner;
	slot->ops->mod_name = mod_name;

	mutex_lock(&pci_hp_mutex);
	/*
	 * No problems if we call this interface from both ACPI_PCI_SLOT
	 * driver and call it here again. If we've already created the
	 * pci_slot, the interface will simply bump the refcount.
	 */
	pci_slot = pci_create_slot(bus, devnr, name, slot);
	if (IS_ERR(pci_slot)) {
		result = PTR_ERR(pci_slot);
		goto out;
	}

	slot->pci_slot = pci_slot;
	pci_slot->hotplug = slot;

	list_add(&slot->slot_list, &pci_hotplug_slot_list);

	result = fs_add_slot(pci_slot);
	kobject_uevent(&pci_slot->kobj, KOBJ_ADD);
	dbg("Added slot %s to the list\n", name);
out:
	mutex_unlock(&pci_hp_mutex);
	return result;
}

/**
 * pci_hp_deregister - deregister a hotplug_slot with the PCI hotplug subsystem
 * @hotplug: pointer to the &struct hotplug_slot to deregister
 *
 * The @slot must have been registered with the pci hotplug subsystem
 * previously with a call to pci_hp_register().
 *
 * Returns 0 if successful, anything else for an error.
 */
int pci_hp_deregister(struct hotplug_slot *hotplug)
{
	struct hotplug_slot *temp;
	struct pci_slot *slot;

	if (!hotplug)
		return -ENODEV;

	mutex_lock(&pci_hp_mutex);
	temp = get_slot_from_name(hotplug_slot_name(hotplug));
	if (temp != hotplug) {
		mutex_unlock(&pci_hp_mutex);
		return -ENODEV;
	}

	list_del(&hotplug->slot_list);

	slot = hotplug->pci_slot;
	fs_remove_slot(slot);
	dbg("Removed slot %s from the list\n", hotplug_slot_name(hotplug));

	hotplug->release(hotplug);
	slot->hotplug = NULL;
	pci_destroy_slot(slot);
	mutex_unlock(&pci_hp_mutex);

	return 0;
}

/**
 * pci_hp_change_slot_info - changes the slot's information structure in the core
 * @hotplug: pointer to the slot whose info has changed
 * @info: pointer to the info copy into the slot's info structure
 *
 * @slot must have been registered with the pci 
 * hotplug subsystem previously with a call to pci_hp_register().
 *
 * Returns 0 if successful, anything else for an error.
 */
int __must_check pci_hp_change_slot_info(struct hotplug_slot *hotplug,
					 struct hotplug_slot_info *info)
{
	struct pci_slot *slot;
	if (!hotplug || !info)
		return -ENODEV;
	slot = hotplug->pci_slot;

	memcpy(hotplug->info, info, sizeof(struct hotplug_slot_info));

	return 0;
}

static int __init pci_hotplug_init (void)
{
	int result;

	result = cpci_hotplug_init(debug);
	if (result) {
		err ("cpci_hotplug_init with error %d\n", result);
		goto err_cpci;
	}

	info (DRIVER_DESC " version: " DRIVER_VERSION "\n");

err_cpci:
	return result;
}

static void __exit pci_hotplug_exit (void)
{
	cpci_hotplug_exit();
}

module_init(pci_hotplug_init);
module_exit(pci_hotplug_exit);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");
module_param(debug, bool, 0644);
MODULE_PARM_DESC(debug, "Debugging mode enabled or not");

EXPORT_SYMBOL_GPL(__pci_hp_register);
EXPORT_SYMBOL_GPL(pci_hp_deregister);
EXPORT_SYMBOL_GPL(pci_hp_change_slot_info);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* PCI HotPlug Controller Core
	3	*
	4	* Copyright (C) 2001-2002 Greg Kroah-Hartman (greg@kroah.com)
	5	* Copyright (C) 2001-2002 IBM Corp.
	6	*
	7	* All rights reserved.
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or (at
	12	* your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
	17	* NON INFRINGEMENT. See the GNU General Public License for more
	18	* details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	23	*
fb5f4d7a	24	* Send feedback to <kristen.c.accardi@intel.com>
1da177e4 LT	25	*
	26	*/
	27
1da177e4 LT	28	#include <linux/module.h>
	29	#include <linux/moduleparam.h>
	30	#include <linux/kernel.h>
	31	#include <linux/types.h>
	32	#include <linux/list.h>
7a54f25c GKH	33	#include <linux/kobject.h>
7a54f25c GKH	34	#include <linux/sysfs.h>
1da177e4	35	#include <linux/pagemap.h>
1da177e4 LT	36	#include <linux/init.h>
	37	#include <linux/mount.h>
	38	#include <linux/namei.h>
95cb9093	39	#include <linux/mutex.h>
1da177e4	40	#include <linux/pci.h>
7a54f25c	41	#include <linux/pci_hotplug.h>
1da177e4	42	#include <asm/uaccess.h>
f46753c5	43	#include "../pci.h"
1da177e4 LT	44
	45	#define MY_NAME "pci_hotplug"
	46
66bef8c0	47	#define dbg(fmt, arg...) do { if (debug) printk(KERN_DEBUG "%s: %s: " fmt , MY_NAME , __func__ , ## arg); } while (0)
1da177e4 LT	48	#define err(format, arg...) printk(KERN_ERR "%s: " format , MY_NAME , ## arg)
	49	#define info(format, arg...) printk(KERN_INFO "%s: " format , MY_NAME , ## arg)
	50	#define warn(format, arg...) printk(KERN_WARNING "%s: " format , MY_NAME , ## arg)
	51
	52
	53	/* local variables */
	54	static int debug;
	55
	56	#define DRIVER_VERSION "0.5"
	57	#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Scott Murray <scottm@somanetworks.com>"
	58	#define DRIVER_DESC "PCI Hot Plug PCI Core"
	59
	60
	61	//////////////////////////////////////////////////////////////////
	62
	63	static LIST_HEAD(pci_hotplug_slot_list);
95cb9093	64	static DEFINE_MUTEX(pci_hp_mutex);
1da177e4	65
1da177e4 LT	66	#ifdef CONFIG_HOTPLUG_PCI_CPCI
	67	extern int cpci_hotplug_init(int debug);
	68	extern void cpci_hotplug_exit(void);
	69	#else
	70	static inline int cpci_hotplug_init(int debug) { return 0; }
	71	static inline void cpci_hotplug_exit(void) { }
	72	#endif
	73
	74	/* Weee, fun with macros... */
	75	#define GET_STATUS(name,type) \
	76	static int get_##name (struct hotplug_slot slot, type value) \
	77	{ \
	78	struct hotplug_slot_ops *ops = slot->ops; \
	79	int retval = 0; \
bd1d9855	80	if (!try_module_get(ops->owner)) \
c8761fe8 ZY	81	return -ENODEV; \
	82	if (ops->get_##name) \
	83	retval = ops->get_##name(slot, value); \
	84	else \
	85	*value = slot->info->name; \
	86	module_put(ops->owner); \
1da177e4 LT	87	return retval; \
	88	}
	89
	90	GET_STATUS(power_status, u8)
	91	GET_STATUS(attention_status, u8)
	92	GET_STATUS(latch_status, u8)
	93	GET_STATUS(adapter_status, u8)
1da177e4	94
f46753c5	95	static ssize_t power_read_file(struct pci_slot slot, char buf)
1da177e4 LT	96	{
	97	int retval;
	98	u8 value;
	99
f46753c5	100	retval = get_power_status(slot->hotplug, &value);
1da177e4 LT	101	if (retval)
	102	goto exit;
	103	retval = sprintf (buf, "%d\n", value);
	104	exit:
	105	return retval;
	106	}
	107
f46753c5	108	static ssize_t power_write_file(struct pci_slot pci_slot, const char buf,
1da177e4 LT	109	size_t count)
1da177e4 LT	110	{
f46753c5	111	struct hotplug_slot *slot = pci_slot->hotplug;
1da177e4 LT	112	unsigned long lpower;
	113	u8 power;
	114	int retval = 0;
	115
	116	lpower = simple_strtoul (buf, NULL, 10);
	117	power = (u8)(lpower & 0xff);
	118	dbg ("power = %d\n", power);
	119
	120	if (!try_module_get(slot->ops->owner)) {
	121	retval = -ENODEV;
	122	goto exit;
	123	}
	124	switch (power) {
	125	case 0:
	126	if (slot->ops->disable_slot)
	127	retval = slot->ops->disable_slot(slot);
	128	break;
	129
	130	case 1:
	131	if (slot->ops->enable_slot)
	132	retval = slot->ops->enable_slot(slot);
	133	break;
	134
	135	default:
	136	err ("Illegal value specified for power\n");
	137	retval = -EINVAL;
	138	}
	139	module_put(slot->ops->owner);
	140
	141	exit:
	142	if (retval)
	143	return retval;
	144	return count;
	145	}
	146
f46753c5	147	static struct pci_slot_attribute hotplug_slot_attr_power = {
1da177e4 LT	148	.attr = {.name = "power", .mode = S_IFREG \| S_IRUGO \| S_IWUSR},
	149	.show = power_read_file,
	150	.store = power_write_file
	151	};
	152
f46753c5	153	static ssize_t attention_read_file(struct pci_slot slot, char buf)
1da177e4 LT	154	{
	155	int retval;
	156	u8 value;
	157
f46753c5	158	retval = get_attention_status(slot->hotplug, &value);
1da177e4 LT	159	if (retval)
1da177e4 LT	160	goto exit;
f46753c5	161	retval = sprintf(buf, "%d\n", value);
1da177e4 LT	162
	163	exit:
	164	return retval;
	165	}
	166
f46753c5	167	static ssize_t attention_write_file(struct pci_slot slot, const char buf,
1da177e4 LT	168	size_t count)
1da177e4 LT	169	{
f46753c5	170	struct hotplug_slot_ops *ops = slot->hotplug->ops;
1da177e4 LT	171	unsigned long lattention;
	172	u8 attention;
	173	int retval = 0;
	174
	175	lattention = simple_strtoul (buf, NULL, 10);
	176	attention = (u8)(lattention & 0xff);
	177	dbg (" - attention = %d\n", attention);
	178
f46753c5	179	if (!try_module_get(ops->owner)) {
1da177e4 LT	180	retval = -ENODEV;
	181	goto exit;
	182	}
f46753c5 AC	183	if (ops->set_attention_status)
	184	retval = ops->set_attention_status(slot->hotplug, attention);
	185	module_put(ops->owner);
1da177e4 LT	186
	187	exit:
	188	if (retval)
	189	return retval;
	190	return count;
	191	}
	192
f46753c5	193	static struct pci_slot_attribute hotplug_slot_attr_attention = {
1da177e4 LT	194	.attr = {.name = "attention", .mode = S_IFREG \| S_IRUGO \| S_IWUSR},
	195	.show = attention_read_file,
	196	.store = attention_write_file
	197	};
	198
f46753c5	199	static ssize_t latch_read_file(struct pci_slot slot, char buf)
1da177e4 LT	200	{
	201	int retval;
	202	u8 value;
	203
f46753c5	204	retval = get_latch_status(slot->hotplug, &value);
1da177e4 LT	205	if (retval)
	206	goto exit;
	207	retval = sprintf (buf, "%d\n", value);
	208
	209	exit:
	210	return retval;
	211	}
	212
f46753c5	213	static struct pci_slot_attribute hotplug_slot_attr_latch = {
1da177e4 LT	214	.attr = {.name = "latch", .mode = S_IFREG \| S_IRUGO},
	215	.show = latch_read_file,
	216	};
	217
f46753c5	218	static ssize_t presence_read_file(struct pci_slot slot, char buf)
1da177e4 LT	219	{
	220	int retval;
	221	u8 value;
	222
f46753c5	223	retval = get_adapter_status(slot->hotplug, &value);
1da177e4 LT	224	if (retval)
	225	goto exit;
	226	retval = sprintf (buf, "%d\n", value);
	227
	228	exit:
	229	return retval;
	230	}
	231
f46753c5	232	static struct pci_slot_attribute hotplug_slot_attr_presence = {
1da177e4 LT	233	.attr = {.name = "adapter", .mode = S_IFREG \| S_IRUGO},
	234	.show = presence_read_file,
	235	};
	236
f46753c5	237	static ssize_t test_write_file(struct pci_slot pci_slot, const char buf,
1da177e4 LT	238	size_t count)
1da177e4 LT	239	{
f46753c5	240	struct hotplug_slot *slot = pci_slot->hotplug;
1da177e4 LT	241	unsigned long ltest;
	242	u32 test;
	243	int retval = 0;
	244
	245	ltest = simple_strtoul (buf, NULL, 10);
	246	test = (u32)(ltest & 0xffffffff);
	247	dbg ("test = %d\n", test);
	248
	249	if (!try_module_get(slot->ops->owner)) {
	250	retval = -ENODEV;
	251	goto exit;
	252	}
	253	if (slot->ops->hardware_test)
	254	retval = slot->ops->hardware_test(slot, test);
	255	module_put(slot->ops->owner);
	256
	257	exit:
	258	if (retval)
	259	return retval;
	260	return count;
	261	}
	262
f46753c5	263	static struct pci_slot_attribute hotplug_slot_attr_test = {
1da177e4 LT	264	.attr = {.name = "test", .mode = S_IFREG \| S_IRUGO \| S_IWUSR},
	265	.store = test_write_file
	266	};
	267
498a8faf	268	static bool has_power_file(struct pci_slot *pci_slot)
1da177e4	269	{
f46753c5	270	struct hotplug_slot *slot = pci_slot->hotplug;
1da177e4	271	if ((!slot) \|\| (!slot->ops))
498a8faf	272	return false;
1da177e4 LT	273	if ((slot->ops->enable_slot) \|\|
	274	(slot->ops->disable_slot) \|\|
	275	(slot->ops->get_power_status))
498a8faf KK	276	return true;
498a8faf KK	277	return false;
1da177e4 LT	278	}
1da177e4 LT	279
498a8faf	280	static bool has_attention_file(struct pci_slot *pci_slot)
1da177e4	281	{
f46753c5	282	struct hotplug_slot *slot = pci_slot->hotplug;
1da177e4	283	if ((!slot) \|\| (!slot->ops))
498a8faf	284	return false;
1da177e4 LT	285	if ((slot->ops->set_attention_status) \|\|
1da177e4 LT	286	(slot->ops->get_attention_status))
498a8faf KK	287	return true;
498a8faf KK	288	return false;
1da177e4 LT	289	}
1da177e4 LT	290
498a8faf	291	static bool has_latch_file(struct pci_slot *pci_slot)
1da177e4	292	{
f46753c5	293	struct hotplug_slot *slot = pci_slot->hotplug;
1da177e4	294	if ((!slot) \|\| (!slot->ops))
498a8faf	295	return false;
1da177e4	296	if (slot->ops->get_latch_status)
498a8faf KK	297	return true;
498a8faf KK	298	return false;
1da177e4 LT	299	}
1da177e4 LT	300
498a8faf	301	static bool has_adapter_file(struct pci_slot *pci_slot)
1da177e4	302	{
f46753c5	303	struct hotplug_slot *slot = pci_slot->hotplug;
1da177e4	304	if ((!slot) \|\| (!slot->ops))
498a8faf	305	return false;
1da177e4	306	if (slot->ops->get_adapter_status)
498a8faf KK	307	return true;
498a8faf KK	308	return false;
1da177e4 LT	309	}
1da177e4 LT	310
498a8faf	311	static bool has_test_file(struct pci_slot *pci_slot)
1da177e4	312	{
f46753c5	313	struct hotplug_slot *slot = pci_slot->hotplug;
1da177e4	314	if ((!slot) \|\| (!slot->ops))
498a8faf	315	return false;
1da177e4	316	if (slot->ops->hardware_test)
498a8faf KK	317	return true;
498a8faf KK	318	return false;
1da177e4 LT	319	}
1da177e4 LT	320
f46753c5	321	static int fs_add_slot(struct pci_slot *slot)
1da177e4	322	{
660a0e8f	323	int retval = 0;
1da177e4	324
c825bc94 KK	325	/* Create symbolic link to the hotplug driver module */
	326	pci_hp_create_module_link(slot);
	327
498a8faf KK	328	if (has_power_file(slot)) {
	329	retval = sysfs_create_file(&slot->kobj,
	330	&hotplug_slot_attr_power.attr);
660a0e8f GKH	331	if (retval)
	332	goto exit_power;
	333	}
1da177e4	334
498a8faf	335	if (has_attention_file(slot)) {
660a0e8f GKH	336	retval = sysfs_create_file(&slot->kobj,
	337	&hotplug_slot_attr_attention.attr);
	338	if (retval)
	339	goto exit_attention;
	340	}
1da177e4	341
498a8faf	342	if (has_latch_file(slot)) {
660a0e8f GKH	343	retval = sysfs_create_file(&slot->kobj,
	344	&hotplug_slot_attr_latch.attr);
	345	if (retval)
	346	goto exit_latch;
	347	}
1da177e4	348
498a8faf	349	if (has_adapter_file(slot)) {
660a0e8f GKH	350	retval = sysfs_create_file(&slot->kobj,
	351	&hotplug_slot_attr_presence.attr);
	352	if (retval)
	353	goto exit_adapter;
	354	}
1da177e4	355
498a8faf	356	if (has_test_file(slot)) {
660a0e8f GKH	357	retval = sysfs_create_file(&slot->kobj,
	358	&hotplug_slot_attr_test.attr);
	359	if (retval)
	360	goto exit_test;
	361	}
	362
	363	goto exit;
	364
	365	exit_test:
498a8faf KK	366	if (has_adapter_file(slot))
	367	sysfs_remove_file(&slot->kobj,
	368	&hotplug_slot_attr_presence.attr);
660a0e8f	369	exit_adapter:
498a8faf	370	if (has_latch_file(slot))
660a0e8f	371	sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_latch.attr);
660a0e8f	372	exit_latch:
498a8faf KK	373	if (has_attention_file(slot))
	374	sysfs_remove_file(&slot->kobj,
	375	&hotplug_slot_attr_attention.attr);
660a0e8f	376	exit_attention:
498a8faf	377	if (has_power_file(slot))
660a0e8f GKH	378	sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_power.attr);
660a0e8f GKH	379	exit_power:
c825bc94	380	pci_hp_remove_module_link(slot);
660a0e8f GKH	381	exit:
660a0e8f GKH	382	return retval;
1da177e4 LT	383	}
1da177e4 LT	384
f46753c5	385	static void fs_remove_slot(struct pci_slot *slot)
1da177e4	386	{
498a8faf	387	if (has_power_file(slot))
1da177e4 LT	388	sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_power.attr);
1da177e4 LT	389
498a8faf KK	390	if (has_attention_file(slot))
	391	sysfs_remove_file(&slot->kobj,
	392	&hotplug_slot_attr_attention.attr);
1da177e4	393
498a8faf	394	if (has_latch_file(slot))
1da177e4 LT	395	sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_latch.attr);
1da177e4 LT	396
498a8faf KK	397	if (has_adapter_file(slot))
	398	sysfs_remove_file(&slot->kobj,
	399	&hotplug_slot_attr_presence.attr);
1da177e4	400
498a8faf	401	if (has_test_file(slot))
1da177e4	402	sysfs_remove_file(&slot->kobj, &hotplug_slot_attr_test.attr);
c825bc94 KK	403
c825bc94 KK	404	pci_hp_remove_module_link(slot);
1da177e4 LT	405	}
	406
	407	static struct hotplug_slot get_slot_from_name (const char name)
	408	{
	409	struct hotplug_slot *slot;
	410	struct list_head *tmp;
	411
	412	list_for_each (tmp, &pci_hotplug_slot_list) {
	413	slot = list_entry (tmp, struct hotplug_slot, slot_list);
58319b80	414	if (strcmp(hotplug_slot_name(slot), name) == 0)
95cb9093	415	return slot;
1da177e4	416	}
95cb9093	417	return NULL;
1da177e4 LT	418	}
	419
	420	/**
c825bc94	421	* __pci_hp_register - register a hotplug_slot with the PCI hotplug subsystem
65b943f6	422	* @bus: bus this slot is on
1da177e4	423	* @slot: pointer to the &struct hotplug_slot to register
c825bc94	424	* @devnr: device number
1359f270	425	* @name: name registered with kobject core
503998ca RD	426	* @owner: caller module owner
503998ca RD	427	* @mod_name: caller module name
1da177e4 LT	428	*
	429	* Registers a hotplug slot with the pci hotplug subsystem, which will allow
	430	* userspace interaction to the slot.
	431	*
	432	* Returns 0 if successful, anything else for an error.
	433	*/
c825bc94 KK	434	int __pci_hp_register(struct hotplug_slot slot, struct pci_bus bus,
	435	int devnr, const char *name,
	436	struct module owner, const char mod_name)
1da177e4 LT	437	{
1da177e4 LT	438	int result;
f46753c5	439	struct pci_slot *pci_slot;
1da177e4 LT	440
	441	if (slot == NULL)
	442	return -ENODEV;
	443	if ((slot->info == NULL) \|\| (slot->ops == NULL))
	444	return -EINVAL;
	445	if (slot->release == NULL) {
a6f29a98	446	dbg("Why are you trying to register a hotplug slot "
1da177e4 LT	447	"without a proper release function?\n");
	448	return -EINVAL;
	449	}
	450
c825bc94 KK	451	slot->ops->owner = owner;
c825bc94 KK	452	slot->ops->mod_name = mod_name;
95cb9093	453
c825bc94	454	mutex_lock(&pci_hp_mutex);
8344b568 AC	455	/*
	456	* No problems if we call this interface from both ACPI_PCI_SLOT
	457	* driver and call it here again. If we've already created the
	458	* pci_slot, the interface will simply bump the refcount.
	459	*/
c825bc94	460	pci_slot = pci_create_slot(bus, devnr, name, slot);
95cb9093 KK	461	if (IS_ERR(pci_slot)) {
95cb9093 KK	462	result = PTR_ERR(pci_slot);
5fe6cc60	463	goto out;
1da177e4	464	}
64dbcac3	465
f46753c5 AC	466	slot->pci_slot = pci_slot;
	467	pci_slot->hotplug = slot;
	468
f46753c5	469	list_add(&slot->slot_list, &pci_hotplug_slot_list);
f46753c5 AC	470
	471	result = fs_add_slot(pci_slot);
	472	kobject_uevent(&pci_slot->kobj, KOBJ_ADD);
1359f270	473	dbg("Added slot %s to the list\n", name);
95cb9093 KK	474	out:
95cb9093 KK	475	mutex_unlock(&pci_hp_mutex);
1da177e4 LT	476	return result;
	477	}
	478
	479	/**
	480	* pci_hp_deregister - deregister a hotplug_slot with the PCI hotplug subsystem
65b943f6	481	* @hotplug: pointer to the &struct hotplug_slot to deregister
1da177e4 LT	482	*
	483	* The @slot must have been registered with the pci hotplug subsystem
	484	* previously with a call to pci_hp_register().
	485	*
	486	* Returns 0 if successful, anything else for an error.
	487	*/
f46753c5	488	int pci_hp_deregister(struct hotplug_slot *hotplug)
1da177e4 LT	489	{
1da177e4 LT	490	struct hotplug_slot *temp;
f46753c5	491	struct pci_slot *slot;
1da177e4	492
f46753c5	493	if (!hotplug)
1da177e4 LT	494	return -ENODEV;
1da177e4 LT	495
95cb9093	496	mutex_lock(&pci_hp_mutex);
58319b80	497	temp = get_slot_from_name(hotplug_slot_name(hotplug));
95cb9093 KK	498	if (temp != hotplug) {
95cb9093 KK	499	mutex_unlock(&pci_hp_mutex);
1da177e4	500	return -ENODEV;
95cb9093	501	}
1da177e4	502
f46753c5	503	list_del(&hotplug->slot_list);
f46753c5 AC	504
	505	slot = hotplug->pci_slot;
	506	fs_remove_slot(slot);
58319b80	507	dbg("Removed slot %s from the list\n", hotplug_slot_name(hotplug));
f46753c5 AC	508
	509	hotplug->release(hotplug);
	510	slot->hotplug = NULL;
	511	pci_destroy_slot(slot);
95cb9093	512	mutex_unlock(&pci_hp_mutex);
f46753c5	513
1da177e4 LT	514	return 0;
	515	}
	516
	517	/**
	518	* pci_hp_change_slot_info - changes the slot's information structure in the core
65b943f6	519	* @hotplug: pointer to the slot whose info has changed
1da177e4 LT	520	* @info: pointer to the info copy into the slot's info structure
	521	*
	522	* @slot must have been registered with the pci
	523	* hotplug subsystem previously with a call to pci_hp_register().
	524	*
	525	* Returns 0 if successful, anything else for an error.
	526	*/
f46753c5	527	int __must_check pci_hp_change_slot_info(struct hotplug_slot *hotplug,
660a0e8f	528	struct hotplug_slot_info *info)
1da177e4	529	{
f46753c5 AC	530	struct pci_slot *slot;
f46753c5 AC	531	if (!hotplug \|\| !info)
1da177e4	532	return -ENODEV;
f46753c5	533	slot = hotplug->pci_slot;
1da177e4	534
f46753c5	535	memcpy(hotplug->info, info, sizeof(struct hotplug_slot_info));
1da177e4 LT	536
	537	return 0;
	538	}
	539
	540	static int __init pci_hotplug_init (void)
	541	{
	542	int result;
0fed80f7	543
1da177e4 LT	544	result = cpci_hotplug_init(debug);
	545	if (result) {
	546	err ("cpci_hotplug_init with error %d\n", result);
f46753c5	547	goto err_cpci;
1da177e4 LT	548	}
	549
	550	info (DRIVER_DESC " version: " DRIVER_VERSION "\n");
81ace5cd	551
f46753c5	552	err_cpci:
1da177e4 LT	553	return result;
	554	}
	555
	556	static void __exit pci_hotplug_exit (void)
	557	{
	558	cpci_hotplug_exit();
1da177e4 LT	559	}
	560
	561	module_init(pci_hotplug_init);
	562	module_exit(pci_hotplug_exit);
	563
	564	MODULE_AUTHOR(DRIVER_AUTHOR);
	565	MODULE_DESCRIPTION(DRIVER_DESC);
	566	MODULE_LICENSE("GPL");
	567	module_param(debug, bool, 0644);
	568	MODULE_PARM_DESC(debug, "Debugging mode enabled or not");
	569
c825bc94	570	EXPORT_SYMBOL_GPL(__pci_hp_register);
1da177e4 LT	571	EXPORT_SYMBOL_GPL(pci_hp_deregister);
1da177e4 LT	572	EXPORT_SYMBOL_GPL(pci_hp_change_slot_info);