[libsigrok.git] / hardware / chronovu-la8 / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef LIBSIGROK_HARDWARE_CHRONOVU_LA8_PROTOCOL_H
#define LIBSIGROK_HARDWARE_CHRONOVU_LA8_PROTOCOL_H

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

/* Message logging helpers with subsystem-specific prefix string. */
#define LOG_PREFIX "la8: "
#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)

#define USB_VENDOR_ID			0x0403
#define USB_DESCRIPTION			"ChronoVu LA8"
#define USB_VENDOR_NAME			"ChronoVu"
#define USB_MODEL_NAME			"LA8"
#define USB_MODEL_VERSION		""

#define NUM_PROBES			8
#define TRIGGER_TYPE 			"01"
#define SDRAM_SIZE			(8 * 1024 * 1024)
#define MIN_NUM_SAMPLES			1

#define BS				4096 /* Block size */
#define NUM_BLOCKS			2048 /* Number of blocks */

/* Private, per-device-instance driver context. */
struct dev_context {
	/** FTDI device context (used by libftdi). */
	struct ftdi_context *ftdic;

	/** The currently configured samplerate of the device. */
	uint64_t cur_samplerate;

	/** The current sampling limit (in ms). */
	uint64_t limit_msec;

	/** The current sampling limit (in number of samples). */
	uint64_t limit_samples;

	void *cb_data;

	/**
	 * A buffer containing some (mangled) samples from the device.
	 * Format: Pretty mangled-up (due to hardware reasons), see code.
	 */
	uint8_t mangled_buf[BS];

	/**
	 * An 8MB buffer where we'll store the de-mangled samples.
	 * Format: Each sample is 1 byte, MSB is channel 7, LSB is channel 0.
	 */
	uint8_t *final_buf;

	/**
	 * Trigger pattern (MSB = channel 7, LSB = channel 0).
	 * A 1 bit matches a high signal, 0 matches a low signal on a probe.
	 * Only low/high triggers (but not e.g. rising/falling) are supported.
	 */
	uint8_t trigger_pattern;

	/**
	 * Trigger mask (MSB = channel 7, LSB = channel 0).
	 * A 1 bit means "must match trigger_pattern", 0 means "don't care".
	 */
	uint8_t trigger_mask;

	/** Time (in seconds) before the trigger times out. */
	uint64_t trigger_timeout;

	/** Tells us whether an SR_DF_TRIGGER packet was already sent. */
	int trigger_found;

	/** TODO */
	time_t done;

	/** Counter/index for the data block to be read. */
	int block_counter;

	/** The divcount value (determines the sample period) for the LA8. */
	uint8_t divcount;

	/** This ChronoVu LA8's USB PID (multiple versions exist). */
	uint16_t usb_pid;
};

/* protocol.c */
extern const int32_t chronovu_la8_hwcaps[];
extern uint64_t chronovu_la8_samplerates[];
extern SR_PRIV const char *chronovu_la8_probe_names[];
SR_PRIV void fill_supported_samplerates_if_needed(void);
SR_PRIV int is_valid_samplerate(uint64_t samplerate);
SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate);
SR_PRIV int la8_write(struct dev_context *devc, uint8_t *buf, int size);
SR_PRIV int la8_read(struct dev_context *devc, uint8_t *buf, int size);
SR_PRIV int la8_close(struct dev_context *devc);
SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc);
SR_PRIV int la8_reset(struct dev_context *devc);
SR_PRIV int configure_probes(const struct sr_dev_inst *sdi);
SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
SR_PRIV int la8_read_block(struct dev_context *devc);
SR_PRIV void send_block_to_session_bus(struct dev_context *devc, int block);

#endif
Commit	Line	Data
b908f067	1	/*
50985c20	2	* This file is part of the libsigrok project.
b908f067 UH	3	*
	4	* Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
	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 2 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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
45e080b6 UH	21	#ifndef LIBSIGROK_HARDWARE_CHRONOVU_LA8_PROTOCOL_H
45e080b6 UH	22	#define LIBSIGROK_HARDWARE_CHRONOVU_LA8_PROTOCOL_H
b908f067 UH	23
	24	#include <glib.h>
	25	#include <ftdi.h>
	26	#include <stdint.h>
45c59c8b BV	27	#include "libsigrok.h"
45c59c8b BV	28	#include "libsigrok-internal.h"
b908f067	29
29a27196 UH	30	/* Message logging helpers with subsystem-specific prefix string. */
	31	#define LOG_PREFIX "la8: "
	32	#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
	33	#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
	34	#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
	35	#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
	36	#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
	37	#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
