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