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 drv_context *drvc;
  72         struct dev_context *devc;
  73         struct sr_config *src;
  74         struct sr_serial_dev_inst *serial;
  75         GSList *l, *devices;
  76         int len, cnt, auxtype;
  77         const char *conn, *serialcomm;
  78         char *buf;
  79         char req[10];
  80
  81         devices = NULL;
  82         drvc = drv->context;
  83         drvc->instances = 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                         devc->version = g_strdup(&buf[9]);
 140                         sdi->conn = serial;
 141                         sdi->priv = devc;
 142                         sdi->driver = drv;
 143                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 144                         drvc->instances = g_slist_append(drvc->instances, sdi);
 145                         devices = g_slist_append(devices, sdi);
 146                         break;
 147                 }
 148
 149                 /*
 150                  * The interface of the DM9x0 contains a cap that needs to
 151                  * charge for up to 10s before the interface works, if not
 152                  * powered externally. Therefore wait a little to improve
 153                  * chances.
 154                  */
 155                 if (cnt == 3) {
 156                         sr_info("Waiting 5s to allow interface to settle.");
 157                         g_usleep(5 * 1000 * 1000);
 158                 }
 159         }
 160
 161         g_free(buf);
 162
 163         serial_close(serial);
 164         if (!devices)
 165                 sr_serial_dev_inst_free(serial);
 166
 167         return devices;
 168 }
 169
 170 static int dev_close(struct sr_dev_inst *sdi)
 171 {
 172         struct dev_context *devc;
 173
 174         std_serial_dev_close(sdi);
 175
 176         /* Free dynamically allocated resources. */
 177         if ((devc = sdi->priv) && devc->version) {
 178                 g_free(devc->version);
 179                 devc->version = NULL;
 180         }
 181
 182         return SR_OK;
 183 }
 184
 185 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 186                 const struct sr_channel_group *cg)
 187 {
 188         struct dev_context *devc;
 189
 190         (void)cg;
 191
 192         if (sdi->status != SR_ST_ACTIVE)
 193                 return SR_ERR_DEV_CLOSED;
 194
 195         devc = sdi->priv;
 196
 197         return sr_sw_limits_config_set(&devc->limits, key, data);
 198 }
 199
 200 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 201                 const struct sr_channel_group *cg)
 202 {
 203         (void)sdi;
 204         (void)cg;
 205
 206         switch (key) {
 207         case SR_CONF_SCAN_OPTIONS:
 208                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 209                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 210                 break;
 211         case SR_CONF_DEVICE_OPTIONS:
 212                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 213                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 214                 break;
 215         default:
 216                 return SR_ERR_NA;
 217         }
 218
 219         return SR_OK;
 220 }
 221
 222 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 223 {
 224         struct dev_context *devc;
 225         struct sr_serial_dev_inst *serial;
 226
 227         if (sdi->status != SR_ST_ACTIVE)
 228                 return SR_ERR_DEV_CLOSED;
 229
 230         devc = sdi->priv;
 231
 232         sr_sw_limits_acquisition_start(&devc->limits);
 233         std_session_send_df_header(sdi, LOG_PREFIX);
 234
 235         /* Poll every 100ms, or whenever some data comes in. */
 236         serial = sdi->conn;
 237         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 238                         norma_dmm_receive_data, (void *)sdi);
 239
 240         return SR_OK;
 241 }
 242
 243 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 244 {
 245         return std_serial_dev_acquisition_stop(sdi, dev_close,
 246                         sdi->conn, LOG_PREFIX);
 247 }
 248
 249 static struct sr_dev_driver norma_dmm_driver_info = {
 250         .name = "norma-dmm",
 251         .longname = "Norma DM9x0 DMMs",
 252         .api_version = 1,
 253         .init = std_init,
 254         .cleanup = std_cleanup,
 255         .scan = scan,
 256         .dev_list = std_dev_list,
 257         .dev_clear = NULL,
 258         .config_get = NULL,
 259         .config_set = config_set,
 260         .config_list = config_list,
 261         .dev_open = std_serial_dev_open,
 262         .dev_close = dev_close,
 263         .dev_acquisition_start = dev_acquisition_start,
 264         .dev_acquisition_stop = dev_acquisition_stop,
 265         .context = NULL,
 266 };
 267 SR_REGISTER_DEV_DRIVER(norma_dmm_driver_info);
 268
 269 static struct sr_dev_driver siemens_b102x_driver_info = {
 270         .name = "siemens-b102x",
 271         .longname = "Siemens B102x DMMs",
 272         .api_version = 1,
 273         .init = std_init,
 274         .cleanup = std_cleanup,
 275         .scan = scan,
 276         .dev_list = std_dev_list,
 277         .dev_clear = NULL,
 278         .config_get = NULL,
 279         .config_set = config_set,
 280         .config_list = config_list,
 281         .dev_open = std_serial_dev_open,
 282         .dev_close = dev_close,
 283         .dev_acquisition_start = dev_acquisition_start,
 284         .dev_acquisition_stop = dev_acquisition_stop,
 285         .context = NULL,
 286 };
 287 SR_REGISTER_DEV_DRIVER(siemens_b102x_driver_info);