target_if_pmo.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471
  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: Declare various api/struct which shall be used
  20. * by pmo component for wmi cmd (tx path) and
  21. * event (rx) handling.
  22. */
  23. #ifndef _TARGET_IF_PMO_H_
  24. #define _TARGET_IF_PMO_H_
  25. #include "target_if.h"
  26. #include "wlan_pmo_tgt_api.h"
  27. #include "wlan_pmo_obj_mgmt_public_struct.h"
  28. /**
  29. * target_if_pmo_enable_wow_wakeup_event() - Enable wow wakeup events.
  30. * @vdev:objmgr vdev handle
  31. * @bitmap: Event bitmap
  32. * @enable: enable/disable
  33. *
  34. * Return: QDF status
  35. */
  36. QDF_STATUS target_if_pmo_enable_wow_wakeup_event(struct wlan_objmgr_vdev *vdev,
  37. uint32_t *bitmap);
  38. /**
  39. * target_if_pmo_disable_wow_wakeup_event() - Disable wow wakeup events.
  40. * @vdev:objmgr vdev handle
  41. * @bitmap: Event bitmap
  42. * @enable: enable/disable
  43. *
  44. * Return: QDF status
  45. */
  46. QDF_STATUS target_if_pmo_disable_wow_wakeup_event(
  47. struct wlan_objmgr_vdev *vdev, uint32_t *bitmap);
  48. /**
  49. * target_if_pmo_send_wow_patterns_to_fw() - Sends WOW patterns to FW.
  50. * @vdev: objmgr vdev handle
  51. * @ptrn_id: pattern id
  52. * @ptrn: pattern
  53. * @ptrn_len: pattern length
  54. * @ptrn_offset: pattern offset
  55. * @mask: mask
  56. * @mask_len: mask length
  57. * @user: true for user configured pattern and false for default pattern
  58. *
  59. * Return: QDF status
  60. */
  61. QDF_STATUS target_if_pmo_send_wow_patterns_to_fw(struct wlan_objmgr_vdev *vdev,
  62. uint8_t ptrn_id,
  63. const uint8_t *ptrn, uint8_t ptrn_len,
  64. uint8_t ptrn_offset, const uint8_t *mask,
  65. uint8_t mask_len, bool user);
  66. QDF_STATUS target_if_pmo_del_wow_patterns_to_fw(struct wlan_objmgr_vdev *vdev,
  67. uint8_t ptrn_id);
  68. /**
  69. * target_if_pmo_send_enhance_mc_offload_req() - send enhance mc offload req
  70. * @vdev: objmgr vdev
  71. * @action: enable or disable enhance multicast offload
  72. *
  73. * Return: QDF_STATUS_SUCCESS on success else error code
  74. */
  75. QDF_STATUS target_if_pmo_send_enhance_mc_offload_req(
  76. struct wlan_objmgr_vdev *vdev,
  77. bool enable);
  78. /**
  79. * target_if_pmo_set_mc_filter_req() - set mcast filter command to fw
  80. * @vdev: objmgr vdev handle
  81. * @multicastAddr: mcast address
  82. *
  83. * Return: 0 for success or error code
  84. */
  85. QDF_STATUS target_if_pmo_set_mc_filter_req(struct wlan_objmgr_vdev *vdev,
  86. struct qdf_mac_addr multicast_addr);
  87. /**
  88. * target_if_pmo_clear_mc_filter_req() - clear mcast filter command to fw
  89. * @vdev: objmgr vdev handle
  90. * @multicastAddr: mcast address
  91. *
  92. * Return: 0 for success or error code
  93. */
  94. QDF_STATUS target_if_pmo_clear_mc_filter_req(struct wlan_objmgr_vdev *vdev,
  95. struct qdf_mac_addr multicast_addr);
  96. /**
  97. * target_if_pmo_get_multiple_mc_filter_support() - get multiple mc filter
  98. * request fw support
  99. * @psoc: the psoc containing the vdev to configure
  100. *
  101. * Return: true if fw supports else false
  102. */
  103. bool target_if_pmo_get_multiple_mc_filter_support(
  104. struct wlan_objmgr_psoc *psoc);
  105. /**
  106. * target_if_pmo_set_multiple_mc_filter_req() - set multiple mcast filter
  107. * command to fw
  108. * @vdev: objmgr vdev handle
  109. * @multicastAddr: mcast address
  110. *
  111. * Return: 0 for success or error code
  112. */
  113. QDF_STATUS target_if_pmo_set_multiple_mc_filter_req(
  114. struct wlan_objmgr_vdev *vdev,
  115. struct pmo_mc_addr_list *mc_list);
  116. /**
  117. * target_if_pmo_clear_multiple_mc_filter_req() - clear multiple mcast
  118. * filter command to fw
  119. * @vdev: objmgr vdev handle
  120. * @multicastAddr: mcast address
  121. *
  122. * Return: 0 for success or error code
  123. */
  124. QDF_STATUS target_if_pmo_clear_multiple_mc_filter_req(
  125. struct wlan_objmgr_vdev *vdev,
  126. struct pmo_mc_addr_list *mc_list);
  127. /**
  128. * target_if_pmo_send_ra_filter_req() - set RA filter pattern in fw
  129. * @vdev: objmgr vdev handle
  130. * @default_pattern: default pattern id
  131. * @rate_limit_interval: ra rate limit interval
  132. *
  133. * Return: QDF status
  134. */
  135. QDF_STATUS target_if_pmo_send_ra_filter_req(struct wlan_objmgr_vdev *vdev,
  136. uint8_t default_pattern, uint16_t rate_limit_interval);
  137. /**
  138. * target_if_pmo_send_action_frame_patterns() - register action frame map to fw
  139. * @handle: Pointer to wma handle
  140. * @vdev_id: VDEV ID
  141. *
  142. * This is called to push action frames wow patterns from local
  143. * cache to firmware.
  144. *
  145. * Return: QDF_STATUS
  146. */
  147. QDF_STATUS target_if_pmo_send_action_frame_patterns(
  148. struct wlan_objmgr_vdev *vdev,
  149. struct pmo_action_wakeup_set_params *ip_cmd);
  150. /**
  151. * target_if_pmo_conf_hw_filter() - configure hardware filter in DTIM mode
  152. * @psoc: the psoc containing the vdev to configure
  153. * @req: the request parameters
  154. *
  155. * Return: QDF_STATUS
  156. */
  157. QDF_STATUS target_if_pmo_conf_hw_filter(struct wlan_objmgr_psoc *psoc,
  158. struct pmo_hw_filter_params *req);
  159. /**
  160. * target_if_pmo_send_pkt_filter_req() - enable packet filter
  161. * @vdev: objmgr vdev
  162. * @rcv_filter_param: filter params
  163. *
  164. * This function enable packet filter
  165. *
  166. * Return: QDF_STATUS_SUCCESS for success or error code
  167. */
  168. QDF_STATUS target_if_pmo_send_pkt_filter_req(struct wlan_objmgr_vdev *vdev,
  169. struct pmo_rcv_pkt_fltr_cfg *rcv_filter_param);
  170. /**
  171. * target_if_pmo_clear_pkt_filter_req() - disable packet filter
  172. * @vdev: objmgr vdev
  173. * @rcv_clear_param: filter params
  174. *
  175. * This function disable packet filter
  176. *
  177. * Return: QDF_STATUS_SUCCESS for success or error code
  178. */
  179. QDF_STATUS target_if_pmo_clear_pkt_filter_req(struct wlan_objmgr_vdev *vdev,
  180. struct pmo_rcv_pkt_fltr_clear_param *rcv_clear_param);
  181. /**
  182. * target_if_pmo_send_arp_offload_req() - sends arp request to fwr
  183. * @vdev: objmgr vdev
  184. * @arp_offload_req: arp offload req
  185. * @ns_offload_req: ns offload request
  186. *
  187. * This functions sends arp request to fwr.
  188. *
  189. * Return: QDF_STATUS_SUCCESS for success or error code
  190. */
  191. QDF_STATUS target_if_pmo_send_arp_offload_req(
  192. struct wlan_objmgr_vdev *vdev,
  193. struct pmo_arp_offload_params *arp_offload_req,
  194. struct pmo_ns_offload_params *ns_offload_req);
  195. #ifdef WLAN_NS_OFFLOAD
  196. /**
  197. * target_if_pmo_send_ns_offload_req() - sends ns request to fwr
  198. * @vdev: objmgr vdev
  199. * @arp_offload_req: arp offload req
  200. * @ns_offload_req: ns offload request
  201. *
  202. * This functions sends ns request to fwr.
  203. *
  204. * Return: QDF_STATUS_SUCCESS for success or error code
  205. */
  206. QDF_STATUS target_if_pmo_send_ns_offload_req(
  207. struct wlan_objmgr_vdev *vdev,
  208. struct pmo_arp_offload_params *arp_offload_req,
  209. struct pmo_ns_offload_params *ns_offload_req);
  210. #else /* WLAN_NS_OFFLOAD */
  211. static inline QDF_STATUS
  212. target_if_pmo_send_ns_offload_req(struct wlan_objmgr_vdev *vdev,
  213. struct pmo_arp_offload_params *arp_offload_req,
  214. struct pmo_ns_offload_params *ns_offload_req)
  215. {
  216. return QDF_STATUS_SUCCESS;
  217. }
  218. #endif /* WLAN_NS_OFFLOAD */
  219. /**
  220. * target_if_pmo_send_gtk_offload_req() - send gtk offload request in fwr
  221. * @vdev: objmgr vdev handle
  222. * @gtk_offload_req: gtk offload request
  223. *
  224. * Return: QDF status
  225. */
  226. QDF_STATUS target_if_pmo_send_gtk_offload_req(struct wlan_objmgr_vdev *vdev,
  227. struct pmo_gtk_req *gtk_offload_req);
  228. /**
  229. * target_if_pmo_send_gtk_response_req() - send gtk response request in fwr
  230. * @vdev: objmgr vdev handle
  231. *
  232. * Return: QDF status
  233. */
  234. QDF_STATUS target_if_pmo_send_gtk_response_req(struct wlan_objmgr_vdev *vdev);
  235. /**
  236. * target_if_pmo_gtk_offload_status_event() - GTK offload status event handler
  237. * @scn_handle: scn handle
  238. * @event: event buffer
  239. * @len: buffer length
  240. *
  241. * Return: 0 for success or error code
  242. */
  243. int target_if_pmo_gtk_offload_status_event(void *scn_handle,
  244. uint8_t *event, uint32_t len);
  245. /**
  246. * target_if_pmo_send_lphb_enable() - enable command of LPHB config req
  247. * @psoc: objmgr psoc handle
  248. * @ts_lphb_enable: lphb enable request which needs to configure in fwr
  249. *
  250. * Return: QDF status
  251. */
  252. QDF_STATUS target_if_pmo_send_lphb_enable(struct wlan_objmgr_psoc *psoc,
  253. struct pmo_lphb_enable_req *ts_lphb_enable);
  254. /**
  255. * target_if_pmo_send_lphb_tcp_params() - set lphb tcp params config request
  256. * @psoc: objmgr psoc handle
  257. * @ts_lphb_tcp_param: lphb tcp params which needs to configure in fwr
  258. *
  259. * Return: QDF status
  260. */
  261. QDF_STATUS target_if_pmo_send_lphb_tcp_params(struct wlan_objmgr_psoc *psoc,
  262. struct pmo_lphb_tcp_params *ts_lphb_tcp_param);
  263. /**
  264. * target_if_pmo_send_lphb_tcp_pkt_filter() - send lphb tcp packet filter req
  265. * @psoc: objmgr psoc handle
  266. * @ts_lphb_tcp_filter: lphb tcp filter request which needs to configure in fwr
  267. *
  268. * Return: QDF status
  269. */
  270. QDF_STATUS target_if_pmo_send_lphb_tcp_pkt_filter(struct wlan_objmgr_psoc *psoc,
  271. struct pmo_lphb_tcp_filter_req *ts_lphb_tcp_filter);
  272. /**
  273. * target_if_pmo_send_lphb_udp_params() - Send udp param command of LPHB
  274. * @psoc: objmgr psoc handle
  275. * @ts_lphb_udp_param: lphb udp params which needs to configure in fwr
  276. *
  277. * Return: QDF status
  278. */
  279. QDF_STATUS target_if_pmo_send_lphb_udp_params(struct wlan_objmgr_psoc *psoc,
  280. struct pmo_lphb_udp_params *ts_lphb_udp_param);
  281. /**
  282. * target_if_pmo_send_lphb_udp_pkt_filter() - Send lphb udp pkt filter cmd req
  283. * @psoc: objmgr psoc handle
  284. * @ts_lphb_udp_filter: lphb udp filter request which needs to configure in fwr
  285. *
  286. * Return: QDF status
  287. */
  288. QDF_STATUS target_if_pmo_send_lphb_udp_pkt_filter(struct wlan_objmgr_psoc *psoc,
  289. struct pmo_lphb_udp_filter_req *ts_lphb_udp_filter);
  290. /**
  291. * target_if_pmo_lphb_evt_handler() - send LPHB indication to os if /HDD
  292. * @psoc: objmgr psoc handle
  293. * @event: lphb event buffer
  294. *
  295. * Return: QDF_STATUS_SUCCESS for success else error code
  296. */
  297. QDF_STATUS target_if_pmo_lphb_evt_handler(struct wlan_objmgr_psoc *psoc,
  298. uint8_t *event);
  299. /**
  300. * target_if_pmo_send_vdev_update_param_req() - Send vdev param value to fwr
  301. * @vdev: objmgr vdev
  302. * @param_id: tell vdev param id which needs to be updated in fwr
  303. * @param_value: vdev parameter value
  304. *
  305. * Return: QDF status
  306. */
  307. QDF_STATUS target_if_pmo_send_vdev_update_param_req(
  308. struct wlan_objmgr_vdev *vdev,
  309. uint32_t param_id, uint32_t param_value);
  310. /**
  311. * target_if_pmo_send_vdev_ps_param_req() - Send vdev ps param value to fwr
  312. * @vdev: objmgr vdev
  313. * @param_id: tell vdev param id which needs to be updated in fwr
  314. * @param_value: vdev parameter value
  315. *
  316. * Return: QDF status
  317. */
  318. QDF_STATUS target_if_pmo_send_vdev_ps_param_req(
  319. struct wlan_objmgr_vdev *vdev,
  320. uint32_t param_id,
  321. uint32_t param_value);
  322. /**
  323. * target_if_pmo_psoc_update_bus_suspend() - update wmi bus suspend flag
  324. * @psoc: objmgr psoc
  325. * @value: bus suspend value
  326. *
  327. * Return: None
  328. */
  329. void target_if_pmo_psoc_update_bus_suspend(struct wlan_objmgr_psoc *psoc,
  330. uint8_t value);
  331. /**
  332. * target_if_pmo_psoc_get_host_credits() - get available host credits
  333. * @psoc: objmgr psoc
  334. *
  335. * Return: return host credits
  336. */
  337. int target_if_pmo_psoc_get_host_credits(struct wlan_objmgr_psoc *psoc);
  338. /**
  339. * target_if_pmo_psoc_get_pending_cmnds() - get wmi pending commands
  340. * @psoc: objmgr psoc
  341. *
  342. * Return: return wmi pending commands
  343. */
  344. int target_if_pmo_psoc_get_pending_cmnds(struct wlan_objmgr_psoc *psoc);
  345. /**
  346. * target_if_pmo_update_target_suspend_flag() - set wmi target suspend flag
  347. * @psoc: objmgr psoc
  348. * @value: value
  349. *
  350. * Return: return wmi pending commands
  351. */
  352. void target_if_pmo_update_target_suspend_flag(struct wlan_objmgr_psoc *psoc,
  353. uint8_t value);
  354. /**
  355. * target_if_pmo_psoc_send_wow_enable_req() -send wow enable request
  356. * @psoc: objmgr psoc
  357. * @param: wow command params
  358. *
  359. * Return: return QDF_STATUS_SUCCESS on success else error code
  360. */
  361. QDF_STATUS target_if_pmo_psoc_send_wow_enable_req(struct wlan_objmgr_psoc *psoc,
  362. struct pmo_wow_cmd_params *param);
  363. /**
  364. * target_if_pmo_psoc_send_suspend_req() - fp to send suspend request
  365. * @psoc: objmgr psoc
  366. * @param: target suspend params
  367. *
  368. * Return: return QDF_STATUS_SUCCESS on success else error code
  369. */
  370. QDF_STATUS target_if_pmo_psoc_send_suspend_req(struct wlan_objmgr_psoc *psoc,
  371. struct pmo_suspend_params *param);
  372. /**
  373. * target_if_pmo_set_runtime_pm_in_progress() - set runtime pm status
  374. * @psoc: objmgr psoc
  375. * @value: set runtime pm status
  376. *
  377. * Return: none
  378. */
  379. void target_if_pmo_set_runtime_pm_in_progress(struct wlan_objmgr_psoc *psoc,
  380. bool value);
  381. /**
  382. * target_if_pmo_get_runtime_pm_in_progress() - fp to get runtime pm status
  383. * @psoc: objmgr psoc
  384. *
  385. * Return: true if runtime pm in progress else false
  386. */
  387. bool target_if_pmo_get_runtime_pm_in_progress(struct wlan_objmgr_psoc *psoc);
  388. /**
  389. * target_if_pmo_psoc_send_host_wakeup_ind() - send host wake ind to fwr
  390. * @psoc: objmgr psoc
  391. *
  392. * Return: return QDF_STATUS_SUCCESS on success else error code
  393. */
  394. QDF_STATUS target_if_pmo_psoc_send_host_wakeup_ind(
  395. struct wlan_objmgr_psoc *psoc);
  396. /**
  397. * target_if_pmo_psoc_send_target_resume_req() -send target resume request
  398. * @psoc: objmgr psoc
  399. *
  400. * Return: return QDF_STATUS_SUCCESS on success else error code
  401. */
  402. QDF_STATUS target_if_pmo_psoc_send_target_resume_req(
  403. struct wlan_objmgr_psoc *psoc);
  404. /**
  405. * target_if_pmo_psoc_send_d0wow_enable_req() - send d0 wow enable request
  406. * @psoc: objmgr psoc
  407. *
  408. * Return: return QDF_STATUS_SUCCESS on success else error code
  409. */
  410. QDF_STATUS target_if_pmo_psoc_send_d0wow_enable_req(
  411. struct wlan_objmgr_psoc *psoc);
  412. /**
  413. * target_if_pmo_psoc_send_d0wow_disable_req() - send d0 wow disable request
  414. * @psoc: objmgr psoc
  415. *
  416. * Return: return QDF_STATUS_SUCCESS on success else error code
  417. */
  418. QDF_STATUS target_if_pmo_psoc_send_d0wow_disable_req(
  419. struct wlan_objmgr_psoc *psoc);
  420. /**
  421. * target_if_pmo_register_tx_ops() - Register PMO component TX OPS
  422. * @tx_ops: PMO if transmit ops
  423. *
  424. * Return: None
  425. */
  426. void target_if_pmo_register_tx_ops(struct wlan_pmo_tx_ops *tx_ops);
  427. #endif