[libsigrok.git] / hardware / genericdmm / genericdmm.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_GENERICDMM_H
#define LIBSIGROK_GENERICDMM_H

/* Message logging helpers with driver-specific prefix string. */
#define DRIVER_LOG_DOMAIN "genericdmm: "
#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)

/* SR_HWCAP_CONN takes one of these: */
#define DMM_CONN_USB_VIDPID    "^([0-9a-z]{1,4})\\.([0-9a-z]{1,4})$"
#define DMM_CONN_USB_BUSADDR   "^(\\d+)\\.(\\d+)$"
#define DMM_CONN_SERIALPORT    "^([a-z0-9/\\-_]+)$"

/* SR_HWCAP_SERIALCOMM like 2400/8n1 */
#define DMM_CONN_SERIALCOMM    "^(\\d+)/(\\d)([neo])(\\d)$"

enum {
	DMM_TRANSPORT_SERIAL,
	DMM_TRANSPORT_USBHID,
};


struct dev_profile {
	char *modelid;
	char *vendor;
	char *model;
	struct dmmchip *chip;
	int transport;
	int poll_timeout;
	struct sr_hwopt *defaults_opts;
};

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

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

	/* Only used for USB-connected devices. */
	struct sr_usb_dev_inst *usb;

	/* Only used for serial-connected devices. */
	struct sr_serial_dev_inst *serial;
	int serial_speed;
	int serial_databits;
	int serial_parity;
	int serial_stopbits;

	/* Runtime. */
	uint64_t num_samples;

	/* DMM chip-specific data, if needed. */
	void *priv;
};

struct dmmchip {
	/* Optional, called once before measurement starts. */
	int (*init) (void);

	/* Scan for devices with the given options. */
	GSList *(*scan) (GSList *options);

	/* Called whenever a chunk of data arrives. */
	int (*data) (struct sr_dev_inst *sdi);
};


#endif /* LIBSIGROK_GENERICDMM_H */
Commit	Line	Data
ca3d84cc BV	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
db135200 BV	20	#ifndef LIBSIGROK_GENERICDMM_H
db135200 BV	21	#define LIBSIGROK_GENERICDMM_H
ca3d84cc	22
2980cc24 UH	23	/* Message logging helpers with driver-specific prefix string. */
	24	#define DRIVER_LOG_DOMAIN "genericdmm: "
	25	#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
	26	#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
	27	#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
	28	#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
	29	#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
	30	#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
	31
ca3d84cc	32	/* SR_HWCAP_CONN takes one of these: */
7356a55d	33	#define DMM_CONN_USB_VIDPID "^([0-9a-z]{1,4})\\.([0-9a-z]{1,4})$"
ca3d84cc BV	34	#define DMM_CONN_USB_BUSADDR "^(\\d+)\\.(\\d+)$"
	35	#define DMM_CONN_SERIALPORT "^([a-z0-9/\\-_]+)$"
	36
	37	/* SR_HWCAP_SERIALCOMM like 2400/8n1 */
	38	#define DMM_CONN_SERIALCOMM "^(\\d+)/(\\d)([neo])(\\d)$"
	39
	40	enum {
	41	DMM_TRANSPORT_SERIAL,
	42	DMM_TRANSPORT_USBHID,
	43	};
	44
	45
	46	struct dev_profile {
	47	char *modelid;
	48	char *vendor;
	49	char *model;
	50	struct dmmchip *chip;
ca3d84cc	51	int transport;
3c6ce226	52	int poll_timeout;
7fc754a0	53	struct sr_hwopt *defaults_opts;
ca3d84cc BV	54	};
ca3d84cc BV	55
301a5e4c BV	56	/* Private, per-device-instance driver context. */
301a5e4c BV	57	struct dev_context {
ca3d84cc BV	58	struct dev_profile *profile;
	59	uint64_t limit_samples;
	60	uint64_t limit_msec;
	61
	62	/* Opaque pointer passed in by the frontend. */
	63	void *cb_data;
	64
	65	/* Only used for USB-connected devices. */
	66	struct sr_usb_dev_inst *usb;
	67
	68	/* Only used for serial-connected devices. */
	69	struct sr_serial_dev_inst *serial;
	70	int serial_speed;
	71	int serial_databits;
	72	int serial_parity;
	73	int serial_stopbits;
	74
	75	/* Runtime. */
	76	uint64_t num_samples;
	77
	78	/* DMM chip-specific data, if needed. */
	79	void *priv;
	80	};
	81
	82	struct dmmchip {
	83	/* Optional, called once before measurement starts. */
633b2fac BV	84	int (*init) (void);
	85
	86	/* Scan for devices with the given options. */
	87	GSList (scan) (GSList *options);
	88
ca3d84cc	89	/* Called whenever a chunk of data arrives. */
3c6ce226	90	int (data) (struct sr_dev_inst sdi);
ca3d84cc BV	91	};
	92
	93
db135200	94	#endif /* LIBSIGROK_GENERICDMM_H */