[libsigrok.git] / src / hardware / lascar-el-usb / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 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_LASCAR_EL_USB_PROTOCOL_H
#define LIBSIGROK_HARDWARE_LASCAR_EL_USB_PROTOCOL_H

#include <stdint.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "lascar-el-usb"

#define LASCAR_VENDOR "Lascar"
#define LASCAR_INTERFACE 0
#define LASCAR_EP_IN 0x82
#define LASCAR_EP_OUT 2
#define MAX_CONFIGBLOCK_SIZE 256

/* Max 100ms for a device to positively identify. */
#define SCAN_TIMEOUT (100 * 1000)
#define BULK_XFER_TIMEOUT (10 * 1000)
#define EVENTS_TIMEOUT (10 * 1000)
#define SLEEP_US_LONG (5 * 1000)
#define SLEEP_US_SHORT (1 * 1000)

/** Private, per-device-instance driver context. */
struct dev_context {
	void *cb_data;
	const struct elusb_profile *profile;
	/* Generic EL-USB */
	unsigned char config[MAX_CONFIGBLOCK_SIZE];
	unsigned int log_size;
	unsigned int rcvd_bytes;
	unsigned int sample_size;
	unsigned int logged_samples;
	unsigned int rcvd_samples;
	uint64_t limit_samples;
	/* Model-specific */
	/* EL-USB-CO: these are something like scaling and calibration values
	 * fixed per device, used to convert the sample values to CO ppm. */
	float co_high;
	float co_low;
	/* Temperature units as stored in the device config. */
	int temp_unit;
};

enum {
	LOG_UNSUPPORTED,
	LOG_TEMP_RH,
	LOG_CO,
};

struct elusb_profile {
	int modelid;
	char *modelname;
	int logformat;
};

SR_PRIV int lascar_get_config(libusb_device_handle *dev_hdl,
		unsigned char *configblock, int *configlen);
SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address);
SR_PRIV int lascar_el_usb_handle_events(int fd, int revents, void *cb_data);
SR_PRIV void LIBUSB_CALL lascar_el_usb_receive_transfer(struct libusb_transfer *transfer);
SR_PRIV int lascar_start_logging(const struct sr_dev_inst *sdi);
SR_PRIV int lascar_stop_logging(const struct sr_dev_inst *sdi);
SR_PRIV int lascar_is_logging(const struct sr_dev_inst *sdi);
SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 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_LASCAR_EL_USB_PROTOCOL_H
	21	#define LIBSIGROK_HARDWARE_LASCAR_EL_USB_PROTOCOL_H
	22
	23	#include <stdint.h>
	24	#include <libsigrok/libsigrok.h>
	25	#include "libsigrok-internal.h"
	26
	27	#define LOG_PREFIX "lascar-el-usb"
	28
	29	#define LASCAR_VENDOR "Lascar"
	30	#define LASCAR_INTERFACE 0
	31	#define LASCAR_EP_IN 0x82
	32	#define LASCAR_EP_OUT 2
	33	#define MAX_CONFIGBLOCK_SIZE 256
	34
	35	/* Max 100ms for a device to positively identify. */
	36	#define SCAN_TIMEOUT (100 * 1000)
	37	#define BULK_XFER_TIMEOUT (10 * 1000)
	38	#define EVENTS_TIMEOUT (10 * 1000)
	39	#define SLEEP_US_LONG (5 * 1000)
	40	#define SLEEP_US_SHORT (1 * 1000)
	41
	42	/** Private, per-device-instance driver context. */
	43	struct dev_context {
	44	void *cb_data;
	45	const struct elusb_profile *profile;
	46	/* Generic EL-USB */
	47	unsigned char config[MAX_CONFIGBLOCK_SIZE];
	48	unsigned int log_size;
	49	unsigned int rcvd_bytes;
	50	unsigned int sample_size;
	51	unsigned int logged_samples;
	52	unsigned int rcvd_samples;
	53	uint64_t limit_samples;
	54	/* Model-specific */
	55	/* EL-USB-CO: these are something like scaling and calibration values
	56	* fixed per device, used to convert the sample values to CO ppm. */
	57	float co_high;
	58	float co_low;
	59	/* Temperature units as stored in the device config. */
	60	int temp_unit;
	61	};
	62
	63	enum {
	64	LOG_UNSUPPORTED,
	65	LOG_TEMP_RH,
	66	LOG_CO,
	67	};
	68
	69	struct elusb_profile {
	70	int modelid;
	71	char *modelname;
	72	int logformat;
	73	};
	74
	75	SR_PRIV int lascar_get_config(libusb_device_handle *dev_hdl,
	76	unsigned char configblock, int configlen);
	77	SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address);
	78	SR_PRIV int lascar_el_usb_handle_events(int fd, int revents, void *cb_data);
	79	SR_PRIV void LIBUSB_CALL lascar_el_usb_receive_transfer(struct libusb_transfer *transfer);
	80	SR_PRIV int lascar_start_logging(const struct sr_dev_inst *sdi);
	81	SR_PRIV int lascar_stop_logging(const struct sr_dev_inst *sdi);
	82	SR_PRIV int lascar_is_logging(const struct sr_dev_inst *sdi);
	83	SR_PRIV int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data);
	84
	85	#endif