src/hardware/chronovu-la/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2011-2014 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_LA_PROTOCOL_H
  22 #define LIBSIGROK_HARDWARE_CHRONOVU_LA_PROTOCOL_H
  23
  24 #include <glib.h>
  25 #include <libusb.h>
  26 #include <ftdi.h>
  27 #include <stdint.h>
  28 #include <string.h>
  29 #include <libsigrok/libsigrok.h>
  30 #include "libsigrok-internal.h"
  31
  32 #define LOG_PREFIX "la8/la16"
  33
  34 #define SDRAM_SIZE                      (8 * 1024 * 1024)
  35 #define MAX_NUM_SAMPLES                 SDRAM_SIZE
  36
  37 #define BS                              4096 /* Block size */
  38 #define NUM_BLOCKS                      2048 /* Number of blocks */
  39
  40 enum {
  41         CHRONOVU_LA8,
  42         CHRONOVU_LA16,
  43 };
  44
  45 struct cv_profile {
  46         int model;
  47         const char *modelname;
  48         const char *iproduct; /* USB iProduct string */
  49         unsigned int num_channels;
  50         uint64_t max_samplerate;
  51         const int num_trigger_matches;
  52         float trigger_constant;
  53 };
  54
  55 /* Private, per-device-instance driver context. */
  56 struct dev_context {
  57         /** Device profile struct for this device. */
  58         const struct cv_profile *prof;
  59
  60         /** FTDI device context (used by libftdi). */
  61         struct ftdi_context *ftdic;
  62
  63         /** The currently configured samplerate of the device. */
  64         uint64_t cur_samplerate;
  65
  66         /** The current sampling limit (in ms). */
  67         uint64_t limit_msec;
  68
  69         /** The current sampling limit (in number of samples). */
  70         uint64_t limit_samples;
  71
  72         /**
  73          * A buffer containing some (mangled) samples from the device.
  74          * Format: Pretty mangled-up (due to hardware reasons), see code.
  75          */
  76         uint8_t mangled_buf[BS];
  77
  78         /**
  79          * An 8MB buffer where we'll store the de-mangled samples.
  80          * LA8: Each sample is 1 byte, MSB is channel 7, LSB is channel 0.
  81          * LA16: Each sample is 2 bytes, MSB is channel 15, LSB is channel 0.
  82          */
  83         uint8_t *final_buf;
  84
  85         /**
  86          * Trigger pattern.
  87          * A 1 bit matches a high signal, 0 matches a low signal on a channel.
  88          *
  89          * If the resp. 'trigger_edgemask' bit is set, 1 means "rising edge",
  90          * and 0 means "falling edge".
  91          */
  92         uint16_t trigger_pattern;
  93
  94         /**
  95          * Trigger mask.
  96          * A 1 bit means "must match trigger_pattern", 0 means "don't care".
  97          */
  98         uint16_t trigger_mask;
  99
 100         /**
 101          * Trigger edge mask.
 102          * A 1 bit means "edge triggered", 0 means "state triggered".
 103          *
 104          * Edge triggering is only supported on LA16 (but not LA8).
 105          */
 106         uint16_t trigger_edgemask;
 107
 108         /** Tells us whether an SR_DF_TRIGGER packet was already sent. */
 109         int trigger_found;
 110
 111         /** Used for keeping track how much time has passed. */
 112         gint64 done;
 113
 114         /** Counter/index for the data block to be read. */
 115         int block_counter;
 116
 117         /** The divcount value (determines the sample period). */
 118         uint8_t divcount;
 119
 120         /** This ChronoVu device's USB VID/PID. */
 121         uint16_t usb_vid;
 122         uint16_t usb_pid;
 123
 124         /** Samplerates supported by this device. */
 125         uint64_t samplerates[255];
 126 };
 127
 128 /* protocol.c */
 129 extern SR_PRIV const char *cv_channel_names[];
 130 extern const struct cv_profile cv_profiles[];
 131 SR_PRIV void cv_fill_samplerates_if_needed(const struct sr_dev_inst *sdi);
 132 SR_PRIV uint8_t cv_samplerate_to_divcount(const struct sr_dev_inst *sdi,
 133                                           uint64_t samplerate);
 134 SR_PRIV int cv_write(struct dev_context *devc, uint8_t *buf, int size);
 135 SR_PRIV int cv_convert_trigger(const struct sr_dev_inst *sdi);
 136 SR_PRIV int cv_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
 137 SR_PRIV int cv_read_block(struct dev_context *devc);
 138 SR_PRIV void cv_send_block_to_session_bus(const struct sr_dev_inst *sdi, int block);
 139
 140 #endif