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