wmi_unified_api.h 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. /*
  2. * Copyright (c) 2013-2016 The Linux Foundation. All rights reserved.
  3. *
  4. * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
  5. *
  6. *
  7. * Permission to use, copy, modify, and/or distribute this software for
  8. * any purpose with or without fee is hereby granted, provided that the
  9. * above copyright notice and this permission notice appear in all
  10. * copies.
  11. *
  12. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  13. * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  14. * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  15. * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  16. * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  17. * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  18. * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  19. * PERFORMANCE OF THIS SOFTWARE.
  20. */
  21. /*
  22. * This file was originally distributed by Qualcomm Atheros, Inc.
  23. * under proprietary terms before Copyright ownership was assigned
  24. * to the Linux Foundation.
  25. */
  26. /*
  27. * This file contains the API definitions for the Unified Wireless Module
  28. * Interface (WMI).
  29. */
  30. #ifndef _WMI_UNIFIED_API_H_
  31. #define _WMI_UNIFIED_API_H_
  32. #include <osdep.h>
  33. #include "a_types.h"
  34. #include "ol_defines.h"
  35. #include "wmi.h"
  36. #include "htc_api.h"
  37. #include "wmi_unified_param.h"
  38. typedef cdf_nbuf_t wmi_buf_t;
  39. #define wmi_buf_data(_buf) cdf_nbuf_data(_buf)
  40. /**
  41. * struct wmi_ops - service callbacks to upper layer
  42. * @service_ready_cbk: service ready callback
  43. * @service_ready_ext_cbk: service ready ext callback
  44. * @ready_cbk: ready calback
  45. * @wma_process_fw_event_handler_cbk: generic event handler callback
  46. */
  47. struct wmi_rx_ops {
  48. int (*wma_process_fw_event_handler_cbk)(void *ctx,
  49. void *ev, uint8_t rx_ctx);
  50. };
  51. /**
  52. * enum wmi_target_type - type of supported wmi command
  53. * @WMI_TLV_TARGET: tlv based target
  54. * @WMI_NON_TLV_TARGET: non-tlv based target
  55. *
  56. */
  57. enum wmi_target_type {
  58. WMI_TLV_TARGET,
  59. WMI_NON_TLV_TARGET
  60. };
  61. /**
  62. * enum wmi_rx_exec_ctx - wmi rx execution context
  63. * @WMI_RX_WORK_CTX: work queue context execution provided by WMI layer
  64. * @WMI_RX_UMAC_CTX: execution context provided by umac layer
  65. *
  66. */
  67. enum wmi_rx_exec_ctx {
  68. WMI_RX_WORK_CTX,
  69. WMI_RX_UMAC_CTX
  70. };
  71. /**
  72. * attach for unified WMI
  73. *
  74. * @param scn_handle : handle to SCN.
  75. * @return opaque handle.
  76. */
  77. void *wmi_unified_attach(void *scn_handle,
  78. osdev_t osdev, enum wmi_target_type target_type,
  79. bool use_cookie, struct wmi_rx_ops *ops);
  80. /**
  81. * detach for unified WMI
  82. *
  83. * @param wmi_handle : handle to WMI.
  84. * @return void.
  85. */
  86. void wmi_unified_detach(struct wmi_unified *wmi_handle);
  87. void
  88. wmi_unified_remove_work(struct wmi_unified *wmi_handle);
  89. /**
  90. * generic function to allocate WMI buffer
  91. *
  92. * @param wmi_handle : handle to WMI.
  93. * @param len : length of the buffer
  94. * @return wmi_buf_t.
  95. */
  96. #ifdef MEMORY_DEBUG
  97. #define wmi_buf_alloc(h, l) wmi_buf_alloc_debug(h, l, __FILE__, __LINE__)
  98. wmi_buf_t
  99. wmi_buf_alloc_debug(wmi_unified_t wmi_handle, uint16_t len,
  100. uint8_t *file_name, uint32_t line_num);
  101. #else
  102. wmi_buf_t wmi_buf_alloc(wmi_unified_t wmi_handle, uint16_t len);
  103. #endif
  104. /**
  105. * generic function frees WMI net buffer
  106. *
  107. * @param net_buf : Pointer ot net_buf to be freed
  108. */
  109. void wmi_buf_free(wmi_buf_t net_buf);
  110. /**
  111. * generic function to send unified WMI command
  112. *
  113. * @param wmi_handle : handle to WMI.
  114. * @param buf : wmi command buffer
  115. * @param buflen : wmi command buffer length
  116. * @return 0 on success and -ve on failure.
  117. */
  118. int
  119. wmi_unified_cmd_send(wmi_unified_t wmi_handle, wmi_buf_t buf, uint32_t buflen,
  120. WMI_CMD_ID cmd_id);
  121. /**
  122. * wmi_unified_register_event_handler() - WMI event handler
  123. * registration function
  124. *
  125. * @wmi_handle: handle to WMI.
  126. * @event_id: WMI event ID
  127. * @handler_func: Event handler call back function
  128. * @rx_ctx: rx event processing context
  129. *
  130. * @return 0 on success and -ve on failure.
  131. */
  132. int
  133. wmi_unified_register_event_handler(wmi_unified_t wmi_handle,
  134. WMI_EVT_ID event_id,
  135. wmi_unified_event_handler handler_func,
  136. uint8_t rx_ctx);
  137. /**
  138. * WMI event handler unregister function
  139. *
  140. * @param wmi_handle : handle to WMI.
  141. * @param event_id : WMI event ID
  142. * @return 0 on success and -ve on failure.
  143. */
  144. int
  145. wmi_unified_unregister_event_handler(wmi_unified_t wmi_handle,
  146. WMI_EVT_ID event_id);
  147. /**
  148. * request wmi to connet its htc service.
  149. * @param wmi_handle : handle to WMI.
  150. * @return void
  151. */
  152. int
  153. wmi_unified_connect_htc_service(struct wmi_unified *wmi_handle,
  154. void *htc_handle);
  155. /*
  156. * WMI API to verify the host has enough credits to suspend
  157. */
  158. int wmi_is_suspend_ready(wmi_unified_t wmi_handle);
  159. /**
  160. WMI API to get updated host_credits
  161. */
  162. int wmi_get_host_credits(wmi_unified_t wmi_handle);
  163. /**
  164. WMI API to get WMI Pending Commands in the HTC queue
  165. */
  166. int wmi_get_pending_cmds(wmi_unified_t wmi_handle);
  167. /**
  168. WMI API to set target suspend state
  169. */
  170. void wmi_set_target_suspend(wmi_unified_t wmi_handle, bool val);
  171. #ifdef FEATURE_RUNTIME_PM
  172. void
  173. wmi_set_runtime_pm_inprogress(wmi_unified_t wmi_handle, bool val);
  174. bool wmi_get_runtime_pm_inprogress(wmi_unified_t wmi_handle);
  175. #else
  176. static inline void
  177. wmi_set_runtime_pm_inprogress(wmi_unified_t wmi_handle, bool val)
  178. {
  179. return;
  180. }
  181. static inline bool wmi_get_runtime_pm_inprogress(wmi_unified_t wmi_handle)
  182. {
  183. return false;
  184. }
  185. #endif
  186. /**
  187. * WMA Callback to process fw event.
  188. */
  189. void wmi_process_fw_event(struct wmi_unified *wmi_handle, wmi_buf_t evt_buf);
  190. uint16_t wmi_get_max_msg_len(wmi_unified_t wmi_handle);
  191. int32_t wmi_unified_vdev_create_send(void *wmi_hdl,
  192. uint8_t macaddr[IEEE80211_ADDR_LEN],
  193. struct vdev_create_params *param);
  194. int32_t wmi_unified_vdev_delete_send(void *wmi_hdl,
  195. uint8_t if_id);
  196. int32_t wmi_unified_vdev_start_send(void *wmi_hdl,
  197. uint8_t macaddr[IEEE80211_ADDR_LEN],
  198. struct vdev_start_params *param);
  199. int32_t wmi_unified_vdev_restart_send(void *wmi_hdl,
  200. uint8_t macaddr[IEEE80211_ADDR_LEN],
  201. struct vdev_start_params *param);
  202. int32_t wmi_unified_vdev_stop_send(void *wmi_hdl,
  203. uint8_t vdev_id);
  204. int32_t wmi_unified_vdev_up_send(void *wmi_hdl,
  205. uint8_t bssid[IEEE80211_ADDR_LEN],
  206. struct vdev_up_params *params);
  207. int32_t wmi_unified_vdev_down_send(void *wmi_hdl,
  208. uint8_t vdev_id);
  209. int32_t wmi_unified_vdev_set_param_send(void *wmi_hdl,
  210. struct vdev_set_params *param);
  211. int32_t wmi_unified_peer_delete_send(void *wmi_hdl,
  212. uint8_t
  213. peer_addr[IEEE80211_ADDR_LEN],
  214. uint8_t vdev_id);
  215. int32_t wmi_unified_peer_flush_tids_send(void *wmi_hdl,
  216. uint8_t peer_addr[IEEE80211_ADDR_LEN],
  217. struct peer_flush_params *param);
  218. int32_t wmi_set_peer_param_send(void *wmi_hdl,
  219. uint8_t peer_addr[IEEE80211_ADDR_LEN],
  220. struct peer_set_params *param);
  221. int32_t wmi_unified_peer_create_send(void *wmi_hdl,
  222. struct peer_create_params *param);
  223. int32_t wmi_unified_stats_request_send(void *wmi_hdl,
  224. uint8_t macaddr[IEEE80211_ADDR_LEN],
  225. struct stats_request_params *param);
  226. int32_t wmi_unified_green_ap_ps_send(void *wmi_hdl,
  227. uint32_t value, uint8_t mac_id);
  228. int32_t wmi_unified_wow_enable_send(void *wmi_hdl,
  229. struct wow_cmd_params *param,
  230. uint8_t mac_id);
  231. int32_t wmi_unified_packet_log_enable_send(void *wmi_hdl,
  232. uint8_t macaddr[IEEE80211_ADDR_LEN],
  233. struct packet_enable_params *param);
  234. int32_t wmi_unified_suspend_send(void *wmi_hdl,
  235. struct suspend_params *param,
  236. uint8_t mac_id);
  237. int32_t wmi_unified_resume_send(void *wmi_hdl,
  238. uint8_t mac_id);
  239. int32_t
  240. wmi_unified_pdev_param_send(void *wmi_hdl,
  241. struct pdev_params *param,
  242. uint8_t mac_id);
  243. int32_t wmi_unified_beacon_send_cmd(void *wmi_hdl,
  244. uint8_t macaddr[IEEE80211_ADDR_LEN],
  245. struct beacon_params *param);
  246. int32_t wmi_unified_peer_assoc_send(void *wmi_hdl,
  247. uint8_t macaddr[IEEE80211_ADDR_LEN],
  248. struct peer_assoc_params *param);
  249. int32_t wmi_unified_sta_ps_cmd_send(void *wmi_hdl,
  250. struct sta_ps_params *param);
  251. int32_t wmi_unified_ap_ps_cmd_send(void *wmi_hdl,
  252. uint8_t macaddr[IEEE80211_ADDR_LEN],
  253. struct ap_ps_params *param);
  254. int32_t wmi_unified_scan_start_cmd_send(void *wmi_hdl,
  255. uint8_t macaddr[IEEE80211_ADDR_LEN],
  256. struct scan_start_params *param);
  257. int32_t wmi_unified_scan_stop_cmd_send(void *wmi_hdl,
  258. uint8_t macaddr[IEEE80211_ADDR_LEN],
  259. struct scan_stop_params *param);
  260. int32_t wmi_unified_scan_chan_list_cmd_send(void *wmi_hdl,
  261. uint8_t macaddr[IEEE80211_ADDR_LEN],
  262. struct scan_chan_list_params *param);
  263. int32_t wmi_crash_inject(void *wmi_hdl,
  264. struct crash_inject *param);
  265. int32_t wmi_unified_pdev_utf_cmd_send(void *wmi_hdl,
  266. struct pdev_utf_params *param,
  267. uint8_t mac_id);
  268. int32_t wmi_unified_dbglog_cmd_send(void *wmi_hdl,
  269. struct dbglog_params *param);
  270. #endif /* _WMI_UNIFIED_API_H_ */