Amit Gandhi / sensen_copy_2

t

Fork of mbed-dev by mbed official

targets/hal/TARGET_STM/TARGET_STM32F4/pwmout_api.c@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Child:
19:112740acecfa
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 *******************************************************************************
bogdanm 0:9b334a45a8ff 3 * Copyright (c) 2014, 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
bogdanm 0:9b334a45a8ff 54 if (obj->pwm == PWM_1) __HAL_RCC_TIM1_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 55 if (obj->pwm == PWM_2) __HAL_RCC_TIM2_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 56 if (obj->pwm == PWM_3) __HAL_RCC_TIM3_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 57 if (obj->pwm == PWM_4) __HAL_RCC_TIM4_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 58 #if defined(TIM8_BASE)
bogdanm 0:9b334a45a8ff 59 if (obj->pwm == PWM_8) __HAL_RCC_TIM8_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 60 #endif
bogdanm 0:9b334a45a8ff 61 if (obj->pwm == PWM_9) __HAL_RCC_TIM9_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 62 if (obj->pwm == PWM_10) __HAL_RCC_TIM10_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 63 if (obj->pwm == PWM_11) __HAL_RCC_TIM11_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 64 #if defined(TIM12_BASE)
bogdanm 0:9b334a45a8ff 65 if (obj->pwm == PWM_12) __HAL_RCC_TIM12_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 66 #endif
bogdanm 0:9b334a45a8ff 67 #if defined(TIM13_BASE)
bogdanm 0:9b334a45a8ff 68 if (obj->pwm == PWM_13) __HAL_RCC_TIM13_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 69 #endif
bogdanm 0:9b334a45a8ff 70 #if defined(TIM14_BASE)
bogdanm 0:9b334a45a8ff 71 if (obj->pwm == PWM_14) __HAL_RCC_TIM14_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 72 #endif
bogdanm 0:9b334a45a8ff 73
bogdanm 0:9b334a45a8ff 74 // Configure GPIO
bogdanm 0:9b334a45a8ff 75 pinmap_pinout(pin, PinMap_PWM);
bogdanm 0:9b334a45a8ff 76
bogdanm 0:9b334a45a8ff 77 obj->pin = pin;
bogdanm 0:9b334a45a8ff 78 obj->period = 0;
bogdanm 0:9b334a45a8ff 79 obj->pulse = 0;
bogdanm 0:9b334a45a8ff 80
bogdanm 0:9b334a45a8ff 81 pwmout_period_us(obj, 20000); // 20 ms per default
bogdanm 0:9b334a45a8ff 82 }
bogdanm 0:9b334a45a8ff 83
bogdanm 0:9b334a45a8ff 84 void pwmout_free(pwmout_t* obj)
bogdanm 0:9b334a45a8ff 85 {
bogdanm 0:9b334a45a8ff 86 // Configure GPIO
bogdanm 0:9b334a45a8ff 87 pin_function(obj->pin, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
bogdanm 0:9b334a45a8ff 88 }
bogdanm 0:9b334a45a8ff 89
bogdanm 0:9b334a45a8ff 90 void pwmout_write(pwmout_t* obj, float value)
bogdanm 0:9b334a45a8ff 91 {
bogdanm 0:9b334a45a8ff 92 TIM_OC_InitTypeDef sConfig;
bogdanm 0:9b334a45a8ff 93 int channel = 0;
bogdanm 0:9b334a45a8ff 94
bogdanm 0:9b334a45a8ff 95 TimHandle.Instance = (TIM_TypeDef *)(obj->pwm);
bogdanm 0:9b334a45a8ff 96
bogdanm 0:9b334a45a8ff 97 if (value < (float)0.0) {
bogdanm 0:9b334a45a8ff 98 value = 0.0;
bogdanm 0:9b334a45a8ff 99 } else if (value > (float)1.0) {
bogdanm 0:9b334a45a8ff 100 value = 1.0;
bogdanm 0:9b334a45a8ff 101 }
bogdanm 0:9b334a45a8ff 102
bogdanm 0:9b334a45a8ff 103 obj->pulse = (uint32_t)((float)obj->period * value);
bogdanm 0:9b334a45a8ff 104
bogdanm 0:9b334a45a8ff 105 // Configure channels
bogdanm 0:9b334a45a8ff 106 sConfig.OCMode = TIM_OCMODE_PWM1;
bogdanm 0:9b334a45a8ff 107 sConfig.Pulse = obj->pulse;
bogdanm 0:9b334a45a8ff 108 sConfig.OCPolarity = TIM_OCPOLARITY_HIGH;
bogdanm 0:9b334a45a8ff 109 sConfig.OCNPolarity = TIM_OCNPOLARITY_HIGH;
bogdanm 0:9b334a45a8ff 110 sConfig.OCFastMode = TIM_OCFAST_DISABLE;
bogdanm 0:9b334a45a8ff 111 sConfig.OCIdleState = TIM_OCIDLESTATE_RESET;
bogdanm 0:9b334a45a8ff 112 sConfig.OCNIdleState = TIM_OCNIDLESTATE_RESET;
bogdanm 0:9b334a45a8ff 113
bogdanm 0:9b334a45a8ff 114 switch (obj->channel) {
bogdanm 0:9b334a45a8ff 115 case 1:
bogdanm 0:9b334a45a8ff 116 channel = TIM_CHANNEL_1;
bogdanm 0:9b334a45a8ff 117 break;
bogdanm 0:9b334a45a8ff 118 case 2:
bogdanm 0:9b334a45a8ff 119 channel = TIM_CHANNEL_2;
bogdanm 0:9b334a45a8ff 120 break;
bogdanm 0:9b334a45a8ff 121 case 3:
bogdanm 0:9b334a45a8ff 122 channel = TIM_CHANNEL_3;
bogdanm 0:9b334a45a8ff 123 break;
bogdanm 0:9b334a45a8ff 124 case 4:
bogdanm 0:9b334a45a8ff 125 channel = TIM_CHANNEL_4;
bogdanm 0:9b334a45a8ff 126 break;
bogdanm 0:9b334a45a8ff 127 default:
bogdanm 0:9b334a45a8ff 128 return;
bogdanm 0:9b334a45a8ff 129 }
bogdanm 0:9b334a45a8ff 130
bogdanm 0:9b334a45a8ff 131 if (HAL_TIM_PWM_ConfigChannel(&TimHandle, &sConfig, channel) != HAL_OK) {
bogdanm 0:9b334a45a8ff 132 error("Cannot initialize PWM\n");
bogdanm 0:9b334a45a8ff 133 }
bogdanm 0:9b334a45a8ff 134
bogdanm 0:9b334a45a8ff 135 if (obj->inverted) {
bogdanm 0:9b334a45a8ff 136 HAL_TIMEx_PWMN_Start(&TimHandle, channel);
bogdanm 0:9b334a45a8ff 137 } else {
bogdanm 0:9b334a45a8ff 138 HAL_TIM_PWM_Start(&TimHandle, channel);
bogdanm 0:9b334a45a8ff 139 }
bogdanm 0:9b334a45a8ff 140 }
bogdanm 0:9b334a45a8ff 141
bogdanm 0:9b334a45a8ff 142 float pwmout_read(pwmout_t* obj)
bogdanm 0:9b334a45a8ff 143 {
bogdanm 0:9b334a45a8ff 144 float value = 0;
bogdanm 0:9b334a45a8ff 145 if (obj->period > 0) {
bogdanm 0:9b334a45a8ff 146 value = (float)(obj->pulse) / (float)(obj->period);
bogdanm 0:9b334a45a8ff 147 }
bogdanm 0:9b334a45a8ff 148 return ((value > (float)1.0) ? (float)(1.0) : (value));
bogdanm 0:9b334a45a8ff 149 }
bogdanm 0:9b334a45a8ff 150
bogdanm 0:9b334a45a8ff 151 void pwmout_period(pwmout_t* obj, float seconds)
bogdanm 0:9b334a45a8ff 152 {
bogdanm 0:9b334a45a8ff 153 pwmout_period_us(obj, seconds * 1000000.0f);
bogdanm 0:9b334a45a8ff 154 }
bogdanm 0:9b334a45a8ff 155
bogdanm 0:9b334a45a8ff 156 void pwmout_period_ms(pwmout_t* obj, int ms)
bogdanm 0:9b334a45a8ff 157 {
bogdanm 0:9b334a45a8ff 158 pwmout_period_us(obj, ms * 1000);
bogdanm 0:9b334a45a8ff 159 }
bogdanm 0:9b334a45a8ff 160
bogdanm 0:9b334a45a8ff 161 void pwmout_period_us(pwmout_t* obj, int us)
bogdanm 0:9b334a45a8ff 162 {
bogdanm 0:9b334a45a8ff 163 TimHandle.Instance = (TIM_TypeDef *)(obj->pwm);
bogdanm 0:9b334a45a8ff 164 RCC_ClkInitTypeDef RCC_ClkInitStruct;
bogdanm 0:9b334a45a8ff 165 uint32_t PclkFreq;
bogdanm 0:9b334a45a8ff 166 uint32_t APBxCLKDivider;
bogdanm 0:9b334a45a8ff 167 float dc = pwmout_read(obj);
bogdanm 0:9b334a45a8ff 168
bogdanm 0:9b334a45a8ff 169 __HAL_TIM_DISABLE(&TimHandle);
bogdanm 0:9b334a45a8ff 170
bogdanm 0:9b334a45a8ff 171 // Get clock configuration
bogdanm 0:9b334a45a8ff 172 // Note: PclkFreq contains here the Latency (not used after)
bogdanm 0:9b334a45a8ff 173 HAL_RCC_GetClockConfig(&RCC_ClkInitStruct, &PclkFreq);
bogdanm 0:9b334a45a8ff 174
bogdanm 0:9b334a45a8ff 175 // Get the PCLK and APBCLK divider related to the timer
bogdanm 0:9b334a45a8ff 176 switch (obj->pwm) {
bogdanm 0:9b334a45a8ff 177
bogdanm 0:9b334a45a8ff 178 // APB1 clock
bogdanm 0:9b334a45a8ff 179 case PWM_2:
bogdanm 0:9b334a45a8ff 180 case PWM_3:
bogdanm 0:9b334a45a8ff 181 case PWM_4:
bogdanm 0:9b334a45a8ff 182 case PWM_5:
bogdanm 0:9b334a45a8ff 183 #if defined(TIM12_BASE)
bogdanm 0:9b334a45a8ff 184 case PWM_12:
bogdanm 0:9b334a45a8ff 185 #endif
bogdanm 0:9b334a45a8ff 186 #if defined(TIM13_BASE)
bogdanm 0:9b334a45a8ff 187 case PWM_13:
bogdanm 0:9b334a45a8ff 188 #endif
bogdanm 0:9b334a45a8ff 189 #if defined(TIM14_BASE)
bogdanm 0:9b334a45a8ff 190 case PWM_14:
bogdanm 0:9b334a45a8ff 191 #endif
bogdanm 0:9b334a45a8ff 192 PclkFreq = HAL_RCC_GetPCLK1Freq();
bogdanm 0:9b334a45a8ff 193 APBxCLKDivider = RCC_ClkInitStruct.APB1CLKDivider;
bogdanm 0:9b334a45a8ff 194 break;
bogdanm 0:9b334a45a8ff 195
bogdanm 0:9b334a45a8ff 196 // APB2 clock
bogdanm 0:9b334a45a8ff 197 case PWM_1:
bogdanm 0:9b334a45a8ff 198 #if defined(TIM8_BASE)
bogdanm 0:9b334a45a8ff 199 case PWM_8:
bogdanm 0:9b334a45a8ff 200 #endif
bogdanm 0:9b334a45a8ff 201 case PWM_9:
bogdanm 0:9b334a45a8ff 202 case PWM_10:
bogdanm 0:9b334a45a8ff 203 case PWM_11:
bogdanm 0:9b334a45a8ff 204 PclkFreq = HAL_RCC_GetPCLK2Freq();
bogdanm 0:9b334a45a8ff 205 APBxCLKDivider = RCC_ClkInitStruct.APB2CLKDivider;
bogdanm 0:9b334a45a8ff 206 break;
bogdanm 0:9b334a45a8ff 207 default:
bogdanm 0:9b334a45a8ff 208 return;
bogdanm 0:9b334a45a8ff 209 }
bogdanm 0:9b334a45a8ff 210
bogdanm 0:9b334a45a8ff 211 TimHandle.Init.Period = us - 1;
bogdanm 0:9b334a45a8ff 212 // TIMxCLK = PCLKx when the APB prescaler = 1 else TIMxCLK = 2 * PCLKx
bogdanm 0:9b334a45a8ff 213 if (APBxCLKDivider == RCC_HCLK_DIV1)
bogdanm 0:9b334a45a8ff 214 TimHandle.Init.Prescaler = (uint16_t)((PclkFreq) / 1000000) - 1; // 1 us tick
bogdanm 0:9b334a45a8ff 215 else
bogdanm 0:9b334a45a8ff 216 TimHandle.Init.Prescaler = (uint16_t)((PclkFreq * 2) / 1000000) - 1; // 1 us tick
bogdanm 0:9b334a45a8ff 217 TimHandle.Init.ClockDivision = 0;
bogdanm 0:9b334a45a8ff 218 TimHandle.Init.CounterMode = TIM_COUNTERMODE_UP;
bogdanm 0:9b334a45a8ff 219
bogdanm 0:9b334a45a8ff 220 if (HAL_TIM_PWM_Init(&TimHandle) != HAL_OK) {
bogdanm 0:9b334a45a8ff 221 error("Cannot initialize PWM\n");
bogdanm 0:9b334a45a8ff 222 }
bogdanm 0:9b334a45a8ff 223
bogdanm 0:9b334a45a8ff 224 // Set duty cycle again
bogdanm 0:9b334a45a8ff 225 pwmout_write(obj, dc);
bogdanm 0:9b334a45a8ff 226
bogdanm 0:9b334a45a8ff 227 // Save for future use
bogdanm 0:9b334a45a8ff 228 obj->period = us;
bogdanm 0:9b334a45a8ff 229
bogdanm 0:9b334a45a8ff 230 __HAL_TIM_ENABLE(&TimHandle);
bogdanm 0:9b334a45a8ff 231 }
bogdanm 0:9b334a45a8ff 232
bogdanm 0:9b334a45a8ff 233 void pwmout_pulsewidth(pwmout_t* obj, float seconds)
bogdanm 0:9b334a45a8ff 234 {
bogdanm 0:9b334a45a8ff 235 pwmout_pulsewidth_us(obj, seconds * 1000000.0f);
bogdanm 0:9b334a45a8ff 236 }
bogdanm 0:9b334a45a8ff 237
bogdanm 0:9b334a45a8ff 238 void pwmout_pulsewidth_ms(pwmout_t* obj, int ms)
bogdanm 0:9b334a45a8ff 239 {
bogdanm 0:9b334a45a8ff 240 pwmout_pulsewidth_us(obj, ms * 1000);
bogdanm 0:9b334a45a8ff 241 }
bogdanm 0:9b334a45a8ff 242
bogdanm 0:9b334a45a8ff 243 void pwmout_pulsewidth_us(pwmout_t* obj, int us)
bogdanm 0:9b334a45a8ff 244 {
bogdanm 0:9b334a45a8ff 245 float value = (float)us / (float)obj->period;
bogdanm 0:9b334a45a8ff 246 pwmout_write(obj, value);
bogdanm 0:9b334a45a8ff 247 }
bogdanm 0:9b334a45a8ff 248
bogdanm 0:9b334a45a8ff 249 #endif