[libsigrok.git] / hwdriver.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 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/>.
 */

#include <stdlib.h>
#include <stdio.h>
#include <sys/types.h>
#include <dirent.h>
#include <string.h>
#include <glib.h>
#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
#include "libsigrok.h"
#include "libsigrok-internal.h"

/* Message logging helpers with subsystem-specific prefix string. */
#define LOG_PREFIX "hwdriver: "
#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)

/**
 * @file
 *
 * Hardware driver handling in libsigrok.
 */

/**
 * @defgroup grp_driver Hardware drivers
 *
 * Hardware driver handling in libsigrok.
 *
 * @{
 */

static struct sr_config_info sr_config_info_data[] = {
	{SR_CONF_CONN, SR_T_CHAR, "conn",
		"Connection", NULL},
	{SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
		"Serial communication", NULL},
	{SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
		"Sample rate", NULL},
	{SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
		"Pre-trigger capture ratio", NULL},
	{SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
		"Pattern generator mode", NULL},
	{SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
		"Trigger types", NULL},
	{SR_CONF_RLE, SR_T_BOOL, "rle",
		"Run Length Encoding", NULL},
	{SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
		"Trigger slope", NULL},
	{SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
		"Trigger source", NULL},
	{SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
		"Horizontal trigger position", NULL},
	{SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
		"Buffer size", NULL},
	{SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
		"Time base", NULL},
	{SR_CONF_FILTER, SR_T_CHAR, "filter",
		"Filter targets", NULL},
	{SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
		"Volts/div", NULL},
	{SR_CONF_COUPLING, SR_T_CHAR, "coupling",
		"Coupling", NULL},
	{SR_CONF_DATALOG, SR_T_BOOL, "datalog",
		"Datalog", NULL},
	{0, 0, NULL, NULL, NULL},
};

/** @cond PRIVATE */
#ifdef HAVE_HW_BRYMEN_DMM
extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
#endif
#ifdef HAVE_HW_COLEAD_SLM
extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
#endif
#ifdef HAVE_LA_DEMO
extern SR_PRIV struct sr_dev_driver demo_driver_info;
#endif
#ifdef HAVE_HW_LASCAR_EL_USB
extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
#endif
#ifdef HAVE_HW_MIC_985XX
extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
#endif
#ifdef HAVE_LA_OLS
extern SR_PRIV struct sr_dev_driver ols_driver_info;
#endif
#ifdef HAVE_HW_RIGOL_DS1XX2
extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
#endif
#ifdef HAVE_HW_TONDAJ_SL_814
extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
#endif
#ifdef HAVE_HW_VICTOR_DMM
extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
#endif
#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
#endif
#ifdef HAVE_LA_ASIX_SIGMA
extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
#endif
#ifdef HAVE_LA_CHRONOVU_LA8
extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
#endif
#ifdef HAVE_HW_ALSA
extern SR_PRIV struct sr_dev_driver alsa_driver_info;
#endif
#ifdef HAVE_LA_FX2LAFW
extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
#endif
#ifdef HAVE_HW_HANTEK_DSO
extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
#endif
#ifdef HAVE_HW_AGILENT_DMM
extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
#endif
#ifdef HAVE_HW_FLUKE_DMM
extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
#endif
#ifdef HAVE_HW_SERIAL_DMM
extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_ser_driver_info;
extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
#endif
#ifdef HAVE_HW_UNI_T_DMM
extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_driver_info;
extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
#endif
/** @endcond */

