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 <config.h>
  21 #include "protocol.h"
  22
  23 static const uint32_t scanopts[] = {
  24         SR_CONF_CONN,
  25         SR_CONF_SERIALCOMM,
  26 };
  27
  28 static const uint32_t devopts[] = {
  29         SR_CONF_MULTIMETER,
  30         SR_CONF_CONTINUOUS,
  31         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  32         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  33 };
  34
  35 SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
  36 static struct sr_dev_driver *di = &brymen_bm857_driver_info;
  37
  38 static GSList *brymen_scan(const char *conn, const char *serialcomm)
  39 {
  40         struct sr_dev_inst *sdi;
  41         struct dev_context *devc;
  42         struct drv_context *drvc;
  43         struct sr_serial_dev_inst *serial;
  44         GSList *devices;
  45         int ret;
  46         uint8_t buf[128];
  47         size_t len;
  48
  49         serial = sr_serial_dev_inst_new(conn, serialcomm);
  50
  51         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  52                 return NULL;
  53
  54         sr_info("Probing port %s.", conn);
  55
  56         devices = NULL;
  57
  58         /* Request reading */
  59         if ((ret = brymen_packet_request(serial)) < 0) {
  60                 sr_err("Unable to send command: %d.", ret);
  61                 goto scan_cleanup;
  62         }
  63
  64         len = 128;
  65         ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
  66                              brymen_packet_is_valid, 1000, 9600);
  67         if (ret != SR_OK)
  68                 goto scan_cleanup;
  69
  70         sr_info("Found device on port %s.", conn);
  71
  72         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  73         sdi->status = SR_ST_INACTIVE;
  74         sdi->vendor = g_strdup("Brymen");
  75         sdi->model = g_strdup("BM85x");
  76         devc = g_malloc0(sizeof(struct dev_context));
  77         sr_sw_limits_init(&devc->sw_limits);
  78         sdi->inst_type = SR_INST_SERIAL;
  79         sdi->conn = serial;
  80         drvc = di->context;
  81         sdi->priv = devc;
  82         sdi->driver = di;
  83         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
  84         drvc->instances = g_slist_append(drvc->instances, sdi);
  85         devices = g_slist_append(devices, sdi);
  86
  87 scan_cleanup:
  88         serial_close(serial);
  89
  90         return devices;
  91 }
  92
  93 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  94 {
  95         struct drv_context *drvc;
  96         struct sr_config *src;
  97         GSList *devices, *l;
  98         const char *conn, *serialcomm;
  99
 100         devices = NULL;
 101         drvc = di->context;
 102         drvc->instances = NULL;
 103
 104         conn = serialcomm = NULL;
 105         for (l = options; l; l = l->next) {
 106                 src = l->data;
 107                 switch (src->key) {
 108                 case SR_CONF_CONN:
 109                         conn = g_variant_get_string(src->data, NULL);
 110                         break;
 111                 case SR_CONF_SERIALCOMM:
 112                         serialcomm = g_variant_get_string(src->data, NULL);
 113                         break;
 114                 }
 115         }
 116         if (!conn)
 117                 return NULL;
 118
 119         if (serialcomm) {
 120                 /* Use the provided comm specs. */
 121                 devices = brymen_scan(conn, serialcomm);
 122         } else {
 123                 /* But 9600/8n1 should work all of the time. */
 124                 devices = brymen_scan(conn, "9600/8n1/dtr=1/rts=1");
 125         }
 126
 127         return devices;
 128 }
 129
 130 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 131                 const struct sr_channel_group *cg)
 132 {
 133         struct dev_context *devc;
 134
 135         (void)cg;
 136
 137         if (sdi->status != SR_ST_ACTIVE)
 138                 return SR_ERR_DEV_CLOSED;
 139
 140         if (!(devc = sdi->priv)) {
 141                 sr_err("sdi->priv was NULL.");
 142                 return SR_ERR_BUG;
 143         }
 144
 145         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 146 }
 147
 148 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 149                 const struct sr_channel_group *cg)
 150 {
 151         (void)sdi;
 152         (void)cg;
 153
 154         switch (key) {
 155         case SR_CONF_SCAN_OPTIONS:
 156                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 157                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 158                 break;
 159         case SR_CONF_DEVICE_OPTIONS:
 160                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 161                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 162                 break;
 163         default:
 164                 return SR_ERR_NA;
 165         }
 166
 167         return SR_OK;
 168 }
 169
 170 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 171 {
 172         struct dev_context *devc;
 173         struct sr_serial_dev_inst *serial;
 174
 175         if (sdi->status != SR_ST_ACTIVE)
 176                 return SR_ERR_DEV_CLOSED;
 177
 178         devc = sdi->priv;
 179
 180         sr_sw_limits_acquisition_start(&devc->sw_limits);
 181         std_session_send_df_header(sdi, LOG_PREFIX);
 182
 183         /* Poll every 50ms, or whenever some data comes in. */
 184         serial = sdi->conn;
 185         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 186                         brymen_dmm_receive_data, (void *)sdi);
 187
 188         return SR_OK;
 189 }
 190
 191 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 192 {
 193         return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
 194                         sdi->conn, LOG_PREFIX);
 195 }
 196
 197 SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
 198         .name = "brymen-bm857",
 199         .longname = "Brymen BM857",
 200         .api_version = 1,
 201         .init = std_init,
 202         .cleanup = std_cleanup,
 203         .scan = scan,
 204         .dev_list = std_dev_list,
 205         .dev_clear = NULL,
 206         .config_get = NULL,
 207         .config_set = config_set,
 208         .config_list = config_list,
 209         .dev_open = std_serial_dev_open,
 210         .dev_close = std_serial_dev_close,
 211         .dev_acquisition_start = dev_acquisition_start,
 212         .dev_acquisition_stop = dev_acquisition_stop,
 213         .context = NULL,
 214 };