[mirror_ubuntu-bionic-kernel.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: 3.0.0"

#ifdef CONFIG_EDAC_DEBUG

static int edac_set_debug_level(const char *buf, struct kernel_param *kp)
{
	unsigned long val;
	int ret;

	ret = kstrtoul(buf, 0, &val);
	if (ret)
		return ret;

	if (val > 4)
		return -EINVAL;

	return param_set_int(buf, kp);
}

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

module_param_call(edac_debug_level, edac_set_debug_level, param_get_int,
		  &edac_debug_level, 0644);
MODULE_PARM_DESC(edac_debug_level, "EDAC debug level: [0-4], default: 2");
#endif

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

/*
 * 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_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;
	}
}

/*
 * sysfs object: /sys/devices/system/edac
 *	need to export to other files
 */
struct bus_type edac_subsys = {
	.name = "edac",
	.dev_name = "edac",
};
EXPORT_SYMBOL_GPL(edac_subsys);

static int edac_subsys_init(void)
{
	int err;

	/* create the /sys/devices/system/edac directory */
	err = subsys_system_register(&edac_subsys, NULL);
	if (err)
		printk(KERN_ERR "Error registering toplevel EDAC sysfs dir\n");

	return err;
}

static void edac_subsys_exit(void)
{
	bus_unregister(&edac_subsys);
}

/* return pointer to the 'edac' node in sysfs */
struct bus_type *edac_get_sysfs_subsys(void)
{
	return &edac_subsys;
}
EXPORT_SYMBOL_GPL(edac_get_sysfs_subsys);
/*
 * edac_init
 *      module initialization entry point
 */
static int __init edac_init(void)
{
	int err = 0;

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

	err = edac_subsys_init();
	if (err)
		return err;

	/*
	 * 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();

	err = edac_mc_sysfs_init();
	if (err)
		goto err_sysfs;

	edac_debugfs_init();

	err = edac_workqueue_setup();
	if (err) {
		edac_printk(KERN_ERR, EDAC_MC, "Failure initializing workqueue\n");
		goto err_wq;
	}

	return 0;

err_wq:
	edac_debugfs_exit();
	edac_mc_sysfs_exit();

err_sysfs:
	edac_subsys_exit();

	return err;
}

/*
 * edac_exit()
 *      module exit/termination function
 */
static void __exit edac_exit(void)
{
	edac_dbg(0, "\n");

	/* tear down the various subsystems */
	edac_workqueue_teardown();
	edac_mc_sysfs_exit();
	edac_debugfs_exit();
	edac_subsys_exit();
}

/*
 * Inform the kernel of our entry and exit points
 */
subsys_initcall(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");
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
5156a5f4	18	#define EDAC_VERSION "Ver: 3.0.0"
7c9281d7 DT	19
7c9281d7 DT	20	#ifdef CONFIG_EDAC_DEBUG
37929874 BP	21
	22	static int edac_set_debug_level(const char buf, struct kernel_param kp)
	23	{
	24	unsigned long val;
	25	int ret;
	26
	27	ret = kstrtoul(buf, 0, &val);
	28	if (ret)
	29	return ret;
	30
6866b390	31	if (val > 4)
37929874 BP	32	return -EINVAL;
	33
	34	return param_set_int(buf, kp);
	35	}
	36
7c9281d7	37	/* Values of 0 to 4 will generate output */
8096cfaf	38	int edac_debug_level = 2;
7c9281d7	39	EXPORT_SYMBOL_GPL(edac_debug_level);
37929874 BP	40
	41	module_param_call(edac_debug_level, edac_set_debug_level, param_get_int,
	42	&edac_debug_level, 0644);
	43	MODULE_PARM_DESC(edac_debug_level, "EDAC debug level: [0-4], default: 2");
7c9281d7 DT	44	#endif
7c9281d7 DT	45
e27e3dac DT	46	/* scope is to module level only */
	47	struct workqueue_struct *edac_workqueue;
	48
91b99041	49	/*
494d0d55	50	* edac_op_state_to_string()
91b99041	51	*/
494d0d55	52	char *edac_op_state_to_string(int opstate)
91b99041 DJ	53	{
	54	if (opstate == OP_RUNNING_POLL)
	55	return "POLLED";
	56	else if (opstate == OP_RUNNING_INTERRUPT)
	57	return "INTERRUPT";
	58	else if (opstate == OP_RUNNING_POLL_INTR)
	59	return "POLL-INTR";
	60	else if (opstate == OP_ALLOC)
	61	return "ALLOC";
	62	else if (opstate == OP_OFFLINE)
	63	return "OFFLINE";
	64
	65	return "UNKNOWN";
	66	}
	67
e27e3dac DT	68	/*
	69	* edac_workqueue_setup
	70	* initialize the edac work queue for polling operations
	71	*/
	72	static int edac_workqueue_setup(void)
	73	{
	74	edac_workqueue = create_singlethread_workqueue("edac-poller");
	75	if (edac_workqueue == NULL)
	76	return -ENODEV;
	77	else
	78	return 0;
	79	}
	80
	81	/*
	82	* edac_workqueue_teardown
	83	* teardown the edac workqueue
	84	*/
	85	static void edac_workqueue_teardown(void)
	86	{
	87	if (edac_workqueue) {
	88	flush_workqueue(edac_workqueue);
	89	destroy_workqueue(edac_workqueue);
	90	edac_workqueue = NULL;
	91	}
	92	}
	93
733476cf BP	94	/*
	95	* sysfs object: /sys/devices/system/edac
	96	* need to export to other files
	97	*/
	98	struct bus_type edac_subsys = {
	99	.name = "edac",
	100	.dev_name = "edac",
	101	};
	102	EXPORT_SYMBOL_GPL(edac_subsys);
	103
	104	static int edac_subsys_init(void)
	105	{
	106	int err;
	107
	108	/* create the /sys/devices/system/edac directory */
	109	err = subsys_system_register(&edac_subsys, NULL);
	110	if (err)
	111	printk(KERN_ERR "Error registering toplevel EDAC sysfs dir\n");
	112
	113	return err;
	114	}
	115
	116	static void edac_subsys_exit(void)
	117	{
	118	bus_unregister(&edac_subsys);
	119	}
	120
	121	/* return pointer to the 'edac' node in sysfs */
	122	struct bus_type *edac_get_sysfs_subsys(void)
	123	{
	124	return &edac_subsys;
	125	}
	126	EXPORT_SYMBOL_GPL(edac_get_sysfs_subsys);
7c9281d7 DT	127	/*
	128	* edac_init
	129	* module initialization entry point
	130	*/
	131	static int __init edac_init(void)
	132	{
e27e3dac DT	133	int err = 0;
e27e3dac DT	134
fb3fb206	135	edac_printk(KERN_INFO, EDAC_MC, EDAC_VERSION "\n");
7c9281d7	136
733476cf BP	137	err = edac_subsys_init();
	138	if (err)
	139	return err;
	140
7c9281d7 DT	141	/*
	142	* Harvest and clear any boot/initialization PCI parity errors
	143	*
	144	* FIXME: This only clears errors logged by devices present at time of
079708b9 DT	145	* module initialization. We should also do an initial clear
079708b9 DT	146	* of each newly hotplugged device.
7c9281d7 DT	147	*/
	148	edac_pci_clear_parity_errors();
	149
7a623c03	150	err = edac_mc_sysfs_init();
8096cfaf	151	if (err)
c6b97bcf	152	goto err_sysfs;
7c9281d7	153
e7930ba4 RH	154	edac_debugfs_init();
e7930ba4 RH	155
e27e3dac DT	156	err = edac_workqueue_setup();
e27e3dac DT	157	if (err) {
c6b97bcf AK	158	edac_printk(KERN_ERR, EDAC_MC, "Failure initializing workqueue\n");
c6b97bcf AK	159	goto err_wq;
7c9281d7 DT	160	}
7c9281d7 DT	161
7c9281d7	162	return 0;
e27e3dac	163
c6b97bcf AK	164	err_wq:
	165	edac_debugfs_exit();
	166	edac_mc_sysfs_exit();
	167
	168	err_sysfs:
733476cf BP	169	edac_subsys_exit();
733476cf BP	170
e27e3dac	171	return err;
7c9281d7 DT	172	}
	173
	174	/*
	175	* edac_exit()
	176	* module exit/termination function
	177	*/
	178	static void __exit edac_exit(void)
	179	{
956b9ba1	180	edac_dbg(0, "\n");
7c9281d7	181
079708b9	182	/* tear down the various subsystems */
e27e3dac	183	edac_workqueue_teardown();
7a623c03	184	edac_mc_sysfs_exit();
e7930ba4	185	edac_debugfs_exit();
733476cf	186	edac_subsys_exit();
7c9281d7 DT	187	}
	188
	189	/*
	190	* Inform the kernel of our entry and exit points
	191	*/
4ab19b06	192	subsys_initcall(edac_init);
7c9281d7 DT	193	module_exit(edac_exit);
	194
	195	MODULE_LICENSE("GPL");
	196	MODULE_AUTHOR("Doug Thompson www.softwarebitmaker.com, et al");
	197	MODULE_DESCRIPTION("Core library routines for EDAC reporting");