[libsigrok.git] / 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 <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"

/**
 * 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, or
 *         SR_ERR_MALLOC upon memory allocation errors.
 */
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("%sInvalid driver, cannot initialize.", prefix);
		return SR_ERR_ARG;
	}

	if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
		sr_err("%sDriver context malloc failed.", prefix);
		return SR_ERR_MALLOC;
	}

	drvc->sr_ctx = sr_ctx;
	drvc->instances = NULL;
	di->priv = drvc;

	return SR_OK;
}

/**
 * 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("%sStarting acquisition.", prefix);

	/* Send header packet to the session bus. */
	sr_dbg("%sSending 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("%sFailed to send header 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 and SERIAL_NONBLOCK flags.
 *
 * 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 | SERIAL_NONBLOCK) != 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 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,
			void *cb_data, dev_close_t dev_close_fn,
			struct sr_serial_dev_inst *serial, const char *prefix)
{
	int ret;
	struct sr_datafeed_packet packet;

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

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

	sr_dbg("%sStopping acquisition.", prefix);

	if ((ret = serial_source_remove(serial)) < 0) {
		sr_err("%sFailed to remove source: %d.", prefix, ret);
		return ret;
	}

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

	/* Send SR_DF_END packet to the session bus. */
	sr_dbg("%sSending SR_DF_END packet.", prefix);
	packet.type = SR_DF_END;
	packet.payload = NULL;
	if ((ret = sr_session_send(cb_data, &packet)) < 0) {
		sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
		return ret;
	}

	return SR_OK;
}

#endif

/*
 * Standard driver dev_clear() helper.
 *
 * 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_t clear_private)
{
	struct drv_context *drvc;
	struct sr_dev_inst *sdi;
	GSList *l;
	int ret;

	if (!(drvc = driver->priv))
		/* 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) {
#if HAVE_LIBSERIALPORT
			if (sdi->inst_type == SR_INST_SERIAL)
				sr_serial_dev_inst_free(sdi->conn);
#endif
#if 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 (clear_private)
			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
063e7aef UH	26	#include <glib.h>
	27	#include "libsigrok.h"
	28	#include "libsigrok-internal.h"
	29
	30	/**
	31	* Standard sr_driver_init() API helper.
	32	*
6078d2c9	33	* This function can be used to simplify most driver's init() API callback.
063e7aef UH	34	*
	35	* It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
	36	* then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
	37	*
	38	* @param sr_ctx The libsigrok context to assign.
	39	* @param di The driver instance to use.
04cb9157	40	* @param[in] prefix A driver-specific prefix string used for log messages.
063e7aef UH	41	*
	42	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
	43	* SR_ERR_MALLOC upon memory allocation errors.
	44	*/
f6beaac5 UH	45	SR_PRIV int std_init(struct sr_context sr_ctx, struct sr_dev_driver di,
f6beaac5 UH	46	const char *prefix)
063e7aef UH	47	{
	48	struct drv_context *drvc;
	49
	50	if (!di) {
	51	sr_err("%sInvalid driver, cannot initialize.", prefix);
	52	return SR_ERR_ARG;
	53	}
	54
c2523f22	55	if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
063e7aef UH	56	sr_err("%sDriver context malloc failed.", prefix);
	57	return SR_ERR_MALLOC;
	58	}
	59
	60	drvc->sr_ctx = sr_ctx;
c2523f22	61	drvc->instances = NULL;
063e7aef UH	62	di->priv = drvc;
	63
	64	return SR_OK;
	65	}
