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