static struct sr_dev_driver *drivers_list[] = {
#ifdef HAVE_HW_BRYMEN_DMM
	&brymen_bm857_driver_info,
#endif
#ifdef HAVE_HW_COLEAD_SLM
	&colead_slm_driver_info,
#endif
#ifdef HAVE_LA_DEMO
	&demo_driver_info,
#endif
#ifdef HAVE_HW_LASCAR_EL_USB
	&lascar_el_usb_driver_info,
#endif
#ifdef HAVE_HW_MIC_985XX
	&mic_98581_driver_info,
	&mic_98583_driver_info,
#endif
#ifdef HAVE_LA_OLS
	&ols_driver_info,
#endif
#ifdef HAVE_HW_RIGOL_DS1XX2
	&rigol_ds1xx2_driver_info,
#endif
#ifdef HAVE_HW_TONDAJ_SL_814
	&tondaj_sl_814_driver_info,
#endif
#ifdef HAVE_HW_VICTOR_DMM
	&victor_dmm_driver_info,
#endif
#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
	&zeroplus_logic_cube_driver_info,
#endif
#ifdef HAVE_LA_ASIX_SIGMA
	&asix_sigma_driver_info,
#endif
#ifdef HAVE_LA_CHRONOVU_LA8
	&chronovu_la8_driver_info,
#endif
#ifdef HAVE_HW_ALSA
	&alsa_driver_info,
#endif
#ifdef HAVE_LA_FX2LAFW
	&fx2lafw_driver_info,
#endif
#ifdef HAVE_HW_HANTEK_DSO
	&hantek_dso_driver_info,
#endif
#ifdef HAVE_HW_AGILENT_DMM
	&agdmm_driver_info,
#endif
#ifdef HAVE_HW_FLUKE_DMM
	&flukedmm_driver_info,
#endif
#ifdef HAVE_HW_SERIAL_DMM
	&digitek_dt4000zc_driver_info,
	&tekpower_tp4000zc_driver_info,
	&metex_me31_driver_info,
	&peaktech_3410_driver_info,
	&mastech_mas345_driver_info,
	&va_va18b_driver_info,
	&metex_m3640d_driver_info,
	&peaktech_4370_driver_info,
	&pce_pce_dm32_driver_info,
	&radioshack_22_168_driver_info,
	&radioshack_22_805_driver_info,
	&radioshack_22_812_driver_info,
	&tecpel_dmm_8060_ser_driver_info,
	&tecpel_dmm_8061_ser_driver_info,
	&voltcraft_vc820_ser_driver_info,
	&voltcraft_vc840_ser_driver_info,
	&uni_t_ut61d_ser_driver_info,
	&uni_t_ut61e_ser_driver_info,
#endif
#ifdef HAVE_HW_UNI_T_DMM
	&tecpel_dmm_8060_driver_info,
	&tecpel_dmm_8061_driver_info,
	&uni_t_ut61d_driver_info,
	&uni_t_ut61e_driver_info,
	&voltcraft_vc820_driver_info,
	&voltcraft_vc840_driver_info,
#endif
	NULL,
};

/**
 * Return the list of supported hardware drivers.
 *
 * @return Pointer to the NULL-terminated list of hardware driver pointers.
 */
SR_API struct sr_dev_driver **sr_driver_list(void)
{

	return drivers_list;
}

/**
 * Initialize a hardware driver.
 *
 * This usually involves memory allocations and variable initializations
 * within the driver, but _not_ scanning for attached devices.
 * The API call sr_driver_scan() is used for that.
 *
 * @param ctx A libsigrok context object allocated by a previous call to
 *            sr_init(). Must not be NULL.
 * @param driver The driver to initialize. This must be a pointer to one of
 *               the entries returned by sr_driver_list(). Must not be NULL.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
 *         SR_ERR_BUG upon internal errors, or another negative error code
 *         upon other errors.
 */
SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
{
	int ret;

	if (!ctx) {
		sr_err("Invalid libsigrok context, can't initialize.");
		return SR_ERR_ARG;
	}

	if (!driver) {
		sr_err("Invalid driver, can't initialize.");
		return SR_ERR_ARG;
	}

	sr_spew("Initializing driver '%s'.", driver->name);
	if ((ret = driver->init(ctx)) < 0)
		sr_err("Failed to initialize the driver: %d.", ret);

	return ret;
}

/**
 * Tell a hardware driver to scan for devices.
 *
 * In addition to the detection, the devices that are found are also
 * initialized automatically. On some devices, this involves a firmware upload,
 * or other such measures.
 *
 * The order in which the system is scanned for devices is not specified. The
 * caller should not assume or rely on any specific order.
 *
 * Before calling sr_driver_scan(), the user must have previously initialized
 * the driver by calling sr_driver_init().
 *
 * @param driver The driver that should scan. This must be a pointer to one of
 *               the entries returned by sr_driver_list(). Must not be NULL.
 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 *                scanner. Can be NULL/empty.
 *
 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 *         found (or errors were encountered). This list must be freed by the
 *         caller using g_slist_free(), but without freeing the data pointed
 *         to in the list.
 */
SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
{
	GSList *l;

	if (!driver) {
		sr_err("Invalid driver, can't scan for devices.");
		return NULL;
	}

	if (!driver->priv) {
		sr_err("Driver not initialized, can't scan for devices.");
		return NULL;
	}

	l = driver->scan(options);

	sr_spew("Scan of '%s' found %d devices.", driver->name,
		g_slist_length(l));

	return l;
}

/** @private */
SR_PRIV void sr_hw_cleanup_all(void)
{
	int i;
	struct sr_dev_driver **drivers;

	drivers = sr_driver_list();
	for (i = 0; drivers[i]; i++) {
		if (drivers[i]->cleanup)
			drivers[i]->cleanup();
	}
}

