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 uint32_t scanopts[] = {
  23         SR_CONF_CONN,
  24         SR_CONF_SERIALCOMM,
  25 };
  26
  27 static const uint32_t devopts[] = {
  28         SR_CONF_MULTIMETER,
  29         SR_CONF_CONTINUOUS,
  30         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  31         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  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) != 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         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  79         sdi->status = SR_ST_INACTIVE;
  80         sdi->vendor = g_strdup("Brymen");
  81         sdi->model = g_strdup("BM85x");
  82         devc = g_malloc0(sizeof(struct dev_context));
  83         sdi->inst_type = SR_INST_SERIAL;
  84         sdi->conn = serial;
  85         drvc = di->priv;
  86         sdi->priv = devc;
  87         sdi->driver = di;
  88
  89         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
  90                 goto scan_cleanup;
  91
  92         sdi->channels = g_slist_append(sdi->channels, ch);
  93         drvc->instances = g_slist_append(drvc->instances, sdi);
  94         devices = g_slist_append(devices, sdi);
  95
  96 scan_cleanup:
  97         serial_close(serial);
  98
  99         return devices;
 100 }
 101
 102 static GSList *scan(GSList *options)
 103 {
 104         struct drv_context *drvc;
 105         struct sr_config *src;
 106         GSList *devices, *l;
 107         const char *conn, *serialcomm;
 108
 109         devices = NULL;
 110         drvc = di->priv;
 111         drvc->instances = NULL;
 112
 113         conn = serialcomm = NULL;
 114         for (l = options; l; l = l->next) {
 115                 src = l->data;
 116                 switch (src->key) {
 117                 case SR_CONF_CONN:
 118                         conn = g_variant_get_string(src->data, NULL);
 119                         break;
 120                 case SR_CONF_SERIALCOMM:
 121                         serialcomm = g_variant_get_string(src->data, NULL);
 122                         break;
 123                 }
 124         }
 125         if (!conn)
 126                 return NULL;
 127
 128         if (serialcomm) {
 129                 /* Use the provided comm specs. */
 130                 devices = brymen_scan(conn, serialcomm);
 131         } else {
 132                 /* But 9600/8n1 should work all of the time. */
 133                 devices = brymen_scan(conn, "9600/8n1/dtr=1/rts=1");
 134         }
 135
 136         return devices;
 137 }
 138
 139 static GSList *dev_list(void)
 140 {
 141         return ((struct drv_context *)(di->priv))->instances;
 142 }
 143
 144 static int cleanup(void)
 145 {
 146         return std_dev_clear(di, NULL);
 147 }
 148
 149 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 150                 const struct sr_channel_group *cg)
 151 {
 152         struct dev_context *devc;
 153         int ret;
 154
 155         (void)cg;
 156
 157         if (sdi->status != SR_ST_ACTIVE)
 158                 return SR_ERR_DEV_CLOSED;
 159
 160         if (!(devc = sdi->priv)) {
 161                 sr_err("sdi->priv was NULL.");
 162                 return SR_ERR_BUG;
 163         }
 164
 165         ret = SR_OK;
 166         switch (key) {
 167         case SR_CONF_LIMIT_SAMPLES:
 168                 devc->limit_samples = g_variant_get_uint64(data);
 169                 break;
 170         case SR_CONF_LIMIT_MSEC:
 171                 devc->limit_msec = g_variant_get_uint64(data);
 172                 break;
 173         default:
 174                 ret = SR_ERR_NA;
 175         }
 176
 177         return ret;
 178 }
 179
 180 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 181                 const struct sr_channel_group *cg)
 182 {
 183         (void)sdi;
 184         (void)cg;
 185
 186         switch (key) {
 187         case SR_CONF_SCAN_OPTIONS:
 188                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 189                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 190                 break;
 191         case SR_CONF_DEVICE_OPTIONS:
 192                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 193                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 194                 break;
 195         default:
 196                 return SR_ERR_NA;
 197         }
 198
 199         return SR_OK;
 200 }
 201
 202 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 203 {
 204         struct dev_context *devc;
 205         struct sr_serial_dev_inst *serial;
 206
 207         if (sdi->status != SR_ST_ACTIVE)
 208                 return SR_ERR_DEV_CLOSED;
 209
 210         if (!(devc = sdi->priv)) {
 211                 sr_err("sdi->priv was NULL.");
 212                 return SR_ERR_BUG;
 213         }
 214
 215         devc->cb_data = cb_data;
 216
 217         /*
 218          * Reset the number of samples to take. If we've already collected our
 219          * quota, but we start a new session, and don't reset this, we'll just
 220          * quit without acquiring any new samples.
 221          */
 222         devc->num_samples = 0;
 223         devc->starttime = g_get_monotonic_time();
 224
 225         /* Send header packet to the session bus. */
 226         std_session_send_df_header(cb_data, LOG_PREFIX);
 227
 228         /* Poll every 50ms, or whenever some data comes in. */
 229         serial = sdi->conn;
 230         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 231                         brymen_dmm_receive_data, (void *)sdi);
 232
 233         return SR_OK;
 234 }
 235
 236 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 237 {
 238         return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
 239                         sdi->conn, LOG_PREFIX);
 240 }
 241
 242 SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
 243         .name = "brymen-bm857",
 244         .longname = "Brymen BM857",
 245         .api_version = 1,
 246         .init = init,
 247         .cleanup = cleanup,
 248         .scan = scan,
 249         .dev_list = dev_list,
 250         .dev_clear = NULL,
 251         .config_get = NULL,
 252         .config_set = config_set,
 253         .config_list = config_list,
 254         .dev_open = std_serial_dev_open,
 255         .dev_close = std_serial_dev_close,
 256         .dev_acquisition_start = dev_acquisition_start,
 257         .dev_acquisition_stop = dev_acquisition_stop,
 258         .priv = NULL,
 259 };