diff options
Diffstat (limited to 'bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c')
| -rw-r--r-- | bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c | 268 |
1 files changed, 133 insertions, 135 deletions
diff --git a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c index b11d058fa3..355f54204b 100644 --- a/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c +++ b/bsps/arm/stm32h7/hal/stm32h7xx_hal_dfsdm_ex.c @@ -1,138 +1,136 @@ -/**
- ******************************************************************************
- * @file stm32h7xx_hal_dfsdm_ex.c
- * @author MCD Application Team
- * @brief DFSDM Extended HAL module driver.
- * This file provides firmware functions to manage the following
- * functionality of the DFSDM Peripheral Controller:
- * + Set and get pulses skipping on channel.
- *
- ******************************************************************************
- * @attention
- *
- * <h2><center>© Copyright (c) 2017 STMicroelectronics.
- * All rights reserved.</center></h2>
- *
- * This software component is licensed by ST under BSD 3-Clause license,
- * the "License"; You may not use this file except in compliance with the
- * License. You may obtain a copy of the License at:
- * opensource.org/licenses/BSD-3-Clause
- *
- ******************************************************************************
- */
-
-/* Includes ------------------------------------------------------------------*/
-#include "stm32h7xx_hal.h"
-
-/** @addtogroup STM32H7xx_HAL_Driver
- * @{
- */
-
-#ifdef HAL_DFSDM_MODULE_ENABLED
-
-#if defined(DFSDM_CHDLYR_PLSSKP)
-
-/** @defgroup DFSDMEx DFSDMEx
+/** + ****************************************************************************** + * @file stm32h7xx_hal_dfsdm_ex.c + * @author MCD Application Team + * @brief DFSDM Extended HAL module driver. + * This file provides firmware functions to manage the following + * functionality of the DFSDM Peripheral Controller: + * + Set and get pulses skipping on channel. + * + ****************************************************************************** + * @attention + * + * Copyright (c) 2017 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + +/* Includes ------------------------------------------------------------------*/ +#include "stm32h7xx_hal.h" + +/** @addtogroup STM32H7xx_HAL_Driver + * @{ + */ + +#ifdef HAL_DFSDM_MODULE_ENABLED + +#if defined(DFSDM_CHDLYR_PLSSKP) + +/** @defgroup DFSDMEx DFSDMEx * @ingroup RTEMSBSPsARMSTM32H7 - * @brief DFSDM Extended HAL module driver
- * @{
- */
-
-/* Private types -------------------------------------------------------------*/
-/* Private variables ---------------------------------------------------------*/
-/* Private constants ---------------------------------------------------------*/
-/* Private macros ------------------------------------------------------------*/
-/* Private functions ---------------------------------------------------------*/
-/* Exported functions --------------------------------------------------------*/
-
-/** @defgroup DFSDMEx_Exported_Functions DFSDM Extended Exported Functions
+ * @brief DFSDM Extended HAL module driver + * @{ + */ + +/* Private types -------------------------------------------------------------*/ +/* Private variables ---------------------------------------------------------*/ +/* Private constants ---------------------------------------------------------*/ +/* Private macros ------------------------------------------------------------*/ +/* Private functions ---------------------------------------------------------*/ +/* Exported functions --------------------------------------------------------*/ + +/** @defgroup DFSDMEx_Exported_Functions DFSDM Extended Exported Functions * @ingroup RTEMSBSPsARMSTM32H7 - * @{
- */
-
-/** @defgroup DFSDMEx_Exported_Functions_Group1_Channel Extended channel operation functions
+ * @{ + */ + +/** @defgroup DFSDMEx_Exported_Functions_Group1_Channel Extended channel operation functions * @ingroup RTEMSBSPsARMSTM32H7 - * @brief DFSDM extended channel operation functions
- *
-@verbatim
- ===============================================================================
- ##### Extended channel operation functions #####
- ===============================================================================
- [..] This section provides functions allowing to:
- (+) Set and get value of pulses skipping on channel
-
-@endverbatim
- * @{
- */
-
-/**
- * @brief Set value of pulses skipping.
- * @param hdfsdm_channel DFSDM channel handle.
- * @param PulsesValue Value of pulses to be skipped.
- * This parameter must be a number between Min_Data = 0 and Max_Data = 63.
- * @retval HAL status.
- */
-HAL_StatusTypeDef HAL_DFDSMEx_ChannelSetPulsesSkipping(DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t PulsesValue)
-{
- HAL_StatusTypeDef status = HAL_OK;
-
- /* Check pulses value */
- assert_param(IS_DFSDM_CHANNEL_SKIPPING_VALUE(PulsesValue));
-
- /* Check DFSDM channel state */
- if (hdfsdm_channel->State == HAL_DFSDM_CHANNEL_STATE_READY)
- {
- /* Set new value of pulses skipping */
- hdfsdm_channel->Instance->CHDLYR = (PulsesValue & DFSDM_CHDLYR_PLSSKP);
- }
- else
- {
- status = HAL_ERROR;
- }
- return status;
-}
-
-/**
- * @brief Get value of pulses skipping.
- * @param hdfsdm_channel DFSDM channel handle.
- * @param PulsesValue Value of pulses to be skipped.
- * @retval HAL status.
- */
-HAL_StatusTypeDef HAL_DFDSMEx_ChannelGetPulsesSkipping(DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t *PulsesValue)
-{
- HAL_StatusTypeDef status = HAL_OK;
-
- /* Check DFSDM channel state */
- if (hdfsdm_channel->State == HAL_DFSDM_CHANNEL_STATE_READY)
- {
- /* Get value of remaining pulses to be skipped */
- *PulsesValue = (hdfsdm_channel->Instance->CHDLYR & DFSDM_CHDLYR_PLSSKP);
- }
- else
- {
- status = HAL_ERROR;
- }
- return status;
-}
-
-/**
- * @}
- */
-
-/**
- * @}
- */
-
-/**
- * @}
- */
-
-#endif /* DFSDM_CHDLYR_PLSSKP */
-
-#endif /* HAL_DFSDM_MODULE_ENABLED */
-
-/**
- * @}
- */
-
-/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
+ * @brief DFSDM extended channel operation functions + * +@verbatim + =============================================================================== + ##### Extended channel operation functions ##### + =============================================================================== + [..] This section provides functions allowing to: + (+) Set and get value of pulses skipping on channel + +@endverbatim + * @{ + */ + +/** + * @brief Set value of pulses skipping. + * @param hdfsdm_channel DFSDM channel handle. + * @param PulsesValue Value of pulses to be skipped. + * This parameter must be a number between Min_Data = 0 and Max_Data = 63. + * @retval HAL status. + */ +HAL_StatusTypeDef HAL_DFDSMEx_ChannelSetPulsesSkipping(DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t PulsesValue) +{ + HAL_StatusTypeDef status = HAL_OK; + + /* Check pulses value */ + assert_param(IS_DFSDM_CHANNEL_SKIPPING_VALUE(PulsesValue)); + + /* Check DFSDM channel state */ + if (hdfsdm_channel->State == HAL_DFSDM_CHANNEL_STATE_READY) + { + /* Set new value of pulses skipping */ + hdfsdm_channel->Instance->CHDLYR = (PulsesValue & DFSDM_CHDLYR_PLSSKP); + } + else + { + status = HAL_ERROR; + } + return status; +} + +/** + * @brief Get value of pulses skipping. + * @param hdfsdm_channel DFSDM channel handle. + * @param PulsesValue Value of pulses to be skipped. + * @retval HAL status. + */ +HAL_StatusTypeDef HAL_DFDSMEx_ChannelGetPulsesSkipping(const DFSDM_Channel_HandleTypeDef *hdfsdm_channel, uint32_t *PulsesValue) +{ + HAL_StatusTypeDef status = HAL_OK; + + /* Check DFSDM channel state */ + if (hdfsdm_channel->State == HAL_DFSDM_CHANNEL_STATE_READY) + { + /* Get value of remaining pulses to be skipped */ + *PulsesValue = (hdfsdm_channel->Instance->CHDLYR & DFSDM_CHDLYR_PLSSKP); + } + else + { + status = HAL_ERROR; + } + return status; +} + +/** + * @} + */ + +/** + * @} + */ + +/** + * @} + */ + +#endif /* DFSDM_CHDLYR_PLSSKP */ + +#endif /* HAL_DFSDM_MODULE_ENABLED */ + +/** + * @} + */ + |