include/linux/moduleparam.h

   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
   7 /* You can override this manually, but generally this should match the
   8    module name. */
   9 #ifdef MODULE
  10 #define MODULE_PARAM_PREFIX /* empty */
  11 #else
  12 #define MODULE_PARAM_PREFIX __stringify(KBUILD_MODNAME) "."
  13 #endif
  14
  15 struct kernel_param;
  16
  17 /* Returns 0, or -errno.  arg is in kp->arg. */
  18 typedef int (*param_set_fn)(const char *val, struct kernel_param *kp);
  19 /* Returns length written or -errno.  Buffer is 4k (ie. be short!) */
  20 typedef int (*param_get_fn)(char *buffer, struct kernel_param *kp);
  21
  22 struct kernel_param {
  23         const char *name;
  24         unsigned int perm;
  25         param_set_fn set;
  26         param_get_fn get;
  27         void *arg;
  28 };
  29
  30 /* Special one for strings we want to copy into */
  31 struct kparam_string {
  32         unsigned int maxlen;
  33         char *string;
  34 };
  35
  36 /* This is the fundamental function for registering boot/module
  37    parameters.  perm sets the visibility in driverfs: 000 means it's
  38    not there, read bits mean it's readable, write bits mean it's
  39    writable. */
  40 #define __module_param_call(prefix, name, set, get, arg, perm)          \
  41         static char __param_str_##name[] __initdata = prefix #name;     \
  42         static struct kernel_param const __param_##name                 \
  43     __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) \
  44         = { __param_str_##name, perm, set, get, arg }
  45
  46 #define module_param_call(name, set, get, arg, perm)                          \
  47         __module_param_call(MODULE_PARAM_PREFIX, name, set, get, arg, perm)
  48
  49 /* Helper functions: type is byte, short, ushort, int, uint, long,
  50    ulong, charp, bool or invbool, or XXX if you define param_get_XXX,
  51    param_set_XXX and param_check_XXX. */
  52 #define module_param_named(name, value, type, perm)                        \
  53         param_check_##type(name, &(value));                                \
  54         module_param_call(name, param_set_##type, param_get_##type, &value, perm)
  55
  56 #define module_param(name, type, perm)                          \
  57         module_param_named(name, name, type, perm)
  58
  59 /* Actually copy string: maxlen param is usually sizeof(string). */
  60 #define module_param_string(name, string, len, perm)                    \
  61         static struct kparam_string __param_string_##name __initdata    \
  62                 = { len, string };                                      \
  63         module_param_call(name, param_set_copystring, param_get_charp,  \
  64                    &__param_string_##name, perm)
  65
  66 /* Called on module insert or kernel boot */
  67 extern int parse_args(const char *name,
  68                       char *args,
  69                       struct kernel_param *params,
  70                       unsigned num,
  71                       int (*unknown)(char *param, char *val));
  72
  73 /* All the helper functions */
  74 /* The macros to do compile-time type checking stolen from Jakub
  75    Jelinek, who IIRC came up with this idea for the 2.4 module init code. */
  76 #define __param_check(name, p, type) \
  77         static inline type *__check_##name(void) { return(p); }
  78
  79 extern int param_set_short(const char *val, struct kernel_param *kp);
  80 extern int param_get_short(char *buffer, struct kernel_param *kp);
  81 #define param_check_short(name, p) __param_check(name, p, short)
  82
  83 extern int param_set_ushort(const char *val, struct kernel_param *kp);
  84 extern int param_get_ushort(char *buffer, struct kernel_param *kp);
  85 #define param_check_ushort(name, p) __param_check(name, p, unsigned short)
  86
  87 extern int param_set_int(const char *val, struct kernel_param *kp);
  88 extern int param_get_int(char *buffer, struct kernel_param *kp);
  89 #define param_check_int(name, p) __param_check(name, p, int)
  90
  91 extern int param_set_uint(const char *val, struct kernel_param *kp);
  92 extern int param_get_uint(char *buffer, struct kernel_param *kp);
  93 #define param_check_uint(name, p) __param_check(name, p, unsigned int)
  94
  95 extern int param_set_long(const char *val, struct kernel_param *kp);
  96 extern int param_get_long(char *buffer, struct kernel_param *kp);
  97 #define param_check_long(name, p) __param_check(name, p, long)
  98
  99 extern int param_set_ulong(const char *val, struct kernel_param *kp);
 100 extern int param_get_ulong(char *buffer, struct kernel_param *kp);
 101 #define param_check_ulong(name, p) __param_check(name, p, unsigned long)
 102
 103 extern int param_set_charp(const char *val, struct kernel_param *kp);
 104 extern int param_get_charp(char *buffer, struct kernel_param *kp);
 105 #define param_check_charp(name, p) __param_check(name, p, char *)
 106
 107 extern int param_set_bool(const char *val, struct kernel_param *kp);
 108 extern int param_get_bool(char *buffer, struct kernel_param *kp);
 109 #define param_check_bool(name, p) __param_check(name, p, int)
 110
 111 extern int param_set_invbool(const char *val, struct kernel_param *kp);
 112 extern int param_get_invbool(char *buffer, struct kernel_param *kp);
 113 #define param_check_invbool(name, p) __param_check(name, p, int)
 114
 115 /* First two elements are the max and min array length (which don't change) */
 116 extern int param_set_intarray(const char *val, struct kernel_param *kp);
 117 extern int param_get_intarray(char *buffer, struct kernel_param *kp);
 118 #define param_check_intarray(name, p) __param_check(name, p, int *)
 119
 120 extern int param_set_copystring(const char *val, struct kernel_param *kp);
 121
 122 int param_array(const char *name,
 123                 const char *val,
 124                 unsigned int min, unsigned int max,
 125                 void *elem, int elemsize,
 126                 int (*set)(const char *, struct kernel_param *kp));
 127 #endif /* _LINUX_MODULE_PARAM_TYPES_H */