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