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 4
  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
  45 enum trigger_slopes {
  46         SLOPE_POSITIVE,
  47         SLOPE_NEGATIVE
  48 };
  49
  50 struct scope_config {
  51         const char *model_id[MAX_INSTRUMENT_VERSIONS];
  52         const char *model_name[MAX_INSTRUMENT_VERSIONS];
  53         const uint8_t analog_channels;
  54         const uint8_t digital_channels;
  55         const uint8_t pods;
  56
  57         const char *(*analog_names)[];
  58         const char *(*digital_names)[];
  59
  60         const int32_t (*hw_caps)[];
  61         const uint8_t num_hwcaps;
  62
  63         const int32_t (*analog_hwcaps)[];
  64         const uint8_t num_analog_hwcaps;
  65
  66         const char *(*coupling_options)[];
  67         const uint8_t num_coupling_options;
  68
  69         const char *(*trigger_sources)[];
  70         const uint8_t num_trigger_sources;
  71
  72         const char *(*trigger_slopes)[];
  73
  74         const uint64_t (*timebases)[][2];
  75         const uint8_t num_timebases;
  76
  77         const uint64_t (*vdivs)[][2];
  78         const uint8_t num_vdivs;
  79
  80         const uint8_t num_xdivs;
  81         const uint8_t num_ydivs;
  82
  83         const char *(*scpi_dialect)[];
  84 };
  85
  86 struct analog_channel_state {
  87         int coupling;
  88
  89         int vdiv;
  90         float vertical_offset, waveform_range, waveform_offset;
  91
  92         gboolean state;
  93 };
  94
  95 struct scope_state {
  96         struct analog_channel_state *analog_states;
  97         gboolean *digital_states;
  98         gboolean *pod_states;
  99
 100         int timebase;
 101         float horiz_triggerpos;
 102
 103         int trigger_source;
 104         int trigger_slope;
 105         uint64_t sample_rate;
 106         uint32_t samples_per_frame;
 107 };
 108
 109 /** Private, per-device-instance driver context. */
 110 struct dev_context {
 111         void *model_config;
 112         void *model_state;
 113
 114         struct sr_channel_group **analog_groups;
 115         struct sr_channel_group **digital_groups;
 116
 117         GSList *enabled_channels;
 118         GSList *current_channel;
 119         uint64_t num_frames;
 120
 121         uint64_t frame_limit;
 122
 123         char receive_buffer[RECEIVE_BUFFER_SIZE];
 124         gboolean data_pending;
 125 };
 126
 127 /*--- api.c -----------------------------------------------------------------*/
 128 SR_PRIV int dlm_data_request(const struct sr_dev_inst *sdi);
 129
 130 /*--- protocol.c ------------------------------------------------------------*/
 131 SR_PRIV int dlm_model_get(char *model_id, char **model_name, int *model_index);
 132 SR_PRIV int dlm_device_init(struct sr_dev_inst *sdi, int model_index);
 133 SR_PRIV int dlm_data_receive(int fd, int revents, void *cb_data);
 134
 135 SR_PRIV void dlm_scope_state_destroy(struct scope_state *state);
 136 SR_PRIV int dlm_scope_state_query(struct sr_dev_inst *sdi);
 137 SR_PRIV int dlm_sample_rate_query(const struct sr_dev_inst *sdi);
 138
 139 SR_PRIV int dlm_channel_data_request(const struct sr_dev_inst *sdi);
 140
 141 #endif