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)
47 #ifdef HAVE_LIBUSB_1_0
48 libusb_context *libusb_ctx;
52 #ifdef HAVE_LIBUSB_1_0
53 struct sr_usb_dev_inst {
56 struct libusb_device_handle *devhdl;
60 #define SERIAL_PARITY_NONE 0
61 #define SERIAL_PARITY_EVEN 1
62 #define SERIAL_PARITY_ODD 2
63 struct sr_serial_dev_inst {
69 /* Private driver context. */
71 struct sr_context *sr_ctx;
75 /*--- log.c -----------------------------------------------------------------*/
77 SR_PRIV int sr_log(int loglevel, const char *format, ...);
78 SR_PRIV int sr_spew(const char *format, ...);
79 SR_PRIV int sr_dbg(const char *format, ...);
80 SR_PRIV int sr_info(const char *format, ...);
81 SR_PRIV int sr_warn(const char *format, ...);
82 SR_PRIV int sr_err(const char *format, ...);
84 /*--- device.c --------------------------------------------------------------*/
86 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
87 gboolean enabled, const char *name);
89 /* Generic device instances */
90 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
91 const char *vendor, const char *model, const char *version);
92 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
94 #ifdef HAVE_LIBUSB_1_0
95 /* USB-specific instances */
96 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
97 uint8_t address, struct libusb_device_handle *hdl);
98 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
99 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
102 /* Serial-specific instances */
103 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
104 const char *serialcomm);
105 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
108 /*--- hwdriver.c ------------------------------------------------------------*/
110 SR_PRIV void sr_hw_cleanup_all(void);
111 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
112 SR_PRIV void sr_config_free(struct sr_config *src);
113 SR_PRIV int sr_source_remove(int fd);
114 SR_PRIV int sr_source_add(int fd, int events, int timeout,
115 sr_receive_data_callback_t cb, void *cb_data);
117 /*--- session.c -------------------------------------------------------------*/
119 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
120 const struct sr_datafeed_packet *packet);
121 SR_PRIV int sr_session_stop_sync(void);
123 /*--- std.c -----------------------------------------------------------------*/
125 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
126 typedef void (*std_dev_clear_t)(void *priv);
128 SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
130 SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
131 void *cb_data, dev_close_t hw_dev_close_fn,
132 struct sr_serial_dev_inst *serial, const char *prefix);
133 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
135 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
136 std_dev_clear_t clear_private);
138 /*--- hardware/common/serial.c ----------------------------------------------*/
146 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
148 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
149 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
150 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
151 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
152 const void *buf, size_t count);
153 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
155 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
156 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
157 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
158 const char *paramstr);
159 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
160 int *buflen, gint64 timeout_ms);
161 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
162 uint8_t *buf, size_t *buflen,
163 size_t packet_size, packet_valid_t is_valid,
164 uint64_t timeout_ms, int baudrate);
166 /*--- hardware/common/ezusb.c -----------------------------------------------*/
168 #ifdef HAVE_LIBUSB_1_0
169 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
170 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
171 const char *filename);
172 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
173 const char *filename);
176 /*--- hardware/common/usb.c -------------------------------------------------*/
178 #ifdef HAVE_LIBUSB_1_0
179 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
180 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
183 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
185 #define ES51922_PACKET_SIZE 14
187 struct es51922_info {
188 gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
189 gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
190 gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
191 gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
192 gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
193 gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
196 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
197 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
198 struct sr_datafeed_analog *analog, void *info);
200 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
202 #define FS9922_PACKET_SIZE 14
205 gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
206 gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
207 gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
208 gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
209 gboolean is_celsius, is_fahrenheit;
210 int bargraph_sign, bargraph_value;
213 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
214 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
215 struct sr_datafeed_analog *analog, void *info);
217 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
219 #define FS9721_PACKET_SIZE 14
222 gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
223 gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
224 gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
225 gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
228 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
229 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
230 struct sr_datafeed_analog *analog, void *info);
231 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
232 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
233 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
234 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
236 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
238 #define METEX14_PACKET_SIZE 14
240 struct metex14_info {
241 gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
242 gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
243 gboolean is_hertz, is_ohm, is_celsius, is_nano, is_micro, is_milli;
244 gboolean is_kilo, is_mega, is_gain, is_decibel, is_hfe, is_unitless;
247 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
248 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
249 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
250 struct sr_datafeed_analog *analog, void *info);
252 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
254 #define RS9LCD_PACKET_SIZE 9
256 /* Dummy info struct. The parser does not use it. */
257 struct rs9lcd_info { int dummy; };
259 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
260 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
261 struct sr_datafeed_analog *analog, void *info);