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 devopts[] = {
  30         SR_CONF_MULTIMETER,
  31         SR_CONF_CONTINUOUS,
  32         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  33         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  34 };
  35
  36 SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info;
  37
  38 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  39 {
  40         return std_init(sr_ctx, di, LOG_PREFIX);
  41 }
  42
  43 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  44 {
  45         GSList *usb_devices, *devices, *l;
  46         struct drv_context *drvc;
  47         struct dev_context *devc;
  48         struct sr_dev_inst *sdi;
  49         struct sr_usb_dev_inst *usb;
  50         struct sr_config *src;
  51         const char *conn;
  52
  53         drvc = di->context;
  54         drvc->instances = NULL;
  55
  56         conn = BRYMEN_BC86X;
  57         for (l = options; l; l = l->next) {
  58                 src = l->data;
  59                 switch (src->key) {
  60                 case SR_CONF_CONN:
  61                         conn = g_variant_get_string(src->data, NULL);
  62                         break;
  63                 }
  64         }
  65
  66         devices = NULL;
  67         if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
  68                 g_slist_free_full(usb_devices, g_free);
  69                 return NULL;
  70         }
  71
  72         for (l = usb_devices; l; l = l->next) {
  73                 usb = l->data;
  74
  75                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
  76                 sdi->status = SR_ST_INACTIVE;
  77                 sdi->vendor = g_strdup("Brymen");
  78                 sdi->model = g_strdup("BM869");
  79                 devc = g_malloc0(sizeof(struct dev_context));
  80                 sdi->priv = devc;
  81                 sdi->driver = di;
  82                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
  83                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P2");
  84
  85                 sdi->inst_type = SR_INST_USB;
  86                 sdi->conn = usb;
  87
  88                 sr_sw_limits_init(&devc->sw_limits);
  89
  90                 drvc->instances = g_slist_append(drvc->instances, sdi);
  91                 devices = g_slist_append(devices, sdi);
  92         }
  93
  94         return devices;
  95 }
  96
  97 static int dev_open(struct sr_dev_inst *sdi)
  98 {
  99         struct sr_dev_driver *di = sdi->driver;
 100         struct drv_context *drvc = di->context;
 101         struct sr_usb_dev_inst *usb;
 102         struct dev_context *devc;
 103         int ret;
 104
 105         usb = sdi->conn;
 106         devc = sdi->priv;
 107
 108         if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
 109                 sdi->status = SR_ST_ACTIVE;
 110         else
 111                 return SR_ERR;
 112
 113         /* Detach kernel drivers which grabbed this device (if any). */
 114         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 115                 ret = libusb_detach_kernel_driver(usb->devhdl, 0);
 116                 if (ret < 0) {
 117                         sr_err("Failed to detach kernel driver: %s.",
 118                                libusb_error_name(ret));
 119                         return SR_ERR;
 120                 }
 121                 devc->detached_kernel_driver = 1;
 122                 sr_dbg("Successfully detached kernel driver.");
 123         } else {
 124                 sr_dbg("No need to detach a kernel driver.");
 125         }
 126
 127         /* Claim interface 0. */
 128         if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
 129                 sr_err("Failed to claim interface 0: %s.",
 130                        libusb_error_name(ret));
 131                 return SR_ERR;
 132         }
 133         sr_dbg("Successfully claimed interface 0.");
 134
 135         return ret;
 136 }
 137
 138 static int dev_close(struct sr_dev_inst *sdi)
 139 {
 140         struct sr_usb_dev_inst *usb;
 141         struct dev_context *devc;
 142         int ret;
 143
 144         if (sdi->status != SR_ST_ACTIVE)
 145                 return SR_ERR_DEV_CLOSED;
 146
 147         usb = sdi->conn;
 148         devc = sdi->priv;
 149
 150         if ((ret = libusb_release_interface(usb->devhdl, 0)))
 151                 sr_err("Failed to release interface 0: %s.\n", libusb_error_name(ret));
 152         else
 153                 sr_dbg("Successfully released interface 0.\n");
 154
 155         if (!ret && devc->detached_kernel_driver) {
 156                 if ((ret = libusb_attach_kernel_driver(usb->devhdl, 0))) {
 157                         sr_err("Failed to attach kernel driver: %s.\n",
 158                                libusb_error_name(ret));
 159                 } else {
 160                         devc->detached_kernel_driver = 0;
 161                         sr_dbg("Successfully attached kernel driver.\n");
 162                 }
 163         }
 164
 165         libusb_close(usb->devhdl);
 166
 167         sdi->status = SR_ST_INACTIVE;
 168
 169         return ret;
 170 }
 171
 172 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 173                 const struct sr_channel_group *cg)
 174 {
 175         struct dev_context *devc = sdi->priv;
 176
 177         (void)cg;
 178
 179         return sr_sw_limits_config_get(&devc->sw_limits, key, data);
 180 }
 181
 182 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 183                 const struct sr_channel_group *cg)
 184 {
 185         struct dev_context *devc;
 186
 187         (void)cg;
 188
 189         if (sdi->status != SR_ST_ACTIVE)
 190                 return SR_ERR_DEV_CLOSED;
 191
 192         if (!(devc = sdi->priv)) {
 193                 sr_err("sdi->priv was NULL.");
 194                 return SR_ERR_BUG;
 195         }
 196
 197         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 198 }
 199
 200 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 201                 const struct sr_channel_group *cg)
 202 {
 203         (void)sdi;
 204         (void)cg;
 205
 206         switch (key) {
 207         case SR_CONF_SCAN_OPTIONS:
 208                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 209                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 210                 break;
 211         case SR_CONF_DEVICE_OPTIONS:
 212                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 213                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 214                 break;
 215         default:
 216                 return SR_ERR_NA;
 217         }
 218
 219         return SR_OK;
 220 }
 221
 222 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 223 {
 224         struct dev_context *devc;
 225
 226         if (sdi->status != SR_ST_ACTIVE)
 227                 return SR_ERR_DEV_CLOSED;
 228
 229         devc = sdi->priv;
 230
 231         sr_sw_limits_acquisition_start(&devc->sw_limits);
 232
 233         std_session_send_df_header(sdi, LOG_PREFIX);
 234
 235         sr_session_source_add(sdi->session, -1, 0, 10,
 236                         brymen_bm86x_receive_data, (void *)sdi);
 237
 238         return SR_OK;
 239 }
 240
 241 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 242 {
 243         if (sdi->status != SR_ST_ACTIVE)
 244                 return SR_ERR_DEV_CLOSED;
 245
 246         std_session_send_df_end(sdi, LOG_PREFIX);
 247
 248         sr_session_source_remove(sdi->session, -1);
 249
 250         return SR_OK;
 251 }
 252
 253 SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info = {
 254         .name = "brymen-bm86x",
 255         .longname = "Brymen BM86X",
 256         .api_version = 1,
 257         .init = init,
 258         .cleanup = std_cleanup,
 259         .scan = scan,
 260         .dev_list = std_dev_list,
 261         .dev_clear = NULL,
 262         .config_get = config_get,
 263         .config_set = config_set,
 264         .config_list = config_list,
 265         .dev_open = dev_open,
 266         .dev_close = dev_close,
 267         .dev_acquisition_start = dev_acquisition_start,
 268         .dev_acquisition_stop = dev_acquisition_stop,
 269         .context = NULL,
 270 };