src/hardware/openbench-logic-sniffer/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   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_OPENBENCH_LOGIC_SNIFFER_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_OPENBENCH_LOGIC_SNIFFER_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include <string.h>
  25 #include <glib.h>
  26 #include <libsigrok/libsigrok.h>
  27 #include "libsigrok-internal.h"
  28
  29 #define LOG_PREFIX "openbench-logic-sniffer"
  30
  31 #define NUM_TRIGGER_STAGES         4
  32 #define CLOCK_RATE                 SR_MHZ(100)
  33 #define MIN_NUM_SAMPLES            4
  34 #define DEFAULT_SAMPLERATE         SR_KHZ(200)
  35
  36 /* Command opcodes */
  37 #define CMD_RESET                  0x00
  38 #define CMD_RUN                    0x01
  39 #define CMD_ID                     0x02
  40 #define CMD_METADATA               0x04
  41 #define CMD_SET_DIVIDER            0x80
  42 #define CMD_CAPTURE_SIZE           0x81
  43 #define CMD_SET_FLAGS              0x82
  44 #define CMD_CAPTURE_DELAYCOUNT     0x83         /* extension for Pepino */
  45 #define CMD_CAPTURE_READCOUNT      0x84         /* extension for Pepino */
  46 #define CMD_SET_TRIGGER_MASK       0xc0
  47 #define CMD_SET_TRIGGER_VALUE      0xc1
  48 #define CMD_SET_TRIGGER_CONFIG     0xc2
  49
  50 /* Trigger config */
  51 #define TRIGGER_START              (1 << 3)
  52
  53 /* Bit mask used for "set flags" command (0x82) */
  54 /* Take care about bit positions in diagrams, they are inverted. */
  55 #define CAPTURE_FLAG_RLEMODE1            (1 << 15)
  56 #define CAPTURE_FLAG_RLEMODE0            (1 << 14)
  57 #define CAPTURE_FLAG_RESERVED1           (1 << 13)
  58 #define CAPTURE_FLAG_RESERVED0           (1 << 12)
  59 #define CAPTURE_FLAG_INTERNAL_TEST_MODE  (1 << 11)
  60 #define CAPTURE_FLAG_EXTERNAL_TEST_MODE  (1 << 10)
  61 #define CAPTURE_FLAG_SWAP_CHANNELS       (1 << 9)
  62 #define CAPTURE_FLAG_RLE                 (1 << 8)
  63 #define CAPTURE_FLAG_INVERT_EXT_CLOCK    (1 << 7)
  64 #define CAPTURE_FLAG_CLOCK_EXTERNAL      (1 << 6)
  65 #define CAPTURE_FLAG_DISABLE_CHANGROUP_4 (1 << 5)
  66 #define CAPTURE_FLAG_DISABLE_CHANGROUP_3 (1 << 4)
  67 #define CAPTURE_FLAG_DISABLE_CHANGROUP_2 (1 << 3)
  68 #define CAPTURE_FLAG_DISABLE_CHANGROUP_1 (1 << 2)
  69 #define CAPTURE_FLAG_NOISE_FILTER        (1 << 1)
  70 #define CAPTURE_FLAG_DEMUX               (1 << 0)
  71
  72 /* Capture context magic numbers */
  73 #define OLS_NO_TRIGGER (-1)
  74
  75 struct dev_context {
  76         /* constant device properties: */
  77         int max_channels;
  78         uint32_t max_samples;
  79         uint32_t max_samplerate;
  80         uint32_t protocol_version;
  81
  82         /* acquisition-related properties: */
  83         uint64_t cur_samplerate;
  84         uint32_t cur_samplerate_divider;
  85         uint64_t limit_samples;
  86         uint64_t capture_ratio;
  87         int trigger_at_smpl;
  88         uint32_t channel_mask;
  89         uint32_t trigger_mask[NUM_TRIGGER_STAGES];
  90         uint32_t trigger_value[NUM_TRIGGER_STAGES];
  91         int num_stages;
  92         uint16_t capture_flags;
  93
  94         unsigned int num_transfers;
  95         unsigned int num_samples;
  96         int num_bytes;
  97         int cnt_bytes;
  98         int cnt_samples;
  99         int cnt_samples_rle;
 100
 101         unsigned int rle_count;
 102         unsigned char sample[4];
 103         unsigned char tmp_sample[4];
 104         unsigned char *raw_sample_buf;
 105 };
 106
 107 SR_PRIV extern const char *ols_channel_names[];
 108
 109 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
 110                 uint8_t command);
 111 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
 112                 uint8_t command, uint8_t *data);
 113 SR_PRIV int ols_send_reset(struct sr_serial_dev_inst *serial);
 114 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi);
 115 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi);
 116 SR_PRIV struct dev_context *ols_dev_new(void);
 117 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial);
 118 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
 119                 uint64_t samplerate);
 120 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
 121 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);
 122
 123 #endif