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