4afdfd46 UH	66
	67	/**
	68	* Standard API helper for sending an SR_DF_HEADER packet.
	69	*
	70	* This function can be used to simplify most driver's
6078d2c9	71	* dev_acquisition_start() API callback.
4afdfd46 UH	72	*
	73	* @param sdi The device instance to use.
	74	* @param prefix A driver-specific prefix string used for log messages.
	75	* Must not be NULL. An empty string is allowed.
	76	*
	77	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
	78	* SR_ERR upon other errors.
	79	*/
	80	SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
	81	const char *prefix)
	82	{
	83	int ret;
	84	struct sr_datafeed_packet packet;
	85	struct sr_datafeed_header header;
	86
	87	if (!prefix) {
	88	sr_err("Invalid prefix.");
	89	return SR_ERR_ARG;
	90	}
	91
	92	sr_dbg("%sStarting acquisition.", prefix);
	93
	94	/* Send header packet to the session bus. */
	95	sr_dbg("%sSending SR_DF_HEADER packet.", prefix);
	96	packet.type = SR_DF_HEADER;
	97	packet.payload = (uint8_t *)&header;
	98	header.feed_version = 1;
	99	gettimeofday(&header.starttime, NULL);
	100
	101	if ((ret = sr_session_send(sdi, &packet)) < 0) {
	102	sr_err("%sFailed to send header packet: %d.", prefix, ret);
	103	return ret;
	104	}
	105
	106	return SR_OK;
	107	}
cd2f0fe2	108
c4f2dfd0 UH	109	#ifdef HAVE_LIBSERIALPORT
c4f2dfd0 UH	110
23dc6661 BV	111	/*
	112	* Standard serial driver dev_open() helper.
	113	*
	114	* This function can be used to implement the dev_open() driver API
	115	* callback in drivers that use a serial port. The port is opened
	116	* with the SERIAL_RDWR and SERIAL_NONBLOCK flags.
	117	*
	118	* If the open succeeded, the status field of the given sdi is set
	119	* to SR_ST_ACTIVE.
	120	*
	121	* @retval SR_OK Success.
	122	* @retval SR_ERR Serial port open failed.
	123	*/
	124	SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
	125	{
	126	struct sr_serial_dev_inst *serial;
	127
	128	serial = sdi->conn;
	129	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	130	return SR_ERR;
	131
	132	sdi->status = SR_ST_ACTIVE;
	133
	134	return SR_OK;
	135	}
	136
1e7134dc BV	137	/*
	138	* Standard serial driver dev_close() helper.
	139	*
	140	* This function can be used to implement the dev_close() driver API
	141	* callback in drivers that use a serial port.
	142	*
	143	* After closing the port, the status field of the given sdi is set
	144	* to SR_ST_INACTIVE.
	145	*
	146	* @retval SR_OK Success.
	147	*/
	148	SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
	149	{
	150	struct sr_serial_dev_inst *serial;
	151
	152	serial = sdi->conn;
	153	if (serial && sdi->status == SR_ST_ACTIVE) {
	154	serial_close(serial);
	155	sdi->status = SR_ST_INACTIVE;
	156	}
	157
	158	return SR_OK;
	159	}
	160
cd2f0fe2 UH	161	/*
	162	* Standard sr_session_stop() API helper.
	163	*
	164	* This function can be used to simplify most (serial port based) driver's
6078d2c9	165	* dev_acquisition_stop() API callback.
cd2f0fe2 UH	166	*
	167	* @param sdi The device instance for which acquisition should stop.
	168	* Must not be NULL.
	169	* @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
6078d2c9	170	* @param dev_close_fn Function pointer to the driver's dev_close().
cd2f0fe2 UH	171	* Must not be NULL.
	172	* @param serial The serial device instance (struct serial_dev_inst *).
	173	* Must not be NULL.
	174	* @param prefix A driver-specific prefix string used for log messages.
	175	* Must not be NULL. An empty string is allowed.
	176	*
1477a9a6 MH	177	* @retval SR_OK Success.
	178	* @retval SR_ERR_ARG Invalid arguments.
	179	* @retval SR_ERR_DEV_CLOSED Device is closed.
	180	* @retval SR_ERR Other errors.
cd2f0fe2	181	*/
d43b0908	182	SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
6078d2c9	183	void *cb_data, dev_close_t dev_close_fn,
cd2f0fe2 UH	184	struct sr_serial_dev_inst serial, const char prefix)
	185	{
	186	int ret;
	187	struct sr_datafeed_packet packet;
	188
	189	if (!prefix) {
	190	sr_err("Invalid prefix.");
	191	return SR_ERR_ARG;
	192	}
	193
	194	if (sdi->status != SR_ST_ACTIVE) {
	195	sr_err("%sDevice inactive, can't stop acquisition.", prefix);
1477a9a6	196	return SR_ERR_DEV_CLOSED;
cd2f0fe2 UH	197	}
	198
	199	sr_dbg("%sStopping acquisition.", prefix);
	200
7faa3e88	201	if ((ret = serial_source_remove(serial)) < 0) {
cd2f0fe2 UH	202	sr_err("%sFailed to remove source: %d.", prefix, ret);
	203	return ret;
	204	}
	205
6078d2c9	206	if ((ret = dev_close_fn(sdi)) < 0) {
cd2f0fe2 UH	207	sr_err("%sFailed to close device: %d.", prefix, ret);
	208	return ret;
	209	}
	210
	211	/* Send SR_DF_END packet to the session bus. */
	212	sr_dbg("%sSending SR_DF_END packet.", prefix);
	213	packet.type = SR_DF_END;
	214	packet.payload = NULL;
	215	if ((ret = sr_session_send(cb_data, &packet)) < 0) {
	216	sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
	217	return ret;
	218	}
	219
	220	return SR_OK;
	221	}
