wmi_unified_twt_api.h 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. /*
  2. * Copyright (c) 2018-2020 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: Implement API's specific to TWT component.
  20. */
  21. #ifndef _WMI_UNIFIED_TWT_API_H_
  22. #define _WMI_UNIFIED_TWT_API_H_
  23. #include "wmi_unified_twt_param.h"
  24. /**
  25. * wmi_unified_twt_enable_cmd() - Send WMI command to Enable TWT
  26. * @wmi_handle: wmi handle
  27. * @params: Parameters to be configured
  28. *
  29. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  30. */
  31. QDF_STATUS
  32. wmi_unified_twt_enable_cmd(wmi_unified_t wmi_handle,
  33. struct wmi_twt_enable_param *params);
  34. /**
  35. * wmi_unified_twt_disable_cmd() - Send WMI command to disable TWT
  36. * @wmi_handle: wmi handle
  37. * @params: Parameters to be configured
  38. *
  39. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  40. */
  41. QDF_STATUS
  42. wmi_unified_twt_disable_cmd(wmi_unified_t wmi_handle,
  43. struct wmi_twt_disable_param *params);
  44. /**
  45. * wmi_unified_twt_add_dialog_cmd() - Send WMI command to add TWT dialog
  46. * @wmi_handle: wmi handle
  47. * @params: Parameters to be configured
  48. *
  49. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  50. */
  51. QDF_STATUS
  52. wmi_unified_twt_add_dialog_cmd(wmi_unified_t wmi_handle,
  53. struct wmi_twt_add_dialog_param *params);
  54. /**
  55. * wmi_unified_twt_del_dialog_cmd() - Send WMI command to delete TWT dialog
  56. * @wmi_handle: wmi handle
  57. * @params: Parameters to be configured
  58. *
  59. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  60. */
  61. QDF_STATUS
  62. wmi_unified_twt_del_dialog_cmd(wmi_unified_t wmi_handle,
  63. struct wmi_twt_del_dialog_param *params);
  64. /**
  65. * wmi_unified_twt_pause_dialog_cmd() - Send WMI command to pause TWT dialog
  66. * @wmi_handle: wmi handle
  67. * @params: Parameters to be configured
  68. *
  69. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  70. */
  71. QDF_STATUS
  72. wmi_unified_twt_pause_dialog_cmd(wmi_unified_t wmi_handle,
  73. struct wmi_twt_pause_dialog_cmd_param *params);
  74. /**
  75. * wmi_unified_twt_resume_dialog_cmd() - Send WMI command to resume TWT dialog
  76. * @wmi_handle: wmi handle
  77. * @params: Parameters to be configured
  78. *
  79. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  80. */
  81. QDF_STATUS wmi_unified_twt_resume_dialog_cmd(
  82. wmi_unified_t wmi_handle,
  83. struct wmi_twt_resume_dialog_cmd_param *params);
  84. #ifdef WLAN_SUPPORT_BCAST_TWT
  85. /**
  86. * wmi_unified_twt_btwt_invite_sta_cmd() - Send WMI command for bTWT sta
  87. * invitation
  88. * @wmi_handle: wmi handle
  89. * @params: Parameters to be configured
  90. *
  91. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  92. */
  93. QDF_STATUS wmi_unified_twt_btwt_invite_sta_cmd(
  94. wmi_unified_t wmi_handle,
  95. struct wmi_twt_btwt_invite_sta_cmd_param *params);
  96. /**
  97. * wmi_unified_twt_btwt_remove_sta_cmd() - Send WMI command for bTWT sta kickoff
  98. * @wmi_handle: wmi handle
  99. * @params: Parameters to be configured
  100. *
  101. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  102. */
  103. QDF_STATUS wmi_unified_twt_btwt_remove_sta_cmd(
  104. wmi_unified_t wmi_handle,
  105. struct wmi_twt_btwt_remove_sta_cmd_param *params);
  106. #endif
  107. /**
  108. * wmi_extract_twt_enable_comp_event() - Extract WMI event params for TWT enable
  109. * completion event
  110. * @wmi_handle: wmi handle
  111. * @evt_buf: Pointer event buffer
  112. * @params: Parameters to extract
  113. *
  114. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  115. */
  116. QDF_STATUS wmi_extract_twt_enable_comp_event(
  117. wmi_unified_t wmi_handle,
  118. uint8_t *evt_buf,
  119. struct wmi_twt_enable_complete_event_param *params);
  120. /**
  121. * wmi_extract_twt_disable_comp_event() - Extract WMI event params for TWT
  122. * disable completion event
  123. * @wmi_handle: wmi handle
  124. * @evt_buf: Pointer event buffer
  125. * @params: Parameters to extract
  126. *
  127. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  128. */
  129. QDF_STATUS wmi_extract_twt_disable_comp_event(
  130. wmi_unified_t wmi_handle,
  131. uint8_t *evt_buf,
  132. struct wmi_twt_disable_complete_event *params);
  133. /**
  134. * wmi_extract_twt_add_dialog_comp_event() - Extract WMI event params for TWT
  135. * add dialog completion event
  136. * @wmi_hdl: wmi handle
  137. * @evt_buf: Pointer event buffer
  138. * @params: Parameters to extract
  139. *
  140. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  141. */
  142. QDF_STATUS wmi_extract_twt_add_dialog_comp_event(
  143. wmi_unified_t wmi_handle,
  144. uint8_t *evt_buf,
  145. struct wmi_twt_add_dialog_complete_event_param *params);
  146. /**
  147. * wmi_extract_twt_del_dialog_comp_event() - Extract WMI event params for TWT
  148. * delete dialog completion event
  149. * @wmi_hdl: wmi handle
  150. * @evt_buf: Pointer event buffer
  151. * @params: Parameters to extract
  152. *
  153. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  154. */
  155. QDF_STATUS wmi_extract_twt_del_dialog_comp_event(
  156. wmi_unified_t wmi_handle,
  157. uint8_t *evt_buf,
  158. struct wmi_twt_del_dialog_complete_event_param *params);
  159. /**
  160. * wmi_extract_twt_pause_dialog_comp_event() - Extract WMI event params for TWT
  161. * pause dialog completion event
  162. * @wmi_handle: wmi handle
  163. * @evt_buf: Pointer event buffer
  164. * @params: Parameters to extract
  165. *
  166. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  167. */
  168. QDF_STATUS wmi_extract_twt_pause_dialog_comp_event(
  169. wmi_unified_t wmi_handle,
  170. uint8_t *evt_buf,
  171. struct wmi_twt_pause_dialog_complete_event_param *params);
  172. /**
  173. * wmi_extract_twt_resume_dialog_comp_event() - Extract WMI event params for TWT
  174. * resume dialog completion event
  175. * @wmi_handle: wmi handle
  176. * @evt_buf: Pointer event buffer
  177. * @params: Parameters to extract
  178. *
  179. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  180. */
  181. QDF_STATUS wmi_extract_twt_resume_dialog_comp_event(
  182. wmi_unified_t wmi_handle,
  183. uint8_t *evt_buf,
  184. struct wmi_twt_resume_dialog_complete_event_param *params);
  185. #ifdef WLAN_SUPPORT_BCAST_TWT
  186. /**
  187. * wmi_extract_twt_btwt_invite_sta_comp_event() - Extract WMI event params for
  188. * BTWT sta invitation completion event
  189. * @wmi_handle: wmi handle
  190. * @evt_buf: Pointer event buffer
  191. * @params: Parameters to extract
  192. *
  193. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  194. */
  195. QDF_STATUS wmi_extract_twt_btwt_invite_sta_comp_event(
  196. wmi_unified_t wmi_handle,
  197. uint8_t *evt_buf,
  198. struct wmi_twt_btwt_invite_sta_complete_event_param *params);
  199. /**
  200. * wmi_extract_twt_btwt_remove_sta_comp_event() - Extract WMI event params for
  201. * BTWT sta kickoff completion event
  202. * @wmi_handle: wmi handle
  203. * @evt_buf: Pointer event buffer
  204. * @params: Parameters to extract
  205. *
  206. * Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
  207. */
  208. QDF_STATUS wmi_extract_twt_btwt_remove_sta_comp_event(
  209. wmi_unified_t wmi_handle,
  210. uint8_t *evt_buf,
  211. struct wmi_twt_btwt_remove_sta_complete_event_param *params);
  212. #endif
  213. #ifdef WLAN_SUPPORT_TWT
  214. void wmi_twt_attach_tlv(struct wmi_unified *wmi_handle);
  215. #else
  216. static void wmi_twt_attach_tlv(struct wmi_unified *wmi_handle)
  217. {
  218. return;
  219. }
  220. #endif
  221. #endif /* _WMI_UNIFIED_TWT_API_H_ */