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