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;
117 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
118 /* We have a list of sr_usb_dev_inst matching the connection
119 * string. Wrap them in sr_dev_inst and we're done. */
120 for (l = usb_devices; l; l = l->next) {
121 if (scan_kecheng(di, l->data, &model) != SR_OK)
123 sdi = g_malloc0(sizeof(struct sr_dev_inst));
124 sdi->status = SR_ST_INACTIVE;
125 sdi->vendor = g_strdup(VENDOR);
126 sdi->model = model; /* Already g_strndup()'d. */
128 sdi->inst_type = SR_INST_USB;
130 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
131 devc = g_malloc0(sizeof(struct dev_context));
133 devc->limit_samples = 0;
134 /* The protocol provides no way to read the current
135 * settings, so we'll enforce these. */
136 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
137 devc->alarm_low = DEFAULT_ALARM_LOW;
138 devc->alarm_high = DEFAULT_ALARM_HIGH;
139 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
140 devc->data_source = DEFAULT_DATA_SOURCE;
141 devc->config_dirty = FALSE;
143 /* TODO: Set date/time? */
145 drvc->instances = g_slist_append(drvc->instances, sdi);
146 devices = g_slist_append(devices, sdi);
148 g_slist_free(usb_devices);
150 g_slist_free_full(usb_devices, g_free);
155 static int dev_open(struct sr_dev_inst *sdi)
157 struct sr_dev_driver *di = sdi->driver;
158 struct drv_context *drvc = di->context;
159 struct sr_usb_dev_inst *usb;
164 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
167 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
168 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
172 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
173 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
176 sdi->status = SR_ST_ACTIVE;
181 static int dev_close(struct sr_dev_inst *sdi)
183 struct dev_context *devc;
184 struct sr_usb_dev_inst *usb;
192 /* This allows a frontend to configure the device without ever
193 * doing an acquisition step. */
195 if (!devc->config_dirty)
196 kecheng_kc_330b_configure(sdi);
198 libusb_release_interface(usb->devhdl, USB_INTERFACE);
199 libusb_close(usb->devhdl);
201 sdi->status = SR_ST_INACTIVE;
206 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
207 const struct sr_channel_group *cg)
209 struct dev_context *devc;
210 GVariant *rational[2];
217 case SR_CONF_LIMIT_SAMPLES:
218 *data = g_variant_new_uint64(devc->limit_samples);
220 case SR_CONF_SAMPLE_INTERVAL:
221 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
222 rational[0] = g_variant_new_uint64(si[0]);
223 rational[1] = g_variant_new_uint64(si[1]);
224 *data = g_variant_new_tuple(rational, 2);
226 case SR_CONF_DATALOG:
227 /* There really isn't a way to be sure the device is logging. */
230 case SR_CONF_SPL_WEIGHT_FREQ:
231 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
232 *data = g_variant_new_string("A");
234 *data = g_variant_new_string("C");
236 case SR_CONF_SPL_WEIGHT_TIME:
237 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
238 *data = g_variant_new_string("F");
240 *data = g_variant_new_string("S");
242 case SR_CONF_DATA_SOURCE:
243 if (devc->data_source == DATA_SOURCE_LIVE)
244 *data = g_variant_new_string("Live");
246 *data = g_variant_new_string("Memory");
255 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
256 const struct sr_channel_group *cg)
258 struct dev_context *devc;
266 if (sdi->status != SR_ST_ACTIVE)
267 return SR_ERR_DEV_CLOSED;
272 case SR_CONF_LIMIT_SAMPLES:
273 devc->limit_samples = g_variant_get_uint64(data);
274 sr_dbg("Setting sample limit to %" PRIu64 ".",
275 devc->limit_samples);
277 case SR_CONF_SAMPLE_INTERVAL:
278 g_variant_get(data, "(tt)", &p, &q);
279 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
280 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
282 devc->sample_interval = i;
283 devc->config_dirty = TRUE;
286 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
289 case SR_CONF_SPL_WEIGHT_FREQ:
290 tmp_str = g_variant_get_string(data, NULL);
291 if (!strcmp(tmp_str, "A"))
292 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
293 else if (!strcmp(tmp_str, "C"))
294 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
297 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
298 devc->mqflags |= tmp;
299 devc->config_dirty = TRUE;
301 case SR_CONF_SPL_WEIGHT_TIME:
302 tmp_str = g_variant_get_string(data, NULL);
303 if (!strcmp(tmp_str, "F"))
304 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
305 else if (!strcmp(tmp_str, "S"))
306 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
309 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
310 devc->mqflags |= tmp;
311 devc->config_dirty = TRUE;
313 case SR_CONF_DATA_SOURCE:
314 tmp_str = g_variant_get_string(data, NULL);
315 if (!strcmp(tmp_str, "Live"))
316 devc->data_source = DATA_SOURCE_LIVE;
317 else if (!strcmp(tmp_str, "Memory"))
318 devc->data_source = DATA_SOURCE_MEMORY;
321 devc->config_dirty = TRUE;
330 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
331 const struct sr_channel_group *cg)
333 GVariant *tuple, *rational[2];
341 case SR_CONF_DEVICE_OPTIONS:
342 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
343 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
345 case SR_CONF_SAMPLE_INTERVAL:
346 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
347 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
348 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
349 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
350 tuple = g_variant_new_tuple(rational, 2);
351 g_variant_builder_add_value(&gvb, tuple);
353 *data = g_variant_builder_end(&gvb);
355 case SR_CONF_SPL_WEIGHT_FREQ:
356 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
358 case SR_CONF_SPL_WEIGHT_TIME:
359 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
361 case SR_CONF_DATA_SOURCE:
362 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
371 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
373 struct sr_dev_driver *di = sdi->driver;
374 struct drv_context *drvc;
375 struct dev_context *devc;
376 struct sr_datafeed_packet packet;
377 struct sr_datafeed_meta meta;
378 struct sr_config *src;
379 struct sr_usb_dev_inst *usb;
380 GVariant *gvar, *rational[2];
382 int req_len, buf_len, len, ret;
383 unsigned char buf[9];
385 if (sdi->status != SR_ST_ACTIVE)
386 return SR_ERR_DEV_CLOSED;
392 devc->num_samples = 0;
394 std_session_send_df_header(sdi, LOG_PREFIX);
396 if (devc->data_source == DATA_SOURCE_LIVE) {
397 /* Force configuration. */
398 kecheng_kc_330b_configure(sdi);
400 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
402 if (ret != DEVICE_ACTIVE) {
403 sr_err("Device is inactive");
404 /* Still continue though, since the device will
405 * just return 30.0 until the user hits the button
406 * on the device -- and then start feeding good
410 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
412 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
413 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
414 devc->stored_samples = (buf[7] << 8) | buf[8];
415 if (devc->stored_samples == 0) {
416 /* Notify frontend of empty log by sending start/end packets. */
417 std_session_send_df_end(sdi, LOG_PREFIX);
421 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
422 devc->stored_samples = devc->limit_samples;
424 si = kecheng_kc_330b_sample_intervals[buf[1]];
425 rational[0] = g_variant_new_uint64(si[0]);
426 rational[1] = g_variant_new_uint64(si[1]);
427 gvar = g_variant_new_tuple(rational, 2);
428 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
429 packet.type = SR_DF_META;
430 packet.payload = &meta;
431 meta.config = g_slist_append(NULL, src);
432 sr_session_send(sdi, &packet);
436 if (!(devc->xfer = libusb_alloc_transfer(0)))
439 usb_source_add(sdi->session, drvc->sr_ctx, 10,
440 kecheng_kc_330b_handle_events, (void *)sdi);
442 if (devc->data_source == DATA_SOURCE_LIVE) {
443 buf[0] = CMD_GET_LIVE_SPL;
445 devc->state = LIVE_SPL_WAIT;
446 devc->last_live_request = g_get_monotonic_time() / 1000;
449 buf[0] = CMD_GET_LOG_DATA;
453 devc->state = LOG_DATA_WAIT;
454 if (devc->stored_samples < 63)
455 buf[3] = devc->stored_samples;
458 /* Command ack byte + 2 bytes per sample. */
459 req_len = 1 + buf[3] * 2;
462 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
463 if (ret != 0 || len != 1) {
464 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
465 libusb_free_transfer(devc->xfer);
469 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
470 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
471 if (libusb_submit_transfer(devc->xfer) != 0) {
472 libusb_free_transfer(devc->xfer);
479 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
481 struct dev_context *devc;
483 if (sdi->status != SR_ST_ACTIVE)
484 return SR_ERR_DEV_CLOSED;
486 /* Signal USB transfer handler to clean up and stop. */
487 sdi->status = SR_ST_STOPPING;
490 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
491 /* The protocol doesn't have a command to clear stored data;
492 * it clears it whenever new configuration is set. That means
493 * we can't just configure the device any time we want when
494 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
495 * it is now, when we're sure we've pulled in all the stored
497 kecheng_kc_330b_configure(sdi);
503 static struct sr_dev_driver kecheng_kc_330b_driver_info = {
504 .name = "kecheng-kc-330b",
505 .longname = "Kecheng KC-330B",
508 .cleanup = std_cleanup,
510 .dev_list = std_dev_list,
512 .config_get = config_get,
513 .config_set = config_set,
514 .config_list = config_list,
515 .dev_open = dev_open,
516 .dev_close = dev_close,
517 .dev_acquisition_start = dev_acquisition_start,
518 .dev_acquisition_stop = dev_acquisition_stop,
521 SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);