[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 sr_ctx The libsigrok context to assign.
 * @param di The driver instance to use.
 * @param[in] prefix A driver-specific prefix string used for log messages.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 */
SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
		     const char *prefix)
{
	struct drv_context *drvc;

	if (!di) {
		sr_err("%s: Invalid driver, cannot initialize.", prefix);
		return SR_ERR_ARG;
	}

	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.
 * @param prefix A driver-specific prefix string used for log messages.
 * 		 Must not be NULL. An empty string is allowed.
 *
 * @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)
{
	int ret;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;

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

	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.
 * @param prefix A driver-specific prefix string used for log messages.
 * 		 Must not be NULL. An empty string is allowed.
 *
 * @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)
{
	int ret;
	struct sr_datafeed_packet packet;

	if (!sdi || !prefix)
		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.
 * @param[in] prefix A driver-specific prefix string used for log messages.
 *               Must not be NULL. An empty string is allowed.
 *
 * @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)
{
	int ret;

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

	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, prefix);

	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;
}
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	*
	42	* @param sr_ctx The libsigrok context to assign.
	43	* @param di The driver instance to use.
04cb9157	44	* @param[in] prefix A driver-specific prefix string used for log messages.
063e7aef	45	*
91219afc	46	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
063e7aef	47	*/
f6beaac5 UH	48	SR_PRIV int std_init(struct sr_context sr_ctx, struct sr_dev_driver di,
f6beaac5 UH	49	const char *prefix)
063e7aef UH	50	{
	51	struct drv_context *drvc;
	52
	53	if (!di) {
ac2926b3	54	sr_err("%s: Invalid driver, cannot initialize.", prefix);
063e7aef UH	55	return SR_ERR_ARG;
	56	}
	57
91219afc	58	drvc = g_malloc0(sizeof(struct drv_context));
063e7aef	59	drvc->sr_ctx = sr_ctx;
c2523f22	60	drvc->instances = NULL;
41812aca	61	di->context = drvc;
063e7aef UH	62
	63	return SR_OK;
	64	}
4afdfd46	65
700d6b64 LPC	66	/**
	67	* Standard driver cleanup() callback API helper
	68	*
	69	* @param di The driver instance to use.
	70	*
	71	* Frees all device instances by calling sr_dev_clear() and then releases any
	72	* resources allocated by std_init().
	73	*
	74	* @retval SR_OK Success
	75	* @retval SR_ERR_ARG Invalid driver
	76	*
	77	*/
	78	SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
	79	{
	80	int ret;
	81
	82	ret = sr_dev_clear(di);
	83	g_free(di->context);
	84
	85	return ret;
	86	}
	87
4afdfd46 UH	88	/**
	89	* Standard API helper for sending an SR_DF_HEADER packet.
	90	*
	91	* This function can be used to simplify most driver's
6078d2c9	92	* dev_acquisition_start() API callback.
4afdfd46 UH	93	*
	94	* @param sdi The device instance to use.
	95	* @param prefix A driver-specific prefix string used for log messages.
	96	* Must not be NULL. An empty string is allowed.
	97	*
	98	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
	99	* SR_ERR upon other errors.
	100	*/
	101	SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
	102	const char *prefix)
	103	{
	104	int ret;
	105	struct sr_datafeed_packet packet;
	106	struct sr_datafeed_header header;
	107
	108	if (!prefix) {
	109	sr_err("Invalid prefix.");
	110	return SR_ERR_ARG;
	111	}
	112
ac2926b3	113	sr_dbg("%s: Starting acquisition.", prefix);
4afdfd46 UH	114
4afdfd46 UH	115	/* Send header packet to the session bus. */
ac2926b3	116	sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
4afdfd46 UH	117	packet.type = SR_DF_HEADER;
	118	packet.payload = (uint8_t *)&header;
	119	header.feed_version = 1;
	120	gettimeofday(&header.starttime, NULL);
	121
	122	if ((ret = sr_session_send(sdi, &packet)) < 0) {
ac2926b3	123	sr_err("%s: Failed to send header packet: %d.", prefix, ret);
4afdfd46 UH	124	return ret;
	125	}
	126
	127	return SR_OK;
	128	}
