src/hardware/appa-55ii/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
   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 3 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 <string.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_GET | SR_CONF_SET,
  36         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  37         SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  38 };
  39
  40 static const char *data_sources[] = {
  41         "Live",
  42         "Memory",
  43 };
  44
  45 SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
  46
  47 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  48 {
  49         struct drv_context *drvc;
  50         struct dev_context *devc;
  51         struct sr_serial_dev_inst *serial;
  52         struct sr_dev_inst *sdi;
  53         struct sr_config *src;
  54         GSList *devices, *l;
  55         const char *conn, *serialcomm;
  56         uint8_t buf[50];
  57         size_t len;
  58
  59         len = sizeof(buf);
  60         devices = NULL;
  61         conn = serialcomm = NULL;
  62         for (l = options; l; l = l->next) {
  63                 src = l->data;
  64                 switch (src->key) {
  65                 case SR_CONF_CONN:
  66                         conn = g_variant_get_string(src->data, NULL);
  67                         break;
  68                 case SR_CONF_SERIALCOMM:
  69                         serialcomm = g_variant_get_string(src->data, NULL);
  70                         break;
  71                 }
  72         }
  73         if (!conn)
  74                 return NULL;
  75         if (!serialcomm)
  76                 serialcomm = "9600/8n1";
  77
  78         serial = sr_serial_dev_inst_new(conn, serialcomm);
  79
  80         if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
  81                 return NULL;
  82
  83         sr_info("Probing serial port %s.", conn);
  84
  85         drvc = di->context;
  86         drvc->instances = NULL;
  87         serial_flush(serial);
  88
  89         /* Let's get a bit of data and see if we can find a packet. */
  90         if (serial_stream_detect(serial, buf, &len, 25,
  91                         appa_55ii_packet_valid, 500, 9600) != SR_OK)
  92                 goto scan_cleanup;
  93
  94         sr_info("Found device on port %s.", conn);
  95
  96         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  97         sdi->status = SR_ST_INACTIVE;
  98         sdi->vendor = g_strdup("APPA");
  99         sdi->model = g_strdup("55II");
 100         devc = g_malloc0(sizeof(struct dev_context));
 101         devc->data_source = DEFAULT_DATA_SOURCE;
 102         sdi->inst_type = SR_INST_SERIAL;
 103         sdi->conn = serial;
 104         sdi->priv = devc;
 105         sdi->driver = di;
 106
 107         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "T1");
 108         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "T2");
 109
 110         drvc->instances = g_slist_append(drvc->instances, sdi);
 111         devices = g_slist_append(devices, sdi);
 112
 113 scan_cleanup:
 114         serial_close(serial);
 115
 116         return devices;
 117 }
 118
 119 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 120                 const struct sr_channel_group *cg)
 121 {
 122         struct dev_context *devc = sdi->priv;
 123
 124         (void)cg;
 125
 126         switch (key) {
 127         case SR_CONF_LIMIT_SAMPLES:
 128         case SR_CONF_LIMIT_MSEC:
 129                 return sr_sw_limits_config_get(&devc->limits, key, data);
 130         case SR_CONF_DATA_SOURCE:
 131                 *data = g_variant_new_string(data_sources[devc->data_source]);
 132                 break;
 133         default:
 134                 return SR_ERR_NA;
 135         }
 136
 137         return SR_OK;
 138 }
 139
 140 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 141                 const struct sr_channel_group *cg)
 142 {
 143         struct dev_context *devc;
 144         const char *tmp_str;
 145         unsigned int i;
 146
 147         (void)cg;
 148
 149         if (sdi->status != SR_ST_ACTIVE)
 150                 return SR_ERR_DEV_CLOSED;
 151
 152         if (!(devc = sdi->priv)) {
 153                 sr_err("sdi->priv was NULL.");
 154                 return SR_ERR_BUG;
 155         }
 156
 157         switch (key) {
 158         case SR_CONF_LIMIT_SAMPLES:
 159                 return sr_sw_limits_config_set(&devc->limits, key, data);
 160         case SR_CONF_DATA_SOURCE: {
 161                 tmp_str = g_variant_get_string(data, NULL);
 162                 for (i = 0; i < ARRAY_SIZE(data_sources); i++)
 163                         if (!strcmp(tmp_str, data_sources[i])) {
 164                                 devc->data_source = i;
 165                                 break;
 166                         }
 167                 if (i == ARRAY_SIZE(data_sources))
 168                         return SR_ERR;
 169                 break;
 170         }
 171         default:
 172                 return SR_ERR_NA;
 173         }
 174
 175         return SR_OK;
 176 }
 177
 178 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 179                 const struct sr_channel_group *cg)
 180 {
 181         (void)cg;
 182
 183         switch (key) {
 184         case SR_CONF_SCAN_OPTIONS:
 185                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 186                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 187                 break;
 188         case SR_CONF_DEVICE_OPTIONS:
 189                 if (!sdi)
 190                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 191                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 192                 else
 193                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 194                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 195                 break;
 196         case SR_CONF_DATA_SOURCE:
 197                 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
 198                 break;
 199         default:
 200                 return SR_ERR_NA;
 201         }
 202
 203         return SR_OK;
 204 }
 205
 206 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 207 {
 208         struct sr_serial_dev_inst *serial;
 209         struct dev_context *devc;
 210
 211         serial = sdi->conn;
 212         if (sdi->status != SR_ST_ACTIVE)
 213                 return SR_ERR_DEV_CLOSED;
 214
 215         devc = sdi->priv;
 216
 217         sr_sw_limits_acquisition_start(&devc->limits);
 218
 219         std_session_send_df_header(sdi, LOG_PREFIX);
 220
 221         /* Poll every 50ms, or whenever some data comes in. */
 222         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 223                         appa_55ii_receive_data, (void *)sdi);
 224
 225         return SR_OK;
 226 }
 227
 228 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 229 {
 230         return std_serial_dev_acquisition_stop(sdi,
 231                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 232 }
 233
 234 SR_PRIV struct sr_dev_driver appa_55ii_driver_info = {
 235         .name = "appa-55ii",
 236         .longname = "APPA 55II",
 237         .api_version = 1,
 238         .init = std_init,
 239         .cleanup = std_cleanup,
 240         .scan = scan,
 241         .dev_list = std_dev_list,
 242         .dev_clear = NULL,
 243         .config_get = config_get,
 244         .config_set = config_set,
 245         .config_list = config_list,
 246         .dev_open = std_serial_dev_open,
 247         .dev_close = std_serial_dev_close,
 248         .dev_acquisition_start = dev_acquisition_start,
 249         .dev_acquisition_stop = dev_acquisition_stop,
 250         .context = NULL,
 251 };