src/hardware/kecheng-kc-330b/api.c

   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
  20 #include <config.h>
  21 #include <string.h>
  22 #include "protocol.h"
  23
  24 #define USB_CONN "1041.8101"
  25 #define VENDOR "Kecheng"
  26 #define USB_INTERFACE 0
  27
  28 static const uint32_t devopts[] = {
  29         SR_CONF_SOUNDLEVELMETER,
  30         SR_CONF_CONTINUOUS,
  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,
  37 };
  38
  39 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
  40         { 1, 8 },
  41         { 1, 2 },
  42         { 1, 1 },
  43         { 2, 1 },
  44         { 5, 1 },
  45         { 10, 1 },
  46         { 60, 1 },
  47 };
  48
  49 static const char *weight_freq[] = {
  50         "A",
  51         "C",
  52 };
  53
  54 static const char *weight_time[] = {
  55         "F",
  56         "S",
  57 };
  58
  59 static const char *data_sources[] = {
  60         "Live",
  61         "Memory",
  62 };
  63
  64 static int scan_kecheng(struct sr_dev_driver *di,
  65                 struct sr_usb_dev_inst *usb, char **model)
  66 {
  67         struct drv_context *drvc;
  68         int len, ret;
  69         unsigned char cmd, buf[32];
  70
  71         drvc = di->context;
  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);
 100
 101         return SR_OK;
 102 }
 103
 104 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 105 {
 106         struct drv_context *drvc;
 107         struct dev_context *devc;
 108         struct sr_dev_inst *sdi;
 109         GSList *usb_devices, *devices, *l;
 110         char *model;
 111
 112         (void)options;
 113
 114         drvc = di->context;
 115
 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) {
 121                         if (scan_kecheng(di, l->data, &model) != SR_OK)
 122                                 continue;
 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;
 128                         sdi->conn = l->data;
 129                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
 130                         devc = g_malloc0(sizeof(struct dev_context));
 131                         sdi->priv = devc;
 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;
 141
 142                         /* TODO: Set date/time? */
 143
 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);
 149
 150         return std_scan_complete(di, devices);
 151 }
 152
 153 static int dev_open(struct sr_dev_inst *sdi)
 154 {
 155         struct sr_dev_driver *di = sdi->driver;
 156         struct drv_context *drvc = di->context;
 157         struct sr_usb_dev_inst *usb;
 158         int ret;
 159
 160         usb = sdi->conn;
 161
 162         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 163                 return SR_ERR;
 164
 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
 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         }
 174
 175         return SR_OK;
 176 }
 177
 178 static int dev_close(struct sr_dev_inst *sdi)
 179 {
 180         struct dev_context *devc;
 181         struct sr_usb_dev_inst *usb;
 182
 183         usb = sdi->conn;
 184
 185         if (!usb->devhdl)
 186                 return SR_ERR_BUG;
 187
 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
 194         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 195         libusb_close(usb->devhdl);
 196         usb->devhdl = NULL;
 197
 198         return SR_OK;
 199 }
 200
 201 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 202                 const struct sr_channel_group *cg)
 203 {
 204         struct dev_context *devc;
 205         GVariant *rational[2];
 206         const uint64_t *si;
 207
 208         (void)cg;
 209
 210         devc = sdi->priv;
 211         switch (key) {
 212         case SR_CONF_LIMIT_SAMPLES:
 213                 *data = g_variant_new_uint64(devc->limit_samples);
 214                 break;
 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);
 220                 break;
 221         case SR_CONF_DATALOG:
 222                 /* There really isn't a way to be sure the device is logging. */
 223                 return SR_ERR_NA;
 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;
 243         default:
 244                 return SR_ERR_NA;
 245         }
 246
 247         return SR_OK;
 248 }
 249
 250 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 251                 const struct sr_channel_group *cg)
 252 {
 253         struct dev_context *devc;
 254         uint64_t p, q;
 255         unsigned int i;
 256         int tmp;
 257         const char *tmp_str;
 258
 259         (void)cg;
 260
 261         devc = sdi->priv;
 262         switch (key) {
 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;
 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)
 272                                 continue;
 273                         devc->sample_interval = i;
 274                         devc->config_dirty = TRUE;
 275                         break;
 276                 }
 277                 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
 278                         return SR_ERR_ARG;
 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;
 290                 devc->config_dirty = TRUE;
 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;
 302                 devc->config_dirty = TRUE;
 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;
 312                 devc->config_dirty = TRUE;
 313                 break;
 314         default:
 315                 return SR_ERR_NA;
 316         }
 317
 318         return SR_OK;
 319 }
 320
 321 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 322                 const struct sr_channel_group *cg)
 323 {
 324         GVariant *tuple, *rational[2];
 325         GVariantBuilder gvb;
 326         unsigned int i;
 327
 328         switch (key) {
 329         case SR_CONF_DEVICE_OPTIONS:
 330                 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, NULL, devopts);
 331         case SR_CONF_SAMPLE_INTERVAL:
 332                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 333                 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
 334                         rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
 335                         rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
 336                         tuple = g_variant_new_tuple(rational, 2);
 337                         g_variant_builder_add_value(&gvb, tuple);
 338                 }
 339                 *data = g_variant_builder_end(&gvb);
 340                 break;
 341         case SR_CONF_SPL_WEIGHT_FREQ:
 342                 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
 343                 break;
 344         case SR_CONF_SPL_WEIGHT_TIME:
 345                 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
 346                 break;
 347         case SR_CONF_DATA_SOURCE:
 348                 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
 349                 break;
 350         default:
 351                 return SR_ERR_NA;
 352         }
 353
 354         return SR_OK;
 355 }
 356
 357 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 358 {
 359         struct sr_dev_driver *di = sdi->driver;
 360         struct drv_context *drvc;
 361         struct dev_context *devc;
 362         struct sr_datafeed_packet packet;
 363         struct sr_datafeed_meta meta;
 364         struct sr_config *src;
 365         struct sr_usb_dev_inst *usb;
 366         GVariant *gvar, *rational[2];
 367         const uint64_t *si;
 368         int req_len, buf_len, len, ret;
 369         unsigned char buf[9];
 370
 371         drvc = di->context;
 372         devc = sdi->priv;
 373         usb = sdi->conn;
 374
 375         devc->num_samples = 0;
 376
 377         std_session_send_df_header(sdi);
 378
 379         if (devc->data_source == DATA_SOURCE_LIVE) {
 380                 /* Force configuration. */
 381                 kecheng_kc_330b_configure(sdi);
 382
 383                 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
 384                         return SR_ERR;
 385                 if (ret != DEVICE_ACTIVE) {
 386                         sr_err("Device is inactive");
 387                         /* Still continue though, since the device will
 388                          * just return 30.0 until the user hits the button
 389                          * on the device -- and then start feeding good
 390                          * samples back. */
 391                 }
 392         } else {
 393                 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
 394                         return SR_ERR;
 395                 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
 396                 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
 397                 devc->stored_samples = (buf[7] << 8) | buf[8];
 398                 if (devc->stored_samples == 0) {
 399                         /* Notify frontend of empty log by sending start/end packets. */
 400                         std_session_send_df_end(sdi);
 401                         return SR_OK;
 402                 }
 403
 404                 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
 405                         devc->stored_samples = devc->limit_samples;
 406
 407                 si = kecheng_kc_330b_sample_intervals[buf[1]];
 408                 rational[0] = g_variant_new_uint64(si[0]);
 409                 rational[1] = g_variant_new_uint64(si[1]);
 410                 gvar = g_variant_new_tuple(rational, 2);
 411                 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
 412                 packet.type = SR_DF_META;
 413                 packet.payload = &meta;
 414                 meta.config = g_slist_append(NULL, src);
 415                 sr_session_send(sdi, &packet);
 416                 g_free(src);
 417         }
 418
 419         if (!(devc->xfer = libusb_alloc_transfer(0)))
 420                 return SR_ERR;
 421
 422         usb_source_add(sdi->session, drvc->sr_ctx, 10,
 423                 kecheng_kc_330b_handle_events, (void *)sdi);
 424
 425         if (devc->data_source == DATA_SOURCE_LIVE) {
 426                 buf[0] = CMD_GET_LIVE_SPL;
 427                 buf_len = 1;
 428                 devc->state = LIVE_SPL_WAIT;
 429                 devc->last_live_request = g_get_monotonic_time() / 1000;
 430                 req_len = 3;
 431         } else {
 432                 buf[0] = CMD_GET_LOG_DATA;
 433                 buf[1] = 0;
 434                 buf[2] = 0;
 435                 buf_len = 4;
 436                 devc->state = LOG_DATA_WAIT;
 437                 if (devc->stored_samples < 63)
 438                         buf[3] = devc->stored_samples;
 439                 else
 440                         buf[3] = 63;
 441                 /* Command ack byte + 2 bytes per sample. */
 442                 req_len = 1 + buf[3] * 2;
 443         }
 444
 445         ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
 446         if (ret != 0 || len != 1) {
 447                 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
 448                 libusb_free_transfer(devc->xfer);
 449                 return SR_ERR;
 450         }
 451
 452         libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
 453                         req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
 454         if (libusb_submit_transfer(devc->xfer) != 0) {
 455                 libusb_free_transfer(devc->xfer);
 456                 return SR_ERR;
 457         }
 458
 459         return SR_OK;
 460 }
 461
 462 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 463 {
 464         struct dev_context *devc;
 465
 466         /* Signal USB transfer handler to clean up and stop. */
 467         sdi->status = SR_ST_STOPPING;
 468
 469         devc = sdi->priv;
 470         if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
 471                 /* The protocol doesn't have a command to clear stored data;
 472                  * it clears it whenever new configuration is set. That means
 473                  * we can't just configure the device any time we want when
 474                  * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
 475                  * it is now, when we're sure we've pulled in all the stored
 476                  * data. */
 477                 kecheng_kc_330b_configure(sdi);
 478         }
 479
 480         return SR_OK;
 481 }
 482
 483 static struct sr_dev_driver kecheng_kc_330b_driver_info = {
 484         .name = "kecheng-kc-330b",
 485         .longname = "Kecheng KC-330B",
 486         .api_version = 1,
 487         .init = std_init,
 488         .cleanup = std_cleanup,
 489         .scan = scan,
 490         .dev_list = std_dev_list,
 491         .dev_clear = std_dev_clear,
 492         .config_get = config_get,
 493         .config_set = config_set,
 494         .config_list = config_list,
 495         .dev_open = dev_open,
 496         .dev_close = dev_close,
 497         .dev_acquisition_start = dev_acquisition_start,
 498         .dev_acquisition_stop = dev_acquisition_stop,
 499         .context = NULL,
 500 };
 501 SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);