49f00e13	222
c4f2dfd0 UH	223	#endif
c4f2dfd0 UH	224
49f00e13 BV	225	/*
	226	* Standard driver dev_clear() helper.
	227	*
	228	* This function can be used to implement the dev_clear() driver API
	229	* callback. dev_close() is called before every sr_dev_inst is cleared.
	230	*
	231	* The only limitation is driver-specific device contexts (sdi->priv).
	232	* These are freed, but any dynamic allocation within structs stored
	233	* there cannot be freed.
	234	*
	235	* @param driver The driver which will have its instances released.
12a33563 BV	236	* @param clear_private If not NULL, this points to a function called
	237	* with sdi->priv as argument. The function can then clear any device
	238	* instance-specific resources kept there. It must also clear the struct
	239	* pointed to by sdi->priv.
49f00e13 BV	240	*
	241	* @return SR_OK on success.
	242	*/
ae5859ff BV	243	SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
ae5859ff BV	244	std_dev_clear_t clear_private)
49f00e13	245	{
49f00e13	246	struct drv_context *drvc;
12a33563	247	struct sr_dev_inst *sdi;
49f00e13 BV	248	GSList *l;
	249	int ret;
	250
3a277f3b BV	251	if (!(drvc = driver->priv))
	252	/* Driver was never initialized, nothing to do. */
	253	return SR_OK;
	254
49f00e13 BV	255	ret = SR_OK;
49f00e13 BV	256	for (l = drvc->instances; l; l = l->next) {
49f00e13 BV	257	if (!(sdi = l->data)) {
	258	ret = SR_ERR_BUG;
	259	continue;
	260	}
49f00e13 BV	261	if (driver->dev_close)
	262	driver->dev_close(sdi);
	263
	264	if (sdi->conn) {
c4f2dfd0 UH	265	#if HAVE_LIBSERIALPORT
c4f2dfd0 UH	266	if (sdi->inst_type == SR_INST_SERIAL)
12a33563	267	sr_serial_dev_inst_free(sdi->conn);
c4f2dfd0	268	#endif
a0c7e23a	269	#if HAVE_LIBUSB_1_0
c4f2dfd0	270	if (sdi->inst_type == SR_INST_USB)
49f00e13	271	sr_usb_dev_inst_free(sdi->conn);
a0c7e23a	272	#endif
23f43dff ML	273	if (sdi->inst_type == SR_INST_SCPI)
23f43dff ML	274	sr_scpi_free(sdi->conn);
49f00e13	275	}
ae5859ff BV	276	if (clear_private)
ae5859ff BV	277	clear_private(sdi->priv);
12a33563 BV	278	else
12a33563 BV	279	g_free(sdi->priv);
49f00e13 BV	280	sr_dev_inst_free(sdi);
	281	}
	282
	283	g_slist_free(drvc->instances);
	284	drvc->instances = NULL;
	285
	286	return ret;
	287	}
043e899a	288