hardware/tondaj-sl-814/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <fcntl.h>
  22 #include <glib.h>
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25 #include "protocol.h"
  26
  27 #define SERIALCOMM "9600/8e1"
  28
  29 static const int32_t hwopts[] = {
  30         SR_CONF_CONN,
  31         SR_CONF_SERIALCOMM,
  32 };
  33
  34 static const int32_t hwcaps[] = {
  35         SR_CONF_SOUNDLEVELMETER,
  36         SR_CONF_LIMIT_SAMPLES,
  37         SR_CONF_CONTINUOUS,
  38 };
  39
  40 SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
  41 static struct sr_dev_driver *di = &tondaj_sl_814_driver_info;
  42
  43 /* Properly close and free all devices. */
  44 static int clear_instances(void)
  45 {
  46         struct sr_dev_inst *sdi;
  47         struct drv_context *drvc;
  48         struct dev_context *devc;
  49         struct sr_serial_dev_inst *serial;
  50         GSList *l;
  51
  52         if (!(drvc = di->priv))
  53                 return SR_OK;
  54
  55         for (l = drvc->instances; l; l = l->next) {
  56                 if (!(sdi = l->data))
  57                         continue;
  58                 if (!(devc = sdi->priv))
  59                         continue;
  60                 serial = sdi->conn;
  61                 sr_serial_dev_inst_free(serial);
  62                 sr_dev_inst_free(sdi);
  63         }
  64
  65         g_slist_free(drvc->instances);
  66         drvc->instances = NULL;
  67
  68         return SR_OK;
  69 }
  70
  71 static int hw_init(struct sr_context *sr_ctx)
  72 {
  73         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
  74 }
  75
  76 static GSList *hw_scan(GSList *options)
  77 {
  78         struct drv_context *drvc;
  79         struct dev_context *devc;
  80         struct sr_dev_inst *sdi;
  81         struct sr_config *src;
  82         struct sr_probe *probe;
  83         GSList *devices, *l;
  84         const char *conn, *serialcomm;
  85         struct sr_serial_dev_inst *serial;
  86
  87         drvc = di->priv;
  88         drvc->instances = NULL;
  89
  90         devices = NULL;
  91
  92         conn = serialcomm = NULL;
  93         for (l = options; l; l = l->next) {
  94                 if (!(src = l->data)) {
  95                         sr_err("Invalid option data, skipping.");
  96                         continue;
  97                 }
  98                 switch (src->key) {
  99                 case SR_CONF_CONN:
 100                         conn = g_variant_get_string(src->data, NULL);
 101                         break;
 102                 case SR_CONF_SERIALCOMM:
 103                         serialcomm  = g_variant_get_string(src->data, NULL);
 104                         break;
 105                 default:
 106                         sr_err("Unknown option %d, skipping.", src->key);
 107                         break;
 108                 }
 109         }
 110         if (!conn)
 111                 return NULL;
 112         if (!serialcomm)
 113                 serialcomm = SERIALCOMM;
 114
 115         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Tondaj",
 116                                     "SL-814", NULL))) {
 117                 sr_err("Failed to create device instance.");
 118                 return NULL;
 119         }
 120
 121         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 122                 sr_err("Device context malloc failed.");
 123                 return NULL;
 124         }
 125
 126         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
 127                 return NULL;
 128
 129         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 130                 return NULL;
 131
 132         sdi->inst_type = SR_INST_SERIAL;
 133         sdi->conn = serial;
 134
 135         sdi->priv = devc;
 136         sdi->driver = di;
 137         probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1");
 138         if (!probe) {
 139                 sr_err("Failed to create probe.");
 140                 return NULL;
 141         }
 142         sdi->probes = g_slist_append(sdi->probes, probe);
 143         drvc->instances = g_slist_append(drvc->instances, sdi);
 144         devices = g_slist_append(devices, sdi);
 145
 146         return devices;
 147 }
 148
 149 static GSList *hw_dev_list(void)
 150 {
 151         return ((struct drv_context *)(di->priv))->instances;
 152 }
 153
 154 static int hw_dev_open(struct sr_dev_inst *sdi)
 155 {
 156         struct sr_serial_dev_inst *serial;
 157
 158         serial = sdi->conn;
 159         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 160                 return SR_ERR;
 161
 162         sdi->status = SR_ST_ACTIVE;
 163
 164         return SR_OK;
 165 }
 166
 167 static int hw_dev_close(struct sr_dev_inst *sdi)
 168 {
 169         struct sr_serial_dev_inst *serial;
 170
 171         serial = sdi->conn;
 172         if (serial && serial->fd != -1) {
 173                 serial_close(serial);
 174                 sdi->status = SR_ST_INACTIVE;
 175         }
 176
 177         return SR_OK;
 178 }
 179
 180 static int hw_cleanup(void)
 181 {
 182         clear_instances();
 183
 184         return SR_OK;
 185 }
 186
 187 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 188 {
 189         struct dev_context *devc;
 190
 191         if (sdi->status != SR_ST_ACTIVE)
 192                 return SR_ERR_DEV_CLOSED;
 193
 194         devc = sdi->priv;
 195
 196         switch (id) {
 197         case SR_CONF_LIMIT_SAMPLES:
 198                 devc->limit_samples = g_variant_get_uint64(data);
 199                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 200                        devc->limit_samples);
 201                 break;
 202         default:
 203                 return SR_ERR_NA;
 204         }
 205
 206         return SR_OK;
 207 }
 208
 209 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 210 {
 211
 212         (void)sdi;
 213
 214         switch (key) {
 215         case SR_CONF_SCAN_OPTIONS:
 216                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 217                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 218                 break;
 219         case SR_CONF_DEVICE_OPTIONS:
 220                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 221                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 222                 break;
 223         default:
 224                 return SR_ERR_NA;
 225         }
 226
 227         return SR_OK;
 228 }
 229
 230 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 231                                     void *cb_data)
 232 {
 233         struct dev_context *devc;
 234         struct sr_serial_dev_inst *serial;
 235
 236         if (sdi->status != SR_ST_ACTIVE)
 237                 return SR_ERR_DEV_CLOSED;
 238
 239         devc = sdi->priv;
 240         devc->cb_data = cb_data;
 241
 242         /* Send header packet to the session bus. */
 243         std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 244
 245         /* Poll every 500ms, or whenever some data comes in. */
 246         serial = sdi->conn;
 247         sr_source_add(serial->fd, G_IO_IN, 500,
 248                       tondaj_sl_814_receive_data, (void *)sdi);
 249
 250         return SR_OK;
 251 }
 252
 253 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 254 {
 255         return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
 256                                                   sdi->conn, DRIVER_LOG_DOMAIN);
 257 }
 258
 259 SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info = {
 260         .name = "tondaj-sl-814",
 261         .longname = "Tondaj SL-814",
 262         .api_version = 1,
 263         .init = hw_init,
 264         .cleanup = hw_cleanup,
 265         .scan = hw_scan,
 266         .dev_list = hw_dev_list,
 267         .dev_clear = clear_instances,
 268         .config_get = NULL,
 269         .config_set = config_set,
 270         .config_list = config_list,
 271         .dev_open = hw_dev_open,
 272         .dev_close = hw_dev_close,
 273         .dev_acquisition_start = hw_dev_acquisition_start,
 274         .dev_acquisition_stop = hw_dev_acquisition_stop,
 275         .priv = NULL,
 276 };