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