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