[libsigrok.git] / hwdriver.c

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

#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 driver-specific prefix string. */
#define DRIVER_LOG_DOMAIN "hwdriver: "
#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)

/**
 * @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_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},
	{0, 0, NULL, NULL, NULL},
};

/** @cond PRIVATE */
#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_985xx_driver_info;
#endif
#ifdef HAVE_HW_NEXUS_OSCIPRIME
extern SR_PRIV struct sr_dev_driver nexus_osciprime_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_LA_LINK_MSO19
extern SR_PRIV struct sr_dev_driver link_mso19_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_812_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_ut61e_ser_driver_info;
#endif
#ifdef HAVE_HW_UNI_T_DMM
extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
#endif
/** @endcond */

static struct sr_dev_driver *drivers_list[] = {
#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_985xx_driver_info,
#endif
#ifdef HAVE_HW_NEXUS_OSCIPRIME
	&nexus_osciprime_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_LA_LINK_MSO19
	&link_mso19_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_812_driver_info,
	&voltcraft_vc820_ser_driver_info,
	&voltcraft_vc840_ser_driver_info,
	&uni_t_ut61e_ser_driver_info,
#endif
#ifdef HAVE_HW_UNI_T_DMM
	&uni_t_ut61d_driver_info,
	&voltcraft_vc820_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();
	}
}

SR_PRIV struct sr_config *sr_config_make(int key, const void *value)
{
	struct sr_config *src;

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

	return 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 where the value will be stored. Must not be NULL.
 * @param sdi 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_get(const struct sr_dev_driver *driver, int key,
		const void **data, const struct sr_dev_inst *sdi)
{
	int ret;

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

	if (!driver->config_get)
		return SR_ERR_ARG;

	ret = driver->config_get(key, data, sdi);

	return ret;
}

/**
 * Set a configuration key in a device instance.
 *
 * @param sdi The device instance.
 * @param key The configuration key (SR_CONF_*).
 * @param value The new value for the key, as a pointer to whatever type
 *        is appropriate for that key.
 *
 * @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,
		const void *value)
{
	int ret;

	if (!sdi || !sdi->driver || !value)
		return SR_ERR;

	if (!sdi->driver->config_set)
		return SR_ERR_ARG;

	ret = sdi->driver->config_set(key, value, sdi);

	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 list of values, in whatever format is
 *             appropriate for that key.
 * @param sdi 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,
		const void **data, const struct sr_dev_inst *sdi)
{
	int ret;

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

	if (!driver->config_list)
		return SR_ERR_ARG;

	ret = driver->config_list(key, data, sdi);

	return ret;
}

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