[libsigrok.git] / src / hardware / openbench-logic-sniffer / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
 *
 * 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/>.
 */

#ifndef LIBSIGROK_HARDWARE_OPENBENCH_LOGIC_SNIFFER_PROTOCOL_H
#define LIBSIGROK_HARDWARE_OPENBENCH_LOGIC_SNIFFER_PROTOCOL_H

#include <stdint.h>
#include <string.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "openbench-logic-sniffer"

#define NUM_TRIGGER_STAGES         4
#define CLOCK_RATE                 SR_MHZ(100)
#define MIN_NUM_SAMPLES            4
#define DEFAULT_SAMPLERATE         SR_KHZ(200)

/* Command opcodes */
#define CMD_RESET                  0x00
#define CMD_RUN                    0x01
#define CMD_ID                     0x02
#define CMD_TESTMODE               0x03
#define CMD_METADATA               0x04
#define CMD_SET_DIVIDER            0x80
#define CMD_CAPTURE_SIZE           0x81
#define CMD_SET_FLAGS              0x82
#define CMD_CAPTURE_DELAYCOUNT     0x83		/* extension for Pepino */
#define CMD_CAPTURE_READCOUNT      0x84		/* extension for Pepino */
#define CMD_SET_TRIGGER_MASK       0xc0
#define CMD_SET_TRIGGER_VALUE      0xc1
#define CMD_SET_TRIGGER_CONFIG     0xc2

/* Trigger config */
#define TRIGGER_START              (1 << 3)

/* Bitmasks for CMD_FLAGS */
/* 12-13 unused, 14-15 RLE mode (we hardcode mode 0). */
#define FLAG_INTERNAL_TEST_MODE    (1 << 11)
#define FLAG_EXTERNAL_TEST_MODE    (1 << 10)
#define FLAG_SWAP_CHANNELS         (1 << 9)
#define FLAG_RLE                   (1 << 8)
#define FLAG_SLOPE_FALLING         (1 << 7)
#define FLAG_CLOCK_EXTERNAL        (1 << 6)
#define FLAG_CHANNELGROUP_4        (1 << 5)
#define FLAG_CHANNELGROUP_3        (1 << 4)
#define FLAG_CHANNELGROUP_2        (1 << 3)
#define FLAG_CHANNELGROUP_1        (1 << 2)
#define FLAG_FILTER                (1 << 1)
#define FLAG_DEMUX                 (1 << 0)

struct dev_context {
	/* constant device properties: */
	int max_channels;
	uint32_t max_samples;
	uint32_t max_samplerate;
	uint32_t protocol_version;

	/* acquisition-related properties: */
	uint64_t cur_samplerate;
	uint32_t cur_samplerate_divider;
	uint64_t limit_samples;
	uint64_t capture_ratio;
	int trigger_at;
	uint32_t channel_mask;
	uint32_t trigger_mask[NUM_TRIGGER_STAGES];
	uint32_t trigger_value[NUM_TRIGGER_STAGES];
	int num_stages;
	uint16_t flag_reg;

	unsigned int num_transfers;
	unsigned int num_samples;
	int num_bytes;
	int cnt_bytes;
	int cnt_samples;
	int cnt_samples_rle;

	unsigned int rle_count;
	unsigned char sample[4];
	unsigned char tmp_sample[4];
	unsigned char *raw_sample_buf;
};

SR_PRIV extern const char *ols_channel_names[];

SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
		uint8_t command);
SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
		uint8_t command, uint8_t *data);
SR_PRIV int ols_send_reset(struct sr_serial_dev_inst *serial);
SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi);
SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi);
SR_PRIV struct dev_context *ols_dev_new(void);
SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial);
SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
		uint64_t samplerate);
SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);

#endif
Commit	Line	Data
	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_TESTMODE 0x03
	41	#define CMD_METADATA 0x04
	42	#define CMD_SET_DIVIDER 0x80
	43	#define CMD_CAPTURE_SIZE 0x81
	44	#define CMD_SET_FLAGS 0x82
	45	#define CMD_CAPTURE_DELAYCOUNT 0x83 /* extension for Pepino */
	46	#define CMD_CAPTURE_READCOUNT 0x84 /* extension for Pepino */
	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	struct dev_context {
	70	/* constant device properties: */
	71	int max_channels;
	72	uint32_t max_samples;
	73	uint32_t max_samplerate;
	74	uint32_t protocol_version;
	75
	76	/* acquisition-related properties: */
	77	uint64_t cur_samplerate;
	78	uint32_t cur_samplerate_divider;
	79	uint64_t limit_samples;
	80	uint64_t capture_ratio;
	81	int trigger_at;
	82	uint32_t channel_mask;
	83	uint32_t trigger_mask[NUM_TRIGGER_STAGES];
	84	uint32_t trigger_value[NUM_TRIGGER_STAGES];
	85	int num_stages;
	86	uint16_t flag_reg;
	87
	88	unsigned int num_transfers;
	89	unsigned int num_samples;
	90	int num_bytes;
	91	int cnt_bytes;
	92	int cnt_samples;
	93	int cnt_samples_rle;
	94
	95	unsigned int rle_count;
	96	unsigned char sample[4];
	97	unsigned char tmp_sample[4];
	98	unsigned char *raw_sample_buf;
	99	};
	100
	101	SR_PRIV extern const char *ols_channel_names[];
	102
	103	SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
	104	uint8_t command);
	105	SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
	106	uint8_t command, uint8_t *data);
	107	SR_PRIV int ols_send_reset(struct sr_serial_dev_inst *serial);
	108	SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi);
	109	SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi);
	110	SR_PRIV struct dev_context *ols_dev_new(void);
	111	SR_PRIV struct sr_dev_inst get_metadata(struct sr_serial_dev_inst serial);
	112	SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
	113	uint64_t samplerate);
	114	SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
	115	SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);
	116
	117	#endif