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