2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode.h"
34 * @defgroup grp_session Session handling
36 * Starting and handling decoding sessions.
43 SRD_PRIV GSList *sessions = NULL;
44 SRD_PRIV int max_session_id = -1;
49 SRD_PRIV int session_is_valid(struct srd_session *sess)
52 if (!sess || sess->session_id < 1)
59 * Create a decoding session.
61 * A session holds all decoder instances, their stack relationships and
64 * @param sess A pointer which will hold a pointer to a newly
65 * initialized session on return.
67 * @return SRD_OK upon success, a (negative) error code otherwise.
71 SRD_API int srd_session_new(struct srd_session **sess)
75 srd_err("Invalid session pointer.");
79 if (!(*sess = g_try_malloc(sizeof(struct srd_session))))
80 return SRD_ERR_MALLOC;
81 (*sess)->session_id = ++max_session_id;
82 (*sess)->di_list = (*sess)->callbacks = NULL;
84 /* Keep a list of all sessions, so we can clean up as needed. */
85 sessions = g_slist_append(sessions, *sess);
87 srd_dbg("Created session %d.", (*sess)->session_id);
93 * Start a decoding session.
95 * Decoders, instances and stack must have been prepared beforehand,
96 * and all SRD_CONF parameters set.
98 * @param sess The session to start.
100 * @return SRD_OK upon success, a (negative) error code otherwise.
104 SRD_API int srd_session_start(struct srd_session *sess)
107 struct srd_decoder_inst *di;
110 if (session_is_valid(sess) != SRD_OK) {
111 srd_err("Invalid session pointer.");
115 srd_dbg("Calling start() on all instances in session %d.", sess->session_id);
117 /* Run the start() method on all decoders receiving frontend data. */
119 for (d = sess->di_list; d; d = d->next) {
121 if ((ret = srd_inst_start(di)) != SRD_OK)
128 static int srd_inst_send_meta(struct srd_decoder_inst *di, int key,
133 if (key != SRD_CONF_SAMPLERATE)
134 /* This is the only key we pass on to the decoder for now. */
137 if (!PyObject_HasAttrString(di->py_inst, "metadata"))
138 /* This decoder doesn't want metadata, that's fine. */
141 py_ret = PyObject_CallMethod(di->py_inst, "metadata", "lK",
142 (long)SRD_CONF_SAMPLERATE,
143 (unsigned long long)g_variant_get_uint64(data));
150 * Set a metadata configuration key in a session.
152 * @param sess The session to configure.
153 * @param key The configuration key (SRD_CONF_*).
154 * @param data The new value for the key, as a GVariant with GVariantType
155 * appropriate to that key. A floating reference can be passed
156 * in; its refcount will be sunk and unreferenced after use.
158 * @return SRD_OK upon success, a (negative) error code otherwise.
162 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
168 if (session_is_valid(sess) != SRD_OK) {
169 srd_err("Invalid session.");
174 srd_err("Invalid key.");
179 srd_err("Invalid value.");
183 /* Hardcoded to samplerate/uint64 for now. */
185 if (key != SRD_CONF_SAMPLERATE) {
186 srd_err("Unknown config key %d.", key);
189 if (!g_variant_is_of_type(data, G_VARIANT_TYPE_UINT64)) {
190 srd_err("Invalid value type: expected uint64, got %s",
191 g_variant_get_type_string(data));
195 srd_dbg("Setting session %d samplerate to %"PRIu64".",
196 sess->session_id, g_variant_get_uint64(data));
199 for (l = sess->di_list; l; l = l->next) {
200 if ((ret = srd_inst_send_meta(l->data, key, data)) != SRD_OK)
204 g_variant_unref(data);
210 * Send a chunk of logic sample data to a running decoder session.
212 * If no channel map has been set up, the logic samples must be arranged
213 * in channel order, in the least amount of space possible. The default
214 * channel set consists of all required channels + all optional channels.
216 * The size of a sample in inbuf is the unit size passed to
217 * srd_inst_channel_set_all(). If no channel map has been configured, it is
218 * the minimum number of bytes needed to store the default channels.
220 * @param sess The session to use.
221 * @param start_samplenum The sample number of the first sample in this chunk.
222 * @param end_samplenum The sample number of the last sample in this chunk.
223 * @param inbuf Pointer to sample data.
224 * @param inbuflen Length in bytes of the buffer.
226 * @return SRD_OK upon success, a (negative) error code otherwise.
230 SRD_API int srd_session_send(struct srd_session *sess,
231 uint64_t start_samplenum, uint64_t end_samplenum,
232 const uint8_t *inbuf, uint64_t inbuflen)
237 if (session_is_valid(sess) != SRD_OK) {
238 srd_err("Invalid session.");
242 srd_dbg("Calling decode() on all instances with starting sample "
243 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
244 start_samplenum, inbuflen, inbuf);
246 for (d = sess->di_list; d; d = d->next) {
247 if ((ret = srd_inst_decode(d->data, start_samplenum,
248 end_samplenum, inbuf, inbuflen)) != SRD_OK)
256 * Destroy a decoding session.
258 * All decoder instances and output callbacks are properly released.
260 * @param sess The session to be destroyed.
262 * @return SRD_OK upon success, a (negative) error code otherwise.
266 SRD_API int srd_session_destroy(struct srd_session *sess)
271 srd_err("Invalid session.");
275 session_id = sess->session_id;
277 srd_inst_free_all(sess, NULL);
279 g_slist_free_full(sess->callbacks, g_free);
280 sessions = g_slist_remove(sessions, sess);
283 srd_dbg("Destroyed session %d.", session_id);
289 * Register/add a decoder output callback function.
291 * The function will be called when a protocol decoder sends output back
292 * to the PD controller (except for Python objects, which only go up the
295 * @param sess The output session in which to register the callback.
296 * @param output_type The output type this callback will receive. Only one
297 * callback per output type can be registered.
298 * @param cb The function to call. Must not be NULL.
299 * @param cb_data Private data for the callback function. Can be NULL.
303 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
304 int output_type, srd_pd_output_callback cb, void *cb_data)
306 struct srd_pd_callback *pd_cb;
308 if (session_is_valid(sess) != SRD_OK) {
309 srd_err("Invalid session.");
313 srd_dbg("Registering new callback for output type %d.", output_type);
315 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
316 srd_err("Failed to g_malloc() struct srd_pd_callback.");
317 return SRD_ERR_MALLOC;
320 pd_cb->output_type = output_type;
322 pd_cb->cb_data = cb_data;
323 sess->callbacks = g_slist_append(sess->callbacks, pd_cb);
329 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(
330 struct srd_session *sess, int output_type)
333 struct srd_pd_callback *tmp, *pd_cb;
335 if (session_is_valid(sess) != SRD_OK) {
336 srd_err("Invalid session.");
341 for (l = sess->callbacks; l; l = l->next) {
343 if (tmp->output_type == output_type) {