nan_ucfg_api.h 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. /*
  2. * Copyright (c) 2017-2018 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_active_ndp_sessions: set active ndp sessions
  60. * @vdev: pointer to vdev object
  61. *
  62. * Return: status of operation
  63. */
  64. QDF_STATUS ucfg_nan_set_active_ndp_sessions(struct wlan_objmgr_vdev *vdev,
  65. uint32_t val, uint8_t idx);
  66. /**
  67. * ucfg_nan_get_active_ndp_sessions: get active ndp sessions from vdev obj
  68. * @vdev: pointer to vdev object
  69. *
  70. * Return: pointer to NAN psoc private object
  71. */
  72. uint32_t ucfg_nan_get_active_ndp_sessions(struct wlan_objmgr_vdev *vdev,
  73. uint8_t idx);
  74. /**
  75. * ucfg_nan_set_ndp_create_transaction_id: set ndp create transaction id
  76. * @vdev: pointer to vdev object
  77. * @val: value to set
  78. *
  79. * Return: status of operation
  80. */
  81. QDF_STATUS ucfg_nan_set_ndp_create_transaction_id(struct wlan_objmgr_vdev *vdev,
  82. uint16_t val);
  83. /**
  84. * ucfg_nan_get_ndp_create_transaction_id: get ndp create transaction id
  85. * vdev obj
  86. * @vdev: pointer to vdev object
  87. *
  88. * Return: ndp create transaction_id
  89. */
  90. uint16_t ucfg_nan_get_ndp_create_transaction_id(struct wlan_objmgr_vdev *vdev);
  91. /**
  92. * ucfg_nan_set_ndp_delete_transaction_id: set ndp delete transaction id
  93. * @vdev: pointer to vdev object
  94. * @val: value to set
  95. *
  96. * Return: status of operation
  97. */
  98. QDF_STATUS ucfg_nan_set_ndp_delete_transaction_id(struct wlan_objmgr_vdev *vdev,
  99. uint16_t val);
  100. /**
  101. * ucfg_nan_get_ndp_delete_transaction_id: get ndp delete transaction id from
  102. * vdev obj
  103. * @vdev: pointer to vdev object
  104. *
  105. * Return: ndp delete transaction_id
  106. */
  107. uint16_t ucfg_nan_get_ndp_delete_transaction_id(struct wlan_objmgr_vdev *vdev);
  108. /**
  109. * ucfg_nan_set_ndi_delete_rsp_reason: set ndi delete response reason
  110. * @vdev: pointer to vdev object
  111. * @val: value to set
  112. *
  113. * Return: status of operation
  114. */
  115. QDF_STATUS ucfg_nan_set_ndi_delete_rsp_reason(struct wlan_objmgr_vdev *vdev,
  116. uint32_t val);
  117. /**
  118. * ucfg_nan_get_ndi_delete_rsp_reason: get ndi delete response reason from vdev
  119. * obj
  120. * @vdev: pointer to vdev object
  121. *
  122. * Return: ndi delete rsp reason
  123. */
  124. uint32_t ucfg_nan_get_ndi_delete_rsp_reason(struct wlan_objmgr_vdev *vdev);
  125. /**
  126. * ucfg_nan_set_ndi_delete_rsp_status: set ndi delete response reason
  127. * @vdev: pointer to vdev object
  128. * @val: value to set
  129. *
  130. * Return: status of operation
  131. */
  132. QDF_STATUS ucfg_nan_set_ndi_delete_rsp_status(struct wlan_objmgr_vdev *vdev,
  133. uint32_t val);
  134. /**
  135. * ucfg_nan_get_ndi_delete_rsp_status: get ndi delete response status from vdev
  136. * obj
  137. * @vdev: pointer to vdev object
  138. *
  139. * Return: ndi delete rsp status
  140. */
  141. uint32_t ucfg_nan_get_ndi_delete_rsp_status(struct wlan_objmgr_vdev *vdev);
  142. /**
  143. * ucfg_nan_get_callbacks: ucfg API to return callbacks
  144. * @psoc: pointer to psoc object
  145. * @cb_obj: callback struct to populate
  146. *
  147. * Return: callback struct on success, NULL otherwise
  148. */
  149. QDF_STATUS ucfg_nan_get_callbacks(struct wlan_objmgr_psoc *psoc,
  150. struct nan_callbacks *cb_obj);
  151. /**
  152. * ucfg_nan_req_processor: ucfg API to be called from HDD/OS_IF to
  153. * process nan datapath initiator request from userspace
  154. * @vdev: nan vdev pointer
  155. * @in_req: NDP request
  156. * @psoc: pointer to psoc object
  157. * @req_type: type of request
  158. *
  159. * Return: status of operation
  160. */
  161. QDF_STATUS ucfg_nan_req_processor(struct wlan_objmgr_vdev *vdev,
  162. void *in_req, uint32_t req_type);
  163. /**
  164. * ucfg_nan_event_handler: ucfg API to be called from legacy code to
  165. * post events to os_if/hdd layer
  166. * @psoc: pointer to psoc object
  167. * @vdev: pointer to vdev object
  168. * @type: message type
  169. * @msg: msg buffer
  170. *
  171. * Return: None
  172. */
  173. void ucfg_nan_event_handler(struct wlan_objmgr_psoc *psoc,
  174. struct wlan_objmgr_vdev *vdev,
  175. uint32_t type, void *msg);
  176. /**
  177. * ucfg_nan_register_hdd_callbacks: ucfg API to set hdd callbacks
  178. * @psoc: pointer to psoc object
  179. * @cb_obj: structs containing callbacks
  180. * @os_if_event_handler: os if event handler callback
  181. *
  182. * Return: status of operation
  183. */
  184. int ucfg_nan_register_hdd_callbacks(struct wlan_objmgr_psoc *,
  185. struct nan_callbacks *,
  186. void (os_if_event_handler)
  187. (struct wlan_objmgr_psoc *,
  188. struct wlan_objmgr_vdev *,
  189. uint32_t, void *));
  190. /*
  191. * ucfg_nan_register_lim_callbacks: ucfg API to set lim callbacks
  192. * @psoc: pointer to psoc object
  193. * @cb_obj: structs containing callbacks
  194. *
  195. * Return: status of operation
  196. */
  197. int ucfg_nan_register_lim_callbacks(struct wlan_objmgr_psoc *psoc,
  198. struct nan_callbacks *cb_obj);
  199. /**
  200. * ucfg_nan_get_callbacks: ucfg API to return callbacks
  201. * @psoc: pointer to psoc object
  202. * @cb_obj: callback struct to populate
  203. *
  204. * Return: callback struct on success, NULL otherwise
  205. */
  206. QDF_STATUS ucfg_nan_get_callbacks(struct wlan_objmgr_psoc *psoc,
  207. struct nan_callbacks *cb_obj);
  208. /**
  209. * ucfg_nan_discovery_req: ucfg API for NAN Discovery related requests
  210. * @in_req: NAN request
  211. * @req_type: Request type
  212. *
  213. * Return: status of operation
  214. */
  215. static inline QDF_STATUS ucfg_nan_discovery_req(void *in_req, uint32_t req_type)
  216. {
  217. return QDF_STATUS_SUCCESS;
  218. }
  219. /**
  220. * ucfg_is_nan_dbs_supported() - ucfg API to query NAN DBS support
  221. * @psoc: pointer to psoc object
  222. *
  223. * This function returns NAN DBS support status
  224. *
  225. * Return: True if NAN DBS is supported, False otherwise
  226. */
  227. bool ucfg_is_nan_dbs_supported(struct wlan_objmgr_psoc *psoc);
  228. /**
  229. * ucfg_is_nan_enable_allowed() - ucfg API to query if NAN Discovery is
  230. * allowed
  231. * @psoc: pointer to psoc object
  232. *
  233. * Return: True if NAN Discovery enable is allowed, False otherwise
  234. */
  235. static inline bool ucfg_is_nan_enable_allowed(struct wlan_objmgr_psoc *psoc)
  236. {
  237. return true;
  238. }
  239. /**
  240. * ucfg_nan_set_tgt_caps: ucfg API to set the NAN capabilities of the Target
  241. * @psoc: pointer to psoc object
  242. * @nan_caps: pointer to the structure of NAN capability bits
  243. *
  244. * Return: status of operation
  245. */
  246. void ucfg_nan_set_tgt_caps(struct wlan_objmgr_psoc *psoc,
  247. struct nan_tgt_caps *nan_caps);
  248. #else /* WLAN_FEATURE_NAN */
  249. static inline
  250. void ucfg_nan_set_tgt_caps(struct wlan_objmgr_psoc *psoc,
  251. struct nan_tgt_caps *nan_caps)
  252. {
  253. }
  254. #endif /* WLAN_FEATURE_NAN */
  255. #endif /* _NAN_UCFG_API_H_ */