]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> | |
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 | ||
20 | /** @file | |
21 | * @internal | |
22 | */ | |
23 | ||
24 | #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H | |
25 | #define LIBSIGROK_LIBSIGROK_INTERNAL_H | |
26 | ||
27 | #include <stdarg.h> | |
28 | #include <glib.h> | |
29 | #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ | |
30 | #ifdef HAVE_LIBUSB_1_0 | |
31 | #include <libusb.h> | |
32 | #endif | |
33 | #ifdef HAVE_LIBSERIALPORT | |
34 | #include <libserialport.h> | |
35 | #endif | |
36 | ||
37 | /** | |
38 | * @file | |
39 | * | |
40 | * libsigrok private header file, only to be used internally. | |
41 | */ | |
42 | ||
43 | /*--- Macros ----------------------------------------------------------------*/ | |
44 | ||
45 | #ifndef ARRAY_SIZE | |
46 | #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) | |
47 | #endif | |
48 | ||
49 | #ifndef ARRAY_AND_SIZE | |
50 | #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) | |
51 | #endif | |
52 | ||
53 | /** | |
54 | * Read a 8 bits unsigned integer out of memory. | |
55 | * @param x a pointer to the input memory | |
56 | * @return the corresponding unsigned integer | |
57 | */ | |
58 | #define R8(x) ((unsigned)((const uint8_t*)(x))[0]) | |
59 | ||
60 | /** | |
61 | * Read a 16 bits big endian unsigned integer out of memory. | |
62 | * @param x a pointer to the input memory | |
63 | * @return the corresponding unsigned integer | |
64 | */ | |
65 | #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \ | |
66 | (unsigned)((const uint8_t*)(x))[1]) | |
67 | ||
68 | /** | |
69 | * Read a 16 bits little endian unsigned integer out of memory. | |
70 | * @param x a pointer to the input memory | |
71 | * @return the corresponding unsigned integer | |
72 | */ | |
73 | #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
74 | (unsigned)((const uint8_t*)(x))[0]) | |
75 | ||
76 | /** | |
77 | * Read a 16 bits little endian signed integer out of memory. | |
78 | * @param x a pointer to the input memory | |
79 | * @return the corresponding signed integer | |
80 | */ | |
81 | #define RL16S(x) ((int16_t) \ | |
82 | (((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
83 | (unsigned)((const uint8_t*)(x))[0])) | |
84 | ||
85 | /** | |
86 | * Read a 32 bits big endian unsigned integer out of memory. | |
87 | * @param x a pointer to the input memory | |
88 | * @return the corresponding unsigned integer | |
89 | */ | |
90 | #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \ | |
91 | ((unsigned)((const uint8_t*)(x))[1] << 16) | \ | |
92 | ((unsigned)((const uint8_t*)(x))[2] << 8) | \ | |
93 | (unsigned)((const uint8_t*)(x))[3]) | |
94 | ||
95 | /** | |
96 | * Read a 32 bits little endian unsigned integer out of memory. | |
97 | * @param x a pointer to the input memory | |
98 | * @return the corresponding unsigned integer | |
99 | */ | |
100 | #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \ | |
101 | ((unsigned)((const uint8_t*)(x))[2] << 16) | \ | |
102 | ((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
103 | (unsigned)((const uint8_t*)(x))[0]) | |
104 | ||
105 | /** | |
106 | * Read a 32 bits little endian signed integer out of memory. | |
107 | * @param x a pointer to the input memory | |
108 | * @return the corresponding signed integer | |
109 | */ | |
110 | #define RL32S(x) ((int32_t) \ | |
111 | (((unsigned)((const uint8_t*)(x))[3] << 24) | \ | |
112 | ((unsigned)((const uint8_t*)(x))[2] << 16) | \ | |
113 | ((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
114 | (unsigned)((const uint8_t*)(x))[0])) | |
115 | ||
116 | /** | |
117 | * Write a 8 bits unsigned integer to memory. | |
118 | * @param p a pointer to the output memory | |
119 | * @param x the input unsigned integer | |
120 | */ | |
121 | #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while(0) | |
122 | ||
123 | /** | |
124 | * Write a 16 bits unsigned integer to memory stored as big endian. | |
125 | * @param p a pointer to the output memory | |
126 | * @param x the input unsigned integer | |
127 | */ | |
128 | #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \ | |
129 | ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while(0) | |
130 | ||
131 | /** | |
132 | * Write a 16 bits unsigned integer to memory stored as little endian. | |
133 | * @param p a pointer to the output memory | |
134 | * @param x the input unsigned integer | |
135 | */ | |
136 | #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \ | |
137 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while(0) | |
138 | ||
139 | /** | |
140 | * Write a 32 bits unsigned integer to memory stored as big endian. | |
141 | * @param p a pointer to the output memory | |
142 | * @param x the input unsigned integer | |
143 | */ | |
144 | #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \ | |
145 | ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \ | |
146 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \ | |
147 | ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while(0) | |
148 | ||
149 | /** | |
150 | * Write a 32 bits unsigned integer to memory stored as little endian. | |
151 | * @param p a pointer to the output memory | |
152 | * @param x the input unsigned integer | |
153 | */ | |
154 | #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \ | |
155 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \ | |
156 | ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \ | |
157 | ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while(0) | |
158 | ||
159 | /* Portability fixes for FreeBSD. */ | |
160 | #ifdef __FreeBSD__ | |
161 | #define LIBUSB_CLASS_APPLICATION 0xfe | |
162 | #define libusb_handle_events_timeout_completed(ctx, tv, c) \ | |
163 | libusb_handle_events_timeout(ctx, tv) | |
164 | #endif | |
165 | ||
166 | /* Static definitions of structs ending with an all-zero entry are a | |
167 | * problem when compiling with -Wmissing-field-initializers: GCC | |
168 | * suppresses the warning only with { 0 }, clang wants { } */ | |
169 | #ifdef __clang__ | |
170 | #define ALL_ZERO { } | |
171 | #else | |
172 | #define ALL_ZERO { 0 } | |
173 | #endif | |
174 | ||
175 | struct sr_context { | |
176 | #ifdef HAVE_LIBUSB_1_0 | |
177 | libusb_context *libusb_ctx; | |
178 | gboolean usb_source_present; | |
179 | #ifdef _WIN32 | |
180 | GThread *usb_thread; | |
181 | gboolean usb_thread_running; | |
182 | GMutex usb_mutex; | |
183 | HANDLE usb_event; | |
184 | GPollFD usb_pollfd; | |
185 | sr_receive_data_callback usb_cb; | |
186 | void *usb_cb_data; | |
187 | #endif | |
188 | #endif | |
189 | }; | |
190 | ||
191 | /** Input module metadata keys. */ | |
192 | enum sr_input_meta_keys { | |
193 | /** The input filename, if there is one. */ | |
194 | SR_INPUT_META_FILENAME = 0x01, | |
195 | /** The input file's size in bytes. */ | |
196 | SR_INPUT_META_FILESIZE = 0x02, | |
197 | /** The first 128 bytes of the file, provided as a GString. */ | |
198 | SR_INPUT_META_HEADER = 0x04, | |
199 | /** The file's MIME type. */ | |
200 | SR_INPUT_META_MIMETYPE = 0x08, | |
201 | ||
202 | /** The module cannot identify a file without this metadata. */ | |
203 | SR_INPUT_META_REQUIRED = 0x80, | |
204 | }; | |
205 | ||
206 | /** Input (file) module struct. */ | |
207 | struct sr_input { | |
208 | /** | |
209 | * A pointer to this input module's 'struct sr_input_module'. | |
210 | */ | |
211 | const struct sr_input_module *module; | |
212 | GString *buf; | |
213 | struct sr_dev_inst *sdi; | |
214 | void *priv; | |
215 | }; | |
216 | ||
217 | /** Input (file) module driver. */ | |
218 | struct sr_input_module { | |
219 | /** | |
220 | * A unique ID for this input module, suitable for use in command-line | |
221 | * clients, [a-z0-9-]. Must not be NULL. | |
222 | */ | |
223 | const char *id; | |
224 | ||
225 | /** | |
226 | * A unique name for this input module, suitable for use in GUI | |
227 | * clients, can contain UTF-8. Must not be NULL. | |
228 | */ | |
229 | const char *name; | |
230 | ||
231 | /** | |
232 | * A short description of the input module. Must not be NULL. | |
233 | * | |
234 | * This can be displayed by frontends, e.g. when selecting the input | |
235 | * module for saving a file. | |
236 | */ | |
237 | const char *desc; | |
238 | ||
239 | /** | |
240 | * Zero-terminated list of metadata items the module needs to be able | |
241 | * to identify an input stream. Can be all-zero, if the module cannot | |
242 | * identify streams at all, i.e. has to be forced into use. | |
243 | * | |
244 | * Each item is one of: | |
245 | * SR_INPUT_META_FILENAME | |
246 | * SR_INPUT_META_FILESIZE | |
247 | * SR_INPUT_META_HEADER | |
248 | * SR_INPUT_META_MIMETYPE | |
249 | * | |
250 | * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot | |
251 | * identify a stream without the given metadata. | |
252 | */ | |
253 | const uint8_t metadata[8]; | |
254 | ||
255 | /** | |
256 | * Returns a NULL-terminated list of options this module can take. | |
257 | * Can be NULL, if the module has no options. | |
258 | */ | |
259 | struct sr_option *(*options) (void); | |
260 | ||
261 | /** | |
262 | * Check if this input module can load and parse the specified stream. | |
263 | * | |
264 | * @param[in] metadata Metadata the module can use to identify the stream. | |
265 | * | |
266 | * @retval SR_OK This module knows the format. | |
267 | * @retval SR_OK_CONTINUE There wasn't enough data for this module to | |
268 | * positively identify the format. | |
269 | * @retval SR_ERR_DATA This module knows the format, but cannot handle it. | |
270 | * This means the stream is either corrupt, or indicates a feature | |
271 | * that the module does not support. | |
272 | * @retval SR_ERR This module does not know the format. | |
273 | */ | |
274 | int (*format_match) (GHashTable *metadata); | |
275 | ||
276 | /** | |
277 | * Initialize the input module. | |
278 | * | |
279 | * @param in A pointer to a valid 'struct sr_input' that the caller | |
280 | * has to allocate and provide to this function. It is also | |
281 | * the responsibility of the caller to free it later. | |
282 | * @param[in] filename The name (and path) of the file to use. | |
283 | * | |
284 | * @retval SR_OK Success | |
285 | * @retval other Negative error code. | |
286 | */ | |
287 | int (*init) (struct sr_input *in, GHashTable *options); | |
288 | ||
289 | /** | |
290 | * Load a file, parsing the input according to the file's format. | |
291 | * | |
292 | * This function will send datafeed packets to the session bus, so | |
293 | * the calling frontend must have registered its session callbacks | |
294 | * beforehand. | |
295 | * | |
296 | * The packet types sent across the session bus by this function must | |
297 | * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data | |
298 | * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet | |
299 | * if appropriate. | |
300 | * | |
301 | * @param in A pointer to a valid 'struct sr_input' that the caller | |
302 | * has to allocate and provide to this function. It is also | |
303 | * the responsibility of the caller to free it later. | |
304 | * @param f The name (and path) of the file to use. | |
305 | * | |
306 | * @retval SR_OK Success | |
307 | * @retval other Negative error code. | |
308 | */ | |
309 | int (*receive) (const struct sr_input *in, GString *buf); | |
310 | ||
311 | /** | |
312 | * This function is called after the caller is finished using | |
313 | * the input module, and can be used to free any internal | |
314 | * resources the module may keep. | |
315 | * | |
316 | * @retval SR_OK Success | |
317 | * @retval other Negative error code. | |
318 | */ | |
319 | int (*cleanup) (struct sr_input *in); | |
320 | }; | |
321 | ||
322 | /** Output module instance. */ | |
323 | struct sr_output { | |
324 | /** A pointer to this output's module. */ | |
325 | const struct sr_output_module *module; | |
326 | ||
327 | /** | |
328 | * The device for which this output module is creating output. This | |
329 | * can be used by the module to find out channel names and numbers. | |
330 | */ | |
331 | const struct sr_dev_inst *sdi; | |
332 | ||
333 | /** | |
334 | * A generic pointer which can be used by the module to keep internal | |
335 | * state between calls into its callback functions. | |
336 | * | |
337 | * For example, the module might store a pointer to a chunk of output | |
338 | * there, and only flush it when it reaches a certain size. | |
339 | */ | |
340 | void *priv; | |
341 | }; | |
342 | ||
343 | /** Output module driver. */ | |
344 | struct sr_output_module { | |
345 | /** | |
346 | * A unique ID for this output module, suitable for use in command-line | |
347 | * clients, [a-z0-9-]. Must not be NULL. | |
348 | */ | |
349 | char *id; | |
350 | ||
351 | /** | |
352 | * A unique name for this output module, suitable for use in GUI | |
353 | * clients, can contain UTF-8. Must not be NULL. | |
354 | */ | |
355 | const char *name; | |
356 | ||
357 | /** | |
358 | * A short description of the output module. Must not be NULL. | |
359 | * | |
360 | * This can be displayed by frontends, e.g. when selecting the output | |
361 | * module for saving a file. | |
362 | */ | |
363 | char *desc; | |
364 | ||
365 | /** | |
366 | * Returns a NULL-terminated list of options this module can take. | |
367 | * Can be NULL, if the module has no options. | |
368 | */ | |
369 | const struct sr_option *(*options) (void); | |
370 | ||
371 | /** | |
372 | * This function is called once, at the beginning of an output stream. | |
373 | * | |
374 | * The device struct will be available in the output struct passed in, | |
375 | * as well as the param field -- which may be NULL or an empty string, | |
376 | * if no parameter was passed. | |
377 | * | |
378 | * The module can use this to initialize itself, create a struct for | |
379 | * keeping state and storing it in the <code>internal</code> field. | |
380 | * | |
381 | * @param o Pointer to the respective 'struct sr_output'. | |
382 | * | |
383 | * @retval SR_OK Success | |
384 | * @retval other Negative error code. | |
385 | */ | |
386 | int (*init) (struct sr_output *o, GHashTable *options); | |
387 | ||
388 | /** | |
389 | * This function is passed a copy of every packed in the data feed. | |
390 | * Any output generated by the output module in response to the | |
391 | * packet should be returned in a newly allocated GString | |
392 | * <code>out</code>, which will be freed by the caller. | |
393 | * | |
394 | * Packets not of interest to the output module can just be ignored, | |
395 | * and the <code>out</code> parameter set to NULL. | |
396 | * | |
397 | * @param o Pointer to the respective 'struct sr_output'. | |
398 | * @param sdi The device instance that generated the packet. | |
399 | * @param packet The complete packet. | |
400 | * @param out A pointer where a GString * should be stored if | |
401 | * the module generates output, or NULL if not. | |
402 | * | |
403 | * @retval SR_OK Success | |
404 | * @retval other Negative error code. | |
405 | */ | |
406 | int (*receive) (const struct sr_output *o, | |
407 | const struct sr_datafeed_packet *packet, GString **out); | |
408 | ||
409 | /** | |
410 | * This function is called after the caller is finished using | |
411 | * the output module, and can be used to free any internal | |
412 | * resources the module may keep. | |
413 | * | |
414 | * @retval SR_OK Success | |
415 | * @retval other Negative error code. | |
416 | */ | |
417 | int (*cleanup) (struct sr_output *o); | |
418 | }; | |
419 | ||
420 | #ifdef HAVE_LIBUSB_1_0 | |
421 | /** USB device instance */ | |
422 | struct sr_usb_dev_inst { | |
423 | /** USB bus */ | |
424 | uint8_t bus; | |
425 | /** Device address on USB bus */ | |
426 | uint8_t address; | |
427 | /** libusb device handle */ | |
428 | struct libusb_device_handle *devhdl; | |
429 | }; | |
430 | #endif | |
431 | ||
432 | #ifdef HAVE_LIBSERIALPORT | |
433 | #define SERIAL_PARITY_NONE SP_PARITY_NONE | |
434 | #define SERIAL_PARITY_EVEN SP_PARITY_EVEN | |
435 | #define SERIAL_PARITY_ODD SP_PARITY_ODD | |
436 | struct sr_serial_dev_inst { | |
437 | /** Port name, e.g. '/dev/tty42'. */ | |
438 | char *port; | |
439 | /** Comm params for serial_set_paramstr(). */ | |
440 | char *serialcomm; | |
441 | /** libserialport port handle */ | |
442 | struct sp_port *data; | |
443 | /** libserialport event set */ | |
444 | struct sp_event_set *event_set; | |
445 | /** GPollFDs for event polling */ | |
446 | GPollFD *pollfds; | |
447 | }; | |
448 | #endif | |
449 | ||
450 | struct sr_usbtmc_dev_inst { | |
451 | char *device; | |
452 | int fd; | |
453 | }; | |
454 | ||
455 | /* Private driver context. */ | |
456 | struct drv_context { | |
457 | /** sigrok context */ | |
458 | struct sr_context *sr_ctx; | |
459 | GSList *instances; | |
460 | }; | |
461 | ||
462 | /*--- log.c -----------------------------------------------------------------*/ | |
463 | ||
464 | SR_PRIV int sr_log(int loglevel, const char *format, ...); | |
465 | SR_PRIV int sr_spew(const char *format, ...); | |
466 | SR_PRIV int sr_dbg(const char *format, ...); | |
467 | SR_PRIV int sr_info(const char *format, ...); | |
468 | SR_PRIV int sr_warn(const char *format, ...); | |
469 | SR_PRIV int sr_err(const char *format, ...); | |
470 | ||
471 | /* Message logging helpers with subsystem-specific prefix string. */ | |
472 | #ifndef NO_LOG_WRAPPERS | |
473 | #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args) | |
474 | #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args) | |
475 | #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args) | |
476 | #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args) | |
477 | #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args) | |
478 | #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args) | |
479 | #endif | |
480 | ||
481 | /*--- device.c --------------------------------------------------------------*/ | |
482 | ||
483 | /** Values for the changes argument of sr_dev_driver.config_channel_set. */ | |
484 | enum { | |
485 | /** The enabled state of the channel has been changed. */ | |
486 | SR_CHANNEL_SET_ENABLED = 1 << 0, | |
487 | }; | |
488 | ||
489 | SR_PRIV struct sr_channel *sr_channel_new(int index, int type, | |
490 | gboolean enabled, const char *name); | |
491 | ||
492 | /* Generic device instances */ | |
493 | SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int status, | |
494 | const char *vendor, const char *model, const char *version); | |
495 | SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi); | |
496 | ||
497 | #ifdef HAVE_LIBUSB_1_0 | |
498 | /* USB-specific instances */ | |
499 | SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, | |
500 | uint8_t address, struct libusb_device_handle *hdl); | |
501 | SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb); | |
502 | #endif | |
503 | ||
504 | #ifdef HAVE_LIBSERIALPORT | |
505 | /* Serial-specific instances */ | |
506 | SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, | |
507 | const char *serialcomm); | |
508 | SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial); | |
509 | #endif | |
510 | ||
511 | /* USBTMC-specific instances */ | |
512 | SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device); | |
513 | SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc); | |
514 | ||
515 | /*--- hwdriver.c ------------------------------------------------------------*/ | |
516 | ||
517 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype); | |
518 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data); | |
519 | SR_PRIV void sr_hw_cleanup_all(void); | |
520 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data); | |
521 | SR_PRIV void sr_config_free(struct sr_config *src); | |
522 | SR_PRIV int sr_source_remove(int fd); | |
523 | SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd); | |
524 | SR_PRIV int sr_source_remove_channel(GIOChannel *channel); | |
525 | SR_PRIV int sr_source_add(int fd, int events, int timeout, | |
526 | sr_receive_data_callback cb, void *cb_data); | |
527 | SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout, | |
528 | sr_receive_data_callback cb, void *cb_data); | |
529 | SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout, | |
530 | sr_receive_data_callback cb, void *cb_data); | |
531 | ||
532 | /*--- session.c -------------------------------------------------------------*/ | |
533 | ||
534 | struct sr_session { | |
535 | /** List of struct sr_dev pointers. */ | |
536 | GSList *devs; | |
537 | /** List of struct datafeed_callback pointers. */ | |
538 | GSList *datafeed_callbacks; | |
539 | struct sr_trigger *trigger; | |
540 | GTimeVal starttime; | |
541 | gboolean running; | |
542 | ||
543 | unsigned int num_sources; | |
544 | ||
545 | /* | |
546 | * Both "sources" and "pollfds" are of the same size and contain pairs | |
547 | * of descriptor and callback function. We can not embed the GPollFD | |
548 | * into the source struct since we want to be able to pass the array | |
549 | * of all poll descriptors to g_poll(). | |
550 | */ | |
551 | struct source *sources; | |
552 | GPollFD *pollfds; | |
553 | int source_timeout; | |
554 | ||
555 | /* | |
556 | * These are our synchronization primitives for stopping the session in | |
557 | * an async fashion. We need to make sure the session is stopped from | |
558 | * within the session thread itself. | |
559 | */ | |
560 | /** Mutex protecting access to abort_session. */ | |
561 | GMutex stop_mutex; | |
562 | /** Abort current session. See sr_session_stop(). */ | |
563 | gboolean abort_session; | |
564 | }; | |
565 | ||
566 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, | |
567 | const struct sr_datafeed_packet *packet); | |
568 | SR_PRIV int sr_session_stop_sync(struct sr_session *session); | |
569 | SR_PRIV int sr_sessionfile_check(const char *filename); | |
570 | SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet, | |
571 | struct sr_datafeed_packet **copy); | |
572 | SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet); | |
573 | ||
574 | /*--- std.c -----------------------------------------------------------------*/ | |
575 | ||
576 | typedef int (*dev_close_callback)(struct sr_dev_inst *sdi); | |
577 | typedef void (*std_dev_clear_callback)(void *priv); | |
578 | ||
579 | SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, | |
580 | const char *prefix); | |
581 | #ifdef HAVE_LIBSERIALPORT | |
582 | SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi); | |
583 | SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, | |
584 | void *cb_data, dev_close_callback dev_close_fn, | |
585 | struct sr_serial_dev_inst *serial, const char *prefix); | |
586 | #endif | |
587 | SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, | |
588 | const char *prefix); | |
589 | SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, | |
590 | std_dev_clear_callback clear_private); | |
591 | SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi); | |
592 | ||
593 | /*--- strutil.c -------------------------------------------------------------*/ | |
594 | ||
595 | SR_PRIV int sr_atol(const char *str, long *ret); | |
596 | SR_PRIV int sr_atoi(const char *str, int *ret); | |
597 | SR_PRIV int sr_atod(const char *str, double *ret); | |
598 | SR_PRIV int sr_atof(const char *str, float *ret); | |
599 | SR_PRIV int sr_atof_ascii(const char *str, float *ret); | |
600 | ||
601 | /*--- soft-trigger.c --------------------------------------------------------*/ | |
602 | ||
603 | struct soft_trigger_logic { | |
604 | const struct sr_dev_inst *sdi; | |
605 | const struct sr_trigger *trigger; | |
606 | int count; | |
607 | int unitsize; | |
608 | int cur_stage; | |
609 | uint8_t *prev_sample; | |
610 | }; | |
611 | ||
612 | SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new( | |
613 | const struct sr_dev_inst *sdi, struct sr_trigger *trigger); | |
614 | SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st); | |
615 | SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf, | |
616 | int len); | |
617 | ||
618 | /*--- hardware/common/serial.c ----------------------------------------------*/ | |
619 | ||
620 | #ifdef HAVE_LIBSERIALPORT | |
621 | enum { | |
622 | SERIAL_RDWR = 1, | |
623 | SERIAL_RDONLY = 2, | |
624 | }; | |
625 | ||
626 | typedef gboolean (*packet_valid_callback)(const uint8_t *buf); | |
627 | ||
628 | SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags); | |
629 | SR_PRIV int serial_close(struct sr_serial_dev_inst *serial); | |
630 | SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial); | |
631 | SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, | |
632 | const void *buf, size_t count); | |
633 | SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial, | |
634 | const void *buf, size_t count); | |
635 | SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, | |
636 | size_t count); | |
637 | SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf, | |
638 | size_t count); | |
639 | SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, | |
640 | int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr); | |
641 | SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial, | |
642 | const char *paramstr); | |
643 | SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf, | |
644 | int *buflen, gint64 timeout_ms); | |
645 | SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, | |
646 | uint8_t *buf, size_t *buflen, | |
647 | size_t packet_size, | |
648 | packet_valid_callback is_valid, | |
649 | uint64_t timeout_ms, int baudrate); | |
650 | SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device, | |
651 | const char **serial_options); | |
652 | SR_PRIV int serial_source_add(struct sr_session *session, | |
653 | struct sr_serial_dev_inst *serial, int events, int timeout, | |
654 | sr_receive_data_callback cb, void *cb_data); | |
655 | SR_PRIV int serial_source_remove(struct sr_session *session, | |
656 | struct sr_serial_dev_inst *serial); | |
657 | SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id); | |
658 | #endif | |
659 | ||
660 | /*--- hardware/common/ezusb.c -----------------------------------------------*/ | |
661 | ||
662 | #ifdef HAVE_LIBUSB_1_0 | |
663 | SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear); | |
664 | SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl, | |
665 | const char *filename); | |
666 | SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration, | |
667 | const char *filename); | |
668 | #endif | |
669 | ||
670 | /*--- hardware/common/usb.c -------------------------------------------------*/ | |
671 | ||
672 | #ifdef HAVE_LIBUSB_1_0 | |
673 | SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn); | |
674 | SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb); | |
675 | SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx, | |
676 | int timeout, sr_receive_data_callback cb, void *cb_data); | |
677 | SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx); | |
678 | SR_PRIV int usb_get_port_path(libusb_device *dev, const char *path, int path_len); | |
679 | #endif | |
680 | ||
681 | /*--- hardware/common/scpi.c ------------------------------------------------*/ | |
682 | ||
683 | #define SCPI_CMD_IDN "*IDN?" | |
684 | #define SCPI_CMD_OPC "*OPC?" | |
685 | ||
686 | enum { | |
687 | SCPI_CMD_SET_TRIGGER_SOURCE, | |
688 | SCPI_CMD_SET_TIMEBASE, | |
689 | SCPI_CMD_SET_VERTICAL_DIV, | |
690 | SCPI_CMD_SET_TRIGGER_SLOPE, | |
691 | SCPI_CMD_SET_COUPLING, | |
692 | SCPI_CMD_SET_HORIZ_TRIGGERPOS, | |
693 | SCPI_CMD_GET_ANALOG_CHAN_STATE, | |
694 | SCPI_CMD_GET_DIG_CHAN_STATE, | |
695 | SCPI_CMD_GET_TIMEBASE, | |
696 | SCPI_CMD_GET_VERTICAL_DIV, | |
697 | SCPI_CMD_GET_VERTICAL_OFFSET, | |
698 | SCPI_CMD_GET_TRIGGER_SOURCE, | |
699 | SCPI_CMD_GET_HORIZ_TRIGGERPOS, | |
700 | SCPI_CMD_GET_TRIGGER_SLOPE, | |
701 | SCPI_CMD_GET_COUPLING, | |
702 | SCPI_CMD_SET_ANALOG_CHAN_STATE, | |
703 | SCPI_CMD_SET_DIG_CHAN_STATE, | |
704 | SCPI_CMD_GET_DIG_POD_STATE, | |
705 | SCPI_CMD_SET_DIG_POD_STATE, | |
706 | SCPI_CMD_GET_ANALOG_DATA, | |
707 | SCPI_CMD_GET_DIG_DATA, | |
708 | SCPI_CMD_GET_SAMPLE_RATE, | |
709 | SCPI_CMD_GET_SAMPLE_RATE_LIVE, | |
710 | }; | |
711 | ||
712 | struct sr_scpi_hw_info { | |
713 | char *manufacturer; | |
714 | char *model; | |
715 | char *serial_number; | |
716 | char *firmware_version; | |
717 | }; | |
718 | ||
719 | struct sr_scpi_dev_inst { | |
720 | const char *name; | |
721 | const char *prefix; | |
722 | int priv_size; | |
723 | GSList *(*scan)(struct drv_context *drvc); | |
724 | int (*dev_inst_new)(void *priv, struct drv_context *drvc, | |
725 | const char *resource, char **params, const char *serialcomm); | |
726 | int (*open)(void *priv); | |
727 | int (*source_add)(struct sr_session *session, void *priv, int events, | |
728 | int timeout, sr_receive_data_callback cb, void *cb_data); | |
729 | int (*source_remove)(struct sr_session *session, void *priv); | |
730 | int (*send)(void *priv, const char *command); | |
731 | int (*read_begin)(void *priv); | |
732 | int (*read_data)(void *priv, char *buf, int maxlen); | |
733 | int (*read_complete)(void *priv); | |
734 | int (*close)(void *priv); | |
735 | void (*free)(void *priv); | |
736 | void *priv; | |
737 | }; | |
738 | ||
739 | SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, | |
740 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)); | |
741 | SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc, | |
742 | const char *resource, const char *serialcomm); | |
743 | SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi); | |
744 | SR_PRIV int sr_scpi_source_add(struct sr_session *session, | |
745 | struct sr_scpi_dev_inst *scpi, int events, int timeout, | |
746 | sr_receive_data_callback cb, void *cb_data); | |
747 | SR_PRIV int sr_scpi_source_remove(struct sr_session *session, | |
748 | struct sr_scpi_dev_inst *scpi); | |
749 | SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi, | |
750 | const char *format, ...); | |
751 | SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi, | |
752 | const char *format, va_list args); | |
753 | SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi); | |
754 | SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen); | |
755 | SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi); | |
756 | SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi); | |
757 | SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi); | |
758 | ||
759 | SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, | |
760 | const char *command, char **scpi_response); | |
761 | SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, | |
762 | const char *command, gboolean *scpi_response); | |
763 | SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, | |
764 | const char *command, int *scpi_response); | |
765 | SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, | |
766 | const char *command, float *scpi_response); | |
767 | SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, | |
768 | const char *command, double *scpi_response); | |
769 | SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi); | |
770 | SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, | |
771 | const char *command, GArray **scpi_response); | |
772 | SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, | |
773 | const char *command, GArray **scpi_response); | |
774 | SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, | |
775 | struct sr_scpi_hw_info **scpi_response); | |
776 | SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info); | |
777 | ||
778 | /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/ | |
779 | ||
780 | /** | |
781 | * All 11-byte es519xx chips repeat each block twice for each conversion cycle | |
782 | * so always read 2 blocks at a time. | |
783 | */ | |
784 | #define ES519XX_11B_PACKET_SIZE (11 * 2) | |
785 | #define ES519XX_14B_PACKET_SIZE 14 | |
786 | ||
787 | struct es519xx_info { | |
788 | gboolean is_judge, is_voltage, is_auto, is_micro, is_current; | |
789 | gboolean is_milli, is_resistance, is_continuity, is_diode; | |
790 | gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle; | |
791 | gboolean is_temperature, is_celsius, is_fahrenheit; | |
792 | gboolean is_adp0, is_adp1, is_adp2, is_adp3; | |
793 | gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo; | |
794 | gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold; | |
795 | gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr; | |
796 | uint32_t baudrate; | |
797 | int packet_size; | |
798 | gboolean alt_functions, fivedigits, clampmeter, selectable_lpf; | |
799 | }; | |
800 | ||
801 | SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf); | |
802 | SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval, | |
803 | struct sr_datafeed_analog *analog, void *info); | |
804 | SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf); | |
805 | SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf, | |
806 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
807 | SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf); | |
808 | SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf, | |
809 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
810 | SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf); | |
811 | SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf, | |
812 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
813 | SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf); | |
814 | SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval, | |
815 | struct sr_datafeed_analog *analog, void *info); | |
816 | SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf); | |
817 | SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval, | |
818 | struct sr_datafeed_analog *analog, void *info); | |
819 | SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf); | |
820 | SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf, | |
821 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
822 | ||
823 | /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/ | |
824 | ||
825 | #define FS9922_PACKET_SIZE 14 | |
826 | ||
827 | struct fs9922_info { | |
828 | gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2; | |
829 | gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro; | |
830 | gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent; | |
831 | gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad; | |
832 | gboolean is_celsius, is_fahrenheit; | |
833 | int bargraph_sign, bargraph_value; | |
834 | }; | |
835 | ||
836 | SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf); | |
837 | SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval, | |
838 | struct sr_datafeed_analog *analog, void *info); | |
839 | SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info); | |
840 | ||
841 | /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/ | |
842 | ||
843 | #define FS9721_PACKET_SIZE 14 | |
844 | ||
845 | struct fs9721_info { | |
846 | gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo; | |
847 | gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad; | |
848 | gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat; | |
849 | gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign; | |
850 | }; | |
851 | ||
852 | SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf); | |
853 | SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval, | |
854 | struct sr_datafeed_analog *analog, void *info); | |
855 | SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info); | |
856 | SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info); | |
857 | SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info); | |
858 | SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info); | |
859 | SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info); | |
860 | ||
861 | /*--- hardware/common/dmm/m2110.c -----------------------------------------*/ | |
862 | ||
863 | #define BBCGM_M2110_PACKET_SIZE 9 | |
864 | ||
865 | SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf); | |
866 | SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval, | |
867 | struct sr_datafeed_analog *analog, void *info); | |
868 | ||
869 | /*--- hardware/common/dmm/metex14.c -----------------------------------------*/ | |
870 | ||
871 | #define METEX14_PACKET_SIZE 14 | |
872 | ||
873 | struct metex14_info { | |
874 | gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature; | |
875 | gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad; | |
876 | gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro; | |
877 | gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe; | |
878 | gboolean is_unitless, is_logic; | |
879 | }; | |
880 | ||
881 | #ifdef HAVE_LIBSERIALPORT | |
882 | SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial); | |
883 | #endif | |
884 | SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf); | |
885 | SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval, | |
886 | struct sr_datafeed_analog *analog, void *info); | |
887 | ||
888 | /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/ | |
889 | ||
890 | #define RS9LCD_PACKET_SIZE 9 | |
891 | ||
892 | /* Dummy info struct. The parser does not use it. */ | |
893 | struct rs9lcd_info { int dummy; }; | |
894 | ||
895 | SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf); | |
896 | SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval, | |
897 | struct sr_datafeed_analog *analog, void *info); | |
898 | ||
899 | /*--- hardware/common/dmm/bm25x.c -----------------------------------------*/ | |
900 | ||
901 | #define BRYMEN_BM25X_PACKET_SIZE 15 | |
902 | ||
903 | /* Dummy info struct. The parser does not use it. */ | |
904 | struct bm25x_info { int dummy; }; | |
905 | ||
906 | SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf); | |
907 | SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval, | |
908 | struct sr_datafeed_analog *analog, void *info); | |
909 | ||
910 | #endif |