src/hardware/testo/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 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 SERIALCOMM "115200/8n1"
  24
  25 SR_PRIV struct sr_dev_driver testo_driver_info;
  26 static struct sr_dev_driver *di = &testo_driver_info;
  27 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
  28
  29 static const uint32_t scanopts[] = {
  30         SR_CONF_CONN,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         SR_CONF_MULTIMETER,
  35         SR_CONF_CONTINUOUS,
  36         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  37         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  38 };
  39
  40 unsigned char TESTO_x35_REQUEST[] = { 0x12, 0, 0, 0, 1, 1, 0x55, 0xd1, 0xb7 };
  41 struct testo_model models[] = {
  42         { "435", 9, TESTO_x35_REQUEST },
  43 };
  44
  45 static int init(struct sr_context *sr_ctx)
  46 {
  47         return std_init(sr_ctx, di, LOG_PREFIX);
  48 }
  49
  50 static GSList *scan(GSList *options)
  51 {
  52         struct drv_context *drvc;
  53         struct dev_context *devc;
  54         struct sr_config *src;
  55         struct sr_dev_inst *sdi;
  56         struct sr_usb_dev_inst *usb;
  57         struct libusb_device_descriptor des;
  58         libusb_device **devlist;
  59         struct libusb_device_handle *hdl;
  60         GSList *conn_devices, *devices, *l;
  61         int ret, i;
  62         const char *str;
  63         char manufacturer[64], product[64], connection_id[64];
  64
  65         devices = NULL;
  66         drvc = di->priv;
  67         drvc->instances = NULL;
  68
  69         conn_devices = NULL;
  70         for (l = options; l; l = l->next) {
  71                 src = l->data;
  72                 if (src->key != SR_CONF_CONN)
  73                         continue;
  74                 str = g_variant_get_string(src->data, NULL);
  75                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, str);
  76         }
  77
  78         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
  79         for (i = 0; devlist[i]; i++) {
  80                 if (conn_devices) {
  81                         usb = NULL;
  82                         for (l = conn_devices; l; l = l->next) {
  83                                 usb = l->data;
  84                                 if (usb->bus == libusb_get_bus_number(devlist[i])
  85                                         && usb->address == libusb_get_device_address(devlist[i]))
  86                                         break;
  87                         }
  88                         if (!l)
  89                                 /* This device matched none of the ones that
  90                                  * matched the conn specification. */
  91                                 continue;
  92                 }
  93
  94                 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
  95                         sr_warn("Failed to get device descriptor: %s.",
  96                                 libusb_error_name(ret));
  97                         continue;
  98                 }
  99
 100                 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
 101                         continue;
 102
 103                 manufacturer[0] = product[0] = '\0';
 104                 if (des.iManufacturer && (ret = libusb_get_string_descriptor_ascii(
 105                                 hdl, des.iManufacturer, (unsigned char *) manufacturer,
 106                                 sizeof(manufacturer))) < 0) {
 107                         sr_warn("Failed to get manufacturer string descriptor: %s.",
 108                                 libusb_error_name(ret));
 109                 }
 110                 if (des.iProduct && (ret = libusb_get_string_descriptor_ascii(
 111                                 hdl, des.iProduct, (unsigned char *) product,
 112                                 sizeof(product))) < 0) {
 113                         sr_warn("Failed to get product string descriptor: %s.",
 114                                 libusb_error_name(ret));
 115                 }
 116                 libusb_close(hdl);
 117
 118                 if (strncmp(manufacturer, "testo", 5))
 119                         continue;
 120
 121                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 122
 123                 /* Hardcode the 435 for now.*/
 124                 if (strcmp(product, "testo 435/635/735"))
 125                         continue;
 126
 127                 sdi = sr_dev_inst_new();
 128                 sdi->status = SR_ST_INACTIVE;
 129                 sdi->vendor = g_strdup("Testo");
 130                 sdi->model = g_strdup("435/635/735");
 131                 sdi->driver = di;
 132                 sdi->inst_type = SR_INST_USB;
 133                 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 134                                 libusb_get_device_address(devlist[i]), NULL);
 135                 sdi->connection_id = g_strdup(connection_id);
 136                 devc = g_malloc(sizeof(struct dev_context));
 137                 devc->model = &models[0];
 138                 devc->limit_msec = 0;
 139                 devc->limit_samples = 0;
 140                 sdi->priv = devc;
 141                 if (testo_probe_channels(sdi) != SR_OK)
 142                         continue;
 143                 drvc->instances = g_slist_append(drvc->instances, sdi);
 144                 devices = g_slist_append(devices, sdi);
 145         }
 146         libusb_free_device_list(devlist, 1);
 147         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 148
 149         return devices;
 150 }
 151
 152 static GSList *dev_list(void)
 153 {
 154         return ((struct drv_context *)(di->priv))->instances;
 155 }
 156
 157 static int dev_clear(void)
 158 {
 159         return std_dev_clear(di, NULL);
 160 }
 161
 162 static int dev_open(struct sr_dev_inst *sdi)
 163 {
 164         struct drv_context *drvc = di->priv;
 165         struct sr_usb_dev_inst *usb;
 166         libusb_device **devlist;
 167         int ret, i;
 168         char connection_id[64];
 169
 170         if (!di->priv) {
 171                 sr_err("Driver was not initialized.");
 172                 return SR_ERR;
 173         }
 174
 175         usb = sdi->conn;
 176         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 177         for (i = 0; devlist[i]; i++) {
 178                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 179                 if (strcmp(sdi->connection_id, connection_id))
 180                         continue;
 181                 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
 182                         sr_err("Failed to open device: %s.", libusb_error_name(ret));
 183                         return SR_ERR;
 184                 }
 185                 break;
 186         }
 187         libusb_free_device_list(devlist, 1);
 188         if (!devlist[i]) {
 189                 sr_err("Device not found.");
 190                 return SR_ERR;
 191         }
 192
 193         if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
 194                 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 195                         if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
 196                                 sr_err("Failed to detach kernel driver: %s.",
 197                                            libusb_error_name(ret));
 198                                 return SR_ERR;
 199                         }
 200                 }
 201         }
 202
 203         if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
 204                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 205                 return SR_ERR;
 206         }
 207         sdi->status = SR_ST_ACTIVE;
 208
 209         return SR_OK;
 210 }
 211
 212 static int dev_close(struct sr_dev_inst *sdi)
 213 {
 214         struct sr_usb_dev_inst *usb;
 215
 216         if (!di->priv) {
 217                 sr_err("Driver was not initialized.");
 218                 return SR_ERR;
 219         }
 220
 221         usb = sdi->conn;
 222         if (!usb->devhdl)
 223                 /*  Nothing to do. */
 224                 return SR_OK;
 225
 226         libusb_release_interface(usb->devhdl, 0);
 227         libusb_close(usb->devhdl);
 228         usb->devhdl = NULL;
 229         sdi->status = SR_ST_INACTIVE;
 230
 231         return SR_OK;
 232 }
 233
 234 static int cleanup(void)
 235 {
 236         int ret;
 237         struct drv_context *drvc;
 238
 239         if (!(drvc = di->priv))
 240                 return SR_OK;
 241
 242         ret = dev_clear();
 243         g_free(drvc);
 244         di->priv = NULL;
 245
 246         return ret;
 247 }
 248
 249 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 250                 const struct sr_channel_group *cg)
 251 {
 252         struct sr_usb_dev_inst *usb;
 253         char str[128];
 254
 255         (void)cg;
 256
 257         switch (key) {
 258         case SR_CONF_CONN:
 259                 if (!sdi || !sdi->conn)
 260                         return SR_ERR_ARG;
 261                 usb = sdi->conn;
 262                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 263                 *data = g_variant_new_string(str);
 264                 break;
 265         default:
 266                 return SR_ERR_NA;
 267         }
 268
 269         return SR_OK;
 270 }
 271
 272 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 273                 const struct sr_channel_group *cg)
 274 {
 275         struct dev_context *devc;
 276         gint64 now;
 277         int ret;
 278
 279         (void)cg;
 280
 281         if (sdi->status != SR_ST_ACTIVE)
 282                 return SR_ERR_DEV_CLOSED;
 283
 284         if (!di->priv) {
 285                 sr_err("Driver was not initialized.");
 286                 return SR_ERR;
 287         }
 288
 289         devc = sdi->priv;
 290         ret = SR_OK;
 291         switch (key) {
 292         case SR_CONF_LIMIT_MSEC:
 293                 devc->limit_msec = g_variant_get_uint64(data);
 294                 now = g_get_monotonic_time() / 1000;
 295                 devc->end_time = now + devc->limit_msec;
 296                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 297                        devc->limit_msec);
 298                 break;
 299         case SR_CONF_LIMIT_SAMPLES:
 300                 devc->limit_samples = g_variant_get_uint64(data);
 301                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 302                        devc->limit_samples);
 303                 break;
 304         default:
 305                 ret = SR_ERR_NA;
 306         }
 307
 308         return ret;
 309 }
 310
 311 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 312                 const struct sr_channel_group *cg)
 313 {
 314         (void)sdi;
 315         (void)cg;
 316
 317         switch (key) {
 318         case SR_CONF_SCAN_OPTIONS:
 319                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 320                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 321                 break;
 322         case SR_CONF_DEVICE_OPTIONS:
 323                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 324                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 325                 break;
 326         default:
 327                 return SR_ERR_NA;
 328         }
 329
 330         return SR_OK;
 331 }
 332
 333 static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
 334 {
 335         struct dev_context *devc;
 336         int packet_size;
 337         uint16_t crc;
 338
 339         devc = sdi->priv;
 340
 341         if (devc->reply_size + len > MAX_REPLY_SIZE) {
 342                 /* Something went very wrong. */
 343                 sr_dbg("Receive buffer overrun.");
 344                 devc->reply_size = 0;
 345                 return;
 346         }
 347
 348         memcpy(devc->reply + devc->reply_size, data, len);
 349         devc->reply_size += len;
 350         /* Sixth byte contains the length of the packet. */
 351         if (devc->reply_size < 7)
 352                 return;
 353
 354         packet_size = 7 + devc->reply[6] * 7 + 2;
 355         if (devc->reply_size < packet_size)
 356                 return;
 357
 358         if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
 359                 return;
 360
 361         crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
 362         if (crc == RL16(&devc->reply[devc->reply_size - 2])) {
 363                 testo_receive_packet(sdi);
 364                 devc->num_samples++;
 365         } else {
 366                 sr_dbg("Packet has invalid CRC.");
 367         }
 368
 369         devc->reply_size = 0;
 370         if (devc->limit_samples && devc->num_samples >= devc->limit_samples)
 371                 dev_acquisition_stop(sdi, devc->cb_data);
 372         else
 373                 testo_request_packet(sdi);
 374
 375 }
 376
 377 SR_PRIV void receive_transfer(struct libusb_transfer *transfer)
 378 {
 379         struct dev_context *devc;
 380         struct sr_dev_inst *sdi;
 381         int ret;
 382
 383         sdi = transfer->user_data;
 384         devc = sdi->priv;
 385         if (transfer == devc->out_transfer)
 386                 /* Just the command acknowledgement. */
 387                 return;
 388
 389         if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
 390                 /* USB device was unplugged. */
 391                 dev_acquisition_stop(sdi, devc->cb_data);
 392         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
 393                 /* First two bytes in any transfer are FTDI status bytes. */
 394                 if (transfer->actual_length > 2)
 395                         receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
 396         }
 397         /* Anything else is either an error or a timeout, which is fine:
 398          * we were just going to send another transfer request anyway. */
 399
 400         if (sdi->status == SR_ST_ACTIVE) {
 401                 if ((ret = libusb_submit_transfer(transfer) != 0)) {
 402                         sr_err("Unable to resubmit transfer: %s.",
 403                                libusb_error_name(ret));
 404                         g_free(transfer->buffer);
 405                         libusb_free_transfer(transfer);
 406                         dev_acquisition_stop(sdi, devc->cb_data);
 407                 }
 408         } else {
 409                 /* This was the last transfer we're going to receive, so
 410                  * clean up now. */
 411                 g_free(transfer->buffer);
 412                 libusb_free_transfer(transfer);
 413         }
 414 }
 415
 416 static int handle_events(int fd, int revents, void *cb_data)
 417 {
 418         struct dev_context *devc;
 419         struct drv_context *drvc = di->priv;
 420         struct sr_datafeed_packet packet;
 421         struct sr_dev_inst *sdi;
 422         struct timeval tv;
 423         gint64 now;
 424
 425         (void)fd;
 426         (void)revents;
 427
 428         sdi = cb_data;
 429         devc = sdi->priv;
 430
 431         if (devc->limit_msec) {
 432                 now = g_get_monotonic_time() / 1000;
 433                 if (now > devc->end_time)
 434                         dev_acquisition_stop(sdi, devc->cb_data);
 435         }
 436
 437         if (sdi->status == SR_ST_STOPPING) {
 438                 usb_source_remove(sdi->session, drvc->sr_ctx);
 439
 440                 dev_close(sdi);
 441
 442                 packet.type = SR_DF_END;
 443                 sr_session_send(sdi, &packet);
 444         }
 445
 446         memset(&tv, 0, sizeof(struct timeval));
 447         libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
 448                         NULL);
 449
 450         return TRUE;
 451 }
 452
 453 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 454 {
 455         struct drv_context *drvc;
 456         struct dev_context *devc;
 457         struct sr_usb_dev_inst *usb;
 458         struct libusb_transfer *transfer;
 459         int ret;
 460         unsigned char *buf;
 461
 462         drvc = di->priv;
 463         if (sdi->status != SR_ST_ACTIVE)
 464                 return SR_ERR_DEV_CLOSED;
 465
 466         if (!di->priv) {
 467                 sr_err("Driver was not initialized.");
 468                 return SR_ERR;
 469         }
 470
 471         devc = sdi->priv;
 472         usb = sdi->conn;
 473         devc->cb_data = cb_data;
 474         devc->end_time = 0;
 475         devc->num_samples = 0;
 476         devc->reply_size = 0;
 477
 478         /* Send header packet to the session bus. */
 479         std_session_send_df_header(cb_data, LOG_PREFIX);
 480
 481         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 482                         handle_events, (void *)sdi);
 483
 484         if (testo_set_serial_params(usb) != SR_OK)
 485                 return SR_ERR;
 486
 487         devc->out_transfer = libusb_alloc_transfer(0);
 488         if (testo_request_packet(sdi) != SR_OK)
 489                 return SR_ERR;
 490
 491         buf = g_try_malloc(MAX_REPLY_SIZE);
 492         transfer = libusb_alloc_transfer(0);
 493         libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
 494                         MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
 495         if ((ret = libusb_submit_transfer(transfer) != 0)) {
 496                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 497                 libusb_free_transfer(transfer);
 498                 g_free(buf);
 499                 return SR_ERR;
 500         }
 501         devc->reply_size = 0;
 502
 503         return SR_OK;
 504 }
 505
 506 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 507 {
 508         (void)cb_data;
 509
 510         if (!di->priv) {
 511                 sr_err("Driver was not initialized.");
 512                 return SR_ERR;
 513         }
 514
 515         if (sdi->status != SR_ST_ACTIVE)
 516                 return SR_ERR_DEV_CLOSED;
 517
 518         sdi->status = SR_ST_STOPPING;
 519
 520         return SR_OK;
 521 }
 522
 523 SR_PRIV struct sr_dev_driver testo_driver_info = {
 524         .name = "testo",
 525         .longname = "Testo",
 526         .api_version = 1,
 527         .init = init,
 528         .cleanup = cleanup,
 529         .scan = scan,
 530         .dev_list = dev_list,
 531         .dev_clear = dev_clear,
 532         .config_get = config_get,
 533         .config_set = config_set,
 534         .config_list = config_list,
 535         .dev_open = dev_open,
 536         .dev_close = dev_close,
 537         .dev_acquisition_start = dev_acquisition_start,
 538         .dev_acquisition_stop = dev_acquisition_stop,
 539         .priv = NULL,
 540 };