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         /* TODO: Query device type. */
  71         // ret = mic_cmd_get_device_info(serial);
  72
  73         sr_info("Found device on port %s.", conn);
  74
  75         /* TODO: Fill in version from protocol response. */
  76         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  77         sdi->status = SR_ST_INACTIVE;
  78         sdi->vendor = g_strdup(mic_devs[idx].vendor);
  79         sdi->model = g_strdup(mic_devs[idx].device);
  80         devc = g_malloc0(sizeof(struct dev_context));
  81         sr_sw_limits_init(&devc->limits);
  82         sdi->inst_type = SR_INST_SERIAL;
  83         sdi->conn = serial;
  84         sdi->priv = devc;
  85
  86         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Temperature");
  87
  88         if (mic_devs[idx].has_humidity)
  89                 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "Humidity");
  90
  91         serial_close(serial);
  92
  93         return std_scan_complete(mic_devs[idx].di, g_slist_append(NULL, sdi));
  94 }
  95
  96 static GSList *scan(GSList *options, int idx)
  97 {
  98         struct sr_config *src;
  99         GSList *l, *devices;
 100         const char *conn, *serialcomm;
 101
 102         conn = serialcomm = NULL;
 103         for (l = options; l; l = l->next) {
 104                 src = l->data;
 105                 switch (src->key) {
 106                 case SR_CONF_CONN:
 107                         conn = g_variant_get_string(src->data, NULL);
 108                         break;
 109                 case SR_CONF_SERIALCOMM:
 110                         serialcomm = g_variant_get_string(src->data, NULL);
 111                         break;
 112                 }
 113         }
 114         if (!conn)
 115                 return NULL;
 116
 117         if (serialcomm)
 118                 devices = mic_scan(conn, serialcomm, idx);
 119         else
 120                 devices = mic_scan(conn, mic_devs[idx].conn, idx);
 121
 122         return devices;
 123 }
 124
 125 static int config_set(uint32_t key, GVariant *data,
 126         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 127 {
 128         struct dev_context *devc;
 129
 130         (void)cg;
 131
 132         devc = sdi->priv;
 133
 134         return sr_sw_limits_config_set(&devc->limits, key, data);
 135 }
 136
 137 static int config_list(uint32_t key, GVariant **data,
 138         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, int idx)
 139 {
 140         /*
 141          * We can't use the ternary operator here! The result would contain
 142          * sizeof((cond) ? A : B) where A/B are arrays of different type/size.
 143          * The ternary operator always returns the "common" type of A and B,
 144          * which would be a pointer instead of either the A or B arrays.
 145          * Thus, sizeof() would yield the size of a pointer, not the size
 146          * of either the A or B array, which is not what we want.
 147          */
 148         if (mic_devs[idx].has_humidity)
 149                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts_temp_hum, devopts);
 150         else
 151                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts_temp, devopts);
 152 }
 153
 154 static int dev_acquisition_start(const struct sr_dev_inst *sdi, int idx)
 155 {
 156         struct dev_context *devc;
 157         struct sr_serial_dev_inst *serial;
 158
 159         devc = sdi->priv;
 160
 161         sr_sw_limits_acquisition_start(&devc->limits);
 162         std_session_send_df_header(sdi);
 163
 164         serial = sdi->conn;
 165         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 166                       mic_devs[idx].receive_data, (void *)sdi);
 167
 168         return SR_OK;
 169 }
 170
 171 /* Driver-specific API function wrappers */
 172 #define HW_SCAN(X) \
 173 static GSList *scan_##X(struct sr_dev_driver *di, GSList *options) { \
 174         (void)di; return scan(options, X); }
 175 #define HW_CONFIG_LIST(X) \
 176 static int config_list_##X(uint32_t key, GVariant **data, \
 177 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { \
 178 return config_list(key, data, sdi, cg, X); }
 179 #define HW_DEV_ACQUISITION_START(X) \
 180 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
 181 ) { return dev_acquisition_start(sdi, X); }
 182
 183 /* Driver structs and API function wrappers */
 184 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 185 HW_SCAN(ID_UPPER) \
 186 HW_CONFIG_LIST(ID_UPPER) \
 187 HW_DEV_ACQUISITION_START(ID_UPPER) \
 188 static struct sr_dev_driver ID##_driver_info = { \
 189         .name = NAME, \
 190         .longname = LONGNAME, \
 191         .api_version = 1, \
 192         .init = std_init, \
 193         .cleanup = std_cleanup, \
 194         .scan = scan_##ID_UPPER, \
 195         .dev_list = std_dev_list, \
 196         .dev_clear = std_dev_clear, \
 197         .config_get = NULL, \
 198         .config_set = config_set, \
 199         .config_list = config_list_##ID_UPPER, \
 200         .dev_open = std_serial_dev_open, \
 201         .dev_close = std_serial_dev_close, \
 202         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
 203         .dev_acquisition_stop = std_serial_dev_acquisition_stop, \
 204         .context = NULL, \
 205 }; \
 206 SR_REGISTER_DEV_DRIVER(ID##_driver_info)
 207
 208 DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
 209 DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")