2 ******************************************************************************
3 * @file stm32f0xx_hal_tim_ex.h
4 * @author MCD Application Team
6 * @date 11-December-2014
7 * @brief Header file of TIM HAL Extended module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
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.
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.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F0xx_HAL_TIM_EX_H
40 #define __STM32F0xx_HAL_TIM_EX_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f0xx_hal_def.h"
49 /** @addtogroup STM32F0xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
58 /** @defgroup TIMEx_Exported_Types TIMEx Extended Exported Types
63 * @brief TIM Hall sensor Configuration Structure definition
69 uint32_t IC1Polarity; /*!< Specifies the active edge of the input signal.
70 This parameter can be a value of @ref TIM_Input_Capture_Polarity */
72 uint32_t IC1Prescaler; /*!< Specifies the Input Capture Prescaler.
73 This parameter can be a value of @ref TIM_Input_Capture_Prescaler */
75 uint32_t IC1Filter; /*!< Specifies the input capture filter.
76 This parameter can be a number between Min_Data = 0x0 and Max_Data = 0xF */
77 uint32_t Commutation_Delay; /*!< Specifies the pulse value to be loaded into the Capture Compare Register.
78 This parameter can be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF */
79 } TIM_HallSensor_InitTypeDef;
82 * @brief TIM Master configuration Structure definition
85 uint32_t MasterOutputTrigger; /*!< Trigger output (TRGO) selection
86 This parameter can be a value of @ref TIM_Master_Mode_Selection */
87 uint32_t MasterSlaveMode; /*!< Master/slave mode selection
88 This parameter can be a value of @ref TIM_Master_Slave_Mode */
89 }TIM_MasterConfigTypeDef;
92 * @brief TIM Break and Dead time configuration Structure definition
96 uint32_t OffStateRunMode; /*!< TIM off state in run mode
97 This parameter can be a value of @ref TIM_OSSR_Off_State_Selection_for_Run_mode_state */
98 uint32_t OffStateIDLEMode; /*!< TIM off state in IDLE mode
99 This parameter can be a value of @ref TIM_OSSI_Off_State_Selection_for_Idle_mode_state */
100 uint32_t LockLevel; /*!< TIM Lock level
101 This parameter can be a value of @ref TIM_Lock_level */
102 uint32_t DeadTime; /*!< TIM dead Time
103 This parameter can be a number between Min_Data = 0x00 and Max_Data = 0xFF */
104 uint32_t BreakState; /*!< TIM Break State
105 This parameter can be a value of @ref TIM_Break_Input_enable_disable */
106 uint32_t BreakPolarity; /*!< TIM Break input polarity
107 This parameter can be a value of @ref TIM_Break_Polarity */
108 uint32_t AutomaticOutput; /*!< TIM Automatic Output Enable state
109 This parameter can be a value of @ref TIM_AOE_Bit_Set_Reset */
110 } TIM_BreakDeadTimeConfigTypeDef;
116 /* Exported constants --------------------------------------------------------*/
117 /** @defgroup TIMEx_Exported_Constants TIMEx Exported Constants
121 /** @defgroup TIMEx_Remap TIMEx Remap
125 #define TIM_TIM14_GPIO (0x00000000) /*!< TIM14 TI1 is connected to GPIO */
126 #define TIM_TIM14_RTC (0x00000001) /*!< TIM14 TI1 is connected to RTC_clock */
127 #define TIM_TIM14_HSE (0x00000002) /*!< TIM14 TI1 is connected to HSE/32 */
128 #define TIM_TIM14_MCO (0x00000003) /*!< TIM14 TI1 is connected to MCO */
130 #define IS_TIM_REMAP(TIM_REMAP) (((TIM_REMAP) == TIM_TIM14_GPIO) ||\
131 ((TIM_REMAP) == TIM_TIM14_RTC) ||\
132 ((TIM_REMAP) == TIM_TIM14_HSE) ||\
133 ((TIM_REMAP) == TIM_TIM14_MCO))
138 /** @defgroup TIM_Clock_Filter TIM Clock Filter
141 #define IS_TIM_DEADTIME(DEADTIME) ((DEADTIME) <= 0xFF)
150 /* Exported macro ------------------------------------------------------------*/
152 /* Exported functions --------------------------------------------------------*/
153 /** @addtogroup TIMEx_Exported_Functions
157 /** @addtogroup TIMEx_Exported_Functions_Group1 Timer Hall Sensor functions
158 * @brief Timer Hall Sensor functions
161 /* Timer Hall Sensor functions **********************************************/
162 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Init(TIM_HandleTypeDef *htim, TIM_HallSensor_InitTypeDef* sConfig);
163 HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit(TIM_HandleTypeDef *htim);
165 void HAL_TIMEx_HallSensor_MspInit(TIM_HandleTypeDef *htim);
166 void HAL_TIMEx_HallSensor_MspDeInit(TIM_HandleTypeDef *htim);
168 /* Blocking mode: Polling */
169 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start(TIM_HandleTypeDef *htim);
170 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop(TIM_HandleTypeDef *htim);
171 /* Non-Blocking mode: Interrupt */
172 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT(TIM_HandleTypeDef *htim);
173 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT(TIM_HandleTypeDef *htim);
174 /* Non-Blocking mode: DMA */
175 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_DMA(TIM_HandleTypeDef *htim, uint32_t *pData, uint16_t Length);
176 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA(TIM_HandleTypeDef *htim);
181 /** @addtogroup TIMEx_Exported_Functions_Group2 Timer Complementary Output Compare functions
182 * @brief Timer Complementary Output Compare functions
185 /* Timer Complementary Output Compare functions *****************************/
186 /* Blocking mode: Polling */
187 HAL_StatusTypeDef HAL_TIMEx_OCN_Start(TIM_HandleTypeDef *htim, uint32_t Channel);
188 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop(TIM_HandleTypeDef *htim, uint32_t Channel);
190 /* Non-Blocking mode: Interrupt */
191 HAL_StatusTypeDef HAL_TIMEx_OCN_Start_IT(TIM_HandleTypeDef *htim, uint32_t Channel);
192 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_IT(TIM_HandleTypeDef *htim, uint32_t Channel);
194 /* Non-Blocking mode: DMA */
195 HAL_StatusTypeDef HAL_TIMEx_OCN_Start_DMA(TIM_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length);
196 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Channel);
201 /** @addtogroup TIMEx_Exported_Functions_Group3 Timer Complementary PWM functions
202 * @brief Timer Complementary PWM functions
205 /* Timer Complementary PWM functions ****************************************/
206 /* Blocking mode: Polling */
207 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start(TIM_HandleTypeDef *htim, uint32_t Channel);
208 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop(TIM_HandleTypeDef *htim, uint32_t Channel);
210 /* Non-Blocking mode: Interrupt */
211 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_IT(TIM_HandleTypeDef *htim, uint32_t Channel);
212 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_IT(TIM_HandleTypeDef *htim, uint32_t Channel);
213 /* Non-Blocking mode: DMA */
214 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_DMA(TIM_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length);
215 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Channel);
220 /** @addtogroup TIMEx_Exported_Functions_Group4 Timer Complementary One Pulse functions
221 * @brief Timer Complementary One Pulse functions
224 /* Timer Complementary One Pulse functions **********************************/
225 /* Blocking mode: Polling */
226 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start(TIM_HandleTypeDef *htim, uint32_t OutputChannel);
227 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop(TIM_HandleTypeDef *htim, uint32_t OutputChannel);
229 /* Non-Blocking mode: Interrupt */
230 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start_IT(TIM_HandleTypeDef *htim, uint32_t OutputChannel);
231 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop_IT(TIM_HandleTypeDef *htim, uint32_t OutputChannel);
236 /** @addtogroup TIMEx_Exported_Functions_Group5 Peripheral Control functions
237 * @brief Peripheral Control functions
240 /* Extended Control functions ************************************************/
241 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent(TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource);
242 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent_IT(TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource);
243 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent_DMA(TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource);
244 HAL_StatusTypeDef HAL_TIMEx_MasterConfigSynchronization(TIM_HandleTypeDef *htim, TIM_MasterConfigTypeDef * sMasterConfig);
245 HAL_StatusTypeDef HAL_TIMEx_ConfigBreakDeadTime(TIM_HandleTypeDef *htim, TIM_BreakDeadTimeConfigTypeDef *sBreakDeadTimeConfig);
246 HAL_StatusTypeDef HAL_TIMEx_RemapConfig(TIM_HandleTypeDef *htim, uint32_t Remap);
251 /** @addtogroup TIMEx_Exported_Functions_Group6 Extension Callbacks functions
252 * @brief Extended Callbacks functions
255 /* Extension Callback *********************************************************/
256 void HAL_TIMEx_CommutationCallback(TIM_HandleTypeDef *htim);
257 void HAL_TIMEx_BreakCallback(TIM_HandleTypeDef *htim);
258 void HAL_TIMEx_DMACommutationCplt(DMA_HandleTypeDef *hdma);
263 /** @addtogroup TIMEx_Exported_Functions_Group7 Extension Peripheral State functions
264 * @brief Extended Peripheral State functions
267 /* Extension Peripheral State functions **************************************/
268 HAL_TIM_StateTypeDef HAL_TIMEx_HallSensor_GetState(TIM_HandleTypeDef *htim);
290 #endif /* __STM32F0xx_HAL_TIM_EX_H */
292 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/