cd2f0fe2	129
3be42bc2 UH	130	/**
	131	* Standard API helper for sending an SR_DF_END packet.
	132	*
	133	* @param sdi The device instance to use. Must not be NULL.
	134	* @param prefix A driver-specific prefix string used for log messages.
	135	* Must not be NULL. An empty string is allowed.
	136	*
	137	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
	138	* SR_ERR upon other errors.
	139	*/
	140	SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi,
	141	const char *prefix)
	142	{
	143	int ret;
	144	struct sr_datafeed_packet packet;
	145
	146	if (!sdi \|\| !prefix)
	147	return SR_ERR_ARG;
	148
	149	sr_dbg("%s: Sending SR_DF_END packet.", prefix);
	150
	151	packet.type = SR_DF_END;
	152	packet.payload = NULL;
	153
	154	if ((ret = sr_session_send(sdi, &packet)) < 0) {
	155	sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
	156	return ret;
	157	}
	158
	159	return SR_OK;
	160	}
	161
c4f2dfd0 UH	162	#ifdef HAVE_LIBSERIALPORT
c4f2dfd0 UH	163
813aab69	164	/**
23dc6661 BV	165	* Standard serial driver dev_open() helper.
	166	*
	167	* This function can be used to implement the dev_open() driver API
	168	* callback in drivers that use a serial port. The port is opened
6c592ece	169	* with the SERIAL_RDWR flag.
23dc6661 BV	170	*
	171	* If the open succeeded, the status field of the given sdi is set
	172	* to SR_ST_ACTIVE.
	173	*
	174	* @retval SR_OK Success.
	175	* @retval SR_ERR Serial port open failed.
	176	*/
	177	SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
	178	{
	179	struct sr_serial_dev_inst *serial;
	180
	181	serial = sdi->conn;
6c592ece	182	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
23dc6661 BV	183	return SR_ERR;
	184
	185	sdi->status = SR_ST_ACTIVE;
	186
	187	return SR_OK;
	188	}
	189
813aab69	190	/**
1e7134dc BV	191	* Standard serial driver dev_close() helper.
	192	*
	193	* This function can be used to implement the dev_close() driver API
	194	* callback in drivers that use a serial port.
	195	*
	196	* After closing the port, the status field of the given sdi is set
	197	* to SR_ST_INACTIVE.
	198	*
	199	* @retval SR_OK Success.
	200	*/
	201	SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
	202	{
	203	struct sr_serial_dev_inst *serial;
	204
	205	serial = sdi->conn;
	206	if (serial && sdi->status == SR_ST_ACTIVE) {
	207	serial_close(serial);
	208	sdi->status = SR_ST_INACTIVE;
	209	}
	210
	211	return SR_OK;
	212	}
	213
813aab69	214	/**
cd2f0fe2 UH	215	* Standard sr_session_stop() API helper.
	216	*
	217	* This function can be used to simplify most (serial port based) driver's
6078d2c9	218	* dev_acquisition_stop() API callback.
cd2f0fe2 UH	219	*
	220	* @param sdi The device instance for which acquisition should stop.
	221	* Must not be NULL.
	222	* @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
6078d2c9	223	* @param dev_close_fn Function pointer to the driver's dev_close().
cd2f0fe2 UH	224	* Must not be NULL.
	225	* @param serial The serial device instance (struct serial_dev_inst *).
	226	* Must not be NULL.
813aab69	227	* @param[in] prefix A driver-specific prefix string used for log messages.
cd2f0fe2 UH	228	* Must not be NULL. An empty string is allowed.
cd2f0fe2 UH	229	*
1477a9a6 MH	230	* @retval SR_OK Success.
	231	* @retval SR_ERR_ARG Invalid arguments.
	232	* @retval SR_ERR_DEV_CLOSED Device is closed.
	233	* @retval SR_ERR Other errors.
cd2f0fe2	234	*/
d43b0908	235	SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
6525d819	236	dev_close_callback dev_close_fn,
cd2f0fe2 UH	237	struct sr_serial_dev_inst serial, const char prefix)
	238	{
	239	int ret;
cd2f0fe2 UH	240
	241	if (!prefix) {
	242	sr_err("Invalid prefix.");
	243	return SR_ERR_ARG;
	244	}
	245
	246	if (sdi->status != SR_ST_ACTIVE) {
ac2926b3	247	sr_err("%s: Device inactive, can't stop acquisition.", prefix);
1477a9a6	248	return SR_ERR_DEV_CLOSED;
cd2f0fe2 UH	249	}
cd2f0fe2 UH	250
ac2926b3	251	sr_dbg("%s: Stopping acquisition.", prefix);
cd2f0fe2	252
102f1239	253	if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
ac2926b3	254	sr_err("%s: Failed to remove source: %d.", prefix, ret);
cd2f0fe2 UH	255	return ret;
	256	}
	257
