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/>.
20 #ifndef LIBSIGROK_SIGROK_INTERNAL_H
21 #define LIBSIGROK_SIGROK_INTERNAL_H
25 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
26 #ifdef HAVE_LIBUSB_1_0
29 #ifdef HAVE_LIBSERIALPORT
30 #include <libserialport.h>
36 * libsigrok private header file, only to be used internally.
39 /*--- Macros ----------------------------------------------------------------*/
42 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
45 #ifndef ARRAY_AND_SIZE
46 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
49 /* Portability fixes for FreeBSD. */
51 #define LIBUSB_CLASS_APPLICATION 0xfe
52 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
53 libusb_handle_events_timeout(ctx, tv)
57 #ifdef HAVE_LIBUSB_1_0
58 libusb_context *libusb_ctx;
62 #ifdef HAVE_LIBUSB_1_0
63 struct sr_usb_dev_inst {
66 struct libusb_device_handle *devhdl;
70 #ifdef HAVE_LIBSERIALPORT
71 #define SERIAL_PARITY_NONE SP_PARITY_NONE
72 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
73 #define SERIAL_PARITY_ODD SP_PARITY_ODD
74 struct sr_serial_dev_inst {
82 struct sr_usbtmc_dev_inst {
87 /* Private driver context. */
89 struct sr_context *sr_ctx;
93 /*--- log.c -----------------------------------------------------------------*/
95 SR_PRIV int sr_log(int loglevel, const char *format, ...);
96 SR_PRIV int sr_spew(const char *format, ...);
97 SR_PRIV int sr_dbg(const char *format, ...);
98 SR_PRIV int sr_info(const char *format, ...);
99 SR_PRIV int sr_warn(const char *format, ...);
100 SR_PRIV int sr_err(const char *format, ...);
102 /*--- device.c --------------------------------------------------------------*/
104 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
105 gboolean enabled, const char *name);
107 /* Generic device instances */
108 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
109 const char *vendor, const char *model, const char *version);
110 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
112 #ifdef HAVE_LIBUSB_1_0
113 /* USB-specific instances */
114 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
115 uint8_t address, struct libusb_device_handle *hdl);
116 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
117 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
120 #ifdef HAVE_LIBSERIALPORT
121 /* Serial-specific instances */
122 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
123 const char *serialcomm);
124 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
127 /* USBTMC-specific instances */
128 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
129 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
131 /*--- hwdriver.c ------------------------------------------------------------*/
133 SR_PRIV void sr_hw_cleanup_all(void);
134 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
135 SR_PRIV void sr_config_free(struct sr_config *src);
136 SR_PRIV int sr_source_remove(int fd);
137 SR_PRIV int sr_source_add(int fd, int events, int timeout,
138 sr_receive_data_callback_t cb, void *cb_data);
140 /*--- session.c -------------------------------------------------------------*/
143 /** List of struct sr_dev pointers. */
145 /** List of struct datafeed_callback pointers. */
146 GSList *datafeed_callbacks;
150 unsigned int num_sources;
153 * Both "sources" and "pollfds" are of the same size and contain pairs
154 * of descriptor and callback function. We can not embed the GPollFD
155 * into the source struct since we want to be able to pass the array
156 * of all poll descriptors to g_poll().
158 struct source *sources;
163 * These are our synchronization primitives for stopping the session in
164 * an async fashion. We need to make sure the session is stopped from
165 * within the session thread itself.
168 gboolean abort_session;
171 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
172 const struct sr_datafeed_packet *packet);
173 SR_PRIV int sr_session_stop_sync(void);
174 SR_PRIV int sr_sessionfile_check(const char *filename);
176 /*--- std.c -----------------------------------------------------------------*/
178 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
179 typedef void (*std_dev_clear_t)(void *priv);
181 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
183 #ifdef HAVE_LIBSERIALPORT
184 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
185 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
186 void *cb_data, dev_close_t dev_close_fn,
187 struct sr_serial_dev_inst *serial, const char *prefix);
189 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
191 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
192 std_dev_clear_t clear_private);
193 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
195 /*--- strutil.c -------------------------------------------------------------*/
197 SR_PRIV int sr_atol(const char *str, long *ret);
198 SR_PRIV int sr_atoi(const char *str, int *ret);
199 SR_PRIV int sr_atod(const char *str, double *ret);
200 SR_PRIV int sr_atof(const char *str, float *ret);
202 /*--- hardware/common/serial.c ----------------------------------------------*/
204 #ifdef HAVE_LIBSERIALPORT
211 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
213 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
214 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
215 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
216 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
217 const void *buf, size_t count);
218 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
220 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
221 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
222 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
223 const char *paramstr);
224 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
225 int *buflen, gint64 timeout_ms);
226 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
227 uint8_t *buf, size_t *buflen,
228 size_t packet_size, packet_valid_t is_valid,
229 uint64_t timeout_ms, int baudrate);
230 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
231 const char **serial_options);
232 SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
233 int timeout, sr_receive_data_callback_t cb, void *cb_data);
234 SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
237 /*--- hardware/common/ezusb.c -----------------------------------------------*/
239 #ifdef HAVE_LIBUSB_1_0
240 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
241 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
242 const char *filename);
243 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
244 const char *filename);
247 /*--- hardware/common/usb.c -------------------------------------------------*/
249 #ifdef HAVE_LIBUSB_1_0
250 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
251 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
254 /*--- hardware/common/scpi.c ------------------------------------------------*/
256 #define SCPI_CMD_IDN "*IDN?"
257 #define SCPI_CMD_OPC "*OPC?"
260 SCPI_CMD_SET_TRIGGER_SOURCE,
261 SCPI_CMD_SET_TIMEBASE,
262 SCPI_CMD_SET_VERTICAL_DIV,
263 SCPI_CMD_SET_TRIGGER_SLOPE,
264 SCPI_CMD_SET_COUPLING,
265 SCPI_CMD_SET_HORIZ_TRIGGERPOS,
266 SCPI_CMD_GET_ANALOG_CHAN_STATE,
267 SCPI_CMD_GET_DIG_CHAN_STATE,
268 SCPI_CMD_GET_TIMEBASE,
269 SCPI_CMD_GET_VERTICAL_DIV,
270 SCPI_CMD_GET_VERTICAL_OFFSET,
271 SCPI_CMD_GET_TRIGGER_SOURCE,
272 SCPI_CMD_GET_HORIZ_TRIGGERPOS,
273 SCPI_CMD_GET_TRIGGER_SLOPE,
274 SCPI_CMD_GET_COUPLING,
275 SCPI_CMD_SET_ANALOG_CHAN_STATE,
276 SCPI_CMD_SET_DIG_CHAN_STATE,
277 SCPI_CMD_GET_DIG_POD_STATE,
278 SCPI_CMD_SET_DIG_POD_STATE,
279 SCPI_CMD_GET_ANALOG_DATA,
280 SCPI_CMD_GET_DIG_DATA,
283 struct sr_scpi_hw_info {
287 char *firmware_version;
290 struct sr_scpi_dev_inst {
291 int (*open)(void *priv);
292 int (*source_add)(void *priv, int events,
293 int timeout, sr_receive_data_callback_t cb, void *cb_data);
294 int (*source_remove)(void *priv);
295 int (*send)(void *priv, const char *command);
296 int (*receive)(void *priv, char **scpi_response);
297 int (*read)(void *priv, char *buf, int maxlen);
298 int (*close)(void *priv);
299 void (*free)(void *priv);
303 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
304 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
305 int timeout, sr_receive_data_callback_t cb, void *cb_data);
306 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
307 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
308 const char *format, ...);
309 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
310 const char *format, va_list args);
311 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
312 char **scpi_response);
313 SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
314 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
315 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
317 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
318 const char *command, char **scpi_response);
319 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
320 const char *command, gboolean *scpi_response);
321 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
322 const char *command, int *scpi_response);
323 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
324 const char *command, float *scpi_response);
325 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
326 const char *command, double *scpi_response);
327 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
328 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
329 const char *command, GArray **scpi_response);
330 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
331 const char *command, GArray **scpi_response);
332 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
333 struct sr_scpi_hw_info **scpi_response);
334 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
336 /*--- hardware/common/scpi_serial.c -----------------------------------------*/
338 #ifdef HAVE_LIBSERIALPORT
339 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
340 const char *serialcomm);
343 /*--- hardware/common/scpi_tcp.c --------------------------------------------*/
345 SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
348 /*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/
350 SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);
352 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
354 #define ES51922_PACKET_SIZE 14
356 struct es51922_info {
357 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
358 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
359 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
360 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
361 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
362 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
365 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
366 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
367 struct sr_datafeed_analog *analog, void *info);
369 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
372 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
373 * so always read 2 blocks at a time.
375 #define ES519XX_11B_PACKET_SIZE (11 * 2)
376 #define ES519XX_14B_PACKET_SIZE 14
378 struct es519xx_info {
379 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
380 gboolean is_milli, is_resistance, is_continuity, is_diode;
381 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
382 gboolean is_temperature, is_celsius, is_fahrenheit;
383 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
384 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
385 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
386 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
389 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
392 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
393 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
394 struct sr_datafeed_analog *analog, void *info);
395 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
396 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
397 float *floatval, struct sr_datafeed_analog *analog, void *info);
398 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
399 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
400 float *floatval, struct sr_datafeed_analog *analog, void *info);
401 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
402 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
403 struct sr_datafeed_analog *analog, void *info);
404 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
405 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
406 struct sr_datafeed_analog *analog, void *info);
407 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
408 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
409 float *floatval, struct sr_datafeed_analog *analog, void *info);
411 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
413 #define FS9922_PACKET_SIZE 14
416 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
417 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
418 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
419 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
420 gboolean is_celsius, is_fahrenheit;
421 int bargraph_sign, bargraph_value;
424 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
425 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
426 struct sr_datafeed_analog *analog, void *info);
427 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
429 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
431 #define FS9721_PACKET_SIZE 14
434 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
435 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
436 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
437 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
440 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
441 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
442 struct sr_datafeed_analog *analog, void *info);
443 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
444 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
445 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
446 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
448 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
450 #define METEX14_PACKET_SIZE 14
452 struct metex14_info {
453 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
454 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
455 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
456 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
457 gboolean is_unitless;
460 #ifdef HAVE_LIBSERIALPORT
461 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
463 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
464 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
465 struct sr_datafeed_analog *analog, void *info);
467 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
469 #define RS9LCD_PACKET_SIZE 9
471 /* Dummy info struct. The parser does not use it. */
472 struct rs9lcd_info { int dummy; };
474 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
475 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
476 struct sr_datafeed_analog *analog, void *info);