xref: /freebsd/sys/compat/linuxkpi/common/include/linux/module.h (revision 5956d97f4b3204318ceb6aa9c77bd0bc6ea87a41)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 #ifndef	_LINUXKPI_LINUX_MODULE_H_
32 #define	_LINUXKPI_LINUX_MODULE_H_
33 
34 #include <sys/cdefs.h>
35 #include <sys/types.h>
36 #include <sys/param.h>
37 #include <sys/module.h>
38 
39 #include <linux/list.h>
40 #include <linux/compiler.h>
41 #include <linux/stringify.h>
42 #include <linux/kmod.h>
43 #include <linux/kobject.h>
44 #include <linux/sysfs.h>
45 #include <linux/moduleparam.h>
46 #include <linux/slab.h>
47 #include <linux/export.h>
48 
49 #define MODULE_AUTHOR(name)
50 #define MODULE_DESCRIPTION(name)
51 #define MODULE_LICENSE(name)
52 #define	MODULE_INFO(tag, info)
53 #define	MODULE_FIRMWARE(firmware)
54 #define	MODULE_SUPPORTED_DEVICE(name)
55 #define	MODULE_IMPORT_NS(_name)
56 
57 #define	THIS_MODULE	((struct module *)0)
58 
59 #define	__MODULE_STRING(x) __stringify(x)
60 
61 /* OFED pre-module initialization */
62 #define	SI_SUB_OFED_PREINIT	(SI_SUB_ROOT_CONF - 2)
63 /* OFED default module initialization */
64 #define	SI_SUB_OFED_MODINIT	(SI_SUB_ROOT_CONF - 1)
65 
66 #include <sys/linker.h>
67 
68 static inline void
69 _module_run(void *arg)
70 {
71 	void (*fn)(void);
72 #ifdef OFED_DEBUG_INIT
73 	char name[1024];
74 	caddr_t pc;
75 	long offset;
76 
77 	pc = (caddr_t)arg;
78 	if (linker_search_symbol_name(pc, name, sizeof(name), &offset) != 0)
79 		printf("Running ??? (%p)\n", pc);
80 	else
81 		printf("Running %s (%p)\n", name, pc);
82 #endif
83 	fn = arg;
84 	fn();
85 }
86 
87 #define	module_init(fn)							\
88 	SYSINIT(fn, SI_SUB_OFED_MODINIT, SI_ORDER_FIRST, _module_run, (fn))
89 
90 #define	module_exit(fn)						\
91 	SYSUNINIT(fn, SI_SUB_OFED_MODINIT, SI_ORDER_SECOND, _module_run, (fn))
92 
93 /*
94  * The following two macros are a workaround for not having a module
95  * load and unload order resolver:
96  */
97 #define	module_init_order(fn, order)					\
98 	SYSINIT(fn, SI_SUB_OFED_MODINIT, (order), _module_run, (fn))
99 
100 #define	module_exit_order(fn, order)				\
101 	SYSUNINIT(fn, SI_SUB_OFED_MODINIT, (order), _module_run, (fn))
102 
103 #define	module_get(module)
104 #define	module_put(module)
105 #define	try_module_get(module)	1
106 
107 #define	postcore_initcall(fn)	module_init(fn)
108 
109 #endif	/* _LINUXKPI_LINUX_MODULE_H_ */
110