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)
54 * Read a 16 bits big endian integer out of memory.
55 * @param x a pointer to the input memory
56 * @return the corresponding integer
58 #define RB16(x) ((((const uint8_t*)(x))[0] << 8) | \
59 ((const uint8_t*)(x))[1])
62 * Read a 16 bits little endian integer out of memory.
63 * @param x a pointer to the input memory
64 * @return the corresponding integer
66 #define RL16(x) ((((const uint8_t*)(x))[1] << 8) | \
67 ((const uint8_t*)(x))[0])
70 * Read a 32 bits big endian integer out of memory.
71 * @param x a pointer to the input memory
72 * @return the corresponding integer
74 #define RB32(x) ((((const uint8_t*)(x))[0] << 24) | \
75 (((const uint8_t*)(x))[1] << 16) | \
76 (((const uint8_t*)(x))[2] << 8) | \
77 ((const uint8_t*)(x))[3])
80 * Read a 32 bits little endian integer out of memory.
81 * @param x a pointer to the input memory
82 * @return the corresponding integer
84 #define RL32(x) ((((const uint8_t*)(x))[3] << 24) | \
85 (((const uint8_t*)(x))[2] << 16) | \
86 (((const uint8_t*)(x))[1] << 8) | \
87 ((const uint8_t*)(x))[0])
89 /* Portability fixes for FreeBSD. */
91 #define LIBUSB_CLASS_APPLICATION 0xfe
92 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
93 libusb_handle_events_timeout(ctx, tv)
97 #ifdef HAVE_LIBUSB_1_0
98 libusb_context *libusb_ctx;
99 gboolean usb_source_present;
102 gboolean usb_thread_running;
106 sr_receive_data_callback_t usb_cb;
112 #ifdef HAVE_LIBUSB_1_0
113 /** USB device instance */
114 struct sr_usb_dev_inst {
117 /** Device address on USB bus */
119 /** libusb device handle */
120 struct libusb_device_handle *devhdl;
124 #ifdef HAVE_LIBSERIALPORT
125 #define SERIAL_PARITY_NONE SP_PARITY_NONE
126 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
127 #define SERIAL_PARITY_ODD SP_PARITY_ODD
128 struct sr_serial_dev_inst {
129 /** Port name, e.g. '/dev/tty42'. */
131 /** Comm params for serial_set_paramstr(). */
133 /** Port is non-blocking. */
135 /** libserialport port handle */
136 struct sp_port *data;
137 /** libserialport event set */
138 struct sp_event_set *event_set;
139 /** GPollFDs for event polling */
144 struct sr_usbtmc_dev_inst {
149 /* Private driver context. */
151 /** sigrok context */
152 struct sr_context *sr_ctx;
156 /*--- log.c -----------------------------------------------------------------*/
158 SR_PRIV int sr_log(int loglevel, const char *format, ...);
159 SR_PRIV int sr_spew(const char *format, ...);
160 SR_PRIV int sr_dbg(const char *format, ...);
161 SR_PRIV int sr_info(const char *format, ...);
162 SR_PRIV int sr_warn(const char *format, ...);
163 SR_PRIV int sr_err(const char *format, ...);
165 /*--- device.c --------------------------------------------------------------*/
167 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
168 gboolean enabled, const char *name);
170 /* Generic device instances */
171 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
172 const char *vendor, const char *model, const char *version);
173 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
175 #ifdef HAVE_LIBUSB_1_0
176 /* USB-specific instances */
177 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
178 uint8_t address, struct libusb_device_handle *hdl);
179 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
180 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
183 #ifdef HAVE_LIBSERIALPORT
184 /* Serial-specific instances */
185 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
186 const char *serialcomm);
187 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
190 /* USBTMC-specific instances */
191 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
192 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
194 /*--- hwdriver.c ------------------------------------------------------------*/
196 SR_PRIV void sr_hw_cleanup_all(void);
197 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
198 SR_PRIV void sr_config_free(struct sr_config *src);
199 SR_PRIV int sr_source_remove(int fd);
200 SR_PRIV int sr_source_add(int fd, int events, int timeout,
201 sr_receive_data_callback_t cb, void *cb_data);
203 /*--- session.c -------------------------------------------------------------*/
206 /** List of struct sr_dev pointers. */
208 /** List of struct datafeed_callback pointers. */
209 GSList *datafeed_callbacks;
213 unsigned int num_sources;
216 * Both "sources" and "pollfds" are of the same size and contain pairs
217 * of descriptor and callback function. We can not embed the GPollFD
218 * into the source struct since we want to be able to pass the array
219 * of all poll descriptors to g_poll().
221 struct source *sources;
226 * These are our synchronization primitives for stopping the session in
227 * an async fashion. We need to make sure the session is stopped from
228 * within the session thread itself.
230 /** Mutex protecting access to abort_session. */
232 /** Abort current session. See sr_session_stop(). */
233 gboolean abort_session;
236 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
237 const struct sr_datafeed_packet *packet);
238 SR_PRIV int sr_session_stop_sync(void);
239 SR_PRIV int sr_sessionfile_check(const char *filename);
241 /*--- std.c -----------------------------------------------------------------*/
243 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
244 typedef void (*std_dev_clear_t)(void *priv);
246 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
248 #ifdef HAVE_LIBSERIALPORT
249 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
250 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
251 void *cb_data, dev_close_t dev_close_fn,
252 struct sr_serial_dev_inst *serial, const char *prefix);
254 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
256 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
257 std_dev_clear_t clear_private);
258 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
260 /*--- strutil.c -------------------------------------------------------------*/
262 SR_PRIV int sr_atol(const char *str, long *ret);
263 SR_PRIV int sr_atoi(const char *str, int *ret);
264 SR_PRIV int sr_atod(const char *str, double *ret);
265 SR_PRIV int sr_atof(const char *str, float *ret);
267 /*--- hardware/common/serial.c ----------------------------------------------*/
269 #ifdef HAVE_LIBSERIALPORT
276 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
278 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
279 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
280 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
281 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
282 const void *buf, size_t count);
283 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
285 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
286 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
287 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
288 const char *paramstr);
289 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
290 int *buflen, gint64 timeout_ms);
291 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
292 uint8_t *buf, size_t *buflen,
293 size_t packet_size, packet_valid_t is_valid,
294 uint64_t timeout_ms, int baudrate);
295 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
296 const char **serial_options);
297 SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
298 int timeout, sr_receive_data_callback_t cb, void *cb_data);
299 SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
302 /*--- hardware/common/ezusb.c -----------------------------------------------*/
304 #ifdef HAVE_LIBUSB_1_0
305 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
306 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
307 const char *filename);
308 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
309 const char *filename);
312 /*--- hardware/common/usb.c -------------------------------------------------*/
314 #ifdef HAVE_LIBUSB_1_0
315 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
316 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
317 SR_PRIV int usb_source_add(struct sr_context *ctx, int timeout,
318 sr_receive_data_callback_t cb, void *cb_data);
319 SR_PRIV int usb_source_remove(struct sr_context *ctx);
322 /*--- hardware/common/scpi.c ------------------------------------------------*/
324 #define SCPI_CMD_IDN "*IDN?"
325 #define SCPI_CMD_OPC "*OPC?"
328 SCPI_CMD_SET_TRIGGER_SOURCE,
329 SCPI_CMD_SET_TIMEBASE,
330 SCPI_CMD_SET_VERTICAL_DIV,
331 SCPI_CMD_SET_TRIGGER_SLOPE,
332 SCPI_CMD_SET_COUPLING,
333 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
334 SCPI_CMD_GET_ANALOG_CHAN_STATE,
335 SCPI_CMD_GET_DIG_CHAN_STATE,
336 SCPI_CMD_GET_TIMEBASE,
337 SCPI_CMD_GET_VERTICAL_DIV,
338 SCPI_CMD_GET_VERTICAL_OFFSET,
339 SCPI_CMD_GET_TRIGGER_SOURCE,
340 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
341 SCPI_CMD_GET_TRIGGER_SLOPE,
342 SCPI_CMD_GET_COUPLING,
343 SCPI_CMD_SET_ANALOG_CHAN_STATE,
344 SCPI_CMD_SET_DIG_CHAN_STATE,
345 SCPI_CMD_GET_DIG_POD_STATE,
346 SCPI_CMD_SET_DIG_POD_STATE,
347 SCPI_CMD_GET_ANALOG_DATA,
348 SCPI_CMD_GET_DIG_DATA,
351 struct sr_scpi_hw_info {
355 char *firmware_version;
358 struct sr_scpi_dev_inst {
359 int (*open)(void *priv);
360 int (*source_add)(void *priv, int events,
361 int timeout, sr_receive_data_callback_t cb, void *cb_data);
362 int (*source_remove)(void *priv);
363 int (*send)(void *priv, const char *command);
364 int (*receive)(void *priv, char **scpi_response);
365 int (*read)(void *priv, char *buf, int maxlen);
366 int (*close)(void *priv);
367 void (*free)(void *priv);
371 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
372 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
373 int timeout, sr_receive_data_callback_t cb, void *cb_data);
374 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
375 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
376 const char *format, ...);
377 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
378 const char *format, va_list args);
379 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
380 char **scpi_response);
381 SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
382 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
383 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
385 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
386 const char *command, char **scpi_response);
387 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
388 const char *command, gboolean *scpi_response);
389 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
390 const char *command, int *scpi_response);
391 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
392 const char *command, float *scpi_response);
393 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
394 const char *command, double *scpi_response);
395 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
396 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
397 const char *command, GArray **scpi_response);
398 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
399 const char *command, GArray **scpi_response);
400 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
401 struct sr_scpi_hw_info **scpi_response);
402 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
404 /*--- hardware/common/scpi_serial.c -----------------------------------------*/
406 #ifdef HAVE_LIBSERIALPORT
407 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
408 const char *serialcomm);
411 /*--- hardware/common/scpi_tcp.c --------------------------------------------*/
413 SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
416 /*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/
418 SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);
420 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
422 #define ES51922_PACKET_SIZE 14
424 struct es51922_info {
425 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
426 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
427 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
428 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
429 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
430 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
433 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
434 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
435 struct sr_datafeed_analog *analog, void *info);
437 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
440 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
441 * so always read 2 blocks at a time.
443 #define ES519XX_11B_PACKET_SIZE (11 * 2)
444 #define ES519XX_14B_PACKET_SIZE 14
446 struct es519xx_info {
447 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
448 gboolean is_milli, is_resistance, is_continuity, is_diode;
449 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
450 gboolean is_temperature, is_celsius, is_fahrenheit;
451 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
452 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
453 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
454 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
457 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
460 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
461 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
462 struct sr_datafeed_analog *analog, void *info);
463 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
464 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
465 float *floatval, struct sr_datafeed_analog *analog, void *info);
466 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
467 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
468 float *floatval, struct sr_datafeed_analog *analog, void *info);
469 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
470 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
471 struct sr_datafeed_analog *analog, void *info);
472 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
473 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
474 struct sr_datafeed_analog *analog, void *info);
475 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
476 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
477 float *floatval, struct sr_datafeed_analog *analog, void *info);
479 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
481 #define FS9922_PACKET_SIZE 14
484 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
485 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
486 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
487 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
488 gboolean is_celsius, is_fahrenheit;
489 int bargraph_sign, bargraph_value;
492 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
493 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
494 struct sr_datafeed_analog *analog, void *info);
495 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
497 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
499 #define FS9721_PACKET_SIZE 14
502 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
503 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
504 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
505 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
508 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
509 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
510 struct sr_datafeed_analog *analog, void *info);
511 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
512 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
513 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
514 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
516 /*--- hardware/common/dmm/m2110.c -----------------------------------------*/
518 #define BBCGM_M2110_PACKET_SIZE 9
520 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
521 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
522 struct sr_datafeed_analog *analog, void *info);
524 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
526 #define METEX14_PACKET_SIZE 14
528 struct metex14_info {
529 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
530 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
531 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
532 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
533 gboolean is_unitless;
536 #ifdef HAVE_LIBSERIALPORT
537 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
539 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
540 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
541 struct sr_datafeed_analog *analog, void *info);
543 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
545 #define RS9LCD_PACKET_SIZE 9
547 /* Dummy info struct. The parser does not use it. */
548 struct rs9lcd_info { int dummy; };
550 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
551 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
552 struct sr_datafeed_analog *analog, void *info);