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