]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
20 | #include <glib.h> | |
21 | #include <string.h> | |
22 | #include <libsigrok/libsigrok.h> | |
23 | #include "libsigrok-internal.h" | |
24 | ||
25 | #define LOG_PREFIX "scpi" | |
26 | ||
27 | #define SCPI_READ_RETRIES 100 | |
28 | #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000) | |
29 | ||
30 | /** | |
31 | * Parse a string representation of a boolean-like value into a gboolean. | |
32 | * Similar to sr_parse_boolstring but rejects strings which do not represent | |
33 | * a boolean-like value. | |
34 | * | |
35 | * @param str String to convert. | |
36 | * @param ret Pointer to a gboolean where the result of the conversion will be | |
37 | * stored. | |
38 | * | |
39 | * @return SR_OK on success, SR_ERR on failure. | |
40 | */ | |
41 | static int parse_strict_bool(const char *str, gboolean *ret) | |
42 | { | |
43 | if (!str) | |
44 | return SR_ERR_ARG; | |
45 | ||
46 | if (!g_strcmp0(str, "1") || | |
47 | !g_ascii_strncasecmp(str, "y", 1) || | |
48 | !g_ascii_strncasecmp(str, "t", 1) || | |
49 | !g_ascii_strncasecmp(str, "yes", 3) || | |
50 | !g_ascii_strncasecmp(str, "true", 4) || | |
51 | !g_ascii_strncasecmp(str, "on", 2)) { | |
52 | *ret = TRUE; | |
53 | return SR_OK; | |
54 | } else if (!g_strcmp0(str, "0") || | |
55 | !g_ascii_strncasecmp(str, "n", 1) || | |
56 | !g_ascii_strncasecmp(str, "f", 1) || | |
57 | !g_ascii_strncasecmp(str, "no", 2) || | |
58 | !g_ascii_strncasecmp(str, "false", 5) || | |
59 | !g_ascii_strncasecmp(str, "off", 3)) { | |
60 | *ret = FALSE; | |
61 | return SR_OK; | |
62 | } | |
63 | ||
64 | return SR_ERR; | |
65 | } | |
66 | ||
67 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev; | |
68 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev; | |
69 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev; | |
70 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev; | |
71 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev; | |
72 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev; | |
73 | SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev; | |
74 | ||
75 | static const struct sr_scpi_dev_inst *scpi_devs[] = { | |
76 | &scpi_tcp_raw_dev, | |
77 | &scpi_tcp_rigol_dev, | |
78 | #ifdef HAVE_LIBUSB_1_0 | |
79 | &scpi_usbtmc_libusb_dev, | |
80 | #endif | |
81 | #if HAVE_RPC | |
82 | &scpi_vxi_dev, | |
83 | #endif | |
84 | #ifdef HAVE_LIBREVISA | |
85 | &scpi_visa_dev, | |
86 | #endif | |
87 | #ifdef HAVE_LIBGPIB | |
88 | &scpi_libgpib_dev, | |
89 | #endif | |
90 | #ifdef HAVE_LIBSERIALPORT | |
91 | &scpi_serial_dev, /* must be last as it matches any resource */ | |
92 | #endif | |
93 | }; | |
94 | ||
95 | static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc, | |
96 | const char *resource, const char *serialcomm, | |
97 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)) | |
98 | { | |
99 | struct sr_scpi_dev_inst *scpi; | |
100 | struct sr_dev_inst *sdi; | |
101 | ||
102 | if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm))) | |
103 | return NULL; | |
104 | ||
105 | if (sr_scpi_open(scpi) != SR_OK) { | |
106 | sr_info("Couldn't open SCPI device."); | |
107 | sr_scpi_free(scpi); | |
108 | return NULL; | |
109 | }; | |
110 | ||
111 | if ((sdi = probe_device(scpi))) | |
112 | return sdi; | |
113 | ||
114 | sr_scpi_close(scpi); | |
115 | sr_scpi_free(scpi); | |
116 | return NULL; | |
117 | } | |
118 | ||
119 | SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, | |
120 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)) | |
121 | { | |
122 | GSList *resources, *l, *devices; | |
123 | struct sr_dev_inst *sdi; | |
124 | const char *resource = NULL; | |
125 | const char *serialcomm = NULL; | |
126 | gchar **res; | |
127 | unsigned i; | |
128 | ||
129 | for (l = options; l; l = l->next) { | |
130 | struct sr_config *src = l->data; | |
131 | switch (src->key) { | |
132 | case SR_CONF_CONN: | |
133 | resource = g_variant_get_string(src->data, NULL); | |
134 | break; | |
135 | case SR_CONF_SERIALCOMM: | |
136 | serialcomm = g_variant_get_string(src->data, NULL); | |
137 | break; | |
138 | } | |
139 | } | |
140 | ||
141 | devices = NULL; | |
142 | for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { | |
143 | if ((resource && strcmp(resource, scpi_devs[i]->prefix)) | |
144 | || !scpi_devs[i]->scan) | |
145 | continue; | |
146 | resources = scpi_devs[i]->scan(drvc); | |
147 | for (l = resources; l; l = l->next) { | |
148 | res = g_strsplit(l->data, ":", 2); | |
149 | if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0], | |
150 | serialcomm ? serialcomm : res[1], probe_device))) { | |
151 | devices = g_slist_append(devices, sdi); | |
152 | sdi->connection_id = g_strdup(l->data); | |
153 | } | |
154 | g_strfreev(res); | |
155 | } | |
156 | g_slist_free_full(resources, g_free); | |
157 | } | |
158 | ||
159 | if (!devices && resource) { | |
160 | sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device); | |
161 | if (sdi) | |
162 | devices = g_slist_append(NULL, sdi); | |
163 | } | |
164 | ||
165 | /* Tack a copy of the newly found devices onto the driver list. */ | |
166 | if (devices) | |
167 | drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices)); | |
168 | ||
169 | return devices; | |
170 | } | |
171 | ||
172 | SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc, | |
173 | const char *resource, const char *serialcomm) | |
174 | { | |
175 | struct sr_scpi_dev_inst *scpi = NULL; | |
176 | const struct sr_scpi_dev_inst *scpi_dev; | |
177 | gchar **params; | |
178 | unsigned i; | |
179 | ||
180 | for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) { | |
181 | scpi_dev = scpi_devs[i]; | |
182 | if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) { | |
183 | sr_dbg("Opening %s device %s.", scpi_dev->name, resource); | |
184 | scpi = g_malloc(sizeof(*scpi)); | |
185 | *scpi = *scpi_dev; | |
186 | scpi->priv = g_malloc0(scpi->priv_size); | |
187 | scpi->read_timeout_ms = 1000; | |
188 | params = g_strsplit(resource, "/", 0); | |
189 | if (scpi->dev_inst_new(scpi->priv, drvc, resource, | |
190 | params, serialcomm) != SR_OK) { | |
191 | sr_scpi_free(scpi); | |
192 | scpi = NULL; | |
193 | } | |
194 | g_strfreev(params); | |
195 | break; | |
196 | } | |
197 | } | |
198 | ||
199 | return scpi; | |
200 | } | |
201 | ||
202 | /** | |
203 | * Open SCPI device. | |
204 | * | |
205 | * @param scpi Previously initialized SCPI device structure. | |
206 | * | |
207 | * @return SR_OK on success, SR_ERR on failure. | |
208 | */ | |
209 | SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi) | |
210 | { | |
211 | return scpi->open(scpi->priv); | |
212 | } | |
213 | ||
214 | /** | |
215 | * Add an event source for an SCPI device. | |
216 | * | |
217 | * @param session The session to add the event source to. | |
218 | * @param scpi Previously initialized SCPI device structure. | |
219 | * @param events Events to check for. | |
220 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
221 | * @param cb Callback function to add. Must not be NULL. | |
222 | * @param cb_data Data for the callback function. Can be NULL. | |
223 | * | |
224 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
225 | * SR_ERR_MALLOC upon memory allocation errors. | |
226 | */ | |
227 | SR_PRIV int sr_scpi_source_add(struct sr_session *session, | |
228 | struct sr_scpi_dev_inst *scpi, int events, int timeout, | |
229 | sr_receive_data_callback cb, void *cb_data) | |
230 | { | |
231 | return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data); | |
232 | } | |
233 | ||
234 | /** | |
235 | * Remove event source for an SCPI device. | |
236 | * | |
237 | * @param session The session to remove the event source from. | |
238 | * @param scpi Previously initialized SCPI device structure. | |
239 | * | |
240 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
241 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
242 | * internal errors. | |
243 | */ | |
244 | SR_PRIV int sr_scpi_source_remove(struct sr_session *session, | |
245 | struct sr_scpi_dev_inst *scpi) | |
246 | { | |
247 | return scpi->source_remove(session, scpi->priv); | |
248 | } | |
249 | ||
250 | /** | |
251 | * Send a SCPI command. | |
252 | * | |
253 | * @param scpi Previously initialized SCPI device structure. | |
254 | * @param format Format string, to be followed by any necessary arguments. | |
255 | * | |
256 | * @return SR_OK on success, SR_ERR on failure. | |
257 | */ | |
258 | SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi, | |
259 | const char *format, ...) | |
260 | { | |
261 | va_list args; | |
262 | int ret; | |
263 | ||
264 | va_start(args, format); | |
265 | ret = sr_scpi_send_variadic(scpi, format, args); | |
266 | va_end(args); | |
267 | ||
268 | return ret; | |
269 | } | |
270 | ||
271 | /** | |
272 | * Send a SCPI command with a variadic argument list. | |
273 | * | |
274 | * @param scpi Previously initialized SCPI device structure. | |
275 | * @param format Format string. | |
276 | * @param args Argument list. | |
277 | * | |
278 | * @return SR_OK on success, SR_ERR on failure. | |
279 | */ | |
280 | SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi, | |
281 | const char *format, va_list args) | |
282 | { | |
283 | va_list args_copy; | |
284 | char *buf; | |
285 | int len, ret; | |
286 | ||
287 | /* Get length of buffer required. */ | |
288 | va_copy(args_copy, args); | |
289 | len = vsnprintf(NULL, 0, format, args_copy); | |
290 | va_end(args_copy); | |
291 | ||
292 | /* Allocate buffer and write out command. */ | |
293 | buf = g_malloc(len + 1); | |
294 | vsprintf(buf, format, args); | |
295 | ||
296 | /* Send command. */ | |
297 | ret = scpi->send(scpi->priv, buf); | |
298 | ||
299 | /* Free command buffer. */ | |
300 | g_free(buf); | |
301 | ||
302 | return ret; | |
303 | } | |
304 | ||
305 | /** | |
306 | * Begin receiving an SCPI reply. | |
307 | * | |
308 | * @param scpi Previously initialised SCPI device structure. | |
309 | * | |
310 | * @return SR_OK on success, SR_ERR on failure. | |
311 | */ | |
312 | SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi) | |
313 | { | |
314 | return scpi->read_begin(scpi->priv); | |
315 | } | |
316 | ||
317 | /** | |
318 | * Read part of a response from SCPI device. | |
319 | * | |
320 | * @param scpi Previously initialised SCPI device structure. | |
321 | * @param buf Buffer to store result. | |
322 | * @param maxlen Maximum number of bytes to read. | |
323 | * | |
324 | * @return Number of bytes read, or SR_ERR upon failure. | |
325 | */ | |
326 | SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, | |
327 | char *buf, int maxlen) | |
328 | { | |
329 | return scpi->read_data(scpi->priv, buf, maxlen); | |
330 | } | |
331 | ||
332 | /** | |
333 | * Check whether a complete SCPI response has been received. | |
334 | * | |
335 | * @param scpi Previously initialised SCPI device structure. | |
336 | * | |
337 | * @return 1 if complete, 0 otherwise. | |
338 | */ | |
339 | SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi) | |
340 | { | |
341 | return scpi->read_complete(scpi->priv); | |
342 | } | |
343 | ||
344 | /** | |
345 | * Close SCPI device. | |
346 | * | |
347 | * @param scpi Previously initialized SCPI device structure. | |
348 | * | |
349 | * @return SR_OK on success, SR_ERR on failure. | |
350 | */ | |
351 | SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi) | |
352 | { | |
353 | return scpi->close(scpi->priv); | |
354 | } | |
355 | ||
356 | /** | |
357 | * Free SCPI device. | |
358 | * | |
359 | * @param scpi Previously initialized SCPI device structure. | |
360 | * | |
361 | * @return SR_OK on success, SR_ERR on failure. | |
362 | */ | |
363 | SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi) | |
364 | { | |
365 | scpi->free(scpi->priv); | |
366 | g_free(scpi->priv); | |
367 | g_free(scpi); | |
368 | } | |
369 | ||
370 | /** | |
371 | * Send a SCPI command, receive the reply and store the reply in scpi_response. | |
372 | * | |
373 | * @param scpi Previously initialised SCPI device structure. | |
374 | * @param command The SCPI command to send to the device (can be NULL). | |
375 | * @param scpi_response Pointer where to store the SCPI response. | |
376 | * | |
377 | * @return SR_OK on success, SR_ERR on failure. | |
378 | */ | |
379 | SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, | |
380 | const char *command, char **scpi_response) | |
381 | { | |
382 | char buf[256]; | |
383 | int len; | |
384 | GString *response; | |
385 | gint64 laststart; | |
386 | unsigned int elapsed_ms; | |
387 | ||
388 | if (command) | |
389 | if (sr_scpi_send(scpi, command) != SR_OK) | |
390 | return SR_ERR; | |
391 | ||
392 | if (sr_scpi_read_begin(scpi) != SR_OK) | |
393 | return SR_ERR; | |
394 | ||
395 | laststart = g_get_monotonic_time(); | |
396 | ||
397 | response = g_string_new(""); | |
398 | ||
399 | *scpi_response = NULL; | |
400 | ||
401 | while (!sr_scpi_read_complete(scpi)) { | |
402 | len = sr_scpi_read_data(scpi, buf, sizeof(buf)); | |
403 | if (len < 0) { | |
404 | sr_err("Incompletely read SCPI response."); | |
405 | g_string_free(response, TRUE); | |
406 | return SR_ERR; | |
407 | } else if (len > 0) { | |
408 | laststart = g_get_monotonic_time(); | |
409 | } | |
410 | g_string_append_len(response, buf, len); | |
411 | elapsed_ms = (g_get_monotonic_time() - laststart) / 1000; | |
412 | if (elapsed_ms >= scpi->read_timeout_ms) { | |
413 | sr_err("Timed out waiting for SCPI response."); | |
414 | g_string_free(response, TRUE); | |
415 | return SR_ERR; | |
416 | } | |
417 | } | |
418 | ||
419 | /* Get rid of trailing linefeed if present */ | |
420 | if (response->len >= 1 && response->str[response->len - 1] == '\n') | |
421 | g_string_truncate(response, response->len - 1); | |
422 | ||
423 | /* Get rid of trailing carriage return if present */ | |
424 | if (response->len >= 1 && response->str[response->len - 1] == '\r') | |
425 | g_string_truncate(response, response->len - 1); | |
426 | ||
427 | *scpi_response = response->str; | |
428 | g_string_free(response, FALSE); | |
429 | ||
430 | sr_spew("Got response: '%.70s', length %d.", *scpi_response, strlen(*scpi_response)); | |
431 | ||
432 | return SR_OK; | |
433 | } | |
434 | ||
435 | /** | |
436 | * Send a SCPI command, read the reply, parse it as a bool value and store the | |
437 | * result in scpi_response. | |
438 | * | |
439 | * @param scpi Previously initialised SCPI device structure. | |
440 | * @param command The SCPI command to send to the device (can be NULL). | |
441 | * @param scpi_response Pointer where to store the parsed result. | |
442 | * | |
443 | * @return SR_OK on success, SR_ERR on failure. | |
444 | */ | |
445 | SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, | |
446 | const char *command, gboolean *scpi_response) | |
447 | { | |
448 | int ret; | |
449 | char *response; | |
450 | ||
451 | response = NULL; | |
452 | ||
453 | if (sr_scpi_get_string(scpi, command, &response) != SR_OK) | |
454 | if (!response) | |
455 | return SR_ERR; | |
456 | ||
457 | if (parse_strict_bool(response, scpi_response) == SR_OK) | |
458 | ret = SR_OK; | |
459 | else | |
460 | ret = SR_ERR; | |
461 | ||
462 | g_free(response); | |
463 | ||
464 | return ret; | |
465 | } | |
466 | ||
467 | /** | |
468 | * Send a SCPI command, read the reply, parse it as an integer and store the | |
469 | * result in scpi_response. | |
470 | * | |
471 | * @param scpi Previously initialised SCPI device structure. | |
472 | * @param command The SCPI command to send to the device (can be NULL). | |
473 | * @param scpi_response Pointer where to store the parsed result. | |
474 | * | |
475 | * @return SR_OK on success, SR_ERR on failure. | |
476 | */ | |
477 | SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, | |
478 | const char *command, int *scpi_response) | |
479 | { | |
480 | int ret; | |
481 | char *response; | |
482 | ||
483 | response = NULL; | |
484 | ||
485 | if (sr_scpi_get_string(scpi, command, &response) != SR_OK) | |
486 | if (!response) | |
487 | return SR_ERR; | |
488 | ||
489 | if (sr_atoi(response, scpi_response) == SR_OK) | |
490 | ret = SR_OK; | |
491 | else | |
492 | ret = SR_ERR; | |
493 | ||
494 | g_free(response); | |
495 | ||
496 | return ret; | |
497 | } | |
498 | ||
499 | /** | |
500 | * Send a SCPI command, read the reply, parse it as a float and store the | |
501 | * result in scpi_response. | |
502 | * | |
503 | * @param scpi Previously initialised SCPI device structure. | |
504 | * @param command The SCPI command to send to the device (can be NULL). | |
505 | * @param scpi_response Pointer where to store the parsed result. | |
506 | * | |
507 | * @return SR_OK on success, SR_ERR on failure. | |
508 | */ | |
509 | SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, | |
510 | const char *command, float *scpi_response) | |
511 | { | |
512 | int ret; | |
513 | char *response; | |
514 | ||
515 | response = NULL; | |
516 | ||
517 | if (sr_scpi_get_string(scpi, command, &response) != SR_OK) | |
518 | if (!response) | |
519 | return SR_ERR; | |
520 | ||
521 | if (sr_atof_ascii(response, scpi_response) == SR_OK) | |
522 | ret = SR_OK; | |
523 | else | |
524 | ret = SR_ERR; | |
525 | ||
526 | g_free(response); | |
527 | ||
528 | return ret; | |
529 | } | |
530 | ||
531 | /** | |
532 | * Send a SCPI command, read the reply, parse it as a double and store the | |
533 | * result in scpi_response. | |
534 | * | |
535 | * @param scpi Previously initialised SCPI device structure. | |
536 | * @param command The SCPI command to send to the device (can be NULL). | |
537 | * @param scpi_response Pointer where to store the parsed result. | |
538 | * | |
539 | * @return SR_OK on success, SR_ERR on failure. | |
540 | */ | |
541 | SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, | |
542 | const char *command, double *scpi_response) | |
543 | { | |
544 | int ret; | |
545 | char *response; | |
546 | ||
547 | response = NULL; | |
548 | ||
549 | if (sr_scpi_get_string(scpi, command, &response) != SR_OK) | |
550 | if (!response) | |
551 | return SR_ERR; | |
552 | ||
553 | if (sr_atod(response, scpi_response) == SR_OK) | |
554 | ret = SR_OK; | |
555 | else | |
556 | ret = SR_ERR; | |
557 | ||
558 | g_free(response); | |
559 | ||
560 | return ret; | |
561 | } | |
562 | ||
563 | /** | |
564 | * Send a SCPI *OPC? command, read the reply and return the result of the | |
565 | * command. | |
566 | * | |
567 | * @param scpi Previously initialised SCPI device structure. | |
568 | * | |
569 | * @return SR_OK on success, SR_ERR on failure. | |
570 | */ | |
571 | SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi) | |
572 | { | |
573 | unsigned int i; | |
574 | gboolean opc; | |
575 | ||
576 | for (i = 0; i < SCPI_READ_RETRIES; ++i) { | |
577 | sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc); | |
578 | if (opc) | |
579 | return SR_OK; | |
580 | g_usleep(SCPI_READ_RETRY_TIMEOUT_US); | |
581 | } | |
582 | ||
583 | return SR_ERR; | |
584 | } | |
585 | ||
586 | /** | |
587 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
588 | * floats and store the as an result in scpi_response. | |
589 | * | |
590 | * @param scpi Previously initialised SCPI device structure. | |
591 | * @param command The SCPI command to send to the device (can be NULL). | |
592 | * @param scpi_response Pointer where to store the parsed result. | |
593 | * | |
594 | * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing | |
595 | * error or upon no response. The allocated response must be freed by | |
596 | * the caller in the case of an SR_OK as well as in the case of | |
597 | * parsing error. | |
598 | */ | |
599 | SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, | |
600 | const char *command, GArray **scpi_response) | |
601 | { | |
602 | int ret; | |
603 | float tmp; | |
604 | char *response; | |
605 | gchar **ptr, **tokens; | |
606 | GArray *response_array; | |
607 | ||
608 | ret = SR_OK; | |
609 | response = NULL; | |
610 | tokens = NULL; | |
611 | ||
612 | if (sr_scpi_get_string(scpi, command, &response) != SR_OK) | |
613 | if (!response) | |
614 | return SR_ERR; | |
615 | ||
616 | tokens = g_strsplit(response, ",", 0); | |
617 | ptr = tokens; | |
618 | ||
619 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256); | |
620 | ||
621 | while (*ptr) { | |
622 | if (sr_atof_ascii(*ptr, &tmp) == SR_OK) | |
623 | response_array = g_array_append_val(response_array, | |
624 | tmp); | |
625 | else | |
626 | ret = SR_ERR; | |
627 | ||
628 | ptr++; | |
629 | } | |
630 | g_strfreev(tokens); | |
631 | g_free(response); | |
632 | ||
633 | if (ret == SR_ERR && response_array->len == 0) { | |
634 | g_array_free(response_array, TRUE); | |
635 | *scpi_response = NULL; | |
636 | return SR_ERR; | |
637 | } | |
638 | ||
639 | *scpi_response = response_array; | |
640 | ||
641 | return ret; | |
642 | } | |
643 | ||
644 | /** | |
645 | * Send a SCPI command, read the reply, parse it as comma separated list of | |
646 | * unsigned 8 bit integers and store the as an result in scpi_response. | |
647 | * | |
648 | * @param scpi Previously initialised SCPI device structure. | |
649 | * @param command The SCPI command to send to the device (can be NULL). | |
650 | * @param scpi_response Pointer where to store the parsed result. | |
651 | * | |
652 | * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing | |
653 | * error or upon no response. The allocated response must be freed by | |
654 | * the caller in the case of an SR_OK as well as in the case of | |
655 | * parsing error. | |
656 | */ | |
657 | SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, | |
658 | const char *command, GArray **scpi_response) | |
659 | { | |
660 | int tmp, ret; | |
661 | char *response; | |
662 | gchar **ptr, **tokens; | |
663 | GArray *response_array; | |
664 | ||
665 | ret = SR_OK; | |
666 | response = NULL; | |
667 | tokens = NULL; | |
668 | ||
669 | if (sr_scpi_get_string(scpi, command, &response) != SR_OK) | |
670 | if (!response) | |
671 | return SR_ERR; | |
672 | ||
673 | tokens = g_strsplit(response, ",", 0); | |
674 | ptr = tokens; | |
675 | ||
676 | response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256); | |
677 | ||
678 | while (*ptr) { | |
679 | if (sr_atoi(*ptr, &tmp) == SR_OK) | |
680 | response_array = g_array_append_val(response_array, | |
681 | tmp); | |
682 | else | |
683 | ret = SR_ERR; | |
684 | ||
685 | ptr++; | |
686 | } | |
687 | g_strfreev(tokens); | |
688 | g_free(response); | |
689 | ||
690 | if (response_array->len == 0) { | |
691 | g_array_free(response_array, TRUE); | |
692 | *scpi_response = NULL; | |
693 | return SR_ERR; | |
694 | } | |
695 | ||
696 | *scpi_response = response_array; | |
697 | ||
698 | return ret; | |
699 | } | |
700 | ||
701 | /** | |
702 | * Send the *IDN? SCPI command, receive the reply, parse it and store the | |
703 | * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer. | |
704 | * | |
705 | * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free(). | |
706 | * | |
707 | * @param scpi Previously initialised SCPI device structure. | |
708 | * @param scpi_response Pointer where to store the hw_info structure. | |
709 | * | |
710 | * @return SR_OK upon success, SR_ERR on failure. | |
711 | */ | |
712 | SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, | |
713 | struct sr_scpi_hw_info **scpi_response) | |
714 | { | |
715 | int num_tokens; | |
716 | char *response; | |
717 | gchar **tokens; | |
718 | struct sr_scpi_hw_info *hw_info; | |
719 | ||
720 | response = NULL; | |
721 | tokens = NULL; | |
722 | ||
723 | if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK) | |
724 | if (!response) | |
725 | return SR_ERR; | |
726 | ||
727 | sr_info("Got IDN string: '%s'", response); | |
728 | ||
729 | /* | |
730 | * The response to a '*IDN?' is specified by the SCPI spec. It contains | |
731 | * a comma-separated list containing the manufacturer name, instrument | |
732 | * model, serial number of the instrument and the firmware version. | |
733 | */ | |
734 | tokens = g_strsplit(response, ",", 0); | |
735 | ||
736 | for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++); | |
737 | ||
738 | if (num_tokens < 4) { | |
739 | sr_dbg("IDN response not according to spec: %80.s.", response); | |
740 | g_strfreev(tokens); | |
741 | g_free(response); | |
742 | return SR_ERR; | |
743 | } | |
744 | g_free(response); | |
745 | ||
746 | hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info)); | |
747 | hw_info->manufacturer = g_strdup(tokens[0]); | |
748 | hw_info->model = g_strdup(tokens[1]); | |
749 | hw_info->serial_number = g_strdup(tokens[2]); | |
750 | hw_info->firmware_version = g_strdup(tokens[3]); | |
751 | ||
752 | g_strfreev(tokens); | |
753 | ||
754 | *scpi_response = hw_info; | |
755 | ||
756 | return SR_OK; | |
757 | } | |
758 | ||
759 | /** | |
760 | * Free a sr_scpi_hw_info struct. | |
761 | * | |
762 | * @param hw_info Pointer to the struct to free. | |
763 | * | |
764 | * This function is safe to call with a NULL pointer. | |
765 | */ | |
766 | SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info) | |
767 | { | |
768 | if (hw_info) { | |
769 | g_free(hw_info->manufacturer); | |
770 | g_free(hw_info->model); | |
771 | g_free(hw_info->serial_number); | |
772 | g_free(hw_info->firmware_version); | |
773 | g_free(hw_info); | |
774 | } | |
775 | } |