hardware/chronovu-la8/driver.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2011-2012 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_CHRONOVU_LA8_DRIVER_H
  22 #define LIBSIGROK_HARDWARE_CHRONOVU_LA8_DRIVER_H
  23
  24 #include <glib.h>
  25 #include <ftdi.h>
  26 #include <stdint.h>
  27 #include "libsigrok.h"
  28 #include "libsigrok-internal.h"
  29
  30 #define USB_VENDOR_ID                   0x0403
  31 #define USB_DESCRIPTION                 "ChronoVu LA8"
  32 #define USB_VENDOR_NAME                 "ChronoVu"
  33 #define USB_MODEL_NAME                  "LA8"
  34 #define USB_MODEL_VERSION               ""
  35
  36 #define NUM_PROBES                      8
  37 #define TRIGGER_TYPES                   "01"
  38 #define SDRAM_SIZE                      (8 * 1024 * 1024)
  39 #define MIN_NUM_SAMPLES                 1
  40
  41 #define BS                              4096 /* Block size */
  42 #define NUM_BLOCKS                      2048 /* Number of blocks */
  43
  44 /* Private driver context. */
  45 struct drv_context {
  46         GSList *instances;
  47 };
  48
  49 /* Private, per-device-instance driver context. */
  50 struct dev_context {
  51         /** FTDI device context (used by libftdi). */
  52         struct ftdi_context *ftdic;
  53
  54         /** The currently configured samplerate of the device. */
  55         uint64_t cur_samplerate;
  56
  57         /** The current sampling limit (in ms). */
  58         uint64_t limit_msec;
  59
  60         /** The current sampling limit (in number of samples). */
  61         uint64_t limit_samples;
  62
  63         /** TODO */
  64         void *session_dev_id;
  65
  66         /**
  67          * A buffer containing some (mangled) samples from the device.
  68          * Format: Pretty mangled-up (due to hardware reasons), see code.
  69          */
  70         uint8_t mangled_buf[BS];
  71
  72         /**
  73          * An 8MB buffer where we'll store the de-mangled samples.
  74          * Format: Each sample is 1 byte, MSB is channel 7, LSB is channel 0.
  75          */
  76         uint8_t *final_buf;
  77
  78         /**
  79          * Trigger pattern (MSB = channel 7, LSB = channel 0).
  80          * A 1 bit matches a high signal, 0 matches a low signal on a probe.
  81          * Only low/high triggers (but not e.g. rising/falling) are supported.
  82          */
  83         uint8_t trigger_pattern;
  84
  85         /**
  86          * Trigger mask (MSB = channel 7, LSB = channel 0).
  87          * A 1 bit means "must match trigger_pattern", 0 means "don't care".
  88          */
  89         uint8_t trigger_mask;
  90
  91         /** Time (in seconds) before the trigger times out. */
  92         uint64_t trigger_timeout;
  93
  94         /** Tells us whether an SR_DF_TRIGGER packet was already sent. */
  95         int trigger_found;
  96
  97         /** TODO */
  98         time_t done;
  99
 100         /** Counter/index for the data block to be read. */
 101         int block_counter;
 102
 103         /** The divcount value (determines the sample period) for the LA8. */
 104         uint8_t divcount;
 105
 106         /** This ChronoVu LA8's USB PID (multiple versions exist). */
 107         uint16_t usb_pid;
 108 };
 109
 110 /* driver.c */
 111 extern SR_PRIV uint64_t supported_samplerates[];
 112 extern SR_PRIV const int hwcaps[];
 113 extern SR_PRIV const char *probe_names[];
 114 extern const struct sr_samplerates samplerates;
 115 SR_PRIV void fill_supported_samplerates_if_needed(void);
 116 SR_PRIV int is_valid_samplerate(uint64_t samplerate);
 117 SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate);
 118 SR_PRIV int la8_write(struct dev_context *devc, uint8_t *buf, int size);
 119 SR_PRIV int la8_read(struct dev_context *devc, uint8_t *buf, int size);
 120 SR_PRIV int la8_close(struct dev_context *devc);
 121 SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc);
 122 SR_PRIV int la8_reset(struct dev_context *devc);
 123 SR_PRIV int configure_probes(struct dev_context *devc, const GSList *probes);
 124 SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
 125 SR_PRIV int la8_read_block(struct dev_context *devc);
 126 SR_PRIV void send_block_to_session_bus(struct dev_context *devc, int block);
 127
 128 #endif