src/main/drivers/pwm_output_dshot_hal_hal.c

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <stdbool.h>
  22 #include <stdint.h>
  23 #include <math.h>
  24 #include <string.h>
  25
  26 #include "platform.h"
  27
  28 #ifdef USE_DSHOT
  29
  30 #include "drivers/dma_reqmap.h"
  31 #include "drivers/io.h"
  32 #include "timer.h"
  33 #include "pwm_output.h"
  34 #include "drivers/dshot.h"
  35 #include "drivers/dshot_dpwm.h"
  36 #include "drivers/dshot_command.h"
  37 #include "drivers/nvic.h"
  38 #include "dma.h"
  39 #include "rcc.h"
  40 #include "pg/timerup.h"
  41
  42 static HAL_StatusTypeDef result;
  43
  44 static uint8_t dmaMotorTimerCount = 0;
  45 static motorDmaTimer_t dmaMotorTimers[MAX_DMA_TIMERS];
  46 static motorDmaOutput_t dmaMotors[MAX_SUPPORTED_MOTORS];
  47
  48 motorDmaOutput_t *getMotorDmaOutput(uint8_t index)
  49 {
  50     return &dmaMotors[index];
  51 }
  52
  53 uint8_t getTimerIndex(TIM_TypeDef *timer)
  54 {
  55     for (int i = 0; i < dmaMotorTimerCount; i++) {
  56         if (dmaMotorTimers[i].timer == timer) {
  57             return i;
  58         }
  59     }
  60     dmaMotorTimers[dmaMotorTimerCount++].timer = timer;
  61     return dmaMotorTimerCount - 1;
  62 }
  63
  64 // TIM_CHANNEL_x TIM_CHANNEL_x/4 TIM_DMA_ID_CCx TIM_DMA_CCx
  65 // 0x0           0               1              0x0200
  66 // 0x4           1               2              0x0400
  67 // 0x8           2               3              0x0800
  68 // 0xC           3               4              0x1000
  69 //
  70 // TIM_CHANNEL_TO_TIM_DMA_ID_CC = (TIM_CHANNEL_x / 4) + 1
  71 // TIM_CHANNEL_TO_TIM_DMA_CC = 0x200 << (TIM_CHANNEL_x / 4)
  72
  73 // pwmChannelDMAStart
  74 // A variant of HAL_TIM_PWM_Start_DMA/HAL_TIMEx_PWMN_Start_DMA that only disables DMA on a timer channel:
  75 //   1. Configure and enable DMA Stream
  76 //   2. Enable DMA request on a timer channel
  77
  78 void pwmChannelDMAStart(TIM_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length)
  79 {
  80     switch (Channel) {
  81     case TIM_CHANNEL_1:
  82         HAL_DMA_Start_IT(htim->hdma[TIM_DMA_ID_CC1], (uint32_t)pData, (uint32_t)&htim->Instance->CCR1, Length);
  83         __HAL_TIM_ENABLE_DMA(htim, TIM_DMA_CC1);
  84     break;
  85
  86     case TIM_CHANNEL_2:
  87         HAL_DMA_Start_IT(htim->hdma[TIM_DMA_ID_CC2], (uint32_t)pData, (uint32_t)&htim->Instance->CCR2, Length);
  88         __HAL_TIM_ENABLE_DMA(htim, TIM_DMA_CC2);
  89         break;
  90
  91     case TIM_CHANNEL_3:
  92         HAL_DMA_Start_IT(htim->hdma[TIM_DMA_ID_CC3], (uint32_t)pData, (uint32_t)&htim->Instance->CCR3,Length);
  93         __HAL_TIM_ENABLE_DMA(htim, TIM_DMA_CC3);
  94         break;
  95
  96     case TIM_CHANNEL_4:
  97         HAL_DMA_Start_IT(htim->hdma[TIM_DMA_ID_CC4], (uint32_t)pData, (uint32_t)&htim->Instance->CCR4, Length);
  98         __HAL_TIM_ENABLE_DMA(htim, TIM_DMA_CC4);
  99         break;
 100     }
 101 }
 102
 103 // pwmChannelDMAStop
 104 // A variant of HAL_TIM_PWM_Stop_DMA/HAL_TIMEx_PWMN_Stop_DMA that only disables DMA on a timer channel
 105 //   1. Disable the TIM Capture/Compare 1 DMA request
 106
 107 void pwmChannelDMAStop(TIM_HandleTypeDef *htim, uint32_t Channel)
 108 {
 109     switch (Channel) {
 110     case TIM_CHANNEL_1:
 111         __HAL_TIM_DISABLE_DMA(htim, TIM_DMA_CC1);
 112         break;
 113
 114     case TIM_CHANNEL_2:
 115         __HAL_TIM_DISABLE_DMA(htim, TIM_DMA_CC2);
 116         break;
 117
 118     case TIM_CHANNEL_3:
 119         __HAL_TIM_DISABLE_DMA(htim, TIM_DMA_CC3);
 120         break;
 121
 122     case TIM_CHANNEL_4:
 123         __HAL_TIM_DISABLE_DMA(htim, TIM_DMA_CC4);
 124         break;
 125     }
 126 }
 127
 128 // pwmBurstDMAStart
 129 // A variant of HAL_TIM_DMABurst_WriteStart that can handle multiple bursts.
 130 // (HAL_TIM_DMABurst_WriteStart can only handle single burst)
 131
 132 void pwmBurstDMAStart(TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, uint32_t BurstUnit, uint32_t* BurstBuffer, uint32_t BurstLength)
 133 {
 134     // Setup DMA stream
 135     HAL_DMA_Start_IT(htim->hdma[TIM_DMA_ID_UPDATE], (uint32_t)BurstBuffer, (uint32_t)&htim->Instance->DMAR, BurstLength);
 136
 137     // Configure burst mode DMA */
 138    htim->Instance->DCR = BurstBaseAddress | BurstUnit;
 139
 140     // Enable burst mode DMA
 141     __HAL_TIM_ENABLE_DMA(htim, BurstRequestSrc);
 142 }
 143
 144 FAST_CODE void pwmWriteDshotInt(uint8_t index, uint16_t value)
 145 {
 146     motorDmaOutput_t *const motor = &dmaMotors[index];
 147
 148     if (!motor->configured) {
 149         return;
 150     }
 151
 152     /*If there is a command ready to go overwrite the value and send that instead*/
 153     if (dshotCommandIsProcessing()) {
 154         value = dshotCommandGetCurrent(index);
 155         if (value) {
 156             motor->protocolControl.requestTelemetry = true;
 157         }
 158     }
 159
 160     if (!motor->timerHardware
 161 #ifndef USE_DMA_SPEC
 162         // When USE_DMA_SPEC is in effect, motor->timerHardware remains NULL if valid DMA is not assigned.
 163         || !motor->timerHardware->dmaRef
 164 #endif
 165     )
 166     {
 167         return;
 168     }
 169
 170     motor->protocolControl.value = value;
 171
 172     uint16_t packet = prepareDshotPacket(&motor->protocolControl);
 173     uint8_t bufferSize;
 174
 175 #ifdef USE_DSHOT_DMAR
 176     if (useBurstDshot) {
 177         bufferSize = loadDmaBuffer(&motor->timer->dmaBurstBuffer[timerLookupChannelIndex(motor->timerHardware->channel)], 4, packet);
 178         motor->timer->dmaBurstLength = bufferSize * 4;
 179     } else
 180 #endif
 181     {
 182         bufferSize = loadDmaBuffer(motor->dmaBuffer, 1, packet);
 183
 184         pwmChannelDMAStart(&motor->TimHandle, motor->timerHardware->channel, motor->dmaBuffer, bufferSize);
 185     }
 186 }
 187
 188 void pwmCompleteDshotMotorUpdate(void)
 189 {
 190     // If there is a dshot command loaded up, time it correctly with motor update
 191
 192     if (!dshotCommandQueueEmpty() && !dshotCommandOutputIsEnabled(dshotPwmDevice.count)) {
 193         return;
 194     }
 195
 196 #ifdef USE_DSHOT_DMAR
 197     if (useBurstDshot) {
 198         for (int i = 0; i < dmaMotorTimerCount; i++) {
 199             motorDmaTimer_t *burstDmaTimer = &dmaMotorTimers[i];
 200
 201             // Transfer CCR1 through CCR4 for each burst
 202             pwmBurstDMAStart(&burstDmaTimer->timHandle,
 203                     TIM_DMABASE_CCR1, TIM_DMA_UPDATE, TIM_DMABURSTLENGTH_4TRANSFERS,
 204                     (uint32_t*)burstDmaTimer->dmaBurstBuffer, burstDmaTimer->dmaBurstLength);
 205         }
 206     } else
 207 #endif
 208     {
 209         // XXX Empty for non-burst?
 210     }
 211 }
 212
 213 static void motor_DMA_IRQHandler(dmaChannelDescriptor_t* descriptor)
 214 {
 215     if (DMA_GET_FLAG_STATUS(descriptor, DMA_IT_TCIF)) {
 216
 217 #ifdef USE_DSHOT_DMAR
 218         if (useBurstDshot) {
 219             motorDmaTimer_t *burstDmaTimer = &dmaMotorTimers[descriptor->userParam];
 220
 221             HAL_TIM_DMABurst_WriteStop(&burstDmaTimer->timHandle, TIM_DMA_UPDATE);
 222             HAL_DMA_IRQHandler(&burstDmaTimer->hdma_tim);
 223         } else
 224 #endif
 225         {
 226             motorDmaOutput_t * const motor = &dmaMotors[descriptor->userParam];
 227
 228             pwmChannelDMAStop(&motor->TimHandle,motor->timerHardware->channel);
 229             HAL_DMA_IRQHandler(motor->TimHandle.hdma[motor->timerDmaIndex]);
 230         }
 231
 232         DMA_CLEAR_FLAG(descriptor, DMA_IT_TCIF);
 233     }
 234 }
 235
 236 bool pwmDshotMotorHardwareConfig(const timerHardware_t *timerHardware, uint8_t motorIndex, uint8_t reorderedMotorIndex, motorPwmProtocolTypes_e pwmProtocolType, uint8_t output)
 237 {
 238     dmaResource_t *dmaRef = NULL;
 239     uint32_t dmaChannel;
 240
 241 #ifdef USE_DMA_SPEC
 242     const dmaChannelSpec_t *dmaSpec = dmaGetChannelSpecByTimer(timerHardware);
 243
 244     if (dmaSpec) {
 245         dmaRef = dmaSpec->ref;
 246         dmaChannel = dmaSpec->channel;
 247     }
 248 #else
 249     dmaRef = timerHardware->dmaRef;
 250     dmaChannel = timerHardware->dmaChannel;
 251 #endif
 252
 253 #ifdef USE_DSHOT_DMAR
 254     if (useBurstDshot) {
 255 #ifdef USE_DMA_SPEC
 256         uint8_t timnum = timerGetTIMNumber(timerHardware->tim);
 257         dmaoptValue_t dmaopt = timerUpConfig(timnum - 1)->dmaopt;
 258         const dmaChannelSpec_t *dmaChannelSpec = dmaGetChannelSpecByPeripheral(DMA_PERIPH_TIMUP, timnum - 1, dmaopt);
 259         dmaRef = dmaChannelSpec->ref;
 260         dmaChannel = dmaChannelSpec->channel;
 261 #else
 262         dmaRef = timerHardware->dmaTimUPRef;
 263         dmaChannel = timerHardware->dmaTimUPChannel;
 264 #endif
 265     }
 266 #endif
 267
 268     if (dmaRef == NULL) {
 269         return false;
 270     }
 271
 272     motorDmaOutput_t * const motor = &dmaMotors[motorIndex];
 273     motor->timerHardware = timerHardware;
 274
 275     TIM_TypeDef *timer = timerHardware->tim; // "timer" is confusing; "tim"?
 276     const IO_t motorIO = IOGetByTag(timerHardware->tag);
 277     uint8_t pupMode = (output & TIMER_OUTPUT_INVERTED) ? GPIO_PULLDOWN : GPIO_PULLUP;
 278 #ifdef USE_DSHOT_TELEMETRY
 279     if (useDshotTelemetry) {
 280         output ^= TIMER_OUTPUT_INVERTED;
 281     }
 282 #endif
 283
 284     motor->iocfg = IO_CONFIG(GPIO_MODE_AF_PP, GPIO_SPEED_FREQ_VERY_HIGH, pupMode);
 285     const uint8_t timerIndex = getTimerIndex(timer);
 286     const bool configureTimer = (timerIndex == dmaMotorTimerCount - 1);
 287
 288     IOInit(motorIO, OWNER_MOTOR, RESOURCE_INDEX(reorderedMotorIndex));
 289     IOConfigGPIOAF(motorIO, motor->iocfg, timerHardware->alternateFunction);
 290
 291     // Configure time base
 292
 293     if (configureTimer) {
 294         RCC_ClockCmd(timerRCC(timer), ENABLE);
 295
 296         motor->TimHandle.Instance = timerHardware->tim; // timer
 297         motor->TimHandle.Init.Prescaler = (uint16_t)(lrintf((float) timerClock(timer) / getDshotHz(pwmProtocolType) + 0.01f) - 1);
 298         motor->TimHandle.Init.Period = pwmProtocolType == PWM_TYPE_PROSHOT1000 ? MOTOR_NIBBLE_LENGTH_PROSHOT : MOTOR_BITLENGTH;
 299         motor->TimHandle.Init.RepetitionCounter = 0;
 300         motor->TimHandle.Init.ClockDivision = TIM_CLOCKDIVISION_DIV1;
 301         motor->TimHandle.Init.CounterMode = TIM_COUNTERMODE_UP;
 302         motor->TimHandle.Init.AutoReloadPreload = TIM_AUTORELOAD_PRELOAD_DISABLE;
 303
 304         result = HAL_TIM_PWM_Init(&motor->TimHandle);
 305
 306         if (result != HAL_OK) {
 307             /* Initialization Error */
 308             return false;
 309         }
 310     }
 311
 312 /*
 313 From LL version
 314 chan oinv IDLE NIDLE POL  NPOL
 315 N    I    -    Low   -    Low
 316 N    -    -    Low   -    High
 317 P    I    High -     Low  -
 318 P    -    High -     High -
 319 */
 320
 321     /* PWM mode 1 configuration */
 322
 323     TIM_OC_InitTypeDef TIM_OCInitStructure;
 324     TIM_OCInitStructure.OCMode = TIM_OCMODE_PWM1;
 325
 326     if (output & TIMER_OUTPUT_N_CHANNEL) {
 327         TIM_OCInitStructure.OCIdleState = TIM_OCIDLESTATE_RESET;
 328         TIM_OCInitStructure.OCPolarity = (output & TIMER_OUTPUT_INVERTED) ? TIM_OCPOLARITY_HIGH : TIM_OCPOLARITY_LOW;
 329         TIM_OCInitStructure.OCNIdleState = TIM_OCNIDLESTATE_RESET;
 330         TIM_OCInitStructure.OCNPolarity = (output & TIMER_OUTPUT_INVERTED) ? TIM_OCNPOLARITY_HIGH : TIM_OCNPOLARITY_LOW;
 331     } else {
 332         TIM_OCInitStructure.OCIdleState = TIM_OCIDLESTATE_SET;
 333         TIM_OCInitStructure.OCPolarity = (output & TIMER_OUTPUT_INVERTED) ? TIM_OCPOLARITY_LOW : TIM_OCPOLARITY_HIGH;
 334         TIM_OCInitStructure.OCNIdleState = TIM_OCNIDLESTATE_SET;
 335         TIM_OCInitStructure.OCNPolarity = (output & TIMER_OUTPUT_INVERTED) ? TIM_OCNPOLARITY_LOW : TIM_OCNPOLARITY_HIGH;
 336     }
 337     TIM_OCInitStructure.OCFastMode = TIM_OCFAST_DISABLE;
 338     TIM_OCInitStructure.Pulse = 0;
 339
 340     result = HAL_TIM_PWM_ConfigChannel(&motor->TimHandle, &TIM_OCInitStructure, motor->timerHardware->channel);
 341
 342     if (result != HAL_OK) {
 343         /* Configuration Error */
 344         return false;
 345     }
 346
 347     // DMA setup
 348
 349     motor->timer = &dmaMotorTimers[timerIndex];
 350
 351 #ifdef USE_DSHOT_DMAR
 352     if (useBurstDshot) {
 353         motor->timer->dmaBurstRef = dmaRef;
 354
 355         if (!configureTimer) {
 356             motor->configured = true;
 357             return false;
 358         }
 359     } else
 360 #endif
 361     {
 362         motor->timerDmaSource = timerDmaSource(timerHardware->channel);
 363         motor->timer->timerDmaSources |= motor->timerDmaSource;
 364         motor->timerDmaIndex = timerDmaIndex(timerHardware->channel);
 365     }
 366
 367     dmaIdentifier_e identifier = dmaGetIdentifier(dmaRef);
 368
 369 #ifdef USE_DSHOT_DMAR
 370     if (useBurstDshot) {
 371         dmaInit(identifier, OWNER_TIMUP, timerGetTIMNumber(timerHardware->tim));
 372         dmaSetHandler(identifier, motor_DMA_IRQHandler, NVIC_PRIO_DSHOT_DMA, timerIndex);
 373     } else
 374 #endif
 375     {
 376         dmaInit(identifier, OWNER_MOTOR, RESOURCE_INDEX(reorderedMotorIndex));
 377         dmaSetHandler(identifier, motor_DMA_IRQHandler, NVIC_PRIO_DSHOT_DMA, motorIndex);
 378     }
 379
 380 #ifdef USE_DSHOT_DMAR
 381     if (useBurstDshot) {
 382         motor->timer->hdma_tim.Init.Direction = DMA_MEMORY_TO_PERIPH;
 383         motor->timer->hdma_tim.Init.PeriphInc = DMA_PINC_DISABLE;
 384         motor->timer->hdma_tim.Init.MemInc = DMA_MINC_ENABLE;
 385         motor->timer->hdma_tim.Init.PeriphDataAlignment = DMA_PDATAALIGN_WORD ;
 386         motor->timer->hdma_tim.Init.MemDataAlignment = DMA_MDATAALIGN_WORD ;
 387         motor->timer->hdma_tim.Init.Mode = DMA_NORMAL;
 388         motor->timer->hdma_tim.Init.Priority = DMA_PRIORITY_HIGH;
 389 #if !defined(STM32G4)
 390         motor->timer->hdma_tim.Init.FIFOMode = DMA_FIFOMODE_DISABLE;
 391         motor->timer->hdma_tim.Init.PeriphBurst = DMA_PBURST_SINGLE;
 392         motor->timer->hdma_tim.Init.MemBurst = DMA_MBURST_SINGLE;
 393         motor->timer->hdma_tim.Init.FIFOThreshold = DMA_FIFO_THRESHOLD_FULL;
 394 #endif
 395
 396         motor->timer->dmaBurstBuffer = &dshotBurstDmaBuffer[timerIndex][0];
 397         motor->timer->timHandle = motor->TimHandle;
 398         memset(motor->timer->dmaBurstBuffer, 0, DSHOT_DMA_BUFFER_SIZE * 4 * sizeof(uint32_t));
 399
 400         /* Set hdma_tim instance */
 401         motor->timer->hdma_tim.Instance = (DMA_ARCH_TYPE *)dmaRef;
 402         motor->timer->hdma_tim.Init.Request = dmaChannel;
 403
 404         /* Link hdma_tim to hdma[TIM_DMA_ID_UPDATE] (update) */
 405         __HAL_LINKDMA(&motor->timer->timHandle, hdma[TIM_DMA_ID_UPDATE], motor->timer->hdma_tim);
 406
 407         /* Initialize TIMx DMA handle */
 408         result = HAL_DMA_Init(motor->timer->timHandle.hdma[TIM_DMA_ID_UPDATE]);
 409
 410     } else
 411 #endif
 412     {
 413         motor->hdma_tim.Init.Direction = DMA_MEMORY_TO_PERIPH;
 414         motor->hdma_tim.Init.PeriphInc = DMA_PINC_DISABLE;
 415         motor->hdma_tim.Init.MemInc = DMA_MINC_ENABLE;
 416         motor->hdma_tim.Init.PeriphDataAlignment = DMA_PDATAALIGN_WORD ;
 417         motor->hdma_tim.Init.MemDataAlignment = DMA_MDATAALIGN_WORD ;
 418         motor->hdma_tim.Init.Mode = DMA_NORMAL;
 419         motor->hdma_tim.Init.Priority = DMA_PRIORITY_HIGH;
 420 #if !defined(STM32G4)
 421         motor->hdma_tim.Init.FIFOMode = DMA_FIFOMODE_DISABLE;
 422         motor->hdma_tim.Init.PeriphBurst = DMA_PBURST_SINGLE;
 423         motor->hdma_tim.Init.MemBurst = DMA_MBURST_SINGLE;
 424         motor->hdma_tim.Init.FIFOThreshold = DMA_FIFO_THRESHOLD_FULL;
 425 #endif
 426
 427         motor->dmaBuffer = &dshotDmaBuffer[motorIndex][0];
 428         motor->dmaBuffer[DSHOT_DMA_BUFFER_SIZE-2] = 0; // XXX Is this necessary? -> probably.
 429         motor->dmaBuffer[DSHOT_DMA_BUFFER_SIZE-1] = 0; // XXX Is this necessary?
 430
 431         motor->hdma_tim.Instance = (DMA_ARCH_TYPE *)dmaRef;
 432         motor->hdma_tim.Init.Request = dmaChannel;
 433
 434         /* Link hdma_tim to hdma[x] (channelx) */
 435         __HAL_LINKDMA(&motor->TimHandle, hdma[motor->timerDmaIndex], motor->hdma_tim);
 436
 437         /* Initialize TIMx DMA handle */
 438         result = HAL_DMA_Init(motor->TimHandle.hdma[motor->timerDmaIndex]);
 439
 440     }
 441
 442     if (result != HAL_OK) {
 443         /* Initialization Error */
 444         return false;
 445     }
 446
 447     // Start the timer channel now.
 448     // Enabling/disabling DMA request can restart a new cycle without PWM start/stop.
 449
 450     if (motor->timerHardware->output & TIMER_OUTPUT_N_CHANNEL) {
 451         result = HAL_TIMEx_PWMN_Start(&motor->TimHandle, motor->timerHardware->channel);
 452     } else {
 453         result = HAL_TIM_PWM_Start(&motor->TimHandle, motor->timerHardware->channel);
 454     }
 455
 456     if (result != HAL_OK) {
 457         /* Starting PWM generation Error */
 458         return false;
 459     }
 460
 461     motor->configured = true;
 462
 463     return true;
 464 }
 465 #endif