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/>.
25 #include <libsigrok/libsigrok.h>
26 #include "libsigrok-internal.h"
29 #define LOG_PREFIX "scpi_serial"
31 #define BUFFER_SIZE 1024
34 struct sr_serial_dev_inst *serial;
35 char buffer[BUFFER_SIZE];
43 const char *serialcomm;
44 } scpi_serial_usb_ids[] = {
45 { 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */
46 { 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */
47 { 0x0aad, 0x0118, "115200/8n1" }, /* R&S HMO1002 */
50 static GSList *scpi_serial_scan(struct drv_context *drvc)
52 GSList *l, *r, *resources = NULL;
58 for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) {
59 if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id,
60 scpi_serial_usb_ids[i].product_id)))
62 for (r = l; r; r = r->next) {
63 if (scpi_serial_usb_ids[i].serialcomm)
64 res = g_strdup_printf("%s:%s", (char *) r->data,
65 scpi_serial_usb_ids[i].serialcomm);
67 res = g_strdup(r->data);
68 resources = g_slist_append(resources, res);
70 g_slist_free_full(l, g_free);
76 static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc,
77 const char *resource, char **params, const char *serialcomm)
79 struct scpi_serial *sscpi = priv;
84 sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm);
89 static int scpi_serial_open(struct sr_scpi_dev_inst *scpi)
91 struct scpi_serial *sscpi = scpi->priv;
92 struct sr_serial_dev_inst *serial = sscpi->serial;
94 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
97 if (serial_flush(serial) != SR_OK)
106 static int scpi_serial_source_add(struct sr_session *session, void *priv,
107 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
109 struct scpi_serial *sscpi = priv;
110 struct sr_serial_dev_inst *serial = sscpi->serial;
112 return serial_source_add(session, serial, events, timeout, cb, cb_data);
115 static int scpi_serial_source_remove(struct sr_session *session, void *priv)
117 struct scpi_serial *sscpi = priv;
118 struct sr_serial_dev_inst *serial = sscpi->serial;
120 return serial_source_remove(session, serial);
123 static int scpi_serial_send(void *priv, const char *command)
125 int len, result, written;
126 gchar *terminated_command;
127 struct scpi_serial *sscpi = priv;
128 struct sr_serial_dev_inst *serial = sscpi->serial;
130 terminated_command = g_strconcat(command, "\n", NULL);
131 len = strlen(terminated_command);
133 while (written < len) {
134 result = serial_write_nonblocking(serial,
135 terminated_command + written, len - written);
137 sr_err("Error while sending SCPI command: '%s'.", command);
138 g_free(terminated_command);
144 g_free(terminated_command);
146 sr_spew("Successfully sent SCPI command: '%s'.", command);
151 static int scpi_serial_read_begin(void *priv)
158 static int scpi_serial_read_data(void *priv, char *buf, int maxlen)
160 struct scpi_serial *sscpi = priv;
163 len = BUFFER_SIZE - sscpi->count;
165 /* Try to read new data into the buffer if there is space. */
167 ret = serial_read_nonblocking(sscpi->serial, sscpi->buffer + sscpi->count,
168 BUFFER_SIZE - sscpi->count);
176 sr_spew("Read %d bytes into buffer.", ret);
179 /* Return as many bytes as possible from buffer, excluding any trailing newline. */
180 if (sscpi->read < sscpi->count) {
181 len = sscpi->count - sscpi->read;
184 if (sscpi->buffer[sscpi->read + len - 1] == '\n')
186 sr_spew("Returning %d bytes from buffer.", len);
187 memcpy(buf, sscpi->buffer + sscpi->read, len);
189 if (sscpi->read == BUFFER_SIZE) {
190 sr_spew("Resetting buffer.");
200 static int scpi_serial_read_complete(void *priv)
202 struct scpi_serial *sscpi = priv;
204 /* If the next character is a newline, discard it and report complete. */
205 if (sscpi->read < sscpi->count && sscpi->buffer[sscpi->read] == '\n') {
213 static int scpi_serial_close(struct sr_scpi_dev_inst *scpi)
215 struct scpi_serial *sscpi = scpi->priv;
217 return serial_close(sscpi->serial);
220 static void scpi_serial_free(void *priv)
222 struct scpi_serial *sscpi = priv;
224 sr_serial_dev_inst_free(sscpi->serial);
227 SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = {
230 .priv_size = sizeof(struct scpi_serial),
231 .scan = scpi_serial_scan,
232 .dev_inst_new = scpi_serial_dev_inst_new,
233 .open = scpi_serial_open,
234 .source_add = scpi_serial_source_add,
235 .source_remove = scpi_serial_source_remove,
236 .send = scpi_serial_send,
237 .read_begin = scpi_serial_read_begin,
238 .read_data = scpi_serial_read_data,
239 .read_complete = scpi_serial_read_complete,
240 .close = scpi_serial_close,
241 .free = scpi_serial_free,