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 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_GET | SR_CONF_SET,
  35         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  36         SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  37 };
  38
  39 static const char *data_sources[] = {
  40         "Live",
  41         "Memory",
  42 };
  43
  44 SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
  45 static struct sr_dev_driver *di = &appa_55ii_driver_info;
  46
  47 static int init(struct sr_context *sr_ctx)
  48 {
  49         return std_init(sr_ctx, di, LOG_PREFIX);
  50 }
  51
  52 static GSList *scan(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_channel *ch;
  59         struct sr_config *src;
  60         GSList *devices, *l;
  61         const char *conn, *serialcomm;
  62         uint8_t buf[50];
  63         size_t len;
  64
  65         len = sizeof(buf);
  66         devices = NULL;
  67         conn = serialcomm = NULL;
  68         for (l = options; l; l = l->next) {
  69                 src = l->data;
  70                 switch (src->key) {
  71                 case SR_CONF_CONN:
  72                         conn = g_variant_get_string(src->data, NULL);
  73                         break;
  74                 case SR_CONF_SERIALCOMM:
  75                         serialcomm = g_variant_get_string(src->data, NULL);
  76                         break;
  77                 }
  78         }
  79         if (!conn)
  80                 return NULL;
  81         if (!serialcomm)
  82                 serialcomm = "9600/8n1";
  83
  84         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
  85                 return NULL;
  86         if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
  87                 return NULL;
  88
  89         sr_info("Probing serial port %s.", conn);
  90
  91         drvc = di->priv;
  92         drvc->instances = NULL;
  93         serial_flush(serial);
  94
  95         /* Let's get a bit of data and see if we can find a packet. */
  96         if (serial_stream_detect(serial, buf, &len, 25,
  97                         appa_55ii_packet_valid, 500, 9600) != SR_OK)
  98                 goto scan_cleanup;
  99
 100         sr_info("Found device on port %s.", conn);
 101
 102         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 103         sdi->status = SR_ST_INACTIVE;
 104         sdi->vendor = g_strdup("APPA");
 105         sdi->model = g_strdup("55II");
 106
 107         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 108                 sr_err("Device context malloc failed.");
 109                 goto scan_cleanup;
 110         }
 111
 112         devc->data_source = DEFAULT_DATA_SOURCE;
 113
 114         sdi->inst_type = SR_INST_SERIAL;
 115         sdi->conn = serial;
 116         sdi->priv = devc;
 117         sdi->driver = di;
 118
 119         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T1")))
 120                 goto scan_cleanup;
 121         sdi->channels = g_slist_append(sdi->channels, ch);
 122         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "T2")))
 123                 goto scan_cleanup;
 124         sdi->channels = g_slist_append(sdi->channels, ch);
 125
 126         drvc->instances = g_slist_append(drvc->instances, sdi);
 127         devices = g_slist_append(devices, sdi);
 128
 129 scan_cleanup:
 130         serial_close(serial);
 131
 132         return devices;
 133 }
 134
 135 static GSList *dev_list(void)
 136 {
 137         return ((struct drv_context *)(di->priv))->instances;
 138 }
 139
 140 static int cleanup(void)
 141 {
 142         return std_dev_clear(di, NULL);
 143 }
 144
 145 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 146                 const struct sr_channel_group *cg)
 147 {
 148         struct dev_context *devc = sdi->priv;
 149
 150         (void)cg;
 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(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 170                 const struct sr_channel_group *cg)
 171 {
 172         struct dev_context *devc;
 173         const char *tmp_str;
 174         unsigned int i;
 175
 176         (void)cg;
 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(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 214                 const struct sr_channel_group *cg)
 215 {
 216         (void)sdi;
 217         (void)cg;
 218
 219         switch (key) {
 220         case SR_CONF_SCAN_OPTIONS:
 221                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 222                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 223                 break;
 224         case SR_CONF_DEVICE_OPTIONS:
 225                 if (!sdi)
 226                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 227                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 228                 else
 229                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 230                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 231                 break;
 232         case SR_CONF_DATA_SOURCE:
 233                 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
 234                 break;
 235         default:
 236                 return SR_ERR_NA;
 237         }
 238
 239         return SR_OK;
 240 }
 241
 242 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 243                 void *cb_data)
 244 {
 245         struct sr_serial_dev_inst *serial;
 246         struct dev_context *devc;
 247
 248         serial = sdi->conn;
 249         if (sdi->status != SR_ST_ACTIVE)
 250                 return SR_ERR_DEV_CLOSED;
 251
 252         if (!(devc = sdi->priv)) {
 253                 sr_err("sdi->priv was NULL.");
 254                 return SR_ERR_BUG;
 255         }
 256
 257         devc->session_cb_data = cb_data;
 258
 259         /*
 260          * Reset the number of samples to take. If we've already collected our
 261          * quota, but we start a new session, and don't reset this, we'll just
 262          * quit without acquiring any new samples.
 263          */
 264         devc->num_samples = 0;
 265         devc->start_time = g_get_monotonic_time();
 266
 267         /* Send header packet to the session bus. */
 268         std_session_send_df_header(cb_data, LOG_PREFIX);
 269
 270         /* Poll every 50ms, or whenever some data comes in. */
 271         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 272                         appa_55ii_receive_data, (void *)sdi);
 273
 274         return SR_OK;
 275 }
 276
 277 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 278 {
 279         return std_serial_dev_acquisition_stop(sdi, cb_data,
 280                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 281 }
 282
 283 SR_PRIV struct sr_dev_driver appa_55ii_driver_info = {
 284         .name = "appa-55ii",
 285         .longname = "APPA 55II",
 286         .api_version = 1,
 287         .init = init,
 288         .cleanup = cleanup,
 289         .scan = scan,
 290         .dev_list = dev_list,
 291         .dev_clear = NULL,
 292         .config_get = config_get,
 293         .config_set = config_set,
 294         .config_list = config_list,
 295         .dev_open = std_serial_dev_open,
 296         .dev_close = std_serial_dev_close,
 297         .dev_acquisition_start = dev_acquisition_start,
 298         .dev_acquisition_stop = dev_acquisition_stop,
 299         .priv = NULL,
 300 };