AFE_NXP.h

Go to the documentation of this file.

 
#ifndef ARDUINO_AFE_DRIVER_H
#define ARDUINO_AFE_DRIVER_H
 
#include <Arduino.h>
#include <math.h>
#include <stdint.h>
#include <SPI_for_AFE.h>
 
class AFE_base : public SPI_for_AFE
{
public:

    using raw_t     = int32_t;
    using volt_t    = double;

    AFE_base( bool spi_addr, bool highspeed_variant, int nINT, int DRDY, int SYN, int nRESET, int DRDY_input, int SYNCDAC );

    virtual ~AFE_base();
    
    virtual void begin( void );

    virtual void boot( void )   = 0;

    virtual void reset( bool hardware_reset = false )   = 0;

    typedef void    (*callback_fp_t)( void );

    virtual void set_DRDY_callback( callback_fp_t fnc );

    virtual void open_logical_channel( int ch, uint16_t cc0, uint16_t cc1, uint16_t cc2, uint16_t cc3 ) = 0;

    virtual void open_logical_channel( int ch, const uint16_t (&cc)[ 4 ] )  = 0;

    virtual void close_logical_channel( int ch )        = 0;

    virtual void close_logical_channel( void )          = 0;

    virtual void enable_logical_channel( int ch )       = 0;

    virtual void start( int ch )                        = 0;

    virtual void start( void )                          = 0;

    virtual void start_continuous_conversion( void )    = 0;
 
    virtual void DRDY_by_sequencer_done( bool flag = true ) = 0;

    virtual raw_t   read( int ch )                          = 0;

    virtual void    read( raw_t *data_ptr )                 = 0;

    virtual void    read( volt_t *data_ptr )            = 0;

    virtual raw_t   start_and_read( int ch );
    
#ifdef  NON_TEMPLATE_VERSION_FOR_START_AND_READ

    virtual void    start_and_read( raw_t *data_ptr );
 
#else
    template<typename T>
    inline void start_and_read( T data )
    {
        double  wait_time   = cbf_DRDY ? -1.0 : total_delay * delay_accuracy;
        
        start();
        wait_conversion_complete( wait_time );
        
        read( data );
    };
#endif

    enum LV_mux_sel : uint8_t {
        REF2_REF2   = 0,
        GPIO0_GPIO1,
        REFCOARSE_REF2,
        VADD_REF2,
        VHDD_REF2,
        REF2_VHSS,
        HV_MUX,
    };

    inline double raw2uv( int ch, raw_t value )
    {
        return raw2v( ch, value ) * 1e6;
    }
    
    inline double raw2mv( int ch, raw_t value )
    {
        return raw2v( ch, value ) * 1e3;
    }
    
    virtual double raw2v( int ch, raw_t value ) = 0;
    
    inline double drdy_delay( int ch )
    {
        return ch_delay[ ch ];
    }

    inline double drdy_delay( void )
    {
        return total_delay;
    }

    inline int enabled_logical_channels( void )
    {
        return enabled_channels;
    }
    
    void    use_DRDY_trigger( bool use = true );
 
protected:
    bool    dev_add;
    bool    highspeed_variant;
    int     pin_nINT;
    int     pin_DRDY;
    int     pin_SYN;
    int     pin_nRESET;
    int     pin_DRDY_input;
    int     pin_SYNCDAC;
    

    int             bit_count( uint32_t value );

    int             enabled_channels;
    
    uint8_t         sequence_order[ 16 ];
    
    double          coeff_V[ 16 ];

    int             mux_setting[ 16 ];

    double          ch_delay[ 16 ];
    double          total_delay;
    static double   delay_accuracy;
    
    constexpr static uint32_t   timeout_limit   = 10000000;
 
    void                    default_drdy_cb();
    static void             static_default_drdy_cb();
    uint32_t                drdy_count;
    volatile bool           drdy_flag;
    static callback_fp_t    cbf_DRDY;
    static void             DRDY_cb();

    virtual void            init( void );

    int                     wait_conversion_complete( double delay = -1.0 );
 
public:
    static AFE_base*        instance;
};
 
class LogicalChannel_Base
{
public:
    LogicalChannel_Base() {}
    virtual ~LogicalChannel_Base() {}
    
    void    enable( void );
    void    disable( void );

    template<class T> T read(void);

    operator AFE_base::raw_t(void);
    operator AFE_base::volt_t(void);

