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 */
19 #include "collectd.h"
20 #include "common.h"
21 #include "plugin.h"
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <time.h>
27 #include <pthread.h>
29 #include <glib.h>
30 #include <libsigrok/libsigrok.h>
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)
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;
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 };
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];
59 if (msg_loglevel <= loglevel) {
60 vsnprintf(s, 512, format, args);
61 plugin_log(LOG_INFO, "sigrok: %s", s);
62 }
64 return 0;
65 }
67 static int sigrok_config_device(oconfig_item_t *ci)
68 {
69 struct config_device *cfdev;
70 int i;
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;
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 }
103 config_devices = g_slist_append(config_devices, cfdev);
105 return 0;
106 }
108 static int sigrok_config(oconfig_item_t *ci)
109 {
110 int tmp, i;
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 }
126 return 0;
127 }
129 static char *sigrok_value_type(const struct sr_datafeed_analog *analog)
130 {
131 char *s;
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 if (analog->mq == SR_MQ_SOUND_PRESSURE_LEVEL)
146 s = "spl";
147 else
148 s = "gauge";
150 return s;
151 }
153 static void sigrok_feed_callback(const struct sr_dev_inst *sdi,
154 const struct sr_datafeed_packet *packet, void *cb_data)
155 {
156 const struct sr_datafeed_analog *analog;
157 struct config_device *cfdev;
158 GSList *l;
159 value_t value;
160 value_list_t vl = VALUE_LIST_INIT;
162 /* Find this device's configuration. */
163 cfdev = NULL;
164 for (l = config_devices; l; l = l->next) {
165 cfdev = l->data;
166 if (cfdev->sdi == sdi) {
167 /* Found it. */
168 break;
169 }
170 cfdev = NULL;
171 }
172 if (!cfdev) {
173 ERROR("Unknown device instance in sigrok driver %s.", sdi->driver->name);
174 return;
175 }
177 if (packet->type == SR_DF_END) {
178 /* TODO: try to restart acquisition after a delay? */
179 WARNING("sigrok: acquisition for '%s' ended.", cfdev->name);
180 return;
181 }
183 if (packet->type != SR_DF_ANALOG)
184 return;
186 if (cdtime() - cfdev->last_dispatch < cfdev->min_dispatch_interval)
187 return;
189 /* Ignore all but the first sample on the first probe. */
190 analog = packet->payload;
191 value.gauge = analog->data[0];
192 vl.values = &value;
193 vl.values_len = 1;
194 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
195 sstrncpy(vl.plugin, "sigrok", sizeof(vl.plugin));
196 ssnprintf(vl.plugin_instance, sizeof(vl.plugin_instance),
197 "%s", cfdev->name);
198 sstrncpy(vl.type, sigrok_value_type(analog), sizeof(vl.type));
199 plugin_dispatch_values(&vl);
201 cfdev->last_dispatch = cdtime();
203 }
205 static void free_drvopts(struct sr_config *src)
206 {
207 g_variant_unref(src->data);
208 g_free(src);
209 }
211 static int sigrok_init_driver(struct config_device *cfdev,
212 struct sr_dev_driver *drv)
213 {
214 struct sr_config *src;
215 GSList *devlist, *drvopts;
216 char hwident[512];
218 if (sr_driver_init(sr_ctx, drv) != SR_OK)
219 /* Error was logged by libsigrok. */
220 return -1;
222 drvopts = NULL;
223 if (cfdev->conn) {
224 if (!(src = malloc(sizeof(struct sr_config))))
225 return -1;
226 src->key = SR_CONF_CONN;
227 src->data = g_variant_new_string(cfdev->conn);
228 drvopts = g_slist_append(drvopts, src);
229 }
230 if (cfdev->serialcomm) {
231 if (!(src = malloc(sizeof(struct sr_config))))
232 return -1;
233 src->key = SR_CONF_SERIALCOMM;
234 src->data = g_variant_new_string(cfdev->serialcomm);
235 drvopts = g_slist_append(drvopts, src);
236 }
237 devlist = sr_driver_scan(drv, drvopts);
238 g_slist_free_full(drvopts, (GDestroyNotify)free_drvopts);
239 if (!devlist) {
240 /* Not an error, but the user should know about it. */
241 WARNING("No device found for '%s'.", cfdev->name);
242 return 0;
243 }
245 if (g_slist_length(devlist) > 1) {
246 INFO("sigrok: %d sigrok devices for device entry '%s': must be 1.",
247 g_slist_length(devlist), cfdev->name);
248 return -1;
249 }
250 cfdev->sdi = devlist->data;
251 g_slist_free(devlist);
252 ssnprintf(hwident, sizeof(hwident), "%s %s %s",
253 cfdev->sdi->vendor ? cfdev->sdi->vendor : "",
254 cfdev->sdi->model ? cfdev->sdi->model : "",
255 cfdev->sdi->version ? cfdev->sdi->version : "");
256 INFO("sigrok: Device '%s' is a %s", cfdev->name, hwident);
258 if (sr_dev_open(cfdev->sdi) != SR_OK)
259 return -1;
261 if (sr_session_dev_add(cfdev->sdi) != SR_OK)
262 return -1;
264 return 1;
265 }
267 static void *sigrok_read_thread(void *arg __attribute__((unused)))
268 {
269 struct sr_dev_driver *drv, **drvlist;
270 GSList *l;
271 struct config_device *cfdev;
272 int ret, i;
274 sr_log_callback_set(sigrok_log_callback, NULL);
275 sr_log_loglevel_set(loglevel);
277 if ((ret = sr_init(&sr_ctx)) != SR_OK) {
278 ERROR("Failed to initialize libsigrok: %s.", sr_strerror(ret));
279 return NULL;
280 }
282 if (!sr_session_new())
283 return NULL;
285 num_devices = 0;
286 drvlist = sr_driver_list();
287 for (l = config_devices; l; l = l->next) {
288 cfdev = l->data;
289 drv = NULL;
290 for (i = 0; drvlist[i]; i++) {
291 if (!strcmp(drvlist[i]->name, cfdev->driver)) {
292 drv = drvlist[i];
293 break;
294 }
295 }
296 if (!drv) {
297 ERROR("sigrok: Unknown driver '%s'.", cfdev->driver);
298 return NULL;
299 }
301 if ((ret = sigrok_init_driver(cfdev, drv)) < 0)
302 /* Error was already logged. */
303 return NULL;
305 num_devices += ret;
306 }
308 if (num_devices > 0) {
309 /* Do this only when we're sure there's hardware to talk to. */
310 if (sr_session_datafeed_callback_add(sigrok_feed_callback, NULL) != SR_OK)
311 return NULL;
313 /* Start acquisition on all devices. */
314 if (sr_session_start() != SR_OK)
315 return NULL;
317 /* Main loop, runs forever. */
318 sr_session_run();
320 sr_session_stop();
321 sr_session_dev_remove_all();
322 }
324 sr_session_destroy();
326 sr_exit(sr_ctx);
328 pthread_exit(NULL);
329 sr_thread_running = FALSE;
331 return NULL;
332 }
334 static int sigrok_init(void)
335 {
336 int status;
338 if (sr_thread_running) {
339 ERROR("sigrok: Thread already running.");
340 return -1;
341 }
343 if ((status = plugin_thread_create(&sr_thread, NULL, sigrok_read_thread,
344 NULL)) != 0) {
345 ERROR("sigrok: Failed to create thread: %s.", strerror(status));
346 return -1;
347 }
348 sr_thread_running = TRUE;
350 return 0;
351 }
353 static int sigrok_shutdown(void)
354 {
355 struct config_device *cfdev;
356 GSList *l;
358 if (sr_thread_running) {
359 pthread_cancel(sr_thread);
360 pthread_join(sr_thread, NULL);
361 }
363 for (l = config_devices; l; l = l->next) {
364 cfdev = l->data;
365 free(cfdev->name);
366 free(cfdev->driver);
367 free(cfdev->conn);
368 free(cfdev->serialcomm);
369 free(cfdev);
370 }
371 g_slist_free(config_devices);
373 return 0;
374 }
376 void module_register(void)
377 {
379 plugin_register_complex_config("sigrok", sigrok_config);
380 plugin_register_init("sigrok", sigrok_init);
381 plugin_register_shutdown("sigrok", sigrok_shutdown);
383 }