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