hardware/mic-985xx/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 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 "protocol.h"
  22
  23 static const int hwopts[] = {
  24         SR_CONF_CONN,
  25         SR_CONF_SERIALCOMM,
  26         0,
  27 };
  28
  29 static const int hwcaps[] = {
  30         SR_CONF_THERMOMETER,
  31         SR_CONF_HYGROMETER,
  32         SR_CONF_LIMIT_SAMPLES,
  33         SR_CONF_LIMIT_MSEC,
  34         SR_CONF_CONTINUOUS,
  35         0,
  36 };
  37
  38 SR_PRIV struct sr_dev_driver mic_98583_driver_info;
  39
  40 SR_PRIV const struct mic_dev_info mic_devs[] = {
  41         {
  42                 "MIC", "98583", "38400/8n2", 32000, TRUE, TRUE,
  43                 &mic_98583_driver_info, receive_data_MIC_98583,
  44         },
  45 };
  46
  47 static int clear_instances(int idx)
  48 {
  49         struct sr_dev_inst *sdi;
  50         struct drv_context *drvc;
  51         struct dev_context *devc;
  52         GSList *l;
  53         struct sr_dev_driver *di;
  54
  55         di = mic_devs[idx].di;
  56
  57         if (!(drvc = di->priv))
  58                 return SR_OK;
  59
  60         for (l = drvc->instances; l; l = l->next) {
  61                 if (!(sdi = l->data))
  62                         continue;
  63                 if (!(devc = sdi->priv))
  64                         continue;
  65                 sr_serial_dev_inst_free(devc->serial);
  66                 sr_dev_inst_free(sdi);
  67         }
  68
  69         g_slist_free(drvc->instances);
  70         drvc->instances = NULL;
  71
  72         return SR_OK;
  73 }
  74
  75 static int hw_init(struct sr_context *sr_ctx, int idx)
  76 {
  77         sr_dbg("Selected '%s' subdriver.", mic_devs[idx].di->name);
  78
  79         return std_hw_init(sr_ctx, mic_devs[idx].di, DRIVER_LOG_DOMAIN);
  80 }
  81
  82 static GSList *scan(const char *conn, const char *serialcomm, int idx)
  83 {
  84         struct sr_dev_inst *sdi;
  85         struct drv_context *drvc;
  86         struct dev_context *devc;
  87         struct sr_probe *probe;
  88         struct sr_serial_dev_inst *serial;
  89         GSList *devices;
  90
  91         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
  92                 return NULL;
  93
  94         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
  95                 return NULL;
  96
  97         drvc = mic_devs[idx].di->priv;
  98         devices = NULL;
  99         serial_flush(serial);
 100
 101         /* TODO: Query device type. */
 102         // ret = mic_cmd_get_device_info(serial);
 103
 104         sr_info("Found device on port %s.", conn);
 105
 106         /* TODO: Fill in version from protocol response. */
 107         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, mic_devs[idx].vendor,
 108                                     mic_devs[idx].device, "")))
 109                 goto scan_cleanup;
 110
 111         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 112                 sr_err("Device context malloc failed.");
 113                 goto scan_cleanup;
 114         }
 115
 116         devc->serial = serial;
 117
 118         sdi->priv = devc;
 119         sdi->driver = mic_devs[idx].di;
 120
 121         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "Temperature")))
 122                 goto scan_cleanup;
 123         sdi->probes = g_slist_append(sdi->probes, probe);
 124
 125         if (!(probe = sr_probe_new(1, SR_PROBE_ANALOG, TRUE, "Humidity")))
 126                 goto scan_cleanup;
 127         sdi->probes = g_slist_append(sdi->probes, probe);
 128
 129         drvc->instances = g_slist_append(drvc->instances, sdi);
 130         devices = g_slist_append(devices, sdi);
 131
 132 scan_cleanup:
 133         serial_close(serial);
 134
 135         return devices;
 136 }
 137
 138 static GSList *hw_scan(GSList *options, int idx)
 139 {
 140         struct sr_config *src;
 141         GSList *l, *devices;
 142         const char *conn, *serialcomm;
 143
 144         conn = serialcomm = NULL;
 145         for (l = options; l; l = l->next) {
 146                 src = l->data;
 147                 switch (src->key) {
 148                 case SR_CONF_CONN:
 149                         conn = src->value;
 150                         break;
 151                 case SR_CONF_SERIALCOMM:
 152                         serialcomm = src->value;
 153                         break;
 154                 }
 155         }
 156         if (!conn)
 157                 return NULL;
 158
 159         if (serialcomm) {
 160                 /* Use the provided comm specs. */
 161                 devices = scan(conn, serialcomm, idx);
 162         } else {
 163                 /* Try the default. */
 164                 devices = scan(conn, mic_devs[idx].conn, idx);
 165         }
 166
 167         return devices;
 168 }
 169
 170 static GSList *hw_dev_list(int idx)
 171 {
 172         struct drv_context *drvc;
 173
 174         drvc = mic_devs[idx].di->priv;
 175
 176         return drvc->instances;
 177 }
 178
 179 static int hw_dev_open(struct sr_dev_inst *sdi)
 180 {
 181         struct dev_context *devc;
 182
 183         devc = sdi->priv;
 184
 185         if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 186                 return SR_ERR;
 187
 188         sdi->status = SR_ST_ACTIVE;
 189
 190         return SR_OK;
 191 }
 192
 193 static int hw_dev_close(struct sr_dev_inst *sdi)
 194 {
 195         struct dev_context *devc;
 196
 197         devc = sdi->priv;
 198
 199         if (devc->serial && devc->serial->fd != -1) {
 200                 serial_close(devc->serial);
 201                 sdi->status = SR_ST_INACTIVE;
 202         }
 203
 204         return SR_OK;
 205 }
 206
 207 static int hw_cleanup(int idx)
 208 {
 209         clear_instances(idx);
 210
 211         return SR_OK;
 212 }
 213
 214 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 215 {
 216         struct dev_context *devc;
 217
 218         if (sdi->status != SR_ST_ACTIVE)
 219                 return SR_ERR;
 220
 221         devc = sdi->priv;
 222
 223         switch (id) {
 224         case SR_CONF_LIMIT_SAMPLES:
 225                 devc->limit_samples = *(const uint64_t *)value;
 226                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 227                        devc->limit_samples);
 228                 break;
 229         case SR_CONF_LIMIT_MSEC:
 230                 devc->limit_msec = *(const uint64_t *)value;
 231                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 232                        devc->limit_msec);
 233                 break;
 234         default:
 235                 sr_err("Unknown config: %d.", id);
 236                 return SR_ERR_ARG;
 237         }
 238
 239         return SR_OK;
 240 }
 241
 242 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 243 {
 244         (void)sdi;
 245
 246         switch (key) {
 247         case SR_CONF_SCAN_OPTIONS:
 248                 *data = hwopts;
 249                 break;
 250         case SR_CONF_DEVICE_OPTIONS:
 251                 *data = hwcaps;
 252                 break;
 253         default:
 254                 return SR_ERR_ARG;
 255         }
 256
 257         return SR_OK;
 258 }
 259
 260 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 261                                     void *cb_data, int idx)
 262 {
 263         struct sr_datafeed_packet packet;
 264         struct sr_datafeed_header header;
 265         struct dev_context *devc;
 266
 267         devc = sdi->priv;
 268
 269         devc->cb_data = cb_data;
 270
 271         sr_dbg("Starting acquisition.");
 272
 273         devc->num_samples = 0;
 274         devc->starttime = g_get_monotonic_time();
 275
 276         /* Send header packet to the session bus. */
 277         sr_dbg("Sending SR_DF_HEADER.");
 278         packet.type = SR_DF_HEADER;
 279         packet.payload = (uint8_t *)&header;
 280         header.feed_version = 1;
 281         gettimeofday(&header.starttime, NULL);
 282         sr_session_send(devc->cb_data, &packet);
 283
 284         /* Poll every 100ms, or whenever some data comes in. */
 285         sr_source_add(devc->serial->fd, G_IO_IN, 100,
 286                       mic_devs[idx].receive_data, (void *)sdi);
 287
 288         return SR_OK;
 289 }
 290
 291 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 292 {
 293         struct sr_datafeed_packet packet;
 294         struct dev_context *devc;
 295
 296         if (sdi->status != SR_ST_ACTIVE) {
 297                 sr_err("Device inactive, can't stop acquisition.");
 298                 return SR_ERR;
 299         }
 300
 301         devc = sdi->priv;
 302
 303         sr_dbg("Stopping acquisition.");
 304
 305         sr_source_remove(devc->serial->fd);
 306         hw_dev_close((struct sr_dev_inst *)sdi);
 307
 308         /* Send end packet to the session bus. */
 309         sr_dbg("Sending SR_DF_END.");
 310         packet.type = SR_DF_END;
 311         sr_session_send(cb_data, &packet);
 312
 313         return SR_OK;
 314 }
 315
 316 /* Driver-specific API function wrappers */
 317 #define HW_INIT(X) \
 318 static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
 319 #define HW_CLEANUP(X) \
 320 static int hw_cleanup_##X(void) { return hw_cleanup(X); }
 321 #define HW_SCAN(X) \
 322 static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
 323 #define HW_DEV_LIST(X) \
 324 static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
 325 #define CLEAR_INSTANCES(X) \
 326 static int clear_instances_##X(void) { return clear_instances(X); }
 327 #define HW_DEV_ACQUISITION_START(X) \
 328 static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 329 void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
 330
 331 /* Driver structs and API function wrappers */
 332 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 333 HW_INIT(ID_UPPER) \
 334 HW_CLEANUP(ID_UPPER) \
 335 HW_SCAN(ID_UPPER) \
 336 HW_DEV_LIST(ID_UPPER) \
 337 CLEAR_INSTANCES(ID_UPPER) \
 338 HW_DEV_ACQUISITION_START(ID_UPPER) \
 339 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 340         .name = NAME, \
 341         .longname = LONGNAME, \
 342         .api_version = 1, \
 343         .init = hw_init_##ID_UPPER, \
 344         .cleanup = hw_cleanup_##ID_UPPER, \
 345         .scan = hw_scan_##ID_UPPER, \
 346         .dev_list = hw_dev_list_##ID_UPPER, \
 347         .dev_clear = clear_instances_##ID_UPPER, \
 348         .config_get = NULL, \
 349         .config_set = config_set, \
 350         .config_list = config_list, \
 351         .dev_open = hw_dev_open, \
 352         .dev_close = hw_dev_close, \
 353         .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
 354         .dev_acquisition_stop = hw_dev_acquisition_stop, \
 355         .priv = NULL, \
 356 };
 357
 358 DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")