Subversion Repositories DashDisplay

/**

  ******************************************************************************

  * @file    stm32f1xx_hal_iwdg.h

  * @author  MCD Application Team

  * @version V1.0.4

  * @date    29-April-2016

  * @brief   Header file of IWDG HAL module.

  ******************************************************************************

  * @attention

  *

  * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>

  *

  * Redistribution and use in source and binary forms, with or without modification,

  * are permitted provided that the following conditions are met:

  *   1. Redistributions of source code must retain the above copyright notice,

  *      this list of conditions and the following disclaimer.

  *   2. Redistributions in binary form must reproduce the above copyright notice,

  *      this list of conditions and the following disclaimer in the documentation

  *      and/or other materials provided with the distribution.

  *   3. Neither the name of STMicroelectronics nor the names of its contributors

  *      may be used to endorse or promote products derived from this software

  *      without specific prior written permission.

  *

  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  *

  ******************************************************************************

  */

/* Define to prevent recursive inclusion -------------------------------------*/

#ifndef __STM32F1xx_HAL_IWDG_H

#define __STM32F1xx_HAL_IWDG_H

#ifdef __cplusplus

 extern "C" {

#endif

/* Includes ------------------------------------------------------------------*/

#include "stm32f1xx_hal_def.h"

/** @addtogroup STM32F1xx_HAL_Driver

  * @{

  */

/** @addtogroup IWDG

  * @{

  */

/* Exported types ------------------------------------------------------------*/

/** @defgroup IWDG_Exported_Types IWDG Exported Types

  * @{

  */

/**

  * @brief  IWDG HAL State Structure definition  

  */

typedef enum

{

  HAL_IWDG_STATE_RESET     = 0x00,  /*!< IWDG not yet initialized or disabled */

  HAL_IWDG_STATE_READY     = 0x01,  /*!< IWDG initialized and ready for use   */

  HAL_IWDG_STATE_BUSY      = 0x02,  /*!< IWDG internal process is ongoing     */

  HAL_IWDG_STATE_TIMEOUT   = 0x03,  /*!< IWDG timeout state                   */

  HAL_IWDG_STATE_ERROR     = 0x04   /*!< IWDG error state                     */

}HAL_IWDG_StateTypeDef;

/**

  * @brief  IWDG Init structure definition  

  */

typedef struct

{

  uint32_t Prescaler;  /*!< Select the prescaler of the IWDG.  

                            This parameter can be a value of @ref IWDG_Prescaler */

  uint32_t Reload;     /*!< Specifies the IWDG down-counter reload value.

                            This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */

}IWDG_InitTypeDef;

/**

  * @brief  IWDG Handle Structure definition  

  */

typedef struct

{

  IWDG_TypeDef                 *Instance;  /*!< Register base address    */

  IWDG_InitTypeDef             Init;       /*!< IWDG required parameters */

  HAL_LockTypeDef              Lock;       /*!< IWDG Locking object      */

  __IO HAL_IWDG_StateTypeDef   State;      /*!< IWDG communication state */

}IWDG_HandleTypeDef;

/**

  * @}

  */

/* Exported constants --------------------------------------------------------*/

/** @defgroup IWDG_Exported_Constants IWDG Exported Constants

  * @{

  */

/** @defgroup IWDG_Registers_BitMask IWDG Registers BitMask

  * @brief IWDG registers bit mask

  * @{

  */

/* --- KR Register ---*/

/* KR register bit mask */

#define IWDG_KEY_RELOAD               ((uint32_t)0xAAAA)  /*!< IWDG Reload Counter Enable   */

#define IWDG_KEY_ENABLE               ((uint32_t)0xCCCC)  /*!< IWDG Peripheral Enable       */

#define IWDG_KEY_WRITE_ACCESS_ENABLE  ((uint32_t)0x5555)  /*!< IWDG KR Write Access Enable  */

#define IWDG_KEY_WRITE_ACCESS_DISABLE ((uint32_t)0x0000)  /*!< IWDG KR Write Access Disable */

/**

  * @}

  */

/** @defgroup IWDG_Flag_definition IWDG Flag definition

  * @{

  */

#define IWDG_FLAG_PVU   ((uint32_t)IWDG_SR_PVU)  /*!< Watchdog counter prescaler value update Flag */

#define IWDG_FLAG_RVU   ((uint32_t)IWDG_SR_RVU)  /*!< Watchdog counter reload value update Flag    */

/**

  * @}

  */

/** @defgroup IWDG_Prescaler IWDG Prescaler

  * @{

  */

#define IWDG_PRESCALER_4     ((uint8_t)0x00)  /*!< IWDG prescaler set to 4   */

#define IWDG_PRESCALER_8     ((uint8_t)(IWDG_PR_PR_0))                  /*!< IWDG prescaler set to 8   */

#define IWDG_PRESCALER_16    ((uint8_t)(IWDG_PR_PR_1))                  /*!< IWDG prescaler set to 16  */

#define IWDG_PRESCALER_32    ((uint8_t)(IWDG_PR_PR_1 | IWDG_PR_PR_0))   /*!< IWDG prescaler set to 32  */

#define IWDG_PRESCALER_64    ((uint8_t)(IWDG_PR_PR_2))                  /*!< IWDG prescaler set to 64  */

#define IWDG_PRESCALER_128   ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_0))   /*!< IWDG prescaler set to 128 */

#define IWDG_PRESCALER_256   ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_1))   /*!< IWDG prescaler set to 256 */

/**

  * @}

  */

/**

  * @}

  */

/* Exported macros -----------------------------------------------------------*/

/** @defgroup IWDG_Exported_Macros IWDG Exported Macros

  * @{

  */

/** @brief Reset IWDG handle state

  * @param  __HANDLE__: IWDG handle.

  * @retval None

  */

#define __HAL_IWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IWDG_STATE_RESET)

/**

  * @brief  Enables the IWDG peripheral.

  * @param  __HANDLE__: IWDG handle

  * @retval None

  */

#define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)

/**

  * @brief  Reloads IWDG counter with value defined in the reload register

  *         (write access to IWDG_PR and IWDG_RLR registers disabled).

  * @param  __HANDLE__: IWDG handle

  * @retval None

  */

#define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)

/**

  * @brief  Gets the selected IWDG's flag status.

  * @param  __HANDLE__: IWDG handle

  * @param  __FLAG__: specifies the flag to check.

  *         This parameter can be one of the following values:

  *            @arg IWDG_FLAG_PVU: Watchdog counter reload value update flag

  *            @arg IWDG_FLAG_RVU: Watchdog counter prescaler value flag

  * @retval The new state of __FLAG__ (TRUE or FALSE).

  */

#define __HAL_IWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))

/**

  * @}

  */

/* Private macro -------------------------------------------------------------*/

/** @defgroup IWDG_Private_Macros IWDG Private Macros

  * @{

  */

/**

  * @brief  Enables write access to IWDG_PR and IWDG_RLR registers.

  * @param  __HANDLE__: IWDG handle

  * @retval None

  */

#define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)

/**

  * @brief  Disables write access to IWDG_PR and IWDG_RLR registers.

  * @param  __HANDLE__: IWDG handle

  * @retval None

  */

#define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)

#define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4)  || \

                                          ((__PRESCALER__) == IWDG_PRESCALER_8)  || \

                                          ((__PRESCALER__) == IWDG_PRESCALER_16) || \

                                          ((__PRESCALER__) == IWDG_PRESCALER_32) || \

                                          ((__PRESCALER__) == IWDG_PRESCALER_64) || \

                                          ((__PRESCALER__) == IWDG_PRESCALER_128)|| \

                                          ((__PRESCALER__) == IWDG_PRESCALER_256))

#define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= 0xFFF)

/**

  * @}

  */

/* Exported functions --------------------------------------------------------*/

/** @addtogroup IWDG_Exported_Functions

  * @{

  */

/** @addtogroup IWDG_Exported_Functions_Group1

  * @{

  */

/* Initialization/de-initialization functions  ********************************/

HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);

void HAL_IWDG_MspInit(IWDG_HandleTypeDef *hiwdg);

/**

  * @}

  */

/** @addtogroup IWDG_Exported_Functions_Group2

  * @{

  */

/* I/O operation functions ****************************************************/

HAL_StatusTypeDef HAL_IWDG_Start(IWDG_HandleTypeDef *hiwdg);

HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);

/**

  * @}

  */

/** @addtogroup IWDG_Exported_Functions_Group3

  * @{

  */

/* Peripheral State functions  ************************************************/

HAL_IWDG_StateTypeDef HAL_IWDG_GetState(IWDG_HandleTypeDef *hiwdg);

/**

  * @}

  */

/**

  * @}

  */

/**

  * @}

  */

/**

  * @}

  */

#ifdef __cplusplus

}

#endif

#endif /* __STM32F1xx_HAL_IWDG_H */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/