wlan_pmo_ucfg_api.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
  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 public API related to the pmo called by north bound HDD/OSIF
  20. */
  21. #ifndef _WLAN_PMO_UCFG_API_H_
  22. #define _WLAN_PMO_UCFG_API_H_
  23. #include "wlan_pmo_arp_public_struct.h"
  24. #include "wlan_pmo_ns_public_struct.h"
  25. #include "wlan_pmo_gtk_public_struct.h"
  26. #include "wlan_pmo_mc_addr_filtering.h"
  27. #include "wlan_pmo_mc_addr_filtering_public_struct.h"
  28. #include "wlan_pmo_wow_public_struct.h"
  29. #include "wlan_pmo_common_public_struct.h"
  30. #include "wlan_pmo_obj_mgmt_api.h"
  31. #include "wlan_pmo_pkt_filter_public_struct.h"
  32. #include "wlan_pmo_hw_filter_public_struct.h"
  33. /**
  34. * ucfg_pmo_get_apf_instruction_size() - get the current APF instruction size
  35. * @psoc: the psoc to query
  36. *
  37. * Return: APF instruction size
  38. */
  39. uint32_t ucfg_pmo_get_apf_instruction_size(struct wlan_objmgr_psoc *psoc);
  40. /**
  41. * ucfg_pmo_get_num_packet_filters() - get the number of packet filters
  42. * @psoc: the psoc to query
  43. *
  44. * Return: number of packet filters
  45. */
  46. uint32_t ucfg_pmo_get_num_packet_filters(struct wlan_objmgr_psoc *psoc);
  47. /**
  48. * ucfg_pmo_get_num_wow_filters() - get the supported number of WoW filters
  49. * @psoc: the psoc to query
  50. *
  51. * Return: number of WoW filters supported
  52. */
  53. uint8_t ucfg_pmo_get_num_wow_filters(struct wlan_objmgr_psoc *psoc);
  54. /**
  55. * ucfg_pmo_is_ap_mode_supports_arp_ns() - Check ap mode support arp&ns offload
  56. * @psoc: objmgr psoc
  57. * @vdev_opmode: vdev opmode
  58. *
  59. * Return: true in case support else false
  60. */
  61. bool ucfg_pmo_is_ap_mode_supports_arp_ns(struct wlan_objmgr_psoc *psoc,
  62. enum QDF_OPMODE vdev_opmode);
  63. /**
  64. * ucfg_pmo_is_vdev_connected() - to check whether peer is associated or not
  65. * @vdev: objmgr vdev
  66. *
  67. * Return: true in case success else false
  68. */
  69. bool ucfg_pmo_is_vdev_connected(struct wlan_objmgr_vdev *vdev);
  70. /**
  71. * ucfg_pmo_is_vdev_supports_offload() - check offload is supported on vdev
  72. * @vdev: objmgr vdev
  73. *
  74. * Return: true in case success else false
  75. */
  76. bool ucfg_pmo_is_vdev_supports_offload(struct wlan_objmgr_vdev *vdev);
  77. /**
  78. * ucfg_pmo_get_psoc_config(): API to get the psoc user configurations of pmo
  79. * @psoc: objmgr psoc handle
  80. * @psoc_cfg: fill the current psoc user configurations.
  81. *
  82. * Return pmo psoc configurations
  83. */
  84. QDF_STATUS ucfg_pmo_get_psoc_config(struct wlan_objmgr_psoc *psoc,
  85. struct pmo_psoc_cfg *psoc_cfg);
  86. /**
  87. * ucfg_pmo_update_psoc_config(): API to update the psoc user configurations
  88. * @psoc: objmgr psoc handle
  89. * @psoc_cfg: pmo psoc configurations
  90. *
  91. * This api shall be used for soc config initialization as well update.
  92. * In case of update caller must first call pmo_get_psoc_cfg to get
  93. * current config and then apply changes on top of current config.
  94. *
  95. * Return QDF_STATUS -in case of success else return error
  96. */
  97. QDF_STATUS ucfg_pmo_update_psoc_config(struct wlan_objmgr_psoc *psoc,
  98. struct pmo_psoc_cfg *psoc_cfg);
  99. /**
  100. * ucfg_pmo_psoc_set_caps() - overwrite configured device capability flags
  101. * @psoc: the psoc for which the capabilities apply
  102. * @caps: the cabability information to configure
  103. *
  104. * Return: QDF_STATUS
  105. */
  106. QDF_STATUS ucfg_pmo_psoc_set_caps(struct wlan_objmgr_psoc *psoc,
  107. struct pmo_device_caps *caps);
  108. /**
  109. * pmo_ucfg_enable_wakeup_event() - enable wow wakeup events
  110. * @psoc: objmgr psoc
  111. * @vdev_id: vdev id
  112. * @bitmap: Event bitmap
  113. *
  114. * Return: none
  115. */
  116. void pmo_ucfg_enable_wakeup_event(struct wlan_objmgr_psoc *psoc,
  117. uint32_t vdev_id, uint32_t *bitmap);
  118. /**
  119. * pmo_ucfg_disable_wakeup_event() - disable wow wakeup events
  120. * @psoc: objmgr psoc
  121. * @vdev_id: vdev id
  122. * @bitmap: Event bitmap
  123. *
  124. * Return: none
  125. */
  126. void pmo_ucfg_disable_wakeup_event(struct wlan_objmgr_psoc *psoc,
  127. uint32_t vdev_id, uint32_t bitmap);
  128. /**
  129. * pmo_ucfg_cache_arp_offload_req(): API to cache arp req in pmo vdev priv ctx
  130. * @arp_req: pmo arp req param
  131. *
  132. * Return QDF_STATUS -in case of success else return error
  133. */
  134. QDF_STATUS pmo_ucfg_cache_arp_offload_req(struct pmo_arp_req *arp_req);
  135. /**
  136. * pmo_ucfg_flush_arp_offload_req(): API to flush arp req from pmo vdev priv ctx
  137. * @vdev: objmgr vdev param
  138. *
  139. * Return QDF_STATUS -in case of success else return error
  140. */
  141. QDF_STATUS pmo_ucfg_flush_arp_offload_req(struct wlan_objmgr_vdev *vdev);
  142. /**
  143. * pmo_ucfg_enable_arp_offload_in_fwr(): API to enable arp req in fwr
  144. * @vdev: objmgr vdev param
  145. * @trigger: triger reason for enable arp offload
  146. *
  147. * API to enable cache arp req in fwr from pmo vdev priv ctx
  148. *
  149. * Return QDF_STATUS -in case of success else return error
  150. */
  151. QDF_STATUS pmo_ucfg_enable_arp_offload_in_fwr(struct wlan_objmgr_vdev *vdev,
  152. enum pmo_offload_trigger trigger);
  153. /**
  154. * pmo_ucfg_disable_arp_offload_in_fwr(): API to disable arp req in fwr
  155. * @vdev: objmgr vdev param
  156. * @trigger: triger reason for disable arp offload
  157. * API to disable cache arp req in fwr
  158. *
  159. * Return QDF_STATUS -in case of success else return error
  160. */
  161. QDF_STATUS pmo_ucfg_disable_arp_offload_in_fwr(struct wlan_objmgr_vdev *vdev,
  162. enum pmo_offload_trigger trigger);
  163. /**
  164. * pmo_ucfg_cache_ns_offload_req(): API to cache ns req in pmo vdev priv ctx
  165. * @ns_req: pmo ns req param
  166. *
  167. * Return QDF_STATUS -in case of success else return error
  168. */
  169. QDF_STATUS pmo_ucfg_cache_ns_offload_req(struct pmo_ns_req *ns_req);
  170. /**
  171. * pmo_ucfg_flush_ns_offload_req(): API to flush ns req from pmo vdev priv ctx
  172. * @vdev: vdev ojbmgr handle
  173. *
  174. * Return QDF_STATUS -in case of success else return error
  175. */
  176. QDF_STATUS pmo_ucfg_flush_ns_offload_req(struct wlan_objmgr_vdev *vdev);
  177. /**
  178. * pmo_ucfg_enable_ns_offload_in_fwr(): API to enable ns req in fwr
  179. * @arp_req: pmo arp req param
  180. * @trigger: trigger reason to enable ns offload
  181. *
  182. * API to enable cache ns req in fwr from pmo vdev priv ctx
  183. *
  184. * Return QDF_STATUS -in case of success else return error
  185. */
  186. QDF_STATUS pmo_ucfg_enable_ns_offload_in_fwr(struct wlan_objmgr_vdev *vdev,
  187. enum pmo_offload_trigger trigger);
  188. /**
  189. * pmo_ucfg_disable_ns_offload_in_fwr(): API to disable ns req in fwr
  190. * @arp_req: pmo arp req param
  191. * @trigger: trigger reason to disable ns offload
  192. *
  193. * API to disable ns req in fwr
  194. *
  195. * Return QDF_STATUS -in case of success else return error
  196. */
  197. QDF_STATUS pmo_ucfg_disable_ns_offload_in_fwr(struct wlan_objmgr_vdev *vdev,
  198. enum pmo_offload_trigger trigger);
  199. /**
  200. * pmo_ucfg_enable_hw_filter_in_fwr() - enable previously configured hw filter
  201. * @vdev: objmgr vdev to configure
  202. *
  203. * Return: QDF_STATUS
  204. */
  205. QDF_STATUS pmo_ucfg_enable_hw_filter_in_fwr(struct wlan_objmgr_vdev *vdev);
  206. /**
  207. * pmo_ucfg_disable_hw_filter_in_fwr() - disable previously configured hw filter
  208. * @vdev: objmgr vdev to configure
  209. *
  210. * Return: QDF_STATUS
  211. */
  212. QDF_STATUS pmo_ucfg_disable_hw_filter_in_fwr(struct wlan_objmgr_vdev *vdev);
  213. /**
  214. * pmo_ucfg_max_mc_addr_supported() - to get max support mc address
  215. * @psoc: objmgr psoc
  216. *
  217. * Return: max mc addr supported count for all vdev in corresponding psoc
  218. */
  219. uint8_t pmo_ucfg_max_mc_addr_supported(struct wlan_objmgr_psoc *psoc);
  220. /**
  221. * pmo_ucfg_cache_mc_addr_list(): API to cache mc addr list in pmo vdev priv obj
  222. * @psoc: objmgr psoc handle
  223. * @vdev_id: vdev id
  224. * @gtk_req: pmo gtk req param
  225. *
  226. * Return QDF_STATUS_SUCCESS -in case of success else return error
  227. */
  228. QDF_STATUS pmo_ucfg_cache_mc_addr_list(
  229. struct pmo_mc_addr_list_params *mc_list_config);
  230. /**
  231. * pmo_ucfg_flush_mc_addr_list(): API to flush mc addr list in pmo vdev priv obj
  232. * @psoc: objmgr psoc handle
  233. * @vdev_id: vdev id
  234. *
  235. * Return QDF_STATUS_SUCCESS -in case of success else return error
  236. */
  237. QDF_STATUS pmo_ucfg_flush_mc_addr_list(struct wlan_objmgr_psoc *psoc,
  238. uint8_t vdev_id);
  239. /**
  240. * pmo_ucfg_enhance_mc_filter_enable() - enable enhanced multicast filtering
  241. * @vdev: the vdev to enable enhanced multicast filtering for
  242. *
  243. * Return: QDF_STATUS
  244. */
  245. static inline QDF_STATUS
  246. pmo_ucfg_enhanced_mc_filter_enable(struct wlan_objmgr_vdev *vdev)
  247. {
  248. return pmo_core_enhanced_mc_filter_enable(vdev);
  249. }
  250. /**
  251. * pmo_ucfg_enhance_mc_filter_disable() - disable enhanced multicast filtering
  252. * @vdev: the vdev to disable enhanced multicast filtering for
  253. *
  254. * Return: QDF_STATUS
  255. */
  256. static inline QDF_STATUS
  257. pmo_ucfg_enhanced_mc_filter_disable(struct wlan_objmgr_vdev *vdev)
  258. {
  259. return pmo_core_enhanced_mc_filter_disable(vdev);
  260. }
  261. /**
  262. * pmo_ucfg_enable_mc_addr_filtering_in_fwr(): Enable cached mc add list in fwr
  263. * @psoc: objmgr psoc handle
  264. * @vdev_id: vdev id
  265. * @gtk_req: pmo gtk req param
  266. * @action: true for enable els false
  267. *
  268. * API to enable cached mc add list in fwr
  269. *
  270. * Return QDF_STATUS_SUCCESS -in case of success else return error
  271. */
  272. QDF_STATUS pmo_ucfg_enable_mc_addr_filtering_in_fwr(
  273. struct wlan_objmgr_psoc *psoc,
  274. uint8_t vdev_id,
  275. enum pmo_offload_trigger trigger);
  276. /**
  277. * pmo_ucfg_disable_mc_addr_filtering_in_fwr(): Disable cached mc addr list
  278. * @psoc: objmgr psoc handle
  279. * @vdev_id: vdev id
  280. * @gtk_req: pmo gtk req param
  281. * @action: true for enable els false
  282. *
  283. * API to disable cached mc add list in fwr
  284. *
  285. * Return QDF_STATUS_SUCCESS -in case of success else return error
  286. */
  287. QDF_STATUS pmo_ucfg_disable_mc_addr_filtering_in_fwr(
  288. struct wlan_objmgr_psoc *psoc,
  289. uint8_t vdev_id,
  290. enum pmo_offload_trigger trigger);
  291. /**
  292. * pmo_ucfg_cache_gtk_offload_req(): API to cache gtk req in pmo vdev priv obj
  293. * @vdev: objmgr vdev handle
  294. * @gtk_req: pmo gtk req param
  295. *
  296. * Return QDF_STATUS_SUCCESS -in case of success else return error
  297. */
  298. QDF_STATUS pmo_ucfg_cache_gtk_offload_req(struct wlan_objmgr_vdev *vdev,
  299. struct pmo_gtk_req *gtk_req);
  300. /**
  301. * pmo_ucfg_flush_gtk_offload_req(): Flush saved gtk req from pmo vdev priv obj
  302. * @vdev: objmgr vdev handle
  303. *
  304. * Return QDF_STATUS_SUCCESS -in case of success else return error
  305. */
  306. QDF_STATUS pmo_ucfg_flush_gtk_offload_req(struct wlan_objmgr_vdev *vdev);
  307. /**
  308. * pmo_ucfg_enable_gtk_offload_in_fwr(): enable cached gtk request in fwr
  309. * @vdev: objmgr vdev handle
  310. *
  311. * Return QDF_STATUS_SUCCESS -in case of success else return error
  312. */
  313. QDF_STATUS pmo_ucfg_enable_gtk_offload_in_fwr(struct wlan_objmgr_vdev *vdev);
  314. /**
  315. * pmo_ucfg_disable_gtk_offload_in_fwr(): disable cached gtk request in fwr
  316. * @vdev: objmgr vdev handle
  317. *
  318. * Return QDF_STATUS_SUCCESS -in case of success else return error
  319. */
  320. QDF_STATUS pmo_ucfg_disable_gtk_offload_in_fwr(struct wlan_objmgr_vdev *vdev);
  321. /**
  322. * pmo_ucfg_set_pkt_filter() - Set packet filter
  323. * @psoc: objmgr psoc handle
  324. * @pmo_set_pkt_fltr_req:
  325. * @vdev_id: vdev id
  326. *
  327. * Return QDF_STATUS_SUCCESS -in case of success else return error
  328. */
  329. QDF_STATUS pmo_ucfg_set_pkt_filter(struct wlan_objmgr_psoc *psoc,
  330. struct pmo_rcv_pkt_fltr_cfg *pmo_set_pkt_fltr_req,
  331. uint8_t vdev_id);
  332. /**
  333. * pmo_ucfg_clear_pkt_filter() - Clear packet filter
  334. * @psoc: objmgr psoc handle
  335. * @pmo_clr_pkt_fltr_req:
  336. * @vdev_id: vdev id
  337. *
  338. * Return QDF_STATUS_SUCCESS -in case of success else return error
  339. */
  340. QDF_STATUS pmo_ucfg_clear_pkt_filter(struct wlan_objmgr_psoc *psoc,
  341. struct pmo_rcv_pkt_fltr_clear_param *pmo_clr_pkt_fltr_param,
  342. uint8_t vdev_id);
  343. /**
  344. * pmo_ucfg_get_gtk_rsp(): API to send gtk response request to fwr
  345. * @vdev: objmgr vdev handle
  346. * @gtk_rsp: pmo gtk response request
  347. *
  348. * This api will send gtk response request to fwr
  349. *
  350. * Return QDF_STATUS_SUCCESS -in case of success else return error
  351. */
  352. QDF_STATUS pmo_ucfg_get_gtk_rsp(struct wlan_objmgr_vdev *vdev,
  353. struct pmo_gtk_rsp_req *gtk_rsp_req);
  354. /**
  355. * pmo_ucfg_update_extscan_in_progress(): update extscan is in progress flags
  356. * @vdev: objmgr vdev handle
  357. * @value:true if extscan is in progress else false
  358. *
  359. * Return: TRUE/FALSE
  360. */
  361. void pmo_ucfg_update_extscan_in_progress(struct wlan_objmgr_vdev *vdev,
  362. bool value);
  363. /**
  364. * pmo_ucfg_update_p2plo_in_progress(): update p2plo is in progress flags
  365. * @vdev: objmgr vdev handle
  366. * @value:true if p2plo is in progress else false
  367. *
  368. * Return: TRUE/FALSE
  369. */
  370. void pmo_ucfg_update_p2plo_in_progress(struct wlan_objmgr_vdev *vdev,
  371. bool value);
  372. /**
  373. * pmo_ucfg_lphb_config_req() - Handles lphb config request for psoc
  374. * @psoc: objmgr psoc handle
  375. * @lphb_req: low power heart beat request
  376. * @lphb_cb_ctx: Context which needs to pass to soif when lphb callback called
  377. * @callback: upon receiving of lphb indication from fwr call lphb callback
  378. *
  379. * Return: QDF status
  380. */
  381. QDF_STATUS pmo_ucfg_lphb_config_req(struct wlan_objmgr_psoc *psoc,
  382. struct pmo_lphb_req *lphb_req, void *lphb_cb_ctx,
  383. pmo_lphb_callback callback);
  384. /**
  385. * pmo_ucfg_update_alt_modulated_dtim_enable() - update alt modulatate dtim
  386. * @vdev: objmgr vdev handle
  387. * @value: true for alt_modulated_dtim enable else false
  388. *
  389. * Return: QDF status
  390. */
  391. void pmo_ucfg_update_alt_modulated_dtim_enable(struct wlan_objmgr_vdev *vdev,
  392. bool value);
  393. /**
  394. * pmo_ucfg_psoc_update_power_save_mode() - update power save mode
  395. * @vdev: objmgr vdev handle
  396. * @value:vdev power save mode
  397. *
  398. * Return: None
  399. */
  400. void pmo_ucfg_psoc_update_power_save_mode(struct wlan_objmgr_psoc *psoc,
  401. uint8_t value);
  402. /**
  403. * pmo_ucfg_psoc_update_dp_handle() - update psoc data path handle
  404. * @psoc: objmgr psoc handle
  405. * @dp_hdl: psoc data path handle
  406. *
  407. * Return: None
  408. */
  409. void pmo_ucfg_psoc_update_dp_handle(struct wlan_objmgr_psoc *psoc,
  410. void *dp_hdl);
  411. /**
  412. * pmo_ucfg_vdev_update_dp_handle() - update vdev data path handle
  413. * @vdev: objmgr vdev handle
  414. * @dp_hdl: vdev data path handle
  415. *
  416. * Return: None
  417. */
  418. void pmo_ucfg_vdev_update_dp_handle(struct wlan_objmgr_vdev *vdev,
  419. void *dp_hdl);
  420. /**
  421. * pmo_ucfg_psoc_update_htc_handle() - update psoc htc layer handle
  422. * @psoc: objmgr psoc handle
  423. * @htc_handle: psoc host-to-tagret layer (htc) handle
  424. *
  425. * Return: None
  426. */
  427. void pmo_ucfg_psoc_update_htc_handle(struct wlan_objmgr_psoc *psoc,
  428. void *htc_handle);
  429. /**
  430. * pmo_ucfg_psoc_set_hif_handle() - Set psoc hif layer handle
  431. * @psoc: objmgr psoc handle
  432. * @hif_handle: hif context handle
  433. *
  434. * Return: None
  435. */
  436. void pmo_ucfg_psoc_set_hif_handle(struct wlan_objmgr_psoc *psoc,
  437. void *hif_handle);
  438. /**
  439. * pmo_ucfg_psoc_set_txrx_handle() - Set psoc pdev txrx layer handle
  440. * @psoc: objmgr psoc handle
  441. * @txrx_handle: pdev txrx context handle
  442. *
  443. * Return: None
  444. */
  445. void pmo_ucfg_psoc_set_txrx_handle(struct wlan_objmgr_psoc *psoc,
  446. void *txrx_handle);
  447. /**
  448. * pmo_ucfg_psoc_user_space_suspend_req() - Handles user space suspend req
  449. * @psoc: objmgr psoc handle
  450. * @type: type of suspend
  451. *
  452. * Handles user space suspend indication for psoc
  453. *
  454. * Return: QDF status
  455. */
  456. QDF_STATUS pmo_ucfg_psoc_user_space_suspend_req(struct wlan_objmgr_psoc *psoc,
  457. enum qdf_suspend_type type);
  458. /**
  459. * pmo_ucfg_psoc_user_space_resume_req() - Handles user space resume req
  460. * @psoc: objmgr psoc handle
  461. * @type: type of suspend from which resume needed
  462. *
  463. * Handles user space resume indication for psoc
  464. *
  465. * Return: QDF status
  466. */
  467. QDF_STATUS pmo_ucfg_psoc_user_space_resume_req(struct wlan_objmgr_psoc *psoc,
  468. enum qdf_suspend_type type);
  469. /**
  470. * pmo_ucfg_psoc_bus_suspend_req(): handles bus suspend for psoc
  471. * @psoc: objmgr psoc
  472. * @type: is this suspend part of runtime suspend or system suspend?
  473. * @wow_params: collection of wow enable override parameters
  474. *
  475. * Bails if a scan is in progress.
  476. * Calls the appropriate handlers based on configuration and event.
  477. *
  478. * Return: QDF_STATUS_SUCCESS for success or error code
  479. */
  480. QDF_STATUS pmo_ucfg_psoc_bus_suspend_req(struct wlan_objmgr_psoc *psoc,
  481. enum qdf_suspend_type type,
  482. struct pmo_wow_enable_params *wow_params);
  483. #ifdef FEATURE_RUNTIME_PM
  484. /**
  485. * pmo_ucfg_psoc_bus_runtime_suspend(): handles bus runtime suspend for psoc
  486. * @psoc: objmgr psoc
  487. * @pld_cb: callback to call link auto suspend
  488. *
  489. * Return: QDF_STATUS_SUCCESS for success or error code
  490. */
  491. QDF_STATUS pmo_ucfg_psoc_bus_runtime_suspend(struct wlan_objmgr_psoc *psoc,
  492. pmo_pld_auto_suspend_cb pld_cb);
  493. /**
  494. * pmo_ucfg_psoc_bus_runtime_resume(): handles bus runtime resume for psoc
  495. * @psoc: objmgr psoc
  496. * @pld_cb: callback to call link auto resume
  497. *
  498. * Return: QDF_STATUS_SUCCESS for success or error code
  499. */
  500. QDF_STATUS pmo_ucfg_psoc_bus_runtime_resume(struct wlan_objmgr_psoc *psoc,
  501. pmo_pld_auto_resume_cb pld_cb);
  502. #endif
  503. /**
  504. * pmo_ucfg_psoc_suspend_target() -Send suspend target command
  505. * @psoc: objmgr psoc handle
  506. * @disable_target_intr: disable target interrupt
  507. *
  508. * Return: QDF_STATUS_SUCCESS for success or error code
  509. */
  510. QDF_STATUS pmo_ucfg_psoc_suspend_target(struct wlan_objmgr_psoc *psoc,
  511. int disable_target_intr);
  512. QDF_STATUS pmo_ucfg_add_wow_user_pattern(struct wlan_objmgr_vdev *vdev,
  513. struct pmo_wow_add_pattern *ptrn);
  514. QDF_STATUS pmo_ucfg_del_wow_user_pattern(struct wlan_objmgr_vdev *vdev,
  515. uint8_t pattern_id);
  516. /**
  517. * pmo_ucfg_psoc_bus_resume() -handle bus resume request for psoc
  518. * @psoc: objmgr psoc handle
  519. * @type: is this suspend part of runtime suspend or system suspend?
  520. *
  521. * Return:QDF_STATUS_SUCCESS on success else error code
  522. */
  523. QDF_STATUS pmo_ucfg_psoc_bus_resume_req(struct wlan_objmgr_psoc *psoc,
  524. enum qdf_suspend_type type);
  525. /**
  526. * pmo_ucfg_get_wow_bus_suspend(): API to check if wow bus is suspended or not
  527. * @psoc: objmgr psoc handle
  528. *
  529. * Return: True if bus suspende else false
  530. */
  531. bool pmo_ucfg_get_wow_bus_suspend(struct wlan_objmgr_psoc *psoc);
  532. /**
  533. * pmo_ucfg_psoc_handle_initial_wake_up() - update initial wake up
  534. * @cb_ctx: objmgr psoc handle as void * due to htc layer is not aware psoc
  535. *
  536. * Return: None
  537. */
  538. void pmo_ucfg_psoc_handle_initial_wake_up(void *cb_ctx);
  539. /**
  540. * pmo_ucfg_psoc_is_target_wake_up_received() - Get initial wake up status
  541. * @psoc: objmgr psoc handle
  542. *
  543. * Return: 0 on success else error code
  544. */
  545. int pmo_ucfg_psoc_is_target_wake_up_received(struct wlan_objmgr_psoc *psoc);
  546. /**
  547. * pmo_ucfg_psoc_is_target_wake_up_received() - Clear initial wake up status
  548. * @psoc: objmgr psoc handle
  549. *
  550. * Return: 0 on success else error code
  551. */
  552. int pmo_ucfg_psoc_clear_target_wake_up(struct wlan_objmgr_psoc *psoc);
  553. /**
  554. * pmo_ucfg_psoc_target_suspend_acknowledge() - Clear initial wake up status
  555. * @psoc: objmgr psoc handle
  556. *
  557. * Return: None
  558. */
  559. void pmo_ucfg_psoc_target_suspend_acknowledge(void *context, bool wow_nack);
  560. /**
  561. * pmo_ucfg_psoc_wakeup_host_event_received() - got host wake up evennt from fwr
  562. * @psoc: objmgr psoc handle
  563. *
  564. * Return: None
  565. */
  566. void pmo_ucfg_psoc_wakeup_host_event_received(struct wlan_objmgr_psoc *psoc);
  567. #endif /* end of _WLAN_PMO_UCFG_API_H_ */