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 SR_PRIV int scpi_serial_open(void *priv)
39 struct scpi_serial *sscpi = priv;
40 struct sr_serial_dev_inst *serial = sscpi->serial;
42 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
45 if (serial_flush(serial) != SR_OK)
51 SR_PRIV int scpi_serial_source_add(void *priv, int events, int timeout,
52 sr_receive_data_callback_t cb, void *cb_data)
54 struct scpi_serial *sscpi = priv;
55 struct sr_serial_dev_inst *serial = sscpi->serial;
57 return serial_source_add(serial, events, timeout, cb, cb_data);
60 SR_PRIV int scpi_serial_source_remove(void *priv)
62 struct scpi_serial *sscpi = priv;
63 struct sr_serial_dev_inst *serial = sscpi->serial;
65 return serial_source_remove(serial);
68 SR_PRIV int scpi_serial_send(void *priv, const char *command)
70 int len, result, written;
71 gchar *terminated_command;
72 struct scpi_serial *sscpi = priv;
73 struct sr_serial_dev_inst *serial = sscpi->serial;
75 terminated_command = g_strconcat(command, "\n", NULL);
76 len = strlen(terminated_command);
78 while (written < len) {
79 result = serial_write(serial, terminated_command + written, len - written);
81 sr_err("Error while sending SCPI command: '%s'.", command);
82 g_free(terminated_command);
88 g_free(terminated_command);
90 sr_spew("Successfully sent SCPI command: '%s'.", command);
95 SR_PRIV int scpi_serial_receive(void *priv, char **scpi_response)
101 struct scpi_serial *sscpi = priv;
102 struct sr_serial_dev_inst *serial = sscpi->serial;
104 response = g_string_sized_new(1024);
106 for (i = 0; i <= SCPI_READ_RETRIES; i++) {
107 while ((len = serial_read(serial, buf, sizeof(buf))) > 0)
108 response = g_string_append_len(response, buf, len);
110 if (response->len > 0 &&
111 response->str[response->len-1] == '\n') {
112 sr_spew("Fetched full SCPI response.");
116 g_usleep(SCPI_READ_RETRY_TIMEOUT);
119 if (response->len == 0) {
120 sr_dbg("No SCPI response received.");
121 g_string_free(response, TRUE);
122 *scpi_response = NULL;
124 } else if (response->str[response->len - 1] == '\n') {
126 * The SCPI response contains a LF ('\n') at the end and we
127 * don't need this so replace it with a '\0' and decrement
130 response->str[--response->len] = '\0';
133 sr_warn("Incomplete SCPI response received!");
137 /* Minor optimization: steal the string instead of copying. */
138 *scpi_response = response->str;
140 /* A SCPI response can be quite large, print at most 50 characters. */
141 sr_dbg("SCPI response received (length %d): '%.50s'",
142 response->len, response->str);
144 g_string_free(response, FALSE);
149 SR_PRIV int scpi_serial_read_begin(void *priv)
151 struct scpi_serial *sscpi = priv;
153 sscpi->last_character = '\0';
158 SR_PRIV int scpi_serial_read_data(void *priv, char *buf, int maxlen)
160 struct scpi_serial *sscpi = priv;
163 ret = serial_read(sscpi->serial, buf, maxlen);
169 sscpi->last_character = buf[ret - 1];
170 if (sscpi->last_character == '\n')
177 SR_PRIV int scpi_serial_read_complete(void *priv)
179 struct scpi_serial *sscpi = priv;
181 return (sscpi->last_character == '\n');
184 static int scpi_serial_close(void *priv)
186 struct scpi_serial *sscpi = priv;
187 struct sr_serial_dev_inst *serial = sscpi->serial;
189 return serial_close(serial);
192 static void scpi_serial_free(void *priv)
194 struct scpi_serial *sscpi = priv;
195 struct sr_serial_dev_inst *serial = sscpi->serial;
197 sr_serial_dev_inst_free(serial);
201 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
202 const char *serialcomm)
204 struct sr_scpi_dev_inst *scpi;
205 struct scpi_serial *sscpi;
206 struct sr_serial_dev_inst *serial;
208 if (!(serial = sr_serial_dev_inst_new(port, serialcomm)))
211 sscpi = g_malloc(sizeof(struct scpi_serial));
213 sscpi->serial = serial;
215 scpi = g_malloc(sizeof(struct sr_scpi_dev_inst));
217 scpi->open = scpi_serial_open;
218 scpi->source_add = scpi_serial_source_add;
219 scpi->source_remove = scpi_serial_source_remove;
220 scpi->send = scpi_serial_send;
221 scpi->read_begin = scpi_serial_read_begin;
222 scpi->read_data = scpi_serial_read_data;
223 scpi->read_complete = scpi_serial_read_complete;
224 scpi->close = scpi_serial_close;
225 scpi->free = scpi_serial_free;