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 = g_malloc0(sizeof(struct sr_dev_inst));
  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         devc = g_malloc0(sizeof(struct dev_context));
  99         sdi->inst_type = SR_INST_SERIAL;
 100         sdi->conn = serial;
 101         sdi->priv = devc;
 102         sdi->driver = mic_devs[idx].di;
 103
 104         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "Temperature")))
 105                 goto scan_cleanup;
 106         sdi->channels = g_slist_append(sdi->channels, ch);
 107
 108         if (mic_devs[idx].has_humidity) {
 109                 if (!(ch = sr_channel_new(1, SR_CHANNEL_ANALOG, TRUE, "Humidity")))
 110                         goto scan_cleanup;
 111                 sdi->channels = g_slist_append(sdi->channels, ch);
 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 *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 = mic_scan(conn, serialcomm, idx);
 147         } else {
 148                 /* Try the default. */
 149                 devices = mic_scan(conn, mic_devs[idx].conn, idx);
 150         }
 151
 152         return devices;
 153 }
 154
 155 static GSList *dev_list(int idx)
 156 {
 157         return ((struct drv_context *)(mic_devs[idx].di->priv))->instances;
 158 }
 159
 160 static int cleanup(int idx)
 161 {
 162         return dev_clear(idx);
 163 }
 164
 165 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 166                 const struct sr_channel_group *cg)
 167 {
 168         struct dev_context *devc;
 169
 170         (void)cg;
 171
 172         if (sdi->status != SR_ST_ACTIVE)
 173                 return SR_ERR_DEV_CLOSED;
 174
 175         devc = sdi->priv;
 176
 177         switch (key) {
 178         case SR_CONF_LIMIT_SAMPLES:
 179                 devc->limit_samples = g_variant_get_uint64(data);
 180                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 181                        devc->limit_samples);
 182                 break;
 183         case SR_CONF_LIMIT_MSEC:
 184                 devc->limit_msec = g_variant_get_uint64(data);
 185                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 186                        devc->limit_msec);
 187                 break;
 188         default:
 189                 return SR_ERR_NA;
 190         }
 191
 192         return SR_OK;
 193 }
 194
 195 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 196                 const struct sr_channel_group *cg, int idx)
 197 {
 198         (void)cg;
 199
 200         switch (key) {
 201         case SR_CONF_SCAN_OPTIONS:
 202                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 203                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 204                 break;
 205         case SR_CONF_DEVICE_OPTIONS:
 206                 if (!sdi && !mic_devs[idx].has_humidity) {
 207                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 208                                 drvopts_temp, ARRAY_SIZE(drvopts_temp),
 209                                 sizeof(uint32_t));
 210                 } else if (!sdi && mic_devs[idx].has_humidity) {
 211                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 212                                 drvopts_temp_hum, ARRAY_SIZE(drvopts_temp_hum),
 213                                 sizeof(uint32_t));
 214                 } else {
 215                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 216                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 217                 }
 218                 break;
 219         default:
 220                 return SR_ERR_NA;
 221         }
 222
 223         return SR_OK;
 224 }
 225
 226 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 227                                     void *cb_data, int idx)
 228 {
 229         struct dev_context *devc;
 230         struct sr_serial_dev_inst *serial;
 231
 232         if (sdi->status != SR_ST_ACTIVE)
 233                 return SR_ERR_DEV_CLOSED;
 234
 235         devc = sdi->priv;
 236         devc->cb_data = cb_data;
 237         devc->num_samples = 0;
 238         devc->starttime = g_get_monotonic_time();
 239
 240         /* Send header packet to the session bus. */
 241         std_session_send_df_header(cb_data, LOG_PREFIX);
 242
 243         /* Poll every 100ms, or whenever some data comes in. */
 244         serial = sdi->conn;
 245         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 246                       mic_devs[idx].receive_data, (void *)sdi);
 247
 248         return SR_OK;
 249 }
 250
 251 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 252 {
 253         return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
 254                         sdi->conn, LOG_PREFIX);
 255 }
 256
 257 /* Driver-specific API function wrappers */
 258 #define HW_INIT(X) \
 259 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
 260 #define HW_CLEANUP(X) \
 261 static int cleanup_##X(void) { return cleanup(X); }
 262 #define HW_SCAN(X) \
 263 static GSList *scan_##X(GSList *options) { return scan(options, X); }
 264 #define HW_DEV_LIST(X) \
 265 static GSList *dev_list_##X(void) { return dev_list(X); }
 266 #define HW_DEV_CLEAR(X) \
 267 static int dev_clear_##X(void) { return dev_clear(X); }
 268 #define HW_CONFIG_LIST(X) \
 269 static int config_list_##X(uint32_t key, GVariant **data, \
 270 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { \
 271 return config_list(key, data, sdi, cg, X); }
 272 #define HW_DEV_ACQUISITION_START(X) \
 273 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
 274 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
 275
 276 /* Driver structs and API function wrappers */
 277 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 278 HW_INIT(ID_UPPER) \
 279 HW_CLEANUP(ID_UPPER) \
 280 HW_SCAN(ID_UPPER) \
 281 HW_DEV_LIST(ID_UPPER) \
 282 HW_DEV_CLEAR(ID_UPPER) \
 283 HW_CONFIG_LIST(ID_UPPER) \
 284 HW_DEV_ACQUISITION_START(ID_UPPER) \
 285 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
 286         .name = NAME, \
 287         .longname = LONGNAME, \
 288         .api_version = 1, \
 289         .init = init_##ID_UPPER, \
 290         .cleanup = cleanup_##ID_UPPER, \
 291         .scan = scan_##ID_UPPER, \
 292         .dev_list = dev_list_##ID_UPPER, \
 293         .dev_clear = dev_clear_##ID_UPPER, \
 294         .config_get = NULL, \
 295         .config_set = config_set, \
 296         .config_list = config_list_##ID_UPPER, \
 297         .dev_open = std_serial_dev_open, \
 298         .dev_close = std_serial_dev_close, \
 299         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
 300         .dev_acquisition_stop = dev_acquisition_stop, \
 301         .priv = NULL, \
 302 };
 303
 304 DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
 305 DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")