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 <string.h>
  21 #include "protocol.h"
  22
  23 #define USB_CONN "1041.8101"
  24 #define VENDOR "Kecheng"
  25 #define USB_INTERFACE 0
  26
  27 static const int32_t hwcaps[] = {
  28         SR_CONF_SOUNDLEVELMETER,
  29         SR_CONF_LIMIT_SAMPLES,
  30         SR_CONF_CONTINUOUS,
  31         SR_CONF_DATALOG,
  32         SR_CONF_SPL_WEIGHT_FREQ,
  33         SR_CONF_SPL_WEIGHT_TIME,
  34         SR_CONF_DATA_SOURCE,
  35 };
  36
  37 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
  38         { 1, 8 },
  39         { 1, 2 },
  40         { 1, 1 },
  41         { 2, 1 },
  42         { 5, 1 },
  43         { 10, 1 },
  44         { 60, 1 },
  45 };
  46
  47 static const char *weight_freq[] = {
  48         "A",
  49         "C",
  50 };
  51
  52 static const char *weight_time[] = {
  53         "F",
  54         "S",
  55 };
  56
  57 static const char *data_sources[] = {
  58         "Live",
  59         "Memory",
  60 };
  61
  62 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
  63 static struct sr_dev_driver *di = &kecheng_kc_330b_driver_info;
  64
  65
  66 static int init(struct sr_context *sr_ctx)
  67 {
  68         return std_init(sr_ctx, di, LOG_PREFIX);
  69 }
  70
  71 static int scan_kecheng(struct sr_usb_dev_inst *usb, char **model)
  72 {
  73         struct drv_context *drvc;
  74         int len, ret;
  75         unsigned char cmd, buf[32];
  76
  77         drvc = di->priv;
  78         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
  79                 return SR_ERR;
  80
  81         cmd = CMD_IDENTIFY;
  82         ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
  83         if (ret != 0) {
  84                 libusb_close(usb->devhdl);
  85                 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
  86                 return SR_ERR;
  87         }
  88
  89         ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
  90         if (ret != 0) {
  91                 libusb_close(usb->devhdl);
  92                 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
  93                 return SR_ERR;
  94         }
  95
  96         libusb_close(usb->devhdl);
  97         usb->devhdl = NULL;
  98
  99         if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
 100                 sr_dbg("Invalid response to Identify command");
 101                 return SR_ERR;
 102         }
 103
 104         buf[buf[1] + 2] = '\x0';
 105         *model = g_strndup((const gchar *)buf + 2, 30);
 106
 107         return SR_OK;
 108 }
 109
 110 static GSList *scan(GSList *options)
 111 {
 112         struct drv_context *drvc;
 113         struct dev_context *devc;
 114         struct sr_dev_inst *sdi;
 115         struct sr_probe *probe;
 116         GSList *usb_devices, *devices, *l;
 117         char *model;
 118
 119         (void)options;
 120
 121         drvc = di->priv;
 122         drvc->instances = NULL;
 123
 124         devices = NULL;
 125         if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
 126                 /* We have a list of sr_usb_dev_inst matching the connection
 127                  * string. Wrap them in sr_dev_inst and we're done. */
 128                 for (l = usb_devices; l; l = l->next) {
 129                         if (scan_kecheng(l->data, &model) != SR_OK)
 130                                 continue;
 131                         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR,
 132                                         model, NULL)))
 133                                 return NULL;
 134                         g_free(model);
 135                         sdi->driver = di;
 136                         sdi->inst_type = SR_INST_USB;
 137                         sdi->conn = l->data;
 138                         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "SPL")))
 139                                 return NULL;
 140                         sdi->probes = g_slist_append(sdi->probes, probe);
 141
 142                         if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
 143                                 sr_dbg("Device context malloc failed.");
 144                                 return NULL;
 145                         }
 146                         sdi->priv = devc;
 147                         devc->limit_samples = 0;
 148                         /* The protocol provides no way to read the current
 149                          * settings, so we'll enforce these. */
 150                         devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
 151                         devc->alarm_low = DEFAULT_ALARM_LOW;
 152                         devc->alarm_high = DEFAULT_ALARM_HIGH;
 153                         devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
 154                         devc->data_source = DEFAULT_DATA_SOURCE;
 155                         devc->config_dirty = FALSE;
 156
 157                         /* TODO: Set date/time? */
 158
 159                         drvc->instances = g_slist_append(drvc->instances, sdi);
 160                         devices = g_slist_append(devices, sdi);
 161                 }
 162                 g_slist_free(usb_devices);
 163         } else
 164                 g_slist_free_full(usb_devices, g_free);
 165
 166         return devices;
 167 }
 168
 169 static GSList *dev_list(void)
 170 {
 171         return ((struct drv_context *)(di->priv))->instances;
 172 }
 173
 174 static int dev_clear(void)
 175 {
 176         return std_dev_clear(di, NULL);
 177 }
 178
 179 static int dev_open(struct sr_dev_inst *sdi)
 180 {
 181         struct drv_context *drvc;
 182         struct sr_usb_dev_inst *usb;
 183         int ret;
 184
 185         if (!(drvc = di->priv)) {
 186                 sr_err("Driver was not initialized.");
 187                 return SR_ERR;
 188         }
 189
 190         usb = sdi->conn;
 191
 192         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 193                 return SR_ERR;
 194
 195         if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
 196                 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
 197                 return SR_ERR;
 198         }
 199
 200         if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
 201                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 202                 return SR_ERR;
 203         }
 204         sdi->status = SR_ST_ACTIVE;
 205
 206         return ret;
 207 }
 208
 209 static int dev_close(struct sr_dev_inst *sdi)
 210 {
 211         struct dev_context *devc;
 212         struct sr_usb_dev_inst *usb;
 213
 214         if (!di->priv) {
 215                 sr_err("Driver was not initialized.");
 216                 return SR_ERR;
 217         }
 218
 219         usb = sdi->conn;
 220
 221         if (!usb->devhdl)
 222                 /*  Nothing to do. */
 223                 return SR_OK;
 224
 225         /* This allows a frontend to configure the device without ever
 226          * doing an acquisition step. */
 227         devc = sdi->priv;
 228         if (!devc->config_dirty)
 229                 kecheng_kc_330b_configure(sdi);
 230
 231         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 232         libusb_close(usb->devhdl);
 233         usb->devhdl = NULL;
 234         sdi->status = SR_ST_INACTIVE;
 235
 236         return SR_OK;
 237 }
 238
 239 static int cleanup(void)
 240 {
 241         int ret;
 242         struct drv_context *drvc;
 243
 244         if (!(drvc = di->priv))
 245                 /* Can get called on an unused driver, doesn't matter. */
 246                 return SR_OK;
 247
 248         ret = dev_clear();
 249         g_free(drvc);
 250         di->priv = NULL;
 251
 252         return ret;
 253 }
 254
 255 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
 256                 const struct sr_probe_group *probe_group)
 257 {
 258         struct dev_context *devc;
 259         GVariant *rational[2];
 260         const uint64_t *si;
 261
 262         (void)probe_group;
 263
 264         devc = sdi->priv;
 265         switch (key) {
 266         case SR_CONF_LIMIT_SAMPLES:
 267                 *data = g_variant_new_uint64(devc->limit_samples);
 268                 break;
 269         case SR_CONF_SAMPLE_INTERVAL:
 270                 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
 271                 rational[0] = g_variant_new_uint64(si[0]);
 272                 rational[1] = g_variant_new_uint64(si[1]);
 273                 *data = g_variant_new_tuple(rational, 2);
 274                 break;
 275         case SR_CONF_DATALOG:
 276                 /* There really isn't a way to be sure the device is logging. */
 277                 return SR_ERR_NA;
 278                 break;
 279         case SR_CONF_SPL_WEIGHT_FREQ:
 280                 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
 281                         *data = g_variant_new_string("A");
 282                 else
 283                         *data = g_variant_new_string("C");
 284                 break;
 285         case SR_CONF_SPL_WEIGHT_TIME:
 286                 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
 287                         *data = g_variant_new_string("F");
 288                 else
 289                         *data = g_variant_new_string("S");
 290                 break;
 291         case SR_CONF_DATA_SOURCE:
 292                 if (devc->data_source == DATA_SOURCE_LIVE)
 293                         *data = g_variant_new_string("Live");
 294                 else
 295                         *data = g_variant_new_string("Memory");
 296                 break;
 297         default:
 298                 return SR_ERR_NA;
 299         }
 300
 301         return SR_OK;
 302 }
 303
 304 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 305                 const struct sr_probe_group *probe_group)
 306 {
 307         struct dev_context *devc;
 308         uint64_t p, q;
 309         unsigned int i;
 310         int tmp, ret;
 311         const char *tmp_str;
 312
 313         (void)probe_group;
 314
 315         if (sdi->status != SR_ST_ACTIVE)
 316                 return SR_ERR_DEV_CLOSED;
 317
 318         if (!di->priv) {
 319                 sr_err("Driver was not initialized.");
 320                 return SR_ERR;
 321         }
 322
 323         devc = sdi->priv;
 324         ret = SR_OK;
 325         switch (key) {
 326         case SR_CONF_LIMIT_SAMPLES:
 327                 devc->limit_samples = g_variant_get_uint64(data);
 328                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 329                        devc->limit_samples);
 330                 break;
 331         case SR_CONF_SAMPLE_INTERVAL:
 332                 g_variant_get(data, "(tt)", &p, &q);
 333                 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
 334                         if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
 335                                 continue;
 336                         devc->sample_interval = i;
 337                         devc->config_dirty = TRUE;
 338                         break;
 339                 }
 340                 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
 341                         ret = SR_ERR_ARG;
 342                 break;
 343         case SR_CONF_SPL_WEIGHT_FREQ:
 344                 tmp_str = g_variant_get_string(data, NULL);
 345                 if (!strcmp(tmp_str, "A"))
 346                         tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
 347                 else if (!strcmp(tmp_str, "C"))
 348                         tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
 349                 else
 350                         return SR_ERR_ARG;
 351                 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
 352                 devc->mqflags |= tmp;
 353                 devc->config_dirty = TRUE;
 354                 break;
 355         case SR_CONF_SPL_WEIGHT_TIME:
 356                 tmp_str = g_variant_get_string(data, NULL);
 357                 if (!strcmp(tmp_str, "F"))
 358                         tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
 359                 else if (!strcmp(tmp_str, "S"))
 360                         tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
 361                 else
 362                         return SR_ERR_ARG;
 363                 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
 364                 devc->mqflags |= tmp;
 365                 devc->config_dirty = TRUE;
 366                 break;
 367         case SR_CONF_DATA_SOURCE:
 368                 tmp_str = g_variant_get_string(data, NULL);
 369                 if (!strcmp(tmp_str, "Live"))
 370                         devc->data_source = DATA_SOURCE_LIVE;
 371                 else if (!strcmp(tmp_str, "Memory"))
 372                         devc->data_source = DATA_SOURCE_MEMORY;
 373                 else
 374                         return SR_ERR;
 375                 devc->config_dirty = TRUE;
 376                 break;
 377         default:
 378                 ret = SR_ERR_NA;
 379         }
 380
 381         return ret;
 382 }
 383
 384 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 385                 const struct sr_probe_group *probe_group)
 386 {
 387         GVariant *tuple, *rational[2];
 388         GVariantBuilder gvb;
 389         unsigned int i;
 390
 391         (void)sdi;
 392         (void)probe_group;
 393
 394         switch (key) {
 395         case SR_CONF_DEVICE_OPTIONS:
 396                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 397                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 398                 break;
 399         case SR_CONF_SAMPLE_INTERVAL:
 400                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 401                 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
 402                         rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
 403                         rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
 404                         tuple = g_variant_new_tuple(rational, 2);
 405                         g_variant_builder_add_value(&gvb, tuple);
 406                 }
 407                 *data = g_variant_builder_end(&gvb);
 408                 break;
 409         case SR_CONF_SPL_WEIGHT_FREQ:
 410                 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
 411                 break;
 412         case SR_CONF_SPL_WEIGHT_TIME:
 413                 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
 414                 break;
 415         case SR_CONF_DATA_SOURCE:
 416                 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
 417                 break;
 418         default:
 419                 return SR_ERR_NA;
 420         }
 421
 422         return SR_OK;
 423 }
 424
 425 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 426                 void *cb_data)
 427 {
 428         struct drv_context *drvc;
 429         struct dev_context *devc;
 430         struct sr_datafeed_packet packet;
 431         struct sr_datafeed_meta meta;
 432         struct sr_config *src;
 433         struct sr_usb_dev_inst *usb;
 434         GVariant *gvar, *rational[2];
 435         const struct libusb_pollfd **pfd;
 436         const uint64_t *si;
 437         int stored_mqflags, req_len, buf_len, len, ret, i;
 438         unsigned char buf[9];
 439
 440         if (sdi->status != SR_ST_ACTIVE)
 441                 return SR_ERR_DEV_CLOSED;
 442
 443         drvc = di->priv;
 444         devc = sdi->priv;
 445         usb = sdi->conn;
 446
 447         devc->cb_data = cb_data;
 448         devc->num_samples = 0;
 449
 450         /* Send header packet to the session bus. */
 451         std_session_send_df_header(cb_data, LOG_PREFIX);
 452
 453         if (devc->data_source == DATA_SOURCE_LIVE) {
 454                 /* Force configuration. */
 455                 kecheng_kc_330b_configure(sdi);
 456
 457                 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
 458                         return SR_ERR;
 459                 if (ret != DEVICE_ACTIVE) {
 460                         sr_err("Device is inactive");
 461                         /* Still continue though, since the device will
 462                          * just return 30.0 until the user hits the button
 463                          * on the device -- and then start feeding good
 464                          * samples back. */
 465                 }
 466         } else {
 467                 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
 468                         return SR_ERR;
 469                 stored_mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
 470                 stored_mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
 471                 devc->stored_samples = (buf[7] << 8) | buf[8];
 472                 if (devc->stored_samples == 0) {
 473                         /* Notify frontend of empty log by sending start/end packets. */
 474                         packet.type = SR_DF_END;
 475                         sr_session_send(cb_data, &packet);
 476                         return SR_OK;
 477                 }
 478
 479                 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
 480                         devc->stored_samples = devc->limit_samples;
 481
 482                 si = kecheng_kc_330b_sample_intervals[buf[1]];
 483                 rational[0] = g_variant_new_uint64(si[0]);
 484                 rational[1] = g_variant_new_uint64(si[1]);
 485                 gvar = g_variant_new_tuple(rational, 2);
 486                 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
 487                 packet.type = SR_DF_META;
 488                 packet.payload = &meta;
 489                 meta.config = g_slist_append(NULL, src);
 490                 sr_session_send(devc->cb_data, &packet);
 491                 g_free(src);
 492         }
 493
 494         if (!(devc->xfer = libusb_alloc_transfer(0)))
 495                 return SR_ERR;
 496
 497         pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 498         for (i = 0; pfd[i]; i++) {
 499                 /* Handle USB events every 10ms. */
 500                 sr_source_add(pfd[i]->fd, pfd[i]->events, 10,
 501                                 kecheng_kc_330b_handle_events, (void *)sdi);
 502                 /* We'll need to remove this fd later. */
 503                 devc->usbfd[i] = pfd[i]->fd;
 504         }
 505         devc->usbfd[i] = -1;
 506
 507         if (devc->data_source == DATA_SOURCE_LIVE) {
 508                 buf[0] = CMD_GET_LIVE_SPL;
 509                 buf_len = 1;
 510                 devc->state = LIVE_SPL_WAIT;
 511                 devc->last_live_request = g_get_monotonic_time() / 1000;
 512                 req_len = 3;
 513         } else {
 514                 buf[0] = CMD_GET_LOG_DATA;
 515                 buf[1] = 0;
 516                 buf[2] = 0;
 517                 buf_len = 4;
 518                 devc->state = LOG_DATA_WAIT;
 519                 if (devc->stored_samples < 63)
 520                         buf[3] = devc->stored_samples;
 521                 else
 522                         buf[3] = 63;
 523                 /* Command ack byte + 2 bytes per sample. */
 524                 req_len = 1 + buf[3] * 2;
 525         }
 526
 527         ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
 528         if (ret != 0 || len != 1) {
 529                 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
 530                 libusb_free_transfer(devc->xfer);
 531                 return SR_ERR;
 532         }
 533
 534         libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
 535                         req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
 536         if (libusb_submit_transfer(devc->xfer) != 0) {
 537                 libusb_free_transfer(devc->xfer);
 538                 return SR_ERR;
 539         }
 540
 541         return SR_OK;
 542 }
 543
 544 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 545 {
 546         struct dev_context *devc;
 547
 548         (void)cb_data;
 549
 550         if (sdi->status != SR_ST_ACTIVE)
 551                 return SR_ERR_DEV_CLOSED;
 552
 553         /* Signal USB transfer handler to clean up and stop. */
 554         sdi->status = SR_ST_STOPPING;
 555
 556         devc = sdi->priv;
 557         if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
 558                 /* The protocol doesn't have a command to clear stored data;
 559                  * it clears it whenever new configuration is set. That means
 560                  * we can't just configure the device any time we want when
 561                  * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
 562                  * it is now, when we're sure we've pulled in all the stored
 563                  * data. */
 564                 kecheng_kc_330b_configure(sdi);
 565         }
 566
 567         return SR_OK;
 568 }
 569
 570 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
 571         .name = "kecheng-kc-330b",
 572         .longname = "Kecheng KC-330B",
 573         .api_version = 1,
 574         .init = init,
 575         .cleanup = cleanup,
 576         .scan = scan,
 577         .dev_list = dev_list,
 578         .dev_clear = dev_clear,
 579         .config_get = config_get,
 580         .config_set = config_set,
 581         .config_list = config_list,
 582         .dev_open = dev_open,
 583         .dev_close = dev_close,
 584         .dev_acquisition_start = dev_acquisition_start,
 585         .dev_acquisition_stop = dev_acquisition_stop,
 586         .priv = NULL,
 587 };