2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 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/>.
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
28 /* Message logging helpers with driver-specific prefix string. */
29 #define DRIVER_LOG_DOMAIN "session: "
30 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
31 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
32 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
33 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
34 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
35 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
40 * Creating, using, or destroying libsigrok sessions.
44 * @defgroup grp_session Session handling
46 * Creating, using, or destroying libsigrok sessions.
53 sr_receive_data_callback_t cb;
56 /* This is used to keep track of the object (fd, pollfd or channel) which is
57 * being polled and will be used to match the source when removing it again.
62 /* There can only be one session at a time. */
63 /* 'session' is not static, it's used elsewhere (via 'extern'). */
64 struct sr_session *session;
67 * Create a new session.
69 * @todo Should it use the file-global "session" variable or take an argument?
70 * The same question applies to all the other session functions.
72 * @return A pointer to the newly allocated session, or NULL upon errors.
74 SR_API struct sr_session *sr_session_new(void)
76 if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
77 sr_err("Session malloc failed.");
81 session->source_timeout = -1;
82 session->abort_session = FALSE;
83 g_mutex_init(&session->stop_mutex);
89 * Destroy the current session.
91 * This frees up all memory used by the session.
93 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
95 SR_API int sr_session_destroy(void)
98 sr_err("%s: session was NULL", __func__);
102 sr_session_dev_remove_all();
104 /* TODO: Error checks needed? */
106 g_mutex_clear(&session->stop_mutex);
115 * Close a device instance.
117 * @param sdi The device instance to close. Must not be NULL. Also,
118 * sdi->driver, sdi->driver->priv, and sdi->priv must not be NULL.
120 static void sr_dev_close(struct sr_dev_inst *sdi)
125 sr_err("Invalid device instance, can't close device.");
129 /* In the drivers sdi->priv is a 'struct dev_context *devc'. */
132 * Should be sr_err() in theory, but the 'demo' driver has
133 * NULL for sdi->priv, so we use sr_dbg() until that's fixed.
135 sr_dbg("Invalid device context, can't close device.");
140 sr_err("Invalid driver, can't close device.");
144 if (!sdi->driver->priv) {
145 sr_err("Driver not initialized, can't close device.");
149 sr_spew("Closing '%s' device instance %d.", sdi->driver->name,
152 if ((ret = sdi->driver->dev_close(sdi)) < 0)
153 sr_err("Failed to close device instance: %d.", ret);
157 * Remove all the devices from the current session.
159 * The session itself (i.e., the struct sr_session) is not free'd and still
160 * exists after this function returns.
162 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
164 SR_API int sr_session_dev_remove_all(void)
167 sr_err("%s: session was NULL", __func__);
171 g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close);
172 session->devs = NULL;
178 * Add a device instance to the current session.
180 * @param sdi The device instance to add to the current session. Must not
181 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
184 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
186 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
191 sr_err("%s: sdi was NULL", __func__);
196 sr_err("%s: session was NULL", __func__);
200 /* If sdi->driver is NULL, this is a virtual device. */
202 sr_dbg("%s: sdi->driver was NULL, this seems to be "
203 "a virtual device; continuing", __func__);
204 /* Just add the device, don't run dev_open(). */
205 session->devs = g_slist_append(session->devs, (gpointer)sdi);
209 /* sdi->driver is non-NULL (i.e. we have a real device). */
210 if (!sdi->driver->dev_open) {
211 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
215 if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != SR_OK) {
216 sr_err("%s: dev_open failed (%d)", __func__, ret);
220 session->devs = g_slist_append(session->devs, (gpointer)sdi);
226 * Remove all datafeed callbacks in the current session.
228 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
230 SR_API int sr_session_datafeed_callback_remove_all(void)
233 sr_err("%s: session was NULL", __func__);
237 g_slist_free(session->datafeed_callbacks);
238 session->datafeed_callbacks = NULL;
244 * Add a datafeed callback to the current session.
246 * @param cb Function to call when a chunk of data is received.
249 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
251 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
254 sr_err("%s: session was NULL", __func__);
259 sr_err("%s: cb was NULL", __func__);
263 session->datafeed_callbacks =
264 g_slist_append(session->datafeed_callbacks, cb);
269 static int sr_session_run_poll(void)
274 while (session->num_sources > 0) {
275 ret = g_poll(session->pollfds, session->num_sources,
276 session->source_timeout);
277 for (i = 0; i < session->num_sources; i++) {
278 if (session->pollfds[i].revents > 0 || (ret == 0
279 && session->source_timeout == session->sources[i].timeout)) {
281 * Invoke the source's callback on an event,
282 * or if the poll timed out and this source
283 * asked for that timeout.
285 if (!session->sources[i].cb(session->pollfds[i].fd,
286 session->pollfds[i].revents,
287 session->sources[i].cb_data))
288 sr_session_source_remove(session->sources[i].poll_object);
291 * We want to take as little time as possible to stop
292 * the session if we have been told to do so. Therefore,
293 * we check the flag after processing every source, not
294 * just once per main event loop.
296 g_mutex_lock(&session->stop_mutex);
297 if (session->abort_session)
298 sr_session_stop_sync();
299 g_mutex_unlock(&session->stop_mutex);
309 * There can only be one session at a time.
311 * @return SR_OK upon success, SR_ERR upon errors.
313 SR_API int sr_session_start(void)
315 struct sr_dev_inst *sdi;
320 sr_err("%s: session was NULL; a session must be "
321 "created before starting it.", __func__);
325 if (!session->devs) {
326 sr_err("%s: session->devs was NULL; a session "
327 "cannot be started without devices.", __func__);
331 sr_info("Starting.");
334 for (l = session->devs; l; l = l->next) {
336 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
337 sr_err("%s: could not start an acquisition "
338 "(%d)", __func__, ret);
343 /* TODO: What if there are multiple devices? Which return code? */
351 * @return SR_OK upon success, SR_ERR_BUG upon errors.
353 SR_API int sr_session_run(void)
356 sr_err("%s: session was NULL; a session must be "
357 "created first, before running it.", __func__);
361 if (!session->devs) {
362 /* TODO: Actually the case? */
363 sr_err("%s: session->devs was NULL; a session "
364 "cannot be run without devices.", __func__);
370 /* Do we have real sources? */
371 if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
372 /* Dummy source, freewheel over it. */
373 while (session->num_sources)
374 session->sources[0].cb(-1, 0, session->sources[0].cb_data);
376 /* Real sources, use g_poll() main loop. */
377 sr_session_run_poll();
384 * Stop the current session.
386 * The current session is stopped immediately, with all acquisition sessions
387 * being stopped and hardware drivers cleaned up.
389 * This must be called from within the session thread, to prevent freeing
390 * resources that the session thread will try to use.
392 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
394 SR_PRIV int sr_session_stop_sync(void)
396 struct sr_dev_inst *sdi;
400 sr_err("%s: session was NULL", __func__);
404 sr_info("Stopping.");
406 for (l = session->devs; l; l = l->next) {
409 if (sdi->driver->dev_acquisition_stop)
410 sdi->driver->dev_acquisition_stop(sdi, sdi);
415 * Some sources may not be necessarily associated with a device.
416 * Those sources may still be present even after stopping all devices.
417 * We need to make sure all sources are removed, or we risk running the
418 * session in an infinite loop.
420 while (session->num_sources)
421 sr_session_source_remove(session->sources[0].poll_object);
427 * Stop the current session.
429 * The current session is stopped immediately, with all acquisition sessions
430 * being stopped and hardware drivers cleaned up.
432 * If the session is run in a separate thread, this function will not block
433 * until the session is finished executing. It is the caller's responsibility
434 * to wait for the session thread to return before assuming that the session is
435 * completely decommissioned.
437 * @return SR_OK upon success, SR_ERR_BUG if no session exists.
439 SR_API int sr_session_stop(void)
442 sr_err("%s: session was NULL", __func__);
446 g_mutex_lock(&session->stop_mutex);
447 session->abort_session = TRUE;
448 g_mutex_unlock(&session->stop_mutex);
456 * @param packet The packet to show debugging information for.
458 static void datafeed_dump(const struct sr_datafeed_packet *packet)
460 const struct sr_datafeed_logic *logic;
461 const struct sr_datafeed_analog *analog;
463 switch (packet->type) {
465 sr_dbg("bus: Received SR_DF_HEADER packet.");
468 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
471 sr_dbg("bus: Received SR_DF_META packet.");
474 logic = packet->payload;
475 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes).",
479 analog = packet->payload;
480 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
481 analog->num_samples);
484 sr_dbg("bus: Received SR_DF_END packet.");
486 case SR_DF_FRAME_BEGIN:
487 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
489 case SR_DF_FRAME_END:
490 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
493 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
499 * Send a packet to whatever is listening on the datafeed bus.
501 * Hardware drivers use this to send a data packet to the frontend.
504 * @param packet The datafeed packet to send to the session bus.
506 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
510 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
511 const struct sr_datafeed_packet *packet)
514 sr_datafeed_callback_t cb;
517 sr_err("%s: sdi was NULL", __func__);
522 sr_err("%s: packet was NULL", __func__);
526 for (l = session->datafeed_callbacks; l; l = l->next) {
527 if (sr_log_loglevel_get() >= SR_LOG_DBG)
528 datafeed_dump(packet);
537 * Add an event source for a file descriptor.
539 * @param pollfd The GPollFD.
540 * @param timeout Max time to wait before the callback is called, ignored if 0.
541 * @param cb Callback function to add. Must not be NULL.
542 * @param cb_data Data for the callback function. Can be NULL.
543 * @param poll_object TODO.
545 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
546 * SR_ERR_MALLOC upon memory allocation errors.
548 static int _sr_session_source_add(GPollFD *pollfd, int timeout,
549 sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
551 struct source *new_sources, *s;
552 GPollFD *new_pollfds;
555 sr_err("%s: cb was NULL", __func__);
559 /* Note: cb_data can be NULL, that's not a bug. */
561 new_pollfds = g_try_realloc(session->pollfds,
562 sizeof(GPollFD) * (session->num_sources + 1));
564 sr_err("%s: new_pollfds malloc failed", __func__);
565 return SR_ERR_MALLOC;
568 new_sources = g_try_realloc(session->sources, sizeof(struct source) *
569 (session->num_sources + 1));
571 sr_err("%s: new_sources malloc failed", __func__);
572 return SR_ERR_MALLOC;
575 new_pollfds[session->num_sources] = *pollfd;
576 s = &new_sources[session->num_sources++];
577 s->timeout = timeout;
579 s->cb_data = cb_data;
580 s->poll_object = poll_object;
581 session->pollfds = new_pollfds;
582 session->sources = new_sources;
584 if (timeout != session->source_timeout && timeout > 0
585 && (session->source_timeout == -1 || timeout < session->source_timeout))
586 session->source_timeout = timeout;
592 * Add an event source for a file descriptor.
594 * @param fd The file descriptor.
595 * @param events Events to check for.
596 * @param timeout Max time to wait before the callback is called, ignored if 0.
597 * @param cb Callback function to add. Must not be NULL.
598 * @param cb_data Data for the callback function. Can be NULL.
600 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
601 * SR_ERR_MALLOC upon memory allocation errors.
603 SR_API int sr_session_source_add(int fd, int events, int timeout,
604 sr_receive_data_callback_t cb, void *cb_data)
611 return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
615 * Add an event source for a GPollFD.
617 * @param pollfd The GPollFD.
618 * @param timeout Max time to wait before the callback is called, ignored if 0.
619 * @param cb Callback function to add. Must not be NULL.
620 * @param cb_data Data for the callback function. Can be NULL.
622 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
623 * SR_ERR_MALLOC upon memory allocation errors.
625 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
626 sr_receive_data_callback_t cb, void *cb_data)
628 return _sr_session_source_add(pollfd, timeout, cb,
629 cb_data, (gintptr)pollfd);
633 * Add an event source for a GIOChannel.
635 * @param channel The GIOChannel.
636 * @param events Events to poll on.
637 * @param timeout Max time to wait before the callback is called, ignored if 0.
638 * @param cb Callback function to add. Must not be NULL.
639 * @param cb_data Data for the callback function. Can be NULL.
641 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
642 * SR_ERR_MALLOC upon memory allocation errors.
644 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
645 int timeout, sr_receive_data_callback_t cb, void *cb_data)
650 g_io_channel_win32_make_pollfd(channel, events, &p);
652 p.fd = g_io_channel_unix_get_fd(channel);
656 return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
660 * Remove the source belonging to the specified channel.
662 * @todo Add more error checks and logging.
664 * @param channel The channel for which the source should be removed.
666 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
667 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
670 static int _sr_session_source_remove(gintptr poll_object)
672 struct source *new_sources;
673 GPollFD *new_pollfds;
676 if (!session->sources || !session->num_sources) {
677 sr_err("%s: sources was NULL", __func__);
681 for (old = 0; old < session->num_sources; old++) {
682 if (session->sources[old].poll_object == poll_object)
686 /* fd not found, nothing to do */
687 if (old == session->num_sources)
690 session->num_sources -= 1;
692 if (old != session->num_sources) {
693 memmove(&session->pollfds[old], &session->pollfds[old+1],
694 (session->num_sources - old) * sizeof(GPollFD));
695 memmove(&session->sources[old], &session->sources[old+1],
696 (session->num_sources - old) * sizeof(struct source));
699 new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
700 if (!new_pollfds && session->num_sources > 0) {
701 sr_err("%s: new_pollfds malloc failed", __func__);
702 return SR_ERR_MALLOC;
705 new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources);
706 if (!new_sources && session->num_sources > 0) {
707 sr_err("%s: new_sources malloc failed", __func__);
708 return SR_ERR_MALLOC;
711 session->pollfds = new_pollfds;
712 session->sources = new_sources;
718 * Remove the source belonging to the specified file descriptor.
720 * @param fd The file descriptor for which the source should be removed.
722 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
723 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
726 SR_API int sr_session_source_remove(int fd)
728 return _sr_session_source_remove((gintptr)fd);
732 * Remove the source belonging to the specified poll descriptor.
734 * @param pollfd The poll descriptor for which the source should be removed.
736 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
737 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
740 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
742 return _sr_session_source_remove((gintptr)pollfd);
746 * Remove the source belonging to the specified channel.
748 * @param channel The channel for which the source should be removed.
750 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
751 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
754 SR_API int sr_session_source_remove_channel(GIOChannel *channel)
756 return _sr_session_source_remove((gintptr)channel);