]>
Commit | Line | Data |
---|---|---|
b5089195 JH |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2014 Janne Huttunen <jahuttun@gmail.com> | |
bf5c4d46 | 5 | * Copyright (C) 2019 Gerhard Sittig <gerhard.sittig@gmx.net> |
b5089195 JH |
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> |
b5089195 | 22 | #include <glib.h> |
c1aae900 | 23 | #include <libsigrok/libsigrok.h> |
b5089195 | 24 | #include "libsigrok-internal.h" |
bf5c4d46 GS |
25 | #include <math.h> |
26 | #include "protocol.h" | |
27 | #include <stdint.h> | |
28 | #include <string.h> | |
b5089195 | 29 | |
bf5c4d46 GS |
30 | static const uint32_t scanopts[] = { |
31 | SR_CONF_CONN, | |
32 | SR_CONF_SERIALCOMM, | |
33 | }; | |
34 | ||
35 | static const uint32_t drvopts[] = { | |
36 | SR_CONF_LCRMETER, | |
37 | }; | |
beedfa06 | 38 | |
bf5c4d46 GS |
39 | static const uint32_t devopts[] = { |
40 | SR_CONF_CONTINUOUS, | |
41 | SR_CONF_LIMIT_FRAMES | SR_CONF_SET, | |
42 | SR_CONF_LIMIT_MSEC | SR_CONF_SET, | |
43 | SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_LIST, | |
44 | SR_CONF_EQUIV_CIRCUIT_MODEL | SR_CONF_GET | SR_CONF_LIST, | |
beedfa06 | 45 | }; |
b5089195 | 46 | |
bf5c4d46 GS |
47 | static struct sr_dev_inst *scan_packet_check_devinst; |
48 | ||
49 | static void scan_packet_check_setup(struct sr_dev_inst *sdi) | |
50 | { | |
51 | scan_packet_check_devinst = sdi; | |
52 | } | |
53 | ||
54 | static gboolean scan_packet_check_func(const uint8_t *buf) | |
b5089195 | 55 | { |
bf5c4d46 GS |
56 | struct sr_dev_inst *sdi; |
57 | struct dev_context *devc; | |
58 | const struct lcr_info *lcr; | |
59 | struct lcr_parse_info *info; | |
60 | ||
61 | /* Get a reference to the LCR model that is getting checked. */ | |
62 | sdi = scan_packet_check_devinst; | |
63 | if (!sdi) | |
64 | return FALSE; | |
65 | devc = sdi->priv; | |
66 | if (!devc) | |
67 | return FALSE; | |
68 | lcr = devc->lcr_info; | |
69 | if (!lcr) | |
70 | return FALSE; | |
71 | ||
72 | /* Synchronize to the stream of LCR packets. */ | |
73 | if (!lcr->packet_valid(buf)) | |
74 | return FALSE; | |
75 | ||
76 | /* Have LCR packets _processed_, gather current configuration. */ | |
77 | info = &devc->parse_info; | |
78 | memset(info, 0, sizeof(*info)); | |
79 | if (lcr->packet_parse(buf, NULL, NULL, info) == SR_OK) { | |
80 | devc->output_freq = info->output_freq; | |
81 | if (info->circuit_model) | |
82 | devc->circuit_model = info->circuit_model; | |
83 | } | |
84 | ||
85 | return TRUE; | |
b5089195 JH |
86 | } |
87 | ||
c4d2e6fa GS |
88 | static int scan_lcr_port(const struct lcr_info *lcr, |
89 | const char *conn, struct sr_serial_dev_inst *serial) | |
b5089195 | 90 | { |
c4d2e6fa | 91 | size_t len; |
bf5c4d46 | 92 | uint8_t buf[128]; |
bf5c4d46 | 93 | int ret; |
c4d2e6fa | 94 | size_t dropped; |
b5089195 | 95 | |
bf5c4d46 | 96 | if (serial_open(serial, SERIAL_RDWR) != SR_OK) |
c4d2e6fa | 97 | return SR_ERR_IO; |
bf5c4d46 GS |
98 | sr_info("Probing serial port %s.", conn); |
99 | ||
100 | /* | |
101 | * See if we can detect a device of specified type. | |
102 | * | |
103 | * No supported device provides a means to "identify" yet. No | |
104 | * supported device requires "packet request" yet. They all just | |
105 | * send data periodically. So we check if the packets match the | |
106 | * probed device's expected format. | |
107 | */ | |
cb5cd153 GS |
108 | serial_flush(serial); |
109 | if (lcr->packet_request) { | |
110 | ret = lcr->packet_request(serial); | |
111 | if (ret < 0) { | |
112 | sr_err("Failed to request packet: %d.", ret); | |
c4d2e6fa | 113 | goto scan_port_cleanup; |
cb5cd153 GS |
114 | } |
115 | } | |
bf5c4d46 GS |
116 | len = sizeof(buf); |
117 | ret = serial_stream_detect(serial, buf, &len, | |
118 | lcr->packet_size, lcr->packet_valid, 3000); | |
119 | if (ret != SR_OK) | |
c4d2e6fa | 120 | goto scan_port_cleanup; |
bf5c4d46 GS |
121 | |
122 | /* | |
123 | * If the packets were found to match after more than two packets | |
124 | * got dropped, something is wrong. This is worth warning about, | |
125 | * but isn't fatal. The dropped bytes might be due to nonstandard | |
126 | * cables that ship with some devices. | |
127 | */ | |
128 | dropped = len - lcr->packet_size; | |
129 | if (dropped > 2 * lcr->packet_size) | |
130 | sr_warn("Had to drop unexpected amounts of data."); | |
131 | ||
132 | /* Create a device instance for the found device. */ | |
133 | sr_info("Found %s %s device on port %s.", lcr->vendor, lcr->model, conn); | |
c4d2e6fa GS |
134 | |
135 | scan_port_cleanup: | |
136 | /* Keep serial port open if probe succeeded. */ | |
137 | if (ret != SR_OK) | |
138 | serial_close(serial); | |
139 | ||
140 | return ret; | |
141 | } | |
142 | ||
143 | static struct sr_dev_inst *create_lcr_sdi(struct lcr_info *lcr, | |
144 | struct sr_serial_dev_inst *serial) | |
145 | { | |
146 | struct sr_dev_inst *sdi; | |
147 | struct dev_context *devc; | |
148 | size_t ch_idx; | |
149 | const char **ch_fmts; | |
150 | const char *fmt; | |
151 | char ch_name[8]; | |
152 | ||
bf5c4d46 GS |
153 | sdi = g_malloc0(sizeof(*sdi)); |
154 | sdi->status = SR_ST_INACTIVE; | |
155 | sdi->vendor = g_strdup(lcr->vendor); | |
156 | sdi->model = g_strdup(lcr->model); | |
157 | sdi->inst_type = SR_INST_SERIAL; | |
158 | sdi->conn = serial; | |
159 | devc = g_malloc0(sizeof(*devc)); | |
160 | sdi->priv = devc; | |
161 | devc->lcr_info = lcr; | |
162 | sr_sw_limits_init(&devc->limits); | |
3f5473dd | 163 | ch_fmts = lcr->channel_formats; |
bf5c4d46 | 164 | for (ch_idx = 0; ch_idx < lcr->channel_count; ch_idx++) { |
3f5473dd GS |
165 | fmt = (ch_fmts && ch_fmts[ch_idx]) ? ch_fmts[ch_idx] : "P%zu"; |
166 | snprintf(ch_name, sizeof(ch_name), fmt, ch_idx + 1); | |
bf5c4d46 GS |
167 | sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, ch_name); |
168 | } | |
c4d2e6fa GS |
169 | |
170 | return sdi; | |
171 | } | |
172 | ||
173 | static int read_lcr_port(struct sr_dev_inst *sdi, | |
174 | const struct lcr_info *lcr, struct sr_serial_dev_inst *serial) | |
175 | { | |
176 | size_t len; | |
177 | uint8_t buf[128]; | |
178 | int ret; | |
bf5c4d46 GS |
179 | |
180 | /* | |
181 | * Receive a few more packets (and process them!) to have the | |
182 | * current output frequency and circuit model parameter values | |
183 | * detected. The above "stream detect" phase only synchronized | |
184 | * to the packets by checking their validity, but it cannot | |
185 | * provide details. This phase here runs a modified "checker" | |
186 | * routine which also extracts details from LCR packets after | |
187 | * the device got detected and parameter storage was prepared. | |
188 | */ | |
189 | sr_info("Retrieving current acquisition parameters."); | |
190 | len = sizeof(buf); | |
191 | scan_packet_check_setup(sdi); | |
192 | ret = serial_stream_detect(serial, buf, &len, | |
193 | lcr->packet_size, scan_packet_check_func, 1000); | |
194 | scan_packet_check_setup(NULL); | |
195 | ||
c4d2e6fa GS |
196 | return ret; |
197 | } | |
198 | ||
199 | static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
200 | { | |
201 | struct lcr_info *lcr; | |
202 | struct sr_config *src; | |
203 | GSList *l, *devices; | |
204 | const char *conn, *serialcomm; | |
205 | struct sr_serial_dev_inst *serial; | |
206 | int ret; | |
207 | struct sr_dev_inst *sdi; | |
208 | ||
209 | lcr = (struct lcr_info *)di; | |
210 | ||
211 | /* Get serial port name and communication parameters. */ | |
212 | conn = NULL; | |
213 | serialcomm = lcr->comm; | |
214 | for (l = options; l; l = l->next) { | |
215 | src = l->data; | |
216 | switch (src->key) { | |
217 | case SR_CONF_CONN: | |
218 | conn = g_variant_get_string(src->data, NULL); | |
219 | break; | |
220 | case SR_CONF_SERIALCOMM: | |
221 | serialcomm = g_variant_get_string(src->data, NULL); | |
222 | break; | |
223 | } | |
224 | } | |
225 | if (!conn) | |
226 | return NULL; | |
227 | ||
228 | devices = NULL; | |
229 | /* TODO Handle ambiguous conn= specs, see serial-dmm. */ | |
230 | ||
231 | /* Open the serial port, check data packets. */ | |
232 | serial = sr_serial_dev_inst_new(conn, serialcomm); | |
233 | ret = scan_lcr_port(lcr, conn, serial); | |
234 | if (ret != SR_OK) { | |
235 | /* Probe failed, release 'serial'. */ | |
236 | sr_serial_dev_inst_free(serial); | |
237 | } else { | |
238 | /* Create and return device instance, keep 'serial' alive. */ | |
239 | sdi = create_lcr_sdi(lcr, serial); | |
240 | devices = g_slist_append(devices, sdi); | |
241 | (void)read_lcr_port(sdi, lcr, serial); | |
242 | serial_close(serial); | |
243 | } | |
bf5c4d46 GS |
244 | |
245 | return std_scan_complete(di, devices); | |
246 | } | |
247 | ||
248 | static int config_get(uint32_t key, GVariant **data, | |
249 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
250 | { | |
251 | struct dev_context *devc; | |
252 | const struct lcr_info *lcr; | |
253 | ||
254 | if (!sdi) | |
255 | return SR_ERR_ARG; | |
256 | devc = sdi->priv; | |
257 | ||
258 | switch (key) { | |
259 | case SR_CONF_LIMIT_FRAMES: | |
260 | case SR_CONF_LIMIT_MSEC: | |
261 | return sr_sw_limits_config_get(&devc->limits, key, data); | |
262 | case SR_CONF_OUTPUT_FREQUENCY: | |
263 | *data = g_variant_new_double(devc->output_freq); | |
264 | return SR_OK; | |
265 | case SR_CONF_EQUIV_CIRCUIT_MODEL: | |
266 | if (!devc->circuit_model) | |
267 | return SR_ERR_NA; | |
268 | *data = g_variant_new_string(devc->circuit_model); | |
269 | return SR_OK; | |
270 | default: | |
271 | lcr = devc->lcr_info; | |
272 | if (!lcr) | |
273 | return SR_ERR_NA; | |
274 | if (!lcr->config_get) | |
275 | return SR_ERR_NA; | |
276 | return lcr->config_get(key, data, sdi, cg); | |
277 | } | |
278 | /* UNREACH */ | |
279 | } | |
280 | ||
281 | static int config_set(uint32_t key, GVariant *data, | |
282 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
283 | { | |
284 | struct dev_context *devc; | |
285 | const struct lcr_info *lcr; | |
286 | ||
287 | if (!sdi) | |
288 | return SR_ERR_ARG; | |
289 | devc = sdi->priv; | |
290 | ||
291 | switch (key) { | |
292 | case SR_CONF_LIMIT_FRAMES: | |
293 | case SR_CONF_LIMIT_MSEC: | |
294 | return sr_sw_limits_config_set(&devc->limits, key, data); | |
295 | default: | |
296 | lcr = devc->lcr_info; | |
297 | if (!lcr) | |
298 | return SR_ERR_NA; | |
299 | if (!lcr->config_set) | |
300 | return SR_ERR_NA; | |
301 | return lcr->config_set(key, data, sdi, cg); | |
302 | } | |
303 | /* UNREACH */ | |
304 | } | |
305 | ||
306 | static int config_list(uint32_t key, GVariant **data, | |
307 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
308 | { | |
309 | struct dev_context *devc; | |
310 | const struct lcr_info *lcr; | |
311 | ||
312 | switch (key) { | |
313 | case SR_CONF_SCAN_OPTIONS: | |
314 | case SR_CONF_DEVICE_OPTIONS: | |
315 | return STD_CONFIG_LIST(key, data, sdi, cg, | |
316 | scanopts, drvopts, devopts); | |
317 | default: | |
318 | break; | |
319 | } | |
320 | ||
321 | if (!sdi) | |
322 | return SR_ERR_ARG; | |
323 | devc = sdi->priv; | |
324 | switch (key) { | |
325 | default: | |
326 | lcr = devc->lcr_info; | |
327 | if (!lcr || !lcr->config_list) | |
328 | return SR_ERR_NA; | |
329 | return lcr->config_list(key, data, sdi, cg); | |
330 | } | |
331 | /* UNREACH */ | |
332 | } | |
333 | ||
334 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) | |
335 | { | |
336 | struct dev_context *devc; | |
337 | struct sr_serial_dev_inst *serial; | |
338 | ||
339 | devc = sdi->priv; | |
340 | ||
341 | /* | |
342 | * Clear values that were gathered during scan or in a previous | |
343 | * acquisition, so that this acquisition's data feed immediately | |
344 | * starts with meta packets before first measurement values, and | |
345 | * also communicates subsequent parameter changes. | |
346 | */ | |
347 | devc->output_freq = 0; | |
348 | devc->circuit_model = NULL; | |
349 | ||
350 | sr_sw_limits_acquisition_start(&devc->limits); | |
351 | std_session_send_df_header(sdi); | |
352 | ||
353 | serial = sdi->conn; | |
354 | serial_source_add(sdi->session, serial, G_IO_IN, 50, | |
355 | lcr_receive_data, (void *)sdi); | |
356 | ||
357 | return SR_OK; | |
b5089195 JH |
358 | } |
359 | ||
beedfa06 | 360 | #define LCR_ES51919(id, vendor, model) \ |
bf5c4d46 | 361 | &((struct lcr_info) { \ |
beedfa06 GS |
362 | { \ |
363 | .name = id, \ | |
364 | .longname = vendor " " model, \ | |
365 | .api_version = 1, \ | |
366 | .init = std_init, \ | |
367 | .cleanup = std_cleanup, \ | |
368 | .scan = scan, \ | |
369 | .dev_list = std_dev_list, \ | |
bf5c4d46 GS |
370 | .dev_clear = std_dev_clear, \ |
371 | .config_get = config_get, \ | |
372 | .config_set = config_set, \ | |
373 | .config_list = config_list, \ | |
beedfa06 GS |
374 | .dev_open = std_serial_dev_open, \ |
375 | .dev_close = std_serial_dev_close, \ | |
bf5c4d46 | 376 | .dev_acquisition_start = dev_acquisition_start, \ |
beedfa06 GS |
377 | .dev_acquisition_stop = std_serial_dev_acquisition_stop, \ |
378 | .context = NULL, \ | |
379 | }, \ | |
3f5473dd | 380 | vendor, model, ES51919_CHANNEL_COUNT, NULL, \ |
bf5c4d46 | 381 | ES51919_COMM_PARAM, ES51919_PACKET_SIZE, \ |
cb5cd153 | 382 | 0, NULL, \ |
bf5c4d46 GS |
383 | es51919_packet_valid, es51919_packet_parse, \ |
384 | NULL, NULL, es51919_config_list, \ | |
beedfa06 GS |
385 | }).di |
386 | ||
387 | SR_REGISTER_DEV_DRIVER_LIST(lcr_es51919_drivers, | |
388 | LCR_ES51919("deree-de5000", "DER EE", "DE-5000"), | |
ca9f8961 | 389 | LCR_ES51919("mastech-ms5308", "MASTECH", "MS5308"), |
6c62c605 | 390 | LCR_ES51919("peaktech-2170", "PeakTech", "2170"), |
6e407e98 | 391 | LCR_ES51919("uni-t-ut612", "UNI-T", "UT612"), |
beedfa06 | 392 | ); |