hardware/appa-55ii/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
   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 3 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <string.h>
  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         SR_CONF_DATA_SOURCE,
  34 };
  35
  36 static const char *data_sources[] = {
  37         "Live",
  38         "Memory",
  39 };
  40
  41 SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
  42 static struct sr_dev_driver *di = &appa_55ii_driver_info;
  43
  44 static int init(struct sr_context *sr_ctx)
  45 {
  46         return std_init(sr_ctx, di, LOG_PREFIX);
  47 }
  48
  49 static GSList *scan(GSList *options)
  50 {
  51         struct drv_context *drvc;
  52         struct dev_context *devc;
  53         struct sr_serial_dev_inst *serial;
  54         struct sr_dev_inst *sdi;
  55         struct sr_probe *probe;
  56         struct sr_config *src;
  57         GSList *devices, *l;
  58         const char *conn, *serialcomm;
  59         uint8_t buf[50];
  60         size_t len;
  61
  62         len = sizeof(buf);
  63         devices = NULL;
  64         conn = serialcomm = NULL;
  65         for (l = options; l; l = l->next) {
  66                 src = l->data;
  67                 switch (src->key) {
  68                 case SR_CONF_CONN:
  69                         conn = g_variant_get_string(src->data, NULL);
  70                         break;
  71                 case SR_CONF_SERIALCOMM:
  72                         serialcomm = g_variant_get_string(src->data, NULL);
  73                         break;
  74                 }
  75         }
  76         if (!conn)
  77                 return NULL;
  78         if (!serialcomm)
  79                 serialcomm = "9600/8n1";
  80
  81         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
  82                 return NULL;
  83         if (serial_open(serial, SERIAL_RDONLY | SERIAL_NONBLOCK) != SR_OK)
  84                 return NULL;
  85
  86         sr_info("Probing serial port %s.", conn);
  87
  88         drvc = di->priv;
  89         drvc->instances = NULL;
  90         serial_flush(serial);
  91
  92         /* Let's get a bit of data and see if we can find a packet. */
  93         if (serial_stream_detect(serial, buf, &len, 25,
  94                         appa_55ii_packet_valid, 500, 9600) != SR_OK)
  95                 goto scan_cleanup;
  96
  97         sr_info("Found device on port %s.", conn);
  98
  99         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "APPA", "55II", "")))
 100                 goto scan_cleanup;
 101
 102         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 103                 sr_err("Device context malloc failed.");
 104                 goto scan_cleanup;
 105         }
 106
 107         devc->data_source = DEFAULT_DATA_SOURCE;
 108
 109         sdi->inst_type = SR_INST_SERIAL;
 110         sdi->conn = serial;
 111         sdi->priv = devc;
 112         sdi->driver = di;
 113
 114         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "T1")))
 115                 goto scan_cleanup;
 116         sdi->probes = g_slist_append(sdi->probes, probe);
 117         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "T2")))
 118                 goto scan_cleanup;
 119         sdi->probes = g_slist_append(sdi->probes, probe);
 120
 121         drvc->instances = g_slist_append(drvc->instances, sdi);
 122         devices = g_slist_append(devices, sdi);
 123
 124 scan_cleanup:
 125         serial_close(serial);
 126
 127         return devices;
 128 }
 129
 130 static GSList *dev_list(void)
 131 {
 132         return ((struct drv_context *)(di->priv))->instances;
 133 }
 134
 135 static int dev_clear(void)
 136 {
 137         return std_dev_clear(di, NULL);
 138 }
 139
 140 static int cleanup(void)
 141 {
 142         return dev_clear();
 143 }
 144
 145 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
 146                 const struct sr_probe_group *probe_group)
 147 {
 148         struct dev_context *devc = sdi->priv;
 149
 150         (void)probe_group;
 151
 152         switch (key) {
 153         case SR_CONF_LIMIT_SAMPLES:
 154                 *data = g_variant_new_uint64(devc->limit_samples);
 155                 break;
 156         case SR_CONF_LIMIT_MSEC:
 157                 *data = g_variant_new_uint64(devc->limit_msec);
 158                 break;
 159         case SR_CONF_DATA_SOURCE:
 160                 *data = g_variant_new_string(data_sources[devc->data_source]);
 161                 break;
 162         default:
 163                 return SR_ERR_NA;
 164         }
 165
 166         return SR_OK;
 167 }
 168
 169 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 170                 const struct sr_probe_group *probe_group)
 171 {
 172         struct dev_context *devc;
 173         const char *tmp_str;
 174         unsigned int i;
 175
 176         (void)probe_group;
 177
 178         if (sdi->status != SR_ST_ACTIVE)
 179                 return SR_ERR_DEV_CLOSED;
 180
 181         if (!(devc = sdi->priv)) {
 182                 sr_err("sdi->priv was NULL.");
 183                 return SR_ERR_BUG;
 184         }
 185
 186         switch (key) {
 187         case SR_CONF_LIMIT_SAMPLES:
 188                 devc->limit_samples = g_variant_get_uint64(data);
 189                 sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
 190                 break;
 191         case SR_CONF_LIMIT_MSEC:
 192                 devc->limit_msec = g_variant_get_uint64(data);
 193                 sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
 194                 break;
 195         case SR_CONF_DATA_SOURCE: {
 196                 tmp_str = g_variant_get_string(data, NULL);
 197                 for (i = 0; i < ARRAY_SIZE(data_sources); i++)
 198                         if (!strcmp(tmp_str, data_sources[i])) {
 199                                 devc->data_source = i;
 200                                 break;
 201                         }
 202                 if (i == ARRAY_SIZE(data_sources))
 203                         return SR_ERR;
 204                 break;
 205         }
 206         default:
 207                 return SR_ERR_NA;
 208         }
 209
 210         return SR_OK;
 211 }
 212
 213 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 214                 const struct sr_probe_group *probe_group)
 215 {
 216         (void)sdi;
 217         (void)probe_group;
 218
 219         switch (key) {
 220         case SR_CONF_SCAN_OPTIONS:
 221                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 222                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 223                 break;
 224         case SR_CONF_DEVICE_OPTIONS:
 225                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 226                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 227                 break;
 228         case SR_CONF_DATA_SOURCE:
 229                 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
 230                 break;
 231         default:
 232                 return SR_ERR_NA;
 233         }
 234
 235         return SR_OK;
 236 }
 237
 238 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 239                 void *cb_data)
 240 {
 241         struct sr_serial_dev_inst *serial;
 242         struct dev_context *devc;
 243
 244         serial = sdi->conn;
 245         if (sdi->status != SR_ST_ACTIVE)
 246                 return SR_ERR_DEV_CLOSED;
 247
 248         if (!(devc = sdi->priv)) {
 249                 sr_err("sdi->priv was NULL.");
 250                 return SR_ERR_BUG;
 251         }
 252
 253         devc->session_cb_data = cb_data;
 254
 255         /*
 256          * Reset the number of samples to take. If we've already collected our
 257          * quota, but we start a new session, and don't reset this, we'll just
 258          * quit without acquiring any new samples.
 259          */
 260         devc->num_samples = 0;
 261         devc->start_time = g_get_monotonic_time();
 262
 263         /* Send header packet to the session bus. */
 264         std_session_send_df_header(cb_data, LOG_PREFIX);
 265
 266         /* Poll every 50ms, or whenever some data comes in. */
 267         serial_source_add(serial, G_IO_IN, 50, appa_55ii_receive_data, (void *)sdi);
 268
 269         return SR_OK;
 270 }
 271
 272 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 273 {
 274         return std_serial_dev_acquisition_stop(sdi, cb_data,
 275                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 276 }
 277
 278 SR_PRIV struct sr_dev_driver appa_55ii_driver_info = {
 279         .name = "appa-55ii",
 280         .longname = "APPA 55II",
 281         .api_version = 1,
 282         .init = init,
 283         .cleanup = cleanup,
 284         .scan = scan,
 285         .dev_list = dev_list,
 286         .dev_clear = dev_clear,
 287         .config_get = config_get,
 288         .config_set = config_set,
 289         .config_list = config_list,
 290         .dev_open = std_serial_dev_open,
 291         .dev_close = std_serial_dev_close,
 292         .dev_acquisition_start = dev_acquisition_start,
 293         .dev_acquisition_stop = dev_acquisition_stop,
 294         .priv = NULL,
 295 };