Something went wrong. Try again.
(I'm so sorry!) Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
C
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643/* SPDX-License-Identifier: GPL-2.0 */#ifndef _LINUX_MODULE_PARAMS_H#define _LINUX_MODULE_PARAMS_H/* (C) Copyright 2001, 2002 Rusty Russell IBM Corporation */
#include <linux/array_size.h>#include <linux/build_bug.h>#include <linux/compiler.h>#include <linux/init.h>#include <linux/stringify.h>#include <linux/sysfs.h>#include <linux/types.h>
/* * The maximum module name length, including the NUL byte. * Chosen so that structs with an unsigned long line up, specifically * modversion_info. */#define __MODULE_NAME_LEN (64 - sizeof(unsigned long))
/* You can override this manually, but generally this should match the module name. */#ifdef MODULE#define MODULE_PARAM_PREFIX /* empty */#define __MODULE_INFO_PREFIX /* empty */#else#define MODULE_PARAM_PREFIX KBUILD_MODNAME "."/* We cannot use MODULE_PARAM_PREFIX because some modules override it. */#define __MODULE_INFO_PREFIX KBUILD_MODNAME "."#endif
/* Generic info of form tag = "info" */#define MODULE_INFO(tag, info) \ static_assert( \ sizeof(info) - 1 == __builtin_strlen(info), \ "MODULE_INFO(" #tag ", ...) contains embedded NUL byte"); \ static const char __UNIQUE_ID(modinfo)[] \ __used __section(".modinfo") __aligned(1) \ = __MODULE_INFO_PREFIX __stringify(tag) "=" info
#define __MODULE_PARM_TYPE(name, _type) \ MODULE_INFO(parmtype, #name ":" _type)
/* One for each parameter, describing how to use it. Some files do multiple of these per line, so can't just use MODULE_INFO. */#define MODULE_PARM_DESC(_parm, desc) \ MODULE_INFO(parm, #_parm ":" desc)
struct kernel_param;
/* * Flags available for kernel_param_ops * * NOARG - the parameter allows for no argument (foo instead of foo=1) */enum { KERNEL_PARAM_OPS_FL_NOARG = (1 << 0)};
struct kernel_param_ops { /* How the ops should behave */ unsigned int flags; /* Returns 0, or -errno. arg is in kp->arg. */ int (*set)(const char *val, const struct kernel_param *kp); /* Returns length written or -errno. Buffer is 4k (ie. be short!) */ int (*get)(char *buffer, const struct kernel_param *kp); /* Optional function to free kp->arg when module unloaded. */ void (*free)(void *arg);};
/* * Flags available for kernel_param * * UNSAFE - the parameter is dangerous and setting it will taint the kernel * HWPARAM - Hardware param not permitted in lockdown mode */enum { KERNEL_PARAM_FL_UNSAFE = (1 << 0), KERNEL_PARAM_FL_HWPARAM = (1 << 1),};
struct kernel_param { const char *name; struct module *mod; const struct kernel_param_ops *ops; const u16 perm; s8 level; u8 flags; union { void *arg; const struct kparam_string *str; const struct kparam_array *arr; };};
extern const struct kernel_param __start___param[], __stop___param[];
/* 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 elemsize; unsigned int *num; const struct kernel_param_ops *ops; void *elem;};
/** * module_param - typesafe helper for a module/cmdline parameter * @name: the variable to alter, and exposed parameter name. * @type: the type of the parameter * @perm: visibility in sysfs. * * @name becomes the module parameter, or (prefixed by KBUILD_MODNAME and a * ".") the kernel commandline parameter. Note that - is changed to _, so * the user can use "foo-bar=1" even for variable "foo_bar". * * @perm is 0 if the variable is not to appear in sysfs, or 0444 * for world-readable, 0644 for root-writable, etc. Note that if it * is writable, you may need to use kernel_param_lock() around * accesses (esp. charp, which can be kfreed when it changes). * * The @type is simply pasted to refer to a param_ops_##type and a * param_check_##type: for convenience many standard types are provided but * you can create your own by defining those variables. * * Standard types are: * byte, hexint, short, ushort, int, uint, long, ulong * charp: a character pointer * bool: a bool, values 0/1, y/n, Y/N. * invbool: the above, only sense-reversed (N = true). */#define module_param(name, type, perm) \ module_param_named(name, name, type, perm)
/** * module_param_unsafe - same as module_param but taints kernel * @name: the variable to alter, and exposed parameter name. * @type: the type of the parameter * @perm: visibility in sysfs. */#define module_param_unsafe(name, type, perm) \ module_param_named_unsafe(name, name, type, perm)
/** * module_param_named - typesafe helper for a renamed module/cmdline parameter * @name: a valid C identifier which is the parameter name. * @value: the actual lvalue to alter. * @type: the type of the parameter * @perm: visibility in sysfs. * * Usually it's a good idea to have variable names and user-exposed names the * same, but that's harder if the variable must be non-static or is inside a * structure. This allows exposure under a different name. */#define module_param_named(name, value, type, perm) \ param_check_##type(name, &(value)); \ module_param_cb(name, ¶m_ops_##type, &value, perm); \ __MODULE_PARM_TYPE(name, #type)
/** * module_param_named_unsafe - same as module_param_named but taints kernel * @name: a valid C identifier which is the parameter name. * @value: the actual lvalue to alter. * @type: the type of the parameter * @perm: visibility in sysfs. */#define module_param_named_unsafe(name, value, type, perm) \ param_check_##type(name, &(value)); \ module_param_cb_unsafe(name, ¶m_ops_##type, &value, perm); \ __MODULE_PARM_TYPE(name, #type)
/** * module_param_cb - general callback for a module/cmdline parameter * @name: a valid C identifier which is the parameter name. * @ops: the set & get operations for this parameter. * @arg: args for @ops * @perm: visibility in sysfs. * * The ops can have NULL set or get functions. */#define module_param_cb(name, ops, arg, perm) \ __module_param_call(MODULE_PARAM_PREFIX, name, ops, arg, perm, -1, 0)
#define module_param_cb_unsafe(name, ops, arg, perm) \ __module_param_call(MODULE_PARAM_PREFIX, name, ops, arg, perm, -1, \ KERNEL_PARAM_FL_UNSAFE)
#define __level_param_cb(name, ops, arg, perm, level) \ __module_param_call(MODULE_PARAM_PREFIX, name, ops, arg, perm, level, 0)/** * core_param_cb - general callback for a module/cmdline parameter * to be evaluated before core initcall level * @name: a valid C identifier which is the parameter name. * @ops: the set & get operations for this parameter. * @arg: args for @ops * @perm: visibility in sysfs. * * The ops can have NULL set or get functions. */#define core_param_cb(name, ops, arg, perm) \ __level_param_cb(name, ops, arg, perm, 1)
/** * postcore_param_cb - general callback for a module/cmdline parameter * to be evaluated before postcore initcall level * @name: a valid C identifier which is the parameter name. * @ops: the set & get operations for this parameter. * @arg: args for @ops * @perm: visibility in sysfs. * * The ops can have NULL set or get functions. */#define postcore_param_cb(name, ops, arg, perm) \ __level_param_cb(name, ops, arg, perm, 2)
/** * arch_param_cb - general callback for a module/cmdline parameter * to be evaluated before arch initcall level * @name: a valid C identifier which is the parameter name. * @ops: the set & get operations for this parameter. * @arg: args for @ops * @perm: visibility in sysfs. * * The ops can have NULL set or get functions. */#define arch_param_cb(name, ops, arg, perm) \ __level_param_cb(name, ops, arg, perm, 3)
/** * subsys_param_cb - general callback for a module/cmdline parameter * to be evaluated before subsys initcall level * @name: a valid C identifier which is the parameter name. * @ops: the set & get operations for this parameter. * @arg: args for @ops * @perm: visibility in sysfs. * * The ops can have NULL set or get functions. */#define subsys_param_cb(name, ops, arg, perm) \ __level_param_cb(name, ops, arg, perm, 4)
/** * fs_param_cb - general callback for a module/cmdline parameter * to be evaluated before fs initcall level * @name: a valid C identifier which is the parameter name. * @ops: the set & get operations for this parameter. * @arg: args for @ops * @perm: visibility in sysfs. * * The ops can have NULL set or get functions. */#define fs_param_cb(name, ops, arg, perm) \ __level_param_cb(name, ops, arg, perm, 5)
/** * device_param_cb - general callback for a module/cmdline parameter * to be evaluated before device initcall level * @name: a valid C identifier which is the parameter name. * @ops: the set & get operations for this parameter. * @arg: args for @ops * @perm: visibility in sysfs. * * The ops can have NULL set or get functions. */#define device_param_cb(name, ops, arg, perm) \ __level_param_cb(name, ops, arg, perm, 6)
/** * late_param_cb - general callback for a module/cmdline parameter * to be evaluated before late initcall level * @name: a valid C identifier which is the parameter name. * @ops: the set & get operations for this parameter. * @arg: args for @ops * @perm: visibility in sysfs. * * The ops can have NULL set or get functions. */#define late_param_cb(name, ops, arg, perm) \ __level_param_cb(name, ops, arg, perm, 7)
/* 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_PPC64)#define __moduleparam_const#else#define __moduleparam_const const#endif
/* This is the fundamental function for registering boot/module parameters. */#define __module_param_call(prefix, name, ops, arg, perm, level, flags) \ static_assert(sizeof(""prefix) - 1 <= __MODULE_NAME_LEN); \ static const char __param_str_##name[] = prefix #name; \ static struct kernel_param __moduleparam_const __param_##name \ __used __section("__param") \ __aligned(__alignof__(struct kernel_param)) \ = { __param_str_##name, THIS_MODULE, ops, \ VERIFY_OCTAL_PERMISSIONS(perm), level, flags, { arg } }
/* * Useful for describing a set/get pair used only once (i.e. for this * parameter). For repeated set/get pairs (i.e. the same struct * kernel_param_ops), use module_param_cb() instead. */#define module_param_call(name, _set, _get, arg, perm) \ static const struct kernel_param_ops __param_ops_##name = \ { .flags = 0, .set = _set, .get = _get }; \ __module_param_call(MODULE_PARAM_PREFIX, \ name, &__param_ops_##name, arg, perm, -1, 0)
#ifdef CONFIG_SYSFSvoid kernel_param_lock(struct module *mod);void kernel_param_unlock(struct module *mod);#elsestatic inline void kernel_param_lock(struct module *mod){}static inline void kernel_param_unlock(struct module *mod){}#endif
#ifndef MODULE/** * core_param - define a historical core kernel parameter. * @name: the name of the cmdline and sysfs parameter (often the same as var) * @var: the variable * @type: the type of the parameter * @perm: visibility in sysfs * * core_param is just like module_param(), but cannot be modular and * doesn't add a prefix (such as "printk."). This is for compatibility * with __setup(), and it makes sense as truly core parameters aren't * tied to the particular file they're in. */#define core_param(name, var, type, perm) \ param_check_##type(name, &(var)); \ __module_param_call("", name, ¶m_ops_##type, &var, perm, -1, 0)
/** * core_param_unsafe - same as core_param but taints kernel * @name: the name of the cmdline and sysfs parameter (often the same as var) * @var: the variable * @type: the type of the parameter * @perm: visibility in sysfs */#define core_param_unsafe(name, var, type, perm) \ param_check_##type(name, &(var)); \ __module_param_call("", name, ¶m_ops_##type, &var, perm, \ -1, KERNEL_PARAM_FL_UNSAFE)
/** * __core_param_cb - similar like core_param, with a set/get ops instead of type. * @name: the name of the cmdline and sysfs parameter (often the same as var) * @ops: the set & get operations for this parameter. * @arg: the variable * @perm: visibility in sysfs * * Ideally this should be called 'core_param_cb', but the name has been * used for module core parameter, so add the '__' prefix */#define __core_param_cb(name, ops, arg, perm) \ __module_param_call("", name, ops, arg, perm, -1, 0)
#endif /* !MODULE */
/** * module_param_string - a char array parameter * @name: the name of the parameter * @string: the string variable * @len: the maximum length of the string, incl. terminator * @perm: visibility in sysfs. * * This actually copies the string when it's set (unlike type charp). * @len is usually just sizeof(string). */#define module_param_string(name, string, len, perm) \ static const struct kparam_string __param_string_##name \ = { len, string }; \ __module_param_call(MODULE_PARAM_PREFIX, name, \ ¶m_ops_string, \ .str = &__param_string_##name, perm, -1, 0);\ __MODULE_PARM_TYPE(name, "string")
/** * parameq - checks if two parameter names match * @name1: parameter name 1 * @name2: parameter name 2 * * Returns: true if the two parameter names are equal. * Dashes (-) are considered equal to underscores (_). */bool parameq(const char *name1, const char *name2);
/** * parameqn - checks if two parameter names match * @name1: parameter name 1 * @name2: parameter name 2 * @n: the length to compare * * Similar to parameq(), except it compares @n characters. * * Returns: true if the first @n characters of the two parameter names * are equal. * Dashes (-) are considered equal to underscores (_). */bool parameqn(const char *name1, const char *name2, size_t n);
typedef int (*parse_unknown_fn)(char *param, char *val, const char *doing, void *arg);
/* Called on module insert or kernel boot */char *parse_args(const char *doing, char *args, const struct kernel_param *params, unsigned int num, s16 min_level, s16 max_level, void *arg, parse_unknown_fn unknown);
/* Called by module remove. */#ifdef CONFIG_MODULESvoid module_destroy_params(const struct kernel_param *params, unsigned int num);#endif
/* 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 __always_unused *__check_##name(void) { return(p); }
extern const struct kernel_param_ops param_ops_byte;int param_set_byte(const char *val, const struct kernel_param *kp);int param_get_byte(char *buffer, const struct kernel_param *kp);#define param_check_byte(name, p) __param_check(name, p, unsigned char)
extern const struct kernel_param_ops param_ops_short;int param_set_short(const char *val, const struct kernel_param *kp);int param_get_short(char *buffer, const struct kernel_param *kp);#define param_check_short(name, p) __param_check(name, p, short)
extern const struct kernel_param_ops param_ops_ushort;int param_set_ushort(const char *val, const struct kernel_param *kp);int param_get_ushort(char *buffer, const struct kernel_param *kp);#define param_check_ushort(name, p) __param_check(name, p, unsigned short)
extern const struct kernel_param_ops param_ops_int;int param_set_int(const char *val, const struct kernel_param *kp);int param_get_int(char *buffer, const struct kernel_param *kp);#define param_check_int(name, p) __param_check(name, p, int)
extern const struct kernel_param_ops param_ops_uint;int param_set_uint(const char *val, const struct kernel_param *kp);int param_get_uint(char *buffer, const struct kernel_param *kp);int param_set_uint_minmax(const char *val, const struct kernel_param *kp, unsigned int min, unsigned int max);#define param_check_uint(name, p) __param_check(name, p, unsigned int)
extern const struct kernel_param_ops param_ops_long;int param_set_long(const char *val, const struct kernel_param *kp);int param_get_long(char *buffer, const struct kernel_param *kp);#define param_check_long(name, p) __param_check(name, p, long)
extern const struct kernel_param_ops param_ops_ulong;int param_set_ulong(const char *val, const struct kernel_param *kp);int param_get_ulong(char *buffer, const struct kernel_param *kp);#define param_check_ulong(name, p) __param_check(name, p, unsigned long)
extern const struct kernel_param_ops param_ops_ullong;int param_set_ullong(const char *val, const struct kernel_param *kp);int param_get_ullong(char *buffer, const struct kernel_param *kp);#define param_check_ullong(name, p) __param_check(name, p, unsigned long long)
extern const struct kernel_param_ops param_ops_hexint;int param_set_hexint(const char *val, const struct kernel_param *kp);int param_get_hexint(char *buffer, const struct kernel_param *kp);#define param_check_hexint(name, p) param_check_uint(name, p)
extern const struct kernel_param_ops param_ops_charp;int param_set_charp(const char *val, const struct kernel_param *kp);int param_get_charp(char *buffer, const struct kernel_param *kp);void param_free_charp(void *arg);#define param_check_charp(name, p) __param_check(name, p, char *)
/* We used to allow int as well as bool. We're taking that away! */extern const struct kernel_param_ops param_ops_bool;int param_set_bool(const char *val, const struct kernel_param *kp);int param_get_bool(char *buffer, const struct kernel_param *kp);#define param_check_bool(name, p) __param_check(name, p, bool)
extern const struct kernel_param_ops param_ops_bool_enable_only;int param_set_bool_enable_only(const char *val, const struct kernel_param *kp);/* getter is the same as for the regular bool */#define param_check_bool_enable_only param_check_bool
extern const struct kernel_param_ops param_ops_invbool;int param_set_invbool(const char *val, const struct kernel_param *kp);int param_get_invbool(char *buffer, const struct kernel_param *kp);#define param_check_invbool(name, p) __param_check(name, p, bool)
/* An int, which can only be set like a bool (though it shows as an int). */extern const struct kernel_param_ops param_ops_bint;int param_set_bint(const char *val, const struct kernel_param *kp);#define param_get_bint param_get_int#define param_check_bint param_check_int
/** * module_param_array - a parameter which is an array of some type * @name: the name of the array variable * @type: the type, as per module_param() * @nump: optional pointer filled in with the number written * @perm: visibility in sysfs * * Input and output are as comma-separated values. Commas inside values * don't work properly (eg. an array of charp). * * ARRAY_SIZE(@name) is used to determine the number of elements in the * array, so the definition must be visible. */#define module_param_array(name, type, nump, perm) \ module_param_array_named(name, name, type, nump, perm)
/** * module_param_array_named - renamed parameter which is an array of some type * @name: a valid C identifier which is the parameter name * @array: the name of the array variable * @type: the type, as per module_param() * @nump: optional pointer filled in with the number written * @perm: visibility in sysfs * * This exposes a different name than the actual variable name. See * module_param_named() for why this might be necessary. */#define module_param_array_named(name, array, type, nump, perm) \ param_check_##type(name, &(array)[0]); \ static const struct kparam_array __param_arr_##name \ = { .max = ARRAY_SIZE(array), .num = nump, \ .ops = ¶m_ops_##type, \ .elemsize = sizeof(array[0]), .elem = array }; \ __module_param_call(MODULE_PARAM_PREFIX, name, \ ¶m_array_ops, \ .arr = &__param_arr_##name, \ perm, -1, 0); \ __MODULE_PARM_TYPE(name, "array of " #type)
enum hwparam_type { hwparam_ioport, /* Module parameter configures an I/O port */ hwparam_iomem, /* Module parameter configures an I/O mem address */ hwparam_ioport_or_iomem, /* Module parameter could be either, depending on other option */ hwparam_irq, /* Module parameter configures an IRQ */ hwparam_dma, /* Module parameter configures a DMA channel */ hwparam_dma_addr, /* Module parameter configures a DMA buffer address */ hwparam_other, /* Module parameter configures some other value */};
/** * module_param_hw_named - A parameter representing a hw parameters * @name: a valid C identifier which is the parameter name. * @value: the actual lvalue to alter. * @type: the type of the parameter * @hwtype: what the value represents (enum hwparam_type) * @perm: visibility in sysfs. * * Usually it's a good idea to have variable names and user-exposed names the * same, but that's harder if the variable must be non-static or is inside a * structure. This allows exposure under a different name. */#define module_param_hw_named(name, value, type, hwtype, perm) \ param_check_##type(name, &(value)); \ __module_param_call(MODULE_PARAM_PREFIX, name, \ ¶m_ops_##type, &value, \ perm, -1, \ KERNEL_PARAM_FL_HWPARAM | (hwparam_##hwtype & 0)); \ __MODULE_PARM_TYPE(name, #type)
#define module_param_hw(name, type, hwtype, perm) \ module_param_hw_named(name, name, type, hwtype, perm)
/** * module_param_hw_array - A parameter representing an array of hw parameters * @name: the name of the array variable * @type: the type, as per module_param() * @hwtype: what the value represents (enum hwparam_type) * @nump: optional pointer filled in with the number written * @perm: visibility in sysfs * * Input and output are as comma-separated values. Commas inside values * don't work properly (eg. an array of charp). * * ARRAY_SIZE(@name) is used to determine the number of elements in the * array, so the definition must be visible. */#define module_param_hw_array(name, type, hwtype, nump, perm) \ param_check_##type(name, &(name)[0]); \ static const struct kparam_array __param_arr_##name \ = { .max = ARRAY_SIZE(name), .num = nump, \ .ops = ¶m_ops_##type, \ .elemsize = sizeof(name[0]), .elem = name }; \ __module_param_call(MODULE_PARAM_PREFIX, name, \ ¶m_array_ops, \ .arr = &__param_arr_##name, \ perm, -1, \ KERNEL_PARAM_FL_HWPARAM | (hwparam_##hwtype & 0)); \ __MODULE_PARM_TYPE(name, "array of " #type)
extern const struct kernel_param_ops param_array_ops;
extern const struct kernel_param_ops param_ops_string;int param_set_copystring(const char *val, const struct kernel_param *kp);int param_get_string(char *buffer, const struct kernel_param *kp);
/* for exporting parameters in /sys/module/.../parameters */
struct module;
#if defined(CONFIG_SYSFS) && defined(CONFIG_MODULES)int module_param_sysfs_setup(struct module *mod, const struct kernel_param *kparam, unsigned int num_params);
void module_param_sysfs_remove(struct module *mod);#elsestatic inline int module_param_sysfs_setup(struct module *mod, const 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 */