2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
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 2 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/>.
23 * Standard API helper functions.
28 /* Needed for gettimeofday(), at least on FreeBSD. */
29 #define _XOPEN_SOURCE 700
36 #include <libsigrok/libsigrok.h>
37 #include "libsigrok-internal.h"
40 #define LOG_PREFIX "std"
43 * Standard driver init() callback API helper.
45 * This function can be used to simplify most driver's init() API callback.
47 * Create a new 'struct drv_context' (drvc), assign sr_ctx to it, and
48 * then assign 'drvc' to the 'struct sr_dev_driver' (di) that is passed.
50 * @param[in] di The driver instance to use. Must not be NULL.
51 * @param[in] sr_ctx The libsigrok context to assign. May be NULL.
53 * @retval SR_OK Success.
54 * @retval SR_ERR_ARG Invalid argument.
56 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
58 struct drv_context *drvc;
61 sr_err("%s: Invalid argument.", __func__);
65 drvc = g_malloc0(sizeof(struct drv_context));
66 drvc->sr_ctx = sr_ctx;
67 drvc->instances = NULL;
74 * Standard driver cleanup() callback API helper.
76 * This function can be used to simplify most driver's cleanup() API callback.
78 * Free all device instances by calling sr_dev_clear() and then release any
79 * resources allocated by std_init().
81 * @param[in] di The driver instance to use. Must not be NULL.
83 * @retval SR_OK Success.
84 * @retval SR_ERR_ARG Invalid argument.
85 * @retval other Other error.
87 SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
92 sr_err("%s: Invalid argument.", __func__);
96 ret = sr_dev_clear(di);
103 * Dummmy driver dev_open() callback API helper.
105 * @param[in] sdi The device instance to use. May be NULL (unused).
107 * @retval SR_OK Success.
109 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi)
117 * Dummmy driver dev_close() callback API helper.
119 * @param[in] sdi The device instance to use. May be NULL (unused).
121 * @retval SR_OK Success.
123 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi)
131 * Dummmy driver dev_acquisition_start() callback API helper.
133 * @param[in] sdi The device instance to use. May be NULL (unused).
135 * @retval SR_OK Success.
137 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi)
145 * Dummmy driver dev_acquisition_stop() callback API helper.
147 * @param[in] sdi The device instance to use. May be NULL (unused).
149 * @retval SR_OK Success.
151 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi)
159 * Standard API helper for sending an SR_DF_HEADER packet.
161 * This function can be used to simplify most drivers'
162 * dev_acquisition_start() API callback.
164 * @param[in] sdi The device instance to use. Must not be NULL.
166 * @retval SR_OK Success.
167 * @retval SR_ERR_ARG Invalid argument.
168 * @retval other Other error.
170 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
174 struct sr_datafeed_packet packet;
175 struct sr_datafeed_header header;
178 sr_err("%s: Invalid argument.", __func__);
182 prefix = (sdi->driver) ? sdi->driver->name : "unknown";
184 /* Send header packet to the session bus. */
185 packet.type = SR_DF_HEADER;
186 packet.payload = (uint8_t *)&header;
187 header.feed_version = 1;
188 gettimeofday(&header.starttime, NULL);
190 if ((ret = sr_session_send(sdi, &packet)) < 0) {
191 sr_err("%s: Failed to send SR_DF_HEADER packet: %d.", prefix, ret);
199 * Standard API helper for sending an SR_DF_END packet.
201 * This function can be used to simplify most drivers'
202 * dev_acquisition_stop() API callback.
204 * @param[in] sdi The device instance to use. Must not be NULL.
206 * @retval SR_OK Success.
207 * @retval SR_ERR_ARG Invalid argument.
208 * @retval other Other error.
210 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
214 struct sr_datafeed_packet packet;
217 sr_err("%s: Invalid argument.", __func__);
221 prefix = (sdi->driver) ? sdi->driver->name : "unknown";
223 packet.type = SR_DF_END;
224 packet.payload = NULL;
226 if ((ret = sr_session_send(sdi, &packet)) < 0) {
227 sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
235 * Standard API helper for sending an SR_DF_FRAME_BEGIN packet.
237 * This function can be used to simplify most drivers'
240 * @param[in] sdi The device instance to use. Must not be NULL.
242 * @retval SR_OK Success.
243 * @retval SR_ERR_ARG Invalid argument.
244 * @retval other Other error.
246 SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi)
250 struct sr_datafeed_packet packet;
253 sr_err("%s: Invalid argument.", __func__);
257 prefix = (sdi->driver) ? sdi->driver->name : "unknown";
259 packet.type = SR_DF_FRAME_BEGIN;
260 packet.payload = NULL;
262 if ((ret = sr_session_send(sdi, &packet)) < 0) {
263 sr_err("%s: Failed to send SR_DF_FRAME_BEGIN packet: %d.", prefix, ret);
271 * Standard API helper for sending an SR_DF_FRAME_END packet.
273 * This function can be used to simplify most drivers'
276 * @param[in] sdi The device instance to use. Must not be NULL.
278 * @retval SR_OK Success.
279 * @retval SR_ERR_ARG Invalid argument.
280 * @retval other Other error.
282 SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi)
286 struct sr_datafeed_packet packet;
289 sr_err("%s: Invalid argument.", __func__);
293 prefix = (sdi->driver) ? sdi->driver->name : "unknown";
295 packet.type = SR_DF_FRAME_END;
296 packet.payload = NULL;
298 if ((ret = sr_session_send(sdi, &packet)) < 0) {
299 sr_err("%s: Failed to send SR_DF_FRAME_END packet: %d.", prefix, ret);
306 #ifdef HAVE_LIBSERIALPORT
309 * Standard serial driver dev_open() callback API helper.
311 * This function can be used to implement the dev_open() driver API
312 * callback in drivers that use a serial port. The port is opened
313 * with the SERIAL_RDWR flag.
315 * @param[in] sdi The device instance to use. Must not be NULL.
317 * @retval SR_OK Success.
318 * @retval SR_ERR_ARG Invalid argument.
319 * @retval other Serial port open failed.
321 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
323 struct sr_serial_dev_inst *serial;
326 sr_err("%s: Invalid argument.", __func__);
332 return serial_open(serial, SERIAL_RDWR);
336 * Standard serial driver dev_close() callback API helper.
338 * This function can be used to implement the dev_close() driver API
339 * callback in drivers that use a serial port.
341 * @param[in] sdi The device instance to use. Must not be NULL.
343 * @retval SR_OK Success.
344 * @retval SR_ERR_ARG Invalid argument.
345 * @retval other Serial port close failed.
347 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
349 struct sr_serial_dev_inst *serial;
352 sr_err("%s: Invalid argument.", __func__);
358 return serial_close(serial);
362 * Standard serial driver dev_acquisition_stop() callback API helper.
364 * This function can be used to simplify most (serial port based) drivers'
365 * dev_acquisition_stop() API callback.
367 * @param[in] sdi The device instance for which acquisition should stop.
370 * @retval SR_OK Success.
371 * @retval SR_ERR_ARG Invalid argument.
372 * @retval other Other error.
374 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi)
376 struct sr_serial_dev_inst *serial;
381 sr_err("%s: Invalid argument.", __func__);
386 prefix = sdi->driver->name;
388 if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
389 sr_err("%s: Failed to remove source: %d.", prefix, ret);
393 if ((ret = sr_dev_close(sdi)) < 0) {
394 sr_err("%s: Failed to close device: %d.", prefix, ret);
398 return std_session_send_df_end(sdi);
404 * Standard driver dev_clear() callback API helper.
406 * Clear driver, this means, close all instances.
408 * This function can be used to implement the dev_clear() driver API
409 * callback. dev_close() is called before every sr_dev_inst is cleared.
411 * The only limitation is driver-specific device contexts (sdi->priv / devc).
412 * These are freed, but any dynamic allocation within structs stored
413 * there cannot be freed.
415 * @param[in] driver The driver which will have its instances released.
417 * @param[in] clear_private If not NULL, this points to a function called
418 * with sdi->priv (devc) as argument. The function can then clear
419 * any device instance-specific resources kept there.
420 * It must NOT clear the struct pointed to by sdi->priv (devc),
421 * since this function will always free it after clear_private()
424 * @retval SR_OK Success.
425 * @retval SR_ERR_ARG Invalid argument.
426 * @retval SR_ERR_BUG Implementation bug.
427 * @retval other Other error.
429 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
430 std_dev_clear_callback clear_private)
432 struct drv_context *drvc;
433 struct sr_dev_inst *sdi;
438 sr_err("%s: Invalid argument.", __func__);
442 drvc = driver->context; /* Caller checked for context != NULL. */
445 for (l = drvc->instances; l; l = l->next) {
446 if (!(sdi = l->data)) {
447 sr_err("%s: Invalid device instance.", __func__);
451 if (driver->dev_close)
452 driver->dev_close(sdi);
455 #ifdef HAVE_LIBSERIALPORT
456 if (sdi->inst_type == SR_INST_SERIAL)
457 sr_serial_dev_inst_free(sdi->conn);
459 #ifdef HAVE_LIBUSB_1_0
460 if (sdi->inst_type == SR_INST_USB)
461 sr_usb_dev_inst_free(sdi->conn);
463 if (sdi->inst_type == SR_INST_SCPI)
464 sr_scpi_free(sdi->conn);
465 if (sdi->inst_type == SR_INST_MODBUS)
466 sr_modbus_free(sdi->conn);
469 /* Clear driver-specific stuff, if any. */
471 clear_private(sdi->priv);
473 /* Clear sdi->priv (devc). */
476 sr_dev_inst_free(sdi);
479 g_slist_free(drvc->instances);
480 drvc->instances = NULL;
485 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver)
487 return std_dev_clear_with_callback(driver, NULL);
491 * Standard driver dev_list() callback API helper.
493 * This function can be used as the dev_list() callback by most drivers.
495 * Return the devices contained in the driver context instances list.
497 * @param[in] di The driver instance to use. Must not be NULL.
499 * @retval NULL Error, or the list is empty.
500 * @retval other The list of device instances of this driver.
502 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
504 struct drv_context *drvc;
507 sr_err("%s: Invalid argument.", __func__);
513 return drvc->instances;
517 * Standard driver scan() callback API helper.
519 * This function can be used to perform common tasks required by a driver's
520 * scan() callback. It will initialize the driver for each device on the list
521 * and add the devices on the list to the driver's device instance list.
522 * Usually it should be used as the last step in the scan() callback, right
525 * Note: This function can only be used if std_init() has been called
526 * previously by the driver.
530 * static GSList *scan(struct sr_dev_driver *di, GSList *options)
532 * struct GSList *device;
533 * struct sr_dev_inst *sdi;
535 * sdi = g_new0(sr_dev_inst, 1);
538 * devices = g_slist_append(devices, sdi);
540 * return std_scan_complete(di, devices);
544 * @param[in] di The driver instance to use. Must not be NULL.
545 * @param[in] devices List of newly discovered devices (struct sr_dev_inst).
548 * @return The @p devices list.
550 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
552 struct drv_context *drvc;
556 sr_err("Invalid driver instance (di), cannot complete scan.");
562 for (l = devices; l; l = l->next) {
563 struct sr_dev_inst *sdi = l->data;
565 sr_err("Invalid device instance, cannot complete scan.");
571 drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
576 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
577 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
578 const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
579 size_t drvsize, const uint32_t devopts[], size_t devsize)
582 case SR_CONF_SCAN_OPTIONS:
583 /* Always return scanopts, regardless of sdi or cg. */
586 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
587 scanopts, scansize, sizeof(uint32_t));
589 case SR_CONF_DEVICE_OPTIONS:
591 /* sdi == NULL: return drvopts. */
594 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
595 drvopts, drvsize, sizeof(uint32_t));
596 } else if (sdi && !cg) {
597 /* sdi != NULL, cg == NULL: return devopts. */
600 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
601 devopts, devsize, sizeof(uint32_t));
604 * Note: sdi != NULL, cg != NULL is not handled by
605 * this function since it's very driver-specific.
607 sr_err("%s: %s: sdi/cg != NULL: not handling.",
608 sdi->driver->name, __func__);
619 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n)
622 GVariant *rational[2];
625 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
627 for (i = 0; i < n; i++) {
628 rational[0] = g_variant_new_uint64(a[i][0]);
629 rational[1] = g_variant_new_uint64(a[i][1]);
631 /* FIXME: Valgrind reports a memory leak here. */
632 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
635 return g_variant_builder_end(&gvb);
638 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n)
641 GVariant *rational[2];
644 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
646 for (i = 0; i < n; i++) {
647 rational[0] = g_variant_new_uint64(r[i].p);
648 rational[1] = g_variant_new_uint64(r[i].q);
650 /* FIXME: Valgrind reports a memory leak here. */
651 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
654 return g_variant_builder_end(&gvb);
657 static GVariant *samplerate_helper(const uint64_t samplerates[], unsigned int n, const char *str)
662 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
663 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
664 n, sizeof(uint64_t));
665 g_variant_builder_add(&gvb, "{sv}", str, gvar);
667 return g_variant_builder_end(&gvb);
670 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n)
672 return samplerate_helper(samplerates, n, "samplerates");
675 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n)
677 return samplerate_helper(samplerates, n, "samplerate-steps");
680 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step)
684 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
686 g_variant_builder_add_value(&gvb, g_variant_new_double(min));
687 g_variant_builder_add_value(&gvb, g_variant_new_double(max));
688 g_variant_builder_add_value(&gvb, g_variant_new_double(step));
690 return g_variant_builder_end(&gvb);
693 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3])
698 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
700 for (i = 0; i < 3; i++)
701 g_variant_builder_add_value(&gvb, g_variant_new_double(a[i]));
703 return g_variant_builder_end(&gvb);
706 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double min, const double max, const double step)
709 GVariant *gvar, *range[2];
712 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
714 for (d = min; d <= max; d += step) {
716 * We will never see exactly 0.0 because of the error we're
717 * accumulating, so catch the "zero" value and force it to be 0.
719 v = ((d > (-step / 2)) && (d < (step / 2))) ? 0 : d;
721 range[0] = g_variant_new_double(v);
722 range[1] = g_variant_new_double(v);
724 gvar = g_variant_new_tuple(range, 2);
725 g_variant_builder_add_value(&gvb, gvar);
728 return g_variant_builder_end(&gvb);
731 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high)
735 range[0] = g_variant_new_uint64(low);
736 range[1] = g_variant_new_uint64(high);
738 return g_variant_new_tuple(range, 2);
741 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high)
745 range[0] = g_variant_new_double(low);
746 range[1] = g_variant_new_double(high);
748 return g_variant_new_tuple(range, 2);
751 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n)
753 return g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
754 a, n, sizeof(int32_t));
757 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n)
759 return g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
760 a, n, sizeof(uint32_t));
763 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n)
765 return g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
766 a, n, sizeof(uint64_t));
769 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n)
772 GVariantBuilder *builder;
775 builder = g_variant_builder_new(G_VARIANT_TYPE ("as"));
777 for (i = 0; i < n; i++)
778 g_variant_builder_add(builder, "s", a[i]);
780 gvar = g_variant_new("as", builder);
781 g_variant_builder_unref(builder);
786 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n)
789 GVariant *gvar, *range[2];
792 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
794 for (i = 0; i < n; i++) {
795 range[0] = g_variant_new_double(a[i][0]);
796 range[1] = g_variant_new_double(a[i][1]);
797 gvar = g_variant_new_tuple(range, 2);
798 g_variant_builder_add_value(&gvb, gvar);
801 return g_variant_builder_end(&gvb);
804 /* Return the index of 'data' in the array 'arr' (or -1). */
805 static int find_in_array(GVariant *data, const GVariantType *type,
806 const void *arr, unsigned int n)
808 const char * const *sarr;
810 const uint64_t *u64arr;
811 const uint8_t *u8arr;
816 if (!g_variant_is_of_type(data, type))
819 switch (g_variant_classify(data)) {
820 case G_VARIANT_CLASS_STRING:
821 s = g_variant_get_string(data, NULL);
824 for (i = 0; i < n; i++)
825 if (!strcmp(s, sarr[i]))
828 case G_VARIANT_CLASS_UINT64:
829 u64 = g_variant_get_uint64(data);
832 for (i = 0; i < n; i++)
833 if (u64 == u64arr[i])
836 case G_VARIANT_CLASS_BYTE:
837 u8 = g_variant_get_byte(data);
840 for (i = 0; i < n; i++)
850 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n)
852 return find_in_array(data, G_VARIANT_TYPE_STRING, a, n);
855 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n)
857 return find_in_array(data, G_VARIANT_TYPE_UINT64, a, n);
860 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n)
862 return find_in_array(data, G_VARIANT_TYPE_BYTE, a, n);
865 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n)
870 data = g_variant_new_string(s);
871 idx = find_in_array(data, G_VARIANT_TYPE_STRING, a, n);
872 g_variant_unref(data);
877 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n)
882 data = g_variant_new_byte(b);
883 idx = find_in_array(data, G_VARIANT_TYPE_BYTE, a, n);
884 g_variant_unref(data);
889 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n)
894 g_variant_get(data, "(tt)", &low, &high);
896 for (i = 0; i < n; i++)
897 if (a[i][0] == low && a[i][1] == high)
903 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n)
908 g_variant_get(data, "(dd)", &low, &high);
910 for (i = 0; i < n; i++)
911 if ((fabs(a[i][0] - low) < 0.1) && ((fabs(a[i][1] - high) < 0.1)))
917 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n)
921 for (i = 0; i < n; i++)
928 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n)
932 for (i = 0; i < n; i++)