[libsigrok.git] / src / hardware / zeroplus-logic-cube / analyzer.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2010 Sven Peter <sven@fail0verflow.com>
 * Copyright (C) 2010 Haxx Enterprises <bushing@gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 *  THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef LIBSIGROK_HARDWARE_ZEROPLUS_LOGIC_CUBE_ANALYZER_H
#define LIBSIGROK_HARDWARE_ZEROPLUS_LOGIC_CUBE_ANALYZER_H

#include <libusb.h>
#include <libsigrok/libsigrok.h>

#define STATUS_FLAG_NONE	0x00
#define STATUS_FLAG_RESET	0x01
#define STATUS_FLAG_INIT	0x02
#define STATUS_FLAG_GO		0x04
#define STATUS_FLAG_PAUSE	0x08
#define STATUS_FLAG_READ	0x10
#define STATUS_FLAG_20		0x20

/* In bytes */
#define MEMORY_SIZE_8K		0x00
#define MEMORY_SIZE_64K		0x01
#define MEMORY_SIZE_128K	0x02
#define MEMORY_SIZE_256K	0x03
#define MEMORY_SIZE_512K	0x04
#define MEMORY_SIZE_1M		0x05
#define MEMORY_SIZE_2M		0x06
#define MEMORY_SIZE_4M		0x07
#define MEMORY_SIZE_8M		0x08

#define STATUS_BUSY		0x01	/* WTF / ??? */
#define STATUS_READY		0x02
#define STATUS_BUTTON_PRESSED	0x04

#define CHANNEL_A		0x1000
#define CHANNEL_B		0x2000
#define CHANNEL_C		0x3000
#define CHANNEL_D		0x4000

#define FREQ_SCALE_HZ		0
#define FREQ_SCALE_KHZ		1
#define FREQ_SCALE_MHZ		2

#define FILTER_HIGH		0
#define FILTER_LOW		1

#define COMPRESSION_NONE	0x0001
#define COMPRESSION_ENABLE	0x8001
#define COMPRESSION_DOUBLE	0x8002

SR_PRIV void analyzer_set_freq(int freq, int scale);
SR_PRIV void analyzer_set_ramsize_trigger_address(unsigned int address);
SR_PRIV void analyzer_set_triggerbar_address(unsigned int address);
SR_PRIV unsigned int  analyzer_get_ramsize_trigger_address(void );
SR_PRIV unsigned int analyzer_get_triggerbar_address(void);
SR_PRIV void analyzer_set_compression(unsigned int type);
SR_PRIV void analyzer_set_memory_size(unsigned int size);
SR_PRIV int analyzer_add_triggers(const struct sr_dev_inst *sdi);
SR_PRIV void analyzer_set_trigger_count(int count);
SR_PRIV void analyzer_add_filter(int channel, int type);
SR_PRIV void analyzer_set_voltage_threshold(int thresh);

SR_PRIV unsigned int analyzer_read_status(libusb_device_handle *devh);
SR_PRIV unsigned int analyzer_read_id(libusb_device_handle *devh);
SR_PRIV unsigned int analyzer_get_stop_address(libusb_device_handle *devh);
SR_PRIV unsigned int analyzer_get_now_address(libusb_device_handle *devh);
SR_PRIV unsigned int analyzer_get_trigger_address(libusb_device_handle *devh);
SR_PRIV int analyzer_decompress(void *input, unsigned int input_len,
				void *output, unsigned int output_len);

SR_PRIV void analyzer_reset(libusb_device_handle *devh);
SR_PRIV void analyzer_initialize(libusb_device_handle *devh);
SR_PRIV void analyzer_wait(libusb_device_handle *devh, int set, int unset);
SR_PRIV void analyzer_read_start(libusb_device_handle *devh);
SR_PRIV int analyzer_read_data(libusb_device_handle *devh, void *buffer,
			       unsigned int size);
SR_PRIV void analyzer_read_stop(libusb_device_handle *devh);
SR_PRIV void analyzer_start(libusb_device_handle *devh);
SR_PRIV void analyzer_configure(libusb_device_handle *devh);

