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/>.
26 #include <arpa/inet.h>
27 #include <glib/gstdio.h>
42 struct channel_group_priv {
56 struct channel_group_priv *probe;
59 #define EEPROM_SERIAL_SIZE 16
60 #define EEPROM_TAG_SIZE 32
62 #define EEPROM_PROBE_TYPE_USB 1
63 #define EEPROM_PROBE_TYPE_JACK 2
64 #define EEPROM_PROBE_TYPE_HE10 3
71 uint8_t serial[EEPROM_SERIAL_SIZE];
72 int8_t tag[EEPROM_TAG_SIZE];
75 #define EEPROM_SIZE (3 * sizeof(uint32_t) + 1 + EEPROM_SERIAL_SIZE + EEPROM_TAG_SIZE)
77 #define EEPROM_OFF_TYPE 0
78 #define EEPROM_OFF_REV sizeof(uint32_t)
79 #define EEPROM_OFF_SHUNT (2 * sizeof(uint32_t))
80 #define EEPROM_OFF_PWR_SW (3 * sizeof(uint32_t))
81 #define EEPROM_OFF_SERIAL (3 * sizeof(uint32_t) + 1)
82 #define EEPROM_OFF_TAG (EEPROM_OFF_SERIAL + EEPROM_SERIAL_SIZE)
84 static const uint8_t enrg_i2c_addrs[] = {
85 0x40, 0x41, 0x44, 0x45, 0x42, 0x43, 0x46, 0x47,
88 static const uint8_t temp_i2c_addrs[] = {
89 0x0, 0x0, 0x0, 0x0, 0x4c, 0x49, 0x4f, 0x4b,
92 static const uint32_t revA_pws_gpios[] = {
93 486, 498, 502, 482, 478, 506, 510, 474,
96 static const uint32_t revA_pws_info_gpios[] = {
97 487, 499, 503, 483, 479, 507, 511, 475,
100 static const uint32_t revB_pws_gpios[] = {
101 489, 491, 493, 495, 497, 499, 501, 503,
104 #define MOHM_TO_UOHM(x) ((x) * 1000)
105 #define UOHM_TO_MOHM(x) ((x) / 1000)
107 SR_PRIV uint8_t bl_acme_get_enrg_addr(int index)
109 return enrg_i2c_addrs[index];
112 SR_PRIV uint8_t bl_acme_get_temp_addr(int index)
114 return temp_i2c_addrs[index];
117 SR_PRIV gboolean bl_acme_is_sane(void)
122 * We expect sysfs to be present and mounted at /sys, ina226 and
123 * tmp435 sensors detected by the system and their appropriate
124 * drivers loaded and functional.
126 status = g_file_test("/sys", G_FILE_TEST_IS_DIR);
128 sr_err("/sys/ directory not found - sysfs not mounted?");
135 static void probe_name_path(unsigned int addr, GString *path)
137 g_string_printf(path,
138 "/sys/class/i2c-adapter/i2c-1/1-00%02x/name", addr);
142 * For given address fill buf with the path to appropriate hwmon entry.
144 static void probe_hwmon_path(unsigned int addr, GString *path)
146 g_string_printf(path,
147 "/sys/class/i2c-adapter/i2c-1/1-00%02x/hwmon", addr);
150 static void probe_eeprom_path(unsigned int addr, GString *path)
152 g_string_printf(path,
153 "/sys/class/i2c-dev/i2c-1/device/1-00%02x/eeprom",
157 SR_PRIV gboolean bl_acme_detect_probe(unsigned int addr,
158 int prb_num, const char *prb_name)
160 gboolean ret = FALSE, status;
162 GString *path = g_string_sized_new(64);
166 probe_name_path(addr, path);
167 status = g_file_get_contents(path->str, &buf, &size, &err);
169 /* Don't log "No such file or directory" messages. */
170 if (err->code != G_FILE_ERROR_NOENT)
171 sr_dbg("Name for probe %d can't be read (%d): %s",
172 prb_num, err->code, err->message);
173 g_string_free(path, TRUE);
178 if (!strncmp(buf, prb_name, strlen(prb_name))) {
180 * Correct driver registered on this address - but is
181 * there an actual probe connected?
183 probe_hwmon_path(addr, path);
184 status = g_file_test(path->str, G_FILE_TEST_IS_DIR);
186 /* We have found an ACME probe. */
192 g_string_free(path, TRUE);
197 static int get_hwmon_index(unsigned int addr)
200 GString *path = g_string_sized_new(64);
204 probe_hwmon_path(addr, path);
205 dir = g_dir_open(path->str, 0, &err);
207 sr_err("Error opening %s: %s", path->str, err->message);
208 g_string_free(path, TRUE);
213 g_string_free(path, TRUE);
216 * The directory should contain a single file named hwmonX where X
217 * is the hwmon index.
219 status = sscanf(g_dir_read_name(dir), "hwmon%d", &hwmon);
222 sr_err("Unable to determine the hwmon entry");
229 static void append_channel(struct sr_dev_inst *sdi, struct sr_channel_group *cg,
232 struct channel_priv *cp;
233 struct dev_context *devc;
234 struct sr_channel *ch;
241 name = g_strdup_printf("P%d_ENRG_PWR", index);
244 name = g_strdup_printf("P%d_ENRG_CURR", index);
247 name = g_strdup_printf("P%d_ENRG_VOL", index);
250 name = g_strdup_printf("P%d_TEMP_IN", index);
253 name = g_strdup_printf("P%d_TEMP_OUT", index);
256 sr_err("Invalid channel type: %d.", type);
260 cp = g_malloc0(sizeof(struct channel_priv));
262 cp->probe = cg->priv;
264 ch = sr_channel_new(sdi, devc->num_channels++,
265 SR_CHANNEL_ANALOG, TRUE, name);
269 cg->channels = g_slist_append(cg->channels, ch);
272 static int read_probe_eeprom(unsigned int addr, struct probe_eeprom *eeprom)
274 GString *path = g_string_sized_new(64);
275 char eeprom_buf[EEPROM_SIZE];
279 probe_eeprom_path(addr, path);
280 fd = g_open(path->str, O_RDONLY);
281 g_string_free(path, TRUE);
285 rd = read(fd, eeprom_buf, EEPROM_SIZE);
287 if (rd != EEPROM_SIZE)
290 eeprom->type = RB32(eeprom_buf + EEPROM_OFF_TYPE);
291 eeprom->rev = RB32(eeprom_buf + EEPROM_OFF_REV);
292 eeprom->shunt = RB32(eeprom_buf + EEPROM_OFF_SHUNT);
293 eeprom->pwr_sw = R8(eeprom_buf + EEPROM_OFF_PWR_SW);
294 /* Don't care about the serial number and tag for now. */
296 /* Check if we have some sensible values. */
297 if (eeprom->rev != 'B')
298 /* 'B' is the only supported revision with EEPROM for now. */
301 if (eeprom->type != EEPROM_PROBE_TYPE_USB &&
302 eeprom->type != EEPROM_PROBE_TYPE_JACK &&
303 eeprom->type != EEPROM_PROBE_TYPE_HE10)
309 /* Some i2c slave addresses on revision B probes differ from revision A. */
310 static int revB_addr_to_num(unsigned int addr)
317 default: return addr - 0x3f;
321 SR_PRIV gboolean bl_acme_register_probe(struct sr_dev_inst *sdi, int type,
322 unsigned int addr, int prb_num)
324 struct sr_channel_group *cg;
325 struct channel_group_priv *cgp;
326 struct probe_eeprom eeprom;
330 /* Obtain the hwmon index. */
331 hwmon = get_hwmon_index(addr);
335 cgp = g_malloc0(sizeof(struct channel_group_priv));
336 cg = sr_channel_group_new(sdi, NULL, cgp);
339 * See if we can read the EEPROM contents. If not, assume it's
340 * a revision A probe.
342 memset(&eeprom, 0, sizeof(struct probe_eeprom));
343 status = read_probe_eeprom(addr, &eeprom);
344 cgp->rev = status < 0 ? ACME_REV_A : ACME_REV_B;
346 prb_num = cgp->rev == ACME_REV_A ? prb_num : revB_addr_to_num(addr);
348 cgp->hwmon_num = hwmon;
349 cgp->probe_type = type;
350 cgp->index = prb_num - 1;
351 cg->name = g_strdup_printf("Probe_%d", prb_num);
353 if (cgp->rev == ACME_REV_A) {
354 gpio = revA_pws_info_gpios[cgp->index];
355 cgp->has_pws = sr_gpio_getval_export(gpio);
356 cgp->pws_gpio = revA_pws_gpios[cgp->index];
358 cgp->has_pws = eeprom.pwr_sw;
359 cgp->pws_gpio = revB_pws_gpios[cgp->index];
362 * For revision B we can already try to set the shunt
363 * resistance according to the EEPROM contents.
365 * Keep the default value if shunt in EEPROM == 0.
367 if (eeprom.shunt > 0)
368 bl_acme_set_shunt(cg, UOHM_TO_MOHM(eeprom.shunt));
371 if (type == PROBE_ENRG) {
372 append_channel(sdi, cg, prb_num, ENRG_PWR);
373 append_channel(sdi, cg, prb_num, ENRG_CURR);
374 append_channel(sdi, cg, prb_num, ENRG_VOL);
375 } else if (type == PROBE_TEMP) {
376 append_channel(sdi, cg, prb_num, TEMP_IN);
377 append_channel(sdi, cg, prb_num, TEMP_OUT);
379 sr_err("Invalid probe type: %d.", type);
385 SR_PRIV int bl_acme_get_probe_type(const struct sr_channel_group *cg)
387 struct channel_group_priv *cgp = cg->priv;
389 return cgp->probe_type;
392 SR_PRIV int bl_acme_probe_has_pws(const struct sr_channel_group *cg)
394 struct channel_group_priv *cgp = cg->priv;
400 * Sets path to the hwmon attribute if this channel group
401 * supports shunt resistance setting. The caller has to supply
404 static int get_shunt_path(const struct sr_channel_group *cg, GString *path)
406 struct channel_group_priv *cgp;
407 int ret = SR_OK, status;
411 if (cgp->probe_type != PROBE_ENRG) {
412 sr_err("Probe doesn't support shunt resistance setting");
416 g_string_append_printf(path,
417 "/sys/class/hwmon/hwmon%d/shunt_resistor",
421 * The shunt_resistor sysfs attribute is available
422 * in the Linux kernel since version 3.20. We have
423 * to notify the user if this attribute is not present.
425 status = g_file_test(path->str, G_FILE_TEST_EXISTS);
427 sr_err("shunt_resistance attribute not present, please update "
428 "your kernel to version >=3.20");
436 * Try setting the update_interval sysfs attribute for each probe according
439 SR_PRIV void bl_acme_maybe_set_update_interval(const struct sr_dev_inst *sdi,
442 struct sr_channel_group *cg;
443 struct channel_group_priv *cgp;
448 for (l = sdi->channel_groups; l != NULL; l = l->next) {
452 hwmon = g_string_sized_new(64);
453 g_string_append_printf(hwmon,
454 "/sys/class/hwmon/hwmon%d/update_interval",
457 if (g_file_test(hwmon->str, G_FILE_TEST_EXISTS)) {
458 fd = g_fopen(hwmon->str, "w");
460 g_string_free(hwmon, TRUE);
464 g_fprintf(fd, "%" PRIu64 "\n", 1000 / samplerate);
468 g_string_free(hwmon, TRUE);
472 SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
475 GString *path = g_string_sized_new(64);
477 int status, ret = SR_OK;
480 status = get_shunt_path(cg, path);
481 if (status != SR_OK) {
486 status = g_file_get_contents(path->str, &contents, NULL, &err);
488 sr_err("Error reading shunt resistance: %s", err->message);
494 *shunt = UOHM_TO_MOHM(strtol(contents, NULL, 10));
497 g_string_free(path, TRUE);
501 SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg, uint64_t shunt)
503 GString *path = g_string_sized_new(64);;
504 int status, ret = SR_OK;
507 status = get_shunt_path(cg, path);
508 if (status != SR_OK) {
514 * Can't use g_file_set_contents() here, as it calls open() with
515 * O_EXEC flag in a sysfs directory thus failing with EACCES.
517 fd = g_fopen(path->str, "w");
519 sr_err("Error opening %s: %s", path->str, g_strerror(errno));
524 g_fprintf(fd, "%" PRIu64 "\n", MOHM_TO_UOHM(shunt));
528 g_string_free(path, TRUE);
532 SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
535 struct channel_group_priv *cgp;
540 if (!bl_acme_probe_has_pws(cg)) {
541 sr_err("Probe has no power-switch");
545 val = sr_gpio_getval_export(cgp->pws_gpio);
546 *off = val ? FALSE : TRUE;
551 SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
554 struct channel_group_priv *cgp;
559 if (!bl_acme_probe_has_pws(cg)) {
560 sr_err("Probe has no power-switch");
564 val = sr_gpio_setval_export(cgp->pws_gpio, off ? 0 : 1);
566 sr_err("Error setting power-off state: gpio: %d",
574 static int channel_to_mq(struct sr_channel *ch)
576 struct channel_priv *chp;
580 switch (chp->ch_type) {
584 return SR_MQ_CURRENT;
586 return SR_MQ_VOLTAGE;
587 case TEMP_IN: /* Fallthrough */
589 return SR_MQ_TEMPERATURE;
595 static int channel_to_unit(struct sr_channel *ch)
597 struct channel_priv *chp;
601 switch (chp->ch_type) {
605 return SR_UNIT_AMPERE;
608 case TEMP_IN: /* Fallthrough */
610 return SR_UNIT_CELSIUS;
616 /* We need to scale measurements down from the units used by the drivers. */
617 static int type_digits(int type)
622 case ENRG_CURR: /* Fallthrough */
623 case ENRG_VOL: /* Fallthrough */
624 case TEMP_IN: /* Fallthrough */
632 static float read_sample(struct sr_channel *ch)
634 struct channel_priv *chp;
642 lseek(fd, 0, SEEK_SET);
644 len = read(fd, buf, sizeof(buf));
646 sr_err("Error reading from channel %s (hwmon: %d): %s",
647 ch->name, chp->probe->hwmon_num, g_strerror(errno));
652 chp->digits = type_digits(chp->ch_type);
653 return strtol(buf, NULL, 10) * powf(10, -chp->digits);
656 SR_PRIV int bl_acme_open_channel(struct sr_channel *ch)
658 struct channel_priv *chp;
665 switch (chp->ch_type) {
666 case ENRG_PWR: file = "power1_input"; break;
667 case ENRG_CURR: file = "curr1_input"; break;
668 case ENRG_VOL: file = "in1_input"; break;
669 case TEMP_IN: file = "temp1_input"; break;
670 case TEMP_OUT: file = "temp2_input"; break;
672 sr_err("Invalid channel type: %d.", chp->ch_type);
676 snprintf(path, sizeof(path), "/sys/class/hwmon/hwmon%d/%s",
677 chp->probe->hwmon_num, file);
679 fd = open(path, O_RDONLY);
681 sr_err("Error opening %s: %s", path, g_strerror(errno));
691 SR_PRIV void bl_acme_close_channel(struct sr_channel *ch)
693 struct channel_priv *chp;
700 SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data)
702 uint64_t nrexpiration;
703 struct sr_datafeed_packet packet;
704 struct sr_datafeed_analog analog;
705 struct sr_analog_encoding encoding;
706 struct sr_analog_meaning meaning;
707 struct sr_analog_spec spec;
708 struct sr_dev_inst *sdi;
709 struct sr_channel *ch;
710 struct channel_priv *chp;
711 struct dev_context *devc;
726 packet.type = SR_DF_ANALOG;
727 packet.payload = &analog;
728 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
730 if (read(devc->timer_fd, &nrexpiration, sizeof(nrexpiration)) < 0) {
731 sr_warn("Failed to read timer information");
736 * We were not able to process the previous timer expiration, we are
739 if (nrexpiration > 1)
740 devc->samples_missed += nrexpiration - 1;
743 * XXX This is a nasty workaround...
745 * At high sampling rates and maximum channels we are not able to
746 * acquire samples fast enough, even though frontends still think
747 * that samples arrive on time. This causes shifts in frontend
750 * To compensate for the delay we check if any clock events were
751 * missed and - if so - don't really read the next value, but send
752 * the same sample as fast as possible. We do it until we are back
755 * At high sampling rate this doesn't seem to visibly reduce the
758 for (i = 0; i < nrexpiration; i++) {
759 std_session_send_df_frame_begin(sdi);
762 * Due to different units used in each channel we're sending
763 * samples one-by-one.
765 for (chl = sdi->channels; chl; chl = chl->next) {
773 analog.num_samples = 1;
774 analog.meaning->channels = &chonly;
775 analog.meaning->mq = channel_to_mq(chl->data);
776 analog.meaning->unit = channel_to_unit(ch);
779 chp->val = read_sample(ch);
781 analog.encoding->digits = chp->digits;
782 analog.spec->spec_digits = chp->digits;
783 analog.data = &chp->val;
784 sr_session_send(sdi, &packet);
787 std_session_send_df_frame_end(sdi);
790 sr_sw_limits_update_samples_read(&devc->limits, 1);
792 if (sr_sw_limits_check(&devc->limits)) {
793 sr_dev_acquisition_stop(sdi);