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         sdi->status = SR_ST_ACTIVE;
 166
 167         return SR_OK;
 168 }
 169
 170 static int dev_close(struct sr_dev_inst *sdi)
 171 {
 172         struct sr_usb_dev_inst *usb;
 173
 174         usb = sdi->conn;
 175         if (!usb->devhdl)
 176                 /* Nothing to do. */
 177                 return SR_OK;
 178
 179         libusb_release_interface(usb->devhdl, 0);
 180         libusb_close(usb->devhdl);
 181         usb->devhdl = NULL;
 182         sdi->status = SR_ST_INACTIVE;
 183
 184         return SR_OK;
 185 }
 186
 187 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 188                 const struct sr_channel_group *cg)
 189 {
 190         struct dev_context *devc = sdi->priv;
 191         struct sr_usb_dev_inst *usb;
 192         char str[128];
 193
 194         (void)cg;
 195
 196         switch (key) {
 197         case SR_CONF_CONN:
 198                 if (!sdi || !sdi->conn)
 199                         return SR_ERR_ARG;
 200                 usb = sdi->conn;
 201                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 202                 *data = g_variant_new_string(str);
 203                 break;
 204         case SR_CONF_LIMIT_MSEC:
 205         case SR_CONF_LIMIT_SAMPLES:
 206                 return sr_sw_limits_config_get(&devc->sw_limits, key, data);
 207         default:
 208                 return SR_ERR_NA;
 209         }
 210
 211         return SR_OK;
 212 }
 213
 214 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 215                 const struct sr_channel_group *cg)
 216 {
 217         struct dev_context *devc = sdi->priv;
 218
 219         (void)cg;
 220
 221         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 222 }
 223
 224 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 225                 const struct sr_channel_group *cg)
 226 {
 227         (void)sdi;
 228         (void)cg;
 229
 230         switch (key) {
 231         case SR_CONF_SCAN_OPTIONS:
 232                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 233                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 234                 break;
 235         case SR_CONF_DEVICE_OPTIONS:
 236                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 237                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 238                 break;
 239         default:
 240                 return SR_ERR_NA;
 241         }
 242
 243         return SR_OK;
 244 }
 245
 246 static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
 247 {
 248         struct dev_context *devc;
 249         int packet_size;
 250         uint16_t crc;
 251
 252         devc = sdi->priv;
 253
 254         if (devc->reply_size + len > MAX_REPLY_SIZE) {
 255                 /* Something went very wrong. */
 256                 sr_dbg("Receive buffer overrun.");
 257                 devc->reply_size = 0;
 258                 return;
 259         }
 260
 261         memcpy(devc->reply + devc->reply_size, data, len);
 262         devc->reply_size += len;
 263         /* Sixth byte contains the length of the packet. */
 264         if (devc->reply_size < 7)
 265                 return;
 266
 267         packet_size = 7 + devc->reply[6] * 7 + 2;
 268         if (devc->reply_size < packet_size)
 269                 return;
 270
 271         if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
 272                 return;
 273
 274         crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
 275         if (crc == RL16(&devc->reply[devc->reply_size - 2])) {
 276                 testo_receive_packet(sdi);
 277                 sr_sw_limits_update_samples_read(&devc->sw_limits, 1);
 278         } else {
 279                 sr_dbg("Packet has invalid CRC.");
 280         }
 281
 282         devc->reply_size = 0;
 283         if (sr_sw_limits_check(&devc->sw_limits))
 284                 sr_dev_acquisition_stop(sdi);
 285         else
 286                 testo_request_packet(sdi);
 287
 288 }
 289
 290 SR_PRIV void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
 291 {
 292         struct dev_context *devc;
 293         struct sr_dev_inst *sdi;
 294         int ret;
 295
 296         sdi = transfer->user_data;
 297         devc = sdi->priv;
 298         if (transfer == devc->out_transfer)
 299                 /* Just the command acknowledgement. */
 300                 return;
 301
 302         if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
 303                 /* USB device was unplugged. */
 304                 sr_dev_acquisition_stop(sdi);
 305         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
 306                 /* First two bytes in any transfer are FTDI status bytes. */
 307                 if (transfer->actual_length > 2)
 308                         receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
 309         }
 310         /* Anything else is either an error or a timeout, which is fine:
 311          * we were just going to send another transfer request anyway. */
 312
 313         if (sdi->status == SR_ST_ACTIVE) {
 314                 if ((ret = libusb_submit_transfer(transfer) != 0)) {
 315                         sr_err("Unable to resubmit transfer: %s.",
 316                                libusb_error_name(ret));
 317                         g_free(transfer->buffer);
 318                         libusb_free_transfer(transfer);
 319                         sr_dev_acquisition_stop(sdi);
 320                 }
 321         } else {
 322                 /* This was the last transfer we're going to receive, so
 323                  * clean up now. */
 324                 g_free(transfer->buffer);
 325                 libusb_free_transfer(transfer);
 326         }
 327 }
 328
 329 static int handle_events(int fd, int revents, void *cb_data)
 330 {
 331         struct sr_dev_driver *di;
 332         struct dev_context *devc;
 333         struct drv_context *drvc;
 334         struct sr_dev_inst *sdi;
 335         struct timeval tv;
 336
 337         (void)fd;
 338         (void)revents;
 339
 340         sdi = cb_data;
 341         devc = sdi->priv;
 342         di = sdi->driver;
 343         drvc = di->context;
 344
 345         if (sr_sw_limits_check(&devc->sw_limits))
 346                 sr_dev_acquisition_stop(sdi);
 347
 348         if (sdi->status == SR_ST_STOPPING) {
 349                 usb_source_remove(sdi->session, drvc->sr_ctx);
 350                 dev_close(sdi);
 351                 std_session_send_df_end(sdi);
 352         }
 353
 354         memset(&tv, 0, sizeof(struct timeval));
 355         libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
 356                         NULL);
 357
 358         return TRUE;
 359 }
 360
 361 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 362 {
 363         struct sr_dev_driver *di = sdi->driver;
 364         struct drv_context *drvc;
 365         struct dev_context *devc;
 366         struct sr_usb_dev_inst *usb;
 367         struct libusb_transfer *transfer;
 368         int ret;
 369         unsigned char *buf;
 370
 371         drvc = di->context;
 372         devc = sdi->priv;
 373         usb = sdi->conn;
 374         devc->reply_size = 0;
 375
 376         std_session_send_df_header(sdi);
 377
 378         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 379                         handle_events, (void *)sdi);
 380
 381         if (testo_set_serial_params(usb) != SR_OK)
 382                 return SR_ERR;
 383
 384         devc->out_transfer = libusb_alloc_transfer(0);
 385         if (testo_request_packet(sdi) != SR_OK)
 386                 return SR_ERR;
 387
 388         buf = g_malloc(MAX_REPLY_SIZE);
 389         transfer = libusb_alloc_transfer(0);
 390         libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
 391                         MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
 392         if ((ret = libusb_submit_transfer(transfer) != 0)) {
 393                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 394                 libusb_free_transfer(transfer);
 395                 g_free(buf);
 396                 return SR_ERR;
 397         }
 398         devc->reply_size = 0;
 399
 400         sr_sw_limits_acquisition_start(&devc->sw_limits);
 401
 402         return SR_OK;
 403 }
 404
 405 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 406 {
 407         sdi->status = SR_ST_STOPPING;
 408
 409         return SR_OK;
 410 }
 411
 412 static struct sr_dev_driver testo_driver_info = {
 413         .name = "testo",
 414         .longname = "Testo",
 415         .api_version = 1,
 416         .init = std_init,
 417         .cleanup = std_cleanup,
 418         .scan = scan,
 419         .dev_list = std_dev_list,
 420         .config_get = config_get,
 421         .config_set = config_set,
 422         .config_list = config_list,
 423         .dev_open = dev_open,
 424         .dev_close = dev_close,
 425         .dev_acquisition_start = dev_acquisition_start,
 426         .dev_acquisition_stop = dev_acquisition_stop,
 427         .context = NULL,
 428 };
 429 SR_REGISTER_DEV_DRIVER(testo_driver_info);