[libsigrok.git] / src / 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"

/** @cond PRIVATE */
#define LOG_PREFIX "device"
/** @endcond */

/**
 * @file
 *
 * Device handling in libsigrok.
 */

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

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

	if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
		sr_err("Channel malloc failed.");
		return NULL;
	}

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

	return ch;
}

/**
 * Set the name of the specified channel in the specified device.
 *
 * If the channel 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 channel is connected to.
 * @param[in] channelnum The number of the channel whose name to set.
 *                 Note that the channel numbers start at 0.
 * @param[in] name The new name that the specified channel should get. A copy
 *             of the string is made.
 *
 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
 *
 * @since 0.3.0
 */
SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
		int channelnum, const char *name)
{
	GSList *l;
	struct sr_channel *ch;
	int ret;

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

	ret = SR_ERR_ARG;
	for (l = sdi->channels; l; l = l->next) {
		ch = l->data;
		if (ch->index == channelnum) {
			g_free(ch->name);
			ch->name = g_strdup(name);
			ret = SR_OK;
			break;
		}
	}

	return ret;
}

/**
 * Enable or disable a channel on the specified device.
 *
 * @param sdi The device instance the channel is connected to.
 * @param channelnum The channel number, starting from 0.
 * @param state TRUE to enable the channel, FALSE to disable.
 *
 * @return SR_OK on success or SR_ERR on failure.  In case of invalid
 *         arguments, SR_ERR_ARG is returned and the channel enabled state
 *         remains unchanged.
 *
 * @since 0.3.0
 */
SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
		gboolean state)
{
	GSList *l;
	struct sr_channel *ch;
	int ret;
	gboolean was_enabled;

	if (!sdi)
		return SR_ERR_ARG;

	ret = SR_ERR_ARG;
	for (l = sdi->channels; l; l = l->next) {
		ch = l->data;
		if (ch->index == channelnum) {
			was_enabled = ch->enabled;
			ch->enabled = state;
			ret = SR_OK;
			if (!state != !was_enabled && sdi->driver
					&& sdi->driver->config_channel_set) {
				ret = sdi->driver->config_channel_set(
					sdi, ch, SR_CHANNEL_SET_ENABLED);
				/* Roll back change if it wasn't applicable. */
				if (ret == SR_ERR_ARG)
					ch->enabled = was_enabled;
			}
			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, sdi, 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] & SR_CONF_MASK) == 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 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->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->serial_num = NULL;
	sdi->connection_id = NULL;
	sdi->channels = NULL;
	sdi->channel_groups = NULL;
	sdi->session = 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_channel *ch;
	GSList *l;

	for (l = sdi->channels; l; l = l->next) {
		ch = l->data;
		g_free(ch->name);
		g_free(ch->priv);
		g_free(ch);
	}
	g_slist_free(sdi->channels);

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

	g_free(sdi->vendor);
	g_free(sdi->model);
	g_free(sdi->version);
	g_free(sdi->serial_num);
	g_free(sdi->connection_id);
	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

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

/** @private */
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 the list of device instances a driver knows about.
 *
 * @param driver The driver to use. This must be a pointer to one of
 *               the entries returned by sr_driver_list(). Must not be NULL.
 *
 * @retval SR_OK Success
 * @retval SR_ERR_ARG Invalid driver
 *
 * @since 0.2.0
 */
SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
{
	int ret;

	if (!driver) {
		sr_err("Invalid driver.");
		return SR_ERR_ARG;
	}

	if (driver->dev_clear)
		ret = driver->dev_clear();
	else
		ret = std_dev_clear(driver, NULL);

	return ret;
}

/**
 * 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
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#include <stdio.h>
	21	#include <glib.h>
	22	#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
	23	#include "libsigrok.h"
	24	#include "libsigrok-internal.h"
	25
	26	/** @cond PRIVATE */
	27	#define LOG_PREFIX "device"
	28	/** @endcond */
	29
	30	/**
	31	* @file
	32	*
	33	* Device handling in libsigrok.
	34	*/
	35
	36	/**
	37	* @defgroup grp_devices Devices
	38	*
	39	* Device handling in libsigrok.
	40	*
	41	* @{
	42	*/
	43
	44	/** @private
	45	* Allocate and initialize new struct sr_channel
	46	* @param[in] index @copydoc sr_channel::index
	47	* @param[in] type @copydoc sr_channel::type
	48	* @param[in] enabled @copydoc sr_channel::enabled
	49	* @param[in] name @copydoc sr_channel::name
	50	*
	51	* @return NULL (failure) or new struct sr_channel*.
	52	*/
	53	SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
	54	gboolean enabled, const char *name)
	55	{
	56	struct sr_channel *ch;
	57
	58	if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
	59	sr_err("Channel malloc failed.");
	60	return NULL;
	61	}
	62
	63	ch->index = index;
	64	ch->type = type;
	65	ch->enabled = enabled;
	66	if (name)
	67	ch->name = g_strdup(name);
	68
	69	return ch;
	70	}
	71
	72	/**
	73	* Set the name of the specified channel in the specified device.
	74	*
	75	* If the channel already has a different name assigned to it, it will be
	76	* removed, and the new name will be saved instead.
	77	*
	78	* @param sdi The device instance the channel is connected to.
	79	* @param[in] channelnum The number of the channel whose name to set.
	80	* Note that the channel numbers start at 0.
	81	* @param[in] name The new name that the specified channel should get. A copy
	82	* of the string is made.
	83	*
	84	* @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
	85	*
	86	* @since 0.3.0
	87	*/
	88	SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
	89	int channelnum, const char *name)
	90	{
	91	GSList *l;
	92	struct sr_channel *ch;
	93	int ret;
	94
	95	if (!sdi) {
	96	sr_err("%s: sdi was NULL", __func__);
	97	return SR_ERR_ARG;
	98	}
	99
	100	ret = SR_ERR_ARG;
	101	for (l = sdi->channels; l; l = l->next) {
	102	ch = l->data;
	103	if (ch->index == channelnum) {
	104	g_free(ch->name);
	105	ch->name = g_strdup(name);
	106	ret = SR_OK;
	107	break;
	108	}
	109	}
	110
	111	return ret;
	112	}
	113
	114	/**
	115	* Enable or disable a channel on the specified device.
	116	*
	117	* @param sdi The device instance the channel is connected to.
	118	* @param channelnum The channel number, starting from 0.
	119	* @param state TRUE to enable the channel, FALSE to disable.
	120	*
	121	* @return SR_OK on success or SR_ERR on failure. In case of invalid
	122	* arguments, SR_ERR_ARG is returned and the channel enabled state
	123	* remains unchanged.
	124	*
	125	* @since 0.3.0
	126	*/
	127	SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
	128	gboolean state)
	129	{
	130	GSList *l;
	131	struct sr_channel *ch;
	132	int ret;
	133	gboolean was_enabled;
	134
	135	if (!sdi)
	136	return SR_ERR_ARG;
	137
	138	ret = SR_ERR_ARG;
	139	for (l = sdi->channels; l; l = l->next) {
	140	ch = l->data;
	141	if (ch->index == channelnum) {
	142	was_enabled = ch->enabled;
	143	ch->enabled = state;
	144	ret = SR_OK;
	145	if (!state != !was_enabled && sdi->driver
	146	&& sdi->driver->config_channel_set) {
	147	ret = sdi->driver->config_channel_set(
	148	sdi, ch, SR_CHANNEL_SET_ENABLED);
	149	/* Roll back change if it wasn't applicable. */
	150	if (ret == SR_ERR_ARG)
	151	ch->enabled = was_enabled;
	152	}
	153	break;
	154	}
	155	}
	156
	157	return ret;
	158	}
	159
	160	/**
	161	* Determine whether the specified device instance has the specified
	162	* capability.
	163	*
	164	* @param sdi Pointer to the device instance to be checked. Must not be NULL.
	165	* If the device's 'driver' field is NULL (virtual device), this
	166	* function will always return FALSE (virtual devices don't have
	167	* a hardware capabilities list).
	168	* @param[in] key The option that should be checked for is supported by the
	169	* specified device.
	170	*
	171	* @retval TRUE Device has the specified option
	172	* @retval FALSE Device does not have the specified option, invalid input
	173	* parameters or other error conditions.
	174	*
	175	* @since 0.2.0
	176	*/
	177	SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
	178	{
	179	GVariant *gvar;
	180	const int *devopts;
	181	gsize num_opts, i;
	182	int ret;
	183
	184	if (!sdi \|\| !sdi->driver \|\| !sdi->driver->config_list)
	185	return FALSE;
	186
	187	if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
	188	&gvar, sdi, NULL) != SR_OK)
	189	return FALSE;
	190
	191	ret = FALSE;
	192	devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
	193	for (i = 0; i < num_opts; i++) {
	194	if ((devopts[i] & SR_CONF_MASK) == key) {
	195	ret = TRUE;
	196	break;
	197	}
	198	}
	199	g_variant_unref(gvar);
	200
	201	return ret;
	202	}
	203
	204	/** @private
	205	* Allocate and init new device instance struct.
	206	* @param[in] index @copydoc sr_dev_inst::index
	207	* @param[in] status @copydoc sr_dev_inst::status
	208	* @param[in] vendor @copydoc sr_dev_inst::vendor
	209	* @param[in] model @copydoc sr_dev_inst::model
	210	* @param[in] version @copydoc sr_dev_inst::version
	211	*
	212	* @retval NULL Error
	213	* @retval struct sr_dev_inst *. Dynamically allocated, free using
	214	* sr_dev_inst_free().
	215	*/
	216	SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int status,
	217	const char vendor, const char model, const char *version)
	218	{
	219	struct sr_dev_inst *sdi;
	220
	221	if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
	222	sr_err("Device instance malloc failed.");
	223	return NULL;
	224	}
	225
	226	sdi->driver = NULL;
	227	sdi->status = status;
	228	sdi->inst_type = -1;
	229	sdi->vendor = vendor ? g_strdup(vendor) : NULL;
	230	sdi->model = model ? g_strdup(model) : NULL;
	231	sdi->version = version ? g_strdup(version) : NULL;
	232	sdi->serial_num = NULL;
	233	sdi->connection_id = NULL;
	234	sdi->channels = NULL;
	235	sdi->channel_groups = NULL;
	236	sdi->session = NULL;
	237	sdi->conn = NULL;
	238	sdi->priv = NULL;
	239
	240	return sdi;
	241	}
	242
	243	/** @private
	244	* Free device instance struct created by sr_dev_inst().
	245	* @param sdi struct* to free.
	246	*/
	247	SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
	248	{
	249	struct sr_channel *ch;
	250	GSList *l;
	251
	252	for (l = sdi->channels; l; l = l->next) {
	253	ch = l->data;
	254	g_free(ch->name);
	255	g_free(ch->priv);
	256	g_free(ch);
	257	}
	258	g_slist_free(sdi->channels);
	259
	260	if (sdi->channel_groups)
	261	g_slist_free(sdi->channel_groups);
	262
	263	g_free(sdi->vendor);
	264	g_free(sdi->model);
	265	g_free(sdi->version);
	266	g_free(sdi->serial_num);
	267	g_free(sdi->connection_id);
	268	g_free(sdi);
	269	}
	270
	271	#ifdef HAVE_LIBUSB_1_0
	272
	273	/** @private
	274	* Allocate and init struct for USB device instance.
	275	* @param[in] bus @copydoc sr_usb_dev_inst::bus
	276	* @param[in] address @copydoc sr_usb_dev_inst::address
	277	* @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
	278	*
	279	* @retval NULL Error
	280	* @retval other struct sr_usb_dev_inst * for USB device instance.
	281	*/
	282	SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
	283	uint8_t address, struct libusb_device_handle *hdl)
	284	{
	285	struct sr_usb_dev_inst *udi;
	286
	287	if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
	288	sr_err("USB device instance malloc failed.");
	289	return NULL;
	290	}
	291
	292	udi->bus = bus;
	293	udi->address = address;
	294	udi->devhdl = hdl;
	295
	296	return udi;
	297	}
	298
	299	/** @private
	300	* Free struct * allocated by sr_usb_dev_inst().
	301	* @param usb struct* to free. Must not be NULL.
	302	*/
	303	SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
	304	{
	305	g_free(usb);
	306	}
	307
	308	#endif
	309
	310	#ifdef HAVE_LIBSERIALPORT
	311
	312	/**
	313	* @private
	314	*
	315	* Both parameters are copied to newly allocated strings, and freed
	316	* automatically by sr_serial_dev_inst_free().
	317	*
	318	* @param[in] port OS-specific serial port specification. Examples:
	319	* "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
	320	* @param[in] serialcomm A serial communication parameters string, in the form
	321	* of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
	322	* "9600/8n1" or "600/7o2". This is an optional parameter;
	323	* it may be filled in later.
	324	*
	325	* @return A pointer to a newly initialized struct sr_serial_dev_inst,
	326	* or NULL on error.
	327	*/
	328	SR_PRIV struct sr_serial_dev_inst sr_serial_dev_inst_new(const char port,
	329	const char *serialcomm)
	330	{
	331	struct sr_serial_dev_inst *serial;
	332
	333	if (!port) {
	334	sr_err("Serial port required.");
	335	return NULL;
	336	}
	337
	338	if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
	339	sr_err("Serial device instance malloc failed.");
	340	return NULL;
	341	}
	342
	343	serial->port = g_strdup(port);
	344	if (serialcomm)
	345	serial->serialcomm = g_strdup(serialcomm);
	346
	347	return serial;
	348	}
	349
	350	/** @private
	351	* Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
	352	* @param serial struct sr_serial_dev_inst * to free. Must not be NULL.
	353	*/
	354	SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
	355	{
	356	g_free(serial->port);
	357	g_free(serial->serialcomm);
	358	g_free(serial);
	359	}
	360	#endif
	361
	362	/** @private */
	363	SR_PRIV struct sr_usbtmc_dev_inst sr_usbtmc_dev_inst_new(const char device)
	364	{
	365	struct sr_usbtmc_dev_inst *usbtmc;
	366
	367	if (!device) {
	368	sr_err("Device name required.");
	369	return NULL;
	370	}
	371
	372	if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
	373	sr_err("USBTMC device instance malloc failed.");
	374	return NULL;
	375	}
	376
	377	usbtmc->device = g_strdup(device);
	378	usbtmc->fd = -1;
	379
	380	return usbtmc;
	381	}
	382
	383	/** @private */
	384	SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
	385	{
	386	g_free(usbtmc->device);
	387	g_free(usbtmc);
	388	}
	389
	390	/**
	391	* Get the list of devices/instances of the specified driver.
	392	*
	393	* @param driver The driver to use. Must not be NULL.
	394	*
	395	* @return The list of devices/instances of this driver, or NULL upon errors
	396	* or if the list is empty.
	397	*
	398	* @since 0.2.0
	399	*/
	400	SR_API GSList sr_dev_list(const struct sr_dev_driver driver)
	401	{
	402	if (driver && driver->dev_list)
	403	return driver->dev_list();
	404	else
	405	return NULL;
	406	}
	407
	408	/**
	409	* Clear the list of device instances a driver knows about.
	410	*
	411	* @param driver The driver to use. This must be a pointer to one of
	412	* the entries returned by sr_driver_list(). Must not be NULL.
	413	*
	414	* @retval SR_OK Success
	415	* @retval SR_ERR_ARG Invalid driver
	416	*
	417	* @since 0.2.0
	418	*/
	419	SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
	420	{
	421	int ret;
	422
	423	if (!driver) {
	424	sr_err("Invalid driver.");
	425	return SR_ERR_ARG;
	426	}
	427
	428	if (driver->dev_clear)
	429	ret = driver->dev_clear();
	430	else
	431	ret = std_dev_clear(driver, NULL);
	432
	433	return ret;
	434	}
	435
	436	/**
	437	* Open the specified device.
	438	*
	439	* @param sdi Device instance to use. Must not be NULL.
	440	*
	441	* @return SR_OK upon success, a negative error code upon errors.
	442	*
	443	* @since 0.2.0
	444	*/
	445	SR_API int sr_dev_open(struct sr_dev_inst *sdi)
	446	{
	447	int ret;
	448
	449	if (!sdi \|\| !sdi->driver \|\| !sdi->driver->dev_open)
	450	return SR_ERR;
	451
	452	ret = sdi->driver->dev_open(sdi);
	453
	454	return ret;
	455	}
	456
	457	/**
	458	* Close the specified device.
	459	*
	460	* @param sdi Device instance to use. Must not be NULL.
	461	*
	462	* @return SR_OK upon success, a negative error code upon errors.
	463	*
	464	* @since 0.2.0
	465	*/
	466	SR_API int sr_dev_close(struct sr_dev_inst *sdi)
	467	{
	468	int ret;
	469
	470	if (!sdi \|\| !sdi->driver \|\| !sdi->driver->dev_close)
	471	return SR_ERR;
	472
	473	ret = sdi->driver->dev_close(sdi);
	474
	475	return ret;
	476	}
	477
	478	/** @} */