src/hardware/kern-scale/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <config.h>
  22 #include <glib.h>
  23 #include <libsigrok/libsigrok.h>
  24 #include "libsigrok-internal.h"
  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_SCALE,
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  36         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  37 };
  38
  39 static int dev_clear(const struct sr_dev_driver *di)
  40 {
  41         return std_dev_clear(di, NULL);
  42 }
  43
  44 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  45 {
  46         return std_init(sr_ctx, di, LOG_PREFIX);
  47 }
  48
  49 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  50 {
  51         struct scale_info *scale;
  52         struct sr_config *src;
  53         GSList *l, *devices;
  54         const char *conn, *serialcomm;
  55         struct sr_dev_inst *sdi;
  56         struct drv_context *drvc;
  57         struct dev_context *devc;
  58         struct sr_serial_dev_inst *serial;
  59         int ret;
  60         size_t len;
  61         uint8_t buf[128];
  62
  63         scale = (struct scale_info *)di;
  64
  65         conn = serialcomm = NULL;
  66         for (l = options; l; l = l->next) {
  67                 src = l->data;
  68                 switch (src->key) {
  69                 case SR_CONF_CONN:
  70                         conn = g_variant_get_string(src->data, NULL);
  71                         break;
  72                 case SR_CONF_SERIALCOMM:
  73                         serialcomm = g_variant_get_string(src->data, NULL);
  74                         break;
  75                 }
  76         }
  77         if (!conn)
  78                 return NULL;
  79
  80         if (!serialcomm)
  81                 serialcomm = scale->conn;
  82
  83         serial = sr_serial_dev_inst_new(conn, serialcomm);
  84
  85         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  86                 return NULL;
  87
  88         sr_info("Probing serial port %s.", conn);
  89
  90         drvc = di->context;
  91         devices = NULL;
  92         serial_flush(serial);
  93
  94         sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
  95         if (serial_write_nonblocking(serial, "O1\r\n", 4) != 4)
  96                 goto scan_cleanup;
  97         /* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
  98
  99         /* Let's get a bit of data and see if we can find a packet. */
 100         len = sizeof(buf);
 101         ret = serial_stream_detect(serial, buf, &len, scale->packet_size,
 102                                    scale->packet_valid, 3000, scale->baudrate);
 103         if (ret != SR_OK)
 104                 goto scan_cleanup;
 105
 106         sr_info("Found device on port %s.", conn);
 107
 108         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 109         sdi->status = SR_ST_INACTIVE;
 110         sdi->vendor = g_strdup(scale->vendor);
 111         sdi->model = g_strdup(scale->device);
 112         devc = g_malloc0(sizeof(struct dev_context));
 113         sdi->inst_type = SR_INST_SERIAL;
 114         sdi->conn = serial;
 115         sdi->priv = devc;
 116         sdi->driver = di;
 117         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Mass");
 118         drvc->instances = g_slist_append(drvc->instances, sdi);
 119         devices = g_slist_append(devices, sdi);
 120
 121 scan_cleanup:
 122         serial_close(serial);
 123
 124         return devices;
 125 }
 126
 127 static GSList *dev_list(const struct sr_dev_driver *di)
 128 {
 129         return ((struct drv_context *)(di->context))->instances;
 130 }
 131
 132 static int cleanup(const struct sr_dev_driver *di)
 133 {
 134         return dev_clear(di);
 135 }
 136
 137 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 138                 const struct sr_channel_group *cg)
 139 {
 140         struct dev_context *devc;
 141
 142         (void)cg;
 143
 144         if (sdi->status != SR_ST_ACTIVE)
 145                 return SR_ERR_DEV_CLOSED;
 146
 147         if (!(devc = sdi->priv))
 148                 return SR_ERR_BUG;
 149
 150         switch (key) {
 151         case SR_CONF_LIMIT_SAMPLES:
 152                 devc->limit_samples = g_variant_get_uint64(data);
 153                 break;
 154         case SR_CONF_LIMIT_MSEC:
 155                 devc->limit_msec = g_variant_get_uint64(data);
 156                 break;
 157         default:
 158                 return SR_ERR_NA;
 159         }
 160
 161         return SR_OK;
 162 }
 163
 164 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 165                 const struct sr_channel_group *cg)
 166 {
 167         (void)sdi;
 168         (void)cg;
 169
 170         switch (key) {
 171         case SR_CONF_SCAN_OPTIONS:
 172                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 173                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 174                 break;
 175         case SR_CONF_DEVICE_OPTIONS:
 176                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 177                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 178                 break;
 179         default:
 180                 return SR_ERR_NA;
 181         }
 182
 183         return SR_OK;
 184 }
 185
 186 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 187 {
 188         struct dev_context *devc;
 189         struct sr_serial_dev_inst *serial;
 190
 191         if (sdi->status != SR_ST_ACTIVE)
 192                 return SR_ERR_DEV_CLOSED;
 193
 194         if (!(devc = sdi->priv))
 195                 return SR_ERR_BUG;
 196
 197         devc->cb_data = cb_data;
 198
 199         serial = sdi->conn;
 200
 201         sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
 202         if (serial_write_nonblocking(serial, "O1\r\n", 4) != 4)
 203                 return SR_ERR;
 204         /* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
 205
 206         devc->num_samples = 0;
 207         devc->starttime = g_get_monotonic_time();
 208
 209         std_session_send_df_header(cb_data, LOG_PREFIX);
 210
 211         /* Poll every 50ms, or whenever some data comes in. */
 212         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 213                       kern_scale_receive_data, (void *)sdi);
 214
 215         return SR_OK;
 216 }
 217
 218 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 219 {
 220         return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
 221                         sdi->conn, LOG_PREFIX);
 222 }
 223
 224 #define SCALE(ID, CHIPSET, VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
 225                         VALID, PARSE) \
 226         &(struct scale_info) { \
 227                 { \
 228                         .name = ID, \
 229                         .longname = VENDOR " " MODEL, \
 230                         .api_version = 1, \
 231                         .init = init, \
 232                         .cleanup = cleanup, \
 233                         .scan = scan, \
 234                         .dev_list = dev_list, \
 235                         .dev_clear = dev_clear, \
 236                         .config_get = NULL, \
 237                         .config_set = config_set, \
 238                         .config_list = config_list, \
 239                         .dev_open = std_serial_dev_open, \
 240                         .dev_close = std_serial_dev_close, \
 241                         .dev_acquisition_start = dev_acquisition_start, \
 242                         .dev_acquisition_stop = dev_acquisition_stop, \
 243                         .context = NULL, \
 244                 }, \
 245                 VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
 246                 VALID, PARSE, sizeof(struct CHIPSET##_info) \
 247         }
 248
 249 /*
 250  * Some scales have (user-configurable) 14-byte or 15-byte packets.
 251  * We transparently support both variants by specifying the larger value
 252  * below and due to the way the stream parser works.
 253  *
 254  * The scales have a standard baudrate (model dependent) as listed below,
 255  * but serial parameters are user-configurable. We support that by letting
 256  * the user override them via "serialcomm".
 257  */
 258
 259 SR_PRIV const struct scale_info *kern_scale_drivers[] = {
 260         SCALE(
 261                 "kern-ew-6200-2nm", kern,
 262                 "KERN", "EW 6200-2NM", "1200/8n2", 1200,
 263                 15 /* (or 14) */, sr_kern_packet_valid, sr_kern_parse
 264         ),
 265         NULL
 266 };