[libsigrok.git] / 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.h"
#include "libsigrok-internal.h"

#define LOG_PREFIX "ols"

#define NUM_PROBES             32
#define NUM_TRIGGER_STAGES     4
#define TRIGGER_TYPE           "01"
#define SERIAL_SPEED           B115200
#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_TESTMODE               0x03
#define CMD_ID                     0x02
#define CMD_METADATA               0x04
#define CMD_SET_FLAGS              0x82
#define CMD_SET_DIVIDER            0x80
#define CMD_CAPTURE_SIZE           0x81
#define CMD_SET_TRIGGER_MASK_0     0xc0
#define CMD_SET_TRIGGER_MASK_1     0xc4
#define CMD_SET_TRIGGER_MASK_2     0xc8
#define CMD_SET_TRIGGER_MASK_3     0xcc
#define CMD_SET_TRIGGER_VALUE_0    0xc1
#define CMD_SET_TRIGGER_VALUE_1    0xc5
#define CMD_SET_TRIGGER_VALUE_2    0xc9
#define CMD_SET_TRIGGER_VALUE_3    0xcd
#define CMD_SET_TRIGGER_CONFIG_0   0xc2
#define CMD_SET_TRIGGER_CONFIG_1   0xc6
#define CMD_SET_TRIGGER_CONFIG_2   0xca
#define CMD_SET_TRIGGER_CONFIG_3   0xce

/* Bitmasks for CMD_FLAGS */
#define FLAG_DEMUX                 0x01
#define FLAG_FILTER                0x02
#define FLAG_CHANNELGROUP_1        0x04
#define FLAG_CHANNELGROUP_2        0x08
#define FLAG_CHANNELGROUP_3        0x10
#define FLAG_CHANNELGROUP_4        0x20
#define FLAG_CLOCK_EXTERNAL        0x40
#define FLAG_CLOCK_INVERTED        0x80
#define FLAG_RLE                   0x0100
#define FLAG_SWAP_PROBES           0x0200
#define FLAG_EXTERNAL_TEST_MODE    0x0400
#define FLAG_INTERNAL_TEST_MODE    0x0800

/* Private, per-device-instance driver context. */
struct dev_context {
	/* Fixed device settings */
	int max_probes;
	uint32_t max_samples;
	uint32_t max_samplerate;
	uint32_t protocol_version;

	/* Acquisition settings */
	uint64_t cur_samplerate;
	uint32_t cur_samplerate_divider;
	uint64_t limit_samples;
	int capture_ratio;
	int trigger_at;
	uint32_t probe_mask;
	uint32_t trigger_mask[4];
	uint32_t trigger_value[4];
	int num_stages;
	uint32_t flag_reg;

	/* Operational states */
	unsigned int num_transfers;
	unsigned int num_samples;
	int num_bytes;

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


SR_PRIV extern const char *ols_probe_names[NUM_PROBES + 1];

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, uint32_t data);
SR_PRIV int ols_configure_probes(const struct sr_dev_inst *sdi);
SR_PRIV uint32_t reverse16(uint32_t in);
SR_PRIV uint32_t reverse32(uint32_t in);
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.h"
	27	#include "libsigrok-internal.h"
	28
	29	#define LOG_PREFIX "ols"
	30
	31	#define NUM_PROBES 32
	32	#define NUM_TRIGGER_STAGES 4
	33	#define TRIGGER_TYPE "01"
	34	#define SERIAL_SPEED B115200
	35	#define CLOCK_RATE SR_MHZ(100)
	36	#define MIN_NUM_SAMPLES 4
	37	#define DEFAULT_SAMPLERATE SR_KHZ(200)
	38
	39	/* Command opcodes */
	40	#define CMD_RESET 0x00
	41	#define CMD_RUN 0x01
	42	#define CMD_TESTMODE 0x03
	43	#define CMD_ID 0x02
	44	#define CMD_METADATA 0x04
	45	#define CMD_SET_FLAGS 0x82
	46	#define CMD_SET_DIVIDER 0x80
	47	#define CMD_CAPTURE_SIZE 0x81
	48	#define CMD_SET_TRIGGER_MASK_0 0xc0
	49	#define CMD_SET_TRIGGER_MASK_1 0xc4
	50	#define CMD_SET_TRIGGER_MASK_2 0xc8
	51	#define CMD_SET_TRIGGER_MASK_3 0xcc
	52	#define CMD_SET_TRIGGER_VALUE_0 0xc1
	53	#define CMD_SET_TRIGGER_VALUE_1 0xc5
	54	#define CMD_SET_TRIGGER_VALUE_2 0xc9
	55	#define CMD_SET_TRIGGER_VALUE_3 0xcd
	56	#define CMD_SET_TRIGGER_CONFIG_0 0xc2
	57	#define CMD_SET_TRIGGER_CONFIG_1 0xc6
	58	#define CMD_SET_TRIGGER_CONFIG_2 0xca
	59	#define CMD_SET_TRIGGER_CONFIG_3 0xce
	60
	61	/* Bitmasks for CMD_FLAGS */
	62	#define FLAG_DEMUX 0x01
	63	#define FLAG_FILTER 0x02
	64	#define FLAG_CHANNELGROUP_1 0x04
	65	#define FLAG_CHANNELGROUP_2 0x08
	66	#define FLAG_CHANNELGROUP_3 0x10
	67	#define FLAG_CHANNELGROUP_4 0x20
	68	#define FLAG_CLOCK_EXTERNAL 0x40
	69	#define FLAG_CLOCK_INVERTED 0x80
	70	#define FLAG_RLE 0x0100
	71	#define FLAG_SWAP_PROBES 0x0200
	72	#define FLAG_EXTERNAL_TEST_MODE 0x0400
	73	#define FLAG_INTERNAL_TEST_MODE 0x0800
	74
	75	/* Private, per-device-instance driver context. */
	76	struct dev_context {
	77	/* Fixed device settings */
	78	int max_probes;
	79	uint32_t max_samples;
	80	uint32_t max_samplerate;
	81	uint32_t protocol_version;
	82
	83	/* Acquisition settings */
	84	uint64_t cur_samplerate;
	85	uint32_t cur_samplerate_divider;
	86	uint64_t limit_samples;
	87	int capture_ratio;
	88	int trigger_at;
	89	uint32_t probe_mask;
	90	uint32_t trigger_mask[4];
	91	uint32_t trigger_value[4];
	92	int num_stages;
	93	uint32_t flag_reg;
	94
	95	/* Operational states */
	96	unsigned int num_transfers;
	97	unsigned int num_samples;
	98	int num_bytes;
	99
	100	/* Temporary variables */
	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
	108	SR_PRIV extern const char *ols_probe_names[NUM_PROBES + 1];
	109
	110	SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
	111	uint8_t command);
	112	SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
	113	uint8_t command, uint32_t data);
	114	SR_PRIV int ols_configure_probes(const struct sr_dev_inst *sdi);
	115	SR_PRIV uint32_t reverse16(uint32_t in);
	116	SR_PRIV uint32_t reverse32(uint32_t in);
	117	SR_PRIV struct dev_context *ols_dev_new(void);
	118	SR_PRIV struct sr_dev_inst get_metadata(struct sr_serial_dev_inst serial);
	119	SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
	120	uint64_t samplerate);
	121	SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
	122	SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);
	123
	124	#endif