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