xref: /wlan-driver/qca-wifi-host-cmn/qdf/linux/src/i_qdf_module.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2014-2018 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name /**
20*5113495bSYour Name  * DOC: i_qdf_module.h
21*5113495bSYour Name  * Linux-specific definitions for QDF module API's
22*5113495bSYour Name  */
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _I_QDF_MODULE_H
25*5113495bSYour Name #define _I_QDF_MODULE_H
26*5113495bSYour Name 
27*5113495bSYour Name #include <linux/version.h>
28*5113495bSYour Name #include <linux/module.h>
29*5113495bSYour Name #include <linux/moduleparam.h>
30*5113495bSYour Name #include <qdf_types.h>
31*5113495bSYour Name 
32*5113495bSYour Name 
33*5113495bSYour Name #define __qdf_virt_module_init(_x)  \
34*5113495bSYour Name 	static int _x##_mod(void) \
35*5113495bSYour Name 	{                   \
36*5113495bSYour Name 		uint32_t st;  \
37*5113495bSYour Name 		st = (_x)();         \
38*5113495bSYour Name 		if (st != QDF_STATUS_SUCCESS)  \
39*5113495bSYour Name 			return QDF_STATUS_E_INVAL;            \
40*5113495bSYour Name 		else                    \
41*5113495bSYour Name 			return 0;             \
42*5113495bSYour Name 	}                           \
43*5113495bSYour Name 	module_init(_x##_mod);
44*5113495bSYour Name 
45*5113495bSYour Name #define __qdf_virt_module_exit(_x)  module_exit(_x)
46*5113495bSYour Name 
47*5113495bSYour Name #define __qdf_virt_module_name(_name) MODULE_LICENSE("Dual BSD/GPL")
48*5113495bSYour Name 
49*5113495bSYour Name #ifdef WLAN_DISABLE_EXPORT_SYMBOL
50*5113495bSYour Name #define __qdf_export_symbol(_sym)
51*5113495bSYour Name #else
52*5113495bSYour Name #define __qdf_export_symbol(_sym) EXPORT_SYMBOL(_sym)
53*5113495bSYour Name #endif
54*5113495bSYour Name 
55*5113495bSYour Name #define __qdf_declare_param(_name, _type) \
56*5113495bSYour Name 	module_param(_name, _type, 0600)
57*5113495bSYour Name 
58*5113495bSYour Name #define __qdf_declare_param_array(_name, _type, _num) \
59*5113495bSYour Name 	module_param_array(_name, _type, _num, 0600)
60*5113495bSYour Name 
61*5113495bSYour Name #endif /* _I_QDF_MODULE_H */
62