[libsigrok.git] / device.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 <stdio.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 "device: "
#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
 *
 * Device handling in libsigrok.
 */

/**
 * @defgroup grp_devices Devices
 *
 * Device handling in libsigrok.
 *
 * @{
 */

/** @private
 *  Allocate and initialize new struct sr_probe
 *  @param[in]  index \copydoc sr_probe::index
 *  @param[in]  type \copydoc sr_probe::type
 *  @param[in]  enabled \copydoc sr_probe::enabled
 *  @param[in]  name \copydoc sr_probe::name
 *
 *  @return NULL (failure) or new struct sr_probe*.
 */
SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
		gboolean enabled, const char *name)
{
	struct sr_probe *probe;

	if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
		sr_err("Probe malloc failed.");
		return NULL;
	}

	probe->index = index;
	probe->type = type;
	probe->enabled = enabled;
	if (name)
		probe->name = g_strdup(name);

	return probe;
}

/**
 * Set the name of the specified probe in the specified device.
 *
 * If the probe already has a different name assigned to it, it will be
 * removed, and the new name will be saved instead.
 *
 * @param sdi The device instance the probe is connected to.
 * @param[in] probenum The number of the probe whose name to set.
 *                 Note that the probe numbers start at 0.
 * @param[in] name The new name that the specified probe should get. A copy
 *             of the string is made.
 *
 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
 *
 * @since 0.2.0
 */
SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
		int probenum, const char *name)
{
	GSList *l;
	struct sr_probe *probe;
	int ret;

	if (!sdi) {
		sr_err("%s: sdi was NULL", __func__);
		return SR_ERR_ARG;
	}

	ret = SR_ERR_ARG;
	for (l = sdi->probes; l; l = l->next) {
		probe = l->data;
		if (probe->index == probenum) {
			g_free(probe->name);
			probe->name = g_strdup(name);
			ret = SR_OK;
			break;
		}
	}

	return ret;
}

/**
 * Enable or disable a probe on the specified device.
 *
 * @param sdi The device instance the probe is connected to.
 * @param probenum The probe number, starting from 0.
 * @param state TRUE to enable the probe, FALSE to disable.
 *
 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
 *
 * @since 0.2.0
 */
SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
		gboolean state)
{
	GSList *l;
	struct sr_probe *probe;
	int ret;

	if (!sdi)
		return SR_ERR_ARG;

	ret = SR_ERR_ARG;
	for (l = sdi->probes; l; l = l->next) {
		probe = l->data;
		if (probe->index == probenum) {
			probe->enabled = state;
			ret = SR_OK;
			break;
		}
	}

	return ret;
}

/**
 * Add a trigger to the specified device (and the specified probe).
 *
 * If the specified probe of this device already has a trigger, it will
 * be silently replaced.
 *
 * @param[in,out] sdi Pointer to the device instance; must not be NULL.
 * @param[in] probenum Number of probe, starting at 0.
 * @param[in] trigger Trigger string, in the format used by sigrok-cli
 *
 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
 *
 * @since 0.2.0
 */
SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
		const char *trigger)
{
	GSList *l;
	struct sr_probe *probe;
	int ret;

	if (!sdi)
		return SR_ERR_ARG;

	ret = SR_ERR_ARG;
	for (l = sdi->probes; l; l = l->next) {
		probe = l->data;
		if (probe->index == probenum) {
			/* If the probe already has a trigger, kill it first. */
			g_free(probe->trigger);
			probe->trigger = g_strdup(trigger);
			ret = SR_OK;
			break;
		}
	}

	return ret;
}

/**
 * Determine whether the specified device instance has the specified
 * capability.
 *
 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
 *            If the device's 'driver' field is NULL (virtual device), this
 *            function will always return FALSE (virtual devices don't have
 *            a hardware capabilities list).
 * @param[in] key The option that should be checked for is supported by the
 *            specified device.
 *
 * @retval TRUE Device has the specified option
 * @retval FALSE Device does not have the specified option, invalid input
 *         parameters or other error conditions.
 *
 * @since 0.2.0
 */
SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
{
	GVariant *gvar;
	const int *devopts;
	gsize num_opts, i;
	int ret;

	if (!sdi || !sdi->driver || !sdi->driver->config_list)
		return FALSE;

	if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
				&gvar, NULL, NULL) != SR_OK)
		return FALSE;

	ret = FALSE;
	devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
	for (i = 0; i < num_opts; i++) {
		if (devopts[i] == key) {
			ret = TRUE;
			break;
		}
	}
	g_variant_unref(gvar);

	return ret;
}

/** @private
 *  Allocate and init new device instance struct.
 *  \param[in]  index   \copydoc sr_dev_inst::index
 *  \param[in]  status  \copydoc sr_dev_inst::status
 *  \param[in]  vendor  \copydoc sr_dev_inst::vendor
 *  \param[in]  model   \copydoc sr_dev_inst::model
 *  \param[in]  version \copydoc sr_dev_inst::version
 *
 *  \retval NULL Error
 *  \retval struct sr_dev_inst *. Dynamically allocated, free using
 *              sr_dev_inst_free().
 */
SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
		const char *vendor, const char *model, const char *version)
{
	struct sr_dev_inst *sdi;

	if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
		sr_err("Device instance malloc failed.");
		return NULL;
	}

	sdi->driver = NULL;
	sdi->index = index;
	sdi->status = status;
	sdi->inst_type = -1;
	sdi->vendor = vendor ? g_strdup(vendor) : NULL;
	sdi->model = model ? g_strdup(model) : NULL;
	sdi->version = version ? g_strdup(version) : NULL;
	sdi->probes = NULL;
	sdi->probe_groups = NULL;
	sdi->conn = NULL;
	sdi->priv = NULL;

	return sdi;
}

/** @private
 *  Free device instance struct created by sr_dev_inst().
 *  \param sdi  struct* to free.
 */
SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
{
	struct sr_probe *probe;
	GSList *l;

	for (l = sdi->probes; l; l = l->next) {
		probe = l->data;
		g_free(probe->name);
		g_free(probe->trigger);
		g_free(probe);
	}
	g_slist_free(sdi->probes);

	if (sdi->probe_groups)
		g_slist_free(sdi->probe_groups);

	g_free(sdi->vendor);
	g_free(sdi->model);
	g_free(sdi->version);
	g_free(sdi);
}

#ifdef HAVE_LIBUSB_1_0

/** @private
 *  Allocate and init struct for USB device instance.
 *  \param[in]  bus \copydoc sr_usb_dev_inst::bus
 *  \param[in]  address \copydoc sr_usb_dev_inst::address
 *  \param[in]  hdl \copydoc sr_usb_dev_inst::devhdl
 *
 *  \retval NULL Error
 *  \retval other struct sr_usb_dev_inst * for USB device instance.
 */
SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
			uint8_t address, struct libusb_device_handle *hdl)
{
	struct sr_usb_dev_inst *udi;

	if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
		sr_err("USB device instance malloc failed.");
		return NULL;
	}

	udi->bus = bus;
	udi->address = address;
	udi->devhdl = hdl;

	return udi;
}

/** @private
 *  Free struct * allocated by sr_usb_dev_inst().
 *  \param usb  struct* to free. Must not be NULL.
 */
SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
{
	g_free(usb);
}

#endif

#ifdef HAVE_LIBSERIALPORT

/**
 * @private
 *
 * Both parameters are copied to newly allocated strings, and freed
 * automatically by sr_serial_dev_inst_free().
 *
 * @param[in] port OS-specific serial port specification. Examples:
 *                 "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
 * @param[in] serialcomm A serial communication parameters string, in the form
 *              of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
 *              "9600/8n1" or "600/7o2". This is an optional parameter;
 *              it may be filled in later.
 *
 * @return A pointer to a newly initialized struct sr_serial_dev_inst,
 *         or NULL on error.
 */
SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
		const char *serialcomm)
{
	struct sr_serial_dev_inst *serial;

	if (!port) {
		sr_err("Serial port required.");
		return NULL;
	}

	if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
		sr_err("Serial device instance malloc failed.");
		return NULL;
	}

	serial->port = g_strdup(port);
	if (serialcomm)
		serial->serialcomm = g_strdup(serialcomm);

	return serial;
}

/** @private
 *  Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
 *  \param serial   struct sr_serial_dev_inst * to free. Must not be NULL.
 */
SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
{
	g_free(serial->port);
	g_free(serial->serialcomm);
	g_free(serial);
}
#endif

SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
{
	struct sr_usbtmc_dev_inst *usbtmc;

	if (!device) {
		sr_err("Device name required.");
		return NULL;
	}

	if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
		sr_err("USBTMC device instance malloc failed.");
		return NULL;
	}

	usbtmc->device = g_strdup(device);
	usbtmc->fd = -1;

	return usbtmc;
}

SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
{
	g_free(usbtmc->device);
	g_free(usbtmc);
}

/**
 * Get the list of devices/instances of the specified driver.
 *
 * @param driver The driver to use. Must not be NULL.
 *
 * @return The list of devices/instances of this driver, or NULL upon errors
 *         or if the list is empty.
 *
 * @since 0.2.0
 */
SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
{
	if (driver && driver->dev_list)
		return driver->dev_list();
	else
		return NULL;
}

/**
 * Clear all devices/instances of the specified driver.
 *
 * @param driver The driver to use. Must not be NULL.
 *
 * @return SR_OK upon success, a negative error code upon errors.
 *
 * @since 0.2.0
 */
SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
{
	if (driver && driver->dev_clear)
		return driver->dev_clear();
	else
		return SR_OK;
}

/**
 * Open the specified device.
 *
 * @param sdi Device instance to use. Must not be NULL.
 *
 * @return SR_OK upon success, a negative error code upon errors.
 *
 * @since 0.2.0
 */
SR_API int sr_dev_open(struct sr_dev_inst *sdi)
{
	int ret;

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

	ret = sdi->driver->dev_open(sdi);

	return ret;
}

/**
 * Close the specified device.
 *
 * @param sdi Device instance to use. Must not be NULL.
 *
 * @return SR_OK upon success, a negative error code upon errors.
 *
 * @since 0.2.0
 */
SR_API int sr_dev_close(struct sr_dev_inst *sdi)
{
	int ret;

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

	ret = sdi->driver->dev_close(sdi);

	return ret;
}

/** @} */
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 <stdio.h>
	21	#include <glib.h>
545f9786	22	#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
45c59c8b BV	23	#include "libsigrok.h"
45c59c8b BV	24	#include "libsigrok-internal.h"
a1bb33af	25
29a27196 UH	26	/* Message logging helpers with subsystem-specific prefix string. */
	27	#define LOG_PREFIX "device: "
	28	#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
	29	#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
	30	#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
	31	#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
	32	#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
	33	#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
a885ce3e	34
393fb9cb UH	35	/**
	36	* @file
	37	*
	38	* Device handling in libsigrok.
	39	*/
	40
7b870c38 UH	41	/**
	42	* @defgroup grp_devices Devices
	43	*
	44	* Device handling in libsigrok.
	45	*
	46	* @{
	47	*/
	48
04cb9157 MH	49	/** @private
	50	* Allocate and initialize new struct sr_probe
	51	* @param[in] index \copydoc sr_probe::index
	52	* @param[in] type \copydoc sr_probe::type
	53	* @param[in] enabled \copydoc sr_probe::enabled
	54	* @param[in] name \copydoc sr_probe::name
	55	*
	56	* @return NULL (failure) or new struct sr_probe*.
	57	*/