/** A floating reference can be passed in for data. */
SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
{
	struct sr_config *src;

	if (!(src = g_try_malloc(sizeof(struct sr_config))))
		return NULL;
	src->key = key;
	src->data = g_variant_ref_sink(data);

	return src;
}

SR_PRIV void sr_config_free(struct sr_config *src)
{

	if (!src || !src->data) {
		sr_err("%s: invalid data!", __func__);
		return;
	}

	g_variant_unref(src->data);
	g_free(src);

}

/**
 * Returns information about the given driver or device instance.
 *
 * @param driver The sr_dev_driver struct to query.
 * @param key The configuration key (SR_CONF_*).
 * @param data Pointer to a GVariant where the value will be stored. Must
 *             not be NULL. The caller is given ownership of the GVariant
 *             and must thus decrease the refcount after use. However if
 *             this function returns an error code, the field should be
 *             considered unused, and should not be unreferenced.
 * @param sdi (optional) If the key is specific to a device, this must
 *            contain a pointer to the struct sr_dev_inst to be checked.
 *            Otherwise it must be NULL.
 *
 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 *         may be returned by the driver indicating it doesn't know that key,
 *         but this is not to be flagged as an error by the caller; merely
 *         as an indication that it's not applicable.
 */
SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
		GVariant **data, const struct sr_dev_inst *sdi)
{
	int ret;

	if (!driver || !data)
		return SR_ERR;

	if (!driver->config_get)
		return SR_ERR_ARG;

	if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
		/* Got a floating reference from the driver. Sink it here,
		 * caller will need to unref when done with it. */
		g_variant_ref_sink(*data);
	}

	return ret;
}

/**
 * Set a configuration key in a device instance.
 *
 * @param sdi The device instance.
 * @param key The configuration key (SR_CONF_*).
 * @param data The new value for the key, as a GVariant with GVariantType
 *        appropriate to that key. A floating reference can be passed
 *        in; its refcount will be sunk and unreferenced after use.
 *
 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 *         may be returned by the driver indicating it doesn't know that key,
 *         but this is not to be flagged as an error by the caller; merely
 *         as an indication that it's not applicable.
 */
SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
{
	int ret;

	g_variant_ref_sink(data);

	if (!sdi || !sdi->driver || !data)
		ret = SR_ERR;
	else if (!sdi->driver->config_set)
		ret = SR_ERR_ARG;
	else
		ret = sdi->driver->config_set(key, data, sdi);

	g_variant_unref(data);

	return ret;
}

/**
 * List all possible values for a configuration key.
 *
 * @param driver The sr_dev_driver struct to query.
 * @param key The configuration key (SR_CONF_*).
 * @param data A pointer to a GVariant where the list will be stored. The
 *             caller is given ownership of the GVariant and must thus
 *             unref the GVariant after use. However if this function
 *             returns an error code, the field should be considered
 *             unused, and should not be unreferenced.
 * @param sdi (optional) If the key is specific to a device, this must
 *            contain a pointer to the struct sr_dev_inst to be checked.
 *
 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 *         may be returned by the driver indicating it doesn't know that key,
 *         but this is not to be flagged as an error by the caller; merely
 *         as an indication that it's not applicable.
 */
SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
		GVariant **data, const struct sr_dev_inst *sdi)
{
	int ret;

	if (!driver || !data)
		ret = SR_ERR;
	else if (!driver->config_list)
		ret = SR_ERR_ARG;
	else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
		g_variant_ref_sink(*data);

	return ret;
}

/**
 * Get information about a configuration key.
 *
 * @param key The configuration key.
 *
 * @return A pointer to a struct sr_config_info, or NULL if the key
 *         was not found.
 */
SR_API const struct sr_config_info *sr_config_info_get(int key)
{
	int i;

	for (i = 0; sr_config_info_data[i].key; i++) {
		if (sr_config_info_data[i].key == key)
			return &sr_config_info_data[i];
	}

	return NULL;
}

/**
 * Get information about an configuration key, by name.
 *
 * @param optname The configuration key.
 *
 * @return A pointer to a struct sr_config_info, or NULL if the key
 *         was not found.
 */
SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
{
	int i;

	for (i = 0; sr_config_info_data[i].key; i++) {
		if (!strcmp(sr_config_info_data[i].id, optname))
			return &sr_config_info_data[i];
	}

	return NULL;
}

/* Unnecessary level of indirection follows. */

/** @private */
SR_PRIV int sr_source_remove(int fd)
{
	return sr_session_source_remove(fd);
}

/** @private */
SR_PRIV int sr_source_add(int fd, int events, int timeout,
			  sr_receive_data_callback_t cb, void *cb_data)
{
	return sr_session_source_add(fd, events, timeout, cb, cb_data);
}

