2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
5 * Copyright (C) 2013 Martin Ling <martin-sigrok@earth.li>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "libsigrok.h"
22 #include "libsigrok-internal.h"
27 #define LOG_PREFIX "scpi_serial"
29 #define SCPI_READ_RETRIES 100
30 #define SCPI_READ_RETRY_TIMEOUT 10000
33 struct sr_serial_dev_inst *serial;
37 static int scpi_serial_dev_inst_new(void *priv, const char *resource,
38 char **params, const char *serialcomm)
40 struct scpi_serial *sscpi = priv;
44 if (!(sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm)))
50 SR_PRIV int scpi_serial_open(void *priv)
52 struct scpi_serial *sscpi = priv;
53 struct sr_serial_dev_inst *serial = sscpi->serial;
55 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
58 if (serial_flush(serial) != SR_OK)
64 SR_PRIV int scpi_serial_source_add(void *priv, int events, int timeout,
65 sr_receive_data_callback_t cb, void *cb_data)
67 struct scpi_serial *sscpi = priv;
68 struct sr_serial_dev_inst *serial = sscpi->serial;
70 return serial_source_add(serial, events, timeout, cb, cb_data);
73 SR_PRIV int scpi_serial_source_remove(void *priv)
75 struct scpi_serial *sscpi = priv;
76 struct sr_serial_dev_inst *serial = sscpi->serial;
78 return serial_source_remove(serial);
81 SR_PRIV int scpi_serial_send(void *priv, const char *command)
83 int len, result, written;
84 gchar *terminated_command;
85 struct scpi_serial *sscpi = priv;
86 struct sr_serial_dev_inst *serial = sscpi->serial;
88 terminated_command = g_strconcat(command, "\n", NULL);
89 len = strlen(terminated_command);
91 while (written < len) {
92 result = serial_write(serial, terminated_command + written, len - written);
94 sr_err("Error while sending SCPI command: '%s'.", command);
95 g_free(terminated_command);
101 g_free(terminated_command);
103 sr_spew("Successfully sent SCPI command: '%s'.", command);
108 SR_PRIV int scpi_serial_receive(void *priv, char **scpi_response)
114 struct scpi_serial *sscpi = priv;
115 struct sr_serial_dev_inst *serial = sscpi->serial;
117 response = g_string_sized_new(1024);
119 for (i = 0; i <= SCPI_READ_RETRIES; i++) {
120 while ((len = serial_read(serial, buf, sizeof(buf))) > 0)
121 response = g_string_append_len(response, buf, len);
123 if (response->len > 0 &&
124 response->str[response->len-1] == '\n') {
125 sr_spew("Fetched full SCPI response.");
129 g_usleep(SCPI_READ_RETRY_TIMEOUT);
132 if (response->len == 0) {
133 sr_dbg("No SCPI response received.");
134 g_string_free(response, TRUE);
135 *scpi_response = NULL;
137 } else if (response->str[response->len - 1] == '\n') {
139 * The SCPI response contains a LF ('\n') at the end and we
140 * don't need this so replace it with a '\0' and decrement
143 response->str[--response->len] = '\0';
146 sr_warn("Incomplete SCPI response received!");
150 /* Minor optimization: steal the string instead of copying. */
151 *scpi_response = response->str;
153 /* A SCPI response can be quite large, print at most 50 characters. */
154 sr_dbg("SCPI response received (length %d): '%.50s'",
155 response->len, response->str);
157 g_string_free(response, FALSE);
162 SR_PRIV int scpi_serial_read_begin(void *priv)
164 struct scpi_serial *sscpi = priv;
166 sscpi->last_character = '\0';
171 SR_PRIV int scpi_serial_read_data(void *priv, char *buf, int maxlen)
173 struct scpi_serial *sscpi = priv;
176 ret = serial_read(sscpi->serial, buf, maxlen);
182 sscpi->last_character = buf[ret - 1];
183 if (sscpi->last_character == '\n')
190 SR_PRIV int scpi_serial_read_complete(void *priv)
192 struct scpi_serial *sscpi = priv;
194 return (sscpi->last_character == '\n');
197 static int scpi_serial_close(void *priv)
199 struct scpi_serial *sscpi = priv;
201 return serial_close(sscpi->serial);
204 static void scpi_serial_free(void *priv)
206 struct scpi_serial *sscpi = priv;
208 sr_serial_dev_inst_free(sscpi->serial);
211 SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
214 .priv_size = sizeof(struct scpi_serial),
215 .dev_inst_new = scpi_serial_dev_inst_new,
216 .open = scpi_serial_open,
217 .source_add = scpi_serial_source_add,
218 .source_remove = scpi_serial_source_remove,
219 .send = scpi_serial_send,
220 .read_begin = scpi_serial_read_begin,
221 .read_data = scpi_serial_read_data,
222 .read_complete = scpi_serial_read_complete,
223 .close = scpi_serial_close,
224 .free = scpi_serial_free,