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