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         conn = serialcomm = NULL;
  84
  85         for (l = options; l; l = l->next) {
  86                 src = l->data;
  87                 switch (src->key) {
  88                 case SR_CONF_CONN:
  89                         conn = g_variant_get_string(src->data, NULL);
  90                         break;
  91                 case SR_CONF_SERIALCOMM:
  92                         serialcomm = g_variant_get_string(src->data, NULL);
  93                         break;
  94                 }
  95         }
  96         if (!conn)
  97                 return NULL;
  98         if (!serialcomm)
  99                 serialcomm = SERIALCOMM;
 100
 101         serial = sr_serial_dev_inst_new(conn, serialcomm);
 102
 103         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 104                 return NULL;
 105
 106         serial_flush(serial);
 107
 108         buf = g_malloc(BUF_MAX);
 109
 110         snprintf(req, sizeof(req), "%s\r\n",
 111                  nmadmm_requests[NMADMM_REQ_IDN].req_str);
 112         g_usleep(150 * 1000); /* Wait a little to allow serial port to settle. */
 113         for (cnt = 0; cnt < 7; cnt++) {
 114                 if (serial_write_blocking(serial, req, strlen(req),
 115                                 serial_timeout(serial, strlen(req))) < 0) {
 116                         sr_err("Unable to send identification request.");
 117                         return NULL;
 118                 }
 119                 len = BUF_MAX;
 120                 serial_readline(serial, &buf, &len, NMADMM_TIMEOUT_MS);
 121                 if (!len)
 122                         continue;
 123                 buf[BUF_MAX - 1] = '\0';
 124
 125                 /* Match ID string, e.g. "1834 065 V1.06,IF V1.02" (DM950). */
 126                 if (g_regex_match_simple("^1834 [^,]*,IF V*", (char *)buf, 0, 0)) {
 127                         auxtype = xgittoint(buf[7]);
 128                         sr_spew("%s %s DMM %s detected!", get_brandstr(drv), get_typestr(auxtype, drv), buf + 9);
 129
 130                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 131                         sdi->status = SR_ST_INACTIVE;
 132                         sdi->vendor = g_strdup(get_brandstr(drv));
 133                         sdi->model = g_strdup(get_typestr(auxtype, drv));
 134                         sdi->version = g_strdup(buf + 9);
 135                         devc = g_malloc0(sizeof(struct dev_context));
 136                         sr_sw_limits_init(&devc->limits);
 137                         devc->type = auxtype;
 138                         devc->version = g_strdup(&buf[9]);
 139                         sdi->conn = serial;
 140                         sdi->priv = devc;
 141                         sdi->driver = drv;
 142                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 143                         drvc->instances = g_slist_append(drvc->instances, sdi);
 144                         devices = g_slist_append(devices, sdi);
 145                         break;
 146                 }
 147
 148                 /*
 149                  * The interface of the DM9x0 contains a cap that needs to
 150                  * charge for up to 10s before the interface works, if not
 151                  * powered externally. Therefore wait a little to improve
 152                  * chances.
 153                  */
 154                 if (cnt == 3) {
 155                         sr_info("Waiting 5s to allow interface to settle.");
 156                         g_usleep(5 * 1000 * 1000);
 157                 }
 158         }
 159
 160         g_free(buf);
 161
 162         serial_close(serial);
 163         if (!devices)
 164                 sr_serial_dev_inst_free(serial);
 165
 166         return devices;
 167 }
 168
 169 static int dev_close(struct sr_dev_inst *sdi)
 170 {
 171         struct dev_context *devc;
 172
 173         std_serial_dev_close(sdi);
 174
 175         /* Free dynamically allocated resources. */
 176         if ((devc = sdi->priv) && devc->version) {
 177                 g_free(devc->version);
 178                 devc->version = NULL;
 179         }
 180
 181         return SR_OK;
 182 }
 183
 184 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 185                 const struct sr_channel_group *cg)
 186 {
 187         struct dev_context *devc;
 188
 189         (void)cg;
 190
 191         if (sdi->status != SR_ST_ACTIVE)
 192                 return SR_ERR_DEV_CLOSED;
 193
 194         devc = sdi->priv;
 195
 196         return sr_sw_limits_config_set(&devc->limits, key, data);
 197 }
 198
 199 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 200                 const struct sr_channel_group *cg)
 201 {
 202         (void)sdi;
 203         (void)cg;
 204
 205         switch (key) {
 206         case SR_CONF_SCAN_OPTIONS:
 207                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 208                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 209                 break;
 210         case SR_CONF_DEVICE_OPTIONS:
 211                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 212                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 213                 break;
 214         default:
 215                 return SR_ERR_NA;
 216         }
 217
 218         return SR_OK;
 219 }
 220
 221 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 222 {
 223         struct dev_context *devc;
 224         struct sr_serial_dev_inst *serial;
 225
 226         if (sdi->status != SR_ST_ACTIVE)
 227                 return SR_ERR_DEV_CLOSED;
 228
 229         devc = sdi->priv;
 230
 231         sr_sw_limits_acquisition_start(&devc->limits);
 232         std_session_send_df_header(sdi, LOG_PREFIX);
 233
 234         /* Poll every 100ms, or whenever some data comes in. */
 235         serial = sdi->conn;
 236         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 237                         norma_dmm_receive_data, (void *)sdi);
 238
 239         return SR_OK;
 240 }
 241
 242 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 243 {
 244         return std_serial_dev_acquisition_stop(sdi, dev_close,
 245                         sdi->conn, LOG_PREFIX);
 246 }
 247
 248 static struct sr_dev_driver norma_dmm_driver_info = {
 249         .name = "norma-dmm",
 250         .longname = "Norma DM9x0 DMMs",
 251         .api_version = 1,
 252         .init = std_init,
 253         .cleanup = std_cleanup,
 254         .scan = scan,
 255         .dev_list = std_dev_list,
 256         .dev_clear = NULL,
 257         .config_get = NULL,
 258         .config_set = config_set,
 259         .config_list = config_list,
 260         .dev_open = std_serial_dev_open,
 261         .dev_close = dev_close,
 262         .dev_acquisition_start = dev_acquisition_start,
 263         .dev_acquisition_stop = dev_acquisition_stop,
 264         .context = NULL,
 265 };
 266 SR_REGISTER_DEV_DRIVER(norma_dmm_driver_info);
 267
 268 static struct sr_dev_driver siemens_b102x_driver_info = {
 269         .name = "siemens-b102x",
 270         .longname = "Siemens B102x DMMs",
 271         .api_version = 1,
 272         .init = std_init,
 273         .cleanup = std_cleanup,
 274         .scan = scan,
 275         .dev_list = std_dev_list,
 276         .dev_clear = NULL,
 277         .config_get = NULL,
 278         .config_set = config_set,
 279         .config_list = config_list,
 280         .dev_open = std_serial_dev_open,
 281         .dev_close = dev_close,
 282         .dev_acquisition_start = dev_acquisition_start,
 283         .dev_acquisition_stop = dev_acquisition_stop,
 284         .context = NULL,
 285 };
 286 SR_REGISTER_DEV_DRIVER(siemens_b102x_driver_info);