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