[libsigrok.git] / src / hardware / norma-dmm / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
 *
 * 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_NORMA_DMM_PROTOCOL_H
#define LIBSIGROK_HARDWARE_NORMA_DMM_PROTOCOL_H

#include <stdint.h>
#include <string.h>
#include <ctype.h>
#include <math.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

/** @file
 *  Norma DM9x0/Siemens B102x DMMs driver.
 *  @internal
 */

#define LOG_PREFIX "norma-dmm"

#define NMADMM_BUFSIZE  256

#define NMADMM_TIMEOUT_MS 2000 /**< Request timeout. */

/** Norma DMM request types (used ones only, the DMMs support about 50). */
enum {
	NMADMM_REQ_IDN = 0,	/**< Request identity */
	NMADMM_REQ_STATUS,	/**< Request device status (value + ...) */
};

/** Defines requests used to communicate with device. */
struct nmadmm_req {
	int req_type;		/**< Request type. */
	const char *req_str;	/**< Request string. */
};

/** Strings for requests. */
extern const struct nmadmm_req nmadmm_requests[];

/** Private, per-device-instance driver context. */
struct dev_context {
	/* Model-specific information */
	char *version;		/**< Version string */
	int type;		/**< DM9x0, e.g. 5 = DM950 */

	/* Acquisition settings */
	uint64_t limit_samples;	/**< Target number of samples */
	uint64_t limit_msec;	/**< Target sampling time */

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

	/* Operational state */
	int last_req;			/**< Last request. */
	int64_t req_sent_at;		/**< Request sent. */
	gboolean last_req_pending;	/**< Last request not answered yet. */
	int lowbatt;			/**< Low battery. 1=low, 2=critical. */

	/* Temporary state across callbacks */
	uint64_t num_samples;		/**< Current #samples. */
	GTimer *elapsed_msec;		/**< Used for limit_msec */
	uint8_t buf[NMADMM_BUFSIZE];	/**< Buffer for read callback */
	int buflen;			/**< Data len in buf */
};

SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data);
SR_PRIV int xgittoint(char xgit);

#endif
Commit	Line	Data
bfd48770 MH	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
	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_NORMA_DMM_PROTOCOL_H
	21	#define LIBSIGROK_HARDWARE_NORMA_DMM_PROTOCOL_H
	22
	23	#include <stdint.h>
e790bd5c UH	24	#include <string.h>
e790bd5c UH	25	#include <ctype.h>
e790bd5c	26	#include <math.h>
bfd48770	27	#include <glib.h>
c1aae900	28	#include <libsigrok/libsigrok.h>
bfd48770 MH	29	#include "libsigrok-internal.h"
bfd48770 MH	30
a4e435eb MH	31	/** @file
	32	* Norma DM9x0/Siemens B102x DMMs driver.
	33	* @internal
	34	*/
	35
3544f848	36	#define LOG_PREFIX "norma-dmm"
bfd48770	37
f8e76e2e MH	38	#define NMADMM_BUFSIZE 256
f8e76e2e MH	39
a4e435eb MH	40	#define NMADMM_TIMEOUT_MS 2000 /*< Request timeout. /
a4e435eb MH	41
e790bd5c UH	42	/** Norma DMM request types (used ones only, the DMMs support about 50). */
e790bd5c UH	43	enum {
f8e76e2e MH	44	NMADMM_REQ_IDN = 0, /*< Request identity /
	45	NMADMM_REQ_STATUS, /*< Request device status (value + ...) /
	46	};
	47
	48	/** Defines requests used to communicate with device. */
	49	struct nmadmm_req {
e790bd5c UH	50	int req_type; /*< Request type. /
e790bd5c UH	51	const char req_str; /< Request string. /
f8e76e2e MH	52	};
	53
	54	/** Strings for requests. */
	55	extern const struct nmadmm_req nmadmm_requests[];
	56
bfd48770 MH	57	/** Private, per-device-instance driver context. */
	58	struct dev_context {
	59	/* Model-specific information */
e790bd5c UH	60	char version; /< Version string /
	61	int type; /*< DM9x0, e.g. 5 = DM950 /
	62
bfd48770	63	/* Acquisition settings */
f8e76e2e MH	64	uint64_t limit_samples; /*< Target number of samples /
f8e76e2e MH	65	uint64_t limit_msec; /*< Target sampling time /
bfd48770	66
f8e76e2e MH	67	/* Opaque pointer passed in by frontend. */
f8e76e2e MH	68	void *cb_data;
bfd48770	69
f8e76e2e	70	/* Operational state */
e790bd5c	71	int last_req; /*< Last request. /
a4e435eb	72	int64_t req_sent_at; /*< Request sent. /
e790bd5c UH	73	gboolean last_req_pending; /*< Last request not answered yet. /
	74	int lowbatt; /*< Low battery. 1=low, 2=critical. /
	75
bfd48770	76	/* Temporary state across callbacks */
f8e76e2e	77	uint64_t num_samples; /*< Current #samples. /
e790bd5c UH	78	GTimer elapsed_msec; /< Used for limit_msec /
e790bd5c UH	79	uint8_t buf[NMADMM_BUFSIZE]; /*< Buffer for read callback /
f8e76e2e	80	int buflen; /*< Data len in buf /
bfd48770 MH	81	};
	82
	83	SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data);
f8e76e2e	84	SR_PRIV int xgittoint(char xgit);
bfd48770 MH	85
bfd48770 MH	86	#endif