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