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