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 uint32_t devopts[] = {
28 SR_CONF_SOUNDLEVELMETER,
30 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
31 SR_CONF_SAMPLE_INTERVAL | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
32 SR_CONF_DATALOG | SR_CONF_GET,
33 SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
34 SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
35 SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
48 static const char *weight_freq[] = {
53 static const char *weight_time[] = {
58 static const char *data_sources[] = {
63 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
64 static struct sr_dev_driver *di = &kecheng_kc_330b_driver_info;
67 static int init(struct sr_context *sr_ctx)
69 return std_init(sr_ctx, di, LOG_PREFIX);
72 static int scan_kecheng(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(GSList *options)
113 struct drv_context *drvc;
114 struct dev_context *devc;
115 struct sr_dev_inst *sdi;
116 struct sr_channel *ch;
117 GSList *usb_devices, *devices, *l;
123 drvc->instances = NULL;
126 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
127 /* We have a list of sr_usb_dev_inst matching the connection
128 * string. Wrap them in sr_dev_inst and we're done. */
129 for (l = usb_devices; l; l = l->next) {
130 if (scan_kecheng(l->data, &model) != SR_OK)
132 sdi = g_malloc0(sizeof(struct sr_dev_inst));
133 sdi->status = SR_ST_INACTIVE;
134 sdi->vendor = g_strdup(VENDOR);
135 sdi->model = model; /* Already g_strndup()'d. */
137 sdi->inst_type = SR_INST_USB;
139 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "SPL")))
141 sdi->channels = g_slist_append(sdi->channels, ch);
142 devc = g_malloc0(sizeof(struct dev_context));
144 devc->limit_samples = 0;
145 /* The protocol provides no way to read the current
146 * settings, so we'll enforce these. */
147 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
148 devc->alarm_low = DEFAULT_ALARM_LOW;
149 devc->alarm_high = DEFAULT_ALARM_HIGH;
150 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
151 devc->data_source = DEFAULT_DATA_SOURCE;
152 devc->config_dirty = FALSE;
154 /* TODO: Set date/time? */
156 drvc->instances = g_slist_append(drvc->instances, sdi);
157 devices = g_slist_append(devices, sdi);
159 g_slist_free(usb_devices);
161 g_slist_free_full(usb_devices, g_free);
166 static GSList *dev_list(void)
168 return ((struct drv_context *)(di->priv))->instances;
171 static int dev_open(struct sr_dev_inst *sdi)
173 struct drv_context *drvc;
174 struct sr_usb_dev_inst *usb;
177 if (!(drvc = di->priv)) {
178 sr_err("Driver was not initialized.");
184 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
187 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
188 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
192 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
193 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
196 sdi->status = SR_ST_ACTIVE;
201 static int dev_close(struct sr_dev_inst *sdi)
203 struct dev_context *devc;
204 struct sr_usb_dev_inst *usb;
207 sr_err("Driver was not initialized.");
217 /* This allows a frontend to configure the device without ever
218 * doing an acquisition step. */
220 if (!devc->config_dirty)
221 kecheng_kc_330b_configure(sdi);
223 libusb_release_interface(usb->devhdl, USB_INTERFACE);
224 libusb_close(usb->devhdl);
226 sdi->status = SR_ST_INACTIVE;
231 static int cleanup(void)
234 struct drv_context *drvc;
236 if (!(drvc = di->priv))
237 /* Can get called on an unused driver, doesn't matter. */
241 ret = std_dev_clear(di, NULL);
248 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
249 const struct sr_channel_group *cg)
251 struct dev_context *devc;
252 GVariant *rational[2];
259 case SR_CONF_LIMIT_SAMPLES:
260 *data = g_variant_new_uint64(devc->limit_samples);
262 case SR_CONF_SAMPLE_INTERVAL:
263 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
264 rational[0] = g_variant_new_uint64(si[0]);
265 rational[1] = g_variant_new_uint64(si[1]);
266 *data = g_variant_new_tuple(rational, 2);
268 case SR_CONF_DATALOG:
269 /* There really isn't a way to be sure the device is logging. */
272 case SR_CONF_SPL_WEIGHT_FREQ:
273 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
274 *data = g_variant_new_string("A");
276 *data = g_variant_new_string("C");
278 case SR_CONF_SPL_WEIGHT_TIME:
279 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
280 *data = g_variant_new_string("F");
282 *data = g_variant_new_string("S");
284 case SR_CONF_DATA_SOURCE:
285 if (devc->data_source == DATA_SOURCE_LIVE)
286 *data = g_variant_new_string("Live");
288 *data = g_variant_new_string("Memory");
297 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
298 const struct sr_channel_group *cg)
300 struct dev_context *devc;
308 if (sdi->status != SR_ST_ACTIVE)
309 return SR_ERR_DEV_CLOSED;
312 sr_err("Driver was not initialized.");
319 case SR_CONF_LIMIT_SAMPLES:
320 devc->limit_samples = g_variant_get_uint64(data);
321 sr_dbg("Setting sample limit to %" PRIu64 ".",
322 devc->limit_samples);
324 case SR_CONF_SAMPLE_INTERVAL:
325 g_variant_get(data, "(tt)", &p, &q);
326 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
327 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
329 devc->sample_interval = i;
330 devc->config_dirty = TRUE;
333 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
336 case SR_CONF_SPL_WEIGHT_FREQ:
337 tmp_str = g_variant_get_string(data, NULL);
338 if (!strcmp(tmp_str, "A"))
339 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
340 else if (!strcmp(tmp_str, "C"))
341 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
344 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
345 devc->mqflags |= tmp;
346 devc->config_dirty = TRUE;
348 case SR_CONF_SPL_WEIGHT_TIME:
349 tmp_str = g_variant_get_string(data, NULL);
350 if (!strcmp(tmp_str, "F"))
351 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
352 else if (!strcmp(tmp_str, "S"))
353 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
356 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
357 devc->mqflags |= tmp;
358 devc->config_dirty = TRUE;
360 case SR_CONF_DATA_SOURCE:
361 tmp_str = g_variant_get_string(data, NULL);
362 if (!strcmp(tmp_str, "Live"))
363 devc->data_source = DATA_SOURCE_LIVE;
364 else if (!strcmp(tmp_str, "Memory"))
365 devc->data_source = DATA_SOURCE_MEMORY;
368 devc->config_dirty = TRUE;
377 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
378 const struct sr_channel_group *cg)
380 GVariant *tuple, *rational[2];
388 case SR_CONF_DEVICE_OPTIONS:
389 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
390 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
392 case SR_CONF_SAMPLE_INTERVAL:
393 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
394 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
395 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
396 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
397 tuple = g_variant_new_tuple(rational, 2);
398 g_variant_builder_add_value(&gvb, tuple);
400 *data = g_variant_builder_end(&gvb);
402 case SR_CONF_SPL_WEIGHT_FREQ:
403 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
405 case SR_CONF_SPL_WEIGHT_TIME:
406 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
408 case SR_CONF_DATA_SOURCE:
409 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
418 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
421 struct drv_context *drvc;
422 struct dev_context *devc;
423 struct sr_datafeed_packet packet;
424 struct sr_datafeed_meta meta;
425 struct sr_config *src;
426 struct sr_usb_dev_inst *usb;
427 GVariant *gvar, *rational[2];
429 int req_len, buf_len, len, ret;
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 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
462 devc->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 usb_source_add(sdi->session, drvc->sr_ctx, 10,
490 kecheng_kc_330b_handle_events, (void *)sdi);
492 if (devc->data_source == DATA_SOURCE_LIVE) {
493 buf[0] = CMD_GET_LIVE_SPL;
495 devc->state = LIVE_SPL_WAIT;
496 devc->last_live_request = g_get_monotonic_time() / 1000;
499 buf[0] = CMD_GET_LOG_DATA;
503 devc->state = LOG_DATA_WAIT;
504 if (devc->stored_samples < 63)
505 buf[3] = devc->stored_samples;
508 /* Command ack byte + 2 bytes per sample. */
509 req_len = 1 + buf[3] * 2;
512 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
513 if (ret != 0 || len != 1) {
514 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
515 libusb_free_transfer(devc->xfer);
519 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
520 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
521 if (libusb_submit_transfer(devc->xfer) != 0) {
522 libusb_free_transfer(devc->xfer);
529 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
531 struct dev_context *devc;
535 if (sdi->status != SR_ST_ACTIVE)
536 return SR_ERR_DEV_CLOSED;
538 /* Signal USB transfer handler to clean up and stop. */
539 sdi->status = SR_ST_STOPPING;
542 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
543 /* The protocol doesn't have a command to clear stored data;
544 * it clears it whenever new configuration is set. That means
545 * we can't just configure the device any time we want when
546 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
547 * it is now, when we're sure we've pulled in all the stored
549 kecheng_kc_330b_configure(sdi);
555 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
556 .name = "kecheng-kc-330b",
557 .longname = "Kecheng KC-330B",
562 .dev_list = dev_list,
564 .config_get = config_get,
565 .config_set = config_set,
566 .config_list = config_list,
567 .dev_open = dev_open,
568 .dev_close = dev_close,
569 .dev_acquisition_start = dev_acquisition_start,
570 .dev_acquisition_stop = dev_acquisition_stop,