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