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