    template<class T> double operator+( T v ) { return (double)(*this) + (double)v; }
    template<class T> double operator-( T v ) { return (double)(*this) - (double)v; }
    template<class T> double operator*( T v ) { return (double)(*this) * (double)v; }
    template<class T> double operator/( T v ) { return (double)(*this) / (double)v; }
    template<class T> friend double operator+( T v, LogicalChannel_Base lc ) { return (double)v + (double)lc; }
    template<class T> friend double operator-( T v, LogicalChannel_Base lc ) { return (double)v - (double)lc; }
    template<class T> friend double operator*( T v, LogicalChannel_Base lc ) { return (double)v * (double)lc; }
    template<class T> friend double operator/( T v, LogicalChannel_Base lc ) { return (double)v / (double)lc; }
    
    int         ch_number;
    AFE_base    *afe_ptr;
};
 
class NAFE13388_Base : public AFE_base
{
public:
    using   ch_setting_t    = uint16_t[ 4 ];
 
    typedef struct  _reference_point    {
        double  voltage;
        int32_t data;
    } reference_point;
 
    typedef struct  _ref_points {
        int             coeff_index;
        reference_point high;
        reference_point low;
        int             cal_index;
    } ref_points;
    
    NAFE13388_Base( bool spi_addr, bool highspeed_variant, int nINT, int DRDY, int SYN, int nRESET, int DRDY_input, int SYNCDAC );

    virtual ~NAFE13388_Base();
    
    virtual void boot( void );

    virtual void reset( bool hardware_reset = false );
    
    virtual void open_logical_channel( int ch, uint16_t cc0, uint16_t cc1, uint16_t cc2, uint16_t cc3 );

    virtual void open_logical_channel( int ch, const uint16_t (&cc)[ 4 ] );
 
    class LogicalChannel : public LogicalChannel_Base
    {
    public:
        LogicalChannel();
        virtual ~LogicalChannel();
        
        void    configure( const uint16_t (&cc)[ 4 ] );

        void    configure( uint16_t cc0 = 0x0000, uint16_t cc1 = 0x0000, uint16_t cc2 = 0x0000, uint16_t cc3 = 0x0000 );
    };
    
    LogicalChannel  logical_channel[ 16 ];
 
    private:    
    double  calc_delay( int ch );
    void    channel_info_update( uint16_t value );
 
public:
    virtual void close_logical_channel( int ch );

    virtual void close_logical_channel( void );

    void    enable_logical_channel( int ch );

    virtual void start( int ch );

    virtual void start( void );

    virtual void start_continuous_conversion();
 
    virtual void DRDY_by_sequencer_done( bool flag = true );
    
    virtual raw_t   read( int ch );

    virtual void    read( raw_t *data );

    virtual void    read( volt_t *data );

    inline double raw2v( int ch, raw_t value )
    {
        double  v   = value * coeff_V[ ch ];
 
        if ( HV_MUX != mux_setting[ ch ] )
        {
            switch ( mux_setting[ ch ] )
            {
                case REF2_REF2:
                case GPIO0_GPIO1:
                    return v;
                    break;
                case REFCOARSE_REF2:
                case VADD_REF2:
                    return 2.00 * (v + 1.50);
                    break;
                case VHDD_REF2:
                    return 32.00 * (v + 0.25);
                    break;
                case REF2_VHSS:
                    return -32.00 * (v - 0.25);
                    break;
            }
        }       
        return v;
    }
 
    
//  constexpr static double pga_gain[]  = { 0.2, 0.4, 0.8, 1, 2, 4, 8, 16 };
    static double   pga_gain[];
 
    enum GainPGA : uint8_t {
        G_PGA_x_0_2 = 0,
        G_PGA_x_0_4,
        G_PGA_x_0_8,
        G_PGA_x_1_0,
        G_PGA_x_2_0,
        G_PGA_x_4_0,
        G_PGA_x_8_0,
        G_PGA_x16_0,
    };
    
    enum class Register16 : uint16_t {
        CH_CONFIG0              = 0x20,
        CH_CONFIG1              = 0x21,
        CH_CONFIG2              = 0x22,
        CH_CONFIG3              = 0x23,
        CH_CONFIG4              = 0x24,
        CRC_CONF_REGS           = 0x25,
        CRC_COEF_REGS           = 0x26,
        CRC_TRIM_REGS           = 0x27,
        GPI_DATA                = 0x29,
        GPIO_CONFIG0            = 0x2A,
        GPIO_CONFIG1            = 0x2B,
        GPIO_CONFIG2            = 0x2C,
        GPI_EDGE_POS            = 0x2D,
        GPI_EDGE_NEG            = 0x2E,
        GPO_DATA                = 0x2F,
        SYS_CONFIG0             = 0x30,
        SYS_STATUS0             = 0x31,
        GLOBAL_ALARM_ENABLE     = 0x32,
        GLOBAL_ALARM_INTERRUPT  = 0x33,
        DIE_TEMP                = 0x34,
        CH_STATUS0              = 0x35,
        CH_STATUS1              = 0x36,
        THRS_TEMP               = 0x37,
        PN2                     = 0x7C,
        PN1                     = 0x7D,
        PN0                     = 0x7E,
        CRC_TRIM_INT            = 0x7F,
    };
 
