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 static const uint32_t scanopts[] = {
  27         SR_CONF_CONN,
  28 };
  29
  30 static const uint32_t devopts[] = {
  31         SR_CONF_MULTIMETER,
  32         SR_CONF_CONTINUOUS,
  33         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_GET,
  34         SR_CONF_LIMIT_MSEC | SR_CONF_SET | SR_CONF_GET,
  35 };
  36
  37 static const uint8_t TESTO_x35_REQUEST[] = { 0x12, 0, 0, 0, 1, 1, 0x55, 0xd1, 0xb7 };
  38
  39 static const struct testo_model models[] = {
  40         { "435", 9, TESTO_x35_REQUEST },
  41 };
  42
  43 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  44 {
  45         struct drv_context *drvc;
  46         struct dev_context *devc;
  47         struct sr_config *src;
  48         struct sr_dev_inst *sdi;
  49         struct sr_usb_dev_inst *usb;
  50         struct libusb_device_descriptor des;
  51         libusb_device **devlist;
  52         struct libusb_device_handle *hdl;
  53         GSList *conn_devices, *devices, *l;
  54         int ret, i;
  55         const char *str;
  56         char manufacturer[64], product[64], connection_id[64];
  57
  58         devices = NULL;
  59         drvc = di->context;
  60
  61         conn_devices = NULL;
  62         for (l = options; l; l = l->next) {
  63                 src = l->data;
  64                 if (src->key != SR_CONF_CONN)
  65                         continue;
  66                 str = g_variant_get_string(src->data, NULL);
  67                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, str);
  68         }
  69
  70         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
  71         for (i = 0; devlist[i]; i++) {
  72                 if (conn_devices) {
  73                         usb = NULL;
  74                         for (l = conn_devices; l; l = l->next) {
  75                                 usb = l->data;
  76                                 if (usb->bus == libusb_get_bus_number(devlist[i])
  77                                         && usb->address == libusb_get_device_address(devlist[i]))
  78                                         break;
  79                         }
  80                         if (!l)
  81                                 /* This device matched none of the ones that
  82                                  * matched the conn specification. */
  83                                 continue;
  84                 }
  85
  86                 libusb_get_device_descriptor(devlist[i], &des);
  87
  88                 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
  89                         continue;
  90
  91                 manufacturer[0] = product[0] = '\0';
  92                 if (des.iManufacturer && (ret = libusb_get_string_descriptor_ascii(
  93                                 hdl, des.iManufacturer, (unsigned char *) manufacturer,
  94                                 sizeof(manufacturer))) < 0) {
  95                         sr_warn("Failed to get manufacturer string descriptor: %s.",
  96                                 libusb_error_name(ret));
  97                 }
  98                 if (des.iProduct && (ret = libusb_get_string_descriptor_ascii(
  99                                 hdl, des.iProduct, (unsigned char *) product,
 100                                 sizeof(product))) < 0) {
 101                         sr_warn("Failed to get product string descriptor: %s.",
 102                                 libusb_error_name(ret));
 103                 }
 104                 libusb_close(hdl);
 105
 106                 if (strncmp(manufacturer, "testo", 5))
 107                         continue;
 108
 109                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 110
 111                 /* Hardcode the 435 for now.*/
 112                 if (strcmp(product, "testo 435/635/735"))
 113                         continue;
 114
 115                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 116                 sdi->status = SR_ST_INACTIVE;
 117                 sdi->vendor = g_strdup("Testo");
 118                 sdi->model = g_strdup("435/635/735");
 119                 sdi->driver = di;
 120                 sdi->inst_type = SR_INST_USB;
 121                 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 122                                 libusb_get_device_address(devlist[i]), NULL);
 123                 sdi->connection_id = g_strdup(connection_id);
 124                 devc = g_malloc(sizeof(struct dev_context));
 125                 devc->model = &models[0];
 126                 sr_sw_limits_init(&devc->sw_limits);
 127                 sdi->priv = devc;
 128                 if (testo_probe_channels(sdi) != SR_OK)
 129                         continue;
 130                 devices = g_slist_append(devices, sdi);
 131         }
 132         libusb_free_device_list(devlist, 1);
 133         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 134
 135         return std_scan_complete(di, devices);
 136 }
 137
 138 static int dev_open(struct sr_dev_inst *sdi)
 139 {
 140         struct sr_dev_driver *di = sdi->driver;
 141         struct drv_context *drvc = di->context;
 142         struct sr_usb_dev_inst *usb;
 143         int ret;
 144
 145         usb = sdi->conn;
 146
 147         ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
 148         if (ret != SR_OK)
 149                 return ret;
 150
 151         if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
 152                 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 153                         if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
 154                                 sr_err("Failed to detach kernel driver: %s.",
 155                                            libusb_error_name(ret));
 156                                 return SR_ERR;
 157                         }
 158                 }
 159         }
 160
 161         if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
 162                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 163                 return SR_ERR;
 164         }
 165
 166         return SR_OK;
 167 }
 168
 169 static int dev_close(struct sr_dev_inst *sdi)
 170 {
 171         struct sr_usb_dev_inst *usb;
 172
 173         usb = sdi->conn;
 174
 175         if (!usb->devhdl)
 176                 return SR_ERR_BUG;
 177
 178         libusb_release_interface(usb->devhdl, 0);
 179         libusb_close(usb->devhdl);
 180         usb->devhdl = NULL;
 181
 182         return SR_OK;
 183 }
 184
 185 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 186                 const struct sr_channel_group *cg)
 187 {
 188         struct dev_context *devc = sdi->priv;
 189         struct sr_usb_dev_inst *usb;
 190         char str[128];
 191
 192         (void)cg;
 193
 194         switch (key) {
 195         case SR_CONF_CONN:
 196                 if (!sdi || !sdi->conn)
 197                         return SR_ERR_ARG;
 198                 usb = sdi->conn;
 199                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 200                 *data = g_variant_new_string(str);
 201                 break;
 202         case SR_CONF_LIMIT_MSEC:
 203         case SR_CONF_LIMIT_SAMPLES:
 204                 return sr_sw_limits_config_get(&devc->sw_limits, key, data);
 205         default:
 206                 return SR_ERR_NA;
 207         }
 208
 209         return SR_OK;
 210 }
 211
 212 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 213                 const struct sr_channel_group *cg)
 214 {
 215         struct dev_context *devc = sdi->priv;
 216
 217         (void)cg;
 218
 219         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 220 }
 221
 222 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 223                 const struct sr_channel_group *cg)
 224 {
 225         (void)sdi;
 226         (void)cg;
 227
 228         switch (key) {
 229         case SR_CONF_SCAN_OPTIONS:
 230                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 231                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 232                 break;
 233         case SR_CONF_DEVICE_OPTIONS:
 234                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 235                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 236                 break;
 237         default:
 238                 return SR_ERR_NA;
 239         }
 240
 241         return SR_OK;
 242 }
 243
 244 static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
 245 {
 246         struct dev_context *devc;
 247         int packet_size;
 248         uint16_t crc;
 249
 250         devc = sdi->priv;
 251
 252         if (devc->reply_size + len > MAX_REPLY_SIZE) {
 253                 /* Something went very wrong. */
 254                 sr_dbg("Receive buffer overrun.");
 255                 devc->reply_size = 0;
 256                 return;
 257         }
 258
 259         memcpy(devc->reply + devc->reply_size, data, len);
 260         devc->reply_size += len;
 261         /* Sixth byte contains the length of the packet. */
 262         if (devc->reply_size < 7)
 263                 return;
 264
 265         packet_size = 7 + devc->reply[6] * 7 + 2;
 266         if (devc->reply_size < packet_size)
 267                 return;
 268
 269         if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
 270                 return;
 271
 272         crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
 273         if (crc == RL16(&devc->reply[devc->reply_size - 2])) {
 274                 testo_receive_packet(sdi);
 275                 sr_sw_limits_update_samples_read(&devc->sw_limits, 1);
 276         } else {
 277                 sr_dbg("Packet has invalid CRC.");
 278         }
 279
 280         devc->reply_size = 0;
 281         if (sr_sw_limits_check(&devc->sw_limits))
 282                 sr_dev_acquisition_stop(sdi);
 283         else
 284                 testo_request_packet(sdi);
 285
 286 }
 287
 288 SR_PRIV void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
 289 {
 290         struct dev_context *devc;
 291         struct sr_dev_inst *sdi;
 292         int ret;
 293
 294         sdi = transfer->user_data;
 295         devc = sdi->priv;
 296         if (transfer == devc->out_transfer)
 297                 /* Just the command acknowledgement. */
 298                 return;
 299
 300         if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
 301                 /* USB device was unplugged. */
 302                 sr_dev_acquisition_stop(sdi);
 303         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
 304                 /* First two bytes in any transfer are FTDI status bytes. */
 305                 if (transfer->actual_length > 2)
 306                         receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
 307         }
 308         /* Anything else is either an error or a timeout, which is fine:
 309          * we were just going to send another transfer request anyway. */
 310
 311         if (sdi->status == SR_ST_ACTIVE) {
 312                 if ((ret = libusb_submit_transfer(transfer) != 0)) {
 313                         sr_err("Unable to resubmit transfer: %s.",
 314                                libusb_error_name(ret));
 315                         g_free(transfer->buffer);
 316                         libusb_free_transfer(transfer);
 317                         sr_dev_acquisition_stop(sdi);
 318                 }
 319         } else {
 320                 /* This was the last transfer we're going to receive, so
 321                  * clean up now. */
 322                 g_free(transfer->buffer);
 323                 libusb_free_transfer(transfer);
 324         }
 325 }
 326
 327 static int handle_events(int fd, int revents, void *cb_data)
 328 {
 329         struct sr_dev_driver *di;
 330         struct dev_context *devc;
 331         struct drv_context *drvc;
 332         struct sr_dev_inst *sdi;
 333         struct timeval tv;
 334
 335         (void)fd;
 336         (void)revents;
 337
 338         sdi = cb_data;
 339         devc = sdi->priv;
 340         di = sdi->driver;
 341         drvc = di->context;
 342
 343         if (sr_sw_limits_check(&devc->sw_limits))
 344                 sr_dev_acquisition_stop(sdi);
 345
 346         if (sdi->status == SR_ST_STOPPING) {
 347                 usb_source_remove(sdi->session, drvc->sr_ctx);
 348                 dev_close(sdi);
 349                 std_session_send_df_end(sdi);
 350         }
 351
 352         memset(&tv, 0, sizeof(struct timeval));
 353         libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
 354                         NULL);
 355
 356         return TRUE;
 357 }
 358
 359 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 360 {
 361         struct sr_dev_driver *di = sdi->driver;
 362         struct drv_context *drvc;
 363         struct dev_context *devc;
 364         struct sr_usb_dev_inst *usb;
 365         struct libusb_transfer *transfer;
 366         int ret;
 367         unsigned char *buf;
 368
 369         drvc = di->context;
 370         devc = sdi->priv;
 371         usb = sdi->conn;
 372         devc->reply_size = 0;
 373
 374         std_session_send_df_header(sdi);
 375
 376         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 377                         handle_events, (void *)sdi);
 378
 379         if (testo_set_serial_params(usb) != SR_OK)
 380                 return SR_ERR;
 381
 382         devc->out_transfer = libusb_alloc_transfer(0);
 383         if (testo_request_packet(sdi) != SR_OK)
 384                 return SR_ERR;
 385
 386         buf = g_malloc(MAX_REPLY_SIZE);
 387         transfer = libusb_alloc_transfer(0);
 388         libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
 389                         MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
 390         if ((ret = libusb_submit_transfer(transfer) != 0)) {
 391                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 392                 libusb_free_transfer(transfer);
 393                 g_free(buf);
 394                 return SR_ERR;
 395         }
 396         devc->reply_size = 0;
 397
 398         sr_sw_limits_acquisition_start(&devc->sw_limits);
 399
 400         return SR_OK;
 401 }
 402
 403 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 404 {
 405         sdi->status = SR_ST_STOPPING;
 406
 407         return SR_OK;
 408 }
 409
 410 static struct sr_dev_driver testo_driver_info = {
 411         .name = "testo",
 412         .longname = "Testo",
 413         .api_version = 1,
 414         .init = std_init,
 415         .cleanup = std_cleanup,
 416         .scan = scan,
 417         .dev_list = std_dev_list,
 418         .config_get = config_get,
 419         .config_set = config_set,
 420         .config_list = config_list,
 421         .dev_open = dev_open,
 422         .dev_close = dev_close,
 423         .dev_acquisition_start = dev_acquisition_start,
 424         .dev_acquisition_stop = dev_acquisition_stop,
 425         .context = NULL,
 426 };
 427 SR_REGISTER_DEV_DRIVER(testo_driver_info);