src/hardware/brymen-bm86x/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
   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 "protocol.h"
  22
  23 #define BRYMEN_BC86X "0820.0001"
  24
  25 static const uint32_t scanopts[] = {
  26         SR_CONF_CONN,
  27 };
  28
  29 static const uint32_t drvopts[] = {
  30         SR_CONF_MULTIMETER,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  36         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  37 };
  38
  39 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  40 {
  41         GSList *usb_devices, *devices, *l;
  42         struct drv_context *drvc;
  43         struct dev_context *devc;
  44         struct sr_dev_inst *sdi;
  45         struct sr_usb_dev_inst *usb;
  46         struct sr_config *src;
  47         const char *conn;
  48
  49         drvc = di->context;
  50
  51         conn = BRYMEN_BC86X;
  52         for (l = options; l; l = l->next) {
  53                 src = l->data;
  54                 switch (src->key) {
  55                 case SR_CONF_CONN:
  56                         conn = g_variant_get_string(src->data, NULL);
  57                         break;
  58                 }
  59         }
  60
  61         devices = NULL;
  62         if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
  63                 g_slist_free_full(usb_devices, g_free);
  64                 return NULL;
  65         }
  66
  67         for (l = usb_devices; l; l = l->next) {
  68                 usb = l->data;
  69
  70                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
  71                 sdi->status = SR_ST_INACTIVE;
  72                 sdi->vendor = g_strdup("Brymen");
  73                 sdi->model = g_strdup("BM869");
  74                 devc = g_malloc0(sizeof(struct dev_context));
  75                 sdi->priv = devc;
  76                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
  77                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P2");
  78
  79                 sdi->inst_type = SR_INST_USB;
  80                 sdi->conn = usb;
  81
  82                 sr_sw_limits_init(&devc->sw_limits);
  83
  84                 devices = g_slist_append(devices, sdi);
  85         }
  86
  87         return std_scan_complete(di, devices);
  88 }
  89
  90 static int dev_open(struct sr_dev_inst *sdi)
  91 {
  92         struct sr_dev_driver *di = sdi->driver;
  93         struct drv_context *drvc = di->context;
  94         struct sr_usb_dev_inst *usb;
  95         struct dev_context *devc;
  96         int ret;
  97
  98         usb = sdi->conn;
  99         devc = sdi->priv;
 100
 101         if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) < 0)
 102                 return SR_ERR;
 103
 104         /* Detach kernel drivers which grabbed this device (if any). */
 105         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 106                 ret = libusb_detach_kernel_driver(usb->devhdl, 0);
 107                 if (ret < 0) {
 108                         sr_err("Failed to detach kernel driver: %s.",
 109                                libusb_error_name(ret));
 110                         return SR_ERR;
 111                 }
 112                 devc->detached_kernel_driver = 1;
 113         }
 114
 115         /* Claim interface 0. */
 116         if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
 117                 sr_err("Failed to claim interface 0: %s.",
 118                        libusb_error_name(ret));
 119                 return SR_ERR;
 120         }
 121
 122         return SR_OK;
 123 }
 124
 125 static int dev_close(struct sr_dev_inst *sdi)
 126 {
 127         struct sr_usb_dev_inst *usb;
 128         struct dev_context *devc;
 129         int ret;
 130
 131         usb = sdi->conn;
 132         devc = sdi->priv;
 133
 134         if ((ret = libusb_release_interface(usb->devhdl, 0)))
 135                 sr_err("Failed to release interface 0: %s.\n", libusb_error_name(ret));
 136
 137         if (!ret && devc->detached_kernel_driver) {
 138                 if ((ret = libusb_attach_kernel_driver(usb->devhdl, 0)))
 139                         sr_err("Failed to attach kernel driver: %s.\n",
 140                                libusb_error_name(ret));
 141                 else
 142                         devc->detached_kernel_driver = 0;
 143         }
 144
 145         libusb_close(usb->devhdl);
 146
 147         return (ret == 0) ? SR_OK : SR_ERR;
 148 }
 149
 150 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 151                 const struct sr_channel_group *cg)
 152 {
 153         struct dev_context *devc = sdi->priv;
 154
 155         (void)cg;
 156
 157         return sr_sw_limits_config_get(&devc->sw_limits, key, data);
 158 }
 159
 160 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 161                 const struct sr_channel_group *cg)
 162 {
 163         struct dev_context *devc;
 164
 165         (void)cg;
 166
 167         devc = sdi->priv;
 168
 169         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 170 }
 171
 172 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 173                 const struct sr_channel_group *cg)
 174 {
 175         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 176 }
 177
 178 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 179 {
 180         struct dev_context *devc;
 181
 182         devc = sdi->priv;
 183
 184         sr_sw_limits_acquisition_start(&devc->sw_limits);
 185
 186         std_session_send_df_header(sdi);
 187
 188         sr_session_source_add(sdi->session, -1, 0, 10,
 189                         brymen_bm86x_receive_data, (void *)sdi);
 190
 191         return SR_OK;
 192 }
 193
 194 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 195 {
 196         std_session_send_df_end(sdi);
 197
 198         sr_session_source_remove(sdi->session, -1);
 199
 200         return SR_OK;
 201 }
 202
 203 static struct sr_dev_driver brymen_bm86x_driver_info = {
 204         .name = "brymen-bm86x",
 205         .longname = "Brymen BM86X",
 206         .api_version = 1,
 207         .init = std_init,
 208         .cleanup = std_cleanup,
 209         .scan = scan,
 210         .dev_list = std_dev_list,
 211         .dev_clear = std_dev_clear,
 212         .config_get = config_get,
 213         .config_set = config_set,
 214         .config_list = config_list,
 215         .dev_open = dev_open,
 216         .dev_close = dev_close,
 217         .dev_acquisition_start = dev_acquisition_start,
 218         .dev_acquisition_stop = dev_acquisition_stop,
 219         .context = NULL,
 220 };
 221 SR_REGISTER_DEV_DRIVER(brymen_bm86x_driver_info);