]> sigrok.org Git - libsigrok.git/blobdiff - hardware/testo/api.c
testo: Initial driver implementation.
[libsigrok.git] / hardware / testo / api.c
index bb529f8af0c0a834c195eba6f665d5d00b1e1667..8d6c4fc5d606a137cbddd6c29a96c47f73160396 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <string.h>
+#include <libserialport.h>
 #include "protocol.h"
 
+#define SERIALCOMM "115200/8n1"
+
 SR_PRIV struct sr_dev_driver testo_driver_info;
 static struct sr_dev_driver *di = &testo_driver_info;
+static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
+
+static const int32_t scanopts[] = {
+       SR_CONF_CONN,
+};
+
+static const int32_t devopts[] = {
+       SR_CONF_MULTIMETER,
+       SR_CONF_LIMIT_MSEC,
+       SR_CONF_LIMIT_SAMPLES,
+       SR_CONF_CONTINUOUS,
+};
+
+unsigned char TESTO_x35_REQUEST[] = { 0x12, 0, 0, 0, 1, 1, 0x55, 0xd1, 0xb7 };
+struct testo_model models[] = {
+       { "435", 9, TESTO_x35_REQUEST },
+};
 
 static int init(struct sr_context *sr_ctx)
 {
@@ -30,16 +51,97 @@ static int init(struct sr_context *sr_ctx)
 static GSList *scan(GSList *options)
 {
        struct drv_context *drvc;
-       GSList *devices;
-
-       (void)options;
+       struct dev_context *devc;
+       struct sr_config *src;
+       struct sr_dev_inst *sdi;
+       struct sr_usb_dev_inst *usb;
+       struct libusb_device_descriptor des;
+       libusb_device **devlist;
+       struct libusb_device_handle *hdl;
+       GSList *conn_devices, *devices, *l;
+       int devcnt, ret, i;
+       const char *str;
+       char manufacturer[64], product[64];
 
        devices = NULL;
        drvc = di->priv;
        drvc->instances = NULL;
 
-       /* TODO: scan for devices, either based on a SR_CONF_CONN option
-        * or on a USB scan. */
+       conn_devices = NULL;
+       for (l = options; l; l = l->next) {
+               src = l->data;
+               if (src->key != SR_CONF_CONN)
+                       continue;
+               str = g_variant_get_string(src->data, NULL);
+               conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, str);
+       }
+
+       libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
+       for (i = 0; devlist[i]; i++) {
+               if (conn_devices) {
+                       usb = NULL;
+                       for (l = conn_devices; l; l = l->next) {
+                               usb = l->data;
+                               if (usb->bus == libusb_get_bus_number(devlist[i])
+                                       && usb->address == libusb_get_device_address(devlist[i]))
+                                       break;
+                       }
+                       if (!l)
+                               /* This device matched none of the ones that
+                                * matched the conn specification. */
+                               continue;
+               }
+
+               if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
+                       sr_warn("Failed to get device descriptor: %s.",
+                               libusb_error_name(ret));
+                       continue;
+               }
+
+               if ((ret = libusb_open(devlist[i], &hdl)) < 0)
+                       continue;
+
+               manufacturer[0] = product[0] = '\0';
+               if (des.iManufacturer && (ret = libusb_get_string_descriptor_ascii(
+                               hdl, des.iManufacturer, (unsigned char *) manufacturer,
+                               sizeof(manufacturer))) < 0) {
+                       sr_warn("Failed to get manufacturer string descriptor: %s.",
+                               libusb_error_name(ret));
+               }
+               if (des.iProduct && (ret = libusb_get_string_descriptor_ascii(
+                               hdl, des.iProduct, (unsigned char *) product,
+                               sizeof(product))) < 0) {
+                       sr_warn("Failed to get product string descriptor: %s.",
+                               libusb_error_name(ret));
+               }
+               libusb_close(hdl);
+
+               if (strncmp(manufacturer, "testo", 5))
+                       continue;
+
+               /* Hardcode the 435 for now.*/
+               if (strcmp(product, "testo 435/635/735"))
+                       continue;
+
+               devcnt = g_slist_length(drvc->instances);
+               sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE, "Testo",
+                               "435/635/735", NULL);
+               sdi->driver = di;
+               sdi->inst_type = SR_INST_USB;
+               sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
+                               libusb_get_device_address(devlist[i]), NULL);
+               devc = g_malloc(sizeof(struct dev_context));
+               devc->model = &models[0];
+               devc->limit_msec = 0;
+               devc->limit_samples = 0;
+               sdi->priv = devc;
+               if (testo_probe_channels(sdi) != SR_OK)
+                       continue;
+               drvc->instances = g_slist_append(drvc->instances, sdi);
+               devices = g_slist_append(devices, sdi);
+       }
+       libusb_free_device_list(devlist, 1);
+       g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 
        return devices;
 }
