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         serial = sr_serial_dev_inst_new(conn, serialcomm);
  80
  81         if (serial_open(serial, SERIAL_RDWR) != 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         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  91         sdi->status = SR_ST_INACTIVE;
  92         sdi->vendor = g_strdup(center_devs[idx].vendor);
  93         sdi->model = g_strdup(center_devs[idx].device);
  94         devc = g_malloc0(sizeof(struct dev_context));
  95         sdi->inst_type = SR_INST_SERIAL;
  96         sdi->conn = serial;
  97         sdi->priv = devc;
  98         sdi->driver = center_devs[idx].di;
  99
 100         for (i = 0; i <  center_devs[idx].num_channels; i++) {
 101                 ch = sr_channel_new(i, SR_CHANNEL_ANALOG,
 102                                     TRUE, channel_names[i]);
 103                 sdi->channels = g_slist_append(sdi->channels, ch);
 104         }
 105
 106         drvc->instances = g_slist_append(drvc->instances, sdi);
 107         devices = g_slist_append(devices, sdi);
 108
 109         serial_close(serial);
 110
 111         return devices;
 112 }
 113
 114 static GSList *scan(GSList *options, int idx)
 115 {
 116         struct sr_config *src;
 117         GSList *l, *devices;
 118         const char *conn, *serialcomm;
 119
 120         conn = serialcomm = NULL;
 121         for (l = options; l; l = l->next) {
 122                 src = l->data;
 123                 switch (src->key) {
 124                 case SR_CONF_CONN:
 125                         conn = g_variant_get_string(src->data, NULL);
 126                         break;
 127                 case SR_CONF_SERIALCOMM:
 128                         serialcomm = g_variant_get_string(src->data, NULL);
 129                         break;
 130                 }
 131         }
 132         if (!conn)
 133                 return NULL;
 134
 135         if (serialcomm) {
 136                 /* Use the provided comm specs. */
 137                 devices = center_scan(conn, serialcomm, idx);
 138         } else {
 139                 /* Try the default. */
 140                 devices = center_scan(conn, center_devs[idx].conn, idx);
 141         }
 142
 143         return devices;
 144 }
 145
 146 static GSList *dev_list(int idx)
 147 {
 148         return ((struct drv_context *)(center_devs[idx].di->priv))->instances;
 149 }
 150
 151 static int cleanup(int idx)
 152 {
 153         return dev_clear(idx);
 154 }
 155
 156 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 157                 const struct sr_channel_group *cg)
 158 {
 159         struct dev_context *devc;
 160
 161         (void)cg;
 162
 163         if (sdi->status != SR_ST_ACTIVE)
 164                 return SR_ERR_DEV_CLOSED;
 165
 166         devc = sdi->priv;
 167
 168         switch (key) {
 169         case SR_CONF_LIMIT_SAMPLES:
 170                 if (g_variant_get_uint64(data) == 0)
 171                         return SR_ERR_ARG;
 172                 devc->limit_samples = g_variant_get_uint64(data);
 173                 break;
 174         case SR_CONF_LIMIT_MSEC:
 175                 if (g_variant_get_uint64(data) == 0)
 176                         return SR_ERR_ARG;
 177                 devc->limit_msec = g_variant_get_uint64(data);
 178                 break;
 179         default:
 180                 return SR_ERR_NA;
 181         }
 182
 183         return SR_OK;
 184 }
 185
 186 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 187                 const struct sr_channel_group *cg)
 188 {
 189         (void)cg;
 190
 191         switch (key) {
 192         case SR_CONF_SCAN_OPTIONS:
 193                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 194                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 195                 break;
 196         case SR_CONF_DEVICE_OPTIONS:
 197                 if (!sdi)
 198                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 199                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 200                 else
 201                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 202                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 203                 break;
 204         default:
 205                 return SR_ERR_NA;
 206         }
 207
 208         return SR_OK;
 209 }
 210
 211 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 212                                     void *cb_data, int idx)
 213 {
 214         struct dev_context *devc;
 215         struct sr_serial_dev_inst *serial;
 216
 217         if (sdi->status != SR_ST_ACTIVE)
 218                 return SR_ERR_DEV_CLOSED;
 219
 220         devc = sdi->priv;
 221         devc->cb_data = cb_data;
 222         devc->num_samples = 0;
 223         devc->starttime = g_get_monotonic_time();
 224
 225         /* Send header packet to the session bus. */
 226         std_session_send_df_header(cb_data, LOG_PREFIX);
 227
 228         /* Poll every 500ms, or whenever some data comes in. */
 229         serial = sdi->conn;
 230         serial_source_add(sdi->session, serial, G_IO_IN, 500,
 231                       center_devs[idx].receive_data, (void *)sdi);
 232
 233         return SR_OK;
 234 }
 235
 236 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 237 {
 238         return std_serial_dev_acquisition_stop(sdi, cb_data,
 239                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 240 }
 241
 242 /* Driver-specific API function wrappers */
 243 #define HW_INIT(X) \
 244 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
 245 #define HW_CLEANUP(X) \
 246 static int cleanup_##X(void) { return cleanup(X); }
 247 #define HW_SCAN(X) \
 248 static GSList *scan_##X(GSList *options) { return scan(options, X); }
 249 #define HW_DEV_LIST(X) \
 250 static GSList *dev_list_##X(void) { return dev_list(X); }
 251 #define HW_DEV_CLEAR(X) \
 252 static int dev_clear_##X(void) { 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         .priv = NULL, \
 282 };
 283
 284 DRV(center_309, CENTER_309, "center-309", "Center 309")
 285 DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")