nrf_drv_saadc.h 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. /**
  2. * Copyright (c) 2015 - 2019, 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 NRF_DRV_SAADC_H__
  41. #define NRF_DRV_SAADC_H__
  42. #include <nrfx_saadc.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /**
  47. * @defgroup nrf_drv_saadc SAADC driver - legacy layer
  48. * @{
  49. * @ingroup nrf_saadc
  50. *
  51. * @brief @tagAPI52 Layer providing compatibility with the former API.
  52. */
  53. /** @brief Type definition for forwarding the new implementation. */
  54. typedef nrfx_saadc_config_t nrf_drv_saadc_config_t;
  55. /** @brief Macro for forwarding the new implementation. */
  56. #define NRF_DRV_SAADC_EVT_DONE NRFX_SAADC_EVT_DONE
  57. /** @brief Macro for forwarding the new implementation. */
  58. #define NRF_DRV_SAADC_EVT_LIMIT NRFX_SAADC_EVT_LIMIT
  59. /** @brief Macro for forwarding the new implementation. */
  60. #define NRF_DRV_SAADC_EVT_CALIBRATEDONE NRFX_SAADC_EVT_CALIBRATEDONE
  61. /** @brief Macro for forwarding the new implementation. */
  62. #define nrf_drv_saadc_evt_type_t nrfx_saadc_evt_type_t
  63. /** @brief Macro for forwarding the new implementation. */
  64. #define nrf_drv_saadc_done_evt_t nrfx_saadc_done_evt_t
  65. /** @brief Macro for forwarding the new implementation. */
  66. #define nrf_drv_saadc_limit_evt_t nrfx_saadc_limit_evt_t
  67. /** @brief Macro for forwarding the new implementation. */
  68. #define nrf_drv_saadc_evt_t nrfx_saadc_evt_t
  69. /** @brief Macro for forwarding the new implementation. */
  70. #define nrf_drv_saadc_event_handler_t nrfx_saadc_event_handler_t
  71. /** @brief Macro for forwarding the new implementation. */
  72. #define NRF_DRV_SAADC_LIMITH_DISABLED NRFX_SAADC_LIMITH_DISABLED
  73. /** @brief Macro for forwarding the new implementation. */
  74. #define NRF_DRV_SAADC_LIMITL_DISABLED NRFX_SAADC_LIMITL_DISABLED
  75. /** @brief Macro for forwarding the new implementation. */
  76. #define NRF_DRV_SAADC_DEFAULT_CONFIG NRFX_SAADC_DEFAULT_CONFIG
  77. /** @brief Macro for forwarding the new implementation. */
  78. #define NRF_DRV_SAADC_DEFAULT_CHANNEL_CONFIG_SE \
  79. NRFX_SAADC_DEFAULT_CHANNEL_CONFIG_SE
  80. /** @brief Macro for forwarding the new implementation. */
  81. #define NRF_DRV_SAADC_DEFAULT_CHANNEL_CONFIG_DIFFERENTIAL \
  82. NRFX_SAADC_DEFAULT_CHANNEL_CONFIG_DIFFERENTIAL
  83. /** @brief Macro for forwarding the new implementation. */
  84. #define nrf_drv_saadc_uninit nrfx_saadc_uninit
  85. /** @brief Macro for forwarding the new implementation. */
  86. #define nrf_drv_saadc_channel_init nrfx_saadc_channel_init
  87. /** @brief Macro for forwarding the new implementation. */
  88. #define nrf_drv_saadc_channel_uninit nrfx_saadc_channel_uninit
  89. /** @brief Macro for forwarding the new implementation. */
  90. #define nrf_drv_saadc_sample nrfx_saadc_sample
  91. /** @brief Macro for forwarding the new implementation. */
  92. #define nrf_drv_saadc_sample_convert nrfx_saadc_sample_convert
  93. /** @brief Macro for forwarding the new implementation. */
  94. #define nrf_drv_saadc_buffer_convert nrfx_saadc_buffer_convert
  95. /** @brief Macro for forwarding the new implementation. */
  96. #define nrf_drv_saadc_calibrate_offset nrfx_saadc_calibrate_offset
  97. /** @brief Macro for forwarding the new implementation. */
  98. #define nrf_drv_saadc_is_busy nrfx_saadc_is_busy
  99. /** @brief Macro for forwarding the new implementation. */
  100. #define nrf_drv_saadc_abort nrfx_saadc_abort
  101. /** @brief Macro for forwarding the new implementation. */
  102. #define nrf_drv_saadc_limits_set nrfx_saadc_limits_set
  103. /** @brief Macro for forwarding the new implementation. */
  104. #define nrf_drv_saadc_sample_task_get nrfx_saadc_sample_task_get
  105. /**
  106. * @brief Function for initializing the SAADC.
  107. *
  108. * @param[in] p_config Pointer to the structure with initial configuration.
  109. * If NULL, the default one is used.
  110. * @param[in] event_handler Event handler provided by the user.
  111. *
  112. * @retval NRF_SUCCESS If initialization was successful.
  113. * @retval NRF_ERROR_INVALID_STATE If the driver is already initialized.
  114. * @retval NRF_ERROR_INVALID_PARAM If event_handler is NULL.
  115. */
  116. __STATIC_INLINE ret_code_t nrf_drv_saadc_init(nrf_drv_saadc_config_t const * p_config,
  117. nrf_drv_saadc_event_handler_t event_handler)
  118. {
  119. if (p_config == NULL)
  120. {
  121. static const nrfx_saadc_config_t default_config = NRFX_SAADC_DEFAULT_CONFIG;
  122. p_config = &default_config;
  123. }
  124. return nrfx_saadc_init(p_config, event_handler);
  125. }
  126. __STATIC_INLINE nrf_saadc_input_t nrf_drv_saadc_gpio_to_ain(uint8_t pin_no)
  127. {
  128. switch(pin_no)
  129. {
  130. case 2:
  131. return NRF_SAADC_INPUT_AIN0;
  132. case 3:
  133. return NRF_SAADC_INPUT_AIN1;
  134. case 4:
  135. return NRF_SAADC_INPUT_AIN2;
  136. case 5:
  137. return NRF_SAADC_INPUT_AIN3;
  138. case 28:
  139. return NRF_SAADC_INPUT_AIN4;
  140. case 29:
  141. return NRF_SAADC_INPUT_AIN5;
  142. case 30:
  143. return NRF_SAADC_INPUT_AIN6;
  144. case 31:
  145. return NRF_SAADC_INPUT_AIN7;
  146. default:
  147. APP_ERROR_CHECK(NRF_ERROR_NOT_FOUND);
  148. }
  149. return NRF_SAADC_INPUT_DISABLED;
  150. }
  151. /** @} */
  152. #ifdef __cplusplus
  153. }
  154. #endif
  155. #endif // NRF_DRV_SAADC_H__