nrf_soc.h 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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 NRF_SOC_H__
  41. #define NRF_SOC_H__
  42. #include <stdint.h>
  43. #include "nrf.h"
  44. #ifdef __cplusplus
  45. extern "C" {
  46. #endif
  47. /**@brief Waits for an application event.
  48. *
  49. * An application event is either an application interrupt or a pended interrupt when the
  50. * interrupt is disabled. When the interrupt is enabled it will be taken immediately since
  51. * this function will wait in thread mode, then the execution will return in the application's
  52. * main thread. When an interrupt is disabled and gets pended it will return to the application's
  53. * thread main. The application must ensure that the pended flag is cleared using
  54. * ::sd_nvic_ClearPendingIRQ in order to sleep using this function. This is only necessary for
  55. * disabled interrupts, as the interrupt handler will clear the pending flag automatically for
  56. * enabled interrupts.
  57. *
  58. * In order to wake up from disabled interrupts, the SEVONPEND flag has to be set in the Cortex-M0
  59. * System Control Register (SCR). @sa CMSIS_SCB
  60. *
  61. * @note If an application interrupt has happened since the last time sd_app_evt_wait was
  62. * called this function will return immediately and not go to sleep. This is to avoid race
  63. * conditions that can occur when a flag is updated in the interrupt handler and processed
  64. * in the main loop.
  65. *
  66. * @post An application interrupt has happened or a interrupt pending flag is set.
  67. *
  68. * @retval ::NRF_SUCCESS
  69. */
  70. uint32_t sd_app_evt_wait(void);
  71. #ifdef __cplusplus
  72. }
  73. #endif
  74. #endif /* NRF_SOC_H__ */