hardware/colead-slm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   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 <glib.h>
  21 #include "libsigrok.h"
  22 #include "libsigrok-internal.h"
  23 #include "protocol.h"
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <errno.h>
  28 #include <string.h>
  29
  30 /* The Colead SL-5868P uses this. */
  31 #define SERIALCOMM "2400/8n1"
  32
  33 static const int hwopts[] = {
  34         SR_CONF_CONN,
  35         SR_CONF_SERIALCOMM,
  36         0,
  37 };
  38
  39 static const int hwcaps[] = {
  40         SR_CONF_SOUNDLEVELMETER,
  41         SR_CONF_LIMIT_SAMPLES,
  42         SR_CONF_LIMIT_MSEC,
  43         SR_CONF_CONTINUOUS,
  44         0,
  45 };
  46
  47 SR_PRIV struct sr_dev_driver colead_slm_driver_info;
  48 static struct sr_dev_driver *di = &colead_slm_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         g_slist_free(drvc->instances);
  70         drvc->instances = NULL;
  71
  72         return SR_OK;
  73 }
  74
  75 static int hw_init(struct sr_context *sr_ctx)
  76 {
  77         struct drv_context *drvc;
  78
  79         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
  80                 sr_err("Driver context malloc failed.");
  81                 return SR_ERR_MALLOC;
  82         }
  83
  84         drvc->sr_ctx = sr_ctx;
  85         di->priv = drvc;
  86
  87         return SR_OK;
  88 }
  89
  90 static GSList *hw_scan(GSList *options)
  91 {
  92         struct drv_context *drvc;
  93         struct dev_context *devc;
  94         struct sr_dev_inst *sdi;
  95         struct sr_config *src;
  96         struct sr_probe *probe;
  97         GSList *devices, *l;
  98         const char *conn, *serialcomm;
  99
 100         drvc = di->priv;
 101         drvc->instances = NULL;
 102
 103         devices = NULL;
 104
 105         conn = serialcomm = NULL;
 106         for (l = options; l; l = l->next) {
 107                 src = l->data;
 108                 switch (src->key) {
 109                 case SR_CONF_CONN:
 110                         conn = src->value;
 111                         break;
 112                 case SR_CONF_SERIALCOMM:
 113                         serialcomm = src->value;
 114                         break;
 115                 }
 116         }
 117         if (!conn)
 118                 return NULL;
 119         if (!serialcomm)
 120                 serialcomm = SERIALCOMM;
 121
 122         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Colead",
 123                         "SL-5868P", NULL)))
 124                 return NULL;
 125
 126         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 127                 sr_dbg("Device context malloc failed.");
 128                 return NULL;
 129         }
 130
 131         if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm)))
 132                 return NULL;
 133
 134         sdi->priv = devc;
 135         sdi->driver = di;
 136         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 137                 return NULL;
 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         if (!(devc = sdi->priv)) {
 159                 sr_err("sdi->priv was NULL.");
 160                 return SR_ERR_BUG;
 161         }
 162
 163         if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
 164                 return SR_ERR;
 165
 166         sdi->status = SR_ST_ACTIVE;
 167
 168         return SR_OK;
 169 }
 170
 171 static int hw_dev_close(struct sr_dev_inst *sdi)
 172 {
 173         struct dev_context *devc;
 174
 175         if (!(devc = sdi->priv)) {
 176                 sr_err("sdi->priv was NULL.");
 177                 return SR_ERR_BUG;
 178         }
 179
 180         if (devc->serial && devc->serial->fd != -1) {
 181                 serial_close(devc->serial);
 182                 sdi->status = SR_ST_INACTIVE;
 183         }
 184
 185         return SR_OK;
 186 }
 187
 188 static int hw_cleanup(void)
 189 {
 190         clear_instances();
 191
 192         return SR_OK;
 193 }
 194
 195 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 196 {
 197         struct dev_context *devc;
 198
 199         if (sdi->status != SR_ST_ACTIVE)
 200                 return SR_ERR;
 201
 202         if (!(devc = sdi->priv)) {
 203                 sr_err("sdi->priv was NULL.");
 204                 return SR_ERR_BUG;
 205         }
 206
 207         switch (id) {
 208         case SR_CONF_LIMIT_MSEC:
 209                 /* TODO: not yet implemented */
 210                 if (*(const uint64_t *)value == 0) {
 211                         sr_err("LIMIT_MSEC can't be 0.");
 212                         return SR_ERR;
 213                 }
 214                 devc->limit_msec = *(const uint64_t *)value;
 215                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 216                        devc->limit_msec);
 217                 break;
 218         case SR_CONF_LIMIT_SAMPLES:
 219                 devc->limit_samples = *(const uint64_t *)value;
 220                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 221                        devc->limit_samples);
 222                 break;
 223         default:
 224                 sr_err("Unknown capability: %d.", id);
 225                 return SR_ERR;
 226                 break;
 227         }
 228
 229         return SR_OK;
 230 }
 231
 232 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 233 {
 234
 235         (void)sdi;
 236
 237         switch (key) {
 238         case SR_CONF_SCAN_OPTIONS:
 239                 *data = hwopts;
 240                 break;
 241         case SR_CONF_DEVICE_OPTIONS:
 242                 *data = hwcaps;
 243                 break;
 244         default:
 245                 return SR_ERR_ARG;
 246         }
 247
 248         return SR_OK;
 249 }
 250
 251 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 252                                     void *cb_data)
 253 {
 254         struct sr_datafeed_packet packet;
 255         struct sr_datafeed_header header;
 256         struct dev_context *devc;
 257
 258         if (!(devc = sdi->priv)) {
 259                 sr_err("sdi->priv was NULL.");
 260                 return SR_ERR_BUG;
 261         }
 262
 263         sr_dbg("Starting acquisition.");
 264
 265         devc->cb_data = cb_data;
 266
 267         /* Send header packet to the session bus. */
 268         sr_dbg("Sending SR_DF_HEADER.");
 269         packet.type = SR_DF_HEADER;
 270         packet.payload = (uint8_t *)&header;
 271         header.feed_version = 1;
 272         gettimeofday(&header.starttime, NULL);
 273         sr_session_send(devc->cb_data, &packet);
 274
 275         /* Poll every 150ms, or whenever some data comes in. */
 276         sr_source_add(devc->serial->fd, G_IO_IN, 150, colead_slm_receive_data,
 277                         (void *)sdi);
 278
 279         return SR_OK;
 280 }
 281
 282 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 283 {
 284         struct sr_datafeed_packet packet;
 285         struct dev_context *devc;
 286
 287         if (sdi->status != SR_ST_ACTIVE)
 288                 return SR_ERR;
 289
 290         if (!(devc = sdi->priv)) {
 291                 sr_err("sdi->priv was NULL.");
 292                 return SR_ERR_BUG;
 293         }
 294
 295         sr_dbg("Stopping acquisition.");
 296
 297         sr_source_remove(devc->serial->fd);
 298         hw_dev_close((struct sr_dev_inst *)sdi);
 299
 300         /* Send end packet to the session bus. */
 301         sr_dbg("Sending SR_DF_END.");
 302         packet.type = SR_DF_END;
 303         sr_session_send(cb_data, &packet);
 304
 305         return SR_OK;
 306 }
 307
 308 SR_PRIV struct sr_dev_driver colead_slm_driver_info = {
 309         .name = "colead-slm",
 310         .longname = "Colead SLM",
 311         .api_version = 1,
 312         .init = hw_init,
 313         .cleanup = hw_cleanup,
 314         .scan = hw_scan,
 315         .dev_list = hw_dev_list,
 316         .dev_clear = clear_instances,
 317         .config_set = config_set,
 318         .config_list = config_list,
 319         .dev_open = hw_dev_open,
 320         .dev_close = hw_dev_close,
 321         .dev_acquisition_start = hw_dev_acquisition_start,
 322         .dev_acquisition_stop = hw_dev_acquisition_stop,
 323         .priv = NULL,
 324 };