]> sigrok.org Git - libsigrok.git/blob - hardware/hameg-hmo/protocol.h
hameg-hmo: Use hmo_ prefix for driver-local SR_PRIV functions.
[libsigrok.git] / 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 SR_PRIV struct sr_dev_driver hameg_hmo_driver_info;
42 static struct sr_dev_driver *di = &hameg_hmo_driver_info;
43
44 struct scope_config {
45         const char *name[MAX_INSTRUMENT_VERSIONS];
46         const uint8_t analog_channels;
47         const uint8_t digital_channels;
48         const uint8_t digital_pods;
49
50         const char *(*analog_names)[];
51         const char *(*digital_names)[];
52
53         const int32_t (*hw_caps)[];
54         const uint8_t num_hwcaps;
55
56         const int32_t (*analog_hwcaps)[];
57         const uint8_t num_analog_hwcaps;
58
59         const char *(*coupling_options)[];
60         const uint8_t num_coupling_options;
61
62         const char *(*trigger_sources)[];
63         const uint8_t num_trigger_sources;
64
65         const char *(*trigger_slopes)[];
66
67         const uint64_t (*timebases)[][2];
68         const uint8_t num_timebases;
69
70         const uint64_t (*vdivs)[][2];
71         const uint8_t num_vdivs;
72
73         const uint8_t num_xdivs;
74         const uint8_t num_ydivs;
75
76         const char *(*scpi_dialect)[];
77 };
78
79 struct analog_channel_state {
80         int coupling;
81
82         float vdiv;
83         float vertical_offset;
84
85         gboolean state;
86 };
87
88 struct scope_state {
89         struct analog_channel_state *analog_channels;
90         gboolean *digital_channels;
91         gboolean *digital_pods;
92
93         float timebase;
94         float horiz_triggerpos;
95
96         int trigger_source;
97         int trigger_slope;
98 };
99
100 /** Private, per-device-instance driver context. */
101 struct dev_context {
102         void *model_config;
103         void *model_state;
104
105         struct sr_probe_group *analog_groups;
106         struct sr_probe_group *digital_groups;
107
108         GSList *enabled_probes;
109         GSList *current_probe;
110         uint64_t num_frames;
111
112         uint64_t frame_limit;
113 };
114
115 SR_PRIV int hmo_init_device(struct sr_dev_inst *sdi);
116 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi);
117 SR_PRIV int hmo_receive_data(int fd, int revents, void *cb_data);
118 SR_PRIV struct sr_dev_inst *hmo_probe_serial_device(const char *serial_device,
119                                                     const char *serial_options);
120
121 SR_PRIV struct scope_state *hmo_scope_state_new(struct scope_config *config);
122 SR_PRIV void hmo_scope_state_free(struct scope_state *state);
123 SR_PRIV int hmo_scope_state_get(struct sr_dev_inst *sdi);
124
125 #endif