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 int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
  27
  28 static const uint32_t scanopts[] = {
  29         SR_CONF_CONN,
  30 };
  31
  32 static const uint32_t devopts[] = {
  33         SR_CONF_MULTIMETER,
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  36         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  37 };
  38
  39 static const uint8_t TESTO_x35_REQUEST[] = { 0x12, 0, 0, 0, 1, 1, 0x55, 0xd1, 0xb7 };
  40
  41 static const struct testo_model models[] = {
  42         { "435", 9, TESTO_x35_REQUEST },
  43 };
  44
  45 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  46 {
  47         return std_init(sr_ctx, di, LOG_PREFIX);
  48 }
  49
  50 static GSList *scan(struct sr_dev_driver *di, 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 = g_malloc0(sizeof(struct sr_dev_inst));
 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(const struct sr_dev_driver *di)
 153 {
 154         return ((struct drv_context *)(di->priv))->instances;
 155 }
 156
 157 static int dev_clear(const struct sr_dev_driver *di)
 158 {
 159         return std_dev_clear(di, NULL);
 160 }
 161
 162 static int dev_open(struct sr_dev_inst *sdi)
 163 {
 164         struct sr_dev_driver *di = sdi->driver;
 165         struct drv_context *drvc = di->priv;
 166         struct sr_usb_dev_inst *usb;
 167         libusb_device **devlist;
 168         int ret, i;
 169         char connection_id[64];
 170
 171         if (!di->priv) {
 172                 sr_err("Driver was not initialized.");
 173                 return SR_ERR;
 174         }
 175
 176         usb = sdi->conn;
 177         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 178         for (i = 0; devlist[i]; i++) {
 179                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 180                 if (strcmp(sdi->connection_id, connection_id))
 181                         continue;
 182                 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
 183                         sr_err("Failed to open device: %s.", libusb_error_name(ret));
 184                         return SR_ERR;
 185                 }
 186                 break;
 187         }
 188         libusb_free_device_list(devlist, 1);
 189         if (!devlist[i]) {
 190                 sr_err("Device not found.");
 191                 return SR_ERR;
 192         }
 193
 194         if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
 195                 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 196                         if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
 197                                 sr_err("Failed to detach kernel driver: %s.",
 198                                            libusb_error_name(ret));
 199                                 return SR_ERR;
 200                         }
 201                 }
 202         }
 203
 204         if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
 205                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 206                 return SR_ERR;
 207         }
 208         sdi->status = SR_ST_ACTIVE;
 209
 210         return SR_OK;
 211 }
 212
 213 static int dev_close(struct sr_dev_inst *sdi)
 214 {
 215         struct sr_dev_driver *di = sdi->driver;
 216         struct sr_usb_dev_inst *usb;
 217
 218         if (!di->priv) {
 219                 sr_err("Driver was not initialized.");
 220                 return SR_ERR;
 221         }
 222
 223         usb = sdi->conn;
 224         if (!usb->devhdl)
 225                 /*  Nothing to do. */
 226                 return SR_OK;
 227
 228         libusb_release_interface(usb->devhdl, 0);
 229         libusb_close(usb->devhdl);
 230         usb->devhdl = NULL;
 231         sdi->status = SR_ST_INACTIVE;
 232
 233         return SR_OK;
 234 }
 235
 236 static int cleanup(const struct sr_dev_driver *di)
 237 {
 238         int ret;
 239         struct drv_context *drvc;
 240
 241         if (!(drvc = di->priv))
 242                 return SR_OK;
 243
 244         ret = dev_clear(di);
 245         g_free(drvc);
 246
 247         return ret;
 248 }
 249
 250 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 251                 const struct sr_channel_group *cg)
 252 {
 253         struct sr_usb_dev_inst *usb;
 254         char str[128];
 255
 256         (void)cg;
 257
 258         switch (key) {
 259         case SR_CONF_CONN:
 260                 if (!sdi || !sdi->conn)
 261                         return SR_ERR_ARG;
 262                 usb = sdi->conn;
 263                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 264                 *data = g_variant_new_string(str);
 265                 break;
 266         default:
 267                 return SR_ERR_NA;
 268         }
 269
 270         return SR_OK;
 271 }
 272
 273 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 274                 const struct sr_channel_group *cg)
 275 {
 276         struct sr_dev_driver *di = sdi->driver;
 277         struct dev_context *devc;
 278         gint64 now;
 279         int ret;
 280
 281         (void)cg;
 282
 283         if (sdi->status != SR_ST_ACTIVE)
 284                 return SR_ERR_DEV_CLOSED;
 285
 286         if (!di->priv) {
 287                 sr_err("Driver was not initialized.");
 288                 return SR_ERR;
 289         }
 290
 291         devc = sdi->priv;
 292         ret = SR_OK;
 293         switch (key) {
 294         case SR_CONF_LIMIT_MSEC:
 295                 devc->limit_msec = g_variant_get_uint64(data);
 296                 now = g_get_monotonic_time() / 1000;
 297                 devc->end_time = now + devc->limit_msec;
 298                 break;
 299         case SR_CONF_LIMIT_SAMPLES:
 300                 devc->limit_samples = g_variant_get_uint64(data);
 301                 break;
 302         default:
 303                 ret = SR_ERR_NA;
 304         }
 305
 306         return ret;
 307 }
 308
 309 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 310                 const struct sr_channel_group *cg)
 311 {
 312         (void)sdi;
 313         (void)cg;
 314
 315         switch (key) {
 316         case SR_CONF_SCAN_OPTIONS:
 317                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 318                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 319                 break;
 320         case SR_CONF_DEVICE_OPTIONS:
 321                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 322                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 323                 break;
 324         default:
 325                 return SR_ERR_NA;
 326         }
 327
 328         return SR_OK;
 329 }
 330
 331 static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
 332 {
 333         struct dev_context *devc;
 334         int packet_size;
 335         uint16_t crc;
 336
 337         devc = sdi->priv;
 338
 339         if (devc->reply_size + len > MAX_REPLY_SIZE) {
 340                 /* Something went very wrong. */
 341                 sr_dbg("Receive buffer overrun.");
 342                 devc->reply_size = 0;
 343                 return;
 344         }
 345
 346         memcpy(devc->reply + devc->reply_size, data, len);
 347         devc->reply_size += len;
 348         /* Sixth byte contains the length of the packet. */
 349         if (devc->reply_size < 7)
 350                 return;
 351
 352         packet_size = 7 + devc->reply[6] * 7 + 2;
 353         if (devc->reply_size < packet_size)
 354                 return;
 355
 356         if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
 357                 return;
 358
 359         crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
 360         if (crc == RL16(&devc->reply[devc->reply_size - 2])) {
 361                 testo_receive_packet(sdi);
 362                 devc->num_samples++;
 363         } else {
 364                 sr_dbg("Packet has invalid CRC.");
 365         }
 366
 367         devc->reply_size = 0;
 368         if (devc->limit_samples && devc->num_samples >= devc->limit_samples)
 369                 dev_acquisition_stop(sdi, devc->cb_data);
 370         else
 371                 testo_request_packet(sdi);
 372
 373 }
 374
 375 SR_PRIV void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
 376 {
 377         struct dev_context *devc;
 378         struct sr_dev_inst *sdi;
 379         int ret;
 380
 381         sdi = transfer->user_data;
 382         devc = sdi->priv;
 383         if (transfer == devc->out_transfer)
 384                 /* Just the command acknowledgement. */
 385                 return;
 386
 387         if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
 388                 /* USB device was unplugged. */
 389                 dev_acquisition_stop(sdi, devc->cb_data);
 390         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
 391                 /* First two bytes in any transfer are FTDI status bytes. */
 392                 if (transfer->actual_length > 2)
 393                         receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
 394         }
 395         /* Anything else is either an error or a timeout, which is fine:
 396          * we were just going to send another transfer request anyway. */
 397
 398         if (sdi->status == SR_ST_ACTIVE) {
 399                 if ((ret = libusb_submit_transfer(transfer) != 0)) {
 400                         sr_err("Unable to resubmit transfer: %s.",
 401                                libusb_error_name(ret));
 402                         g_free(transfer->buffer);
 403                         libusb_free_transfer(transfer);
 404                         dev_acquisition_stop(sdi, devc->cb_data);
 405                 }
 406         } else {
 407                 /* This was the last transfer we're going to receive, so
 408                  * clean up now. */
 409                 g_free(transfer->buffer);
 410                 libusb_free_transfer(transfer);
 411         }
 412 }
 413
 414 static int handle_events(int fd, int revents, void *cb_data)
 415 {
 416         struct sr_dev_driver *di;
 417         struct dev_context *devc;
 418         struct drv_context *drvc;
 419         struct sr_datafeed_packet packet;
 420         struct sr_dev_inst *sdi;
 421         struct timeval tv;
 422         gint64 now;
 423
 424         (void)fd;
 425         (void)revents;
 426
 427         sdi = cb_data;
 428         devc = sdi->priv;
 429         di = sdi->driver;
 430         drvc = di->priv;
 431
 432         if (devc->limit_msec) {
 433                 now = g_get_monotonic_time() / 1000;
 434                 if (now > devc->end_time)
 435                         dev_acquisition_stop(sdi, devc->cb_data);
 436         }
 437
 438         if (sdi->status == SR_ST_STOPPING) {
 439                 usb_source_remove(sdi->session, drvc->sr_ctx);
 440
 441                 dev_close(sdi);
 442
 443                 packet.type = SR_DF_END;
 444                 sr_session_send(sdi, &packet);
 445         }
 446
 447         memset(&tv, 0, sizeof(struct timeval));
 448         libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
 449                         NULL);
 450
 451         return TRUE;
 452 }
 453
 454 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 455 {
 456         struct sr_dev_driver *di = sdi->driver;
 457         struct drv_context *drvc;
 458         struct dev_context *devc;
 459         struct sr_usb_dev_inst *usb;
 460         struct libusb_transfer *transfer;
 461         int ret;
 462         unsigned char *buf;
 463
 464         drvc = di->priv;
 465         if (sdi->status != SR_ST_ACTIVE)
 466                 return SR_ERR_DEV_CLOSED;
 467
 468         if (!di->priv) {
 469                 sr_err("Driver was not initialized.");
 470                 return SR_ERR;
 471         }
 472
 473         devc = sdi->priv;
 474         usb = sdi->conn;
 475         devc->cb_data = cb_data;
 476         devc->end_time = 0;
 477         devc->num_samples = 0;
 478         devc->reply_size = 0;
 479
 480         /* Send header packet to the session bus. */
 481         std_session_send_df_header(cb_data, LOG_PREFIX);
 482
 483         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 484                         handle_events, (void *)sdi);
 485
 486         if (testo_set_serial_params(usb) != SR_OK)
 487                 return SR_ERR;
 488
 489         devc->out_transfer = libusb_alloc_transfer(0);
 490         if (testo_request_packet(sdi) != SR_OK)
 491                 return SR_ERR;
 492
 493         buf = g_malloc(MAX_REPLY_SIZE);
 494         transfer = libusb_alloc_transfer(0);
 495         libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
 496                         MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
 497         if ((ret = libusb_submit_transfer(transfer) != 0)) {
 498                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 499                 libusb_free_transfer(transfer);
 500                 g_free(buf);
 501                 return SR_ERR;
 502         }
 503         devc->reply_size = 0;
 504
 505         return SR_OK;
 506 }
 507
 508 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 509 {
 510         struct sr_dev_driver *di = sdi->driver;
 511         (void)cb_data;
 512
 513         if (!di->priv) {
 514                 sr_err("Driver was not initialized.");
 515                 return SR_ERR;
 516         }
 517
 518         if (sdi->status != SR_ST_ACTIVE)
 519                 return SR_ERR_DEV_CLOSED;
 520
 521         sdi->status = SR_ST_STOPPING;
 522
 523         return SR_OK;
 524 }
 525
 526 SR_PRIV struct sr_dev_driver testo_driver_info = {
 527         .name = "testo",
 528         .longname = "Testo",
 529         .api_version = 1,
 530         .init = init,
 531         .cleanup = cleanup,
 532         .scan = scan,
 533         .dev_list = dev_list,
 534         .dev_clear = dev_clear,
 535         .config_get = config_get,
 536         .config_set = config_set,
 537         .config_list = config_list,
 538         .dev_open = dev_open,
 539         .dev_close = dev_close,
 540         .dev_acquisition_start = dev_acquisition_start,
 541         .dev_acquisition_stop = dev_acquisition_stop,
 542         .priv = NULL,
 543 };