[libsigrok.git] / src / std.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

/** @file
  * Standard API helper functions.
  * @internal
  */

#include <config.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "scpi.h"

#define LOG_PREFIX "std"

/**
 * Standard sr_driver_init() API helper.
 *
 * This function can be used to simplify most driver's init() API callback.
 *
 * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
 * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
 *
 * @param di The driver instance to use.
 * @param sr_ctx The libsigrok context to assign.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 */
SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	struct drv_context *drvc;

	drvc = g_malloc0(sizeof(struct drv_context));
	drvc->sr_ctx = sr_ctx;
	drvc->instances = NULL;
	di->context = drvc;

	return SR_OK;
}

/**
 * Standard driver cleanup() callback API helper
 *
 * @param di The driver instance to use.
 *
 * Frees all device instances by calling sr_dev_clear() and then releases any
 * resources allocated by std_init().
 *
 * @retval SR_OK Success
 * @retval SR_ERR_ARG Invalid driver
 *
*/
SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
{
	int ret;

	ret = sr_dev_clear(di);
	g_free(di->context);

	return ret;
}

/**
 * Standard API helper for sending an SR_DF_HEADER packet.
 *
 * This function can be used to simplify most driver's
 * dev_acquisition_start() API callback.
 *
 * @param sdi The device instance to use.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 *         SR_ERR upon other errors.
 */
SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
{
	const char *prefix = sdi->driver->name;
	int ret;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;

	sr_dbg("%s: Starting acquisition.", prefix);

	/* Send header packet to the session bus. */
	sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
	packet.type = SR_DF_HEADER;
	packet.payload = (uint8_t *)&header;
	header.feed_version = 1;
	gettimeofday(&header.starttime, NULL);

	if ((ret = sr_session_send(sdi, &packet)) < 0) {
		sr_err("%s: Failed to send header packet: %d.", prefix, ret);
		return ret;
	}

	return SR_OK;
}

/**
 * Standard API helper for sending an SR_DF_END packet.
 *
 * @param sdi The device instance to use. Must not be NULL.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 *         SR_ERR upon other errors.
 */
SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
{
	const char *prefix = sdi->driver->name;
	int ret;
	struct sr_datafeed_packet packet;

	if (!sdi)
		return SR_ERR_ARG;

	sr_dbg("%s: Sending SR_DF_END packet.", prefix);

	packet.type = SR_DF_END;
	packet.payload = NULL;

	if ((ret = sr_session_send(sdi, &packet)) < 0) {
		sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
		return ret;
	}

	return SR_OK;
}

#ifdef HAVE_LIBSERIALPORT

/**
 * Standard serial driver dev_open() helper.
 *
 * This function can be used to implement the dev_open() driver API
 * callback in drivers that use a serial port. The port is opened
 * with the SERIAL_RDWR flag.
 *
 * If the open succeeded, the status field of the given sdi is set
 * to SR_ST_ACTIVE.
 *
 * @retval SR_OK Success.
 * @retval SR_ERR Serial port open failed.
 */
SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

/**
 * Standard serial driver dev_close() helper.
 *
 * This function can be used to implement the dev_close() driver API
 * callback in drivers that use a serial port.
 *
 * After closing the port, the status field of the given sdi is set
 * to SR_ST_INACTIVE.
 *
 * @retval SR_OK Success.
 */
SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial && sdi->status == SR_ST_ACTIVE) {
		serial_close(serial);
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

/**
 * Standard sr_session_stop() API helper.
 *
 * This function can be used to simplify most (serial port based) driver's
 * dev_acquisition_stop() API callback.
 *
 * @param sdi The device instance for which acquisition should stop.
 *            Must not be NULL.
 * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
 * @param dev_close_fn Function pointer to the driver's dev_close().
 *               	  Must not be NULL.
 * @param serial The serial device instance (struct serial_dev_inst *).
 *               Must not be NULL.
 *
 * @retval SR_OK Success.
 * @retval SR_ERR_ARG Invalid arguments.
 * @retval SR_ERR_DEV_CLOSED Device is closed.
 * @retval SR_ERR Other errors.
 */
SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
			dev_close_callback dev_close_fn,
			struct sr_serial_dev_inst *serial)
{
	const char *prefix = sdi->driver->name;
	int ret;

	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("%s: Device inactive, can't stop acquisition.", prefix);
		return SR_ERR_DEV_CLOSED;
	}

	sr_dbg("%s: Stopping acquisition.", prefix);

	if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
		sr_err("%s: Failed to remove source: %d.", prefix, ret);
		return ret;
	}

	if ((ret = dev_close_fn(sdi)) < 0) {
		sr_err("%s: Failed to close device: %d.", prefix, ret);
		return ret;
	}

	std_session_send_df_end(sdi);

	return SR_OK;
}

#endif

/**
 * Standard driver dev_clear() helper.
 *
 * Clear driver, this means, close all instances.
 *
 * This function can be used to implement the dev_clear() driver API
 * callback. dev_close() is called before every sr_dev_inst is cleared.
 *
 * The only limitation is driver-specific device contexts (sdi->priv).
 * These are freed, but any dynamic allocation within structs stored
 * there cannot be freed.
 *
 * @param driver The driver which will have its instances released.
 * @param clear_private If not NULL, this points to a function called
 * with sdi->priv as argument. The function can then clear any device
 * instance-specific resources kept there. It must also clear the struct
 * pointed to by sdi->priv.
 *
 * @return SR_OK on success.
 */
SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
		std_dev_clear_callback clear_private)
{
	struct drv_context *drvc;
	struct sr_dev_inst *sdi;
	GSList *l;
	int ret;

	if (!(drvc = driver->context))
		/* Driver was never initialized, nothing to do. */
		return SR_OK;

	ret = SR_OK;
	for (l = drvc->instances; l; l = l->next) {
		if (!(sdi = l->data)) {
			ret = SR_ERR_BUG;
			continue;
		}
		if (driver->dev_close)
			driver->dev_close(sdi);

		if (sdi->conn) {
#ifdef HAVE_LIBSERIALPORT
			if (sdi->inst_type == SR_INST_SERIAL)
				sr_serial_dev_inst_free(sdi->conn);
#endif
#ifdef HAVE_LIBUSB_1_0
			if (sdi->inst_type == SR_INST_USB)
				sr_usb_dev_inst_free(sdi->conn);
#endif
			if (sdi->inst_type == SR_INST_SCPI)
				sr_scpi_free(sdi->conn);
			if (sdi->inst_type == SR_INST_MODBUS)
				sr_modbus_free(sdi->conn);
		}
		if (clear_private)
			/* The helper function is responsible for freeing
			 * its own sdi->priv! */
			clear_private(sdi->priv);
		else
			g_free(sdi->priv);

		sr_dev_inst_free(sdi);
	}

	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return ret;
}

/**
 * Standard implementation for the driver dev_list() callback
 *
 * This function can be used as the dev_list callback by most drivers that use
 * the standard helper functions. It returns the devices contained in the driver
 * context instances list.
 *
 * @param di The driver instance to use.
 *
 * @return The list of devices/instances of this driver, or NULL upon errors
 *         or if the list is empty.
 */
SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
{
	struct drv_context *drvc = di->context;

	return drvc->instances;
}

/**
 * Standard scan() callback API helper.
 *
 * This function can be used to perform common tasks required by a driver's
 * scan() callback. It will initialize the driver for each device on the list
 * and add the devices on the list to the driver's device instance list.
 * Usually it should be used as the last step in the scan() callback, right
 * before returning.
 *
 * Note: This function can only be used if std_init() has been called
 * previously by the driver.
 *
 * Example:
 * @code{c}
 * static GSList *scan(struct sr_dev_driver *di, GSList *options)
 * {
 *     struct GSList *device;
 *     struct sr_dev_inst *sdi;
 *
 *     sdi = g_new0(sr_dev_inst, 1);
 *     sdi->vendor = ...;
 *     ...
 *     devices = g_slist_append(devices, sdi);
 *     ...
 *     return std_scan_complete(di, devices);
 * }
 * @endcode
 *
 * @param di The driver instance to use. Must not be NULL.
 * @param devices List of newly discovered devices (struct sr_dev_inst).
 *
 * @return The @p devices list.
 */
SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
{
	struct drv_context *drvc;
	GSList *l;

	if (!di) {
		sr_err("Invalid driver instance (di), cannot complete scan.");
		return NULL;
	}

	drvc = di->context;

	for (l = devices; l; l = l->next) {
		struct sr_dev_inst *sdi = l->data;
		if (!sdi) {
			sr_err("Invalid driver instance, cannot complete scan.");
			return NULL;
		}
		sdi->driver = di;
	}

	drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));

	return devices;
}
Commit	Line	Data
063e7aef	1	/*
50985c20	2	* This file is part of the libsigrok project.
063e7aef UH	3	*
	4	* Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
	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 2 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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
2eb84c98	21	/** @file
04cb9157 MH	22	* Standard API helper functions.
	23	* @internal
	24	*/
	25
6ec6c43b	26	#include <config.h>
063e7aef	27	#include <glib.h>
c1aae900	28	#include <libsigrok/libsigrok.h>
063e7aef	29	#include "libsigrok-internal.h"
5a1afc09	30	#include "scpi.h"
063e7aef	31
3544f848 ML	32	#define LOG_PREFIX "std"
3544f848 ML	33
063e7aef UH	34	/**
	35	* Standard sr_driver_init() API helper.
	36	*
6078d2c9	37	* This function can be used to simplify most driver's init() API callback.
063e7aef UH	38	*
	39	* It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
	40	* then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
	41	*
063e7aef	42	* @param di The driver instance to use.
1f8f5bc0	43	* @param sr_ctx The libsigrok context to assign.
063e7aef	44	*
91219afc	45	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
063e7aef	46	*/
c45c32ce	47	SR_PRIV int std_init(struct sr_dev_driver di, struct sr_context sr_ctx)
063e7aef UH	48	{
	49	struct drv_context *drvc;
	50
91219afc	51	drvc = g_malloc0(sizeof(struct drv_context));
063e7aef	52	drvc->sr_ctx = sr_ctx;
c2523f22	53	drvc->instances = NULL;
41812aca	54	di->context = drvc;
063e7aef UH	55
	56	return SR_OK;
	57	}
4afdfd46	58
700d6b64 LPC	59	/**
	60	* Standard driver cleanup() callback API helper
	61	*
	62	* @param di The driver instance to use.
	63	*
	64	* Frees all device instances by calling sr_dev_clear() and then releases any
	65	* resources allocated by std_init().
	66	*
	67	* @retval SR_OK Success
	68	* @retval SR_ERR_ARG Invalid driver
	69	*
	70	*/
	71	SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
	72	{
	73	int ret;
	74
	75	ret = sr_dev_clear(di);
	76	g_free(di->context);
	77
	78	return ret;
	79	}
	80
4afdfd46 UH	81	/**
	82	* Standard API helper for sending an SR_DF_HEADER packet.
	83	*
	84	* This function can be used to simplify most driver's
6078d2c9	85	* dev_acquisition_start() API callback.
4afdfd46 UH	86	*
4afdfd46 UH	87	* @param sdi The device instance to use.
4afdfd46 UH	88	*
	89	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
	90	* SR_ERR upon other errors.
	91	*/
