src/sigrok.c

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