/** @} */
Commit	Line	Data
a1bb33af	1	/*
50985c20	2	* This file is part of the libsigrok project.
a1bb33af	3	*
13d8e03c	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
a1bb33af UH	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	#include <stdlib.h>
	21	#include <stdio.h>
	22	#include <sys/types.h>
	23	#include <dirent.h>
	24	#include <string.h>
	25	#include <glib.h>
545f9786	26	#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
45c59c8b BV	27	#include "libsigrok.h"
45c59c8b BV	28	#include "libsigrok-internal.h"
a1bb33af	29
29a27196 UH	30	/* Message logging helpers with subsystem-specific prefix string. */
	31	#define LOG_PREFIX "hwdriver: "
	32	#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
	33	#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
	34	#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
	35	#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
	36	#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
	37	#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
bd36d826	38
393fb9cb UH	39	/**
	40	* @file
	41	*
	42	* Hardware driver handling in libsigrok.
	43	*/
	44
7b870c38 UH	45	/**
	46	* @defgroup grp_driver Hardware drivers
	47	*
	48	* Hardware driver handling in libsigrok.
	49	*
	50	* @{
	51	*/
8bfdc8c4	52
c89c1c9c	53	static struct sr_config_info sr_config_info_data[] = {
1953564a	54	{SR_CONF_CONN, SR_T_CHAR, "conn",
083d64f9	55	"Connection", NULL},
1953564a	56	{SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
083d64f9	57	"Serial communication", NULL},
1953564a	58	{SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
083d64f9	59	"Sample rate", NULL},
1953564a	60	{SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
083d64f9	61	"Pre-trigger capture ratio", NULL},
1953564a	62	{SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
083d64f9	63	"Pattern generator mode", NULL},
8e34ca86 BV	64	{SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
8e34ca86 BV	65	"Trigger types", NULL},
1953564a	66	{SR_CONF_RLE, SR_T_BOOL, "rle",
083d64f9	67	"Run Length Encoding", NULL},
1953564a	68	{SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
083d64f9	69	"Trigger slope", NULL},
1953564a	70	{SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
083d64f9	71	"Trigger source", NULL},
1953564a	72	{SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
083d64f9	73	"Horizontal trigger position", NULL},
1953564a	74	{SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
083d64f9	75	"Buffer size", NULL},
1953564a	76	{SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
083d64f9	77	"Time base", NULL},
1953564a	78	{SR_CONF_FILTER, SR_T_CHAR, "filter",
083d64f9	79	"Filter targets", NULL},
1953564a	80	{SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
083d64f9	81	"Volts/div", NULL},
1953564a	82	{SR_CONF_COUPLING, SR_T_CHAR, "coupling",
083d64f9	83	"Coupling", NULL},
e6551ea6 BV	84	{SR_CONF_DATALOG, SR_T_BOOL, "datalog",
e6551ea6 BV	85	"Datalog", NULL},
083d64f9	86	{0, 0, NULL, NULL, NULL},
a1bb33af UH	87	};
a1bb33af UH	88
b4bd7088	89	/** @cond PRIVATE */
20cbc785	90	#ifdef HAVE_HW_BRYMEN_DMM
c5d6f5cc	91	extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
20cbc785	92	#endif
4d729ddc BV	93	#ifdef HAVE_HW_COLEAD_SLM
	94	extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
	95	#endif
a61b0e6a	96	#ifdef HAVE_LA_DEMO
c09f0b57	97	extern SR_PRIV struct sr_dev_driver demo_driver_info;
a61b0e6a	98	#endif
46697e38 BV	99	#ifdef HAVE_HW_LASCAR_EL_USB
	100	extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
	101	#endif
7ec5b549	102	#ifdef HAVE_HW_MIC_985XX
6f3e5335	103	extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
0cd8e231	104	extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
7ec5b549	105	#endif
960a75e4	106	#ifdef HAVE_LA_OLS
c09f0b57	107	extern SR_PRIV struct sr_dev_driver ols_driver_info;
960a75e4	108	#endif
f4816ac6 ML	109	#ifdef HAVE_HW_RIGOL_DS1XX2
	110	extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
	111	#endif
aa2af324 UH	112	#ifdef HAVE_HW_TONDAJ_SL_814
	113	extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
	114	#endif
ac3898d2 BV	115	#ifdef HAVE_HW_VICTOR_DMM
	116	extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
	117	#endif
