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 /** Output module instance. */
 172 struct sr_output {
 173         /** A pointer to this output's module.  */
 174         const struct sr_output_module *module;
 175
 176         /**
 177          * The device for which this output module is creating output. This
 178          * can be used by the module to find out channel names and numbers.
 179          */
 180         const struct sr_dev_inst *sdi;
 181
 182         /**
 183          * A generic pointer which can be used by the module to keep internal
 184          * state between calls into its callback functions.
 185          *
 186          * For example, the module might store a pointer to a chunk of output
 187          * there, and only flush it when it reaches a certain size.
 188          */
 189         void *priv;
 190 };
 191
 192 /** Output module driver. */
 193 struct sr_output_module {
 194         /**
 195          * A unique ID for this output module, suitable for use in command-line
 196          * clients, [a-z0-9-]. Must not be NULL.
 197          */
 198         char *id;
 199
 200         /**
 201          * A unique name for this output module, suitable for use in GUI
 202          * clients, can contain UTF-8. Must not be NULL.
 203          */
 204         const char *name;
 205
 206         /**
 207          * A short description of the output module. Must not be NULL.
 208          *
 209          * This can be displayed by frontends, e.g. when selecting the output
 210          * module for saving a file.
 211          */
 212         char *desc;
 213
 214         /**
 215          * Returns a NULL-terminated list of options this module can take.
 216          * Can be NULL, if the module has no options.
 217          */
 218         const struct sr_option *(*options) (void);
 219
 220         /**
 221          * This function is called once, at the beginning of an output stream.
 222          *
 223          * The device struct will be available in the output struct passed in,
 224          * as well as the param field -- which may be NULL or an empty string,
 225          * if no parameter was passed.
 226          *
 227          * The module can use this to initialize itself, create a struct for
 228          * keeping state and storing it in the <code>internal</code> field.
 229          *
 230          * @param o Pointer to the respective 'struct sr_output'.
 231          *
 232          * @retval SR_OK Success
 233          * @retval other Negative error code.
 234          */
 235         int (*init) (struct sr_output *o, GHashTable *options);
 236
 237         /**
 238          * This function is passed a copy of every packed in the data feed.
 239          * Any output generated by the output module in response to the
 240          * packet should be returned in a newly allocated GString
 241          * <code>out</code>, which will be freed by the caller.
 242          *
 243          * Packets not of interest to the output module can just be ignored,
 244          * and the <code>out</code> parameter set to NULL.
 245          *
 246          * @param o Pointer to the respective 'struct sr_output'.
 247          * @param sdi The device instance that generated the packet.
 248          * @param packet The complete packet.
 249          * @param out A pointer where a GString * should be stored if
 250          * the module generates output, or NULL if not.
 251          *
 252          * @retval SR_OK Success
 253          * @retval other Negative error code.
 254          */
 255         int (*receive) (const struct sr_output *o,
 256                         const struct sr_datafeed_packet *packet, GString **out);
 257
 258         /**
 259          * This function is called after the caller is finished using
 260          * the output module, and can be used to free any internal
 261          * resources the module may keep.
 262          *
 263          * @retval SR_OK Success
 264          * @retval other Negative error code.
 265          */
 266         int (*cleanup) (struct sr_output *o);
 267 };
 268
 269 #ifdef HAVE_LIBUSB_1_0
 270 /** USB device instance */
 271 struct sr_usb_dev_inst {
 272         /** USB bus */
 273         uint8_t bus;
 274         /** Device address on USB bus */
 275         uint8_t address;
 276         /** libusb device handle */
 277         struct libusb_device_handle *devhdl;
 278 };
 279 #endif
 280
 281 #ifdef HAVE_LIBSERIALPORT
 282 #define SERIAL_PARITY_NONE SP_PARITY_NONE
 283 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
 284 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
 285 struct sr_serial_dev_inst {
 286         /** Port name, e.g. '/dev/tty42'. */
 287         char *port;
 288         /** Comm params for serial_set_paramstr(). */
 289         char *serialcomm;
 290         /** Port is non-blocking. */
 291         int nonblocking;
 292         /** libserialport port handle */
 293         struct sp_port *data;
 294         /** libserialport event set */
 295         struct sp_event_set *event_set;
 296         /** GPollFDs for event polling */
 297         GPollFD *pollfds;
 298 };
 299 #endif
 300
 301 struct sr_usbtmc_dev_inst {
 302         char *device;
 303         int fd;
 304 };
 305
 306 /* Private driver context. */
 307 struct drv_context {
 308         /** sigrok context */
 309         struct sr_context *sr_ctx;
 310         GSList *instances;
 311 };
 312
 313 /*--- log.c -----------------------------------------------------------------*/
 314
 315 SR_PRIV int sr_log(int loglevel, const char *format, ...);
 316 SR_PRIV int sr_spew(const char *format, ...);
 317 SR_PRIV int sr_dbg(const char *format, ...);
 318 SR_PRIV int sr_info(const char *format, ...);
 319 SR_PRIV int sr_warn(const char *format, ...);
 320 SR_PRIV int sr_err(const char *format, ...);
 321
 322 /* Message logging helpers with subsystem-specific prefix string. */
 323 #ifndef NO_LOG_WRAPPERS
 324 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
 325 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
 326 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
 327 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
 328 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
 329 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
 330 #endif
 331
 332 /*--- device.c --------------------------------------------------------------*/
 333
 334 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
 335 enum {
 336         /** The enabled state of the channel has been changed. */
 337         SR_CHANNEL_SET_ENABLED = 1 << 0,
 338 };
 339
 340 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
 341                 gboolean enabled, const char *name);
 342
 343 /* Generic device instances */
 344 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 345                 const char *vendor, const char *model, const char *version);
 346 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 347
 348 #ifdef HAVE_LIBUSB_1_0
 349 /* USB-specific instances */
 350 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 351                 uint8_t address, struct libusb_device_handle *hdl);
 352 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 353 #endif
 354
 355 #ifdef HAVE_LIBSERIALPORT
 356 /* Serial-specific instances */
 357 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 358                 const char *serialcomm);
 359 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 360 #endif
 361
 362 /* USBTMC-specific instances */
 363 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
 364 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
 365
 366 /*--- hwdriver.c ------------------------------------------------------------*/
 367
 368 SR_PRIV void sr_hw_cleanup_all(void);
 369 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
 370 SR_PRIV void sr_config_free(struct sr_config *src);
 371 SR_PRIV int sr_source_remove(int fd);
 372 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
 373 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
 374 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 375                 sr_receive_data_callback cb, void *cb_data);
 376 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
 377                 sr_receive_data_callback cb, void *cb_data);
 378 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
 379                 sr_receive_data_callback cb, void *cb_data);
 380
 381 /*--- session.c -------------------------------------------------------------*/
 382
 383 struct sr_session {
 384         /** List of struct sr_dev pointers. */
 385         GSList *devs;
 386         /** List of struct datafeed_callback pointers. */
 387         GSList *datafeed_callbacks;
 388         struct sr_trigger *trigger;
 389         GTimeVal starttime;
 390         gboolean running;
 391
 392         unsigned int num_sources;
 393
 394         /*
 395          * Both "sources" and "pollfds" are of the same size and contain pairs
 396          * of descriptor and callback function. We can not embed the GPollFD
 397          * into the source struct since we want to be able to pass the array
 398          * of all poll descriptors to g_poll().
 399          */
 400         struct source *sources;
 401         GPollFD *pollfds;
 402         int source_timeout;
 403
 404         /*
 405          * These are our synchronization primitives for stopping the session in
 406          * an async fashion. We need to make sure the session is stopped from
 407          * within the session thread itself.
 408          */
 409         /** Mutex protecting access to abort_session. */
 410         GMutex stop_mutex;
 411         /** Abort current session. See sr_session_stop(). */
 412         gboolean abort_session;
 413 };
 414
 415 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 416                 const struct sr_datafeed_packet *packet);
 417 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
 418 SR_PRIV int sr_sessionfile_check(const char *filename);
 419
 420 /*--- std.c -----------------------------------------------------------------*/
 421
 422 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
 423 typedef void (*std_dev_clear_callback)(void *priv);
 424
 425 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 426                 const char *prefix);
 427 #ifdef HAVE_LIBSERIALPORT
 428 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
 429 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 430                 void *cb_data, dev_close_callback dev_close_fn,
 431                 struct sr_serial_dev_inst *serial, const char *prefix);
 432 #endif
 433 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 434                 const char *prefix);
 435 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 436                 std_dev_clear_callback clear_private);
 437 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
 438
 439 /*--- strutil.c -------------------------------------------------------------*/
 440
 441 SR_PRIV int sr_atol(const char *str, long *ret);
 442 SR_PRIV int sr_atoi(const char *str, int *ret);
 443 SR_PRIV int sr_atod(const char *str, double *ret);
 444 SR_PRIV int sr_atof(const char *str, float *ret);
 445 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
 446
 447 /*--- soft-trigger.c --------------------------------------------------------*/
 448
 449 struct soft_trigger_logic {
 450         const struct sr_dev_inst *sdi;
 451         const struct sr_trigger *trigger;
 452         int count;
 453         int unitsize;
 454         int cur_stage;
 455         uint8_t *prev_sample;
 456 };
 457
 458 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
 459                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger);
 460 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
 461 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
 462                 int len);
 463
 464 /*--- hardware/common/serial.c ----------------------------------------------*/
 465
 466 #ifdef HAVE_LIBSERIALPORT
 467 enum {
 468         SERIAL_RDWR = 1,
 469         SERIAL_RDONLY = 2,
 470         SERIAL_NONBLOCK = 4,
 471 };
 472
 473 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
 474
 475 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 476 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 477 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 478 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 479                 const void *buf, size_t count);
 480 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
 481                 const void *buf, size_t count);
 482 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
 483                 const void *buf, size_t count);
 484 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 485                 size_t count);
 486 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
 487                 size_t count);
 488 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
 489                 size_t count);
 490 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 491                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 492 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 493                 const char *paramstr);
 494 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 495                 int *buflen, gint64 timeout_ms);
 496 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 497                                  uint8_t *buf, size_t *buflen,
 498                                  size_t packet_size,
 499                                  packet_valid_callback is_valid,
 500                                  uint64_t timeout_ms, int baudrate);
 501 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
 502                                       const char **serial_options);
 503 SR_PRIV int serial_source_add(struct sr_session *session,
 504                 struct sr_serial_dev_inst *serial, int events, int timeout,
 505                 sr_receive_data_callback cb, void *cb_data);
 506 SR_PRIV int serial_source_remove(struct sr_session *session,
 507                 struct sr_serial_dev_inst *serial);
 508 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
 509 #endif
 510
 511 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 512
 513 #ifdef HAVE_LIBUSB_1_0
 514 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 515 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 516                                    const char *filename);
 517 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 518                                   const char *filename);
 519 #endif
 520
 521 /*--- hardware/common/usb.c -------------------------------------------------*/
 522
 523 #ifdef HAVE_LIBUSB_1_0
 524 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 525 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 526 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
 527                 int timeout, sr_receive_data_callback cb, void *cb_data);
 528 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
 529 #endif
 530
 531 /*--- hardware/common/scpi.c ------------------------------------------------*/
 532
 533 #define SCPI_CMD_IDN "*IDN?"
 534 #define SCPI_CMD_OPC "*OPC?"
 535
 536 enum {
 537         SCPI_CMD_SET_TRIGGER_SOURCE,
 538         SCPI_CMD_SET_TIMEBASE,
 539         SCPI_CMD_SET_VERTICAL_DIV,
 540         SCPI_CMD_SET_TRIGGER_SLOPE,
 541         SCPI_CMD_SET_COUPLING,
 542         SCPI_CMD_SET_HORIZ_TRIGGERPOS,
 543         SCPI_CMD_GET_ANALOG_CHAN_STATE,
 544         SCPI_CMD_GET_DIG_CHAN_STATE,
 545         SCPI_CMD_GET_TIMEBASE,
 546         SCPI_CMD_GET_VERTICAL_DIV,
 547         SCPI_CMD_GET_VERTICAL_OFFSET,
 548         SCPI_CMD_GET_TRIGGER_SOURCE,
 549         SCPI_CMD_GET_HORIZ_TRIGGERPOS,
 550         SCPI_CMD_GET_TRIGGER_SLOPE,
 551         SCPI_CMD_GET_COUPLING,
 552         SCPI_CMD_SET_ANALOG_CHAN_STATE,
 553         SCPI_CMD_SET_DIG_CHAN_STATE,
 554         SCPI_CMD_GET_DIG_POD_STATE,
 555         SCPI_CMD_SET_DIG_POD_STATE,
 556         SCPI_CMD_GET_ANALOG_DATA,
 557         SCPI_CMD_GET_DIG_DATA,
 558         SCPI_CMD_GET_SAMPLE_RATE,
 559         SCPI_CMD_GET_SAMPLE_RATE_LIVE,
 560 };
 561
 562 struct sr_scpi_hw_info {
 563         char *manufacturer;
 564         char *model;
 565         char *serial_number;
 566         char *firmware_version;
 567 };
 568
 569 struct sr_scpi_dev_inst {
 570         const char *name;
 571         const char *prefix;
 572         int priv_size;
 573         GSList *(*scan)(struct drv_context *drvc);
 574         int (*dev_inst_new)(void *priv, struct drv_context *drvc,
 575                 const char *resource, char **params, const char *serialcomm);
 576         int (*open)(void *priv);
 577         int (*source_add)(struct sr_session *session, void *priv, int events,
 578                 int timeout, sr_receive_data_callback cb, void *cb_data);
 579         int (*source_remove)(struct sr_session *session, void *priv);
 580         int (*send)(void *priv, const char *command);
 581         int (*read_begin)(void *priv);
 582         int (*read_data)(void *priv, char *buf, int maxlen);
 583         int (*read_complete)(void *priv);
 584         int (*close)(void *priv);
 585         void (*free)(void *priv);
 586         void *priv;
 587 };
 588
 589 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
 590                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
 591 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
 592                 const char *resource, const char *serialcomm);
 593 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
 594 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
 595                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
 596                 sr_receive_data_callback cb, void *cb_data);
 597 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
 598                 struct sr_scpi_dev_inst *scpi);
 599 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 600                 const char *format, ...);
 601 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 602                 const char *format, va_list args);
 603 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
 604 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
 605 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
 606 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
 607 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
 608
 609 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 610                         const char *command, char **scpi_response);
 611 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 612                         const char *command, gboolean *scpi_response);
 613 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 614                         const char *command, int *scpi_response);
 615 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 616                         const char *command, float *scpi_response);
 617 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 618                         const char *command, double *scpi_response);
 619 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
 620 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 621                         const char *command, GArray **scpi_response);
 622 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 623                         const char *command, GArray **scpi_response);
 624 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 625                         struct sr_scpi_hw_info **scpi_response);
 626 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
 627
 628 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
 629
 630 /**
 631  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 632  * so always read 2 blocks at a time.
 633  */
 634 #define ES519XX_11B_PACKET_SIZE (11 * 2)
 635 #define ES519XX_14B_PACKET_SIZE 14
 636
 637 struct es519xx_info {
 638         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
 639         gboolean is_milli, is_resistance, is_continuity, is_diode;
 640         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
 641         gboolean is_temperature, is_celsius, is_fahrenheit;
 642         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
 643         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
 644         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
 645         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
 646         uint32_t baudrate;
 647         int packet_size;
 648         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
 649 };
 650
 651 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 652 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
 653                 struct sr_datafeed_analog *analog, void *info);
 654 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
 655 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
 656                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 657 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 658 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
 659                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 660 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 661 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
 662                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 663 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 664 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
 665                 struct sr_datafeed_analog *analog, void *info);
 666 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 667 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
 668                 struct sr_datafeed_analog *analog, void *info);
 669 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 670 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
 671                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 672
 673 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
 674
 675 #define FS9922_PACKET_SIZE 14
 676
 677 struct fs9922_info {
 678         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
 679         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
 680         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
 681         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
 682         gboolean is_celsius, is_fahrenheit;
 683         int bargraph_sign, bargraph_value;
 684 };
 685
 686 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 687 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 688                             struct sr_datafeed_analog *analog, void *info);
 689 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 690
 691 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
 692
 693 #define FS9721_PACKET_SIZE 14
 694
 695 struct fs9721_info {
 696         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 697         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 698         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 699         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 700 };
 701
 702 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 703 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 704                             struct sr_datafeed_analog *analog, void *info);
 705 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
 706 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
 707 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
 708 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
 709 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
 710
 711 /*--- hardware/common/dmm/m2110.c -----------------------------------------*/
 712
 713 #define BBCGM_M2110_PACKET_SIZE 9
 714
 715 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
 716 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
 717                              struct sr_datafeed_analog *analog, void *info);
 718
 719 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
 720
 721 #define METEX14_PACKET_SIZE 14
 722
 723 struct metex14_info {
 724         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 725         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 726         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
 727         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
 728         gboolean is_unitless, is_logic;
 729 };
 730
 731 #ifdef HAVE_LIBSERIALPORT
 732 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 733 #endif
 734 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 735 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 736                              struct sr_datafeed_analog *analog, void *info);
 737
 738 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
 739
 740 #define RS9LCD_PACKET_SIZE 9
 741
 742 /* Dummy info struct. The parser does not use it. */
 743 struct rs9lcd_info { int dummy; };
 744
 745 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 746 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 747                             struct sr_datafeed_analog *analog, void *info);
 748
 749 /*--- hardware/common/dmm/bm25x.c -----------------------------------------*/
 750
 751 #define BRYMEN_BM25X_PACKET_SIZE 15
 752
 753 /* Dummy info struct. The parser does not use it. */
 754 struct bm25x_info { int dummy; };
 755
 756 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
 757 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
 758                              struct sr_datafeed_analog *analog, void *info);
 759
 760 #endif