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;
65 gboolean usb_thread_running;
69 sr_receive_data_callback_t usb_cb;
75 #ifdef HAVE_LIBUSB_1_0
76 /** USB device instance */
77 struct sr_usb_dev_inst {
80 /** Device address on USB bus */
82 /** libusb device handle */
83 struct libusb_device_handle *devhdl;
87 #ifdef HAVE_LIBSERIALPORT
88 #define SERIAL_PARITY_NONE SP_PARITY_NONE
89 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
90 #define SERIAL_PARITY_ODD SP_PARITY_ODD
91 struct sr_serial_dev_inst {
92 /** Port name, e.g. '/dev/tty42'. */
94 /** Comm params for serial_set_paramstr(). */
96 /** Port is non-blocking. */
98 /** libserialport port handle */
100 /** libserialport event set */
101 struct sp_event_set *event_set;
102 /** GPollFDs for event polling */
107 struct sr_usbtmc_dev_inst {
112 /* Private driver context. */
114 /** sigrok context */
115 struct sr_context *sr_ctx;
119 /*--- log.c -----------------------------------------------------------------*/
121 SR_PRIV int sr_log(int loglevel, const char *format, ...);
122 SR_PRIV int sr_spew(const char *format, ...);
123 SR_PRIV int sr_dbg(const char *format, ...);
124 SR_PRIV int sr_info(const char *format, ...);
125 SR_PRIV int sr_warn(const char *format, ...);
126 SR_PRIV int sr_err(const char *format, ...);
128 /*--- device.c --------------------------------------------------------------*/
130 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
131 gboolean enabled, const char *name);
133 /* Generic device instances */
134 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
135 const char *vendor, const char *model, const char *version);
136 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
138 #ifdef HAVE_LIBUSB_1_0
139 /* USB-specific instances */
140 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
141 uint8_t address, struct libusb_device_handle *hdl);
142 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
143 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
146 #ifdef HAVE_LIBSERIALPORT
147 /* Serial-specific instances */
148 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
149 const char *serialcomm);
150 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
153 /* USBTMC-specific instances */
154 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
155 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
157 /*--- hwdriver.c ------------------------------------------------------------*/
159 SR_PRIV void sr_hw_cleanup_all(void);
160 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
161 SR_PRIV void sr_config_free(struct sr_config *src);
162 SR_PRIV int sr_source_remove(int fd);
163 SR_PRIV int sr_source_add(int fd, int events, int timeout,
164 sr_receive_data_callback_t cb, void *cb_data);
166 /*--- session.c -------------------------------------------------------------*/
169 /** List of struct sr_dev pointers. */
171 /** List of struct datafeed_callback pointers. */
172 GSList *datafeed_callbacks;
176 unsigned int num_sources;
179 * Both "sources" and "pollfds" are of the same size and contain pairs
180 * of descriptor and callback function. We can not embed the GPollFD
181 * into the source struct since we want to be able to pass the array
182 * of all poll descriptors to g_poll().
184 struct source *sources;
189 * These are our synchronization primitives for stopping the session in
190 * an async fashion. We need to make sure the session is stopped from
191 * within the session thread itself.
193 /** Mutex protecting access to abort_session. */
195 /** Abort current session. See sr_session_stop(). */
196 gboolean abort_session;
199 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
200 const struct sr_datafeed_packet *packet);
201 SR_PRIV int sr_session_stop_sync(void);
202 SR_PRIV int sr_sessionfile_check(const char *filename);
204 /*--- std.c -----------------------------------------------------------------*/
206 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
207 typedef void (*std_dev_clear_t)(void *priv);
209 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
211 #ifdef HAVE_LIBSERIALPORT
212 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
213 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
214 void *cb_data, dev_close_t dev_close_fn,
215 struct sr_serial_dev_inst *serial, const char *prefix);
217 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
219 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
220 std_dev_clear_t clear_private);
221 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
223 /*--- strutil.c -------------------------------------------------------------*/
225 SR_PRIV int sr_atol(const char *str, long *ret);
226 SR_PRIV int sr_atoi(const char *str, int *ret);
227 SR_PRIV int sr_atod(const char *str, double *ret);
228 SR_PRIV int sr_atof(const char *str, float *ret);
230 /*--- hardware/common/serial.c ----------------------------------------------*/
232 #ifdef HAVE_LIBSERIALPORT
239 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
241 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
242 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
243 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
244 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
245 const void *buf, size_t count);
246 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
248 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
249 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
250 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
251 const char *paramstr);
252 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
253 int *buflen, gint64 timeout_ms);
254 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
255 uint8_t *buf, size_t *buflen,
256 size_t packet_size, packet_valid_t is_valid,
257 uint64_t timeout_ms, int baudrate);
258 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
259 const char **serial_options);
260 SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
261 int timeout, sr_receive_data_callback_t cb, void *cb_data);
262 SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
265 /*--- hardware/common/ezusb.c -----------------------------------------------*/
267 #ifdef HAVE_LIBUSB_1_0
268 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
269 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
270 const char *filename);
271 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
272 const char *filename);
275 /*--- hardware/common/usb.c -------------------------------------------------*/
277 #ifdef HAVE_LIBUSB_1_0
278 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
279 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
280 SR_PRIV int usb_source_add(struct sr_context *ctx, int timeout,
281 sr_receive_data_callback_t cb, void *cb_data);
282 SR_PRIV int usb_source_remove(struct sr_context *ctx);
285 /*--- hardware/common/scpi.c ------------------------------------------------*/
287 #define SCPI_CMD_IDN "*IDN?"
288 #define SCPI_CMD_OPC "*OPC?"
291 SCPI_CMD_SET_TRIGGER_SOURCE,
292 SCPI_CMD_SET_TIMEBASE,
293 SCPI_CMD_SET_VERTICAL_DIV,
294 SCPI_CMD_SET_TRIGGER_SLOPE,
295 SCPI_CMD_SET_COUPLING,
296 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
297 SCPI_CMD_GET_ANALOG_CHAN_STATE,
298 SCPI_CMD_GET_DIG_CHAN_STATE,
299 SCPI_CMD_GET_TIMEBASE,
300 SCPI_CMD_GET_VERTICAL_DIV,
301 SCPI_CMD_GET_VERTICAL_OFFSET,
302 SCPI_CMD_GET_TRIGGER_SOURCE,
303 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
304 SCPI_CMD_GET_TRIGGER_SLOPE,
305 SCPI_CMD_GET_COUPLING,
306 SCPI_CMD_SET_ANALOG_CHAN_STATE,
307 SCPI_CMD_SET_DIG_CHAN_STATE,
308 SCPI_CMD_GET_DIG_POD_STATE,
309 SCPI_CMD_SET_DIG_POD_STATE,
310 SCPI_CMD_GET_ANALOG_DATA,
311 SCPI_CMD_GET_DIG_DATA,
314 struct sr_scpi_hw_info {
318 char *firmware_version;
321 struct sr_scpi_dev_inst {
322 int (*open)(void *priv);
323 int (*source_add)(void *priv, int events,
324 int timeout, sr_receive_data_callback_t cb, void *cb_data);
325 int (*source_remove)(void *priv);
326 int (*send)(void *priv, const char *command);
327 int (*receive)(void *priv, char **scpi_response);
328 int (*read)(void *priv, char *buf, int maxlen);
329 int (*close)(void *priv);
330 void (*free)(void *priv);
334 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
335 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
336 int timeout, sr_receive_data_callback_t cb, void *cb_data);
337 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
338 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
339 const char *format, ...);
340 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
341 const char *format, va_list args);
342 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
343 char **scpi_response);
344 SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
345 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
346 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
348 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
349 const char *command, char **scpi_response);
350 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
351 const char *command, gboolean *scpi_response);
352 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
353 const char *command, int *scpi_response);
354 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
355 const char *command, float *scpi_response);
356 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
357 const char *command, double *scpi_response);
358 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
359 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
360 const char *command, GArray **scpi_response);
361 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
362 const char *command, GArray **scpi_response);
363 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
364 struct sr_scpi_hw_info **scpi_response);
365 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
367 /*--- hardware/common/scpi_serial.c -----------------------------------------*/
369 #ifdef HAVE_LIBSERIALPORT
370 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
371 const char *serialcomm);
374 /*--- hardware/common/scpi_tcp.c --------------------------------------------*/
376 SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
379 /*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/
381 SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);
383 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
385 #define ES51922_PACKET_SIZE 14
387 struct es51922_info {
388 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
389 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
390 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
391 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
392 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
393 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
396 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
397 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
398 struct sr_datafeed_analog *analog, void *info);
400 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
403 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
404 * so always read 2 blocks at a time.
406 #define ES519XX_11B_PACKET_SIZE (11 * 2)
407 #define ES519XX_14B_PACKET_SIZE 14
409 struct es519xx_info {
410 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
411 gboolean is_milli, is_resistance, is_continuity, is_diode;
412 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
413 gboolean is_temperature, is_celsius, is_fahrenheit;
414 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
415 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
416 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
417 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
420 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
423 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
424 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
425 struct sr_datafeed_analog *analog, void *info);
426 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
427 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
428 float *floatval, struct sr_datafeed_analog *analog, void *info);
429 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
430 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
431 float *floatval, struct sr_datafeed_analog *analog, void *info);
432 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
433 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
434 struct sr_datafeed_analog *analog, void *info);
435 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
436 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
437 struct sr_datafeed_analog *analog, void *info);
438 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
439 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
440 float *floatval, struct sr_datafeed_analog *analog, void *info);
442 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
444 #define FS9922_PACKET_SIZE 14
447 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
448 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
449 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
450 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
451 gboolean is_celsius, is_fahrenheit;
452 int bargraph_sign, bargraph_value;
455 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
456 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
457 struct sr_datafeed_analog *analog, void *info);
458 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
460 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
462 #define FS9721_PACKET_SIZE 14
465 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
466 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
467 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
468 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
471 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
472 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
473 struct sr_datafeed_analog *analog, void *info);
474 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
475 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
476 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
477 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
479 /*--- hardware/common/dmm/m2110.c -----------------------------------------*/
481 #define BBCGM_M2110_PACKET_SIZE 9
483 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
484 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
485 struct sr_datafeed_analog *analog, void *info);
487 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
489 #define METEX14_PACKET_SIZE 14
491 struct metex14_info {
492 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
493 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
494 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
495 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
496 gboolean is_unitless;
499 #ifdef HAVE_LIBSERIALPORT
500 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
502 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
503 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
504 struct sr_datafeed_analog *analog, void *info);
506 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
508 #define RS9LCD_PACKET_SIZE 9
510 /* Dummy info struct. The parser does not use it. */
511 struct rs9lcd_info { int dummy; };
513 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
514 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
515 struct sr_datafeed_analog *analog, void *info);