    enum class Register24 : uint16_t {
        CH_DATA0        = 0x40,
        CH_DATA1        = 0x41,
        CH_DATA2        = 0x42,
        CH_DATA3        = 0x43,
        CH_DATA4        = 0x44,
        CH_DATA5        = 0x45,
        CH_DATA6        = 0x46,
        CH_DATA7        = 0x47,
        CH_DATA8        = 0x48,
        CH_DATA9        = 0x4A,
        CH_DATA10       = 0x4B,
        CH_DATA11       = 0x4C,
        CH_DATA13       = 0x4D,
        CH_DATA14       = 0x4E,
        CH_DATA15       = 0x4F,
        CH_CONFIG5_0    = 0x50,
        CH_CONFIG5_1    = 0x51,
        CH_CONFIG5_2    = 0x52,
        CH_CONFIG5_3    = 0x53,
        CH_CONFIG5_4    = 0x54,
        CH_CONFIG5_5    = 0x55,
        CH_CONFIG5_6    = 0x56,
        CH_CONFIG5_7    = 0x57,
        CH_CONFIG5_8    = 0x58,
        CH_CONFIG5_9    = 0x59,
        CH_CONFIG5_10   = 0x5A,
        CH_CONFIG5_11   = 0x5B,
        CH_CONFIG5_12   = 0x5C,
        CH_CONFIG5_13   = 0x5D,
        CH_CONFIG5_14   = 0x5E,
        CH_CONFIG5_15   = 0x5F,
        CH_CONFIG6_0    = 0x60,
        CH_CONFIG6_1    = 0x61,
        CH_CONFIG6_2    = 0x62,
        CH_CONFIG6_3    = 0x63,
        CH_CONFIG6_4    = 0x64,
        CH_CONFIG6_5    = 0x65,
        CH_CONFIG6_6    = 0x66,
        CH_CONFIG6_7    = 0x67,
        CH_CONFIG6_8    = 0x68,
        CH_CONFIG6_9    = 0x69,
        CH_CONFIG6_10   = 0x6A,
        CH_CONFIG6_11   = 0x6B,
        CH_CONFIG6_12   = 0x6C,
        CH_CONFIG6_13   = 0x6D,
        CH_CONFIG6_14   = 0x6E,
        CH_CONFIG6_15   = 0x6F,
        GAIN_COEFF0     = 0x80,
        GAIN_COEFF1     = 0x81,
        GAIN_COEFF2     = 0x82,
        GAIN_COEFF3     = 0x83,
        GAIN_COEFF4     = 0x84,
        GAIN_COEFF5     = 0x85,
        GAIN_COEFF6     = 0x86,
        GAIN_COEFF7     = 0x87,
        GAIN_COEFF8     = 0x88,
        GAIN_COEFF9     = 0x89,
        GAIN_COEFF10    = 0x8A,
        GAIN_COEFF11    = 0x8B,
        GAIN_COEFF12    = 0x8C,
        GAIN_COEFF13    = 0x8D,
        GAIN_COEFF14    = 0x8E,
        GAIN_COEFF15    = 0x8F,
        OFFSET_COEFF0   = 0x90,
        OFFSET_COEFF1   = 0x91,
        OFFSET_COEFF2   = 0x92,
        OFFSET_COEFF3   = 0x93,
        OFFSET_COEFF4   = 0x94,
        OFFSET_COEFF5   = 0x95,
        OFFSET_COEFF6   = 0x96,
        OFFSET_COEFF7   = 0x97,
        OFFSET_COEFF8   = 0x98,
        OFFSET_COEFF9   = 0x99,
        OFFSET_COEFF10  = 0x9A,
        OFFSET_COEFF11  = 0x9B,
        OFFSET_COEFF12  = 0x9C,
        OFFSET_COEFF13  = 0x9D,
        OFFSET_COEFF14  = 0x9E,
        OFFSET_COEFF15  = 0x9F,
        OPT_COEF0       = 0xA0,
        OPT_COEF1       = 0xA1,
        OPT_COEF2       = 0xA2,
        OPT_COEF3       = 0xA3,
        OPT_COEF4       = 0xA4,
        OPT_COEF5       = 0xA5,
        OPT_COEF6       = 0xA6,
        OPT_COEF7       = 0xA7,
        OPT_COEF8       = 0xA8,
        OPT_COEF9       = 0xA9,
        OPT_COEF10      = 0xAA,
        OPT_COEF11      = 0xAB,
        OPT_COEF12      = 0xAC,
        OPT_COEF13      = 0xAD,
        SERIAL1         = 0xAE,
        SERIAL0         = 0xAF,
    };
 