960a75e4	118	#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
c09f0b57	119	extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
960a75e4	120	#endif
5b907f9b	121	#ifdef HAVE_LA_ASIX_SIGMA
c09f0b57	122	extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
5b907f9b	123	#endif
f4314d7e	124	#ifdef HAVE_LA_CHRONOVU_LA8
c09f0b57	125	extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
f4314d7e	126	#endif
0254651d	127	#ifdef HAVE_HW_ALSA
c09f0b57	128	extern SR_PRIV struct sr_dev_driver alsa_driver_info;
6ed4f044	129	#endif
f302a082	130	#ifdef HAVE_LA_FX2LAFW
c09f0b57	131	extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
f302a082	132	#endif
3b533202	133	#ifdef HAVE_HW_HANTEK_DSO
62bb8840	134	extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
3b533202	135	#endif
e93cdf42 BV	136	#ifdef HAVE_HW_AGILENT_DMM
	137	extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
	138	#endif
e7edd64f BV	139	#ifdef HAVE_HW_FLUKE_DMM
	140	extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
	141	#endif
21a7f269	142	#ifdef HAVE_HW_SERIAL_DMM
f086b830	143	extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
729b01f9	144	extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
ce3777ad	145	extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
f0ac4929	146	extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
5887c9cc	147	extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
6dca2f16	148	extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
a53da082	149	extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
a376ffea	150	extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
d4bd66a0	151	extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
d5ce233f	152	extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
3864648b	153	extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
21829e67	154	extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
c2fa697a	155	extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_ser_driver_info;
b38e08fb	156	extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
40830061	157	extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
54d11221	158	extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
ae3a59de	159	extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
986fde75	160	extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
7dc55d93	161	#endif
79081ec8	162	#ifdef HAVE_HW_UNI_T_DMM
4554314c	163	extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_driver_info;
b6bad47c	164	extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
fdbcb86d	165	extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
bbef5e32	166	extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
fdbcb86d	167	extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
695d0e1e	168	extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
79081ec8	169	#endif
b4bd7088	170	/** @endcond */
6ed4f044	171
c09f0b57	172	static struct sr_dev_driver *drivers_list[] = {
20cbc785	173	#ifdef HAVE_HW_BRYMEN_DMM
c5d6f5cc	174	&brymen_bm857_driver_info,
20cbc785	175	#endif
4d729ddc BV	176	#ifdef HAVE_HW_COLEAD_SLM
	177	&colead_slm_driver_info,
	178	#endif
a61b0e6a	179	#ifdef HAVE_LA_DEMO
c09f0b57	180	&demo_driver_info,
a61b0e6a	181	#endif
46697e38 BV	182	#ifdef HAVE_HW_LASCAR_EL_USB
	183	&lascar_el_usb_driver_info,
	184	#endif
7ec5b549	185	#ifdef HAVE_HW_MIC_985XX
6f3e5335	186	&mic_98581_driver_info,
0cd8e231	187	&mic_98583_driver_info,
7ec5b549	188	#endif
960a75e4	189	#ifdef HAVE_LA_OLS
c09f0b57	190	&ols_driver_info,
960a75e4	191	#endif
f4816ac6 ML	192	#ifdef HAVE_HW_RIGOL_DS1XX2
	193	&rigol_ds1xx2_driver_info,
	194	#endif
aa2af324 UH	195	#ifdef HAVE_HW_TONDAJ_SL_814
	196	&tondaj_sl_814_driver_info,
	197	#endif
ac3898d2 BV	198	#ifdef HAVE_HW_VICTOR_DMM
	199	&victor_dmm_driver_info,
	200	#endif
960a75e4	201	#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
c09f0b57	202	&zeroplus_logic_cube_driver_info,
960a75e4	203	#endif
5b907f9b	204	#ifdef HAVE_LA_ASIX_SIGMA
c09f0b57	205	&asix_sigma_driver_info,
5b907f9b	206	#endif
f4314d7e	207	#ifdef HAVE_LA_CHRONOVU_LA8
c09f0b57	208	&chronovu_la8_driver_info,
f4314d7e	209	#endif
0254651d	210	#ifdef HAVE_HW_ALSA
c09f0b57	211	&alsa_driver_info,
f302a082 JH	212	#endif
f302a082 JH	213	#ifdef HAVE_LA_FX2LAFW
c09f0b57	214	&fx2lafw_driver_info,
3b533202 BV	215	#endif
3b533202 BV	216	#ifdef HAVE_HW_HANTEK_DSO
62bb8840	217	&hantek_dso_driver_info,
6ed4f044	218	#endif
e93cdf42 BV	219	#ifdef HAVE_HW_AGILENT_DMM
e93cdf42 BV	220	&agdmm_driver_info,
e7edd64f BV	221	#endif
	222	#ifdef HAVE_HW_FLUKE_DMM
	223	&flukedmm_driver_info,
d375b3c3	224	#endif
21a7f269	225	#ifdef HAVE_HW_SERIAL_DMM
f086b830	226	&digitek_dt4000zc_driver_info,
729b01f9	227	&tekpower_tp4000zc_driver_info,
ce3777ad	228	&metex_me31_driver_info,
f0ac4929	229	&peaktech_3410_driver_info,
5887c9cc	230	&mastech_mas345_driver_info,
6dca2f16	231	&va_va18b_driver_info,
a53da082	232	&metex_m3640d_driver_info,
a376ffea	233	&peaktech_4370_driver_info,
d4bd66a0	234	&pce_pce_dm32_driver_info,
d5ce233f	235	&radioshack_22_168_driver_info,
3864648b	236	&radioshack_22_805_driver_info,
21829e67	237	&radioshack_22_812_driver_info,
c2fa697a	238	&tecpel_dmm_8060_ser_driver_info,
b38e08fb	239	&tecpel_dmm_8061_ser_driver_info,
40830061	240	&voltcraft_vc820_ser_driver_info,
54d11221	241	&voltcraft_vc840_ser_driver_info,
ae3a59de	242	&uni_t_ut61d_ser_driver_info,
986fde75	243	&uni_t_ut61e_ser_driver_info,
79081ec8 UH	244	#endif
79081ec8 UH	245	#ifdef HAVE_HW_UNI_T_DMM
4554314c	246	&tecpel_dmm_8060_driver_info,
b6bad47c	247	&tecpel_dmm_8061_driver_info,
fdbcb86d	248	&uni_t_ut61d_driver_info,
bbef5e32	249	&uni_t_ut61e_driver_info,
fdbcb86d	250	&voltcraft_vc820_driver_info,
695d0e1e	251	&voltcraft_vc840_driver_info,
eb1f1eb4	252	#endif
050e9219 UH	253	NULL,
050e9219 UH	254	};
a1bb33af	255
a1645fcd	256	/**
cfe064d8	257	* Return the list of supported hardware drivers.
a1645fcd	258	*
c09f0b57	259	* @return Pointer to the NULL-terminated list of hardware driver pointers.
a1645fcd	260	*/
cfe064d8	261	SR_API struct sr_dev_driver **sr_driver_list(void)
a1bb33af	262	{
80bf0426	263
c09f0b57	264	return drivers_list;
a1bb33af UH	265	}
a1bb33af UH	266
a1645fcd	267	/**
c09f0b57	268	* Initialize a hardware driver.
a1645fcd	269	*
c0eea11c UH	270	* This usually involves memory allocations and variable initializations
	271	* within the driver, but _not_ scanning for attached devices.
	272	* The API call sr_driver_scan() is used for that.
	273	*
44fc870c	274	* @param ctx A libsigrok context object allocated by a previous call to
c0eea11c UH	275	* sr_init(). Must not be NULL.
	276	* @param driver The driver to initialize. This must be a pointer to one of
	277	* the entries returned by sr_driver_list(). Must not be NULL.
a1645fcd	278	*
c0eea11c UH	279	* @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
	280	* SR_ERR_BUG upon internal errors, or another negative error code
	281	* upon other errors.
a1645fcd	282	*/
44fc870c	283	SR_API int sr_driver_init(struct sr_context ctx, struct sr_dev_driver driver)
8722c31e	284	{
c0eea11c UH	285	int ret;
	286
	287	if (!ctx) {
	288	sr_err("Invalid libsigrok context, can't initialize.");
	289	return SR_ERR_ARG;
	290	}
	291
	292	if (!driver) {
	293	sr_err("Invalid driver, can't initialize.");
	294	return SR_ERR_ARG;
	295	}
8722c31e	296
c0eea11c UH	297	sr_spew("Initializing driver '%s'.", driver->name);
	298	if ((ret = driver->init(ctx)) < 0)
	299	sr_err("Failed to initialize the driver: %d.", ret);
80bf0426	300
c0eea11c	301	return ret;
80bf0426 BV	302	}
	303
	304	/**
	305	* Tell a hardware driver to scan for devices.
	306	*
a5f2e707 BV	307	* In addition to the detection, the devices that are found are also
	308	* initialized automatically. On some devices, this involves a firmware upload,
	309	* or other such measures.
	310	*
	311	* The order in which the system is scanned for devices is not specified. The
	312	* caller should not assume or rely on any specific order.
	313	*
4b97c74e UH	314	* Before calling sr_driver_scan(), the user must have previously initialized
4b97c74e UH	315	* the driver by calling sr_driver_init().
80bf0426	316	*
4b97c74e UH	317	* @param driver The driver that should scan. This must be a pointer to one of
	318	* the entries returned by sr_driver_list(). Must not be NULL.
	319	* @param options A list of 'struct sr_hwopt' options to pass to the driver's
	320	* scanner. Can be NULL/empty.
	321	*
	322	* @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
	323	* found (or errors were encountered). This list must be freed by the
	324	* caller using g_slist_free(), but without freeing the data pointed
	325	* to in the list.
80bf0426 BV	326	*/
	327	SR_API GSList sr_driver_scan(struct sr_dev_driver driver, GSList *options)
	328	{
4b97c74e UH	329	GSList *l;
	330
	331	if (!driver) {
	332	sr_err("Invalid driver, can't scan for devices.");
	333	return NULL;
	334	}
	335
	336	if (!driver->priv) {
	337	sr_err("Driver not initialized, can't scan for devices.");
	338	return NULL;
	339	}
	340
	341	l = driver->scan(options);
80bf0426	342
4b97c74e UH	343	sr_spew("Scan of '%s' found %d devices.", driver->name,
4b97c74e UH	344	g_slist_length(l));
80bf0426	345
4b97c74e	346	return l;
8722c31e BV	347	}
8722c31e BV	348
b4bd7088	349	/** @private */
93a04e3b	350	SR_PRIV void sr_hw_cleanup_all(void)
8722c31e	351	{
050e9219	352	int i;
c09f0b57	353	struct sr_dev_driver **drivers;
8722c31e	354
cfe064d8	355	drivers = sr_driver_list();
c09f0b57 UH	356	for (i = 0; drivers[i]; i++) {
	357	if (drivers[i]->cleanup)
	358	drivers[i]->cleanup();
8722c31e	359	}
8722c31e BV	360	}
8722c31e BV	361
bc1c2f00 BV	362	/** A floating reference can be passed in for data. */
bc1c2f00 BV	363	SR_PRIV struct sr_config sr_config_new(int key, GVariant data)
4c0e310c BV	364	{
	365	struct sr_config *src;
	366
	367	if (!(src = g_try_malloc(sizeof(struct sr_config))))
	368	return NULL;
	369	src->key = key;
bc1c2f00	370	src->data = g_variant_ref_sink(data);
4c0e310c BV	371
	372	return src;
	373	}
	374
