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 {
38 struct channel_group_priv *probe;
41 static const uint8_t enrg_i2c_addrs[] = {
42 0x40, 0x41, 0x44, 0x45, 0x42, 0x43, 0x46, 0x47,
45 static const uint8_t temp_i2c_addrs[] = {
46 0x0, 0x0, 0x0, 0x0, 0x4c, 0x49, 0x4f, 0x4b,
49 static const uint32_t pws_gpios[] = {
50 486, 498, 502, 482, 478, 506, 510, 474,
53 static const uint32_t pws_info_gpios[] = {
54 487, 499, 503, 483, 479, 507, 511, 475,
57 #define MOHM_TO_UOHM(x) ((x) * 1000)
58 #define UOHM_TO_MOHM(x) ((x) / 1000)
60 SR_PRIV uint8_t bl_acme_get_enrg_addr(int index)
62 return enrg_i2c_addrs[index];
65 SR_PRIV uint8_t bl_acme_get_temp_addr(int index)
67 return temp_i2c_addrs[index];
70 SR_PRIV gboolean bl_acme_is_sane(void)
75 * We expect sysfs to be present and mounted at /sys, ina226 and
76 * tmp435 sensors detected by the system and their appropriate
77 * drivers loaded and functional.
79 status = g_file_test("/sys", G_FILE_TEST_IS_DIR);
81 sr_err("/sys/ directory not found - sysfs not mounted?");
88 static void probe_name_path(unsigned int addr, GString *path)
91 "/sys/class/i2c-adapter/i2c-1/1-00%02x/name", addr);
95 * For given address fill buf with the path to appropriate hwmon entry.
97 static void probe_hwmon_path(unsigned int addr, GString *path)
100 "/sys/class/i2c-adapter/i2c-1/1-00%02x/hwmon", addr);
103 SR_PRIV gboolean bl_acme_detect_probe(unsigned int addr,
104 int prb_num, const char *prb_name)
106 gboolean ret = FALSE, status;
108 GString *path = g_string_sized_new(64);
112 probe_name_path(addr, path);
113 status = g_file_get_contents(path->str, &buf, &size, &err);
115 sr_dbg("Name for probe %d can't be read: %s",
116 prb_num, err->message);
117 g_string_free(path, TRUE);
121 if (!strncmp(buf, prb_name, strlen(prb_name))) {
123 * Correct driver registered on this address - but is
124 * there an actual probe connected?
126 probe_hwmon_path(addr, path);
127 status = g_file_test(path->str, G_FILE_TEST_IS_DIR);
129 /* We have found an ACME probe. */
135 g_string_free(path, TRUE);
140 static int get_hwmon_index(unsigned int addr)
143 GString *path = g_string_sized_new(64);
147 probe_hwmon_path(addr, path);
148 dir = g_dir_open(path->str, 0, &err);
150 sr_err("Error opening %s: %s", path->str, err->message);
151 g_string_free(path, TRUE);
155 g_string_free(path, TRUE);
158 * The directory should contain a single file named hwmonX where X
159 * is the hwmon index.
161 status = sscanf(g_dir_read_name(dir), "hwmon%d", &hwmon);
164 sr_err("Unable to determine the hwmon entry");
171 static void append_channel(struct sr_dev_inst *sdi, struct sr_channel_group *cg,
174 struct channel_priv *cp;
175 struct dev_context *devc;
176 struct sr_channel *ch;
183 name = g_strdup_printf("P%d_ENRG_PWR", index);
186 name = g_strdup_printf("P%d_ENRG_CURR", index);
189 name = g_strdup_printf("P%d_ENRG_VOL", index);
192 name = g_strdup_printf("P%d_TEMP_IN", index);
195 name = g_strdup_printf("P%d_TEMP_OUT", index);
198 sr_err("Invalid channel type: %d.", type);
202 cp = g_malloc0(sizeof(struct channel_priv));
204 cp->probe = cg->priv;
206 ch = sr_channel_new(sdi, devc->num_channels++,
207 SR_CHANNEL_ANALOG, TRUE, name);
211 cg->channels = g_slist_append(cg->channels, ch);
214 SR_PRIV gboolean bl_acme_register_probe(struct sr_dev_inst *sdi, int type,
215 unsigned int addr, int prb_num)
217 struct sr_channel_group *cg;
218 struct channel_group_priv *cgp;
221 /* Obtain the hwmon index. */
222 hwmon = get_hwmon_index(addr);
226 cg = g_malloc0(sizeof(struct sr_channel_group));
227 cgp = g_malloc0(sizeof(struct channel_group_priv));
228 cgp->hwmon_num = hwmon;
229 cgp->probe_type = type;
230 cgp->index = prb_num - 1;
231 cg->name = g_strdup_printf("Probe_%d", prb_num);
234 if (type == PROBE_ENRG) {
235 append_channel(sdi, cg, prb_num, ENRG_PWR);
236 append_channel(sdi, cg, prb_num, ENRG_CURR);
237 append_channel(sdi, cg, prb_num, ENRG_VOL);
238 } else if (type == PROBE_TEMP) {
239 append_channel(sdi, cg, prb_num, TEMP_IN);
240 append_channel(sdi, cg, prb_num, TEMP_OUT);
242 sr_err("Invalid probe type: %d.", type);
245 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
250 SR_PRIV int bl_acme_get_probe_type(const struct sr_channel_group *cg)
252 struct channel_group_priv *cgp = cg->priv;
254 return cgp->probe_type;
257 SR_PRIV int bl_acme_probe_has_pws(const struct sr_channel_group *cg)
259 struct channel_group_priv *cgp = cg->priv;
261 return sr_gpio_getval_export(pws_info_gpios[cgp->index]);
265 * Sets path to the hwmon attribute if this channel group
266 * supports shunt resistance setting. The caller has to supply
269 static int get_shunt_path(const struct sr_channel_group *cg, GString *path)
271 struct channel_group_priv *cgp;
272 int ret = SR_OK, status;
276 if (cgp->probe_type != PROBE_ENRG) {
277 sr_err("Probe doesn't support shunt resistance setting");
281 g_string_append_printf(path,
282 "/sys/class/hwmon/hwmon%d/shunt_resistor",
286 * The shunt_resistor sysfs attribute is available
287 * in the Linux kernel since version 3.20. We have
288 * to notify the user if this attribute is not present.
290 status = g_file_test(path->str, G_FILE_TEST_EXISTS);
292 sr_err("shunt_resistance attribute not present, please update "
293 "your kernel to version >=3.20");
301 * Try setting the update_interval sysfs attribute for each probe according
304 SR_PRIV void bl_acme_maybe_set_update_interval(const struct sr_dev_inst *sdi,
307 struct sr_channel_group *cg;
308 struct channel_group_priv *cgp;
313 for (l = sdi->channel_groups; l != NULL; l = l->next) {
317 hwmon = g_string_sized_new(64);
318 g_string_append_printf(hwmon,
319 "/sys/class/hwmon/hwmon%d/update_interval",
322 if (g_file_test(hwmon->str, G_FILE_TEST_EXISTS)) {
323 fd = g_fopen(hwmon->str, "w");
325 g_string_free(hwmon, TRUE);
329 g_fprintf(fd, "%" PRIu64 "\n", 1000 / samplerate);
333 g_string_free(hwmon, TRUE);
337 SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
340 GString *path = g_string_sized_new(64);
342 int status, ret = SR_OK;
345 status = get_shunt_path(cg, path);
346 if (status != SR_OK) {
351 status = g_file_get_contents(path->str, &contents, NULL, &err);
353 sr_err("Error reading shunt resistance: %s", err->message);
358 *shunt = UOHM_TO_MOHM(strtol(contents, NULL, 10));
361 g_string_free(path, TRUE);
365 SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg, uint64_t shunt)
367 GString *path = g_string_sized_new(64);;
368 int status, ret = SR_OK;
371 status = get_shunt_path(cg, path);
372 if (status != SR_OK) {
378 * Can't use g_file_set_contents() here, as it calls open() with
379 * O_EXEC flag in a sysfs directory thus failing with EACCES.
381 fd = g_fopen(path->str, "w");
383 sr_err("Error opening %s: %s", path->str, strerror(errno));
388 g_fprintf(fd, "%" PRIu64 "\n", MOHM_TO_UOHM(shunt));
392 g_string_free(path, TRUE);
396 SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
399 struct channel_group_priv *cgp;
404 if (!bl_acme_probe_has_pws(cg)) {
405 sr_err("Probe has no power-switch");
409 val = sr_gpio_getval_export(pws_gpios[cgp->index]);
410 *off = val ? FALSE : TRUE;
415 SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
418 struct channel_group_priv *cgp;
423 if (!bl_acme_probe_has_pws(cg)) {
424 sr_err("Probe has no power-switch");
428 val = sr_gpio_setval_export(pws_gpios[cgp->index], off ? 0 : 1);
430 sr_err("Error setting power-off state: gpio: %d",
431 pws_gpios[cgp->index]);
438 static int channel_to_mq(struct sr_channel *ch)
440 struct channel_priv *chp;
444 switch (chp->ch_type) {
448 return SR_MQ_CURRENT;
450 return SR_MQ_VOLTAGE;
451 case TEMP_IN: /* Fallthrough */
453 return SR_MQ_TEMPERATURE;
459 static int channel_to_unit(struct sr_channel *ch)
461 struct channel_priv *chp;
465 switch (chp->ch_type) {
469 return SR_UNIT_AMPERE;
472 case TEMP_IN: /* Fallthrough */
474 return SR_UNIT_CELSIUS;
480 /* We need to scale measurements down from the units used by the drivers. */
481 static float adjust_data(int val, int type)
485 return ((float)val) / 1000000.0;
486 case ENRG_CURR: /* Fallthrough */
487 case ENRG_VOL: /* Fallthrough */
488 case TEMP_IN: /* Fallthrough */
490 return ((float)val) / 1000.0;
496 static float read_sample(struct sr_channel *ch)
498 struct channel_priv *chp;
506 lseek(fd, 0, SEEK_SET);
508 len = read(fd, buf, sizeof(buf));
510 sr_err("Error reading from channel %s (hwmon: %s): %s",
511 ch->name, chp->probe->hwmon_num, strerror(errno));
516 return adjust_data(strtol(buf, NULL, 10), chp->ch_type);
519 SR_PRIV int bl_acme_open_channel(struct sr_channel *ch)
521 struct channel_priv *chp;
522 char path[64], *file;
527 switch (chp->ch_type) {
528 case ENRG_PWR: file = "power1_input"; break;
529 case ENRG_CURR: file = "curr1_input"; break;
530 case ENRG_VOL: file = "in1_input"; break;
531 case TEMP_IN: file = "temp1_input"; break;
532 case TEMP_OUT: file = "temp2_input"; break;
534 sr_err("Invalid channel type: %d.", chp->ch_type);
538 snprintf(path, sizeof(path), "/sys/class/hwmon/hwmon%d/%s",
539 chp->probe->hwmon_num, file);
541 fd = open(path, O_RDONLY);
543 sr_err("Error opening %s: %s", path, strerror(errno));
553 SR_PRIV void bl_acme_close_channel(struct sr_channel *ch)
555 struct channel_priv *chp;
562 SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data)
564 uint32_t cur_time, elapsed_time;
565 uint64_t nrexpiration;
566 struct sr_datafeed_packet packet, framep;
567 struct sr_datafeed_analog analog;
568 struct sr_dev_inst *sdi;
569 struct sr_channel *ch;
570 struct channel_priv *chp;
571 struct dev_context *devc;
586 packet.type = SR_DF_ANALOG;
587 packet.payload = &analog;
588 memset(&analog, 0, sizeof(struct sr_datafeed_analog));
590 if (read(devc->timer_fd, &nrexpiration, sizeof(nrexpiration)) < 0) {
591 sr_warn("Failed to read timer information");
596 * We were not able to process the previous timer expiration, we are
599 if (nrexpiration > 1)
600 devc->samples_missed += nrexpiration - 1;
603 * XXX This is a nasty workaround...
605 * At high sampling rates and maximum channels we are not able to
606 * acquire samples fast enough, even though frontends still think
607 * that samples arrive on time. This causes shifts in frontend
610 * To compensate for the delay we check if any clock events were
611 * missed and - if so - don't really read the next value, but send
612 * the same sample as fast as possible. We do it until we are back
615 * At high sampling rate this doesn't seem to visibly reduce the
618 for (i = 0; i < nrexpiration; i++) {
619 framep.type = SR_DF_FRAME_BEGIN;
620 sr_session_send(cb_data, &framep);
623 * Due to different units used in each channel we're sending
624 * samples one-by-one.
626 for (chl = sdi->channels; chl; chl = chl->next) {
634 analog.channels = &chonly;
635 analog.num_samples = 1;
636 analog.mq = channel_to_mq(chl->data);
637 analog.unit = channel_to_unit(ch);
640 chp->val = read_sample(ch);
642 analog.data = &chp->val;
643 sr_session_send(cb_data, &packet);
646 framep.type = SR_DF_FRAME_END;
647 sr_session_send(cb_data, &framep);
650 devc->samples_read++;
651 if (devc->limit_samples > 0 &&
652 devc->samples_read >= devc->limit_samples) {
653 sr_info("Requested number of samples reached.");
654 sdi->driver->dev_acquisition_stop(sdi, cb_data);
655 devc->last_sample_fin = g_get_monotonic_time();
657 } else if (devc->limit_msec > 0) {
658 cur_time = g_get_monotonic_time();
659 elapsed_time = cur_time - devc->start_time;
661 if (elapsed_time >= devc->limit_msec) {
662 sr_info("Sampling time limit reached.");
663 sdi->driver->dev_acquisition_stop(sdi, cb_data);
664 devc->last_sample_fin = g_get_monotonic_time();
669 devc->last_sample_fin = g_get_monotonic_time();