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_channel *ch;
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 (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "SPL")))
140 sdi->channels = g_slist_append(sdi->channels, ch);
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_open(struct sr_dev_inst *sdi)
176 struct drv_context *drvc;
177 struct sr_usb_dev_inst *usb;
180 if (!(drvc = di->priv)) {
181 sr_err("Driver was not initialized.");
187 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
190 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
191 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
195 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
196 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
199 sdi->status = SR_ST_ACTIVE;
204 static int dev_close(struct sr_dev_inst *sdi)
206 struct dev_context *devc;
207 struct sr_usb_dev_inst *usb;
210 sr_err("Driver was not initialized.");
220 /* This allows a frontend to configure the device without ever
221 * doing an acquisition step. */
223 if (!devc->config_dirty)
224 kecheng_kc_330b_configure(sdi);
226 libusb_release_interface(usb->devhdl, USB_INTERFACE);
227 libusb_close(usb->devhdl);
229 sdi->status = SR_ST_INACTIVE;
234 static int cleanup(void)
237 struct drv_context *drvc;
239 if (!(drvc = di->priv))
240 /* Can get called on an unused driver, doesn't matter. */
244 ret = std_dev_clear(di, NULL);
251 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
252 const struct sr_channel_group *cg)
254 struct dev_context *devc;
255 GVariant *rational[2];
262 case SR_CONF_LIMIT_SAMPLES:
263 *data = g_variant_new_uint64(devc->limit_samples);
265 case SR_CONF_SAMPLE_INTERVAL:
266 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
267 rational[0] = g_variant_new_uint64(si[0]);
268 rational[1] = g_variant_new_uint64(si[1]);
269 *data = g_variant_new_tuple(rational, 2);
271 case SR_CONF_DATALOG:
272 /* There really isn't a way to be sure the device is logging. */
275 case SR_CONF_SPL_WEIGHT_FREQ:
276 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
277 *data = g_variant_new_string("A");
279 *data = g_variant_new_string("C");
281 case SR_CONF_SPL_WEIGHT_TIME:
282 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
283 *data = g_variant_new_string("F");
285 *data = g_variant_new_string("S");
287 case SR_CONF_DATA_SOURCE:
288 if (devc->data_source == DATA_SOURCE_LIVE)
289 *data = g_variant_new_string("Live");
291 *data = g_variant_new_string("Memory");
300 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
301 const struct sr_channel_group *cg)
303 struct dev_context *devc;
311 if (sdi->status != SR_ST_ACTIVE)
312 return SR_ERR_DEV_CLOSED;
315 sr_err("Driver was not initialized.");
322 case SR_CONF_LIMIT_SAMPLES:
323 devc->limit_samples = g_variant_get_uint64(data);
324 sr_dbg("Setting sample limit to %" PRIu64 ".",
325 devc->limit_samples);
327 case SR_CONF_SAMPLE_INTERVAL:
328 g_variant_get(data, "(tt)", &p, &q);
329 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
330 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
332 devc->sample_interval = i;
333 devc->config_dirty = TRUE;
336 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
339 case SR_CONF_SPL_WEIGHT_FREQ:
340 tmp_str = g_variant_get_string(data, NULL);
341 if (!strcmp(tmp_str, "A"))
342 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
343 else if (!strcmp(tmp_str, "C"))
344 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
347 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
348 devc->mqflags |= tmp;
349 devc->config_dirty = TRUE;
351 case SR_CONF_SPL_WEIGHT_TIME:
352 tmp_str = g_variant_get_string(data, NULL);
353 if (!strcmp(tmp_str, "F"))
354 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
355 else if (!strcmp(tmp_str, "S"))
356 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
359 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
360 devc->mqflags |= tmp;
361 devc->config_dirty = TRUE;
363 case SR_CONF_DATA_SOURCE:
364 tmp_str = g_variant_get_string(data, NULL);
365 if (!strcmp(tmp_str, "Live"))
366 devc->data_source = DATA_SOURCE_LIVE;
367 else if (!strcmp(tmp_str, "Memory"))
368 devc->data_source = DATA_SOURCE_MEMORY;
371 devc->config_dirty = TRUE;
380 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
381 const struct sr_channel_group *cg)
383 GVariant *tuple, *rational[2];
391 case SR_CONF_DEVICE_OPTIONS:
392 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
393 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
395 case SR_CONF_SAMPLE_INTERVAL:
396 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
397 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
398 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
399 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
400 tuple = g_variant_new_tuple(rational, 2);
401 g_variant_builder_add_value(&gvb, tuple);
403 *data = g_variant_builder_end(&gvb);
405 case SR_CONF_SPL_WEIGHT_FREQ:
406 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
408 case SR_CONF_SPL_WEIGHT_TIME:
409 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
411 case SR_CONF_DATA_SOURCE:
412 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
421 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
424 struct drv_context *drvc;
425 struct dev_context *devc;
426 struct sr_datafeed_packet packet;
427 struct sr_datafeed_meta meta;
428 struct sr_config *src;
429 struct sr_usb_dev_inst *usb;
430 GVariant *gvar, *rational[2];
432 int stored_mqflags, req_len, buf_len, len, ret;
433 unsigned char buf[9];
435 if (sdi->status != SR_ST_ACTIVE)
436 return SR_ERR_DEV_CLOSED;
442 devc->cb_data = cb_data;
443 devc->num_samples = 0;
445 /* Send header packet to the session bus. */
446 std_session_send_df_header(cb_data, LOG_PREFIX);
448 if (devc->data_source == DATA_SOURCE_LIVE) {
449 /* Force configuration. */
450 kecheng_kc_330b_configure(sdi);
452 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
454 if (ret != DEVICE_ACTIVE) {
455 sr_err("Device is inactive");
456 /* Still continue though, since the device will
457 * just return 30.0 until the user hits the button
458 * on the device -- and then start feeding good
462 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
464 stored_mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
465 stored_mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
466 devc->stored_samples = (buf[7] << 8) | buf[8];
467 if (devc->stored_samples == 0) {
468 /* Notify frontend of empty log by sending start/end packets. */
469 packet.type = SR_DF_END;
470 sr_session_send(cb_data, &packet);
474 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
475 devc->stored_samples = devc->limit_samples;
477 si = kecheng_kc_330b_sample_intervals[buf[1]];
478 rational[0] = g_variant_new_uint64(si[0]);
479 rational[1] = g_variant_new_uint64(si[1]);
480 gvar = g_variant_new_tuple(rational, 2);
481 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
482 packet.type = SR_DF_META;
483 packet.payload = &meta;
484 meta.config = g_slist_append(NULL, src);
485 sr_session_send(devc->cb_data, &packet);
489 if (!(devc->xfer = libusb_alloc_transfer(0)))
492 usb_source_add(sdi->session, drvc->sr_ctx, 10,
493 kecheng_kc_330b_handle_events, (void *)sdi);
495 if (devc->data_source == DATA_SOURCE_LIVE) {
496 buf[0] = CMD_GET_LIVE_SPL;
498 devc->state = LIVE_SPL_WAIT;
499 devc->last_live_request = g_get_monotonic_time() / 1000;
502 buf[0] = CMD_GET_LOG_DATA;
506 devc->state = LOG_DATA_WAIT;
507 if (devc->stored_samples < 63)
508 buf[3] = devc->stored_samples;
511 /* Command ack byte + 2 bytes per sample. */
512 req_len = 1 + buf[3] * 2;
515 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
516 if (ret != 0 || len != 1) {
517 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
518 libusb_free_transfer(devc->xfer);
522 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
523 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
524 if (libusb_submit_transfer(devc->xfer) != 0) {
525 libusb_free_transfer(devc->xfer);
532 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
534 struct dev_context *devc;
538 if (sdi->status != SR_ST_ACTIVE)
539 return SR_ERR_DEV_CLOSED;
541 /* Signal USB transfer handler to clean up and stop. */
542 sdi->status = SR_ST_STOPPING;
545 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
546 /* The protocol doesn't have a command to clear stored data;
547 * it clears it whenever new configuration is set. That means
548 * we can't just configure the device any time we want when
549 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
550 * it is now, when we're sure we've pulled in all the stored
552 kecheng_kc_330b_configure(sdi);
558 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
559 .name = "kecheng-kc-330b",
560 .longname = "Kecheng KC-330B",
565 .dev_list = dev_list,
567 .config_get = config_get,
568 .config_set = config_set,
569 .config_list = config_list,
570 .dev_open = dev_open,
571 .dev_close = dev_close,
572 .dev_acquisition_start = dev_acquisition_start,
573 .dev_acquisition_stop = dev_acquisition_stop,