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 "protocol.h"
  21
  22 #define BRYMEN_BC86X "0820.0001"
  23
  24 static const uint32_t scanopts[] = {
  25         SR_CONF_CONN,
  26 };
  27
  28 static const uint32_t devopts[] = {
  29         SR_CONF_MULTIMETER,
  30         SR_CONF_CONTINUOUS,
  31         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  32         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  33 };
  34
  35 SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info;
  36 static struct sr_dev_driver *di = &brymen_bm86x_driver_info;
  37
  38 static int init(struct sr_context *sr_ctx)
  39 {
  40         return std_init(sr_ctx, di, LOG_PREFIX);
  41 }
  42
  43 static GSList *scan(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         struct sr_channel *ch;
  52         const char *conn;
  53
  54         drvc = di->priv;
  55         drvc->instances = NULL;
  56
  57         conn = BRYMEN_BC86X;
  58         for (l = options; l; l = l->next) {
  59                 src = l->data;
  60                 switch (src->key) {
  61                 case SR_CONF_CONN:
  62                         conn = g_variant_get_string(src->data, NULL);
  63                         break;
  64                 }
  65         }
  66
  67         devices = NULL;
  68         if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
  69                 g_slist_free_full(usb_devices, g_free);
  70                 return NULL;
  71         }
  72
  73         for (l = usb_devices; l; l = l->next) {
  74                 usb = l->data;
  75
  76                 sdi = sr_dev_inst_new();
  77                 sdi->status = SR_ST_INACTIVE;
  78                 sdi->vendor = g_strdup("Brymen");
  79                 sdi->model = g_strdup("BM869");
  80
  81                 if (!(devc = g_try_malloc0(sizeof(*devc)))) {
  82                         sr_err("Device context malloc failed.");
  83                         return NULL;
  84                 }
  85
  86                 sdi->priv = devc;
  87                 sdi->driver = di;
  88                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
  89                         return NULL;
  90                 sdi->channels = g_slist_append(sdi->channels, ch);
  91                 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P2")))
  92                         return NULL;
  93                 sdi->channels = g_slist_append(sdi->channels, ch);
  94
  95                 sdi->inst_type = SR_INST_USB;
  96                 sdi->conn = usb;
  97
  98                 drvc->instances = g_slist_append(drvc->instances, sdi);
  99                 devices = g_slist_append(devices, sdi);
 100         }
 101
 102         return devices;
 103 }
 104
 105 static GSList *dev_list(void)
 106 {
 107         return ((struct drv_context *)(di->priv))->instances;
 108 }
 109
 110 static int dev_open(struct sr_dev_inst *sdi)
 111 {
 112         struct drv_context *drvc = di->priv;
 113         struct sr_usb_dev_inst *usb;
 114         struct dev_context *devc;
 115         int ret;
 116
 117         usb = sdi->conn;
 118         devc = sdi->priv;
 119
 120         if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
 121                 sdi->status = SR_ST_ACTIVE;
 122
 123         /* Detach kernel drivers which grabbed this device (if any). */
 124         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 125                 ret = libusb_detach_kernel_driver(usb->devhdl, 0);
 126                 if (ret < 0) {
 127                         sr_err("Failed to detach kernel driver: %s.",
 128                                libusb_error_name(ret));
 129                         return SR_ERR;
 130                 }
 131                 devc->detached_kernel_driver = 1;
 132                 sr_dbg("Successfully detached kernel driver.");
 133         } else {
 134                 sr_dbg("No need to detach a kernel driver.");
 135         }
 136
 137         /* Claim interface 0. */
 138         if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
 139                 sr_err("Failed to claim interface 0: %s.",
 140                        libusb_error_name(ret));
 141                 return SR_ERR;
 142         }
 143         sr_dbg("Successfully claimed interface 0.");
 144
 145         return ret;
 146 }
 147
 148 static int dev_close(struct sr_dev_inst *sdi)
 149 {
 150         struct sr_usb_dev_inst *usb;
 151         struct dev_context *devc;
 152         int ret;
 153
 154         usb = sdi->conn;
 155         devc = sdi->priv;
 156
 157         if ((ret = libusb_release_interface(usb->devhdl, 0)))
 158                 sr_err("Failed to release interface 0: %s.\n", libusb_error_name(ret));
 159         else
 160                 sr_dbg("Successfully released interface 0.\n");
 161
 162         if (!ret && devc->detached_kernel_driver) {
 163                 if ((ret = libusb_attach_kernel_driver(usb->devhdl, 0))) {
 164                         sr_err("Failed to attach kernel driver: %s.\n",
 165                                libusb_error_name(ret));
 166                 } else {
 167                         devc->detached_kernel_driver = 0;
 168                         sr_dbg("Successfully attached kernel driver.\n");
 169                 }
 170         }
 171
 172         libusb_close(usb->devhdl);
 173
 174         sdi->status = SR_ST_INACTIVE;
 175
 176         return ret;
 177 }
 178
 179 static int cleanup(void)
 180 {
 181         return std_dev_clear(di, NULL);
 182 }
 183
 184 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 185                 const struct sr_channel_group *cg)
 186 {
 187         struct dev_context *devc = sdi->priv;
 188
 189         (void)cg;
 190
 191         switch (key) {
 192         case SR_CONF_LIMIT_SAMPLES:
 193                 *data = g_variant_new_uint64(devc->limit_samples);
 194                 break;
 195         case SR_CONF_LIMIT_MSEC:
 196                 *data = g_variant_new_uint64(devc->limit_msec);
 197                 break;
 198         default:
 199                 return SR_ERR_NA;
 200         }
 201
 202         return SR_OK;
 203 }
 204
 205 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 206                 const struct sr_channel_group *cg)
 207 {
 208         struct dev_context *devc;
 209
 210         (void)cg;
 211
 212         if (sdi->status != SR_ST_ACTIVE)
 213                 return SR_ERR_DEV_CLOSED;
 214
 215         if (!(devc = sdi->priv)) {
 216                 sr_err("sdi->priv was NULL.");
 217                 return SR_ERR_BUG;
 218         }
 219
 220         switch (key) {
 221         case SR_CONF_LIMIT_SAMPLES:
 222                 devc->limit_samples = g_variant_get_uint64(data);
 223                 sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
 224                 break;
 225         case SR_CONF_LIMIT_MSEC:
 226                 devc->limit_msec = g_variant_get_uint64(data);
 227                 sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
 228                 break;
 229         default:
 230                 return SR_ERR_NA;
 231         }
 232
 233         return SR_OK;
 234 }
 235
 236 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 237                 const struct sr_channel_group *cg)
 238 {
 239         (void)sdi;
 240         (void)cg;
 241
 242         switch (key) {
 243         case SR_CONF_SCAN_OPTIONS:
 244                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 245                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 246                 break;
 247         case SR_CONF_DEVICE_OPTIONS:
 248                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 249                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 250                 break;
 251         default:
 252                 return SR_ERR_NA;
 253         }
 254
 255         return SR_OK;
 256 }
 257
 258 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 259                                     void *cb_data)
 260 {
 261         struct dev_context *devc;
 262
 263         (void)cb_data;
 264
 265         if (sdi->status != SR_ST_ACTIVE)
 266                 return SR_ERR_DEV_CLOSED;
 267
 268         devc = sdi->priv;
 269         devc->start_time = g_get_monotonic_time();
 270
 271         /* Send header packet to the session bus. */
 272         std_session_send_df_header(sdi, LOG_PREFIX);
 273
 274         sr_session_source_add(sdi->session, 0, 0, 10,
 275                         brymen_bm86x_receive_data, (void *)sdi);
 276
 277         return SR_OK;
 278 }
 279
 280 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 281 {
 282         struct sr_datafeed_packet packet;
 283
 284         (void)cb_data;
 285
 286         if (sdi->status != SR_ST_ACTIVE)
 287                 return SR_ERR_DEV_CLOSED;
 288
 289         /* Send end packet to the session bus. */
 290         packet.type = SR_DF_END;
 291         sr_session_send(sdi, &packet);
 292
 293         sr_session_source_remove(sdi->session, 0);
 294
 295         return SR_OK;
 296 }
 297
 298 SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info = {
 299         .name = "brymen-bm86x",
 300         .longname = "Brymen BM86X",
 301         .api_version = 1,
 302         .init = init,
 303         .cleanup = cleanup,
 304         .scan = scan,
 305         .dev_list = dev_list,
 306         .dev_clear = NULL,
 307         .config_get = config_get,
 308         .config_set = config_set,
 309         .config_list = config_list,
 310         .dev_open = dev_open,
 311         .dev_close = dev_close,
 312         .dev_acquisition_start = dev_acquisition_start,
 313         .dev_acquisition_stop = dev_acquisition_stop,
 314         .priv = NULL,
 315 };