722db131 BV	375	SR_PRIV void sr_config_free(struct sr_config *src)
	376	{
	377
	378	if (!src \|\| !src->data) {
	379	sr_err("%s: invalid data!", __func__);
	380	return;
	381	}
	382
	383	g_variant_unref(src->data);
	384	g_free(src);
	385
	386	}
	387
df123801 BV	388	/**
	389	* Returns information about the given driver or device instance.
	390	*
	391	* @param driver The sr_dev_driver struct to query.
cbadb856	392	* @param key The configuration key (SR_CONF_*).
bc1c2f00 BV	393	* @param data Pointer to a GVariant where the value will be stored. Must
	394	* not be NULL. The caller is given ownership of the GVariant
	395	* and must thus decrease the refcount after use. However if
	396	* this function returns an error code, the field should be
	397	* considered unused, and should not be unreferenced.
	398	* @param sdi (optional) If the key is specific to a device, this must
	399	* contain a pointer to the struct sr_dev_inst to be checked.
	400	* Otherwise it must be NULL.
df123801 BV	401	*
df123801 BV	402	* @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
cbadb856	403	* may be returned by the driver indicating it doesn't know that key,
df123801 BV	404	* but this is not to be flagged as an error by the caller; merely
	405	* as an indication that it's not applicable.
	406	*/
