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 drvopts[] = {
29 SR_CONF_SOUNDLEVELMETER,
32 static const uint32_t devopts[] = {
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
35 SR_CONF_SAMPLE_INTERVAL | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_DATALOG | SR_CONF_GET,
37 SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
42 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
52 static const char *weight_freq[] = {
56 static const char *weight_time[] = {
60 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. */
127 sdi->inst_type = SR_INST_USB;
129 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
130 devc = g_malloc0(sizeof(struct dev_context));
132 devc->limit_samples = 0;
133 /* The protocol provides no way to read the current
134 * settings, so we'll enforce these. */
135 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
136 devc->alarm_low = DEFAULT_ALARM_LOW;
137 devc->alarm_high = DEFAULT_ALARM_HIGH;
138 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
139 devc->data_source = DEFAULT_DATA_SOURCE;
140 devc->config_dirty = FALSE;
142 /* TODO: Set date/time? */
144 devices = g_slist_append(devices, sdi);
146 g_slist_free(usb_devices);
148 g_slist_free_full(usb_devices, g_free);
150 return std_scan_complete(di, devices);
153 static int dev_open(struct sr_dev_inst *sdi)
155 struct sr_dev_driver *di = sdi->driver;
156 struct drv_context *drvc = di->context;
157 struct sr_usb_dev_inst *usb;
162 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
165 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
166 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
170 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
171 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
178 static int dev_close(struct sr_dev_inst *sdi)
180 struct dev_context *devc;
181 struct sr_usb_dev_inst *usb;
188 /* This allows a frontend to configure the device without ever
189 * doing an acquisition step. */
191 if (!devc->config_dirty)
192 kecheng_kc_330b_configure(sdi);
194 libusb_release_interface(usb->devhdl, USB_INTERFACE);
195 libusb_close(usb->devhdl);
201 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
202 const struct sr_channel_group *cg)
204 struct dev_context *devc;
205 GVariant *rational[2];
212 case SR_CONF_LIMIT_SAMPLES:
213 *data = g_variant_new_uint64(devc->limit_samples);
215 case SR_CONF_SAMPLE_INTERVAL:
216 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
217 rational[0] = g_variant_new_uint64(si[0]);
218 rational[1] = g_variant_new_uint64(si[1]);
219 *data = g_variant_new_tuple(rational, 2);
221 case SR_CONF_DATALOG:
222 /* There really isn't a way to be sure the device is logging. */
225 case SR_CONF_SPL_WEIGHT_FREQ:
226 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
227 *data = g_variant_new_string("A");
229 *data = g_variant_new_string("C");
231 case SR_CONF_SPL_WEIGHT_TIME:
232 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
233 *data = g_variant_new_string("F");
235 *data = g_variant_new_string("S");
237 case SR_CONF_DATA_SOURCE:
238 if (devc->data_source == DATA_SOURCE_LIVE)
239 *data = g_variant_new_string("Live");
241 *data = g_variant_new_string("Memory");
250 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
251 const struct sr_channel_group *cg)
253 struct dev_context *devc;
263 case SR_CONF_LIMIT_SAMPLES:
264 devc->limit_samples = g_variant_get_uint64(data);
265 sr_dbg("Setting sample limit to %" PRIu64 ".",
266 devc->limit_samples);
268 case SR_CONF_SAMPLE_INTERVAL:
269 g_variant_get(data, "(tt)", &p, &q);
270 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
271 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
273 devc->sample_interval = i;
274 devc->config_dirty = TRUE;
277 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
280 case SR_CONF_SPL_WEIGHT_FREQ:
281 tmp_str = g_variant_get_string(data, NULL);
282 if (!strcmp(tmp_str, "A"))
283 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
284 else if (!strcmp(tmp_str, "C"))
285 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
288 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
289 devc->mqflags |= tmp;
290 devc->config_dirty = TRUE;
292 case SR_CONF_SPL_WEIGHT_TIME:
293 tmp_str = g_variant_get_string(data, NULL);
294 if (!strcmp(tmp_str, "F"))
295 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
296 else if (!strcmp(tmp_str, "S"))
297 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
300 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
301 devc->mqflags |= tmp;
302 devc->config_dirty = TRUE;
304 case SR_CONF_DATA_SOURCE:
305 tmp_str = g_variant_get_string(data, NULL);
306 if (!strcmp(tmp_str, "Live"))
307 devc->data_source = DATA_SOURCE_LIVE;
308 else if (!strcmp(tmp_str, "Memory"))
309 devc->data_source = DATA_SOURCE_MEMORY;
312 devc->config_dirty = TRUE;
321 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
322 const struct sr_channel_group *cg)
325 case SR_CONF_DEVICE_OPTIONS:
326 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
327 case SR_CONF_SAMPLE_INTERVAL:
328 *data = std_gvar_tuple_array(&kecheng_kc_330b_sample_intervals,
329 ARRAY_SIZE(kecheng_kc_330b_sample_intervals));
331 case SR_CONF_SPL_WEIGHT_FREQ:
332 *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq));
334 case SR_CONF_SPL_WEIGHT_TIME:
335 *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time));
337 case SR_CONF_DATA_SOURCE:
338 *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
347 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
349 struct sr_dev_driver *di = sdi->driver;
350 struct drv_context *drvc;
351 struct dev_context *devc;
352 struct sr_datafeed_packet packet;
353 struct sr_datafeed_meta meta;
354 struct sr_config *src;
355 struct sr_usb_dev_inst *usb;
356 GVariant *gvar, *rational[2];
358 int req_len, buf_len, len, ret;
359 unsigned char buf[9];
365 devc->num_samples = 0;
367 std_session_send_df_header(sdi);
369 if (devc->data_source == DATA_SOURCE_LIVE) {
370 /* Force configuration. */
371 kecheng_kc_330b_configure(sdi);
373 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
375 if (ret != DEVICE_ACTIVE) {
376 sr_err("Device is inactive");
377 /* Still continue though, since the device will
378 * just return 30.0 until the user hits the button
379 * on the device -- and then start feeding good
383 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
385 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
386 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
387 devc->stored_samples = (buf[7] << 8) | buf[8];
388 if (devc->stored_samples == 0) {
389 /* Notify frontend of empty log by sending start/end packets. */
390 std_session_send_df_end(sdi);
394 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
395 devc->stored_samples = devc->limit_samples;
397 si = kecheng_kc_330b_sample_intervals[buf[1]];
398 rational[0] = g_variant_new_uint64(si[0]);
399 rational[1] = g_variant_new_uint64(si[1]);
400 gvar = g_variant_new_tuple(rational, 2);
401 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
402 packet.type = SR_DF_META;
403 packet.payload = &meta;
404 meta.config = g_slist_append(NULL, src);
405 sr_session_send(sdi, &packet);
409 if (!(devc->xfer = libusb_alloc_transfer(0)))
412 usb_source_add(sdi->session, drvc->sr_ctx, 10,
413 kecheng_kc_330b_handle_events, (void *)sdi);
415 if (devc->data_source == DATA_SOURCE_LIVE) {
416 buf[0] = CMD_GET_LIVE_SPL;
418 devc->state = LIVE_SPL_WAIT;
419 devc->last_live_request = g_get_monotonic_time() / 1000;
422 buf[0] = CMD_GET_LOG_DATA;
426 devc->state = LOG_DATA_WAIT;
427 if (devc->stored_samples < 63)
428 buf[3] = devc->stored_samples;
431 /* Command ack byte + 2 bytes per sample. */
432 req_len = 1 + buf[3] * 2;
435 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
436 if (ret != 0 || len != 1) {
437 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
438 libusb_free_transfer(devc->xfer);
442 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
443 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
444 if (libusb_submit_transfer(devc->xfer) != 0) {
445 libusb_free_transfer(devc->xfer);
452 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
454 struct dev_context *devc;
456 /* Signal USB transfer handler to clean up and stop. */
457 sdi->status = SR_ST_STOPPING;
460 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
461 /* The protocol doesn't have a command to clear stored data;
462 * it clears it whenever new configuration is set. That means
463 * we can't just configure the device any time we want when
464 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
465 * it is now, when we're sure we've pulled in all the stored
467 kecheng_kc_330b_configure(sdi);
473 static struct sr_dev_driver kecheng_kc_330b_driver_info = {
474 .name = "kecheng-kc-330b",
475 .longname = "Kecheng KC-330B",
478 .cleanup = std_cleanup,
480 .dev_list = std_dev_list,
481 .dev_clear = std_dev_clear,
482 .config_get = config_get,
483 .config_set = config_set,
484 .config_list = config_list,
485 .dev_open = dev_open,
486 .dev_close = dev_close,
487 .dev_acquisition_start = dev_acquisition_start,
488 .dev_acquisition_stop = dev_acquisition_stop,
491 SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);