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_HWOPT_CONN,
  35         SR_HWOPT_SERIALCOMM,
  36         0,
  37 };
  38
  39 static const int hwcaps[] = {
  40         SR_HWCAP_SOUNDLEVELMETER,
  41         SR_HWCAP_LIMIT_SAMPLES,
  42         SR_HWCAP_LIMIT_MSEC,
  43         SR_HWCAP_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;
  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_hwopt *opt;
  96         struct sr_probe *probe;
  97         GSList *devices, *l;
  98         const char *conn, *serialcomm;
  99
 100         devices = NULL;
 101         drvc = di->priv;
 102         drvc->instances = NULL;
 103
 104         conn = serialcomm = NULL;
 105         for (l = options; l; l = l->next) {
 106                 opt = l->data;
 107                 switch (opt->hwopt) {
 108                 case SR_HWOPT_CONN:
 109                         conn = opt->value;
 110                         break;
 111                 case SR_HWOPT_SERIALCOMM:
 112                         serialcomm = opt->value;
 113                         break;
 114                 }
 115         }
 116         if (!conn)
 117                 return NULL;
 118         if (!serialcomm)
 119                 serialcomm = SERIALCOMM;
 120
 121         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Colead",
 122                         "SL-5868P", NULL)))
 123                 return NULL;
 124
 125         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 126                 sr_dbg("failed to malloc devc");
 127                 return NULL;
 128         }
 129
 130         if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm)))
 131                 return NULL;
 132
 133         sdi->priv = devc;
 134         sdi->driver = di;
 135         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 136                 return NULL;
 137         sdi->probes = g_slist_append(sdi->probes, probe);
 138         drvc->instances = g_slist_append(drvc->instances, sdi);
 139         devices = g_slist_append(devices, sdi);
 140
 141         return devices;
 142 }
 143
 144 static GSList *hw_dev_list(void)
 145 {
 146         struct drv_context *drvc;
 147
 148         drvc = di->priv;
 149
 150         return drvc->instances;
 151 }
 152
 153 static int hw_dev_open(struct sr_dev_inst *sdi)
 154 {
 155         struct dev_context *devc;
 156
 157         if (!(devc = sdi->priv)) {
 158                 sr_err("sdi->priv was NULL.");
 159                 return SR_ERR_BUG;
 160         }
 161
 162         if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
 163                 return SR_ERR;
 164
 165         sdi->status = SR_ST_ACTIVE;
 166
 167         return SR_OK;
 168 }
 169
 170 static int hw_dev_close(struct sr_dev_inst *sdi)
 171 {
 172         struct dev_context *devc;
 173
 174         if (!(devc = sdi->priv)) {
 175                 sr_err("sdi->priv was NULL.");
 176                 return SR_ERR_BUG;
 177         }
 178
 179         if (devc->serial && devc->serial->fd != -1) {
 180                 serial_close(devc->serial);
 181                 sdi->status = SR_ST_INACTIVE;
 182         }
 183
 184         return SR_OK;
 185 }
 186
 187 static int hw_cleanup(void)
 188 {
 189         clear_instances();
 190
 191         return SR_OK;
 192 }
 193
 194 static int hw_info_get(int info_id, const void **data,
 195                        const struct sr_dev_inst *sdi)
 196 {
 197
 198         (void)sdi;
 199
 200         switch (info_id) {
 201         case SR_DI_HWOPTS:
 202                 *data = hwopts;
 203                 break;
 204         case SR_DI_HWCAPS:
 205                 *data = hwcaps;
 206                 break;
 207         default:
 208                 return SR_ERR_ARG;
 209         }
 210
 211         return SR_OK;
 212 }
 213
 214 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 215                              const void *value)
 216 {
 217         struct dev_context *devc;
 218
 219         if (sdi->status != SR_ST_ACTIVE)
 220                 return SR_ERR;
 221
 222         if (!(devc = sdi->priv)) {
 223                 sr_err("sdi->priv was NULL.");
 224                 return SR_ERR_BUG;
 225         }
 226
 227         switch (hwcap) {
 228         case SR_HWCAP_LIMIT_MSEC:
 229                 /* TODO: not yet implemented */
 230                 if (*(const uint64_t *)value == 0) {
 231                         sr_err("LIMIT_MSEC can't be 0.");
 232                         return SR_ERR;
 233                 }
 234                 devc->limit_msec = *(const uint64_t *)value;
 235                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 236                        devc->limit_msec);
 237                 break;
 238         case SR_HWCAP_LIMIT_SAMPLES:
 239                 devc->limit_samples = *(const uint64_t *)value;
 240                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 241                        devc->limit_samples);
 242                 break;
 243         default:
 244                 sr_err("Unknown capability: %d.", hwcap);
 245                 return SR_ERR;
 246                 break;
 247         }
 248
 249         return SR_OK;
 250 }
 251
 252 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 253                                     void *cb_data)
 254 {
 255         struct sr_datafeed_packet packet;
 256         struct sr_datafeed_header header;
 257         struct sr_datafeed_meta_analog meta;
 258         struct dev_context *devc;
 259
 260         if (!(devc = sdi->priv)) {
 261                 sr_err("sdi->priv was NULL.");
 262                 return SR_ERR_BUG;
 263         }
 264
 265         sr_dbg("Starting acquisition.");
 266
 267         devc->cb_data = cb_data;
 268
 269         /* Send header packet to the session bus. */
 270         sr_dbg("Sending SR_DF_HEADER.");
 271         packet.type = SR_DF_HEADER;
 272         packet.payload = (uint8_t *)&header;
 273         header.feed_version = 1;
 274         gettimeofday(&header.starttime, NULL);
 275         sr_session_send(devc->cb_data, &packet);
 276
 277         /* Send metadata about the SR_DF_ANALOG packets to come. */
 278         sr_dbg("Sending SR_DF_META_ANALOG.");
 279         packet.type = SR_DF_META_ANALOG;
 280         packet.payload = &meta;
 281         meta.num_probes = 1;
 282         sr_session_send(devc->cb_data, &packet);
 283
 284         /* Poll every 150ms, or whenever some data comes in. */
 285         sr_source_add(devc->serial->fd, G_IO_IN, 150, colead_slm_receive_data,
 286                         (void *)sdi);
 287
 288         return SR_OK;
 289 }
 290
 291 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 292 {
 293         struct sr_datafeed_packet packet;
 294         struct dev_context *devc;
 295
 296         if (sdi->status != SR_ST_ACTIVE)
 297                 return SR_ERR;
 298
 299         if (!(devc = sdi->priv)) {
 300                 sr_err("sdi->priv was NULL.");
 301                 return SR_ERR_BUG;
 302         }
 303
 304         sr_dbg("Stopping acquisition.");
 305
 306         sr_source_remove(devc->serial->fd);
 307         hw_dev_close((struct sr_dev_inst *)sdi);
 308
 309         /* Send end packet to the session bus. */
 310         sr_dbg("Sending SR_DF_END.");
 311         packet.type = SR_DF_END;
 312         sr_session_send(cb_data, &packet);
 313
 314         return SR_OK;
 315 }
 316
 317 SR_PRIV struct sr_dev_driver colead_slm_driver_info = {
 318         .name = "colead-slm",
 319         .longname = "Colead SLM",
 320         .api_version = 1,
 321         .init = hw_init,
 322         .cleanup = hw_cleanup,
 323         .scan = hw_scan,
 324         .dev_list = hw_dev_list,
 325         .dev_clear = clear_instances,
 326         .dev_open = hw_dev_open,
 327         .dev_close = hw_dev_close,
 328         .info_get = hw_info_get,
 329         .dev_config_set = hw_dev_config_set,
 330         .dev_acquisition_start = hw_dev_acquisition_start,
 331         .dev_acquisition_stop = hw_dev_acquisition_stop,
 332         .priv = NULL,
 333 };