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  *
   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 #ifndef LIBSIGROK_HARDWARE_SALEAE_LOGIC16_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_SALEAE_LOGIC16_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include <glib.h>
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27
  28 /* Message logging helpers with subsystem-specific prefix string. */
  29 #define LOG_PREFIX "saleae-logic16: "
  30 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  31 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  32 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  33 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  34 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  35 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  36
  37 enum voltage_range {
  38         VOLTAGE_RANGE_UNKNOWN,
  39         VOLTAGE_RANGE_18_33_V,  /* 1.8V and 3.3V logic */
  40         VOLTAGE_RANGE_5_V,      /* 5V logic */
  41 };
  42
  43 /** Private, per-device-instance driver context. */
  44 struct dev_context {
  45         /*
  46          * Since we can't keep track of a Logic16 device after upgrading
  47          * the firmware (it renumerates into a different device address
  48          * after the upgrade) this is like a global lock. No device will open
  49          * until a proper delay after the last device was upgraded.
  50          */
  51         int64_t fw_updated;
  52
  53         /** The currently configured samplerate of the device. */
  54         uint64_t cur_samplerate;
  55
  56         /** Maximum number of samples to capture, if nonzero */
  57         uint64_t limit_samples;
  58
  59         /** The currently configured input voltage of the device */
  60         enum voltage_range cur_voltage_range;
  61
  62         /** The input voltage selected by the user */
  63         enum voltage_range selected_voltage_range;
  64
  65         /** Channels to use */
  66         uint16_t cur_channels;
  67
  68         /*
  69          * EEPROM data from address 8
  70          */
  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         int *usbfd;
  86 };
  87
  88 SR_PRIV int saleae_logic16_setup_acquisition(const struct sr_dev_inst *sdi,
  89                                              uint64_t samplerate,
  90                                              uint16_t channels);
  91 SR_PRIV int saleae_logic16_start_acquisition(const struct sr_dev_inst *sdi);
  92 SR_PRIV int saleae_logic16_abort_acquisition(const struct sr_dev_inst *sdi);
  93 SR_PRIV int saleae_logic16_init_device(const struct sr_dev_inst *sdi);
  94 SR_PRIV void saleae_logic16_receive_transfer(struct libusb_transfer *transfer);
  95
  96 #endif