src/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 uint32_t scanopts[] = {
  24         SR_CONF_CONN,
  25         SR_CONF_SERIALCOMM,
  26 };
  27
  28 static const uint32_t devopts[] = {
  29         SR_CONF_THERMOMETER,
  30         SR_CONF_CONTINUOUS,
  31         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  32         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  33         SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  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_channel *ch;
  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) != 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         sdi = sr_dev_inst_new();
 100         sdi->status = SR_ST_INACTIVE;
 101         sdi->vendor = g_strdup("APPA");
 102         sdi->model = g_strdup("55II");
 103
 104         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 105                 sr_err("Device context malloc failed.");
 106                 goto scan_cleanup;
 107         }
 108
 109         devc->data_source = DEFAULT_DATA_SOURCE;
 110
 111         sdi->inst_type = SR_INST_SERIAL;
 112         sdi->conn = serial;
 113         sdi->priv = devc;
 114         sdi->driver = di;
 115
 116         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T1")))
 117                 goto scan_cleanup;
 118         sdi->channels = g_slist_append(sdi->channels, ch);
 119         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T2")))
 120                 goto scan_cleanup;
 121         sdi->channels = g_slist_append(sdi->channels, ch);
 122
 123         drvc->instances = g_slist_append(drvc->instances, sdi);
 124         devices = g_slist_append(devices, sdi);
 125
 126 scan_cleanup:
 127         serial_close(serial);
 128
 129         return devices;
 130 }
 131
 132 static GSList *dev_list(void)
 133 {
 134         return ((struct drv_context *)(di->priv))->instances;
 135 }
 136
 137 static int cleanup(void)
 138 {
 139         return std_dev_clear(di, NULL);
 140 }
 141
 142 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 143                 const struct sr_channel_group *cg)
 144 {
 145         struct dev_context *devc = sdi->priv;
 146
 147         (void)cg;
 148
 149         switch (key) {
 150         case SR_CONF_LIMIT_SAMPLES:
 151                 *data = g_variant_new_uint64(devc->limit_samples);
 152                 break;
 153         case SR_CONF_LIMIT_MSEC:
 154                 *data = g_variant_new_uint64(devc->limit_msec);
 155                 break;
 156         case SR_CONF_DATA_SOURCE:
 157                 *data = g_variant_new_string(data_sources[devc->data_source]);
 158                 break;
 159         default:
 160                 return SR_ERR_NA;
 161         }
 162
 163         return SR_OK;
 164 }
 165
 166 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 167                 const struct sr_channel_group *cg)
 168 {
 169         struct dev_context *devc;
 170         const char *tmp_str;
 171         unsigned int i;
 172
 173         (void)cg;
 174
 175         if (sdi->status != SR_ST_ACTIVE)
 176                 return SR_ERR_DEV_CLOSED;
 177
 178         if (!(devc = sdi->priv)) {
 179                 sr_err("sdi->priv was NULL.");
 180                 return SR_ERR_BUG;
 181         }
 182
 183         switch (key) {
 184         case SR_CONF_LIMIT_SAMPLES:
 185                 devc->limit_samples = g_variant_get_uint64(data);
 186                 sr_dbg("Setting sample limit to %" PRIu64 ".", devc->limit_samples);
 187                 break;
 188         case SR_CONF_LIMIT_MSEC:
 189                 devc->limit_msec = g_variant_get_uint64(data);
 190                 sr_dbg("Setting time limit to %" PRIu64 "ms.", devc->limit_msec);
 191                 break;
 192         case SR_CONF_DATA_SOURCE: {
 193                 tmp_str = g_variant_get_string(data, NULL);
 194                 for (i = 0; i < ARRAY_SIZE(data_sources); i++)
 195                         if (!strcmp(tmp_str, data_sources[i])) {
 196                                 devc->data_source = i;
 197                                 break;
 198                         }
 199                 if (i == ARRAY_SIZE(data_sources))
 200                         return SR_ERR;
 201                 break;
 202         }
 203         default:
 204                 return SR_ERR_NA;
 205         }
 206
 207         return SR_OK;
 208 }
 209
 210 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 211                 const struct sr_channel_group *cg)
 212 {
 213         (void)sdi;
 214         (void)cg;
 215
 216         switch (key) {
 217         case SR_CONF_SCAN_OPTIONS:
 218                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 219                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 220                 break;
 221         case SR_CONF_DEVICE_OPTIONS:
 222                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 223                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 224                 break;
 225         case SR_CONF_DATA_SOURCE:
 226                 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
 227                 break;
 228         default:
 229                 return SR_ERR_NA;
 230         }
 231
 232         return SR_OK;
 233 }
 234
 235 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 236                 void *cb_data)
 237 {
 238         struct sr_serial_dev_inst *serial;
 239         struct dev_context *devc;
 240
 241         serial = sdi->conn;
 242         if (sdi->status != SR_ST_ACTIVE)
 243                 return SR_ERR_DEV_CLOSED;
 244
 245         if (!(devc = sdi->priv)) {
 246                 sr_err("sdi->priv was NULL.");
 247                 return SR_ERR_BUG;
 248         }
 249
 250         devc->session_cb_data = cb_data;
 251
 252         /*
 253          * Reset the number of samples to take. If we've already collected our
 254          * quota, but we start a new session, and don't reset this, we'll just
 255          * quit without acquiring any new samples.
 256          */
 257         devc->num_samples = 0;
 258         devc->start_time = g_get_monotonic_time();
 259
 260         /* Send header packet to the session bus. */
 261         std_session_send_df_header(cb_data, LOG_PREFIX);
 262
 263         /* Poll every 50ms, or whenever some data comes in. */
 264         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 265                         appa_55ii_receive_data, (void *)sdi);
 266
 267         return SR_OK;
 268 }
 269
 270 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 271 {
 272         return std_serial_dev_acquisition_stop(sdi, cb_data,
 273                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 274 }
 275
 276 SR_PRIV struct sr_dev_driver appa_55ii_driver_info = {
 277         .name = "appa-55ii",
 278         .longname = "APPA 55II",
 279         .api_version = 1,
 280         .init = init,
 281         .cleanup = cleanup,
 282         .scan = scan,
 283         .dev_list = dev_list,
 284         .dev_clear = NULL,
 285         .config_get = config_get,
 286         .config_set = config_set,
 287         .config_list = config_list,
 288         .dev_open = std_serial_dev_open,
 289         .dev_close = std_serial_dev_close,
 290         .dev_acquisition_start = dev_acquisition_start,
 291         .dev_acquisition_stop = dev_acquisition_stop,
 292         .priv = NULL,
 293 };