ssi_pal_sem_plat.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. /**************************************************************************************
  2. * Copyright (c) 2016-2017, ARM Limited or its affiliates. All rights reserved *
  3. * *
  4. * This file and the related binary are licensed under the following license: *
  5. * *
  6. * ARM Object Code and Header Files License, v1.0 Redistribution. *
  7. * *
  8. * Redistribution and use of object code, header files, and documentation, without *
  9. * modification, are permitted provided that the following conditions are met: *
  10. * *
  11. * 1) Redistributions must reproduce the above copyright notice and the *
  12. * following disclaimer in the documentation and/or other materials *
  13. * provided with the distribution. *
  14. * *
  15. * 2) Unless to the extent explicitly permitted by law, no reverse *
  16. * engineering, decompilation, or disassembly of is permitted. *
  17. * *
  18. * 3) Redistribution and use is permitted solely for the purpose of *
  19. * developing or executing applications that are targeted for use *
  20. * on an ARM-based product. *
  21. * *
  22. * DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND *
  23. * CONTRIBUTORS "AS IS." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT *
  24. * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, *
  25. * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE *
  26. * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, *
  27. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED *
  28. * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
  29. * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
  30. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
  31. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
  32. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
  33. **************************************************************************************/
  34. #ifndef _SSI_PAL_SEM_INT__H
  35. #define _SSI_PAL_SEM_INT__H
  36. #ifdef __cplusplus
  37. extern "C"
  38. {
  39. #endif
  40. #include "ssi_pal_types.h"
  41. /**
  42. * @brief File Description:
  43. * This file contains functions for resource management (semaphor operations).
  44. * The functions implementations are generally just wrappers to different operating system calls.
  45. * None of the described functions will check the input parameters so the behavior
  46. * of the APIs in illegal parameters case is dependent on the operating system behavior.
  47. *
  48. */
  49. typedef int DX_PAL_SEM;
  50. /*----------------------------
  51. PUBLIC FUNCTIONS
  52. -----------------------------------*/
  53. /**
  54. * @brief This function purpose is to create a semaphore.
  55. *
  56. *
  57. * @param[out] aSemId - Pointer to created semaphor handle
  58. * @param[in] aInitialVal - Initial semaphore value
  59. *
  60. * @return The return values is according to operating system return values.
  61. */
  62. SaSiError_t _SaSi_PalSemCreate( DX_PAL_SEM *aSemId, uint32_t aInitialVal );
  63. #define _SaSi_PalSemCreate(aSemId,aInitialVal) SASI_SUCCESS
  64. /**
  65. * @brief This function purpose is to delete a semaphore
  66. *
  67. *
  68. * @param[in] aSemId - Semaphore handle
  69. *
  70. * @return The return values is according to operating system return values.
  71. */
  72. SaSiError_t _SaSi_PalSemDelete( DX_PAL_SEM *aSemId );
  73. #define _SaSi_PalSemDelete( aSemId ) SASI_SUCCESS
  74. /**
  75. * @brief This function purpose is to Wait for semaphore with aTimeOut. aTimeOut is
  76. * specified in milliseconds.
  77. *
  78. *
  79. * @param[in] aSemId - Semaphore handle
  80. * @param[in] aTimeOut - timeout in mSec, or SASI_INFINITE
  81. *
  82. * @return The return values is according to operating system return values.
  83. */
  84. SaSiError_t _SaSi_PalSemWait(DX_PAL_SEM aSemId, uint32_t aTimeOut);
  85. #define _SaSi_PalSemWait(aSemId, aTimeOut) SASI_SUCCESS
  86. /**
  87. * @brief This function purpose is to signal the semaphore.
  88. *
  89. *
  90. * @param[in] aSemId - Semaphore handle
  91. *
  92. * @return The return values is according to operating system return values.
  93. */
  94. SaSiError_t _SaSi_PalSemGive(DX_PAL_SEM aSemId);
  95. #define _SaSi_PalSemGive(aSemId) SASI_SUCCESS
  96. #ifdef __cplusplus
  97. }
  98. #endif
  99. #endif