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