]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> | |
5 | * | |
6 | * This program is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #include <config.h> | |
21 | #include <string.h> | |
22 | #include "protocol.h" | |
23 | ||
24 | #define USB_CONN "1041.8101" | |
25 | #define VENDOR "Kecheng" | |
26 | #define USB_INTERFACE 0 | |
27 | ||
28 | static const uint32_t drvopts[] = { | |
29 | SR_CONF_SOUNDLEVELMETER, | |
30 | }; | |
31 | ||
32 | static const uint32_t devopts[] = { | |
33 | SR_CONF_CONTINUOUS, | |
34 | SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET, | |
35 | SR_CONF_SAMPLE_INTERVAL | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
36 | SR_CONF_DATALOG | SR_CONF_GET, | |
37 | SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
38 | SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
39 | SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
40 | }; | |
41 | ||
42 | SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = { | |
43 | { 1, 8 }, | |
44 | { 1, 2 }, | |
45 | { 1, 1 }, | |
46 | { 2, 1 }, | |
47 | { 5, 1 }, | |
48 | { 10, 1 }, | |
49 | { 60, 1 }, | |
50 | }; | |
51 | ||
52 | static const char *weight_freq[] = { | |
53 | "A", | |
54 | "C", | |
55 | }; | |
56 | ||
57 | static const char *weight_time[] = { | |
58 | "F", | |
59 | "S", | |
60 | }; | |
61 | ||
62 | static const char *data_sources[] = { | |
63 | "Live", | |
64 | "Memory", | |
65 | }; | |
66 | ||
67 | static int scan_kecheng(struct sr_dev_driver *di, | |
68 | struct sr_usb_dev_inst *usb, char **model) | |
69 | { | |
70 | struct drv_context *drvc; | |
71 | int len, ret; | |
72 | unsigned char cmd, buf[32]; | |
73 | ||
74 | drvc = di->context; | |
75 | if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK) | |
76 | return SR_ERR; | |
77 | ||
78 | cmd = CMD_IDENTIFY; | |
79 | ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5); | |
80 | if (ret != 0) { | |
81 | libusb_close(usb->devhdl); | |
82 | sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret)); | |
83 | return SR_ERR; | |
84 | } | |
85 | ||
86 | ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10); | |
87 | if (ret != 0) { | |
88 | libusb_close(usb->devhdl); | |
89 | sr_dbg("Failed to receive response: %s", libusb_error_name(ret)); | |
90 | return SR_ERR; | |
91 | } | |
92 | ||
93 | libusb_close(usb->devhdl); | |
94 | usb->devhdl = NULL; | |
95 | ||
96 | if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) { | |
97 | sr_dbg("Invalid response to Identify command"); | |
98 | return SR_ERR; | |
99 | } | |
100 | ||
101 | buf[buf[1] + 2] = '\x0'; | |
102 | *model = g_strndup((const gchar *)buf + 2, 30); | |
103 | ||
104 | return SR_OK; | |
105 | } | |
106 | ||
107 | static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
108 | { | |
109 | struct drv_context *drvc; | |
110 | struct dev_context *devc; | |
111 | struct sr_dev_inst *sdi; | |
112 | GSList *usb_devices, *devices, *l; | |
113 | char *model; | |
114 | ||
115 | (void)options; | |
116 | ||
117 | drvc = di->context; | |
118 | ||
119 | devices = NULL; | |
120 | if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) { | |
121 | /* We have a list of sr_usb_dev_inst matching the connection | |
122 | * string. Wrap them in sr_dev_inst and we're done. */ | |
123 | for (l = usb_devices; l; l = l->next) { | |
124 | if (scan_kecheng(di, l->data, &model) != SR_OK) | |
125 | continue; | |
126 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); | |
127 | sdi->status = SR_ST_INACTIVE; | |
128 | sdi->vendor = g_strdup(VENDOR); | |
129 | sdi->model = model; /* Already g_strndup()'d. */ | |
130 | sdi->inst_type = SR_INST_USB; | |
131 | sdi->conn = l->data; | |
132 | sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL"); | |
133 | devc = g_malloc0(sizeof(struct dev_context)); | |
134 | sdi->priv = devc; | |
135 | devc->limit_samples = 0; | |
136 | /* The protocol provides no way to read the current | |
137 | * settings, so we'll enforce these. */ | |
138 | devc->sample_interval = DEFAULT_SAMPLE_INTERVAL; | |
139 | devc->alarm_low = DEFAULT_ALARM_LOW; | |
140 | devc->alarm_high = DEFAULT_ALARM_HIGH; | |
141 | devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ; | |
142 | devc->data_source = DEFAULT_DATA_SOURCE; | |
143 | devc->config_dirty = FALSE; | |
144 | ||
145 | /* TODO: Set date/time? */ | |
146 | ||
147 | devices = g_slist_append(devices, sdi); | |
148 | } | |
149 | g_slist_free(usb_devices); | |
150 | } else | |
151 | g_slist_free_full(usb_devices, g_free); | |
152 | ||
153 | return std_scan_complete(di, devices); | |
154 | } | |
155 | ||
156 | static int dev_open(struct sr_dev_inst *sdi) | |
157 | { | |
158 | struct sr_dev_driver *di = sdi->driver; | |
159 | struct drv_context *drvc = di->context; | |
160 | struct sr_usb_dev_inst *usb; | |
161 | int ret; | |
162 | ||
163 | usb = sdi->conn; | |
164 | ||
165 | if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK) | |
166 | return SR_ERR; | |
167 | ||
168 | if ((ret = libusb_set_configuration(usb->devhdl, 1))) { | |
169 | sr_err("Failed to set configuration: %s.", libusb_error_name(ret)); | |
170 | return SR_ERR; | |
171 | } | |
172 | ||
173 | if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) { | |
174 | sr_err("Failed to claim interface: %s.", libusb_error_name(ret)); | |
175 | return SR_ERR; | |
176 | } | |
177 | ||
178 | return SR_OK; | |
179 | } | |
180 | ||
181 | static int dev_close(struct sr_dev_inst *sdi) | |
182 | { | |
183 | struct dev_context *devc; | |
184 | struct sr_usb_dev_inst *usb; | |
185 | ||
186 | usb = sdi->conn; | |
187 | ||
188 | if (!usb->devhdl) | |
189 | return SR_ERR_BUG; | |
190 | ||
191 | /* This allows a frontend to configure the device without ever | |
192 | * doing an acquisition step. */ | |
193 | devc = sdi->priv; | |
194 | if (!devc->config_dirty) | |
195 | kecheng_kc_330b_configure(sdi); | |
196 | ||
197 | libusb_release_interface(usb->devhdl, USB_INTERFACE); | |
198 | libusb_close(usb->devhdl); | |
199 | usb->devhdl = NULL; | |
200 | ||
201 | return SR_OK; | |
202 | } | |
203 | ||
204 | static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, | |
205 | const struct sr_channel_group *cg) | |
206 | { | |
207 | struct dev_context *devc; | |
208 | GVariant *rational[2]; | |
209 | const uint64_t *si; | |
210 | ||
211 | (void)cg; | |
212 | ||
213 | devc = sdi->priv; | |
214 | switch (key) { | |
215 | case SR_CONF_LIMIT_SAMPLES: | |
216 | *data = g_variant_new_uint64(devc->limit_samples); | |
217 | break; | |
218 | case SR_CONF_SAMPLE_INTERVAL: | |
219 | si = kecheng_kc_330b_sample_intervals[devc->sample_interval]; | |
220 | rational[0] = g_variant_new_uint64(si[0]); | |
221 | rational[1] = g_variant_new_uint64(si[1]); | |
222 | *data = g_variant_new_tuple(rational, 2); | |
223 | break; | |
224 | case SR_CONF_DATALOG: | |
225 | /* There really isn't a way to be sure the device is logging. */ | |
226 | return SR_ERR_NA; | |
227 | break; | |
228 | case SR_CONF_SPL_WEIGHT_FREQ: | |
229 | if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A) | |
230 | *data = g_variant_new_string("A"); | |
231 | else | |
232 | *data = g_variant_new_string("C"); | |
233 | break; | |
234 | case SR_CONF_SPL_WEIGHT_TIME: | |
235 | if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F) | |
236 | *data = g_variant_new_string("F"); | |
237 | else | |
238 | *data = g_variant_new_string("S"); | |
239 | break; | |
240 | case SR_CONF_DATA_SOURCE: | |
241 | if (devc->data_source == DATA_SOURCE_LIVE) | |
242 | *data = g_variant_new_string("Live"); | |
243 | else | |
244 | *data = g_variant_new_string("Memory"); | |
245 | break; | |
246 | default: | |
247 | return SR_ERR_NA; | |
248 | } | |
249 | ||
250 | return SR_OK; | |
251 | } | |
252 | ||
253 | static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi, | |
254 | const struct sr_channel_group *cg) | |
255 | { | |
256 | struct dev_context *devc; | |
257 | uint64_t p, q; | |
258 | unsigned int i; | |
259 | int tmp; | |
260 | const char *tmp_str; | |
261 | ||
262 | (void)cg; | |
263 | ||
264 | devc = sdi->priv; | |
265 | switch (key) { | |
266 | case SR_CONF_LIMIT_SAMPLES: | |
267 | devc->limit_samples = g_variant_get_uint64(data); | |
268 | sr_dbg("Setting sample limit to %" PRIu64 ".", | |
269 | devc->limit_samples); | |
270 | break; | |
271 | case SR_CONF_SAMPLE_INTERVAL: | |
272 | g_variant_get(data, "(tt)", &p, &q); | |
273 | for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) { | |
274 | if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q) | |
275 | continue; | |
276 | devc->sample_interval = i; | |
277 | devc->config_dirty = TRUE; | |
278 | break; | |
279 | } | |
280 | if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals)) | |
281 | return SR_ERR_ARG; | |
282 | break; | |
283 | case SR_CONF_SPL_WEIGHT_FREQ: | |
284 | tmp_str = g_variant_get_string(data, NULL); | |
285 | if (!strcmp(tmp_str, "A")) | |
286 | tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A; | |
287 | else if (!strcmp(tmp_str, "C")) | |
288 | tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C; | |
289 | else | |
290 | return SR_ERR_ARG; | |
291 | devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C); | |
292 | devc->mqflags |= tmp; | |
293 | devc->config_dirty = TRUE; | |
294 | break; | |
295 | case SR_CONF_SPL_WEIGHT_TIME: | |
296 | tmp_str = g_variant_get_string(data, NULL); | |
297 | if (!strcmp(tmp_str, "F")) | |
298 | tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F; | |
299 | else if (!strcmp(tmp_str, "S")) | |
300 | tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S; | |
301 | else | |
302 | return SR_ERR_ARG; | |
303 | devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S); | |
304 | devc->mqflags |= tmp; | |
305 | devc->config_dirty = TRUE; | |
306 | break; | |
307 | case SR_CONF_DATA_SOURCE: | |
308 | tmp_str = g_variant_get_string(data, NULL); | |
309 | if (!strcmp(tmp_str, "Live")) | |
310 | devc->data_source = DATA_SOURCE_LIVE; | |
311 | else if (!strcmp(tmp_str, "Memory")) | |
312 | devc->data_source = DATA_SOURCE_MEMORY; | |
313 | else | |
314 | return SR_ERR; | |
315 | devc->config_dirty = TRUE; | |
316 | break; | |
317 | default: | |
318 | return SR_ERR_NA; | |
319 | } | |
320 | ||
321 | return SR_OK; | |
322 | } | |
323 | ||
324 | static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, | |
325 | const struct sr_channel_group *cg) | |
326 | { | |
327 | GVariant *tuple, *rational[2]; | |
328 | GVariantBuilder gvb; | |
329 | unsigned int i; | |
330 | ||
331 | switch (key) { | |
332 | case SR_CONF_DEVICE_OPTIONS: | |
333 | return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts); | |
334 | case SR_CONF_SAMPLE_INTERVAL: | |
335 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
336 | for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) { | |
337 | rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]); | |
338 | rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]); | |
339 | tuple = g_variant_new_tuple(rational, 2); | |
340 | g_variant_builder_add_value(&gvb, tuple); | |
341 | } | |
342 | *data = g_variant_builder_end(&gvb); | |
343 | break; | |
344 | case SR_CONF_SPL_WEIGHT_FREQ: | |
345 | *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq)); | |
346 | break; | |
347 | case SR_CONF_SPL_WEIGHT_TIME: | |
348 | *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time)); | |
349 | break; | |
350 | case SR_CONF_DATA_SOURCE: | |
351 | *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources)); | |
352 | break; | |
353 | default: | |
354 | return SR_ERR_NA; | |
355 | } | |
356 | ||
357 | return SR_OK; | |
358 | } | |
359 | ||
360 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) | |
361 | { | |
362 | struct sr_dev_driver *di = sdi->driver; | |
363 | struct drv_context *drvc; | |
364 | struct dev_context *devc; | |
365 | struct sr_datafeed_packet packet; | |
366 | struct sr_datafeed_meta meta; | |
367 | struct sr_config *src; | |
368 | struct sr_usb_dev_inst *usb; | |
369 | GVariant *gvar, *rational[2]; | |
370 | const uint64_t *si; | |
371 | int req_len, buf_len, len, ret; | |
372 | unsigned char buf[9]; | |
373 | ||
374 | drvc = di->context; | |
375 | devc = sdi->priv; | |
376 | usb = sdi->conn; | |
377 | ||
378 | devc->num_samples = 0; | |
379 | ||
380 | std_session_send_df_header(sdi); | |
381 | ||
382 | if (devc->data_source == DATA_SOURCE_LIVE) { | |
383 | /* Force configuration. */ | |
384 | kecheng_kc_330b_configure(sdi); | |
385 | ||
386 | if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK) | |
387 | return SR_ERR; | |
388 | if (ret != DEVICE_ACTIVE) { | |
389 | sr_err("Device is inactive"); | |
390 | /* Still continue though, since the device will | |
391 | * just return 30.0 until the user hits the button | |
392 | * on the device -- and then start feeding good | |
393 | * samples back. */ | |
394 | } | |
395 | } else { | |
396 | if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK) | |
397 | return SR_ERR; | |
398 | devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F; | |
399 | devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A; | |
400 | devc->stored_samples = (buf[7] << 8) | buf[8]; | |
401 | if (devc->stored_samples == 0) { | |
402 | /* Notify frontend of empty log by sending start/end packets. */ | |
403 | std_session_send_df_end(sdi); | |
404 | return SR_OK; | |
405 | } | |
406 | ||
407 | if (devc->limit_samples && devc->limit_samples < devc->stored_samples) | |
408 | devc->stored_samples = devc->limit_samples; | |
409 | ||
410 | si = kecheng_kc_330b_sample_intervals[buf[1]]; | |
411 | rational[0] = g_variant_new_uint64(si[0]); | |
412 | rational[1] = g_variant_new_uint64(si[1]); | |
413 | gvar = g_variant_new_tuple(rational, 2); | |
414 | src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar); | |
415 | packet.type = SR_DF_META; | |
416 | packet.payload = &meta; | |
417 | meta.config = g_slist_append(NULL, src); | |
418 | sr_session_send(sdi, &packet); | |
419 | g_free(src); | |
420 | } | |
421 | ||
422 | if (!(devc->xfer = libusb_alloc_transfer(0))) | |
423 | return SR_ERR; | |
424 | ||
425 | usb_source_add(sdi->session, drvc->sr_ctx, 10, | |
426 | kecheng_kc_330b_handle_events, (void *)sdi); | |
427 | ||
428 | if (devc->data_source == DATA_SOURCE_LIVE) { | |
429 | buf[0] = CMD_GET_LIVE_SPL; | |
430 | buf_len = 1; | |
431 | devc->state = LIVE_SPL_WAIT; | |
432 | devc->last_live_request = g_get_monotonic_time() / 1000; | |
433 | req_len = 3; | |
434 | } else { | |
435 | buf[0] = CMD_GET_LOG_DATA; | |
436 | buf[1] = 0; | |
437 | buf[2] = 0; | |
438 | buf_len = 4; | |
439 | devc->state = LOG_DATA_WAIT; | |
440 | if (devc->stored_samples < 63) | |
441 | buf[3] = devc->stored_samples; | |
442 | else | |
443 | buf[3] = 63; | |
444 | /* Command ack byte + 2 bytes per sample. */ | |
445 | req_len = 1 + buf[3] * 2; | |
446 | } | |
447 | ||
448 | ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5); | |
449 | if (ret != 0 || len != 1) { | |
450 | sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret)); | |
451 | libusb_free_transfer(devc->xfer); | |
452 | return SR_ERR; | |
453 | } | |
454 | ||
455 | libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf, | |
456 | req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15); | |
457 | if (libusb_submit_transfer(devc->xfer) != 0) { | |
458 | libusb_free_transfer(devc->xfer); | |
459 | return SR_ERR; | |
460 | } | |
461 | ||
462 | return SR_OK; | |
463 | } | |
464 | ||
465 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) | |
466 | { | |
467 | struct dev_context *devc; | |
468 | ||
469 | /* Signal USB transfer handler to clean up and stop. */ | |
470 | sdi->status = SR_ST_STOPPING; | |
471 | ||
472 | devc = sdi->priv; | |
473 | if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) { | |
474 | /* The protocol doesn't have a command to clear stored data; | |
475 | * it clears it whenever new configuration is set. That means | |
476 | * we can't just configure the device any time we want when | |
477 | * it's in DATA_SOURCE_MEMORY mode. The only safe time to do | |
478 | * it is now, when we're sure we've pulled in all the stored | |
479 | * data. */ | |
480 | kecheng_kc_330b_configure(sdi); | |
481 | } | |
482 | ||
483 | return SR_OK; | |
484 | } | |
485 | ||
486 | static struct sr_dev_driver kecheng_kc_330b_driver_info = { | |
487 | .name = "kecheng-kc-330b", | |
488 | .longname = "Kecheng KC-330B", | |
489 | .api_version = 1, | |
490 | .init = std_init, | |
491 | .cleanup = std_cleanup, | |
492 | .scan = scan, | |
493 | .dev_list = std_dev_list, | |
494 | .dev_clear = std_dev_clear, | |
495 | .config_get = config_get, | |
496 | .config_set = config_set, | |
497 | .config_list = config_list, | |
498 | .dev_open = dev_open, | |
499 | .dev_close = dev_close, | |
500 | .dev_acquisition_start = dev_acquisition_start, | |
501 | .dev_acquisition_stop = dev_acquisition_stop, | |
502 | .context = NULL, | |
503 | }; | |
504 | SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info); |