hardware/brymen-dmm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
   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 static const int hwopts[] = {
  23         SR_CONF_CONN,
  24         SR_CONF_SERIALCOMM,
  25         0,
  26 };
  27
  28 static const int hwcaps[] = {
  29         SR_CONF_MULTIMETER,
  30         SR_CONF_LIMIT_SAMPLES,
  31         SR_CONF_CONTINUOUS,
  32         SR_CONF_LIMIT_MSEC,
  33         0,
  34 };
  35
  36 SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
  37 static struct sr_dev_driver *di = &brymen_bm857_driver_info;
  38
  39 static int hw_init(struct sr_context *sr_ctx)
  40 {
  41         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
  42 }
  43
  44 static void free_instance(void *inst)
  45 {
  46         struct sr_dev_inst *sdi;
  47         struct dev_context *devc;
  48
  49         if (!(sdi = inst))
  50                 return;
  51         if (!(devc = sdi->priv))
  52                 return;
  53         sr_serial_dev_inst_free(devc->serial);
  54         sr_dev_inst_free(sdi);
  55 }
  56
  57 /* Properly close and free all devices. */
  58 static int clear_instances(void)
  59 {
  60         struct drv_context *drvc;
  61
  62         if (!(drvc = di->priv))
  63                 return SR_OK;
  64
  65         g_slist_free_full(drvc->instances, free_instance);
  66         drvc->instances = NULL;
  67
  68         return SR_OK;
  69 }
  70
  71 static GSList *brymen_scan(const char *conn, const char *serialcomm)
  72 {
  73         struct sr_dev_inst *sdi;
  74         struct dev_context *devc;
  75         struct drv_context *drvc;
  76         struct sr_probe *probe;
  77         struct sr_serial_dev_inst *serial;
  78         GSList *devices;
  79         int ret;
  80         uint8_t buf[128];
  81         size_t len;
  82
  83         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
  84                 return NULL;
  85
  86         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
  87                 return NULL;
  88
  89         sr_info("Probing port %s.", conn);
  90
  91         devices = NULL;
  92
  93         /* Request reading */
  94         if ((ret = brymen_packet_request(serial)) < 0) {
  95                 sr_err("Unable to send command: %d.", ret);
  96                 goto scan_cleanup;
  97         }
  98
  99         len = 128;
 100         ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
 101                              brymen_packet_is_valid, 1000, 9600);
 102         if (ret != SR_OK)
 103                 goto scan_cleanup;
 104
 105         sr_info("Found device on port %s.", conn);
 106
 107         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Brymen", "BM85x", "")))
 108                 goto scan_cleanup;
 109
 110         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 111                 sr_err("Device context malloc failed.");
 112                 goto scan_cleanup;
 113         }
 114
 115         devc->serial = serial;
 116         drvc = di->priv;
 117         sdi->priv = devc;
 118         sdi->driver = di;
 119
 120         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 121                 goto scan_cleanup;
 122
 123         sdi->probes = g_slist_append(sdi->probes, probe);
 124         drvc->instances = g_slist_append(drvc->instances, sdi);
 125         devices = g_slist_append(devices, sdi);
 126
 127 scan_cleanup:
 128         serial_close(serial);
 129
 130         return devices;
 131 }
 132
 133 static GSList *hw_scan(GSList *options)
 134 {
 135         struct drv_context *drvc;
 136         struct sr_config *src;
 137         GSList *devices, *l;
 138         const char *conn, *serialcomm;
 139
 140         (void)options;
 141
 142         devices = NULL;
 143         drvc = di->priv;
 144         drvc->instances = NULL;
 145
 146         conn = serialcomm = NULL;
 147         for (l = options; l; l = l->next) {
 148                 src = l->data;
 149                 switch (src->key) {
 150                 case SR_CONF_CONN:
 151                         conn = src->value;
 152                         break;
 153                 case SR_CONF_SERIALCOMM:
 154                         serialcomm = src->value;
 155                         break;
 156                 }
 157         }
 158         if (!conn) {
 159                 return NULL;
 160         }
 161
 162         if (serialcomm) {
 163                 /* Use the provided comm specs. */
 164                 devices = brymen_scan(conn, serialcomm);
 165         } else {
 166                 /* But 9600/8n1 should work all of the time. */
 167                 devices = brymen_scan(conn, "9600/8n1/dtr=1/rts=1");
 168         }
 169
 170         return devices;
 171 }
 172
 173 static GSList *hw_dev_list(void)
 174 {
 175         return ((struct drv_context *)(di->priv))->instances;
 176 }
 177
 178 static int hw_dev_open(struct sr_dev_inst *sdi)
 179 {
 180         struct dev_context *devc;
 181
 182         if (!(devc = sdi->priv)) {
 183                 sr_err("sdi->priv was NULL.");
 184                 return SR_ERR_BUG;
 185         }
 186
 187         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 188                 return SR_ERR;
 189
 190         sdi->status = SR_ST_ACTIVE;
 191
 192         return SR_OK;
 193 }
 194
 195 static int hw_dev_close(struct sr_dev_inst *sdi)
 196 {
 197         struct dev_context *devc;
 198
 199         devc = sdi->priv;
 200
 201         if (devc->serial && devc->serial->fd != -1) {
 202                 serial_close(devc->serial);
 203                 sdi->status = SR_ST_INACTIVE;
 204         }
 205
 206         return SR_OK;
 207 }
 208
 209 static int hw_cleanup(void)
 210 {
 211         clear_instances();
 212
 213         return SR_OK;
 214 }
 215
 216 static int config_list(int key, const void **data,
 217                        const struct sr_dev_inst *sdi)
 218 {
 219         (void)sdi;
 220
 221         switch (key) {
 222         case SR_CONF_SCAN_OPTIONS:
 223                 *data = hwopts;
 224                 break;
 225         case SR_CONF_DEVICE_OPTIONS:
 226                 *data = hwcaps;
 227                 break;
 228         default:
 229                 sr_err("Unknown config key: %d.", key);
 230                 return SR_ERR_ARG;
 231         }
 232
 233         return SR_OK;
 234 }
 235
 236 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 237 {
 238         struct dev_context *devc;
 239         int ret;
 240
 241         if (sdi->status != SR_ST_ACTIVE) {
 242                 sr_err("Device inactive, can't set config options.");
 243                 return SR_ERR;
 244         }
 245
 246         if (!(devc = sdi->priv)) {
 247                 sr_err("sdi->priv was NULL.");
 248                 return SR_ERR_BUG;
 249         }
 250
 251         ret = SR_OK;
 252         switch (id) {
 253         case SR_CONF_LIMIT_SAMPLES:
 254                 devc->limit_samples = *(const uint64_t *)value;
 255                 break;
 256         case SR_CONF_LIMIT_MSEC:
 257                 devc->limit_msec = *(const uint64_t *)value;
 258                 break;
 259         default:
 260                 sr_err("Unknown hardware capability: %d.", id);
 261                 ret = SR_ERR_ARG;
 262         }
 263
 264         return ret;
 265 }
 266
 267 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 268                                     void *cb_data)
 269 {
 270         struct dev_context *devc;
 271
 272         if (!(devc = sdi->priv)) {
 273                 sr_err("sdi->priv was NULL.");
 274                 return SR_ERR_BUG;
 275         }
 276
 277         devc->cb_data = cb_data;
 278
 279         /*
 280          * Reset the number of samples to take. If we've already collected our
 281          * quota, but we start a new session, and don't reset this, we'll just
 282          * quit without acquiring any new samples.
 283          */
 284         devc->num_samples = 0;
 285         devc->starttime = g_get_monotonic_time();
 286
 287         /* Send header packet to the session bus. */
 288         std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 289
 290         /* Poll every 50ms, or whenever some data comes in. */
 291         sr_source_add(devc->serial->fd, G_IO_IN, 50,
 292                       brymen_dmm_receive_data, (void *)sdi);
 293
 294         return SR_OK;
 295 }
 296
 297 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 298 {
 299         struct sr_datafeed_packet packet;
 300         struct dev_context *devc;
 301
 302         if (sdi->status != SR_ST_ACTIVE) {
 303                 sr_err("Device inactive, can't stop acquisition.");
 304                 return SR_ERR;
 305         }
 306
 307         if (!(devc = sdi->priv)) {
 308                 sr_err("sdi->priv was NULL.");
 309                 return SR_ERR_BUG;
 310         }
 311
 312         sr_dbg("Stopping acquisition.");
 313
 314         sr_source_remove(devc->serial->fd);
 315         hw_dev_close((struct sr_dev_inst *)sdi);
 316
 317         /* Send end packet to the session bus. */
 318         sr_dbg("Sending SR_DF_END.");
 319         packet.type = SR_DF_END;
 320         sr_session_send(cb_data, &packet);
 321
 322         return SR_OK;
 323 }
 324
 325 SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
 326         .name = "brymen-bm857",
 327         .longname = "Brymen BM857",
 328         .api_version = 1,
 329         .init = hw_init,
 330         .cleanup = hw_cleanup,
 331         .scan = hw_scan,
 332         .dev_list = hw_dev_list,
 333         .dev_clear = clear_instances,
 334         .config_get = NULL,
 335         .config_set = config_set,
 336         .config_list = config_list,
 337         .dev_open = hw_dev_open,
 338         .dev_close = hw_dev_close,
 339         .dev_acquisition_start = hw_dev_acquisition_start,
 340         .dev_acquisition_stop = hw_dev_acquisition_stop,
 341         .priv = NULL,
 342 };