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