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