src/hardware/center-3xx/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 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 "protocol.h"
  23
  24 static const uint32_t scanopts[] = {
  25         SR_CONF_CONN,
  26         SR_CONF_SERIALCOMM,
  27 };
  28
  29 static const uint32_t drvopts[] = {
  30         SR_CONF_THERMOMETER,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  36         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  37 };
  38
  39 static const char *channel_names[] = {
  40         "T1", "T2", "T3", "T4",
  41 };
  42
  43 static struct sr_dev_driver center_309_driver_info;
  44 static struct sr_dev_driver voltcraft_k204_driver_info;
  45
  46 SR_PRIV const struct center_dev_info center_devs[] = {
  47         {
  48                 "Center", "309", "9600/8n1", 4, 32000, 45,
  49                 center_3xx_packet_valid,
  50                 &center_309_driver_info, receive_data_CENTER_309,
  51         },
  52         {
  53                 "Voltcraft", "K204", "9600/8n1", 4, 32000, 45,
  54                 center_3xx_packet_valid,
  55                 &voltcraft_k204_driver_info, receive_data_VOLTCRAFT_K204,
  56         },
  57 };
  58
  59 static GSList *center_scan(const char *conn, const char *serialcomm, int idx)
  60 {
  61         int i;
  62         struct sr_dev_inst *sdi;
  63         struct dev_context *devc;
  64         struct sr_serial_dev_inst *serial;
  65
  66         serial = sr_serial_dev_inst_new(conn, serialcomm);
  67
  68         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  69                 return NULL;
  70
  71         serial_flush(serial);
  72
  73         sr_info("Found device on port %s.", conn);
  74
  75         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  76         sdi->status = SR_ST_INACTIVE;
  77         sdi->vendor = g_strdup(center_devs[idx].vendor);
  78         sdi->model = g_strdup(center_devs[idx].device);
  79         devc = g_malloc0(sizeof(struct dev_context));
  80         sdi->inst_type = SR_INST_SERIAL;
  81         sdi->conn = serial;
  82         sdi->priv = devc;
  83
  84         for (i = 0; i < center_devs[idx].num_channels; i++)
  85                 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
  86
  87         serial_close(serial);
  88
  89         return g_slist_append(NULL, sdi);
  90 }
  91
  92 static GSList *scan(GSList *options, int idx)
  93 {
  94         struct sr_config *src;
  95         GSList *l, *devices;
  96         const char *conn, *serialcomm;
  97
  98         conn = serialcomm = NULL;
  99         for (l = options; l; l = l->next) {
 100                 src = l->data;
 101                 switch (src->key) {
 102                 case SR_CONF_CONN:
 103                         conn = g_variant_get_string(src->data, NULL);
 104                         break;
 105                 case SR_CONF_SERIALCOMM:
 106                         serialcomm = g_variant_get_string(src->data, NULL);
 107                         break;
 108                 }
 109         }
 110         if (!conn)
 111                 return NULL;
 112
 113         if (serialcomm) {
 114                 /* Use the provided comm specs. */
 115                 devices = center_scan(conn, serialcomm, idx);
 116         } else {
 117                 /* Try the default. */
 118                 devices = center_scan(conn, center_devs[idx].conn, idx);
 119         }
 120
 121         return std_scan_complete(center_devs[idx].di, devices);
 122 }
 123
 124 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 125                 const struct sr_channel_group *cg)
 126 {
 127         struct dev_context *devc;
 128
 129         (void)cg;
 130
 131         if (sdi->status != SR_ST_ACTIVE)
 132                 return SR_ERR_DEV_CLOSED;
 133
 134         devc = sdi->priv;
 135
 136         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 137 }
 138
 139 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 140                 const struct sr_channel_group *cg)
 141 {
 142         (void)cg;
 143
 144         switch (key) {
 145         case SR_CONF_SCAN_OPTIONS:
 146                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 147                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 148                 break;
 149         case SR_CONF_DEVICE_OPTIONS:
 150                 if (!sdi)
 151                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 152                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 153                 else
 154                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 155                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 156                 break;
 157         default:
 158                 return SR_ERR_NA;
 159         }
 160
 161         return SR_OK;
 162 }
 163
 164 static int dev_acquisition_start(const struct sr_dev_inst *sdi, int idx)
 165 {
 166         struct dev_context *devc;
 167         struct sr_serial_dev_inst *serial;
 168
 169         if (sdi->status != SR_ST_ACTIVE)
 170                 return SR_ERR_DEV_CLOSED;
 171
 172         devc = sdi->priv;
 173
 174         sr_sw_limits_acquisition_start(&devc->sw_limits);
 175
 176         std_session_send_df_header(sdi);
 177
 178         /* Poll every 500ms, or whenever some data comes in. */
 179         serial = sdi->conn;
 180         serial_source_add(sdi->session, serial, G_IO_IN, 500,
 181                       center_devs[idx].receive_data, (void *)sdi);
 182
 183         return SR_OK;
 184 }
 185
 186 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 187 {
 188         return std_serial_dev_acquisition_stop(sdi,
 189                         std_serial_dev_close);
 190 }
 191
 192 /* Driver-specific API function wrappers */
 193 #define HW_SCAN(X) \
 194 static GSList *scan_##X(struct sr_dev_driver *d, GSList *options) { \
 195         (void)d; return scan(options, X); }
 196 #define HW_DEV_ACQUISITION_START(X) \
 197 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
 198 ) { return dev_acquisition_start(sdi, X); }
 199
 200 /* Driver structs and API function wrappers */
 201 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 202 HW_SCAN(ID_UPPER) \
 203 HW_DEV_ACQUISITION_START(ID_UPPER) \
 204 static struct sr_dev_driver ID##_driver_info = { \
 205         .name = NAME, \
 206         .longname = LONGNAME, \
 207         .api_version = 1, \
 208         .init = std_init, \
 209         .cleanup = std_cleanup, \
 210         .scan = scan_##ID_UPPER, \
 211         .dev_list = std_dev_list, \
 212         .config_get = NULL, \
 213         .config_set = config_set, \
 214         .config_list = config_list, \
 215         .dev_open = std_serial_dev_open, \
 216         .dev_close = std_serial_dev_close, \
 217         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
 218         .dev_acquisition_stop = dev_acquisition_stop, \
 219         .context = NULL, \
 220 }; \
 221 SR_REGISTER_DEV_DRIVER(ID##_driver_info);
 222
 223 DRV(center_309, CENTER_309, "center-309", "Center 309")
 224 DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")