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