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