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;
65 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
67 return std_init(sr_ctx, di, LOG_PREFIX);
70 static int scan_kecheng(struct sr_dev_driver *di,
71 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(struct sr_dev_driver *di, GSList *options)
112 struct drv_context *drvc;
113 struct dev_context *devc;
114 struct sr_dev_inst *sdi;
115 GSList *usb_devices, *devices, *l;
121 drvc->instances = NULL;
124 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
125 /* We have a list of sr_usb_dev_inst matching the connection
126 * string. Wrap them in sr_dev_inst and we're done. */
127 for (l = usb_devices; l; l = l->next) {
128 if (scan_kecheng(di, l->data, &model) != SR_OK)
130 sdi = g_malloc0(sizeof(struct sr_dev_inst));
131 sdi->status = SR_ST_INACTIVE;
132 sdi->vendor = g_strdup(VENDOR);
133 sdi->model = model; /* Already g_strndup()'d. */
135 sdi->inst_type = SR_INST_USB;
137 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
138 devc = g_malloc0(sizeof(struct dev_context));
140 devc->limit_samples = 0;
141 /* The protocol provides no way to read the current
142 * settings, so we'll enforce these. */
143 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
144 devc->alarm_low = DEFAULT_ALARM_LOW;
145 devc->alarm_high = DEFAULT_ALARM_HIGH;
146 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
147 devc->data_source = DEFAULT_DATA_SOURCE;
148 devc->config_dirty = FALSE;
150 /* TODO: Set date/time? */
152 drvc->instances = g_slist_append(drvc->instances, sdi);
153 devices = g_slist_append(devices, sdi);
155 g_slist_free(usb_devices);
157 g_slist_free_full(usb_devices, g_free);
162 static GSList *dev_list(const struct sr_dev_driver *di)
164 return ((struct drv_context *)(di->priv))->instances;
167 static int dev_open(struct sr_dev_inst *sdi)
169 struct sr_dev_driver *di = sdi->driver;
170 struct drv_context *drvc;
171 struct sr_usb_dev_inst *usb;
174 if (!(drvc = di->priv)) {
175 sr_err("Driver was not initialized.");
181 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
184 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
185 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
189 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
190 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
193 sdi->status = SR_ST_ACTIVE;
198 static int dev_close(struct sr_dev_inst *sdi)
200 struct sr_dev_driver *di = sdi->driver;
201 struct dev_context *devc;
202 struct sr_usb_dev_inst *usb;
205 sr_err("Driver was not initialized.");
215 /* This allows a frontend to configure the device without ever
216 * doing an acquisition step. */
218 if (!devc->config_dirty)
219 kecheng_kc_330b_configure(sdi);
221 libusb_release_interface(usb->devhdl, USB_INTERFACE);
222 libusb_close(usb->devhdl);
224 sdi->status = SR_ST_INACTIVE;
229 static int cleanup(const struct sr_dev_driver *di)
232 struct drv_context *drvc;
234 if (!(drvc = di->priv))
235 /* Can get called on an unused driver, doesn't matter. */
238 ret = std_dev_clear(di, NULL);
244 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
245 const struct sr_channel_group *cg)
247 struct dev_context *devc;
248 GVariant *rational[2];
255 case SR_CONF_LIMIT_SAMPLES:
256 *data = g_variant_new_uint64(devc->limit_samples);
258 case SR_CONF_SAMPLE_INTERVAL:
259 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
260 rational[0] = g_variant_new_uint64(si[0]);
261 rational[1] = g_variant_new_uint64(si[1]);
262 *data = g_variant_new_tuple(rational, 2);
264 case SR_CONF_DATALOG:
265 /* There really isn't a way to be sure the device is logging. */
268 case SR_CONF_SPL_WEIGHT_FREQ:
269 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
270 *data = g_variant_new_string("A");
272 *data = g_variant_new_string("C");
274 case SR_CONF_SPL_WEIGHT_TIME:
275 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
276 *data = g_variant_new_string("F");
278 *data = g_variant_new_string("S");
280 case SR_CONF_DATA_SOURCE:
281 if (devc->data_source == DATA_SOURCE_LIVE)
282 *data = g_variant_new_string("Live");
284 *data = g_variant_new_string("Memory");
293 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
294 const struct sr_channel_group *cg)
296 struct sr_dev_driver *di = sdi->driver;
297 struct dev_context *devc;
305 if (sdi->status != SR_ST_ACTIVE)
306 return SR_ERR_DEV_CLOSED;
309 sr_err("Driver was not initialized.");
316 case SR_CONF_LIMIT_SAMPLES:
317 devc->limit_samples = g_variant_get_uint64(data);
318 sr_dbg("Setting sample limit to %" PRIu64 ".",
319 devc->limit_samples);
321 case SR_CONF_SAMPLE_INTERVAL:
322 g_variant_get(data, "(tt)", &p, &q);
323 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
324 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
326 devc->sample_interval = i;
327 devc->config_dirty = TRUE;
330 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
333 case SR_CONF_SPL_WEIGHT_FREQ:
334 tmp_str = g_variant_get_string(data, NULL);
335 if (!strcmp(tmp_str, "A"))
336 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
337 else if (!strcmp(tmp_str, "C"))
338 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
341 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
342 devc->mqflags |= tmp;
343 devc->config_dirty = TRUE;
345 case SR_CONF_SPL_WEIGHT_TIME:
346 tmp_str = g_variant_get_string(data, NULL);
347 if (!strcmp(tmp_str, "F"))
348 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
349 else if (!strcmp(tmp_str, "S"))
350 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
353 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
354 devc->mqflags |= tmp;
355 devc->config_dirty = TRUE;
357 case SR_CONF_DATA_SOURCE:
358 tmp_str = g_variant_get_string(data, NULL);
359 if (!strcmp(tmp_str, "Live"))
360 devc->data_source = DATA_SOURCE_LIVE;
361 else if (!strcmp(tmp_str, "Memory"))
362 devc->data_source = DATA_SOURCE_MEMORY;
365 devc->config_dirty = TRUE;
374 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
375 const struct sr_channel_group *cg)
377 GVariant *tuple, *rational[2];
385 case SR_CONF_DEVICE_OPTIONS:
386 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
387 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
389 case SR_CONF_SAMPLE_INTERVAL:
390 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
391 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
392 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
393 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
394 tuple = g_variant_new_tuple(rational, 2);
395 g_variant_builder_add_value(&gvb, tuple);
397 *data = g_variant_builder_end(&gvb);
399 case SR_CONF_SPL_WEIGHT_FREQ:
400 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
402 case SR_CONF_SPL_WEIGHT_TIME:
403 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
405 case SR_CONF_DATA_SOURCE:
406 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
415 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
418 struct sr_dev_driver *di = sdi->driver;
419 struct drv_context *drvc;
420 struct dev_context *devc;
421 struct sr_datafeed_packet packet;
422 struct sr_datafeed_meta meta;
423 struct sr_config *src;
424 struct sr_usb_dev_inst *usb;
425 GVariant *gvar, *rational[2];
427 int req_len, buf_len, len, ret;
428 unsigned char buf[9];
430 if (sdi->status != SR_ST_ACTIVE)
431 return SR_ERR_DEV_CLOSED;
437 devc->cb_data = cb_data;
438 devc->num_samples = 0;
440 /* Send header packet to the session bus. */
441 std_session_send_df_header(cb_data, LOG_PREFIX);
443 if (devc->data_source == DATA_SOURCE_LIVE) {
444 /* Force configuration. */
445 kecheng_kc_330b_configure(sdi);
447 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
449 if (ret != DEVICE_ACTIVE) {
450 sr_err("Device is inactive");
451 /* Still continue though, since the device will
452 * just return 30.0 until the user hits the button
453 * on the device -- and then start feeding good
457 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
459 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
460 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
461 devc->stored_samples = (buf[7] << 8) | buf[8];
462 if (devc->stored_samples == 0) {
463 /* Notify frontend of empty log by sending start/end packets. */
464 packet.type = SR_DF_END;
465 sr_session_send(cb_data, &packet);
469 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
470 devc->stored_samples = devc->limit_samples;
472 si = kecheng_kc_330b_sample_intervals[buf[1]];
473 rational[0] = g_variant_new_uint64(si[0]);
474 rational[1] = g_variant_new_uint64(si[1]);
475 gvar = g_variant_new_tuple(rational, 2);
476 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
477 packet.type = SR_DF_META;
478 packet.payload = &meta;
479 meta.config = g_slist_append(NULL, src);
480 sr_session_send(devc->cb_data, &packet);
484 if (!(devc->xfer = libusb_alloc_transfer(0)))
487 usb_source_add(sdi->session, drvc->sr_ctx, 10,
488 kecheng_kc_330b_handle_events, (void *)sdi);
490 if (devc->data_source == DATA_SOURCE_LIVE) {
491 buf[0] = CMD_GET_LIVE_SPL;
493 devc->state = LIVE_SPL_WAIT;
494 devc->last_live_request = g_get_monotonic_time() / 1000;
497 buf[0] = CMD_GET_LOG_DATA;
501 devc->state = LOG_DATA_WAIT;
502 if (devc->stored_samples < 63)
503 buf[3] = devc->stored_samples;
506 /* Command ack byte + 2 bytes per sample. */
507 req_len = 1 + buf[3] * 2;
510 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
511 if (ret != 0 || len != 1) {
512 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
513 libusb_free_transfer(devc->xfer);
517 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
518 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
519 if (libusb_submit_transfer(devc->xfer) != 0) {
520 libusb_free_transfer(devc->xfer);
527 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
529 struct dev_context *devc;
533 if (sdi->status != SR_ST_ACTIVE)
534 return SR_ERR_DEV_CLOSED;
536 /* Signal USB transfer handler to clean up and stop. */
537 sdi->status = SR_ST_STOPPING;
540 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
541 /* The protocol doesn't have a command to clear stored data;
542 * it clears it whenever new configuration is set. That means
543 * we can't just configure the device any time we want when
544 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
545 * it is now, when we're sure we've pulled in all the stored
547 kecheng_kc_330b_configure(sdi);
553 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
554 .name = "kecheng-kc-330b",
555 .longname = "Kecheng KC-330B",
560 .dev_list = dev_list,
562 .config_get = config_get,
563 .config_set = config_set,
564 .config_list = config_list,
565 .dev_open = dev_open,
566 .dev_close = dev_close,
567 .dev_acquisition_start = dev_acquisition_start,
568 .dev_acquisition_stop = dev_acquisition_stop,