]>
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 |
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 | ||
9bbb9e5a RR |
34 | struct kernel_param_ops { |
35 | /* Returns 0, or -errno. arg is in kp->arg. */ | |
36 | int (*set)(const char *val, const struct kernel_param *kp); | |
37 | /* Returns length written or -errno. Buffer is 4k (ie. be short!) */ | |
38 | int (*get)(char *buffer, const struct kernel_param *kp); | |
39 | }; | |
1da177e4 | 40 | |
45fcc70c | 41 | /* Flag bits for kernel_param.flags */ |
fddd5201 | 42 | #define KPARAM_ISBOOL 2 |
45fcc70c | 43 | |
1da177e4 LT |
44 | struct kernel_param { |
45 | const char *name; | |
9bbb9e5a | 46 | const struct kernel_param_ops *ops; |
45fcc70c RR |
47 | u16 perm; |
48 | u16 flags; | |
22e48eaf JB |
49 | union { |
50 | void *arg; | |
51 | const struct kparam_string *str; | |
52 | const struct kparam_array *arr; | |
53 | }; | |
1da177e4 LT |
54 | }; |
55 | ||
56 | /* Special one for strings we want to copy into */ | |
57 | struct kparam_string { | |
58 | unsigned int maxlen; | |
59 | char *string; | |
60 | }; | |
61 | ||
62 | /* Special one for arrays */ | |
63 | struct kparam_array | |
64 | { | |
65 | unsigned int max; | |
66 | unsigned int *num; | |
9bbb9e5a | 67 | const struct kernel_param_ops *ops; |
1da177e4 LT |
68 | unsigned int elemsize; |
69 | void *elem; | |
70 | }; | |
71 | ||
91d35dd9 IK |
72 | /* On alpha, ia64 and ppc64 relocations to global data cannot go into |
73 | read-only sections (which is part of respective UNIX ABI on these | |
74 | platforms). So 'const' makes no sense and even causes compile failures | |
75 | with some compilers. */ | |
76 | #if defined(CONFIG_ALPHA) || defined(CONFIG_IA64) || defined(CONFIG_PPC64) | |
77 | #define __moduleparam_const | |
78 | #else | |
79 | #define __moduleparam_const const | |
80 | #endif | |
81 | ||
1da177e4 | 82 | /* This is the fundamental function for registering boot/module |
405ae7d3 | 83 | parameters. perm sets the visibility in sysfs: 000 means it's |
1da177e4 LT |
84 | not there, read bits mean it's readable, write bits mean it's |
85 | writable. */ | |
9bbb9e5a | 86 | #define __module_param_call(prefix, name, ops, arg, isbool, perm) \ |
9774a1f5 AD |
87 | /* Default value instead of permissions? */ \ |
88 | static int __param_perm_check_##name __attribute__((unused)) = \ | |
730b69d2 RR |
89 | BUILD_BUG_ON_ZERO((perm) < 0 || (perm) > 0777 || ((perm) & 2)) \ |
90 | + BUILD_BUG_ON_ZERO(sizeof(""prefix) > MAX_PARAM_PREFIX_LEN); \ | |
22e48eaf | 91 | static const char __param_str_##name[] = prefix #name; \ |
91d35dd9 | 92 | static struct kernel_param __moduleparam_const __param_##name \ |
3ff6eecc | 93 | __used \ |
1da177e4 | 94 | __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) \ |
9bbb9e5a RR |
95 | = { __param_str_##name, ops, perm, isbool ? KPARAM_ISBOOL : 0, \ |
96 | { arg } } | |
97 | ||
98 | /* Obsolete - use module_param_cb() */ | |
99 | #define module_param_call(name, set, get, arg, perm) \ | |
100 | static struct kernel_param_ops __param_ops_##name = \ | |
101 | { (void *)set, (void *)get }; \ | |
102 | __module_param_call(MODULE_PARAM_PREFIX, \ | |
103 | name, &__param_ops_##name, arg, \ | |
104 | __same_type(*(arg), bool), \ | |
105 | (perm) + sizeof(__check_old_set_param(set))*0) | |
106 | ||
107 | /* We don't get oldget: it's often a new-style param_get_uint, etc. */ | |
108 | static inline int | |
109 | __check_old_set_param(int (*oldset)(const char *, struct kernel_param *)) | |
110 | { | |
111 | return 0; | |
112 | } | |
1da177e4 | 113 | |
9bbb9e5a | 114 | #define module_param_cb(name, ops, arg, perm) \ |
fddd5201 | 115 | __module_param_call(MODULE_PARAM_PREFIX, \ |
9bbb9e5a | 116 | name, ops, arg, __same_type(*(arg), bool), perm) |
1da177e4 | 117 | |
9bbb9e5a RR |
118 | /* |
119 | * Helper functions: type is byte, short, ushort, int, uint, long, | |
120 | * ulong, charp, bool or invbool, or XXX if you define param_ops_XXX | |
121 | * and param_check_XXX. | |
122 | */ | |
1da177e4 LT |
123 | #define module_param_named(name, value, type, perm) \ |
124 | param_check_##type(name, &(value)); \ | |
9bbb9e5a | 125 | module_param_cb(name, ¶m_ops_##type, &value, perm); \ |
1da177e4 LT |
126 | __MODULE_PARM_TYPE(name, #type) |
127 | ||
128 | #define module_param(name, type, perm) \ | |
129 | module_param_named(name, name, type, perm) | |
130 | ||
67e67cea RR |
131 | #ifndef MODULE |
132 | /** | |
133 | * core_param - define a historical core kernel parameter. | |
134 | * @name: the name of the cmdline and sysfs parameter (often the same as var) | |
135 | * @var: the variable | |
136 | * @type: the type (for param_set_##type and param_get_##type) | |
137 | * @perm: visibility in sysfs | |
138 | * | |
139 | * core_param is just like module_param(), but cannot be modular and | |
140 | * doesn't add a prefix (such as "printk."). This is for compatibility | |
141 | * with __setup(), and it makes sense as truly core parameters aren't | |
142 | * tied to the particular file they're in. | |
143 | */ | |
144 | #define core_param(name, var, type, perm) \ | |
145 | param_check_##type(name, &(var)); \ | |
9bbb9e5a | 146 | __module_param_call("", name, ¶m_ops_##type, \ |
fddd5201 | 147 | &var, __same_type(var, bool), perm) |
67e67cea RR |
148 | #endif /* !MODULE */ |
149 | ||
1da177e4 LT |
150 | /* Actually copy string: maxlen param is usually sizeof(string). */ |
151 | #define module_param_string(name, string, len, perm) \ | |
22e48eaf | 152 | static const struct kparam_string __param_string_##name \ |
1da177e4 | 153 | = { len, string }; \ |
fddd5201 | 154 | __module_param_call(MODULE_PARAM_PREFIX, name, \ |
9bbb9e5a | 155 | ¶m_ops_string, \ |
fddd5201 | 156 | .str = &__param_string_##name, 0, perm); \ |
1da177e4 LT |
157 | __MODULE_PARM_TYPE(name, "string") |
158 | ||
159 | /* Called on module insert or kernel boot */ | |
160 | extern int parse_args(const char *name, | |
161 | char *args, | |
162 | struct kernel_param *params, | |
163 | unsigned num, | |
164 | int (*unknown)(char *param, char *val)); | |
165 | ||
e180a6b7 RR |
166 | /* Called by module remove. */ |
167 | #ifdef CONFIG_SYSFS | |
168 | extern void destroy_params(const struct kernel_param *params, unsigned num); | |
169 | #else | |
170 | static inline void destroy_params(const struct kernel_param *params, | |
171 | unsigned num) | |
172 | { | |
173 | } | |
174 | #endif /* !CONFIG_SYSFS */ | |
175 | ||
1da177e4 LT |
176 | /* All the helper functions */ |
177 | /* The macros to do compile-time type checking stolen from Jakub | |
178 | Jelinek, who IIRC came up with this idea for the 2.4 module init code. */ | |
179 | #define __param_check(name, p, type) \ | |
180 | static inline type *__check_##name(void) { return(p); } | |
181 | ||
9bbb9e5a RR |
182 | extern struct kernel_param_ops param_ops_byte; |
183 | extern int param_set_byte(const char *val, const struct kernel_param *kp); | |
184 | extern int param_get_byte(char *buffer, const struct kernel_param *kp); | |
1da177e4 LT |
185 | #define param_check_byte(name, p) __param_check(name, p, unsigned char) |
186 | ||
9bbb9e5a RR |
187 | extern struct kernel_param_ops param_ops_short; |
188 | extern int param_set_short(const char *val, const struct kernel_param *kp); | |
189 | extern int param_get_short(char *buffer, const struct kernel_param *kp); | |
1da177e4 LT |
190 | #define param_check_short(name, p) __param_check(name, p, short) |
191 | ||
9bbb9e5a RR |
192 | extern struct kernel_param_ops param_ops_ushort; |
193 | extern int param_set_ushort(const char *val, const struct kernel_param *kp); | |
194 | extern int param_get_ushort(char *buffer, const struct kernel_param *kp); | |
1da177e4 LT |
195 | #define param_check_ushort(name, p) __param_check(name, p, unsigned short) |
196 | ||
9bbb9e5a RR |
197 | extern struct kernel_param_ops param_ops_int; |
198 | extern int param_set_int(const char *val, const struct kernel_param *kp); | |
199 | extern int param_get_int(char *buffer, const struct kernel_param *kp); | |
1da177e4 LT |
200 | #define param_check_int(name, p) __param_check(name, p, int) |
201 | ||
9bbb9e5a RR |
202 | extern struct kernel_param_ops param_ops_uint; |
203 | extern int param_set_uint(const char *val, const struct kernel_param *kp); | |
204 | extern int param_get_uint(char *buffer, const struct kernel_param *kp); | |
1da177e4 LT |
205 | #define param_check_uint(name, p) __param_check(name, p, unsigned int) |
206 | ||
9bbb9e5a RR |
207 | extern struct kernel_param_ops param_ops_long; |
208 | extern int param_set_long(const char *val, const struct kernel_param *kp); | |
209 | extern int param_get_long(char *buffer, const struct kernel_param *kp); | |
1da177e4 LT |
210 | #define param_check_long(name, p) __param_check(name, p, long) |
211 | ||
9bbb9e5a RR |
212 | extern struct kernel_param_ops param_ops_ulong; |
213 | extern int param_set_ulong(const char *val, const struct kernel_param *kp); | |
214 | extern int param_get_ulong(char *buffer, const struct kernel_param *kp); | |
1da177e4 LT |
215 | #define param_check_ulong(name, p) __param_check(name, p, unsigned long) |
216 | ||
9bbb9e5a RR |
217 | extern struct kernel_param_ops param_ops_charp; |
218 | extern int param_set_charp(const char *val, const struct kernel_param *kp); | |
219 | extern int param_get_charp(char *buffer, const struct kernel_param *kp); | |
1da177e4 LT |
220 | #define param_check_charp(name, p) __param_check(name, p, char *) |
221 | ||
fddd5201 | 222 | /* For historical reasons "bool" parameters can be (unsigned) "int". */ |
9bbb9e5a RR |
223 | extern struct kernel_param_ops param_ops_bool; |
224 | extern int param_set_bool(const char *val, const struct kernel_param *kp); | |
225 | extern int param_get_bool(char *buffer, const struct kernel_param *kp); | |
fddd5201 RR |
226 | #define param_check_bool(name, p) \ |
227 | static inline void __check_##name(void) \ | |
228 | { \ | |
229 | BUILD_BUG_ON(!__same_type(*(p), bool) && \ | |
230 | !__same_type(*(p), unsigned int) && \ | |
231 | !__same_type(*(p), int)); \ | |
232 | } | |
1da177e4 | 233 | |
9bbb9e5a RR |
234 | extern struct kernel_param_ops param_ops_invbool; |
235 | extern int param_set_invbool(const char *val, const struct kernel_param *kp); | |
236 | extern int param_get_invbool(char *buffer, const struct kernel_param *kp); | |
9a71af2c | 237 | #define param_check_invbool(name, p) __param_check(name, p, bool) |
1da177e4 LT |
238 | |
239 | /* Comma-separated array: *nump is set to number they actually specified. */ | |
240 | #define module_param_array_named(name, array, type, nump, perm) \ | |
22e48eaf | 241 | static const struct kparam_array __param_arr_##name \ |
9bbb9e5a | 242 | = { ARRAY_SIZE(array), nump, ¶m_ops_##type, \ |
1da177e4 | 243 | sizeof(array[0]), array }; \ |
fddd5201 | 244 | __module_param_call(MODULE_PARAM_PREFIX, name, \ |
9bbb9e5a | 245 | ¶m_array_ops, \ |
fddd5201 RR |
246 | .arr = &__param_arr_##name, \ |
247 | __same_type(array[0], bool), perm); \ | |
1da177e4 LT |
248 | __MODULE_PARM_TYPE(name, "array of " #type) |
249 | ||
250 | #define module_param_array(name, type, nump, perm) \ | |
251 | module_param_array_named(name, name, type, nump, perm) | |
252 | ||
9bbb9e5a | 253 | extern struct kernel_param_ops param_array_ops; |
1da177e4 | 254 | |
9bbb9e5a RR |
255 | extern struct kernel_param_ops param_ops_string; |
256 | extern int param_set_copystring(const char *val, const struct kernel_param *); | |
257 | extern int param_get_string(char *buffer, const struct kernel_param *kp); | |
1da177e4 | 258 | |
1da177e4 LT |
259 | /* for exporting parameters in /sys/parameters */ |
260 | ||
261 | struct module; | |
262 | ||
ef665c1a | 263 | #if defined(CONFIG_SYSFS) && defined(CONFIG_MODULES) |
1da177e4 | 264 | extern int module_param_sysfs_setup(struct module *mod, |
9bbb9e5a | 265 | const struct kernel_param *kparam, |
1da177e4 LT |
266 | unsigned int num_params); |
267 | ||
268 | extern void module_param_sysfs_remove(struct module *mod); | |
ef665c1a RD |
269 | #else |
270 | static inline int module_param_sysfs_setup(struct module *mod, | |
9bbb9e5a | 271 | const struct kernel_param *kparam, |
ef665c1a RD |
272 | unsigned int num_params) |
273 | { | |
274 | return 0; | |
275 | } | |
276 | ||
277 | static inline void module_param_sysfs_remove(struct module *mod) | |
278 | { } | |
279 | #endif | |
1da177e4 LT |
280 | |
281 | #endif /* _LINUX_MODULE_PARAMS_H */ |