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.h"
  27 #include "libsigrok-internal.h"
  28
  29 #define LOG_PREFIX "ols"
  30
  31 #define NUM_CHANNELS               32
  32 #define NUM_TRIGGER_STAGES         4
  33 #define SERIAL_SPEED               B115200
  34 #define CLOCK_RATE                 SR_MHZ(100)
  35 #define MIN_NUM_SAMPLES            4
  36 #define DEFAULT_SAMPLERATE         SR_KHZ(200)
  37
  38 /* Command opcodes */
  39 #define CMD_RESET                  0x00
  40 #define CMD_RUN                    0x01
  41 #define CMD_TESTMODE               0x03
  42 #define CMD_ID                     0x02
  43 #define CMD_METADATA               0x04
  44 #define CMD_SET_FLAGS              0x82
  45 #define CMD_SET_DIVIDER            0x80
  46 #define CMD_CAPTURE_SIZE           0x81
  47 #define CMD_SET_TRIGGER_MASK       0xc0
  48 #define CMD_SET_TRIGGER_VALUE      0xc1
  49 #define CMD_SET_TRIGGER_CONFIG     0xc2
  50
  51 /* Trigger config */
  52 #define TRIGGER_START              (1 << 3)
  53
  54 /* Bitmasks for CMD_FLAGS */
  55 /* 12-13 unused, 14-15 RLE mode (we hardcode mode 0). */
  56 #define FLAG_INTERNAL_TEST_MODE    (1 << 11)
  57 #define FLAG_EXTERNAL_TEST_MODE    (1 << 10)
  58 #define FLAG_SWAP_CHANNELS         (1 << 9)
  59 #define FLAG_RLE                   (1 << 8)
  60 #define FLAG_SLOPE_FALLING         (1 << 7)
  61 #define FLAG_CLOCK_EXTERNAL        (1 << 6)
  62 #define FLAG_CHANNELGROUP_4        (1 << 5)
  63 #define FLAG_CHANNELGROUP_3        (1 << 4)
  64 #define FLAG_CHANNELGROUP_2        (1 << 3)
  65 #define FLAG_CHANNELGROUP_1        (1 << 2)
  66 #define FLAG_FILTER                (1 << 1)
  67 #define FLAG_DEMUX                 (1 << 0)
  68
  69 /* Private, per-device-instance driver context. */
  70 struct dev_context {
  71         /* Fixed device settings */
  72         int max_channels;
  73         uint32_t max_samples;
  74         uint32_t max_samplerate;
  75         uint32_t protocol_version;
  76
  77         /* Acquisition settings */
  78         uint64_t cur_samplerate;
  79         uint32_t cur_samplerate_divider;
  80         uint64_t limit_samples;
  81         int capture_ratio;
  82         int trigger_at;
  83         uint32_t channel_mask;
  84         uint32_t trigger_mask[NUM_TRIGGER_STAGES];
  85         uint32_t trigger_value[NUM_TRIGGER_STAGES];
  86         int num_stages;
  87         uint16_t flag_reg;
  88
  89         /* Operational states */
  90         unsigned int num_transfers;
  91         unsigned int num_samples;
  92         int num_bytes;
  93         int cnt_bytes;
  94         int cnt_samples;
  95         int cnt_samples_rle;
  96
  97         /* Temporary variables */
  98         unsigned int rle_count;
  99         unsigned char sample[4];
 100         unsigned char tmp_sample[4];
 101         unsigned char *raw_sample_buf;
 102 };
 103
 104 SR_PRIV extern const char *ols_channel_names[];
 105
 106 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
 107                 uint8_t command);
 108 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
 109                 uint8_t command, uint8_t *data);
 110 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi);
 111 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi);
 112 SR_PRIV struct dev_context *ols_dev_new(void);
 113 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial);
 114 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
 115                 uint64_t samplerate);
 116 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
 117 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);
 118
 119 #endif