/*----------------------------------------------------------------------------*/ /* Copyright (c) 2016-2017 FIRST. All Rights Reserved. */ /* Open Source Software - may be modified and shared by FRC teams. The code */ /* must be accompanied by the FIRST BSD license file in the root directory of */ /* the project. */ /*----------------------------------------------------------------------------*/ #include "HAL/PWM.h" #include "ConstantsInternal.h" #include "DigitalInternal.h" #include "HAL/handles/HandlesInternal.h" #include "MockData/PWMDataInternal.h" #include "PortsInternal.h" using namespace hal; extern "C" { HAL_DigitalHandle HAL_InitializePWMPort(HAL_PortHandle portHandle, int32_t* status) { if (*status != 0) return HAL_kInvalidHandle; int16_t channel = getPortHandleChannel(portHandle); if (channel == InvalidHandleIndex) { *status = PARAMETER_OUT_OF_RANGE; return HAL_kInvalidHandle; } uint8_t origChannel = static_cast(channel); if (origChannel < kNumPWMHeaders) { channel += kNumDigitalChannels; // remap Headers to end of allocations } else { channel = remapMXPPWMChannel(channel) + 10; // remap MXP to proper channel } auto handle = digitalChannelHandles.Allocate(channel, HAL_HandleEnum::PWM, status); if (*status != 0) return HAL_kInvalidHandle; // failed to allocate. Pass error back. auto port = digitalChannelHandles.Get(handle, HAL_HandleEnum::PWM); if (port == nullptr) { // would only occur on thread issue. *status = HAL_HANDLE_ERROR; return HAL_kInvalidHandle; } port->channel = origChannel; SimPWMData[origChannel].SetInitialized(true); return handle; } void HAL_FreePWMPort(HAL_DigitalHandle pwmPortHandle, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } SimPWMData[port->channel].SetInitialized(false); digitalChannelHandles.Free(pwmPortHandle, HAL_HandleEnum::PWM); } HAL_Bool HAL_CheckPWMChannel(int32_t channel) { return channel < kNumPWMChannels && channel >= 0; } void HAL_SetPWMConfig(HAL_DigitalHandle pwmPortHandle, double max, double deadbandMax, double center, double deadbandMin, double min, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } // calculate the loop time in milliseconds double loopTime = HAL_GetPWMLoopTiming(status) / (kSystemClockTicksPerMicrosecond * 1e3); if (*status != 0) return; int32_t maxPwm = static_cast((max - kDefaultPwmCenter) / loopTime + kDefaultPwmStepsDown - 1); int32_t deadbandMaxPwm = static_cast( (deadbandMax - kDefaultPwmCenter) / loopTime + kDefaultPwmStepsDown - 1); int32_t centerPwm = static_cast( (center - kDefaultPwmCenter) / loopTime + kDefaultPwmStepsDown - 1); int32_t deadbandMinPwm = static_cast( (deadbandMin - kDefaultPwmCenter) / loopTime + kDefaultPwmStepsDown - 1); int32_t minPwm = static_cast((min - kDefaultPwmCenter) / loopTime + kDefaultPwmStepsDown - 1); port->maxPwm = maxPwm; port->deadbandMaxPwm = deadbandMaxPwm; port->deadbandMinPwm = deadbandMinPwm; port->centerPwm = centerPwm; port->minPwm = minPwm; port->configSet = true; } void HAL_SetPWMConfigRaw(HAL_DigitalHandle pwmPortHandle, int32_t maxPwm, int32_t deadbandMaxPwm, int32_t centerPwm, int32_t deadbandMinPwm, int32_t minPwm, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } port->maxPwm = maxPwm; port->deadbandMaxPwm = deadbandMaxPwm; port->deadbandMinPwm = deadbandMinPwm; port->centerPwm = centerPwm; port->minPwm = minPwm; } void HAL_GetPWMConfigRaw(HAL_DigitalHandle pwmPortHandle, int32_t* maxPwm, int32_t* deadbandMaxPwm, int32_t* centerPwm, int32_t* deadbandMinPwm, int32_t* minPwm, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } *maxPwm = port->maxPwm; *deadbandMaxPwm = port->deadbandMaxPwm; *deadbandMinPwm = port->deadbandMinPwm; *centerPwm = port->centerPwm; *minPwm = port->minPwm; } void HAL_SetPWMEliminateDeadband(HAL_DigitalHandle pwmPortHandle, HAL_Bool eliminateDeadband, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } port->eliminateDeadband = eliminateDeadband; } HAL_Bool HAL_GetPWMEliminateDeadband(HAL_DigitalHandle pwmPortHandle, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return false; } return port->eliminateDeadband; } /** * Set a PWM channel to the desired value. The values range from 0 to 255 and * the period is controlled * by the PWM Period and MinHigh registers. * * @param channel The PWM channel to set. * @param value The PWM value to set. */ void HAL_SetPWMRaw(HAL_DigitalHandle pwmPortHandle, int32_t value, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } SimPWMData[port->channel].SetRawValue(value); } /** * Set a PWM channel to the desired scaled value. The values range from -1 to 1 * and * the period is controlled * by the PWM Period and MinHigh registers. * * @param channel The PWM channel to set. * @param value The scaled PWM value to set. */ void HAL_SetPWMSpeed(HAL_DigitalHandle pwmPortHandle, double speed, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } if (!port->configSet) { *status = INCOMPATIBLE_STATE; return; } if (speed < -1.0) { speed = -1.0; } else if (speed > 1.0) { speed = 1.0; } SimPWMData[port->channel].SetSpeed(speed); } /** * Set a PWM channel to the desired position value. The values range from 0 to 1 * and * the period is controlled * by the PWM Period and MinHigh registers. * * @param channel The PWM channel to set. * @param value The scaled PWM value to set. */ void HAL_SetPWMPosition(HAL_DigitalHandle pwmPortHandle, double pos, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } if (!port->configSet) { *status = INCOMPATIBLE_STATE; return; } if (pos < 0.0) { pos = 0.0; } else if (pos > 1.0) { pos = 1.0; } SimPWMData[port->channel].SetPosition(pos); } void HAL_SetPWMDisabled(HAL_DigitalHandle pwmPortHandle, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } SimPWMData[port->channel].SetRawValue(0); SimPWMData[port->channel].SetPosition(0); SimPWMData[port->channel].SetSpeed(0); } /** * Get a value from a PWM channel. The values range from 0 to 255. * * @param channel The PWM channel to read from. * @return The raw PWM value. */ int32_t HAL_GetPWMRaw(HAL_DigitalHandle pwmPortHandle, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return 0; } return SimPWMData[port->channel].GetRawValue(); } /** * Get a scaled value from a PWM channel. The values range from -1 to 1. * * @param channel The PWM channel to read from. * @return The scaled PWM value. */ double HAL_GetPWMSpeed(HAL_DigitalHandle pwmPortHandle, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return 0; } if (!port->configSet) { *status = INCOMPATIBLE_STATE; return 0; } double speed = SimPWMData[port->channel].GetSpeed(); if (speed > 1) speed = 1; if (speed < -1) speed = -1; return speed; } /** * Get a position value from a PWM channel. The values range from 0 to 1. * * @param channel The PWM channel to read from. * @return The scaled PWM value. */ double HAL_GetPWMPosition(HAL_DigitalHandle pwmPortHandle, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return 0; } if (!port->configSet) { *status = INCOMPATIBLE_STATE; return 0; } double position = SimPWMData[port->channel].GetPosition(); if (position > 1) position = 1; if (position < 0) position = 0; return position; } void HAL_LatchPWMZero(HAL_DigitalHandle pwmPortHandle, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } SimPWMData[port->channel].SetZeroLatch(true); SimPWMData[port->channel].SetZeroLatch(false); } /** * Set how how often the PWM signal is squelched, thus scaling the period. * * @param channel The PWM channel to configure. * @param squelchMask The 2-bit mask of outputs to squelch. */ void HAL_SetPWMPeriodScale(HAL_DigitalHandle pwmPortHandle, int32_t squelchMask, int32_t* status) { auto port = digitalChannelHandles.Get(pwmPortHandle, HAL_HandleEnum::PWM); if (port == nullptr) { *status = HAL_HANDLE_ERROR; return; } SimPWMData[port->channel].SetPeriodScale(squelchMask); } /** * Get the loop timing of the PWM system * * @return The loop time */ int32_t HAL_GetPWMLoopTiming(int32_t* status) { return kExpectedLoopTiming; } /** * Get the pwm starting cycle time * * @return The pwm cycle start time. */ uint64_t HAL_GetPWMCycleStartTime(int32_t* status) { return 0; } } // extern "C"