48a486cd BV	58	SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
	59	gboolean enabled, const char *name)
	60	{
	61	struct sr_probe *probe;
	62
	63	if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
a885ce3e	64	sr_err("Probe malloc failed.");
48a486cd BV	65	return NULL;
	66	}
	67
	68	probe->index = index;
	69	probe->type = type;
	70	probe->enabled = enabled;
	71	if (name)
	72	probe->name = g_strdup(name);
	73
	74	return probe;
	75	}
	76
94799bc4 UH	77	/**
	78	* Set the name of the specified probe in the specified device.
	79	*
	80	* If the probe already has a different name assigned to it, it will be
	81	* removed, and the new name will be saved instead.
	82	*
37e8b4c4	83	* @param sdi The device instance the probe is connected to.
04cb9157	84	* @param[in] probenum The number of the probe whose name to set.
37e8b4c4	85	* Note that the probe numbers start at 0.
04cb9157	86	* @param[in] name The new name that the specified probe should get. A copy
37e8b4c4	87	* of the string is made.
0e3b1439	88	*
37e8b4c4	89	* @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
9fb5f2df	90	*
53f05fa8	91	* @since 0.2.0
94799bc4	92	*/
37e8b4c4 BV	93	SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
37e8b4c4 BV	94	int probenum, const char *name)
a1bb33af	95	{
37e8b4c4 BV	96	GSList *l;
	97	struct sr_probe *probe;
	98	int ret;
a1bb33af	99
37e8b4c4 BV	100	if (!sdi) {
37e8b4c4 BV	101	sr_err("%s: sdi was NULL", __func__);
0e3b1439	102	return SR_ERR_ARG;
94799bc4 UH	103	}
94799bc4 UH	104
37e8b4c4 BV	105	ret = SR_ERR_ARG;
	106	for (l = sdi->probes; l; l = l->next) {
	107	probe = l->data;
	108	if (probe->index == probenum) {
	109	g_free(probe->name);
	110	probe->name = g_strdup(name);
	111	ret = SR_OK;
	112	break;
	113	}
94799bc4 UH	114	}
94799bc4 UH	115
37e8b4c4	116	return ret;
a1bb33af UH	117	}
a1bb33af UH	118
be5bf44d BV	119	/**
	120	* Enable or disable a probe on the specified device.
	121	*
	122	* @param sdi The device instance the probe is connected to.
	123	* @param probenum The probe number, starting from 0.
	124	* @param state TRUE to enable the probe, FALSE to disable.
	125	*
	126	* @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
9fb5f2df UH	127	*
9fb5f2df UH	128	* @since 0.2.0
be5bf44d BV	129	*/
	130	SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
	131	gboolean state)
	132	{
	133	GSList *l;
	134	struct sr_probe *probe;
	135	int ret;
	136
	137	if (!sdi)
	138	return SR_ERR_ARG;
	139
	140	ret = SR_ERR_ARG;
	141	for (l = sdi->probes; l; l = l->next) {
	142	probe = l->data;
	143	if (probe->index == probenum) {
	144	probe->enabled = state;
	145	ret = SR_OK;
	146	break;
	147	}
	148	}
	149
	150	return ret;
	151	}
	152