6078d2c9	258	if ((ret = dev_close_fn(sdi)) < 0) {
ac2926b3	259	sr_err("%s: Failed to close device: %d.", prefix, ret);
cd2f0fe2 UH	260	return ret;
	261	}
	262
6525d819	263	std_session_send_df_end(sdi, prefix);
cd2f0fe2 UH	264
	265	return SR_OK;
	266	}
49f00e13	267
c4f2dfd0 UH	268	#endif
c4f2dfd0 UH	269
813aab69	270	/**
49f00e13 BV	271	* Standard driver dev_clear() helper.
49f00e13 BV	272	*
813aab69 MH	273	* Clear driver, this means, close all instances.
813aab69 MH	274	*
49f00e13 BV	275	* This function can be used to implement the dev_clear() driver API
	276	* callback. dev_close() is called before every sr_dev_inst is cleared.
	277	*
	278	* The only limitation is driver-specific device contexts (sdi->priv).
	279	* These are freed, but any dynamic allocation within structs stored
	280	* there cannot be freed.
	281	*
	282	* @param driver The driver which will have its instances released.
12a33563 BV	283	* @param clear_private If not NULL, this points to a function called
	284	* with sdi->priv as argument. The function can then clear any device
	285	* instance-specific resources kept there. It must also clear the struct
	286	* pointed to by sdi->priv.
49f00e13 BV	287	*
	288	* @return SR_OK on success.
	289	*/
ae5859ff	290	SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
144f6660	291	std_dev_clear_callback clear_private)
49f00e13	292	{
49f00e13	293	struct drv_context *drvc;
12a33563	294	struct sr_dev_inst *sdi;
7aebe22d	295	GSList *l;
49f00e13 BV	296	int ret;
49f00e13 BV	297
41812aca	298	if (!(drvc = driver->context))
3a277f3b BV	299	/* Driver was never initialized, nothing to do. */
	300	return SR_OK;
	301
49f00e13 BV	302	ret = SR_OK;
49f00e13 BV	303	for (l = drvc->instances; l; l = l->next) {
49f00e13 BV	304	if (!(sdi = l->data)) {
	305	ret = SR_ERR_BUG;
	306	continue;
	307	}
49f00e13 BV	308	if (driver->dev_close)
	309	driver->dev_close(sdi);
	310
	311	if (sdi->conn) {
45357ce6	312	#ifdef HAVE_LIBSERIALPORT
c4f2dfd0	313	if (sdi->inst_type == SR_INST_SERIAL)
12a33563	314	sr_serial_dev_inst_free(sdi->conn);
c4f2dfd0	315	#endif
45357ce6	316	#ifdef HAVE_LIBUSB_1_0
c4f2dfd0	317	if (sdi->inst_type == SR_INST_USB)
49f00e13	318	sr_usb_dev_inst_free(sdi->conn);
a0c7e23a	319	#endif
23f43dff ML	320	if (sdi->inst_type == SR_INST_SCPI)
23f43dff ML	321	sr_scpi_free(sdi->conn);
daa39012 AJ	322	if (sdi->inst_type == SR_INST_MODBUS)
daa39012 AJ	323	sr_modbus_free(sdi->conn);
49f00e13	324	}
ae5859ff	325	if (clear_private)
886413b6 BV	326	/* The helper function is responsible for freeing
886413b6 BV	327	* its own sdi->priv! */
ae5859ff	328	clear_private(sdi->priv);
12a33563 BV	329	else
12a33563 BV	330	g_free(sdi->priv);
886413b6	331
49f00e13 BV	332	sr_dev_inst_free(sdi);
	333	}
	334
	335	g_slist_free(drvc->instances);
	336	drvc->instances = NULL;
	337
	338	return ret;
	339	}