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 void sigrok_feed_callback(const struct sr_dev_inst *sdi,
 130                 const struct sr_datafeed_packet *packet, void *cb_data)
 131 {
 132         const struct sr_datafeed_analog *analog;
 133         struct config_device *cfdev;
 134         GSList *l;
 135         value_t value;
 136         value_list_t vl = VALUE_LIST_INIT;
 137
 138         /* Find this device's configuration. */
 139         cfdev = NULL;
 140         for (l = config_devices; l; l = l->next) {
 141                 cfdev = l->data;
 142                 if (cfdev->sdi == sdi) {
 143                         /* Found it. */
 144                         break;
 145                 }
 146                 cfdev = NULL;
 147         }
 148         if (!cfdev) {
 149                 ERROR("Unknown device instance in sigrok driver %s.", sdi->driver->name);
 150                 return;
 151         }
 152
 153         if (packet->type == SR_DF_END) {
 154                 /* TODO: try to restart acquisition after a delay? */
 155                 WARNING("sigrok: acquisition for '%s' ended.", cfdev->name);
 156                 return;
 157         }
 158
 159         if (packet->type != SR_DF_ANALOG)
 160                 return;
 161
 162         if (cdtime() - cfdev->last_dispatch < cfdev->min_dispatch_interval)
 163                 return;
 164
 165         /* Ignore all but the first sample on the first probe. */
 166         analog = packet->payload;
 167         value.gauge = analog->data[0];
 168         vl.values = &value;
 169         vl.values_len = 1;
 170         sstrncpy(vl.host, hostname_g, sizeof(vl.host));
 171         sstrncpy(vl.plugin, "sigrok", sizeof(vl.plugin));
 172         ssnprintf(vl.plugin_instance, sizeof(vl.plugin_instance),
 173                         "%s", cfdev->name);
 174         sstrncpy(vl.type, "gauge", sizeof(vl.type));
 175         plugin_dispatch_values(&vl);
 176
 177         cfdev->last_dispatch = cdtime();
 178
 179 }
 180
 181 static void free_drvopts(struct sr_config *src)
 182 {
 183         g_variant_unref(src->data);
 184         g_free(src);
 185 }
 186
 187 static int sigrok_init_driver(struct config_device *cfdev,
 188                 struct sr_dev_driver *drv)
 189 {
 190         struct sr_config *src;
 191         GSList *devlist, *drvopts;
 192         char hwident[512];
 193
 194         if (sr_driver_init(sr_ctx, drv) != SR_OK)
 195                 /* Error was logged by libsigrok. */
 196                 return -1;
 197
 198         drvopts = NULL;
 199         if (cfdev->conn) {
 200                 if (!(src = malloc(sizeof(struct sr_config))))
 201                         return -1;
 202                 src->key = SR_CONF_CONN;
 203                 src->data = g_variant_new_string(cfdev->conn);
 204                 drvopts = g_slist_append(drvopts, src);
 205         }
 206         if (cfdev->serialcomm) {
 207                 if (!(src = malloc(sizeof(struct sr_config))))
 208                         return -1;
 209                 src->key = SR_CONF_SERIALCOMM;
 210                 src->data = g_variant_new_string(cfdev->serialcomm);
 211                 drvopts = g_slist_append(drvopts, src);
 212         }
 213         devlist = sr_driver_scan(drv, drvopts);
 214         g_slist_free_full(drvopts, (GDestroyNotify)free_drvopts);
 215         if (!devlist) {
 216                 /* Not an error, but the user should know about it. */
 217                 WARNING("No device found for '%s'.", cfdev->name);
 218                 return 0;
 219         }
 220
 221         if (g_slist_length(devlist) > 1) {
 222                 INFO("sigrok: %d sigrok devices for device entry '%s': must be 1.",
 223                                 g_slist_length(devlist), cfdev->name);
 224                 return -1;
 225         }
 226         cfdev->sdi = devlist->data;
 227         g_slist_free(devlist);
 228         ssnprintf(hwident, sizeof(hwident), "%s %s %s",
 229                         cfdev->sdi->vendor ? cfdev->sdi->vendor : "",
 230                         cfdev->sdi->model ? cfdev->sdi->model : "",
 231                         cfdev->sdi->version ? cfdev->sdi->version : "");
 232         INFO("sigrok: Device '%s' is a %s", cfdev->name, hwident);
 233
 234         if (sr_dev_open(cfdev->sdi) != SR_OK)
 235                 return -1;
 236
 237         if (sr_session_dev_add(cfdev->sdi) != SR_OK)
 238                 return -1;
 239
 240         return 1;
 241 }
 242
 243 static void *sigrok_read_thread(void *arg __attribute__((unused)))
 244 {
 245         struct sr_dev_driver *drv, **drvlist;
 246         GSList *l;
 247         struct config_device *cfdev;
 248         int ret, i;
 249
 250         sr_log_callback_set(sigrok_log_callback, NULL);
 251         sr_log_loglevel_set(loglevel);
 252
 253         if ((ret = sr_init(&sr_ctx)) != SR_OK) {
 254                 ERROR("Failed to initialize libsigrok: %s.", sr_strerror(ret));
 255                 return NULL;
 256         }
 257
 258         if (!sr_session_new())
 259                 return NULL;
 260
 261         num_devices = 0;
 262         drvlist = sr_driver_list();
 263         for (l = config_devices; l; l = l->next) {
 264                 cfdev = l->data;
 265                 drv = NULL;
 266                 for (i = 0; drvlist[i]; i++) {
 267                         if (!strcmp(drvlist[i]->name, cfdev->driver)) {
 268                                 drv = drvlist[i];
 269                                 break;
 270                         }
 271                 }
 272                 if (!drv) {
 273                         ERROR("sigrok: Unknown driver '%s'.", cfdev->driver);
 274                         return NULL;
 275                 }
 276
 277                 if ((ret = sigrok_init_driver(cfdev, drv)) < 0)
 278                         /* Error was already logged. */
 279                         return NULL;
 280
 281                 num_devices += ret;
 282         }
 283
 284         if (num_devices > 0) {
 285                 /* Do this only when we're sure there's hardware to talk to. */
 286                 if (sr_session_datafeed_callback_add(sigrok_feed_callback, NULL) != SR_OK)
 287                         return NULL;
 288
 289                 /* Start acquisition on all devices. */
 290                 if (sr_session_start() != SR_OK)
 291                         return NULL;
 292
 293                 /* Main loop, runs forever. */
 294                 sr_session_run();
 295
 296                 sr_session_stop();
 297                 sr_session_dev_remove_all();
 298         }
 299
 300         sr_session_destroy();
 301
 302         sr_exit(sr_ctx);
 303
 304         pthread_exit(NULL);
 305         sr_thread_running = FALSE;
 306
 307         return NULL;
 308 }
 309
 310 static int sigrok_init(void)
 311 {
 312         int status;
 313
 314         if (sr_thread_running) {
 315                 ERROR("sigrok: Thread already running.");
 316                 return -1;
 317         }
 318
 319         if ((status = plugin_thread_create(&sr_thread, NULL, sigrok_read_thread,
 320                         NULL)) != 0) {
 321                 ERROR("sigrok: Failed to create thread: %s.", strerror(status));
 322                 return -1;
 323         }
 324         sr_thread_running = TRUE;
 325
 326         return 0;
 327 }
 328
 329 static int sigrok_shutdown(void)
 330 {
 331         struct config_device *cfdev;
 332         GSList *l;
 333
 334         if (sr_thread_running) {
 335                 pthread_cancel(sr_thread);
 336                 pthread_join(sr_thread, NULL);
 337         }
 338
 339         for (l = config_devices; l; l = l->next) {
 340                 cfdev = l->data;
 341                 free(cfdev->name);
 342                 free(cfdev->driver);
 343                 free(cfdev->conn);
 344                 free(cfdev->serialcomm);
 345                 free(cfdev);
 346         }
 347         g_slist_free(config_devices);
 348
 349         return 0;
 350 }
 351
 352 void module_register(void)
 353 {
 354
 355         plugin_register_complex_config("sigrok", sigrok_config);
 356         plugin_register_init("sigrok", sigrok_init);
 357         plugin_register_shutdown("sigrok", sigrok_shutdown);
 358
 359 }