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