[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

/* 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 driver context. */
struct drv_context {
	GSList *instances;
};

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