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