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_SIGROK_INTERNAL_H
25 #define LIBSIGROK_SIGROK_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 {
69 uint8_t bus; /**< USB bus */
70 uint8_t address; /**< Device address on USB bus */
71 struct libusb_device_handle *devhdl; /**< libusb device handle */
75 #ifdef HAVE_LIBSERIALPORT
76 #define SERIAL_PARITY_NONE SP_PARITY_NONE
77 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
78 #define SERIAL_PARITY_ODD SP_PARITY_ODD
79 struct sr_serial_dev_inst {
80 char *port; /**< Port name, e.g. '/dev/tty42'. */
81 char *serialcomm; /**< Comm params for serial_set_paramstr(). */
83 struct sp_port *data; /**< libserialport port handle */
87 struct sr_usbtmc_dev_inst {
92 /* Private driver context. */
94 struct sr_context *sr_ctx; /**< sigrok context */
98 /*--- log.c -----------------------------------------------------------------*/
100 SR_PRIV int sr_log(int loglevel, const char *format, ...);
101 SR_PRIV int sr_spew(const char *format, ...);
102 SR_PRIV int sr_dbg(const char *format, ...);
103 SR_PRIV int sr_info(const char *format, ...);
104 SR_PRIV int sr_warn(const char *format, ...);
105 SR_PRIV int sr_err(const char *format, ...);
107 /*--- device.c --------------------------------------------------------------*/
109 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
110 gboolean enabled, const char *name);
112 /* Generic device instances */
113 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
114 const char *vendor, const char *model, const char *version);
115 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
117 #ifdef HAVE_LIBUSB_1_0
118 /* USB-specific instances */
119 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
120 uint8_t address, struct libusb_device_handle *hdl);
121 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
122 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
125 #ifdef HAVE_LIBSERIALPORT
126 /* Serial-specific instances */
127 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
128 const char *serialcomm);
129 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
132 /* USBTMC-specific instances */
133 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
134 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
136 /*--- hwdriver.c ------------------------------------------------------------*/
138 SR_PRIV void sr_hw_cleanup_all(void);
139 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
140 SR_PRIV void sr_config_free(struct sr_config *src);
141 SR_PRIV int sr_source_remove(int fd);
142 SR_PRIV int sr_source_add(int fd, int events, int timeout,
143 sr_receive_data_callback_t cb, void *cb_data);
145 /*--- session.c -------------------------------------------------------------*/
148 /** List of struct sr_dev pointers. */
150 /** List of struct datafeed_callback pointers. */
151 GSList *datafeed_callbacks;
155 unsigned int num_sources;
158 * Both "sources" and "pollfds" are of the same size and contain pairs
159 * of descriptor and callback function. We can not embed the GPollFD
160 * into the source struct since we want to be able to pass the array
161 * of all poll descriptors to g_poll().
163 struct source *sources;
168 * These are our synchronization primitives for stopping the session in
169 * an async fashion. We need to make sure the session is stopped from
170 * within the session thread itself.
172 GMutex stop_mutex; /**< Mutex protecting access to abort_session. */
173 gboolean abort_session;
174 /**< Abort current session. See sr_session_stop(). */
177 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
178 const struct sr_datafeed_packet *packet);
179 SR_PRIV int sr_session_stop_sync(void);
180 SR_PRIV int sr_sessionfile_check(const char *filename);
182 /*--- std.c -----------------------------------------------------------------*/
184 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
185 typedef void (*std_dev_clear_t)(void *priv);
187 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
189 #ifdef HAVE_LIBSERIALPORT
190 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
191 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
192 void *cb_data, dev_close_t dev_close_fn,
193 struct sr_serial_dev_inst *serial, const char *prefix);
195 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
197 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
198 std_dev_clear_t clear_private);
199 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
201 /*--- strutil.c -------------------------------------------------------------*/
203 SR_PRIV int sr_atol(const char *str, long *ret);
204 SR_PRIV int sr_atoi(const char *str, int *ret);
205 SR_PRIV int sr_atod(const char *str, double *ret);
206 SR_PRIV int sr_atof(const char *str, float *ret);
208 /*--- hardware/common/serial.c ----------------------------------------------*/
210 #ifdef HAVE_LIBSERIALPORT
217 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
219 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
220 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
221 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
222 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
223 const void *buf, size_t count);
224 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
226 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
227 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
228 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
229 const char *paramstr);
230 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
231 int *buflen, gint64 timeout_ms);
232 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
233 uint8_t *buf, size_t *buflen,
234 size_t packet_size, packet_valid_t is_valid,
235 uint64_t timeout_ms, int baudrate);
236 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
237 const char **serial_options);
238 SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
239 int timeout, sr_receive_data_callback_t cb, void *cb_data);
240 SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
243 /*--- hardware/common/ezusb.c -----------------------------------------------*/
245 #ifdef HAVE_LIBUSB_1_0
246 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
247 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
248 const char *filename);
249 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
250 const char *filename);
253 /*--- hardware/common/usb.c -------------------------------------------------*/
255 #ifdef HAVE_LIBUSB_1_0
256 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
257 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
260 /*--- hardware/common/scpi.c ------------------------------------------------*/
262 #define SCPI_CMD_IDN "*IDN?"
263 #define SCPI_CMD_OPC "*OPC?"
266 SCPI_CMD_SET_TRIGGER_SOURCE,
267 SCPI_CMD_SET_TIMEBASE,
268 SCPI_CMD_SET_VERTICAL_DIV,
269 SCPI_CMD_SET_TRIGGER_SLOPE,
270 SCPI_CMD_SET_COUPLING,
271 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
272 SCPI_CMD_GET_ANALOG_CHAN_STATE,
273 SCPI_CMD_GET_DIG_CHAN_STATE,
274 SCPI_CMD_GET_TIMEBASE,
275 SCPI_CMD_GET_VERTICAL_DIV,
276 SCPI_CMD_GET_VERTICAL_OFFSET,
277 SCPI_CMD_GET_TRIGGER_SOURCE,
278 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
279 SCPI_CMD_GET_TRIGGER_SLOPE,
280 SCPI_CMD_GET_COUPLING,
281 SCPI_CMD_SET_ANALOG_CHAN_STATE,
282 SCPI_CMD_SET_DIG_CHAN_STATE,
283 SCPI_CMD_GET_DIG_POD_STATE,
284 SCPI_CMD_SET_DIG_POD_STATE,
285 SCPI_CMD_GET_ANALOG_DATA,
286 SCPI_CMD_GET_DIG_DATA,
289 struct sr_scpi_hw_info {
293 char *firmware_version;
296 struct sr_scpi_dev_inst {
297 int (*open)(void *priv);
298 int (*source_add)(void *priv, int events,
299 int timeout, sr_receive_data_callback_t cb, void *cb_data);
300 int (*source_remove)(void *priv);
301 int (*send)(void *priv, const char *command);
302 int (*receive)(void *priv, char **scpi_response);
303 int (*read)(void *priv, char *buf, int maxlen);
304 int (*close)(void *priv);
305 void (*free)(void *priv);
309 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
310 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
311 int timeout, sr_receive_data_callback_t cb, void *cb_data);
312 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
313 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
314 const char *format, ...);
315 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
316 const char *format, va_list args);
317 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
318 char **scpi_response);
319 SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
320 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
321 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
323 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
324 const char *command, char **scpi_response);
325 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
326 const char *command, gboolean *scpi_response);
327 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
328 const char *command, int *scpi_response);
329 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
330 const char *command, float *scpi_response);
331 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
332 const char *command, double *scpi_response);
333 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
334 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
335 const char *command, GArray **scpi_response);
336 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
337 const char *command, GArray **scpi_response);
338 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
339 struct sr_scpi_hw_info **scpi_response);
340 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
342 /*--- hardware/common/scpi_serial.c -----------------------------------------*/
344 #ifdef HAVE_LIBSERIALPORT
345 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
346 const char *serialcomm);
349 /*--- hardware/common/scpi_tcp.c --------------------------------------------*/
351 SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
354 /*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/
356 SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);
358 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
360 #define ES51922_PACKET_SIZE 14
362 struct es51922_info {
363 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
364 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
365 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
366 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
367 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
368 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
371 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
372 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
373 struct sr_datafeed_analog *analog, void *info);
375 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
378 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
379 * so always read 2 blocks at a time.
381 #define ES519XX_11B_PACKET_SIZE (11 * 2)
382 #define ES519XX_14B_PACKET_SIZE 14
384 struct es519xx_info {
385 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
386 gboolean is_milli, is_resistance, is_continuity, is_diode;
387 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
388 gboolean is_temperature, is_celsius, is_fahrenheit;
389 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
390 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
391 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
392 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
395 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
398 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
399 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
400 struct sr_datafeed_analog *analog, void *info);
401 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
402 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
403 float *floatval, struct sr_datafeed_analog *analog, void *info);
404 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
405 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
406 float *floatval, struct sr_datafeed_analog *analog, void *info);
407 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
408 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
409 struct sr_datafeed_analog *analog, void *info);
410 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
411 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
412 struct sr_datafeed_analog *analog, void *info);
413 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
414 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
415 float *floatval, struct sr_datafeed_analog *analog, void *info);
417 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
419 #define FS9922_PACKET_SIZE 14
422 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
423 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
424 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
425 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
426 gboolean is_celsius, is_fahrenheit;
427 int bargraph_sign, bargraph_value;
430 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
431 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
432 struct sr_datafeed_analog *analog, void *info);
433 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
435 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
437 #define FS9721_PACKET_SIZE 14
440 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
441 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
442 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
443 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
446 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
447 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
448 struct sr_datafeed_analog *analog, void *info);
449 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
450 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
451 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
452 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
454 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
456 #define METEX14_PACKET_SIZE 14
458 struct metex14_info {
459 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
460 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
461 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
462 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
463 gboolean is_unitless;
466 #ifdef HAVE_LIBSERIALPORT
467 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
469 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
470 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
471 struct sr_datafeed_analog *analog, void *info);
473 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
475 #define RS9LCD_PACKET_SIZE 9
477 /* Dummy info struct. The parser does not use it. */
478 struct rs9lcd_info { int dummy; };
480 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
481 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
482 struct sr_datafeed_analog *analog, void *info);