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