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