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 static int scan_kecheng(struct sr_dev_driver *di,
65 struct sr_usb_dev_inst *usb, char **model)
67 struct drv_context *drvc;
69 unsigned char cmd, buf[32];
72 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
76 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
78 libusb_close(usb->devhdl);
79 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
83 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
85 libusb_close(usb->devhdl);
86 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
90 libusb_close(usb->devhdl);
93 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
94 sr_dbg("Invalid response to Identify command");
98 buf[buf[1] + 2] = '\x0';
99 *model = g_strndup((const gchar *)buf + 2, 30);
104 static GSList *scan(struct sr_dev_driver *di, GSList *options)
106 struct drv_context *drvc;
107 struct dev_context *devc;
108 struct sr_dev_inst *sdi;
109 GSList *usb_devices, *devices, *l;
115 drvc->instances = NULL;
118 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
119 /* We have a list of sr_usb_dev_inst matching the connection
120 * string. Wrap them in sr_dev_inst and we're done. */
121 for (l = usb_devices; l; l = l->next) {
122 if (scan_kecheng(di, l->data, &model) != SR_OK)
124 sdi = g_malloc0(sizeof(struct sr_dev_inst));
125 sdi->status = SR_ST_INACTIVE;
126 sdi->vendor = g_strdup(VENDOR);
127 sdi->model = model; /* Already g_strndup()'d. */
129 sdi->inst_type = SR_INST_USB;
131 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
132 devc = g_malloc0(sizeof(struct dev_context));
134 devc->limit_samples = 0;
135 /* The protocol provides no way to read the current
136 * settings, so we'll enforce these. */
137 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
138 devc->alarm_low = DEFAULT_ALARM_LOW;
139 devc->alarm_high = DEFAULT_ALARM_HIGH;
140 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
141 devc->data_source = DEFAULT_DATA_SOURCE;
142 devc->config_dirty = FALSE;
144 /* TODO: Set date/time? */
146 drvc->instances = g_slist_append(drvc->instances, sdi);
147 devices = g_slist_append(devices, sdi);
149 g_slist_free(usb_devices);
151 g_slist_free_full(usb_devices, g_free);
156 static int dev_open(struct sr_dev_inst *sdi)
158 struct sr_dev_driver *di = sdi->driver;
159 struct drv_context *drvc = di->context;
160 struct sr_usb_dev_inst *usb;
165 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
168 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
169 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
173 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
174 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
177 sdi->status = SR_ST_ACTIVE;
182 static int dev_close(struct sr_dev_inst *sdi)
184 struct dev_context *devc;
185 struct sr_usb_dev_inst *usb;
193 /* This allows a frontend to configure the device without ever
194 * doing an acquisition step. */
196 if (!devc->config_dirty)
197 kecheng_kc_330b_configure(sdi);
199 libusb_release_interface(usb->devhdl, USB_INTERFACE);
200 libusb_close(usb->devhdl);
202 sdi->status = SR_ST_INACTIVE;
207 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
208 const struct sr_channel_group *cg)
210 struct dev_context *devc;
211 GVariant *rational[2];
218 case SR_CONF_LIMIT_SAMPLES:
219 *data = g_variant_new_uint64(devc->limit_samples);
221 case SR_CONF_SAMPLE_INTERVAL:
222 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
223 rational[0] = g_variant_new_uint64(si[0]);
224 rational[1] = g_variant_new_uint64(si[1]);
225 *data = g_variant_new_tuple(rational, 2);
227 case SR_CONF_DATALOG:
228 /* There really isn't a way to be sure the device is logging. */
231 case SR_CONF_SPL_WEIGHT_FREQ:
232 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
233 *data = g_variant_new_string("A");
235 *data = g_variant_new_string("C");
237 case SR_CONF_SPL_WEIGHT_TIME:
238 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
239 *data = g_variant_new_string("F");
241 *data = g_variant_new_string("S");
243 case SR_CONF_DATA_SOURCE:
244 if (devc->data_source == DATA_SOURCE_LIVE)
245 *data = g_variant_new_string("Live");
247 *data = g_variant_new_string("Memory");
256 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
257 const struct sr_channel_group *cg)
259 struct dev_context *devc;
267 if (sdi->status != SR_ST_ACTIVE)
268 return SR_ERR_DEV_CLOSED;
273 case SR_CONF_LIMIT_SAMPLES:
274 devc->limit_samples = g_variant_get_uint64(data);
275 sr_dbg("Setting sample limit to %" PRIu64 ".",
276 devc->limit_samples);
278 case SR_CONF_SAMPLE_INTERVAL:
279 g_variant_get(data, "(tt)", &p, &q);
280 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
281 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
283 devc->sample_interval = i;
284 devc->config_dirty = TRUE;
287 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
290 case SR_CONF_SPL_WEIGHT_FREQ:
291 tmp_str = g_variant_get_string(data, NULL);
292 if (!strcmp(tmp_str, "A"))
293 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
294 else if (!strcmp(tmp_str, "C"))
295 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
298 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
299 devc->mqflags |= tmp;
300 devc->config_dirty = TRUE;
302 case SR_CONF_SPL_WEIGHT_TIME:
303 tmp_str = g_variant_get_string(data, NULL);
304 if (!strcmp(tmp_str, "F"))
305 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
306 else if (!strcmp(tmp_str, "S"))
307 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
310 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
311 devc->mqflags |= tmp;
312 devc->config_dirty = TRUE;
314 case SR_CONF_DATA_SOURCE:
315 tmp_str = g_variant_get_string(data, NULL);
316 if (!strcmp(tmp_str, "Live"))
317 devc->data_source = DATA_SOURCE_LIVE;
318 else if (!strcmp(tmp_str, "Memory"))
319 devc->data_source = DATA_SOURCE_MEMORY;
322 devc->config_dirty = TRUE;
331 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
332 const struct sr_channel_group *cg)
334 GVariant *tuple, *rational[2];
342 case SR_CONF_DEVICE_OPTIONS:
343 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
344 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
346 case SR_CONF_SAMPLE_INTERVAL:
347 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
348 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
349 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
350 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
351 tuple = g_variant_new_tuple(rational, 2);
352 g_variant_builder_add_value(&gvb, tuple);
354 *data = g_variant_builder_end(&gvb);
356 case SR_CONF_SPL_WEIGHT_FREQ:
357 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
359 case SR_CONF_SPL_WEIGHT_TIME:
360 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
362 case SR_CONF_DATA_SOURCE:
363 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
372 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
374 struct sr_dev_driver *di = sdi->driver;
375 struct drv_context *drvc;
376 struct dev_context *devc;
377 struct sr_datafeed_packet packet;
378 struct sr_datafeed_meta meta;
379 struct sr_config *src;
380 struct sr_usb_dev_inst *usb;
381 GVariant *gvar, *rational[2];
383 int req_len, buf_len, len, ret;
384 unsigned char buf[9];
386 if (sdi->status != SR_ST_ACTIVE)
387 return SR_ERR_DEV_CLOSED;
393 devc->num_samples = 0;
395 std_session_send_df_header(sdi, LOG_PREFIX);
397 if (devc->data_source == DATA_SOURCE_LIVE) {
398 /* Force configuration. */
399 kecheng_kc_330b_configure(sdi);
401 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
403 if (ret != DEVICE_ACTIVE) {
404 sr_err("Device is inactive");
405 /* Still continue though, since the device will
406 * just return 30.0 until the user hits the button
407 * on the device -- and then start feeding good
411 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
413 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
414 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
415 devc->stored_samples = (buf[7] << 8) | buf[8];
416 if (devc->stored_samples == 0) {
417 /* Notify frontend of empty log by sending start/end packets. */
418 std_session_send_df_end(sdi, LOG_PREFIX);
422 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
423 devc->stored_samples = devc->limit_samples;
425 si = kecheng_kc_330b_sample_intervals[buf[1]];
426 rational[0] = g_variant_new_uint64(si[0]);
427 rational[1] = g_variant_new_uint64(si[1]);
428 gvar = g_variant_new_tuple(rational, 2);
429 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
430 packet.type = SR_DF_META;
431 packet.payload = &meta;
432 meta.config = g_slist_append(NULL, src);
433 sr_session_send(sdi, &packet);
437 if (!(devc->xfer = libusb_alloc_transfer(0)))
440 usb_source_add(sdi->session, drvc->sr_ctx, 10,
441 kecheng_kc_330b_handle_events, (void *)sdi);
443 if (devc->data_source == DATA_SOURCE_LIVE) {
444 buf[0] = CMD_GET_LIVE_SPL;
446 devc->state = LIVE_SPL_WAIT;
447 devc->last_live_request = g_get_monotonic_time() / 1000;
450 buf[0] = CMD_GET_LOG_DATA;
454 devc->state = LOG_DATA_WAIT;
455 if (devc->stored_samples < 63)
456 buf[3] = devc->stored_samples;
459 /* Command ack byte + 2 bytes per sample. */
460 req_len = 1 + buf[3] * 2;
463 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
464 if (ret != 0 || len != 1) {
465 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
466 libusb_free_transfer(devc->xfer);
470 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
471 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
472 if (libusb_submit_transfer(devc->xfer) != 0) {
473 libusb_free_transfer(devc->xfer);
480 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
482 struct dev_context *devc;
484 if (sdi->status != SR_ST_ACTIVE)
485 return SR_ERR_DEV_CLOSED;
487 /* Signal USB transfer handler to clean up and stop. */
488 sdi->status = SR_ST_STOPPING;
491 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
492 /* The protocol doesn't have a command to clear stored data;
493 * it clears it whenever new configuration is set. That means
494 * we can't just configure the device any time we want when
495 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
496 * it is now, when we're sure we've pulled in all the stored
498 kecheng_kc_330b_configure(sdi);
504 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
505 .name = "kecheng-kc-330b",
506 .longname = "Kecheng KC-330B",
509 .cleanup = std_cleanup,
511 .dev_list = std_dev_list,
513 .config_get = config_get,
514 .config_set = config_set,
515 .config_list = config_list,
516 .dev_open = dev_open,
517 .dev_close = dev_close,
518 .dev_acquisition_start = dev_acquisition_start,
519 .dev_acquisition_stop = dev_acquisition_stop,