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/>.
25 #include <arpa/inet.h>
26 #include <glib/gstdio.h>
41 struct channel_group_priv {
54 struct channel_group_priv *probe;
57 #define EEPROM_SERIAL_SIZE 16
58 #define EEPROM_TAG_SIZE 32
60 #define EEPROM_PROBE_TYPE_USB 1
61 #define EEPROM_PROBE_TYPE_JACK 2
62 #define EEPROM_PROBE_TYPE_HE10 3
69 uint8_t serial[EEPROM_SERIAL_SIZE];
70 int8_t tag[EEPROM_TAG_SIZE];
71 } __attribute__((packed));
73 static const uint8_t enrg_i2c_addrs[] = {
74 0x40, 0x41, 0x44, 0x45, 0x42, 0x43, 0x46, 0x47,
77 static const uint8_t temp_i2c_addrs[] = {
78 0x0, 0x0, 0x0, 0x0, 0x4c, 0x49, 0x4f, 0x4b,
81 static const uint32_t revA_pws_gpios[] = {
82 486, 498, 502, 482, 478, 506, 510, 474,
85 static const uint32_t revA_pws_info_gpios[] = {
86 487, 499, 503, 483, 479, 507, 511, 475,
89 static const uint32_t revB_pws_gpios[] = {
90 489, 491, 493, 495, 497, 499, 501, 503,
93 #define MOHM_TO_UOHM(x) ((x) * 1000)
94 #define UOHM_TO_MOHM(x) ((x) / 1000)
96 SR_PRIV uint8_t bl_acme_get_enrg_addr(int index)
98 return enrg_i2c_addrs[index];
101 SR_PRIV uint8_t bl_acme_get_temp_addr(int index)
103 return temp_i2c_addrs[index];
106 SR_PRIV gboolean bl_acme_is_sane(void)
111 * We expect sysfs to be present and mounted at /sys, ina226 and
112 * tmp435 sensors detected by the system and their appropriate
113 * drivers loaded and functional.
115 status = g_file_test("/sys", G_FILE_TEST_IS_DIR);
117 sr_err("/sys/ directory not found - sysfs not mounted?");
124 static void probe_name_path(unsigned int addr, GString *path)
126 g_string_printf(path,
127 "/sys/class/i2c-adapter/i2c-1/1-00%02x/name", addr);
131 * For given address fill buf with the path to appropriate hwmon entry.
133 static void probe_hwmon_path(unsigned int addr, GString *path)
135 g_string_printf(path,
136 "/sys/class/i2c-adapter/i2c-1/1-00%02x/hwmon", addr);
139 static void probe_eeprom_path(unsigned int addr, GString *path)
141 g_string_printf(path,
142 "/sys/class/i2c-dev/i2c-1/device/1-00%02x/eeprom",
146 SR_PRIV gboolean bl_acme_detect_probe(unsigned int addr,
147 int prb_num, const char *prb_name)
149 gboolean ret = FALSE, status;
151 GString *path = g_string_sized_new(64);
155 probe_name_path(addr, path);
156 status = g_file_get_contents(path->str, &buf, &size, &err);
158 sr_dbg("Name for probe %d can't be read: %s",
159 prb_num, err->message);
160 g_string_free(path, TRUE);
164 if (!strncmp(buf, prb_name, strlen(prb_name))) {
166 * Correct driver registered on this address - but is
167 * there an actual probe connected?
169 probe_hwmon_path(addr, path);
170 status = g_file_test(path->str, G_FILE_TEST_IS_DIR);
172 /* We have found an ACME probe. */
178 g_string_free(path, TRUE);
183 static int get_hwmon_index(unsigned int addr)
186 GString *path = g_string_sized_new(64);
190 probe_hwmon_path(addr, path);
191 dir = g_dir_open(path->str, 0, &err);
193 sr_err("Error opening %s: %s", path->str, err->message);
194 g_string_free(path, TRUE);
198 g_string_free(path, TRUE);
201 * The directory should contain a single file named hwmonX where X
202 * is the hwmon index.
204 status = sscanf(g_dir_read_name(dir), "hwmon%d", &hwmon);
207 sr_err("Unable to determine the hwmon entry");
214 static void append_channel(struct sr_dev_inst *sdi, struct sr_channel_group *cg,
217 struct channel_priv *cp;
218 struct dev_context *devc;
219 struct sr_channel *ch;
226 name = g_strdup_printf("P%d_ENRG_PWR", index);
229 name = g_strdup_printf("P%d_ENRG_CURR", index);
232 name = g_strdup_printf("P%d_ENRG_VOL", index);
235 name = g_strdup_printf("P%d_TEMP_IN", index);
238 name = g_strdup_printf("P%d_TEMP_OUT", index);
241 sr_err("Invalid channel type: %d.", type);
245 cp = g_malloc0(sizeof(struct channel_priv));
247 cp->probe = cg->priv;
249 ch = sr_channel_new(sdi, devc->num_channels++,
250 SR_CHANNEL_ANALOG, TRUE, name);
254 cg->channels = g_slist_append(cg->channels, ch);
257 static int read_probe_eeprom(unsigned int addr, struct probe_eeprom *eeprom)
259 static const ssize_t len = sizeof(struct probe_eeprom);
261 GString *path = g_string_sized_new(64);
265 probe_eeprom_path(addr, path);
266 fd = g_open(path->str, O_RDONLY);
267 g_string_free(path, TRUE);
271 rd = read(fd, eeprom, len);
277 * All integer types are in network byte order. Convert them to
278 * host order before proceeding.
280 eeprom->type = ntohl(eeprom->type);
281 eeprom->rev = ntohl(eeprom->rev);
282 eeprom->shunt = ntohl(eeprom->shunt);
284 /* Check if we have some sensible values. */
285 if (eeprom->rev != 'B')
286 /* 'B' is the only supported revision with EEPROM for now. */
289 if (eeprom->type != EEPROM_PROBE_TYPE_USB &&
290 eeprom->type != EEPROM_PROBE_TYPE_JACK &&
291 eeprom->type != EEPROM_PROBE_TYPE_HE10)
297 /* Some i2c slave addresses on revision B probes differ from revision A. */
298 static int revB_addr_to_num(unsigned int addr)
305 default: return addr - 0x3f;
309 SR_PRIV gboolean bl_acme_register_probe(struct sr_dev_inst *sdi, int type,
310 unsigned int addr, int prb_num)
312 struct sr_channel_group *cg;
313 struct channel_group_priv *cgp;
314 struct probe_eeprom eeprom;
318 /* Obtain the hwmon index. */
319 hwmon = get_hwmon_index(addr);
323 cg = g_malloc0(sizeof(struct sr_channel_group));
324 cgp = g_malloc0(sizeof(struct channel_group_priv));
328 * See if we can read the EEPROM contents. If not, assume it's
329 * a revision A probe.
331 status = read_probe_eeprom(addr, &eeprom);
332 cgp->rev = status < 0 ? ACME_REV_A : ACME_REV_B;
334 prb_num = cgp->rev == ACME_REV_A ? prb_num : revB_addr_to_num(addr);
336 cgp->hwmon_num = hwmon;
337 cgp->probe_type = type;
338 cgp->index = prb_num - 1;
339 cg->name = g_strdup_printf("Probe_%d", prb_num);
341 if (cgp->rev == ACME_REV_A) {
342 gpio = revA_pws_info_gpios[cgp->index];
343 cgp->has_pws = sr_gpio_getval_export(gpio);
344 cgp->pws_gpio = revA_pws_gpios[cgp->index];
346 cgp->has_pws = eeprom.pwr_sw;
347 cgp->pws_gpio = revB_pws_gpios[cgp->index];
350 * For revision B we can already try to set the shunt
351 * resistance according to the EEPROM contents.
353 * Keep the default value if shunt in EEPROM == 0.
355 if (eeprom.shunt > 0)
356 bl_acme_set_shunt(cg, UOHM_TO_MOHM(eeprom.shunt));
359 if (type == PROBE_ENRG) {
360 append_channel(sdi, cg, prb_num, ENRG_PWR);
361 append_channel(sdi, cg, prb_num, ENRG_CURR);
362 append_channel(sdi, cg, prb_num, ENRG_VOL);
363 } else if (type == PROBE_TEMP) {
364 append_channel(sdi, cg, prb_num, TEMP_IN);
365 append_channel(sdi, cg, prb_num, TEMP_OUT);
367 sr_err("Invalid probe type: %d.", type);
370 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
375 SR_PRIV int bl_acme_get_probe_type(const struct sr_channel_group *cg)
377 struct channel_group_priv *cgp = cg->priv;
379 return cgp->probe_type;
382 SR_PRIV int bl_acme_probe_has_pws(const struct sr_channel_group *cg)
384 struct channel_group_priv *cgp = cg->priv;
390 * Sets path to the hwmon attribute if this channel group
391 * supports shunt resistance setting. The caller has to supply
394 static int get_shunt_path(const struct sr_channel_group *cg, GString *path)
396 struct channel_group_priv *cgp;
397 int ret = SR_OK, status;
401 if (cgp->probe_type != PROBE_ENRG) {
402 sr_err("Probe doesn't support shunt resistance setting");
406 g_string_append_printf(path,
407 "/sys/class/hwmon/hwmon%d/shunt_resistor",
411 * The shunt_resistor sysfs attribute is available
412 * in the Linux kernel since version 3.20. We have
413 * to notify the user if this attribute is not present.
415 status = g_file_test(path->str, G_FILE_TEST_EXISTS);
417 sr_err("shunt_resistance attribute not present, please update "
418 "your kernel to version >=3.20");
426 * Try setting the update_interval sysfs attribute for each probe according
429 SR_PRIV void bl_acme_maybe_set_update_interval(const struct sr_dev_inst *sdi,
432 struct sr_channel_group *cg;
433 struct channel_group_priv *cgp;
438 for (l = sdi->channel_groups; l != NULL; l = l->next) {
442 hwmon = g_string_sized_new(64);
443 g_string_append_printf(hwmon,
444 "/sys/class/hwmon/hwmon%d/update_interval",
447 if (g_file_test(hwmon->str, G_FILE_TEST_EXISTS)) {
448 fd = g_fopen(hwmon->str, "w");
450 g_string_free(hwmon, TRUE);
454 g_fprintf(fd, "%" PRIu64 "\n", 1000 / samplerate);
458 g_string_free(hwmon, TRUE);
462 SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
465 GString *path = g_string_sized_new(64);
467 int status, ret = SR_OK;
470 status = get_shunt_path(cg, path);
471 if (status != SR_OK) {
476 status = g_file_get_contents(path->str, &contents, NULL, &err);
478 sr_err("Error reading shunt resistance: %s", err->message);
483 *shunt = UOHM_TO_MOHM(strtol(contents, NULL, 10));
486 g_string_free(path, TRUE);
490 SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg, uint64_t shunt)
492 GString *path = g_string_sized_new(64);;
493 int status, ret = SR_OK;
496 status = get_shunt_path(cg, path);
497 if (status != SR_OK) {
503 * Can't use g_file_set_contents() here, as it calls open() with
504 * O_EXEC flag in a sysfs directory thus failing with EACCES.
506 fd = g_fopen(path->str, "w");
508 sr_err("Error opening %s: %s", path->str, g_strerror(errno));
513 g_fprintf(fd, "%" PRIu64 "\n", MOHM_TO_UOHM(shunt));
517 g_string_free(path, TRUE);
521 SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
524 struct channel_group_priv *cgp;
529 if (!bl_acme_probe_has_pws(cg)) {
530 sr_err("Probe has no power-switch");
534 val = sr_gpio_getval_export(cgp->pws_gpio);
535 *off = val ? FALSE : TRUE;
540 SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
543 struct channel_group_priv *cgp;
548 if (!bl_acme_probe_has_pws(cg)) {
549 sr_err("Probe has no power-switch");
553 val = sr_gpio_setval_export(cgp->pws_gpio, off ? 0 : 1);
555 sr_err("Error setting power-off state: gpio: %d",
563 static int channel_to_mq(struct sr_channel *ch)
565 struct channel_priv *chp;
569 switch (chp->ch_type) {
573 return SR_MQ_CURRENT;
575 return SR_MQ_VOLTAGE;
576 case TEMP_IN: /* Fallthrough */
578 return SR_MQ_TEMPERATURE;
584 static int channel_to_unit(struct sr_channel *ch)
586 struct channel_priv *chp;
590 switch (chp->ch_type) {
594 return SR_UNIT_AMPERE;
597 case TEMP_IN: /* Fallthrough */
599 return SR_UNIT_CELSIUS;
605 /* We need to scale measurements down from the units used by the drivers. */
606 static float adjust_data(int val, int type)
610 return ((float)val) / 1000000.0;
611 case ENRG_CURR: /* Fallthrough */
612 case ENRG_VOL: /* Fallthrough */
613 case TEMP_IN: /* Fallthrough */
615 return ((float)val) / 1000.0;
621 static float read_sample(struct sr_channel *ch)
623 struct channel_priv *chp;
631 lseek(fd, 0, SEEK_SET);
633 len = read(fd, buf, sizeof(buf));
635 sr_err("Error reading from channel %s (hwmon: %d): %s",
636 ch->name, chp->probe->hwmon_num, g_strerror(errno));
641 return adjust_data(strtol(buf, NULL, 10), chp->ch_type);
644 SR_PRIV int bl_acme_open_channel(struct sr_channel *ch)
646 struct channel_priv *chp;
647 char path[64], *file;
652 switch (chp->ch_type) {
653 case ENRG_PWR: file = "power1_input"; break;
654 case ENRG_CURR: file = "curr1_input"; break;
655 case ENRG_VOL: file = "in1_input"; break;
656 case TEMP_IN: file = "temp1_input"; break;
657 case TEMP_OUT: file = "temp2_input"; break;
659 sr_err("Invalid channel type: %d.", chp->ch_type);
663 snprintf(path, sizeof(path), "/sys/class/hwmon/hwmon%d/%s",
664 chp->probe->hwmon_num, file);
666 fd = open(path, O_RDONLY);
668 sr_err("Error opening %s: %s", path, g_strerror(errno));
678 SR_PRIV void bl_acme_close_channel(struct sr_channel *ch)
680 struct channel_priv *chp;
687 SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data)
689 uint32_t cur_time, elapsed_time;
690 uint64_t nrexpiration;
691 struct sr_datafeed_packet packet, framep;
692 struct sr_datafeed_analog analog;
693 struct sr_dev_inst *sdi;
694 struct sr_channel *ch;
695 struct channel_priv *chp;
696 struct dev_context *devc;
711 packet.type = SR_DF_ANALOG;
712 packet.payload = &analog;
713 memset(&analog, 0, sizeof(struct sr_datafeed_analog));
715 if (read(devc->timer_fd, &nrexpiration, sizeof(nrexpiration)) < 0) {
716 sr_warn("Failed to read timer information");
721 * We were not able to process the previous timer expiration, we are
724 if (nrexpiration > 1)
725 devc->samples_missed += nrexpiration - 1;
728 * XXX This is a nasty workaround...
730 * At high sampling rates and maximum channels we are not able to
731 * acquire samples fast enough, even though frontends still think
732 * that samples arrive on time. This causes shifts in frontend
735 * To compensate for the delay we check if any clock events were
736 * missed and - if so - don't really read the next value, but send
737 * the same sample as fast as possible. We do it until we are back
740 * At high sampling rate this doesn't seem to visibly reduce the
743 for (i = 0; i < nrexpiration; i++) {
744 framep.type = SR_DF_FRAME_BEGIN;
745 sr_session_send(cb_data, &framep);
748 * Due to different units used in each channel we're sending
749 * samples one-by-one.
751 for (chl = sdi->channels; chl; chl = chl->next) {
759 analog.channels = &chonly;
760 analog.num_samples = 1;
761 analog.mq = channel_to_mq(chl->data);
762 analog.unit = channel_to_unit(ch);
765 chp->val = read_sample(ch);
767 analog.data = &chp->val;
768 sr_session_send(cb_data, &packet);
771 framep.type = SR_DF_FRAME_END;
772 sr_session_send(cb_data, &framep);
775 devc->samples_read++;
776 if (devc->limit_samples > 0 &&
777 devc->samples_read >= devc->limit_samples) {
778 sr_info("Requested number of samples reached.");
779 sdi->driver->dev_acquisition_stop(sdi, cb_data);
780 devc->last_sample_fin = g_get_monotonic_time();
782 } else if (devc->limit_msec > 0) {
783 cur_time = g_get_monotonic_time();
784 elapsed_time = cur_time - devc->start_time;
786 if (elapsed_time >= devc->limit_msec) {
787 sr_info("Sampling time limit reached.");
788 sdi->driver->dev_acquisition_stop(sdi, cb_data);
789 devc->last_sample_fin = g_get_monotonic_time();
794 devc->last_sample_fin = g_get_monotonic_time();