bee2b016	92	SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
4afdfd46	93	{
bee2b016	94	const char *prefix = sdi->driver->name;
4afdfd46 UH	95	int ret;
	96	struct sr_datafeed_packet packet;
	97	struct sr_datafeed_header header;
	98
ac2926b3	99	sr_dbg("%s: Starting acquisition.", prefix);
4afdfd46 UH	100
4afdfd46 UH	101	/* Send header packet to the session bus. */
ac2926b3	102	sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
4afdfd46 UH	103	packet.type = SR_DF_HEADER;
	104	packet.payload = (uint8_t *)&header;
	105	header.feed_version = 1;
	106	gettimeofday(&header.starttime, NULL);
	107
	108	if ((ret = sr_session_send(sdi, &packet)) < 0) {
ac2926b3	109	sr_err("%s: Failed to send header packet: %d.", prefix, ret);
4afdfd46 UH	110	return ret;
	111	}
	112
	113	return SR_OK;
	114	}
cd2f0fe2	115
3be42bc2 UH	116	/**
	117	* Standard API helper for sending an SR_DF_END packet.
	118	*
	119	* @param sdi The device instance to use. Must not be NULL.
3be42bc2 UH	120	*
	121	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
	122	* SR_ERR upon other errors.
	123	*/
bee2b016	124	SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
3be42bc2	125	{
bee2b016	126	const char *prefix = sdi->driver->name;
3be42bc2 UH	127	int ret;
	128	struct sr_datafeed_packet packet;
	129
bee2b016	130	if (!sdi)
3be42bc2 UH	131	return SR_ERR_ARG;
	132
	133	sr_dbg("%s: Sending SR_DF_END packet.", prefix);
	134
	135	packet.type = SR_DF_END;
	136	packet.payload = NULL;
	137
	138	if ((ret = sr_session_send(sdi, &packet)) < 0) {
	139	sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
	140	return ret;
	141	}
	142
	143	return SR_OK;
	144	}
	145
c4f2dfd0 UH	146	#ifdef HAVE_LIBSERIALPORT
c4f2dfd0 UH	147
813aab69	148	/**
23dc6661 BV	149	* Standard serial driver dev_open() helper.
	150	*
	151	* This function can be used to implement the dev_open() driver API
	152	* callback in drivers that use a serial port. The port is opened
6c592ece	153	* with the SERIAL_RDWR flag.
23dc6661 BV	154	*
	155	* If the open succeeded, the status field of the given sdi is set
	156	* to SR_ST_ACTIVE.
	157	*
	158	* @retval SR_OK Success.
	159	* @retval SR_ERR Serial port open failed.
	160	*/
	161	SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
	162	{
	163	struct sr_serial_dev_inst *serial;
	164
	165	serial = sdi->conn;
6c592ece	166	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
23dc6661 BV	167	return SR_ERR;
	168
	169	sdi->status = SR_ST_ACTIVE;
	170
	171	return SR_OK;
	172	}
	173
813aab69	174	/**
1e7134dc BV	175	* Standard serial driver dev_close() helper.
	176	*
	177	* This function can be used to implement the dev_close() driver API
	178	* callback in drivers that use a serial port.
	179	*
	180	* After closing the port, the status field of the given sdi is set
	181	* to SR_ST_INACTIVE.
	182	*
	183	* @retval SR_OK Success.
	184	*/
	185	SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
	186	{
	187	struct sr_serial_dev_inst *serial;
	188
	189	serial = sdi->conn;
	190	if (serial && sdi->status == SR_ST_ACTIVE) {
	191	serial_close(serial);
	192	sdi->status = SR_ST_INACTIVE;
	193	}
	194
	195	return SR_OK;
	196	}
	197