f3a35908	38
b908f067	39	#define USB_VENDOR_ID 0x0403
b908f067 UH	40	#define USB_DESCRIPTION "ChronoVu LA8"
	41	#define USB_VENDOR_NAME "ChronoVu"
	42	#define USB_MODEL_NAME "LA8"
	43	#define USB_MODEL_VERSION ""
	44
	45	#define NUM_PROBES 8
c50277a6	46	#define TRIGGER_TYPE "01"
b908f067 UH	47	#define SDRAM_SIZE (8 * 1024 * 1024)
	48	#define MIN_NUM_SAMPLES 1
	49
	50	#define BS 4096 /* Block size */
	51	#define NUM_BLOCKS 2048 /* Number of blocks */
	52
	53	/* Private, per-device-instance driver context. */
1644fb24	54	struct dev_context {
b908f067 UH	55	/** FTDI device context (used by libftdi). */
	56	struct ftdi_context *ftdic;
	57
	58	/** The currently configured samplerate of the device. */
	59	uint64_t cur_samplerate;
	60
	61	/** The current sampling limit (in ms). */
	62	uint64_t limit_msec;
	63
	64	/** The current sampling limit (in number of samples). */
	65	uint64_t limit_samples;
	66
3e9b7f9c	67	void *cb_data;
b908f067 UH	68
	69	/**
	70	* A buffer containing some (mangled) samples from the device.
	71	* Format: Pretty mangled-up (due to hardware reasons), see code.
	72	*/
	73	uint8_t mangled_buf[BS];
	74
	75	/**
	76	* An 8MB buffer where we'll store the de-mangled samples.
	77	* Format: Each sample is 1 byte, MSB is channel 7, LSB is channel 0.
	78	*/
	79	uint8_t *final_buf;
	80
	81	/**
	82	* Trigger pattern (MSB = channel 7, LSB = channel 0).
	83	* A 1 bit matches a high signal, 0 matches a low signal on a probe.
	84	* Only low/high triggers (but not e.g. rising/falling) are supported.
	85	*/
	86	uint8_t trigger_pattern;
	87
	88	/**
	89	* Trigger mask (MSB = channel 7, LSB = channel 0).
	90	* A 1 bit means "must match trigger_pattern", 0 means "don't care".
	91	*/
	92	uint8_t trigger_mask;
	93
	94	/** Time (in seconds) before the trigger times out. */
	95	uint64_t trigger_timeout;
	96
	97	/** Tells us whether an SR_DF_TRIGGER packet was already sent. */
	98	int trigger_found;
	99
	100	/** TODO */
	101	time_t done;
	102
	103	/** Counter/index for the data block to be read. */
	104	int block_counter;
	105
	106	/** The divcount value (determines the sample period) for the LA8. */
	107	uint8_t divcount;
74e5f12d UH	108
	109	/** This ChronoVu LA8's USB PID (multiple versions exist). */
	110	uint16_t usb_pid;
b908f067 UH	111	};
b908f067 UH	112
45e080b6	113	/* protocol.c */
1bec72d2 BV	114	extern const int32_t chronovu_la8_hwcaps[];
	115	extern uint64_t chronovu_la8_samplerates[];
	116	extern SR_PRIV const char *chronovu_la8_probe_names[];
b908f067 UH	117	SR_PRIV void fill_supported_samplerates_if_needed(void);
	118	SR_PRIV int is_valid_samplerate(uint64_t samplerate);
	119	SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate);
1644fb24 BV	120	SR_PRIV int la8_write(struct dev_context devc, uint8_t buf, int size);
	121	SR_PRIV int la8_read(struct dev_context devc, uint8_t buf, int size);
	122	SR_PRIV int la8_close(struct dev_context *devc);
	123	SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc);
	124	SR_PRIV int la8_reset(struct dev_context *devc);
014359e3	125	SR_PRIV int configure_probes(const struct sr_dev_inst *sdi);
6f4b1868	126	SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
1644fb24 BV	127	SR_PRIV int la8_read_block(struct dev_context *devc);
1644fb24 BV	128	SR_PRIV void send_block_to_session_bus(struct dev_context *devc, int block);
b908f067 UH	129
b908f067 UH	130	#endif