94799bc4	153	/**
01c3e9db UH	154	* Add a trigger to the specified device (and the specified probe).
	155	*
	156	* If the specified probe of this device already has a trigger, it will
	157	* be silently replaced.
94799bc4	158	*
04cb9157 MH	159	* @param[in,out] sdi Pointer to the device instance; must not be NULL.
	160	* @param[in] probenum Number of probe, starting at 0.
	161	* @param[in] trigger Trigger string, in the format used by sigrok-cli
0e3b1439	162	*
a5f2e707	163	* @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
9fb5f2df	164	*
53f05fa8	165	* @since 0.2.0
94799bc4	166	*/
58453e58 BV	167	SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
58453e58 BV	168	const char *trigger)
a1bb33af	169	{
58453e58 BV	170	GSList *l;
	171	struct sr_probe *probe;
	172	int ret;
a1bb33af	173
58453e58	174	if (!sdi)
0e3b1439	175	return SR_ERR_ARG;
94799bc4	176
58453e58 BV	177	ret = SR_ERR_ARG;
	178	for (l = sdi->probes; l; l = l->next) {
	179	probe = l->data;
	180	if (probe->index == probenum) {
	181	/* If the probe already has a trigger, kill it first. */
	182	g_free(probe->trigger);
	183	probe->trigger = g_strdup(trigger);
	184	ret = SR_OK;
	185	break;
	186	}
94799bc4	187	}
a1bb33af	188
58453e58	189	return ret;
7d658874 BV	190	}
7d658874 BV	191
94799bc4	192	/**
9c5332d2 UH	193	* Determine whether the specified device instance has the specified
9c5332d2 UH	194	* capability.
94799bc4	195	*
9c5332d2	196	* @param sdi Pointer to the device instance to be checked. Must not be NULL.
8ec95d22 UH	197	* If the device's 'driver' field is NULL (virtual device), this
	198	* function will always return FALSE (virtual devices don't have
	199	* a hardware capabilities list).
04cb9157	200	* @param[in] key The option that should be checked for is supported by the
4d15e5c9	201	* specified device.
94799bc4	202	*
04cb9157 MH	203	* @retval TRUE Device has the specified option
	204	* @retval FALSE Device does not have the specified option, invalid input
	205	* parameters or other error conditions.
9fb5f2df	206	*
53f05fa8	207	* @since 0.2.0
94799bc4	208	*/
4d15e5c9	209	SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
7d658874	210	{
003595ac	211	GVariant *gvar;
4d15e5c9	212	const int *devopts;
003595ac BV	213	gsize num_opts, i;
003595ac BV	214	int ret;
7d658874	215
003595ac	216	if (!sdi \|\| !sdi->driver \|\| !sdi->driver->config_list)
8ec95d22	217	return FALSE;
94799bc4	218
8f996b89 ML	219	if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
8f996b89 ML	220	&gvar, NULL, NULL) != SR_OK)
8ec95d22	221	return FALSE;
94799bc4	222
003595ac BV	223	ret = FALSE;
	224	devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
	225	for (i = 0; i < num_opts; i++) {
	226	if (devopts[i] == key) {
	227	ret = TRUE;
	228	break;
	229	}
94799bc4	230	}
003595ac	231	g_variant_unref(gvar);
218557b8	232
003595ac	233	return ret;
a1bb33af	234	}
fd9836bf	235
04cb9157 MH	236	/** @private
	237	* Allocate and init new device instance struct.
	238	* \param[in] index \copydoc sr_dev_inst::index
	239	* \param[in] status \copydoc sr_dev_inst::status
	240	* \param[in] vendor \copydoc sr_dev_inst::vendor
	241	* \param[in] model \copydoc sr_dev_inst::model
	242	* \param[in] version \copydoc sr_dev_inst::version
	243	*
	244	* \retval NULL Error
	245	* \retval struct sr_dev_inst *. Dynamically allocated, free using
	246	* sr_dev_inst_free().
	247	*/
48a486cd BV	248	SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
	249	const char vendor, const char model, const char *version)
	250	{
	251	struct sr_dev_inst *sdi;
	252
	253	if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
c4227fc6	254	sr_err("Device instance malloc failed.");
48a486cd BV	255	return NULL;
	256	}
	257
e8d3d6c8	258	sdi->driver = NULL;
48a486cd BV	259	sdi->index = index;
	260	sdi->status = status;
	261	sdi->inst_type = -1;
	262	sdi->vendor = vendor ? g_strdup(vendor) : NULL;
	263	sdi->model = model ? g_strdup(model) : NULL;
	264	sdi->version = version ? g_strdup(version) : NULL;
	265	sdi->probes = NULL;
