hardware/ikalogic-scanaplus/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef LIBSIGROK_HARDWARE_IKALOGIC_SCANAPLUS_PROTOCOL_H
  22 #define LIBSIGROK_HARDWARE_IKALOGIC_SCANAPLUS_PROTOCOL_H
  23
  24 #include <stdint.h>
  25 #include <string.h>
  26 #include <glib.h>
  27 #include <ftdi.h>
  28 #include "libsigrok.h"
  29 #include "libsigrok-internal.h"
  30
  31 /* Message logging helpers with subsystem-specific prefix string. */
  32 #define LOG_PREFIX "scanaplus: "
  33 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  34 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  35 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  36 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  37 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  38 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  39
  40 #define COMPRESSED_BUF_SIZE             (64 * 1024)
  41
  42 /* Private, per-device-instance driver context. */
  43 struct dev_context {
  44         /** FTDI device context (used by libftdi). */
  45         struct ftdi_context *ftdic;
  46
  47         /** The current sampling limit (in ms). */
  48         uint64_t limit_msec;
  49
  50         /** The current sampling limit (in number of samples). */
  51         uint64_t limit_samples;
  52
  53         void *cb_data;
  54
  55         uint8_t *compressed_buf;
  56         uint64_t compressed_bytes_ignored;
  57         uint8_t *sample_buf;
  58         uint64_t bytes_received;
  59         uint64_t samples_sent;
  60
  61         /** ScanaPLUS unique device ID (3 bytes). */
  62         uint8_t devid[3];
  63 };
  64
  65 SR_PRIV int scanaplus_close(struct dev_context *devc);
  66 SR_PRIV int scanaplus_get_device_id(struct dev_context *devc);
  67 SR_PRIV int scanaplus_init(struct dev_context *devc);
  68 SR_PRIV int scanaplus_start_acquisition(struct dev_context *devc);
  69 SR_PRIV int scanaplus_receive_data(int fd, int revents, void *cb_data);
  70
  71 #endif