]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> | |
5 | * | |
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> | |
24 | #include <glib.h> | |
25 | #include "sigrok.h" | |
26 | #include "sigrok-internal.h" | |
27 | ||
28 | /* demo.c. TODO: Should not be global! */ | |
29 | extern SR_PRIV GIOChannel channels[2]; | |
30 | ||
31 | struct source { | |
32 | int fd; | |
33 | int events; | |
34 | int timeout; | |
35 | sr_receive_data_callback_t cb; | |
36 | void *cb_data; | |
37 | }; | |
38 | ||
39 | /* There can only be one session at a time. */ | |
40 | /* 'session' is not static, it's used elsewhere (via 'extern'). */ | |
41 | struct sr_session *session; | |
42 | static int num_sources = 0; | |
43 | ||
44 | static struct source *sources = NULL; | |
45 | static int source_timeout = -1; | |
46 | ||
47 | /** | |
48 | * Create a new session. | |
49 | * | |
50 | * TODO: Should it use the file-global "session" variable or take an argument? | |
51 | * The same question applies to all the other session functions. | |
52 | * | |
53 | * @return A pointer to the newly allocated session, or NULL upon errors. | |
54 | */ | |
55 | SR_API struct sr_session *sr_session_new(void) | |
56 | { | |
57 | if (!(session = g_try_malloc0(sizeof(struct sr_session)))) { | |
58 | sr_err("session: %s: session malloc failed", __func__); | |
59 | return NULL; /* TODO: SR_ERR_MALLOC? */ | |
60 | } | |
61 | ||
62 | return session; | |
63 | } | |
64 | ||
65 | /** | |
66 | * Destroy the current session. | |
67 | * | |
68 | * This frees up all memory used by the session. | |
69 | * | |
70 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
71 | */ | |
72 | SR_API int sr_session_destroy(void) | |
73 | { | |
74 | if (!session) { | |
75 | sr_err("session: %s: session was NULL", __func__); | |
76 | return SR_ERR_BUG; | |
77 | } | |
78 | ||
79 | g_slist_free(session->devs); | |
80 | session->devs = NULL; | |
81 | ||
82 | /* TODO: Error checks needed? */ | |
83 | ||
84 | /* TODO: Loop over protocol decoders and free them. */ | |
85 | ||
86 | g_free(session); | |
87 | session = NULL; | |
88 | ||
89 | return SR_OK; | |
90 | } | |
91 | ||
92 | /** | |
93 | * Remove all the devices from the current session. TODO? | |
94 | * | |
95 | * The session itself (i.e., the struct sr_session) is not free'd and still | |
96 | * exists after this function returns. | |
97 | * | |
98 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
99 | */ | |
100 | SR_API int sr_session_dev_clear(void) | |
101 | { | |
102 | if (!session) { | |
103 | sr_err("session: %s: session was NULL", __func__); | |
104 | return SR_ERR_BUG; | |
105 | } | |
106 | ||
107 | g_slist_free(session->devs); | |
108 | session->devs = NULL; | |
109 | ||
110 | return SR_OK; | |
111 | } | |
112 | ||
113 | /** | |
114 | * Add a device to the current session. | |
115 | * | |
116 | * @param dev The device to add to the current session. Must not be NULL. | |
117 | * Also, dev->driver and dev->driver->dev_open must not be NULL. | |
118 | * | |
119 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. | |
120 | */ | |
121 | SR_API int sr_session_dev_add(struct sr_dev *dev) | |
122 | { | |
123 | int ret; | |
124 | ||
125 | if (!dev) { | |
126 | sr_err("session: %s: dev was NULL", __func__); | |
127 | return SR_ERR_ARG; | |
128 | } | |
129 | ||
130 | if (!dev->driver) { | |
131 | sr_err("session: %s: dev->driver was NULL", __func__); | |
132 | return SR_ERR_ARG; | |
133 | } | |
134 | ||
135 | if (!dev->driver->dev_open) { | |
136 | sr_err("session: %s: dev->driver->dev_open was NULL", | |
137 | __func__); | |
138 | return SR_ERR_ARG; | |
139 | } | |
140 | ||
141 | if (!session) { | |
142 | sr_err("session: %s: session was NULL", __func__); | |
143 | return SR_ERR_BUG; | |
144 | } | |
145 | ||
146 | if ((ret = dev->driver->dev_open(dev->driver_index)) != SR_OK) { | |
147 | sr_err("session: %s: dev_open failed (%d)", __func__, ret); | |
148 | return ret; | |
149 | } | |
150 | ||
151 | session->devs = g_slist_append(session->devs, dev); | |
152 | ||
153 | return SR_OK; | |
154 | } | |
155 | ||
156 | /** | |
157 | * Clear all datafeed callbacks in the current session. | |
158 | * | |
159 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
160 | */ | |
161 | SR_API int sr_session_datafeed_callback_clear(void) | |
162 | { | |
163 | if (!session) { | |
164 | sr_err("session: %s: session was NULL", __func__); | |
165 | return SR_ERR_BUG; | |
166 | } | |
167 | ||
168 | g_slist_free(session->datafeed_callbacks); | |
169 | session->datafeed_callbacks = NULL; | |
170 | ||
171 | return SR_OK; | |
172 | } | |
173 | ||
174 | /** | |
175 | * Add a datafeed callback to the current session. | |
176 | * | |
177 | * @param cb Function to call when a chunk of data is received. | |
178 | * Must not be NULL. | |
179 | * | |
180 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
181 | */ | |
182 | SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb) | |
183 | { | |
184 | if (!session) { | |
185 | sr_err("session: %s: session was NULL", __func__); | |
186 | return SR_ERR_BUG; | |
187 | } | |
188 | ||
189 | if (!cb) { | |
190 | sr_err("session: %s: cb was NULL", __func__); | |
191 | return SR_ERR_ARG; | |
192 | } | |
193 | ||
194 | session->datafeed_callbacks = | |
195 | g_slist_append(session->datafeed_callbacks, cb); | |
196 | ||
197 | return SR_OK; | |
198 | } | |
199 | ||
200 | /** | |
201 | * TODO. | |
202 | */ | |
203 | static int sr_session_run_poll(void) | |
204 | { | |
205 | GPollFD *fds, my_gpollfd; | |
206 | int ret, i; | |
207 | ||
208 | fds = NULL; | |
209 | while (session->running) { | |
210 | /* TODO: Add comment. */ | |
211 | g_free(fds); | |
212 | ||
213 | /* Construct g_poll()'s array. */ | |
214 | if (!(fds = g_try_malloc(sizeof(GPollFD) * num_sources))) { | |
215 | sr_err("session: %s: fds malloc failed", __func__); | |
216 | return SR_ERR_MALLOC; | |
217 | } | |
218 | for (i = 0; i < num_sources; i++) { | |
219 | #ifdef _WIN32 | |
220 | g_io_channel_win32_make_pollfd(&channels[0], | |
221 | sources[i].events, &my_gpollfd); | |
222 | #else | |
223 | my_gpollfd.fd = sources[i].fd; | |
224 | my_gpollfd.events = sources[i].events; | |
225 | fds[i] = my_gpollfd; | |
226 | #endif | |
227 | } | |
228 | ||
229 | ret = g_poll(fds, num_sources, source_timeout); | |
230 | ||
231 | for (i = 0; i < num_sources; i++) { | |
232 | if (fds[i].revents > 0 || (ret == 0 | |
233 | && source_timeout == sources[i].timeout)) { | |
234 | /* | |
235 | * Invoke the source's callback on an event, | |
236 | * or if the poll timeout out and this source | |
237 | * asked for that timeout. | |
238 | */ | |
239 | if (!sources[i].cb(fds[i].fd, fds[i].revents, | |
240 | sources[i].cb_data)) | |
241 | sr_session_source_remove(sources[i].fd); | |
242 | } | |
243 | } | |
244 | } | |
245 | g_free(fds); | |
246 | ||
247 | return SR_OK; | |
248 | } | |
249 | ||
250 | /** | |
251 | * Start a session. | |
252 | * | |
253 | * There can only be one session at a time. | |
254 | * | |
255 | * @return SR_OK upon success, SR_ERR upon errors. | |
256 | */ | |
257 | SR_API int sr_session_start(void) | |
258 | { | |
259 | struct sr_dev *dev; | |
260 | GSList *l; | |
261 | int ret; | |
262 | ||
263 | if (!session) { | |
264 | sr_err("session: %s: session was NULL; a session must be " | |
265 | "created first, before starting it.", __func__); | |
266 | return SR_ERR_BUG; | |
267 | } | |
268 | ||
269 | if (!session->devs) { | |
270 | /* TODO: Actually the case? */ | |
271 | sr_err("session: %s: session->devs was NULL; a session " | |
272 | "cannot be started without devices.", __func__); | |
273 | return SR_ERR_BUG; | |
274 | } | |
275 | ||
276 | /* TODO: Check driver_index validity? */ | |
277 | ||
278 | sr_info("session: starting"); | |
279 | ||
280 | for (l = session->devs; l; l = l->next) { | |
281 | dev = l->data; | |
282 | /* TODO: Check for dev != NULL. */ | |
283 | if ((ret = dev->driver->dev_acquisition_start( | |
284 | dev->driver_index, dev)) != SR_OK) { | |
285 | sr_err("session: %s: could not start an acquisition " | |
286 | "(%d)", __func__, ret); | |
287 | break; | |
288 | } | |
289 | } | |
290 | ||
291 | /* TODO: What if there are multiple devices? Which return code? */ | |
292 | ||
293 | return ret; | |
294 | } | |
295 | ||
296 | /** | |
297 | * Run the session. | |
298 | * | |
299 | * TODO: Various error checks etc. | |
300 | * | |
301 | * @return SR_OK upon success, SR_ERR_BUG upon errors. | |
302 | */ | |
303 | SR_API int sr_session_run(void) | |
304 | { | |
305 | if (!session) { | |
306 | sr_err("session: %s: session was NULL; a session must be " | |
307 | "created first, before running it.", __func__); | |
308 | return SR_ERR_BUG; | |
309 | } | |
310 | ||
311 | if (!session->devs) { | |
312 | /* TODO: Actually the case? */ | |
313 | sr_err("session: %s: session->devs was NULL; a session " | |
314 | "cannot be run without devices.", __func__); | |
315 | return SR_ERR_BUG; | |
316 | } | |
317 | ||
318 | sr_info("session: running"); | |
319 | session->running = TRUE; | |
320 | ||
321 | /* Do we have real sources? */ | |
322 | if (num_sources == 1 && sources[0].fd == -1) { | |
323 | /* Dummy source, freewheel over it. */ | |
324 | while (session->running) | |
325 | sources[0].cb(-1, 0, sources[0].cb_data); | |
326 | } else { | |
327 | /* Real sources, use g_poll() main loop. */ | |
328 | sr_session_run_poll(); | |
329 | } | |
330 | ||
331 | return SR_OK; | |
332 | } | |
333 | ||
334 | /** | |
335 | * Halt the current session. | |
336 | * | |
337 | * This requests the current session be stopped as soon as possible, for | |
338 | * example on receiving an SR_DF_END packet. | |
339 | * | |
340 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
341 | */ | |
342 | SR_API int sr_session_halt(void) | |
343 | { | |
344 | if (!session) { | |
345 | sr_err("session: %s: session was NULL", __func__); | |
346 | return SR_ERR_BUG; | |
347 | } | |
348 | ||
349 | sr_info("session: halting"); | |
350 | session->running = FALSE; | |
351 | ||
352 | return SR_OK; | |
353 | } | |
354 | ||
355 | /** | |
356 | * Stop the current session. | |
357 | * | |
358 | * The current session is stopped immediately, with all acquisition sessions | |
359 | * being stopped and hardware drivers cleaned up. | |
360 | * | |
361 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
362 | */ | |
363 | SR_API int sr_session_stop(void) | |
364 | { | |
365 | struct sr_dev *dev; | |
366 | GSList *l; | |
367 | ||
368 | if (!session) { | |
369 | sr_err("session: %s: session was NULL", __func__); | |
370 | return SR_ERR_BUG; | |
371 | } | |
372 | ||
373 | sr_info("session: stopping"); | |
374 | session->running = FALSE; | |
375 | ||
376 | for (l = session->devs; l; l = l->next) { | |
377 | dev = l->data; | |
378 | /* Check for dev != NULL. */ | |
379 | if (dev->driver) { | |
380 | if (dev->driver->dev_acquisition_stop) | |
381 | dev->driver->dev_acquisition_stop(dev->driver_index, dev); | |
382 | if (dev->driver->cleanup) | |
383 | dev->driver->cleanup(); | |
384 | } | |
385 | } | |
386 | ||
387 | return SR_OK; | |
388 | } | |
389 | ||
390 | /** | |
391 | * Debug helper. | |
392 | * | |
393 | * @param packet The packet to show debugging information for. | |
394 | */ | |
395 | static void datafeed_dump(struct sr_datafeed_packet *packet) | |
396 | { | |
397 | struct sr_datafeed_logic *logic; | |
398 | ||
399 | switch (packet->type) { | |
400 | case SR_DF_HEADER: | |
401 | sr_dbg("bus: received SR_DF_HEADER"); | |
402 | break; | |
403 | case SR_DF_TRIGGER: | |
404 | sr_dbg("bus: received SR_DF_TRIGGER"); | |
405 | break; | |
406 | case SR_DF_LOGIC: | |
407 | logic = packet->payload; | |
408 | /* TODO: Check for logic != NULL. */ | |
409 | sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length); | |
410 | break; | |
411 | case SR_DF_END: | |
412 | sr_dbg("bus: received SR_DF_END"); | |
413 | break; | |
414 | default: | |
415 | sr_dbg("bus: received unknown packet type %d", packet->type); | |
416 | break; | |
417 | } | |
418 | } | |
419 | ||
420 | /** | |
421 | * Send a packet to whatever is listening on the datafeed bus. | |
422 | * | |
423 | * Hardware drivers use this to send a data packet to the frontend. | |
424 | * | |
425 | * @param dev TODO. | |
426 | * @param packet The datafeed packet to send to the session bus. | |
427 | * | |
428 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. | |
429 | */ | |
430 | SR_PRIV int sr_session_send(struct sr_dev *dev, | |
431 | struct sr_datafeed_packet *packet) | |
432 | { | |
433 | GSList *l; | |
434 | sr_datafeed_callback_t cb; | |
435 | ||
436 | if (!dev) { | |
437 | sr_err("session: %s: dev was NULL", __func__); | |
438 | return SR_ERR_ARG; | |
439 | } | |
440 | ||
441 | if (!dev->driver) { | |
442 | sr_err("session: %s: dev->driver was NULL", __func__); | |
443 | return SR_ERR_ARG; | |
444 | } | |
445 | ||
446 | if (!packet) { | |
447 | sr_err("session: %s: packet was NULL", __func__); | |
448 | return SR_ERR_ARG; | |
449 | } | |
450 | ||
451 | for (l = session->datafeed_callbacks; l; l = l->next) { | |
452 | if (sr_log_loglevel_get() >= SR_LOG_DBG) | |
453 | datafeed_dump(packet); | |
454 | cb = l->data; | |
455 | /* TODO: Check for cb != NULL. */ | |
456 | cb(dev, packet); | |
457 | } | |
458 | ||
459 | return SR_OK; | |
460 | } | |
461 | ||
462 | /** | |
463 | * TODO. | |
464 | * | |
465 | * TODO: More error checks etc. | |
466 | * | |
467 | * @param fd TODO. | |
468 | * @param events TODO. | |
469 | * @param timeout TODO. | |
470 | * @param cb Callback function to add. Must not be NULL. | |
471 | * @param cb_data Data for the callback function. Can be NULL. | |
472 | * | |
473 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
474 | * SR_ERR_MALLOC upon memory allocation errors. | |
475 | */ | |
476 | SR_API int sr_session_source_add(int fd, int events, int timeout, | |
477 | sr_receive_data_callback_t cb, void *cb_data) | |
478 | { | |
479 | struct source *new_sources, *s; | |
480 | ||
481 | if (!cb) { | |
482 | sr_err("session: %s: cb was NULL", __func__); | |
483 | return SR_ERR_ARG; | |
484 | } | |
485 | ||
486 | /* Note: cb_data can be NULL, that's not a bug. */ | |
487 | ||
488 | new_sources = g_try_malloc0(sizeof(struct source) * (num_sources + 1)); | |
489 | if (!new_sources) { | |
490 | sr_err("session: %s: new_sources malloc failed", __func__); | |
491 | return SR_ERR_MALLOC; | |
492 | } | |
493 | ||
494 | if (sources) { | |
495 | memcpy(new_sources, sources, | |
496 | sizeof(struct source) * num_sources); | |
497 | g_free(sources); | |
498 | } | |
499 | ||
500 | s = &new_sources[num_sources++]; | |
501 | s->fd = fd; | |
502 | s->events = events; | |
503 | s->timeout = timeout; | |
504 | s->cb = cb; | |
505 | s->cb_data = cb_data; | |
506 | sources = new_sources; | |
507 | ||
508 | if (timeout != source_timeout && timeout > 0 | |
509 | && (source_timeout == -1 || timeout < source_timeout)) | |
510 | source_timeout = timeout; | |
511 | ||
512 | return SR_OK; | |
513 | } | |
514 | ||
515 | /** | |
516 | * Remove the source belonging to the specified file descriptor. | |
517 | * | |
518 | * TODO: More error checks. | |
519 | * | |
520 | * @param fd TODO. | |
521 | * | |
522 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
523 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
524 | * internal errors. | |
525 | */ | |
526 | SR_API int sr_session_source_remove(int fd) | |
527 | { | |
528 | struct source *new_sources; | |
529 | int old, new; | |
530 | ||
531 | if (!sources) { | |
532 | sr_err("session: %s: sources was NULL", __func__); | |
533 | return SR_ERR_BUG; | |
534 | } | |
535 | ||
536 | /* TODO: Check if 'fd' valid. */ | |
537 | ||
538 | new_sources = g_try_malloc0(sizeof(struct source) * num_sources); | |
539 | if (!new_sources) { | |
540 | sr_err("session: %s: new_sources malloc failed", __func__); | |
541 | return SR_ERR_MALLOC; | |
542 | } | |
543 | ||
544 | for (old = 0, new = 0; old < num_sources; old++) { | |
545 | if (sources[old].fd != fd) | |
546 | memcpy(&new_sources[new++], &sources[old], | |
547 | sizeof(struct source)); | |
548 | } | |
549 | ||
550 | if (old != new) { | |
551 | g_free(sources); | |
552 | sources = new_sources; | |
553 | num_sources--; | |
554 | } else { | |
555 | /* Target fd was not found. */ | |
556 | g_free(new_sources); | |
557 | } | |
558 | ||
559 | return SR_OK; | |
560 | } |