]> sigrok.org Git - libsigrok.git/blame - src/hardware/baylibre-acme/protocol.c
Simplify channel creation.
[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
61f2b7f7
BG
248/*
249 * Sets path to the hwmon attribute if this channel group
250 * supports shunt resistance setting. The caller has to supply
251 * a valid GString.
252 */
253static int get_shunt_path(const struct sr_channel_group *cg, GString *path)
254{
255 struct channel_group_priv *cgp;
256 int ret = SR_OK, status;
257
258 cgp = cg->priv;
259
260 if (cgp->probe_type != PROBE_ENRG) {
261 sr_err("Probe doesn't support shunt resistance setting");
262 return SR_ERR_ARG;
263 }
264
265 g_string_append_printf(path,
266 "/sys/class/hwmon/hwmon%d/shunt_resistor",
267 cgp->hwmon_num);
268
269 /*
270 * The shunt_resistor sysfs attribute is available
271 * in the Linux kernel since version 3.20. We have
391e23a9 272 * to notify the user if this attribute is not present.
61f2b7f7
BG
273 */
274 status = g_file_test(path->str, G_FILE_TEST_EXISTS);
275 if (!status) {
391e23a9 276 sr_err("shunt_resistance attribute not present, please update "
61f2b7f7
BG
277 "your kernel to version >=3.20");
278 return SR_ERR_NA;
279 }
280
281 return ret;
282}
283
284SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
285 uint64_t *shunt)
286{
287 GString *path = g_string_sized_new(64);
288 gchar *contents;
289 int status, ret = SR_OK;
290 GError *err = NULL;
291
292 status = get_shunt_path(cg, path);
293 if (status != SR_OK) {
294 ret = status;
295 goto out;
296 }
297
298 status = g_file_get_contents(path->str, &contents, NULL, &err);
299 if (!status) {
300 sr_err("Error reading shunt resistance: %s", err->message);
301 ret = SR_ERR_IO;
302 goto out;
303 }
304
305 *shunt = UOHM_TO_MOHM(strtol(contents, NULL, 10));
306
307out:
308 g_string_free(path, TRUE);
309 return ret;
310}
311
391e23a9 312SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg, uint64_t shunt)
61f2b7f7
BG
313{
314 GString *path = g_string_sized_new(64);;
315 int status, ret = SR_OK;
316 FILE *fd;
317
318 status = get_shunt_path(cg, path);
319 if (status != SR_OK) {
320 ret = status;
321 goto out;
322 }
323
324 /*
325 * Can't use g_file_set_contents() here, as it calls open() with
326 * O_EXEC flag in a sysfs directory thus failing with EACCES.
327 */
328 fd = g_fopen(path->str, "w");
329 if (!fd) {
330 sr_err("Error opening %s: %s", path->str, strerror(errno));
331 g_string_free(path, TRUE);
332 return SR_ERR_IO;
333 }
334
335 g_string_free(path, TRUE);
34527854 336 g_fprintf(fd, "%" PRIu64 "\n", MOHM_TO_UOHM(shunt));
61f2b7f7
BG
337 fclose(fd);
338
339out:
340 g_string_free(path, TRUE);
341 return ret;
342}
343
740ad48a
BG
344SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
345 gboolean *off)
346{
347 struct channel_group_priv *cgp;
348 int val;
349
350 cgp = cg->priv;
351
352 val = sr_gpio_getval_export(pws_info_gpios[cgp->index]);
353 if (val != 1) {
354 sr_err("Probe has no power-switch");
355 return SR_ERR_ARG;
356 }
357
358 val = sr_gpio_getval_export(pws_gpios[cgp->index]);
359 *off = val ? FALSE : TRUE;
360
361 return SR_OK;
362}
363
364SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
365 gboolean off)
366{
367 struct channel_group_priv *cgp;
368 int val;
369
370 cgp = cg->priv;
371
372 val = sr_gpio_getval_export(pws_info_gpios[cgp->index]);
373 if (val != 1) {
374 sr_err("Probe has no power-switch");
375 return SR_ERR_ARG;
376 }
377
378 val = sr_gpio_setval_export(pws_gpios[cgp->index], off ? 0 : 1);
379
380 return SR_OK;
381}
382
6b80b80d 383static int channel_to_mq(struct sr_channel *ch)
dfaee1de 384{
6b80b80d
BG
385 struct channel_priv *chp;
386
387 chp = ch->priv;
388
389 switch (chp->ch_type) {
390 case ENRG_PWR:
391 return SR_MQ_POWER;
392 case ENRG_CURR:
393 return SR_MQ_CURRENT;
394 case ENRG_VOL:
395 return SR_MQ_VOLTAGE;
391e23a9 396 case TEMP_IN: /* Fallthrough */
6b80b80d
BG
397 case TEMP_OUT:
398 return SR_MQ_TEMPERATURE;
399 default:
400 return -1;
401 }
402}
403
404static int channel_to_unit(struct sr_channel *ch)
405{
406 struct channel_priv *chp;
407
408 chp = ch->priv;
409
410 switch (chp->ch_type) {
411 case ENRG_PWR:
412 return SR_UNIT_WATT;
413 case ENRG_CURR:
414 return SR_UNIT_AMPERE;
415 case ENRG_VOL:
416 return SR_UNIT_VOLT;
391e23a9 417 case TEMP_IN: /* Fallthrough */
6b80b80d
BG
418 case TEMP_OUT:
419 return SR_UNIT_CELSIUS;
420 default:
421 return -1;
422 }
423}
424
425/* We need to scale measurements down from the units used by the drivers. */
426static float adjust_data(int val, int type)
427{
428 switch (type) {
429 case ENRG_PWR:
430 return ((float)val) / 1000000.0;
391e23a9
UH
431 case ENRG_CURR: /* Fallthrough */
432 case ENRG_VOL: /* Fallthrough */
433 case TEMP_IN: /* Fallthrough */
6b80b80d
BG
434 case TEMP_OUT:
435 return ((float)val) / 1000.0;
436 default:
437 return 0.0;
438 }
439}
440
441static float read_sample(struct sr_channel *ch)
442{
443 struct channel_priv *chp;
444 char path[64], *file, buf[16];
445 ssize_t len;
446 int fd;
447
448 chp = ch->priv;
449
450 switch (chp->ch_type) {
451 case ENRG_PWR: file = "power1_input"; break;
452 case ENRG_CURR: file = "curr1_input"; break;
453 case ENRG_VOL: file = "in1_input"; break;
454 case TEMP_IN: file = "temp1_input"; break;
455 case TEMP_OUT: file = "temp2_input"; break;
456 default:
391e23a9 457 sr_err("Invalid channel type: %d.", chp->ch_type);
6b80b80d
BG
458 return -1.0;
459 }
460
391e23a9 461 snprintf(path, sizeof(path), "/sys/class/hwmon/hwmon%d/%s",
6b80b80d
BG
462 chp->probe->hwmon_num, file);
463 fd = open(path, O_RDONLY);
464 if (fd < 0) {
465 sr_err("Error opening %s: %s", path, strerror(errno));
466 ch->enabled = FALSE;
467 return -1.0;
468 }
469
470 len = read(fd, buf, sizeof(buf));
471 close(fd);
472 if (len < 0) {
391e23a9 473 sr_err("Error reading from %s: %s", path, strerror(errno));
6b80b80d
BG
474 ch->enabled = FALSE;
475 return -1.0;
476 }
477
478 return adjust_data(strtol(buf, NULL, 10), chp->ch_type);
479}
480
481SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data)
482{
483 uint32_t cur_time, elapsed_time, diff_time;
484 int64_t time_to_sleep;
485 struct sr_datafeed_packet packet, framep;
486 struct sr_datafeed_analog analog;
487 struct sr_dev_inst *sdi;
488 struct sr_channel *ch;
dfaee1de 489 struct dev_context *devc;
6b80b80d
BG
490 GSList *chl, chonly;
491 float valf;
dfaee1de
BG
492
493 (void)fd;
6b80b80d
BG
494 (void)revents;
495
496 sdi = cb_data;
497 if (!sdi)
498 return TRUE;
dfaee1de 499
6b80b80d
BG
500 devc = sdi->priv;
501 if (!devc)
dfaee1de
BG
502 return TRUE;
503
6b80b80d
BG
504 packet.type = SR_DF_ANALOG;
505 packet.payload = &analog;
506 memset(&analog, 0, sizeof(analog));
507 analog.data = &valf;
508
509 /*
391e23a9 510 * Reading from sysfs takes some time - try to keep up with samplerate.
6b80b80d
BG
511 */
512 if (devc->samples_read) {
513 cur_time = g_get_monotonic_time();
514 diff_time = cur_time - devc->last_sample_fin;
515 time_to_sleep = G_USEC_PER_SEC / devc->samplerate - diff_time;
516 if (time_to_sleep > 0)
517 g_usleep(time_to_sleep);
518 }
519
520 framep.type = SR_DF_FRAME_BEGIN;
521 sr_session_send(cb_data, &framep);
522
523 /*
524 * Due to different units used in each channel we're sending
525 * samples one-by-one.
526 */
527 for (chl = sdi->channels; chl; chl = chl->next) {
528 ch = chl->data;
529 if (!ch->enabled)
530 continue;
531 chonly.next = NULL;
532 chonly.data = ch;
533 analog.channels = &chonly;
534 analog.num_samples = 1;
535 analog.mq = channel_to_mq(chl->data);
536 analog.unit = channel_to_unit(ch);
537
538 valf = read_sample(ch);
539
540 sr_session_send(cb_data, &packet);
541 }
542
543 framep.type = SR_DF_FRAME_END;
544 sr_session_send(cb_data, &framep);
545
546 devc->samples_read++;
547 if (devc->limit_samples > 0 &&
548 devc->samples_read >= devc->limit_samples) {
549 sr_info("Requested number of samples reached.");
550 sdi->driver->dev_acquisition_stop(sdi, cb_data);
551 devc->last_sample_fin = g_get_monotonic_time();
dfaee1de 552 return TRUE;
6b80b80d
BG
553 } else if (devc->limit_msec > 0) {
554 cur_time = g_get_monotonic_time();
555 elapsed_time = cur_time - devc->start_time;
dfaee1de 556
6b80b80d
BG
557 if (elapsed_time >= devc->limit_msec) {
558 sr_info("Sampling time limit reached.");
559 sdi->driver->dev_acquisition_stop(sdi, cb_data);
560 devc->last_sample_fin = g_get_monotonic_time();
561 return TRUE;
562 }
dfaee1de
BG
563 }
564
6b80b80d 565 devc->last_sample_fin = g_get_monotonic_time();
dfaee1de
BG
566 return TRUE;
567}