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/>.
23 #define USB_CONN "1041.8101"
24 #define VENDOR "Kecheng"
25 #define USB_INTERFACE 0
27 static const int32_t hwcaps[] = {
28 SR_CONF_SOUNDLEVELMETER,
29 SR_CONF_LIMIT_SAMPLES,
32 SR_CONF_SPL_WEIGHT_FREQ,
33 SR_CONF_SPL_WEIGHT_TIME,
37 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
47 static const char *weight_freq[] = {
52 static const char *weight_time[] = {
57 static const char *data_sources[] = {
62 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
63 static struct sr_dev_driver *di = &kecheng_kc_330b_driver_info;
66 static int init(struct sr_context *sr_ctx)
68 return std_init(sr_ctx, di, LOG_PREFIX);
71 static int scan_kecheng(struct sr_usb_dev_inst *usb, char **model)
73 struct drv_context *drvc;
75 unsigned char cmd, buf[32];
78 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
82 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
84 libusb_close(usb->devhdl);
85 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
89 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
91 libusb_close(usb->devhdl);
92 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
96 libusb_close(usb->devhdl);
99 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
100 sr_dbg("Invalid response to Identify command");
104 buf[buf[1] + 2] = '\x0';
105 *model = g_strndup((const gchar *)buf + 2, 30);
110 static GSList *scan(GSList *options)
112 struct drv_context *drvc;
113 struct dev_context *devc;
114 struct sr_dev_inst *sdi;
115 struct sr_probe *probe;
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(l->data, &model) != SR_OK)
131 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR,
136 sdi->inst_type = SR_INST_USB;
138 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "SPL")))
140 sdi->probes = g_slist_append(sdi->probes, probe);
142 if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
143 sr_dbg("Device context malloc failed.");
147 devc->limit_samples = 0;
148 /* The protocol provides no way to read the current
149 * settings, so we'll enforce these. */
150 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
151 devc->alarm_low = DEFAULT_ALARM_LOW;
152 devc->alarm_high = DEFAULT_ALARM_HIGH;
153 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
154 devc->data_source = DEFAULT_DATA_SOURCE;
155 devc->config_dirty = FALSE;
157 /* TODO: Set date/time? */
159 drvc->instances = g_slist_append(drvc->instances, sdi);
160 devices = g_slist_append(devices, sdi);
162 g_slist_free(usb_devices);
164 g_slist_free_full(usb_devices, g_free);
169 static GSList *dev_list(void)
171 return ((struct drv_context *)(di->priv))->instances;
174 static int dev_clear(void)
176 return std_dev_clear(di, NULL);
179 static int dev_open(struct sr_dev_inst *sdi)
181 struct drv_context *drvc;
182 struct sr_usb_dev_inst *usb;
185 if (!(drvc = di->priv)) {
186 sr_err("Driver was not initialized.");
192 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
195 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
196 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
200 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
201 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
204 sdi->status = SR_ST_ACTIVE;
209 static int dev_close(struct sr_dev_inst *sdi)
211 struct dev_context *devc;
212 struct sr_usb_dev_inst *usb;
215 sr_err("Driver was not initialized.");
225 /* This allows a frontend to configure the device without ever
226 * doing an acquisition step. */
228 if (!devc->config_dirty)
229 kecheng_kc_330b_configure(sdi);
231 libusb_release_interface(usb->devhdl, USB_INTERFACE);
232 libusb_close(usb->devhdl);
234 sdi->status = SR_ST_INACTIVE;
239 static int cleanup(void)
242 struct drv_context *drvc;
244 if (!(drvc = di->priv))
245 /* Can get called on an unused driver, doesn't matter. */
255 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
257 struct dev_context *devc;
258 GVariant *rational[2];
263 case SR_CONF_LIMIT_SAMPLES:
264 *data = g_variant_new_uint64(devc->limit_samples);
266 case SR_CONF_SAMPLE_INTERVAL:
267 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
268 rational[0] = g_variant_new_uint64(si[0]);
269 rational[1] = g_variant_new_uint64(si[1]);
270 *data = g_variant_new_tuple(rational, 2);
272 case SR_CONF_DATALOG:
273 /* There really isn't a way to be sure the device is logging. */
276 case SR_CONF_SPL_WEIGHT_FREQ:
277 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
278 *data = g_variant_new_string("A");
280 *data = g_variant_new_string("C");
282 case SR_CONF_SPL_WEIGHT_TIME:
283 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
284 *data = g_variant_new_string("F");
286 *data = g_variant_new_string("S");
288 case SR_CONF_DATA_SOURCE:
289 if (devc->data_source == DATA_SOURCE_LIVE)
290 *data = g_variant_new_string("Live");
292 *data = g_variant_new_string("Memory");
301 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
303 struct dev_context *devc;
309 if (sdi->status != SR_ST_ACTIVE)
310 return SR_ERR_DEV_CLOSED;
313 sr_err("Driver was not initialized.");
320 case SR_CONF_LIMIT_SAMPLES:
321 devc->limit_samples = g_variant_get_uint64(data);
322 sr_dbg("Setting sample limit to %" PRIu64 ".",
323 devc->limit_samples);
325 case SR_CONF_SAMPLE_INTERVAL:
326 g_variant_get(data, "(tt)", &p, &q);
327 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
328 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
330 devc->sample_interval = i;
331 devc->config_dirty = TRUE;
334 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
337 case SR_CONF_SPL_WEIGHT_FREQ:
338 tmp_str = g_variant_get_string(data, NULL);
339 if (!strcmp(tmp_str, "A"))
340 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
341 else if (!strcmp(tmp_str, "C"))
342 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
345 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
346 devc->mqflags |= tmp;
347 devc->config_dirty = TRUE;
349 case SR_CONF_SPL_WEIGHT_TIME:
350 tmp_str = g_variant_get_string(data, NULL);
351 if (!strcmp(tmp_str, "F"))
352 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
353 else if (!strcmp(tmp_str, "S"))
354 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
357 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
358 devc->mqflags |= tmp;
359 devc->config_dirty = TRUE;
361 case SR_CONF_DATA_SOURCE:
362 tmp_str = g_variant_get_string(data, NULL);
363 if (!strcmp(tmp_str, "Live"))
364 devc->data_source = DATA_SOURCE_LIVE;
365 else if (!strcmp(tmp_str, "Memory"))
366 devc->data_source = DATA_SOURCE_MEMORY;
369 devc->config_dirty = TRUE;
378 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
380 GVariant *tuple, *rational[2];
387 case SR_CONF_DEVICE_OPTIONS:
388 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
389 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
391 case SR_CONF_SAMPLE_INTERVAL:
392 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
393 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
394 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
395 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
396 tuple = g_variant_new_tuple(rational, 2);
397 g_variant_builder_add_value(&gvb, tuple);
399 *data = g_variant_builder_end(&gvb);
401 case SR_CONF_SPL_WEIGHT_FREQ:
402 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
404 case SR_CONF_SPL_WEIGHT_TIME:
405 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
407 case SR_CONF_DATA_SOURCE:
408 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
417 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
420 struct drv_context *drvc;
421 struct dev_context *devc;
422 struct sr_datafeed_packet packet;
423 struct sr_datafeed_meta meta;
424 struct sr_config *src;
425 struct sr_usb_dev_inst *usb;
426 GVariant *gvar, *rational[2];
427 const struct libusb_pollfd **pfd;
429 int stored_mqflags, req_len, buf_len, len, ret, i;
430 unsigned char buf[9];
432 if (sdi->status != SR_ST_ACTIVE)
433 return SR_ERR_DEV_CLOSED;
439 devc->cb_data = cb_data;
440 devc->num_samples = 0;
442 /* Send header packet to the session bus. */
443 std_session_send_df_header(cb_data, LOG_PREFIX);
445 if (devc->data_source == DATA_SOURCE_LIVE) {
446 /* Force configuration. */
447 kecheng_kc_330b_configure(sdi);
449 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
451 if (ret != DEVICE_ACTIVE) {
452 sr_err("Device is inactive");
453 /* Still continue though, since the device will
454 * just return 30.0 until the user hits the button
455 * on the device -- and then start feeding good
459 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
461 stored_mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
462 stored_mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
463 devc->stored_samples = (buf[7] << 8) | buf[8];
464 if (devc->stored_samples == 0) {
465 /* Notify frontend of empty log by sending start/end packets. */
466 packet.type = SR_DF_END;
467 sr_session_send(cb_data, &packet);
471 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
472 devc->stored_samples = devc->limit_samples;
474 si = kecheng_kc_330b_sample_intervals[buf[1]];
475 rational[0] = g_variant_new_uint64(si[0]);
476 rational[1] = g_variant_new_uint64(si[1]);
477 gvar = g_variant_new_tuple(rational, 2);
478 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
479 packet.type = SR_DF_META;
480 packet.payload = &meta;
481 meta.config = g_slist_append(NULL, src);
482 sr_session_send(devc->cb_data, &packet);
486 if (!(devc->xfer = libusb_alloc_transfer(0)))
489 pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
490 for (i = 0; pfd[i]; i++) {
491 /* Handle USB events every 10ms. */
492 sr_source_add(pfd[i]->fd, pfd[i]->events, 10,
493 kecheng_kc_330b_handle_events, (void *)sdi);
494 /* We'll need to remove this fd later. */
495 devc->usbfd[i] = pfd[i]->fd;
499 if (devc->data_source == DATA_SOURCE_LIVE) {
500 buf[0] = CMD_GET_LIVE_SPL;
502 devc->state = LIVE_SPL_WAIT;
503 devc->last_live_request = g_get_monotonic_time() / 1000;
506 buf[0] = CMD_GET_LOG_DATA;
510 devc->state = LOG_DATA_WAIT;
511 if (devc->stored_samples < 63)
512 buf[3] = devc->stored_samples;
515 /* Command ack byte + 2 bytes per sample. */
516 req_len = 1 + buf[3] * 2;
519 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
520 if (ret != 0 || len != 1) {
521 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
522 libusb_free_transfer(devc->xfer);
526 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
527 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
528 if (libusb_submit_transfer(devc->xfer) != 0) {
529 libusb_free_transfer(devc->xfer);
536 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
538 struct dev_context *devc;
542 if (sdi->status != SR_ST_ACTIVE)
543 return SR_ERR_DEV_CLOSED;
545 /* Signal USB transfer handler to clean up and stop. */
546 sdi->status = SR_ST_STOPPING;
549 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
550 /* The protocol doesn't have a command to clear stored data;
551 * it clears it whenever new configuration is set. That means
552 * we can't just configure the device any time we want when
553 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
554 * it is now, when we're sure we've pulled in all the stored
556 kecheng_kc_330b_configure(sdi);
562 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
563 .name = "kecheng-kc-330b",
564 .longname = "Kecheng KC-330B",
569 .dev_list = dev_list,
570 .dev_clear = dev_clear,
571 .config_get = config_get,
572 .config_set = config_set,
573 .config_list = config_list,
574 .dev_open = dev_open,
575 .dev_close = dev_close,
576 .dev_acquisition_start = dev_acquisition_start,
577 .dev_acquisition_stop = dev_acquisition_stop,