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