source: svn/trunk/newcon3bcm2_21bu/toolchain/mipsel-linux-uclibc/include/linux/moduleparam.h

Last change on this file was 2, checked in by jglee, 11 years ago

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