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