SR_PRIV void analyzer_wait_button(libusb_device_handle *devh);
SR_PRIV void analyzer_wait_data(libusb_device_handle *devh);

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2010 Sven Peter <sven@fail0verflow.com>
	5	* Copyright (C) 2010 Haxx Enterprises <bushing@gmail.com>
	6	* All rights reserved.
	7	*
	8	* Redistribution and use in source and binary forms, with or
	9	* without modification, are permitted provided that the following
	10	* conditions are met:
	11	*
	12	* * Redistributions of source code must retain the above copyright notice,
	13	* this list of conditions and the following disclaimer.
	14	*
	15	* * Redistributions in binary form must reproduce the above copyright notice,
	16	* this list of conditions and the following disclaimer in the documentation
	17	* and/or other materials provided with the distribution.
	18	*
	19	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	20	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	21	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	22	* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
	23	* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	24	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	25	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	26	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	27	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	28	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
	29	* THE POSSIBILITY OF SUCH DAMAGE.
	30	*/
	31
	32	#ifndef LIBSIGROK_HARDWARE_ZEROPLUS_LOGIC_CUBE_ANALYZER_H
	33	#define LIBSIGROK_HARDWARE_ZEROPLUS_LOGIC_CUBE_ANALYZER_H
	34
	35	#include <libusb.h>
	36	#include <libsigrok/libsigrok.h>
	37
	38	#define STATUS_FLAG_NONE 0x00
	39	#define STATUS_FLAG_RESET 0x01
	40	#define STATUS_FLAG_INIT 0x02
	41	#define STATUS_FLAG_GO 0x04
	42	#define STATUS_FLAG_PAUSE 0x08
	43	#define STATUS_FLAG_READ 0x10
	44	#define STATUS_FLAG_20 0x20
	45
	46	/* In bytes */
	47	#define MEMORY_SIZE_8K 0x00
	48	#define MEMORY_SIZE_64K 0x01
	49	#define MEMORY_SIZE_128K 0x02
	50	#define MEMORY_SIZE_256K 0x03
	51	#define MEMORY_SIZE_512K 0x04
	52	#define MEMORY_SIZE_1M 0x05
	53	#define MEMORY_SIZE_2M 0x06
	54	#define MEMORY_SIZE_4M 0x07
	55	#define MEMORY_SIZE_8M 0x08
	56
	57	#define STATUS_BUSY 0x01 /* WTF / ??? */
	58	#define STATUS_READY 0x02
	59	#define STATUS_BUTTON_PRESSED 0x04
	60
	61	#define CHANNEL_A 0x1000
	62	#define CHANNEL_B 0x2000
	63	#define CHANNEL_C 0x3000
	64	#define CHANNEL_D 0x4000
	65
	66	#define FREQ_SCALE_HZ 0
	67	#define FREQ_SCALE_KHZ 1
	68	#define FREQ_SCALE_MHZ 2
	69
	70	#define FILTER_HIGH 0
	71	#define FILTER_LOW 1
	72
	73	#define COMPRESSION_NONE 0x0001
	74	#define COMPRESSION_ENABLE 0x8001
	75	#define COMPRESSION_DOUBLE 0x8002
	76
	77	SR_PRIV void analyzer_set_freq(int freq, int scale);
	78	SR_PRIV void analyzer_set_ramsize_trigger_address(unsigned int address);
	79	SR_PRIV void analyzer_set_triggerbar_address(unsigned int address);
	80	SR_PRIV unsigned int analyzer_get_ramsize_trigger_address(void );
	81	SR_PRIV unsigned int analyzer_get_triggerbar_address(void);
	82	SR_PRIV void analyzer_set_compression(unsigned int type);
	83	SR_PRIV void analyzer_set_memory_size(unsigned int size);
	84	SR_PRIV int analyzer_add_triggers(const struct sr_dev_inst *sdi);
	85	SR_PRIV void analyzer_set_trigger_count(int count);
	86	SR_PRIV void analyzer_add_filter(int channel, int type);
	87	SR_PRIV void analyzer_set_voltage_threshold(int thresh);
	88
	89	SR_PRIV unsigned int analyzer_read_status(libusb_device_handle *devh);
	90	SR_PRIV unsigned int analyzer_read_id(libusb_device_handle *devh);
	91	SR_PRIV unsigned int analyzer_get_stop_address(libusb_device_handle *devh);
	92	SR_PRIV unsigned int analyzer_get_now_address(libusb_device_handle *devh);
	93	SR_PRIV unsigned int analyzer_get_trigger_address(libusb_device_handle *devh);
	94	SR_PRIV int analyzer_decompress(void *input, unsigned int input_len,
	95	void *output, unsigned int output_len);
	96
	97	SR_PRIV void analyzer_reset(libusb_device_handle *devh);
	98	SR_PRIV void analyzer_initialize(libusb_device_handle *devh);
	99	SR_PRIV void analyzer_wait(libusb_device_handle *devh, int set, int unset);
	100	SR_PRIV void analyzer_read_start(libusb_device_handle *devh);
	101	SR_PRIV int analyzer_read_data(libusb_device_handle devh, void buffer,
	102	unsigned int size);
	103	SR_PRIV void analyzer_read_stop(libusb_device_handle *devh);
	104	SR_PRIV void analyzer_start(libusb_device_handle *devh);
	105	SR_PRIV void analyzer_configure(libusb_device_handle *devh);
	106
	107	SR_PRIV void analyzer_wait_button(libusb_device_handle *devh);
	108	SR_PRIV void analyzer_wait_data(libusb_device_handle *devh);
	109
	110	#endif