cc310_backend_mutex.h 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. /**
  2. * Copyright (c) 2018 - 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 CC310_BACKEND_MUTEX_H__
  41. #define CC310_BACKEND_MUTEX_H__
  42. /** @file
  43. *
  44. * @defgroup nrf_crypto_cc310_backend_mutex nrf_crypto CC310 backend mutex.
  45. * @{
  46. * @ingroup nrf_crypto_cc310_backend
  47. *
  48. * @brief Mutex control for the nrf_crypto CC310 backend.
  49. */
  50. #include "sdk_config.h"
  51. #include "nrf_mtx.h"
  52. #if NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310) || NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_BL)
  53. #ifdef __cplusplus
  54. extern "C" {
  55. #endif
  56. extern nrf_mtx_t g_cc310_mutex;
  57. __STATIC_INLINE void cc310_backend_mutex_init(void);
  58. __STATIC_INLINE bool cc310_backend_mutex_trylock(void);
  59. __STATIC_INLINE void cc310_backend_mutex_unlock(void);
  60. #ifndef SUPPRESS_INLINE_IMPLEMENTATION
  61. /**@internal @brief Function initializing CC310 mutex.
  62. *
  63. * This function _must_ be called before other mutex operations.
  64. */
  65. __STATIC_INLINE void cc310_backend_mutex_init(void)
  66. {
  67. nrf_mtx_init(&g_cc310_mutex);
  68. }
  69. /**@internal @brief Function try to lock a CC310 mutex.
  70. *
  71. * @return true if lock was acquired, false if not.
  72. */
  73. __STATIC_INLINE bool cc310_backend_mutex_trylock(void)
  74. {
  75. return nrf_mtx_trylock(&g_cc310_mutex);
  76. }
  77. /**@internal @brief Unlock a CC310 mutex.
  78. *
  79. * This function _must_ only be called when holding the lock. Unlocking a mutex which you do not
  80. * hold will give undefined behavior.
  81. *
  82. */
  83. __STATIC_INLINE void cc310_backend_mutex_unlock(void)
  84. {
  85. nrf_mtx_unlock(&g_cc310_mutex);
  86. }
  87. #endif // SUPPRESS_INLINE_IMPLEMENTATION
  88. #ifdef __cplusplus
  89. }
  90. #endif
  91. #endif // NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310) || NRF_MODULE_ENABLED(NRF_CRYPTO_BACKEND_CC310_BL)
  92. /** @} */
  93. #endif // CC310_BACKEND_MUTEX_H__