wmi_unified_api.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  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. void (*service_ready_cbk)(void *ctx, void *ev);
  49. void (*service_ready_ext_cbk)(void *ctx, void *ev);
  50. void (*ready_cbk)(void *ctx, void *ev);
  51. int (*wma_process_fw_event_handler_cbk)(void *ctx,
  52. void *ev);
  53. };
  54. /**
  55. * enum wmi_target_type - type of supported wmi command
  56. * @WMI_TLV_TARGET: tlv based target
  57. * @WMI_NON_TLV_TARGET: non-tlv based target
  58. *
  59. */
  60. enum wmi_target_type {
  61. WMI_TLV_TARGET,
  62. WMI_NON_TLV_TARGET
  63. };
  64. /**
  65. * attach for unified WMI
  66. *
  67. * @param scn_handle : handle to SCN.
  68. * @return opaque handle.
  69. */
  70. void *wmi_unified_attach(void *scn_handle,
  71. osdev_t osdev, enum wmi_target_type target_type,
  72. bool use_cookie, struct wmi_rx_ops *ops);
  73. /**
  74. * detach for unified WMI
  75. *
  76. * @param wmi_handle : handle to WMI.
  77. * @return void.
  78. */
  79. void wmi_unified_detach(struct wmi_unified *wmi_handle);
  80. void
  81. wmi_unified_remove_work(struct wmi_unified *wmi_handle);
  82. /**
  83. * generic function to allocate WMI buffer
  84. *
  85. * @param wmi_handle : handle to WMI.
  86. * @param len : length of the buffer
  87. * @return wmi_buf_t.
  88. */
  89. #ifdef MEMORY_DEBUG
  90. #define wmi_buf_alloc(h, l) wmi_buf_alloc_debug(h, l, __FILE__, __LINE__)
  91. wmi_buf_t
  92. wmi_buf_alloc_debug(wmi_unified_t wmi_handle, uint16_t len,
  93. uint8_t *file_name, uint32_t line_num);
  94. #else
  95. wmi_buf_t wmi_buf_alloc(wmi_unified_t wmi_handle, uint16_t len);
  96. #endif
  97. /**
  98. * generic function frees WMI net buffer
  99. *
  100. * @param net_buf : Pointer ot net_buf to be freed
  101. */
  102. void wmi_buf_free(wmi_buf_t net_buf);
  103. /**
  104. * generic function to send unified WMI command
  105. *
  106. * @param wmi_handle : handle to WMI.
  107. * @param buf : wmi command buffer
  108. * @param buflen : wmi command buffer length
  109. * @return 0 on success and -ve on failure.
  110. */
  111. int
  112. wmi_unified_cmd_send(wmi_unified_t wmi_handle, wmi_buf_t buf, uint32_t buflen,
  113. WMI_CMD_ID cmd_id);
  114. /**
  115. * WMI event handler register function
  116. *
  117. * @param wmi_handle : handle to WMI.
  118. * @param event_id : WMI event ID
  119. * @param handler_func : Event handler call back function
  120. * @return 0 on success and -ve on failure.
  121. */
  122. int
  123. wmi_unified_register_event_handler(wmi_unified_t wmi_handle,
  124. WMI_EVT_ID event_id,
  125. wmi_unified_event_handler handler_func);
  126. /**
  127. * WMI event handler unregister function
  128. *
  129. * @param wmi_handle : handle to WMI.
  130. * @param event_id : WMI event ID
  131. * @return 0 on success and -ve on failure.
  132. */
  133. int
  134. wmi_unified_unregister_event_handler(wmi_unified_t wmi_handle,
  135. WMI_EVT_ID event_id);
  136. /**
  137. * request wmi to connet its htc service.
  138. * @param wmi_handle : handle to WMI.
  139. * @return void
  140. */
  141. int
  142. wmi_unified_connect_htc_service(struct wmi_unified *wmi_handle,
  143. void *htc_handle);
  144. /*
  145. * WMI API to verify the host has enough credits to suspend
  146. */
  147. int wmi_is_suspend_ready(wmi_unified_t wmi_handle);
  148. /**
  149. WMI API to get updated host_credits
  150. */
  151. int wmi_get_host_credits(wmi_unified_t wmi_handle);
  152. /**
  153. WMI API to get WMI Pending Commands in the HTC queue
  154. */
  155. int wmi_get_pending_cmds(wmi_unified_t wmi_handle);
  156. /**
  157. WMI API to set target suspend state
  158. */
  159. void wmi_set_target_suspend(wmi_unified_t wmi_handle, bool val);
  160. #ifdef FEATURE_RUNTIME_PM
  161. void
  162. wmi_set_runtime_pm_inprogress(wmi_unified_t wmi_handle, bool val);
  163. bool wmi_get_runtime_pm_inprogress(wmi_unified_t wmi_handle);
  164. #else
  165. static inline void
  166. wmi_set_runtime_pm_inprogress(wmi_unified_t wmi_handle, bool val)
  167. {
  168. return;
  169. }
  170. static inline bool wmi_get_runtime_pm_inprogress(wmi_unified_t wmi_handle)
  171. {
  172. return false;
  173. }
  174. #endif
  175. /**
  176. * WMA Callback to process fw event.
  177. */
  178. void wmi_process_fw_event(struct wmi_unified *wmi_handle, wmi_buf_t evt_buf);
  179. uint16_t wmi_get_max_msg_len(wmi_unified_t wmi_handle);
  180. int32_t wmi_unified_vdev_create_send(void *wmi_hdl,
  181. uint8_t macaddr[IEEE80211_ADDR_LEN],
  182. struct vdev_create_params *param);
  183. int32_t wmi_unified_vdev_delete_send(void *wmi_hdl,
  184. uint8_t if_id);
  185. int32_t wmi_unified_vdev_start_send(void *wmi_hdl,
  186. uint8_t macaddr[IEEE80211_ADDR_LEN],
  187. struct vdev_start_params *param);
  188. int32_t wmi_unified_vdev_restart_send(void *wmi_hdl,
  189. uint8_t macaddr[IEEE80211_ADDR_LEN],
  190. struct vdev_start_params *param);
  191. int32_t wmi_unified_vdev_stop_send(void *wmi_hdl,
  192. uint8_t vdev_id);
  193. int32_t wmi_unified_vdev_up_send(void *wmi_hdl,
  194. uint8_t bssid[IEEE80211_ADDR_LEN],
  195. struct vdev_up_params *params);
  196. int32_t wmi_unified_vdev_down_send(void *wmi_hdl,
  197. uint8_t vdev_id);
  198. int32_t wmi_unified_vdev_set_param_send(void *wmi_hdl,
  199. struct vdev_set_params *param);
  200. int32_t wmi_unified_peer_delete_send(void *wmi_hdl,
  201. uint8_t
  202. peer_addr[IEEE80211_ADDR_LEN],
  203. uint8_t vdev_id);
  204. int32_t wmi_unified_peer_flush_tids_send(void *wmi_hdl,
  205. uint8_t peer_addr[IEEE80211_ADDR_LEN],
  206. struct peer_flush_params *param);
  207. int32_t wmi_set_peer_param_send(void *wmi_hdl,
  208. uint8_t peer_addr[IEEE80211_ADDR_LEN],
  209. struct peer_set_params *param);
  210. int32_t wmi_unified_peer_create_send(void *wmi_hdl,
  211. struct peer_create_params *param);
  212. int32_t wmi_unified_stats_request_send(void *wmi_hdl,
  213. uint8_t macaddr[IEEE80211_ADDR_LEN],
  214. struct stats_request_params *param);
  215. int32_t wmi_unified_green_ap_ps_send(void *wmi_hdl,
  216. uint32_t value, uint8_t mac_id);
  217. int32_t wmi_unified_wow_enable_send(void *wmi_hdl,
  218. struct wow_cmd_params *param,
  219. uint8_t mac_id);
  220. int32_t wmi_unified_packet_log_enable_send(void *wmi_hdl,
  221. uint8_t macaddr[IEEE80211_ADDR_LEN],
  222. struct packet_enable_params *param);
  223. int32_t wmi_unified_suspend_send(void *wmi_hdl,
  224. struct suspend_params *param,
  225. uint8_t mac_id);
  226. int32_t wmi_unified_resume_send(void *wmi_hdl,
  227. uint8_t mac_id);
  228. int32_t
  229. wmi_unified_pdev_param_send(void *wmi_hdl,
  230. struct pdev_params *param,
  231. uint8_t mac_id);
  232. int32_t wmi_unified_beacon_send_cmd(void *wmi_hdl,
  233. uint8_t macaddr[IEEE80211_ADDR_LEN],
  234. struct beacon_params *param);
  235. int32_t wmi_unified_peer_assoc_send(void *wmi_hdl,
  236. uint8_t macaddr[IEEE80211_ADDR_LEN],
  237. struct peer_assoc_params *param);
  238. int32_t wmi_unified_sta_ps_cmd_send(void *wmi_hdl,
  239. struct sta_ps_params *param);
  240. int32_t wmi_unified_ap_ps_cmd_send(void *wmi_hdl,
  241. uint8_t macaddr[IEEE80211_ADDR_LEN],
  242. struct ap_ps_params *param);
  243. int32_t wmi_unified_scan_start_cmd_send(void *wmi_hdl,
  244. uint8_t macaddr[IEEE80211_ADDR_LEN],
  245. struct scan_start_params *param);
  246. int32_t wmi_unified_scan_stop_cmd_send(void *wmi_hdl,
  247. uint8_t macaddr[IEEE80211_ADDR_LEN],
  248. struct scan_stop_params *param);
  249. int32_t wmi_unified_scan_chan_list_cmd_send(void *wmi_hdl,
  250. uint8_t macaddr[IEEE80211_ADDR_LEN],
  251. struct scan_chan_list_params *param);
  252. int32_t wmi_crash_inject(void *wmi_hdl,
  253. struct crash_inject *param);
  254. int32_t wmi_unified_pdev_utf_cmd_send(void *wmi_hdl,
  255. struct pdev_utf_params *param,
  256. uint8_t mac_id);
  257. int32_t wmi_unified_dbglog_cmd_send(void *wmi_hdl,
  258. struct dbglog_params *param);
  259. #endif /* _WMI_UNIFIED_API_H_ */