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