hardware/tondaj-sl-814/api.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2012 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 <fcntl.h>
  22 #include <glib.h>
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25 #include "protocol.h"
  26
  27 #define SERIALCOMM "9600/8e1"
  28
  29 static const int hwopts[] = {
  30         SR_CONF_CONN,
  31         SR_CONF_SERIALCOMM,
  32         0,
  33 };
  34
  35 static const int hwcaps[] = {
  36         SR_CONF_SOUNDLEVELMETER,
  37         SR_CONF_LIMIT_SAMPLES,
  38         SR_CONF_CONTINUOUS,
  39         0,
  40 };
  41
  42 SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
  43 static struct sr_dev_driver *di = &tondaj_sl_814_driver_info;
  44
  45 /* Properly close and free all devices. */
  46 static int clear_instances(void)
  47 {
  48         struct sr_dev_inst *sdi;
  49         struct drv_context *drvc;
  50         struct dev_context *devc;
  51         GSList *l;
  52
  53         if (!(drvc = di->priv))
  54                 return SR_OK;
  55
  56         for (l = drvc->instances; l; l = l->next) {
  57                 if (!(sdi = l->data))
  58                         continue;
  59                 if (!(devc = sdi->priv))
  60                         continue;
  61                 sr_serial_dev_inst_free(devc->serial);
  62                 sr_dev_inst_free(sdi);
  63         }
  64
  65         g_slist_free(drvc->instances);
  66         drvc->instances = NULL;
  67
  68         return SR_OK;
  69 }
  70
  71 static int hw_init(struct sr_context *sr_ctx)
  72 {
  73         struct drv_context *drvc;
  74
  75         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
  76                 sr_err("Driver context malloc failed.");
  77                 return SR_ERR_MALLOC;
  78         }
  79
  80         drvc->sr_ctx = sr_ctx;
  81         di->priv = drvc;
  82
  83         return SR_OK;
  84 }
  85
  86 static GSList *hw_scan(GSList *options)
  87 {
  88         struct drv_context *drvc;
  89         struct dev_context *devc;
  90         struct sr_dev_inst *sdi;
  91         struct sr_config *src;
  92         struct sr_probe *probe;
  93         GSList *devices, *l;
  94         const char *conn, *serialcomm;
  95
  96         devices = NULL;
  97         drvc = di->priv;
  98         drvc->instances = NULL;
  99
 100         conn = serialcomm = NULL;
 101         for (l = options; l; l = l->next) {
 102                 if (!(src = l->data)) {
 103                         sr_err("Invalid option data, skipping.");
 104                         continue;
 105                 }
 106                 switch (src->key) {
 107                 case SR_CONF_CONN:
 108                         conn = src->value;
 109                         break;
 110                 case SR_CONF_SERIALCOMM:
 111                         serialcomm = src->value;
 112                         break;
 113                 default:
 114                         sr_err("Unknown option %d, skipping.", src->key);
 115                         break;
 116                 }
 117         }
 118         if (!conn)
 119                 return NULL;
 120         if (!serialcomm)
 121                 serialcomm = SERIALCOMM;
 122
 123         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Tondaj",
 124                                     "SL-814", NULL))) {
 125                 sr_err("Failed to create device instance.");
 126                 return NULL;
 127         }
 128
 129         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 130                 sr_err("Device context malloc failed.");
 131                 return NULL;
 132         }
 133
 134         if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm)))
 135                 return NULL;
 136
 137         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 138                 return NULL;
 139
 140         sdi->priv = devc;
 141         sdi->driver = di;
 142         probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1");
 143         if (!probe) {
 144                 sr_err("Failed to create probe.");
 145                 return NULL;
 146         }
 147         sdi->probes = g_slist_append(sdi->probes, probe);
 148         drvc->instances = g_slist_append(drvc->instances, sdi);
 149         devices = g_slist_append(devices, sdi);
 150
 151         return devices;
 152 }
 153
 154 static GSList *hw_dev_list(void)
 155 {
 156         struct drv_context *drvc;
 157
 158         drvc = di->priv;
 159
 160         return drvc->instances;
 161 }
 162
 163 static int hw_dev_open(struct sr_dev_inst *sdi)
 164 {
 165         struct dev_context *devc;
 166
 167         devc = sdi->priv;
 168
 169         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 170                 return SR_ERR;
 171
 172         sdi->status = SR_ST_ACTIVE;
 173
 174         return SR_OK;
 175 }
 176
 177 static int hw_dev_close(struct sr_dev_inst *sdi)
 178 {
 179         struct dev_context *devc;
 180
 181         devc = sdi->priv;
 182
 183         if (devc->serial && devc->serial->fd != -1) {
 184                 serial_close(devc->serial);
 185                 sdi->status = SR_ST_INACTIVE;
 186         }
 187
 188         return SR_OK;
 189 }
 190
 191 static int hw_cleanup(void)
 192 {
 193         clear_instances();
 194
 195         return SR_OK;
 196 }
 197
 198 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
 199 {
 200         (void)sdi;
 201
 202         switch (id) {
 203         case SR_DI_HWOPTS:
 204                 *data = hwopts;
 205                 break;
 206         default:
 207                 return SR_ERR_ARG;
 208         }
 209
 210         return SR_OK;
 211 }
 212
 213 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 214 {
 215         struct dev_context *devc;
 216
 217         if (sdi->status != SR_ST_ACTIVE) {
 218                 sr_err("Device inactive, can't set config options.");
 219                 return SR_ERR;
 220         }
 221
 222         devc = sdi->priv;
 223
 224         switch (id) {
 225         case SR_CONF_LIMIT_SAMPLES:
 226                 devc->limit_samples = *(const uint64_t *)value;
 227                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 228                        devc->limit_samples);
 229                 break;
 230         default:
 231                 sr_err("Unknown hardware capability: %d.", id);
 232                 return SR_ERR_ARG;
 233         }
 234
 235         return SR_OK;
 236 }
 237
 238 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 239 {
 240
 241         (void)sdi;
 242
 243         switch (key) {
 244         case SR_CONF_DEVICE_OPTIONS:
 245                 *data = hwcaps;
 246                 break;
 247         default:
 248                 return SR_ERR_ARG;
 249         }
 250
 251         return SR_OK;
 252 }
 253
 254 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 255                                     void *cb_data)
 256 {
 257         struct sr_datafeed_packet packet;
 258         struct sr_datafeed_header header;
 259         struct dev_context *devc;
 260
 261         devc = sdi->priv;
 262         devc->cb_data = cb_data;
 263
 264         /* Send header packet to the session bus. */
 265         sr_dbg("Sending SR_DF_HEADER.");
 266         packet.type = SR_DF_HEADER;
 267         packet.payload = (uint8_t *)&header;
 268         header.feed_version = 1;
 269         gettimeofday(&header.starttime, NULL);
 270         sr_session_send(devc->cb_data, &packet);
 271
 272         /* Poll every 500ms, or whenever some data comes in. */
 273         sr_source_add(devc->serial->fd, G_IO_IN, 500,
 274                       tondaj_sl_814_receive_data, (void *)sdi);
 275
 276         return SR_OK;
 277 }
 278
 279 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 280 {
 281         int ret, final_ret;
 282         struct sr_datafeed_packet packet;
 283         struct dev_context *devc;
 284
 285         final_ret = SR_OK;
 286
 287         if (sdi->status != SR_ST_ACTIVE) {
 288                 sr_err("Device inactive, can't stop acquisition.");
 289                 return SR_ERR;
 290         }
 291
 292         devc = sdi->priv;
 293
 294         if ((ret = sr_source_remove(devc->serial->fd)) < 0) {
 295                 sr_err("Error removing source: %d.", ret);
 296                 final_ret = SR_ERR;
 297         }
 298
 299         if ((ret = hw_dev_close(sdi)) < 0) {
 300                 sr_err("Error closing device: %d.", ret);
 301                 final_ret = SR_ERR;
 302         }
 303
 304         /* Send end packet to the session bus. */
 305         sr_dbg("Sending SR_DF_END.");
 306         packet.type = SR_DF_END;
 307         sr_session_send(cb_data, &packet);
 308
 309         return final_ret;
 310 }
 311
 312 SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info = {
 313         .name = "tondaj-sl-814",
 314         .longname = "Tondaj SL-814",
 315         .api_version = 1,
 316         .init = hw_init,
 317         .cleanup = hw_cleanup,
 318         .scan = hw_scan,
 319         .dev_list = hw_dev_list,
 320         .dev_clear = clear_instances,
 321         .config_get = config_get,
 322         .config_set = config_set,
 323         .config_list = config_list,
 324         .dev_open = hw_dev_open,
 325         .dev_close = hw_dev_close,
 326         .dev_acquisition_start = hw_dev_acquisition_start,
 327         .dev_acquisition_stop = hw_dev_acquisition_stop,
 328         .priv = NULL,
 329 };