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