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