source: GPL/include/linux/moduleparam.h@ 1

Last change on this file since 1 was 1, checked in by vladest, 20 years ago

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