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