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/>.
22 SR_PRIV struct sr_dev_driver baylibre_acme_driver_info;
24 static 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,
32 * Currently there are two channel-group/probe options for ACME:
33 * - SR_CONF_PROBE_FACTOR - allows to modify current shunt resistance
35 * - SR_CONF_POWER_OFF - allows to remotely cut-off/restore power to
38 * They are not static - we have to check each probe's capabilities in
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)
45 #define MAX_SAMPLE_RATE 500 /* In Hz */
47 static const uint64_t samplerates[] = {
49 SR_HZ(MAX_SAMPLE_RATE),
53 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
55 return std_init(sr_ctx, di, LOG_PREFIX);
58 static GSList *scan(struct sr_dev_driver *di, GSList *options)
60 struct drv_context *drvc;
61 struct dev_context *devc;
62 struct sr_dev_inst *sdi;
72 devc = g_malloc0(sizeof(struct dev_context));
73 devc->samplerate = SR_HZ(10);
75 sdi = g_malloc0(sizeof(struct sr_dev_inst));
76 sdi->status = SR_ST_INACTIVE;
77 sdi->vendor = g_strdup("BayLibre");
78 sdi->model = g_strdup("ACME");
82 status = bl_acme_is_sane();
87 * Iterate over all ACME connectors and check if any probes
90 for (i = 0; i < MAX_PROBES; i++) {
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.
96 status = bl_acme_detect_probe(bl_acme_get_enrg_addr(i),
97 PROBE_NUM(i), ENRG_PROBE_NAME);
99 /* Energy probe detected. */
100 status = bl_acme_register_probe(sdi, PROBE_ENRG,
101 bl_acme_get_enrg_addr(i), PROBE_NUM(i));
103 sr_err("Error registering power probe %d",
107 } else if (i >= TEMP_PRB_START_INDEX) {
108 status = bl_acme_detect_probe(bl_acme_get_temp_addr(i),
109 PROBE_NUM(i), TEMP_PROBE_NAME);
111 /* Temperature probe detected. */
112 status = bl_acme_register_probe(sdi,PROBE_TEMP,
113 bl_acme_get_temp_addr(i), PROBE_NUM(i));
115 sr_err("Error registering temp "
116 "probe %d", PROBE_NUM(i));
124 * Let's assume there's no ACME device present if no probe
125 * has been registered.
127 if (!sdi->channel_groups)
130 devices = g_slist_append(devices, sdi);
131 drvc->instances = g_slist_append(drvc->instances, sdi);
137 sr_dev_inst_free(sdi);
142 static GSList *dev_list(const struct sr_dev_driver *di)
144 return ((struct drv_context *)(di->priv))->instances;
147 static int dev_clear(const struct sr_dev_driver *di)
149 return std_dev_clear(di, NULL);
152 static int dev_open(struct sr_dev_inst *sdi)
156 /* Nothing to do here. */
157 sdi->status = SR_ST_ACTIVE;
162 static int dev_close(struct sr_dev_inst *sdi)
166 /* Nothing to do here. */
167 sdi->status = SR_ST_INACTIVE;
172 static int cleanup(const struct sr_dev_driver *di)
179 static int config_get(uint32_t key, GVariant **data,
180 const struct sr_dev_inst *sdi,
181 const struct sr_channel_group *cg)
183 struct dev_context *devc;
192 case SR_CONF_LIMIT_SAMPLES:
193 *data = g_variant_new_uint64(devc->limit_samples);
195 case SR_CONF_LIMIT_MSEC:
196 *data = g_variant_new_uint64(devc->limit_msec);
198 case SR_CONF_SAMPLERATE:
199 *data = g_variant_new_uint64(devc->samplerate);
201 case SR_CONF_PROBE_FACTOR:
203 return SR_ERR_CHANNEL_GROUP;
204 ret = bl_acme_get_shunt(cg, &shunt);
206 *data = g_variant_new_uint64(shunt);
208 case SR_CONF_POWER_OFF:
210 return SR_ERR_CHANNEL_GROUP;
211 ret = bl_acme_read_power_state(cg, &power_off);
213 *data = g_variant_new_boolean(power_off);
222 static int config_set(uint32_t key, GVariant *data,
223 const struct sr_dev_inst *sdi,
224 const struct sr_channel_group *cg)
226 struct dev_context *devc;
230 if (sdi->status != SR_ST_ACTIVE)
231 return SR_ERR_DEV_CLOSED;
237 case SR_CONF_LIMIT_SAMPLES:
238 devc->limit_samples = g_variant_get_uint64(data);
239 devc->limit_msec = 0;
241 case SR_CONF_LIMIT_MSEC:
242 devc->limit_msec = g_variant_get_uint64(data) * 1000;
243 devc->limit_samples = 0;
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;
252 devc->samplerate = samplerate;
253 bl_acme_maybe_set_update_interval(sdi, samplerate);
255 case SR_CONF_PROBE_FACTOR:
257 return SR_ERR_CHANNEL_GROUP;
258 ret = bl_acme_set_shunt(cg, g_variant_get_uint64(data));
260 case SR_CONF_POWER_OFF:
262 return SR_ERR_CHANNEL_GROUP;
263 ret = bl_acme_set_power_off(cg, g_variant_get_boolean(data));
272 static int config_list(uint32_t key, GVariant **data,
273 const struct sr_dev_inst *sdi,
274 const struct sr_channel_group *cg)
276 uint32_t devopts_cg[MAX_DEVOPTS_CG];
279 int ret, num_devopts_cg = 0;
287 case SR_CONF_DEVICE_OPTIONS:
288 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
289 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
291 case SR_CONF_SAMPLERATE:
292 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
293 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
294 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
295 g_variant_builder_add(&gvb, "{sv}",
296 "samplerate-steps", gvar);
297 *data = g_variant_builder_end(&gvb);
304 case SR_CONF_DEVICE_OPTIONS:
305 if (bl_acme_get_probe_type(cg) == PROBE_ENRG)
306 devopts_cg[num_devopts_cg++] = HAS_PROBE_FACTOR;
307 if (bl_acme_probe_has_pws(cg))
308 devopts_cg[num_devopts_cg++] = HAS_POWER_OFF;
310 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
311 devopts_cg, num_devopts_cg, sizeof(uint32_t));
321 static void dev_acquisition_close(const struct sr_dev_inst *sdi)
324 struct sr_channel *ch;
326 for (chl = sdi->channels; chl; chl = chl->next) {
328 bl_acme_close_channel(ch);
332 static int dev_acquisition_open(const struct sr_dev_inst *sdi)
335 struct sr_channel *ch;
337 for (chl = sdi->channels; chl; chl = chl->next) {
339 if (bl_acme_open_channel(ch)) {
340 sr_err("Error opening channel %s", ch->name);
341 dev_acquisition_close(sdi);
349 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
351 struct dev_context *devc;
355 if (sdi->status != SR_ST_ACTIVE)
356 return SR_ERR_DEV_CLOSED;
358 if (dev_acquisition_open(sdi))
362 devc->samples_read = 0;
364 if (pipe(devc->pipe_fds)) {
365 sr_err("Error setting up pipe");
369 devc->channel = g_io_channel_unix_new(devc->pipe_fds[0]);
370 g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL);
371 g_io_channel_set_encoding(devc->channel, NULL, NULL);
372 g_io_channel_set_buffered(devc->channel, FALSE);
374 sr_session_source_add_channel(sdi->session, devc->channel,
375 G_IO_IN | G_IO_ERR, 1, bl_acme_receive_data, (void *)sdi);
377 /* Send header packet to the session bus. */
378 std_session_send_df_header(sdi, LOG_PREFIX);
379 devc->start_time = g_get_monotonic_time();
384 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
386 struct sr_datafeed_packet packet;
387 struct dev_context *devc;
393 if (sdi->status != SR_ST_ACTIVE)
394 return SR_ERR_DEV_CLOSED;
396 sr_session_source_remove_channel(sdi->session, devc->channel);
397 g_io_channel_shutdown(devc->channel, FALSE, NULL);
398 g_io_channel_unref(devc->channel);
399 devc->channel = NULL;
401 /* Send last packet. */
402 packet.type = SR_DF_END;
403 sr_session_send(sdi, &packet);
408 SR_PRIV struct sr_dev_driver baylibre_acme_driver_info = {
409 .name = "baylibre-acme",
410 .longname = "BayLibre ACME (Another Cute Measurement Equipment)",
415 .dev_list = dev_list,
416 .dev_clear = dev_clear,
417 .config_get = config_get,
418 .config_set = config_set,
419 .config_list = config_list,
420 .dev_open = dev_open,
421 .dev_close = dev_close,
422 .dev_acquisition_start = dev_acquisition_start,
423 .dev_acquisition_stop = dev_acquisition_stop,