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 };
  41
  42 SR_PRIV struct sr_dev_driver center_309_driver_info;
  43 SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
  44
  45 SR_PRIV const struct center_dev_info center_devs[] = {
  46         {
  47                 "Center", "309", "9600/8n1", 4, 32000, 45,
  48                 center_3xx_packet_valid,
  49                 &center_309_driver_info, receive_data_CENTER_309,
  50         },
  51         {
  52                 "Voltcraft", "K204", "9600/8n1", 4, 32000, 45,
  53                 center_3xx_packet_valid,
  54                 &voltcraft_k204_driver_info, receive_data_VOLTCRAFT_K204,
  55         },
  56 };
  57
  58 static int dev_clear(int idx)
  59 {
  60         return std_dev_clear(center_devs[idx].di, NULL);
  61 }
  62
  63 static int init(struct sr_context *sr_ctx, int idx)
  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_serial_dev_inst *serial;
  75         GSList *devices;
  76
  77         serial = sr_serial_dev_inst_new(conn, serialcomm);
  78
  79         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  80                 return NULL;
  81
  82         drvc = center_devs[idx].di->context;
  83         devices = NULL;
  84         serial_flush(serial);
  85
  86         sr_info("Found device on port %s.", conn);
  87
  88         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  89         sdi->status = SR_ST_INACTIVE;
  90         sdi->vendor = g_strdup(center_devs[idx].vendor);
  91         sdi->model = g_strdup(center_devs[idx].device);
  92         devc = g_malloc0(sizeof(struct dev_context));
  93         sdi->inst_type = SR_INST_SERIAL;
  94         sdi->conn = serial;
  95         sdi->priv = devc;
  96         sdi->driver = center_devs[idx].di;
  97
  98         for (i = 0; i < center_devs[idx].num_channels; i++)
  99                 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
 100
 101         drvc->instances = g_slist_append(drvc->instances, sdi);
 102         devices = g_slist_append(devices, sdi);
 103
 104         serial_close(serial);
 105
 106         return devices;
 107 }
 108
 109 static GSList *scan(GSList *options, int idx)
 110 {
 111         struct sr_config *src;
 112         GSList *l, *devices;
 113         const char *conn, *serialcomm;
 114
 115         conn = serialcomm = NULL;
 116         for (l = options; l; l = l->next) {
 117                 src = l->data;
 118                 switch (src->key) {
 119                 case SR_CONF_CONN:
 120                         conn = g_variant_get_string(src->data, NULL);
 121                         break;
 122                 case SR_CONF_SERIALCOMM:
 123                         serialcomm = g_variant_get_string(src->data, NULL);
 124                         break;
 125                 }
 126         }
 127         if (!conn)
 128                 return NULL;
 129
 130         if (serialcomm) {
 131                 /* Use the provided comm specs. */
 132                 devices = center_scan(conn, serialcomm, idx);
 133         } else {
 134                 /* Try the default. */
 135                 devices = center_scan(conn, center_devs[idx].conn, idx);
 136         }
 137
 138         return devices;
 139 }
 140
 141 static GSList *dev_list(int idx)
 142 {
 143         return ((struct drv_context *)(center_devs[idx].di->context))->instances;
 144 }
 145
 146 static int cleanup(int idx)
 147 {
 148         return dev_clear(idx);
 149 }
 150
 151 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 152                 const struct sr_channel_group *cg)
 153 {
 154         struct dev_context *devc;
 155
 156         (void)cg;
 157
 158         if (sdi->status != SR_ST_ACTIVE)
 159                 return SR_ERR_DEV_CLOSED;
 160
 161         devc = sdi->priv;
 162
 163         switch (key) {
 164         case SR_CONF_LIMIT_SAMPLES:
 165                 if (g_variant_get_uint64(data) == 0)
 166                         return SR_ERR_ARG;
 167                 devc->limit_samples = g_variant_get_uint64(data);
 168                 break;
 169         case SR_CONF_LIMIT_MSEC:
 170                 if (g_variant_get_uint64(data) == 0)
 171                         return SR_ERR_ARG;
 172                 devc->limit_msec = g_variant_get_uint64(data);
 173                 break;
 174         default:
 175                 return SR_ERR_NA;
 176         }
 177
 178         return SR_OK;
 179 }
 180
 181 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 182                 const struct sr_channel_group *cg)
 183 {
 184         (void)cg;
 185
 186         switch (key) {
 187         case SR_CONF_SCAN_OPTIONS:
 188                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 189                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 190                 break;
 191         case SR_CONF_DEVICE_OPTIONS:
 192                 if (!sdi)
 193                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 194                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 195                 else
 196                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 197                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 198                 break;
 199         default:
 200                 return SR_ERR_NA;
 201         }
 202
 203         return SR_OK;
 204 }
 205
 206 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 207                                     void *cb_data, int idx)
 208 {
 209         struct dev_context *devc;
 210         struct sr_serial_dev_inst *serial;
 211
 212         if (sdi->status != SR_ST_ACTIVE)
 213                 return SR_ERR_DEV_CLOSED;
 214
 215         devc = sdi->priv;
 216         devc->cb_data = cb_data;
 217         devc->num_samples = 0;
 218         devc->starttime = g_get_monotonic_time();
 219
 220         /* Send header packet to the session bus. */
 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")