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 #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
  13 #define MODULE_PARAM_PREFIX __stringify(KBUILD_MODNAME) "."
  14 #endif
  15
  16 struct kernel_param;
  17
  18 /* Returns 0, or -errno.  arg is in kp->arg. */
  19 typedef int (*param_set_fn)(const char *val, struct kernel_param *kp);
  20 /* Returns length written or -errno.  Buffer is 4k (ie. be short!) */
  21 typedef int (*param_get_fn)(char *buffer, struct kernel_param *kp);
  22
  23 struct kernel_param {
  24         const char *name;
  25         unsigned int perm;
  26         param_set_fn set;
  27         param_get_fn get;
  28         void *arg;
  29 };
  30
  31 /* Special one for strings we want to copy into */
  32 struct kparam_string {
  33         unsigned int maxlen;
  34         char *string;
  35 };
  36
  37 /* Special one for arrays */
  38 struct kparam_array
  39 {
  40         unsigned int max;
  41         unsigned int *num;
  42         param_set_fn set;
  43         param_get_fn get;
  44         unsigned int elemsize;
  45         void *elem;
  46 };
  47
  48 /* This is the fundamental function for registering boot/module
  49    parameters.  perm sets the visibility in driverfs: 000 means it's
  50    not there, read bits mean it's readable, write bits mean it's
  51    writable. */
  52 #define __module_param_call(prefix, name, set, get, arg, perm)          \
  53         static char __param_str_##name[] = prefix #name;                \
  54         static struct kernel_param const __param_##name                 \
  55         __attribute_used__                                              \
  56     __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) \
  57         = { __param_str_##name, perm, set, get, arg }
  58
  59 #define module_param_call(name, set, get, arg, perm)                          \
  60         __module_param_call(MODULE_PARAM_PREFIX, name, set, get, arg, perm)
  61
  62 /* Helper functions: type is byte, short, ushort, int, uint, long,
  63    ulong, charp, bool or invbool, or XXX if you define param_get_XXX,
  64    param_set_XXX and param_check_XXX. */
  65 #define module_param_named(name, value, type, perm)                        \
  66         param_check_##type(name, &(value));                                \
  67         module_param_call(name, param_set_##type, param_get_##type, &value, perm); \
  68         __MODULE_INFO(parmtype, name##type, #name ":" #type)
  69
  70 #define module_param(name, type, perm)                          \
  71         module_param_named(name, name, type, perm)
  72
  73 /* Actually copy string: maxlen param is usually sizeof(string). */
  74 #define module_param_string(name, string, len, perm)                    \
  75         static struct kparam_string __param_string_##name               \
  76                 = { len, string };                                      \
  77         module_param_call(name, param_set_copystring, param_get_string, \
  78                    &__param_string_##name, perm);                       \
  79         __MODULE_INFO(parmtype, name##type, #name ":string")
  80
  81 /* Called on module insert or kernel boot */
  82 extern int parse_args(const char *name,
  83                       char *args,
  84                       struct kernel_param *params,
  85                       unsigned num,
  86                       int (*unknown)(char *param, char *val));
  87
  88 /* All the helper functions */
  89 /* The macros to do compile-time type checking stolen from Jakub
  90    Jelinek, who IIRC came up with this idea for the 2.4 module init code. */
  91 #define __param_check(name, p, type) \
  92         static inline type *__check_##name(void) { return(p); }
  93
  94 extern int param_set_byte(const char *val, struct kernel_param *kp);
  95 extern int param_get_byte(char *buffer, struct kernel_param *kp);
  96 #define param_check_byte(name, p) __param_check(name, p, unsigned char)
  97
  98 extern int param_set_short(const char *val, struct kernel_param *kp);
  99 extern int param_get_short(char *buffer, struct kernel_param *kp);
 100 #define param_check_short(name, p) __param_check(name, p, short)
 101
 102 extern int param_set_ushort(const char *val, struct kernel_param *kp);
 103 extern int param_get_ushort(char *buffer, struct kernel_param *kp);
 104 #define param_check_ushort(name, p) __param_check(name, p, unsigned short)
 105
 106 extern int param_set_int(const char *val, struct kernel_param *kp);
 107 extern int param_get_int(char *buffer, struct kernel_param *kp);
 108 #define param_check_int(name, p) __param_check(name, p, int)
 109
 110 extern int param_set_uint(const char *val, struct kernel_param *kp);
 111 extern int param_get_uint(char *buffer, struct kernel_param *kp);
 112 #define param_check_uint(name, p) __param_check(name, p, unsigned int)
 113
 114 extern int param_set_long(const char *val, struct kernel_param *kp);
 115 extern int param_get_long(char *buffer, struct kernel_param *kp);
 116 #define param_check_long(name, p) __param_check(name, p, long)
 117
 118 extern int param_set_ulong(const char *val, struct kernel_param *kp);
 119 extern int param_get_ulong(char *buffer, struct kernel_param *kp);
 120 #define param_check_ulong(name, p) __param_check(name, p, unsigned long)
 121
 122 extern int param_set_charp(const char *val, struct kernel_param *kp);
 123 extern int param_get_charp(char *buffer, struct kernel_param *kp);
 124 #define param_check_charp(name, p) __param_check(name, p, char *)
 125
 126 extern int param_set_bool(const char *val, struct kernel_param *kp);
 127 extern int param_get_bool(char *buffer, struct kernel_param *kp);
 128 #define param_check_bool(name, p) __param_check(name, p, int)
 129
 130 extern int param_set_invbool(const char *val, struct kernel_param *kp);
 131 extern int param_get_invbool(char *buffer, struct kernel_param *kp);
 132 #define param_check_invbool(name, p) __param_check(name, p, int)
 133
 134 /* Comma-separated array: *nump is set to number they actually specified. */
 135 #define module_param_array_named(name, array, type, nump, perm)         \
 136         static struct kparam_array __param_arr_##name                   \
 137         = { ARRAY_SIZE(array), nump, param_set_##type, param_get_##type,\
 138             sizeof(array[0]), array };                                  \
 139         module_param_call(name, param_array_set, param_array_get,       \
 140                           &__param_arr_##name, perm);                   \
 141         __MODULE_INFO(parmtype, name##type, #name ":array of " #type)
 142
 143 #define module_param_array(name, type, nump, perm)              \
 144         module_param_array_named(name, name, type, nump, perm)
 145
 146 extern int param_array_set(const char *val, struct kernel_param *kp);
 147 extern int param_array_get(char *buffer, struct kernel_param *kp);
 148
 149 extern int param_set_copystring(const char *val, struct kernel_param *kp);
 150 extern int param_get_string(char *buffer, struct kernel_param *kp);
 151
 152 int param_array(const char *name,
 153                 const char *val,
 154                 unsigned int min, unsigned int max,
 155                 void *elem, int elemsize,
 156                 int (*set)(const char *, struct kernel_param *kp),
 157                 int *num);
 158
 159 /* for exporting parameters in /sys/parameters */
 160
 161 struct module;
 162
 163 extern int module_param_sysfs_setup(struct module *mod,
 164                                     struct kernel_param *kparam,
 165                                     unsigned int num_params);
 166
 167 extern void module_param_sysfs_remove(struct module *mod);
 168
 169 #endif /* _LINUX_MODULE_PARAMS_H */