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