blob: d8ef6cf08f62de160089fa55f8caeb1c5a30880c [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 Hermann3d2efd72012-02-05 13:36:03 +010028/* demo.c. TODO: Should not be global! */
29extern SR_PRIV GIOChannel channels[2];
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020030
Bert Vermeulen544a4582011-01-30 02:40:55 +010031struct source {
Bert Vermeulen544a4582011-01-30 02:40:55 +010032 int timeout;
Uwe Hermannd08490a2012-02-29 21:56:24 +010033 sr_receive_data_callback_t cb;
Uwe Hermann1f9813e2012-02-29 22:32:34 +010034 void *cb_data;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +020035
36 /* This is used to keep track of the object (fd, pollfd or channel) which is
37 * being polled and will be used to match the source when removing it again.
38 */
39 gintptr poll_object;
Bert Vermeulen544a4582011-01-30 02:40:55 +010040};
41
Bert Vermeulen7d658872011-01-31 22:34:14 +010042/* There can only be one session at a time. */
Uwe Hermanna0ecd832011-12-28 22:55:21 +010043/* 'session' is not static, it's used elsewhere (via 'extern'). */
Uwe Hermann2872d212011-02-08 17:50:29 +010044struct sr_session *session;
Uwe Hermanna0ecd832011-12-28 22:55:21 +010045static int num_sources = 0;
Bert Vermeulen7d658872011-01-31 22:34:14 +010046
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +020047/* Both "sources" and "pollfds" are of the same size and contain pairs of
48 * descriptor and callback function. We can not embed the GPollFD into the
49 * source struct since we want to be able to pass the array of all poll
50 * descriptors to g_poll.
51 */
Uwe Hermanna0ecd832011-12-28 22:55:21 +010052static struct source *sources = NULL;
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +020053static GPollFD *pollfds;
Uwe Hermanna0ecd832011-12-28 22:55:21 +010054static int source_timeout = -1;
Bert Vermeulen544a4582011-01-30 02:40:55 +010055
Uwe Hermann9f45fb32012-01-02 14:15:25 +010056/**
57 * Create a new session.
58 *
Uwe Hermann9f45fb32012-01-02 14:15:25 +010059 * TODO: Should it use the file-global "session" variable or take an argument?
60 * The same question applies to all the other session functions.
61 *
62 * @return A pointer to the newly allocated session, or NULL upon errors.
63 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +010064SR_API struct sr_session *sr_session_new(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020065{
Uwe Hermann133a37b2012-02-11 20:06:46 +010066 if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +010067 sr_err("session: %s: session malloc failed", __func__);
68 return NULL; /* TODO: SR_ERR_MALLOC? */
69 }
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020070
71 return session;
72}
73
Uwe Hermann9f45fb32012-01-02 14:15:25 +010074/**
75 * Destroy the current session.
76 *
77 * This frees up all memory used by the session.
78 *
Uwe Hermanne0508e62012-01-07 17:08:54 +010079 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +010080 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +010081SR_API int sr_session_destroy(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020082{
Uwe Hermann9f45fb32012-01-02 14:15:25 +010083 if (!session) {
Uwe Hermann133a37b2012-02-11 20:06:46 +010084 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +010085 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +010086 }
87
Uwe Hermannbb7ef792012-02-17 22:25:01 +010088 g_slist_free(session->devs);
89 session->devs = NULL;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020090
Uwe Hermann9f45fb32012-01-02 14:15:25 +010091 /* TODO: Error checks needed? */
92
Bert Vermeulenaa4b1102011-01-24 07:46:16 +010093 /* TODO: Loop over protocol decoders and free them. */
Uwe Hermanna1bb33a2010-04-02 20:18:27 +020094
95 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
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100101/**
102 * Remove all the devices from the current session. TODO?
103 *
104 * The session itself (i.e., the struct sr_session) is not free'd and still
105 * exists after this function returns.
106 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100107 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100108 */
Uwe Hermann01c3e9d2012-03-28 21:55:48 +0200109SR_API int sr_session_dev_remove_all(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200110{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100111 if (!session) {
Uwe Hermann133a37b2012-02-11 20:06:46 +0100112 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100113 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100114 }
115
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100116 g_slist_free(session->devs);
117 session->devs = NULL;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100118
119 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200120}
121
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100122/**
123 * Add a device to the current session.
124 *
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100125 * @param dev The device to add to the current session. Must not be NULL.
Uwe Hermannc09f0b52012-02-28 23:52:30 +0100126 * Also, dev->driver and dev->driver->dev_open must not be NULL.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100127 *
128 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
129 */
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100130SR_API int sr_session_dev_add(struct sr_dev *dev)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200131{
132 int ret;
133
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100134 if (!dev) {
135 sr_err("session: %s: dev was NULL", __func__);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100136 return SR_ERR_ARG;
137 }
138
Uwe Hermannd6eb0c32012-03-18 12:57:34 +0100139 if (!session) {
140 sr_err("session: %s: session was NULL", __func__);
141 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100142 }
143
Uwe Hermannd6eb0c32012-03-18 12:57:34 +0100144 /* If dev->driver is NULL, this is a virtual device. */
145 if (!dev->driver) {
146 sr_dbg("session: %s: dev->driver was NULL, this seems to be "
147 "a virtual device; continuing", __func__);
148 /* Just add the device, don't run dev_open(). */
149 session->devs = g_slist_append(session->devs, dev);
150 return SR_OK;
151 }
152
153 /* dev->driver is non-NULL (i.e. we have a real device). */
Uwe Hermannc09f0b52012-02-28 23:52:30 +0100154 if (!dev->driver->dev_open) {
155 sr_err("session: %s: dev->driver->dev_open was NULL",
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100156 __func__);
Uwe Hermann8ec95d22012-03-21 19:28:43 +0100157 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100158 }
159
Uwe Hermannc09f0b52012-02-28 23:52:30 +0100160 if ((ret = dev->driver->dev_open(dev->driver_index)) != SR_OK) {
Uwe Hermanne7eb7032012-02-18 11:57:43 +0100161 sr_err("session: %s: dev_open failed (%d)", __func__, ret);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100162 return ret;
Bert Vermeulenaa4b1102011-01-24 07:46:16 +0100163 }
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200164
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100165 session->devs = g_slist_append(session->devs, dev);
Bert Vermeulenaa4b1102011-01-24 07:46:16 +0100166
Uwe Hermanne46b8fb2011-01-29 16:23:12 +0100167 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200168}
169
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100170/**
Uwe Hermann01c3e9d2012-03-28 21:55:48 +0200171 * Remove all datafeed callbacks in the current session.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100172 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100173 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100174 */
Uwe Hermann01c3e9d2012-03-28 21:55:48 +0200175SR_API int sr_session_datafeed_callback_remove_all(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200176{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100177 if (!session) {
178 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100179 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100180 }
181
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200182 g_slist_free(session->datafeed_callbacks);
183 session->datafeed_callbacks = NULL;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100184
185 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200186}
187
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100188/**
189 * Add a datafeed callback to the current session.
190 *
Uwe Hermannd08490a2012-02-29 21:56:24 +0100191 * @param cb Function to call when a chunk of data is received.
Uwe Hermann0abee502012-03-04 15:08:11 +0100192 * Must not be NULL.
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100193 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100194 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100195 */
Uwe Hermannd08490a2012-02-29 21:56:24 +0100196SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200197{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100198 if (!session) {
199 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100200 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100201 }
202
Uwe Hermann0abee502012-03-04 15:08:11 +0100203 if (!cb) {
204 sr_err("session: %s: cb was NULL", __func__);
205 return SR_ERR_ARG;
206 }
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100207
Uwe Hermann62c82022010-04-15 20:16:53 +0200208 session->datafeed_callbacks =
Uwe Hermannd08490a2012-02-29 21:56:24 +0100209 g_slist_append(session->datafeed_callbacks, cb);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100210
211 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200212}
213
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100214/**
215 * TODO.
216 */
Uwe Hermanne0508e62012-01-07 17:08:54 +0100217static int sr_session_run_poll(void)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100218{
Bert Vermeulen544a4582011-01-30 02:40:55 +0100219 int ret, i;
220
Bert Vermeulen544a4582011-01-30 02:40:55 +0100221 while (session->running) {
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200222 ret = g_poll(pollfds, num_sources, source_timeout);
Bert Vermeulen544a4582011-01-30 02:40:55 +0100223
224 for (i = 0; i < num_sources; i++) {
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200225 if (pollfds[i].revents > 0 || (ret == 0
Bert Vermeulen544a4582011-01-30 02:40:55 +0100226 && source_timeout == sources[i].timeout)) {
227 /*
228 * Invoke the source's callback on an event,
229 * or if the poll timeout out and this source
230 * asked for that timeout.
231 */
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200232 if (!sources[i].cb(pollfds[i].fd, pollfds[i].revents,
Uwe Hermann1f9813e2012-02-29 22:32:34 +0100233 sources[i].cb_data))
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200234 sr_session_source_remove(pollfds[i].fd);
Bert Vermeulen544a4582011-01-30 02:40:55 +0100235 }
236 }
237 }
Uwe Hermanne0508e62012-01-07 17:08:54 +0100238
239 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100240}
241
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100242/**
243 * Start a session.
244 *
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100245 * There can only be one session at a time.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100246 *
247 * @return SR_OK upon success, SR_ERR upon errors.
248 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +0100249SR_API int sr_session_start(void)
Bert Vermeulen7d658872011-01-31 22:34:14 +0100250{
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100251 struct sr_dev *dev;
Bert Vermeulen7d658872011-01-31 22:34:14 +0100252 GSList *l;
253 int ret;
254
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100255 if (!session) {
256 sr_err("session: %s: session was NULL; a session must be "
257 "created first, before starting it.", __func__);
Uwe Hermann0abee502012-03-04 15:08:11 +0100258 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100259 }
260
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100261 if (!session->devs) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100262 /* TODO: Actually the case? */
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100263 sr_err("session: %s: session->devs was NULL; a session "
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100264 "cannot be started without devices.", __func__);
Uwe Hermann0abee502012-03-04 15:08:11 +0100265 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100266 }
267
Uwe Hermannc09f0b52012-02-28 23:52:30 +0100268 /* TODO: Check driver_index validity? */
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100269
Uwe Hermannb08024a2011-04-14 09:46:53 +0200270 sr_info("session: starting");
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100271
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100272 for (l = session->devs; l; l = l->next) {
273 dev = l->data;
274 /* TODO: Check for dev != NULL. */
Uwe Hermannc09f0b52012-02-28 23:52:30 +0100275 if ((ret = dev->driver->dev_acquisition_start(
276 dev->driver_index, dev)) != SR_OK) {
Renato Caldas446a0372012-01-06 00:04:29 +0000277 sr_err("session: %s: could not start an acquisition "
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100278 "(%d)", __func__, ret);
Bert Vermeulen7d658872011-01-31 22:34:14 +0100279 break;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100280 }
Bert Vermeulen7d658872011-01-31 22:34:14 +0100281 }
282
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100283 /* TODO: What if there are multiple devices? Which return code? */
284
Bert Vermeulen7d658872011-01-31 22:34:14 +0100285 return ret;
286}
287
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100288/**
289 * Run the session.
290 *
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100291 * TODO: Various error checks etc.
292 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100293 * @return SR_OK upon success, SR_ERR_BUG upon errors.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100294 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +0100295SR_API int sr_session_run(void)
Bert Vermeulen7d658872011-01-31 22:34:14 +0100296{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100297 if (!session) {
298 sr_err("session: %s: session was NULL; a session must be "
299 "created first, before running it.", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100300 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100301 }
302
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100303 if (!session->devs) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100304 /* TODO: Actually the case? */
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100305 sr_err("session: %s: session->devs was NULL; a session "
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100306 "cannot be run without devices.", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100307 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100308 }
309
Uwe Hermannb08024a2011-04-14 09:46:53 +0200310 sr_info("session: running");
Bert Vermeulen7d658872011-01-31 22:34:14 +0100311 session->running = TRUE;
312
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100313 /* Do we have real sources? */
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200314 if (num_sources == 1 && pollfds[0].fd == -1) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100315 /* Dummy source, freewheel over it. */
Bert Vermeulen7d658872011-01-31 22:34:14 +0100316 while (session->running)
Uwe Hermann1f9813e2012-02-29 22:32:34 +0100317 sources[0].cb(-1, 0, sources[0].cb_data);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100318 } else {
319 /* Real sources, use g_poll() main loop. */
Uwe Hermann8a2efef2011-02-08 18:00:49 +0100320 sr_session_run_poll();
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100321 }
322
Uwe Hermanne0508e62012-01-07 17:08:54 +0100323 return SR_OK;
Bert Vermeulen7d658872011-01-31 22:34:14 +0100324}
325
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100326/**
327 * Halt the current session.
328 *
Uwe Hermann44dae532012-02-17 20:44:19 +0100329 * This requests the current session be stopped as soon as possible, for
330 * example on receiving an SR_DF_END packet.
Uwe Hermanne0508e62012-01-07 17:08:54 +0100331 *
332 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100333 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +0100334SR_API int sr_session_halt(void)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100335{
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100336 if (!session) {
337 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100338 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100339 }
340
Uwe Hermannb08024a2011-04-14 09:46:53 +0200341 sr_info("session: halting");
Bert Vermeulen544a4582011-01-30 02:40:55 +0100342 session->running = FALSE;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100343
Uwe Hermanne0508e62012-01-07 17:08:54 +0100344 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100345}
346
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100347/**
348 * Stop the current session.
349 *
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100350 * The current session is stopped immediately, with all acquisition sessions
Uwe Hermannc09f0b52012-02-28 23:52:30 +0100351 * being stopped and hardware drivers cleaned up.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100352 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100353 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100354 */
Uwe Hermann1a081ca2012-02-01 23:40:35 +0100355SR_API int sr_session_stop(void)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200356{
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100357 struct sr_dev *dev;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200358 GSList *l;
359
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100360 if (!session) {
361 sr_err("session: %s: session was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100362 return SR_ERR_BUG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100363 }
364
Uwe Hermannb08024a2011-04-14 09:46:53 +0200365 sr_info("session: stopping");
Bert Vermeulen544a4582011-01-30 02:40:55 +0100366 session->running = FALSE;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100367
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100368 for (l = session->devs; l; l = l->next) {
369 dev = l->data;
370 /* Check for dev != NULL. */
Uwe Hermannc09f0b52012-02-28 23:52:30 +0100371 if (dev->driver) {
372 if (dev->driver->dev_acquisition_stop)
373 dev->driver->dev_acquisition_stop(dev->driver_index, dev);
374 if (dev->driver->cleanup)
375 dev->driver->cleanup();
Bert Vermeulen8c76be52012-01-08 22:05:00 +0100376 }
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200377 }
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100378
Uwe Hermanne0508e62012-01-07 17:08:54 +0100379 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200380}
381
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100382/**
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100383 * Debug helper.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100384 *
Bert Vermeulen996b0c72012-02-13 02:13:51 +0100385 * @param packet The packet to show debugging information for.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100386 */
Bert Vermeulen18beaef2012-02-13 00:08:23 +0100387static void datafeed_dump(struct sr_datafeed_packet *packet)
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200388{
389 struct sr_datafeed_logic *logic;
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200390 struct sr_datafeed_analog *analog;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200391
392 switch (packet->type) {
393 case SR_DF_HEADER:
394 sr_dbg("bus: received SR_DF_HEADER");
395 break;
396 case SR_DF_TRIGGER:
Bert Vermeulen01469702012-02-01 02:59:41 +0100397 sr_dbg("bus: received SR_DF_TRIGGER");
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200398 break;
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200399 case SR_DF_META_LOGIC:
400 sr_dbg("bus: received SR_DF_META_LOGIC");
401 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200402 case SR_DF_LOGIC:
403 logic = packet->payload;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100404 /* TODO: Check for logic != NULL. */
Bert Vermeulen01469702012-02-01 02:59:41 +0100405 sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200406 break;
Bert Vermeulenee7489d2012-04-22 18:11:31 +0200407 case SR_DF_META_ANALOG:
408 sr_dbg("bus: received SR_DF_META_LOGIC");
409 break;
410 case SR_DF_ANALOG:
411 analog = packet->payload;
412 /* TODO: Check for analog != NULL. */
413 sr_dbg("bus: received SR_DF_ANALOG %d samples", analog->num_samples);
414 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200415 case SR_DF_END:
416 sr_dbg("bus: received SR_DF_END");
417 break;
Bert Vermeulen6ea76692012-04-30 19:55:06 +0200418 case SR_DF_FRAME_BEGIN:
419 sr_dbg("bus: received SR_DF_FRAME_BEGIN");
420 break;
421 case SR_DF_FRAME_END:
422 sr_dbg("bus: received SR_DF_FRAME_END");
423 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200424 default:
Bert Vermeulen18beaef2012-02-13 00:08:23 +0100425 sr_dbg("bus: received unknown packet type %d", packet->type);
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100426 break;
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200427 }
Bert Vermeulen7d2afd62011-06-20 11:42:43 +0200428}
429
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100430/**
Bert Vermeulena1645fc2012-02-13 03:36:32 +0100431 * Send a packet to whatever is listening on the datafeed bus.
432 *
433 * Hardware drivers use this to send a data packet to the frontend.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100434 *
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100435 * @param dev TODO.
Uwe Hermann31ccebc2012-02-29 22:08:45 +0100436 * @param packet The datafeed packet to send to the session bus.
Uwe Hermann44dae532012-02-17 20:44:19 +0100437 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100438 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100439 */
Uwe Hermann31ccebc2012-02-29 22:08:45 +0100440SR_PRIV int sr_session_send(struct sr_dev *dev,
441 struct sr_datafeed_packet *packet)
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200442{
443 GSList *l;
Uwe Hermannd08490a2012-02-29 21:56:24 +0100444 sr_datafeed_callback_t cb;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200445
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100446 if (!dev) {
447 sr_err("session: %s: dev was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100448 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100449 }
450
Uwe Hermanne0508e62012-01-07 17:08:54 +0100451 if (!packet) {
452 sr_err("session: %s: packet was NULL", __func__);
453 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100454 }
455
Uwe Hermann62c82022010-04-15 20:16:53 +0200456 for (l = session->datafeed_callbacks; l; l = l->next) {
Bert Vermeulen18beaef2012-02-13 00:08:23 +0100457 if (sr_log_loglevel_get() >= SR_LOG_DBG)
458 datafeed_dump(packet);
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200459 cb = l->data;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100460 /* TODO: Check for cb != NULL. */
Uwe Hermannbb7ef792012-02-17 22:25:01 +0100461 cb(dev, packet);
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200462 }
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100463
Uwe Hermanne0508e62012-01-07 17:08:54 +0100464 return SR_OK;
Uwe Hermanna1bb33a2010-04-02 20:18:27 +0200465}
466
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200467static int _sr_session_source_add(GPollFD *pollfd, int timeout,
468 sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100469{
470 struct source *new_sources, *s;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200471 GPollFD *new_pollfds;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100472
Uwe Hermannd08490a2012-02-29 21:56:24 +0100473 if (!cb) {
474 sr_err("session: %s: cb was NULL", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100475 return SR_ERR_ARG;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100476 }
477
Uwe Hermann1f9813e2012-02-29 22:32:34 +0100478 /* Note: cb_data can be NULL, that's not a bug. */
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100479
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200480 new_pollfds = g_try_realloc(pollfds, sizeof(GPollFD) * (num_sources + 1));
481 if (!new_pollfds) {
482 sr_err("session: %s: new_sources malloc failed", __func__);
483 return SR_ERR_MALLOC;
484 }
485
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200486 new_sources = g_try_realloc(sources, sizeof(struct source) * (num_sources + 1));
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100487 if (!new_sources) {
488 sr_err("session: %s: new_sources malloc failed", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100489 return SR_ERR_MALLOC;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100490 }
Bert Vermeulen544a4582011-01-30 02:40:55 +0100491
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200492 new_pollfds[num_sources] = *pollfd;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100493 s = &new_sources[num_sources++];
Bert Vermeulen544a4582011-01-30 02:40:55 +0100494 s->timeout = timeout;
Uwe Hermannd08490a2012-02-29 21:56:24 +0100495 s->cb = cb;
Uwe Hermann1f9813e2012-02-29 22:32:34 +0100496 s->cb_data = cb_data;
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200497 s->poll_object = poll_object;
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200498 pollfds = new_pollfds;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100499 sources = new_sources;
500
501 if (timeout != source_timeout && timeout > 0
502 && (source_timeout == -1 || timeout < source_timeout))
503 source_timeout = timeout;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100504
Uwe Hermanne0508e62012-01-07 17:08:54 +0100505 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100506}
507
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100508/**
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200509 * Add a event source for a file descriptor.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100510 *
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200511 * @param fd The file descriptor.
512 * @param events Events to check for.
513 * @param timeout Max time to wait before the callback is called, ignored if 0.
514 * @param cb Callback function to add. Must not be NULL.
515 * @param cb_data Data for the callback function. Can be NULL.
Uwe Hermann44dae532012-02-17 20:44:19 +0100516 *
Uwe Hermanne0508e62012-01-07 17:08:54 +0100517 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200518 * SR_ERR_MALLOC upon memory allocation errors.
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100519 */
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200520SR_API int sr_session_source_add(int fd, int events, int timeout,
521 sr_receive_data_callback_t cb, void *cb_data)
522{
523 GPollFD p;
524
525#ifdef _WIN32
526 g_io_channel_win32_make_pollfd(&channels[0],
527 events, &p);
528#else
529 p.fd = fd;
530 p.events = events;
531#endif
532
533 return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
534}
535
536/**
537 * Add a event source for a GPollFD
538 *
539 * TODO: More error checks etc.
540 *
541 * @param pollfd The GPollFD.
542 * @param timeout Max time to wait before the callback is called, ignored if 0.
543 * @param cb Callback function to add. Must not be NULL.
544 * @param cb_data Data for the callback function. Can be NULL.
545 *
546 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
547 * SR_ERR_MALLOC upon memory allocation errors.
548 */
549SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
550 sr_receive_data_callback_t cb, void *cb_data)
551{
552 return _sr_session_source_add(pollfd, timeout, cb, cb_data, (gintptr)pollfd);
553}
554
555/**
556 * Add a event source for a GIOChannel
557 *
558 * TODO: More error checks etc.
559 *
560 * @param channel The GIOChannel.
561 * @param events Events to poll on.
562 * @param timeout Max time to wait before the callback is called, ignored if 0.
563 * @param cb Callback function to add. Must not be NULL.
564 * @param cb_data Data for the callback function. Can be NULL.
565 *
566 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
567 * SR_ERR_MALLOC upon memory allocation errors.
568 */
569SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, int timeout,
570 sr_receive_data_callback_t cb, void *cb_data)
571{
572 GPollFD p;
573
574#ifdef _WIN32
575 g_io_channel_win32_make_pollfd(channel,
576 events, &p);
577#else
578 p.fd = g_io_channel_unix_get_fd(channel);
579 p.events = events;
580#endif
581
582 return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
583}
584
585
586static int _sr_session_source_remove(gintptr poll_object)
Bert Vermeulen544a4582011-01-30 02:40:55 +0100587{
588 struct source *new_sources;
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200589 GPollFD *new_pollfds;
590 int old;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100591
Uwe Hermanne0508e62012-01-07 17:08:54 +0100592 if (!sources) {
593 sr_err("session: %s: sources was NULL", __func__);
Uwe Hermann0abee502012-03-04 15:08:11 +0100594 return SR_ERR_BUG;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100595 }
596
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200597 for (old = 0; old < num_sources; old++) {
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200598 if (sources[old].poll_object == poll_object)
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200599 break;
600 }
Bert Vermeulen544a4582011-01-30 02:40:55 +0100601
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200602 /* fd not found, nothing to do */
603 if (old == num_sources)
604 return SR_OK;
605
606 num_sources -= 1;
607
608 if (old != num_sources) {
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200609 memmove(&pollfds[old], &pollfds[old+1],
610 (num_sources - old) * sizeof(GPollFD));
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200611 memmove(&sources[old], &sources[old+1],
612 (num_sources - old) * sizeof(struct source));
613 }
614
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200615 new_pollfds = g_try_realloc(sources, sizeof(GPollFD) * num_sources);
616 if (!new_pollfds && num_sources > 0) {
617 sr_err("session: %s: new_sources malloc failed", __func__);
618 return SR_ERR_MALLOC;
619 }
620
621 new_sources = g_try_realloc(sources, sizeof(struct source) * num_sources);
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200622 if (!new_sources && num_sources > 0) {
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100623 sr_err("session: %s: new_sources malloc failed", __func__);
Uwe Hermanne0508e62012-01-07 17:08:54 +0100624 return SR_ERR_MALLOC;
Uwe Hermann9f45fb32012-01-02 14:15:25 +0100625 }
626
Lars-Peter Clausen0687dfc2012-06-30 20:54:43 +0200627 pollfds = new_pollfds;
Lars-Peter Clausen2bccd322012-06-30 20:54:42 +0200628 sources = new_sources;
Uwe Hermanne0508e62012-01-07 17:08:54 +0100629
630 return SR_OK;
Bert Vermeulen544a4582011-01-30 02:40:55 +0100631}
Lars-Peter Clausenaac0ea22012-06-30 20:54:44 +0200632
633/*
634 * Remove the source belonging to the specified file descriptor.
635 *
636 * TODO: More error checks.
637 *
638 * @param fd: The file descriptor for which the source should be removed.
639 *
640 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
641 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
642 * internal errors.
643 */
644SR_API int sr_session_source_remove(int fd)
645{
646 return _sr_session_source_remove((gintptr)fd);
647}
648
649/**
650 * Remove the source belonging to the specified poll descriptor.
651 *
652 * TODO: More error checks.
653 *
654 * @param pollfd The poll descriptor for which the source should be removed.
655 *
656 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
657 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
658 * internal errors.
659 */
660SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
661{
662 return _sr_session_source_remove((gintptr)pollfd);
663}
664
665/*
666 * Remove the source belonging to the specified channel.
667 *
668 * TODO: More error checks.
669 *
670 * @parama channel: The channel for which the source should be removed.
671 *
672 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
673 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
674 * internal errors.
675 */
676SR_API int sr_session_source_remove_channel(GIOChannel *channel)
677{
678 return _sr_session_source_remove((gintptr)channel);
679}