hardware/hameg-hmo/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef LIBSIGROK_HARDWARE_HAMEG_HMO_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_HAMEG_HMO_PROTOCOL_H
  22
  23 #include <glib.h>
  24 #include <stdint.h>
  25 #include <string.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28
  29 /* Message logging helpers with subsystem-specific prefix string. */
  30 #define LOG_PREFIX "hameg-hmo: "
  31 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  32 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  33 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  34 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  35 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  36 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  37
  38 #define MAX_INSTRUMENT_VERSIONS 10
  39 #define MAX_COMMAND_SIZE 31
  40
  41 struct scope_config {
  42         const char *name[MAX_INSTRUMENT_VERSIONS];
  43         const uint8_t analog_channels;
  44         const uint8_t digital_channels;
  45         const uint8_t digital_pods;
  46
  47         const char *(*analog_names)[];
  48         const char *(*digital_names)[];
  49
  50         const int32_t (*hw_caps)[];
  51         const uint8_t num_hwcaps;
  52
  53         const int32_t (*analog_hwcaps)[];
  54         const uint8_t num_analog_hwcaps;
  55
  56         const char *(*coupling_options)[];
  57         const uint8_t num_coupling_options;
  58
  59         const char *(*trigger_sources)[];
  60         const uint8_t num_trigger_sources;
  61
  62         const char *(*trigger_slopes)[];
  63
  64         const uint64_t (*timebases)[][2];
  65         const uint8_t num_timebases;
  66
  67         const uint64_t (*vdivs)[][2];
  68         const uint8_t num_vdivs;
  69
  70         const uint8_t num_xdivs;
  71         const uint8_t num_ydivs;
  72
  73         const char *(*scpi_dialect)[];
  74 };
  75
  76 struct analog_channel_state {
  77         int coupling;
  78
  79         float vdiv;
  80         float vertical_offset;
  81
  82         gboolean state;
  83 };
  84
  85 struct scope_state {
  86         struct analog_channel_state *analog_channels;
  87         gboolean *digital_channels;
  88         gboolean *digital_pods;
  89
  90         float timebase;
  91         float horiz_triggerpos;
  92
  93         int trigger_source;
  94         int trigger_slope;
  95 };
  96
  97 /** Private, per-device-instance driver context. */
  98 struct dev_context {
  99         void *model_config;
 100         void *model_state;
 101
 102         struct sr_probe_group *analog_groups;
 103         struct sr_probe_group *digital_groups;
 104
 105         GSList *enabled_probes;
 106         GSList *current_probe;
 107         uint64_t num_frames;
 108
 109         uint64_t frame_limit;
 110 };
 111
 112 SR_PRIV int hmo_init_device(struct sr_dev_inst *sdi);
 113 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi);
 114 SR_PRIV int hmo_receive_data(int fd, int revents, void *cb_data);
 115
 116 SR_PRIV struct scope_state *hmo_scope_state_new(struct scope_config *config);
 117 SR_PRIV void hmo_scope_state_free(struct scope_state *state);
 118 SR_PRIV int hmo_scope_state_get(struct sr_dev_inst *sdi);
 119
 120 #endif