2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
24 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
25 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
29 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
30 #ifdef HAVE_LIBUSB_1_0
33 #ifdef HAVE_LIBSERIALPORT
34 #include <libserialport.h>
40 * libsigrok private header file, only to be used internally.
43 /*--- Macros ----------------------------------------------------------------*/
46 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
49 #ifndef ARRAY_AND_SIZE
50 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
53 /* Portability fixes for FreeBSD. */
55 #define LIBUSB_CLASS_APPLICATION 0xfe
56 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
57 libusb_handle_events_timeout(ctx, tv)
61 #ifdef HAVE_LIBUSB_1_0
62 libusb_context *libusb_ctx;
63 gboolean usb_source_present;
66 gboolean usb_thread_running;
70 sr_receive_data_callback_t usb_cb;
76 #ifdef HAVE_LIBUSB_1_0
77 /** USB device instance */
78 struct sr_usb_dev_inst {
81 /** Device address on USB bus */
83 /** libusb device handle */
84 struct libusb_device_handle *devhdl;
88 #ifdef HAVE_LIBSERIALPORT
89 #define SERIAL_PARITY_NONE SP_PARITY_NONE
90 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
91 #define SERIAL_PARITY_ODD SP_PARITY_ODD
92 struct sr_serial_dev_inst {
93 /** Port name, e.g. '/dev/tty42'. */
95 /** Comm params for serial_set_paramstr(). */
97 /** Port is non-blocking. */
99 /** libserialport port handle */
100 struct sp_port *data;
101 /** libserialport event set */
102 struct sp_event_set *event_set;
103 /** GPollFDs for event polling */
108 struct sr_usbtmc_dev_inst {
113 /* Private driver context. */
115 /** sigrok context */
116 struct sr_context *sr_ctx;
120 /*--- log.c -----------------------------------------------------------------*/
122 SR_PRIV int sr_log(int loglevel, const char *format, ...);
123 SR_PRIV int sr_spew(const char *format, ...);
124 SR_PRIV int sr_dbg(const char *format, ...);
125 SR_PRIV int sr_info(const char *format, ...);
126 SR_PRIV int sr_warn(const char *format, ...);
127 SR_PRIV int sr_err(const char *format, ...);
129 /*--- device.c --------------------------------------------------------------*/
131 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
132 gboolean enabled, const char *name);
134 /* Generic device instances */
135 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
136 const char *vendor, const char *model, const char *version);
137 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
139 #ifdef HAVE_LIBUSB_1_0
140 /* USB-specific instances */
141 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
142 uint8_t address, struct libusb_device_handle *hdl);
143 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
144 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
147 #ifdef HAVE_LIBSERIALPORT
148 /* Serial-specific instances */
149 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
150 const char *serialcomm);
151 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
154 /* USBTMC-specific instances */
155 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
156 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
158 /*--- hwdriver.c ------------------------------------------------------------*/
160 SR_PRIV void sr_hw_cleanup_all(void);
161 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
162 SR_PRIV void sr_config_free(struct sr_config *src);
163 SR_PRIV int sr_source_remove(int fd);
164 SR_PRIV int sr_source_add(int fd, int events, int timeout,
165 sr_receive_data_callback_t cb, void *cb_data);
167 /*--- session.c -------------------------------------------------------------*/
170 /** List of struct sr_dev pointers. */
172 /** List of struct datafeed_callback pointers. */
173 GSList *datafeed_callbacks;
177 unsigned int num_sources;
180 * Both "sources" and "pollfds" are of the same size and contain pairs
181 * of descriptor and callback function. We can not embed the GPollFD
182 * into the source struct since we want to be able to pass the array
183 * of all poll descriptors to g_poll().
185 struct source *sources;
190 * These are our synchronization primitives for stopping the session in
191 * an async fashion. We need to make sure the session is stopped from
192 * within the session thread itself.
194 /** Mutex protecting access to abort_session. */
196 /** Abort current session. See sr_session_stop(). */
197 gboolean abort_session;
200 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
201 const struct sr_datafeed_packet *packet);
202 SR_PRIV int sr_session_stop_sync(void);
203 SR_PRIV int sr_sessionfile_check(const char *filename);
205 /*--- std.c -----------------------------------------------------------------*/
207 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
208 typedef void (*std_dev_clear_t)(void *priv);
210 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
212 #ifdef HAVE_LIBSERIALPORT
213 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
214 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
215 void *cb_data, dev_close_t dev_close_fn,
216 struct sr_serial_dev_inst *serial, const char *prefix);
218 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
220 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
221 std_dev_clear_t clear_private);
222 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
224 /*--- strutil.c -------------------------------------------------------------*/
226 SR_PRIV int sr_atol(const char *str, long *ret);
227 SR_PRIV int sr_atoi(const char *str, int *ret);
228 SR_PRIV int sr_atod(const char *str, double *ret);
229 SR_PRIV int sr_atof(const char *str, float *ret);
231 /*--- hardware/common/serial.c ----------------------------------------------*/
233 #ifdef HAVE_LIBSERIALPORT
240 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
242 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
243 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
244 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
245 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
246 const void *buf, size_t count);
247 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
249 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
250 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
251 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
252 const char *paramstr);
253 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
254 int *buflen, gint64 timeout_ms);
255 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
256 uint8_t *buf, size_t *buflen,
257 size_t packet_size, packet_valid_t is_valid,
258 uint64_t timeout_ms, int baudrate);
259 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
260 const char **serial_options);
261 SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
262 int timeout, sr_receive_data_callback_t cb, void *cb_data);
263 SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
266 /*--- hardware/common/ezusb.c -----------------------------------------------*/
268 #ifdef HAVE_LIBUSB_1_0
269 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
270 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
271 const char *filename);
272 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
273 const char *filename);
276 /*--- hardware/common/usb.c -------------------------------------------------*/
278 #ifdef HAVE_LIBUSB_1_0
279 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
280 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
281 SR_PRIV int usb_source_add(struct sr_context *ctx, int timeout,
282 sr_receive_data_callback_t cb, void *cb_data);
283 SR_PRIV int usb_source_remove(struct sr_context *ctx);
286 /*--- hardware/common/scpi.c ------------------------------------------------*/
288 #define SCPI_CMD_IDN "*IDN?"
289 #define SCPI_CMD_OPC "*OPC?"
292 SCPI_CMD_SET_TRIGGER_SOURCE,
293 SCPI_CMD_SET_TIMEBASE,
294 SCPI_CMD_SET_VERTICAL_DIV,
295 SCPI_CMD_SET_TRIGGER_SLOPE,
296 SCPI_CMD_SET_COUPLING,
297 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
298 SCPI_CMD_GET_ANALOG_CHAN_STATE,
299 SCPI_CMD_GET_DIG_CHAN_STATE,
300 SCPI_CMD_GET_TIMEBASE,
301 SCPI_CMD_GET_VERTICAL_DIV,
302 SCPI_CMD_GET_VERTICAL_OFFSET,
303 SCPI_CMD_GET_TRIGGER_SOURCE,
304 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
305 SCPI_CMD_GET_TRIGGER_SLOPE,
306 SCPI_CMD_GET_COUPLING,
307 SCPI_CMD_SET_ANALOG_CHAN_STATE,
308 SCPI_CMD_SET_DIG_CHAN_STATE,
309 SCPI_CMD_GET_DIG_POD_STATE,
310 SCPI_CMD_SET_DIG_POD_STATE,
311 SCPI_CMD_GET_ANALOG_DATA,
312 SCPI_CMD_GET_DIG_DATA,
315 struct sr_scpi_hw_info {
319 char *firmware_version;
322 struct sr_scpi_dev_inst {
323 int (*open)(void *priv);
324 int (*source_add)(void *priv, int events,
325 int timeout, sr_receive_data_callback_t cb, void *cb_data);
326 int (*source_remove)(void *priv);
327 int (*send)(void *priv, const char *command);
328 int (*receive)(void *priv, char **scpi_response);
329 int (*read)(void *priv, char *buf, int maxlen);
330 int (*close)(void *priv);
331 void (*free)(void *priv);
335 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
336 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
337 int timeout, sr_receive_data_callback_t cb, void *cb_data);
338 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
339 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
340 const char *format, ...);
341 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
342 const char *format, va_list args);
343 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
344 char **scpi_response);
345 SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
346 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
347 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
349 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
350 const char *command, char **scpi_response);
351 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
352 const char *command, gboolean *scpi_response);
353 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
354 const char *command, int *scpi_response);
355 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
356 const char *command, float *scpi_response);
357 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
358 const char *command, double *scpi_response);
359 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
360 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
361 const char *command, GArray **scpi_response);
362 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
363 const char *command, GArray **scpi_response);
364 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
365 struct sr_scpi_hw_info **scpi_response);
366 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
368 /*--- hardware/common/scpi_serial.c -----------------------------------------*/
370 #ifdef HAVE_LIBSERIALPORT
371 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
372 const char *serialcomm);
375 /*--- hardware/common/scpi_tcp.c --------------------------------------------*/
377 SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
380 /*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/
382 SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);
384 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
386 #define ES51922_PACKET_SIZE 14
388 struct es51922_info {
389 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
390 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
391 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
392 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
393 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
394 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
397 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
398 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
399 struct sr_datafeed_analog *analog, void *info);
401 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
404 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
405 * so always read 2 blocks at a time.
407 #define ES519XX_11B_PACKET_SIZE (11 * 2)
408 #define ES519XX_14B_PACKET_SIZE 14
410 struct es519xx_info {
411 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
412 gboolean is_milli, is_resistance, is_continuity, is_diode;
413 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
414 gboolean is_temperature, is_celsius, is_fahrenheit;
415 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
416 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
417 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
418 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
421 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
424 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
425 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
426 struct sr_datafeed_analog *analog, void *info);
427 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
428 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
429 float *floatval, struct sr_datafeed_analog *analog, void *info);
430 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
431 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
432 float *floatval, struct sr_datafeed_analog *analog, void *info);
433 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
434 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
435 struct sr_datafeed_analog *analog, void *info);
436 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
437 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
438 struct sr_datafeed_analog *analog, void *info);
439 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
440 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
441 float *floatval, struct sr_datafeed_analog *analog, void *info);
443 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
445 #define FS9922_PACKET_SIZE 14
448 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
449 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
450 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
451 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
452 gboolean is_celsius, is_fahrenheit;
453 int bargraph_sign, bargraph_value;
456 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
457 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
458 struct sr_datafeed_analog *analog, void *info);
459 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
461 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
463 #define FS9721_PACKET_SIZE 14
466 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
467 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
468 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
469 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
472 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
473 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
474 struct sr_datafeed_analog *analog, void *info);
475 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
476 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
477 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
478 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
480 /*--- hardware/common/dmm/m2110.c -----------------------------------------*/
482 #define BBCGM_M2110_PACKET_SIZE 9
484 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
485 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
486 struct sr_datafeed_analog *analog, void *info);
488 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
490 #define METEX14_PACKET_SIZE 14
492 struct metex14_info {
493 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
494 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
495 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
496 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
497 gboolean is_unitless;
500 #ifdef HAVE_LIBSERIALPORT
501 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
503 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
504 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
505 struct sr_datafeed_analog *analog, void *info);
507 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
509 #define RS9LCD_PACKET_SIZE 9
511 /* Dummy info struct. The parser does not use it. */
512 struct rs9lcd_info { int dummy; };
514 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
515 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
516 struct sr_datafeed_analog *analog, void *info);