]> sigrok.org Git - libsigrok.git/blobdiff - hardware/asix-sigma/asix-sigma.h
build: Portability fixes.
[libsigrok.git] / hardware / asix-sigma / asix-sigma.h
index c4e31c6f877918a029bbce3935cc55f83f38b705..4c9deff68bf480ddbf859fe8eb5c3bd747bad115 100644 (file)
@@ -1,8 +1,30 @@
-#ifndef ASIX_SIGMA_H
-#define ASIX_SIGMA_H
+/*
+ * This file is part of the libsigrok project.
+ *
+ * Copyright (C) 2010 Håvard Espeland <gus@ping.uio.no>,
+ * Copyright (C) 2010 Martin Stensgård <mastensg@ping.uio.no>
+ * Copyright (C) 2010 Carl Henrik Lunde <chlunde@ping.uio.no>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 
-enum sigma_write_register
-{
+#ifndef LIBSIGROK_HARDWARE_ASIX_SIGMA_ASIX_SIGMA_H
+#define LIBSIGROK_HARDWARE_ASIX_SIGMA_ASIX_SIGMA_H
+
+#define LOG_PREFIX "asix-sigma"
+
+enum sigma_write_register {
        WRITE_CLOCK_SELECT      = 0,
        WRITE_TRIGGER_SELECT0   = 1,
        WRITE_TRIGGER_SELECT1   = 2,
@@ -12,11 +34,10 @@ enum sigma_write_register
        WRITE_TRIGGER_OPTION    = 6,
        WRITE_PIN_VIEW          = 7,
 
-       WRITE_TEST              = 15
+       WRITE_TEST              = 15,
 };
 
-enum sigma_read_register
-{
+enum sigma_read_register {
        READ_ID                 = 0,
        READ_TRIGGER_POS_LOW    = 1,
        READ_TRIGGER_POS_HIGH   = 2,
@@ -31,20 +52,23 @@ enum sigma_read_register
        READ_BLOCK_LAST_TS_HIGH = 11,
        READ_PIN_VIEW           = 12,
 
-       READ_TEST               = 15
+       READ_TEST               = 15,
 };
 
-#define REG_ADDR_LOW           (0 << 4)
-#define REG_ADDR_HIGH          (1 << 4)
-#define REG_DATA_LOW           (2 << 4)
-#define REG_DATA_HIGH_WRITE    (3 << 4)
-#define REG_READ_ADDR          (4 << 4)
-#define REG_DRAM_WAIT_ACK      (5 << 4)
+#define REG_ADDR_LOW           (0x0 << 4)
+#define REG_ADDR_HIGH          (0x1 << 4)
+#define REG_DATA_LOW           (0x2 << 4)
+#define REG_DATA_HIGH_WRITE    (0x3 << 4)
+#define REG_READ_ADDR          (0x4 << 4)
+#define REG_DRAM_WAIT_ACK      (0x5 << 4)
 
 /* Bit (1 << 4) can be low or high (double buffer / cache) */
-#define REG_DRAM_BLOCK         (6 << 4)
-#define REG_DRAM_BLOCK_BEGIN   (8 << 4)
-#define REG_DRAM_BLOCK_DATA    (10 << 4)
+#define REG_DRAM_BLOCK         (0x6 << 4)
+#define REG_DRAM_BLOCK_BEGIN   (0x8 << 4)
+#define REG_DRAM_BLOCK_DATA    (0xa << 4)
+
+#define LEDSEL0                        6
+#define LEDSEL1                        7
 
 #define NEXT_REG               1
 
@@ -52,6 +76,136 @@ enum sigma_read_register
 
 #define CHUNK_SIZE             1024
 
