]> sigrok.org Git - libsigrok.git/blame - src/hardware/baylibre-acme/protocol.c
baylibre-acme: Dynamically check per probe config options.
[libsigrok.git] / src / hardware / baylibre-acme / protocol.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
6b80b80d 20#include <string.h>
391e23a9 21#include <stdlib.h>
6b80b80d 22#include <errno.h>
391e23a9 23#include <fcntl.h>
61f2b7f7 24#include <glib/gstdio.h>
dfaee1de 25#include "protocol.h"
740ad48a 26#include "gpio.h"
dfaee1de 27
6b80b80d
BG
28struct channel_group_priv {
29 int hwmon_num;
61f2b7f7 30 int probe_type;
740ad48a 31 int index;
6b80b80d
BG
32};
33
34struct channel_priv {
35 int ch_type;
36 struct channel_group_priv *probe;
37};
38
39static const uint8_t enrg_i2c_addrs[] = {
40 0x40, 0x41, 0x44, 0x45, 0x42, 0x43, 0x46, 0x47,
41};
42
43static const uint8_t temp_i2c_addrs[] = {
44 0x0, 0x0, 0x0, 0x0, 0x4c, 0x49, 0x4f, 0x4b,
45};
46
740ad48a 47static const uint32_t pws_gpios[] = {
391e23a9 48 486, 498, 502, 482, 478, 506, 510, 474,
740ad48a
BG
49};
50
51static const uint32_t pws_info_gpios[] = {
52 487, 499, 503, 483, 479, 507, 511, 475,
53};
54
61f2b7f7
BG
55#define MOHM_TO_UOHM(x) ((x) * 1000)
56#define UOHM_TO_MOHM(x) ((x) / 1000)
57
6b80b80d
BG
58SR_PRIV uint8_t bl_acme_get_enrg_addr(int index)
59{
60 return enrg_i2c_addrs[index];
61}
62
63SR_PRIV uint8_t bl_acme_get_temp_addr(int index)
64{
65 return temp_i2c_addrs[index];
66}
67
68SR_PRIV gboolean bl_acme_is_sane(void)
69{
70 gboolean status;
71
72 /*
73 * We expect sysfs to be present and mounted at /sys, ina226 and
74 * tmp435 sensors detected by the system and their appropriate
75 * drivers loaded and functional.
76 */
77 status = g_file_test("/sys", G_FILE_TEST_IS_DIR);
78 if (!status) {
79 sr_err("/sys/ directory not found - sysfs not mounted?");
80 return FALSE;
81 }
82
83 return TRUE;
84}
85
86static void probe_name_path(unsigned int addr, GString *path)
87{
88 g_string_printf(path,
89 "/sys/class/i2c-adapter/i2c-1/1-00%02x/name", addr);
90}
91
92/*
93 * For given address fill buf with the path to appropriate hwmon entry.
94 */
95static void probe_hwmon_path(unsigned int addr, GString *path)
96{
97 g_string_printf(path,
98 "/sys/class/i2c-adapter/i2c-1/1-00%02x/hwmon", addr);
99}
100
101SR_PRIV gboolean bl_acme_detect_probe(unsigned int addr,
102 int prb_num, const char *prb_name)
103{
104 gboolean ret = FALSE, status;
105 char *buf = NULL;
106 GString *path = g_string_sized_new(64);
107 GError *err = NULL;
108 gsize size;
109
110 probe_name_path(addr, path);
111 status = g_file_get_contents(path->str, &buf, &size, &err);
112 if (!status) {
113 sr_dbg("Name for probe %d can't be read: %s",
114 prb_num, err->message);
115 g_string_free(path, TRUE);
116 return ret;
6b80b80d
BG
117 }
118
391e23a9 119 if (!strncmp(buf, prb_name, strlen(prb_name))) {
6b80b80d
BG
120 /*
121 * Correct driver registered on this address - but is
122 * there an actual probe connected?
123 */
124 probe_hwmon_path(addr, path);
125 status = g_file_test(path->str, G_FILE_TEST_IS_DIR);
126 if (status) {
127 /* We have found an ACME probe. */
128 ret = TRUE;
129 }
130 }
131
132 g_free(buf);
133 g_string_free(path, TRUE);
134
135 return ret;
136}
137
138static int get_hwmon_index(unsigned int addr)
139{
140 int status, hwmon;
141 GString *path = g_string_sized_new(64);
142 GError *err = NULL;
143 GDir *dir;
144
145 probe_hwmon_path(addr, path);
146 dir = g_dir_open(path->str, 0, &err);
391e23a9 147 if (!dir) {
6b80b80d
BG
148 sr_err("Error opening %s: %s", path->str, err->message);
149 g_string_free(path, TRUE);
150 return -1;
151 }
152
153 g_string_free(path, TRUE);
154
155 /*
156 * The directory should contain a single file named hwmonX where X
157 * is the hwmon index.
158 */
159 status = sscanf(g_dir_read_name(dir), "hwmon%d", &hwmon);
160 g_dir_close(dir);
161 if (status != 1) {
162 sr_err("Unable to determine the hwmon entry");
163 return -1;
164 }
165
166 return hwmon;
167}
168
391e23a9 169static void append_channel(struct sr_dev_inst *sdi, struct sr_channel_group *cg,
6b80b80d
BG
170 int index, int type)
171{
172 struct channel_priv *cp;
173 struct dev_context *devc;
174 struct sr_channel *ch;
175 char *name;
176
177 devc = sdi->priv;
178
179 switch (type) {
180 case ENRG_PWR:
181 name = g_strdup_printf("P%d_ENRG_PWR", index);
182 break;
183 case ENRG_CURR:
184 name = g_strdup_printf("P%d_ENRG_CURR", index);
185 break;
186 case ENRG_VOL:
187 name = g_strdup_printf("P%d_ENRG_VOL", index);
188 break;
189 case TEMP_IN:
190 name = g_strdup_printf("P%d_TEMP_IN", index);
191 break;
192 case TEMP_OUT:
193 name = g_strdup_printf("P%d_TEMP_OUT", index);
194 break;
195 default:
391e23a9 196 sr_err("Invalid channel type: %d.", type);
6b80b80d
BG
197 return;
198 }
199
200 cp = g_malloc0(sizeof(struct channel_priv));
201 cp->ch_type = type;
202 cp->probe = cg->priv;
203
5e23fcab 204 ch = sr_channel_new(sdi, devc->num_channels++,
6b80b80d
BG
205 SR_CHANNEL_ANALOG, TRUE, name);
206 g_free(name);
207
208 ch->priv = cp;
209 cg->channels = g_slist_append(cg->channels, ch);
6b80b80d
BG
210}
211
212SR_PRIV gboolean bl_acme_register_probe(struct sr_dev_inst *sdi, int type,
213 unsigned int addr, int prb_num)
214{
215 struct sr_channel_group *cg;
216 struct channel_group_priv *cgp;
217 int hwmon;
218
219 /* Obtain the hwmon index. */
220 hwmon = get_hwmon_index(addr);
221 if (hwmon < 0)
222 return FALSE;
223
224 cg = g_malloc0(sizeof(struct sr_channel_group));
225 cgp = g_malloc0(sizeof(struct channel_group_priv));
226 cgp->hwmon_num = hwmon;
61f2b7f7 227 cgp->probe_type = type;
740ad48a 228 cgp->index = prb_num - 1;
6b80b80d
BG
229 cg->name = g_strdup_printf("Probe_%d", prb_num);
230 cg->priv = cgp;
231
232 if (type == PROBE_ENRG) {
233 append_channel(sdi, cg, prb_num, ENRG_PWR);
234 append_channel(sdi, cg, prb_num, ENRG_CURR);
235 append_channel(sdi, cg, prb_num, ENRG_VOL);
236 } else if (type == PROBE_TEMP) {
237 append_channel(sdi, cg, prb_num, TEMP_IN);
238 append_channel(sdi, cg, prb_num, TEMP_OUT);
239 } else {
391e23a9 240 sr_err("Invalid probe type: %d.", type);
6b80b80d
BG
241 }
242
243 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
244
245 return TRUE;
246}
247
1fe04eb8
BG
248SR_PRIV int bl_acme_get_probe_type(const struct sr_channel_group *cg)
249{
250 struct channel_group_priv *cgp = cg->priv;
251
252 return cgp->probe_type;
253}
254
255SR_PRIV int bl_acme_probe_has_pws(const struct sr_channel_group *cg)
256{
257 struct channel_group_priv *cgp = cg->priv;
258
259 return sr_gpio_getval_export(pws_info_gpios[cgp->index]);
260}
261
61f2b7f7
BG
262/*
263 * Sets path to the hwmon attribute if this channel group
264 * supports shunt resistance setting. The caller has to supply
265 * a valid GString.
266 */
267static int get_shunt_path(const struct sr_channel_group *cg, GString *path)
268{
269 struct channel_group_priv *cgp;
270 int ret = SR_OK, status;
271
272 cgp = cg->priv;
273
274 if (cgp->probe_type != PROBE_ENRG) {
275 sr_err("Probe doesn't support shunt resistance setting");
276 return SR_ERR_ARG;
277 }
278
279 g_string_append_printf(path,
280 "/sys/class/hwmon/hwmon%d/shunt_resistor",
281 cgp->hwmon_num);
282
283 /*
284 * The shunt_resistor sysfs attribute is available
285 * in the Linux kernel since version 3.20. We have
391e23a9 286 * to notify the user if this attribute is not present.
61f2b7f7
BG
287 */
288 status = g_file_test(path->str, G_FILE_TEST_EXISTS);
289 if (!status) {
391e23a9 290 sr_err("shunt_resistance attribute not present, please update "
61f2b7f7
BG
291 "your kernel to version >=3.20");
292 return SR_ERR_NA;
293 }
294
295 return ret;
296}
297
298SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
299 uint64_t *shunt)
300{
301 GString *path = g_string_sized_new(64);
302 gchar *contents;
303 int status, ret = SR_OK;
304 GError *err = NULL;
305
306 status = get_shunt_path(cg, path);
307 if (status != SR_OK) {
308 ret = status;
309 goto out;
310 }
311
312 status = g_file_get_contents(path->str, &contents, NULL, &err);
313 if (!status) {
314 sr_err("Error reading shunt resistance: %s", err->message);
315 ret = SR_ERR_IO;
316 goto out;
317 }
318
319 *shunt = UOHM_TO_MOHM(strtol(contents, NULL, 10));
320
321out:
322 g_string_free(path, TRUE);
323 return ret;
324}
325
391e23a9 326SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg, uint64_t shunt)
61f2b7f7
BG
327{
328 GString *path = g_string_sized_new(64);;
329 int status, ret = SR_OK;
330 FILE *fd;
331
332 status = get_shunt_path(cg, path);
333 if (status != SR_OK) {
334 ret = status;
335 goto out;
336 }
337
338 /*
339 * Can't use g_file_set_contents() here, as it calls open() with
340 * O_EXEC flag in a sysfs directory thus failing with EACCES.
341 */
342 fd = g_fopen(path->str, "w");
343 if (!fd) {
344 sr_err("Error opening %s: %s", path->str, strerror(errno));
350b8b07
BG
345 ret = SR_ERR_IO;
346 goto out;
61f2b7f7
BG
347 }
348
34527854 349 g_fprintf(fd, "%" PRIu64 "\n", MOHM_TO_UOHM(shunt));
61f2b7f7
BG
350 fclose(fd);
351
352out:
353 g_string_free(path, TRUE);
354 return ret;
355}
356
740ad48a
BG
357SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
358 gboolean *off)
359{
360 struct channel_group_priv *cgp;
361 int val;
362
363 cgp = cg->priv;
364
1fe04eb8 365 if (!bl_acme_probe_has_pws(cg)) {
740ad48a
BG
366 sr_err("Probe has no power-switch");
367 return SR_ERR_ARG;
368 }
369
370 val = sr_gpio_getval_export(pws_gpios[cgp->index]);
371 *off = val ? FALSE : TRUE;
372
373 return SR_OK;
374}
375
376SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
377 gboolean off)
378{
379 struct channel_group_priv *cgp;
380 int val;
381
382 cgp = cg->priv;
383
1fe04eb8 384 if (!bl_acme_probe_has_pws(cg)) {
740ad48a
BG
385 sr_err("Probe has no power-switch");
386 return SR_ERR_ARG;
387 }
388
389 val = sr_gpio_setval_export(pws_gpios[cgp->index], off ? 0 : 1);
390
391 return SR_OK;
392}
393
6b80b80d 394static int channel_to_mq(struct sr_channel *ch)
dfaee1de 395{
6b80b80d
BG
396 struct channel_priv *chp;
397
398 chp = ch->priv;
399
400 switch (chp->ch_type) {
401 case ENRG_PWR:
402 return SR_MQ_POWER;
403 case ENRG_CURR:
404 return SR_MQ_CURRENT;
405 case ENRG_VOL:
406 return SR_MQ_VOLTAGE;
391e23a9 407 case TEMP_IN: /* Fallthrough */
6b80b80d
BG
408 case TEMP_OUT:
409 return SR_MQ_TEMPERATURE;
410 default:
411 return -1;
412 }
413}
414
415static int channel_to_unit(struct sr_channel *ch)
416{
417 struct channel_priv *chp;
418
419 chp = ch->priv;
420
421 switch (chp->ch_type) {
422 case ENRG_PWR:
423 return SR_UNIT_WATT;
424 case ENRG_CURR:
425 return SR_UNIT_AMPERE;
426 case ENRG_VOL:
427 return SR_UNIT_VOLT;
391e23a9 428 case TEMP_IN: /* Fallthrough */
6b80b80d
BG
429 case TEMP_OUT:
430 return SR_UNIT_CELSIUS;
431 default:
432 return -1;
433 }
434}
435
436/* We need to scale measurements down from the units used by the drivers. */
437static float adjust_data(int val, int type)
438{
439 switch (type) {
440 case ENRG_PWR:
441 return ((float)val) / 1000000.0;
391e23a9
UH
442 case ENRG_CURR: /* Fallthrough */
443 case ENRG_VOL: /* Fallthrough */
444 case TEMP_IN: /* Fallthrough */
6b80b80d
BG
445 case TEMP_OUT:
446 return ((float)val) / 1000.0;
447 default:
448 return 0.0;
449 }
450}
451
452static float read_sample(struct sr_channel *ch)
453{
454 struct channel_priv *chp;
455 char path[64], *file, buf[16];
456 ssize_t len;
457 int fd;
458
459 chp = ch->priv;
460
461 switch (chp->ch_type) {
462 case ENRG_PWR: file = "power1_input"; break;
463 case ENRG_CURR: file = "curr1_input"; break;
464 case ENRG_VOL: file = "in1_input"; break;
465 case TEMP_IN: file = "temp1_input"; break;
466 case TEMP_OUT: file = "temp2_input"; break;
467 default:
391e23a9 468 sr_err("Invalid channel type: %d.", chp->ch_type);
6b80b80d
BG
469 return -1.0;
470 }
471
391e23a9 472 snprintf(path, sizeof(path), "/sys/class/hwmon/hwmon%d/%s",
6b80b80d
BG
473 chp->probe->hwmon_num, file);
474 fd = open(path, O_RDONLY);
475 if (fd < 0) {
476 sr_err("Error opening %s: %s", path, strerror(errno));
477 ch->enabled = FALSE;
478 return -1.0;
479 }
480
481 len = read(fd, buf, sizeof(buf));
482 close(fd);
483 if (len < 0) {
391e23a9 484 sr_err("Error reading from %s: %s", path, strerror(errno));
6b80b80d
BG
485 ch->enabled = FALSE;
486 return -1.0;
487 }
488
489 return adjust_data(strtol(buf, NULL, 10), chp->ch_type);
490}
491
492SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data)
493{
494 uint32_t cur_time, elapsed_time, diff_time;
495 int64_t time_to_sleep;
496 struct sr_datafeed_packet packet, framep;
497 struct sr_datafeed_analog analog;
498 struct sr_dev_inst *sdi;
499 struct sr_channel *ch;
dfaee1de 500 struct dev_context *devc;
6b80b80d
BG
501 GSList *chl, chonly;
502 float valf;
dfaee1de
BG
503
504 (void)fd;
6b80b80d
BG
505 (void)revents;
506
507 sdi = cb_data;
508 if (!sdi)
509 return TRUE;
dfaee1de 510
6b80b80d
BG
511 devc = sdi->priv;
512 if (!devc)
dfaee1de
BG
513 return TRUE;
514
6b80b80d
BG
515 packet.type = SR_DF_ANALOG;
516 packet.payload = &analog;
d0148a50 517 memset(&analog, 0, sizeof(struct sr_datafeed_analog));
6b80b80d
BG
518 analog.data = &valf;
519
520 /*
391e23a9 521 * Reading from sysfs takes some time - try to keep up with samplerate.
6b80b80d
BG
522 */
523 if (devc->samples_read) {
524 cur_time = g_get_monotonic_time();
525 diff_time = cur_time - devc->last_sample_fin;
526 time_to_sleep = G_USEC_PER_SEC / devc->samplerate - diff_time;
527 if (time_to_sleep > 0)
528 g_usleep(time_to_sleep);
529 }
530
531 framep.type = SR_DF_FRAME_BEGIN;
532 sr_session_send(cb_data, &framep);
533
534 /*
535 * Due to different units used in each channel we're sending
536 * samples one-by-one.
537 */
538 for (chl = sdi->channels; chl; chl = chl->next) {
539 ch = chl->data;
540 if (!ch->enabled)
541 continue;
542 chonly.next = NULL;
543 chonly.data = ch;
544 analog.channels = &chonly;
545 analog.num_samples = 1;
546 analog.mq = channel_to_mq(chl->data);
547 analog.unit = channel_to_unit(ch);
548
549 valf = read_sample(ch);
550
551 sr_session_send(cb_data, &packet);
552 }
553
554 framep.type = SR_DF_FRAME_END;
555 sr_session_send(cb_data, &framep);
556
557 devc->samples_read++;
558 if (devc->limit_samples > 0 &&
559 devc->samples_read >= devc->limit_samples) {
560 sr_info("Requested number of samples reached.");
561 sdi->driver->dev_acquisition_stop(sdi, cb_data);
562 devc->last_sample_fin = g_get_monotonic_time();
dfaee1de 563 return TRUE;
6b80b80d
BG
564 } else if (devc->limit_msec > 0) {
565 cur_time = g_get_monotonic_time();
566 elapsed_time = cur_time - devc->start_time;
dfaee1de 567
6b80b80d
BG
568 if (elapsed_time >= devc->limit_msec) {
569 sr_info("Sampling time limit reached.");
570 sdi->driver->dev_acquisition_stop(sdi, cb_data);
571 devc->last_sample_fin = g_get_monotonic_time();
572 return TRUE;
573 }
dfaee1de
BG
574 }
575
6b80b80d 576 devc->last_sample_fin = g_get_monotonic_time();
dfaee1de
BG
577 return TRUE;
578}