src/hardware/rdtech-um/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2018-2020 Andreas Sandberg <andreas@sandberg.pp.se>
   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 #include <config.h>
  21
  22 #include <glib.h>
  23 #include <fcntl.h>
  24 #include <libsigrok/libsigrok.h>
  25 #include <string.h>
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28
  29 #include "libsigrok-internal.h"
  30 #include "protocol.h"
  31
  32 #define RDTECH_UM_SERIALCOMM "115200/8n1"
  33
  34 static const uint32_t scanopts[] = {
  35         SR_CONF_CONN,
  36         SR_CONF_SERIALCOMM,
  37 };
  38
  39 static const uint32_t drvopts[] = {
  40         SR_CONF_ENERGYMETER,
  41 };
  42
  43 static const uint32_t devopts[] = {
  44         SR_CONF_CONTINUOUS,
  45         SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
  46         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  47 };
  48
  49 static GSList *rdtech_um_scan(struct sr_dev_driver *di,
  50         const char *conn, const char *serialcomm)
  51 {
  52         struct sr_serial_dev_inst *serial;
  53         const struct rdtech_um_profile *p;
  54         GSList *devices;
  55         struct dev_context *devc;
  56         struct sr_dev_inst *sdi;
  57         size_t ch_idx;
  58         const struct rdtech_um_channel_desc *pch;
  59         struct sr_channel *ch;
  60         struct feed_queue_analog *feed;
  61
  62         serial = sr_serial_dev_inst_new(conn, serialcomm);
  63         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  64                 goto err_out;
  65
  66         p = rdtech_um_probe(serial);
  67         if (!p) {
  68                 sr_err("Failed to find a supported RDTech UM device.");
  69                 goto err_out_serial;
  70         }
  71
  72         devc = g_malloc0(sizeof(*devc));
  73         sr_sw_limits_init(&devc->limits);
  74         devc->profile = p;
  75
  76         sdi = g_malloc0(sizeof(*sdi));
  77         sdi->priv = devc;
  78         sdi->status = SR_ST_INACTIVE;
  79         sdi->vendor = g_strdup("RDTech");
  80         sdi->model = g_strdup(p->model_name);
  81         sdi->version = NULL;
  82         sdi->inst_type = SR_INST_SERIAL;
  83         sdi->conn = serial;
  84
  85         devc->feeds = g_malloc0(p->channel_count * sizeof(devc->feeds[0]));
  86         for (ch_idx = 0; ch_idx < p->channel_count; ch_idx++) {
  87                 pch = &p->channels[ch_idx];
  88                 ch = sr_channel_new(sdi, ch_idx,
  89                         SR_CHANNEL_ANALOG, TRUE, pch->name);
  90                 feed = feed_queue_analog_alloc(sdi, 1, pch->digits, ch);
  91                 feed_queue_analog_mq_unit(feed, pch->mq, 0, pch->unit);
  92                 feed_queue_analog_scale_offset(feed, &pch->scale, NULL);
  93                 devc->feeds[ch_idx] = feed;
  94         }
  95
  96         devices = g_slist_append(NULL, sdi);
  97         serial_close(serial);
  98         if (!devices)
  99                 sr_serial_dev_inst_free(serial);
 100
 101         return std_scan_complete(di, devices);
 102
 103 err_out_serial:
 104         serial_close(serial);
 105 err_out:
 106         sr_serial_dev_inst_free(serial);
 107
 108         return NULL;
 109 }
 110
 111 static void clear_helper(struct dev_context *devc)
 112 {
 113         const struct rdtech_um_profile *p;
 114         size_t ch_idx;
 115
 116         if (!devc)
 117                 return;
 118
 119         p = devc->profile;
 120         if (p && devc->feeds) {
 121                 for (ch_idx = 0; ch_idx < p->channel_count; ch_idx++)
 122                         feed_queue_analog_free(devc->feeds[ch_idx]);
 123                 g_free(devc->feeds);
 124         }
 125 }
 126
 127 static int dev_clear(const struct sr_dev_driver *di)
 128 {
 129         return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 130 }
 131
 132 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 133 {
 134         const char *conn;
 135         const char *serialcomm;
 136
 137         conn = NULL;
 138         serialcomm = RDTECH_UM_SERIALCOMM;
 139         (void)sr_serial_extract_options(options, &conn, &serialcomm);
 140         if (!conn)
 141                 return NULL;
 142
 143         return rdtech_um_scan(di, conn, serialcomm);
 144 }
 145
 146 static int config_get(uint32_t key, GVariant **data,
 147         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 148 {
 149         struct dev_context *devc;
 150
 151         (void)cg;
 152
 153         devc = sdi->priv;
 154
 155         return sr_sw_limits_config_get(&devc->limits, key, data);
 156 }
 157
 158 static int config_set(uint32_t key, GVariant *data,
 159         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 160 {
 161         struct dev_context *devc;
 162
 163         (void)cg;
 164
 165         devc = sdi->priv;
 166
 167         return sr_sw_limits_config_set(&devc->limits, key, data);
 168 }
 169
 170 static int config_list(uint32_t key, GVariant **data,
 171         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 172 {
 173         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 174 }
 175
 176 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 177 {
 178         struct dev_context *devc;
 179         struct sr_serial_dev_inst *serial;
 180
 181         devc = sdi->priv;
 182         sr_sw_limits_acquisition_start(&devc->limits);
 183         std_session_send_df_header(sdi);
 184
 185         serial = sdi->conn;
 186         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 187                 rdtech_um_receive_data, (void *)sdi);
 188
 189         return rdtech_um_poll(sdi, TRUE);
 190 }
 191
 192 static struct sr_dev_driver rdtech_um_driver_info = {
 193         .name = "rdtech-um",
 194         .longname = "RDTech UMxx USB power meter",
 195         .api_version = 1,
 196         .init = std_init,
 197         .cleanup = std_cleanup,
 198         .scan = scan,
 199         .dev_list = std_dev_list,
 200         .dev_clear = dev_clear,
 201         .config_get = config_get,
 202         .config_set = config_set,
 203         .config_list = config_list,
 204         .dev_open = std_serial_dev_open,
 205         .dev_close = std_serial_dev_close,
 206         .dev_acquisition_start = dev_acquisition_start,
 207         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 208         .context = NULL,
 209 };
 210 SR_REGISTER_DEV_DRIVER(rdtech_um_driver_info);