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