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 int num_devices;
  40 static int loglevel = SR_LOG_WARN;
  41 static struct sr_context *sr_ctx;
  42
  43 struct config_device {
  44         char *name;
  45         char *driver;
  46         char *conn;
  47         char *serialcomm;
  48         struct sr_dev_inst *sdi;
  49         cdtime_t min_dispatch_interval;
  50         cdtime_t last_dispatch;
  51 };
  52
  53
  54 static int sigrok_log_callback(void*cb_data __attribute__((unused)),
  55                 int msg_loglevel, const char *format, va_list args)
  56 {
  57         char s[512];
  58
  59         if (msg_loglevel <= loglevel) {
  60                 vsnprintf(s, 512, format, args);
  61                 plugin_log(LOG_INFO, "sigrok: %s", s);
  62         }
  63
  64         return 0;
  65 }
  66
  67 static int sigrok_config_device(oconfig_item_t *ci)
  68 {
  69         struct config_device *cfdev;
  70         int i;
  71
  72         if (!(cfdev = malloc(sizeof(struct config_device)))) {
  73                 ERROR("malloc() failed.");
  74                 return -1;
  75         }
  76         memset(cfdev, 0, sizeof(*cfdev));
  77         if (cf_util_get_string(ci, &cfdev->name)) {
  78                 free(cfdev);
  79                 WARNING("Invalid device name.");
  80                 return -1;
  81         }
  82         cfdev->min_dispatch_interval = DEFAULT_MIN_DISPATCH_INTERVAL;
  83
  84         for (i = 0; i < ci->children_num; i++) {
  85                 oconfig_item_t *item = ci->children + i;
  86                 if (item->values_num != 1) {
  87                         free(cfdev);
  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         int tmp, i;
 111
 112         for (i = 0; i < ci->children_num; i++) {
 113                 oconfig_item_t *item = ci->children + i;
 114                 if (!strcasecmp(item->key, "loglevel")) {
 115                         if (cf_util_get_int(item, &tmp) || tmp < 0 || tmp > 5) {
 116                                 ERROR("Invalid loglevel");
 117                                 continue;
 118                         }
 119                         loglevel = tmp;
 120                 } else if (!strcasecmp(item->key, "Device"))
 121                         sigrok_config_device(item);
 122                 else
 123                         WARNING("Invalid keyword '%s'.", item->key);
 124         }
 125
 126         return 0;
 127 }
 128
 129 static char *sigrok_value_type(const struct sr_datafeed_analog *analog)
 130 {
 131         char *s;
 132
 133         if (analog->mq == SR_MQ_VOLTAGE)
 134                 s = "voltage";
 135         else if (analog->mq == SR_MQ_CURRENT)
 136                 s = "current";
 137         else if (analog->mq == SR_MQ_FREQUENCY)
 138                 s = "frequency";
 139         else if (analog->mq == SR_MQ_POWER)
 140                 s = "power";
 141         else if (analog->mq == SR_MQ_TEMPERATURE)
 142                 s = "temperature";
 143         else if (analog->mq == SR_MQ_RELATIVE_HUMIDITY)
 144                 s = "humidity";
 145         else
 146                 s = "gauge";
 147
 148         return s;
 149 }
 150
 151 static void sigrok_feed_callback(const struct sr_dev_inst *sdi,
 152                 const struct sr_datafeed_packet *packet, void *cb_data)
 153 {
 154         const struct sr_datafeed_analog *analog;
 155         struct config_device *cfdev;
 156         GSList *l;
 157         value_t value;
 158         value_list_t vl = VALUE_LIST_INIT;
 159
 160         /* Find this device's configuration. */
 161         cfdev = NULL;
 162         for (l = config_devices; l; l = l->next) {
 163                 cfdev = l->data;
 164                 if (cfdev->sdi == sdi) {
 165                         /* Found it. */
 166                         break;
 167                 }
 168                 cfdev = NULL;
 169         }
 170         if (!cfdev) {
 171                 ERROR("Unknown device instance in sigrok driver %s.", sdi->driver->name);
 172                 return;
 173         }
 174
 175         if (packet->type == SR_DF_END) {
 176                 /* TODO: try to restart acquisition after a delay? */
 177                 WARNING("sigrok: acquisition for '%s' ended.", cfdev->name);
 178                 return;
 179         }
 180
 181         if (packet->type != SR_DF_ANALOG)
 182                 return;
 183
 184         if (cdtime() - cfdev->last_dispatch < cfdev->min_dispatch_interval)
 185                 return;
 186
 187         /* Ignore all but the first sample on the first probe. */
 188         analog = packet->payload;
 189         value.gauge = analog->data[0];
 190         vl.values = &value;
 191         vl.values_len = 1;
 192         sstrncpy(vl.host, hostname_g, sizeof(vl.host));
 193         sstrncpy(vl.plugin, "sigrok", sizeof(vl.plugin));
 194         ssnprintf(vl.plugin_instance, sizeof(vl.plugin_instance),
 195                         "%s", cfdev->name);
 196         sstrncpy(vl.type, sigrok_value_type(analog), sizeof(vl.type));
 197         plugin_dispatch_values(&vl);
 198
 199         cfdev->last_dispatch = cdtime();
 200
 201 }
 202
 203 static void free_drvopts(struct sr_config *src)
 204 {
 205         g_variant_unref(src->data);
 206         g_free(src);
 207 }
 208
 209 static int sigrok_init_driver(struct config_device *cfdev,
 210                 struct sr_dev_driver *drv)
 211 {
 212         struct sr_config *src;
 213         GSList *devlist, *drvopts;
 214         char hwident[512];
 215
 216         if (sr_driver_init(sr_ctx, drv) != SR_OK)
 217                 /* Error was logged by libsigrok. */
 218                 return -1;
 219
 220         drvopts = NULL;
 221         if (cfdev->conn) {
 222                 if (!(src = malloc(sizeof(struct sr_config))))
 223                         return -1;
 224                 src->key = SR_CONF_CONN;
 225                 src->data = g_variant_new_string(cfdev->conn);
 226                 drvopts = g_slist_append(drvopts, src);
 227         }
 228         if (cfdev->serialcomm) {
 229                 if (!(src = malloc(sizeof(struct sr_config))))
 230                         return -1;
 231                 src->key = SR_CONF_SERIALCOMM;
 232                 src->data = g_variant_new_string(cfdev->serialcomm);
 233                 drvopts = g_slist_append(drvopts, src);
 234         }
 235         devlist = sr_driver_scan(drv, drvopts);
 236         g_slist_free_full(drvopts, (GDestroyNotify)free_drvopts);
 237         if (!devlist) {
 238                 /* Not an error, but the user should know about it. */
 239                 WARNING("No device found for '%s'.", cfdev->name);
 240                 return 0;
 241         }
 242
 243         if (g_slist_length(devlist) > 1) {
 244                 INFO("sigrok: %d sigrok devices for device entry '%s': must be 1.",
 245                                 g_slist_length(devlist), cfdev->name);
 246                 return -1;
 247         }
 248         cfdev->sdi = devlist->data;
 249         g_slist_free(devlist);
 250         ssnprintf(hwident, sizeof(hwident), "%s %s %s",
 251                         cfdev->sdi->vendor ? cfdev->sdi->vendor : "",
 252                         cfdev->sdi->model ? cfdev->sdi->model : "",
 253                         cfdev->sdi->version ? cfdev->sdi->version : "");
 254         INFO("sigrok: Device '%s' is a %s", cfdev->name, hwident);
 255
 256         if (sr_dev_open(cfdev->sdi) != SR_OK)
 257                 return -1;
 258
 259         if (sr_session_dev_add(cfdev->sdi) != SR_OK)
 260                 return -1;
 261
 262         return 1;
 263 }
 264
 265 static void *sigrok_read_thread(void *arg __attribute__((unused)))
 266 {
 267         struct sr_dev_driver *drv, **drvlist;
 268         GSList *l;
 269         struct config_device *cfdev;
 270         int ret, i;
 271
 272         sr_log_callback_set(sigrok_log_callback, NULL);
 273         sr_log_loglevel_set(loglevel);
 274
 275         if ((ret = sr_init(&sr_ctx)) != SR_OK) {
 276                 ERROR("Failed to initialize libsigrok: %s.", sr_strerror(ret));
 277                 return NULL;
 278         }
 279
 280         if (!sr_session_new())
 281                 return NULL;
 282
 283         num_devices = 0;
 284         drvlist = sr_driver_list();
 285         for (l = config_devices; l; l = l->next) {
 286                 cfdev = l->data;
 287                 drv = NULL;
 288                 for (i = 0; drvlist[i]; i++) {
 289                         if (!strcmp(drvlist[i]->name, cfdev->driver)) {
 290                                 drv = drvlist[i];
 291                                 break;
 292                         }
 293                 }
 294                 if (!drv) {
 295                         ERROR("sigrok: Unknown driver '%s'.", cfdev->driver);
 296                         return NULL;
 297                 }
 298
 299                 if ((ret = sigrok_init_driver(cfdev, drv)) < 0)
 300                         /* Error was already logged. */
 301                         return NULL;
 302
 303                 num_devices += ret;
 304         }
 305
 306         if (num_devices > 0) {
 307                 /* Do this only when we're sure there's hardware to talk to. */
 308                 if (sr_session_datafeed_callback_add(sigrok_feed_callback, NULL) != SR_OK)
 309                         return NULL;
 310
 311                 /* Start acquisition on all devices. */
 312                 if (sr_session_start() != SR_OK)
 313                         return NULL;
 314
 315                 /* Main loop, runs forever. */
 316                 sr_session_run();
 317
 318                 sr_session_stop();
 319                 sr_session_dev_remove_all();
 320         }
 321
 322         sr_session_destroy();
 323
 324         sr_exit(sr_ctx);
 325
 326         pthread_exit(NULL);
 327         sr_thread_running = FALSE;
 328
 329         return NULL;
 330 }
 331
 332 static int sigrok_init(void)
 333 {
 334         int status;
 335
 336         if (sr_thread_running) {
 337                 ERROR("sigrok: Thread already running.");
 338                 return -1;
 339         }
 340
 341         if ((status = plugin_thread_create(&sr_thread, NULL, sigrok_read_thread,
 342                         NULL)) != 0) {
 343                 ERROR("sigrok: Failed to create thread: %s.", strerror(status));
 344                 return -1;
 345         }
 346         sr_thread_running = TRUE;
 347
 348         return 0;
 349 }
 350
 351 static int sigrok_shutdown(void)
 352 {
 353         struct config_device *cfdev;
 354         GSList *l;
 355
 356         if (sr_thread_running) {
 357                 pthread_cancel(sr_thread);
 358                 pthread_join(sr_thread, NULL);
 359         }
 360
 361         for (l = config_devices; l; l = l->next) {
 362                 cfdev = l->data;
 363                 free(cfdev->name);
 364                 free(cfdev->driver);
 365                 free(cfdev->conn);
 366                 free(cfdev->serialcomm);
 367                 free(cfdev);
 368         }
 369         g_slist_free(config_devices);
 370
 371         return 0;
 372 }
 373
 374 void module_register(void)
 375 {
 376
 377         plugin_register_complex_config("sigrok", sigrok_config);
 378         plugin_register_init("sigrok", sigrok_init);
 379         plugin_register_shutdown("sigrok", sigrok_shutdown);
 380
 381 }