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