tle94112.hpp

Go to the documentation of this file.

 
#ifndef TLE94112_HPP_
#define TLE94112_HPP_
 
#include <stdint.h>
#include <stdlib.h>
#include "timer.hpp"
#include "gpio.hpp"
#include "spic.hpp"
 
using namespace tle94112;
 
#define TLE94112_NUM_HB             13
 
#define TLE94112_NUM_PWM            4
 
#define TLE94112_NUM_CTRL_REGS      12
 
#define TLE94112_NUM_STATUS_REGS    7
 
class Tle94112
{
    public:
        enum HalfBridge
        {
            TLE_NOHB = 0, TLE_HB1, TLE_HB2, TLE_HB3, TLE_HB4, TLE_HB5, TLE_HB6,
            TLE_HB7, TLE_HB8, TLE_HB9, TLE_HB10, TLE_HB11, TLE_HB12
        };
 
        enum PWMChannel
        {
            TLE_NOPWM = 0, TLE_PWM1, TLE_PWM2, TLE_PWM3
        };
 
        enum HBState
        {
            TLE_FLOATING = 0b00, TLE_LOW = 0b01, TLE_HIGH = 0b10
        };
 
        enum HBOCState
        {
            TLE_NONE = 0b00, TLE_LOWSIDE = 0b01, TLE_HIGHSIDE = 0b10
        };
 
        enum PWMFreq
        {
            TLE_FREQOFF = 0b00, TLE_FREQ80HZ, TLE_FREQ100HZ, TLE_FREQ200HZ
        };
 
        enum DiagFlag
        {
            TLE_SPI_ERROR = 0x80,
            TLE_LOAD_ERROR = 0x40,
            TLE_UNDER_VOLTAGE = 0x20,
            TLE_OVER_VOLTAGE = 0x10,
            TLE_POWER_ON_RESET = 0x08,
            TLE_TEMP_SHUTDOWN = 0x04,
            TLE_TEMP_WARNING = 0x02
        };
 
        static const uint8_t TLE_STATUS_OK = 0U;
 
        Tle94112();
 
        Tle94112(SPIC * sBus, GPIOC * cs, GPIOC * en, Timer * timer);
 
        ~Tle94112();
 
        void begin(void);
 
        void end(void);
 
        void configHB(HalfBridge hb, HBState state, PWMChannel pwm);
 
        void configHB(HalfBridge hb, HBState state, PWMChannel pwm, uint8_t activeFW);
 
        void configPWM(PWMChannel pwm, PWMFreq freq, uint8_t dutyCycle);
 
        uint8_t setLedMode(HalfBridge hb, uint8_t active);
 
        uint8_t getSysDiagnosis();
 
        uint8_t getSysDiagnosis(DiagFlag mask);
 
        uint8_t getSysDiagnosis(uint8_t mask);
 
        uint8_t getHBOverCurrent(HalfBridge hb);
 
        uint8_t getHBOpenLoad(HalfBridge hb);
 
        void clearErrors();
 
        void directWriteReg(uint8_t reg, uint8_t data);
 
        uint8_t readStatusReg(uint8_t reg);
 
        SPIC     *sBus;      //<! \brief SPI cover class as representation of the SPI bus
        GPIOC    *cs;        //<! \brief shield enable GPIO to switch chipselect on/off
        GPIOC    *en;        //<! \brief shield enable GPIO to switch shield on/off
        Timer    *timer;     //<! \brief timer for delay settings
 
    protected:
 
        enum CtrlRegisters
        {
            HB_ACT_1_CTRL = 0,
            HB_ACT_2_CTRL,
            HB_ACT_3_CTRL,
            HB_MODE_1_CTRL,
            HB_MODE_2_CTRL,
            HB_MODE_3_CTRL,
            PWM_CH_FREQ_CTRL,
            PWM1_DC_CTRL,
            PWM2_DC_CTRL,
            PWM3_DC_CTRL,
            FW_OL_CTRL,
            FW_CTRL
        };
 
        enum StatusRegisters
        {
            SYS_DIAG1 = 0,
            OP_ERROR_1_STAT,
            OP_ERROR_2_STAT,
            OP_ERROR_3_STAT,
            OP_ERROR_4_STAT,
            OP_ERROR_5_STAT,
            OP_ERROR_6_STAT
        };
 
        typedef struct
        {
            uint8_t stateReg;
            uint8_t stateMask;
            uint8_t stateShift;
            uint8_t pwmReg;
            uint8_t pwmMask;
            uint8_t pwmShift;
            uint8_t fwReg;
            uint8_t fwMask;
            uint8_t fwShift;
            uint8_t ocReg;
            uint8_t ocMask;
            uint8_t ocShift;
            uint8_t olReg;
            uint8_t olMask;
            uint8_t olShift;
        } HalfBridge_t;
 
        typedef struct
        {
            uint8_t freqReg;
            uint8_t freqMask;
            uint8_t freqShift;
            uint8_t dcReg;
            uint8_t dcMask;
            uint8_t dcShift;
        } PWMchannel_t;
 
 
        HalfBridge_t mHalfBridges[TLE94112_NUM_HB];
        PWMchannel_t mPwmChannels[TLE94112_NUM_PWM];
        uint8_t mCtrlRegAddresses[TLE94112_NUM_CTRL_REGS];
        uint8_t mCtrlRegData[TLE94112_NUM_CTRL_REGS];
        uint8_t mStatusRegAddresses[TLE94112_NUM_STATUS_REGS];
 
        void init(void);
 
        void _configHB(uint8_t hb, uint8_t state, uint8_t pwm, uint8_t activeFW);
 
        void _configPWM(uint8_t pwm, uint8_t freq, uint8_t dutyCycle);
 
        uint8_t _getHBOverCurrent(uint8_t hb);
 
        uint8_t _getHBOpenLoad(uint8_t hb);
 
        void writeReg(uint8_t reg, uint8_t mask, uint8_t shift, uint8_t data);
 
        uint8_t readStatusReg(uint8_t reg, uint8_t mask, uint8_t shift);
 
        void clearStatusReg(uint8_t reg);
 
        uint8_t mEnabled;    //<! \brief indicates if TLE94112LE is enabled
 
};
 
#endif