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