hardware/openbench-logic-sniffer/protocol.h

   1 /*
   2  * This file is part of the sigrok 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 /* Message logging helpers with driver-specific prefix string. */
  30 #define DRIVER_LOG_DOMAIN "ols: "
  31 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  32 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  33 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  34 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  35 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  36 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  37
  38 #define NUM_PROBES             32
  39 #define NUM_TRIGGER_STAGES     4
  40 #define TRIGGER_TYPE           "01"
  41 #define SERIAL_SPEED           B115200
  42 #define CLOCK_RATE             SR_MHZ(100)
  43 #define MIN_NUM_SAMPLES        4
  44
  45 /* Command opcodes */
  46 #define CMD_RESET                  0x00
  47 #define CMD_RUN                    0x01
  48 #define CMD_ID                     0x02
  49 #define CMD_METADATA               0x04
  50 #define CMD_SET_FLAGS              0x82
  51 #define CMD_SET_DIVIDER            0x80
  52 #define CMD_CAPTURE_SIZE           0x81
  53 #define CMD_SET_TRIGGER_MASK_0     0xc0
  54 #define CMD_SET_TRIGGER_MASK_1     0xc4
  55 #define CMD_SET_TRIGGER_MASK_2     0xc8
  56 #define CMD_SET_TRIGGER_MASK_3     0xcc
  57 #define CMD_SET_TRIGGER_VALUE_0    0xc1
  58 #define CMD_SET_TRIGGER_VALUE_1    0xc5
  59 #define CMD_SET_TRIGGER_VALUE_2    0xc9
  60 #define CMD_SET_TRIGGER_VALUE_3    0xcd
  61 #define CMD_SET_TRIGGER_CONFIG_0   0xc2
  62 #define CMD_SET_TRIGGER_CONFIG_1   0xc6
  63 #define CMD_SET_TRIGGER_CONFIG_2   0xca
  64 #define CMD_SET_TRIGGER_CONFIG_3   0xce
  65
  66 /* Bitmasks for CMD_FLAGS */
  67 #define FLAG_DEMUX                 0x01
  68 #define FLAG_FILTER                0x02
  69 #define FLAG_CHANNELGROUP_1        0x04
  70 #define FLAG_CHANNELGROUP_2        0x08
  71 #define FLAG_CHANNELGROUP_3        0x10
  72 #define FLAG_CHANNELGROUP_4        0x20
  73 #define FLAG_CLOCK_EXTERNAL        0x40
  74 #define FLAG_CLOCK_INVERTED        0x80
  75 #define FLAG_RLE                   0x0100
  76
  77 /* Private, per-device-instance driver context. */
  78 struct dev_context {
  79         uint32_t max_samplerate;
  80         uint32_t max_samples;
  81         uint32_t protocol_version;
  82
  83         uint64_t cur_samplerate;
  84         uint32_t cur_samplerate_divider;
  85         uint64_t limit_samples;
  86         /* Current state of the flag register */
  87         uint32_t flag_reg;
  88
  89         /* Pre/post trigger capture ratio, in percentage.
  90          * 0 means no pre-trigger data. */
  91         int capture_ratio;
  92         int trigger_at;
  93         uint32_t probe_mask;
  94         uint32_t trigger_mask[4];
  95         uint32_t trigger_value[4];
  96         int num_stages;
  97
  98         unsigned int num_transfers;
  99         unsigned int num_samples;
 100         int rle_count;
 101         int num_bytes;
 102         unsigned char sample[4];
 103         unsigned char tmp_sample[4];
 104         unsigned char *raw_sample_buf;
 105
 106         struct sr_serial_dev_inst *serial;
 107 };
 108
 109
 110 SR_PRIV extern const char *ols_probe_names[NUM_PROBES + 1];
 111
 112 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
 113                 uint8_t command);
 114 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
 115                 uint8_t command, uint32_t data);
 116 SR_PRIV int ols_configure_probes(const struct sr_dev_inst *sdi);
 117 SR_PRIV uint32_t reverse16(uint32_t in);
 118 SR_PRIV uint32_t reverse32(uint32_t in);
 119 SR_PRIV struct dev_context *ols_dev_new(void);
 120 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial);
 121 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
 122                                uint64_t samplerate,
 123                                const struct sr_samplerates *samplerates);
 124 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
 125 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);
 126
 127 #endif