2 ******************************************************************************
3 * @file stm32f1xx_hal_tim_ex.h
4 * @author MCD Application Team
6 * @date 15-December-2014
7 * @brief Header file of TIM HAL Extension 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 __STM32F1xx_HAL_TIM_EX_H
40 #define __STM32F1xx_HAL_TIM_EX_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f1xx_hal_def.h"
49 /** @addtogroup STM32F1xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
58 /** @defgroup TIMEx_Exported_Types TIMEx Exported Types
62 #if defined (STM32F100xB) || defined (STM32F100xE) || \
63 defined (STM32F103x6) || defined (STM32F103xB) || defined (STM32F103xE) || defined (STM32F103xG) || \
64 defined (STM32F105xC) || defined (STM32F107xC)
67 * @brief TIM Hall sensor Configuration Structure definition
73 uint32_t IC1Polarity; /*!< Specifies the active edge of the input signal.
74 This parameter can be a value of @ref TIM_Input_Capture_Polarity */
76 uint32_t IC1Prescaler; /*!< Specifies the Input Capture Prescaler.
77 This parameter can be a value of @ref TIM_Input_Capture_Prescaler */
79 uint32_t IC1Filter; /*!< Specifies the input capture filter.
80 This parameter can be a number between Min_Data = 0x0 and Max_Data = 0xF */
81 uint32_t Commutation_Delay; /*!< Specifies the pulse value to be loaded into the Capture Compare Register.
82 This parameter can be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF */
83 } TIM_HallSensor_InitTypeDef;
86 * @brief TIM Break and Dead time configuration Structure definition
90 uint32_t OffStateRunMode; /*!< TIM off state in run mode
91 This parameter can be a value of @ref TIM_OSSR_Off_State_Selection_for_Run_mode_state */
92 uint32_t OffStateIDLEMode; /*!< TIM off state in IDLE mode
93 This parameter can be a value of @ref TIM_OSSI_Off_State_Selection_for_Idle_mode_state */
94 uint32_t LockLevel; /*!< TIM Lock level
95 This parameter can be a value of @ref TIM_Lock_level */
96 uint32_t DeadTime; /*!< TIM dead Time
97 This parameter can be a number between Min_Data = 0x00 and Max_Data = 0xFF */
98 uint32_t BreakState; /*!< TIM Break State
99 This parameter can be a value of @ref TIM_Break_Input_enable_disable */
100 uint32_t BreakPolarity; /*!< TIM Break input polarity
101 This parameter can be a value of @ref TIM_Break_Polarity */
102 uint32_t AutomaticOutput; /*!< TIM Automatic Output Enable state
103 This parameter can be a value of @ref TIM_AOE_Bit_Set_Reset */
104 } TIM_BreakDeadTimeConfigTypeDef;
106 #endif /* defined(STM32F100xB) || defined(STM32F100xE) || */
107 /* defined(STM32F103x6) || defined(STM32F103xB) || defined(STM32F103xE) || defined(STM32F103xG) || */
108 /* defined(STM32F105xC) || defined(STM32F107xC) */
111 * @brief TIM Master configuration Structure definition
114 uint32_t MasterOutputTrigger; /*!< Trigger output (TRGO) selection
115 This parameter can be a value of @ref TIM_Master_Mode_Selection */
116 uint32_t MasterSlaveMode; /*!< Master/slave mode selection
117 This parameter can be a value of @ref TIM_Master_Slave_Mode */
118 }TIM_MasterConfigTypeDef;
124 /* Exported constants --------------------------------------------------------*/
125 #if defined (STM32F100xB) || defined (STM32F100xE) || \
126 defined (STM32F103x6) || defined (STM32F103xB) || defined (STM32F103xE) || defined (STM32F103xG) || \
127 defined (STM32F105xC) || defined (STM32F107xC)
128 /** @defgroup TIMEx_Exported_Constants TIMEx Exported Constants
132 /** @defgroup TIMEx_Clock_Filter TIMEx Clock Filter
135 #define IS_TIM_DEADTIME(DEADTIME) ((DEADTIME) <= 0xFF) /*!< BreakDead Time */
143 #endif /* defined(STM32F100xB) || defined(STM32F100xE) || */
144 /* defined(STM32F103x6) || defined(STM32F103xB) || defined(STM32F103xE) || defined(STM32F103xG) || */
145 /* defined(STM32F105xC) || defined(STM32F107xC) */
147 /* Exported macro ------------------------------------------------------------*/
149 /* Exported functions --------------------------------------------------------*/
150 /** @addtogroup TIMEx_Exported_Functions
154 #if defined (STM32F100xB) || defined (STM32F100xE) || \
155 defined (STM32F103x6) || defined (STM32F103xB) || defined (STM32F103xE) || defined (STM32F103xG) || \
156 defined (STM32F105xC) || defined (STM32F107xC)
158 /** @addtogroup TIMEx_Exported_Functions_Group1
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
184 /* Timer Complementary Output Compare functions *****************************/
185 /* Blocking mode: Polling */
186 HAL_StatusTypeDef HAL_TIMEx_OCN_Start(TIM_HandleTypeDef *htim, uint32_t Channel);
187 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop(TIM_HandleTypeDef *htim, uint32_t Channel);
189 /* Non-Blocking mode: Interrupt */
190 HAL_StatusTypeDef HAL_TIMEx_OCN_Start_IT(TIM_HandleTypeDef *htim, uint32_t Channel);
191 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_IT(TIM_HandleTypeDef *htim, uint32_t Channel);
193 /* Non-Blocking mode: DMA */
194 HAL_StatusTypeDef HAL_TIMEx_OCN_Start_DMA(TIM_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length);
195 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Channel);
200 /** @addtogroup TIMEx_Exported_Functions_Group3
203 /* Timer Complementary PWM functions ****************************************/
204 /* Blocking mode: Polling */
205 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start(TIM_HandleTypeDef *htim, uint32_t Channel);
206 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop(TIM_HandleTypeDef *htim, uint32_t Channel);
208 /* Non-Blocking mode: Interrupt */
209 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_IT(TIM_HandleTypeDef *htim, uint32_t Channel);
210 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_IT(TIM_HandleTypeDef *htim, uint32_t Channel);
211 /* Non-Blocking mode: DMA */
212 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_DMA(TIM_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length);
213 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_DMA(TIM_HandleTypeDef *htim, uint32_t Channel);
218 /** @addtogroup TIMEx_Exported_Functions_Group4
221 /* Timer Complementary One Pulse functions **********************************/
222 /* Blocking mode: Polling */
223 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start(TIM_HandleTypeDef *htim, uint32_t OutputChannel);
224 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop(TIM_HandleTypeDef *htim, uint32_t OutputChannel);
226 /* Non-Blocking mode: Interrupt */
227 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start_IT(TIM_HandleTypeDef *htim, uint32_t OutputChannel);
228 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop_IT(TIM_HandleTypeDef *htim, uint32_t OutputChannel);
232 #endif /* defined(STM32F100xB) || defined(STM32F100xE) || */
233 /* defined(STM32F103x6) || defined(STM32F103xB) || defined(STM32F103xE) || defined(STM32F103xG) || */
234 /* defined(STM32F105xC) || defined(STM32F107xC) */
236 /** @addtogroup TIMEx_Exported_Functions_Group5
239 /* Extended Control functions ************************************************/
240 #if defined (STM32F100xB) || defined (STM32F100xE) || \
241 defined (STM32F103x6) || defined (STM32F103xB) || defined (STM32F103xE) || defined (STM32F103xG) || \
242 defined (STM32F105xC) || defined (STM32F107xC)
243 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent(TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource);
244 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent_IT(TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource);
245 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent_DMA(TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource);
246 HAL_StatusTypeDef HAL_TIMEx_ConfigBreakDeadTime(TIM_HandleTypeDef *htim, TIM_BreakDeadTimeConfigTypeDef *sBreakDeadTimeConfig);
247 #endif /* defined(STM32F100xB) || defined(STM32F100xE) || */
248 /* defined(STM32F103x6) || defined(STM32F103xB) || defined(STM32F103xE) || defined(STM32F103xG) || */
249 /* defined(STM32F105xC) || defined(STM32F107xC) */
250 HAL_StatusTypeDef HAL_TIMEx_MasterConfigSynchronization(TIM_HandleTypeDef *htim, TIM_MasterConfigTypeDef * sMasterConfig);
255 /** @addtogroup TIMEx_Exported_Functions_Group6
258 /* Extension Callback *********************************************************/
259 void HAL_TIMEx_CommutationCallback(TIM_HandleTypeDef *htim);
260 void HAL_TIMEx_BreakCallback(TIM_HandleTypeDef *htim);
265 #if defined (STM32F100xB) || defined (STM32F100xE) || \
266 defined (STM32F103x6) || defined (STM32F103xB) || defined (STM32F103xE) || defined (STM32F103xG) || \
267 defined (STM32F105xC) || defined (STM32F107xC)
268 /** @addtogroup TIMEx_Exported_Functions_Group7
271 /* Extension Peripheral State functions **************************************/
272 HAL_TIM_StateTypeDef HAL_TIMEx_HallSensor_GetState(TIM_HandleTypeDef *htim);
276 #endif /* defined(STM32F100xB) || defined(STM32F100xE) || */
277 /* defined(STM32F103x6) || defined(STM32F103xB) || defined(STM32F103xE) || defined(STM32F103xG) || */
278 /* defined(STM32F105xC) || defined(STM32F107xC) */
283 /* End of exported functions -------------------------------------------------*/
285 /* Private functions----------------------------------------------------------*/
286 /** @defgroup TIMEx_Private_Functions TIMEx Private Functions
289 void TIMEx_DMACommutationCplt(DMA_HandleTypeDef *hdma);
293 /* End of private functions --------------------------------------------------*/
308 #endif /* __STM32F1xx_HAL_TIM_EX_H */
310 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/