nan_ucfg_api.h 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. /*
  2. * Copyright (c) 2017-2019 The Linux Foundation. All rights reserved.
  3. *
  4. * Permission to use, copy, modify, and/or distribute this software for
  5. * any purpose with or without fee is hereby granted, provided that the
  6. * above copyright notice and this permission notice appear in all
  7. * copies.
  8. *
  9. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  10. * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  11. * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  12. * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  13. * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  14. * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  15. * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16. * PERFORMANCE OF THIS SOFTWARE.
  17. */
  18. /**
  19. * DOC: contains interface prototypes for OS_IF layer
  20. */
  21. #ifndef _NAN_UCFG_API_H_
  22. #define _NAN_UCFG_API_H_
  23. #include "wlan_objmgr_cmn.h"
  24. #include "nan_public_structs.h"
  25. #ifdef WLAN_FEATURE_NAN
  26. /**
  27. * ucfg_nan_set_ndi_state: set ndi state
  28. * @vdev: pointer to vdev object
  29. * @state: value to set
  30. *
  31. * Return: status of operation
  32. */
  33. QDF_STATUS ucfg_nan_set_ndi_state(struct wlan_objmgr_vdev *vdev,
  34. uint32_t state);
  35. /**
  36. * ucfg_nan_get_ndi_state: get ndi state from vdev obj
  37. * @vdev: pointer to vdev object
  38. *
  39. * Return: ndi state
  40. */
  41. enum nan_datapath_state ucfg_nan_get_ndi_state(struct wlan_objmgr_vdev *vdev);
  42. /**
  43. * ucfg_nan_set_active_peers: set active ndi peer
  44. * @vdev: pointer to vdev object
  45. * @val: value to set
  46. *
  47. * Return: status of operation
  48. */
  49. QDF_STATUS ucfg_nan_set_active_peers(struct wlan_objmgr_vdev *vdev,
  50. uint32_t val);
  51. /**
  52. * ucfg_nan_get_active_peers: get active ndi peer from vdev obj
  53. * @vdev: pointer to vdev object
  54. *
  55. * Return: active ndi peer
  56. */
  57. uint32_t ucfg_nan_get_active_peers(struct wlan_objmgr_vdev *vdev);
  58. /**
  59. * ucfg_nan_set_ndp_create_transaction_id: set ndp create transaction id
  60. * @vdev: pointer to vdev object
  61. * @val: value to set
  62. *
  63. * Return: status of operation
  64. */
  65. QDF_STATUS ucfg_nan_set_ndp_create_transaction_id(struct wlan_objmgr_vdev *vdev,
  66. uint16_t val);
  67. /**
  68. * ucfg_nan_get_ndp_create_transaction_id: get ndp create transaction id
  69. * vdev obj
  70. * @vdev: pointer to vdev object
  71. *
  72. * Return: ndp create transaction_id
  73. */
  74. uint16_t ucfg_nan_get_ndp_create_transaction_id(struct wlan_objmgr_vdev *vdev);
  75. /**
  76. * ucfg_nan_set_ndp_delete_transaction_id: set ndp delete transaction id
  77. * @vdev: pointer to vdev object
  78. * @val: value to set
  79. *
  80. * Return: status of operation
  81. */
  82. QDF_STATUS ucfg_nan_set_ndp_delete_transaction_id(struct wlan_objmgr_vdev *vdev,
  83. uint16_t val);
  84. /**
  85. * ucfg_nan_get_ndp_delete_transaction_id: get ndp delete transaction id from
  86. * vdev obj
  87. * @vdev: pointer to vdev object
  88. *
  89. * Return: ndp delete transaction_id
  90. */
  91. uint16_t ucfg_nan_get_ndp_delete_transaction_id(struct wlan_objmgr_vdev *vdev);
  92. /**
  93. * ucfg_nan_set_ndi_delete_rsp_reason: set ndi delete response reason
  94. * @vdev: pointer to vdev object
  95. * @val: value to set
  96. *
  97. * Return: status of operation
  98. */
  99. QDF_STATUS ucfg_nan_set_ndi_delete_rsp_reason(struct wlan_objmgr_vdev *vdev,
  100. uint32_t val);
  101. /**
  102. * ucfg_nan_get_ndi_delete_rsp_reason: get ndi delete response reason from vdev
  103. * obj
  104. * @vdev: pointer to vdev object
  105. *
  106. * Return: ndi delete rsp reason
  107. */
  108. uint32_t ucfg_nan_get_ndi_delete_rsp_reason(struct wlan_objmgr_vdev *vdev);
  109. /**
  110. * ucfg_nan_set_ndi_delete_rsp_status: set ndi delete response reason
  111. * @vdev: pointer to vdev object
  112. * @val: value to set
  113. *
  114. * Return: status of operation
  115. */
  116. QDF_STATUS ucfg_nan_set_ndi_delete_rsp_status(struct wlan_objmgr_vdev *vdev,
  117. uint32_t val);
  118. /**
  119. * ucfg_nan_get_ndi_delete_rsp_status: get ndi delete response status from vdev
  120. * obj
  121. * @vdev: pointer to vdev object
  122. *
  123. * Return: ndi delete rsp status
  124. */
  125. uint32_t ucfg_nan_get_ndi_delete_rsp_status(struct wlan_objmgr_vdev *vdev);
  126. /**
  127. * ucfg_nan_get_callbacks: ucfg API to return callbacks
  128. * @psoc: pointer to psoc object
  129. * @cb_obj: callback struct to populate
  130. *
  131. * Return: callback struct on success, NULL otherwise
  132. */
  133. QDF_STATUS ucfg_nan_get_callbacks(struct wlan_objmgr_psoc *psoc,
  134. struct nan_callbacks *cb_obj);
  135. /**
  136. * ucfg_nan_req_processor: ucfg API to be called from HDD/OS_IF to
  137. * process nan datapath initiator request from userspace
  138. * @vdev: nan vdev pointer
  139. * @in_req: NDP request
  140. * @psoc: pointer to psoc object
  141. * @req_type: type of request
  142. *
  143. * Return: status of operation
  144. */
  145. QDF_STATUS ucfg_nan_req_processor(struct wlan_objmgr_vdev *vdev,
  146. void *in_req, uint32_t req_type);
  147. /**
  148. * ucfg_nan_datapath_event_handler: ucfg API to be called from legacy code to
  149. * post events to os_if/hdd layer
  150. * @psoc: pointer to psoc object
  151. * @vdev: pointer to vdev object
  152. * @type: message type
  153. * @msg: msg buffer
  154. *
  155. * Return: None
  156. */
  157. void ucfg_nan_datapath_event_handler(struct wlan_objmgr_psoc *psoc,
  158. struct wlan_objmgr_vdev *vdev,
  159. uint32_t type, void *msg);
  160. /**
  161. * ucfg_nan_register_hdd_callbacks: ucfg API to set hdd callbacks
  162. * @psoc: pointer to psoc object
  163. * @cb_obj: structs containing callbacks
  164. * @os_if_event_handler: os if event handler callback
  165. *
  166. * Return: status of operation
  167. */
  168. int ucfg_nan_register_hdd_callbacks(struct wlan_objmgr_psoc *psoc,
  169. struct nan_callbacks *cb_obj);
  170. /*
  171. * ucfg_nan_register_lim_callbacks: ucfg API to set lim callbacks
  172. * @psoc: pointer to psoc object
  173. * @cb_obj: structs containing callbacks
  174. *
  175. * Return: status of operation
  176. */
  177. int ucfg_nan_register_lim_callbacks(struct wlan_objmgr_psoc *psoc,
  178. struct nan_callbacks *cb_obj);
  179. /**
  180. * ucfg_nan_get_callbacks: ucfg API to return callbacks
  181. * @psoc: pointer to psoc object
  182. * @cb_obj: callback struct to populate
  183. *
  184. * Return: callback struct on success, NULL otherwise
  185. */
  186. QDF_STATUS ucfg_nan_get_callbacks(struct wlan_objmgr_psoc *psoc,
  187. struct nan_callbacks *cb_obj);
  188. /**
  189. * ucfg_nan_discovery_req: ucfg API for NAN Discovery related requests
  190. * @in_req: NAN request
  191. * @req_type: Request type
  192. *
  193. * Return: status of operation
  194. */
  195. QDF_STATUS ucfg_nan_discovery_req(void *in_req, uint32_t req_type);
  196. /**
  197. * ucfg_is_nan_disable_supported() - ucfg API to query NAN Disable support
  198. * @psoc: pointer to psoc object
  199. *
  200. * This function returns NAN Disable support status
  201. *
  202. * Return: True if NAN Disable is supported, False otherwise
  203. */
  204. bool ucfg_is_nan_disable_supported(struct wlan_objmgr_psoc *psoc);
  205. /**
  206. * ucfg_is_nan_dbs_supported() - ucfg API to query NAN DBS support
  207. * @psoc: pointer to psoc object
  208. *
  209. * This function returns NAN DBS support status
  210. *
  211. * Return: True if NAN DBS is supported, False otherwise
  212. */
  213. bool ucfg_is_nan_dbs_supported(struct wlan_objmgr_psoc *psoc);
  214. /**
  215. * ucfg_is_ndi_dbs_supported() - ucfg API to query NAN Datapath DBS support
  216. * @psoc: pointer to psoc object
  217. *
  218. * This function returns NDI DBS support status
  219. *
  220. * Return: True if NDI DBS is supported, False otherwise
  221. */
  222. bool ucfg_is_ndi_dbs_supported(struct wlan_objmgr_psoc *psoc);
  223. /**
  224. * ucfg_is_nan_dbs_supported() - ucfg API to query NAN SAP support
  225. * @psoc: pointer to psoc object
  226. *
  227. * This function returns NAN SAP support status
  228. *
  229. * Return: True if NAN SAP is supported, False otherwise
  230. */
  231. bool ucfg_is_nan_sap_supported(struct wlan_objmgr_psoc *psoc);
  232. /**
  233. * ucfg_is_nan_enable_allowed() - ucfg API to query if NAN Discovery is
  234. * allowed
  235. * @psoc: pointer to psoc object
  236. * @nan_chan: NAN Discovery primary social channel
  237. *
  238. * Return: True if NAN Discovery enable is allowed, False otherwise
  239. */
  240. bool ucfg_is_nan_enable_allowed(struct wlan_objmgr_psoc *psoc,
  241. uint8_t nan_chan);
  242. /**
  243. * ucfg_nan_set_tgt_caps: ucfg API to set the NAN capabilities of the Target
  244. * @psoc: pointer to psoc object
  245. * @nan_caps: pointer to the structure of NAN capability bits
  246. *
  247. * Return: status of operation
  248. */
  249. void ucfg_nan_set_tgt_caps(struct wlan_objmgr_psoc *psoc,
  250. struct nan_tgt_caps *nan_caps);
  251. /**
  252. * ucfg_nan_disable_concurrency: ucfg API to explicitly disable NAN Discovery
  253. * @psoc: pointer to psoc object
  254. *
  255. * Return: None
  256. */
  257. void ucfg_nan_disable_concurrency(struct wlan_objmgr_psoc *psoc);
  258. /**
  259. * ucfg_nan_register_wma_callbacks: ucfg API to register WMA callbacks
  260. * @psoc: pointer to psoc object
  261. * @cb_obj: Pointer to NAN callback structure
  262. *
  263. * Return: status of operation
  264. */
  265. int ucfg_nan_register_wma_callbacks(struct wlan_objmgr_psoc *psoc,
  266. struct nan_callbacks *cb_obj);
  267. /**
  268. * ucfg_nan_check_and_disable_unsupported_ndi: ucfg API to check if NAN Datapath
  269. * is active on multiple NDI's and disable the unsupported concurrencies.
  270. * @psoc: pointer to psoc object
  271. *
  272. * Return: QDF_STATUS
  273. */
  274. QDF_STATUS
  275. ucfg_nan_check_and_disable_unsupported_ndi(struct wlan_objmgr_psoc *psoc);
  276. #else /* WLAN_FEATURE_NAN */
  277. static inline
  278. void ucfg_nan_set_tgt_caps(struct wlan_objmgr_psoc *psoc,
  279. struct nan_tgt_caps *nan_caps)
  280. {
  281. }
  282. static inline void ucfg_nan_disable_concurrency(struct wlan_objmgr_psoc *psoc)
  283. {
  284. }
  285. static inline QDF_STATUS
  286. ucfg_nan_check_and_disable_unsupported_ndi(struct wlan_objmgr_psoc *psoc)
  287. {
  288. return QDF_STATUS_SUCCESS;
  289. }
  290. #endif /* WLAN_FEATURE_NAN */
  291. #endif /* _NAN_UCFG_API_H_ */