]>
Commit | Line | Data |
---|---|---|
23f43dff ML |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com> | |
5 | * Copyright (C) 2013 Martin Ling <martin-sigrok@earth.li> | |
6 | * | |
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. | |
11 | * | |
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. | |
16 | * | |
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/>. | |
19 | */ | |
20 | ||
6ec6c43b | 21 | #include <config.h> |
23f43dff | 22 | #include <glib.h> |
b541f837 | 23 | #include <stdlib.h> |
23f43dff | 24 | #include <string.h> |
c1aae900 | 25 | #include <libsigrok/libsigrok.h> |
515ab088 | 26 | #include "libsigrok-internal.h" |
5a1afc09 | 27 | #include "scpi.h" |
23f43dff | 28 | |
3544f848 | 29 | #define LOG_PREFIX "scpi_serial" |
23f43dff | 30 | |
8943049c | 31 | #define BUFFER_SIZE 1024 |
23f43dff | 32 | |
05c644ea ML |
33 | struct scpi_serial { |
34 | struct sr_serial_dev_inst *serial; | |
8943049c ML |
35 | char buffer[BUFFER_SIZE]; |
36 | size_t count; | |
37 | size_t read; | |
05c644ea ML |
38 | }; |
39 | ||
329733d9 | 40 | static const struct { |
b541f837 AJ |
41 | uint16_t vendor_id; |
42 | uint16_t product_id; | |
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 */ | |
d38f4e7a | 47 | { 0x0aad, 0x0118, "115200/8n1" }, /* R&S HMO1002 */ |
b541f837 AJ |
48 | }; |
49 | ||
50 | static GSList *scpi_serial_scan(struct drv_context *drvc) | |
51 | { | |
52 | GSList *l, *r, *resources = NULL; | |
53 | gchar *res; | |
54 | unsigned i; | |
55 | ||
56 | (void)drvc; | |
57 | ||
58 | for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) { | |
98fec29e UH |
59 | if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id, |
60 | scpi_serial_usb_ids[i].product_id))) | |
b541f837 AJ |
61 | continue; |
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); | |
66 | else | |
67 | res = g_strdup(r->data); | |
68 | resources = g_slist_append(resources, res); | |
69 | } | |
70 | g_slist_free_full(l, g_free); | |
71 | } | |
72 | ||
73 | return resources; | |
74 | } | |
75 | ||
17bdda58 AJ |
76 | static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc, |
77 | const char *resource, char **params, const char *serialcomm) | |
f754c146 AJ |
78 | { |
79 | struct scpi_serial *sscpi = priv; | |
80 | ||
17bdda58 | 81 | (void)drvc; |
f754c146 AJ |
82 | (void)params; |
83 | ||
91219afc | 84 | sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm); |
f754c146 AJ |
85 | |
86 | return SR_OK; | |
87 | } | |
88 | ||
04229f7b | 89 | static int scpi_serial_open(struct sr_scpi_dev_inst *scpi) |
23f43dff | 90 | { |
04229f7b | 91 | struct scpi_serial *sscpi = scpi->priv; |
05c644ea | 92 | struct sr_serial_dev_inst *serial = sscpi->serial; |
23f43dff | 93 | |
406e0c79 | 94 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) |
9dfeb81b ML |
95 | return SR_ERR; |
96 | ||
97 | if (serial_flush(serial) != SR_OK) | |
98 | return SR_ERR; | |
99 | ||
8943049c ML |
100 | sscpi->count = 0; |
101 | sscpi->read = 0; | |
102 | ||
9dfeb81b | 103 | return SR_OK; |
23f43dff ML |
104 | } |
105 | ||
102f1239 BV |
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) | |
23f43dff | 108 | { |
05c644ea ML |
109 | struct scpi_serial *sscpi = priv; |
110 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff | 111 | |
102f1239 | 112 | return serial_source_add(session, serial, events, timeout, cb, cb_data); |
23f43dff ML |
113 | } |
114 | ||
102f1239 | 115 | static int scpi_serial_source_remove(struct sr_session *session, void *priv) |
23f43dff | 116 | { |
05c644ea ML |
117 | struct scpi_serial *sscpi = priv; |
118 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff | 119 | |
102f1239 | 120 | return serial_source_remove(session, serial); |
23f43dff ML |
121 | } |
122 | ||
d87c1766 | 123 | static int scpi_serial_send(void *priv, const char *command) |
23f43dff | 124 | { |
721fc227 | 125 | int len, result, written; |
23f43dff | 126 | gchar *terminated_command; |
05c644ea ML |
127 | struct scpi_serial *sscpi = priv; |
128 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff ML |
129 | |
130 | terminated_command = g_strconcat(command, "\n", NULL); | |
131 | len = strlen(terminated_command); | |
721fc227 ML |
132 | written = 0; |
133 | while (written < len) { | |
406e0c79 ML |
134 | result = serial_write_nonblocking(serial, |
135 | terminated_command + written, len - written); | |
721fc227 ML |
136 | if (result < 0) { |
137 | sr_err("Error while sending SCPI command: '%s'.", command); | |
138 | g_free(terminated_command); | |
139 | return SR_ERR; | |
140 | } | |
141 | written += result; | |
23f43dff ML |
142 | } |
143 | ||
721fc227 ML |
144 | g_free(terminated_command); |
145 | ||
23f43dff ML |
146 | sr_spew("Successfully sent SCPI command: '%s'.", command); |
147 | ||
148 | return SR_OK; | |
149 | } | |
150 | ||
d87c1766 | 151 | static int scpi_serial_read_begin(void *priv) |
05c644ea | 152 | { |
8943049c | 153 | (void) priv; |
05c644ea ML |
154 | |
155 | return SR_OK; | |
156 | } | |
157 | ||
d87c1766 | 158 | static int scpi_serial_read_data(void *priv, char *buf, int maxlen) |
bc03a7cc | 159 | { |
05c644ea | 160 | struct scpi_serial *sscpi = priv; |
8943049c ML |
161 | int len, ret; |
162 | ||
163 | len = BUFFER_SIZE - sscpi->count; | |
164 | ||
165 | /* Try to read new data into the buffer if there is space. */ | |
166 | if (len > 0) { | |
aff94d06 | 167 | ret = serial_read_nonblocking(sscpi->serial, sscpi->buffer + sscpi->count, |
8943049c | 168 | BUFFER_SIZE - sscpi->count); |
05c644ea | 169 | |
8943049c ML |
170 | if (ret < 0) |
171 | return ret; | |
05c644ea | 172 | |
8943049c | 173 | sscpi->count += ret; |
05c644ea | 174 | |
8943049c ML |
175 | if (ret > 0) |
176 | sr_spew("Read %d bytes into buffer.", ret); | |
05c644ea ML |
177 | } |
178 | ||
8943049c ML |
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; | |
182 | if (len > maxlen) | |
183 | len = maxlen; | |
184 | if (sscpi->buffer[sscpi->read + len - 1] == '\n') | |
185 | len--; | |
186 | sr_spew("Returning %d bytes from buffer.", len); | |
187 | memcpy(buf, sscpi->buffer + sscpi->read, len); | |
188 | sscpi->read += len; | |
189 | if (sscpi->read == BUFFER_SIZE) { | |
190 | sr_spew("Resetting buffer."); | |
191 | sscpi->count = 0; | |
192 | sscpi->read = 0; | |
193 | } | |
194 | return len; | |
195 | } | |
196 | ||
197 | return 0; | |
bc03a7cc | 198 | } |
05c644ea | 199 | |
d87c1766 | 200 | static int scpi_serial_read_complete(void *priv) |
05c644ea ML |
201 | { |
202 | struct scpi_serial *sscpi = priv; | |
203 | ||
8943049c ML |
204 | /* If the next character is a newline, discard it and report complete. */ |
205 | if (sscpi->read < sscpi->count && sscpi->buffer[sscpi->read] == '\n') { | |
206 | sscpi->read++; | |
207 | return 1; | |
208 | } else { | |
209 | return 0; | |
210 | } | |
05c644ea ML |
211 | } |
212 | ||
04229f7b | 213 | static int scpi_serial_close(struct sr_scpi_dev_inst *scpi) |
bc03a7cc | 214 | { |
04229f7b | 215 | struct scpi_serial *sscpi = scpi->priv; |
05c644ea | 216 | |
f754c146 | 217 | return serial_close(sscpi->serial); |
bc03a7cc | 218 | } |
05c644ea | 219 | |
bc03a7cc BV |
220 | static void scpi_serial_free(void *priv) |
221 | { | |
05c644ea | 222 | struct scpi_serial *sscpi = priv; |
05c644ea | 223 | |
f754c146 | 224 | sr_serial_dev_inst_free(sscpi->serial); |
bc03a7cc BV |
225 | } |
226 | ||
f754c146 AJ |
227 | SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = { |
228 | .name = "serial", | |
229 | .prefix = "", | |
230 | .priv_size = sizeof(struct scpi_serial), | |
b541f837 | 231 | .scan = scpi_serial_scan, |
f754c146 AJ |
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, | |
242 | }; |