813aab69	198	/**
cd2f0fe2 UH	199	* Standard sr_session_stop() API helper.
	200	*
	201	* This function can be used to simplify most (serial port based) driver's
6078d2c9	202	* dev_acquisition_stop() API callback.
cd2f0fe2 UH	203	*
	204	* @param sdi The device instance for which acquisition should stop.
	205	* Must not be NULL.
	206	* @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
6078d2c9	207	* @param dev_close_fn Function pointer to the driver's dev_close().
cd2f0fe2 UH	208	* Must not be NULL.
	209	* @param serial The serial device instance (struct serial_dev_inst *).
	210	* Must not be NULL.
cd2f0fe2	211	*
1477a9a6 MH	212	* @retval SR_OK Success.
	213	* @retval SR_ERR_ARG Invalid arguments.
	214	* @retval SR_ERR_DEV_CLOSED Device is closed.
	215	* @retval SR_ERR Other errors.
cd2f0fe2	216	*/
d43b0908	217	SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
6525d819	218	dev_close_callback dev_close_fn,
bee2b016	219	struct sr_serial_dev_inst *serial)
cd2f0fe2	220	{
bee2b016	221	const char *prefix = sdi->driver->name;
cd2f0fe2	222	int ret;
cd2f0fe2	223
cd2f0fe2	224	if (sdi->status != SR_ST_ACTIVE) {
ac2926b3	225	sr_err("%s: Device inactive, can't stop acquisition.", prefix);
1477a9a6	226	return SR_ERR_DEV_CLOSED;
cd2f0fe2 UH	227	}
cd2f0fe2 UH	228
ac2926b3	229	sr_dbg("%s: Stopping acquisition.", prefix);
cd2f0fe2	230
102f1239	231	if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
ac2926b3	232	sr_err("%s: Failed to remove source: %d.", prefix, ret);
cd2f0fe2 UH	233	return ret;
	234	}
	235
6078d2c9	236	if ((ret = dev_close_fn(sdi)) < 0) {
ac2926b3	237	sr_err("%s: Failed to close device: %d.", prefix, ret);
cd2f0fe2 UH	238	return ret;
	239	}
	240
bee2b016	241	std_session_send_df_end(sdi);
cd2f0fe2 UH	242
	243	return SR_OK;
	244	}
49f00e13	245
c4f2dfd0 UH	246	#endif
c4f2dfd0 UH	247
813aab69	248	/**
49f00e13 BV	249	* Standard driver dev_clear() helper.
49f00e13 BV	250	*
813aab69 MH	251	* Clear driver, this means, close all instances.
813aab69 MH	252	*
49f00e13 BV	253	* This function can be used to implement the dev_clear() driver API
	254	* callback. dev_close() is called before every sr_dev_inst is cleared.
	255	*
	256	* The only limitation is driver-specific device contexts (sdi->priv).
	257	* These are freed, but any dynamic allocation within structs stored
	258	* there cannot be freed.
	259	*
	260	* @param driver The driver which will have its instances released.
12a33563 BV	261	* @param clear_private If not NULL, this points to a function called
	262	* with sdi->priv as argument. The function can then clear any device
	263	* instance-specific resources kept there. It must also clear the struct
	264	* pointed to by sdi->priv.
49f00e13 BV	265	*
	266	* @return SR_OK on success.
	267	*/
ae5859ff	268	SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
144f6660	269	std_dev_clear_callback clear_private)
49f00e13	270	{
49f00e13	271	struct drv_context *drvc;
12a33563	272	struct sr_dev_inst *sdi;
7aebe22d	273	GSList *l;
49f00e13 BV	274	int ret;
49f00e13 BV	275
41812aca	276	if (!(drvc = driver->context))
3a277f3b BV	277	/* Driver was never initialized, nothing to do. */
	278	return SR_OK;
	279
49f00e13 BV	280	ret = SR_OK;
49f00e13 BV	281	for (l = drvc->instances; l; l = l->next) {
49f00e13 BV	282	if (!(sdi = l->data)) {
	283	ret = SR_ERR_BUG;
	284	continue;
	285	}
49f00e13 BV	286	if (driver->dev_close)
	287	driver->dev_close(sdi);
	288
	289	if (sdi->conn) {
45357ce6	290	#ifdef HAVE_LIBSERIALPORT
c4f2dfd0	291	if (sdi->inst_type == SR_INST_SERIAL)
12a33563	292	sr_serial_dev_inst_free(sdi->conn);
c4f2dfd0	293	#endif
45357ce6	294	#ifdef HAVE_LIBUSB_1_0
c4f2dfd0	295	if (sdi->inst_type == SR_INST_USB)
49f00e13	296	sr_usb_dev_inst_free(sdi->conn);
a0c7e23a	297	#endif
23f43dff ML	298	if (sdi->inst_type == SR_INST_SCPI)
23f43dff ML	299	sr_scpi_free(sdi->conn);
daa39012 AJ	300	if (sdi->inst_type == SR_INST_MODBUS)
daa39012 AJ	301	sr_modbus_free(sdi->conn);
49f00e13	302	}
ae5859ff	303	if (clear_private)
886413b6 BV	304	/* The helper function is responsible for freeing
886413b6 BV	305	* its own sdi->priv! */
ae5859ff	306	clear_private(sdi->priv);
12a33563 BV	307	else
12a33563 BV	308	g_free(sdi->priv);
886413b6	309
49f00e13 BV	310	sr_dev_inst_free(sdi);
	311	}
	312
	313	g_slist_free(drvc->instances);
	314	drvc->instances = NULL;
	315
	316	return ret;
	317	}
