moduleparam.h revision 1.11 1 1.11 riastrad /* $NetBSD: moduleparam.h,v 1.11 2021/12/19 12:01:48 riastradh Exp $ */
2 1.2 riastrad
3 1.2 riastrad /*-
4 1.2 riastrad * Copyright (c) 2013 The NetBSD Foundation, Inc.
5 1.2 riastrad * All rights reserved.
6 1.2 riastrad *
7 1.2 riastrad * This code is derived from software contributed to The NetBSD Foundation
8 1.2 riastrad * by Taylor R. Campbell.
9 1.2 riastrad *
10 1.2 riastrad * Redistribution and use in source and binary forms, with or without
11 1.2 riastrad * modification, are permitted provided that the following conditions
12 1.2 riastrad * are met:
13 1.2 riastrad * 1. Redistributions of source code must retain the above copyright
14 1.2 riastrad * notice, this list of conditions and the following disclaimer.
15 1.2 riastrad * 2. Redistributions in binary form must reproduce the above copyright
16 1.2 riastrad * notice, this list of conditions and the following disclaimer in the
17 1.2 riastrad * documentation and/or other materials provided with the distribution.
18 1.2 riastrad *
19 1.2 riastrad * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.2 riastrad * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.2 riastrad * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.2 riastrad * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.2 riastrad * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.2 riastrad * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.2 riastrad * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.2 riastrad * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.2 riastrad * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.2 riastrad * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.2 riastrad * POSSIBILITY OF SUCH DAMAGE.
30 1.2 riastrad */
31 1.2 riastrad
32 1.2 riastrad #ifndef _LINUX_MODULEPARAM_H_
33 1.2 riastrad #define _LINUX_MODULEPARAM_H_
34 1.2 riastrad
35 1.3 christos #include <sys/types.h>
36 1.3 christos
37 1.3 christos struct linux_module_param_info {
38 1.4 christos const char *dname; // Name used for description
39 1.4 christos const char *name; // Name for sysctl
40 1.4 christos void *ptr; // Pointer to variable value
41 1.4 christos int type; // MTYPE_
42 1.4 christos mode_t mode; // 600 (rw) or 400 (r)
43 1.3 christos };
44 1.3 christos
45 1.3 christos #define MTYPE_int 0
46 1.3 christos #define MTYPE_bool 1
47 1.5 riastrad #define MTYPE_charp 2
48 1.8 riastrad #define MTYPE_uint 3
49 1.3 christos
50 1.9 riastrad /*
51 1.9 riastrad * In case of accidental cpp expansion, break glass to raise alarm and
52 1.9 riastrad * reach antizombie chainsaw.
53 1.9 riastrad */
54 1.9 riastrad #define MTYPE__Bool MTYPE_bool
55 1.9 riastrad
56 1.3 christos #define module_param_named(NAME, VAR, TYPE, MODE) \
57 1.3 christos static __attribute__((__used__)) struct linux_module_param_info info_ ## NAME = { \
58 1.4 christos .dname = # NAME, \
59 1.3 christos .name = # VAR, \
60 1.3 christos .ptr = & VAR, \
61 1.3 christos .type = MTYPE_ ## TYPE, \
62 1.3 christos .mode = MODE, \
63 1.3 christos }; \
64 1.3 christos __link_set_add_data(linux_module_param_info, info_ ## NAME)
65 1.2 riastrad
66 1.6 riastrad #define module_param(VAR, TYPE, MODE) module_param_named(VAR, VAR, TYPE, MODE)
67 1.6 riastrad #define module_param_unsafe module_param
68 1.7 riastrad #define module_param_named_unsafe module_param_named
69 1.11 riastrad #define module_param_string(VAR, TYPE, SIZE, MODE) \
70 1.11 riastrad CTASSERT(1) /* XXX */
71 1.6 riastrad
72 1.10 riastrad struct linux_module_param_desc {
73 1.10 riastrad const char *name;
74 1.10 riastrad const char *description;
75 1.10 riastrad };
76 1.10 riastrad #define MODULE_PARM_DESC(PARAMETER, DESCRIPTION) \
77 1.10 riastrad static __attribute__((__used__)) \
78 1.10 riastrad const struct linux_module_param_desc PARAMETER ## _desc = { \
79 1.10 riastrad .name = # PARAMETER, \
80 1.10 riastrad .description = DESCRIPTION, \
81 1.10 riastrad }; \
82 1.10 riastrad __link_set_add_rodata(linux_module_param_desc, PARAMETER ## _desc)
83 1.10 riastrad
84 1.10 riastrad
85 1.2 riastrad #endif /* _LINUX_MODULEPARAM_H_ */
86