[libsigrok.git] / hardware / saleae-logic / saleae-logic.h

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2011 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 SALEAE_LOGIC_H_
#define SALEAE_LOGIC_H_

#define USB_INTERFACE          0
#define USB_CONFIGURATION      1
#define NUM_TRIGGER_STAGES     4
#define TRIGGER_TYPES          "01"
#define FIRMWARE               FIRMWARE_DIR "/saleae-logic.fw"
#define GTV_TO_MSEC(gtv)       (gtv.tv_sec * 1000 + gtv.tv_usec / 1000)

/* delay in ms */
#define MAX_RENUM_DELAY        3000
#define NUM_SIMUL_TRANSFERS    10
#define MAX_EMPTY_TRANSFERS    (NUM_SIMUL_TRANSFERS * 2)

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

struct fx2_profile {
	/* VID/PID when first found */
	uint16_t orig_vid;
	uint16_t orig_pid;
	/* VID/PID after firmware upload */
	uint16_t fw_vid;
	uint16_t fw_pid;
	char *vendor;
	char *model;
	char *model_version;
	int num_probes;
};

struct fx2_device {
	struct fx2_profile *profile;
	/*
	 * Since we can't keep track of a Saleae Logic 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.
	 */
	GTimeVal fw_updated;
	/* device/capture settings */
	uint64_t cur_samplerate;
	uint64_t period_ps;
	uint64_t limit_samples;
	uint8_t probe_mask;
	uint8_t trigger_mask[NUM_TRIGGER_STAGES];
	uint8_t trigger_value[NUM_TRIGGER_STAGES];
	int trigger_stage;
	uint8_t trigger_buffer[NUM_TRIGGER_STAGES];
	/*
	 * opaque session data passed in by the frontend, will be passed back
	 * on the session bus along with samples.
	 */
	void *session_data;

	struct sr_usb_device_instance *usb;
};

#endif /* SALEAE_LOGIC_H_ */
Commit	Line	Data
6d754b6d BV	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2011 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
6d754b6d BV	20	#ifndef SALEAE_LOGIC_H_
	21	#define SALEAE_LOGIC_H_
	22
	23	#define USB_INTERFACE 0
	24	#define USB_CONFIGURATION 1
	25	#define NUM_TRIGGER_STAGES 4
	26	#define TRIGGER_TYPES "01"
	27	#define FIRMWARE FIRMWARE_DIR "/saleae-logic.fw"
	28	#define GTV_TO_MSEC(gtv) (gtv.tv_sec * 1000 + gtv.tv_usec / 1000)
	29
	30	/* delay in ms */
	31	#define MAX_RENUM_DELAY 3000
	32	#define NUM_SIMUL_TRANSFERS 10
	33	#define MAX_EMPTY_TRANSFERS (NUM_SIMUL_TRANSFERS * 2)
	34
	35	/* Software trigger implementation: positive values indicate trigger stage. */
	36	#define TRIGGER_FIRED -1
	37
	38	struct fx2_profile {
	39	/* VID/PID when first found */
	40	uint16_t orig_vid;
	41	uint16_t orig_pid;
	42	/* VID/PID after firmware upload */
	43	uint16_t fw_vid;
	44	uint16_t fw_pid;
	45	char *vendor;
	46	char *model;
	47	char *model_version;
	48	int num_probes;
	49	};
	50
	51	struct fx2_device {
	52	struct fx2_profile *profile;
	53	/*
	54	* Since we can't keep track of a Saleae Logic device after upgrading the
	55	* firmware (it re-enumerates into a different device address after the
	56	* upgrade) this is like a global lock. No device will open until a proper
	57	* delay after the last device was upgraded.
	58	*/
	59	GTimeVal fw_updated;
	60	/* device/capture settings */
	61	uint64_t cur_samplerate;
9c939c51	62	uint64_t period_ps;
6d754b6d BV	63	uint64_t limit_samples;
	64	uint8_t probe_mask;
	65	uint8_t trigger_mask[NUM_TRIGGER_STAGES];
	66	uint8_t trigger_value[NUM_TRIGGER_STAGES];
	67	int trigger_stage;
	68	uint8_t trigger_buffer[NUM_TRIGGER_STAGES];
	69	/*
	70	* opaque session data passed in by the frontend, will be passed back
	71	* on the session bus along with samples.
	72	*/
	73	void *session_data;
69890f73 UH	74
69890f73 UH	75	struct sr_usb_device_instance *usb;
6d754b6d BV	76	};
6d754b6d BV	77
6d754b6d	78	#endif /* SALEAE_LOGIC_H_ */