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/>.
24 #include <glib/gstdio.h>
28 struct channel_group_priv {
37 struct channel_group_priv *probe;
40 static const uint8_t enrg_i2c_addrs[] = {
41 0x40, 0x41, 0x44, 0x45, 0x42, 0x43, 0x46, 0x47,
44 static const uint8_t temp_i2c_addrs[] = {
45 0x0, 0x0, 0x0, 0x0, 0x4c, 0x49, 0x4f, 0x4b,
48 static const uint32_t pws_gpios[] = {
49 486, 498, 502, 482, 478, 506, 510, 474,
52 static const uint32_t pws_info_gpios[] = {
53 487, 499, 503, 483, 479, 507, 511, 475,
56 #define MOHM_TO_UOHM(x) ((x) * 1000)
57 #define UOHM_TO_MOHM(x) ((x) / 1000)
59 SR_PRIV uint8_t bl_acme_get_enrg_addr(int index)
61 return enrg_i2c_addrs[index];
64 SR_PRIV uint8_t bl_acme_get_temp_addr(int index)
66 return temp_i2c_addrs[index];
69 SR_PRIV gboolean bl_acme_is_sane(void)
74 * We expect sysfs to be present and mounted at /sys, ina226 and
75 * tmp435 sensors detected by the system and their appropriate
76 * drivers loaded and functional.
78 status = g_file_test("/sys", G_FILE_TEST_IS_DIR);
80 sr_err("/sys/ directory not found - sysfs not mounted?");
87 static void probe_name_path(unsigned int addr, GString *path)
90 "/sys/class/i2c-adapter/i2c-1/1-00%02x/name", addr);
94 * For given address fill buf with the path to appropriate hwmon entry.
96 static void probe_hwmon_path(unsigned int addr, GString *path)
99 "/sys/class/i2c-adapter/i2c-1/1-00%02x/hwmon", addr);
102 SR_PRIV gboolean bl_acme_detect_probe(unsigned int addr,
103 int prb_num, const char *prb_name)
105 gboolean ret = FALSE, status;
107 GString *path = g_string_sized_new(64);
111 probe_name_path(addr, path);
112 status = g_file_get_contents(path->str, &buf, &size, &err);
114 sr_dbg("Name for probe %d can't be read: %s",
115 prb_num, err->message);
116 g_string_free(path, TRUE);
120 if (!strncmp(buf, prb_name, strlen(prb_name))) {
122 * Correct driver registered on this address - but is
123 * there an actual probe connected?
125 probe_hwmon_path(addr, path);
126 status = g_file_test(path->str, G_FILE_TEST_IS_DIR);
128 /* We have found an ACME probe. */
134 g_string_free(path, TRUE);
139 static int get_hwmon_index(unsigned int addr)
142 GString *path = g_string_sized_new(64);
146 probe_hwmon_path(addr, path);
147 dir = g_dir_open(path->str, 0, &err);
149 sr_err("Error opening %s: %s", path->str, err->message);
150 g_string_free(path, TRUE);
154 g_string_free(path, TRUE);
157 * The directory should contain a single file named hwmonX where X
158 * is the hwmon index.
160 status = sscanf(g_dir_read_name(dir), "hwmon%d", &hwmon);
163 sr_err("Unable to determine the hwmon entry");
170 static void append_channel(struct sr_dev_inst *sdi, struct sr_channel_group *cg,
173 struct channel_priv *cp;
174 struct dev_context *devc;
175 struct sr_channel *ch;
182 name = g_strdup_printf("P%d_ENRG_PWR", index);
185 name = g_strdup_printf("P%d_ENRG_CURR", index);
188 name = g_strdup_printf("P%d_ENRG_VOL", index);
191 name = g_strdup_printf("P%d_TEMP_IN", index);
194 name = g_strdup_printf("P%d_TEMP_OUT", index);
197 sr_err("Invalid channel type: %d.", type);
201 cp = g_malloc0(sizeof(struct channel_priv));
203 cp->probe = cg->priv;
205 ch = sr_channel_new(sdi, devc->num_channels++,
206 SR_CHANNEL_ANALOG, TRUE, name);
210 cg->channels = g_slist_append(cg->channels, ch);
213 SR_PRIV gboolean bl_acme_register_probe(struct sr_dev_inst *sdi, int type,
214 unsigned int addr, int prb_num)
216 struct sr_channel_group *cg;
217 struct channel_group_priv *cgp;
220 /* Obtain the hwmon index. */
221 hwmon = get_hwmon_index(addr);
225 cg = g_malloc0(sizeof(struct sr_channel_group));
226 cgp = g_malloc0(sizeof(struct channel_group_priv));
227 cgp->hwmon_num = hwmon;
228 cgp->probe_type = type;
229 cgp->index = prb_num - 1;
230 cg->name = g_strdup_printf("Probe_%d", prb_num);
233 if (type == PROBE_ENRG) {
234 append_channel(sdi, cg, prb_num, ENRG_PWR);
235 append_channel(sdi, cg, prb_num, ENRG_CURR);
236 append_channel(sdi, cg, prb_num, ENRG_VOL);
237 } else if (type == PROBE_TEMP) {
238 append_channel(sdi, cg, prb_num, TEMP_IN);
239 append_channel(sdi, cg, prb_num, TEMP_OUT);
241 sr_err("Invalid probe type: %d.", type);
244 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
249 SR_PRIV int bl_acme_get_probe_type(const struct sr_channel_group *cg)
251 struct channel_group_priv *cgp = cg->priv;
253 return cgp->probe_type;
256 SR_PRIV int bl_acme_probe_has_pws(const struct sr_channel_group *cg)
258 struct channel_group_priv *cgp = cg->priv;
260 return sr_gpio_getval_export(pws_info_gpios[cgp->index]);
264 * Sets path to the hwmon attribute if this channel group
265 * supports shunt resistance setting. The caller has to supply
268 static int get_shunt_path(const struct sr_channel_group *cg, GString *path)
270 struct channel_group_priv *cgp;
271 int ret = SR_OK, status;
275 if (cgp->probe_type != PROBE_ENRG) {
276 sr_err("Probe doesn't support shunt resistance setting");
280 g_string_append_printf(path,
281 "/sys/class/hwmon/hwmon%d/shunt_resistor",
285 * The shunt_resistor sysfs attribute is available
286 * in the Linux kernel since version 3.20. We have
287 * to notify the user if this attribute is not present.
289 status = g_file_test(path->str, G_FILE_TEST_EXISTS);
291 sr_err("shunt_resistance attribute not present, please update "
292 "your kernel to version >=3.20");
300 * Try setting the update_interval sysfs attribute for each probe according
303 SR_PRIV void bl_acme_maybe_set_update_interval(const struct sr_dev_inst *sdi,
306 struct sr_channel_group *cg;
307 struct channel_group_priv *cgp;
312 for (l = sdi->channel_groups; l != NULL; l = l->next) {
316 hwmon = g_string_sized_new(64);
317 g_string_append_printf(hwmon,
318 "/sys/class/hwmon/hwmon%d/update_interval",
321 if (g_file_test(hwmon->str, G_FILE_TEST_EXISTS)) {
322 fd = g_fopen(hwmon->str, "w");
324 g_string_free(hwmon, TRUE);
328 g_fprintf(fd, "%" PRIu64 "\n", 1000 / samplerate);
332 g_string_free(hwmon, TRUE);
336 SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
339 GString *path = g_string_sized_new(64);
341 int status, ret = SR_OK;
344 status = get_shunt_path(cg, path);
345 if (status != SR_OK) {
350 status = g_file_get_contents(path->str, &contents, NULL, &err);
352 sr_err("Error reading shunt resistance: %s", err->message);
357 *shunt = UOHM_TO_MOHM(strtol(contents, NULL, 10));
360 g_string_free(path, TRUE);
364 SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg, uint64_t shunt)
366 GString *path = g_string_sized_new(64);;
367 int status, ret = SR_OK;
370 status = get_shunt_path(cg, path);
371 if (status != SR_OK) {
377 * Can't use g_file_set_contents() here, as it calls open() with
378 * O_EXEC flag in a sysfs directory thus failing with EACCES.
380 fd = g_fopen(path->str, "w");
382 sr_err("Error opening %s: %s", path->str, strerror(errno));
387 g_fprintf(fd, "%" PRIu64 "\n", MOHM_TO_UOHM(shunt));
391 g_string_free(path, TRUE);
395 SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
398 struct channel_group_priv *cgp;
403 if (!bl_acme_probe_has_pws(cg)) {
404 sr_err("Probe has no power-switch");
408 val = sr_gpio_getval_export(pws_gpios[cgp->index]);
409 *off = val ? FALSE : TRUE;
414 SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
417 struct channel_group_priv *cgp;
422 if (!bl_acme_probe_has_pws(cg)) {
423 sr_err("Probe has no power-switch");
427 val = sr_gpio_setval_export(pws_gpios[cgp->index], off ? 0 : 1);
429 sr_err("Error setting power-off state: gpio: %d",
430 pws_gpios[cgp->index]);
437 static int channel_to_mq(struct sr_channel *ch)
439 struct channel_priv *chp;
443 switch (chp->ch_type) {
447 return SR_MQ_CURRENT;
449 return SR_MQ_VOLTAGE;
450 case TEMP_IN: /* Fallthrough */
452 return SR_MQ_TEMPERATURE;
458 static int channel_to_unit(struct sr_channel *ch)
460 struct channel_priv *chp;
464 switch (chp->ch_type) {
468 return SR_UNIT_AMPERE;
471 case TEMP_IN: /* Fallthrough */
473 return SR_UNIT_CELSIUS;
479 /* We need to scale measurements down from the units used by the drivers. */
480 static float adjust_data(int val, int type)
484 return ((float)val) / 1000000.0;
485 case ENRG_CURR: /* Fallthrough */
486 case ENRG_VOL: /* Fallthrough */
487 case TEMP_IN: /* Fallthrough */
489 return ((float)val) / 1000.0;
495 static float read_sample(struct sr_channel *ch)
497 struct channel_priv *chp;
505 lseek(fd, 0, SEEK_SET);
507 len = read(fd, buf, sizeof(buf));
509 sr_err("Error reading from channel %s (hwmon: %s): %s",
510 ch->name, chp->probe->hwmon_num, strerror(errno));
515 return adjust_data(strtol(buf, NULL, 10), chp->ch_type);
518 SR_PRIV int bl_acme_open_channel(struct sr_channel *ch)
520 struct channel_priv *chp;
521 char path[64], *file;
526 switch (chp->ch_type) {
527 case ENRG_PWR: file = "power1_input"; break;
528 case ENRG_CURR: file = "curr1_input"; break;
529 case ENRG_VOL: file = "in1_input"; break;
530 case TEMP_IN: file = "temp1_input"; break;
531 case TEMP_OUT: file = "temp2_input"; break;
533 sr_err("Invalid channel type: %d.", chp->ch_type);
537 snprintf(path, sizeof(path), "/sys/class/hwmon/hwmon%d/%s",
538 chp->probe->hwmon_num, file);
540 fd = open(path, O_RDONLY);
542 sr_err("Error opening %s: %s", path, strerror(errno));
552 SR_PRIV void bl_acme_close_channel(struct sr_channel *ch)
554 struct channel_priv *chp;
561 SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data)
563 uint32_t cur_time, elapsed_time, diff_time;
564 int64_t time_to_sleep;
565 struct sr_datafeed_packet packet, framep;
566 struct sr_datafeed_analog analog;
567 struct sr_dev_inst *sdi;
568 struct sr_channel *ch;
569 struct dev_context *devc;
584 packet.type = SR_DF_ANALOG;
585 packet.payload = &analog;
586 memset(&analog, 0, sizeof(struct sr_datafeed_analog));
590 * Reading from sysfs takes some time - try to keep up with samplerate.
592 if (devc->samples_read) {
593 cur_time = g_get_monotonic_time();
594 diff_time = cur_time - devc->last_sample_fin;
595 time_to_sleep = G_USEC_PER_SEC / devc->samplerate - diff_time;
596 if (time_to_sleep > 0)
597 g_usleep(time_to_sleep);
600 framep.type = SR_DF_FRAME_BEGIN;
601 sr_session_send(cb_data, &framep);
604 * Due to different units used in each channel we're sending
605 * samples one-by-one.
607 for (chl = sdi->channels; chl; chl = chl->next) {
613 analog.channels = &chonly;
614 analog.num_samples = 1;
615 analog.mq = channel_to_mq(chl->data);
616 analog.unit = channel_to_unit(ch);
618 valf = read_sample(ch);
620 sr_session_send(cb_data, &packet);
623 framep.type = SR_DF_FRAME_END;
624 sr_session_send(cb_data, &framep);
626 devc->samples_read++;
627 if (devc->limit_samples > 0 &&
628 devc->samples_read >= devc->limit_samples) {
629 sr_info("Requested number of samples reached.");
630 sdi->driver->dev_acquisition_stop(sdi, cb_data);
631 devc->last_sample_fin = g_get_monotonic_time();
633 } else if (devc->limit_msec > 0) {
634 cur_time = g_get_monotonic_time();
635 elapsed_time = cur_time - devc->start_time;
637 if (elapsed_time >= devc->limit_msec) {
638 sr_info("Sampling time limit reached.");
639 sdi->driver->dev_acquisition_stop(sdi, cb_data);
640 devc->last_sample_fin = g_get_monotonic_time();
645 devc->last_sample_fin = g_get_monotonic_time();