-#endif /* ASIX_SIGMA_H */
+/*
+ * The entire ASIX Sigma DRAM is an array of struct sigma_dram_line[1024];
+ */
+
+/* One "DRAM cluster" contains a timestamp and 7 samples, 16b total. */
+struct sigma_dram_cluster {
+       uint8_t         timestamp_lo;
+       uint8_t         timestamp_hi;
+       struct {
+               uint8_t sample_hi;
+               uint8_t sample_lo;
+       }               samples[7];
+};
+
+/* One "DRAM line" contains 64 "DRAM clusters", 1024b total. */
+struct sigma_dram_line {
+       struct sigma_dram_cluster       cluster[64];
+};
+
+struct clockselect_50 {
+       uint8_t async;
+       uint8_t fraction;
+       uint16_t disabled_channels;
+};
+
+/* The effect of all these are still a bit unclear. */
+struct triggerinout {
+       uint8_t trgout_resistor_enable : 1;
+       uint8_t trgout_resistor_pullup : 1;
+       uint8_t reserved1 : 1;
+       uint8_t trgout_bytrigger : 1;
+       uint8_t trgout_byevent : 1;
+       uint8_t trgout_bytriggerin : 1;
+       uint8_t reserved2 : 2;
+
+       /* Should be set same as the first two */
+       uint8_t trgout_resistor_enable2 : 1;
+       uint8_t trgout_resistor_pullup2 : 1;
+
+       uint8_t reserved3 : 1;
+       uint8_t trgout_long : 1;
+       uint8_t trgout_pin : 1; /* Use 1k resistor. Pullup? */
+       uint8_t trgin_negate : 1;
+       uint8_t trgout_enable : 1;
+       uint8_t trgin_enable : 1;
+};
+
+struct triggerlut {
+       /* The actual LUTs. */
+       uint16_t m0d[4], m1d[4], m2d[4];
+       uint16_t m3, m3s, m4;
+
+       /* Paramters should be sent as a single register write. */
+       struct {
+               uint8_t selc : 2;
+               uint8_t selpresc : 6;
+
+               uint8_t selinc : 2;
+               uint8_t selres : 2;
+               uint8_t sela : 2;
+               uint8_t selb : 2;
+
+               uint16_t cmpb;
+               uint16_t cmpa;
+       } params;
+};
+
+/* Trigger configuration */
+struct sigma_trigger {
+       /* Only two channels can be used in mask. */
+       uint16_t risingmask;
+       uint16_t fallingmask;
+
+       /* Simple trigger support (<= 50 MHz). */
+       uint16_t simplemask;
+       uint16_t simplevalue;
+
+       /* TODO: Advanced trigger support (boolean expressions). */
+};
+
+/* Events for trigger operation. */
+enum triggerop {
+       OP_LEVEL = 1,
+       OP_NOT,
+       OP_RISE,
+       OP_FALL,
+       OP_RISEFALL,
+       OP_NOTRISE,
+       OP_NOTFALL,
+       OP_NOTRISEFALL,
+};
+
+/* Logical functions for trigger operation. */
+enum triggerfunc {
+       FUNC_AND = 1,
+       FUNC_NAND,
+       FUNC_OR,
+       FUNC_NOR,
+       FUNC_XOR,
+       FUNC_NXOR,
+};
+
+struct sigma_state {
+       enum {
+               SIGMA_UNINITIALIZED = 0,
+               SIGMA_IDLE,
+               SIGMA_CAPTURE,
+               SIGMA_DOWNLOAD,
+       } state;
+
+       uint16_t lastts;
+       uint16_t lastsample;
+};
+
+/* Private, per-device-instance driver context. */
+struct dev_context {
+       struct ftdi_context ftdic;
+       uint64_t cur_samplerate;
+       uint64_t period_ps;
+       uint64_t limit_msec;
+       struct timeval start_tv;
+       int cur_firmware;
+       int num_channels;
+       int cur_channels;
+       int samples_per_event;
+       int capture_ratio;
+       struct sigma_trigger trigger;
+       int use_triggers;
+       struct sigma_state state;
+       void *cb_data;
+};
 
-// vim:noexpandtab:ts=8 sts=8 sw=8
+#endif