src/hardware/norma-dmm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
   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 /** @file
  21  *  Norma DM9x0/Siemens B102x DMMs driver.
  22  *  @internal
  23  */
  24
  25 #include <config.h>
  26 #include "protocol.h"
  27
  28 static const uint32_t scanopts[] = {
  29         SR_CONF_CONN,
  30         SR_CONF_SERIALCOMM,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         SR_CONF_MULTIMETER,
  35         SR_CONF_CONTINUOUS,
  36         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  37         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  38 };
  39
  40 #define BUF_MAX 50
  41
  42 #define SERIALCOMM "4800/8n1/dtr=1/rts=0/flow=1"
  43
  44 static struct sr_dev_driver norma_dmm_driver_info;
  45 static struct sr_dev_driver siemens_b102x_driver_info;
  46
  47 static const char *get_brandstr(struct sr_dev_driver *drv)
  48 {
  49         return (drv == &norma_dmm_driver_info) ? "Norma" : "Siemens";
  50 }
  51
  52 static const char *get_typestr(int type, struct sr_dev_driver *drv)
  53 {
  54         static const char *nameref[5][2] = {
  55                 {"DM910", "B1024"},
  56                 {"DM920", "B1025"},
  57                 {"DM930", "B1026"},
  58                 {"DM940", "B1027"},
  59                 {"DM950", "B1028"},
  60         };
  61
  62         if ((type < 1) || (type > 5))
  63                 return "Unknown type!";
  64
  65         return nameref[type - 1][(drv == &siemens_b102x_driver_info)];
  66 }
  67
  68 static GSList *scan(struct sr_dev_driver *drv, GSList *options)
  69 {
  70         struct sr_dev_inst *sdi;
  71         struct dev_context *devc;
  72         struct sr_config *src;
  73         struct sr_serial_dev_inst *serial;
  74         GSList *l, *devices;
  75         int len, cnt, auxtype;
  76         const char *conn, *serialcomm;
  77         char *buf;
  78         char req[10];
  79
  80         devices = NULL;
  81         conn = serialcomm = NULL;
  82
  83         for (l = options; l; l = l->next) {
  84                 src = l->data;
  85                 switch (src->key) {
  86                 case SR_CONF_CONN:
  87                         conn = g_variant_get_string(src->data, NULL);
  88                         break;
  89                 case SR_CONF_SERIALCOMM:
  90                         serialcomm = g_variant_get_string(src->data, NULL);
  91                         break;
  92                 }
  93         }
  94         if (!conn)
  95                 return NULL;
  96         if (!serialcomm)
  97                 serialcomm = SERIALCOMM;
  98
  99         serial = sr_serial_dev_inst_new(conn, serialcomm);
 100
 101         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 102                 return NULL;
 103
 104         serial_flush(serial);
 105
 106         buf = g_malloc(BUF_MAX);
 107
 108         snprintf(req, sizeof(req), "%s\r\n",
 109                  nmadmm_requests[NMADMM_REQ_IDN].req_str);
 110         g_usleep(150 * 1000); /* Wait a little to allow serial port to settle. */
 111         for (cnt = 0; cnt < 7; cnt++) {
 112                 if (serial_write_blocking(serial, req, strlen(req),
 113                                 serial_timeout(serial, strlen(req))) < 0) {
 114                         sr_err("Unable to send identification request.");
 115                         return NULL;
 116                 }
 117                 len = BUF_MAX;
 118                 serial_readline(serial, &buf, &len, NMADMM_TIMEOUT_MS);
 119                 if (!len)
 120                         continue;
 121                 buf[BUF_MAX - 1] = '\0';
 122
 123                 /* Match ID string, e.g. "1834 065 V1.06,IF V1.02" (DM950). */
 124                 if (g_regex_match_simple("^1834 [^,]*,IF V*", (char *)buf, 0, 0)) {
 125                         auxtype = xgittoint(buf[7]);
 126                         sr_spew("%s %s DMM %s detected!", get_brandstr(drv), get_typestr(auxtype, drv), buf + 9);
 127
 128                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 129                         sdi->status = SR_ST_INACTIVE;
 130                         sdi->vendor = g_strdup(get_brandstr(drv));
 131                         sdi->model = g_strdup(get_typestr(auxtype, drv));
 132                         sdi->version = g_strdup(buf + 9);
 133                         devc = g_malloc0(sizeof(struct dev_context));
 134                         sr_sw_limits_init(&devc->limits);
 135                         devc->type = auxtype;
 136                         sdi->conn = serial;
 137                         sdi->priv = devc;
 138                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 139                         devices = g_slist_append(devices, sdi);
 140                         break;
 141                 }
 142
 143                 /*
 144                  * The interface of the DM9x0 contains a cap that needs to
 145                  * charge for up to 10s before the interface works, if not
 146                  * powered externally. Therefore wait a little to improve
 147                  * chances.
 148                  */
 149                 if (cnt == 3) {
 150                         sr_info("Waiting 5s to allow interface to settle.");
 151                         g_usleep(5 * 1000 * 1000);
 152                 }
 153         }
 154
 155         g_free(buf);
 156
 157         serial_close(serial);
 158         if (!devices)
 159                 sr_serial_dev_inst_free(serial);
 160
 161         return std_scan_complete(drv, devices);
 162 }
 163
 164 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 165                 const struct sr_channel_group *cg)
 166 {
 167         struct dev_context *devc;
 168
 169         (void)cg;
 170
 171         if (sdi->status != SR_ST_ACTIVE)
 172                 return SR_ERR_DEV_CLOSED;
 173
 174         devc = sdi->priv;
 175
 176         return sr_sw_limits_config_set(&devc->limits, key, data);
 177 }
 178
 179 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 180                 const struct sr_channel_group *cg)
 181 {
 182         (void)sdi;
 183         (void)cg;
 184
 185         switch (key) {
 186         case SR_CONF_SCAN_OPTIONS:
 187                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 188                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 189                 break;
 190         case SR_CONF_DEVICE_OPTIONS:
 191                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 192                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 193                 break;
 194         default:
 195                 return SR_ERR_NA;
 196         }
 197
 198         return SR_OK;
 199 }
 200
 201 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 202 {
 203         struct dev_context *devc;
 204         struct sr_serial_dev_inst *serial;
 205
 206         if (sdi->status != SR_ST_ACTIVE)
 207                 return SR_ERR_DEV_CLOSED;
 208
 209         devc = sdi->priv;
 210
 211         sr_sw_limits_acquisition_start(&devc->limits);
 212         std_session_send_df_header(sdi);
 213
 214         /* Poll every 100ms, or whenever some data comes in. */
 215         serial = sdi->conn;
 216         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 217                         norma_dmm_receive_data, (void *)sdi);
 218
 219         return SR_OK;
 220 }
 221
 222 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 223 {
 224         return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close);
 225 }
 226
 227 static struct sr_dev_driver norma_dmm_driver_info = {
 228         .name = "norma-dmm",
 229         .longname = "Norma DM9x0 DMMs",
 230         .api_version = 1,
 231         .init = std_init,
 232         .cleanup = std_cleanup,
 233         .scan = scan,
 234         .dev_list = std_dev_list,
 235         .dev_clear = NULL,
 236         .config_get = NULL,
 237         .config_set = config_set,
 238         .config_list = config_list,
 239         .dev_open = std_serial_dev_open,
 240         .dev_close = std_serial_dev_close,
 241         .dev_acquisition_start = dev_acquisition_start,
 242         .dev_acquisition_stop = dev_acquisition_stop,
 243         .context = NULL,
 244 };
 245 SR_REGISTER_DEV_DRIVER(norma_dmm_driver_info);
 246
 247 static struct sr_dev_driver siemens_b102x_driver_info = {
 248         .name = "siemens-b102x",
 249         .longname = "Siemens B102x DMMs",
 250         .api_version = 1,
 251         .init = std_init,
 252         .cleanup = std_cleanup,
 253         .scan = scan,
 254         .dev_list = std_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         .context = NULL,
 264 };
 265 SR_REGISTER_DEV_DRIVER(siemens_b102x_driver_info);