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 static struct sr_dev_driver *di = &kecheng_kc_330b_driver_info;
  65
  66
  67 static int init(struct sr_context *sr_ctx)
  68 {
  69         return std_init(sr_ctx, di, LOG_PREFIX);
  70 }
  71
  72 static int scan_kecheng(struct sr_usb_dev_inst *usb, char **model)
  73 {
  74         struct drv_context *drvc;
  75         int len, ret;
  76         unsigned char cmd, buf[32];
  77
  78         drvc = di->priv;
  79         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
  80                 return SR_ERR;
  81
  82         cmd = CMD_IDENTIFY;
  83         ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
  84         if (ret != 0) {
  85                 libusb_close(usb->devhdl);
  86                 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
  87                 return SR_ERR;
  88         }
  89
  90         ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
  91         if (ret != 0) {
  92                 libusb_close(usb->devhdl);
  93                 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
  94                 return SR_ERR;
  95         }
  96
  97         libusb_close(usb->devhdl);
  98         usb->devhdl = NULL;
  99
 100         if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
 101                 sr_dbg("Invalid response to Identify command");
 102                 return SR_ERR;
 103         }
 104
 105         buf[buf[1] + 2] = '\x0';
 106         *model = g_strndup((const gchar *)buf + 2, 30);
 107
 108         return SR_OK;
 109 }
 110
 111 static GSList *scan(GSList *options)
 112 {
 113         struct drv_context *drvc;
 114         struct dev_context *devc;
 115         struct sr_dev_inst *sdi;
 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                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 132                         sdi->status = SR_ST_INACTIVE;
 133                         sdi->vendor = g_strdup(VENDOR);
 134                         sdi->model = model; /* Already g_strndup()'d. */
 135                         sdi->driver = di;
 136                         sdi->inst_type = SR_INST_USB;
 137                         sdi->conn = l->data;
 138                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
 139                         devc = g_malloc0(sizeof(struct dev_context));
 140                         sdi->priv = devc;
 141                         devc->limit_samples = 0;
 142                         /* The protocol provides no way to read the current
 143                          * settings, so we'll enforce these. */
 144                         devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
 145                         devc->alarm_low = DEFAULT_ALARM_LOW;
 146                         devc->alarm_high = DEFAULT_ALARM_HIGH;
 147                         devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
 148                         devc->data_source = DEFAULT_DATA_SOURCE;
 149                         devc->config_dirty = FALSE;
 150
 151                         /* TODO: Set date/time? */
 152
 153                         drvc->instances = g_slist_append(drvc->instances, sdi);
 154                         devices = g_slist_append(devices, sdi);
 155                 }
 156                 g_slist_free(usb_devices);
 157         } else
 158                 g_slist_free_full(usb_devices, g_free);
 159
 160         return devices;
 161 }
 162
 163 static GSList *dev_list(void)
 164 {
 165         return ((struct drv_context *)(di->priv))->instances;
 166 }
 167
 168 static int dev_open(struct sr_dev_inst *sdi)
 169 {
 170         struct drv_context *drvc;
 171         struct sr_usb_dev_inst *usb;
 172         int ret;
 173
 174         if (!(drvc = di->priv)) {
 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 dev_context *devc;
 201         struct sr_usb_dev_inst *usb;
 202
 203         if (!di->priv) {
 204                 sr_err("Driver was not initialized.");
 205                 return SR_ERR;
 206         }
 207
 208         usb = sdi->conn;
 209
 210         if (!usb->devhdl)
 211                 /*  Nothing to do. */
 212                 return SR_OK;
 213
 214         /* This allows a frontend to configure the device without ever
 215          * doing an acquisition step. */
 216         devc = sdi->priv;
 217         if (!devc->config_dirty)
 218                 kecheng_kc_330b_configure(sdi);
 219
 220         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 221         libusb_close(usb->devhdl);
 222         usb->devhdl = NULL;
 223         sdi->status = SR_ST_INACTIVE;
 224
 225         return SR_OK;
 226 }
 227
 228 static int cleanup(void)
 229 {
 230         int ret;
 231         struct drv_context *drvc;
 232
 233         if (!(drvc = di->priv))
 234                 /* Can get called on an unused driver, doesn't matter. */
 235                 return SR_OK;
 236
 237
 238         ret = std_dev_clear(di, NULL);
 239         g_free(drvc);
 240         di->priv = NULL;
 241
 242         return ret;
 243 }
 244
 245 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 246                 const struct sr_channel_group *cg)
 247 {
 248         struct dev_context *devc;
 249         GVariant *rational[2];
 250         const uint64_t *si;
 251
 252         (void)cg;
 253
 254         devc = sdi->priv;
 255         switch (key) {
 256         case SR_CONF_LIMIT_SAMPLES:
 257                 *data = g_variant_new_uint64(devc->limit_samples);
 258                 break;
 259         case SR_CONF_SAMPLE_INTERVAL:
 260                 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
 261                 rational[0] = g_variant_new_uint64(si[0]);
 262                 rational[1] = g_variant_new_uint64(si[1]);
 263                 *data = g_variant_new_tuple(rational, 2);
 264                 break;
 265         case SR_CONF_DATALOG:
 266                 /* There really isn't a way to be sure the device is logging. */
 267                 return SR_ERR_NA;
 268                 break;
 269         case SR_CONF_SPL_WEIGHT_FREQ:
 270                 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
 271                         *data = g_variant_new_string("A");
 272                 else
 273                         *data = g_variant_new_string("C");
 274                 break;
 275         case SR_CONF_SPL_WEIGHT_TIME:
 276                 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
 277                         *data = g_variant_new_string("F");
 278                 else
 279                         *data = g_variant_new_string("S");
 280                 break;
 281         case SR_CONF_DATA_SOURCE:
 282                 if (devc->data_source == DATA_SOURCE_LIVE)
 283                         *data = g_variant_new_string("Live");
 284                 else
 285                         *data = g_variant_new_string("Memory");
 286                 break;
 287         default:
 288                 return SR_ERR_NA;
 289         }
 290
 291         return SR_OK;
 292 }
 293
 294 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 295                 const struct sr_channel_group *cg)
 296 {
 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->priv) {
 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 drv_context *drvc;
 419         struct dev_context *devc;
 420         struct sr_datafeed_packet packet;
 421         struct sr_datafeed_meta meta;
 422         struct sr_config *src;
 423         struct sr_usb_dev_inst *usb;
 424         GVariant *gvar, *rational[2];
 425         const uint64_t *si;
 426         int req_len, buf_len, len, ret;
 427         unsigned char buf[9];
 428
 429         if (sdi->status != SR_ST_ACTIVE)
 430                 return SR_ERR_DEV_CLOSED;
 431
 432         drvc = di->priv;
 433         devc = sdi->priv;
 434         usb = sdi->conn;
 435
 436         devc->cb_data = cb_data;
 437         devc->num_samples = 0;
 438
 439         /* Send header packet to the session bus. */
 440         std_session_send_df_header(cb_data, LOG_PREFIX);
 441
 442         if (devc->data_source == DATA_SOURCE_LIVE) {
 443                 /* Force configuration. */
 444                 kecheng_kc_330b_configure(sdi);
 445
 446                 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
 447                         return SR_ERR;
 448                 if (ret != DEVICE_ACTIVE) {
 449                         sr_err("Device is inactive");
 450                         /* Still continue though, since the device will
 451                          * just return 30.0 until the user hits the button
 452                          * on the device -- and then start feeding good
 453                          * samples back. */
 454                 }
 455         } else {
 456                 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
 457                         return SR_ERR;
 458                 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
 459                 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
 460                 devc->stored_samples = (buf[7] << 8) | buf[8];
 461                 if (devc->stored_samples == 0) {
 462                         /* Notify frontend of empty log by sending start/end packets. */
 463                         packet.type = SR_DF_END;
 464                         sr_session_send(cb_data, &packet);
 465                         return SR_OK;
 466                 }
 467
 468                 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
 469                         devc->stored_samples = devc->limit_samples;
 470
 471                 si = kecheng_kc_330b_sample_intervals[buf[1]];
 472                 rational[0] = g_variant_new_uint64(si[0]);
 473                 rational[1] = g_variant_new_uint64(si[1]);
 474                 gvar = g_variant_new_tuple(rational, 2);
 475                 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
 476                 packet.type = SR_DF_META;
 477                 packet.payload = &meta;
 478                 meta.config = g_slist_append(NULL, src);
 479                 sr_session_send(devc->cb_data, &packet);
 480                 g_free(src);
 481         }
 482
 483         if (!(devc->xfer = libusb_alloc_transfer(0)))
 484                 return SR_ERR;
 485
 486         usb_source_add(sdi->session, drvc->sr_ctx, 10,
 487                 kecheng_kc_330b_handle_events, (void *)sdi);
 488
 489         if (devc->data_source == DATA_SOURCE_LIVE) {
 490                 buf[0] = CMD_GET_LIVE_SPL;
 491                 buf_len = 1;
 492                 devc->state = LIVE_SPL_WAIT;
 493                 devc->last_live_request = g_get_monotonic_time() / 1000;
 494                 req_len = 3;
 495         } else {
 496                 buf[0] = CMD_GET_LOG_DATA;
 497                 buf[1] = 0;
 498                 buf[2] = 0;
 499                 buf_len = 4;
 500                 devc->state = LOG_DATA_WAIT;
 501                 if (devc->stored_samples < 63)
 502                         buf[3] = devc->stored_samples;
 503                 else
 504                         buf[3] = 63;
 505                 /* Command ack byte + 2 bytes per sample. */
 506                 req_len = 1 + buf[3] * 2;
 507         }
 508
 509         ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
 510         if (ret != 0 || len != 1) {
 511                 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
 512                 libusb_free_transfer(devc->xfer);
 513                 return SR_ERR;
 514         }
 515
 516         libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
 517                         req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
 518         if (libusb_submit_transfer(devc->xfer) != 0) {
 519                 libusb_free_transfer(devc->xfer);
 520                 return SR_ERR;
 521         }
 522
 523         return SR_OK;
 524 }
 525
 526 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 527 {
 528         struct dev_context *devc;
 529
 530         (void)cb_data;
 531
 532         if (sdi->status != SR_ST_ACTIVE)
 533                 return SR_ERR_DEV_CLOSED;
 534
 535         /* Signal USB transfer handler to clean up and stop. */
 536         sdi->status = SR_ST_STOPPING;
 537
 538         devc = sdi->priv;
 539         if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
 540                 /* The protocol doesn't have a command to clear stored data;
 541                  * it clears it whenever new configuration is set. That means
 542                  * we can't just configure the device any time we want when
 543                  * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
 544                  * it is now, when we're sure we've pulled in all the stored
 545                  * data. */
 546                 kecheng_kc_330b_configure(sdi);
 547         }
 548
 549         return SR_OK;
 550 }
 551
 552 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
 553         .name = "kecheng-kc-330b",
 554         .longname = "Kecheng KC-330B",
 555         .api_version = 1,
 556         .init = init,
 557         .cleanup = cleanup,
 558         .scan = scan,
 559         .dev_list = dev_list,
 560         .dev_clear = NULL,
 561         .config_get = config_get,
 562         .config_set = config_set,
 563         .config_list = config_list,
 564         .dev_open = dev_open,
 565         .dev_close = dev_close,
 566         .dev_acquisition_start = dev_acquisition_start,
 567         .dev_acquisition_stop = dev_acquisition_stop,
 568         .priv = NULL,
 569 };