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