X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fhp-3478a%2Fprotocol.c;h=6e3b2bc1aff8c887ef77ea9c03d86ee6f8ca6a51;hb=HEAD;hp=e9cf6677f88dc448afe1cd6c0a7081ca6fc34d38;hpb=d2c1730a281ed4982f2ea8be0cd137d0e47135a0;p=libsigrok.git diff --git a/src/hardware/hp-3478a/protocol.c b/src/hardware/hp-3478a/protocol.c index e9cf6677..6e3b2bc1 100644 --- a/src/hardware/hp-3478a/protocol.c +++ b/src/hardware/hp-3478a/protocol.c @@ -1,7 +1,7 @@ /* * This file is part of the libsigrok project. * - * Copyright (C) 2017-2018 Frank Stettner + * Copyright (C) 2017-2021 Frank Stettner * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -38,46 +38,27 @@ static const struct { static int set_mq_volt(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags) { - const char *cmd; - if ((flags & SR_MQFLAG_AC) != SR_MQFLAG_AC && (flags & SR_MQFLAG_DC) != SR_MQFLAG_DC) return SR_ERR_NA; - if ((flags & SR_MQFLAG_AC) == SR_MQFLAG_AC) - cmd = "F2"; - else - cmd = "F1"; - - return sr_scpi_send(scpi, "%s", cmd); + return sr_scpi_send(scpi, "%s", + ((flags & SR_MQFLAG_AC) == SR_MQFLAG_AC) ? "F2" : "F1"); } static int set_mq_amp(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags) { - const char *cmd; - if ((flags & SR_MQFLAG_AC) != SR_MQFLAG_AC && (flags & SR_MQFLAG_DC) != SR_MQFLAG_DC) return SR_ERR_NA; - if (flags & SR_MQFLAG_AC) - cmd = "F6"; - else - cmd = "F5"; - - return sr_scpi_send(scpi, "%s", cmd); + return sr_scpi_send(scpi, "%s", (flags & SR_MQFLAG_AC) ? "F6" : "F5"); } static int set_mq_ohm(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags) { - const char *cmd; - - if (flags & SR_MQFLAG_FOUR_WIRE) - cmd = "F4"; - else - cmd = "F3"; - - return sr_scpi_send(scpi, "%s", cmd); + return sr_scpi_send(scpi, "%s", + (flags & SR_MQFLAG_FOUR_WIRE) ? "F4" : "F3"); } SR_PRIV int hp_3478a_set_mq(const struct sr_dev_inst *sdi, enum sr_mq mq, @@ -88,9 +69,8 @@ SR_PRIV int hp_3478a_set_mq(const struct sr_dev_inst *sdi, enum sr_mq mq, struct sr_scpi_dev_inst *scpi = sdi->conn; struct dev_context *devc = sdi->priv; - /* No need to send command if we're not changing measurement type. */ - if (devc->measurement_mq == mq && - ((devc->measurement_mq_flags & mq_flags) == mq_flags)) + /* No need to send a command if we're not changing the measurement type. */ + if (devc->measurement_mq == mq && devc->measurement_mq_flag == mq_flags) return SR_OK; for (i = 0; i < ARRAY_SIZE(sr_mq_to_cmd_map); i++) { @@ -108,21 +88,64 @@ SR_PRIV int hp_3478a_set_mq(const struct sr_dev_inst *sdi, enum sr_mq mq, return SR_ERR_NA; } +SR_PRIV int hp_3478a_set_range(const struct sr_dev_inst *sdi, int range_exp) +{ + int ret; + struct sr_scpi_dev_inst *scpi = sdi->conn; + struct dev_context *devc = sdi->priv; + + /* No need to send command if we're not changing the range. */ + if (devc->range_exp == range_exp) + return SR_OK; + + /* -99 is a dummy exponent for auto ranging. */ + if (range_exp == -99) + ret = sr_scpi_send(scpi, "RA"); + else + ret = sr_scpi_send(scpi, "R%i", range_exp); + if (ret != SR_OK) + return ret; + + return hp_3478a_get_status_bytes(sdi); +} + +SR_PRIV int hp_3478a_set_digits(const struct sr_dev_inst *sdi, uint8_t digits) +{ + int ret; + struct sr_scpi_dev_inst *scpi = sdi->conn; + struct dev_context *devc = sdi->priv; + + /* No need to send command if we're not changing the resolution. */ + if (devc->digits == digits) + return SR_OK; + + /* digits are the total number of digits, so we have to substract 1 */ + ret = sr_scpi_send(scpi, "N%i", digits-1); + if (ret != SR_OK) + return ret; + + return hp_3478a_get_status_bytes(sdi); +} + static int parse_range_vdc(struct dev_context *devc, uint8_t range_byte) { if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_30MV) { - devc->enc_digits = devc->spec_digits - 2; + devc->range_exp = -2; + devc->sr_digits = devc->digits + 1; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_300MV) { - devc->enc_digits = devc->spec_digits - 3; + devc->range_exp = -1; + devc->sr_digits = devc->digits; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_3V) { - devc->enc_digits = devc->spec_digits - 1; + devc->range_exp = 0; + devc->sr_digits = devc->digits - 1; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_30V) { - devc->enc_digits = devc->spec_digits - 2; + devc->range_exp = 1; + devc->sr_digits = devc->digits - 2; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_300V) { - devc->enc_digits = devc->spec_digits - 3; - } else { + devc->range_exp = 2; + devc->sr_digits = devc->digits - 3; + } else return SR_ERR_DATA; - } return SR_OK; } @@ -130,16 +153,19 @@ static int parse_range_vdc(struct dev_context *devc, uint8_t range_byte) static int parse_range_vac(struct dev_context *devc, uint8_t range_byte) { if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_300MV) { - devc->enc_digits = devc->spec_digits - 3; + devc->range_exp = -1; + devc->sr_digits = devc->digits; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_3V) { - devc->enc_digits = devc->spec_digits - 1; + devc->range_exp = 0; + devc->sr_digits = devc->digits - 1; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_30V) { - devc->enc_digits = devc->spec_digits - 2; + devc->range_exp = 1; + devc->sr_digits = devc->digits - 2; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_300V) { - devc->enc_digits = devc->spec_digits - 3; - } else { + devc->range_exp = 2; + devc->sr_digits = devc->digits - 3; + } else return SR_ERR_DATA; - } return SR_OK; } @@ -147,12 +173,13 @@ static int parse_range_vac(struct dev_context *devc, uint8_t range_byte) static int parse_range_a(struct dev_context *devc, uint8_t range_byte) { if ((range_byte & SB1_RANGE_BLOCK) == RANGE_A_300MA) { - devc->enc_digits = devc->spec_digits - 3; + devc->range_exp = -1; + devc->sr_digits = devc->digits; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_A_3A) { - devc->enc_digits = devc->spec_digits - 1; - } else { + devc->range_exp = 0; + devc->sr_digits = devc->digits - 1; + } else return SR_ERR_DATA; - } return SR_OK; } @@ -160,39 +187,57 @@ static int parse_range_a(struct dev_context *devc, uint8_t range_byte) static int parse_range_ohm(struct dev_context *devc, uint8_t range_byte) { if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30R) { - devc->enc_digits = devc->spec_digits - 2; + devc->range_exp = 1; + devc->sr_digits = devc->digits - 2; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_300R) { - devc->enc_digits = devc->spec_digits - 3; + devc->range_exp = 2; + devc->sr_digits = devc->digits - 3; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_3KR) { - devc->enc_digits = devc->spec_digits - 1; + devc->range_exp = 3; + devc->sr_digits = devc->digits - 4; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30KR) { - devc->enc_digits = devc->spec_digits - 2; + devc->range_exp = 4; + devc->sr_digits = devc->digits - 5; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_300KR) { - devc->enc_digits = devc->spec_digits - 3; + devc->range_exp = 5; + devc->sr_digits = devc->digits - 6; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_3MR) { - devc->enc_digits = devc->spec_digits - 1; + devc->range_exp = 6; + devc->sr_digits = devc->digits - 7; } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30MR) { - devc->enc_digits = devc->spec_digits - 2; - } else { + devc->range_exp = 7; + devc->sr_digits = devc->digits - 8; + } else return SR_ERR_DATA; - } return SR_OK; } static int parse_function_byte(struct dev_context *devc, uint8_t function_byte) { - devc->measurement_mq_flags = 0; + /* Digits / Resolution (digits must be set before range parsing) */ + if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_5_5) + devc->digits = 6; + else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_4_5) + devc->digits = 5; + else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_3_5) + devc->digits = 4; + else + return SR_ERR_DATA; /* Function + Range */ + devc->measurement_mq_flag = 0; + devc->acquisition_mq_flags = 0; if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_VDC) { devc->measurement_mq = SR_MQ_VOLTAGE; - devc->measurement_mq_flags |= SR_MQFLAG_DC; + devc->measurement_mq_flag = SR_MQFLAG_DC; + devc->acquisition_mq_flags |= SR_MQFLAG_DC; devc->measurement_unit = SR_UNIT_VOLT; parse_range_vdc(devc, function_byte); } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_VAC) { devc->measurement_mq = SR_MQ_VOLTAGE; - devc->measurement_mq_flags |= SR_MQFLAG_AC | SR_MQFLAG_RMS; + devc->measurement_mq_flag = SR_MQFLAG_AC; + devc->acquisition_mq_flags |= SR_MQFLAG_AC | SR_MQFLAG_RMS; devc->measurement_unit = SR_UNIT_VOLT; parse_range_vac(devc, function_byte); } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_2WR) { @@ -201,17 +246,20 @@ static int parse_function_byte(struct dev_context *devc, uint8_t function_byte) parse_range_ohm(devc, function_byte); } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_4WR) { devc->measurement_mq = SR_MQ_RESISTANCE; - devc->measurement_mq_flags |= SR_MQFLAG_FOUR_WIRE; + devc->measurement_mq_flag = SR_MQFLAG_FOUR_WIRE; + devc->acquisition_mq_flags |= SR_MQFLAG_FOUR_WIRE; devc->measurement_unit = SR_UNIT_OHM; parse_range_ohm(devc, function_byte); } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_ADC) { devc->measurement_mq = SR_MQ_CURRENT; - devc->measurement_mq_flags |= SR_MQFLAG_DC; + devc->measurement_mq_flag = SR_MQFLAG_DC; + devc->acquisition_mq_flags |= SR_MQFLAG_DC; devc->measurement_unit = SR_UNIT_AMPERE; parse_range_a(devc, function_byte); } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_AAC) { devc->measurement_mq = SR_MQ_CURRENT; - devc->measurement_mq_flags |= SR_MQFLAG_AC | SR_MQFLAG_RMS; + devc->measurement_mq_flag = SR_MQFLAG_AC; + devc->acquisition_mq_flags |= SR_MQFLAG_AC | SR_MQFLAG_RMS; devc->measurement_unit = SR_UNIT_AMPERE; parse_range_a(devc, function_byte); } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_EXR) { @@ -220,15 +268,6 @@ static int parse_function_byte(struct dev_context *devc, uint8_t function_byte) parse_range_ohm(devc, function_byte); } - /* Digits / Resolution */ - if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_5_5) { - devc->spec_digits = 5; - } else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_4_5) { - devc->spec_digits = 4; - } else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_3_5) { - devc->spec_digits = 3; - } - return SR_OK; } @@ -265,10 +304,11 @@ static int parse_status_byte(struct dev_context *devc, uint8_t status_byte) devc->auto_zero = FALSE; /* Auto-Range */ - if ((status_byte & STATUS_AUTO_RANGE) == STATUS_AUTO_RANGE) - devc->measurement_mq_flags |= SR_MQFLAG_AUTORANGE; - else - devc->measurement_mq_flags &= ~SR_MQFLAG_AUTORANGE; + if ((status_byte & STATUS_AUTO_RANGE) == STATUS_AUTO_RANGE) { + devc->acquisition_mq_flags |= SR_MQFLAG_AUTORANGE; + devc->range_exp = -99; + } else + devc->acquisition_mq_flags &= ~SR_MQFLAG_AUTORANGE; /* Internal trigger */ if ((status_byte & STATUS_INT_TRIGGER) == STATUS_INT_TRIGGER) @@ -286,29 +326,27 @@ static int parse_srq_byte(uint8_t sqr_byte) /* PON SRQ */ if ((sqr_byte & SRQ_POWER_ON) == SRQ_POWER_ON) - sr_spew("hp_3478a_get_status_bytes: Power On SRQ or clear " - "msg received"); + sr_spew("Power On SRQ or clear msg received"); /* Cal failed SRQ */ if ((sqr_byte & SRQ_CAL_FAILED) == SRQ_CAL_FAILED) - sr_spew("hp_3478a_get_status_bytes: CAL failed SRQ"); + sr_spew("CAL failed SRQ"); /* Keyboard SRQ */ if ((sqr_byte & SRQ_KEYBORD) == SRQ_KEYBORD) - sr_spew("hp_3478a_get_status_bytes: Keyboard SRQ"); + sr_spew("Keyboard SRQ"); /* Hardware error SRQ */ if ((sqr_byte & SRQ_HARDWARE_ERR) == SRQ_HARDWARE_ERR) - sr_spew("hp_3478a_get_status_bytes: Hardware error SRQ"); + sr_spew("Hardware error SRQ"); /* Syntax error SRQ */ if ((sqr_byte & SRQ_SYNTAX_ERR) == SRQ_SYNTAX_ERR) - sr_spew("hp_3478a_get_status_bytes: Syntax error SRQ"); + sr_spew("Syntax error SRQ"); /* Every reading is available to the bus SRQ */ if ((sqr_byte & SRQ_BUS_AVAIL) == SRQ_BUS_AVAIL) - sr_spew("hp_3478a_get_status_bytes: Every reading is available to " - "the bus SRQ"); + sr_spew("Every reading is available to the bus SRQ"); #endif return SR_OK; @@ -322,38 +360,38 @@ static int parse_error_byte(uint8_t error_byte) /* A/D link */ if ((error_byte & ERROR_AD_LINK) == ERROR_AD_LINK) { - sr_err("hp_3478a: Failure in the A/D link"); + sr_err("Failure in the A/D link"); ret = SR_ERR; } /* A/D Self Test */ if ((error_byte & ERROR_AD_SELF_TEST) == ERROR_AD_SELF_TEST) { - sr_err("hp_3478a: A/D has failed its internal Self Test"); + sr_err("A/D has failed its internal Self Test"); ret = SR_ERR; } /* A/D slope error */ if ((error_byte & ERROR_AD_SLOPE) == ERROR_AD_SLOPE) { - sr_err("hp_3478a: There has been an A/D slope error"); + sr_err("There has been an A/D slope error"); ret = SR_ERR; } /* ROM Selt Test */ if ((error_byte & ERROR_ROM_SELF_TEST) == ERROR_ROM_SELF_TEST) { - sr_err("hp_3478a: The ROM Self Test has failed"); + sr_err("The ROM Self Test has failed"); ret = SR_ERR; } /* RAM Selt Test */ if ((error_byte & ERROR_RAM_SELF_TEST) == ERROR_RAM_SELF_TEST) { - sr_err("hp_3478a: The RAM Self Test has failed"); + sr_err("The RAM Self Test has failed"); ret = SR_ERR; } /* Selt Test */ if ((error_byte & ERROR_SELF_TEST) == ERROR_SELF_TEST) { - sr_err("hp_3478a: Self Test: Any of the CAL RAM locations have bad " - "checksums, or a range with a bad checksum is selected"); + sr_err("Self Test: Any of the CAL RAM locations have bad " + "checksums, or a range with a bad checksum is selected"); ret = SR_ERR; } @@ -405,7 +443,7 @@ static void acq_send_measurement(struct sr_dev_inst *sdi) packet.type = SR_DF_ANALOG; packet.payload = &analog; - sr_analog_init(&analog, &encoding, &meaning, &spec, devc->enc_digits); + sr_analog_init(&analog, &encoding, &meaning, &spec, devc->sr_digits); /* TODO: Implement NAN, depending on counts, range and value. */ f = devc->measurement; @@ -414,14 +452,14 @@ static void acq_send_measurement(struct sr_dev_inst *sdi) encoding.unitsize = sizeof(float); encoding.is_float = TRUE; - encoding.digits = devc->enc_digits; + encoding.digits = devc->sr_digits; meaning.mq = devc->measurement_mq; - meaning.mqflags = devc->measurement_mq_flags; + meaning.mqflags = devc->acquisition_mq_flags; meaning.unit = devc->measurement_unit; meaning.channels = sdi->channels; - spec.spec_digits = devc->spec_digits; + spec.spec_digits = devc->sr_digits; sr_session_send(sdi, &packet); } @@ -431,6 +469,7 @@ SR_PRIV int hp_3478a_receive_data(int fd, int revents, void *cb_data) struct sr_scpi_dev_inst *scpi; struct sr_dev_inst *sdi; struct dev_context *devc; + char status_register; (void)fd; (void)revents; @@ -441,18 +480,32 @@ SR_PRIV int hp_3478a_receive_data(int fd, int revents, void *cb_data) scpi = sdi->conn; /* - * This is necessary to get the actual range for the encoding digits. - * When SPoll is implemmented, this can be done via SPoll. + * TODO: Wait for SRQ from the DMM when a new measurement is available. + * For now, we don't wait for a SRQ, but just do a SPoll and + * check the Data Ready bit (0x01). + * This is necessary, because (1) reading a value will block the + * bus until a measurement is available and (2) when switching + * ranges, there could be a timeout. */ - if (hp_3478a_get_status_bytes(sdi) != SR_OK) + if (sr_scpi_gpib_spoll(scpi, &status_register) != SR_OK) return FALSE; + if (!(((uint8_t)status_register) & SRQ_BUS_AVAIL)) + return TRUE; + + /* Get a reading from the DMM. */ + if (sr_scpi_get_double(scpi, NULL, &devc->measurement) != SR_OK) + return FALSE; + + /* Check for overflow. */ + if (devc->measurement >= 9.998e+9) + devc->measurement = INFINITY; /* - * TODO: Implement GPIB-SPoll, to get notified by a SRQ when a new - * measurement is available. This is necessary, because when - * switching ranges, there could be a timeout. + * This is necessary to get the actual range for the encoding digits. + * Must be called after reading the value, because it resets the + * status register! */ - if (sr_scpi_get_double(scpi, NULL, &devc->measurement) != SR_OK) + if (hp_3478a_get_status_bytes(sdi) != SR_OK) return FALSE; acq_send_measurement(sdi);