Johannes Stratmann / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

targets/hal/TARGET_STM/TARGET_STM32F0/pwmout_api.c@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
5:ac9f6c2c45e8 
This updates the lib to the mbed lib v125

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /* mbed Microcontroller Library
<> 144:ef7eb2e8f9f7 2 *******************************************************************************
<> 144:ef7eb2e8f9f7 3 * Copyright (c) 2014, STMicroelectronics
<> 144:ef7eb2e8f9f7 4 * All rights reserved.
<> 144:ef7eb2e8f9f7 5 *
<> 144:ef7eb2e8f9f7 6 * Redistribution and use in source and binary forms, with or without
<> 144:ef7eb2e8f9f7 7 * modification, are permitted provided that the following conditions are met:
<> 144:ef7eb2e8f9f7 8 *
<> 144:ef7eb2e8f9f7 9 * 1. Redistributions of source code must retain the above copyright notice,
<> 144:ef7eb2e8f9f7 10 * this list of conditions and the following disclaimer.
<> 144:ef7eb2e8f9f7 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
<> 144:ef7eb2e8f9f7 12 * this list of conditions and the following disclaimer in the documentation
<> 144:ef7eb2e8f9f7 13 * and/or other materials provided with the distribution.
<> 144:ef7eb2e8f9f7 14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
<> 144:ef7eb2e8f9f7 15 * may be used to endorse or promote products derived from this software
<> 144:ef7eb2e8f9f7 16 * without specific prior written permission.
<> 144:ef7eb2e8f9f7 17 *
<> 144:ef7eb2e8f9f7 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
<> 144:ef7eb2e8f9f7 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
<> 144:ef7eb2e8f9f7 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 144:ef7eb2e8f9f7 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
<> 144:ef7eb2e8f9f7 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
<> 144:ef7eb2e8f9f7 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
<> 144:ef7eb2e8f9f7 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
<> 144:ef7eb2e8f9f7 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
<> 144:ef7eb2e8f9f7 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
<> 144:ef7eb2e8f9f7 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 144:ef7eb2e8f9f7 28 *******************************************************************************
<> 144:ef7eb2e8f9f7 29 */
<> 144:ef7eb2e8f9f7 30 #include "pwmout_api.h"
<> 144:ef7eb2e8f9f7 31
<> 144:ef7eb2e8f9f7 32 #if DEVICE_PWMOUT
<> 144:ef7eb2e8f9f7 33
<> 144:ef7eb2e8f9f7 34 #include "cmsis.h"
<> 144:ef7eb2e8f9f7 35 #include "pinmap.h"
<> 144:ef7eb2e8f9f7 36 #include "mbed_error.h"
<> 144:ef7eb2e8f9f7 37 #include "PeripheralPins.h"
<> 144:ef7eb2e8f9f7 38
<> 144:ef7eb2e8f9f7 39 static TIM_HandleTypeDef TimHandle;
<> 144:ef7eb2e8f9f7 40
<> 144:ef7eb2e8f9f7 41 void pwmout_init(pwmout_t* obj, PinName pin) {
<> 144:ef7eb2e8f9f7 42 // Get the peripheral name from the pin and assign it to the object
<> 144:ef7eb2e8f9f7 43 obj->pwm = (PWMName)pinmap_peripheral(pin, PinMap_PWM);
<> 144:ef7eb2e8f9f7 44 MBED_ASSERT(obj->pwm != (PWMName)NC);
<> 144:ef7eb2e8f9f7 45
<> 144:ef7eb2e8f9f7 46 // Get the functions (timer channel, (non)inverted) from the pin and assign it to the object
<> 144:ef7eb2e8f9f7 47 uint32_t function = pinmap_function(pin, PinMap_PWM);
<> 144:ef7eb2e8f9f7 48 MBED_ASSERT(function != (uint32_t)NC);
<> 144:ef7eb2e8f9f7 49 obj->channel = STM_PIN_CHANNEL(function);
<> 144:ef7eb2e8f9f7 50 obj->inverted = STM_PIN_INVERTED(function);
<> 144:ef7eb2e8f9f7 51
<> 144:ef7eb2e8f9f7 52 // Enable TIM clock
<> 144:ef7eb2e8f9f7 53 #if defined(TIM1_BASE)
<> 144:ef7eb2e8f9f7 54 if (obj->pwm == PWM_1) __TIM1_CLK_ENABLE();
<> 144:ef7eb2e8f9f7 55 #endif
<> 144:ef7eb2e8f9f7 56 #if defined(TIM2_BASE)
<> 144:ef7eb2e8f9f7 57 if (obj->pwm == PWM_2) __TIM2_CLK_ENABLE();
<> 144:ef7eb2e8f9f7 58 #endif
<> 144:ef7eb2e8f9f7 59 #if defined(TIM3_BASE)
<> 144:ef7eb2e8f9f7 60 if (obj->pwm == PWM_3) __TIM3_CLK_ENABLE();
<> 144:ef7eb2e8f9f7 61 #endif
<> 144:ef7eb2e8f9f7 62 #if defined(TIM14_BASE)
<> 144:ef7eb2e8f9f7 63 if (obj->pwm == PWM_14) __TIM14_CLK_ENABLE();
<> 144:ef7eb2e8f9f7 64 #endif
<> 144:ef7eb2e8f9f7 65 #if defined(TIM15_BASE)
<> 144:ef7eb2e8f9f7 66 if (obj->pwm == PWM_15) __TIM15_CLK_ENABLE();
<> 144:ef7eb2e8f9f7 67 #endif
<> 144:ef7eb2e8f9f7 68 #if defined(TIM16_BASE)
<> 144:ef7eb2e8f9f7 69 if (obj->pwm == PWM_16) __TIM16_CLK_ENABLE();
<> 144:ef7eb2e8f9f7 70 #endif
<> 144:ef7eb2e8f9f7 71 #if defined(TIM17_BASE)
<> 144:ef7eb2e8f9f7 72 if (obj->pwm == PWM_17) __TIM17_CLK_ENABLE();
<> 144:ef7eb2e8f9f7 73 #endif
<> 144:ef7eb2e8f9f7 74
<> 144:ef7eb2e8f9f7 75 // Configure GPIO
<> 144:ef7eb2e8f9f7 76 pinmap_pinout(pin, PinMap_PWM);
<> 144:ef7eb2e8f9f7 77
<> 144:ef7eb2e8f9f7 78 obj->pin = pin;
<> 144:ef7eb2e8f9f7 79 obj->period = 0;
<> 144:ef7eb2e8f9f7 80 obj->pulse = 0;
<> 144:ef7eb2e8f9f7 81 obj->prescaler = 1;
<> 144:ef7eb2e8f9f7 82
<> 144:ef7eb2e8f9f7 83 pwmout_period_us(obj, 20000); // 20 ms per default
<> 144:ef7eb2e8f9f7 84 }
<> 144:ef7eb2e8f9f7 85
<> 144:ef7eb2e8f9f7 86 void pwmout_free(pwmout_t* obj) {
<> 144:ef7eb2e8f9f7 87 // Configure GPIO
<> 144:ef7eb2e8f9f7 88 pin_function(obj->pin, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
<> 144:ef7eb2e8f9f7 89 }
<> 144:ef7eb2e8f9f7 90
<> 144:ef7eb2e8f9f7 91 void pwmout_write(pwmout_t* obj, float value) {
<> 144:ef7eb2e8f9f7 92 TIM_OC_InitTypeDef sConfig;
<> 144:ef7eb2e8f9f7 93 int channel = 0;
<> 144:ef7eb2e8f9f7 94
<> 144:ef7eb2e8f9f7 95 TimHandle.Instance = (TIM_TypeDef *)(obj->pwm);
<> 144:ef7eb2e8f9f7 96
<> 144:ef7eb2e8f9f7 97 if (value < (float)0.0) {
<> 144:ef7eb2e8f9f7 98 value = 0.0;
<> 144:ef7eb2e8f9f7 99 } else if (value > (float)1.0) {
<> 144:ef7eb2e8f9f7 100 value = 1.0;
<> 144:ef7eb2e8f9f7 101 }
<> 144:ef7eb2e8f9f7 102
<> 144:ef7eb2e8f9f7 103 obj->pulse = (uint32_t)((float)obj->period * value);
<> 144:ef7eb2e8f9f7 104
<> 144:ef7eb2e8f9f7 105 // Configure channels
<> 144:ef7eb2e8f9f7 106 sConfig.OCMode = TIM_OCMODE_PWM1;
<> 144:ef7eb2e8f9f7 107 sConfig.Pulse = obj->pulse / obj->prescaler;
<> 144:ef7eb2e8f9f7 108 sConfig.OCPolarity = TIM_OCPOLARITY_HIGH;
<> 144:ef7eb2e8f9f7 109 sConfig.OCNPolarity = TIM_OCNPOLARITY_HIGH;
<> 144:ef7eb2e8f9f7 110 sConfig.OCFastMode = TIM_OCFAST_DISABLE;
<> 144:ef7eb2e8f9f7 111 sConfig.OCIdleState = TIM_OCIDLESTATE_RESET;
<> 144:ef7eb2e8f9f7 112 sConfig.OCNIdleState = TIM_OCNIDLESTATE_RESET;
<> 144:ef7eb2e8f9f7 113
<> 144:ef7eb2e8f9f7 114 switch (obj->channel) {
<> 144:ef7eb2e8f9f7 115 case 1:
<> 144:ef7eb2e8f9f7 116 channel = TIM_CHANNEL_1;
<> 144:ef7eb2e8f9f7 117 break;
<> 144:ef7eb2e8f9f7 118 case 2:
<> 144:ef7eb2e8f9f7 119 channel = TIM_CHANNEL_2;
<> 144:ef7eb2e8f9f7 120 break;
<> 144:ef7eb2e8f9f7 121 case 3:
<> 144:ef7eb2e8f9f7 122 channel = TIM_CHANNEL_3;
<> 144:ef7eb2e8f9f7 123 break;
<> 144:ef7eb2e8f9f7 124 case 4:
<> 144:ef7eb2e8f9f7 125 channel = TIM_CHANNEL_4;
<> 144:ef7eb2e8f9f7 126 break;
<> 144:ef7eb2e8f9f7 127 default:
<> 144:ef7eb2e8f9f7 128 return;
<> 144:ef7eb2e8f9f7 129 }
<> 144:ef7eb2e8f9f7 130
<> 144:ef7eb2e8f9f7 131 if (HAL_TIM_PWM_ConfigChannel(&TimHandle, &sConfig, channel) != HAL_OK) {
<> 144:ef7eb2e8f9f7 132 error("Cannot initialize PWM\n");
<> 144:ef7eb2e8f9f7 133 }
<> 144:ef7eb2e8f9f7 134
<> 144:ef7eb2e8f9f7 135 if (obj->inverted) {
<> 144:ef7eb2e8f9f7 136 HAL_TIMEx_PWMN_Start(&TimHandle, channel);
<> 144:ef7eb2e8f9f7 137 } else {
<> 144:ef7eb2e8f9f7 138 HAL_TIM_PWM_Start(&TimHandle, channel);
<> 144:ef7eb2e8f9f7 139 }
<> 144:ef7eb2e8f9f7 140 }
<> 144:ef7eb2e8f9f7 141
<> 144:ef7eb2e8f9f7 142 float pwmout_read(pwmout_t* obj) {
<> 144:ef7eb2e8f9f7 143 float value = 0;
<> 144:ef7eb2e8f9f7 144 if (obj->period > 0) {
<> 144:ef7eb2e8f9f7 145 value = (float)(obj->pulse) / (float)(obj->period);
<> 144:ef7eb2e8f9f7 146 }
<> 144:ef7eb2e8f9f7 147 return ((value > (float)1.0) ? (float)(1.0) : (value));
<> 144:ef7eb2e8f9f7 148 }
<> 144:ef7eb2e8f9f7 149
<> 144:ef7eb2e8f9f7 150 void pwmout_period(pwmout_t* obj, float seconds) {
<> 144:ef7eb2e8f9f7 151 pwmout_period_us(obj, seconds * 1000000.0f);
<> 144:ef7eb2e8f9f7 152 }
<> 144:ef7eb2e8f9f7 153
<> 144:ef7eb2e8f9f7 154 void pwmout_period_ms(pwmout_t* obj, int ms) {
<> 144:ef7eb2e8f9f7 155 pwmout_period_us(obj, ms * 1000);
<> 144:ef7eb2e8f9f7 156 }
<> 144:ef7eb2e8f9f7 157
<> 144:ef7eb2e8f9f7 158 void pwmout_period_us(pwmout_t* obj, int us) {
<> 144:ef7eb2e8f9f7 159 TimHandle.Instance = (TIM_TypeDef *)(obj->pwm);
<> 144:ef7eb2e8f9f7 160
<> 144:ef7eb2e8f9f7 161 float dc = pwmout_read(obj);
<> 144:ef7eb2e8f9f7 162
<> 144:ef7eb2e8f9f7 163 __HAL_TIM_DISABLE(&TimHandle);
<> 144:ef7eb2e8f9f7 164
<> 144:ef7eb2e8f9f7 165 // Update the SystemCoreClock variable
<> 144:ef7eb2e8f9f7 166 SystemCoreClockUpdate();
<> 144:ef7eb2e8f9f7 167
<> 144:ef7eb2e8f9f7 168 /* To make it simple, we use to possible prescaler values which lead to:
<> 144:ef7eb2e8f9f7 169 * pwm unit = 1us, period/pulse can be from 1us to 65535us
<> 144:ef7eb2e8f9f7 170 * or
<> 144:ef7eb2e8f9f7 171 * pwm unit = 500us, period/pulse can be from 500us to ~32.76sec
<> 144:ef7eb2e8f9f7 172 * Be careful that all the channels of a PWM shares the same prescaler
<> 144:ef7eb2e8f9f7 173 */
<> 144:ef7eb2e8f9f7 174 if (us > 0xFFFF) {
<> 144:ef7eb2e8f9f7 175 obj->prescaler = 500;
<> 144:ef7eb2e8f9f7 176 } else {
<> 144:ef7eb2e8f9f7 177 obj->prescaler = 1;
<> 144:ef7eb2e8f9f7 178 }
<> 144:ef7eb2e8f9f7 179 TimHandle.Init.Prescaler = ((SystemCoreClock / 1000000) * obj->prescaler) - 1;
<> 144:ef7eb2e8f9f7 180
<> 144:ef7eb2e8f9f7 181 if (TimHandle.Init.Prescaler > 0xFFFF)
<> 144:ef7eb2e8f9f7 182 error("PWM: out of range prescaler");
<> 144:ef7eb2e8f9f7 183
<> 144:ef7eb2e8f9f7 184 TimHandle.Init.Period = (us - 1) / obj->prescaler;
<> 144:ef7eb2e8f9f7 185 if (TimHandle.Init.Period > 0xFFFF)
<> 144:ef7eb2e8f9f7 186 error("PWM: out of range period");
<> 144:ef7eb2e8f9f7 187
<> 144:ef7eb2e8f9f7 188 TimHandle.Init.ClockDivision = 0;
<> 144:ef7eb2e8f9f7 189 TimHandle.Init.CounterMode = TIM_COUNTERMODE_UP;
<> 144:ef7eb2e8f9f7 190
<> 144:ef7eb2e8f9f7 191 if (HAL_TIM_PWM_Init(&TimHandle) != HAL_OK) {
<> 144:ef7eb2e8f9f7 192 error("Cannot initialize PWM");
<> 144:ef7eb2e8f9f7 193 }
<> 144:ef7eb2e8f9f7 194
<> 144:ef7eb2e8f9f7 195 // Save for future use
<> 144:ef7eb2e8f9f7 196 obj->period = us;
<> 144:ef7eb2e8f9f7 197
<> 144:ef7eb2e8f9f7 198 // Set duty cycle again
<> 144:ef7eb2e8f9f7 199 pwmout_write(obj, dc);
<> 144:ef7eb2e8f9f7 200
<> 144:ef7eb2e8f9f7 201 __HAL_TIM_ENABLE(&TimHandle);
<> 144:ef7eb2e8f9f7 202 }
<> 144:ef7eb2e8f9f7 203
<> 144:ef7eb2e8f9f7 204 void pwmout_pulsewidth(pwmout_t* obj, float seconds) {
<> 144:ef7eb2e8f9f7 205 pwmout_pulsewidth_us(obj, seconds * 1000000.0f);
<> 144:ef7eb2e8f9f7 206 }
<> 144:ef7eb2e8f9f7 207
<> 144:ef7eb2e8f9f7 208 void pwmout_pulsewidth_ms(pwmout_t* obj, int ms) {
<> 144:ef7eb2e8f9f7 209 pwmout_pulsewidth_us(obj, ms * 1000);
<> 144:ef7eb2e8f9f7 210 }
<> 144:ef7eb2e8f9f7 211
<> 144:ef7eb2e8f9f7 212 void pwmout_pulsewidth_us(pwmout_t* obj, int us) {
<> 144:ef7eb2e8f9f7 213 float value = (float)us / (float)obj->period;
<> 144:ef7eb2e8f9f7 214 pwmout_write(obj, value);
<> 144:ef7eb2e8f9f7 215 }
<> 144:ef7eb2e8f9f7 216
<> 144:ef7eb2e8f9f7 217 #endif