]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/baylibre-acme/api.c
sr_dev_close(): Set status to SR_ST_INACTIVE.
[libsigrok.git] / src / hardware / baylibre-acme / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
20#include <config.h>
21#include "protocol.h"
22#include <time.h>
23#include <sys/timerfd.h>
24
25static const uint32_t devopts[] = {
26 SR_CONF_CONTINUOUS,
27 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
28 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
29 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
30};
31
32/*
33 * Currently there are two channel-group/probe options for ACME:
34 * - SR_CONF_PROBE_FACTOR - allows to modify current shunt resistance
35 * calibration
36 * - SR_CONF_POWER_OFF - allows to remotely cut-off/restore power to
37 * measured devices
38 *
39 * They are not static - we have to check each probe's capabilities in
40 * config_list().
41 */
42#define MAX_DEVOPTS_CG 2
43#define HAS_PROBE_FACTOR (SR_CONF_PROBE_FACTOR | SR_CONF_GET | SR_CONF_SET)
44#define HAS_POWER_OFF (SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET)
45
46#define MAX_SAMPLE_RATE 500 /* In Hz */
47
48static const uint64_t samplerates[] = {
49 SR_HZ(1),
50 SR_HZ(MAX_SAMPLE_RATE),
51 SR_HZ(1),
52};
53
54static GSList *scan(struct sr_dev_driver *di, GSList *options)
55{
56 struct dev_context *devc;
57 struct sr_dev_inst *sdi;
58 gboolean status;
59 int i;
60
61 (void)options;
62
63 devc = g_malloc0(sizeof(struct dev_context));
64 devc->samplerate = SR_HZ(10);
65
66 sdi = g_malloc0(sizeof(struct sr_dev_inst));
67 sdi->status = SR_ST_INACTIVE;
68 sdi->vendor = g_strdup("BayLibre");
69 sdi->model = g_strdup("ACME");
70 sdi->priv = devc;
71
72 status = bl_acme_is_sane();
73 if (!status)
74 goto err_out;
75
76 /*
77 * Iterate over all ACME connectors and check if any probes
78 * are present.
79 */
80 for (i = 0; i < MAX_PROBES; i++) {
81 /*
82 * First check if there's an energy probe on this connector. If
83 * not, and we're already at the fifth probe - see if we can
84 * detect a temperature probe.
85 */
86 status = bl_acme_detect_probe(bl_acme_get_enrg_addr(i),
87 PROBE_NUM(i), ENRG_PROBE_NAME);
88 if (status) {
89 /* Energy probe detected. */
90 status = bl_acme_register_probe(sdi, PROBE_ENRG,
91 bl_acme_get_enrg_addr(i), PROBE_NUM(i));
92 if (!status) {
93 sr_err("Error registering power probe %d",
94 PROBE_NUM(i));
95 continue;
96 }
97 } else if (i >= TEMP_PRB_START_INDEX) {
98 status = bl_acme_detect_probe(bl_acme_get_temp_addr(i),
99 PROBE_NUM(i), TEMP_PROBE_NAME);
100 if (status) {
101 /* Temperature probe detected. */
102 status = bl_acme_register_probe(sdi,PROBE_TEMP,
103 bl_acme_get_temp_addr(i), PROBE_NUM(i));
104 if (!status) {
105 sr_err("Error registering temp "
106 "probe %d", PROBE_NUM(i));
107 continue;
108 }
109 }
110 }
111 }
112
113 /*
114 * Let's assume there's no ACME device present if no probe
115 * has been registered.
116 */
117 if (!sdi->channel_groups)
118 goto err_out;
119
120 return std_scan_complete(di, g_slist_append(NULL, sdi));
121
122err_out:
123 g_free(devc);
124 sr_dev_inst_free(sdi);
125
126 return NULL;
127}
128
129static int dev_open(struct sr_dev_inst *sdi)
130{
131 (void)sdi;
132
133 return SR_OK;
134}
135
136static int dev_close(struct sr_dev_inst *sdi)
137{
138 (void)sdi;
139
140 return SR_OK;
141}
142
143static int config_get(uint32_t key, GVariant **data,
144 const struct sr_dev_inst *sdi,
145 const struct sr_channel_group *cg)
146{
147 struct dev_context *devc;
148 int ret;
149 uint64_t shunt;
150 gboolean power_off;
151
152 devc = sdi->priv;
153
154 ret = SR_OK;
155 switch (key) {
156 case SR_CONF_LIMIT_SAMPLES:
157 case SR_CONF_LIMIT_MSEC:
158 ret = sr_sw_limits_config_get(&devc->limits, key, data);
159 break;
160 case SR_CONF_SAMPLERATE:
161 *data = g_variant_new_uint64(devc->samplerate);
162 break;
163 case SR_CONF_PROBE_FACTOR:
164 if (!cg)
165 return SR_ERR_CHANNEL_GROUP;
166 ret = bl_acme_get_shunt(cg, &shunt);
167 if (ret == SR_OK)
168 *data = g_variant_new_uint64(shunt);
169 break;
170 case SR_CONF_POWER_OFF:
171 if (!cg)
172 return SR_ERR_CHANNEL_GROUP;
173 ret = bl_acme_read_power_state(cg, &power_off);
174 if (ret == SR_OK)
175 *data = g_variant_new_boolean(power_off);
176 break;
177 default:
178 return SR_ERR_NA;
179 }
180
181 return ret;
182}
183
184static int config_set(uint32_t key, GVariant *data,
185 const struct sr_dev_inst *sdi,
186 const struct sr_channel_group *cg)
187{
188 struct dev_context *devc;
189 uint64_t samplerate;
190 int ret;
191
192 devc = sdi->priv;
193
194 ret = SR_OK;
195 switch (key) {
196 case SR_CONF_LIMIT_SAMPLES:
197 case SR_CONF_LIMIT_MSEC:
198 ret = sr_sw_limits_config_set(&devc->limits, key, data);
199 break;
200 case SR_CONF_SAMPLERATE:
201 samplerate = g_variant_get_uint64(data);
202 if (samplerate > MAX_SAMPLE_RATE) {
203 sr_err("Maximum sample rate is %d", MAX_SAMPLE_RATE);
204 ret = SR_ERR_SAMPLERATE;
205 break;
206 }
207 devc->samplerate = samplerate;
208 bl_acme_maybe_set_update_interval(sdi, samplerate);
209 break;
210 case SR_CONF_PROBE_FACTOR:
211 if (!cg)
212 return SR_ERR_CHANNEL_GROUP;
213 ret = bl_acme_set_shunt(cg, g_variant_get_uint64(data));
214 break;
215 case SR_CONF_POWER_OFF:
216 if (!cg)
217 return SR_ERR_CHANNEL_GROUP;
218 ret = bl_acme_set_power_off(cg, g_variant_get_boolean(data));
219 break;
220 default:
221 ret = SR_ERR_NA;
222 }
223
224 return ret;
225}
226
227static int config_list(uint32_t key, GVariant **data,
228 const struct sr_dev_inst *sdi,
229 const struct sr_channel_group *cg)
230{
231 uint32_t devopts_cg[MAX_DEVOPTS_CG];
232 GVariant *gvar;
233 GVariantBuilder gvb;
234 int ret, num_devopts_cg = 0;
235
236 (void)sdi;
237 (void)cg;
238
239 ret = SR_OK;
240 if (!cg) {
241 switch (key) {
242 case SR_CONF_DEVICE_OPTIONS:
243 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
244 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
245 break;
246 case SR_CONF_SAMPLERATE:
247 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
248 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
249 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
250 g_variant_builder_add(&gvb, "{sv}",
251 "samplerate-steps", gvar);
252 *data = g_variant_builder_end(&gvb);
253 break;
254 default:
255 return SR_ERR_NA;
256 }
257 } else {
258 switch (key) {
259 case SR_CONF_DEVICE_OPTIONS:
260 if (bl_acme_get_probe_type(cg) == PROBE_ENRG)
261 devopts_cg[num_devopts_cg++] = HAS_PROBE_FACTOR;
262 if (bl_acme_probe_has_pws(cg))
263 devopts_cg[num_devopts_cg++] = HAS_POWER_OFF;
264
265 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
266 devopts_cg, num_devopts_cg, sizeof(uint32_t));
267 break;
268 default:
269 return SR_ERR_NA;
270 }
271 }
272
273 return ret;
274}
275
276static void dev_acquisition_close(const struct sr_dev_inst *sdi)
277{
278 GSList *chl;
279 struct sr_channel *ch;
280
281 for (chl = sdi->channels; chl; chl = chl->next) {
282 ch = chl->data;
283 bl_acme_close_channel(ch);
284 }
285}
286
287static int dev_acquisition_open(const struct sr_dev_inst *sdi)
288{
289 GSList *chl;
290 struct sr_channel *ch;
291
292 for (chl = sdi->channels; chl; chl = chl->next) {
293 ch = chl->data;
294 if (bl_acme_open_channel(ch)) {
295 sr_err("Error opening channel %s", ch->name);
296 dev_acquisition_close(sdi);
297 return SR_ERR;
298 }
299 }
300
301 return 0;
302}
303
304static int dev_acquisition_start(const struct sr_dev_inst *sdi)
305{
306 struct dev_context *devc;
307 struct itimerspec tspec = {
308 .it_interval = { 0, 0 },
309 .it_value = { 0, 0 }
310 };
311
312 if (dev_acquisition_open(sdi))
313 return SR_ERR;
314
315 devc = sdi->priv;
316 devc->samples_missed = 0;
317 devc->timer_fd = timerfd_create(CLOCK_MONOTONIC, 0);
318 if (devc->timer_fd < 0) {
319 sr_err("Error creating timer fd");
320 return SR_ERR;
321 }
322
323 tspec.it_interval.tv_sec = 0;
324 tspec.it_interval.tv_nsec = SR_HZ_TO_NS(devc->samplerate);
325 tspec.it_value = tspec.it_interval;
326
327 if (timerfd_settime(devc->timer_fd, 0, &tspec, NULL)) {
328 sr_err("Failed to set timer");
329 close(devc->timer_fd);
330 return SR_ERR;
331 }
332
333 devc->channel = g_io_channel_unix_new(devc->timer_fd);
334 g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL);
335 g_io_channel_set_encoding(devc->channel, NULL, NULL);
336 g_io_channel_set_buffered(devc->channel, FALSE);
337
338 sr_session_source_add_channel(sdi->session, devc->channel,
339 G_IO_IN | G_IO_ERR, 1000, bl_acme_receive_data, (void *)sdi);
340
341 std_session_send_df_header(sdi);
342 sr_sw_limits_acquisition_start(&devc->limits);
343
344 return SR_OK;
345}
346
347static int dev_acquisition_stop(struct sr_dev_inst *sdi)
348{
349 struct dev_context *devc;
350
351 devc = sdi->priv;
352
353 dev_acquisition_close(sdi);
354 sr_session_source_remove_channel(sdi->session, devc->channel);
355 g_io_channel_shutdown(devc->channel, FALSE, NULL);
356 g_io_channel_unref(devc->channel);
357 devc->channel = NULL;
358
359 std_session_send_df_end(sdi);
360
361 if (devc->samples_missed > 0)
362 sr_warn("%" PRIu64 " samples missed", devc->samples_missed);
363
364 return SR_OK;
365}
366
367static struct sr_dev_driver baylibre_acme_driver_info = {
368 .name = "baylibre-acme",
369 .longname = "BayLibre ACME (Another Cute Measurement Equipment)",
370 .api_version = 1,
371 .init = std_init,
372 .cleanup = std_cleanup,
373 .scan = scan,
374 .dev_list = std_dev_list,
375 .config_get = config_get,
376 .config_set = config_set,
377 .config_list = config_list,
378 .dev_open = dev_open,
379 .dev_close = dev_close,
380 .dev_acquisition_start = dev_acquisition_start,
381 .dev_acquisition_stop = dev_acquisition_stop,
382 .context = NULL,
383};
384SR_REGISTER_DEV_DRIVER(baylibre_acme_driver_info);