blob: f32326694e8fe9b8fba82e7d963f27adad28a004 [file] [log] [blame]
Uwe Hermanna1bb33a2010-04-02 20:18:27 +02001/*
Uwe Hermann50985c22013-04-23 22:24:30 +02002 * This file is part of the libsigrok project.
Uwe Hermanna1bb33a2010-04-02 20:18:27 +02003 *
Bert Vermeulenc73d2ea2012-02-13 14:31:51 +01004 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
Uwe Hermanna1bb33a2010-04-02 20:18:27 +02005 *
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 <stdlib.h>
22#include <unistd.h>
23#include <string.h>
Bert Vermeulen544a4582011-01-30 02:40:55 +010024#include <glib.h>
Bert Vermeulen45c59c82012-07-05 00:55:07 +020025#include "libsigrok.h"
26#include "libsigrok-internal.h"
Bert Vermeulenaa4b1102011-01-24 07:46:16 +010027
Uwe Hermann2ad1deb2014-04-25 18:40:59 +020028/** @cond PRIVATE */
Martin Ling3544f842013-12-23 03:38:35 +000029#define LOG_PREFIX "session"
Uwe Hermann2ad1deb2014-04-25 18:40:59 +020030/** @endcond */
Uwe Hermanna421dc12013-01-29 12:55:00 +010031
Uwe Hermann7b870c32012-10-21 16:13:36 +020032/**
Uwe Hermann393fb9c2012-10-22 00:30:12 +020033 * @file
34 *
35 * Creating, using, or destroying libsigrok sessions.
36 */
37
38/**
Uwe Hermann7b870c32012-10-21 16:13:36 +020039 * @defgroup grp_session Session handling
40 *
41 * Creating, using, or destroying libsigrok sessions.
42 *
43 * @{
44 */
45
Bert Vermeulen544a4582011-01-30 02:40:55 +010046struct source {
Bert Vermeulen544a4582011-01-30 02:40:55 +010047 int timeout;
Uwe Hermann144f6662014-05-03 22:14:01 +020048 sr_receive_data_callback cb;
Uwe Hermann1f9813e2012-02-29 22:32:34 +010049 void *cb_data;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +020050
51 /* This is used to keep track of the object (fd, pollfd or channel) which is
52 * being polled and will be used to match the source when removing it again.
53 */
54 gintptr poll_object;
Bert Vermeulen544a4582011-01-30 02:40:55 +010055};
56
Martin Ling27264742013-04-15 21:08:55 +010057struct datafeed_callback {
Uwe Hermann144f6662014-05-03 22:14:01 +020058 sr_datafeed_callback cb;
Martin Ling27264742013-04-15 21:08:55 +010059 void *cb_data;
60};
61
Uwe Hermann9f45fb32012-01-02 14:15:25 +010062/**
63 * Create a new session.
Uwe Hermann7efe8892014-08-10 17:27:43 +020064 *
65 * @param new_session This will contain a pointer to the newly created
66 * session if the return value is SR_OK, otherwise the value
67 * is undefined and should not be used. Must not be NULL.
Uwe Hermann9f45fb32012-01-02 14:15:25 +010068 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +010069 * @retval SR_OK Success.
Uwe Hermann41de54f2014-08-11 13:15:43 +020070 * @retval SR_ERR_ARG Invalid argument.
Uwe Hermann47117242014-05-04 20:51:05 +020071 *
Martin Ling0812c402014-05-04 23:07:00 +010072 * @since 0.4.0
Uwe Hermann9f45fb32012-01-02 14:15:25 +010073 */
Bert Vermeulen3337e9a2014-07-21 15:08:17 +020074SR_API int sr_session_new(struct sr_session **new_session)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020075{
Bert Vermeulen3337e9a2014-07-21 15:08:17 +020076 struct sr_session *session;
Uwe Hermann9f45fb32012-01-02 14:15:25 +010077
Uwe Hermann41de54f2014-08-11 13:15:43 +020078 if (!new_session)
79 return SR_ERR_ARG;
80
Bert Vermeulen3337e9a2014-07-21 15:08:17 +020081 session = g_malloc0(sizeof(struct sr_session));
Alexandru Gagniuc33c6e4c2013-02-02 00:50:00 -060082
Bert Vermeulen3337e9a2014-07-21 15:08:17 +020083 session->source_timeout = -1;
84 session->running = FALSE;
85 session->abort_session = FALSE;
86 g_mutex_init(&session->stop_mutex);
Martin Ling0812c402014-05-04 23:07:00 +010087
Bert Vermeulen3337e9a2014-07-21 15:08:17 +020088 *new_session = session;
Uwe Hermanne0508e62012-01-07 17:08:54 +010089
90 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020091}
92
Uwe Hermann961009b2013-02-01 22:58:54 +010093/**
Martin Ling0812c402014-05-04 23:07:00 +010094 * Destroy a session.
95 * This frees up all memory used by the session.
96 *
Uwe Hermann7efe8892014-08-10 17:27:43 +020097 * @param session The session to destroy. Must not be NULL.
98 *
Martin Ling0812c402014-05-04 23:07:00 +010099 * @retval SR_OK Success.
100 * @retval SR_ERR_ARG Invalid session passed.
101 *
102 * @since 0.4.0
103 */
104SR_API int sr_session_destroy(struct sr_session *session)
105{
106 if (!session) {
107 sr_err("%s: session was NULL", __func__);
108 return SR_ERR_ARG;
109 }
110
111 sr_session_dev_remove_all(session);
112 g_mutex_clear(&session->stop_mutex);
113 if (session->trigger)
114 sr_trigger_free(session->trigger);
115
Martin Ling1de3cce2014-10-12 15:56:36 +0100116 g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
117
Martin Ling0812c402014-05-04 23:07:00 +0100118 g_free(session);
119
Martin Ling0812c402014-05-04 23:07:00 +0100120 return SR_OK;
121}
122
123/**
124 * Remove all the devices from a session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100125 *
126 * The session itself (i.e., the struct sr_session) is not free'd and still
127 * exists after this function returns.
128 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200129 * @param session The session to use. Must not be NULL.
130 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100131 * @retval SR_OK Success.
Martin Ling0812c402014-05-04 23:07:00 +0100132 * @retval SR_ERR_BUG Invalid session passed.
Uwe Hermann47117242014-05-04 20:51:05 +0200133 *
Martin Ling0812c402014-05-04 23:07:00 +0100134 * @since 0.4.0
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100135 */
Martin Ling0812c402014-05-04 23:07:00 +0100136SR_API int sr_session_dev_remove_all(struct sr_session *session)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200137{
Martin Ling0812c402014-05-04 23:07:00 +0100138 struct sr_dev_inst *sdi;
139 GSList *l;
140
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100141 if (!session) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100142 sr_err("%s: session was NULL", __func__);
Martin Ling0812c402014-05-04 23:07:00 +0100143 return SR_ERR_ARG;
144 }
145
146 for (l = session->devs; l; l = l->next) {
147 sdi = (struct sr_dev_inst *) l->data;
148 sdi->session = NULL;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100149 }
150
Bert Vermeulen681803d2013-04-28 22:35:42 +0200151 g_slist_free(session->devs);
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100152 session->devs = NULL;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100153
154 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200155}
156
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100157/**
Martin Ling0812c402014-05-04 23:07:00 +0100158 * Add a device instance to a session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100159 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200160 * @param session The session to add to. Must not be NULL.
Martin Ling0812c402014-05-04 23:07:00 +0100161 * @param sdi The device instance to add to a session. Must not
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200162 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
163 * not be NULL.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100164 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100165 * @retval SR_OK Success.
166 * @retval SR_ERR_ARG Invalid argument.
Uwe Hermann47117242014-05-04 20:51:05 +0200167 *
Martin Ling0812c402014-05-04 23:07:00 +0100168 * @since 0.4.0
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100169 */
Martin Ling0812c402014-05-04 23:07:00 +0100170SR_API int sr_session_dev_add(struct sr_session *session,
171 struct sr_dev_inst *sdi)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200172{
Bert Vermeulen54518162013-09-21 17:44:49 +0200173 int ret;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200174
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200175 if (!sdi) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100176 sr_err("%s: sdi was NULL", __func__);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100177 return SR_ERR_ARG;
178 }
179
Uwe Hermannd6eb0c32012-03-18 12:57:34 +0100180 if (!session) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100181 sr_err("%s: session was NULL", __func__);
Martin Ling0812c402014-05-04 23:07:00 +0100182 return SR_ERR_ARG;
183 }
184
185 /* If sdi->session is not NULL, the device is already in this or
186 * another session. */
187 if (sdi->session) {
188 sr_err("%s: already assigned to session", __func__);
189 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100190 }
191
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200192 /* If sdi->driver is NULL, this is a virtual device. */
193 if (!sdi->driver) {
Uwe Hermannd6eb0c32012-03-18 12:57:34 +0100194 /* Just add the device, don't run dev_open(). */
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200195 session->devs = g_slist_append(session->devs, (gpointer)sdi);
Martin Ling0812c402014-05-04 23:07:00 +0100196 sdi->session = session;
Uwe Hermannd6eb0c32012-03-18 12:57:34 +0100197 return SR_OK;
198 }
199
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200200 /* sdi->driver is non-NULL (i.e. we have a real device). */
201 if (!sdi->driver->dev_open) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100202 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
Uwe Hermann8ec95d22012-03-21 19:28:43 +0100203 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100204 }
205
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200206 session->devs = g_slist_append(session->devs, (gpointer)sdi);
Martin Ling0812c402014-05-04 23:07:00 +0100207 sdi->session = session;
Bert Vermeulenaa4b1102011-01-24 07:46:16 +0100208
Bert Vermeulen54518162013-09-21 17:44:49 +0200209 if (session->running) {
Daniel Elstner32b7cd42014-01-20 23:04:49 +0100210 /* Adding a device to a running session. Commit settings
211 * and start acquisition on that device now. */
212 if ((ret = sr_config_commit(sdi)) != SR_OK) {
213 sr_err("Failed to commit device settings before "
214 "starting acquisition in running session (%s)",
215 sr_strerror(ret));
216 return ret;
217 }
Bert Vermeulen54518162013-09-21 17:44:49 +0200218 if ((ret = sdi->driver->dev_acquisition_start(sdi,
Daniel Elstner32b7cd42014-01-20 23:04:49 +0100219 (void *)sdi)) != SR_OK) {
Bert Vermeulen54518162013-09-21 17:44:49 +0200220 sr_err("Failed to start acquisition of device in "
Daniel Elstner32b7cd42014-01-20 23:04:49 +0100221 "running session (%s)", sr_strerror(ret));
222 return ret;
223 }
Bert Vermeulen54518162013-09-21 17:44:49 +0200224 }
225
Uwe Hermanne46b8fb2011-01-29 16:23:12 +0100226 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200227}
228
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100229/**
Martin Ling0812c402014-05-04 23:07:00 +0100230 * List all device instances attached to a session.
Bert Vermeulen2bb311b2013-09-02 14:24:32 +0200231 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200232 * @param session The session to use. Must not be NULL.
Bert Vermeulen2bb311b2013-09-02 14:24:32 +0200233 * @param devlist A pointer where the device instance list will be
234 * stored on return. If no devices are in the session,
235 * this will be NULL. Each element in the list points
236 * to a struct sr_dev_inst *.
237 * The list must be freed by the caller, but not the
238 * elements pointed to.
239 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100240 * @retval SR_OK Success.
Martin Ling0812c402014-05-04 23:07:00 +0100241 * @retval SR_ERR_ARG Invalid argument.
Uwe Hermann47117242014-05-04 20:51:05 +0200242 *
Martin Ling0812c402014-05-04 23:07:00 +0100243 * @since 0.4.0
Bert Vermeulen2bb311b2013-09-02 14:24:32 +0200244 */
Martin Ling0812c402014-05-04 23:07:00 +0100245SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
Bert Vermeulen2bb311b2013-09-02 14:24:32 +0200246{
Bert Vermeulen2bb311b2013-09-02 14:24:32 +0200247 if (!session)
Martin Ling0812c402014-05-04 23:07:00 +0100248 return SR_ERR_ARG;
249
250 if (!devlist)
251 return SR_ERR_ARG;
Bert Vermeulen2bb311b2013-09-02 14:24:32 +0200252
253 *devlist = g_slist_copy(session->devs);
254
255 return SR_OK;
256}
257
258/**
Martin Ling0812c402014-05-04 23:07:00 +0100259 * Remove all datafeed callbacks in a session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100260 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200261 * @param session The session to use. Must not be NULL.
262 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100263 * @retval SR_OK Success.
Martin Ling0812c402014-05-04 23:07:00 +0100264 * @retval SR_ERR_ARG Invalid session passed.
Uwe Hermann47117242014-05-04 20:51:05 +0200265 *
Martin Ling0812c402014-05-04 23:07:00 +0100266 * @since 0.4.0
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100267 */
Martin Ling0812c402014-05-04 23:07:00 +0100268SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200269{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100270 if (!session) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100271 sr_err("%s: session was NULL", __func__);
Martin Ling0812c402014-05-04 23:07:00 +0100272 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100273 }
274
Martin Ling27264742013-04-15 21:08:55 +0100275 g_slist_free_full(session->datafeed_callbacks, g_free);
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200276 session->datafeed_callbacks = NULL;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100277
278 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200279}
280
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100281/**
Martin Ling0812c402014-05-04 23:07:00 +0100282 * Add a datafeed callback to a session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100283 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200284 * @param session The session to use. Must not be NULL.
Uwe Hermannd08490a2012-02-29 21:56:24 +0100285 * @param cb Function to call when a chunk of data is received.
Uwe Hermann0abee502012-03-04 15:08:11 +0100286 * Must not be NULL.
Uwe Hermann85222792013-04-16 12:48:58 +0200287 * @param cb_data Opaque pointer passed in by the caller.
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100288 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100289 * @retval SR_OK Success.
290 * @retval SR_ERR_BUG No session exists.
Uwe Hermann47117242014-05-04 20:51:05 +0200291 *
292 * @since 0.3.0
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100293 */
Martin Ling0812c402014-05-04 23:07:00 +0100294SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
295 sr_datafeed_callback cb, void *cb_data)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200296{
Martin Ling27264742013-04-15 21:08:55 +0100297 struct datafeed_callback *cb_struct;
298
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100299 if (!session) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100300 sr_err("%s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100301 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100302 }
303
Uwe Hermann0abee502012-03-04 15:08:11 +0100304 if (!cb) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100305 sr_err("%s: cb was NULL", __func__);
Uwe Hermann0abee502012-03-04 15:08:11 +0100306 return SR_ERR_ARG;
307 }
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100308
Martin Ling27264742013-04-15 21:08:55 +0100309 if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback))))
310 return SR_ERR_MALLOC;
311
312 cb_struct->cb = cb;
313 cb_struct->cb_data = cb_data;
314
Uwe Hermann62c82022010-04-15 20:16:53 +0200315 session->datafeed_callbacks =
Martin Ling27264742013-04-15 21:08:55 +0100316 g_slist_append(session->datafeed_callbacks, cb_struct);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100317
318 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200319}
320
Martin Ling0812c402014-05-04 23:07:00 +0100321SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
Bert Vermeulen7b5e6d22014-05-23 01:21:58 +0200322{
323 return session->trigger;
324}
325
Martin Ling0812c402014-05-04 23:07:00 +0100326SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
Bert Vermeulen7b5e6d22014-05-23 01:21:58 +0200327{
328 session->trigger = trig;
329
330 return SR_OK;
331}
332
Bert Vermeulenb483be72013-07-15 14:14:28 +0200333/**
Martin Ling0812c402014-05-04 23:07:00 +0100334 * Call every device in the current session's callback.
Bert Vermeulenb483be72013-07-15 14:14:28 +0200335 *
336 * For sessions not driven by select loops such as sr_session_run(),
337 * but driven by another scheduler, this can be used to poll the devices
338 * from within that scheduler.
339 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200340 * @param session The session to use. Must not be NULL.
Bert Vermeulenf6eb2cb2013-07-18 15:06:06 +0200341 * @param block If TRUE, this call will wait for any of the session's
342 * sources to fire an event on the file descriptors, or
343 * any of their timeouts to activate. In other words, this
344 * can be used as a select loop.
345 * If FALSE, all sources have their callback run, regardless
346 * of file descriptor or timeout status.
347 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100348 * @retval SR_OK Success.
349 * @retval SR_ERR Error occured.
Bert Vermeulenb483be72013-07-15 14:14:28 +0200350 */
Bert Vermeulen3337e9a2014-07-21 15:08:17 +0200351static int sr_session_iteration(struct sr_session *session, gboolean block)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100352{
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200353 unsigned int i;
354 int ret;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100355
Bert Vermeulenb483be72013-07-15 14:14:28 +0200356 ret = g_poll(session->pollfds, session->num_sources,
357 block ? session->source_timeout : 0);
358 for (i = 0; i < session->num_sources; i++) {
359 if (session->pollfds[i].revents > 0 || (ret == 0
360 && session->source_timeout == session->sources[i].timeout)) {
Alexandru Gagniuc33c6e4c2013-02-02 00:50:00 -0600361 /*
Bert Vermeulenb483be72013-07-15 14:14:28 +0200362 * Invoke the source's callback on an event,
363 * or if the poll timed out and this source
364 * asked for that timeout.
Alexandru Gagniuc33c6e4c2013-02-02 00:50:00 -0600365 */
Bert Vermeulenb483be72013-07-15 14:14:28 +0200366 if (!session->sources[i].cb(session->pollfds[i].fd,
367 session->pollfds[i].revents,
368 session->sources[i].cb_data))
Martin Ling0812c402014-05-04 23:07:00 +0100369 sr_session_source_remove(session,
370 session->sources[i].poll_object);
Bert Vermeulen544a4582011-01-30 02:40:55 +0100371 }
Bert Vermeulenb483be72013-07-15 14:14:28 +0200372 /*
373 * We want to take as little time as possible to stop
374 * the session if we have been told to do so. Therefore,
375 * we check the flag after processing every source, not
376 * just once per main event loop.
377 */
378 g_mutex_lock(&session->stop_mutex);
379 if (session->abort_session) {
Martin Ling0812c402014-05-04 23:07:00 +0100380 sr_session_stop_sync(session);
Bert Vermeulenb483be72013-07-15 14:14:28 +0200381 /* But once is enough. */
382 session->abort_session = FALSE;
383 }
384 g_mutex_unlock(&session->stop_mutex);
Bert Vermeulen544a4582011-01-30 02:40:55 +0100385 }
Uwe Hermanne0508e62012-01-07 17:08:54 +0100386
387 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100388}
389
Bert Vermeulen7b5e6d22014-05-23 01:21:58 +0200390
391static int verify_trigger(struct sr_trigger *trigger)
392{
393 struct sr_trigger_stage *stage;
394 struct sr_trigger_match *match;
395 GSList *l, *m;
396
397 if (!trigger->stages) {
398 sr_err("No trigger stages defined.");
399 return SR_ERR;
400 }
401
402 sr_spew("Checking trigger:");
403 for (l = trigger->stages; l; l = l->next) {
404 stage = l->data;
405 if (!stage->matches) {
406 sr_err("Stage %d has no matches defined.", stage->stage);
407 return SR_ERR;
408 }
409 for (m = stage->matches; m; m = m->next) {
410 match = m->data;
411 if (!match->channel) {
412 sr_err("Stage %d match has no channel.", stage->stage);
413 return SR_ERR;
414 }
415 if (!match->match) {
416 sr_err("Stage %d match is not defined.", stage->stage);
417 return SR_ERR;
418 }
419 sr_spew("Stage %d match on channel %s, match %d", stage->stage,
420 match->channel->name, match->match);
421 }
422 }
423
424 return SR_OK;
425}
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100426/**
427 * Start a session.
428 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200429 * @param session The session to use. Must not be NULL.
430 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100431 * @retval SR_OK Success.
Martin Ling0812c402014-05-04 23:07:00 +0100432 * @retval SR_ERR_ARG Invalid session passed.
Uwe Hermann47117242014-05-04 20:51:05 +0200433 *
Martin Ling0812c402014-05-04 23:07:00 +0100434 * @since 0.4.0
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100435 */
Martin Ling0812c402014-05-04 23:07:00 +0100436SR_API int sr_session_start(struct sr_session *session)
Bert Vermeulen7d658872011-01-31 22:34:14 +0100437{
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200438 struct sr_dev_inst *sdi;
Bert Vermeulen013ec842014-09-10 18:21:51 +0200439 struct sr_channel *ch;
440 GSList *l, *c;
441 int enabled_channels, ret;
Bert Vermeulen7d658872011-01-31 22:34:14 +0100442
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100443 if (!session) {
Martin Ling0812c402014-05-04 23:07:00 +0100444 sr_err("%s: session was NULL", __func__);
445 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100446 }
447
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100448 if (!session->devs) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100449 sr_err("%s: session->devs was NULL; a session "
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100450 "cannot be started without devices.", __func__);
Martin Ling0812c402014-05-04 23:07:00 +0100451 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100452 }
453
Bert Vermeulen7b5e6d22014-05-23 01:21:58 +0200454 if (session->trigger && verify_trigger(session->trigger) != SR_OK)
455 return SR_ERR;
456
Uwe Hermannc7142602013-02-07 09:16:28 +0100457 sr_info("Starting.");
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100458
Uwe Hermannb7c3e842012-12-31 21:05:11 +0100459 ret = SR_OK;
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100460 for (l = session->devs; l; l = l->next) {
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200461 sdi = l->data;
Bert Vermeulen013ec842014-09-10 18:21:51 +0200462 enabled_channels = 0;
463 for (c = sdi->channels; c; c = c->next) {
464 ch = c->data;
465 if (ch->enabled) {
466 enabled_channels++;
467 break;
468 }
469 }
470 if (enabled_channels == 0) {
471 ret = SR_ERR;
Soeren Apel1b9e5672014-09-27 22:20:51 +0200472 sr_err("%s using connection %s has no enabled channels!",
473 sdi->driver->name, sdi->connection_id);
Bert Vermeulen013ec842014-09-10 18:21:51 +0200474 break;
475 }
476
Daniel Elstner32b7cd42014-01-20 23:04:49 +0100477 if ((ret = sr_config_commit(sdi)) != SR_OK) {
478 sr_err("Failed to commit device settings before "
479 "starting acquisition (%s)", sr_strerror(ret));
480 break;
481 }
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200482 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100483 sr_err("%s: could not start an acquisition "
Bert Vermeulen568dcac2013-10-16 10:40:38 +0200484 "(%s)", __func__, sr_strerror(ret));
Bert Vermeulen7d658872011-01-31 22:34:14 +0100485 break;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100486 }
Bert Vermeulen7d658872011-01-31 22:34:14 +0100487 }
488
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100489 /* TODO: What if there are multiple devices? Which return code? */
490
Bert Vermeulen7d658872011-01-31 22:34:14 +0100491 return ret;
492}
493
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100494/**
Martin Ling0812c402014-05-04 23:07:00 +0100495 * Run a session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100496 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200497 * @param session The session to use. Must not be NULL.
498 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100499 * @retval SR_OK Success.
Martin Ling0812c402014-05-04 23:07:00 +0100500 * @retval SR_ERR_ARG Invalid session passed.
Uwe Hermann47117242014-05-04 20:51:05 +0200501 *
Martin Ling0812c402014-05-04 23:07:00 +0100502 * @since 0.4.0
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100503 */
Martin Ling0812c402014-05-04 23:07:00 +0100504SR_API int sr_session_run(struct sr_session *session)
Bert Vermeulen7d658872011-01-31 22:34:14 +0100505{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100506 if (!session) {
Martin Ling0812c402014-05-04 23:07:00 +0100507 sr_err("%s: session was NULL", __func__);
508 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100509 }
510
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100511 if (!session->devs) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100512 /* TODO: Actually the case? */
Uwe Hermanna421dc12013-01-29 12:55:00 +0100513 sr_err("%s: session->devs was NULL; a session "
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100514 "cannot be run without devices.", __func__);
Martin Ling0812c402014-05-04 23:07:00 +0100515 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100516 }
Bert Vermeulen54518162013-09-21 17:44:49 +0200517 session->running = TRUE;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100518
Uwe Hermanna421dc12013-01-29 12:55:00 +0100519 sr_info("Running.");
Bert Vermeulen7d658872011-01-31 22:34:14 +0100520
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100521 /* Do we have real sources? */
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200522 if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100523 /* Dummy source, freewheel over it. */
Bert Vermeulen2cbeb2b2012-08-03 01:04:05 +0200524 while (session->num_sources)
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200525 session->sources[0].cb(-1, 0, session->sources[0].cb_data);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100526 } else {
527 /* Real sources, use g_poll() main loop. */
Bert Vermeulenb483be72013-07-15 14:14:28 +0200528 while (session->num_sources)
Bert Vermeulen3337e9a2014-07-21 15:08:17 +0200529 sr_session_iteration(session, TRUE);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100530 }
531
Uwe Hermanne0508e62012-01-07 17:08:54 +0100532 return SR_OK;
Bert Vermeulen7d658872011-01-31 22:34:14 +0100533}
534
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100535/**
Martin Ling0812c402014-05-04 23:07:00 +0100536 * Stop a session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100537 *
Martin Ling0812c402014-05-04 23:07:00 +0100538 * The session is stopped immediately, with all acquisition sessions stopped
539 * and hardware drivers cleaned up.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100540 *
Alexandru Gagniuc33c6e4c2013-02-02 00:50:00 -0600541 * This must be called from within the session thread, to prevent freeing
542 * resources that the session thread will try to use.
543 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200544 * @param session The session to use. Must not be NULL.
545 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100546 * @retval SR_OK Success.
Martin Ling0812c402014-05-04 23:07:00 +0100547 * @retval SR_ERR_ARG Invalid session passed.
Bert Vermeulen72a08bc2013-09-25 11:51:38 +0200548 *
549 * @private
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100550 */
Martin Ling0812c402014-05-04 23:07:00 +0100551SR_PRIV int sr_session_stop_sync(struct sr_session *session)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200552{
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200553 struct sr_dev_inst *sdi;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200554 GSList *l;
555
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100556 if (!session) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100557 sr_err("%s: session was NULL", __func__);
Martin Ling0812c402014-05-04 23:07:00 +0100558 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100559 }
560
Uwe Hermanna421dc12013-01-29 12:55:00 +0100561 sr_info("Stopping.");
Uwe Hermanne0508e62012-01-07 17:08:54 +0100562
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100563 for (l = session->devs; l; l = l->next) {
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200564 sdi = l->data;
565 if (sdi->driver) {
566 if (sdi->driver->dev_acquisition_stop)
567 sdi->driver->dev_acquisition_stop(sdi, sdi);
Bert Vermeulen8c76be52012-01-08 22:05:00 +0100568 }
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200569 }
Bert Vermeulen54518162013-09-21 17:44:49 +0200570 session->running = FALSE;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100571
Uwe Hermanne0508e62012-01-07 17:08:54 +0100572 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200573}
574
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100575/**
Martin Ling0812c402014-05-04 23:07:00 +0100576 * Stop a session.
Alexandru Gagniuc33c6e4c2013-02-02 00:50:00 -0600577 *
Martin Ling0812c402014-05-04 23:07:00 +0100578 * The session is stopped immediately, with all acquisition sessions being
579 * stopped and hardware drivers cleaned up.
Alexandru Gagniuc33c6e4c2013-02-02 00:50:00 -0600580 *
581 * If the session is run in a separate thread, this function will not block
582 * until the session is finished executing. It is the caller's responsibility
583 * to wait for the session thread to return before assuming that the session is
584 * completely decommissioned.
585 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200586 * @param session The session to use. Must not be NULL.
587 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100588 * @retval SR_OK Success.
Martin Ling0812c402014-05-04 23:07:00 +0100589 * @retval SR_ERR_ARG Invalid session passed.
Uwe Hermann47117242014-05-04 20:51:05 +0200590 *
Martin Ling0812c402014-05-04 23:07:00 +0100591 * @since 0.4.0
Alexandru Gagniuc33c6e4c2013-02-02 00:50:00 -0600592 */
Martin Ling0812c402014-05-04 23:07:00 +0100593SR_API int sr_session_stop(struct sr_session *session)
Alexandru Gagniuc33c6e4c2013-02-02 00:50:00 -0600594{
595 if (!session) {
596 sr_err("%s: session was NULL", __func__);
597 return SR_ERR_BUG;
598 }
599
600 g_mutex_lock(&session->stop_mutex);
601 session->abort_session = TRUE;
602 g_mutex_unlock(&session->stop_mutex);
603
604 return SR_OK;
605}
606
607/**
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100608 * Debug helper.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100609 *
Bert Vermeulen996b0c72012-02-13 02:13:51 +0100610 * @param packet The packet to show debugging information for.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100611 */
Joel Holdsworthbf534572012-12-13 21:07:53 +0000612static void datafeed_dump(const struct sr_datafeed_packet *packet)
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200613{
Joel Holdsworthbf534572012-12-13 21:07:53 +0000614 const struct sr_datafeed_logic *logic;
615 const struct sr_datafeed_analog *analog;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200616
617 switch (packet->type) {
618 case SR_DF_HEADER:
Uwe Hermanna421dc12013-01-29 12:55:00 +0100619 sr_dbg("bus: Received SR_DF_HEADER packet.");
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200620 break;
621 case SR_DF_TRIGGER:
Uwe Hermanna421dc12013-01-29 12:55:00 +0100622 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200623 break;
Bert Vermeulenc71bac32013-01-20 16:37:23 +0100624 case SR_DF_META:
Uwe Hermanna421dc12013-01-29 12:55:00 +0100625 sr_dbg("bus: Received SR_DF_META packet.");
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200626 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200627 case SR_DF_LOGIC:
628 logic = packet->payload;
Uwe Hermann7ea45862014-04-25 19:34:41 +0200629 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
630 "unitsize = %d).", logic->length, logic->unitsize);
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200631 break;
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200632 case SR_DF_ANALOG:
633 analog = packet->payload;
Uwe Hermanna421dc12013-01-29 12:55:00 +0100634 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
635 analog->num_samples);
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200636 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200637 case SR_DF_END:
Uwe Hermanna421dc12013-01-29 12:55:00 +0100638 sr_dbg("bus: Received SR_DF_END packet.");
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200639 break;
Bert Vermeulen6ea76692012-04-30 19:55:06 +0200640 case SR_DF_FRAME_BEGIN:
Uwe Hermanna421dc12013-01-29 12:55:00 +0100641 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
Bert Vermeulen6ea76692012-04-30 19:55:06 +0200642 break;
643 case SR_DF_FRAME_END:
Uwe Hermanna421dc12013-01-29 12:55:00 +0100644 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
Bert Vermeulen6ea76692012-04-30 19:55:06 +0200645 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200646 default:
Uwe Hermanna421dc12013-01-29 12:55:00 +0100647 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100648 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200649 }
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200650}
651
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100652/**
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100653 * Send a packet to whatever is listening on the datafeed bus.
654 *
655 * Hardware drivers use this to send a data packet to the frontend.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100656 *
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200657 * @param sdi TODO.
Uwe Hermann31ccebc2012-02-29 22:08:45 +0100658 * @param packet The datafeed packet to send to the session bus.
Uwe Hermann44dae532012-02-17 20:44:19 +0100659 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100660 * @retval SR_OK Success.
661 * @retval SR_ERR_ARG Invalid argument.
Uwe Hermannb4bd7082012-10-19 10:07:22 +0200662 *
663 * @private
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100664 */
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200665SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
Bert Vermeulen8143cfd2014-09-26 01:33:15 +0200666 const struct sr_datafeed_packet *packet)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200667{
668 GSList *l;
Martin Ling27264742013-04-15 21:08:55 +0100669 struct datafeed_callback *cb_struct;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200670
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200671 if (!sdi) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100672 sr_err("%s: sdi was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100673 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100674 }
675
Uwe Hermanne0508e62012-01-07 17:08:54 +0100676 if (!packet) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100677 sr_err("%s: packet was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100678 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100679 }
680
Bert Vermeulen79f92682014-09-19 00:21:30 +0200681 if (!sdi->session) {
682 sr_err("%s: session was NULL", __func__);
683 return SR_ERR_BUG;
684 }
685
Bert Vermeulen3337e9a2014-07-21 15:08:17 +0200686 for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
Bert Vermeulen18beaef2012-02-13 00:08:23 +0100687 if (sr_log_loglevel_get() >= SR_LOG_DBG)
688 datafeed_dump(packet);
Martin Ling27264742013-04-15 21:08:55 +0100689 cb_struct = l->data;
690 cb_struct->cb(sdi, packet, cb_struct->cb_data);
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200691 }
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100692
Uwe Hermanne0508e62012-01-07 17:08:54 +0100693 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200694}
695
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200696/**
697 * Add an event source for a file descriptor.
698 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200699 * @param session The session to use. Must not be NULL.
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200700 * @param pollfd The GPollFD.
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100701 * @param[in] timeout Max time to wait before the callback is called,
702 * ignored if 0.
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200703 * @param cb Callback function to add. Must not be NULL.
704 * @param cb_data Data for the callback function. Can be NULL.
705 * @param poll_object TODO.
706 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100707 * @retval SR_OK Success.
708 * @retval SR_ERR_ARG Invalid argument.
709 * @retval SR_ERR_MALLOC Memory allocation error.
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200710 */
Bert Vermeulen102f1232014-07-21 14:35:27 +0200711static int _sr_session_source_add(struct sr_session *session, GPollFD *pollfd,
712 int timeout, sr_receive_data_callback cb, void *cb_data, gintptr poll_object)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100713{
714 struct source *new_sources, *s;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200715 GPollFD *new_pollfds;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100716
Uwe Hermannd08490a2012-02-29 21:56:24 +0100717 if (!cb) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100718 sr_err("%s: cb was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100719 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100720 }
721
Uwe Hermann1f9813e2012-02-29 22:32:34 +0100722 /* Note: cb_data can be NULL, that's not a bug. */
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100723
Bert Vermeulen2ac2e622012-07-22 15:32:35 +0200724 new_pollfds = g_try_realloc(session->pollfds,
725 sizeof(GPollFD) * (session->num_sources + 1));
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200726 if (!new_pollfds) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100727 sr_err("%s: new_pollfds malloc failed", __func__);
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200728 return SR_ERR_MALLOC;
729 }
730
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200731 new_sources = g_try_realloc(session->sources, sizeof(struct source) *
Bert Vermeulen2ac2e622012-07-22 15:32:35 +0200732 (session->num_sources + 1));
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100733 if (!new_sources) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100734 sr_err("%s: new_sources malloc failed", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100735 return SR_ERR_MALLOC;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100736 }
Bert Vermeulen544a4582011-01-30 02:40:55 +0100737
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200738 new_pollfds[session->num_sources] = *pollfd;
739 s = &new_sources[session->num_sources++];
Bert Vermeulen544a4582011-01-30 02:40:55 +0100740 s->timeout = timeout;
Uwe Hermannd08490a2012-02-29 21:56:24 +0100741 s->cb = cb;
Uwe Hermann1f9813e2012-02-29 22:32:34 +0100742 s->cb_data = cb_data;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200743 s->poll_object = poll_object;
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200744 session->pollfds = new_pollfds;
745 session->sources = new_sources;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100746
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200747 if (timeout != session->source_timeout && timeout > 0
748 && (session->source_timeout == -1 || timeout < session->source_timeout))
749 session->source_timeout = timeout;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100750
Uwe Hermanne0508e62012-01-07 17:08:54 +0100751 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100752}
753
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100754/**
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200755 * Add an event source for a file descriptor.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100756 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200757 * @param session The session to use. Must not be NULL.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200758 * @param fd The file descriptor.
759 * @param events Events to check for.
760 * @param timeout Max time to wait before the callback is called, ignored if 0.
761 * @param cb Callback function to add. Must not be NULL.
762 * @param cb_data Data for the callback function. Can be NULL.
Uwe Hermann44dae532012-02-17 20:44:19 +0100763 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100764 * @retval SR_OK Success.
765 * @retval SR_ERR_ARG Invalid argument.
766 * @retval SR_ERR_MALLOC Memory allocation error.
Uwe Hermann47117242014-05-04 20:51:05 +0200767 *
768 * @since 0.3.0
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100769 */
Martin Ling0812c402014-05-04 23:07:00 +0100770SR_API int sr_session_source_add(struct sr_session *session, int fd,
771 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200772{
773 GPollFD p;
774
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200775 p.fd = fd;
776 p.events = events;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200777
Bert Vermeulen102f1232014-07-21 14:35:27 +0200778 return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)fd);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200779}
780
781/**
Uwe Hermann1a895c62012-07-05 01:47:44 +0200782 * Add an event source for a GPollFD.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200783 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200784 * @param session The session to use. Must not be NULL.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200785 * @param pollfd The GPollFD.
786 * @param timeout Max time to wait before the callback is called, ignored if 0.
787 * @param cb Callback function to add. Must not be NULL.
788 * @param cb_data Data for the callback function. Can be NULL.
789 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100790 * @retval SR_OK Success.
791 * @retval SR_ERR_ARG Invalid argument.
792 * @retval SR_ERR_MALLOC Memory allocation error.
Uwe Hermann47117242014-05-04 20:51:05 +0200793 *
794 * @since 0.3.0
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200795 */
Martin Ling0812c402014-05-04 23:07:00 +0100796SR_API int sr_session_source_add_pollfd(struct sr_session *session,
797 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
798 void *cb_data)
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200799{
Bert Vermeulen102f1232014-07-21 14:35:27 +0200800 return _sr_session_source_add(session, pollfd, timeout, cb,
Bert Vermeulen8143cfd2014-09-26 01:33:15 +0200801 cb_data, (gintptr)pollfd);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200802}
803
804/**
Uwe Hermann1a895c62012-07-05 01:47:44 +0200805 * Add an event source for a GIOChannel.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200806 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200807 * @param session The session to use. Must not be NULL.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200808 * @param channel The GIOChannel.
809 * @param events Events to poll on.
810 * @param timeout Max time to wait before the callback is called, ignored if 0.
811 * @param cb Callback function to add. Must not be NULL.
812 * @param cb_data Data for the callback function. Can be NULL.
813 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100814 * @retval SR_OK Success.
815 * @retval SR_ERR_ARG Invalid argument.
816 * @retval SR_ERR_MALLOC Memory allocation error.
Uwe Hermann47117242014-05-04 20:51:05 +0200817 *
818 * @since 0.3.0
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200819 */
Martin Ling0812c402014-05-04 23:07:00 +0100820SR_API int sr_session_source_add_channel(struct sr_session *session,
821 GIOChannel *channel, int events, int timeout,
822 sr_receive_data_callback cb, void *cb_data)
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200823{
824 GPollFD p;
825
826#ifdef _WIN32
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200827 g_io_channel_win32_make_pollfd(channel, events, &p);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200828#else
829 p.fd = g_io_channel_unix_get_fd(channel);
830 p.events = events;
831#endif
832
Bert Vermeulen102f1232014-07-21 14:35:27 +0200833 return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)channel);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200834}
835
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200836/**
837 * Remove the source belonging to the specified channel.
838 *
839 * @todo Add more error checks and logging.
840 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200841 * @param session The session to use. Must not be NULL.
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100842 * @param poll_object The channel for which the source should be removed.
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200843 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100844 * @retval SR_OK Success
845 * @retval SR_ERR_ARG Invalid arguments
846 * @retval SR_ERR_MALLOC Memory allocation error
847 * @retval SR_ERR_BUG Internal error
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200848 */
Bert Vermeulen102f1232014-07-21 14:35:27 +0200849static int _sr_session_source_remove(struct sr_session *session, gintptr poll_object)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100850{
851 struct source *new_sources;
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200852 GPollFD *new_pollfds;
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200853 unsigned int old;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100854
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200855 if (!session->sources || !session->num_sources) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100856 sr_err("%s: sources was NULL", __func__);
Uwe Hermann0abee502012-03-04 15:08:11 +0100857 return SR_ERR_BUG;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100858 }
859
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200860 for (old = 0; old < session->num_sources; old++) {
861 if (session->sources[old].poll_object == poll_object)
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200862 break;
863 }
Bert Vermeulen544a4582011-01-30 02:40:55 +0100864
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200865 /* fd not found, nothing to do */
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200866 if (old == session->num_sources)
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200867 return SR_OK;
868
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200869 session->num_sources -= 1;
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200870
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200871 if (old != session->num_sources) {
872 memmove(&session->pollfds[old], &session->pollfds[old+1],
873 (session->num_sources - old) * sizeof(GPollFD));
874 memmove(&session->sources[old], &session->sources[old+1],
875 (session->num_sources - old) * sizeof(struct source));
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200876 }
877
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200878 new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
879 if (!new_pollfds && session->num_sources > 0) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100880 sr_err("%s: new_pollfds malloc failed", __func__);
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200881 return SR_ERR_MALLOC;
882 }
883
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200884 new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources);
885 if (!new_sources && session->num_sources > 0) {
Uwe Hermanna421dc12013-01-29 12:55:00 +0100886 sr_err("%s: new_sources malloc failed", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100887 return SR_ERR_MALLOC;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100888 }
889
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200890 session->pollfds = new_pollfds;
891 session->sources = new_sources;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100892
893 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100894}
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200895
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200896/**
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200897 * Remove the source belonging to the specified file descriptor.
898 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200899 * @param session The session to use. Must not be NULL.
Uwe Hermann1a895c62012-07-05 01:47:44 +0200900 * @param fd The file descriptor for which the source should be removed.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200901 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100902 * @retval SR_OK Success
903 * @retval SR_ERR_ARG Invalid argument
904 * @retval SR_ERR_MALLOC Memory allocation error.
905 * @retval SR_ERR_BUG Internal error.
Uwe Hermann47117242014-05-04 20:51:05 +0200906 *
907 * @since 0.3.0
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200908 */
Martin Ling0812c402014-05-04 23:07:00 +0100909SR_API int sr_session_source_remove(struct sr_session *session, int fd)
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200910{
Bert Vermeulen102f1232014-07-21 14:35:27 +0200911 return _sr_session_source_remove(session, (gintptr)fd);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200912}
913
914/**
915 * Remove the source belonging to the specified poll descriptor.
916 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200917 * @param session The session to use. Must not be NULL.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200918 * @param pollfd The poll descriptor for which the source should be removed.
919 *
920 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
921 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
922 * internal errors.
Uwe Hermann47117242014-05-04 20:51:05 +0200923 *
924 * @since 0.2.0
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200925 */
Martin Ling0812c402014-05-04 23:07:00 +0100926SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
927 GPollFD *pollfd)
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200928{
Bert Vermeulen102f1232014-07-21 14:35:27 +0200929 return _sr_session_source_remove(session, (gintptr)pollfd);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200930}
931
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200932/**
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200933 * Remove the source belonging to the specified channel.
934 *
Uwe Hermann7efe8892014-08-10 17:27:43 +0200935 * @param session The session to use. Must not be NULL.
Uwe Hermann1a895c62012-07-05 01:47:44 +0200936 * @param channel The channel for which the source should be removed.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200937 *
Matthias Heidbrink04cb9152013-11-22 20:40:52 +0100938 * @retval SR_OK Success.
939 * @retval SR_ERR_ARG Invalid argument.
940 * @retval SR_ERR_MALLOC Memory allocation error.
941 * @return SR_ERR_BUG Internal error.
Uwe Hermann47117242014-05-04 20:51:05 +0200942 *
943 * @since 0.2.0
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200944 */
Martin Ling0812c402014-05-04 23:07:00 +0100945SR_API int sr_session_source_remove_channel(struct sr_session *session,
946 GIOChannel *channel)
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200947{
Bert Vermeulen102f1232014-07-21 14:35:27 +0200948 return _sr_session_source_remove(session, (gintptr)channel);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200949}
Uwe Hermann7b870c32012-10-21 16:13:36 +0200950
Bert Vermeulen8143cfd2014-09-26 01:33:15 +0200951static void *copy_src(struct sr_config *src)
952{
953 struct sr_config *new_src;
954
955 new_src = g_malloc(sizeof(struct sr_config));
956 memcpy(new_src, src, sizeof(struct sr_config));
957 g_variant_ref(src->data);
958
959 return new_src;
960}
961
962SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
963 struct sr_datafeed_packet **copy)
964{
965 const struct sr_datafeed_meta *meta;
966 struct sr_datafeed_meta *meta_copy;
967 const struct sr_datafeed_logic *logic;
968 struct sr_datafeed_logic *logic_copy;
969 const struct sr_datafeed_analog *analog;
970 struct sr_datafeed_analog *analog_copy;
971 uint8_t *payload;
972
973 *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
974 (*copy)->type = packet->type;
975
976 switch (packet->type) {
977 case SR_DF_TRIGGER:
978 case SR_DF_END:
979 /* No payload. */
980 break;
981 case SR_DF_HEADER:
982 payload = g_malloc(sizeof(struct sr_datafeed_header));
983 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
984 (*copy)->payload = payload;
985 break;
986 case SR_DF_META:
987 meta = packet->payload;
988 meta_copy = g_malloc(sizeof(struct sr_datafeed_meta));
989 meta_copy->config = g_slist_copy_deep(meta->config,
990 (GCopyFunc)copy_src, NULL);
991 (*copy)->payload = meta_copy;
992 break;
993 case SR_DF_LOGIC:
994 logic = packet->payload;
995 logic_copy = g_malloc(sizeof(logic));
996 logic_copy->length = logic->length;
997 logic_copy->unitsize = logic->unitsize;
998 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
999 (*copy)->payload = logic_copy;
1000 break;
1001 case SR_DF_ANALOG:
1002 analog = packet->payload;
1003 analog_copy = g_malloc(sizeof(analog));
1004 analog_copy->channels = g_slist_copy(analog->channels);
1005 analog_copy->num_samples = analog->num_samples;
1006 analog_copy->mq = analog->mq;
1007 analog_copy->unit = analog->unit;
1008 analog_copy->mqflags = analog->mqflags;
1009 memcpy(analog_copy->data, analog->data,
1010 analog->num_samples * sizeof(float));
1011 (*copy)->payload = analog_copy;
1012 break;
1013 default:
1014 sr_err("Unknown packet type %d", packet->type);
1015 return SR_ERR;
1016 }
1017
1018 return SR_OK;
1019}
1020
1021void sr_packet_free(struct sr_datafeed_packet *packet)
1022{
1023 const struct sr_datafeed_meta *meta;
1024 const struct sr_datafeed_logic *logic;
1025 const struct sr_datafeed_analog *analog;
1026 struct sr_config *src;
1027 GSList *l;
1028
1029 switch (packet->type) {
1030 case SR_DF_TRIGGER:
1031 case SR_DF_END:
1032 /* No payload. */
1033 break;
1034 case SR_DF_HEADER:
1035 /* Payload is a simple struct. */
1036 g_free((void *)packet->payload);
1037 break;
1038 case SR_DF_META:
1039 meta = packet->payload;
1040 for (l = meta->config; l; l = l->next) {
1041 src = l->data;
1042 g_variant_unref(src->data);
1043 g_free(src);
1044 }
1045 g_slist_free(meta->config);
1046 g_free((void *)packet->payload);
1047 break;
1048 case SR_DF_LOGIC:
1049 logic = packet->payload;
1050 g_free(logic->data);
1051 g_free((void *)packet->payload);
1052 break;
1053 case SR_DF_ANALOG:
1054 analog = packet->payload;
1055 g_slist_free(analog->channels);
1056 g_free(analog->data);
1057 g_free((void *)packet->payload);
1058 break;
1059 default:
1060 sr_err("Unknown packet type %d", packet->type);
1061 }
1062 g_free(packet);
1063
1064}
1065
Uwe Hermann7b870c32012-10-21 16:13:36 +02001066/** @} */