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 int32_t hwopts[] = {
  34         SR_CONF_CONN,
  35         SR_CONF_SERIALCOMM,
  36 };
  37
  38 static const int32_t hwcaps[] = {
  39         SR_CONF_SOUNDLEVELMETER,
  40         SR_CONF_LIMIT_SAMPLES,
  41         SR_CONF_LIMIT_MSEC,
  42         SR_CONF_CONTINUOUS,
  43 };
  44
  45 SR_PRIV struct sr_dev_driver colead_slm_driver_info;
  46 static struct sr_dev_driver *di = &colead_slm_driver_info;
  47
  48 static int dev_clear(void)
  49 {
  50         return std_dev_clear(di, NULL);
  51 }
  52
  53 static int init(struct sr_context *sr_ctx)
  54 {
  55         return std_init(sr_ctx, di, LOG_PREFIX);
  56 }
  57
  58 static GSList *scan(GSList *options)
  59 {
  60         struct drv_context *drvc;
  61         struct dev_context *devc;
  62         struct sr_dev_inst *sdi;
  63         struct sr_config *src;
  64         struct sr_probe *probe;
  65         GSList *devices, *l;
  66         const char *conn, *serialcomm;
  67
  68         drvc = di->priv;
  69         drvc->instances = NULL;
  70
  71         devices = NULL;
  72
  73         conn = serialcomm = NULL;
  74         for (l = options; l; l = l->next) {
  75                 src = l->data;
  76                 switch (src->key) {
  77                 case SR_CONF_CONN:
  78                         conn = g_variant_get_string(src->data, NULL);
  79                         break;
  80                 case SR_CONF_SERIALCOMM:
  81                         serialcomm = g_variant_get_string(src->data, NULL);
  82                         break;
  83                 }
  84         }
  85         if (!conn)
  86                 return NULL;
  87         if (!serialcomm)
  88                 serialcomm = SERIALCOMM;
  89
  90         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Colead",
  91                         "SL-5868P", NULL)))
  92                 return NULL;
  93
  94         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
  95                 sr_dbg("Device context malloc failed.");
  96                 return NULL;
  97         }
  98
  99         if (!(sdi->conn = sr_serial_dev_inst_new(conn, serialcomm)))
 100                 return NULL;
 101
 102         sdi->inst_type = SR_INST_SERIAL;
 103         sdi->priv = devc;
 104         sdi->driver = di;
 105         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 106                 return NULL;
 107         sdi->probes = g_slist_append(sdi->probes, probe);
 108         drvc->instances = g_slist_append(drvc->instances, sdi);
 109         devices = g_slist_append(devices, sdi);
 110
 111         return devices;
 112 }
 113
 114 static GSList *dev_list(void)
 115 {
 116         return ((struct drv_context *)(di->priv))->instances;
 117 }
 118
 119 static int dev_open(struct sr_dev_inst *sdi)
 120 {
 121         struct sr_serial_dev_inst *serial;
 122
 123         serial = sdi->conn;
 124         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 125                 return SR_ERR;
 126
 127         sdi->status = SR_ST_ACTIVE;
 128
 129         return SR_OK;
 130 }
 131
 132 static int dev_close(struct sr_dev_inst *sdi)
 133 {
 134         struct sr_serial_dev_inst *serial;
 135
 136         serial = sdi->conn;
 137         if (serial && serial->fd != -1) {
 138                 serial_close(serial);
 139                 sdi->status = SR_ST_INACTIVE;
 140         }
 141
 142         return SR_OK;
 143 }
 144
 145 static int cleanup(void)
 146 {
 147         return dev_clear();
 148 }
 149
 150 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 151 {
 152         struct dev_context *devc;
 153
 154         if (sdi->status != SR_ST_ACTIVE)
 155                 return SR_ERR_DEV_CLOSED;
 156
 157         if (!(devc = sdi->priv)) {
 158                 sr_err("sdi->priv was NULL.");
 159                 return SR_ERR_BUG;
 160         }
 161
 162         switch (id) {
 163         case SR_CONF_LIMIT_MSEC:
 164                 /* TODO: not yet implemented */
 165                 if (g_variant_get_uint64(data) == 0) {
 166                         sr_err("LIMIT_MSEC can't be 0.");
 167                         return SR_ERR;
 168                 }
 169                 devc->limit_msec = g_variant_get_uint64(data);;
 170                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 171                        devc->limit_msec);
 172                 break;
 173         case SR_CONF_LIMIT_SAMPLES:
 174                 devc->limit_samples = g_variant_get_uint64(data);
 175                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 176                        devc->limit_samples);
 177                 break;
 178         default:
 179                 return SR_ERR_NA;
 180         }
 181
 182         return SR_OK;
 183 }
 184
 185 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 186 {
 187
 188         (void)sdi;
 189
 190         switch (key) {
 191         case SR_CONF_SCAN_OPTIONS:
 192                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 193                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 194                 break;
 195         case SR_CONF_DEVICE_OPTIONS:
 196                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 197                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 198                 break;
 199         default:
 200                 return SR_ERR_NA;
 201         }
 202
 203         return SR_OK;
 204 }
 205
 206 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 207 {
 208         struct dev_context *devc;
 209         struct sr_serial_dev_inst *serial;
 210
 211         if (sdi->status != SR_ST_ACTIVE)
 212                 return SR_ERR_DEV_CLOSED;
 213
 214         if (!(devc = sdi->priv)) {
 215                 sr_err("sdi->priv was NULL.");
 216                 return SR_ERR_BUG;
 217         }
 218
 219         devc->cb_data = cb_data;
 220
 221         /* Send header packet to the session bus. */
 222         std_session_send_df_header(cb_data, LOG_PREFIX);
 223
 224         /* Poll every 150ms, or whenever some data comes in. */
 225         serial = sdi->conn;
 226         sr_source_add(serial->fd, G_IO_IN, 150, colead_slm_receive_data,
 227                         (void *)sdi);
 228
 229         return SR_OK;
 230 }
 231
 232 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 233 {
 234         return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
 235                         sdi->conn, LOG_PREFIX);
 236 }
 237
 238 SR_PRIV struct sr_dev_driver colead_slm_driver_info = {
 239         .name = "colead-slm",
 240         .longname = "Colead SLM",
 241         .api_version = 1,
 242         .init = init,
 243         .cleanup = cleanup,
 244         .scan = scan,
 245         .dev_list = dev_list,
 246         .dev_clear = dev_clear,
 247         .config_get = NULL,
 248         .config_set = config_set,
 249         .config_list = config_list,
 250         .dev_open = dev_open,
 251         .dev_close = dev_close,
 252         .dev_acquisition_start = dev_acquisition_start,
 253         .dev_acquisition_stop = dev_acquisition_stop,
 254         .priv = NULL,
 255 };