hardware/saleae-logic16/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
   5  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   6  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef LIBSIGROK_HARDWARE_SALEAE_LOGIC16_PROTOCOL_H
  23 #define LIBSIGROK_HARDWARE_SALEAE_LOGIC16_PROTOCOL_H
  24
  25 #include <stdint.h>
  26 #include <glib.h>
  27 #include "libsigrok.h"
  28 #include "libsigrok-internal.h"
  29
  30 /* Message logging helpers with subsystem-specific prefix string. */
  31 #define LOG_PREFIX "saleae-logic16: "
  32 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  33 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  34 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  35 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  36 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  37 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  38
  39 enum voltage_range {
  40         VOLTAGE_RANGE_UNKNOWN,
  41         VOLTAGE_RANGE_18_33_V,  /* 1.8V and 3.3V logic */
  42         VOLTAGE_RANGE_5_V,      /* 5V logic */
  43 };
  44
  45 /** Private, per-device-instance driver context. */
  46 struct dev_context {
  47         /*
  48          * Since we can't keep track of a Logic16 device after upgrading
  49          * the firmware (it renumerates into a different device address
  50          * after the upgrade) this is like a global lock. No device will open
  51          * until a proper delay after the last device was upgraded.
  52          */
  53         int64_t fw_updated;
  54
  55         /** The currently configured samplerate of the device. */
  56         uint64_t cur_samplerate;
  57
  58         /** Maximum number of samples to capture, if nonzero. */
  59         uint64_t limit_samples;
  60
  61         /** The currently configured input voltage of the device. */
  62         enum voltage_range cur_voltage_range;
  63
  64         /** The input voltage selected by the user. */
  65         enum voltage_range selected_voltage_range;
  66
  67         /** Channels to use. */
  68         uint16_t cur_channels;
  69
  70         /* EEPROM data from address 8. */
  71         uint8_t eeprom_data[8];
  72
  73         int64_t num_samples;
  74         int submitted_transfers;
  75         int empty_transfer_count;
  76         int num_channels, cur_channel;
  77         uint16_t channel_masks[16];
  78         uint16_t channel_data[16];
  79         uint8_t *convbuffer;
  80         size_t convbuffer_size;
  81
  82         void *cb_data;
  83         unsigned int num_transfers;
  84         struct libusb_transfer **transfers;
  85         struct sr_context *ctx;
  86 };
  87
  88 SR_PRIV int logic16_setup_acquisition(const struct sr_dev_inst *sdi,
  89                         uint64_t samplerate, uint16_t channels);
  90 SR_PRIV int logic16_start_acquisition(const struct sr_dev_inst *sdi);
  91 SR_PRIV int logic16_abort_acquisition(const struct sr_dev_inst *sdi);
  92 SR_PRIV int logic16_init_device(const struct sr_dev_inst *sdi);
  93 SR_PRIV void logic16_receive_transfer(struct libusb_transfer *transfer);
  94
  95 #endif