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