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