enums.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Analog Devices Inc.
 *
 * This file is part of libm2k
 * (see http://www.github.com/analogdevicesinc/libm2k).
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ENUMS_HPP
#define ENUMS_HPP

#include <string>
#include <vector>

extern "C" {
    struct iio_context;
    struct iio_device;
    struct iio_channel;
    struct iio_buffer;
}
namespace libm2k {

    enum CALIBRATION_MODE {
        ADC_REF1,
        ADC_REF2,
        ADC_GND,
        DAC,
        NONE
    };


    struct CALIBRATION_PARAMETERS {
        int adc_offset_ch_1; 
        int adc_offset_ch_2; 
        double adc_gain_ch_1; 
        double adc_gain_ch_2; 
        int dac_a_offset; 
        int dac_b_offset; 
        double dac_a_gain; 
        double dac_b_gain; 
    };


    enum GAIN_MODE {
        LOW_GAIN,
        HIGH_GAIN
    };

    enum M2K_EXCEPTION_TYPE {
        EXC_OUT_OF_RANGE = 0,
        EXC_RUNTIME_ERROR = 1,
        EXC_INVALID_PARAMETER = 2,
        EXC_TIMEOUT = 3,
        EXC_INVALID_FIRMWARE_VERSION = 4
    };


    enum M2K_TRIGGER_CONDITION_ANALOG {
        RISING_EDGE_ANALOG = 0,
        FALLING_EDGE_ANALOG = 1,
        LOW_LEVEL_ANALOG = 2,
        HIGH_LEVEL_ANALOG = 3
    };


    enum M2K_TRIGGER_CONDITION_DIGITAL {
        RISING_EDGE_DIGITAL = 0,
        FALLING_EDGE_DIGITAL = 1,
        LOW_LEVEL_DIGITAL = 2,
        HIGH_LEVEL_DIGITAL = 3,
        ANY_EDGE_DIGITAL = 4,
        NO_TRIGGER_DIGITAL = 5,
    };


    enum M2K_TRIGGER_MODE {
        ALWAYS = 0, 
        ANALOG = 1, 
        EXTERNAL = 2, 
        DIGITAL_OR_ANALOG = 3,
        DIGITAL_AND_ANALOG = 4,
        DIGITAL_XOR_ANALOG = 5,
        N_DIGITAL_OR_ANALOG = 6,
        N_DIGITAL_AND_ANALOG = 7,
        N_DIGITAL_XOR_ANALOG = 8,
    };


    enum M2K_TRIGGER_SOURCE_ANALOG {
        CHANNEL_1 = 0, 
        CHANNEL_2 = 1, 
        CHANNEL_1_OR_CHANNEL_2 = 2,
        CHANNEL_1_AND_CHANNEL_2 = 3,
        CHANNEL_1_XOR_CHANNEL_2 = 4,
        SRC_DIGITAL_IN = 5, 
        CHANNEL_1_OR_SRC_LOGIC_ANALYZER = 6,
        CHANNEL_2_OR_SRC_LOGIC_ANALYZER = 7,
        CHANNEL_1_OR_CHANNEL_2_OR_SRC_LOGIC_ANALYZER = 8,
        NO_SOURCE = 9, 
    };


    enum M2K_TRIGGER_SOURCE_OUT {
        TRIGGER_NONE = 0,
        TRIGGER_TI = 1, 
        TRIGGER_ADC = 2,
        TRIGGER_LA = 3,
    };

    enum M2K_TRIGGER_CONDITION_OUT {
        NONE_OUT = 0,
        LOW_LEVEL_OUT = 1,
        HIGH_LEVEL_OUT = 2,
        ANY_EDGE_OUT = 3,
        RISING_EDGE_OUT = 4,
        FALLING_EDGE_OUT = 5,
    };

    enum M2K_TRIGGER_STATUS_ANALOG_OUT {
        DISABLED = 0,
        START = 1,
        STOP = 2,
    };  


    enum M2K_TRIGGER_SOURCE_DIGITAL {
        SRC_TRIGGER_IN = 0, 
        SRC_ANALOG_IN = 1, 
        SRC_NONE = 2, 
        SRC_DISABLED = 3, 
    };


    enum M2K_TRIGGER_OUT_SELECT {
        SELECT_NONE = 0, 
        SELECT_TRIGGER_I_SAME_CHAN = 1,
        SELECT_TRIGGER_IN = 2, 
        SELECT_ANALOG_IN = 3, 
        SELECT_DIGITAL_IN = 4 
    };


    struct SETTINGS {
        std::vector<M2K_TRIGGER_CONDITION_ANALOG> analog_condition; 
        std::vector<M2K_TRIGGER_CONDITION_DIGITAL> digital_condition; 
        std::vector<int> raw_level; 
        std::vector<double> level; 
        std::vector<double> hysteresis; 
        std::vector<M2K_TRIGGER_MODE> mode; 
        M2K_TRIGGER_SOURCE_ANALOG trigger_source; 
        int delay; 
    };


    struct CONTEXT_INFO {
        std::string id_vendor; 
        std::string id_product; 
        std::string manufacturer; 
        std::string product; 
        std::string serial; 
        std::string uri; 
    };


    struct IIO_OBJECTS {
        std::vector<iio_channel*> channels_in;
        std::vector<iio_channel*> channels_out;
        std::vector<iio_device*> devices;
        std::vector<iio_buffer*> buffers_rx;
        std::vector<iio_buffer*> buffers_tx;
        iio_context* context;
    };

    struct IIO_CONTEXT_VERSION {
            unsigned int major; 
            unsigned int minor; 
            char git_tag[8]; 
    };
}


#endif