wmi_unified_dbr_api.h 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. /*
  2. * Copyright (c) 2013-2019 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 DBR component.
  20. */
  21. #ifndef _WMI_UNIFIED_DBR_API_H_
  22. #define _WMI_UNIFIED_DBR_API_H_
  23. #include "wmi_unified_dbr_param.h"
  24. /**
  25. * wmi_unified_dbr_ring_cfg: Configure direct buffer rx rings
  26. * @wmi_handle: WMI handle
  27. * @cfg: pointer to direct buffer rx config request
  28. *
  29. * Return: QDF status of operation
  30. */
  31. QDF_STATUS wmi_unified_dbr_ring_cfg(wmi_unified_t wmi_handle,
  32. struct direct_buf_rx_cfg_req *cfg);
  33. /**
  34. * wmi_extract_dbr_buf_release_fixed : Extract direct buffer rx fixed param
  35. * from buffer release event
  36. * @wmi_handle: WMI handle
  37. * @evt_buf: Event buffer
  38. * @param: Pointer to direct buffer rx response struct
  39. *
  40. * Return: QDF status of operation
  41. */
  42. QDF_STATUS wmi_extract_dbr_buf_release_fixed(
  43. wmi_unified_t wmi_handle,
  44. uint8_t *evt_buf,
  45. struct direct_buf_rx_rsp *param);
  46. /**
  47. * wmi_extract_dbr_buf_release_entry: Extract direct buffer rx buffer tlv
  48. *
  49. * @wmi_handle: WMI handle
  50. * @evt_buf: Event buffer
  51. * @idx: Index of the module for which capability is received
  52. * @param: Pointer to direct buffer rx entry
  53. *
  54. * Return: QDF status of operation
  55. */
  56. QDF_STATUS wmi_extract_dbr_buf_release_entry(
  57. wmi_unified_t wmi_handle,
  58. uint8_t *evt_buf, uint8_t idx,
  59. struct direct_buf_rx_entry *param);
  60. /**
  61. * wmi_extract_dbr_buf_metadata: Extract direct buffer metadata
  62. *
  63. * @wmi_handle: WMI handle
  64. * @evt_buf: Event buffer
  65. * @idx: Index of the module for which capability is received
  66. * @param: Pointer to direct buffer metadata
  67. *
  68. * Return: QDF status of operation
  69. */
  70. QDF_STATUS wmi_extract_dbr_buf_metadata(
  71. wmi_unified_t wmi_handle,
  72. uint8_t *evt_buf, uint8_t idx,
  73. struct direct_buf_rx_metadata *param);
  74. #endif /* _WMI_UNIFIED_DBR_API_H_ */