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