tool/mbed/mbed-sdk/libraries/mbed/targets/hal/TARGET_STM/TARGET_STM32F3/TARGET_NUCLEO_F303RE/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     if (obj->pwm == PWM_8) __TIM8_CLK_ENABLE();
  55     if (obj->pwm == PWM_15) __TIM15_CLK_ENABLE();
  56     if (obj->pwm == PWM_16) __TIM16_CLK_ENABLE();
  57     if (obj->pwm == PWM_17) __TIM17_CLK_ENABLE();
  58
  59     // Configure GPIO
  60     pinmap_pinout(pin, PinMap_PWM);
  61
  62     obj->pin = pin;
  63     obj->period = 0;
  64     obj->pulse = 0;
  65
  66     pwmout_period_us(obj, 20000); // 20 ms per default
  67 }
  68
  69 void pwmout_free(pwmout_t* obj)
  70 {
  71     // Configure GPIO
  72     pin_function(obj->pin, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
  73 }
  74
  75 void pwmout_write(pwmout_t* obj, float value)
  76 {
  77     TIM_OC_InitTypeDef sConfig;
  78     int channel = 0;
  79     int complementary_channel = 0;
  80
  81     TimHandle.Instance = (TIM_TypeDef *)(obj->pwm);
  82
  83     if (value < (float)0.0) {
  84         value = 0.0;
  85     } else if (value > (float)1.0) {
  86         value = 1.0;
  87     }
  88
  89     obj->pulse = (uint32_t)((float)obj->period * value);
  90
  91     // Configure channels
  92     sConfig.OCMode       = TIM_OCMODE_PWM1;
  93     sConfig.Pulse        = obj->pulse;
  94     sConfig.OCPolarity   = TIM_OCPOLARITY_HIGH;
  95     sConfig.OCNPolarity  = TIM_OCNPOLARITY_HIGH;
  96     sConfig.OCFastMode   = TIM_OCFAST_DISABLE;
  97     sConfig.OCIdleState  = TIM_OCIDLESTATE_RESET;
  98     sConfig.OCNIdleState = TIM_OCNIDLESTATE_RESET;
  99
 100     switch (obj->pin) {
 101
 102         // Channels 1
 103         case PA_2:
 104         case PA_6:
 105         case PA_7:
 106         case PA_8:
 107         case PA_12:
 108         case PA_15:
 109         case PB_4:
 110         case PB_5:
 111         case PB_8:
 112         case PB_9:
 113         case PB_14:
 114         case PC_0:
 115         case PC_6:
 116             channel = TIM_CHANNEL_1;
 117             break;
 118
 119         // Channels 1N
 120         case PA_1:
 121         case PA_13:
 122         case PB_3:
 123         case PB_6:
 124         case PB_7:
 125         case PB_13:
 126         case PC_10:
 127         case PC_13:
 128             channel = TIM_CHANNEL_1;
 129             complementary_channel = 1;
 130             break;
 131
 132         // Channels 2
 133         case PA_3:
 134         case PA_4:
 135         case PA_9:
 136         case PA_14:
 137         case PB_15:
 138         case PC_1:
 139         case PC_7:
 140             channel = TIM_CHANNEL_2;
 141             break;
 142
 143         // Channels 2N
 144         case PB_0:
 145         case PC_11:
 146             channel = TIM_CHANNEL_2;
 147             complementary_channel = 1;
 148             break;
 149
 150         // Channels 3
 151         case PA_10:
 152         case PC_2:
 153         case PC_8:
 154             channel = TIM_CHANNEL_3;
 155             break;
 156
 157         // Channels 3N
 158         case PB_1:
 159         case PC_12:
 160         case PF_0:
 161             channel = TIM_CHANNEL_3;
 162             complementary_channel = 1;
 163             break;
 164
 165         // Channels 4
 166         case PA_11:
 167         case PC_3:
 168         case PC_9:
 169             channel = TIM_CHANNEL_4;
 170             break;
 171
 172         default:
 173             return;
 174     }
 175
 176     HAL_TIM_PWM_ConfigChannel(&TimHandle, &sConfig, channel);
 177
 178     if (complementary_channel) {
 179         HAL_TIMEx_PWMN_Start(&TimHandle, channel);
 180     } else {
 181         HAL_TIM_PWM_Start(&TimHandle, channel);
 182     }
 183 }
 184
 185 float pwmout_read(pwmout_t* obj)
 186 {
 187     float value = 0;
 188     if (obj->period > 0) {
 189         value = (float)(obj->pulse) / (float)(obj->period);
 190     }
 191     return ((value > (float)1.0) ? (float)(1.0) : (value));
 192 }
 193
 194 void pwmout_period(pwmout_t* obj, float seconds)
 195 {
 196     pwmout_period_us(obj, seconds * 1000000.0f);
 197 }
 198
 199 void pwmout_period_ms(pwmout_t* obj, int ms)
 200 {
 201     pwmout_period_us(obj, ms * 1000);
 202 }
 203
 204 void pwmout_period_us(pwmout_t* obj, int us)
 205 {
 206     TimHandle.Instance = (TIM_TypeDef *)(obj->pwm);
 207
 208     float dc = pwmout_read(obj);
 209
 210     __HAL_TIM_DISABLE(&TimHandle);
 211
 212     // Update the SystemCoreClock variable
 213     SystemCoreClockUpdate();
 214
 215     TimHandle.Init.Period        = us - 1;
 216     TimHandle.Init.Prescaler     = (uint16_t)(SystemCoreClock / 1000000) - 1; // 1 µs tick
 217     TimHandle.Init.ClockDivision = 0;
 218     TimHandle.Init.CounterMode   = TIM_COUNTERMODE_UP;
 219     HAL_TIM_PWM_Init(&TimHandle);
 220
 221     // Set duty cycle again
 222     pwmout_write(obj, dc);
 223
 224     // Save for future use
 225     obj->period = us;
 226
 227     __HAL_TIM_ENABLE(&TimHandle);
 228 }
 229
 230 void pwmout_pulsewidth(pwmout_t* obj, float seconds)
 231 {
 232     pwmout_pulsewidth_us(obj, seconds * 1000000.0f);
 233 }
 234
 235 void pwmout_pulsewidth_ms(pwmout_t* obj, int ms)
 236 {
 237     pwmout_pulsewidth_us(obj, ms * 1000);
 238 }
 239
 240 void pwmout_pulsewidth_us(pwmout_t* obj, int us)
 241 {
 242     float value = (float)us / (float)obj->period;
 243     pwmout_write(obj, value);
 244 }
 245
 246 #endif