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