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 "protocol.h"
  26
  27 static const uint32_t scanopts[] = {
  28         SR_CONF_CONN,
  29         SR_CONF_SERIALCOMM,
  30 };
  31
  32 static const uint32_t devopts[] = {
  33         SR_CONF_MULTIMETER,
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  36         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  37 };
  38
  39 #define BUF_MAX 50
  40
  41 #define SERIALCOMM "4800/8n1/dtr=1/rts=0/flow=1"
  42
  43 SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
  44 SR_PRIV struct sr_dev_driver siemens_b102x_driver_info;
  45
  46 static const char* get_brandstr(struct sr_dev_driver* drv)
  47 {
  48         if (drv == &norma_dmm_driver_info)
  49                 return "Norma";
  50         else
  51                 return "Siemens";
  52 }
  53
  54 static const char* get_typestr(int type, struct sr_dev_driver* drv)
  55 {
  56         static const char* nameref[5][2] = {
  57                 {"DM910", "B1024"},
  58                 {"DM920", "B1025"},
  59                 {"DM930", "B1026"},
  60                 {"DM940", "B1027"},
  61                 {"DM950", "B1028"}};
  62
  63         if ((type < 1) || (type > 5))
  64                 return "Unknown type!";
  65
  66         return nameref[type-1][(drv == &siemens_b102x_driver_info)];
  67 }
  68
  69 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  70 {
  71         return std_init(sr_ctx, di, LOG_PREFIX);
  72 }
  73
  74 static GSList *scan(struct sr_dev_driver* drv, GSList *options)
  75 {
  76         struct sr_dev_inst *sdi;
  77         struct drv_context *drvc;
  78         struct dev_context *devc;
  79         struct sr_config *src;
  80         struct sr_serial_dev_inst *serial;
  81         GSList *l, *devices;
  82         int len, cnt;
  83         const char *conn, *serialcomm;
  84         char *buf;
  85         char req[10];
  86         int auxtype;
  87
  88         devices = NULL;
  89         drvc = drv->priv;
  90         drvc->instances = NULL;
  91         conn = serialcomm = NULL;
  92
  93         for (l = options; l; l = l->next) {
  94                 src = l->data;
  95                 switch (src->key) {
  96                 case SR_CONF_CONN:
  97                         conn = g_variant_get_string(src->data, NULL);
  98                         break;
  99                 case SR_CONF_SERIALCOMM:
 100                         serialcomm = g_variant_get_string(src->data, NULL);
 101                         break;
 102                 }
 103         }
 104         if (!conn)
 105                 return NULL;
 106         if (!serialcomm)
 107                 serialcomm = SERIALCOMM;
 108
 109         serial = sr_serial_dev_inst_new(conn, serialcomm);
 110
 111         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 112                 return NULL;
 113
 114         serial_flush(serial);
 115
 116         buf = g_malloc(BUF_MAX);
 117
 118         snprintf(req, sizeof(req), "%s\r\n",
 119                  nmadmm_requests[NMADMM_REQ_IDN].req_str);
 120         g_usleep(150 * 1000); /* Wait a little to allow serial port to settle. */
 121         for (cnt = 0; cnt < 7; cnt++) {
 122                 if (serial_write_blocking(serial, req, strlen(req), 0) < 0) {
 123                         sr_err("Unable to send identification request.");
 124                         return NULL;
 125                 }
 126                 len = BUF_MAX;
 127                 serial_readline(serial, &buf, &len, NMADMM_TIMEOUT_MS);
 128                 if (!len)
 129                         continue;
 130                 buf[BUF_MAX - 1] = '\0';
 131
 132                 /* Match ID string, e.g. "1834 065 V1.06,IF V1.02" (DM950) */
 133                 if (g_regex_match_simple("^1834 [^,]*,IF V*", (char *)buf, 0, 0)) {
 134                         auxtype = xgittoint(buf[7]);
 135                         sr_spew("%s %s DMM %s detected!", get_brandstr(drv), get_typestr(auxtype, drv), buf + 9);
 136
 137                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 138                         sdi->status = SR_ST_INACTIVE;
 139                         sdi->vendor = g_strdup(get_brandstr(drv));
 140                         sdi->model = g_strdup(get_typestr(auxtype, drv));
 141                         sdi->version = g_strdup(buf + 9);
 142                         devc = g_malloc0(sizeof(struct dev_context));
 143                         devc->type = auxtype;
 144                         devc->version = g_strdup(&buf[9]);
 145                         devc->elapsed_msec = g_timer_new();
 146                         sdi->conn = serial;
 147                         sdi->priv = devc;
 148                         sdi->driver = drv;
 149                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 150                         drvc->instances = g_slist_append(drvc->instances, sdi);
 151                         devices = g_slist_append(devices, sdi);
 152                         break;
 153                 }
 154
 155                 /*
 156                  * The interface of the DM9x0 contains a cap that needs to
 157                  * charge for up to 10s before the interface works, if not
 158                  * powered externally. Therefore wait a little to improve
 159                  * chances.
 160                  */
 161                 if (cnt == 3) {
 162                         sr_info("Waiting 5s to allow interface to settle.");
 163                         g_usleep(5 * 1000 * 1000);
 164                 }
 165         }
 166
 167         g_free(buf);
 168
 169         serial_close(serial);
 170         if (!devices)
 171                 sr_serial_dev_inst_free(serial);
 172
 173         return devices;
 174 }
 175
 176 static GSList *dev_list(const struct sr_dev_driver *di)
 177 {
 178         return ((struct drv_context *)(di->context))->instances;
 179 }
 180
 181 static int dev_close(struct sr_dev_inst *sdi)
 182 {
 183         struct dev_context *devc;
 184
 185         std_serial_dev_close(sdi);
 186
 187         /* Free dynamically allocated resources. */
 188         if ((devc = sdi->priv) && devc->version) {
 189                 g_free(devc->version);
 190                 devc->version = NULL;
 191                 g_timer_destroy(devc->elapsed_msec);
 192         }
 193
 194         return SR_OK;
 195 }
 196
 197 static int cleanup(const struct sr_dev_driver *di)
 198 {
 199         return std_dev_clear(di, NULL);
 200 }
 201
 202 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 203                 const struct sr_channel_group *cg)
 204 {
 205         struct dev_context *devc;
 206
 207         (void)cg;
 208
 209         if (sdi->status != SR_ST_ACTIVE)
 210                 return SR_ERR_DEV_CLOSED;
 211
 212         if (!(devc = sdi->priv)) {
 213                 sr_err("sdi->priv was NULL.");
 214                 return SR_ERR_BUG;
 215         }
 216
 217         switch (key) {
 218         case SR_CONF_LIMIT_MSEC:
 219                 devc->limit_msec = g_variant_get_uint64(data);
 220                 break;
 221         case SR_CONF_LIMIT_SAMPLES:
 222                 devc->limit_samples = g_variant_get_uint64(data);
 223                 break;
 224         default:
 225                 return SR_ERR_NA;
 226         }
 227
 228         return SR_OK;
 229 }
 230
 231 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 232                 const struct sr_channel_group *cg)
 233 {
 234         (void)sdi;
 235         (void)cg;
 236
 237         switch (key) {
 238         case SR_CONF_SCAN_OPTIONS:
 239                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 240                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 241                 break;
 242         case SR_CONF_DEVICE_OPTIONS:
 243                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 244                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 245                 break;
 246         default:
 247                 return SR_ERR_NA;
 248         }
 249
 250         return SR_OK;
 251 }
 252
 253 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 254                                     void *cb_data)
 255 {
 256         struct dev_context *devc;
 257         struct sr_serial_dev_inst *serial;
 258
 259         if (!sdi || !cb_data || !(devc = sdi->priv))
 260                 return SR_ERR_BUG;
 261
 262         if (sdi->status != SR_ST_ACTIVE)
 263                 return SR_ERR_DEV_CLOSED;
 264
 265         devc->cb_data = cb_data;
 266
 267         /* Send header packet to the session bus. */
 268         std_session_send_df_header(cb_data, LOG_PREFIX);
 269
 270         /* Start timer, if required. */
 271         if (devc->limit_msec)
 272                 g_timer_start(devc->elapsed_msec);
 273
 274         /* Poll every 100ms, or whenever some data comes in. */
 275         serial = sdi->conn;
 276         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 277                         norma_dmm_receive_data, (void *)sdi);
 278
 279         return SR_OK;
 280 }
 281
 282 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 283 {
 284         struct dev_context *devc;
 285
 286         /* Stop timer, if required. */
 287         if (sdi && (devc = sdi->priv) && devc->limit_msec)
 288                 g_timer_stop(devc->elapsed_msec);
 289
 290         return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
 291                         sdi->conn, LOG_PREFIX);
 292 }
 293
 294 SR_PRIV struct sr_dev_driver norma_dmm_driver_info = {
 295         .name = "norma-dmm",
 296         .longname = "Norma DM9x0 DMMs",
 297         .api_version = 1,
 298         .init = init,
 299         .cleanup = cleanup,
 300         .scan = scan,
 301         .dev_list = dev_list,
 302         .dev_clear = NULL,
 303         .config_get = NULL,
 304         .config_set = config_set,
 305         .config_list = config_list,
 306         .dev_open = std_serial_dev_open,
 307         .dev_close = dev_close,
 308         .dev_acquisition_start = dev_acquisition_start,
 309         .dev_acquisition_stop = dev_acquisition_stop,
 310         .context = NULL,
 311 };
 312
 313 SR_PRIV struct sr_dev_driver siemens_b102x_driver_info = {
 314         .name = "siemens-b102x",
 315         .longname = "Siemens B102x DMMs",
 316         .api_version = 1,
 317         .init = init,
 318         .cleanup = cleanup,
 319         .scan = scan,
 320         .dev_list = dev_list,
 321         .dev_clear = NULL,
 322         .config_get = NULL,
 323         .config_set = config_set,
 324         .config_list = config_list,
 325         .dev_open = std_serial_dev_open,
 326         .dev_close = dev_close,
 327         .dev_acquisition_start = dev_acquisition_start,
 328         .dev_acquisition_stop = dev_acquisition_stop,
 329         .context = NULL,
 330 };