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