1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2014-2017 The Linux Foundation. All rights reserved. 3*5113495bSYour Name * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved. 4*5113495bSYour Name * 5*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for 6*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the 7*5113495bSYour Name * above copyright notice and this permission notice appear in all 8*5113495bSYour Name * copies. 9*5113495bSYour Name * 10*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 11*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 12*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 13*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 14*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 15*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 16*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE. 18*5113495bSYour Name */ 19*5113495bSYour Name 20*5113495bSYour Name /** 21*5113495bSYour Name * DOC: qdf_module.h 22*5113495bSYour Name * This file abstracts "kernel module" semantics. 23*5113495bSYour Name */ 24*5113495bSYour Name 25*5113495bSYour Name #ifndef _QDF_MODULE_H 26*5113495bSYour Name #define _QDF_MODULE_H 27*5113495bSYour Name 28*5113495bSYour Name #include <i_qdf_module.h> 29*5113495bSYour Name 30*5113495bSYour Name typedef uint32_t (*module_init_func_t)(void); 31*5113495bSYour Name 32*5113495bSYour Name /** 33*5113495bSYour Name * qdf_virt_module_init - Specify the module's entry point. 34*5113495bSYour Name * @_mod_init_func: module entry function 35*5113495bSYour Name */ 36*5113495bSYour Name #define qdf_virt_module_init(_mod_init_func) \ 37*5113495bSYour Name __qdf_virt_module_init(_mod_init_func) 38*5113495bSYour Name 39*5113495bSYour Name /** 40*5113495bSYour Name * qdf_virt_module_exit() - Specify the module's exit point. 41*5113495bSYour Name * @_mod_exit_func: module exit function 42*5113495bSYour Name */ 43*5113495bSYour Name #define qdf_virt_module_exit(_mod_exit_func) \ 44*5113495bSYour Name __qdf_virt_module_exit(_mod_exit_func) 45*5113495bSYour Name 46*5113495bSYour Name /** 47*5113495bSYour Name * qdf_virt_module_name() - Specify the module's name. 48*5113495bSYour Name * @_name: module name 49*5113495bSYour Name */ 50*5113495bSYour Name #define qdf_virt_module_name(_name) __qdf_virt_module_name(_name) 51*5113495bSYour Name 52*5113495bSYour Name 53*5113495bSYour Name /** 54*5113495bSYour Name * qdf_export_symbol() - Export a symbol from a module. 55*5113495bSYour Name * @_sym: symbol to export 56*5113495bSYour Name */ 57*5113495bSYour Name #define qdf_export_symbol(_sym) __qdf_export_symbol(_sym) 58*5113495bSYour Name 59*5113495bSYour Name /** 60*5113495bSYour Name * qdf_declare_param() - Declare a module parameter. 61*5113495bSYour Name * @name: name of the parameter 62*5113495bSYour Name * @_type: type of the parameter 63*5113495bSYour Name */ 64*5113495bSYour Name #define qdf_declare_param(name, _type) __qdf_declare_param(name, _type) 65*5113495bSYour Name 66*5113495bSYour Name /** 67*5113495bSYour Name * qdf_declare_param_array() - Declare a module parameter that is an array 68*5113495bSYour Name * @name: name of the array 69*5113495bSYour Name * @_type: type of the array element 70*5113495bSYour Name * @_num: number of entries written 71*5113495bSYour Name */ 72*5113495bSYour Name #define qdf_declare_param_array(name, _type, _num) \ 73*5113495bSYour Name __qdf_declare_param_array(name, _type, _num) 74*5113495bSYour Name 75*5113495bSYour Name #endif /*_QDF_MODULE_H*/ 76