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