2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <sys/timerfd.h>
25 SR_PRIV struct sr_dev_driver baylibre_acme_driver_info;
27 static const uint32_t devopts[] = {
28 SR_CONF_CONTINUOUS | SR_CONF_SET,
29 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
30 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
31 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
35 * Currently there are two channel-group/probe options for ACME:
36 * - SR_CONF_PROBE_FACTOR - allows to modify current shunt resistance
38 * - SR_CONF_POWER_OFF - allows to remotely cut-off/restore power to
41 * They are not static - we have to check each probe's capabilities in
44 #define MAX_DEVOPTS_CG 2
45 #define HAS_PROBE_FACTOR (SR_CONF_PROBE_FACTOR | SR_CONF_GET | SR_CONF_SET)
46 #define HAS_POWER_OFF (SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET)
48 #define MAX_SAMPLE_RATE 500 /* In Hz */
50 static const uint64_t samplerates[] = {
52 SR_HZ(MAX_SAMPLE_RATE),
56 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
58 return std_init(sr_ctx, di, LOG_PREFIX);
61 static GSList *scan(struct sr_dev_driver *di, GSList *options)
63 struct drv_context *drvc;
64 struct dev_context *devc;
65 struct sr_dev_inst *sdi;
75 devc = g_malloc0(sizeof(struct dev_context));
76 devc->samplerate = SR_HZ(10);
78 sdi = g_malloc0(sizeof(struct sr_dev_inst));
79 sdi->status = SR_ST_INACTIVE;
80 sdi->vendor = g_strdup("BayLibre");
81 sdi->model = g_strdup("ACME");
85 status = bl_acme_is_sane();
90 * Iterate over all ACME connectors and check if any probes
93 for (i = 0; i < MAX_PROBES; i++) {
95 * First check if there's an energy probe on this connector. If
96 * not, and we're already at the fifth probe - see if we can
97 * detect a temperature probe.
99 status = bl_acme_detect_probe(bl_acme_get_enrg_addr(i),
100 PROBE_NUM(i), ENRG_PROBE_NAME);
102 /* Energy probe detected. */
103 status = bl_acme_register_probe(sdi, PROBE_ENRG,
104 bl_acme_get_enrg_addr(i), PROBE_NUM(i));
106 sr_err("Error registering power probe %d",
110 } else if (i >= TEMP_PRB_START_INDEX) {
111 status = bl_acme_detect_probe(bl_acme_get_temp_addr(i),
112 PROBE_NUM(i), TEMP_PROBE_NAME);
114 /* Temperature probe detected. */
115 status = bl_acme_register_probe(sdi,PROBE_TEMP,
116 bl_acme_get_temp_addr(i), PROBE_NUM(i));
118 sr_err("Error registering temp "
119 "probe %d", PROBE_NUM(i));
127 * Let's assume there's no ACME device present if no probe
128 * has been registered.
130 if (!sdi->channel_groups)
133 devices = g_slist_append(devices, sdi);
134 drvc->instances = g_slist_append(drvc->instances, sdi);
140 sr_dev_inst_free(sdi);
145 static int dev_open(struct sr_dev_inst *sdi)
149 sdi->status = SR_ST_ACTIVE;
154 static int dev_close(struct sr_dev_inst *sdi)
158 sdi->status = SR_ST_INACTIVE;
163 static int config_get(uint32_t key, GVariant **data,
164 const struct sr_dev_inst *sdi,
165 const struct sr_channel_group *cg)
167 struct dev_context *devc;
176 case SR_CONF_LIMIT_SAMPLES:
177 *data = g_variant_new_uint64(devc->limit_samples);
179 case SR_CONF_LIMIT_MSEC:
180 *data = g_variant_new_uint64(devc->limit_msec);
182 case SR_CONF_SAMPLERATE:
183 *data = g_variant_new_uint64(devc->samplerate);
185 case SR_CONF_PROBE_FACTOR:
187 return SR_ERR_CHANNEL_GROUP;
188 ret = bl_acme_get_shunt(cg, &shunt);
190 *data = g_variant_new_uint64(shunt);
192 case SR_CONF_POWER_OFF:
194 return SR_ERR_CHANNEL_GROUP;
195 ret = bl_acme_read_power_state(cg, &power_off);
197 *data = g_variant_new_boolean(power_off);
206 static int config_set(uint32_t key, GVariant *data,
207 const struct sr_dev_inst *sdi,
208 const struct sr_channel_group *cg)
210 struct dev_context *devc;
214 if (sdi->status != SR_ST_ACTIVE)
215 return SR_ERR_DEV_CLOSED;
221 case SR_CONF_LIMIT_SAMPLES:
222 devc->limit_samples = g_variant_get_uint64(data);
223 devc->limit_msec = 0;
225 case SR_CONF_LIMIT_MSEC:
226 devc->limit_msec = g_variant_get_uint64(data) * 1000;
227 devc->limit_samples = 0;
229 case SR_CONF_SAMPLERATE:
230 samplerate = g_variant_get_uint64(data);
231 if (samplerate > MAX_SAMPLE_RATE) {
232 sr_err("Maximum sample rate is %d", MAX_SAMPLE_RATE);
233 ret = SR_ERR_SAMPLERATE;
236 devc->samplerate = samplerate;
237 bl_acme_maybe_set_update_interval(sdi, samplerate);
239 case SR_CONF_PROBE_FACTOR:
241 return SR_ERR_CHANNEL_GROUP;
242 ret = bl_acme_set_shunt(cg, g_variant_get_uint64(data));
244 case SR_CONF_POWER_OFF:
246 return SR_ERR_CHANNEL_GROUP;
247 ret = bl_acme_set_power_off(cg, g_variant_get_boolean(data));
256 static int config_list(uint32_t key, GVariant **data,
257 const struct sr_dev_inst *sdi,
258 const struct sr_channel_group *cg)
260 uint32_t devopts_cg[MAX_DEVOPTS_CG];
263 int ret, num_devopts_cg = 0;
271 case SR_CONF_DEVICE_OPTIONS:
272 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
273 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
275 case SR_CONF_SAMPLERATE:
276 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
277 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
278 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
279 g_variant_builder_add(&gvb, "{sv}",
280 "samplerate-steps", gvar);
281 *data = g_variant_builder_end(&gvb);
288 case SR_CONF_DEVICE_OPTIONS:
289 if (bl_acme_get_probe_type(cg) == PROBE_ENRG)
290 devopts_cg[num_devopts_cg++] = HAS_PROBE_FACTOR;
291 if (bl_acme_probe_has_pws(cg))
292 devopts_cg[num_devopts_cg++] = HAS_POWER_OFF;
294 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
295 devopts_cg, num_devopts_cg, sizeof(uint32_t));
305 static void dev_acquisition_close(const struct sr_dev_inst *sdi)
308 struct sr_channel *ch;
310 for (chl = sdi->channels; chl; chl = chl->next) {
312 bl_acme_close_channel(ch);
316 static int dev_acquisition_open(const struct sr_dev_inst *sdi)
319 struct sr_channel *ch;
321 for (chl = sdi->channels; chl; chl = chl->next) {
323 if (bl_acme_open_channel(ch)) {
324 sr_err("Error opening channel %s", ch->name);
325 dev_acquisition_close(sdi);
333 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
335 struct dev_context *devc;
336 struct itimerspec tspec = {
337 .it_interval = { 0, 0 },
341 if (sdi->status != SR_ST_ACTIVE)
342 return SR_ERR_DEV_CLOSED;
344 if (dev_acquisition_open(sdi))
348 devc->samples_read = 0;
349 devc->samples_missed = 0;
350 devc->timer_fd = timerfd_create(CLOCK_MONOTONIC, 0);
351 if (devc->timer_fd < 0) {
352 sr_err("Error creating timer fd");
356 tspec.it_interval.tv_sec = 0;
357 tspec.it_interval.tv_nsec = SR_HZ_TO_NS(devc->samplerate);
358 tspec.it_value = tspec.it_interval;
360 if (timerfd_settime(devc->timer_fd, 0, &tspec, NULL)) {
361 sr_err("Failed to set timer");
362 close(devc->timer_fd);
366 devc->channel = g_io_channel_unix_new(devc->timer_fd);
367 g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL);
368 g_io_channel_set_encoding(devc->channel, NULL, NULL);
369 g_io_channel_set_buffered(devc->channel, FALSE);
371 sr_session_source_add_channel(sdi->session, devc->channel,
372 G_IO_IN | G_IO_ERR, 1000, bl_acme_receive_data, (void *)sdi);
374 std_session_send_df_header(sdi, LOG_PREFIX);
375 devc->start_time = g_get_monotonic_time();
380 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
382 struct dev_context *devc;
386 if (sdi->status != SR_ST_ACTIVE)
387 return SR_ERR_DEV_CLOSED;
389 dev_acquisition_close(sdi);
390 sr_session_source_remove_channel(sdi->session, devc->channel);
391 g_io_channel_shutdown(devc->channel, FALSE, NULL);
392 g_io_channel_unref(devc->channel);
393 devc->channel = NULL;
395 std_session_send_df_end(sdi, LOG_PREFIX);
397 if (devc->samples_missed > 0)
398 sr_warn("%" PRIu64 " samples missed", devc->samples_missed);
403 SR_PRIV struct sr_dev_driver baylibre_acme_driver_info = {
404 .name = "baylibre-acme",
405 .longname = "BayLibre ACME (Another Cute Measurement Equipment)",
408 .cleanup = std_cleanup,
410 .dev_list = std_dev_list,
411 .config_get = config_get,
412 .config_set = config_set,
413 .config_list = config_list,
414 .dev_open = dev_open,
415 .dev_close = dev_close,
416 .dev_acquisition_start = dev_acquisition_start,
417 .dev_acquisition_stop = dev_acquisition_stop,