stm32f4xx_hal_i2s_ex.h 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_i2s_ex.h
  4. * @author MCD Application Team
  5. * @version V1.3.0
  6. * @date 09-March-2015
  7. * @brief Header file of I2S HAL module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
  12. *
  13. * Redistribution and use in source and binary forms, with or without modification,
  14. * are permitted provided that the following conditions are met:
  15. * 1. Redistributions of source code must retain the above copyright notice,
  16. * this list of conditions and the following disclaimer.
  17. * 2. Redistributions in binary form must reproduce the above copyright notice,
  18. * this list of conditions and the following disclaimer in the documentation
  19. * and/or other materials provided with the distribution.
  20. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  21. * may be used to endorse or promote products derived from this software
  22. * without specific prior written permission.
  23. *
  24. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34. *
  35. ******************************************************************************
  36. */
  37. /* Define to prevent recursive inclusion -------------------------------------*/
  38. #ifndef __STM32F4xx_HAL_I2S_EX_H
  39. #define __STM32F4xx_HAL_I2S_EX_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. /* Includes ------------------------------------------------------------------*/
  44. #include "stm32f4xx_hal_def.h"
  45. /** @addtogroup STM32F4xx_HAL_Driver
  46. * @{
  47. */
  48. /** @addtogroup I2SEx
  49. * @{
  50. */
  51. /* Exported types ------------------------------------------------------------*/
  52. /** @defgroup I2SEx_Exported_Types I2S Exported Types
  53. * @{
  54. */
  55. /**
  56. * @}
  57. */
  58. /* Exported constants --------------------------------------------------------*/
  59. /** @defgroup I2SEx_Exported_Constants I2S Exported Constants
  60. * @{
  61. */
  62. /**
  63. * @}
  64. */
  65. /* Exported macro ------------------------------------------------------------*/
  66. /** @defgroup I2SEx_Exported_Macros I2S Exported Macros
  67. * @{
  68. */
  69. /**
  70. * @}
  71. */
  72. /* Exported functions --------------------------------------------------------*/
  73. /** @addtogroup I2SEx_Exported_Functions
  74. * @{
  75. */
  76. /** @addtogroup I2SEx_Exported_Functions_Group1
  77. * @{
  78. */
  79. /* Extended features functions **************************************************/
  80. /* Blocking mode: Polling */
  81. HAL_StatusTypeDef HAL_I2SEx_TransmitReceive(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size, uint32_t Timeout);
  82. /* Non-Blocking mode: Interrupt */
  83. HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
  84. /* Non-Blocking mode: DMA */
  85. HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
  86. /**
  87. * @}
  88. */
  89. /**
  90. * @}
  91. */
  92. /* Private types -------------------------------------------------------------*/
  93. /* Private variables ---------------------------------------------------------*/
  94. /* Private constants ---------------------------------------------------------*/
  95. /** @defgroup I2SEx_Private_Constants I2S Private Constants
  96. * @{
  97. */
  98. /**
  99. * @}
  100. */
  101. /* Private macros ------------------------------------------------------------*/
  102. /** @defgroup I2SEx_Private_Macros I2S Private Macros
  103. * @{
  104. */
  105. /**
  106. * @}
  107. */
  108. /* Private functions ---------------------------------------------------------*/
  109. /** @defgroup I2SEx_Private_Functions I2S Private Functions
  110. * @{
  111. */
  112. HAL_StatusTypeDef I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s);
  113. uint32_t I2S_GetInputClock(I2S_HandleTypeDef *hi2s);
  114. /**
  115. * @}
  116. */
  117. /**
  118. * @}
  119. */
  120. /**
  121. * @}
  122. */
  123. #ifdef __cplusplus
  124. }
  125. #endif
  126. #endif /* __STM32F4xx_HAL_I2S_EX_H */
  127. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/