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
33 * libsigrok private header file, only to be used internally.
36 /*--- Macros ----------------------------------------------------------------*/
39 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
42 #ifndef ARRAY_AND_SIZE
43 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
46 /* Portability fixes for FreeBSD. */
48 #define LIBUSB_CLASS_APPLICATION 0xfe
49 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
50 libusb_handle_events_timeout(ctx, tv)
54 #ifdef HAVE_LIBUSB_1_0
55 libusb_context *libusb_ctx;
59 #ifdef HAVE_LIBUSB_1_0
60 struct sr_usb_dev_inst {
63 struct libusb_device_handle *devhdl;
67 #define SERIAL_PARITY_NONE 0
68 #define SERIAL_PARITY_EVEN 1
69 #define SERIAL_PARITY_ODD 2
70 struct sr_serial_dev_inst {
76 /* Private driver context. */
78 struct sr_context *sr_ctx;
82 /*--- log.c -----------------------------------------------------------------*/
84 SR_PRIV int sr_log(int loglevel, const char *format, ...);
85 SR_PRIV int sr_spew(const char *format, ...);
86 SR_PRIV int sr_dbg(const char *format, ...);
87 SR_PRIV int sr_info(const char *format, ...);
88 SR_PRIV int sr_warn(const char *format, ...);
89 SR_PRIV int sr_err(const char *format, ...);
91 /*--- device.c --------------------------------------------------------------*/
93 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
94 gboolean enabled, const char *name);
96 /* Generic device instances */
97 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
98 const char *vendor, const char *model, const char *version);
99 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
101 #ifdef HAVE_LIBUSB_1_0
102 /* USB-specific instances */
103 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
104 uint8_t address, struct libusb_device_handle *hdl);
105 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
106 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
109 /* Serial-specific instances */
110 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
111 const char *serialcomm);
112 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
115 /*--- hwdriver.c ------------------------------------------------------------*/
117 SR_PRIV void sr_hw_cleanup_all(void);
118 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
119 SR_PRIV void sr_config_free(struct sr_config *src);
120 SR_PRIV int sr_source_remove(int fd);
121 SR_PRIV int sr_source_add(int fd, int events, int timeout,
122 sr_receive_data_callback_t cb, void *cb_data);
124 /*--- session.c -------------------------------------------------------------*/
126 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
127 const struct sr_datafeed_packet *packet);
128 SR_PRIV int sr_session_stop_sync(void);
129 SR_PRIV int sr_sessionfile_check(const char *filename);
131 /*--- std.c -----------------------------------------------------------------*/
133 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
134 typedef void (*std_dev_clear_t)(void *priv);
136 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
138 SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
139 void *cb_data, dev_close_t dev_close_fn,
140 struct sr_serial_dev_inst *serial, const char *prefix);
141 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
143 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
144 std_dev_clear_t clear_private);
146 /*--- hardware/common/serial.c ----------------------------------------------*/
154 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
156 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
157 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
158 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
159 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
160 const void *buf, size_t count);
161 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
163 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
164 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
165 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
166 const char *paramstr);
167 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
168 int *buflen, gint64 timeout_ms);
169 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
170 uint8_t *buf, size_t *buflen,
171 size_t packet_size, packet_valid_t is_valid,
172 uint64_t timeout_ms, int baudrate);
174 /*--- hardware/common/ezusb.c -----------------------------------------------*/
176 #ifdef HAVE_LIBUSB_1_0
177 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
178 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
179 const char *filename);
180 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
181 const char *filename);
184 /*--- hardware/common/usb.c -------------------------------------------------*/
186 #ifdef HAVE_LIBUSB_1_0
187 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
188 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
191 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
193 #define ES51922_PACKET_SIZE 14
195 struct es51922_info {
196 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
197 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
198 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
199 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
200 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
201 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
204 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
205 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
206 struct sr_datafeed_analog *analog, void *info);
208 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
211 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
212 * so always read 2 blocks at a time.
214 #define ES519XX_11B_PACKET_SIZE (11 * 2)
215 #define ES519XX_14B_PACKET_SIZE 14
217 struct es519xx_info {
218 gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
219 gboolean is_milli, is_resistance, is_continuity, is_diode;
220 gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
221 gboolean is_temperature, is_celsius, is_fahrenheit;
222 gboolean is_adp0, is_adp1, is_adp2, is_adp3;
223 gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
224 gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
225 gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
228 gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
231 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
232 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
233 struct sr_datafeed_analog *analog, void *info);
234 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
235 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
236 float *floatval, struct sr_datafeed_analog *analog, void *info);
237 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
238 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
239 float *floatval, struct sr_datafeed_analog *analog, void *info);
240 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
241 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
242 struct sr_datafeed_analog *analog, void *info);
243 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
244 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
245 struct sr_datafeed_analog *analog, void *info);
246 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
247 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
248 float *floatval, struct sr_datafeed_analog *analog, void *info);
250 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
252 #define FS9922_PACKET_SIZE 14
255 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
256 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
257 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
258 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
259 gboolean is_celsius, is_fahrenheit;
260 int bargraph_sign, bargraph_value;
263 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
264 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
265 struct sr_datafeed_analog *analog, void *info);
266 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
268 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
270 #define FS9721_PACKET_SIZE 14
273 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
274 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
275 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
276 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
279 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
280 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
281 struct sr_datafeed_analog *analog, void *info);
282 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
283 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
284 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
285 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
287 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
289 #define METEX14_PACKET_SIZE 14
291 struct metex14_info {
292 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
293 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
294 gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
295 gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
296 gboolean is_unitless;
299 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
300 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
301 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
302 struct sr_datafeed_analog *analog, void *info);
304 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
306 #define RS9LCD_PACKET_SIZE 9
308 /* Dummy info struct. The parser does not use it. */
309 struct rs9lcd_info { int dummy; };
311 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
312 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
313 struct sr_datafeed_analog *analog, void *info);