shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F411RE/stm32f4xx_hal_tim_ex.h@323:9e901b0a5aa1, 2014-09-13 (annotated)

Committer:
shaoziyang
Date:
Sat Sep 13 14:25:46 2014 +0000
Revision:
323:9e901b0a5aa1
Parent:
235:685d5f11838f 
test with CLOCK_SETUP = 0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 235:685d5f11838f 1 /**
mbed_official 235:685d5f11838f 2 ******************************************************************************
mbed_official 235:685d5f11838f 3 * @file stm32f4xx_hal_tim_ex.h
mbed_official 235:685d5f11838f 4 * @author MCD Application Team
mbed_official 235:685d5f11838f 5 * @version V1.1.0
mbed_official 235:685d5f11838f 6 * @date 19-June-2014
mbed_official 235:685d5f11838f 7 * @brief Header file of TIM HAL Extension module.
mbed_official 235:685d5f11838f 8 ******************************************************************************
mbed_official 235:685d5f11838f 9 * @attention
mbed_official 235:685d5f11838f 10 *
mbed_official 235:685d5f11838f 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 235:685d5f11838f 12 *
mbed_official 235:685d5f11838f 13 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 235:685d5f11838f 14 * are permitted provided that the following conditions are met:
mbed_official 235:685d5f11838f 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 235:685d5f11838f 16 * this list of conditions and the following disclaimer.
mbed_official 235:685d5f11838f 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 235:685d5f11838f 18 * this list of conditions and the following disclaimer in the documentation
mbed_official 235:685d5f11838f 19 * and/or other materials provided with the distribution.
mbed_official 235:685d5f11838f 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 235:685d5f11838f 21 * may be used to endorse or promote products derived from this software
mbed_official 235:685d5f11838f 22 * without specific prior written permission.
mbed_official 235:685d5f11838f 23 *
mbed_official 235:685d5f11838f 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 235:685d5f11838f 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 235:685d5f11838f 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 235:685d5f11838f 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 235:685d5f11838f 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 235:685d5f11838f 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 235:685d5f11838f 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 235:685d5f11838f 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 235:685d5f11838f 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 235:685d5f11838f 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 235:685d5f11838f 34 *
mbed_official 235:685d5f11838f 35 ******************************************************************************
mbed_official 235:685d5f11838f 36 */
mbed_official 235:685d5f11838f 37
mbed_official 235:685d5f11838f 38 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 235:685d5f11838f 39 #ifndef __STM32F4xx_HAL_TIM_EX_H
mbed_official 235:685d5f11838f 40 #define __STM32F4xx_HAL_TIM_EX_H
mbed_official 235:685d5f11838f 41
mbed_official 235:685d5f11838f 42 #ifdef __cplusplus
mbed_official 235:685d5f11838f 43 extern "C" {
mbed_official 235:685d5f11838f 44 #endif
mbed_official 235:685d5f11838f 45
mbed_official 235:685d5f11838f 46 /* Includes ------------------------------------------------------------------*/
mbed_official 235:685d5f11838f 47 #include "stm32f4xx_hal_def.h"
mbed_official 235:685d5f11838f 48
mbed_official 235:685d5f11838f 49 /** @addtogroup STM32F4xx_HAL
mbed_official 235:685d5f11838f 50 * @{
mbed_official 235:685d5f11838f 51 */
mbed_official 235:685d5f11838f 52
mbed_official 235:685d5f11838f 53 /** @addtogroup TIMEx
mbed_official 235:685d5f11838f 54 * @{
mbed_official 235:685d5f11838f 55 */
mbed_official 235:685d5f11838f 56
mbed_official 235:685d5f11838f 57 /* Exported types ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 58
mbed_official 235:685d5f11838f 59 /**
mbed_official 235:685d5f11838f 60 * @brief TIM Hall sensor Configuration Structure definition
mbed_official 235:685d5f11838f 61 */
mbed_official 235:685d5f11838f 62
mbed_official 235:685d5f11838f 63 typedef struct
mbed_official 235:685d5f11838f 64 {
mbed_official 235:685d5f11838f 65
mbed_official 235:685d5f11838f 66 uint32_t IC1Polarity; /*!< Specifies the active edge of the input signal.
mbed_official 235:685d5f11838f 67 This parameter can be a value of @ref TIM_Input_Capture_Polarity */
mbed_official 235:685d5f11838f 68
mbed_official 235:685d5f11838f 69 uint32_t IC1Prescaler; /*!< Specifies the Input Capture Prescaler.
mbed_official 235:685d5f11838f 70 This parameter can be a value of @ref TIM_Input_Capture_Prescaler */
mbed_official 235:685d5f11838f 71
mbed_official 235:685d5f11838f 72 uint32_t IC1Filter; /*!< Specifies the input capture filter.
mbed_official 235:685d5f11838f 73 This parameter can be a number between Min_Data = 0x0 and Max_Data = 0xF */
mbed_official 235:685d5f11838f 74 uint32_t Commutation_Delay; /*!< Specifies the pulse value to be loaded into the Capture Compare Register.
mbed_official 235:685d5f11838f 75 This parameter can be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF */
mbed_official 235:685d5f11838f 76 } TIM_HallSensor_InitTypeDef;
mbed_official 235:685d5f11838f 77
mbed_official 235:685d5f11838f 78 /**
mbed_official 235:685d5f11838f 79 * @brief TIM Master configuration Structure definition
mbed_official 235:685d5f11838f 80 */
mbed_official 235:685d5f11838f 81 typedef struct {
mbed_official 235:685d5f11838f 82 uint32_t MasterOutputTrigger; /*!< Trigger output (TRGO) selection.
mbed_official 235:685d5f11838f 83 This parameter can be a value of @ref TIM_Master_Mode_Selection */
mbed_official 235:685d5f11838f 84 uint32_t MasterSlaveMode; /*!< Master/slave mode selection.
mbed_official 235:685d5f11838f 85 This parameter can be a value of @ref TIM_Master_Slave_Mode */
mbed_official 235:685d5f11838f 86 }TIM_MasterConfigTypeDef;
mbed_official 235:685d5f11838f 87
mbed_official 235:685d5f11838f 88 /**
mbed_official 235:685d5f11838f 89 * @brief TIM Break and Dead time configuration Structure definition
mbed_official 235:685d5f11838f 90 */
mbed_official 235:685d5f11838f 91 typedef struct
mbed_official 235:685d5f11838f 92 {
mbed_official 235:685d5f11838f 93 uint32_t OffStateRunMode; /*!< TIM off state in run mode.
mbed_official 235:685d5f11838f 94 This parameter can be a value of @ref TIM_OSSR_Off_State_Selection_for_Run_mode_state */
mbed_official 235:685d5f11838f 95 uint32_t OffStateIDLEMode; /*!< TIM off state in IDLE mode.
mbed_official 235:685d5f11838f 96 This parameter can be a value of @ref TIM_OSSI_Off_State_Selection_for_Idle_mode_state */
mbed_official 235:685d5f11838f 97 uint32_t LockLevel; /*!< TIM Lock level.
mbed_official 235:685d5f11838f 98 This parameter can be a value of @ref TIM_Lock_level */
mbed_official 235:685d5f11838f 99 uint32_t DeadTime; /*!< TIM dead Time.
mbed_official 235:685d5f11838f 100 This parameter can be a number between Min_Data = 0x00 and Max_Data = 0xFF */
mbed_official 235:685d5f11838f 101 uint32_t BreakState; /*!< TIM Break State.
mbed_official 235:685d5f11838f 102 This parameter can be a value of @ref TIM_Break_Input_enable_disable */
mbed_official 235:685d5f11838f 103 uint32_t BreakPolarity; /*!< TIM Break input polarity.
mbed_official 235:685d5f11838f 104 This parameter can be a value of @ref TIM_Break_Polarity */
mbed_official 235:685d5f11838f 105 uint32_t AutomaticOutput; /*!< TIM Automatic Output Enable state.
mbed_official 235:685d5f11838f 106 This parameter can be a value of @ref TIM_AOE_Bit_Set_Reset */
mbed_official 235:685d5f11838f 107 }TIM_BreakDeadTimeConfigTypeDef;
mbed_official 235:685d5f11838f 108
mbed_official 235:685d5f11838f 109 /* Exported constants --------------------------------------------------------*/
mbed_official 235:685d5f11838f 110 /** @defgroup TIMEx_Exported_Constants
mbed_official 235:685d5f11838f 111 * @{
mbed_official 235:685d5f11838f 112 */
mbed_official 235:685d5f11838f 113
mbed_official 235:685d5f11838f 114 /** @defgroup TIMEx_Remap
mbed_official 235:685d5f11838f 115 * @{
mbed_official 235:685d5f11838f 116 */
mbed_official 235:685d5f11838f 117
mbed_official 235:685d5f11838f 118 #define TIM_TIM2_TIM8_TRGO (0x00000000)
mbed_official 235:685d5f11838f 119 #define TIM_TIM2_ETH_PTP (0x00000400)
mbed_official 235:685d5f11838f 120 #define TIM_TIM2_USBFS_SOF (0x00000800)
mbed_official 235:685d5f11838f 121 #define TIM_TIM2_USBHS_SOF (0x00000C00)
mbed_official 235:685d5f11838f 122 #define TIM_TIM5_GPIO (0x00000000)
mbed_official 235:685d5f11838f 123 #define TIM_TIM5_LSI (0x00000040)
mbed_official 235:685d5f11838f 124 #define TIM_TIM5_LSE (0x00000080)
mbed_official 235:685d5f11838f 125 #define TIM_TIM5_RTC (0x000000C0)
mbed_official 235:685d5f11838f 126 #define TIM_TIM11_GPIO (0x00000000)
mbed_official 235:685d5f11838f 127 #define TIM_TIM11_HSE (0x00000002)
mbed_official 235:685d5f11838f 128
mbed_official 235:685d5f11838f 129 #define IS_TIM_REMAP(TIM_REMAP) (((TIM_REMAP) == TIM_TIM2_TIM8_TRGO)||\
mbed_official 235:685d5f11838f 130 ((TIM_REMAP) == TIM_TIM2_ETH_PTP)||\
mbed_official 235:685d5f11838f 131 ((TIM_REMAP) == TIM_TIM2_USBFS_SOF)||\
mbed_official 235:685d5f11838f 132 ((TIM_REMAP) == TIM_TIM2_USBHS_SOF)||\
mbed_official 235:685d5f11838f 133 ((TIM_REMAP) == TIM_TIM5_GPIO)||\
mbed_official 235:685d5f11838f 134 ((TIM_REMAP) == TIM_TIM5_LSI)||\
mbed_official 235:685d5f11838f 135 ((TIM_REMAP) == TIM_TIM5_LSE)||\
mbed_official 235:685d5f11838f 136 ((TIM_REMAP) == TIM_TIM5_RTC)||\
mbed_official 235:685d5f11838f 137 ((TIM_REMAP) == TIM_TIM11_GPIO)||\
mbed_official 235:685d5f11838f 138 ((TIM_REMAP) == TIM_TIM11_HSE))
mbed_official 235:685d5f11838f 139
mbed_official 235:685d5f11838f 140 /**
mbed_official 235:685d5f11838f 141 * @}
mbed_official 235:685d5f11838f 142 */
mbed_official 235:685d5f11838f 143
mbed_official 235:685d5f11838f 144 /**
mbed_official 235:685d5f11838f 145 * @}
mbed_official 235:685d5f11838f 146 */
mbed_official 235:685d5f11838f 147
mbed_official 235:685d5f11838f 148 /* Exported macro ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 149
mbed_official 235:685d5f11838f 150 /* Exported functions --------------------------------------------------------*/
mbed_official 235:685d5f11838f 151
mbed_official 235:685d5f11838f 152 /* Timer Hall Sensor functions **********************************************/
mbed_official 235:685d5f11838f 153 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Init(TIM_HandleTypeDef* htim, TIM_HallSensor_InitTypeDef* sConfig);
mbed_official 235:685d5f11838f 154 HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 155
mbed_official 235:685d5f11838f 156 void HAL_TIMEx_HallSensor_MspInit(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 157 void HAL_TIMEx_HallSensor_MspDeInit(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 158
mbed_official 235:685d5f11838f 159 /* Blocking mode: Polling */
mbed_official 235:685d5f11838f 160 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 161 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 162 /* Non-Blocking mode: Interrupt */
mbed_official 235:685d5f11838f 163 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 164 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 165 /* Non-Blocking mode: DMA */
mbed_official 235:685d5f11838f 166 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_DMA(TIM_HandleTypeDef* htim, uint32_t *pData, uint16_t Length);
mbed_official 235:685d5f11838f 167 HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 168
mbed_official 235:685d5f11838f 169 /* Timer Complementary Output Compare functions *****************************/
mbed_official 235:685d5f11838f 170 /* Blocking mode: Polling */
mbed_official 235:685d5f11838f 171 HAL_StatusTypeDef HAL_TIMEx_OCN_Start(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 172 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 173
mbed_official 235:685d5f11838f 174 /* Non-Blocking mode: Interrupt */
mbed_official 235:685d5f11838f 175 HAL_StatusTypeDef HAL_TIMEx_OCN_Start_IT(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 176 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_IT(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 177
mbed_official 235:685d5f11838f 178 /* Non-Blocking mode: DMA */
mbed_official 235:685d5f11838f 179 HAL_StatusTypeDef HAL_TIMEx_OCN_Start_DMA(TIM_HandleTypeDef* htim, uint32_t Channel, uint32_t *pData, uint16_t Length);
mbed_official 235:685d5f11838f 180 HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_DMA(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 181
mbed_official 235:685d5f11838f 182 /* Timer Complementary PWM functions ****************************************/
mbed_official 235:685d5f11838f 183 /* Blocking mode: Polling */
mbed_official 235:685d5f11838f 184 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 185 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 186
mbed_official 235:685d5f11838f 187 /* Non-Blocking mode: Interrupt */
mbed_official 235:685d5f11838f 188 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_IT(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 189 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_IT(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 190 /* Non-Blocking mode: DMA */
mbed_official 235:685d5f11838f 191 HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_DMA(TIM_HandleTypeDef* htim, uint32_t Channel, uint32_t *pData, uint16_t Length);
mbed_official 235:685d5f11838f 192 HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_DMA(TIM_HandleTypeDef* htim, uint32_t Channel);
mbed_official 235:685d5f11838f 193
mbed_official 235:685d5f11838f 194 /* Timer Complementary One Pulse functions **********************************/
mbed_official 235:685d5f11838f 195 /* Blocking mode: Polling */
mbed_official 235:685d5f11838f 196 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start(TIM_HandleTypeDef* htim, uint32_t OutputChannel);
mbed_official 235:685d5f11838f 197 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop(TIM_HandleTypeDef* htim, uint32_t OutputChannel);
mbed_official 235:685d5f11838f 198
mbed_official 235:685d5f11838f 199 /* Non-Blocking mode: Interrupt */
mbed_official 235:685d5f11838f 200 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start_IT(TIM_HandleTypeDef* htim, uint32_t OutputChannel);
mbed_official 235:685d5f11838f 201 HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop_IT(TIM_HandleTypeDef* htim, uint32_t OutputChannel);
mbed_official 235:685d5f11838f 202
mbed_official 235:685d5f11838f 203 /* Extnsion Control functions ************************************************/
mbed_official 235:685d5f11838f 204 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent(TIM_HandleTypeDef* htim, uint32_t InputTrigger, uint32_t CommutationSource);
mbed_official 235:685d5f11838f 205 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent_IT(TIM_HandleTypeDef* htim, uint32_t InputTrigger, uint32_t CommutationSource);
mbed_official 235:685d5f11838f 206 HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent_DMA(TIM_HandleTypeDef* htim, uint32_t InputTrigger, uint32_t CommutationSource);
mbed_official 235:685d5f11838f 207 HAL_StatusTypeDef HAL_TIMEx_MasterConfigSynchronization(TIM_HandleTypeDef* htim, TIM_MasterConfigTypeDef * sMasterConfig);
mbed_official 235:685d5f11838f 208 HAL_StatusTypeDef HAL_TIMEx_ConfigBreakDeadTime(TIM_HandleTypeDef* htim, TIM_BreakDeadTimeConfigTypeDef *sBreakDeadTimeConfig);
mbed_official 235:685d5f11838f 209 HAL_StatusTypeDef HAL_TIMEx_RemapConfig(TIM_HandleTypeDef* htim, uint32_t Remap);
mbed_official 235:685d5f11838f 210
mbed_official 235:685d5f11838f 211 /* Extension Callback *********************************************************/
mbed_official 235:685d5f11838f 212 void HAL_TIMEx_CommutationCallback(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 213 void HAL_TIMEx_BreakCallback(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 214 void HAL_TIMEx_DMACommutationCplt(DMA_HandleTypeDef *hdma);
mbed_official 235:685d5f11838f 215
mbed_official 235:685d5f11838f 216 /* Extension Peripheral State functions **************************************/
mbed_official 235:685d5f11838f 217 HAL_TIM_StateTypeDef HAL_TIMEx_HallSensor_GetState(TIM_HandleTypeDef* htim);
mbed_official 235:685d5f11838f 218
mbed_official 235:685d5f11838f 219 /**
mbed_official 235:685d5f11838f 220 * @}
mbed_official 235:685d5f11838f 221 */
mbed_official 235:685d5f11838f 222
mbed_official 235:685d5f11838f 223 /**
mbed_official 235:685d5f11838f 224 * @}
mbed_official 235:685d5f11838f 225 */
mbed_official 235:685d5f11838f 226
mbed_official 235:685d5f11838f 227 #ifdef __cplusplus
mbed_official 235:685d5f11838f 228 }
mbed_official 235:685d5f11838f 229 #endif
mbed_official 235:685d5f11838f 230
mbed_official 235:685d5f11838f 231 #endif /* __STM32F4xx_HAL_TIM_EX_H */
mbed_official 235:685d5f11838f 232
mbed_official 235:685d5f11838f 233 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/