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                 drvc->instances = g_slist_append(drvc->instances, sdi);
  89                 devices = g_slist_append(devices, sdi);
  90         }
  91
  92         return devices;
  93 }
  94
  95 static GSList *dev_list(const struct sr_dev_driver *di)
  96 {
  97         return ((struct drv_context *)(di->context))->instances;
  98 }
  99
 100 static int dev_open(struct sr_dev_inst *sdi)
 101 {
 102         struct sr_dev_driver *di = sdi->driver;
 103         struct drv_context *drvc = di->context;
 104         struct sr_usb_dev_inst *usb;
 105         struct dev_context *devc;
 106         int ret;
 107
 108         usb = sdi->conn;
 109         devc = sdi->priv;
 110
 111         if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
 112                 sdi->status = SR_ST_ACTIVE;
 113         else
 114                 return SR_ERR;
 115
 116         /* Detach kernel drivers which grabbed this device (if any). */
 117         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 118                 ret = libusb_detach_kernel_driver(usb->devhdl, 0);
 119                 if (ret < 0) {
 120                         sr_err("Failed to detach kernel driver: %s.",
 121                                libusb_error_name(ret));
 122                         return SR_ERR;
 123                 }
 124                 devc->detached_kernel_driver = 1;
 125                 sr_dbg("Successfully detached kernel driver.");
 126         } else {
 127                 sr_dbg("No need to detach a kernel driver.");
 128         }
 129
 130         /* Claim interface 0. */
 131         if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
 132                 sr_err("Failed to claim interface 0: %s.",
 133                        libusb_error_name(ret));
 134                 return SR_ERR;
 135         }
 136         sr_dbg("Successfully claimed interface 0.");
 137
 138         return ret;
 139 }
 140
 141 static int dev_close(struct sr_dev_inst *sdi)
 142 {
 143         struct sr_usb_dev_inst *usb;
 144         struct dev_context *devc;
 145         int ret;
 146
 147         if (sdi->status != SR_ST_ACTIVE)
 148                 return SR_ERR_DEV_CLOSED;
 149
 150         usb = sdi->conn;
 151         devc = sdi->priv;
 152
 153         if ((ret = libusb_release_interface(usb->devhdl, 0)))
 154                 sr_err("Failed to release interface 0: %s.\n", libusb_error_name(ret));
 155         else
 156                 sr_dbg("Successfully released interface 0.\n");
 157
 158         if (!ret && devc->detached_kernel_driver) {
 159                 if ((ret = libusb_attach_kernel_driver(usb->devhdl, 0))) {
 160                         sr_err("Failed to attach kernel driver: %s.\n",
 161                                libusb_error_name(ret));
 162                 } else {
 163                         devc->detached_kernel_driver = 0;
 164                         sr_dbg("Successfully attached kernel driver.\n");
 165                 }
 166         }
 167
 168         libusb_close(usb->devhdl);
 169
 170         sdi->status = SR_ST_INACTIVE;
 171
 172         return ret;
 173 }
 174
 175 static int cleanup(const struct sr_dev_driver *di)
 176 {
 177         return std_dev_clear(di, NULL);
 178 }
 179
 180 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 181                 const struct sr_channel_group *cg)
 182 {
 183         struct dev_context *devc = sdi->priv;
 184
 185         (void)cg;
 186
 187         switch (key) {
 188         case SR_CONF_LIMIT_SAMPLES:
 189                 *data = g_variant_new_uint64(devc->limit_samples);
 190                 break;
 191         case SR_CONF_LIMIT_MSEC:
 192                 *data = g_variant_new_uint64(devc->limit_msec);
 193                 break;
 194         default:
 195                 return SR_ERR_NA;
 196         }
 197
 198         return SR_OK;
 199 }
 200
 201 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 202                 const struct sr_channel_group *cg)
 203 {
 204         struct dev_context *devc;
 205
 206         (void)cg;
 207
 208         if (sdi->status != SR_ST_ACTIVE)
 209                 return SR_ERR_DEV_CLOSED;
 210
 211         if (!(devc = sdi->priv)) {
 212                 sr_err("sdi->priv was NULL.");
 213                 return SR_ERR_BUG;
 214         }
 215
 216         switch (key) {
 217         case SR_CONF_LIMIT_SAMPLES:
 218                 devc->limit_samples = g_variant_get_uint64(data);
 219                 break;
 220         case SR_CONF_LIMIT_MSEC:
 221                 devc->limit_msec = g_variant_get_uint64(data);
 222                 break;
 223         default:
 224                 return SR_ERR_NA;
 225         }
 226
 227         return SR_OK;
 228 }
 229
 230 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 231                 const struct sr_channel_group *cg)
 232 {
 233         (void)sdi;
 234         (void)cg;
 235
 236         switch (key) {
 237         case SR_CONF_SCAN_OPTIONS:
 238                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 239                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 240                 break;
 241         case SR_CONF_DEVICE_OPTIONS:
 242                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 243                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 244                 break;
 245         default:
 246                 return SR_ERR_NA;
 247         }
 248
 249         return SR_OK;
 250 }
 251
 252 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 253                                     void *cb_data)
 254 {
 255         struct dev_context *devc;
 256
 257         (void)cb_data;
 258
 259         if (sdi->status != SR_ST_ACTIVE)
 260                 return SR_ERR_DEV_CLOSED;
 261
 262         devc = sdi->priv;
 263         devc->start_time = g_get_monotonic_time();
 264
 265         std_session_send_df_header(sdi, LOG_PREFIX);
 266
 267         sr_session_source_add(sdi->session, -1, 0, 10,
 268                         brymen_bm86x_receive_data, (void *)sdi);
 269
 270         return SR_OK;
 271 }
 272
 273 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 274 {
 275         (void)cb_data;
 276
 277         if (sdi->status != SR_ST_ACTIVE)
 278                 return SR_ERR_DEV_CLOSED;
 279
 280         std_session_send_df_end(sdi, LOG_PREFIX);
 281
 282         sr_session_source_remove(sdi->session, -1);
 283
 284         return SR_OK;
 285 }
 286
 287 SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info = {
 288         .name = "brymen-bm86x",
 289         .longname = "Brymen BM86X",
 290         .api_version = 1,
 291         .init = init,
 292         .cleanup = cleanup,
 293         .scan = scan,
 294         .dev_list = dev_list,
 295         .dev_clear = NULL,
 296         .config_get = config_get,
 297         .config_set = config_set,
 298         .config_list = config_list,
 299         .dev_open = dev_open,
 300         .dev_close = dev_close,
 301         .dev_acquisition_start = dev_acquisition_start,
 302         .dev_acquisition_stop = dev_acquisition_stop,
 303         .context = NULL,
 304 };