blob: 440e3bd64970db1caab999e873b392f989f1b1d9 [file] [log] [blame]
Uwe Hermanna1bb33a2010-04-02 20:18:27 +02001/*
2 * This file is part of the sigrok project.
3 *
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 Hermann7b870c32012-10-21 16:13:36 +020028/**
Uwe Hermann393fb9c2012-10-22 00:30:12 +020029 * @file
30 *
31 * Creating, using, or destroying libsigrok sessions.
32 */
33
34/**
Uwe Hermann7b870c32012-10-21 16:13:36 +020035 * @defgroup grp_session Session handling
36 *
37 * Creating, using, or destroying libsigrok sessions.
38 *
39 * @{
40 */
41
Bert Vermeulen544a4582011-01-30 02:40:55 +010042struct source {
Bert Vermeulen544a4582011-01-30 02:40:55 +010043 int timeout;
Uwe Hermannd08490a2012-02-29 21:56:24 +010044 sr_receive_data_callback_t cb;
Uwe Hermann1f9813e2012-02-29 22:32:34 +010045 void *cb_data;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +020046
47 /* This is used to keep track of the object (fd, pollfd or channel) which is
48 * being polled and will be used to match the source when removing it again.
49 */
50 gintptr poll_object;
Bert Vermeulen544a4582011-01-30 02:40:55 +010051};
52
Bert Vermeulen7d658872011-01-31 22:34:14 +010053/* There can only be one session at a time. */
Uwe Hermanna0ecd832011-12-28 22:55:21 +010054/* 'session' is not static, it's used elsewhere (via 'extern'). */
Uwe Hermann2872d212011-02-08 17:50:29 +010055struct sr_session *session;
Bert Vermeulen544a4582011-01-30 02:40:55 +010056
Uwe Hermann9f45fb32012-01-02 14:15:25 +010057/**
58 * Create a new session.
59 *
Uwe Hermann6b2d8d32012-10-21 23:24:42 +020060 * @todo Should it use the file-global "session" variable or take an argument?
Uwe Hermann9f45fb32012-01-02 14:15:25 +010061 * The same question applies to all the other session functions.
62 *
63 * @return A pointer to the newly allocated session, or NULL upon errors.
64 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +010065SR_API struct sr_session *sr_session_new(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020066{
Uwe Hermann133a37b2012-02-11 20:06:46 +010067 if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +010068 sr_err("session: %s: session malloc failed", __func__);
69 return NULL; /* TODO: SR_ERR_MALLOC? */
70 }
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020071
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +020072 session->source_timeout = -1;
73
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020074 return session;
75}
76
Uwe Hermann9f45fb32012-01-02 14:15:25 +010077/**
78 * Destroy the current session.
79 *
80 * This frees up all memory used by the session.
81 *
Uwe Hermanne0508e62012-01-07 17:08:54 +010082 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +010083 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +010084SR_API int sr_session_destroy(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020085{
Uwe Hermann9f45fb32012-01-02 14:15:25 +010086 if (!session) {
Uwe Hermann133a37b2012-02-11 20:06:46 +010087 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +010088 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +010089 }
90
Lars-Peter Clausened229aa2012-07-05 21:15:07 +020091 sr_session_dev_remove_all();
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020092
Uwe Hermann9f45fb32012-01-02 14:15:25 +010093 /* TODO: Error checks needed? */
94
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020095 g_free(session);
Uwe Hermann9f45fb32012-01-02 14:15:25 +010096 session = NULL;
Uwe Hermanne0508e62012-01-07 17:08:54 +010097
98 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020099}
100
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200101static void sr_dev_close(struct sr_dev_inst *sdi)
Lars-Peter Clausened229aa2012-07-05 21:15:07 +0200102{
Bert Vermeulene8d3d6c2012-07-29 03:01:57 +0200103 if (sdi->driver && sdi->driver->dev_close)
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200104 sdi->driver->dev_close(sdi);
Lars-Peter Clausened229aa2012-07-05 21:15:07 +0200105}
106
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100107/**
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200108 * Remove all the devices from the current session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100109 *
110 * The session itself (i.e., the struct sr_session) is not free'd and still
111 * exists after this function returns.
112 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100113 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100114 */
Uwe Hermann01c3e9d2012-03-28 21:55:48 +0200115SR_API int sr_session_dev_remove_all(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200116{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100117 if (!session) {
Uwe Hermann133a37b2012-02-11 20:06:46 +0100118 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100119 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100120 }
121
Lars-Peter Clausened229aa2012-07-05 21:15:07 +0200122 g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close);
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100123 session->devs = NULL;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100124
125 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200126}
127
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100128/**
Uwe Hermann9c5332d2012-10-21 16:52:56 +0200129 * Add a device instance to the current session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100130 *
Uwe Hermann9c5332d2012-10-21 16:52:56 +0200131 * @param sdi The device instance to add to the current session. Must not
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200132 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
133 * not be NULL.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100134 *
135 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
136 */
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200137SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200138{
139 int ret;
140
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200141 if (!sdi) {
142 sr_err("session: %s: sdi was NULL", __func__);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100143 return SR_ERR_ARG;
144 }
145
Uwe Hermannd6eb0c32012-03-18 12:57:34 +0100146 if (!session) {
147 sr_err("session: %s: session was NULL", __func__);
148 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100149 }
150
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200151 /* If sdi->driver is NULL, this is a virtual device. */
152 if (!sdi->driver) {
153 sr_dbg("session: %s: sdi->driver was NULL, this seems to be "
Uwe Hermannd6eb0c32012-03-18 12:57:34 +0100154 "a virtual device; continuing", __func__);
155 /* Just add the device, don't run dev_open(). */
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200156 session->devs = g_slist_append(session->devs, (gpointer)sdi);
Uwe Hermannd6eb0c32012-03-18 12:57:34 +0100157 return SR_OK;
158 }
159
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200160 /* sdi->driver is non-NULL (i.e. we have a real device). */
161 if (!sdi->driver->dev_open) {
162 sr_err("session: %s: sdi->driver->dev_open was NULL", __func__);
Uwe Hermann8ec95d22012-03-21 19:28:43 +0100163 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100164 }
165
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200166 if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != SR_OK) {
Uwe Hermanne7eb7032012-02-18 11:57:43 +0100167 sr_err("session: %s: dev_open failed (%d)", __func__, ret);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100168 return ret;
Bert Vermeulenaa4b1102011-01-24 07:46:16 +0100169 }
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200170
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200171 session->devs = g_slist_append(session->devs, (gpointer)sdi);
Bert Vermeulenaa4b1102011-01-24 07:46:16 +0100172
Uwe Hermanne46b8fb2011-01-29 16:23:12 +0100173 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200174}
175
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100176/**
Uwe Hermann01c3e9d2012-03-28 21:55:48 +0200177 * Remove all datafeed callbacks in the current session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100178 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100179 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100180 */
Uwe Hermann01c3e9d2012-03-28 21:55:48 +0200181SR_API int sr_session_datafeed_callback_remove_all(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200182{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100183 if (!session) {
184 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100185 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100186 }
187
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200188 g_slist_free(session->datafeed_callbacks);
189 session->datafeed_callbacks = NULL;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100190
191 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200192}
193
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100194/**
195 * Add a datafeed callback to the current session.
196 *
Uwe Hermannd08490a2012-02-29 21:56:24 +0100197 * @param cb Function to call when a chunk of data is received.
Uwe Hermann0abee502012-03-04 15:08:11 +0100198 * Must not be NULL.
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100199 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100200 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100201 */
Uwe Hermannd08490a2012-02-29 21:56:24 +0100202SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200203{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100204 if (!session) {
205 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100206 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100207 }
208
Uwe Hermann0abee502012-03-04 15:08:11 +0100209 if (!cb) {
210 sr_err("session: %s: cb was NULL", __func__);
211 return SR_ERR_ARG;
212 }
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100213
Uwe Hermann62c82022010-04-15 20:16:53 +0200214 session->datafeed_callbacks =
Uwe Hermannd08490a2012-02-29 21:56:24 +0100215 g_slist_append(session->datafeed_callbacks, cb);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100216
217 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200218}
219
Uwe Hermanne0508e62012-01-07 17:08:54 +0100220static int sr_session_run_poll(void)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100221{
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200222 unsigned int i;
223 int ret;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100224
Bert Vermeulen2cbeb2b2012-08-03 01:04:05 +0200225 while (session->num_sources > 0) {
226 ret = g_poll(session->pollfds, session->num_sources,
227 session->source_timeout);
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200228 for (i = 0; i < session->num_sources; i++) {
229 if (session->pollfds[i].revents > 0 || (ret == 0
230 && session->source_timeout == session->sources[i].timeout)) {
Bert Vermeulen544a4582011-01-30 02:40:55 +0100231 /*
232 * Invoke the source's callback on an event,
Bert Vermeulen2cbeb2b2012-08-03 01:04:05 +0200233 * or if the poll timed out and this source
Bert Vermeulen544a4582011-01-30 02:40:55 +0100234 * asked for that timeout.
235 */
Bert Vermeulen2cbeb2b2012-08-03 01:04:05 +0200236 if (!session->sources[i].cb(session->pollfds[i].fd,
237 session->pollfds[i].revents,
238 session->sources[i].cb_data))
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200239 sr_session_source_remove(session->sources[i].poll_object);
Bert Vermeulen544a4582011-01-30 02:40:55 +0100240 }
241 }
242 }
Uwe Hermanne0508e62012-01-07 17:08:54 +0100243
244 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100245}
246
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100247/**
248 * Start a session.
249 *
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100250 * There can only be one session at a time.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100251 *
252 * @return SR_OK upon success, SR_ERR upon errors.
253 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +0100254SR_API int sr_session_start(void)
Bert Vermeulen7d658872011-01-31 22:34:14 +0100255{
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200256 struct sr_dev_inst *sdi;
Bert Vermeulen7d658872011-01-31 22:34:14 +0100257 GSList *l;
258 int ret;
259
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100260 if (!session) {
261 sr_err("session: %s: session was NULL; a session must be "
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200262 "created before starting it.", __func__);
Uwe Hermann0abee502012-03-04 15:08:11 +0100263 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100264 }
265
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100266 if (!session->devs) {
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100267 sr_err("session: %s: session->devs was NULL; a session "
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100268 "cannot be started without devices.", __func__);
Uwe Hermann0abee502012-03-04 15:08:11 +0100269 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100270 }
271
Uwe Hermannb08024a2011-04-14 09:46:53 +0200272 sr_info("session: starting");
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100273
Uwe Hermannb7c3e842012-12-31 21:05:11 +0100274 ret = SR_OK;
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100275 for (l = session->devs; l; l = l->next) {
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200276 sdi = l->data;
277 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
Renato Caldas446a0372012-01-06 00:04:29 +0000278 sr_err("session: %s: could not start an acquisition "
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100279 "(%d)", __func__, ret);
Bert Vermeulen7d658872011-01-31 22:34:14 +0100280 break;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100281 }
Bert Vermeulen7d658872011-01-31 22:34:14 +0100282 }
283
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100284 /* TODO: What if there are multiple devices? Which return code? */
285
Bert Vermeulen7d658872011-01-31 22:34:14 +0100286 return ret;
287}
288
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100289/**
290 * Run the session.
291 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100292 * @return SR_OK upon success, SR_ERR_BUG upon errors.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100293 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +0100294SR_API int sr_session_run(void)
Bert Vermeulen7d658872011-01-31 22:34:14 +0100295{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100296 if (!session) {
297 sr_err("session: %s: session was NULL; a session must be "
298 "created first, before running it.", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100299 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100300 }
301
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100302 if (!session->devs) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100303 /* TODO: Actually the case? */
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100304 sr_err("session: %s: session->devs was NULL; a session "
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100305 "cannot be run without devices.", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100306 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100307 }
308
Uwe Hermannb08024a2011-04-14 09:46:53 +0200309 sr_info("session: running");
Bert Vermeulen7d658872011-01-31 22:34:14 +0100310
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100311 /* Do we have real sources? */
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200312 if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100313 /* Dummy source, freewheel over it. */
Bert Vermeulen2cbeb2b2012-08-03 01:04:05 +0200314 while (session->num_sources)
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200315 session->sources[0].cb(-1, 0, session->sources[0].cb_data);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100316 } else {
317 /* Real sources, use g_poll() main loop. */
Uwe Hermann8a2efef2011-02-08 18:00:49 +0100318 sr_session_run_poll();
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100319 }
320
Uwe Hermanne0508e62012-01-07 17:08:54 +0100321 return SR_OK;
Bert Vermeulen7d658872011-01-31 22:34:14 +0100322}
323
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100324/**
325 * Halt the current session.
326 *
Lars-Peter Clausen9ffbde02012-07-05 21:15:09 +0200327 * This function is deprecated and should not be used in new code, use
328 * sr_session_stop() instead. The behaviour of this function is identical to
329 * sr_session_stop().
Uwe Hermanne0508e62012-01-07 17:08:54 +0100330 *
331 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100332 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +0100333SR_API int sr_session_halt(void)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100334{
Lars-Peter Clausen9ffbde02012-07-05 21:15:09 +0200335 return sr_session_stop();
Bert Vermeulen544a4582011-01-30 02:40:55 +0100336}
337
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100338/**
339 * Stop the current session.
340 *
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100341 * The current session is stopped immediately, with all acquisition sessions
Uwe Hermannc09f0b52012-02-28 23:52:30 +0100342 * being stopped and hardware drivers cleaned up.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100343 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100344 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100345 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +0100346SR_API int sr_session_stop(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200347{
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200348 struct sr_dev_inst *sdi;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200349 GSList *l;
350
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100351 if (!session) {
352 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100353 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100354 }
355
Uwe Hermannb08024a2011-04-14 09:46:53 +0200356 sr_info("session: stopping");
Uwe Hermanne0508e62012-01-07 17:08:54 +0100357
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100358 for (l = session->devs; l; l = l->next) {
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200359 sdi = l->data;
360 if (sdi->driver) {
361 if (sdi->driver->dev_acquisition_stop)
362 sdi->driver->dev_acquisition_stop(sdi, sdi);
Bert Vermeulen8c76be52012-01-08 22:05:00 +0100363 }
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200364 }
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100365
Alexandru Gagniucf1f7e622012-12-19 04:15:18 -0600366 /*
367 * Some sources may not be necessarily associated with a device.
368 * Those sources may still be present even after stopping all devices.
369 * We need to make sure all sources are removed, or we risk running the
370 * session in an infinite loop.
371 */
372 while (session->num_sources)
373 sr_session_source_remove(session->sources[0].poll_object);
374
Uwe Hermanne0508e62012-01-07 17:08:54 +0100375 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200376}
377
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100378/**
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100379 * Debug helper.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100380 *
Bert Vermeulen996b0c72012-02-13 02:13:51 +0100381 * @param packet The packet to show debugging information for.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100382 */
Joel Holdsworthbf534572012-12-13 21:07:53 +0000383static void datafeed_dump(const struct sr_datafeed_packet *packet)
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200384{
Joel Holdsworthbf534572012-12-13 21:07:53 +0000385 const struct sr_datafeed_logic *logic;
386 const struct sr_datafeed_analog *analog;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200387
388 switch (packet->type) {
389 case SR_DF_HEADER:
390 sr_dbg("bus: received SR_DF_HEADER");
391 break;
392 case SR_DF_TRIGGER:
Bert Vermeulen01469702012-02-01 02:59:41 +0100393 sr_dbg("bus: received SR_DF_TRIGGER");
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200394 break;
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200395 case SR_DF_META_LOGIC:
396 sr_dbg("bus: received SR_DF_META_LOGIC");
397 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200398 case SR_DF_LOGIC:
399 logic = packet->payload;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100400 /* TODO: Check for logic != NULL. */
Bert Vermeulen01469702012-02-01 02:59:41 +0100401 sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200402 break;
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200403 case SR_DF_META_ANALOG:
Alexandru Gagniucdfd8f562012-10-19 20:31:19 -0500404 sr_dbg("bus: received SR_DF_META_ANALOG");
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200405 break;
406 case SR_DF_ANALOG:
407 analog = packet->payload;
408 /* TODO: Check for analog != NULL. */
409 sr_dbg("bus: received SR_DF_ANALOG %d samples", analog->num_samples);
410 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200411 case SR_DF_END:
412 sr_dbg("bus: received SR_DF_END");
413 break;
Bert Vermeulen6ea76692012-04-30 19:55:06 +0200414 case SR_DF_FRAME_BEGIN:
415 sr_dbg("bus: received SR_DF_FRAME_BEGIN");
416 break;
417 case SR_DF_FRAME_END:
418 sr_dbg("bus: received SR_DF_FRAME_END");
419 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200420 default:
Bert Vermeulen18beaef2012-02-13 00:08:23 +0100421 sr_dbg("bus: received unknown packet type %d", packet->type);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100422 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200423 }
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200424}
425
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100426/**
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100427 * Send a packet to whatever is listening on the datafeed bus.
428 *
429 * Hardware drivers use this to send a data packet to the frontend.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100430 *
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200431 * @param sdi TODO.
Uwe Hermann31ccebc2012-02-29 22:08:45 +0100432 * @param packet The datafeed packet to send to the session bus.
Uwe Hermann44dae532012-02-17 20:44:19 +0100433 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100434 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
Uwe Hermannb4bd7082012-10-19 10:07:22 +0200435 *
436 * @private
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100437 */
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200438SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
Joel Holdsworthbf534572012-12-13 21:07:53 +0000439 const struct sr_datafeed_packet *packet)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200440{
441 GSList *l;
Uwe Hermannd08490a2012-02-29 21:56:24 +0100442 sr_datafeed_callback_t cb;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200443
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200444 if (!sdi) {
445 sr_err("session: %s: sdi was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100446 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100447 }
448
Uwe Hermanne0508e62012-01-07 17:08:54 +0100449 if (!packet) {
450 sr_err("session: %s: packet was NULL", __func__);
451 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100452 }
453
Uwe Hermann62c82022010-04-15 20:16:53 +0200454 for (l = session->datafeed_callbacks; l; l = l->next) {
Bert Vermeulen18beaef2012-02-13 00:08:23 +0100455 if (sr_log_loglevel_get() >= SR_LOG_DBG)
456 datafeed_dump(packet);
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200457 cb = l->data;
Bert Vermeulende4d3f92012-07-22 15:31:56 +0200458 cb(sdi, packet);
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200459 }
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100460
Uwe Hermanne0508e62012-01-07 17:08:54 +0100461 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200462}
463
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200464/**
465 * Add an event source for a file descriptor.
466 *
467 * @param pollfd The GPollFD.
468 * @param timeout Max time to wait before the callback is called, ignored if 0.
469 * @param cb Callback function to add. Must not be NULL.
470 * @param cb_data Data for the callback function. Can be NULL.
471 * @param poll_object TODO.
472 *
473 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
474 * SR_ERR_MALLOC upon memory allocation errors.
475 */
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200476static int _sr_session_source_add(GPollFD *pollfd, int timeout,
Uwe Hermann1a895c62012-07-05 01:47:44 +0200477 sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100478{
479 struct source *new_sources, *s;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200480 GPollFD *new_pollfds;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100481
Uwe Hermannd08490a2012-02-29 21:56:24 +0100482 if (!cb) {
483 sr_err("session: %s: cb was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100484 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100485 }
486
Uwe Hermann1f9813e2012-02-29 22:32:34 +0100487 /* Note: cb_data can be NULL, that's not a bug. */
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100488
Bert Vermeulen2ac2e622012-07-22 15:32:35 +0200489 new_pollfds = g_try_realloc(session->pollfds,
490 sizeof(GPollFD) * (session->num_sources + 1));
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200491 if (!new_pollfds) {
Uwe Hermann1a895c62012-07-05 01:47:44 +0200492 sr_err("session: %s: new_pollfds malloc failed", __func__);
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200493 return SR_ERR_MALLOC;
494 }
495
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200496 new_sources = g_try_realloc(session->sources, sizeof(struct source) *
Bert Vermeulen2ac2e622012-07-22 15:32:35 +0200497 (session->num_sources + 1));
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100498 if (!new_sources) {
499 sr_err("session: %s: new_sources malloc failed", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100500 return SR_ERR_MALLOC;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100501 }
Bert Vermeulen544a4582011-01-30 02:40:55 +0100502
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200503 new_pollfds[session->num_sources] = *pollfd;
504 s = &new_sources[session->num_sources++];
Bert Vermeulen544a4582011-01-30 02:40:55 +0100505 s->timeout = timeout;
Uwe Hermannd08490a2012-02-29 21:56:24 +0100506 s->cb = cb;
Uwe Hermann1f9813e2012-02-29 22:32:34 +0100507 s->cb_data = cb_data;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200508 s->poll_object = poll_object;
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200509 session->pollfds = new_pollfds;
510 session->sources = new_sources;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100511
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200512 if (timeout != session->source_timeout && timeout > 0
513 && (session->source_timeout == -1 || timeout < session->source_timeout))
514 session->source_timeout = timeout;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100515
Uwe Hermanne0508e62012-01-07 17:08:54 +0100516 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100517}
518
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100519/**
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200520 * Add an event source for a file descriptor.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100521 *
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200522 * @param fd The file descriptor.
523 * @param events Events to check for.
524 * @param timeout Max time to wait before the callback is called, ignored if 0.
525 * @param cb Callback function to add. Must not be NULL.
526 * @param cb_data Data for the callback function. Can be NULL.
Uwe Hermann44dae532012-02-17 20:44:19 +0100527 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100528 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200529 * SR_ERR_MALLOC upon memory allocation errors.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100530 */
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200531SR_API int sr_session_source_add(int fd, int events, int timeout,
532 sr_receive_data_callback_t cb, void *cb_data)
533{
534 GPollFD p;
535
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200536 p.fd = fd;
537 p.events = events;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200538
539 return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
540}
541
542/**
Uwe Hermann1a895c62012-07-05 01:47:44 +0200543 * Add an event source for a GPollFD.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200544 *
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200545 * @param pollfd The GPollFD.
546 * @param timeout Max time to wait before the callback is called, ignored if 0.
547 * @param cb Callback function to add. Must not be NULL.
548 * @param cb_data Data for the callback function. Can be NULL.
549 *
550 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
551 * SR_ERR_MALLOC upon memory allocation errors.
552 */
553SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
554 sr_receive_data_callback_t cb, void *cb_data)
555{
Uwe Hermann1a895c62012-07-05 01:47:44 +0200556 return _sr_session_source_add(pollfd, timeout, cb,
557 cb_data, (gintptr)pollfd);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200558}
559
560/**
Uwe Hermann1a895c62012-07-05 01:47:44 +0200561 * Add an event source for a GIOChannel.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200562 *
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200563 * @param channel The GIOChannel.
564 * @param events Events to poll on.
565 * @param timeout Max time to wait before the callback is called, ignored if 0.
566 * @param cb Callback function to add. Must not be NULL.
567 * @param cb_data Data for the callback function. Can be NULL.
568 *
569 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
570 * SR_ERR_MALLOC upon memory allocation errors.
571 */
Uwe Hermann1a895c62012-07-05 01:47:44 +0200572SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
573 int timeout, sr_receive_data_callback_t cb, void *cb_data)
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200574{
575 GPollFD p;
576
577#ifdef _WIN32
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200578 g_io_channel_win32_make_pollfd(channel, events, &p);
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200579#else
580 p.fd = g_io_channel_unix_get_fd(channel);
581 p.events = events;
582#endif
583
584 return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
585}
586
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200587/**
588 * Remove the source belonging to the specified channel.
589 *
590 * @todo Add more error checks and logging.
591 *
592 * @param channel The channel for which the source should be removed.
593 *
594 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
595 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
596 * internal errors.
597 */
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200598static int _sr_session_source_remove(gintptr poll_object)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100599{
600 struct source *new_sources;
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200601 GPollFD *new_pollfds;
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200602 unsigned int old;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100603
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200604 if (!session->sources || !session->num_sources) {
Uwe Hermanne0508e62012-01-07 17:08:54 +0100605 sr_err("session: %s: sources was NULL", __func__);
Uwe Hermann0abee502012-03-04 15:08:11 +0100606 return SR_ERR_BUG;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100607 }
608
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200609 for (old = 0; old < session->num_sources; old++) {
610 if (session->sources[old].poll_object == poll_object)
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200611 break;
612 }
Bert Vermeulen544a4582011-01-30 02:40:55 +0100613
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200614 /* fd not found, nothing to do */
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200615 if (old == session->num_sources)
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200616 return SR_OK;
617
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200618 session->num_sources -= 1;
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200619
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200620 if (old != session->num_sources) {
621 memmove(&session->pollfds[old], &session->pollfds[old+1],
622 (session->num_sources - old) * sizeof(GPollFD));
623 memmove(&session->sources[old], &session->sources[old+1],
624 (session->num_sources - old) * sizeof(struct source));
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200625 }
626
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200627 new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
628 if (!new_pollfds && session->num_sources > 0) {
Uwe Hermann1a895c62012-07-05 01:47:44 +0200629 sr_err("session: %s: new_pollfds malloc failed", __func__);
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200630 return SR_ERR_MALLOC;
631 }
632
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200633 new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources);
634 if (!new_sources && session->num_sources > 0) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100635 sr_err("session: %s: new_sources malloc failed", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100636 return SR_ERR_MALLOC;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100637 }
638
Lars-Peter Clausenb7e94112012-07-06 23:23:31 +0200639 session->pollfds = new_pollfds;
640 session->sources = new_sources;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100641
642 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100643}
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200644
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200645/**
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200646 * Remove the source belonging to the specified file descriptor.
647 *
Uwe Hermann1a895c62012-07-05 01:47:44 +0200648 * @param fd The file descriptor for which the source should be removed.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200649 *
650 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
651 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
652 * internal errors.
653 */
654SR_API int sr_session_source_remove(int fd)
655{
656 return _sr_session_source_remove((gintptr)fd);
657}
658
659/**
660 * Remove the source belonging to the specified poll descriptor.
661 *
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200662 * @param pollfd The poll descriptor for which the source should be removed.
663 *
664 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
665 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
666 * internal errors.
667 */
668SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
669{
670 return _sr_session_source_remove((gintptr)pollfd);
671}
672
Uwe Hermann6b2d8d32012-10-21 23:24:42 +0200673/**
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200674 * Remove the source belonging to the specified channel.
675 *
Uwe Hermann1a895c62012-07-05 01:47:44 +0200676 * @param channel The channel for which the source should be removed.
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200677 *
678 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
679 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
680 * internal errors.
681 */
682SR_API int sr_session_source_remove_channel(GIOChannel *channel)
683{
684 return _sr_session_source_remove((gintptr)channel);
685}
Uwe Hermann7b870c32012-10-21 16:13:36 +0200686
687/** @} */