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