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