2 * This file is part of the libsigrok project.
4 * Copyright (C) 2017-2018 Frank Stettner <frank-stettner@gmx.net>
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 static int set_mq_volt(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
27 static int set_mq_amp(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
28 static int set_mq_ohm(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
32 int (*set_mode)(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
33 } sr_mq_to_cmd_map[] = {
34 { SR_MQ_VOLTAGE, set_mq_volt },
35 { SR_MQ_CURRENT, set_mq_amp },
36 { SR_MQ_RESISTANCE, set_mq_ohm },
39 static int set_mq_volt(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
43 if ((flags & SR_MQFLAG_AC) != SR_MQFLAG_AC &&
44 (flags & SR_MQFLAG_DC) != SR_MQFLAG_DC)
47 if ((flags & SR_MQFLAG_AC) == SR_MQFLAG_AC)
52 return sr_scpi_send(scpi, "%s", cmd);
55 static int set_mq_amp(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
59 if ((flags & SR_MQFLAG_AC) != SR_MQFLAG_AC &&
60 (flags & SR_MQFLAG_DC) != SR_MQFLAG_DC)
63 if (flags & SR_MQFLAG_AC)
68 return sr_scpi_send(scpi, "%s", cmd);
71 static int set_mq_ohm(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
75 if (flags & SR_MQFLAG_FOUR_WIRE)
80 return sr_scpi_send(scpi, "%s", cmd);
83 SR_PRIV int hp_3478a_set_mq(const struct sr_dev_inst *sdi, enum sr_mq mq,
84 enum sr_mqflag mq_flags)
88 struct sr_scpi_dev_inst *scpi = sdi->conn;
89 struct dev_context *devc = sdi->priv;
91 /* No need to send command if we're not changing measurement type. */
92 if (devc->measurement_mq == mq &&
93 ((devc->measurement_mq_flags & mq_flags) == mq_flags))
96 for (i = 0; i < ARRAY_SIZE(sr_mq_to_cmd_map); i++) {
97 if (sr_mq_to_cmd_map[i].mq != mq)
100 ret = sr_mq_to_cmd_map[i].set_mode(scpi, mq_flags);
104 ret = hp_3478a_get_status_bytes(sdi);
111 static int parse_range_vdc(struct dev_context *devc, uint8_t range_byte)
113 if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_30MV) {
114 devc->enc_digits = devc->spec_digits - 2;
115 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_300MV) {
116 devc->enc_digits = devc->spec_digits - 3;
117 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_3V) {
118 devc->enc_digits = devc->spec_digits - 1;
119 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_30V) {
120 devc->enc_digits = devc->spec_digits - 2;
121 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_300V) {
122 devc->enc_digits = devc->spec_digits - 3;
130 static int parse_range_vac(struct dev_context *devc, uint8_t range_byte)
132 if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_300MV) {
133 devc->enc_digits = devc->spec_digits - 3;
134 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_3V) {
135 devc->enc_digits = devc->spec_digits - 1;
136 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_30V) {
137 devc->enc_digits = devc->spec_digits - 2;
138 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_300V) {
139 devc->enc_digits = devc->spec_digits - 3;
147 static int parse_range_a(struct dev_context *devc, uint8_t range_byte)
149 if ((range_byte & SB1_RANGE_BLOCK) == RANGE_A_300MA) {
150 devc->enc_digits = devc->spec_digits - 3;
151 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_A_3A) {
152 devc->enc_digits = devc->spec_digits - 1;
160 static int parse_range_ohm(struct dev_context *devc, uint8_t range_byte)
162 if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30R) {
163 devc->enc_digits = devc->spec_digits - 2;
164 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_300R) {
165 devc->enc_digits = devc->spec_digits - 3;
166 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_3KR) {
167 devc->enc_digits = devc->spec_digits - 1;
168 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30KR) {
169 devc->enc_digits = devc->spec_digits - 2;
170 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_300KR) {
171 devc->enc_digits = devc->spec_digits - 3;
172 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_3MR) {
173 devc->enc_digits = devc->spec_digits - 1;
174 } else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30MR) {
175 devc->enc_digits = devc->spec_digits - 2;
183 static int parse_function_byte(struct dev_context *devc, uint8_t function_byte)
185 devc->measurement_mq_flags = 0;
187 /* Function + Range */
188 if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_VDC) {
189 devc->measurement_mq = SR_MQ_VOLTAGE;
190 devc->measurement_mq_flags |= SR_MQFLAG_DC;
191 devc->measurement_unit = SR_UNIT_VOLT;
192 parse_range_vdc(devc, function_byte);
193 } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_VAC) {
194 devc->measurement_mq = SR_MQ_VOLTAGE;
195 devc->measurement_mq_flags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
196 devc->measurement_unit = SR_UNIT_VOLT;
197 parse_range_vac(devc, function_byte);
198 } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_2WR) {
199 devc->measurement_mq = SR_MQ_RESISTANCE;
200 devc->measurement_unit = SR_UNIT_OHM;
201 parse_range_ohm(devc, function_byte);
202 } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_4WR) {
203 devc->measurement_mq = SR_MQ_RESISTANCE;
204 devc->measurement_mq_flags |= SR_MQFLAG_FOUR_WIRE;
205 devc->measurement_unit = SR_UNIT_OHM;
206 parse_range_ohm(devc, function_byte);
207 } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_ADC) {
208 devc->measurement_mq = SR_MQ_CURRENT;
209 devc->measurement_mq_flags |= SR_MQFLAG_DC;
210 devc->measurement_unit = SR_UNIT_AMPERE;
211 parse_range_a(devc, function_byte);
212 } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_AAC) {
213 devc->measurement_mq = SR_MQ_CURRENT;
214 devc->measurement_mq_flags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
215 devc->measurement_unit = SR_UNIT_AMPERE;
216 parse_range_a(devc, function_byte);
217 } else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_EXR) {
218 devc->measurement_mq = SR_MQ_RESISTANCE;
219 devc->measurement_unit = SR_UNIT_OHM;
220 parse_range_ohm(devc, function_byte);
223 /* Digits / Resolution */
224 if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_5_5) {
225 devc->spec_digits = 5;
226 } else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_4_5) {
227 devc->spec_digits = 4;
228 } else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_3_5) {
229 devc->spec_digits = 3;
235 static int parse_status_byte(struct dev_context *devc, uint8_t status_byte)
237 devc->trigger = TRIGGER_UNDEFINED;
239 /* External Trigger */
240 if ((status_byte & STATUS_EXT_TRIGGER) == STATUS_EXT_TRIGGER)
241 devc->trigger = TRIGGER_EXTERNAL;
244 if ((status_byte & STATUS_CAL_RAM) == STATUS_CAL_RAM)
245 devc->calibration = TRUE;
247 devc->calibration = FALSE;
249 /* Front/Rear terminals */
250 if ((status_byte & STATUS_FRONT_TERMINAL) == STATUS_FRONT_TERMINAL)
251 devc->terminal = TERMINAL_FRONT;
253 devc->terminal = TERMINAL_REAR;
256 if ((status_byte & STATUS_50HZ) == STATUS_50HZ)
257 devc->line = LINE_50HZ;
259 devc->line = LINE_60HZ;
262 if ((status_byte & STATUS_AUTO_ZERO) == STATUS_AUTO_ZERO)
263 devc->auto_zero = TRUE;
265 devc->auto_zero = FALSE;
268 if ((status_byte & STATUS_AUTO_RANGE) == STATUS_AUTO_RANGE)
269 devc->measurement_mq_flags |= SR_MQFLAG_AUTORANGE;
271 devc->measurement_mq_flags &= ~SR_MQFLAG_AUTORANGE;
273 /* Internal trigger */
274 if ((status_byte & STATUS_INT_TRIGGER) == STATUS_INT_TRIGGER)
275 devc->trigger = TRIGGER_INTERNAL;
280 static int parse_srq_byte(uint8_t sqr_byte)
285 /* The ServiceReQuest register isn't used at the moment. */
288 if ((sqr_byte & SRQ_POWER_ON) == SRQ_POWER_ON)
289 sr_spew("hp_3478a_get_status_bytes: Power On SRQ or clear "
293 if ((sqr_byte & SRQ_CAL_FAILED) == SRQ_CAL_FAILED)
294 sr_spew("hp_3478a_get_status_bytes: CAL failed SRQ");
297 if ((sqr_byte & SRQ_KEYBORD) == SRQ_KEYBORD)
298 sr_spew("hp_3478a_get_status_bytes: Keyboard SRQ");
300 /* Hardware error SRQ */
301 if ((sqr_byte & SRQ_HARDWARE_ERR) == SRQ_HARDWARE_ERR)
302 sr_spew("hp_3478a_get_status_bytes: Hardware error SRQ");
304 /* Syntax error SRQ */
305 if ((sqr_byte & SRQ_SYNTAX_ERR) == SRQ_SYNTAX_ERR)
306 sr_spew("hp_3478a_get_status_bytes: Syntax error SRQ");
308 /* Every reading is available to the bus SRQ */
309 if ((sqr_byte & SRQ_BUS_AVAIL) == SRQ_BUS_AVAIL)
310 sr_spew("hp_3478a_get_status_bytes: Every reading is available to "
317 static int parse_error_byte(uint8_t error_byte)
324 if ((error_byte & ERROR_AD_LINK) == ERROR_AD_LINK) {
325 sr_err("hp_3478a: Failure in the A/D link");
330 if ((error_byte & ERROR_AD_SELF_TEST) == ERROR_AD_SELF_TEST) {
331 sr_err("hp_3478a: A/D has failed its internal Self Test");
335 /* A/D slope error */
336 if ((error_byte & ERROR_AD_SLOPE) == ERROR_AD_SLOPE) {
337 sr_err("hp_3478a: There has been an A/D slope error");
342 if ((error_byte & ERROR_ROM_SELF_TEST) == ERROR_ROM_SELF_TEST) {
343 sr_err("hp_3478a: The ROM Self Test has failed");
348 if ((error_byte & ERROR_RAM_SELF_TEST) == ERROR_RAM_SELF_TEST) {
349 sr_err("hp_3478a: The RAM Self Test has failed");
354 if ((error_byte & ERROR_SELF_TEST) == ERROR_SELF_TEST) {
355 sr_err("hp_3478a: Self Test: Any of the CAL RAM locations have bad "
356 "checksums, or a range with a bad checksum is selected");
363 SR_PRIV int hp_3478a_get_status_bytes(const struct sr_dev_inst *sdi)
367 uint8_t function_byte, status_byte, srq_byte, error_byte;
368 struct sr_scpi_dev_inst *scpi = sdi->conn;
369 struct dev_context *devc = sdi->priv;
371 ret = sr_scpi_get_string(scpi, "B", &response);
378 function_byte = (uint8_t)response[0];
379 status_byte = (uint8_t)response[1];
380 srq_byte = (uint8_t)response[2];
381 error_byte = (uint8_t)response[3];
385 parse_function_byte(devc, function_byte);
386 parse_status_byte(devc, status_byte);
387 parse_srq_byte(srq_byte);
388 ret = parse_error_byte(error_byte);
393 static void acq_send_measurement(struct sr_dev_inst *sdi)
395 struct sr_datafeed_packet packet;
396 struct sr_datafeed_analog analog;
397 struct sr_analog_encoding encoding;
398 struct sr_analog_meaning meaning;
399 struct sr_analog_spec spec;
400 struct dev_context *devc;
405 packet.type = SR_DF_ANALOG;
406 packet.payload = &analog;
408 sr_analog_init(&analog, &encoding, &meaning, &spec, devc->enc_digits);
410 /* TODO: Implement NAN, depending on counts, range and value. */
411 f = devc->measurement;
412 analog.num_samples = 1;
415 encoding.unitsize = sizeof(float);
416 encoding.is_float = TRUE;
417 encoding.digits = devc->enc_digits;
419 meaning.mq = devc->measurement_mq;
420 meaning.mqflags = devc->measurement_mq_flags;
421 meaning.unit = devc->measurement_unit;
422 meaning.channels = sdi->channels;
424 spec.spec_digits = devc->spec_digits;
426 sr_session_send(sdi, &packet);
429 SR_PRIV int hp_3478a_receive_data(int fd, int revents, void *cb_data)
431 struct sr_scpi_dev_inst *scpi;
432 struct sr_dev_inst *sdi;
433 struct dev_context *devc;
438 if (!(sdi = cb_data) || !(devc = sdi->priv))
444 * This is necessary to get the actual range for the encoding digits.
445 * When SPoll is implemmented, this can be done via SPoll.
447 if (hp_3478a_get_status_bytes(sdi) != SR_OK)
451 * TODO: Implement GPIB-SPoll, to get notified by a SRQ when a new
452 * measurement is available. This is necessary, because when
453 * switching ranges, there could be a timeout.
455 if (sr_scpi_get_double(scpi, NULL, &devc->measurement) != SR_OK)
458 acq_send_measurement(sdi);
459 sr_sw_limits_update_samples_read(&devc->limits, 1);
461 if (sr_sw_limits_check(&devc->limits))
462 sr_dev_acquisition_stop(sdi);