AdcManager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __ADCMANAGER_H__
#define __ADCMANAGER_H__

#include <stdint.h>
#include "IirFilter.h"

namespace ClearCore {

class AdcManager {
public:
    typedef enum {
        ADC_VSUPPLY_MON = 0, 
        ADC_AIN12,           
        ADC_5VOB_MON,        
        ADC_AIN11,           
        ADC_AIN10,           
        ADC_AIN09,           
        ADC_SDRVR3_IMON,     
        ADC_SDRVR2_IMON,     
        ADC_CHANNEL_COUNT // Keep at end
    } AdcChannels;

    typedef enum {
        FILTER_UNIT_RAW,
        FILTER_UNIT_MS,
        FILTER_UNIT_SAMPLES,
    } FilterUnits;

    static const uint8_t ADC_RESOLUTION_DEFAULT = 12;
    static const uint8_t ADC_TIMEOUT_DEFAULT = 3;
    static const uint32_t ADC_IIR_FILTER_TC_MS = 2;

#ifndef HIDE_FROM_DOXYGEN
    // Max voltage that a channel can read.
    // This will probably need a scale rework once populated
    // Calculated by multiplying the ratio by the ADC supply which is
    // 3.3v
    static constexpr float ADC_CHANNEL_MAX_FLOAT[ADC_CHANNEL_COUNT] = {
        80.85,      // ADC_VSUPPLY_MON
        10.0,       // ADC_AIN12
        6.6,        // ADC_5VOB_MON
        10.0,       // ADC_AIN11
        10.0,       // ADC_AIN10
        10.0,       // ADC_AIN09
        10.0,       // ADC_SDRVR3_IMON
        10.0        // ADC_SDRVR2_IMON
    };

    void Initialize();

    void Update();
#endif

    bool AdcResolution(uint8_t resolution);

    volatile const uint8_t &AdcResolution() {
        return m_AdcResolution;
    }

    volatile const uint16_t &FilteredResult(AdcChannels adcChannel) {
        return m_AdcResultsConvertedFiltered[adcChannel];
    }

    volatile const uint16_t &ConvertedResult(AdcChannels adcChannel) {
        return m_AdcResultsConverted[adcChannel];
    }

    bool FilterTc(AdcChannels adcChannel, uint16_t tc, FilterUnits theUnits);

    uint16_t FilterTc(AdcChannels adcChannel, FilterUnits theUnits);

    bool FilterReset(AdcChannels adcChannel, uint16_t newSetting) {
        if (adcChannel >= ADC_CHANNEL_COUNT) {
            return false;
        }
        m_analogFilter[adcChannel].Reset(newSetting);
        m_AdcResultsConvertedFiltered[adcChannel] =
            m_analogFilter[adcChannel].LastOutput();
        return true;
    }

    void AdcTimeoutLimit(uint8_t timeout) {
        m_AdcTimeoutLimit = timeout;
    }

    volatile const bool &AdcTimeout() {
        return m_AdcTimeout;
    }

    float AnalogVoltage(AdcChannels adcChannel) {
        uint16_t maxReading = INT16_MAX & ~(INT16_MAX >> m_AdcResolution);
        float voltage = ADC_CHANNEL_MAX_FLOAT[adcChannel] *
                        m_AdcResultsConvertedFiltered[adcChannel] / maxReading;
        return voltage;
    }

#ifndef HIDE_FROM_DOXYGEN

    static AdcManager &Instance();

    volatile const uint32_t &ShiftRegSnapshot() {
        return m_shiftRegSnapshot;
    }
#endif
private:

    static constexpr float ADC_INITIAL_FILTER_VALUE_V[ADC_CHANNEL_COUNT] = {
        24.0, // ADC_VSUPPLY_MON
        0.0,  // ADC_AIN12
        5.0,  // ADC_5VOB_MON
        0.0,  // ADC_AIN11
        0.0,  // ADC_AIN10
        0.0,  // ADC_AIN09
        0.0,  // ADC_SDRVR3_IMON
        0.0,  // ADC_SDRVR2_IMON
    };

    // ADC state holders in Q15. ADC logic has already been performed
    volatile uint16_t m_AdcResultsConverted[ADC_CHANNEL_COUNT] = {0};
    volatile uint16_t m_AdcResultsConvertedFiltered[ADC_CHANNEL_COUNT] = {0};
    Iir16 m_analogFilter[ADC_CHANNEL_COUNT];

    bool m_initialized;

    bool m_AdcTimeout;
    uint32_t m_shiftRegSnapshot;
    uint32_t m_shiftRegPending;

    uint8_t m_AdcResolution;
    uint8_t m_AdcResPending;

    uint8_t m_AdcTimeoutLimit;

    uint32_t m_AdcBusyCount;

    AdcManager();

    void DmaInit();
    void DmaUpdate();

    bool AdcResChange();

}; // AdcManager

} // ClearCore namespace

#endif // __ADCMANAGER_H__