[libsigrok.git] / hardware / fluke-dmm / fluke-dmm.h

/*
 * This file is part of the sigrok 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_FLUKE_DMM_H
#define LIBSIGROK_FLUKE_DMM_H

/* Message logging helpers with driver-specific prefix string. */
#define DRIVER_LOG_DOMAIN "fluke-dmm: "
#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)

#define FLUKEDMM_BUFSIZE  256

/* Supported models */
enum {
	FLUKE_187 = 1,
	FLUKE_287,
	FLUKE_190,
};

/* Supported device profiles */
struct flukedmm_profile {
	int model;
	const char *modelname;
	/* How often to poll, in ms. */
	int poll_period;
	/* If no response received, how long to wait before retrying. */
	int timeout;
};

/* Private, per-device-instance driver context. */
struct dev_context {
	const struct flukedmm_profile *profile;
	uint64_t limit_samples;
	uint64_t limit_msec;

	/* Opaque pointer passed in by the frontend. */
	void *cb_data;

	/* Runtime. */
	uint64_t num_samples;
	char buf[FLUKEDMM_BUFSIZE];
	int buflen;
	int64_t cmd_sent_at;
	int expect_response;
	int meas_type;
	int is_relative;
	int mq;
	int unit;
	int mqflags;
};

SR_PRIV int fluke_receive_data(int fd, int revents, void *cb_data);

#endif /* LIBSIGROK_FLUKE_DMM_H */
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok 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
	21	#ifndef LIBSIGROK_FLUKE_DMM_H
	22	#define LIBSIGROK_FLUKE_DMM_H
	23
	24	/* Message logging helpers with driver-specific prefix string. */
	25	#define DRIVER_LOG_DOMAIN "fluke-dmm: "
	26	#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
	27	#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
	28	#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
	29	#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
	30	#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
	31	#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
	32
	33	#define FLUKEDMM_BUFSIZE 256
	34
	35	/* Supported models */
	36	enum {
	37	FLUKE_187 = 1,
	38	FLUKE_287,
	39	FLUKE_190,
	40	};
	41
	42	/* Supported device profiles */
	43	struct flukedmm_profile {
	44	int model;
	45	const char *modelname;
	46	/* How often to poll, in ms. */
	47	int poll_period;
	48	/* If no response received, how long to wait before retrying. */
	49	int timeout;
	50	};
	51
	52	/* Private, per-device-instance driver context. */
	53	struct dev_context {
	54	const struct flukedmm_profile *profile;
	55	uint64_t limit_samples;
	56	uint64_t limit_msec;
	57
	58	/* Opaque pointer passed in by the frontend. */
	59	void *cb_data;
	60
	61	/* Runtime. */
	62	uint64_t num_samples;
	63	char buf[FLUKEDMM_BUFSIZE];
	64	int buflen;
	65	int64_t cmd_sent_at;
	66	int expect_response;
	67	int meas_type;
	68	int is_relative;
	69	int mq;
	70	int unit;
	71	int mqflags;
	72	};
	73
	74	SR_PRIV int fluke_receive_data(int fd, int revents, void *cb_data);
	75
	76	#endif /* LIBSIGROK_FLUKE_DMM_H */