src/hardware/center-3xx/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[] = {
  29         SR_CONF_THERMOMETER,
  30 };
  31
  32 static const uint32_t devopts[] = {
  33         SR_CONF_CONTINUOUS,
  34         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  35         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  36 };
  37
  38 static const char *channel_names[] = {
  39         "T1", "T2", "T3", "T4",
  40 };
  41
  42 static struct sr_dev_driver center_309_driver_info;
  43 static struct sr_dev_driver voltcraft_k204_driver_info;
  44
  45 SR_PRIV const struct center_dev_info center_devs[] = {
  46         {
  47                 "Center", "309", "9600/8n1", 4, 32000, 45,
  48                 center_3xx_packet_valid,
  49                 &center_309_driver_info, receive_data_CENTER_309,
  50         },
  51         {
  52                 "Voltcraft", "K204", "9600/8n1", 4, 32000, 45,
  53                 center_3xx_packet_valid,
  54                 &voltcraft_k204_driver_info, receive_data_VOLTCRAFT_K204,
  55         },
  56 };
  57
  58 static GSList *center_scan(const char *conn, const char *serialcomm, int idx)
  59 {
  60         int i;
  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         sr_info("Found device on port %s.", conn);
  73
  74         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  75         sdi->status = SR_ST_INACTIVE;
  76         sdi->vendor = g_strdup(center_devs[idx].vendor);
  77         sdi->model = g_strdup(center_devs[idx].device);
  78         devc = g_malloc0(sizeof(struct dev_context));
  79         sdi->inst_type = SR_INST_SERIAL;
  80         sdi->conn = serial;
  81         sdi->priv = devc;
  82
  83         for (i = 0; i < center_devs[idx].num_channels; i++)
  84                 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
  85
  86         serial_close(serial);
  87
  88         return g_slist_append(NULL, sdi);
  89 }
  90
  91 static GSList *scan(GSList *options, int idx)
  92 {
  93         struct sr_config *src;
  94         GSList *l, *devices;
  95         const char *conn, *serialcomm;
  96
  97         conn = serialcomm = NULL;
  98         for (l = options; l; l = l->next) {
  99                 src = l->data;
 100                 switch (src->key) {
 101                 case SR_CONF_CONN:
 102                         conn = g_variant_get_string(src->data, NULL);
 103                         break;
 104                 case SR_CONF_SERIALCOMM:
 105                         serialcomm = g_variant_get_string(src->data, NULL);
 106                         break;
 107                 }
 108         }
 109         if (!conn)
 110                 return NULL;
 111
 112         if (serialcomm) {
 113                 /* Use the provided comm specs. */
 114                 devices = center_scan(conn, serialcomm, idx);
 115         } else {
 116                 /* Try the default. */
 117                 devices = center_scan(conn, center_devs[idx].conn, idx);
 118         }
 119
 120         return std_scan_complete(center_devs[idx].di, devices);
 121 }
 122
 123 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 124                 const struct sr_channel_group *cg)
 125 {
 126         struct dev_context *devc;
 127
 128         (void)cg;
 129
 130         if (sdi->status != SR_ST_ACTIVE)
 131                 return SR_ERR_DEV_CLOSED;
 132
 133         devc = sdi->priv;
 134
 135         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 136 }
 137
 138 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 139                 const struct sr_channel_group *cg)
 140 {
 141         (void)cg;
 142
 143         switch (key) {
 144         case SR_CONF_SCAN_OPTIONS:
 145                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 146                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 147                 break;
 148         case SR_CONF_DEVICE_OPTIONS:
 149                 if (!sdi)
 150                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 151                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 152                 else
 153                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 154                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 155                 break;
 156         default:
 157                 return SR_ERR_NA;
 158         }
 159
 160         return SR_OK;
 161 }
 162
 163 static int dev_acquisition_start(const struct sr_dev_inst *sdi, int idx)
 164 {
 165         struct dev_context *devc;
 166         struct sr_serial_dev_inst *serial;
 167
 168         if (sdi->status != SR_ST_ACTIVE)
 169                 return SR_ERR_DEV_CLOSED;
 170
 171         devc = sdi->priv;
 172
 173         sr_sw_limits_acquisition_start(&devc->sw_limits);
 174
 175         std_session_send_df_header(sdi);
 176
 177         /* Poll every 500ms, or whenever some data comes in. */
 178         serial = sdi->conn;
 179         serial_source_add(sdi->session, serial, G_IO_IN, 500,
 180                       center_devs[idx].receive_data, (void *)sdi);
 181
 182         return SR_OK;
 183 }
 184
 185 /* Driver-specific API function wrappers */
 186 #define HW_SCAN(X) \
 187 static GSList *scan_##X(struct sr_dev_driver *d, GSList *options) { \
 188         (void)d; return scan(options, X); }
 189 #define HW_DEV_ACQUISITION_START(X) \
 190 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi \
 191 ) { return dev_acquisition_start(sdi, X); }
 192
 193 /* Driver structs and API function wrappers */
 194 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
 195 HW_SCAN(ID_UPPER) \
 196 HW_DEV_ACQUISITION_START(ID_UPPER) \
 197 static struct sr_dev_driver ID##_driver_info = { \
 198         .name = NAME, \
 199         .longname = LONGNAME, \
 200         .api_version = 1, \
 201         .init = std_init, \
 202         .cleanup = std_cleanup, \
 203         .scan = scan_##ID_UPPER, \
 204         .dev_list = std_dev_list, \
 205         .config_get = NULL, \
 206         .config_set = config_set, \
 207         .config_list = config_list, \
 208         .dev_open = std_serial_dev_open, \
 209         .dev_close = std_serial_dev_close, \
 210         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
 211         .dev_acquisition_stop = std_serial_dev_acquisition_stop, \
 212         .context = NULL, \
 213 }; \
 214 SR_REGISTER_DEV_DRIVER(ID##_driver_info);
 215
 216 DRV(center_309, CENTER_309, "center-309", "Center 309")
 217 DRV(voltcraft_k204, VOLTCRAFT_K204, "voltcraft-k204", "Voltcraft K204")