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[] = {
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 GSList *scan(struct sr_dev_driver *di, GSList *options)
58 struct drv_context *drvc;
59 struct dev_context *devc;
60 struct sr_dev_inst *sdi;
70 devc = g_malloc0(sizeof(struct dev_context));
71 devc->samplerate = SR_HZ(10);
73 sdi = g_malloc0(sizeof(struct sr_dev_inst));
74 sdi->status = SR_ST_INACTIVE;
75 sdi->vendor = g_strdup("BayLibre");
76 sdi->model = g_strdup("ACME");
80 status = bl_acme_is_sane();
85 * Iterate over all ACME connectors and check if any probes
88 for (i = 0; i < MAX_PROBES; i++) {
90 * First check if there's an energy probe on this connector. If
91 * not, and we're already at the fifth probe - see if we can
92 * detect a temperature probe.
94 status = bl_acme_detect_probe(bl_acme_get_enrg_addr(i),
95 PROBE_NUM(i), ENRG_PROBE_NAME);
97 /* Energy probe detected. */
98 status = bl_acme_register_probe(sdi, PROBE_ENRG,
99 bl_acme_get_enrg_addr(i), PROBE_NUM(i));
101 sr_err("Error registering power probe %d",
105 } else if (i >= TEMP_PRB_START_INDEX) {
106 status = bl_acme_detect_probe(bl_acme_get_temp_addr(i),
107 PROBE_NUM(i), TEMP_PROBE_NAME);
109 /* Temperature probe detected. */
110 status = bl_acme_register_probe(sdi,PROBE_TEMP,
111 bl_acme_get_temp_addr(i), PROBE_NUM(i));
113 sr_err("Error registering temp "
114 "probe %d", PROBE_NUM(i));
122 * Let's assume there's no ACME device present if no probe
123 * has been registered.
125 if (!sdi->channel_groups)
128 devices = g_slist_append(devices, sdi);
129 drvc->instances = g_slist_append(drvc->instances, sdi);
135 sr_dev_inst_free(sdi);
140 static int dev_open(struct sr_dev_inst *sdi)
144 sdi->status = SR_ST_ACTIVE;
149 static int dev_close(struct sr_dev_inst *sdi)
153 sdi->status = SR_ST_INACTIVE;
158 static int config_get(uint32_t key, GVariant **data,
159 const struct sr_dev_inst *sdi,
160 const struct sr_channel_group *cg)
162 struct dev_context *devc;
171 case SR_CONF_LIMIT_SAMPLES:
172 case SR_CONF_LIMIT_MSEC:
173 ret = sr_sw_limits_config_get(&devc->limits, key, data);
175 case SR_CONF_SAMPLERATE:
176 *data = g_variant_new_uint64(devc->samplerate);
178 case SR_CONF_PROBE_FACTOR:
180 return SR_ERR_CHANNEL_GROUP;
181 ret = bl_acme_get_shunt(cg, &shunt);
183 *data = g_variant_new_uint64(shunt);
185 case SR_CONF_POWER_OFF:
187 return SR_ERR_CHANNEL_GROUP;
188 ret = bl_acme_read_power_state(cg, &power_off);
190 *data = g_variant_new_boolean(power_off);
199 static int config_set(uint32_t key, GVariant *data,
200 const struct sr_dev_inst *sdi,
201 const struct sr_channel_group *cg)
203 struct dev_context *devc;
207 if (sdi->status != SR_ST_ACTIVE)
208 return SR_ERR_DEV_CLOSED;
214 case SR_CONF_LIMIT_SAMPLES:
215 case SR_CONF_LIMIT_MSEC:
216 ret = sr_sw_limits_config_set(&devc->limits, key, data);
218 case SR_CONF_SAMPLERATE:
219 samplerate = g_variant_get_uint64(data);
220 if (samplerate > MAX_SAMPLE_RATE) {
221 sr_err("Maximum sample rate is %d", MAX_SAMPLE_RATE);
222 ret = SR_ERR_SAMPLERATE;
225 devc->samplerate = samplerate;
226 bl_acme_maybe_set_update_interval(sdi, samplerate);
228 case SR_CONF_PROBE_FACTOR:
230 return SR_ERR_CHANNEL_GROUP;
231 ret = bl_acme_set_shunt(cg, g_variant_get_uint64(data));
233 case SR_CONF_POWER_OFF:
235 return SR_ERR_CHANNEL_GROUP;
236 ret = bl_acme_set_power_off(cg, g_variant_get_boolean(data));
245 static int config_list(uint32_t key, GVariant **data,
246 const struct sr_dev_inst *sdi,
247 const struct sr_channel_group *cg)
249 uint32_t devopts_cg[MAX_DEVOPTS_CG];
252 int ret, num_devopts_cg = 0;
260 case SR_CONF_DEVICE_OPTIONS:
261 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
262 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
264 case SR_CONF_SAMPLERATE:
265 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
266 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
267 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
268 g_variant_builder_add(&gvb, "{sv}",
269 "samplerate-steps", gvar);
270 *data = g_variant_builder_end(&gvb);
277 case SR_CONF_DEVICE_OPTIONS:
278 if (bl_acme_get_probe_type(cg) == PROBE_ENRG)
279 devopts_cg[num_devopts_cg++] = HAS_PROBE_FACTOR;
280 if (bl_acme_probe_has_pws(cg))
281 devopts_cg[num_devopts_cg++] = HAS_POWER_OFF;
283 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
284 devopts_cg, num_devopts_cg, sizeof(uint32_t));
294 static void dev_acquisition_close(const struct sr_dev_inst *sdi)
297 struct sr_channel *ch;
299 for (chl = sdi->channels; chl; chl = chl->next) {
301 bl_acme_close_channel(ch);
305 static int dev_acquisition_open(const struct sr_dev_inst *sdi)
308 struct sr_channel *ch;
310 for (chl = sdi->channels; chl; chl = chl->next) {
312 if (bl_acme_open_channel(ch)) {
313 sr_err("Error opening channel %s", ch->name);
314 dev_acquisition_close(sdi);
322 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
324 struct dev_context *devc;
325 struct itimerspec tspec = {
326 .it_interval = { 0, 0 },
330 if (sdi->status != SR_ST_ACTIVE)
331 return SR_ERR_DEV_CLOSED;
333 if (dev_acquisition_open(sdi))
337 devc->samples_missed = 0;
338 devc->timer_fd = timerfd_create(CLOCK_MONOTONIC, 0);
339 if (devc->timer_fd < 0) {
340 sr_err("Error creating timer fd");
344 tspec.it_interval.tv_sec = 0;
345 tspec.it_interval.tv_nsec = SR_HZ_TO_NS(devc->samplerate);
346 tspec.it_value = tspec.it_interval;
348 if (timerfd_settime(devc->timer_fd, 0, &tspec, NULL)) {
349 sr_err("Failed to set timer");
350 close(devc->timer_fd);
354 devc->channel = g_io_channel_unix_new(devc->timer_fd);
355 g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL);
356 g_io_channel_set_encoding(devc->channel, NULL, NULL);
357 g_io_channel_set_buffered(devc->channel, FALSE);
359 sr_session_source_add_channel(sdi->session, devc->channel,
360 G_IO_IN | G_IO_ERR, 1000, bl_acme_receive_data, (void *)sdi);
362 std_session_send_df_header(sdi, LOG_PREFIX);
363 sr_sw_limits_acquisition_start(&devc->limits);
368 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
370 struct dev_context *devc;
374 if (sdi->status != SR_ST_ACTIVE)
375 return SR_ERR_DEV_CLOSED;
377 dev_acquisition_close(sdi);
378 sr_session_source_remove_channel(sdi->session, devc->channel);
379 g_io_channel_shutdown(devc->channel, FALSE, NULL);
380 g_io_channel_unref(devc->channel);
381 devc->channel = NULL;
383 std_session_send_df_end(sdi, LOG_PREFIX);
385 if (devc->samples_missed > 0)
386 sr_warn("%" PRIu64 " samples missed", devc->samples_missed);
391 SR_PRIV struct sr_dev_driver baylibre_acme_driver_info = {
392 .name = "baylibre-acme",
393 .longname = "BayLibre ACME (Another Cute Measurement Equipment)",
396 .cleanup = std_cleanup,
398 .dev_list = std_dev_list,
399 .config_get = config_get,
400 .config_set = config_set,
401 .config_list = config_list,
402 .dev_open = dev_open,
403 .dev_close = dev_close,
404 .dev_acquisition_start = dev_acquisition_start,
405 .dev_acquisition_stop = dev_acquisition_stop,