[net-next-2.6.git] / drivers / edac / edac_module.c

/*
 * edac_module.c
 *
 * (C) 2007 www.softwarebitmaker.com
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2. This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 *
 * Author: Doug Thompson <dougthompson@xmission.com>
 *
 */
#include <linux/edac.h>

#include "edac_core.h"
#include "edac_module.h"

#define EDAC_VERSION "Ver: 2.1.0 " __DATE__

#ifdef CONFIG_EDAC_DEBUG
/* Values of 0 to 4 will generate output */
int edac_debug_level = 2;
EXPORT_SYMBOL_GPL(edac_debug_level);
#endif

/* scope is to module level only */
struct workqueue_struct *edac_workqueue;

/*
 * sysfs object: /sys/devices/system/edac
 *	need to export to other files in this modules
 */
static struct sysdev_class edac_class = {
	.name = "edac",
};
static int edac_class_valid;

/*
 * edac_op_state_to_string()
 */
char *edac_op_state_to_string(int opstate)
{
	if (opstate == OP_RUNNING_POLL)
		return "POLLED";
	else if (opstate == OP_RUNNING_INTERRUPT)
		return "INTERRUPT";
	else if (opstate == OP_RUNNING_POLL_INTR)
		return "POLL-INTR";
	else if (opstate == OP_ALLOC)
		return "ALLOC";
	else if (opstate == OP_OFFLINE)
		return "OFFLINE";

	return "UNKNOWN";
}

/*
 * edac_get_edac_class()
 *
 *	return pointer to the edac class of 'edac'
 */
struct sysdev_class *edac_get_edac_class(void)
{
	struct sysdev_class *classptr = NULL;

	if (edac_class_valid)
		classptr = &edac_class;

	return classptr;
}

/*
 * edac_register_sysfs_edac_name()
 *
 *	register the 'edac' into /sys/devices/system
 *
 * return:
 *	0  success
 *	!0 error
 */
static int edac_register_sysfs_edac_name(void)
{
	int err;

	/* create the /sys/devices/system/edac directory */
	err = sysdev_class_register(&edac_class);

	if (err) {
		debugf1("%s() error=%d\n", __func__, err);
		return err;
	}

	edac_class_valid = 1;
	return 0;
}

/*
 * sysdev_class_unregister()
 *
 *	unregister the 'edac' from /sys/devices/system
 */
static void edac_unregister_sysfs_edac_name(void)
{
	/* only if currently registered, then unregister it */
	if (edac_class_valid)
		sysdev_class_unregister(&edac_class);

	edac_class_valid = 0;
}

/*
 * edac_workqueue_setup
 *	initialize the edac work queue for polling operations
 */
static int edac_workqueue_setup(void)
{
	edac_workqueue = create_singlethread_workqueue("edac-poller");
	if (edac_workqueue == NULL)
		return -ENODEV;
	else
		return 0;
}

/*
 * edac_workqueue_teardown
 *	teardown the edac workqueue
 */
static void edac_workqueue_teardown(void)
{
	if (edac_workqueue) {
		flush_workqueue(edac_workqueue);
		destroy_workqueue(edac_workqueue);
		edac_workqueue = NULL;
	}
}

/*
 * edac_init
 *      module initialization entry point
 */
static int __init edac_init(void)
{
	int err = 0;

	edac_printk(KERN_INFO, EDAC_MC, EDAC_VERSION "\n");

	/*
	 * Harvest and clear any boot/initialization PCI parity errors
	 *
	 * FIXME: This only clears errors logged by devices present at time of
	 *      module initialization.  We should also do an initial clear
	 *      of each newly hotplugged device.
	 */
	edac_pci_clear_parity_errors();

	/*
	 * perform the registration of the /sys/devices/system/edac class object
	 */
	if (edac_register_sysfs_edac_name()) {
		edac_printk(KERN_ERR, EDAC_MC,
			"Error initializing 'edac' kobject\n");
		err = -ENODEV;
		goto error;
	}

	/*
	 * now set up the mc_kset under the edac class object
	 */
	err = edac_sysfs_setup_mc_kset();
	if (err)
		goto sysfs_setup_fail;

	/* Setup/Initialize the workq for this core */
	err = edac_workqueue_setup();
	if (err) {
		edac_printk(KERN_ERR, EDAC_MC, "init WorkQueue failure\n");
		goto workq_fail;
	}

	return 0;

	/* Error teardown stack */
workq_fail:
	edac_sysfs_teardown_mc_kset();

sysfs_setup_fail:
	edac_unregister_sysfs_edac_name();

error:
	return err;
}

