ser_phy_debug_comm.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. /**
  2. * Copyright (c) 2014 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef SER_PHY_DEBUG_COMM_H__
  41. #define SER_PHY_DEBUG_COMM_H__
  42. #ifndef SER_PHY_HCI_DEBUG_ENABLE
  43. // empty definitions here
  44. #define DEBUG_EVT_HCI_PHY_EVT_TX_PKT_SENT(data)
  45. #define DEBUG_EVT_HCI_PHY_EVT_BUF_REQUEST(data)
  46. #define DEBUG_EVT_HCI_PHY_EVT_RX_PKT_RECEIVED(data)
  47. #define DEBUG_EVT_HCI_PHY_EVT_RX_PKT_DROPPED(data)
  48. #define DEBUG_EVT_HCI_PHY_EVT_TX_ERROR(data)
  49. #define DEBUG_EVT_SLIP_PACKET_TX(data)
  50. #define DEBUG_EVT_SLIP_ACK_TX(data)
  51. #define DEBUG_EVT_SLIP_PACKET_TXED(data)
  52. #define DEBUG_EVT_SLIP_ACK_TXED(data)
  53. #define DEBUG_EVT_SLIP_PACKET_RXED(data)
  54. #define DEBUG_EVT_SLIP_ACK_RXED(data)
  55. #define DEBUG_EVT_SLIP_ERR_RXED(data)
  56. #define DEBUG_EVT_TIMEOUT(data)
  57. #define DEBUG_HCI_RETX(data)
  58. #define DEBUG_EVT_MAIN_BUSY(data)
  59. #define DEBUG_EVT_TX_REQ(data)
  60. #else
  61. #include <stdint.h>
  62. #ifdef __cplusplus
  63. extern "C" {
  64. #endif
  65. //Low level hardware events
  66. typedef enum
  67. {
  68. HCI_PHY_EVT_TX_PKT_SENT,
  69. HCI_PHY_EVT_BUF_REQUEST,
  70. HCI_PHY_EVT_RX_PKT_RECEIVED,
  71. HCI_PHY_EVT_RX_PKT_DROPPED,
  72. HCI_PHY_EVT_TX_ERROR,
  73. HCI_SLIP_EVT_PACKET_TX,
  74. HCI_SLIP_EVT_ACK_TX,
  75. HCI_SLIP_EVT_PACKET_TXED,
  76. HCI_SLIP_EVT_ACK_TXED,
  77. HCI_SLIP_EVT_PACKET_RXED,
  78. HCI_SLIP_EVT_ACK_RXED,
  79. HCI_SLIP_EVT_ERR_RXED,
  80. HCI_TIMER_EVT_TIMEOUT,
  81. HCI_RETX,
  82. HCI_MAIN_BUSY,
  83. HCI_TX_REQ,
  84. HCI_PHY_EVT_MAX
  85. } hci_dbg_evt_type_t;
  86. //Low level hardware event definition
  87. typedef struct
  88. {
  89. hci_dbg_evt_type_t evt;
  90. uint32_t data;
  91. } hci_dbg_evt_t;
  92. typedef void (*hci_dbg_event_handler_t)(hci_dbg_evt_t event);
  93. void debug_init(hci_dbg_event_handler_t evt_callback);
  94. void debug_evt(hci_dbg_evt_type_t evt, uint32_t data);
  95. #define DEBUG_EVT(event_type, data) \
  96. do { \
  97. debug_evt(event_type, data); \
  98. } while (0);
  99. #define DEBUG_EVT_HCI_PHY_EVT_TX_PKT_SENT(data) \
  100. do { \
  101. DEBUG_EVT(HCI_PHY_EVT_TX_PKT_SENT, data); \
  102. } while (0);
  103. #define DEBUG_EVT_HCI_PHY_EVT_BUF_REQUEST(data) \
  104. do { \
  105. DEBUG_EVT(HCI_PHY_EVT_BUF_REQUEST, data); \
  106. } while (0);
  107. #define DEBUG_EVT_HCI_PHY_EVT_RX_PKT_RECEIVED(data) \
  108. do { \
  109. DEBUG_EVT(HCI_PHY_EVT_RX_PKT_RECEIVED, data); \
  110. } while (0);
  111. #define DEBUG_EVT_HCI_PHY_EVT_RX_PKT_DROPPED(data) \
  112. do { \
  113. DEBUG_EVT(HCI_PHY_EVT_RX_PKT_DROPPED, data); \
  114. } while (0);
  115. #define DEBUG_EVT_HCI_PHY_EVT_TX_ERROR(data) \
  116. do { \
  117. DEBUG_EVT(HCI_PHY_EVT_TX_ERROR, data); \
  118. } while (0);
  119. #define DEBUG_EVT_SLIP_PACKET_TX(data) \
  120. do { \
  121. DEBUG_EVT(HCI_SLIP_EVT_PACKET_TX, data); \
  122. } while (0);
  123. #define DEBUG_EVT_SLIP_ACK_TX(data) \
  124. do { \
  125. DEBUG_EVT(HCI_SLIP_EVT_ACK_TX, data); \
  126. } while (0);
  127. #define DEBUG_EVT_SLIP_PACKET_TXED(data) \
  128. do { \
  129. DEBUG_EVT(HCI_SLIP_EVT_PACKET_TXED, data); \
  130. } while (0);
  131. #define DEBUG_EVT_SLIP_ACK_TXED(data) \
  132. do { \
  133. DEBUG_EVT(HCI_SLIP_EVT_ACK_TXED, data); \
  134. } while (0);
  135. #define DEBUG_EVT_SLIP_PACKET_RXED(data) \
  136. do { \
  137. DEBUG_EVT(HCI_SLIP_EVT_PACKET_RXED, data); \
  138. } while (0);
  139. #define DEBUG_EVT_SLIP_ACK_RXED(data) \
  140. do { \
  141. DEBUG_EVT(HCI_SLIP_EVT_ACK_RXED, data); \
  142. } while (0);
  143. #define DEBUG_EVT_SLIP_ERR_RXED(data) \
  144. do { \
  145. DEBUG_EVT(HCI_SLIP_EVT_ERR_RXED, data); \
  146. } while (0);
  147. #define DEBUG_EVT_TIMEOUT(data) \
  148. do { \
  149. DEBUG_EVT(HCI_TIMER_EVT_TIMEOUT, data); \
  150. } while (0);
  151. #define DEBUG_HCI_RETX(data) \
  152. do { \
  153. DEBUG_EVT(HCI_RETX, data); \
  154. } while (0);
  155. #define DEBUG_EVT_MAIN_BUSY(data) \
  156. do { \
  157. DEBUG_EVT(HCI_MAIN_BUSY, data); \
  158. } while (0);
  159. #define DEBUG_EVT_TX_REQ(data) \
  160. do { \
  161. DEBUG_EVT(HCI_TX_REQ, data); \
  162. } while (0);
  163. #endif // SER_PHY_HCI_DEBUG_ENABLE
  164. #ifdef __cplusplus
  165. }
  166. #endif
  167. #endif // SER_PHY_DEBUG_COMM_H__