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
  21 #include <config.h>
  22 #include <glib.h>
  23 #include <sys/types.h>
  24 #include <sys/stat.h>
  25 #include <fcntl.h>
  26 #include <string.h>
  27
  28 #include <libsigrok/libsigrok.h>
  29 #include "libsigrok-internal.h"
  30
  31 #include "protocol.h"
  32
  33 #define RDTECH_UM_SERIALCOMM "115200/8n1"
  34
  35 static const uint32_t scanopts[] = {
  36         SR_CONF_CONN,
  37         SR_CONF_SERIALCOMM,
  38 };
  39
  40 static const uint32_t drvopts[] = {
  41         SR_CONF_ENERGYMETER,
  42 };
  43
  44 static const uint32_t devopts[] = {
  45         SR_CONF_CONTINUOUS,
  46         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  47         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  48 };
  49
  50 static GSList *rdtech_um_scan(struct sr_dev_driver *di,
  51         const char *conn, const char *serialcomm)
  52 {
  53         struct sr_serial_dev_inst *serial;
  54         const struct rdtech_um_profile *p = NULL;
  55         GSList *devices = NULL;
  56         struct dev_context *devc = NULL;
  57         struct sr_dev_inst *sdi = NULL;
  58         size_t ch_idx;
  59         const char *name;
  60
  61         serial = sr_serial_dev_inst_new(conn, serialcomm);
  62         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  63                 goto err_out;
  64
  65         p = rdtech_um_probe(serial);
  66         if (!p) {
  67                 sr_err("Failed to find a supported RDTech UM device.");
  68                 goto err_out_serial;
  69         }
  70
  71         devc = g_malloc0(sizeof(struct dev_context));
  72         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  73
  74         sr_sw_limits_init(&devc->limits);
  75         devc->profile = p;
  76
  77         sdi->status = SR_ST_INACTIVE;
  78         sdi->vendor = g_strdup("RDTech");
  79         sdi->model = g_strdup(p->model_name);
  80         sdi->version = NULL;
  81         sdi->inst_type = SR_INST_SERIAL;
  82         sdi->conn = serial;
  83         sdi->priv = devc;
  84
  85         for (ch_idx = 0; (name = p->channels[ch_idx].name); ch_idx++)
  86                 sr_channel_new(sdi, ch_idx, SR_CHANNEL_ANALOG, TRUE, name);
  87
  88         devices = g_slist_append(devices, sdi);
  89         serial_close(serial);
  90         if (!devices)
  91                 sr_serial_dev_inst_free(serial);
  92
  93         return std_scan_complete(di, devices);
  94
  95 err_out_serial:
  96         serial_close(serial);
  97 err_out:
  98         sr_serial_dev_inst_free(serial);
  99
 100         return NULL;
 101 }
 102
 103 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 104 {
 105         struct sr_config *src;
 106         const char *conn = NULL;
 107         const char *serialcomm = RDTECH_UM_SERIALCOMM;
 108
 109         for (GSList *l = options; l; l = l->next) {
 110                 src = l->data;
 111                 switch (src->key) {
 112                 case SR_CONF_CONN:
 113                         conn = g_variant_get_string(src->data, NULL);
 114                         break;
 115                 case SR_CONF_SERIALCOMM:
 116                         serialcomm = g_variant_get_string(src->data, NULL);
 117                         break;
 118                 }
 119         }
 120         if (!conn)
 121                 return NULL;
 122
 123         return rdtech_um_scan(di, conn, serialcomm);
 124 }
 125
 126 static int config_set(uint32_t key, GVariant *data,
 127         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 128 {
 129         struct dev_context *devc;
 130
 131         (void)cg;
 132
 133         devc = sdi->priv;
 134
 135         return sr_sw_limits_config_set(&devc->limits, key, data);
 136 }
 137
 138 static int config_list(uint32_t key, GVariant **data,
 139         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 140 {
 141         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 142 }
 143
 144 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 145 {
 146         struct dev_context *devc = sdi->priv;
 147         struct sr_serial_dev_inst *serial = sdi->conn;
 148
 149         sr_sw_limits_acquisition_start(&devc->limits);
 150         std_session_send_df_header(sdi);
 151
 152         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 153                 rdtech_um_receive_data, (void *)sdi);
 154
 155         return rdtech_um_poll(sdi);
 156 }
 157
 158 static struct sr_dev_driver rdtech_um_driver_info = {
 159         .name = "rdtech-um",
 160         .longname = "RDTech UMxx USB power meter",
 161         .api_version = 1,
 162         .init = std_init,
 163         .cleanup = std_cleanup,
 164         .scan = scan,
 165         .dev_list = std_dev_list,
 166         .dev_clear = std_dev_clear,
 167         .config_get = NULL,
 168         .config_set = config_set,
 169         .config_list = config_list,
 170         .dev_open = std_serial_dev_open,
 171         .dev_close = std_serial_dev_close,
 172         .dev_acquisition_start = dev_acquisition_start,
 173         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 174         .context = NULL,
 175 };
 176 SR_REGISTER_DEV_DRIVER(rdtech_um_driver_info);