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