c01bf34c LPC	318
	319	/**
	320	* Standard implementation for the driver dev_list() callback
	321	*
	322	* This function can be used as the dev_list callback by most drivers that use
	323	* the standard helper functions. It returns the devices contained in the driver
	324	* context instances list.
	325	*
	326	* @param di The driver instance to use.
	327	*
	328	* @return The list of devices/instances of this driver, or NULL upon errors
	329	* or if the list is empty.
	330	*/
	331	SR_PRIV GSList std_dev_list(const struct sr_dev_driver di)
	332	{
	333	struct drv_context *drvc = di->context;
	334
	335	return drvc->instances;
	336	}
15a5bfe4 LPC	337
	338	/**
	339	* Standard scan() callback API helper.
	340	*
	341	* This function can be used to perform common tasks required by a driver's
	342	* scan() callback. It will initialize the driver for each device on the list
	343	* and add the devices on the list to the driver's device instance list.
	344	* Usually it should be used as the last step in the scan() callback, right
	345	* before returning.
	346	*
	347	* Note: This function can only be used if std_init() has been called
	348	* previously by the driver.
	349	*
	350	* Example:
	351	* @code{c}
	352	* static GSList scan(struct sr_dev_driver di, GSList *options)
	353	* {
	354	* struct GSList *device;
	355	* struct sr_dev_inst *sdi;
	356	*
	357	* sdi = g_new0(sr_dev_inst, 1);
	358	* sdi->vendor = ...;
	359	* ...
	360	* devices = g_slist_append(devices, sdi);
	361	* ...
	362	* return std_scan_complete(di, devices);
	363	* }
	364	* @endcode
	365	*
39fcfdc9	366	* @param di The driver instance to use. Must not be NULL.
15a5bfe4 LPC	367	* @param devices List of newly discovered devices (struct sr_dev_inst).
	368	*
	369	* @return The @p devices list.
	370	*/
	371	SR_PRIV GSList std_scan_complete(struct sr_dev_driver di, GSList *devices)
	372	{
39fcfdc9	373	struct drv_context *drvc;
15a5bfe4 LPC	374	GSList *l;
15a5bfe4 LPC	375
39fcfdc9 UH	376	if (!di) {
	377	sr_err("Invalid driver instance (di), cannot complete scan.");
	378	return NULL;
	379	}
	380
	381	drvc = di->context;
	382
15a5bfe4 LPC	383	for (l = devices; l; l = l->next) {
15a5bfe4 LPC	384	struct sr_dev_inst *sdi = l->data;
39fcfdc9 UH	385	if (!sdi) {
	386	sr_err("Invalid driver instance, cannot complete scan.");
	387	return NULL;
	388	}
15a5bfe4 LPC	389	sdi->driver = di;
	390	}
	391
	392	drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
	393
	394	return devices;
	395	}