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_norma_dmm(struct sr_context *sr_ctx)
  70 {
  71         return std_init(sr_ctx, &norma_dmm_driver_info, LOG_PREFIX);
  72 }
  73
  74 static int init_siemens_b102x(struct sr_context *sr_ctx)
  75 {
  76         return std_init(sr_ctx, &siemens_b102x_driver_info, LOG_PREFIX);
  77 }
  78
  79 static GSList *do_scan(struct sr_dev_driver* drv, GSList *options)
  80 {
  81         struct sr_dev_inst *sdi;
  82         struct drv_context *drvc;
  83         struct dev_context *devc;
  84         struct sr_config *src;
  85         struct sr_channel *ch;
  86         struct sr_serial_dev_inst *serial;
  87         GSList *l, *devices;
  88         int len, cnt;
  89         const char *conn, *serialcomm;
  90         char *buf;
  91         char req[10];
  92         int auxtype;
  93
  94         devices = NULL;
  95         drvc = drv->priv;
  96         drvc->instances = NULL;
  97         conn = serialcomm = NULL;
  98
  99         for (l = options; l; l = l->next) {
 100                 src = l->data;
 101                 switch (src->key) {
 102                 case SR_CONF_CONN:
 103                         conn = g_variant_get_string(src->data, NULL);
 104                         break;
 105                 case SR_CONF_SERIALCOMM:
 106                         serialcomm = g_variant_get_string(src->data, NULL);
 107                         break;
 108                 }
 109         }
 110         if (!conn)
 111                 return NULL;
 112         if (!serialcomm)
 113                 serialcomm = SERIALCOMM;
 114
 115         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
 116                 return NULL;
 117
 118         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 119                 return NULL;
 120
 121         serial_flush(serial);
 122
 123         if (!(buf = g_try_malloc(BUF_MAX))) {
 124                 sr_err("Serial buffer malloc failed.");
 125                 return NULL;
 126         }
 127
 128         snprintf(req, sizeof(req), "%s\r\n",
 129                  nmadmm_requests[NMADMM_REQ_IDN].req_str);
 130         g_usleep(150 * 1000); /* Wait a little to allow serial port to settle. */
 131         for (cnt = 0; cnt < 7; cnt++) {
 132                 if (serial_write_blocking(serial, req, strlen(req), 0) < 0) {
 133                         sr_err("Unable to send identification request.");
 134                         return NULL;
 135                 }
 136                 len = BUF_MAX;
 137                 serial_readline(serial, &buf, &len, NMADMM_TIMEOUT_MS);
 138                 if (!len)
 139                         continue;
 140                 buf[BUF_MAX - 1] = '\0';
 141
 142                 /* Match ID string, e.g. "1834 065 V1.06,IF V1.02" (DM950) */
 143                 if (g_regex_match_simple("^1834 [^,]*,IF V*", (char *)buf, 0, 0)) {
 144                         auxtype = xgittoint(buf[7]);
 145                         sr_spew("%s %s DMM %s detected!", get_brandstr(drv), get_typestr(auxtype, drv), buf + 9);
 146
 147                         sdi = sr_dev_inst_new();
 148                         sdi->status = SR_ST_INACTIVE;
 149                         sdi->vendor = g_strdup(get_brandstr(drv));
 150                         sdi->model = g_strdup(get_typestr(auxtype, drv));
 151                         sdi->version = g_strdup(buf + 9);
 152                         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 153                                 sr_err("Device context malloc failed.");
 154                                 return NULL;
 155                         }
 156                         devc->type = auxtype;
 157                         devc->version = g_strdup(&buf[9]);
 158                         devc->elapsed_msec = g_timer_new();
 159
 160                         sdi->conn = serial;
 161                         sdi->priv = devc;
 162                         sdi->driver = drv;
 163                         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE,
 164                                 "P1")))
 165                                 return NULL;
 166                         sdi->channels = g_slist_append(sdi->channels, ch);
 167                         drvc->instances = g_slist_append(drvc->instances, sdi);
 168                         devices = g_slist_append(devices, sdi);
 169                         break;
 170                 }
 171
 172                 /*
 173                  * The interface of the DM9x0 contains a cap that needs to
 174                  * charge for up to 10s before the interface works, if not
 175                  * powered externally. Therefore wait a little to improve
 176                  * chances.
 177                  */
 178                 if (cnt == 3) {
 179                         sr_info("Waiting 5s to allow interface to settle.");
 180                         g_usleep(5 * 1000 * 1000);
 181                 }
 182         }
 183
 184         g_free(buf);
 185
 186         serial_close(serial);
 187         if (!devices)
 188                 sr_serial_dev_inst_free(serial);
 189
 190         return devices;
 191 }
 192
 193 static GSList *scan_norma_dmm(GSList *options)
 194 {
 195         return do_scan(&norma_dmm_driver_info, options);
 196 }
 197
 198 static GSList *scan_siemens_b102x(GSList *options)
 199 {
 200         return do_scan(&siemens_b102x_driver_info, options);
 201 }
 202
 203 static GSList *dev_list_norma_dmm(void)
 204 {
 205         return ((struct drv_context *)(norma_dmm_driver_info.priv))->instances;
 206 }
 207
 208 static GSList *dev_list_siemens_b102x(void)
 209 {
 210         return ((struct drv_context *)(siemens_b102x_driver_info.priv))->instances;
 211 }
 212
 213 static int dev_close(struct sr_dev_inst *sdi)
 214 {
 215         struct dev_context *devc;
 216
 217         std_serial_dev_close(sdi);
 218
 219         /* Free dynamically allocated resources. */
 220         if ((devc = sdi->priv) && devc->version) {
 221                 g_free(devc->version);
 222                 devc->version = NULL;
 223                 g_timer_destroy(devc->elapsed_msec);
 224         }
 225
 226         return SR_OK;
 227 }
 228
 229 static int cleanup_norma_dmm(void)
 230 {
 231         return std_dev_clear(&norma_dmm_driver_info, NULL);
 232 }
 233
 234 static int cleanup_siemens_b102x(void)
 235 {
 236         return std_dev_clear(&siemens_b102x_driver_info, NULL);
 237 }
 238
 239 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 240                 const struct sr_channel_group *cg)
 241 {
 242         struct dev_context *devc;
 243
 244         (void)cg;
 245
 246         if (sdi->status != SR_ST_ACTIVE)
 247                 return SR_ERR_DEV_CLOSED;
 248
 249         if (!(devc = sdi->priv)) {
 250                 sr_err("sdi->priv was NULL.");
 251                 return SR_ERR_BUG;
 252         }
 253
 254         switch (key) {
 255         case SR_CONF_LIMIT_MSEC:
 256                 if (g_variant_get_uint64(data) == 0) {
 257                         sr_err("LIMIT_MSEC can't be 0.");
 258                         return SR_ERR;
 259                 }
 260                 devc->limit_msec = g_variant_get_uint64(data);
 261                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 262                        devc->limit_msec);
 263                 break;
 264         case SR_CONF_LIMIT_SAMPLES:
 265                 devc->limit_samples = g_variant_get_uint64(data);
 266                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 267                        devc->limit_samples);
 268                 break;
 269         default:
 270                 return SR_ERR_NA;
 271         }
 272
 273         return SR_OK;
 274 }
 275
 276 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 277                 const struct sr_channel_group *cg)
 278 {
 279         (void)sdi;
 280         (void)cg;
 281
 282         switch (key) {
 283         case SR_CONF_SCAN_OPTIONS:
 284                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 285                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 286                 break;
 287         case SR_CONF_DEVICE_OPTIONS:
 288                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 289                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 290                 break;
 291         default:
 292                 return SR_ERR_NA;
 293         }
 294
 295         return SR_OK;
 296 }
 297
 298 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 299                                     void *cb_data)
 300 {
 301         struct dev_context *devc;
 302         struct sr_serial_dev_inst *serial;
 303
 304         if (!sdi || !cb_data || !(devc = sdi->priv))
 305                 return SR_ERR_BUG;
 306
 307         if (sdi->status != SR_ST_ACTIVE)
 308                 return SR_ERR_DEV_CLOSED;
 309
 310         devc->cb_data = cb_data;
 311
 312         /* Send header packet to the session bus. */
 313         std_session_send_df_header(cb_data, LOG_PREFIX);
 314
 315         /* Start timer, if required. */
 316         if (devc->limit_msec)
 317                 g_timer_start(devc->elapsed_msec);
 318
 319         /* Poll every 100ms, or whenever some data comes in. */
 320         serial = sdi->conn;
 321         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 322                         norma_dmm_receive_data, (void *)sdi);
 323
 324         return SR_OK;
 325 }
 326
 327 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 328 {
 329         struct dev_context *devc;
 330
 331         /* Stop timer, if required. */
 332         if (sdi && (devc = sdi->priv) && devc->limit_msec)
 333                 g_timer_stop(devc->elapsed_msec);
 334
 335         return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
 336                         sdi->conn, LOG_PREFIX);
 337 }
 338
 339 SR_PRIV struct sr_dev_driver norma_dmm_driver_info = {
 340         .name = "norma-dmm",
 341         .longname = "Norma DM9x0 DMMs",
 342         .api_version = 1,
 343         .init = init_norma_dmm,
 344         .cleanup = cleanup_norma_dmm,
 345         .scan = scan_norma_dmm,
 346         .dev_list = dev_list_norma_dmm,
 347         .dev_clear = NULL,
 348         .config_get = NULL,
 349         .config_set = config_set,
 350         .config_list = config_list,
 351         .dev_open = std_serial_dev_open,
 352         .dev_close = dev_close,
 353         .dev_acquisition_start = dev_acquisition_start,
 354         .dev_acquisition_stop = dev_acquisition_stop,
 355         .priv = NULL,
 356 };
 357
 358
 359 SR_PRIV struct sr_dev_driver siemens_b102x_driver_info = {
 360         .name = "siemens-b102x",
 361         .longname = "Siemens B102x DMMs",
 362         .api_version = 1,
 363         .init = init_siemens_b102x,
 364         .cleanup = cleanup_siemens_b102x,
 365         .scan = scan_siemens_b102x,
 366         .dev_list = dev_list_siemens_b102x,
 367         .dev_clear = NULL,
 368         .config_get = NULL,
 369         .config_set = config_set,
 370         .config_list = config_list,
 371         .dev_open = std_serial_dev_open,
 372         .dev_close = dev_close,
 373         .dev_acquisition_start = dev_acquisition_start,
 374         .dev_acquisition_stop = dev_acquisition_stop,
 375         .priv = NULL,
 376 };