@@ -56,10 +158,38 @@ static int dev_clear(void)
 
 static int dev_open(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct drv_context *drvc = di->priv;
+       struct sr_usb_dev_inst *usb;
+       libusb_device **devlist;
+       int ret, i;
+
+       if (!di->priv) {
+               sr_err("Driver was not initialized.");
+               return SR_ERR;
+       }
 
-       /* TODO: get handle from sdi->conn and open it. */
+       usb = sdi->conn;
+       libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
+       for (i = 0; devlist[i]; i++) {
+               if (libusb_get_bus_number(devlist[i]) != usb->bus
+                               || libusb_get_device_address(devlist[i]) != usb->address)
+                       continue;
+               if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
+                       sr_err("Failed to open device: %s.", libusb_error_name(ret));
+                       return SR_ERR;
+               }
+               break;
+       }
+       libusb_free_device_list(devlist, 1);
+       if (!devlist[i]) {
+               sr_err("Device not found.");
+               return SR_ERR;
+       }
 
+       if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
+               sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
+               return SR_ERR;
+       }
        sdi->status = SR_ST_ACTIVE;
 
        return SR_OK;
@@ -67,10 +197,21 @@ static int dev_open(struct sr_dev_inst *sdi)
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct sr_usb_dev_inst *usb;
+
+       if (!di->priv) {
+               sr_err("Driver was not initialized.");
+               return SR_ERR;
+       }
 
-       /* TODO: get handle from sdi->conn and close it. */
+       usb = sdi->conn;
+       if (!usb->devhdl)
+               /*  Nothing to do. */
+               return SR_OK;
 
+       libusb_release_interface(usb->devhdl, 0);
+       libusb_close(usb->devhdl);
+       usb->devhdl = NULL;
        sdi->status = SR_ST_INACTIVE;
 
        return SR_OK;
@@ -78,46 +219,74 @@ static int dev_close(struct sr_dev_inst *sdi)
 
 static int cleanup(void)
 {
-       dev_clear();
+       int ret;
+       struct drv_context *drvc;
 
-       /* TODO: free other driver resources, if any. */
+       if (!(drvc = di->priv))
+               return SR_OK;
 
-       return SR_OK;
+       ret = dev_clear();
+       g_free(drvc);
+       di->priv = NULL;
+
+       return ret;
 }
 
 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
-       int ret;
+       struct sr_usb_dev_inst *usb;
+       char str[128];
 
-       (void)sdi;
-       (void)data;
        (void)cg;
 
