Amit Gandhi / sensen_copy_2

t

Fork of mbed-dev by mbed official

targets/hal/TARGET_STM/TARGET_STM32F4/pwmout_api.c@25:ac5b0a371348, 2015-11-20 (annotated)

Committer:
mbed_official
Date:
Fri Nov 20 10:00:12 2015 +0000
Revision:
25:ac5b0a371348
Parent:
23:ee8ca7052b3c
Child:
144:ef7eb2e8f9f7
Synchronized with git revision a4b777d8b25f9146e77396273dc9631c38583eb9



Full URL: https://github.com/mbedmicro/mbed/commit/a4b777d8b25f9146e77396273dc9631c38583eb9/



Added new Nucleo target - F410RB

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 *******************************************************************************
mbed_official 23:ee8ca7052b3c 3 * Copyright (c) 2015, STMicroelectronics
bogdanm 0:9b334a45a8ff 4 * All rights reserved.
bogdanm 0:9b334a45a8ff 5 *
bogdanm 0:9b334a45a8ff 6 * Redistribution and use in source and binary forms, with or without
bogdanm 0:9b334a45a8ff 7 * modification, are permitted provided that the following conditions are met:
bogdanm 0:9b334a45a8ff 8 *
bogdanm 0:9b334a45a8ff 9 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 0:9b334a45a8ff 10 * this list of conditions and the following disclaimer.
bogdanm 0:9b334a45a8ff 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 0:9b334a45a8ff 12 * this list of conditions and the following disclaimer in the documentation
bogdanm 0:9b334a45a8ff 13 * and/or other materials provided with the distribution.
bogdanm 0:9b334a45a8ff 14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 0:9b334a45a8ff 15 * may be used to endorse or promote products derived from this software
bogdanm 0:9b334a45a8ff 16 * without specific prior written permission.
bogdanm 0:9b334a45a8ff 17 *
bogdanm 0:9b334a45a8ff 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 0:9b334a45a8ff 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 0:9b334a45a8ff 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 0:9b334a45a8ff 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 0:9b334a45a8ff 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 0:9b334a45a8ff 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 0:9b334a45a8ff 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 0:9b334a45a8ff 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 0:9b334a45a8ff 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 0:9b334a45a8ff 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 0:9b334a45a8ff 28 *******************************************************************************
bogdanm 0:9b334a45a8ff 29 */
bogdanm 0:9b334a45a8ff 30 #include "pwmout_api.h"
bogdanm 0:9b334a45a8ff 31
bogdanm 0:9b334a45a8ff 32 #if DEVICE_PWMOUT
bogdanm 0:9b334a45a8ff 33
bogdanm 0:9b334a45a8ff 34 #include "cmsis.h"
bogdanm 0:9b334a45a8ff 35 #include "pinmap.h"
bogdanm 0:9b334a45a8ff 36 #include "mbed_error.h"
bogdanm 0:9b334a45a8ff 37 #include "PeripheralPins.h"
bogdanm 0:9b334a45a8ff 38
bogdanm 0:9b334a45a8ff 39 static TIM_HandleTypeDef TimHandle;
bogdanm 0:9b334a45a8ff 40
bogdanm 0:9b334a45a8ff 41 void pwmout_init(pwmout_t* obj, PinName pin)
bogdanm 0:9b334a45a8ff 42 {
bogdanm 0:9b334a45a8ff 43 // Get the peripheral name from the pin and assign it to the object
bogdanm 0:9b334a45a8ff 44 obj->pwm = (PWMName)pinmap_peripheral(pin, PinMap_PWM);
bogdanm 0:9b334a45a8ff 45 MBED_ASSERT(obj->pwm != (PWMName)NC);
bogdanm 0:9b334a45a8ff 46
bogdanm 0:9b334a45a8ff 47 // Get the functions (timer channel, (non)inverted) from the pin and assign it to the object
bogdanm 0:9b334a45a8ff 48 uint32_t function = pinmap_function(pin, PinMap_PWM);
bogdanm 0:9b334a45a8ff 49 MBED_ASSERT(function != (uint32_t)NC);
bogdanm 0:9b334a45a8ff 50 obj->channel = STM_PIN_CHANNEL(function);
bogdanm 0:9b334a45a8ff 51 obj->inverted = STM_PIN_INVERTED(function);
bogdanm 0:9b334a45a8ff 52
bogdanm 0:9b334a45a8ff 53 // Enable TIM clock
mbed_official 25:ac5b0a371348 54 #if defined(TIM1_BASE)
bogdanm 0:9b334a45a8ff 55 if (obj->pwm == PWM_1) __HAL_RCC_TIM1_CLK_ENABLE();
mbed_official 25:ac5b0a371348 56 #endif
mbed_official 25:ac5b0a371348 57 #if defined(TIM2_BASE)
bogdanm 0:9b334a45a8ff 58 if (obj->pwm == PWM_2) __HAL_RCC_TIM2_CLK_ENABLE();
mbed_official 25:ac5b0a371348 59 #endif
mbed_official 25:ac5b0a371348 60 #if defined(TIM3_BASE)
bogdanm 0:9b334a45a8ff 61 if (obj->pwm == PWM_3) __HAL_RCC_TIM3_CLK_ENABLE();
mbed_official 25:ac5b0a371348 62 #endif
mbed_official 25:ac5b0a371348 63 #if defined(TIM4_BASE)
bogdanm 0:9b334a45a8ff 64 if (obj->pwm == PWM_4) __HAL_RCC_TIM4_CLK_ENABLE();
mbed_official 25:ac5b0a371348 65 #endif
mbed_official 19:112740acecfa 66 #if defined(TIM5_BASE)
mbed_official 19:112740acecfa 67 if (obj->pwm == PWM_5) __HAL_RCC_TIM5_CLK_ENABLE();
mbed_official 25:ac5b0a371348 68 #endif
bogdanm 0:9b334a45a8ff 69 #if defined(TIM8_BASE)
bogdanm 0:9b334a45a8ff 70 if (obj->pwm == PWM_8) __HAL_RCC_TIM8_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 71 #endif
mbed_official 25:ac5b0a371348 72 #if defined(TIM9_BASE)
bogdanm 0:9b334a45a8ff 73 if (obj->pwm == PWM_9) __HAL_RCC_TIM9_CLK_ENABLE();
mbed_official 25:ac5b0a371348 74 #endif
mbed_official 25:ac5b0a371348 75 #if defined(TIM10_BASE)
bogdanm 0:9b334a45a8ff 76 if (obj->pwm == PWM_10) __HAL_RCC_TIM10_CLK_ENABLE();
mbed_official 25:ac5b0a371348 77 #endif
mbed_official 25:ac5b0a371348 78 #if defined(TIM11_BASE)
bogdanm 0:9b334a45a8ff 79 if (obj->pwm == PWM_11) __HAL_RCC_TIM11_CLK_ENABLE();
mbed_official 25:ac5b0a371348 80 #endif
bogdanm 0:9b334a45a8ff 81 #if defined(TIM12_BASE)
bogdanm 0:9b334a45a8ff 82 if (obj->pwm == PWM_12) __HAL_RCC_TIM12_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 83 #endif
bogdanm 0:9b334a45a8ff 84 #if defined(TIM13_BASE)
bogdanm 0:9b334a45a8ff 85 if (obj->pwm == PWM_13) __HAL_RCC_TIM13_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 86 #endif
bogdanm 0:9b334a45a8ff 87 #if defined(TIM14_BASE)
bogdanm 0:9b334a45a8ff 88 if (obj->pwm == PWM_14) __HAL_RCC_TIM14_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 89 #endif
bogdanm 0:9b334a45a8ff 90
bogdanm 0:9b334a45a8ff 91 // Configure GPIO
bogdanm 0:9b334a45a8ff 92 pinmap_pinout(pin, PinMap_PWM);
bogdanm 0:9b334a45a8ff 93
bogdanm 0:9b334a45a8ff 94 obj->pin = pin;
bogdanm 0:9b334a45a8ff 95 obj->period = 0;
bogdanm 0:9b334a45a8ff 96 obj->pulse = 0;
bogdanm 0:9b334a45a8ff 97
bogdanm 0:9b334a45a8ff 98 pwmout_period_us(obj, 20000); // 20 ms per default
bogdanm 0:9b334a45a8ff 99 }
bogdanm 0:9b334a45a8ff 100
bogdanm 0:9b334a45a8ff 101 void pwmout_free(pwmout_t* obj)
bogdanm 0:9b334a45a8ff 102 {
bogdanm 0:9b334a45a8ff 103 // Configure GPIO
bogdanm 0:9b334a45a8ff 104 pin_function(obj->pin, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
bogdanm 0:9b334a45a8ff 105 }
bogdanm 0:9b334a45a8ff 106
bogdanm 0:9b334a45a8ff 107 void pwmout_write(pwmout_t* obj, float value)
bogdanm 0:9b334a45a8ff 108 {
bogdanm 0:9b334a45a8ff 109 TIM_OC_InitTypeDef sConfig;
bogdanm 0:9b334a45a8ff 110 int channel = 0;
bogdanm 0:9b334a45a8ff 111
bogdanm 0:9b334a45a8ff 112 TimHandle.Instance = (TIM_TypeDef *)(obj->pwm);
bogdanm 0:9b334a45a8ff 113
bogdanm 0:9b334a45a8ff 114 if (value < (float)0.0) {
bogdanm 0:9b334a45a8ff 115 value = 0.0;
bogdanm 0:9b334a45a8ff 116 } else if (value > (float)1.0) {
bogdanm 0:9b334a45a8ff 117 value = 1.0;
bogdanm 0:9b334a45a8ff 118 }
bogdanm 0:9b334a45a8ff 119
bogdanm 0:9b334a45a8ff 120 obj->pulse = (uint32_t)((float)obj->period * value);
bogdanm 0:9b334a45a8ff 121
bogdanm 0:9b334a45a8ff 122 // Configure channels
bogdanm 0:9b334a45a8ff 123 sConfig.OCMode = TIM_OCMODE_PWM1;
bogdanm 0:9b334a45a8ff 124 sConfig.Pulse = obj->pulse;
bogdanm 0:9b334a45a8ff 125 sConfig.OCPolarity = TIM_OCPOLARITY_HIGH;
bogdanm 0:9b334a45a8ff 126 sConfig.OCNPolarity = TIM_OCNPOLARITY_HIGH;
bogdanm 0:9b334a45a8ff 127 sConfig.OCFastMode = TIM_OCFAST_DISABLE;
bogdanm 0:9b334a45a8ff 128 sConfig.OCIdleState = TIM_OCIDLESTATE_RESET;
bogdanm 0:9b334a45a8ff 129 sConfig.OCNIdleState = TIM_OCNIDLESTATE_RESET;
bogdanm 0:9b334a45a8ff 130
bogdanm 0:9b334a45a8ff 131 switch (obj->channel) {
bogdanm 0:9b334a45a8ff 132 case 1:
bogdanm 0:9b334a45a8ff 133 channel = TIM_CHANNEL_1;
bogdanm 0:9b334a45a8ff 134 break;
bogdanm 0:9b334a45a8ff 135 case 2:
bogdanm 0:9b334a45a8ff 136 channel = TIM_CHANNEL_2;
bogdanm 0:9b334a45a8ff 137 break;
bogdanm 0:9b334a45a8ff 138 case 3:
bogdanm 0:9b334a45a8ff 139 channel = TIM_CHANNEL_3;
bogdanm 0:9b334a45a8ff 140 break;
bogdanm 0:9b334a45a8ff 141 case 4:
bogdanm 0:9b334a45a8ff 142 channel = TIM_CHANNEL_4;
bogdanm 0:9b334a45a8ff 143 break;
bogdanm 0:9b334a45a8ff 144 default:
bogdanm 0:9b334a45a8ff 145 return;
bogdanm 0:9b334a45a8ff 146 }
bogdanm 0:9b334a45a8ff 147
bogdanm 0:9b334a45a8ff 148 if (HAL_TIM_PWM_ConfigChannel(&TimHandle, &sConfig, channel) != HAL_OK) {
bogdanm 0:9b334a45a8ff 149 error("Cannot initialize PWM\n");
bogdanm 0:9b334a45a8ff 150 }
bogdanm 0:9b334a45a8ff 151
bogdanm 0:9b334a45a8ff 152 if (obj->inverted) {
bogdanm 0:9b334a45a8ff 153 HAL_TIMEx_PWMN_Start(&TimHandle, channel);
bogdanm 0:9b334a45a8ff 154 } else {
bogdanm 0:9b334a45a8ff 155 HAL_TIM_PWM_Start(&TimHandle, channel);
bogdanm 0:9b334a45a8ff 156 }
bogdanm 0:9b334a45a8ff 157 }
bogdanm 0:9b334a45a8ff 158
bogdanm 0:9b334a45a8ff 159 float pwmout_read(pwmout_t* obj)
bogdanm 0:9b334a45a8ff 160 {
bogdanm 0:9b334a45a8ff 161 float value = 0;
bogdanm 0:9b334a45a8ff 162 if (obj->period > 0) {
bogdanm 0:9b334a45a8ff 163 value = (float)(obj->pulse) / (float)(obj->period);
bogdanm 0:9b334a45a8ff 164 }
bogdanm 0:9b334a45a8ff 165 return ((value > (float)1.0) ? (float)(1.0) : (value));
bogdanm 0:9b334a45a8ff 166 }
bogdanm 0:9b334a45a8ff 167
bogdanm 0:9b334a45a8ff 168 void pwmout_period(pwmout_t* obj, float seconds)
bogdanm 0:9b334a45a8ff 169 {
bogdanm 0:9b334a45a8ff 170 pwmout_period_us(obj, seconds * 1000000.0f);
bogdanm 0:9b334a45a8ff 171 }
bogdanm 0:9b334a45a8ff 172
bogdanm 0:9b334a45a8ff 173 void pwmout_period_ms(pwmout_t* obj, int ms)
bogdanm 0:9b334a45a8ff 174 {
bogdanm 0:9b334a45a8ff 175 pwmout_period_us(obj, ms * 1000);
bogdanm 0:9b334a45a8ff 176 }
bogdanm 0:9b334a45a8ff 177
bogdanm 0:9b334a45a8ff 178 void pwmout_period_us(pwmout_t* obj, int us)
bogdanm 0:9b334a45a8ff 179 {
bogdanm 0:9b334a45a8ff 180 TimHandle.Instance = (TIM_TypeDef *)(obj->pwm);
bogdanm 0:9b334a45a8ff 181 RCC_ClkInitTypeDef RCC_ClkInitStruct;
bogdanm 0:9b334a45a8ff 182 uint32_t PclkFreq;
bogdanm 0:9b334a45a8ff 183 uint32_t APBxCLKDivider;
bogdanm 0:9b334a45a8ff 184 float dc = pwmout_read(obj);
bogdanm 0:9b334a45a8ff 185
bogdanm 0:9b334a45a8ff 186 __HAL_TIM_DISABLE(&TimHandle);
bogdanm 0:9b334a45a8ff 187
bogdanm 0:9b334a45a8ff 188 // Get clock configuration
bogdanm 0:9b334a45a8ff 189 // Note: PclkFreq contains here the Latency (not used after)
bogdanm 0:9b334a45a8ff 190 HAL_RCC_GetClockConfig(&RCC_ClkInitStruct, &PclkFreq);
bogdanm 0:9b334a45a8ff 191
bogdanm 0:9b334a45a8ff 192 // Get the PCLK and APBCLK divider related to the timer
bogdanm 0:9b334a45a8ff 193 switch (obj->pwm) {
bogdanm 0:9b334a45a8ff 194
bogdanm 0:9b334a45a8ff 195 // APB1 clock
mbed_official 25:ac5b0a371348 196 #if defined(TIM2_BASE)
bogdanm 0:9b334a45a8ff 197 case PWM_2:
mbed_official 25:ac5b0a371348 198 #endif
mbed_official 25:ac5b0a371348 199 #if defined(TIM3_BASE)
bogdanm 0:9b334a45a8ff 200 case PWM_3:
mbed_official 25:ac5b0a371348 201 #endif
mbed_official 25:ac5b0a371348 202 #if defined(TIM4_BASE)
bogdanm 0:9b334a45a8ff 203 case PWM_4:
mbed_official 25:ac5b0a371348 204 #endif
mbed_official 25:ac5b0a371348 205 #if defined(TIM5_BASE)
bogdanm 0:9b334a45a8ff 206 case PWM_5:
mbed_official 25:ac5b0a371348 207 #endif
bogdanm 0:9b334a45a8ff 208 #if defined(TIM12_BASE)
bogdanm 0:9b334a45a8ff 209 case PWM_12:
bogdanm 0:9b334a45a8ff 210 #endif
bogdanm 0:9b334a45a8ff 211 #if defined(TIM13_BASE)
bogdanm 0:9b334a45a8ff 212 case PWM_13:
bogdanm 0:9b334a45a8ff 213 #endif
bogdanm 0:9b334a45a8ff 214 #if defined(TIM14_BASE)
bogdanm 0:9b334a45a8ff 215 case PWM_14:
bogdanm 0:9b334a45a8ff 216 #endif
bogdanm 0:9b334a45a8ff 217 PclkFreq = HAL_RCC_GetPCLK1Freq();
bogdanm 0:9b334a45a8ff 218 APBxCLKDivider = RCC_ClkInitStruct.APB1CLKDivider;
bogdanm 0:9b334a45a8ff 219 break;
bogdanm 0:9b334a45a8ff 220
bogdanm 0:9b334a45a8ff 221 // APB2 clock
mbed_official 25:ac5b0a371348 222 #if defined(TIM1_BASE)
bogdanm 0:9b334a45a8ff 223 case PWM_1:
mbed_official 25:ac5b0a371348 224 #endif
bogdanm 0:9b334a45a8ff 225 #if defined(TIM8_BASE)
bogdanm 0:9b334a45a8ff 226 case PWM_8:
bogdanm 0:9b334a45a8ff 227 #endif
mbed_official 25:ac5b0a371348 228 #if defined(TIM9_BASE)
bogdanm 0:9b334a45a8ff 229 case PWM_9:
mbed_official 25:ac5b0a371348 230 #endif
mbed_official 25:ac5b0a371348 231 #if defined(TIM10_BASE)
bogdanm 0:9b334a45a8ff 232 case PWM_10:
mbed_official 25:ac5b0a371348 233 #endif
mbed_official 25:ac5b0a371348 234 #if defined(TIM11_BASE)
bogdanm 0:9b334a45a8ff 235 case PWM_11:
mbed_official 25:ac5b0a371348 236 #endif
bogdanm 0:9b334a45a8ff 237 PclkFreq = HAL_RCC_GetPCLK2Freq();
bogdanm 0:9b334a45a8ff 238 APBxCLKDivider = RCC_ClkInitStruct.APB2CLKDivider;
bogdanm 0:9b334a45a8ff 239 break;
bogdanm 0:9b334a45a8ff 240 default:
bogdanm 0:9b334a45a8ff 241 return;
bogdanm 0:9b334a45a8ff 242 }
bogdanm 0:9b334a45a8ff 243
bogdanm 0:9b334a45a8ff 244 TimHandle.Init.Period = us - 1;
bogdanm 0:9b334a45a8ff 245 // TIMxCLK = PCLKx when the APB prescaler = 1 else TIMxCLK = 2 * PCLKx
bogdanm 0:9b334a45a8ff 246 if (APBxCLKDivider == RCC_HCLK_DIV1)
bogdanm 0:9b334a45a8ff 247 TimHandle.Init.Prescaler = (uint16_t)((PclkFreq) / 1000000) - 1; // 1 us tick
bogdanm 0:9b334a45a8ff 248 else
bogdanm 0:9b334a45a8ff 249 TimHandle.Init.Prescaler = (uint16_t)((PclkFreq * 2) / 1000000) - 1; // 1 us tick
bogdanm 0:9b334a45a8ff 250 TimHandle.Init.ClockDivision = 0;
bogdanm 0:9b334a45a8ff 251 TimHandle.Init.CounterMode = TIM_COUNTERMODE_UP;
bogdanm 0:9b334a45a8ff 252
bogdanm 0:9b334a45a8ff 253 if (HAL_TIM_PWM_Init(&TimHandle) != HAL_OK) {
bogdanm 0:9b334a45a8ff 254 error("Cannot initialize PWM\n");
bogdanm 0:9b334a45a8ff 255 }
bogdanm 0:9b334a45a8ff 256
bogdanm 0:9b334a45a8ff 257 // Set duty cycle again
bogdanm 0:9b334a45a8ff 258 pwmout_write(obj, dc);
bogdanm 0:9b334a45a8ff 259
bogdanm 0:9b334a45a8ff 260 // Save for future use
bogdanm 0:9b334a45a8ff 261 obj->period = us;
bogdanm 0:9b334a45a8ff 262
bogdanm 0:9b334a45a8ff 263 __HAL_TIM_ENABLE(&TimHandle);
bogdanm 0:9b334a45a8ff 264 }
bogdanm 0:9b334a45a8ff 265
bogdanm 0:9b334a45a8ff 266 void pwmout_pulsewidth(pwmout_t* obj, float seconds)
bogdanm 0:9b334a45a8ff 267 {
bogdanm 0:9b334a45a8ff 268 pwmout_pulsewidth_us(obj, seconds * 1000000.0f);
bogdanm 0:9b334a45a8ff 269 }
bogdanm 0:9b334a45a8ff 270
bogdanm 0:9b334a45a8ff 271 void pwmout_pulsewidth_ms(pwmout_t* obj, int ms)
bogdanm 0:9b334a45a8ff 272 {
bogdanm 0:9b334a45a8ff 273 pwmout_pulsewidth_us(obj, ms * 1000);
bogdanm 0:9b334a45a8ff 274 }
bogdanm 0:9b334a45a8ff 275
bogdanm 0:9b334a45a8ff 276 void pwmout_pulsewidth_us(pwmout_t* obj, int us)
bogdanm 0:9b334a45a8ff 277 {
bogdanm 0:9b334a45a8ff 278 float value = (float)us / (float)obj->period;
bogdanm 0:9b334a45a8ff 279 pwmout_write(obj, value);
bogdanm 0:9b334a45a8ff 280 }
bogdanm 0:9b334a45a8ff 281
bogdanm 0:9b334a45a8ff 282 #endif