]> sigrok.org Git - libsigrok.git/blame - src/hardware/kecheng-kc-330b/api.c
drivers: Shorten some unnecessarily long arrays.
[libsigrok.git] / src / hardware / kecheng-kc-330b / api.c
CommitLineData
ed759a08
BV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
6ec6c43b 20#include <config.h>
bc7be4a9 21#include <string.h>
ed759a08
BV
22#include "protocol.h"
23
a8806f03
BV
24#define USB_CONN "1041.8101"
25#define VENDOR "Kecheng"
26#define USB_INTERFACE 0
a8806f03 27
05199c0a 28static const uint32_t drvopts[] = {
a8806f03 29 SR_CONF_SOUNDLEVELMETER,
05199c0a
UH
30};
31
32static const uint32_t devopts[] = {
a8806f03 33 SR_CONF_CONTINUOUS,
5827f61b
BV
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,
bc7be4a9
BV
40};
41
df035528 42SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
bc7be4a9
BV
43 { 1, 8 },
44 { 1, 2 },
45 { 1, 1 },
46 { 2, 1 },
47 { 5, 1 },
48 { 10, 1 },
49 { 60, 1 },
50};
51
52static const char *weight_freq[] = {
f8195cb2 53 "A", "C",
bc7be4a9
BV
54};
55
56static const char *weight_time[] = {
f8195cb2 57 "F", "S",
bc7be4a9
BV
58};
59
60static const char *data_sources[] = {
f8195cb2 61 "Live", "Memory",
a8806f03
BV
62};
63
4f840ce9
ML
64static int scan_kecheng(struct sr_dev_driver *di,
65 struct sr_usb_dev_inst *usb, char **model)
a8806f03
BV
66{
67 struct drv_context *drvc;
68 int len, ret;
69 unsigned char cmd, buf[32];
70
41812aca 71 drvc = di->context;
a8806f03
BV
72 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
73 return SR_ERR;
74
75 cmd = CMD_IDENTIFY;
76 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
77 if (ret != 0) {
78 libusb_close(usb->devhdl);
79 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
80 return SR_ERR;
81 }
82
83 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
84 if (ret != 0) {
85 libusb_close(usb->devhdl);
86 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
87 return SR_ERR;
88 }
89
90 libusb_close(usb->devhdl);
91 usb->devhdl = NULL;
92
93 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
94 sr_dbg("Invalid response to Identify command");
95 return SR_ERR;
96 }
97
98 buf[buf[1] + 2] = '\x0';
99 *model = g_strndup((const gchar *)buf + 2, 30);
a8806f03
BV
100
101 return SR_OK;
102}
103
4f840ce9 104static GSList *scan(struct sr_dev_driver *di, GSList *options)
ed759a08
BV
105{
106 struct drv_context *drvc;
a8806f03
BV
107 struct dev_context *devc;
108 struct sr_dev_inst *sdi;
a8806f03
BV
109 GSList *usb_devices, *devices, *l;
110 char *model;
ed759a08
BV
111
112 (void)options;
113
41812aca 114 drvc = di->context;
ed759a08 115
a8806f03
BV
116 devices = NULL;
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) {
4f840ce9 121 if (scan_kecheng(di, l->data, &model) != SR_OK)
a8806f03 122 continue;
aac29cc1 123 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
124 sdi->status = SR_ST_INACTIVE;
125 sdi->vendor = g_strdup(VENDOR);
126 sdi->model = model; /* Already g_strndup()'d. */
a8806f03
BV
127 sdi->inst_type = SR_INST_USB;
128 sdi->conn = l->data;
5e23fcab 129 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
f57d8ffe 130 devc = g_malloc0(sizeof(struct dev_context));
a8806f03
BV
131 sdi->priv = devc;
132 devc->limit_samples = 0;
bc7be4a9
BV
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;
85ed4ab3 140 devc->config_dirty = FALSE;
bc7be4a9
BV
141
142 /* TODO: Set date/time? */
a8806f03 143
a8806f03
BV
144 devices = g_slist_append(devices, sdi);
145 }
146 g_slist_free(usb_devices);
147 } else
148 g_slist_free_full(usb_devices, g_free);
ed759a08 149
15a5bfe4 150 return std_scan_complete(di, devices);
ed759a08
BV
151}
152
ed759a08
BV
153static int dev_open(struct sr_dev_inst *sdi)
154{
4f840ce9 155 struct sr_dev_driver *di = sdi->driver;
efa98402 156 struct drv_context *drvc = di->context;
a8806f03
BV
157 struct sr_usb_dev_inst *usb;
158 int ret;
159
a8806f03 160 usb = sdi->conn;
ed759a08 161
a8806f03
BV
162 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
163 return SR_ERR;
ed759a08 164
85ed4ab3
BV
165 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
166 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
167 return SR_ERR;
168 }
169
a8806f03
BV
170 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
171 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
172 return SR_ERR;
173 }
ed759a08 174
7e463623 175 return SR_OK;
ed759a08
BV
176}
177
178static int dev_close(struct sr_dev_inst *sdi)
179{
85ed4ab3 180 struct dev_context *devc;
a8806f03
BV
181 struct sr_usb_dev_inst *usb;
182
a8806f03 183 usb = sdi->conn;
ed759a08 184
a8806f03 185 if (!usb->devhdl)
f1ba6b4b 186 return SR_ERR_BUG;
ed759a08 187
85ed4ab3
BV
188 /* This allows a frontend to configure the device without ever
189 * doing an acquisition step. */
190 devc = sdi->priv;
191 if (!devc->config_dirty)
192 kecheng_kc_330b_configure(sdi);
193
a8806f03
BV
194 libusb_release_interface(usb->devhdl, USB_INTERFACE);
195 libusb_close(usb->devhdl);
196 usb->devhdl = NULL;
ed759a08
BV
197
198 return SR_OK;
199}
200
584560f1 201static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 202 const struct sr_channel_group *cg)
ed759a08 203{
a8806f03 204 struct dev_context *devc;
bc7be4a9
BV
205 GVariant *rational[2];
206 const uint64_t *si;
ed759a08 207
53b4680f 208 (void)cg;
d3c74a6f 209
a8806f03 210 devc = sdi->priv;
ed759a08 211 switch (key) {
a8806f03
BV
212 case SR_CONF_LIMIT_SAMPLES:
213 *data = g_variant_new_uint64(devc->limit_samples);
214 break;
bc7be4a9 215 case SR_CONF_SAMPLE_INTERVAL:
df035528 216 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
bc7be4a9
BV
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);
220 break;
221 case SR_CONF_DATALOG:
85ed4ab3
BV
222 /* There really isn't a way to be sure the device is logging. */
223 return SR_ERR_NA;
bc7be4a9
BV
224 break;
225 case SR_CONF_SPL_WEIGHT_FREQ:
226 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
227 *data = g_variant_new_string("A");
228 else
229 *data = g_variant_new_string("C");
230 break;
231 case SR_CONF_SPL_WEIGHT_TIME:
232 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
233 *data = g_variant_new_string("F");
234 else
235 *data = g_variant_new_string("S");
236 break;
237 case SR_CONF_DATA_SOURCE:
238 if (devc->data_source == DATA_SOURCE_LIVE)
239 *data = g_variant_new_string("Live");
240 else
241 *data = g_variant_new_string("Memory");
242 break;
ed759a08
BV
243 default:
244 return SR_ERR_NA;
245 }
246
a8806f03 247 return SR_OK;
ed759a08
BV
248}
249
584560f1 250static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 251 const struct sr_channel_group *cg)
ed759a08 252{
a8806f03 253 struct dev_context *devc;
bc7be4a9
BV
254 uint64_t p, q;
255 unsigned int i;
a9010323 256 int tmp;
bc7be4a9 257 const char *tmp_str;
ed759a08 258
53b4680f 259 (void)cg;
d3c74a6f 260
a8806f03 261 devc = sdi->priv;
ed759a08 262 switch (key) {
a8806f03
BV
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);
267 break;
bc7be4a9
BV
268 case SR_CONF_SAMPLE_INTERVAL:
269 g_variant_get(data, "(tt)", &p, &q);
df035528
BV
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)
bc7be4a9
BV
272 continue;
273 devc->sample_interval = i;
85ed4ab3 274 devc->config_dirty = TRUE;
bc7be4a9
BV
275 break;
276 }
df035528 277 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
a9010323 278 return SR_ERR_ARG;
bc7be4a9
BV
279 break;
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;
286 else
287 return SR_ERR_ARG;
288 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
289 devc->mqflags |= tmp;
85ed4ab3 290 devc->config_dirty = TRUE;
bc7be4a9
BV
291 break;
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;
298 else
299 return SR_ERR_ARG;
300 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
301 devc->mqflags |= tmp;
85ed4ab3 302 devc->config_dirty = TRUE;
bc7be4a9
BV
303 break;
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;
310 else
311 return SR_ERR;
85ed4ab3 312 devc->config_dirty = TRUE;
bc7be4a9 313 break;
ed759a08 314 default:
a9010323 315 return SR_ERR_NA;
ed759a08
BV
316 }
317
a9010323 318 return SR_OK;
ed759a08
BV
319}
320
584560f1 321static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 322 const struct sr_channel_group *cg)
ed759a08 323{
ed759a08 324 switch (key) {
a8806f03 325 case SR_CONF_DEVICE_OPTIONS:
05199c0a 326 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
bc7be4a9 327 case SR_CONF_SAMPLE_INTERVAL:
db944f16
UH
328 *data = std_gvar_tuple_array(&kecheng_kc_330b_sample_intervals,
329 ARRAY_SIZE(kecheng_kc_330b_sample_intervals));
bc7be4a9
BV
330 break;
331 case SR_CONF_SPL_WEIGHT_FREQ:
53012da6 332 *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq));
bc7be4a9
BV
333 break;
334 case SR_CONF_SPL_WEIGHT_TIME:
53012da6 335 *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time));
bc7be4a9
BV
336 break;
337 case SR_CONF_DATA_SOURCE:
53012da6 338 *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
bc7be4a9 339 break;
ed759a08
BV
340 default:
341 return SR_ERR_NA;
342 }
343
a8806f03 344 return SR_OK;
ed759a08
BV
345}
346
695dc859 347static int dev_acquisition_start(const struct sr_dev_inst *sdi)
ed759a08 348{
4f840ce9 349 struct sr_dev_driver *di = sdi->driver;
bc7be4a9
BV
350 struct drv_context *drvc;
351 struct dev_context *devc;
85ed4ab3
BV
352 struct sr_datafeed_packet packet;
353 struct sr_datafeed_meta meta;
354 struct sr_config *src;
bc7be4a9 355 struct sr_usb_dev_inst *usb;
85ed4ab3 356 GVariant *gvar, *rational[2];
85ed4ab3 357 const uint64_t *si;
7f22cd95 358 int req_len, buf_len, len, ret;
85ed4ab3 359 unsigned char buf[9];
ed759a08 360
41812aca 361 drvc = di->context;
bc7be4a9
BV
362 devc = sdi->priv;
363 usb = sdi->conn;
364
bc7be4a9
BV
365 devc->num_samples = 0;
366
bee2b016 367 std_session_send_df_header(sdi);
85ed4ab3 368
f336618c 369 if (devc->data_source == DATA_SOURCE_LIVE) {
85ed4ab3
BV
370 /* Force configuration. */
371 kecheng_kc_330b_configure(sdi);
372
f336618c
BV
373 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
374 return SR_ERR;
f336618c
BV
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
380 * samples back. */
381 }
85ed4ab3
BV
382 } else {
383 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
384 return SR_ERR;
7f22cd95
BV
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;
85ed4ab3
BV
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. */
bee2b016 390 std_session_send_df_end(sdi);
85ed4ab3
BV
391 return SR_OK;
392 }
393
394 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
395 devc->stored_samples = devc->limit_samples;
396
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);
695dc859 405 sr_session_send(sdi, &packet);
85ed4ab3 406 g_free(src);
f336618c
BV
407 }
408
df035528
BV
409 if (!(devc->xfer = libusb_alloc_transfer(0)))
410 return SR_ERR;
411
102f1239 412 usb_source_add(sdi->session, drvc->sr_ctx, 10,
6c60facc 413 kecheng_kc_330b_handle_events, (void *)sdi);
bc7be4a9 414
85ed4ab3
BV
415 if (devc->data_source == DATA_SOURCE_LIVE) {
416 buf[0] = CMD_GET_LIVE_SPL;
417 buf_len = 1;
418 devc->state = LIVE_SPL_WAIT;
419 devc->last_live_request = g_get_monotonic_time() / 1000;
420 req_len = 3;
421 } else {
422 buf[0] = CMD_GET_LOG_DATA;
423 buf[1] = 0;
424 buf[2] = 0;
425 buf_len = 4;
426 devc->state = LOG_DATA_WAIT;
427 if (devc->stored_samples < 63)
428 buf[3] = devc->stored_samples;
429 else
430 buf[3] = 63;
431 /* Command ack byte + 2 bytes per sample. */
432 req_len = 1 + buf[3] * 2;
433 }
434
435 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
bc7be4a9
BV
436 if (ret != 0 || len != 1) {
437 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
df035528
BV
438 libusb_free_transfer(devc->xfer);
439 return SR_ERR;
440 }
df035528
BV
441
442 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
85ed4ab3 443 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
df035528
BV
444 if (libusb_submit_transfer(devc->xfer) != 0) {
445 libusb_free_transfer(devc->xfer);
bc7be4a9
BV
446 return SR_ERR;
447 }
ed759a08
BV
448
449 return SR_OK;
450}
451
695dc859 452static int dev_acquisition_stop(struct sr_dev_inst *sdi)
ed759a08 453{
85ed4ab3
BV
454 struct dev_context *devc;
455
df035528
BV
456 /* Signal USB transfer handler to clean up and stop. */
457 sdi->status = SR_ST_STOPPING;
ed759a08 458
85ed4ab3
BV
459 devc = sdi->priv;
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
466 * data. */
467 kecheng_kc_330b_configure(sdi);
468 }
469
ed759a08
BV
470 return SR_OK;
471}
472
dd5c48a6 473static struct sr_dev_driver kecheng_kc_330b_driver_info = {
ed759a08
BV
474 .name = "kecheng-kc-330b",
475 .longname = "Kecheng KC-330B",
476 .api_version = 1,
c2fdcc25 477 .init = std_init,
700d6b64 478 .cleanup = std_cleanup,
ed759a08 479 .scan = scan,
c01bf34c 480 .dev_list = std_dev_list,
f778bf02 481 .dev_clear = std_dev_clear,
ed759a08
BV
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,
41812aca 489 .context = NULL,
ed759a08 490};
dd5c48a6 491SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);