src/sigrok.c

   1 /*
   2  * collectd - src/sigrok.c
   3  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include "collectd.h"
  20 #include "common.h"
  21 #include "plugin.h"
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <time.h>
  27 #include <pthread.h>
  28
  29 #include <glib.h>
  30 #include <libsigrok/libsigrok.h>
  31
  32 /* Minimum interval between dispatches coming from this plugin. The RRD
  33  * plugin, at least, complains when written to with sub-second intervals.*/
  34 #define DEFAULT_MIN_DISPATCH_INTERVAL TIME_T_TO_CDTIME_T(1)
  35
  36 static pthread_t sr_thread;
  37 static int sr_thread_running = FALSE;
  38 GSList *config_devices;
  39 static struct sr_session *session = NULL;
  40 static int num_devices;
  41 static int loglevel = SR_LOG_WARN;
  42 static struct sr_context *sr_ctx;
  43
  44 struct config_device {
  45         char *name;
  46         char *driver;
  47         char *conn;
  48         char *serialcomm;
  49         struct sr_dev_inst *sdi;
  50         cdtime_t min_dispatch_interval;
  51         cdtime_t last_dispatch;
  52 };
  53
  54
  55 static int cd_logger(void *cb_data, int msg_loglevel, const char *format,
  56                 va_list args)
  57 {
  58         char s[512];
  59
  60         if (msg_loglevel <= loglevel) {
  61                 vsnprintf(s, 512, format, args);
  62                 plugin_log(LOG_INFO, "sigrok: %s", s);
  63         }
  64
  65         return 0;
  66 }
  67
  68 static int sigrok_config_device(oconfig_item_t *ci)
  69 {
  70         oconfig_item_t *item;
  71         struct config_device *cfdev;
  72         int i;
  73
  74         if (!(cfdev = malloc(sizeof(struct config_device)))) {
  75                 ERROR("malloc() failed.");
  76                 return 1;
  77         }
  78         memset(cfdev, 0, sizeof(struct config_device));
  79         if (cf_util_get_string(ci, &cfdev->name)) {
  80                 WARNING("Invalid device name.");
  81                 return 1;
  82         }
  83         cfdev->min_dispatch_interval = DEFAULT_MIN_DISPATCH_INTERVAL;
  84
  85         for (i = 0; i < ci->children_num; i++) {
  86                 item = ci->children + i;
  87                 if (item->values_num != 1) {
  88                         WARNING("Missing value for '%s'.", item->key);
  89                         return 1;
  90                 }
  91                 if (!strcasecmp(item->key, "driver"))
  92                         cf_util_get_string(item, &cfdev->driver);
  93                 else if (!strcasecmp(item->key, "conn"))
  94                         cf_util_get_string(item, &cfdev->conn);
  95                 else if (!strcasecmp(item->key, "serialcomm"))
  96                         cf_util_get_string(item, &cfdev->serialcomm);
  97                 else if (!strcasecmp(item->key, "interval"))
  98                         cf_util_get_cdtime(item, &cfdev->min_dispatch_interval);
  99                 else
 100                         WARNING("Invalid keyword '%s'.", item->key);
 101         }
 102
 103         config_devices = g_slist_append(config_devices, cfdev);
 104
 105         return 0;
 106 }
 107
 108 static int sigrok_config(oconfig_item_t *ci)
 109 {
 110         oconfig_item_t *item;
 111         int tmp, i;
 112
 113         for (i = 0; i < ci->children_num; i++) {
 114                 item = ci->children + i;
 115                 if (!strcasecmp(item->key, "loglevel")) {
 116                         if (cf_util_get_int(item, &tmp) || tmp < 0 || tmp > 5) {
 117                                 ERROR("Invalid loglevel");
 118                                 continue;
 119                         }
 120                         loglevel = tmp;
 121                 } else if (!strcasecmp(item->key, "Device"))
 122                         sigrok_config_device(item);
 123                 else
 124                         WARNING("Invalid keyword '%s'.", item->key);
 125         }
 126
 127         return 0;
 128 }
 129
 130 static void free_drvopts(struct sr_config *src)
 131 {
 132         g_variant_unref(src->data);
 133         g_free(src);
 134 }
 135
 136 static void sigrok_feed_callback(const struct sr_dev_inst *sdi,
 137                 const struct sr_datafeed_packet *packet, void *cb_data)
 138 {
 139         const struct sr_datafeed_analog *analog;
 140         struct config_device *cfdev;
 141         GSList *l;
 142         value_t *values;
 143         value_list_t vl = VALUE_LIST_INIT;
 144         int num_probes, s, p;
 145
 146         if (packet->type == SR_DF_END) {
 147                 /* TODO: try to restart acquisition after a delay? */
 148                 INFO("oops! ended");
 149                 return;
 150         }
 151
 152         /* Find this device's configuration. */
 153         cfdev = NULL;
 154         for (l = config_devices; l; l = l->next) {
 155                 cfdev = l->data;
 156                 if (cfdev->sdi == sdi) {
 157                         /* Found it. */
 158                         break;
 159                 }
 160                 cfdev = NULL;
 161         }
 162         if (!cfdev) {
 163                 ERROR("Unknown device instance in sigrok driver %s.", sdi->driver->name);
 164                 return;
 165         }
 166
 167         if (packet->type == SR_DF_ANALOG) {
 168                 if (cdtime() - cfdev->last_dispatch < cfdev->min_dispatch_interval)
 169                         return;
 170
 171                 analog = packet->payload;
 172                 num_probes = g_slist_length(analog->probes);
 173                 if (!(values = malloc(sizeof(value_t) * num_probes))) {
 174                         ERROR("malloc() failed.");
 175                         return;
 176                 }
 177                 for (s = 0; s < analog->num_samples; s++) {
 178                         for (p = 0; p < num_probes; p++) {
 179                                 values[s + p].gauge = analog->data[s + p];
 180                         }
 181                 }
 182                 vl.values = values;
 183                 vl.values_len = num_probes;
 184                 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
 185                 sstrncpy(vl.plugin, "sigrok", sizeof(vl.plugin));
 186                 ssnprintf(vl.plugin_instance, sizeof(vl.plugin_instance),
 187                                 "%s", cfdev->name);
 188                 sstrncpy(vl.type, "gauge", sizeof(vl.type));
 189                 plugin_dispatch_values(&vl);
 190
 191                 cfdev->last_dispatch = cdtime();
 192         }
 193
 194 }
 195
 196 static int sigrok_init_driver(struct config_device *cfdev,
 197                 struct sr_dev_driver *drv)
 198 {
 199         struct sr_config *src;
 200         GSList *devlist, *drvopts;
 201         char hwident[512];
 202
 203         if (sr_driver_init(sr_ctx, drv) != SR_OK)
 204                 /* Error was logged by libsigrok. */
 205                 return -1;
 206
 207         drvopts = NULL;
 208         if (cfdev->conn) {
 209                 if (!(src = malloc(sizeof(struct sr_config))))
 210                         return -1;
 211                 src->key = SR_CONF_CONN;
 212                 src->data = g_variant_new_string(cfdev->conn);
 213                 drvopts = g_slist_append(drvopts, src);
 214         }
 215         if (cfdev->serialcomm) {
 216                 if (!(src = malloc(sizeof(struct sr_config))))
 217                         return -1;
 218                 src->key = SR_CONF_SERIALCOMM;
 219                 src->data = g_variant_new_string(cfdev->serialcomm);
 220                 drvopts = g_slist_append(drvopts, src);
 221         }
 222         devlist = sr_driver_scan(drv, drvopts);
 223         g_slist_free_full(drvopts, (GDestroyNotify)free_drvopts);
 224         if (!devlist)
 225                 /* No devices found for this driver, not an error. */
 226                 return 0;
 227
 228         if (g_slist_length(devlist) > 1) {
 229                 INFO("sigrok: %d sigrok devices for device entry '%s': must be 1.",
 230                                 g_slist_length(devlist), cfdev->name);
 231                 return -1;
 232         }
 233         cfdev->sdi = devlist->data;
 234         g_slist_free(devlist);
 235         ssnprintf(hwident, sizeof(hwident), "%s %s %s",
 236                         cfdev->sdi->vendor ? cfdev->sdi->vendor : "",
 237                         cfdev->sdi->model ? cfdev->sdi->model : "",
 238                         cfdev->sdi->version ? cfdev->sdi->version : "");
 239         INFO("sigrok: Device '%s' is a %s", cfdev->name, hwident);
 240
 241         if (sr_dev_open(cfdev->sdi) != SR_OK)
 242                 return -1;
 243
 244         if (sr_session_dev_add(cfdev->sdi) != SR_OK)
 245                 return -1;
 246
 247         return 1;
 248 }
 249
 250 static void *thread_init(void *arg __attribute__((unused)))
 251 {
 252         struct sr_dev_driver *drv, **drvlist;
 253         GSList *l;
 254         struct config_device *cfdev;
 255         int ret, i;
 256
 257         sr_log_callback_set(cd_logger, NULL);
 258         sr_log_loglevel_set(loglevel);
 259
 260         if ((ret = sr_init(&sr_ctx)) != SR_OK) {
 261                 ERROR("Failed to initialize libsigrok: %s.", sr_strerror(ret));
 262                 return NULL;
 263         }
 264
 265         if (!(session = sr_session_new()))
 266                 return NULL;
 267
 268         num_devices = 0;
 269         drvlist = sr_driver_list();
 270         for (l = config_devices; l; l = l->next) {
 271                 cfdev = l->data;
 272                 drv = NULL;
 273                 for (i = 0; drvlist[i]; i++) {
 274                         if (!strcmp(drvlist[i]->name, cfdev->driver)) {
 275                                 drv = drvlist[i];
 276                                 break;
 277                         }
 278                 }
 279                 if (!drv) {
 280                         ERROR("sigrok: Unknown driver '%s'.", cfdev->driver);
 281                         return NULL;
 282                 }
 283
 284                 if ((ret = sigrok_init_driver(cfdev, drv)) < 0)
 285                         /* Error was already logged. */
 286                         return NULL;
 287
 288                 num_devices += ret;
 289         }
 290
 291         if (num_devices > 0) {
 292                 /* Do this only when we're sure there's hardware to talk to. */
 293                 if (sr_session_datafeed_callback_add(sigrok_feed_callback, NULL) != SR_OK)
 294                         return NULL;
 295
 296                 /* Start acquisition on all devices. */
 297                 if (sr_session_start() != SR_OK)
 298                         return NULL;
 299
 300                 /* Main loop, runs forever. */
 301                 sr_session_run();
 302
 303                 sr_session_stop();
 304                 sr_session_dev_remove_all();
 305         }
 306
 307         sr_session_destroy();
 308
 309         sr_exit(sr_ctx);
 310
 311         pthread_exit(NULL);
 312         sr_thread_running = FALSE;
 313
 314         return NULL;
 315 }
 316
 317 static int sigrok_init(void)
 318 {
 319         int status;
 320
 321         if (sr_thread_running) {
 322                 ERROR("sigrok: Thread already running.");
 323                 return -1;
 324         }
 325
 326         if ((status = plugin_thread_create(&sr_thread, NULL, thread_init, NULL)) != 0) {
 327                 ERROR("sigrok: Failed to create thread: %s.", strerror(status));
 328                 return -1;
 329         }
 330         sr_thread_running = TRUE;
 331
 332         return 0;
 333 }
 334
 335 static int sigrok_shutdown(void)
 336 {
 337         struct config_device *cfdev;
 338         GSList *l;
 339
 340         if (sr_thread_running) {
 341                 pthread_cancel(sr_thread);
 342                 pthread_join(sr_thread, NULL);
 343         }
 344
 345         for (l = config_devices; l; l = l->next) {
 346                 cfdev = l->data;
 347                 free(cfdev->name);
 348                 free(cfdev->driver);
 349                 free(cfdev->conn);
 350                 free(cfdev->serialcomm);
 351                 free(cfdev);
 352         }
 353         g_slist_free(config_devices);
 354
 355         return 0;
 356 }
 357
 358 void module_register(void)
 359 {
 360
 361         plugin_register_complex_config("sigrok", sigrok_config);
 362         plugin_register_init("sigrok", sigrok_init);
 363         plugin_register_shutdown("sigrok", sigrok_shutdown);
 364
 365 }