[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 */
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 probenum The number of the probe whose name to set.
 *                 Note that the probe numbers start at 0.
 * @param 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 sdi Must not be NULL.
 * @param probenum The probe number, starting from 0.
 * @param 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 key The option that should be checked for support on the
 *            specified device.
 *
 * @return TRUE if the device has the specified option, FALSE otherwise.
 *         FALSE is also returned on 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 */
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 */
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 */
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 */
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 pathname OS-specific serial port specification. Examples:
 *                 "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
 * @param 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);
	serial->fd = -1;

	return serial;
}

/** @private */
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

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