    enum Command : uint16_t {
        CMD_CH0             = 0x0000,
        CMD_CH1             = 0x0001,
        CMD_CH2             = 0x0002,
        CMD_CH3             = 0x0003,
        CMD_CH4             = 0x0004,
        CMD_CH5             = 0x0005,
        CMD_CH6             = 0x0006,
        CMD_CH7             = 0x0007,
        CMD_CH8             = 0x0008,
        CMD_CH9             = 0x0009,
        CMD_CH10            = 0x000A,
        CMD_CH11            = 0x000B,
        CMD_CH12            = 0x000C,
        CMD_CH13            = 0x000D,
        CMD_CH14            = 0x000E,
        CMD_CH15            = 0x000F,
        CMD_ABORT           = 0x0010,
        CMD_END             = 0x0011,
        CMD_CLEAR_ALARM     = 0x0012,
        CMD_CLEAR_DATA      = 0x0013,
        CMD_RESET           = 0x0014,
        CMD_CLEAR_REG       = 0x0015,
        CMD_RELOAD          = 0x0016,
        TBD                 = 0x0017,
        CMD_SS              = 0x2000,
        CMD_SC              = 0x2001,
        CMD_MM              = 0x2002,
        CMD_MC              = 0x2003,
        CMD_MS              = 0x2004,
        CMD_BURST_DATA      = 0x2005,
        CMD_CALC_CRC_CONFG  = 0x2006,
        CMD_CALC_CRC_COEF   = 0x2007,
        CMD_CALC_CRC_FAC    = 0x2008,
    };
    
    virtual void        command( uint16_t com );

    virtual void        reg( Register16 r, uint16_t value );

    virtual void        reg( Register24 r, uint32_t value );

    virtual uint16_t    reg( Register16 r );

    virtual uint32_t    reg( Register24 r );
        
    template<typename T>
    uint32_t    bit_op( T rg, uint32_t mask, uint32_t value )
    {
        uint32_t v  = reg( rg );
 
        v   &= mask;
        v   |= value & ~mask;
 
        reg( rg, v );
        
        return v;
    }
    
    uint32_t    part_number( void );

    uint8_t revision_number( void );

    uint64_t    serial_number( void );

    float   temperature( void );
    
    void    gain_offset_coeff( const ref_points &ref );
 
    enum CalibrationError : int {
        NoError     =  0,
        GainError   = -1,
        OffsetError = -2,
    };
    
    int     self_calibrate( int pga_gain_index, int channel_selection = 15, int input_select = 0, double reference_source_voltage = 0, bool use_positive_side = true );

    void blink_leds( void );
};
 
class NAFE13388 : public NAFE13388_Base
{
public: 
    NAFE13388( bool spi_addr = 0, bool highspeed_variant = false, int nINT = 2, int DRDY = 4, int SYN = 5, int nRESET = 6, int DRDY_input = 15, int SYNCDAC = 14 );

    virtual ~NAFE13388();
};
 
class NAFE13388_UIM : public NAFE13388_Base
{
public: 
    NAFE13388_UIM( bool spi_addr = 0, bool highspeed_variant = false, int nINT = 3, int DRDY = 4, int SYN = 6, int nRESET = 7, int DRDY_input = 2, int SYNCDAC = 14 );

    virtual ~NAFE13388_UIM();

    void blink_leds( void );
};
 
inline NAFE13388_Base::Register16 operator+( NAFE13388_Base::Register16 rn, int n )
{
    return static_cast<NAFE13388_Base::Register16>( static_cast<uint16_t>( rn ) + n );
}
 
inline NAFE13388_Base::Register16 operator+( int n, NAFE13388_Base::Register16 rn )
{
    return static_cast<NAFE13388_Base::Register16>( n + static_cast<uint16_t>( rn ) );
}
 
inline NAFE13388_Base::Register24 operator+( NAFE13388_Base::Register24 rn, int n )
{
    return static_cast<NAFE13388_Base::Register24>( static_cast<uint16_t>( rn ) + n );
}
 
inline NAFE13388_Base::Register24 operator+( int n, NAFE13388_Base::Register24 rn )
{
    return static_cast<NAFE13388_Base::Register24>( n + static_cast<uint16_t>( rn ) );
}
 
#endif //   ARDUINO_AFE_DRIVER_H