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