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         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
  74 }
  75
  76 static GSList *hw_scan(GSList *options)
  77 {
  78         struct drv_context *drvc;
  79         struct dev_context *devc;
  80         struct sr_dev_inst *sdi;
  81         struct sr_config *src;
  82         struct sr_probe *probe;
  83         GSList *devices, *l;
  84         const char *conn, *serialcomm;
  85
  86         drvc = di->priv;
  87         drvc->instances = NULL;
  88
  89         devices = NULL;
  90
  91         conn = serialcomm = NULL;
  92         for (l = options; l; l = l->next) {
  93                 if (!(src = l->data)) {
  94                         sr_err("Invalid option data, skipping.");
  95                         continue;
  96                 }
  97                 switch (src->key) {
  98                 case SR_CONF_CONN:
  99                         conn = src->value;
 100                         break;
 101                 case SR_CONF_SERIALCOMM:
 102                         serialcomm = src->value;
 103                         break;
 104                 default:
 105                         sr_err("Unknown option %d, skipping.", src->key);
 106                         break;
 107                 }
 108         }
 109         if (!conn)
 110                 return NULL;
 111         if (!serialcomm)
 112                 serialcomm = SERIALCOMM;
 113
 114         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Tondaj",
 115                                     "SL-814", NULL))) {
 116                 sr_err("Failed to create device instance.");
 117                 return NULL;
 118         }
 119
 120         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 121                 sr_err("Device context malloc failed.");
 122                 return NULL;
 123         }
 124
 125         if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm)))
 126                 return NULL;
 127
 128         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 129                 return NULL;
 130
 131         sdi->priv = devc;
 132         sdi->driver = di;
 133         probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1");
 134         if (!probe) {
 135                 sr_err("Failed to create probe.");
 136                 return NULL;
 137         }
 138         sdi->probes = g_slist_append(sdi->probes, probe);
 139         drvc->instances = g_slist_append(drvc->instances, sdi);
 140         devices = g_slist_append(devices, sdi);
 141
 142         return devices;
 143 }
 144
 145 static GSList *hw_dev_list(void)
 146 {
 147         struct drv_context *drvc;
 148
 149         drvc = di->priv;
 150
 151         return drvc->instances;
 152 }
 153
 154 static int hw_dev_open(struct sr_dev_inst *sdi)
 155 {
 156         struct dev_context *devc;
 157
 158         devc = sdi->priv;
 159
 160         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 161                 return SR_ERR;
 162
 163         sdi->status = SR_ST_ACTIVE;
 164
 165         return SR_OK;
 166 }
 167
 168 static int hw_dev_close(struct sr_dev_inst *sdi)
 169 {
 170         struct dev_context *devc;
 171
 172         devc = sdi->priv;
 173
 174         if (devc->serial && devc->serial->fd != -1) {
 175                 serial_close(devc->serial);
 176                 sdi->status = SR_ST_INACTIVE;
 177         }
 178
 179         return SR_OK;
 180 }
 181
 182 static int hw_cleanup(void)
 183 {
 184         clear_instances();
 185
 186         return SR_OK;
 187 }
 188
 189 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 190 {
 191         struct dev_context *devc;
 192
 193         if (sdi->status != SR_ST_ACTIVE) {
 194                 sr_err("Device inactive, can't set config options.");
 195                 return SR_ERR;
 196         }
 197
 198         devc = sdi->priv;
 199
 200         switch (id) {
 201         case SR_CONF_LIMIT_SAMPLES:
 202                 devc->limit_samples = *(const uint64_t *)value;
 203                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 204                        devc->limit_samples);
 205                 break;
 206         default:
 207                 sr_err("Unknown hardware capability: %d.", id);
 208                 return SR_ERR_ARG;
 209         }
 210
 211         return SR_OK;
 212 }
 213
 214 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 215 {
 216
 217         (void)sdi;
 218
 219         switch (key) {
 220         case SR_CONF_SCAN_OPTIONS:
 221                 *data = hwopts;
 222                 break;
 223         case SR_CONF_DEVICE_OPTIONS:
 224                 *data = hwcaps;
 225                 break;
 226         default:
 227                 return SR_ERR_ARG;
 228         }
 229
 230         return SR_OK;
 231 }
 232
 233 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 234                                     void *cb_data)
 235 {
 236         struct sr_datafeed_packet packet;
 237         struct sr_datafeed_header header;
 238         struct dev_context *devc;
 239
 240         devc = sdi->priv;
 241         devc->cb_data = cb_data;
 242
 243         /* Send header packet to the session bus. */
 244         sr_dbg("Sending SR_DF_HEADER.");
 245         packet.type = SR_DF_HEADER;
 246         packet.payload = (uint8_t *)&header;
 247         header.feed_version = 1;
 248         gettimeofday(&header.starttime, NULL);
 249         sr_session_send(devc->cb_data, &packet);
 250
 251         /* Poll every 500ms, or whenever some data comes in. */
 252         sr_source_add(devc->serial->fd, G_IO_IN, 500,
 253                       tondaj_sl_814_receive_data, (void *)sdi);
 254
 255         return SR_OK;
 256 }
 257
 258 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 259 {
 260         int ret, final_ret;
 261         struct sr_datafeed_packet packet;
 262         struct dev_context *devc;
 263
 264         final_ret = SR_OK;
 265
 266         if (sdi->status != SR_ST_ACTIVE) {
 267                 sr_err("Device inactive, can't stop acquisition.");
 268                 return SR_ERR;
 269         }
 270
 271         devc = sdi->priv;
 272
 273         if ((ret = sr_source_remove(devc->serial->fd)) < 0) {
 274                 sr_err("Error removing source: %d.", ret);
 275                 final_ret = SR_ERR;
 276         }
 277
 278         if ((ret = hw_dev_close(sdi)) < 0) {
 279                 sr_err("Error closing device: %d.", ret);
 280                 final_ret = SR_ERR;
 281         }
 282
 283         /* Send end packet to the session bus. */
 284         sr_dbg("Sending SR_DF_END.");
 285         packet.type = SR_DF_END;
 286         sr_session_send(cb_data, &packet);
 287
 288         return final_ret;
 289 }
 290
 291 SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info = {
 292         .name = "tondaj-sl-814",
 293         .longname = "Tondaj SL-814",
 294         .api_version = 1,
 295         .init = hw_init,
 296         .cleanup = hw_cleanup,
 297         .scan = hw_scan,
 298         .dev_list = hw_dev_list,
 299         .dev_clear = clear_instances,
 300         .config_set = config_set,
 301         .config_list = config_list,
 302         .dev_open = hw_dev_open,
 303         .dev_close = hw_dev_close,
 304         .dev_acquisition_start = hw_dev_acquisition_start,
 305         .dev_acquisition_stop = hw_dev_acquisition_stop,
 306         .priv = NULL,
 307 };