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