tool/mbed/mbed-sdk/libraries/mbed/targets/hal/TARGET_STM/TARGET_STM32F1/pwmout_api.c

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