909cc050	266	sdi->probe_groups = NULL;
9e2e9864	267	sdi->conn = NULL;
48a486cd BV	268	sdi->priv = NULL;
	269
	270	return sdi;
	271	}
	272
04cb9157 MH	273	/** @private
	274	* Free device instance struct created by sr_dev_inst().
	275	* \param sdi struct* to free.
	276	*/
48a486cd BV	277	SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
48a486cd BV	278	{
d3cff734 BV	279	struct sr_probe *probe;
	280	GSList *l;
	281
	282	for (l = sdi->probes; l; l = l->next) {
	283	probe = l->data;
	284	g_free(probe->name);
a006798b	285	g_free(probe->trigger);
d3cff734 BV	286	g_free(probe);
d3cff734 BV	287	}
a006798b	288	g_slist_free(sdi->probes);
d3cff734	289
90c7f4e9 DJ	290	if (sdi->probe_groups)
	291	g_slist_free(sdi->probe_groups);
	292
48a486cd BV	293	g_free(sdi->vendor);
	294	g_free(sdi->model);
	295	g_free(sdi->version);
	296	g_free(sdi);
	297	}
	298
	299	#ifdef HAVE_LIBUSB_1_0
	300
04cb9157 MH	301	/** @private
	302	* Allocate and init struct for USB device instance.
	303	* \param[in] bus \copydoc sr_usb_dev_inst::bus
	304	* \param[in] address \copydoc sr_usb_dev_inst::address
	305	* \param[in] hdl \copydoc sr_usb_dev_inst::devhdl
	306	*
	307	* \retval NULL Error
	308	* \retval other struct sr_usb_dev_inst * for USB device instance.
	309	*/
48a486cd BV	310	SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
	311	uint8_t address, struct libusb_device_handle *hdl)
	312	{
	313	struct sr_usb_dev_inst *udi;
	314
	315	if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
c4227fc6	316	sr_err("USB device instance malloc failed.");
48a486cd BV	317	return NULL;
	318	}
	319
	320	udi->bus = bus;
	321	udi->address = address;
	322	udi->devhdl = hdl;
	323
	324	return udi;
	325	}
	326
04cb9157 MH	327	/** @private
	328	* Free struct * allocated by sr_usb_dev_inst().
	329	* \param usb struct* to free. Must not be NULL.
	330	*/
48a486cd BV	331	SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
48a486cd BV	332	{
a006798b	333	g_free(usb);
48a486cd BV	334	}
	335
	336	#endif
	337
c4f2dfd0 UH	338	#ifdef HAVE_LIBSERIALPORT
c4f2dfd0 UH	339
9fb5f2df UH	340	/**
9fb5f2df UH	341	* @private
299bdb24 BV	342	*
	343	* Both parameters are copied to newly allocated strings, and freed
	344	* automatically by sr_serial_dev_inst_free().
9fb5f2df	345	*
04cb9157	346	* @param[in] port OS-specific serial port specification. Examples:
9fb5f2df	347	* "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
04cb9157 MH	348	* @param[in] serialcomm A serial communication parameters string, in the form
	349	* of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
	350	* "9600/8n1" or "600/7o2". This is an optional parameter;
	351	* it may be filled in later.
9fb5f2df UH	352	*
	353	* @return A pointer to a newly initialized struct sr_serial_dev_inst,
	354	* or NULL on error.
299bdb24	355	*/
48a486cd	356	SR_PRIV struct sr_serial_dev_inst sr_serial_dev_inst_new(const char port,
299bdb24	357	const char *serialcomm)
48a486cd BV	358	{
	359	struct sr_serial_dev_inst *serial;
	360
299bdb24	361	if (!port) {
c4227fc6	362	sr_err("Serial port required.");
299bdb24 BV	363	return NULL;
	364	}
	365
	366	if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
c4227fc6	367	sr_err("Serial device instance malloc failed.");
48a486cd BV	368	return NULL;
	369	}
	370
	371	serial->port = g_strdup(port);
