src/libsigrok-internal.h

   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_has_capability(x) 0
 163 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
 164         libusb_handle_events_timeout(ctx, tv)
 165 #endif
 166
 167 /* Static definitions of structs ending with an all-zero entry are a
 168  * problem when compiling with -Wmissing-field-initializers: GCC
 169  * suppresses the warning only with { 0 }, clang wants { } */
 170 #ifdef __clang__
 171 #define ALL_ZERO { }
 172 #else
 173 #define ALL_ZERO { 0 }
 174 #endif
 175
 176 struct sr_context {
 177 #ifdef HAVE_LIBUSB_1_0
 178         libusb_context *libusb_ctx;
 179         gboolean usb_source_present;
 180 #ifdef _WIN32
 181         GThread *usb_thread;
 182         gboolean usb_thread_running;
 183         GMutex usb_mutex;
 184         HANDLE usb_event;
 185         GPollFD usb_pollfd;
 186         sr_receive_data_callback usb_cb;
 187         void *usb_cb_data;
 188 #endif
 189 #endif
 190 };
 191
 192 /** Input module metadata keys. */
 193 enum sr_input_meta_keys {
 194         /** The input filename, if there is one. */
 195         SR_INPUT_META_FILENAME = 0x01,
 196         /** The input file's size in bytes. */
 197         SR_INPUT_META_FILESIZE = 0x02,
 198         /** The first 128 bytes of the file, provided as a GString. */
 199         SR_INPUT_META_HEADER = 0x04,
 200         /** The file's MIME type. */
 201         SR_INPUT_META_MIMETYPE = 0x08,
 202
 203         /** The module cannot identify a file without this metadata. */
 204         SR_INPUT_META_REQUIRED = 0x80,
 205 };
 206
 207 /** Input (file) module struct. */
 208 struct sr_input {
 209         /**
 210          * A pointer to this input module's 'struct sr_input_module'.
 211          */
 212         const struct sr_input_module *module;
 213         GString *buf;
 214         struct sr_dev_inst *sdi;
 215         gboolean sdi_ready;
 216         void *priv;
 217 };
 218
 219 /** Input (file) module driver. */
 220 struct sr_input_module {
 221         /**
 222          * A unique ID for this input module, suitable for use in command-line
 223          * clients, [a-z0-9-]. Must not be NULL.
 224          */
 225         const char *id;
 226
 227         /**
 228          * A unique name for this input module, suitable for use in GUI
 229          * clients, can contain UTF-8. Must not be NULL.
 230          */
 231         const char *name;
 232
 233         /**
 234          * A short description of the input module. Must not be NULL.
 235          *
 236          * This can be displayed by frontends, e.g. when selecting the input
 237          * module for saving a file.
 238          */
 239         const char *desc;
 240
 241         /**
 242          * A NULL terminated array of strings containing a list of file name
 243          * extensions typical for the input file format, or NULL if there is
 244          * no typical extension for this file format.
 245          */
 246         const char *const *exts;
 247
 248         /**
 249          * Zero-terminated list of metadata items the module needs to be able
 250          * to identify an input stream. Can be all-zero, if the module cannot
 251          * identify streams at all, i.e. has to be forced into use.
 252          *
 253          * Each item is one of:
 254          *   SR_INPUT_META_FILENAME
 255          *   SR_INPUT_META_FILESIZE
 256          *   SR_INPUT_META_HEADER
 257          *   SR_INPUT_META_MIMETYPE
 258          *
 259          * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
 260          * identify a stream without the given metadata.
 261          */
 262         const uint8_t metadata[8];
 263
 264         /**
 265          * Returns a NULL-terminated list of options this module can take.
 266          * Can be NULL, if the module has no options.
 267          */
 268         struct sr_option *(*options) (void);
 269
 270         /**
 271          * Check if this input module can load and parse the specified stream.
 272          *
 273          * @param[in] metadata Metadata the module can use to identify the stream.
 274          *
 275          * @retval SR_OK This module knows the format.
 276          * @retval SR_ERR_NA There wasn't enough data for this module to
 277          *   positively identify the format.
 278          * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
 279          *   This means the stream is either corrupt, or indicates a feature
 280          *   that the module does not support.
 281          * @retval SR_ERR This module does not know the format.
 282          */
 283         int (*format_match) (GHashTable *metadata);
 284
 285         /**
 286          * Initialize the input module.
 287          *
 288          * @retval SR_OK Success
 289          * @retval other Negative error code.
 290          */
 291         int (*init) (struct sr_input *in, GHashTable *options);
 292
 293         /**
 294          * Send data to the specified input instance.
 295          *
 296          * When an input module instance is created with sr_input_new(), this
 297          * function is used to feed data to the instance.
 298          *
 299          * As enough data gets fed into this function to completely populate
 300          * the device instance associated with this input instance, this is
 301          * guaranteed to return the moment it's ready. This gives the caller
 302          * the chance to examine the device instance, attach session callbacks
 303          * and so on.
 304          *
 305          * @retval SR_OK Success
 306          * @retval other Negative error code.
 307          */
 308         int (*receive) (struct sr_input *in, GString *buf);
 309
 310         /**
 311          * Signal the input module no more data will come.
 312          *
 313          * This will cause the module to process any data it may have buffered.
 314          * The SR_DF_END packet will also typically be sent at this time.
 315          */
 316         int (*end) (struct sr_input *in);
 317
 318         /**
 319          * This function is called after the caller is finished using
 320          * the input module, and can be used to free any internal
 321          * resources the module may keep.
 322          *
 323          * This function is optional.
 324          *
 325          * @retval SR_OK Success
 326          * @retval other Negative error code.
 327          */
 328         void (*cleanup) (struct sr_input *in);
 329 };
 330
 331 /** Output module instance. */
 332 struct sr_output {
 333         /** A pointer to this output's module.  */
 334         const struct sr_output_module *module;
 335
 336         /**
 337          * The device for which this output module is creating output. This
 338          * can be used by the module to find out channel names and numbers.
 339          */
 340         const struct sr_dev_inst *sdi;
 341
 342         /**
 343          * A generic pointer which can be used by the module to keep internal
 344          * state between calls into its callback functions.
 345          *
 346          * For example, the module might store a pointer to a chunk of output
 347          * there, and only flush it when it reaches a certain size.
 348          */
 349         void *priv;
 350 };
 351
 352 /** Output module driver. */
 353 struct sr_output_module {
 354         /**
 355          * A unique ID for this output module, suitable for use in command-line
 356          * clients, [a-z0-9-]. Must not be NULL.
 357          */
 358         char *id;
 359
 360         /**
 361          * A unique name for this output module, suitable for use in GUI
 362          * clients, can contain UTF-8. Must not be NULL.
 363          */
 364         const char *name;
 365
 366         /**
 367          * A short description of the output module. Must not be NULL.
 368          *
 369          * This can be displayed by frontends, e.g. when selecting the output
 370          * module for saving a file.
 371          */
 372         char *desc;
 373
 374         /**
 375          * A NULL terminated array of strings containing a list of file name
 376          * extensions typical for the input file format, or NULL if there is
 377          * no typical extension for this file format.
 378          */
 379         const char *const *exts;
 380
 381         /**
 382          * Returns a NULL-terminated list of options this module can take.
 383          * Can be NULL, if the module has no options.
 384          */
 385         const struct sr_option *(*options) (void);
 386
 387         /**
 388          * This function is called once, at the beginning of an output stream.
 389          *
 390          * The device struct will be available in the output struct passed in,
 391          * as well as the param field -- which may be NULL or an empty string,
 392          * if no parameter was passed.
 393          *
 394          * The module can use this to initialize itself, create a struct for
 395          * keeping state and storing it in the <code>internal</code> field.
 396          *
 397          * @param o Pointer to the respective 'struct sr_output'.
 398          *
 399          * @retval SR_OK Success
 400          * @retval other Negative error code.
 401          */
 402         int (*init) (struct sr_output *o, GHashTable *options);
 403
 404         /**
 405          * This function is passed a copy of every packed in the data feed.
 406          * Any output generated by the output module in response to the
 407          * packet should be returned in a newly allocated GString
 408          * <code>out</code>, which will be freed by the caller.
 409          *
 410          * Packets not of interest to the output module can just be ignored,
 411          * and the <code>out</code> parameter set to NULL.
 412          *
 413          * @param o Pointer to the respective 'struct sr_output'.
 414          * @param sdi The device instance that generated the packet.
 415          * @param packet The complete packet.
 416          * @param out A pointer where a GString * should be stored if
 417          * the module generates output, or NULL if not.
 418          *
 419          * @retval SR_OK Success
 420          * @retval other Negative error code.
 421          */
 422         int (*receive) (const struct sr_output *o,
 423                         const struct sr_datafeed_packet *packet, GString **out);
 424
 425         /**
 426          * This function is called after the caller is finished using
 427          * the output module, and can be used to free any internal
 428          * resources the module may keep.
 429          *
 430          * @retval SR_OK Success
 431          * @retval other Negative error code.
 432          */
 433         int (*cleanup) (struct sr_output *o);
 434 };
 435
 436 #ifdef HAVE_LIBUSB_1_0
 437 /** USB device instance */
 438 struct sr_usb_dev_inst {
 439         /** USB bus */
 440         uint8_t bus;
 441         /** Device address on USB bus */
 442         uint8_t address;
 443         /** libusb device handle */
 444         struct libusb_device_handle *devhdl;
 445 };
 446 #endif
 447
 448 #ifdef HAVE_LIBSERIALPORT
 449 #define SERIAL_PARITY_NONE SP_PARITY_NONE
 450 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
 451 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
 452 struct sr_serial_dev_inst {
 453         /** Port name, e.g. '/dev/tty42'. */
 454         char *port;
 455         /** Comm params for serial_set_paramstr(). */
 456         char *serialcomm;
 457         /** libserialport port handle */
 458         struct sp_port *data;
 459         /** libserialport event set */
 460         struct sp_event_set *event_set;
 461         /** GPollFDs for event polling */
 462         GPollFD *pollfds;
 463 };
 464 #endif
 465
 466 struct sr_usbtmc_dev_inst {
 467         char *device;
 468         int fd;
 469 };
 470
 471 /* Private driver context. */
 472 struct drv_context {
 473         /** sigrok context */
 474         struct sr_context *sr_ctx;
 475         GSList *instances;
 476 };
 477
 478 /*--- log.c -----------------------------------------------------------------*/
 479
 480 SR_PRIV int sr_log(int loglevel, const char *format, ...);
 481 SR_PRIV int sr_spew(const char *format, ...);
 482 SR_PRIV int sr_dbg(const char *format, ...);
 483 SR_PRIV int sr_info(const char *format, ...);
 484 SR_PRIV int sr_warn(const char *format, ...);
 485 SR_PRIV int sr_err(const char *format, ...);
 486
 487 /* Message logging helpers with subsystem-specific prefix string. */
 488 #ifndef NO_LOG_WRAPPERS
 489 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
 490 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
 491 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
 492 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
 493 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
 494 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
 495 #endif
 496
 497 /*--- device.c --------------------------------------------------------------*/
 498
 499 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
 500 enum {
 501         /** The enabled state of the channel has been changed. */
 502         SR_CHANNEL_SET_ENABLED = 1 << 0,
 503 };
 504
 505 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
 506                 gboolean enabled, const char *name);
 507
 508 /** Device instance data */
 509 struct sr_dev_inst {
 510         /** Device driver. */
 511         struct sr_dev_driver *driver;
 512         /** Device instance status. SR_ST_NOT_FOUND, etc. */
 513         int status;
 514         /** Device instance type. SR_INST_USB, etc. */
 515         int inst_type;
 516         /** Device vendor. */
 517         char *vendor;
 518         /** Device model. */
 519         char *model;
 520         /** Device version. */
 521         char *version;
 522         /** Serial number. */
 523         char *serial_num;
 524         /** Connection string to uniquely identify devices. */
 525         char *connection_id;
 526         /** List of channels. */
 527         GSList *channels;
 528         /** List of sr_channel_group structs */
 529         GSList *channel_groups;
 530         /** Device instance connection data (used?) */
 531         void *conn;
 532         /** Device instance private data (used?) */
 533         void *priv;
 534         /** Session to which this device is currently assigned. */
 535         struct sr_session *session;
 536 };
 537
 538 /* Generic device instances */
 539 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 540
 541 #ifdef HAVE_LIBUSB_1_0
 542 /* USB-specific instances */
 543 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 544                 uint8_t address, struct libusb_device_handle *hdl);
 545 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 546 #endif
 547
 548 #ifdef HAVE_LIBSERIALPORT
 549 /* Serial-specific instances */
 550 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 551                 const char *serialcomm);
 552 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 553 #endif
 554
 555 /* USBTMC-specific instances */
 556 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
 557 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
 558
 559 /*--- hwdriver.c ------------------------------------------------------------*/
 560
 561 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
 562 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
 563 SR_PRIV void sr_hw_cleanup_all(void);
 564 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
 565 SR_PRIV void sr_config_free(struct sr_config *src);
 566 SR_PRIV int sr_source_remove(int fd);
 567 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
 568 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
 569 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 570                 sr_receive_data_callback cb, void *cb_data);
 571 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
 572                 sr_receive_data_callback cb, void *cb_data);
 573 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
 574                 sr_receive_data_callback cb, void *cb_data);
 575
 576 /*--- session.c -------------------------------------------------------------*/
 577
 578 struct sr_session {
 579         /** List of struct sr_dev_inst pointers. */
 580         GSList *devs;
 581         /** List of struct sr_dev_inst pointers owned by this session. */
 582         GSList *owned_devs;
 583         /** List of struct datafeed_callback pointers. */
 584         GSList *datafeed_callbacks;
 585         struct sr_trigger *trigger;
 586         GTimeVal starttime;
 587         gboolean running;
 588
 589         unsigned int num_sources;
 590
 591         /*
 592          * Both "sources" and "pollfds" are of the same size and contain pairs
 593          * of descriptor and callback function. We can not embed the GPollFD
 594          * into the source struct since we want to be able to pass the array
 595          * of all poll descriptors to g_poll().
 596          */
 597         struct source *sources;
 598         GPollFD *pollfds;
 599         int source_timeout;
 600
 601         /*
 602          * These are our synchronization primitives for stopping the session in
 603          * an async fashion. We need to make sure the session is stopped from
 604          * within the session thread itself.
 605          */
 606         /** Mutex protecting access to abort_session. */
 607         GMutex stop_mutex;
 608         /** Abort current session. See sr_session_stop(). */
 609         gboolean abort_session;
 610 };
 611
 612 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 613                 const struct sr_datafeed_packet *packet);
 614 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
 615 SR_PRIV int sr_sessionfile_check(const char *filename);
 616 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
 617                 struct sr_datafeed_packet **copy);
 618 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
 619
 620 /*--- analog.c --------------------------------------------------------------*/
 621
 622 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
 623                            struct sr_analog_encoding *encoding,
 624                            struct sr_analog_meaning *meaning,
 625                            struct sr_analog_spec *spec,
 626                            int digits);
 627
 628 /*--- std.c -----------------------------------------------------------------*/
 629
 630 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
 631 typedef void (*std_dev_clear_callback)(void *priv);
 632
 633 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 634                 const char *prefix);
 635 #ifdef HAVE_LIBSERIALPORT
 636 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
 637 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 638                 void *cb_data, dev_close_callback dev_close_fn,
 639                 struct sr_serial_dev_inst *serial, const char *prefix);
 640 #endif
 641 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 642                 const char *prefix);
 643 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 644                 std_dev_clear_callback clear_private);
 645 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
 646
 647 /*--- strutil.c -------------------------------------------------------------*/
 648
 649 SR_PRIV int sr_atol(const char *str, long *ret);
 650 SR_PRIV int sr_atoi(const char *str, int *ret);
 651 SR_PRIV int sr_atod(const char *str, double *ret);
 652 SR_PRIV int sr_atof(const char *str, float *ret);
 653 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
 654
 655 /*--- soft-trigger.c --------------------------------------------------------*/
 656
 657 struct soft_trigger_logic {
 658         const struct sr_dev_inst *sdi;
 659         const struct sr_trigger *trigger;
 660         int count;
 661         int unitsize;
 662         int cur_stage;
 663         uint8_t *prev_sample;
 664         uint8_t *pre_trigger_buffer;
 665         uint8_t *pre_trigger_head;
 666         int pre_trigger_size;
 667         int pre_trigger_fill;
 668 };
 669
 670 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
 671                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
 672                 int pre_trigger_samples);
 673 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
 674 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
 675                 int len, int *pre_trigger_samples);
 676
 677 /*--- hardware/serial.c -----------------------------------------------------*/
 678
 679 #ifdef HAVE_LIBSERIALPORT
 680 enum {
 681         SERIAL_RDWR = 1,
 682         SERIAL_RDONLY = 2,
 683 };
 684
 685 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
 686
 687 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 688 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 689 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 690 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
 691 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
 692                 const void *buf, size_t count, unsigned int timeout_ms);
 693 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
 694                 const void *buf, size_t count);
 695 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
 696                 size_t count, unsigned int timeout_ms);
 697 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
 698                 size_t count);
 699 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 700                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 701 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 702                 const char *paramstr);
 703 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 704                 int *buflen, gint64 timeout_ms);
 705 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 706                                  uint8_t *buf, size_t *buflen,
 707                                  size_t packet_size,
 708                                  packet_valid_callback is_valid,
 709                                  uint64_t timeout_ms, int baudrate);
 710 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
 711                                       const char **serial_options);
 712 SR_PRIV int serial_source_add(struct sr_session *session,
 713                 struct sr_serial_dev_inst *serial, int events, int timeout,
 714                 sr_receive_data_callback cb, void *cb_data);
 715 SR_PRIV int serial_source_remove(struct sr_session *session,
 716                 struct sr_serial_dev_inst *serial);
 717 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
 718 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
 719 #endif
 720
 721 /*--- hardware/ezusb.c ------------------------------------------------------*/
 722
 723 #ifdef HAVE_LIBUSB_1_0
 724 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 725 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 726                                    const char *filename);
 727 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 728                                   const char *filename);
 729 #endif
 730
 731 /*--- hardware/usb.c --------------------------------------------------------*/
 732
 733 #ifdef HAVE_LIBUSB_1_0
 734 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 735 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 736 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
 737                 int timeout, sr_receive_data_callback cb, void *cb_data);
 738 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
 739 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
 740 #endif
 741
 742 /*--- hardware/scpi.c -------------------------------------------------------*/
 743
 744 #define SCPI_CMD_IDN "*IDN?"
 745 #define SCPI_CMD_OPC "*OPC?"
 746
 747 enum {
 748         SCPI_CMD_SET_TRIGGER_SOURCE,
 749         SCPI_CMD_SET_TIMEBASE,
 750         SCPI_CMD_SET_VERTICAL_DIV,
 751         SCPI_CMD_SET_TRIGGER_SLOPE,
 752         SCPI_CMD_SET_COUPLING,
 753         SCPI_CMD_SET_HORIZ_TRIGGERPOS,
 754         SCPI_CMD_GET_ANALOG_CHAN_STATE,
 755         SCPI_CMD_GET_DIG_CHAN_STATE,
 756         SCPI_CMD_GET_TIMEBASE,
 757         SCPI_CMD_GET_VERTICAL_DIV,
 758         SCPI_CMD_GET_VERTICAL_OFFSET,
 759         SCPI_CMD_GET_TRIGGER_SOURCE,
 760         SCPI_CMD_GET_HORIZ_TRIGGERPOS,
 761         SCPI_CMD_GET_TRIGGER_SLOPE,
 762         SCPI_CMD_GET_COUPLING,
 763         SCPI_CMD_SET_ANALOG_CHAN_STATE,
 764         SCPI_CMD_SET_DIG_CHAN_STATE,
 765         SCPI_CMD_GET_DIG_POD_STATE,
 766         SCPI_CMD_SET_DIG_POD_STATE,
 767         SCPI_CMD_GET_ANALOG_DATA,
 768         SCPI_CMD_GET_DIG_DATA,
 769         SCPI_CMD_GET_SAMPLE_RATE,
 770         SCPI_CMD_GET_SAMPLE_RATE_LIVE,
 771 };
 772
 773 struct sr_scpi_hw_info {
 774         char *manufacturer;
 775         char *model;
 776         char *serial_number;
 777         char *firmware_version;
 778 };
 779
 780 struct sr_scpi_dev_inst {
 781         const char *name;
 782         const char *prefix;
 783         int priv_size;
 784         GSList *(*scan)(struct drv_context *drvc);
 785         int (*dev_inst_new)(void *priv, struct drv_context *drvc,
 786                 const char *resource, char **params, const char *serialcomm);
 787         int (*open)(void *priv);
 788         int (*source_add)(struct sr_session *session, void *priv, int events,
 789                 int timeout, sr_receive_data_callback cb, void *cb_data);
 790         int (*source_remove)(struct sr_session *session, void *priv);
 791         int (*send)(void *priv, const char *command);
 792         int (*read_begin)(void *priv);
 793         int (*read_data)(void *priv, char *buf, int maxlen);
 794         int (*read_complete)(void *priv);
 795         int (*close)(void *priv);
 796         void (*free)(void *priv);
 797         unsigned int read_timeout_ms;
 798         void *priv;
 799 };
 800
 801 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
 802                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
 803 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
 804                 const char *resource, const char *serialcomm);
 805 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
 806 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
 807                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
 808                 sr_receive_data_callback cb, void *cb_data);
 809 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
 810                 struct sr_scpi_dev_inst *scpi);
 811 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 812                 const char *format, ...);
 813 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 814                 const char *format, va_list args);
 815 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
 816 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
 817 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
 818 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
 819 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
 820
 821 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 822                         const char *command, char **scpi_response);
 823 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 824                         const char *command, gboolean *scpi_response);
 825 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 826                         const char *command, int *scpi_response);
 827 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 828                         const char *command, float *scpi_response);
 829 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 830                         const char *command, double *scpi_response);
 831 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
 832 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 833                         const char *command, GArray **scpi_response);
 834 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 835                         const char *command, GArray **scpi_response);
 836 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 837                         struct sr_scpi_hw_info **scpi_response);
 838 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
 839
 840 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
 841
 842 /**
 843  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 844  * so always read 2 blocks at a time.
 845  */
 846 #define ES519XX_11B_PACKET_SIZE (11 * 2)
 847 #define ES519XX_14B_PACKET_SIZE 14
 848
 849 struct es519xx_info {
 850         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
 851         gboolean is_milli, is_resistance, is_continuity, is_diode;
 852         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
 853         gboolean is_temperature, is_celsius, is_fahrenheit;
 854         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
 855         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
 856         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
 857         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
 858         uint32_t baudrate;
 859         int packet_size;
 860         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
 861 };
 862
 863 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 864 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
 865                 struct sr_datafeed_analog *analog, void *info);
 866 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
 867 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
 868                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 869 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 870 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
 871                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 872 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 873 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
 874                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 875 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 876 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
 877                 struct sr_datafeed_analog *analog, void *info);
 878 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 879 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
 880                 struct sr_datafeed_analog *analog, void *info);
 881 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 882 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
 883                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 884
 885 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
 886
 887 #define FS9922_PACKET_SIZE 14
 888
 889 struct fs9922_info {
 890         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
 891         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
 892         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
 893         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
 894         gboolean is_celsius, is_fahrenheit;
 895         int bargraph_sign, bargraph_value;
 896 };
 897
 898 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 899 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 900                             struct sr_datafeed_analog *analog, void *info);
 901 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 902
 903 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
 904
 905 #define FS9721_PACKET_SIZE 14
 906
 907 struct fs9721_info {
 908         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 909         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 910         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 911         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 912 };
 913
 914 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 915 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 916                             struct sr_datafeed_analog *analog, void *info);
 917 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
 918 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
 919 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
 920 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
 921 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
 922
 923 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
 924
 925 #define BBCGM_M2110_PACKET_SIZE 9
 926
 927 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
 928 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
 929                              struct sr_datafeed_analog *analog, void *info);
 930
 931 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
 932
 933 #define METEX14_PACKET_SIZE 14
 934
 935 struct metex14_info {
 936         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 937         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 938         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
 939         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
 940         gboolean is_unitless, is_logic;
 941 };
 942
 943 #ifdef HAVE_LIBSERIALPORT
 944 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 945 #endif
 946 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 947 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 948                              struct sr_datafeed_analog *analog, void *info);
 949
 950 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
 951
 952 #define RS9LCD_PACKET_SIZE 9
 953
 954 /* Dummy info struct. The parser does not use it. */
 955 struct rs9lcd_info { int dummy; };
 956
 957 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 958 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 959                             struct sr_datafeed_analog *analog, void *info);
 960
 961 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
 962
 963 #define BRYMEN_BM25X_PACKET_SIZE 15
 964
 965 /* Dummy info struct. The parser does not use it. */
 966 struct bm25x_info { int dummy; };
 967
 968 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
 969 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
 970                              struct sr_datafeed_analog *analog, void *info);
 971
 972 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
 973
 974 #define UT71X_PACKET_SIZE 11
 975
 976 struct ut71x_info {
 977         gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
 978         gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
 979         gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
 980         gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
 981 };
 982
 983 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
 984 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
 985                 struct sr_datafeed_analog *analog, void *info);
 986
 987 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
 988
 989 SR_PRIV void es51919_serial_clean(void *priv);
 990 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
 991                                                 const char *vendor,
 992                                                 const char *model);
 993 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
 994                                       const struct sr_dev_inst *sdi,
 995                                       const struct sr_channel_group *cg);
 996 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
 997                                       const struct sr_dev_inst *sdi,
 998                                       const struct sr_channel_group *cg);
 999 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1000                                        const struct sr_dev_inst *sdi,
1001                                        const struct sr_channel_group *cg);
1002 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1003                                              void *cb_data);
1004 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1005                                             void *cb_data);
1006
1007 #endif