]>
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 */ | |
b541f837 AJ |
49 | }; |
50 | ||
51 | static GSList *scpi_serial_scan(struct drv_context *drvc) | |
52 | { | |
53 | GSList *l, *r, *resources = NULL; | |
54 | gchar *res; | |
55 | unsigned i; | |
56 | ||
57 | (void)drvc; | |
58 | ||
59 | for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) { | |
98fec29e UH |
60 | if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id, |
61 | scpi_serial_usb_ids[i].product_id))) | |
b541f837 AJ |
62 | continue; |
63 | for (r = l; r; r = r->next) { | |
64 | if (scpi_serial_usb_ids[i].serialcomm) | |
65 | res = g_strdup_printf("%s:%s", (char *) r->data, | |
66 | scpi_serial_usb_ids[i].serialcomm); | |
67 | else | |
68 | res = g_strdup(r->data); | |
69 | resources = g_slist_append(resources, res); | |
70 | } | |
71 | g_slist_free_full(l, g_free); | |
72 | } | |
73 | ||
74 | return resources; | |
75 | } | |
76 | ||
17bdda58 AJ |
77 | static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc, |
78 | const char *resource, char **params, const char *serialcomm) | |
f754c146 | 79 | { |
232eb33c GT |
80 | GSList *l, *r; |
81 | unsigned i; | |
f754c146 AJ |
82 | struct scpi_serial *sscpi = priv; |
83 | ||
17bdda58 | 84 | (void)drvc; |
f754c146 AJ |
85 | (void)params; |
86 | ||
232eb33c GT |
87 | /* If no serial port option is specified on the command-line using the |
88 | * "serialcomm" driver option, but the device is connected through USB | |
89 | * and it requires a known default serial port option, then used it in | |
90 | * order to avoid data corruption or even worse problems. | |
91 | */ | |
92 | if (!serialcomm) { | |
93 | for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) { | |
94 | if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id, | |
95 | scpi_serial_usb_ids[i].product_id))) | |
96 | continue; | |
97 | for (r = l; r; r = r->next) | |
98 | if (!strcmp(resource, r->data) && scpi_serial_usb_ids[i].serialcomm) | |
99 | serialcomm = scpi_serial_usb_ids[i].serialcomm; | |
100 | g_slist_free_full(l, g_free); | |
101 | } | |
102 | } | |
103 | ||
91219afc | 104 | sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm); |
f754c146 AJ |
105 | |
106 | return SR_OK; | |
107 | } | |
108 | ||
04229f7b | 109 | static int scpi_serial_open(struct sr_scpi_dev_inst *scpi) |
23f43dff | 110 | { |
04229f7b | 111 | struct scpi_serial *sscpi = scpi->priv; |
05c644ea | 112 | struct sr_serial_dev_inst *serial = sscpi->serial; |
23f43dff | 113 | |
406e0c79 | 114 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) |
9dfeb81b ML |
115 | return SR_ERR; |
116 | ||
117 | if (serial_flush(serial) != SR_OK) | |
118 | return SR_ERR; | |
119 | ||
35bb2fce | 120 | sscpi->got_newline = FALSE; |
8943049c | 121 | |
9dfeb81b | 122 | return SR_OK; |
23f43dff ML |
123 | } |
124 | ||
8107a9a6 FS |
125 | static int scpi_serial_connection_id(struct sr_scpi_dev_inst *scpi, |
126 | char **connection_id) | |
127 | { | |
128 | struct scpi_serial *sscpi = scpi->priv; | |
129 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
130 | ||
131 | *connection_id = g_strdup(serial->port); | |
132 | ||
133 | return SR_OK; | |
134 | } | |
135 | ||
102f1239 BV |
136 | static int scpi_serial_source_add(struct sr_session *session, void *priv, |
137 | int events, int timeout, sr_receive_data_callback cb, void *cb_data) | |
23f43dff | 138 | { |
05c644ea ML |
139 | struct scpi_serial *sscpi = priv; |
140 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff | 141 | |
102f1239 | 142 | return serial_source_add(session, serial, events, timeout, cb, cb_data); |
23f43dff ML |
143 | } |
144 | ||
102f1239 | 145 | static int scpi_serial_source_remove(struct sr_session *session, void *priv) |
23f43dff | 146 | { |
05c644ea ML |
147 | struct scpi_serial *sscpi = priv; |
148 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff | 149 | |
102f1239 | 150 | return serial_source_remove(session, serial); |
23f43dff ML |
151 | } |
152 | ||
d87c1766 | 153 | static int scpi_serial_send(void *priv, const char *command) |
23f43dff | 154 | { |
379e95c5 | 155 | int result; |
05c644ea ML |
156 | struct scpi_serial *sscpi = priv; |
157 | struct sr_serial_dev_inst *serial = sscpi->serial; | |
23f43dff | 158 | |
379e95c5 UH |
159 | result = serial_write_blocking(serial, command, strlen(command), 0); |
160 | if (result < 0) { | |
0c8aedb5 UH |
161 | sr_err("Error while sending SCPI command '%s': %d.", |
162 | command, result); | |
379e95c5 | 163 | return SR_ERR; |
23f43dff ML |
164 | } |
165 | ||
166 | sr_spew("Successfully sent SCPI command: '%s'.", command); | |
167 | ||
168 | return SR_OK; | |
169 | } | |
170 | ||
d87c1766 | 171 | static int scpi_serial_read_begin(void *priv) |
05c644ea | 172 | { |
9ea4018f | 173 | struct scpi_serial *sscpi = priv; |
35bb2fce | 174 | sscpi->got_newline = FALSE; |
05c644ea ML |
175 | |
176 | return SR_OK; | |
177 | } | |
178 | ||
d87c1766 | 179 | static int scpi_serial_read_data(void *priv, char *buf, int maxlen) |
bc03a7cc | 180 | { |
05c644ea | 181 | struct scpi_serial *sscpi = priv; |
9ea4018f | 182 | int ret; |
8943049c | 183 | |
9ea4018f SB |
184 | /* Try to read new data into the buffer. */ |
185 | ret = serial_read_nonblocking(sscpi->serial, buf, maxlen); | |
05c644ea | 186 | |
9ea4018f SB |
187 | if (ret < 0) |
188 | return ret; | |
05c644ea | 189 | |
9ea4018f | 190 | if (ret > 0) { |
9ea4018f | 191 | if (buf[ret - 1] == '\n') { |
35bb2fce | 192 | sscpi->got_newline = TRUE; |
9ea4018f SB |
193 | sr_spew("Received terminator"); |
194 | } else { | |
35bb2fce | 195 | sscpi->got_newline = FALSE; |
8943049c | 196 | } |
8943049c ML |
197 | } |
198 | ||
9ea4018f | 199 | return ret; |
bc03a7cc | 200 | } |
05c644ea | 201 | |
d87c1766 | 202 | static int scpi_serial_read_complete(void *priv) |
05c644ea ML |
203 | { |
204 | struct scpi_serial *sscpi = priv; | |
205 | ||
9ea4018f | 206 | return sscpi->got_newline; |
05c644ea ML |
207 | } |
208 | ||
04229f7b | 209 | static int scpi_serial_close(struct sr_scpi_dev_inst *scpi) |
bc03a7cc | 210 | { |
04229f7b | 211 | struct scpi_serial *sscpi = scpi->priv; |
05c644ea | 212 | |
f754c146 | 213 | return serial_close(sscpi->serial); |
bc03a7cc | 214 | } |
05c644ea | 215 | |
bc03a7cc BV |
216 | static void scpi_serial_free(void *priv) |
217 | { | |
05c644ea | 218 | struct scpi_serial *sscpi = priv; |
05c644ea | 219 | |
f754c146 | 220 | sr_serial_dev_inst_free(sscpi->serial); |
bc03a7cc BV |
221 | } |
222 | ||
f754c146 AJ |
223 | SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = { |
224 | .name = "serial", | |
225 | .prefix = "", | |
87aa1e63 | 226 | .transport = SCPI_TRANSPORT_SERIAL, |
f754c146 | 227 | .priv_size = sizeof(struct scpi_serial), |
b541f837 | 228 | .scan = scpi_serial_scan, |
f754c146 AJ |
229 | .dev_inst_new = scpi_serial_dev_inst_new, |
230 | .open = scpi_serial_open, | |
8107a9a6 | 231 | .connection_id = scpi_serial_connection_id, |
f754c146 AJ |
232 | .source_add = scpi_serial_source_add, |
233 | .source_remove = scpi_serial_source_remove, | |
234 | .send = scpi_serial_send, | |
235 | .read_begin = scpi_serial_read_begin, | |
236 | .read_data = scpi_serial_read_data, | |
237 | .read_complete = scpi_serial_read_complete, | |
238 | .close = scpi_serial_close, | |
239 | .free = scpi_serial_free, | |
240 | }; | |
48b7c346 GS |
241 | |
242 | #endif |