299bdb24 BV	372	if (serialcomm)
299bdb24 BV	373	serial->serialcomm = g_strdup(serialcomm);
48a486cd BV	374
	375	return serial;
	376	}
	377
04cb9157 MH	378	/** @private
	379	* Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
	380	* \param serial struct sr_serial_dev_inst * to free. Must not be NULL.
	381	*/
48a486cd BV	382	SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
	383	{
	384	g_free(serial->port);
299bdb24	385	g_free(serial->serialcomm);
acac8fc3	386	g_free(serial);
48a486cd	387	}
c4f2dfd0 UH	388	#endif
c4f2dfd0 UH	389
ae67644f ML	390	SR_PRIV struct sr_usbtmc_dev_inst sr_usbtmc_dev_inst_new(const char device)
	391	{
	392	struct sr_usbtmc_dev_inst *usbtmc;
	393
	394	if (!device) {
	395	sr_err("Device name required.");
	396	return NULL;
	397	}
	398
	399	if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
	400	sr_err("USBTMC device instance malloc failed.");
	401	return NULL;
	402	}
	403
	404	usbtmc->device = g_strdup(device);
	405	usbtmc->fd = -1;
	406
	407	return usbtmc;
	408	}
	409
	410	SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
	411	{
	412	g_free(usbtmc->device);
	413	g_free(usbtmc);
	414	}
	415
576ff5b0 UH	416	/**
	417	* Get the list of devices/instances of the specified driver.
	418	*
	419	* @param driver The driver to use. Must not be NULL.
	420	*
	421	* @return The list of devices/instances of this driver, or NULL upon errors
	422	* or if the list is empty.
	423	*
53f05fa8	424	* @since 0.2.0
576ff5b0	425	*/
f99e32af	426	SR_API GSList sr_dev_list(const struct sr_dev_driver driver)
811deee4	427	{
811deee4 BV	428	if (driver && driver->dev_list)
	429	return driver->dev_list();
	430	else
	431	return NULL;
	432	}
	433
576ff5b0 UH	434	/**
	435	* Clear all devices/instances of the specified driver.
	436	*
	437	* @param driver The driver to use. Must not be NULL.
	438	*
	439	* @return SR_OK upon success, a negative error code upon errors.
	440	*
	441	* @since 0.2.0
	442	*/
f99e32af	443	SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
811deee4	444	{
811deee4 BV	445	if (driver && driver->dev_clear)
	446	return driver->dev_clear();
	447	else
	448	return SR_OK;
	449	}
	450
576ff5b0 UH	451	/**
	452	* Open the specified device.
	453	*
	454	* @param sdi Device instance to use. Must not be NULL.
	455	*
	456	* @return SR_OK upon success, a negative error code upon errors.
	457	*
	458	* @since 0.2.0
	459	*/
efdecf4c BV	460	SR_API int sr_dev_open(struct sr_dev_inst *sdi)
	461	{
	462	int ret;
	463
	464	if (!sdi \|\| !sdi->driver \|\| !sdi->driver->dev_open)
	465	return SR_ERR;
	466
	467	ret = sdi->driver->dev_open(sdi);
	468
	469	return ret;
	470	}
	471
576ff5b0 UH	472	/**
	473	* Close the specified device.
	474	*
	475	* @param sdi Device instance to use. Must not be NULL.
	476	*
	477	* @return SR_OK upon success, a negative error code upon errors.
	478	*
	479	* @since 0.2.0
	480	*/
efdecf4c BV	481	SR_API int sr_dev_close(struct sr_dev_inst *sdi)
	482	{
	483	int ret;
	484
	485	if (!sdi \|\| !sdi->driver \|\| !sdi->driver->dev_close)
	486	return SR_ERR;
	487
	488	ret = sdi->driver->dev_close(sdi);
	489
	490	return ret;
	491	}
	492
7b870c38	493	/** @} */