]>
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 | |
48b7c346 GS |
31 | #ifdef HAVE_SERIAL_COMM |
32 | ||
05c644ea ML |
33 | struct scpi_serial { |
34 | struct sr_serial_dev_inst *serial; | |
35bb2fce | 35 | gboolean got_newline; |
05c644ea ML |
36 | }; |
37 | ||
33084500 | 38 | /* Default serial port options for some known USB devices */ |
329733d9 | 39 | static const struct { |
b541f837 AJ |
40 | uint16_t vendor_id; |
41 | uint16_t product_id; | |
42 | const char *serialcomm; | |
43 | } scpi_serial_usb_ids[] = { | |
44 | { 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */ | |
45 | { 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */ | |
33084500 GT |
46 | { 0x0aad, 0x0117, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */ |
47 | { 0x0aad, 0x0118, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */ | |
48 | { 0x0aad, 0x0119, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */ | |
f91c6940 | 49 | { 0x2184, 0x0030, "115200/8n1" }, /* GW-Instek GDM-8341 (VCP, SiLabs CP210x) */ |
4e5ff004 | 50 | { 0x2184, 0x0058, "115200/8n1" }, /* GW-Instek GDM-9061 (USBCDC mode) */ |
b541f837 AJ |
51 | }; |
52 | ||
53 | static GSList *scpi_serial_scan(struct drv_context *drvc) | |
54 | { | |
55 | GSList *l, *r, *resources = NULL; | |
56 | gchar *res; | |
57 | unsigned i; | |
58 | ||
59 | (void)drvc; | |
60 | ||
61 | for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) { | |
98fec29e UH |
62 | if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id, |
63 | scpi_serial_usb_ids[i].product_id))) | |
b541f837 AJ |
64 | continue; |
65 | for (r = l; r; r = r->next) { | |
66 | if (scpi_serial_usb_ids[i].serialcomm) | |
67 | res = g_strdup_printf("%s:%s", (char *) r->data, | |
68 | scpi_serial_usb_ids[i].serialcomm); | |
69 | else | |
70 | res = g_strdup(r->data); | |
71 | resources = g_slist_append(resources, res); | |
72 | } | |
73 | g_slist_free_full(l, g_free); | |
74 | } | |
75 | ||
76 | return resources; | |
77 | } | |
78 | ||
17bdda58 AJ |
79 | static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc, |
80 | const char *resource, char **params, const char *serialcomm) | |
f754c146 | 81 | { |
232eb33c GT |
82 | GSList *l, *r; |
83 | unsigned i; | |
f754c146 AJ |
84 | struct scpi_serial *sscpi = priv; |
85 | ||
17bdda58 | 86 | (void)drvc; |
f754c146 AJ |
87 | (void)params; |
88 | ||
232eb33c GT |
89 | /* If no serial port option is specified on the command-line using the |
90 | * "serialcomm" driver option, but the device is connected through USB | |
91 | * and it requires a known default serial port option, then used it in | |
92 | * order to avoid data corruption or even worse problems. | |
93 | */ | |
94 | if (!serialcomm) { | |
95 | for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) { | |
96 | if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id, | |
97 | scpi_serial_usb_ids[i].product_id))) | |
98 | continue; | |
99 | for (r = l; r; r = r->next) | |
100 | if (!strcmp(resource, r->data) && scpi_serial_usb_ids[i].serialcomm) | |
101 | serialcomm = scpi_serial_usb_ids[i].serialcomm; | |
102 | g_slist_free_full(l, g_free); | |
103 | } | |
104 | } | |
105 | ||
91219afc | 106 | sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm); |
f754c146 AJ |
107 | |
108 | return SR_OK; | |
109 | } | |
110 | ||
04229f7b | 111 | static int scpi_serial_open(struct sr_scpi_dev_inst *scpi) |
23f43dff | 112 | { |
04229f7b | 113 | struct scpi_serial *sscpi = scpi->priv; |
05c644ea | 114 | struct sr_serial_dev_inst *serial = sscpi->serial; |
23f43dff | 115 | |
406e0c79 | 116 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) |
9dfeb81b ML |
117 | return SR_ERR; |
118 | ||
35bb2fce | 119 | sscpi->got_newline = FALSE; |
8943049c | 120 | |
9dfeb81b | 121 | return SR_OK; |
23f43dff ML |
122 | } |
123 | ||
8107a9a6 FS |
124 | static int scpi_serial_connection_id(struct sr_scpi_dev_inst *scpi, |
125 | char **connection_id) | |
126 | { | |
127 | struct scpi_serial *sscpi = scpi->priv; | |
128 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
129 | ||
130 | *connection_id = g_strdup(serial->port); | |
131 | ||
132 | return SR_OK; | |
133 | } | |
134 | ||
102f1239 BV |
135 | static int scpi_serial_source_add(struct sr_session *session, void *priv, |
136 | int events, int timeout, sr_receive_data_callback cb, void *cb_data) | |
23f43dff | 137 | { |
05c644ea ML |
138 | struct scpi_serial *sscpi = priv; |
139 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff | 140 | |
102f1239 | 141 | return serial_source_add(session, serial, events, timeout, cb, cb_data); |
23f43dff ML |
142 | } |
143 | ||
102f1239 | 144 | static int scpi_serial_source_remove(struct sr_session *session, void *priv) |
23f43dff | 145 | { |
05c644ea ML |
146 | struct scpi_serial *sscpi = priv; |
147 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff | 148 | |
102f1239 | 149 | return serial_source_remove(session, serial); |
23f43dff ML |
150 | } |
151 | ||
d87c1766 | 152 | static int scpi_serial_send(void *priv, const char *command) |
23f43dff | 153 | { |
379e95c5 | 154 | int result; |
05c644ea ML |
155 | struct scpi_serial *sscpi = priv; |
156 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff | 157 | |
379e95c5 UH |
158 | result = serial_write_blocking(serial, command, strlen(command), 0); |
159 | if (result < 0) { | |
0c8aedb5 UH |
160 | sr_err("Error while sending SCPI command '%s': %d.", |
161 | command, result); | |
379e95c5 | 162 | return SR_ERR; |
23f43dff ML |
163 | } |
164 | ||
165 | sr_spew("Successfully sent SCPI command: '%s'.", command); | |
166 | ||
167 | return SR_OK; | |
168 | } | |
169 | ||
d87c1766 | 170 | static int scpi_serial_read_begin(void *priv) |
05c644ea | 171 | { |
9ea4018f | 172 | struct scpi_serial *sscpi = priv; |
35bb2fce | 173 | sscpi->got_newline = FALSE; |
05c644ea ML |
174 | |
175 | return SR_OK; | |
176 | } | |
177 | ||
d87c1766 | 178 | static int scpi_serial_read_data(void *priv, char *buf, int maxlen) |
bc03a7cc | 179 | { |
05c644ea | 180 | struct scpi_serial *sscpi = priv; |
9ea4018f | 181 | int ret; |
8943049c | 182 | |
9ea4018f SB |
183 | /* Try to read new data into the buffer. */ |
184 | ret = serial_read_nonblocking(sscpi->serial, buf, maxlen); | |
9ea4018f SB |
185 | if (ret < 0) |
186 | return ret; | |
05c644ea | 187 | |
6dc0007c GS |
188 | /* |
189 | * Check for line termination at the end of the receive data. | |
190 | * Handle the usual case of NL, as well as the unusual NL+CR | |
191 | * combination (some GWInstek DMMs were found to do this). | |
192 | */ | |
193 | sscpi->got_newline = FALSE; | |
194 | if (ret >= 1 && buf[ret - 1] == '\n') { | |
195 | sscpi->got_newline = TRUE; | |
196 | sr_spew("Received NL terminator"); | |
197 | } else if (ret >= 2 && buf[ret - 2] == '\n' && buf[ret - 1] == '\r') { | |
198 | ret--; | |
199 | sscpi->got_newline = TRUE; | |
200 | sr_spew("Received NL+CR terminator"); | |
8943049c ML |
201 | } |
202 | ||
9ea4018f | 203 | return ret; |
bc03a7cc | 204 | } |
05c644ea | 205 | |
d87c1766 | 206 | static int scpi_serial_read_complete(void *priv) |
05c644ea ML |
207 | { |
208 | struct scpi_serial *sscpi = priv; | |
209 | ||
9ea4018f | 210 | return sscpi->got_newline; |
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 = "", | |
87aa1e63 | 230 | .transport = SCPI_TRANSPORT_SERIAL, |
f754c146 | 231 | .priv_size = sizeof(struct scpi_serial), |
b541f837 | 232 | .scan = scpi_serial_scan, |
f754c146 AJ |
233 | .dev_inst_new = scpi_serial_dev_inst_new, |
234 | .open = scpi_serial_open, | |
8107a9a6 | 235 | .connection_id = scpi_serial_connection_id, |
f754c146 AJ |
236 | .source_add = scpi_serial_source_add, |
237 | .source_remove = scpi_serial_source_remove, | |
238 | .send = scpi_serial_send, | |
239 | .read_begin = scpi_serial_read_begin, | |
240 | .read_data = scpi_serial_read_data, | |
241 | .read_complete = scpi_serial_read_complete, | |
242 | .close = scpi_serial_close, | |
243 | .free = scpi_serial_free, | |
244 | }; | |
48b7c346 GS |
245 | |
246 | #endif |