[mirror_ubuntu-zesty-kernel.git] / include / linux / moduleparam.h

#ifndef _LINUX_MODULE_PARAMS_H
#define _LINUX_MODULE_PARAMS_H
/* (C) Copyright 2001, 2002 Rusty Russell IBM Corporation */
#include <linux/init.h>
#include <linux/stringify.h>
#include <linux/kernel.h>

/* You can override this manually, but generally this should match the
   module name. */
#ifdef MODULE
#define MODULE_PARAM_PREFIX /* empty */
#else
#define MODULE_PARAM_PREFIX KBUILD_MODNAME "."
#endif

/* Chosen so that structs with an unsigned long line up. */
#define MAX_PARAM_PREFIX_LEN (64 - sizeof(unsigned long))

#ifdef MODULE
#define ___module_cat(a,b) __mod_ ## a ## b
#define __module_cat(a,b) ___module_cat(a,b)
#define __MODULE_INFO(tag, name, info)					  \
static const char __module_cat(name,__LINE__)[]				  \
  __used								  \
  __attribute__((section(".modinfo"),unused)) = __stringify(tag) "=" info
#else  /* !MODULE */
#define __MODULE_INFO(tag, name, info)
#endif
#define __MODULE_PARM_TYPE(name, _type)					  \
  __MODULE_INFO(parmtype, name##type, #name ":" _type)

struct kernel_param;

/* Returns 0, or -errno.  arg is in kp->arg. */
typedef int (*param_set_fn)(const char *val, struct kernel_param *kp);
/* Returns length written or -errno.  Buffer is 4k (ie. be short!) */
typedef int (*param_get_fn)(char *buffer, struct kernel_param *kp);

struct kernel_param {
	const char *name;
	unsigned int perm;
	param_set_fn set;
	param_get_fn get;
	union {
		void *arg;
		const struct kparam_string *str;
		const struct kparam_array *arr;
	};
};

/* Special one for strings we want to copy into */
struct kparam_string {
	unsigned int maxlen;
	char *string;
};

/* Special one for arrays */
struct kparam_array
{
	unsigned int max;
	unsigned int *num;
	param_set_fn set;
	param_get_fn get;
	unsigned int elemsize;
	void *elem;
};

/* On alpha, ia64 and ppc64 relocations to global data cannot go into
   read-only sections (which is part of respective UNIX ABI on these
   platforms). So 'const' makes no sense and even causes compile failures
   with some compilers. */
#if defined(CONFIG_ALPHA) || defined(CONFIG_IA64) || defined(CONFIG_PPC64)
#define __moduleparam_const
#else
#define __moduleparam_const const
#endif

/* This is the fundamental function for registering boot/module
   parameters.  perm sets the visibility in sysfs: 000 means it's
   not there, read bits mean it's readable, write bits mean it's
   writable. */
#define __module_param_call(prefix, name, set, get, arg, perm)		\
	/* Default value instead of permissions? */			\
	static int __param_perm_check_##name __attribute__((unused)) =	\
	BUILD_BUG_ON_ZERO((perm) < 0 || (perm) > 0777 || ((perm) & 2))	\
	+ BUILD_BUG_ON_ZERO(sizeof(""prefix) > MAX_PARAM_PREFIX_LEN);	\
	static const char __param_str_##name[] = prefix #name;		\
	static struct kernel_param __moduleparam_const __param_##name	\
	__used								\
    __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) \
	= { __param_str_##name, perm, set, get, { arg } }

#define module_param_call(name, set, get, arg, perm)			      \
	__module_param_call(MODULE_PARAM_PREFIX, name, set, get, arg, perm)

/* Helper functions: type is byte, short, ushort, int, uint, long,
   ulong, charp, bool or invbool, or XXX if you define param_get_XXX,
   param_set_XXX and param_check_XXX. */
#define module_param_named(name, value, type, perm)			   \
	param_check_##type(name, &(value));				   \
	module_param_call(name, param_set_##type, param_get_##type, &value, perm); \
	__MODULE_PARM_TYPE(name, #type)

#define module_param(name, type, perm)				\
	module_param_named(name, name, type, perm)

/* Actually copy string: maxlen param is usually sizeof(string). */
#define module_param_string(name, string, len, perm)			\
	static const struct kparam_string __param_string_##name		\
		= { len, string };					\
	module_param_call(name, param_set_copystring, param_get_string,	\
			  .str = &__param_string_##name, perm);		\
	__MODULE_PARM_TYPE(name, "string")

/* Called on module insert or kernel boot */
extern int parse_args(const char *name,
		      char *args,
		      struct kernel_param *params,
		      unsigned num,
		      int (*unknown)(char *param, char *val));

/* All the helper functions */
/* The macros to do compile-time type checking stolen from Jakub
   Jelinek, who IIRC came up with this idea for the 2.4 module init code. */
#define __param_check(name, p, type) \
	static inline type *__check_##name(void) { return(p); }

extern int param_set_byte(const char *val, struct kernel_param *kp);
extern int param_get_byte(char *buffer, struct kernel_param *kp);
#define param_check_byte(name, p) __param_check(name, p, unsigned char)

extern int param_set_short(const char *val, struct kernel_param *kp);
extern int param_get_short(char *buffer, struct kernel_param *kp);
#define param_check_short(name, p) __param_check(name, p, short)

extern int param_set_ushort(const char *val, struct kernel_param *kp);
extern int param_get_ushort(char *buffer, struct kernel_param *kp);
#define param_check_ushort(name, p) __param_check(name, p, unsigned short)

extern int param_set_int(const char *val, struct kernel_param *kp);
extern int param_get_int(char *buffer, struct kernel_param *kp);
#define param_check_int(name, p) __param_check(name, p, int)

extern int param_set_uint(const char *val, struct kernel_param *kp);
extern int param_get_uint(char *buffer, struct kernel_param *kp);
#define param_check_uint(name, p) __param_check(name, p, unsigned int)

extern int param_set_long(const char *val, struct kernel_param *kp);
extern int param_get_long(char *buffer, struct kernel_param *kp);
#define param_check_long(name, p) __param_check(name, p, long)

extern int param_set_ulong(const char *val, struct kernel_param *kp);
extern int param_get_ulong(char *buffer, struct kernel_param *kp);
#define param_check_ulong(name, p) __param_check(name, p, unsigned long)

extern int param_set_charp(const char *val, struct kernel_param *kp);
extern int param_get_charp(char *buffer, struct kernel_param *kp);
#define param_check_charp(name, p) __param_check(name, p, char *)

extern int param_set_bool(const char *val, struct kernel_param *kp);
extern int param_get_bool(char *buffer, struct kernel_param *kp);
#define param_check_bool(name, p) __param_check(name, p, int)

extern int param_set_invbool(const char *val, struct kernel_param *kp);
extern int param_get_invbool(char *buffer, struct kernel_param *kp);
#define param_check_invbool(name, p) __param_check(name, p, int)

/* Comma-separated array: *nump is set to number they actually specified. */
#define module_param_array_named(name, array, type, nump, perm)		\
	static const struct kparam_array __param_arr_##name		\
	= { ARRAY_SIZE(array), nump, param_set_##type, param_get_##type,\
	    sizeof(array[0]), array };					\
	module_param_call(name, param_array_set, param_array_get, 	\
			  .arr = &__param_arr_##name, perm);		\
	__MODULE_PARM_TYPE(name, "array of " #type)

#define module_param_array(name, type, nump, perm)		\
	module_param_array_named(name, name, type, nump, perm)

extern int param_array_set(const char *val, struct kernel_param *kp);
extern int param_array_get(char *buffer, struct kernel_param *kp);

extern int param_set_copystring(const char *val, struct kernel_param *kp);
extern int param_get_string(char *buffer, struct kernel_param *kp);

/* for exporting parameters in /sys/parameters */

struct module;

#if defined(CONFIG_SYSFS) && defined(CONFIG_MODULES)
extern int module_param_sysfs_setup(struct module *mod,
				    struct kernel_param *kparam,
				    unsigned int num_params);

extern void module_param_sysfs_remove(struct module *mod);
#else
static inline int module_param_sysfs_setup(struct module *mod,
			     struct kernel_param *kparam,
			     unsigned int num_params)
{
	return 0;
}

static inline void module_param_sysfs_remove(struct module *mod)
{ }
#endif

#endif /* _LINUX_MODULE_PARAMS_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_MODULE_PARAMS_H
	2	#define _LINUX_MODULE_PARAMS_H
	3	/* (C) Copyright 2001, 2002 Rusty Russell IBM Corporation */
	4	#include <linux/init.h>
	5	#include <linux/stringify.h>
	6	#include <linux/kernel.h>
	7
	8	/* You can override this manually, but generally this should match the
	9	module name. */
	10	#ifdef MODULE
	11	#define MODULE_PARAM_PREFIX /* empty */
	12	#else
367cb704	13	#define MODULE_PARAM_PREFIX KBUILD_MODNAME "."
1da177e4 LT	14	#endif
1da177e4 LT	15
730b69d2 RR	16	/* Chosen so that structs with an unsigned long line up. */
	17	#define MAX_PARAM_PREFIX_LEN (64 - sizeof(unsigned long))
	18
1da177e4 LT	19	#ifdef MODULE
	20	#define ___module_cat(a,b) __mod_ ## a ## b
	21	#define __module_cat(a,b) ___module_cat(a,b)
	22	#define __MODULE_INFO(tag, name, info) \
	23	static const char __module_cat(name,__LINE__)[] \
3ff6eecc	24	__used \
1da177e4 LT	25	__attribute__((section(".modinfo"),unused)) = __stringify(tag) "=" info
	26	#else /* !MODULE */
	27	#define __MODULE_INFO(tag, name, info)
	28	#endif
	29	#define __MODULE_PARM_TYPE(name, _type) \
	30	__MODULE_INFO(parmtype, name##type, #name ":" _type)
	31
	32	struct kernel_param;
	33
	34	/* Returns 0, or -errno. arg is in kp->arg. */
	35	typedef int (param_set_fn)(const char val, struct kernel_param *kp);
	36	/* Returns length written or -errno. Buffer is 4k (ie. be short!) */
	37	typedef int (param_get_fn)(char buffer, struct kernel_param *kp);
	38
	39	struct kernel_param {
	40	const char *name;
	41	unsigned int perm;
	42	param_set_fn set;
	43	param_get_fn get;
22e48eaf JB	44	union {
	45	void *arg;
	46	const struct kparam_string *str;
	47	const struct kparam_array *arr;
	48	};
1da177e4 LT	49	};
	50
	51	/* Special one for strings we want to copy into */
	52	struct kparam_string {
	53	unsigned int maxlen;
	54	char *string;
	55	};
	56
	57	/* Special one for arrays */
	58	struct kparam_array
	59	{
	60	unsigned int max;
	61	unsigned int *num;
	62	param_set_fn set;
	63	param_get_fn get;
	64	unsigned int elemsize;
	65	void *elem;
	66	};
	67
91d35dd9 IK	68	/* On alpha, ia64 and ppc64 relocations to global data cannot go into
	69	read-only sections (which is part of respective UNIX ABI on these
	70	platforms). So 'const' makes no sense and even causes compile failures
	71	with some compilers. */
	72	#if defined(CONFIG_ALPHA) \|\| defined(CONFIG_IA64) \|\| defined(CONFIG_PPC64)
	73	#define __moduleparam_const
	74	#else
	75	#define __moduleparam_const const
	76	#endif
	77
1da177e4	78	/* This is the fundamental function for registering boot/module
405ae7d3	79	parameters. perm sets the visibility in sysfs: 000 means it's
1da177e4 LT	80	not there, read bits mean it's readable, write bits mean it's
	81	writable. */
	82	#define __module_param_call(prefix, name, set, get, arg, perm) \
9774a1f5 AD	83	/* Default value instead of permissions? */ \
9774a1f5 AD	84	static int __param_perm_check_##name __attribute__((unused)) = \
730b69d2 RR	85	BUILD_BUG_ON_ZERO((perm) < 0 \|\| (perm) > 0777 \|\| ((perm) & 2)) \
730b69d2 RR	86	+ BUILD_BUG_ON_ZERO(sizeof(""prefix) > MAX_PARAM_PREFIX_LEN); \
22e48eaf	87	static const char __param_str_##name[] = prefix #name; \
91d35dd9	88	static struct kernel_param __moduleparam_const __param_##name \
3ff6eecc	89	__used \
1da177e4	90	__attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) \
22e48eaf	91	= { __param_str_##name, perm, set, get, { arg } }
1da177e4 LT	92
	93	#define module_param_call(name, set, get, arg, perm) \
	94	__module_param_call(MODULE_PARAM_PREFIX, name, set, get, arg, perm)
	95
	96	/* Helper functions: type is byte, short, ushort, int, uint, long,
	97	ulong, charp, bool or invbool, or XXX if you define param_get_XXX,
	98	param_set_XXX and param_check_XXX. */
	99	#define module_param_named(name, value, type, perm) \
	100	param_check_##type(name, &(value)); \
	101	module_param_call(name, param_set_##type, param_get_##type, &value, perm); \
	102	__MODULE_PARM_TYPE(name, #type)
	103
	104	#define module_param(name, type, perm) \
	105	module_param_named(name, name, type, perm)
	106
	107	/* Actually copy string: maxlen param is usually sizeof(string). */
	108	#define module_param_string(name, string, len, perm) \
22e48eaf	109	static const struct kparam_string __param_string_##name \
1da177e4 LT	110	= { len, string }; \
1da177e4 LT	111	module_param_call(name, param_set_copystring, param_get_string, \
22e48eaf	112	.str = &__param_string_##name, perm); \
1da177e4 LT	113	__MODULE_PARM_TYPE(name, "string")
	114
	115	/* Called on module insert or kernel boot */
	116	extern int parse_args(const char *name,
	117	char *args,
	118	struct kernel_param *params,
	119	unsigned num,
	120	int (unknown)(char param, char *val));
	121
	122	/* All the helper functions */
	123	/* The macros to do compile-time type checking stolen from Jakub
	124	Jelinek, who IIRC came up with this idea for the 2.4 module init code. */
	125	#define __param_check(name, p, type) \
	126	static inline type *__check_##name(void) { return(p); }
	127
	128	extern int param_set_byte(const char val, struct kernel_param kp);
	129	extern int param_get_byte(char buffer, struct kernel_param kp);
	130	#define param_check_byte(name, p) __param_check(name, p, unsigned char)
	131
	132	extern int param_set_short(const char val, struct kernel_param kp);
	133	extern int param_get_short(char buffer, struct kernel_param kp);
	134	#define param_check_short(name, p) __param_check(name, p, short)
	135
	136	extern int param_set_ushort(const char val, struct kernel_param kp);
	137	extern int param_get_ushort(char buffer, struct kernel_param kp);
	138	#define param_check_ushort(name, p) __param_check(name, p, unsigned short)
	139
	140	extern int param_set_int(const char val, struct kernel_param kp);
	141	extern int param_get_int(char buffer, struct kernel_param kp);
	142	#define param_check_int(name, p) __param_check(name, p, int)
	143
	144	extern int param_set_uint(const char val, struct kernel_param kp);
	145	extern int param_get_uint(char buffer, struct kernel_param kp);
	146	#define param_check_uint(name, p) __param_check(name, p, unsigned int)
	147
	148	extern int param_set_long(const char val, struct kernel_param kp);
	149	extern int param_get_long(char buffer, struct kernel_param kp);
	150	#define param_check_long(name, p) __param_check(name, p, long)
	151
	152	extern int param_set_ulong(const char val, struct kernel_param kp);
	153	extern int param_get_ulong(char buffer, struct kernel_param kp);
	154	#define param_check_ulong(name, p) __param_check(name, p, unsigned long)
	155
	156	extern int param_set_charp(const char val, struct kernel_param kp);
	157	extern int param_get_charp(char buffer, struct kernel_param kp);
	158	#define param_check_charp(name, p) __param_check(name, p, char *)
	159
	160	extern int param_set_bool(const char val, struct kernel_param kp);
	161	extern int param_get_bool(char buffer, struct kernel_param kp);
	162	#define param_check_bool(name, p) __param_check(name, p, int)
	163
	164	extern int param_set_invbool(const char val, struct kernel_param kp);
	165	extern int param_get_invbool(char buffer, struct kernel_param kp);
	166	#define param_check_invbool(name, p) __param_check(name, p, int)
	167
	168	/* Comma-separated array: nump is set to number they actually specified. /
	169	#define module_param_array_named(name, array, type, nump, perm) \
22e48eaf	170	static const struct kparam_array __param_arr_##name \
1da177e4 LT	171	= { ARRAY_SIZE(array), nump, param_set_##type, param_get_##type,\
	172	sizeof(array[0]), array }; \
	173	module_param_call(name, param_array_set, param_array_get, \
22e48eaf	174	.arr = &__param_arr_##name, perm); \
1da177e4 LT	175	__MODULE_PARM_TYPE(name, "array of " #type)
	176
	177	#define module_param_array(name, type, nump, perm) \
	178	module_param_array_named(name, name, type, nump, perm)
	179
	180	extern int param_array_set(const char val, struct kernel_param kp);
	181	extern int param_array_get(char buffer, struct kernel_param kp);
	182
	183	extern int param_set_copystring(const char val, struct kernel_param kp);
	184	extern int param_get_string(char buffer, struct kernel_param kp);
	185
1da177e4 LT	186	/* for exporting parameters in /sys/parameters */
	187
	188	struct module;
	189
ef665c1a	190	#if defined(CONFIG_SYSFS) && defined(CONFIG_MODULES)
1da177e4 LT	191	extern int module_param_sysfs_setup(struct module *mod,
	192	struct kernel_param *kparam,
	193	unsigned int num_params);
	194
	195	extern void module_param_sysfs_remove(struct module *mod);
ef665c1a RD	196	#else
	197	static inline int module_param_sysfs_setup(struct module *mod,
	198	struct kernel_param *kparam,
	199	unsigned int num_params)
	200	{
	201	return 0;
	202	}
	203
	204	static inline void module_param_sysfs_remove(struct module *mod)
	205	{ }
	206	#endif
1da177e4 LT	207
1da177e4 LT	208	#endif /* _LINUX_MODULE_PARAMS_H */