]> sigrok.org Git - libsigrok.git/blame - libsigrok-internal.h
add ISO-TECH IDM103N serial-dmm driver
[libsigrok.git] / libsigrok-internal.h
CommitLineData
1483577e 1/*
50985c20 2 * This file is part of the libsigrok project.
1483577e 3 *
13d8e03c 4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
1483577e
UH
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
0f8522bf
UH
20#ifndef LIBSIGROK_SIGROK_INTERNAL_H
21#define LIBSIGROK_SIGROK_INTERNAL_H
1483577e 22
b08024a8 23#include <stdarg.h>
cc8a7d25 24#include <glib.h>
1a081ca6 25#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
69890f73
UH
26#ifdef HAVE_LIBUSB_1_0
27#include <libusb.h>
28#endif
b08024a8 29
393fb9cb
UH
30/**
31 * @file
32 *
33 * libsigrok private header file, only to be used internally.
34 */
35
4cea9eb2
UH
36/*--- Macros ----------------------------------------------------------------*/
37
38#ifndef ARRAY_SIZE
39#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
40#endif
41
42#ifndef ARRAY_AND_SIZE
43#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
44#endif
45
b8072700 46struct sr_context {
785b9ff2
PS
47#ifdef HAVE_LIBUSB_1_0
48 libusb_context *libusb_ctx;
49#endif
b8072700
PS
50};
51
69890f73 52#ifdef HAVE_LIBUSB_1_0
d68e2d1a 53struct sr_usb_dev_inst {
69890f73
UH
54 uint8_t bus;
55 uint8_t address;
56 struct libusb_device_handle *devhdl;
57};
58#endif
59
f8c1fcda
BV
60#define SERIAL_PARITY_NONE 0
61#define SERIAL_PARITY_EVEN 1
62#define SERIAL_PARITY_ODD 2
d68e2d1a 63struct sr_serial_dev_inst {
69890f73 64 char *port;
299bdb24 65 char *serialcomm;
69890f73
UH
66 int fd;
67};
68
026c822d
UH
69/* Private driver context. */
70struct drv_context {
1ebe4b4e 71 struct sr_context *sr_ctx;
026c822d
UH
72 GSList *instances;
73};
74
48a486cd
BV
75/*--- log.c -----------------------------------------------------------------*/
76
77SR_PRIV int sr_log(int loglevel, const char *format, ...);
78SR_PRIV int sr_spew(const char *format, ...);
79SR_PRIV int sr_dbg(const char *format, ...);
80SR_PRIV int sr_info(const char *format, ...);
81SR_PRIV int sr_warn(const char *format, ...);
82SR_PRIV int sr_err(const char *format, ...);
83
84/*--- device.c --------------------------------------------------------------*/
85
86SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
87 gboolean enabled, const char *name);
88
89/* Generic device instances */
90SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
91 const char *vendor, const char *model, const char *version);
92SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
48a486cd 93
545f9786 94#ifdef HAVE_LIBUSB_1_0
69890f73 95/* USB-specific instances */
d68e2d1a 96SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
69890f73 97 uint8_t address, struct libusb_device_handle *hdl);
91162629 98SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
d68e2d1a 99SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
69890f73
UH
100#endif
101
102/* Serial-specific instances */
299bdb24
BV
103SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
104 const char *serialcomm);
d68e2d1a 105SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
69890f73 106
b08024a8 107
c09f0b57 108/*--- hwdriver.c ------------------------------------------------------------*/
996b0c72 109
93a04e3b 110SR_PRIV void sr_hw_cleanup_all(void);
bc1c2f00 111SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
722db131 112SR_PRIV void sr_config_free(struct sr_config *src);
48a486cd
BV
113SR_PRIV int sr_source_remove(int fd);
114SR_PRIV int sr_source_add(int fd, int events, int timeout,
ae5859ff 115 sr_receive_data_callback_t cb, void *cb_data);
996b0c72 116
a1645fcd
BV
117/*--- session.c -------------------------------------------------------------*/
118
de4d3f99 119SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
ae5859ff 120 const struct sr_datafeed_packet *packet);
33c6e4c5 121SR_PRIV int sr_session_stop_sync(void);
f438e0c9 122SR_PRIV int sr_sessionfile_check(const char *filename);
a1645fcd 123
063e7aef
UH
124/*--- std.c -----------------------------------------------------------------*/
125
cd2f0fe2 126typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
ae5859ff 127typedef void (*std_dev_clear_t)(void *priv);
cd2f0fe2 128
f6beaac5 129SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
ae5859ff 130 const char *prefix);
f6beaac5 131SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
6078d2c9 132 void *cb_data, dev_close_t dev_close_fn,
ae5859ff 133 struct sr_serial_dev_inst *serial, const char *prefix);
4afdfd46 134SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
ae5859ff
BV
135 const char *prefix);
136SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
137 std_dev_clear_t clear_private);
4afdfd46 138
058b7035
UH
139/*--- hardware/common/serial.c ----------------------------------------------*/
140
a54dd31e
UH
141enum {
142 SERIAL_RDWR = 1,
143 SERIAL_RDONLY = 2,
144 SERIAL_NONBLOCK = 4,
145};
146
766456be
UH
147typedef gboolean (*packet_valid_t)(const uint8_t *buf);
148
299bdb24
BV
149SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
150SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
151SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
152SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
153 const void *buf, size_t count);
154SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
155 size_t count);
156SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
71caaad4 157 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
299bdb24
BV
158SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
159 const char *paramstr);
160SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
161 int *buflen, gint64 timeout_ms);
766456be
UH
162SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
163 uint8_t *buf, size_t *buflen,
164 size_t packet_size, packet_valid_t is_valid,
165 uint64_t timeout_ms, int baudrate);
1483577e 166
058b7035
UH
167/*--- hardware/common/ezusb.c -----------------------------------------------*/
168
22b02383 169#ifdef HAVE_LIBUSB_1_0
1a081ca6
UH
170SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
171SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
172 const char *filename);
173SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
174 const char *filename);
22b02383 175#endif
058b7035 176
0c632d36
UH
177/*--- hardware/common/usb.c -------------------------------------------------*/
178
179#ifdef HAVE_LIBUSB_1_0
7ae6a758 180SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
0c632d36
UH
181SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
182#endif
183
fe0c0b98
UH
184/*--- hardware/common/dmm/es51922.c -----------------------------------------*/
185
186#define ES51922_PACKET_SIZE 14
187
188struct es51922_info {
189 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
190 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
191 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
192 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
193 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
194 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
195};
196
197SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
198SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
199 struct sr_datafeed_analog *analog, void *info);
200
c01bdebc
AJ
201/*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
202
203#define ES519XX_11B_PACKET_SIZE 2*11
204#define ES519XX_14B_PACKET_SIZE 14
205
206struct es519xx_info {
207 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
208 gboolean is_milli, is_resistance, is_continuity, is_diode;
209 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
210 gboolean is_temperature, is_celsius, is_fahrenheit;
211 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
212 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
213 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
214 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
215 uint32_t baudrate;
216 int packet_size;
217 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
218};
219
220SR_PRIV gboolean sr_es519xx_2400_11B_packet_valid(const uint8_t *buf);
221SR_PRIV int sr_es519xx_2400_11B_parse(const uint8_t *buf, float *floatval,
222 struct sr_datafeed_analog *analog,
223 void *info);
224SR_PRIV gboolean sr_es519xx_19200_11B_5digits_packet_valid(const uint8_t *buf);
225SR_PRIV int sr_es519xx_19200_11B_5difits_parse(const uint8_t *buf,
226 float *floatval, struct sr_datafeed_analog *analog, void *info);
227SR_PRIV gboolean sr_es519xx_19200_11B_clamp_packet_valid(const uint8_t *buf);
228SR_PRIV int sr_es519xx_19200_11B_clamp_parse(const uint8_t *buf,
229 float *floatval,
230 struct sr_datafeed_analog *analog,
231 void *info);
232SR_PRIV gboolean sr_es519xx_19200_11B_packet_valid(const uint8_t *buf);
233SR_PRIV int sr_es519xx_19200_11B_parse(const uint8_t *buf, float *floatval,
234 struct sr_datafeed_analog *analog,
235 void *info);
236SR_PRIV gboolean sr_es519xx_19200_14B_packet_valid(const uint8_t *buf);
237SR_PRIV int sr_es519xx_19200_14B_parse(const uint8_t *buf, float *floatval,
238 struct sr_datafeed_analog *analog,
239 void *info);
240SR_PRIV gboolean sr_es519xx_19200_14B_selectable_lpfpacket_valid(const uint8_t *buf);
241SR_PRIV int sr_es519xx_19200_14B_selectable_lpf_parse(const uint8_t *buf,
242 float *floatval,
243 struct sr_datafeed_analog *analog,
244 void *info);
245
79081ec8
UH
246/*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
247
913abe83
UH
248#define FS9922_PACKET_SIZE 14
249
250struct fs9922_info {
251 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
252 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
253 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
254 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
255 gboolean is_celsius, is_fahrenheit;
256 int bargraph_sign, bargraph_value;
257};
258
913abe83
UH
259SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
260SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
261 struct sr_datafeed_analog *analog, void *info);
e52bb9be 262SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
79081ec8 263
6c701476
UH
264/*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
265
8c1adf37
UH
266#define FS9721_PACKET_SIZE 14
267
268struct fs9721_info {
269 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
270 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
271 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
272 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
273};
274
8c1adf37
UH
275SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
276SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
93357bc3 277 struct sr_datafeed_analog *analog, void *info);
2451a20f
UH
278SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
279SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
280SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
281SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
6c701476 282
ac913e5c
UH
283/*--- hardware/common/dmm/metex14.c -----------------------------------------*/
284
285#define METEX14_PACKET_SIZE 14
286
287struct metex14_info {
288 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
289 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
290 gboolean is_hertz, is_ohm, is_celsius, is_nano, is_micro, is_milli;
9871215c 291 gboolean is_kilo, is_mega, is_gain, is_decibel, is_hfe, is_unitless;
ac913e5c
UH
292};
293
ce3777ad 294SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
ac913e5c
UH
295SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
296SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1fbab466 297 struct sr_datafeed_analog *analog, void *info);
ac913e5c 298
05f134ab
AG
299/*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
300
21829e67 301#define RS9LCD_PACKET_SIZE 9
05f134ab 302
e7ed87a4 303/* Dummy info struct. The parser does not use it. */
bf6f8399 304struct rs9lcd_info { int dummy; };
e7ed87a4 305
05f134ab
AG
306SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
307SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
308 struct sr_datafeed_analog *analog, void *info);
309
1483577e 310#endif