9fd504b9	407	SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
bc1c2f00	408	GVariant *data, const struct sr_dev_inst sdi)
df123801 BV	409	{
	410	int ret;
	411
cbadb856	412	if (!driver \|\| !data)
df123801 BV	413	return SR_ERR;
df123801 BV	414
6cefe516 BV	415	if (!driver->config_get)
	416	return SR_ERR_ARG;
	417
bc1c2f00 BV	418	if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
	419	/* Got a floating reference from the driver. Sink it here,
	420	* caller will need to unref when done with it. */
	421	g_variant_ref_sink(*data);
	422	}
df123801 BV	423
	424	return ret;
	425	}
	426
cbadb856 BV	427	/**
	428	* Set a configuration key in a device instance.
	429	*
	430	* @param sdi The device instance.
	431	* @param key The configuration key (SR_CONF_*).
bc1c2f00 BV	432	* @param data The new value for the key, as a GVariant with GVariantType
	433	* appropriate to that key. A floating reference can be passed
	434	* in; its refcount will be sunk and unreferenced after use.
cbadb856 BV	435	*
	436	* @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
	437	* may be returned by the driver indicating it doesn't know that key,
	438	* but this is not to be flagged as an error by the caller; merely
	439	* as an indication that it's not applicable.
	440	*/
