src/hardware/yokogawa-dlm/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 abraxa (Soeren Apel) <soeren@apelpie.net>
   5  * Based on the Hameg HMO driver by poljar (Damir Jelić) <poljarinho@gmail.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef LIBSIGROK_HARDWARE_YOKOGAWA_DLM_PROTOCOL_H
  22 #define LIBSIGROK_HARDWARE_YOKOGAWA_DLM_PROTOCOL_H
  23
  24 #include <glib.h>
  25 #include <stdint.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <math.h>
  29 #include "libsigrok.h"
  30 #include "libsigrok-internal.h"
  31 #include "protocol_wrappers.h"
  32
  33 #define LOG_PREFIX "yokogawa-dlm"
  34 #define MAX_INSTRUMENT_VERSIONS 8
  35
  36 #define RECEIVE_BUFFER_SIZE 4096
  37
  38 /* See Communication Interface User's Manual on p. 268 (:WAVeform:ALL:SEND?). */
  39 #define DLM_MAX_FRAME_LENGTH 12500
  40 /* See Communication Interface User's Manual on p. 269 (:WAVeform:SEND?). */
  41 #define DLM_DIVISION_FOR_WORD_FORMAT 3200
  42 #define DLM_DIVISION_FOR_BYTE_FORMAT 12.5
  43
  44 #define DLM_DIG_CHAN_INDEX_OFFS (32)
  45
  46 enum trigger_slopes {
  47         SLOPE_POSITIVE,
  48         SLOPE_NEGATIVE
  49 };
  50
  51 struct scope_config {
  52         const char *model_id[MAX_INSTRUMENT_VERSIONS];
  53         const char *model_name[MAX_INSTRUMENT_VERSIONS];
  54         const uint8_t analog_channels;
  55         const uint8_t digital_channels;
  56         const uint8_t pods;
  57
  58         const char *(*analog_names)[];
  59         const char *(*digital_names)[];
  60
  61         const uint32_t (*devopts)[];
  62         const uint8_t num_devopts;
  63
  64         const uint32_t (*analog_devopts)[];
  65         const uint8_t num_analog_devopts;
  66
  67         const char *(*coupling_options)[];
  68         const uint8_t num_coupling_options;
  69
  70         const char *(*trigger_sources)[];
  71         const uint8_t num_trigger_sources;
  72
  73         const char *(*trigger_slopes)[];
  74
  75         const uint64_t (*timebases)[][2];
  76         const uint8_t num_timebases;
  77
  78         const uint64_t (*vdivs)[][2];
  79         const uint8_t num_vdivs;
  80
  81         const uint8_t num_xdivs;
  82         const uint8_t num_ydivs;
  83 };
  84
  85 struct analog_channel_state {
  86         int coupling;
  87
  88         int vdiv;
  89         float vertical_offset, waveform_range, waveform_offset;
  90
  91         gboolean state;
  92 };
  93
  94 struct scope_state {
  95         struct analog_channel_state *analog_states;
  96         gboolean *digital_states;
  97         gboolean *pod_states;
  98
  99         int timebase;
 100         float horiz_triggerpos;
 101
 102         int trigger_source;
 103         int trigger_slope;
 104         uint64_t sample_rate;
 105         uint32_t samples_per_frame;
 106 };
 107
 108 /** Private, per-device-instance driver context. */
 109 struct dev_context {
 110         const void *model_config;
 111         void *model_state;
 112
 113         struct sr_channel_group **analog_groups;
 114         struct sr_channel_group **digital_groups;
 115
 116         GSList *enabled_channels;
 117         GSList *current_channel;
 118         uint64_t num_frames;
 119
 120         uint64_t frame_limit;
 121
 122         char receive_buffer[RECEIVE_BUFFER_SIZE];
 123         gboolean data_pending;
 124 };
 125
 126 SR_PRIV int dlm_data_request(const struct sr_dev_inst *sdi);
 127 SR_PRIV int dlm_model_get(char *model_id, char **model_name, int *model_index);
 128 SR_PRIV int dlm_device_init(struct sr_dev_inst *sdi, int model_index);
 129 SR_PRIV int dlm_data_receive(int fd, int revents, void *cb_data);
 130 SR_PRIV void dlm_scope_state_destroy(struct scope_state *state);
 131 SR_PRIV int dlm_scope_state_query(struct sr_dev_inst *sdi);
 132 SR_PRIV int dlm_sample_rate_query(const struct sr_dev_inst *sdi);
 133 SR_PRIV int dlm_channel_data_request(const struct sr_dev_inst *sdi);
 134
 135 #endif