2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
27 #include "sigrok-internal.h"
30 extern GIOChannel channels[2];
36 sr_receive_data_callback cb;
40 /* There can only be one session at a time. */
41 /* 'session' is not static, it's used elsewhere (via 'extern'). */
42 struct sr_session *session;
43 static int num_sources = 0;
45 static struct source *sources = NULL;
46 static int source_timeout = -1;
49 * Create a new session.
53 * TODO: Should return int?
54 * TODO: Should it use the file-global "session" variable or take an argument?
55 * The same question applies to all the other session functions.
57 * @return A pointer to the newly allocated session, or NULL upon errors.
59 struct sr_session *sr_session_new(void)
61 if (!(session = calloc(1, sizeof(struct sr_session)))) {
62 sr_err("session: %s: session malloc failed", __func__);
63 return NULL; /* TODO: SR_ERR_MALLOC? */
70 * Destroy the current session.
72 * This frees up all memory used by the session.
74 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
76 int sr_session_destroy(void)
79 sr_warn("session: %s: session was NULL", __func__);
83 g_slist_free(session->devices);
84 session->devices = NULL;
86 /* TODO: Error checks needed? */
88 /* TODO: Loop over protocol decoders and free them. */
97 * Remove all the devices from the current session. TODO?
99 * The session itself (i.e., the struct sr_session) is not free'd and still
100 * exists after this function returns.
102 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
104 int sr_session_device_clear(void)
107 sr_warn("session: %s: session was NULL", __func__);
111 g_slist_free(session->devices);
112 session->devices = NULL;
118 * Add a device to the current session.
120 * @param device The device to add to the current session. Must not be NULL.
121 * Also, device->plugin and device->plugin->opendev must not
124 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
126 int sr_session_device_add(struct sr_device *device)
131 sr_err("session: %s: device was NULL", __func__);
135 if (!device->plugin) {
136 sr_err("session: %s: device->plugin was NULL", __func__);
140 if (!device->plugin->opendev) {
141 sr_err("session: %s: device->plugin->opendev was NULL",
147 sr_err("session: %s: session was NULL", __func__);
148 return SR_ERR; /* TODO: SR_ERR_BUG? */
151 if ((ret = device->plugin->opendev(device->plugin_index)) != SR_OK) {
152 sr_err("session: %s: opendev failed (%d)", __func__, ret);
156 session->devices = g_slist_append(session->devices, device);
162 * Clear all datafeed callbacks in the current session.
166 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
168 int sr_session_datafeed_callback_clear(void)
171 sr_err("session: %s: session was NULL", __func__);
175 g_slist_free(session->datafeed_callbacks);
176 session->datafeed_callbacks = NULL;
182 * Add a datafeed callback to the current session.
184 * @param callback TODO.
185 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
187 int sr_session_datafeed_callback_add(sr_datafeed_callback callback)
190 sr_err("session: %s: session was NULL", __func__);
194 /* TODO: Is 'callback' allowed to be NULL? */
196 session->datafeed_callbacks =
197 g_slist_append(session->datafeed_callbacks, callback);
205 static int sr_session_run_poll(void)
207 GPollFD *fds, my_gpollfd;
211 while (session->running) {
215 /* Construct g_poll()'s array. */
216 /* TODO: Check malloc return value. */
217 fds = malloc(sizeof(GPollFD) * num_sources);
219 sr_err("session: %s: fds malloc failed", __func__);
220 return SR_ERR_MALLOC;
222 for (i = 0; i < num_sources; i++) {
224 g_io_channel_win32_make_pollfd(&channels[0],
225 sources[i].events, &my_gpollfd);
227 my_gpollfd.fd = sources[i].fd;
228 my_gpollfd.events = sources[i].events;
233 ret = g_poll(fds, num_sources, source_timeout);
235 for (i = 0; i < num_sources; i++) {
236 if (fds[i].revents > 0 || (ret == 0
237 && source_timeout == sources[i].timeout)) {
239 * Invoke the source's callback on an event,
240 * or if the poll timeout out and this source
241 * asked for that timeout.
243 if (!sources[i].cb(fds[i].fd, fds[i].revents,
244 sources[i].user_data))
245 sr_session_source_remove(sources[i].fd);
257 * There can only be one session at a time. TODO
259 * @return SR_OK upon success, SR_ERR upon errors.
261 int sr_session_start(void)
263 struct sr_device *device;
268 sr_err("session: %s: session was NULL; a session must be "
269 "created first, before starting it.", __func__);
270 return SR_ERR; /* TODO: SR_ERR_BUG? */
273 if (!session->devices) {
274 /* TODO: Actually the case? */
275 sr_err("session: %s: session->devices was NULL; a session "
276 "cannot be started without devices.", __func__);
277 return SR_ERR; /* TODO: SR_ERR_BUG? */
280 /* TODO: Check plugin_index validity? */
282 sr_info("session: starting");
284 for (l = session->devices; l; l = l->next) {
286 /* TODO: Check for device != NULL. */
287 if ((ret = device->plugin->start_acquisition(
288 device->plugin_index, device)) != SR_OK) {
289 sr_err("session: %s: could not start an acquisition "
290 "(%d)", __func__, ret);
295 /* TODO: What if there are multiple devices? Which return code? */
303 * TODO: Various error checks etc.
305 * @return SR_OK upon success, SR_ERR_BUG upon errors.
307 int sr_session_run(void)
310 sr_err("session: %s: session was NULL; a session must be "
311 "created first, before running it.", __func__);
315 if (!session->devices) {
316 /* TODO: Actually the case? */
317 sr_err("session: %s: session->devices was NULL; a session "
318 "cannot be run without devices.", __func__);
322 sr_info("session: running");
323 session->running = TRUE;
325 /* Do we have real sources? */
326 if (num_sources == 1 && sources[0].fd == -1) {
327 /* Dummy source, freewheel over it. */
328 while (session->running)
329 sources[0].cb(-1, 0, sources[0].user_data);
331 /* Real sources, use g_poll() main loop. */
332 sr_session_run_poll();
339 * Halt the current session.
343 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
345 int sr_session_halt(void)
348 sr_err("session: %s: session was NULL", __func__);
352 sr_info("session: halting");
353 session->running = FALSE;
359 * Stop the current session.
361 * TODO: Difference to halt?
363 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
365 int sr_session_stop(void)
367 struct sr_device *device;
371 sr_err("session: %s: session was NULL", __func__);
375 sr_info("session: stopping");
376 session->running = FALSE;
378 for (l = session->devices; l; l = l->next) {
380 /* Check for device != NULL. */
381 if (device->plugin && device->plugin->stop_acquisition)
382 device->plugin->stop_acquisition(device->plugin_index, device);
391 * TODO: Various error checks.
393 * @param packet TODO.
394 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
396 static int datafeed_dump(struct sr_datafeed_packet *packet)
398 struct sr_datafeed_logic *logic;
401 sr_err("session: %s: packet was NULL", __func__);
405 /* TODO: Validity checks for packet contents. */
407 switch (packet->type) {
409 sr_dbg("bus: received SR_DF_HEADER");
412 sr_dbg("bus: received SR_DF_TRIGGER at %lu ms",
413 packet->timeoffset / 1000000);
416 logic = packet->payload;
417 /* TODO: Check for logic != NULL. */
418 sr_dbg("bus: received SR_DF_LOGIC at %f ms duration %f ms, "
419 "%" PRIu64 " bytes", packet->timeoffset / 1000000.0,
420 packet->duration / 1000000.0, logic->length);
423 sr_dbg("bus: received SR_DF_END");
427 sr_err("bus: received unknown packet type %d", packet->type);
437 * @param device TODO.
438 * @param packet TODO.
439 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
441 int sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet)
444 sr_datafeed_callback cb;
447 sr_err("session: %s: device was NULL", __func__);
451 if (!device->plugin) {
452 sr_err("session: %s: device->plugin was NULL", __func__);
457 sr_err("session: %s: packet was NULL", __func__);
462 * TODO: Send packet through PD pipe, and send the output of that to
463 * the callbacks as well.
465 for (l = session->datafeed_callbacks; l; l = l->next) {
467 /* TODO: Check for cb != NULL. */
468 datafeed_dump(packet);
478 * TODO: Switch to g_try_malloc0() / g_free().
479 * TODO: More error checks etc.
482 * @param events TODO.
483 * @param timeout TODO.
484 * @param callback TODO.
485 * @param user_data TODO.
486 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
487 * SR_ERR_MALLOC upon memory allocation errors.
489 int sr_session_source_add(int fd, int events, int timeout,
490 sr_receive_data_callback callback, void *user_data)
492 struct source *new_sources, *s;
495 sr_err("session: %s: callback was NULL", __func__);
499 /* Note: user_data can be NULL, that's not a bug. */
501 new_sources = calloc(1, sizeof(struct source) * (num_sources + 1));
503 sr_err("session: %s: new_sources malloc failed", __func__);
504 return SR_ERR_MALLOC;
508 memcpy(new_sources, sources,
509 sizeof(struct source) * num_sources);
513 s = &new_sources[num_sources++];
516 s->timeout = timeout;
518 s->user_data = user_data;
519 sources = new_sources;
521 if (timeout != source_timeout && timeout > 0
522 && (source_timeout == -1 || timeout < source_timeout))
523 source_timeout = timeout;
529 * Remove the source belonging to the specified file descriptor.
531 * TODO: More error checks.
532 * TODO: Switch to g_try_malloc0() / g_free().
535 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
536 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
539 int sr_session_source_remove(int fd)
541 struct source *new_sources;
545 sr_err("session: %s: sources was NULL", __func__);
546 return SR_ERR_BUG; /* TODO: Other? */
549 /* TODO: Check if 'fd' valid. */
551 new_sources = calloc(1, sizeof(struct source) * num_sources);
553 sr_err("session: %s: new_sources malloc failed", __func__);
554 return SR_ERR_MALLOC;
557 for (old = 0, new = 0; old < num_sources; old++) {
558 if (sources[old].fd != fd)
559 memcpy(&new_sources[new++], &sources[old],
560 sizeof(struct source));
565 sources = new_sources;
568 /* Target fd was not found. */