[libsigrok.git] / hardware / fx2lafw / fx2lafw.h

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * 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/>.
 */

#include <glib.h>
#include <stdbool.h>

#ifndef LIBSIGROK_HARDWARE_FX2LAFW_FX2LAFW_H
#define LIBSIGROK_HARDWARE_FX2LAFW_FX2LAFW_H

#define USB_INTERFACE		0
#define USB_CONFIGURATION	1
#define NUM_TRIGGER_STAGES	4
#define TRIGGER_TYPES		"01"

#define MAX_RENUM_DELAY_MS	3000
#define NUM_SIMUL_TRANSFERS	32
#define MAX_EMPTY_TRANSFERS	(NUM_SIMUL_TRANSFERS * 2)

#define FX2LAFW_REQUIRED_VERSION_MAJOR	1

/* 6 delay states of up to 256 clock ticks */
#define MAX_SAMPLE_DELAY	(6 * 256)

/* Software trigger implementation: positive values indicate trigger stage. */
#define TRIGGER_FIRED          -1

#define DEV_CAPS_16BIT_POS	0

#define DEV_CAPS_16BIT		(1 << DEV_CAPS_16BIT_POS)

struct fx2lafw_profile {
	uint16_t vid;
	uint16_t pid;

	const char *vendor;
	const char *model;
	const char *model_version;

	const char *firmware;

	uint32_t dev_caps;
};

struct context {
	const struct fx2lafw_profile *profile;

	/*
	 * Since we can't keep track of an fx2lafw device after upgrading
	 * the firmware (it re-enumerates into a different device address
	 * after the upgrade) this is like a global lock. No device will open
	 * until a proper delay after the last device was upgraded.
	 */
	int64_t fw_updated;

	/* Device/capture settings */
	uint64_t cur_samplerate;
	uint64_t limit_samples;

	bool sample_wide;

	uint16_t trigger_mask[NUM_TRIGGER_STAGES];
	uint16_t trigger_value[NUM_TRIGGER_STAGES];
	int trigger_stage;
	uint16_t trigger_buffer[NUM_TRIGGER_STAGES];

	int num_samples;
	int submitted_transfers;

	void *session_dev_id;

	struct sr_usb_dev_inst *usb;
};

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
	5	* Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
	21	#include <glib.h>
	22	#include <stdbool.h>
	23
	24	#ifndef LIBSIGROK_HARDWARE_FX2LAFW_FX2LAFW_H
	25	#define LIBSIGROK_HARDWARE_FX2LAFW_FX2LAFW_H
	26
	27	#define USB_INTERFACE 0
	28	#define USB_CONFIGURATION 1
	29	#define NUM_TRIGGER_STAGES 4
	30	#define TRIGGER_TYPES "01"
	31
	32	#define MAX_RENUM_DELAY_MS 3000
	33	#define NUM_SIMUL_TRANSFERS 32
	34	#define MAX_EMPTY_TRANSFERS (NUM_SIMUL_TRANSFERS * 2)
	35
	36	#define FX2LAFW_REQUIRED_VERSION_MAJOR 1
	37
	38	/* 6 delay states of up to 256 clock ticks */
	39	#define MAX_SAMPLE_DELAY (6 * 256)
	40
	41	/* Software trigger implementation: positive values indicate trigger stage. */
	42	#define TRIGGER_FIRED -1
	43
	44	#define DEV_CAPS_16BIT_POS 0
	45
	46	#define DEV_CAPS_16BIT (1 << DEV_CAPS_16BIT_POS)
	47
	48	struct fx2lafw_profile {
	49	uint16_t vid;
	50	uint16_t pid;
	51
	52	const char *vendor;
	53	const char *model;
	54	const char *model_version;
	55
	56	const char *firmware;
	57
	58	uint32_t dev_caps;
	59	};
	60
	61	struct context {
	62	const struct fx2lafw_profile *profile;
	63
	64	/*
	65	* Since we can't keep track of an fx2lafw device after upgrading
	66	* the firmware (it re-enumerates into a different device address
	67	* after the upgrade) this is like a global lock. No device will open
	68	* until a proper delay after the last device was upgraded.
	69	*/
	70	int64_t fw_updated;
	71
	72	/* Device/capture settings */
	73	uint64_t cur_samplerate;
	74	uint64_t limit_samples;
	75
	76	bool sample_wide;
	77
	78	uint16_t trigger_mask[NUM_TRIGGER_STAGES];
	79	uint16_t trigger_value[NUM_TRIGGER_STAGES];
	80	int trigger_stage;
	81	uint16_t trigger_buffer[NUM_TRIGGER_STAGES];
	82
	83	int num_samples;
	84	int submitted_transfers;
	85
	86	void *session_dev_id;
	87
	88	struct sr_usb_dev_inst *usb;
	89	};
	90
	91	#endif