bc1c2f00	441	SR_API int sr_config_set(const struct sr_dev_inst sdi, int key, GVariant data)
cbadb856 BV	442	{
	443	int ret;
	444
bc1c2f00	445	g_variant_ref_sink(data);
cbadb856	446
bc1c2f00 BV	447	if (!sdi \|\| !sdi->driver \|\| !data)
	448	ret = SR_ERR;
	449	else if (!sdi->driver->config_set)
	450	ret = SR_ERR_ARG;
	451	else
	452	ret = sdi->driver->config_set(key, data, sdi);
cbadb856	453
bc1c2f00	454	g_variant_unref(data);
cbadb856 BV	455
	456	return ret;
	457	}
	458
	459	/**
	460	* List all possible values for a configuration key.
	461	*
	462	* @param driver The sr_dev_driver struct to query.
	463	* @param key The configuration key (SR_CONF_*).
bc1c2f00 BV	464	* @param data A pointer to a GVariant where the list will be stored. The
	465	* caller is given ownership of the GVariant and must thus
	466	* unref the GVariant after use. However if this function
	467	* returns an error code, the field should be considered
	468	* unused, and should not be unreferenced.
	469	* @param sdi (optional) If the key is specific to a device, this must
	470	* contain a pointer to the struct sr_dev_inst to be checked.
cbadb856 BV	471	*
	472	* @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
	473	* may be returned by the driver indicating it doesn't know that key,
	474	* but this is not to be flagged as an error by the caller; merely
	475	* as an indication that it's not applicable.
	476	*/
4c961f5e	477	SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
bc1c2f00	478	GVariant *data, const struct sr_dev_inst sdi)
c5fb502f BV	479	{
	480	int ret;
	481
6cefe516	482	if (!driver \|\| !data)
bc1c2f00	483	ret = SR_ERR;
d8284802	484	else if (!driver->config_list)
6cefe516	485	ret = SR_ERR_ARG;
bc1c2f00 BV	486	else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
bc1c2f00 BV	487	g_variant_ref_sink(*data);
c5fb502f BV	488
	489	return ret;
	490	}
	491
8bfdc8c4	492	/**
cbadb856	493	* Get information about a configuration key.
a1645fcd	494	*
ca0938c5	495	* @param key The configuration key.
15cb43d6	496	*
c89c1c9c	497	* @return A pointer to a struct sr_config_info, or NULL if the key
15cb43d6 BV	498	* was not found.
15cb43d6 BV	499	*/
c89c1c9c	500	SR_API const struct sr_config_info *sr_config_info_get(int key)
15cb43d6 BV	501	{
	502	int i;
	503
c89c1c9c BV	504	for (i = 0; sr_config_info_data[i].key; i++) {
	505	if (sr_config_info_data[i].key == key)
	506	return &sr_config_info_data[i];
15cb43d6 BV	507	}
	508
	509	return NULL;
	510	}
	511
	512	/**
cbadb856	513	* Get information about an configuration key, by name.
15cb43d6	514	*
cbadb856	515	* @param optname The configuration key.
a1645fcd	516	*
c89c1c9c	517	* @return A pointer to a struct sr_config_info, or NULL if the key
15cb43d6	518	* was not found.
a1645fcd	519	*/
c89c1c9c	520	SR_API const struct sr_config_info sr_config_info_name_get(const char optname)
a1bb33af	521	{
a1bb33af UH	522	int i;
a1bb33af UH	523
c89c1c9c BV	524	for (i = 0; sr_config_info_data[i].key; i++) {
	525	if (!strcmp(sr_config_info_data[i].id, optname))
	526	return &sr_config_info_data[i];
a1bb33af UH	527	}
a1bb33af UH	528
49d0ce50	529	return NULL;
a1bb33af UH	530	}
a1bb33af UH	531
69cfcfc8	532	/* Unnecessary level of indirection follows. */
544a4582	533
b4bd7088	534	/** @private */
69cfcfc8	535	SR_PRIV int sr_source_remove(int fd)
a1bb33af	536	{
69cfcfc8	537	return sr_session_source_remove(fd);
a1bb33af UH	538	}
a1bb33af UH	539
b4bd7088	540	/** @private */
69cfcfc8 UH	541	SR_PRIV int sr_source_add(int fd, int events, int timeout,
69cfcfc8 UH	542	sr_receive_data_callback_t cb, void *cb_data)
a1bb33af	543	{
69cfcfc8	544	return sr_session_source_add(fd, events, timeout, cb, cb_data);
a1bb33af	545	}
7b870c38 UH	546
7b870c38 UH	547	/** @} */