2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
24 #define USB_CONN "1041.8101"
25 #define VENDOR "Kecheng"
26 #define USB_INTERFACE 0
28 static const uint32_t devopts[] = {
29 SR_CONF_SOUNDLEVELMETER,
31 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
32 SR_CONF_SAMPLE_INTERVAL | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
33 SR_CONF_DATALOG | SR_CONF_GET,
34 SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
35 SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
49 static const char *weight_freq[] = {
54 static const char *weight_time[] = {
59 static const char *data_sources[] = {
64 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
66 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
68 return std_init(sr_ctx, di, LOG_PREFIX);
71 static int scan_kecheng(struct sr_dev_driver *di,
72 struct sr_usb_dev_inst *usb, char **model)
74 struct drv_context *drvc;
76 unsigned char cmd, buf[32];
79 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
83 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
85 libusb_close(usb->devhdl);
86 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
90 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
92 libusb_close(usb->devhdl);
93 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
97 libusb_close(usb->devhdl);
100 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
101 sr_dbg("Invalid response to Identify command");
105 buf[buf[1] + 2] = '\x0';
106 *model = g_strndup((const gchar *)buf + 2, 30);
111 static GSList *scan(struct sr_dev_driver *di, GSList *options)
113 struct drv_context *drvc;
114 struct dev_context *devc;
115 struct sr_dev_inst *sdi;
116 GSList *usb_devices, *devices, *l;
122 drvc->instances = NULL;
125 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
126 /* We have a list of sr_usb_dev_inst matching the connection
127 * string. Wrap them in sr_dev_inst and we're done. */
128 for (l = usb_devices; l; l = l->next) {
129 if (scan_kecheng(di, l->data, &model) != SR_OK)
131 sdi = g_malloc0(sizeof(struct sr_dev_inst));
132 sdi->status = SR_ST_INACTIVE;
133 sdi->vendor = g_strdup(VENDOR);
134 sdi->model = model; /* Already g_strndup()'d. */
136 sdi->inst_type = SR_INST_USB;
138 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
139 devc = g_malloc0(sizeof(struct dev_context));
141 devc->limit_samples = 0;
142 /* The protocol provides no way to read the current
143 * settings, so we'll enforce these. */
144 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
145 devc->alarm_low = DEFAULT_ALARM_LOW;
146 devc->alarm_high = DEFAULT_ALARM_HIGH;
147 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
148 devc->data_source = DEFAULT_DATA_SOURCE;
149 devc->config_dirty = FALSE;
151 /* TODO: Set date/time? */
153 drvc->instances = g_slist_append(drvc->instances, sdi);
154 devices = g_slist_append(devices, sdi);
156 g_slist_free(usb_devices);
158 g_slist_free_full(usb_devices, g_free);
163 static GSList *dev_list(const struct sr_dev_driver *di)
165 return ((struct drv_context *)(di->context))->instances;
168 static int dev_open(struct sr_dev_inst *sdi)
170 struct sr_dev_driver *di = sdi->driver;
171 struct drv_context *drvc;
172 struct sr_usb_dev_inst *usb;
175 if (!(drvc = di->context)) {
176 sr_err("Driver was not initialized.");
182 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
185 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
186 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
190 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
191 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
194 sdi->status = SR_ST_ACTIVE;
199 static int dev_close(struct sr_dev_inst *sdi)
201 struct sr_dev_driver *di = sdi->driver;
202 struct dev_context *devc;
203 struct sr_usb_dev_inst *usb;
206 sr_err("Driver was not initialized.");
216 /* This allows a frontend to configure the device without ever
217 * doing an acquisition step. */
219 if (!devc->config_dirty)
220 kecheng_kc_330b_configure(sdi);
222 libusb_release_interface(usb->devhdl, USB_INTERFACE);
223 libusb_close(usb->devhdl);
225 sdi->status = SR_ST_INACTIVE;
230 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
231 const struct sr_channel_group *cg)
233 struct dev_context *devc;
234 GVariant *rational[2];
241 case SR_CONF_LIMIT_SAMPLES:
242 *data = g_variant_new_uint64(devc->limit_samples);
244 case SR_CONF_SAMPLE_INTERVAL:
245 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
246 rational[0] = g_variant_new_uint64(si[0]);
247 rational[1] = g_variant_new_uint64(si[1]);
248 *data = g_variant_new_tuple(rational, 2);
250 case SR_CONF_DATALOG:
251 /* There really isn't a way to be sure the device is logging. */
254 case SR_CONF_SPL_WEIGHT_FREQ:
255 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
256 *data = g_variant_new_string("A");
258 *data = g_variant_new_string("C");
260 case SR_CONF_SPL_WEIGHT_TIME:
261 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
262 *data = g_variant_new_string("F");
264 *data = g_variant_new_string("S");
266 case SR_CONF_DATA_SOURCE:
267 if (devc->data_source == DATA_SOURCE_LIVE)
268 *data = g_variant_new_string("Live");
270 *data = g_variant_new_string("Memory");
279 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
280 const struct sr_channel_group *cg)
282 struct sr_dev_driver *di = sdi->driver;
283 struct dev_context *devc;
291 if (sdi->status != SR_ST_ACTIVE)
292 return SR_ERR_DEV_CLOSED;
295 sr_err("Driver was not initialized.");
302 case SR_CONF_LIMIT_SAMPLES:
303 devc->limit_samples = g_variant_get_uint64(data);
304 sr_dbg("Setting sample limit to %" PRIu64 ".",
305 devc->limit_samples);
307 case SR_CONF_SAMPLE_INTERVAL:
308 g_variant_get(data, "(tt)", &p, &q);
309 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
310 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
312 devc->sample_interval = i;
313 devc->config_dirty = TRUE;
316 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
319 case SR_CONF_SPL_WEIGHT_FREQ:
320 tmp_str = g_variant_get_string(data, NULL);
321 if (!strcmp(tmp_str, "A"))
322 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
323 else if (!strcmp(tmp_str, "C"))
324 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
327 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
328 devc->mqflags |= tmp;
329 devc->config_dirty = TRUE;
331 case SR_CONF_SPL_WEIGHT_TIME:
332 tmp_str = g_variant_get_string(data, NULL);
333 if (!strcmp(tmp_str, "F"))
334 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
335 else if (!strcmp(tmp_str, "S"))
336 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
339 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
340 devc->mqflags |= tmp;
341 devc->config_dirty = TRUE;
343 case SR_CONF_DATA_SOURCE:
344 tmp_str = g_variant_get_string(data, NULL);
345 if (!strcmp(tmp_str, "Live"))
346 devc->data_source = DATA_SOURCE_LIVE;
347 else if (!strcmp(tmp_str, "Memory"))
348 devc->data_source = DATA_SOURCE_MEMORY;
351 devc->config_dirty = TRUE;
360 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
361 const struct sr_channel_group *cg)
363 GVariant *tuple, *rational[2];
371 case SR_CONF_DEVICE_OPTIONS:
372 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
373 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
375 case SR_CONF_SAMPLE_INTERVAL:
376 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
377 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
378 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
379 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
380 tuple = g_variant_new_tuple(rational, 2);
381 g_variant_builder_add_value(&gvb, tuple);
383 *data = g_variant_builder_end(&gvb);
385 case SR_CONF_SPL_WEIGHT_FREQ:
386 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
388 case SR_CONF_SPL_WEIGHT_TIME:
389 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
391 case SR_CONF_DATA_SOURCE:
392 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
401 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
403 struct sr_dev_driver *di = sdi->driver;
404 struct drv_context *drvc;
405 struct dev_context *devc;
406 struct sr_datafeed_packet packet;
407 struct sr_datafeed_meta meta;
408 struct sr_config *src;
409 struct sr_usb_dev_inst *usb;
410 GVariant *gvar, *rational[2];
412 int req_len, buf_len, len, ret;
413 unsigned char buf[9];
415 if (sdi->status != SR_ST_ACTIVE)
416 return SR_ERR_DEV_CLOSED;
422 devc->num_samples = 0;
424 std_session_send_df_header(sdi, LOG_PREFIX);
426 if (devc->data_source == DATA_SOURCE_LIVE) {
427 /* Force configuration. */
428 kecheng_kc_330b_configure(sdi);
430 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
432 if (ret != DEVICE_ACTIVE) {
433 sr_err("Device is inactive");
434 /* Still continue though, since the device will
435 * just return 30.0 until the user hits the button
436 * on the device -- and then start feeding good
440 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
442 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
443 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
444 devc->stored_samples = (buf[7] << 8) | buf[8];
445 if (devc->stored_samples == 0) {
446 /* Notify frontend of empty log by sending start/end packets. */
447 std_session_send_df_end(sdi, LOG_PREFIX);
451 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
452 devc->stored_samples = devc->limit_samples;
454 si = kecheng_kc_330b_sample_intervals[buf[1]];
455 rational[0] = g_variant_new_uint64(si[0]);
456 rational[1] = g_variant_new_uint64(si[1]);
457 gvar = g_variant_new_tuple(rational, 2);
458 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
459 packet.type = SR_DF_META;
460 packet.payload = &meta;
461 meta.config = g_slist_append(NULL, src);
462 sr_session_send(sdi, &packet);
466 if (!(devc->xfer = libusb_alloc_transfer(0)))
469 usb_source_add(sdi->session, drvc->sr_ctx, 10,
470 kecheng_kc_330b_handle_events, (void *)sdi);
472 if (devc->data_source == DATA_SOURCE_LIVE) {
473 buf[0] = CMD_GET_LIVE_SPL;
475 devc->state = LIVE_SPL_WAIT;
476 devc->last_live_request = g_get_monotonic_time() / 1000;
479 buf[0] = CMD_GET_LOG_DATA;
483 devc->state = LOG_DATA_WAIT;
484 if (devc->stored_samples < 63)
485 buf[3] = devc->stored_samples;
488 /* Command ack byte + 2 bytes per sample. */
489 req_len = 1 + buf[3] * 2;
492 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
493 if (ret != 0 || len != 1) {
494 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
495 libusb_free_transfer(devc->xfer);
499 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
500 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
501 if (libusb_submit_transfer(devc->xfer) != 0) {
502 libusb_free_transfer(devc->xfer);
509 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
511 struct dev_context *devc;
513 if (sdi->status != SR_ST_ACTIVE)
514 return SR_ERR_DEV_CLOSED;
516 /* Signal USB transfer handler to clean up and stop. */
517 sdi->status = SR_ST_STOPPING;
520 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
521 /* The protocol doesn't have a command to clear stored data;
522 * it clears it whenever new configuration is set. That means
523 * we can't just configure the device any time we want when
524 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
525 * it is now, when we're sure we've pulled in all the stored
527 kecheng_kc_330b_configure(sdi);
533 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
534 .name = "kecheng-kc-330b",
535 .longname = "Kecheng KC-330B",
538 .cleanup = std_cleanup,
540 .dev_list = dev_list,
542 .config_get = config_get,
543 .config_set = config_set,
544 .config_list = config_list,
545 .dev_open = dev_open,
546 .dev_close = dev_close,
547 .dev_acquisition_start = dev_acquisition_start,
548 .dev_acquisition_stop = dev_acquisition_stop,