]>
Commit | Line | Data |
---|---|---|
1483577e | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
1483577e | 3 | * |
13d8e03c | 4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> |
1483577e UH |
5 | * |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
0f8522bf UH |
20 | #ifndef LIBSIGROK_SIGROK_INTERNAL_H |
21 | #define LIBSIGROK_SIGROK_INTERNAL_H | |
1483577e | 22 | |
b08024a8 | 23 | #include <stdarg.h> |
cc8a7d25 | 24 | #include <glib.h> |
1a081ca6 | 25 | #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ |
69890f73 UH |
26 | #ifdef HAVE_LIBUSB_1_0 |
27 | #include <libusb.h> | |
28 | #endif | |
c4f2dfd0 | 29 | #ifdef HAVE_LIBSERIALPORT |
dc991353 | 30 | #include <libserialport.h> |
c4f2dfd0 | 31 | #endif |
b08024a8 | 32 | |
393fb9cb UH |
33 | /** |
34 | * @file | |
35 | * | |
36 | * libsigrok private header file, only to be used internally. | |
37 | */ | |
38 | ||
4cea9eb2 UH |
39 | /*--- Macros ----------------------------------------------------------------*/ |
40 | ||
41 | #ifndef ARRAY_SIZE | |
42 | #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) | |
43 | #endif | |
44 | ||
45 | #ifndef ARRAY_AND_SIZE | |
46 | #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) | |
47 | #endif | |
48 | ||
6bf4273e UH |
49 | /* Portability fixes for FreeBSD. */ |
50 | #ifdef __FreeBSD__ | |
51 | #define LIBUSB_CLASS_APPLICATION 0xfe | |
52 | #define libusb_handle_events_timeout_completed(ctx, tv, c) \ | |
53 | libusb_handle_events_timeout(ctx, tv) | |
54 | #endif | |
55 | ||
b8072700 | 56 | struct sr_context { |
785b9ff2 PS |
57 | #ifdef HAVE_LIBUSB_1_0 |
58 | libusb_context *libusb_ctx; | |
59 | #endif | |
b8072700 PS |
60 | }; |
61 | ||
69890f73 | 62 | #ifdef HAVE_LIBUSB_1_0 |
d68e2d1a | 63 | struct sr_usb_dev_inst { |
69890f73 UH |
64 | uint8_t bus; |
65 | uint8_t address; | |
66 | struct libusb_device_handle *devhdl; | |
67 | }; | |
68 | #endif | |
69 | ||
c4f2dfd0 | 70 | #ifdef HAVE_LIBSERIALPORT |
a9bce5a5 ML |
71 | #define SERIAL_PARITY_NONE SP_PARITY_NONE |
72 | #define SERIAL_PARITY_EVEN SP_PARITY_EVEN | |
73 | #define SERIAL_PARITY_ODD SP_PARITY_ODD | |
d68e2d1a | 74 | struct sr_serial_dev_inst { |
69890f73 | 75 | char *port; |
299bdb24 | 76 | char *serialcomm; |
69890f73 | 77 | int fd; |
c9bc57b6 | 78 | struct sp_port *data; |
69890f73 | 79 | }; |
c4f2dfd0 | 80 | #endif |
69890f73 | 81 | |
026c822d UH |
82 | /* Private driver context. */ |
83 | struct drv_context { | |
1ebe4b4e | 84 | struct sr_context *sr_ctx; |
026c822d UH |
85 | GSList *instances; |
86 | }; | |
87 | ||
48a486cd BV |
88 | /*--- log.c -----------------------------------------------------------------*/ |
89 | ||
90 | SR_PRIV int sr_log(int loglevel, const char *format, ...); | |
91 | SR_PRIV int sr_spew(const char *format, ...); | |
92 | SR_PRIV int sr_dbg(const char *format, ...); | |
93 | SR_PRIV int sr_info(const char *format, ...); | |
94 | SR_PRIV int sr_warn(const char *format, ...); | |
95 | SR_PRIV int sr_err(const char *format, ...); | |
96 | ||
97 | /*--- device.c --------------------------------------------------------------*/ | |
98 | ||
99 | SR_PRIV struct sr_probe *sr_probe_new(int index, int type, | |
100 | gboolean enabled, const char *name); | |
101 | ||
102 | /* Generic device instances */ | |
103 | SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, | |
104 | const char *vendor, const char *model, const char *version); | |
105 | SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi); | |
48a486cd | 106 | |
545f9786 | 107 | #ifdef HAVE_LIBUSB_1_0 |
69890f73 | 108 | /* USB-specific instances */ |
d68e2d1a | 109 | SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, |
69890f73 | 110 | uint8_t address, struct libusb_device_handle *hdl); |
91162629 | 111 | SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx); |
d68e2d1a | 112 | SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb); |
69890f73 UH |
113 | #endif |
114 | ||
c4f2dfd0 | 115 | #ifdef HAVE_LIBSERIALPORT |
69890f73 | 116 | /* Serial-specific instances */ |
299bdb24 BV |
117 | SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, |
118 | const char *serialcomm); | |
d68e2d1a | 119 | SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial); |
c4f2dfd0 | 120 | #endif |
69890f73 | 121 | |
b08024a8 | 122 | |
c09f0b57 | 123 | /*--- hwdriver.c ------------------------------------------------------------*/ |
996b0c72 | 124 | |
93a04e3b | 125 | SR_PRIV void sr_hw_cleanup_all(void); |
bc1c2f00 | 126 | SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data); |
722db131 | 127 | SR_PRIV void sr_config_free(struct sr_config *src); |
48a486cd BV |
128 | SR_PRIV int sr_source_remove(int fd); |
129 | SR_PRIV int sr_source_add(int fd, int events, int timeout, | |
ae5859ff | 130 | sr_receive_data_callback_t cb, void *cb_data); |
996b0c72 | 131 | |
a1645fcd BV |
132 | /*--- session.c -------------------------------------------------------------*/ |
133 | ||
e2b23821 UH |
134 | struct sr_session { |
135 | /** List of struct sr_dev pointers. */ | |
136 | GSList *devs; | |
137 | /** List of struct datafeed_callback pointers. */ | |
138 | GSList *datafeed_callbacks; | |
139 | GTimeVal starttime; | |
140 | gboolean running; | |
141 | ||
142 | unsigned int num_sources; | |
143 | ||
144 | /* | |
145 | * Both "sources" and "pollfds" are of the same size and contain pairs | |
146 | * of descriptor and callback function. We can not embed the GPollFD | |
147 | * into the source struct since we want to be able to pass the array | |
148 | * of all poll descriptors to g_poll(). | |
149 | */ | |
150 | struct source *sources; | |
151 | GPollFD *pollfds; | |
152 | int source_timeout; | |
153 | ||
154 | /* | |
155 | * These are our synchronization primitives for stopping the session in | |
156 | * an async fashion. We need to make sure the session is stopped from | |
157 | * within the session thread itself. | |
158 | */ | |
159 | GMutex stop_mutex; | |
160 | gboolean abort_session; | |
161 | }; | |
162 | ||
de4d3f99 | 163 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, |
ae5859ff | 164 | const struct sr_datafeed_packet *packet); |
33c6e4c5 | 165 | SR_PRIV int sr_session_stop_sync(void); |
f438e0c9 | 166 | SR_PRIV int sr_sessionfile_check(const char *filename); |
a1645fcd | 167 | |
063e7aef UH |
168 | /*--- std.c -----------------------------------------------------------------*/ |
169 | ||
cd2f0fe2 | 170 | typedef int (*dev_close_t)(struct sr_dev_inst *sdi); |
ae5859ff | 171 | typedef void (*std_dev_clear_t)(void *priv); |
cd2f0fe2 | 172 | |
f6beaac5 | 173 | SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, |
ae5859ff | 174 | const char *prefix); |
c4f2dfd0 | 175 | #ifdef HAVE_LIBSERIALPORT |
f6beaac5 | 176 | SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi, |
6078d2c9 | 177 | void *cb_data, dev_close_t dev_close_fn, |
ae5859ff | 178 | struct sr_serial_dev_inst *serial, const char *prefix); |
c4f2dfd0 | 179 | #endif |
4afdfd46 | 180 | SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, |
ae5859ff BV |
181 | const char *prefix); |
182 | SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, | |
183 | std_dev_clear_t clear_private); | |
4afdfd46 | 184 | |
058b7035 UH |
185 | /*--- hardware/common/serial.c ----------------------------------------------*/ |
186 | ||
c4f2dfd0 | 187 | #ifdef HAVE_LIBSERIALPORT |
a54dd31e UH |
188 | enum { |
189 | SERIAL_RDWR = 1, | |
190 | SERIAL_RDONLY = 2, | |
191 | SERIAL_NONBLOCK = 4, | |
192 | }; | |
193 | ||
766456be UH |
194 | typedef gboolean (*packet_valid_t)(const uint8_t *buf); |
195 | ||
299bdb24 BV |
196 | SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags); |
197 | SR_PRIV int serial_close(struct sr_serial_dev_inst *serial); | |
198 | SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial); | |
199 | SR_PRIV int serial_write(struct sr_serial_dev_inst *serial, | |
200 | const void *buf, size_t count); | |
201 | SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf, | |
202 | size_t count); | |
203 | SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, | |
71caaad4 | 204 | int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr); |
299bdb24 BV |
205 | SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial, |
206 | const char *paramstr); | |
207 | SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf, | |
208 | int *buflen, gint64 timeout_ms); | |
766456be UH |
209 | SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, |
210 | uint8_t *buf, size_t *buflen, | |
211 | size_t packet_size, packet_valid_t is_valid, | |
212 | uint64_t timeout_ms, int baudrate); | |
c4f2dfd0 | 213 | #endif |
1483577e | 214 | |
058b7035 UH |
215 | /*--- hardware/common/ezusb.c -----------------------------------------------*/ |
216 | ||
22b02383 | 217 | #ifdef HAVE_LIBUSB_1_0 |
1a081ca6 UH |
218 | SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear); |
219 | SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl, | |
220 | const char *filename); | |
221 | SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration, | |
222 | const char *filename); | |
22b02383 | 223 | #endif |
058b7035 | 224 | |
0c632d36 UH |
225 | /*--- hardware/common/usb.c -------------------------------------------------*/ |
226 | ||
227 | #ifdef HAVE_LIBUSB_1_0 | |
7ae6a758 | 228 | SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn); |
0c632d36 UH |
229 | SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb); |
230 | #endif | |
231 | ||
fe0c0b98 UH |
232 | /*--- hardware/common/dmm/es51922.c -----------------------------------------*/ |
233 | ||
234 | #define ES51922_PACKET_SIZE 14 | |
235 | ||
236 | struct es51922_info { | |
237 | gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current; | |
238 | gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf; | |
239 | gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature; | |
240 | gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol; | |
241 | gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin; | |
242 | gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega; | |
243 | }; | |
244 | ||
245 | SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf); | |
246 | SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval, | |
247 | struct sr_datafeed_analog *analog, void *info); | |
248 | ||
c01bdebc AJ |
249 | /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/ |
250 | ||
bfb926c1 AJ |
251 | /** |
252 | * All 11-byte es519xx chips repeat each block twice for each conversion cycle | |
253 | * so always read 2 blocks at a time. | |
254 | */ | |
255 | #define ES519XX_11B_PACKET_SIZE (11 * 2) | |
72e1672f | 256 | #define ES519XX_14B_PACKET_SIZE 14 |
c01bdebc AJ |
257 | |
258 | struct es519xx_info { | |
259 | gboolean is_judge, is_voltage, is_auto, is_micro, is_current; | |
260 | gboolean is_milli, is_resistance, is_continuity, is_diode; | |
261 | gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle; | |
262 | gboolean is_temperature, is_celsius, is_fahrenheit; | |
263 | gboolean is_adp0, is_adp1, is_adp2, is_adp3; | |
264 | gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo; | |
265 | gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold; | |
266 | gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr; | |
267 | uint32_t baudrate; | |
268 | int packet_size; | |
269 | gboolean alt_functions, fivedigits, clampmeter, selectable_lpf; | |
270 | }; | |
271 | ||
72e1672f UH |
272 | SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf); |
273 | SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval, | |
274 | struct sr_datafeed_analog *analog, void *info); | |
275 | SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf); | |
93d719cd | 276 | SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf, |
72e1672f UH |
277 | float *floatval, struct sr_datafeed_analog *analog, void *info); |
278 | SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf); | |
279 | SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf, | |
280 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
281 | SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf); | |
282 | SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval, | |
283 | struct sr_datafeed_analog *analog, void *info); | |
284 | SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf); | |
285 | SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval, | |
286 | struct sr_datafeed_analog *analog, void *info); | |
287 | SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf); | |
288 | SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf, | |
289 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
c01bdebc | 290 | |
79081ec8 UH |
291 | /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/ |
292 | ||
913abe83 UH |
293 | #define FS9922_PACKET_SIZE 14 |
294 | ||
295 | struct fs9922_info { | |
296 | gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2; | |
297 | gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro; | |
298 | gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent; | |
299 | gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad; | |
300 | gboolean is_celsius, is_fahrenheit; | |
301 | int bargraph_sign, bargraph_value; | |
302 | }; | |
303 | ||
913abe83 UH |
304 | SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf); |
305 | SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval, | |
306 | struct sr_datafeed_analog *analog, void *info); | |
e52bb9be | 307 | SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info); |
79081ec8 | 308 | |
6c701476 UH |
309 | /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/ |
310 | ||
8c1adf37 UH |
311 | #define FS9721_PACKET_SIZE 14 |
312 | ||
313 | struct fs9721_info { | |
314 | gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo; | |
315 | gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad; | |
316 | gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat; | |
317 | gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign; | |
318 | }; | |
319 | ||
8c1adf37 UH |
320 | SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf); |
321 | SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval, | |
93357bc3 | 322 | struct sr_datafeed_analog *analog, void *info); |
2451a20f UH |
323 | SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info); |
324 | SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info); | |
325 | SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info); | |
326 | SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info); | |
6c701476 | 327 | |
ac913e5c UH |
328 | /*--- hardware/common/dmm/metex14.c -----------------------------------------*/ |
329 | ||
330 | #define METEX14_PACKET_SIZE 14 | |
331 | ||
332 | struct metex14_info { | |
333 | gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature; | |
334 | gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad; | |
c02dc3e2 UH |
335 | gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro; |
336 | gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe; | |
337 | gboolean is_unitless; | |
ac913e5c UH |
338 | }; |
339 | ||
c4f2dfd0 | 340 | #ifdef HAVE_LIBSERIALPORT |
ce3777ad | 341 | SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial); |
c4f2dfd0 | 342 | #endif |
ac913e5c UH |
343 | SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf); |
344 | SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval, | |
1fbab466 | 345 | struct sr_datafeed_analog *analog, void *info); |
ac913e5c | 346 | |
05f134ab AG |
347 | /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/ |
348 | ||
21829e67 | 349 | #define RS9LCD_PACKET_SIZE 9 |
05f134ab | 350 | |
e7ed87a4 | 351 | /* Dummy info struct. The parser does not use it. */ |
bf6f8399 | 352 | struct rs9lcd_info { int dummy; }; |
e7ed87a4 | 353 | |
05f134ab AG |
354 | SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf); |
355 | SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval, | |
356 | struct sr_datafeed_analog *analog, void *info); | |
357 | ||
1483577e | 358 | #endif |