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