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;
66 #ifdef HAVE_LIBUSB_1_0
67 /** USB device instance */
68 struct sr_usb_dev_inst {
71 /** Device address on USB bus */
73 /** libusb device handle */
74 struct libusb_device_handle *devhdl;
78 #ifdef HAVE_LIBSERIALPORT
79 #define SERIAL_PARITY_NONE SP_PARITY_NONE
80 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
81 #define SERIAL_PARITY_ODD SP_PARITY_ODD
82 struct sr_serial_dev_inst {
83 /** Port name, e.g. '/dev/tty42'. */
85 /** Comm params for serial_set_paramstr(). */
87 /** Port is non-blocking. */
89 /** libserialport port handle */
91 /** libserialport event set */
92 struct sp_event_set *event_set;
93 /** GPollFDs for event polling */
98 struct sr_usbtmc_dev_inst {
103 /* Private driver context. */
105 /** sigrok context */
106 struct sr_context *sr_ctx;
110 /*--- log.c -----------------------------------------------------------------*/
112 SR_PRIV int sr_log(int loglevel, const char *format, ...);
113 SR_PRIV int sr_spew(const char *format, ...);
114 SR_PRIV int sr_dbg(const char *format, ...);
115 SR_PRIV int sr_info(const char *format, ...);
116 SR_PRIV int sr_warn(const char *format, ...);
117 SR_PRIV int sr_err(const char *format, ...);
119 /*--- device.c --------------------------------------------------------------*/
121 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
122 gboolean enabled, const char *name);
124 /* Generic device instances */
125 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
126 const char *vendor, const char *model, const char *version);
127 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
129 #ifdef HAVE_LIBUSB_1_0
130 /* USB-specific instances */
131 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
132 uint8_t address, struct libusb_device_handle *hdl);
133 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
134 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
137 #ifdef HAVE_LIBSERIALPORT
138 /* Serial-specific instances */
139 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
140 const char *serialcomm);
141 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
144 /* USBTMC-specific instances */
145 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
146 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
148 /*--- hwdriver.c ------------------------------------------------------------*/
150 SR_PRIV void sr_hw_cleanup_all(void);
151 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
152 SR_PRIV void sr_config_free(struct sr_config *src);
153 SR_PRIV int sr_source_remove(int fd);
154 SR_PRIV int sr_source_add(int fd, int events, int timeout,
155 sr_receive_data_callback_t cb, void *cb_data);
157 /*--- session.c -------------------------------------------------------------*/
160 /** List of struct sr_dev pointers. */
162 /** List of struct datafeed_callback pointers. */
163 GSList *datafeed_callbacks;
167 unsigned int num_sources;
170 * Both "sources" and "pollfds" are of the same size and contain pairs
171 * of descriptor and callback function. We can not embed the GPollFD
172 * into the source struct since we want to be able to pass the array
173 * of all poll descriptors to g_poll().
175 struct source *sources;
180 * These are our synchronization primitives for stopping the session in
181 * an async fashion. We need to make sure the session is stopped from
182 * within the session thread itself.
184 /** Mutex protecting access to abort_session. */
186 /** Abort current session. See sr_session_stop(). */
187 gboolean abort_session;
190 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
191 const struct sr_datafeed_packet *packet);
192 SR_PRIV int sr_session_stop_sync(void);
193 SR_PRIV int sr_sessionfile_check(const char *filename);
195 /*--- std.c -----------------------------------------------------------------*/
197 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
198 typedef void (*std_dev_clear_t)(void *priv);
200 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
202 #ifdef HAVE_LIBSERIALPORT
203 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
204 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
205 void *cb_data, dev_close_t dev_close_fn,
206 struct sr_serial_dev_inst *serial, const char *prefix);
208 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
210 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
211 std_dev_clear_t clear_private);
212 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
214 /*--- strutil.c -------------------------------------------------------------*/
216 SR_PRIV int sr_atol(const char *str, long *ret);
217 SR_PRIV int sr_atoi(const char *str, int *ret);
218 SR_PRIV int sr_atod(const char *str, double *ret);
219 SR_PRIV int sr_atof(const char *str, float *ret);
221 /*--- hardware/common/serial.c ----------------------------------------------*/
223 #ifdef HAVE_LIBSERIALPORT
230 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
232 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
233 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
234 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
235 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
236 const void *buf, size_t count);
237 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
239 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
240 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
241 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
242 const char *paramstr);
243 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
244 int *buflen, gint64 timeout_ms);
245 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
246 uint8_t *buf, size_t *buflen,
247 size_t packet_size, packet_valid_t is_valid,
248 uint64_t timeout_ms, int baudrate);
249 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
250 const char **serial_options);
251 SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
252 int timeout, sr_receive_data_callback_t cb, void *cb_data);
253 SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
256 /*--- hardware/common/ezusb.c -----------------------------------------------*/
258 #ifdef HAVE_LIBUSB_1_0
259 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
260 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
261 const char *filename);
262 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
263 const char *filename);
266 /*--- hardware/common/usb.c -------------------------------------------------*/
268 #ifdef HAVE_LIBUSB_1_0
269 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
270 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
271 SR_PRIV int usb_source_add(struct sr_context *ctx, int timeout,
272 sr_receive_data_callback_t cb, void *cb_data);
273 SR_PRIV int usb_source_remove(struct sr_context *ctx);
276 /*--- hardware/common/scpi.c ------------------------------------------------*/
278 #define SCPI_CMD_IDN "*IDN?"
279 #define SCPI_CMD_OPC "*OPC?"
282 SCPI_CMD_SET_TRIGGER_SOURCE,
283 SCPI_CMD_SET_TIMEBASE,
284 SCPI_CMD_SET_VERTICAL_DIV,
285 SCPI_CMD_SET_TRIGGER_SLOPE,
286 SCPI_CMD_SET_COUPLING,
287 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
288 SCPI_CMD_GET_ANALOG_CHAN_STATE,
289 SCPI_CMD_GET_DIG_CHAN_STATE,
290 SCPI_CMD_GET_TIMEBASE,
291 SCPI_CMD_GET_VERTICAL_DIV,
292 SCPI_CMD_GET_VERTICAL_OFFSET,
293 SCPI_CMD_GET_TRIGGER_SOURCE,
294 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
295 SCPI_CMD_GET_TRIGGER_SLOPE,
296 SCPI_CMD_GET_COUPLING,
297 SCPI_CMD_SET_ANALOG_CHAN_STATE,
298 SCPI_CMD_SET_DIG_CHAN_STATE,
299 SCPI_CMD_GET_DIG_POD_STATE,
300 SCPI_CMD_SET_DIG_POD_STATE,
301 SCPI_CMD_GET_ANALOG_DATA,
302 SCPI_CMD_GET_DIG_DATA,
305 struct sr_scpi_hw_info {
309 char *firmware_version;
312 struct sr_scpi_dev_inst {
313 int (*open)(void *priv);
314 int (*source_add)(void *priv, int events,
315 int timeout, sr_receive_data_callback_t cb, void *cb_data);
316 int (*source_remove)(void *priv);
317 int (*send)(void *priv, const char *command);
318 int (*receive)(void *priv, char **scpi_response);
319 int (*read)(void *priv, char *buf, int maxlen);
320 int (*close)(void *priv);
321 void (*free)(void *priv);
325 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
326 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
327 int timeout, sr_receive_data_callback_t cb, void *cb_data);
328 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
329 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
330 const char *format, ...);
331 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
332 const char *format, va_list args);
333 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
334 char **scpi_response);
335 SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
336 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
337 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
339 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
340 const char *command, char **scpi_response);
341 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
342 const char *command, gboolean *scpi_response);
343 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
344 const char *command, int *scpi_response);
345 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
346 const char *command, float *scpi_response);
347 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
348 const char *command, double *scpi_response);
349 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
350 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
351 const char *command, GArray **scpi_response);
352 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
353 const char *command, GArray **scpi_response);
354 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
355 struct sr_scpi_hw_info **scpi_response);
356 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
358 /*--- hardware/common/scpi_serial.c -----------------------------------------*/
360 #ifdef HAVE_LIBSERIALPORT
361 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
362 const char *serialcomm);
365 /*--- hardware/common/scpi_tcp.c --------------------------------------------*/
367 SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
370 /*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/
372 SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);
374 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
376 #define ES51922_PACKET_SIZE 14
378 struct es51922_info {
379 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
380 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
381 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
382 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
383 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
384 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
387 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
388 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
389 struct sr_datafeed_analog *analog, void *info);
391 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
394 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
395 * so always read 2 blocks at a time.
397 #define ES519XX_11B_PACKET_SIZE (11 * 2)
398 #define ES519XX_14B_PACKET_SIZE 14
400 struct es519xx_info {
401 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
402 gboolean is_milli, is_resistance, is_continuity, is_diode;
403 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
404 gboolean is_temperature, is_celsius, is_fahrenheit;
405 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
406 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
407 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
408 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
411 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
414 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
415 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
416 struct sr_datafeed_analog *analog, void *info);
417 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
418 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
419 float *floatval, struct sr_datafeed_analog *analog, void *info);
420 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
421 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
422 float *floatval, struct sr_datafeed_analog *analog, void *info);
423 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
424 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
425 struct sr_datafeed_analog *analog, void *info);
426 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
427 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
428 struct sr_datafeed_analog *analog, void *info);
429 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
430 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
431 float *floatval, struct sr_datafeed_analog *analog, void *info);
433 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
435 #define FS9922_PACKET_SIZE 14
438 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
439 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
440 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
441 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
442 gboolean is_celsius, is_fahrenheit;
443 int bargraph_sign, bargraph_value;
446 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
447 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
448 struct sr_datafeed_analog *analog, void *info);
449 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
451 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
453 #define FS9721_PACKET_SIZE 14
456 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
457 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
458 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
459 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
462 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
463 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
464 struct sr_datafeed_analog *analog, void *info);
465 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
466 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
467 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
468 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
470 /*--- hardware/common/dmm/m2110.c -----------------------------------------*/
472 #define BBCGM_M2110_PACKET_SIZE 9
474 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
475 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
476 struct sr_datafeed_analog *analog, void *info);
478 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
480 #define METEX14_PACKET_SIZE 14
482 struct metex14_info {
483 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
484 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
485 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
486 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
487 gboolean is_unitless;
490 #ifdef HAVE_LIBSERIALPORT
491 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
493 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
494 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
495 struct sr_datafeed_analog *analog, void *info);
497 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
499 #define RS9LCD_PACKET_SIZE 9
501 /* Dummy info struct. The parser does not use it. */
502 struct rs9lcd_info { int dummy; };
504 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
505 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
506 struct sr_datafeed_analog *analog, void *info);