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 | SR_CONF_SET,
  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 SR_PRIV struct sr_dev_driver center_309_driver_info;
  44 SR_PRIV 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 int dev_clear(int idx)
  60 {
  61         return std_dev_clear(center_devs[idx].di, NULL);
  62 }
  63
  64 static int init(struct sr_context *sr_ctx, int idx)
  65 {
  66         return std_init(sr_ctx, center_devs[idx].di, LOG_PREFIX);
  67 }
  68
  69 static GSList *center_scan(const char *conn, const char *serialcomm, int idx)
  70 {
  71         int i;
  72         struct sr_dev_inst *sdi;
  73         struct drv_context *drvc;
  74         struct dev_context *devc;
  75         struct sr_serial_dev_inst *serial;
  76         GSList *devices;
  77
  78         serial = sr_serial_dev_inst_new(conn, serialcomm);
  79
  80         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  81                 return NULL;
  82
  83         drvc = center_devs[idx].di->context;
  84         devices = NULL;
  85         serial_flush(serial);
  86
  87         sr_info("Found device on port %s.", conn);
  88
  89         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  90         sdi->status = SR_ST_INACTIVE;
  91         sdi->vendor = g_strdup(center_devs[idx].vendor);
  92         sdi->model = g_strdup(center_devs[idx].device);
  93         devc = g_malloc0(sizeof(struct dev_context));
  94         sdi->inst_type = SR_INST_SERIAL;
  95         sdi->conn = serial;
  96         sdi->priv = devc;
  97         sdi->driver = center_devs[idx].di;
  98
  99         for (i = 0; i < center_devs[idx].num_channels; i++)
 100                 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
 101
 102         drvc->instances = g_slist_append(drvc->instances, sdi);
 103         devices = g_slist_append(devices, sdi);
 104
 105         serial_close(serial);
 106
 107         return devices;
 108 }
 109
 110 static GSList *scan(GSList *options, int idx)
 111 {
 112         struct sr_config *src;
 113         GSList *l, *devices;
 114         const char *conn, *serialcomm;
 115
 116         conn = serialcomm = NULL;
 117         for (l = options; l; l = l->next) {
 118                 src = l->data;
 119                 switch (src->key) {
 120                 case SR_CONF_CONN:
 121                         conn = g_variant_get_string(src->data, NULL);
 122                         break;
 123                 case SR_CONF_SERIALCOMM:
 124                         serialcomm = g_variant_get_string(src->data, NULL);
 125                         break;
 126                 }
 127         }
 128         if (!conn)
 129                 return NULL;
 130
 131         if (serialcomm) {
 132                 /* Use the provided comm specs. */
 133                 devices = center_scan(conn, serialcomm, idx);
 134         } else {
 135                 /* Try the default. */
 136                 devices = center_scan(conn, center_devs[idx].conn, idx);
 137         }
 138
 139         return devices;
 140 }
 141
 142 static GSList *dev_list(int idx)
 143 {
 144         return ((struct drv_context *)(center_devs[idx].di->context))->instances;
 145 }
 146
 147 static int cleanup(int idx)
 148 {
 149         return dev_clear(idx);
 150 }
 151
 152 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 153                 const struct sr_channel_group *cg)
 154 {
 155         struct dev_context *devc;
 156
 157         (void)cg;
 158
 159         if (sdi->status != SR_ST_ACTIVE)
 160                 return SR_ERR_DEV_CLOSED;
 161
 162         devc = sdi->priv;
 163
 164         switch (key) {
 165         case SR_CONF_LIMIT_SAMPLES:
 166                 if (g_variant_get_uint64(data) == 0)
 167                         return SR_ERR_ARG;
 168                 devc->limit_samples = g_variant_get_uint64(data);
 169                 break;
 170         case SR_CONF_LIMIT_MSEC:
 171                 if (g_variant_get_uint64(data) == 0)
 172                         return SR_ERR_ARG;
 173                 devc->limit_msec = g_variant_get_uint64(data);
 174                 break;
 175         default:
 176                 return SR_ERR_NA;
 177         }
 178
 179         return SR_OK;
 180 }
 181
 182 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 183                 const struct sr_channel_group *cg)
 184 {
 185         (void)cg;
 186
 187         switch (key) {
 188         case SR_CONF_SCAN_OPTIONS:
 189                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 190                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 191                 break;
 192         case SR_CONF_DEVICE_OPTIONS:
 193                 if (!sdi)
 194                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 195                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 196                 else
 197                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 198                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 199                 break;
 200         default:
 201                 return SR_ERR_NA;
 202         }
 203
 204         return SR_OK;
 205 }
 206
 207 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 208                                     void *cb_data, int idx)
 209 {
 210         struct dev_context *devc;
 211         struct sr_serial_dev_inst *serial;
 212
 213         if (sdi->status != SR_ST_ACTIVE)
 214                 return SR_ERR_DEV_CLOSED;
 215
 216         devc = sdi->priv;
 217         devc->cb_data = cb_data;
 218         devc->num_samples = 0;
 219         devc->starttime = g_get_monotonic_time();
 220
 221         std_session_send_df_header(cb_data, LOG_PREFIX);
 222
 223         /* Poll every 500ms, or whenever some data comes in. */
 224         serial = sdi->conn;
 225         serial_source_add(sdi->session, serial, G_IO_IN, 500,
 226                       center_devs[idx].receive_data, (void *)sdi);
 227
 228         return SR_OK;
 229 }
 230
 231 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 232 {
 233         return std_serial_dev_acquisition_stop(sdi, cb_data,
 234                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 235 }
 236
 237 /* Driver-specific API function wrappers */
 238 #define HW_INIT(X) \
 239 static int init_##X(struct sr_dev_driver *d, \
 240         struct sr_context *sr_ctx) { (void)d; return init(sr_ctx, X); }
 241 #define HW_CLEANUP(X) \
 242 static int cleanup_##X(const struct sr_dev_driver *d) { \
 243         (void)d; return cleanup(X); }
 244 #define HW_SCAN(X) \
 245 static GSList *scan_##X(struct sr_dev_driver *d, GSList *options) { \
 246         (void)d; return scan(options, X); }
 247 #define HW_DEV_LIST(X) \
 248 static GSList *dev_list_##X(const struct sr_dev_driver *d) { \
 249         (void)d; return dev_list(X); }
 250 #define HW_DEV_CLEAR(X) \
 251 static int dev_clear_##X(const struct sr_dev_driver *d) { \
 252         (void)d; return dev_clear(X); }
 253 #define HW_DEV_ACQUISITION_START(X) \
 254 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 255 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
 256
 257 /* Driver structs and API function wrappers */
 258 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 259 HW_INIT(ID_UPPER) \
 260 HW_CLEANUP(ID_UPPER) \
 261 HW_SCAN(ID_UPPER) \
 262 HW_DEV_LIST(ID_UPPER) \
 263 HW_DEV_CLEAR(ID_UPPER) \
 264 HW_DEV_ACQUISITION_START(ID_UPPER) \
 265 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 266         .name = NAME, \
 267         .longname = LONGNAME, \
 268         .api_version = 1, \
 269         .init = init_##ID_UPPER, \
 270         .cleanup = cleanup_##ID_UPPER, \
 271         .scan = scan_##ID_UPPER, \
 272         .dev_list = dev_list_##ID_UPPER, \
 273         .dev_clear = dev_clear_##ID_UPPER, \
 274         .config_get = NULL, \
 275         .config_set = config_set, \
 276         .config_list = config_list, \
 277         .dev_open = std_serial_dev_open, \
 278         .dev_close = std_serial_dev_close, \
 279         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
 280         .dev_acquisition_stop = dev_acquisition_stop, \
 281         .context = NULL, \
 282 };
 283
 284 DRV(center_309, CENTER_309, "center-309", "Center 309")
 285 DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")