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 int32_t hwopts[] = {
  23         SR_CONF_CONN,
  24         SR_CONF_SERIALCOMM,
  25 };
  26
  27 static const int32_t hwcaps[] = {
  28         SR_CONF_MULTIMETER,
  29         SR_CONF_LIMIT_SAMPLES,
  30         SR_CONF_CONTINUOUS,
  31         SR_CONF_LIMIT_MSEC,
  32 };
  33
  34 SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
  35 static struct sr_dev_driver *di = &brymen_bm857_driver_info;
  36
  37 static int init(struct sr_context *sr_ctx)
  38 {
  39         return std_init(sr_ctx, di, LOG_PREFIX);
  40 }
  41
  42 static int dev_clear(void)
  43 {
  44         return std_dev_clear(di, NULL);
  45 }
  46
  47 static GSList *brymen_scan(const char *conn, const char *serialcomm)
  48 {
  49         struct sr_dev_inst *sdi;
  50         struct dev_context *devc;
  51         struct drv_context *drvc;
  52         struct sr_probe *probe;
  53         struct sr_serial_dev_inst *serial;
  54         GSList *devices;
  55         int ret;
  56         uint8_t buf[128];
  57         size_t len;
  58
  59         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
  60                 return NULL;
  61
  62         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
  63                 return NULL;
  64
  65         sr_info("Probing port %s.", conn);
  66
  67         devices = NULL;
  68
  69         /* Request reading */
  70         if ((ret = brymen_packet_request(serial)) < 0) {
  71                 sr_err("Unable to send command: %d.", ret);
  72                 goto scan_cleanup;
  73         }
  74
  75         len = 128;
  76         ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
  77                              brymen_packet_is_valid, 1000, 9600);
  78         if (ret != SR_OK)
  79                 goto scan_cleanup;
  80
  81         sr_info("Found device on port %s.", conn);
  82
  83         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Brymen", "BM85x", "")))
  84                 goto scan_cleanup;
  85
  86         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
  87                 sr_err("Device context malloc failed.");
  88                 goto scan_cleanup;
  89         }
  90
  91         sdi->inst_type = SR_INST_SERIAL;
  92         sdi->conn = serial;
  93         drvc = di->priv;
  94         sdi->priv = devc;
  95         sdi->driver = di;
  96
  97         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
  98                 goto scan_cleanup;
  99
 100         sdi->probes = g_slist_append(sdi->probes, probe);
 101         drvc->instances = g_slist_append(drvc->instances, sdi);
 102         devices = g_slist_append(devices, sdi);
 103
 104 scan_cleanup:
 105         serial_close(serial);
 106
 107         return devices;
 108 }
 109
 110 static GSList *scan(GSList *options)
 111 {
 112         struct drv_context *drvc;
 113         struct sr_config *src;
 114         GSList *devices, *l;
 115         const char *conn, *serialcomm;
 116
 117         devices = NULL;
 118         drvc = di->priv;
 119         drvc->instances = NULL;
 120
 121         conn = serialcomm = NULL;
 122         for (l = options; l; l = l->next) {
 123                 src = l->data;
 124                 switch (src->key) {
 125                 case SR_CONF_CONN:
 126                         conn = g_variant_get_string(src->data, NULL);
 127                         break;
 128                 case SR_CONF_SERIALCOMM:
 129                         serialcomm = g_variant_get_string(src->data, NULL);
 130                         break;
 131                 }
 132         }
 133         if (!conn)
 134                 return NULL;
 135
 136         if (serialcomm) {
 137                 /* Use the provided comm specs. */
 138                 devices = brymen_scan(conn, serialcomm);
 139         } else {
 140                 /* But 9600/8n1 should work all of the time. */
 141                 devices = brymen_scan(conn, "9600/8n1/dtr=1/rts=1");
 142         }
 143
 144         return devices;
 145 }
 146
 147 static GSList *dev_list(void)
 148 {
 149         return ((struct drv_context *)(di->priv))->instances;
 150 }
 151
 152 static int dev_open(struct sr_dev_inst *sdi)
 153 {
 154         struct sr_serial_dev_inst *serial;
 155
 156         serial = sdi->conn;
 157         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 158                 return SR_ERR;
 159
 160         sdi->status = SR_ST_ACTIVE;
 161
 162         return SR_OK;
 163 }
 164
 165 static int dev_close(struct sr_dev_inst *sdi)
 166 {
 167         struct sr_serial_dev_inst *serial;
 168
 169         serial = sdi->conn;
 170         if (serial && serial->fd != -1) {
 171                 serial_close(serial);
 172                 sdi->status = SR_ST_INACTIVE;
 173         }
 174
 175         return SR_OK;
 176 }
 177
 178 static int cleanup(void)
 179 {
 180         return dev_clear();
 181 }
 182
 183 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 184 {
 185         struct dev_context *devc;
 186         int ret;
 187
 188         if (sdi->status != SR_ST_ACTIVE)
 189                 return SR_ERR_DEV_CLOSED;
 190
 191         if (!(devc = sdi->priv)) {
 192                 sr_err("sdi->priv was NULL.");
 193                 return SR_ERR_BUG;
 194         }
 195
 196         ret = SR_OK;
 197         switch (id) {
 198         case SR_CONF_LIMIT_SAMPLES:
 199                 devc->limit_samples = g_variant_get_uint64(data);
 200                 break;
 201         case SR_CONF_LIMIT_MSEC:
 202                 devc->limit_msec = g_variant_get_uint64(data);
 203                 break;
 204         default:
 205                 ret = SR_ERR_NA;
 206         }
 207
 208         return ret;
 209 }
 210
 211 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 212 {
 213         (void)sdi;
 214
 215         switch (key) {
 216         case SR_CONF_SCAN_OPTIONS:
 217                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 218                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 219                 break;
 220         case SR_CONF_DEVICE_OPTIONS:
 221                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 222                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 223                 break;
 224         default:
 225                 return SR_ERR_NA;
 226         }
 227
 228         return SR_OK;
 229 }
 230
 231 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 232 {
 233         struct dev_context *devc;
 234         struct sr_serial_dev_inst *serial;
 235
 236         if (sdi->status != SR_ST_ACTIVE)
 237                 return SR_ERR_DEV_CLOSED;
 238
 239         if (!(devc = sdi->priv)) {
 240                 sr_err("sdi->priv was NULL.");
 241                 return SR_ERR_BUG;
 242         }
 243
 244         devc->cb_data = cb_data;
 245
 246         /*
 247          * Reset the number of samples to take. If we've already collected our
 248          * quota, but we start a new session, and don't reset this, we'll just
 249          * quit without acquiring any new samples.
 250          */
 251         devc->num_samples = 0;
 252         devc->starttime = g_get_monotonic_time();
 253
 254         /* Send header packet to the session bus. */
 255         std_session_send_df_header(cb_data, LOG_PREFIX);
 256
 257         /* Poll every 50ms, or whenever some data comes in. */
 258         serial = sdi->conn;
 259         sr_source_add(serial->fd, G_IO_IN, 50,
 260                       brymen_dmm_receive_data, (void *)sdi);
 261
 262         return SR_OK;
 263 }
 264
 265 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 266 {
 267         return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
 268                                                sdi->conn, LOG_PREFIX);
 269 }
 270
 271 SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
 272         .name = "brymen-bm857",
 273         .longname = "Brymen BM857",
 274         .api_version = 1,
 275         .init = init,
 276         .cleanup = cleanup,
 277         .scan = scan,
 278         .dev_list = dev_list,
 279         .dev_clear = dev_clear,
 280         .config_get = NULL,
 281         .config_set = config_set,
 282         .config_list = config_list,
 283         .dev_open = dev_open,
 284         .dev_close = dev_close,
 285         .dev_acquisition_start = dev_acquisition_start,
 286         .dev_acquisition_stop = dev_acquisition_stop,
 287         .priv = NULL,
 288 };