/*
 * edac_exit()
 *      module exit/termination function
 */
static void __exit edac_exit(void)
{
	debugf0("%s()\n", __func__);

	/* tear down the various subsystems */
	edac_workqueue_teardown();
	edac_sysfs_teardown_mc_kset();
	edac_unregister_sysfs_edac_name();
}

/*
 * Inform the kernel of our entry and exit points
 */
module_init(edac_init);
module_exit(edac_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Doug Thompson www.softwarebitmaker.com, et al");
MODULE_DESCRIPTION("Core library routines for EDAC reporting");

/* refer to *_sysfs.c files for parameters that are exported via sysfs */

#ifdef CONFIG_EDAC_DEBUG
module_param(edac_debug_level, int, 0644);
MODULE_PARM_DESC(edac_debug_level, "Debug level");
#endif
Commit	Line	Data
81d87cb1 DJ	1	/*
	2	* edac_module.c
	3	*
fb3fb206 DT	4	* (C) 2007 www.softwarebitmaker.com
fb3fb206 DT	5	*
81d87cb1 DJ	6	* This file is licensed under the terms of the GNU General Public
	7	* License version 2. This program is licensed "as is" without any
	8	* warranty of any kind, whether express or implied.
	9	*
fb3fb206	10	* Author: Doug Thompson <dougthompson@xmission.com>
81d87cb1 DJ	11	*
81d87cb1 DJ	12	*/
c0d12172	13	#include <linux/edac.h>
7c9281d7	14
20bcb7a8	15	#include "edac_core.h"
7c9281d7 DT	16	#include "edac_module.h"
7c9281d7 DT	17
fb3fb206	18	#define EDAC_VERSION "Ver: 2.1.0 " __DATE__
7c9281d7 DT	19
	20	#ifdef CONFIG_EDAC_DEBUG
	21	/* Values of 0 to 4 will generate output */
8096cfaf	22	int edac_debug_level = 2;
7c9281d7 DT	23	EXPORT_SYMBOL_GPL(edac_debug_level);
	24	#endif
	25
e27e3dac DT	26	/* scope is to module level only */
	27	struct workqueue_struct *edac_workqueue;
	28
e27e3dac DT	29	/*
	30	* sysfs object: /sys/devices/system/edac
	31	* need to export to other files in this modules
	32	*/
	33	static struct sysdev_class edac_class = {
af5ca3f4	34	.name = "edac",
e27e3dac	35	};
f044091c	36	static int edac_class_valid;
e27e3dac	37
91b99041	38	/*
494d0d55	39	* edac_op_state_to_string()
91b99041	40	*/
494d0d55	41	char *edac_op_state_to_string(int opstate)
91b99041 DJ	42	{
	43	if (opstate == OP_RUNNING_POLL)
	44	return "POLLED";
	45	else if (opstate == OP_RUNNING_INTERRUPT)
	46	return "INTERRUPT";
	47	else if (opstate == OP_RUNNING_POLL_INTR)
	48	return "POLL-INTR";
	49	else if (opstate == OP_ALLOC)
	50	return "ALLOC";
	51	else if (opstate == OP_OFFLINE)
	52	return "OFFLINE";
	53
	54	return "UNKNOWN";
	55	}
	56
e27e3dac DT	57	/*
	58	* edac_get_edac_class()
	59	*
	60	* return pointer to the edac class of 'edac'
	61	*/
	62	struct sysdev_class *edac_get_edac_class(void)
	63	{
079708b9	64	struct sysdev_class *classptr = NULL;
e27e3dac DT	65
	66	if (edac_class_valid)
	67	classptr = &edac_class;
	68
	69	return classptr;
	70	}
	71
	72	/*
	73	* edac_register_sysfs_edac_name()
	74	*
	75	* register the 'edac' into /sys/devices/system
	76	*
	77	* return:
	78	* 0 success
	79	* !0 error
	80	*/
	81	static int edac_register_sysfs_edac_name(void)
	82	{
	83	int err;
	84
	85	/* create the /sys/devices/system/edac directory */
	86	err = sysdev_class_register(&edac_class);
	87
	88	if (err) {
	89	debugf1("%s() error=%d\n", __func__, err);
	90	return err;
	91	}
	92
	93	edac_class_valid = 1;
	94	return 0;
	95	}
	96
	97	/*
	98	* sysdev_class_unregister()
	99	*
	100	* unregister the 'edac' from /sys/devices/system
	101	*/
	102	static void edac_unregister_sysfs_edac_name(void)
	103	{
	104	/* only if currently registered, then unregister it */
	105	if (edac_class_valid)
	106	sysdev_class_unregister(&edac_class);
	107
	108	edac_class_valid = 0;
	109	}
	110
e27e3dac DT	111	/*
	112	* edac_workqueue_setup
	113	* initialize the edac work queue for polling operations
	114	*/
	115	static int edac_workqueue_setup(void)
	116	{
	117	edac_workqueue = create_singlethread_workqueue("edac-poller");
	118	if (edac_workqueue == NULL)
	119	return -ENODEV;
	120	else
	121	return 0;
	122	}
	123
	124	/*
	125	* edac_workqueue_teardown
	126	* teardown the edac workqueue
	127	*/
	128	static void edac_workqueue_teardown(void)
	129	{
	130	if (edac_workqueue) {
	131	flush_workqueue(edac_workqueue);
	132	destroy_workqueue(edac_workqueue);
	133	edac_workqueue = NULL;
	134	}
	135	}
	136
7c9281d7 DT	137	/*
	138	* edac_init
	139	* module initialization entry point
	140	*/
	141	static int __init edac_init(void)
	142	{
e27e3dac DT	143	int err = 0;
e27e3dac DT	144
fb3fb206	145	edac_printk(KERN_INFO, EDAC_MC, EDAC_VERSION "\n");
7c9281d7 DT	146
	147	/*
	148	* Harvest and clear any boot/initialization PCI parity errors
	149	*
	150	* FIXME: This only clears errors logged by devices present at time of
079708b9 DT	151	* module initialization. We should also do an initial clear
079708b9 DT	152	* of each newly hotplugged device.
7c9281d7 DT	153	*/
	154	edac_pci_clear_parity_errors();
	155
e27e3dac	156	/*
8096cfaf	157	* perform the registration of the /sys/devices/system/edac class object
e27e3dac DT	158	*/
	159	if (edac_register_sysfs_edac_name()) {
	160	edac_printk(KERN_ERR, EDAC_MC,
052dfb45	161	"Error initializing 'edac' kobject\n");
e27e3dac DT	162	err = -ENODEV;
	163	goto error;
	164	}
	165
8096cfaf DT	166	/*
8096cfaf DT	167	* now set up the mc_kset under the edac class object
e27e3dac	168	*/
8096cfaf DT	169	err = edac_sysfs_setup_mc_kset();
	170	if (err)
	171	goto sysfs_setup_fail;
7c9281d7	172
8096cfaf	173	/* Setup/Initialize the workq for this core */
e27e3dac DT	174	err = edac_workqueue_setup();
	175	if (err) {
	176	edac_printk(KERN_ERR, EDAC_MC, "init WorkQueue failure\n");
8096cfaf	177	goto workq_fail;
7c9281d7 DT	178	}
7c9281d7 DT	179
7c9281d7	180	return 0;
e27e3dac DT	181
e27e3dac DT	182	/* Error teardown stack */
8096cfaf DT	183	workq_fail:
	184	edac_sysfs_teardown_mc_kset();
	185
	186	sysfs_setup_fail:
e27e3dac	187	edac_unregister_sysfs_edac_name();
8096cfaf	188
052dfb45	189	error:
e27e3dac	190	return err;
7c9281d7 DT	191	}
	192
	193	/*
	194	* edac_exit()
	195	* module exit/termination function
	196	*/
	197	static void __exit edac_exit(void)
	198	{
	199	debugf0("%s()\n", __func__);
7c9281d7	200
079708b9	201	/* tear down the various subsystems */
e27e3dac	202	edac_workqueue_teardown();
8096cfaf	203	edac_sysfs_teardown_mc_kset();
e27e3dac	204	edac_unregister_sysfs_edac_name();
7c9281d7 DT	205	}
	206
	207	/*
	208	* Inform the kernel of our entry and exit points
	209	*/
	210	module_init(edac_init);
	211	module_exit(edac_exit);
	212
	213	MODULE_LICENSE("GPL");
	214	MODULE_AUTHOR("Doug Thompson www.softwarebitmaker.com, et al");
	215	MODULE_DESCRIPTION("Core library routines for EDAC reporting");
	216
	217	/* refer to _sysfs.c files for parameters that are exported via sysfs /
	218
	219	#ifdef CONFIG_EDAC_DEBUG
	220	module_param(edac_debug_level, int, 0644);
	221	MODULE_PARM_DESC(edac_debug_level, "Debug level");
	222	#endif