-       ret = SR_OK;
        switch (key) {
-       /* TODO */
+       case SR_CONF_CONN:
+               if (!sdi || !sdi->conn)
+                       return SR_ERR_ARG;
+               usb = sdi->conn;
+               snprintf(str, 128, "%d.%d", usb->bus, usb->address);
+               *data = g_variant_new_string(str);
+               break;
        default:
                return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
+       struct dev_context *devc;
+       gint64 now;
        int ret;
 
-       (void)data;
        (void)cg;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
+       if (!di->priv) {
+               sr_err("Driver was not initialized.");
+               return SR_ERR;
+       }
+
+       devc = sdi->priv;
        ret = SR_OK;
        switch (key) {
-       /* TODO */
+       case SR_CONF_LIMIT_MSEC:
+               devc->limit_msec = g_variant_get_uint64(data);
+               now = g_get_monotonic_time() / 1000;
+               devc->end_time = now + devc->limit_msec;
+               sr_dbg("Setting time limit to %" PRIu64 "ms.",
+                      devc->limit_msec);
+               break;
+       case SR_CONF_LIMIT_SAMPLES:
+               devc->limit_samples = g_variant_get_uint64(data);
+               sr_dbg("Setting sample limit to %" PRIu64 ".",
+                      devc->limit_samples);
+               break;
        default:
                ret = SR_ERR_NA;
        }
@@ -128,33 +297,181 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
-       int ret;
-
        (void)sdi;
-       (void)data;
        (void)cg;
 
-       ret = SR_OK;
        switch (key) {
-       /* TODO */
+       case SR_CONF_SCAN_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               scanopts, ARRAY_SIZE(scanopts), sizeof(int32_t));
+               break;
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               devopts, ARRAY_SIZE(devopts), sizeof(int32_t));
+               break;
        default:
                return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
 {
-       (void)sdi;
-       (void)cb_data;
+       struct dev_context *devc;
+       int packet_size;
+
+       devc = sdi->priv;
+
+       if (devc->reply_size + len > MAX_REPLY_SIZE) {
+               /* Something went very wrong. */
+               sr_dbg("Receive buffer overrun.");
+               devc->reply_size = 0;
+               return;
+       }
+
+       memcpy(devc->reply + devc->reply_size, data, len);
+       devc->reply_size += len;
+       /* Sixth byte contains the length of the packet. */
+       if (devc->reply_size >= 7) {
+               packet_size = 7 + devc->reply[6] * 7 + 2;
+               if (devc->reply_size >= packet_size) {
+                       testo_receive_packet(sdi);
+                       devc->num_samples++;
+                       devc->reply_size = 0;
+                       if (devc->limit_samples && devc->num_samples >= devc->limit_samples)
+                               dev_acquisition_stop(sdi, devc->cb_data);
+                       else
+                               testo_request_packet(sdi);
+               }
+       }
+
+}
+
+SR_PRIV void receive_transfer(struct libusb_transfer *transfer)
+{
+       struct dev_context *devc;
+       struct sr_dev_inst *sdi;
+       int ret;
+
+       sdi = transfer->user_data;
+       devc = sdi->priv;
+       if (transfer == devc->out_transfer)
+               /* Just the command acknowledgement. */
+               return;
+
+       if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
+               /* USB device was unplugged. */
+               dev_acquisition_stop(sdi, devc->cb_data);
+       } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
+               /* First two bytes in any transfer are FTDI status bytes. */
+               if (transfer->actual_length > 2)
+                       receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
+       }
+       /* Anything else is either an error or a timeout, which is fine:
+        * we were just going to send another transfer request anyway. */
+
+       if (sdi->status == SR_ST_ACTIVE) {
+               if ((ret = libusb_submit_transfer(transfer) != 0)) {
+                       sr_err("Unable to resubmit transfer: %s.",
+                              libusb_error_name(ret));
+                       g_free(transfer->buffer);
+                       libusb_free_transfer(transfer);
+                       dev_acquisition_stop(sdi, devc->cb_data);
+               }
+       } else {
+               /* This was the last transfer we're going to receive, so
+                * clean up now. */
+               g_free(transfer->buffer);
+               libusb_free_transfer(transfer);
+       }
+}
+
+static int handle_events(int fd, int revents, void *cb_data)
+{
+       struct dev_context *devc;
+       struct drv_context *drvc = di->priv;
+       struct sr_datafeed_packet packet;
+       struct sr_dev_inst *sdi;
+       struct timeval tv;
+       gint64 now;
+
+       (void)fd;
+       (void)revents;
+
+       sdi = cb_data;
+       devc = sdi->priv;
+
+       if (devc->limit_msec) {
+               now = g_get_monotonic_time() / 1000;
+               if (now > devc->end_time)
+                       dev_acquisition_stop(sdi, devc->cb_data);
+       }
+
+       if (sdi->status == SR_ST_STOPPING) {
+               usb_source_remove(drvc->sr_ctx);
+
+               dev_close(sdi);
+
+               packet.type = SR_DF_END;
+               sr_session_send(sdi, &packet);
+       }
+
+       memset(&tv, 0, sizeof(struct timeval));
+       libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
+                       NULL);
+
+       return TRUE;
+}
+
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
+{
+       struct drv_context *drvc;
+       struct dev_context *devc;
+       struct sr_usb_dev_inst *usb;
+       struct libusb_transfer *transfer;
+       int ret;
+       unsigned char *buf;
 
+       drvc = di->priv;
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       /* TODO: configure hardware, reset acquisition state, set up
-        * callbacks and send header packet. */
+       if (!di->priv) {
+               sr_err("Driver was not initialized.");
+               return SR_ERR;
+       }
+
+       devc = sdi->priv;
+       usb = sdi->conn;
+       devc->cb_data = cb_data;
+       devc->end_time = 0;
+       devc->num_samples = 0;
+       devc->reply_size = 0;
+
+       /* Send header packet to the session bus. */
+       std_session_send_df_header(cb_data, LOG_PREFIX);
+
+       usb_source_add(drvc->sr_ctx, 100, handle_events, (void *)sdi);
+
+       if (testo_set_serial_params(usb) != SR_OK)
+               return SR_ERR;
+
+       devc->out_transfer = libusb_alloc_transfer(0);
+       if (testo_request_packet(sdi) != SR_OK)
+               return SR_ERR;
+
+       buf = g_try_malloc(MAX_REPLY_SIZE);
+       transfer = libusb_alloc_transfer(0);
+       libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
+                       MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
+       if ((ret = libusb_submit_transfer(transfer) != 0)) {
+               sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
+               libusb_free_transfer(transfer);
+               g_free(buf);
+               return SR_ERR;
+       }
+       devc->reply_size = 0;
 
        return SR_OK;
 }
@@ -163,10 +480,15 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        (void)cb_data;
 
+       if (!di->priv) {
+               sr_err("Driver was not initialized.");
+               return SR_ERR;
+       }
+
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       /* TODO: stop acquisition. */
+       sdi->status = SR_ST_STOPPING;
 
        return SR_OK;
 }