src/hardware/mastech-ms6514/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2019 Dave Buechi <db@pflutsch.ch>
   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 "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_GET | SR_CONF_SET,
  35         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  36         SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  37 };
  38
  39 static const char *channel_names[] = {
  40         "T1", "T2", "T1-T2",
  41 };
  42
  43 static const char *data_sources[] = {
  44         "Live", "Memory",
  45 };
  46
  47 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  48 {
  49         struct dev_context *devc;
  50         struct sr_serial_dev_inst *serial;
  51         struct sr_dev_inst *sdi;
  52         struct sr_config *src;
  53         GSList *devices, *l;
  54         const char *conn, *serialcomm;
  55         uint8_t buf[2 * MASTECH_MS6514_FRAME_SIZE];
  56         size_t len, i;
  57
  58         len = sizeof(buf);
  59         devices = NULL;
  60         conn = serialcomm = NULL;
  61         for (l = options; l; l = l->next) {
  62                 src = l->data;
  63                 switch (src->key) {
  64                 case SR_CONF_CONN:
  65                         conn = g_variant_get_string(src->data, NULL);
  66                         break;
  67                 case SR_CONF_SERIALCOMM:
  68                         serialcomm = g_variant_get_string(src->data, NULL);
  69                         break;
  70                 }
  71         }
  72         if (!conn)
  73                 return NULL;
  74         if (!serialcomm)
  75                 serialcomm = "9600/8n1";
  76
  77         serial = sr_serial_dev_inst_new(conn, serialcomm);
  78
  79         if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
  80                 return NULL;
  81
  82         sr_info("Probing serial port %s.", conn);
  83
  84         /* Let's get a bit of data and see if we can find a packet. */
  85         if (serial_stream_detect(serial, buf, &len, (2 * MASTECH_MS6514_FRAME_SIZE),
  86                         mastech_ms6514_packet_valid, 500) != SR_OK)
  87                 goto scan_cleanup;
  88
  89         sr_info("Found device on port %s.", conn);
  90
  91         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  92         sdi->status = SR_ST_INACTIVE;
  93         sdi->vendor = g_strdup("MASTECH");
  94         sdi->model = g_strdup("MS6514");
  95         devc = g_malloc0(sizeof(struct dev_context));
  96         devc->data_source = DEFAULT_DATA_SOURCE;
  97         sdi->inst_type = SR_INST_SERIAL;
  98         sdi->conn = serial;
  99         sdi->priv = devc;
 100
 101         for (i = 0; i < ARRAY_SIZE(channel_names); i++)
 102                 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
 103
 104         devices = g_slist_append(devices, sdi);
 105
 106 scan_cleanup:
 107         serial_close(serial);
 108
 109         return std_scan_complete(di, devices);
 110 }
 111
 112 static int config_get(uint32_t key, GVariant **data,
 113         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 114 {
 115         struct dev_context *devc = sdi->priv;
 116
 117         (void)cg;
 118
 119         switch (key) {
 120         case SR_CONF_LIMIT_SAMPLES:
 121         case SR_CONF_LIMIT_MSEC:
 122                 return sr_sw_limits_config_get(&devc->limits, key, data);
 123         case SR_CONF_DATA_SOURCE:
 124                 *data = g_variant_new_string(data_sources[devc->data_source]);
 125                 break;
 126         default:
 127                 return SR_ERR_NA;
 128         }
 129
 130         return SR_OK;
 131 }
 132
 133 static int config_set(uint32_t key, GVariant *data,
 134         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 135 {
 136         struct dev_context *devc;
 137         int idx;
 138
 139         (void)cg;
 140
 141         devc = sdi->priv;
 142
 143         switch (key) {
 144         case SR_CONF_LIMIT_SAMPLES:
 145         case SR_CONF_LIMIT_MSEC:
 146                 return sr_sw_limits_config_set(&devc->limits, key, data);
 147         case SR_CONF_DATA_SOURCE:
 148                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0)
 149                         return SR_ERR_ARG;
 150                 devc->data_source = idx;
 151                 break;
 152         default:
 153                 return SR_ERR_NA;
 154         }
 155
 156         return SR_OK;
 157 }
 158
 159 static int config_list(uint32_t key, GVariant **data,
 160         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 161 {
 162         switch (key) {
 163         case SR_CONF_SCAN_OPTIONS:
 164         case SR_CONF_DEVICE_OPTIONS:
 165                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 166         case SR_CONF_DATA_SOURCE:
 167                 *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
 168                 break;
 169         default:
 170                 return SR_ERR_NA;
 171         }
 172
 173         return SR_OK;
 174 }
 175
 176 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 177 {
 178         struct sr_serial_dev_inst *serial;
 179         struct dev_context *devc;
 180         uint8_t command;
 181
 182         serial = sdi->conn;
 183         devc = sdi->priv;
 184
 185         sr_sw_limits_acquisition_start(&devc->limits);
 186         std_session_send_df_header(sdi);
 187
 188         if (devc->data_source == DATA_SOURCE_MEMORY) {
 189                 command = CMD_GET_STORED;
 190                 serial_write_blocking(serial, &command, sizeof(command), 0);
 191         }
 192
 193         serial_source_add(sdi->session, serial, G_IO_IN, MASTECH_MS6514_BUF_SIZE,
 194                         mastech_ms6514_receive_data, (void *)sdi);
 195
 196         return SR_OK;
 197 }
 198
 199 static struct sr_dev_driver mastech_ms6514_driver_info = {
 200         .name = "mastech-ms6514",
 201         .longname = "MASTECH MS6514",
 202         .api_version = 1,
 203         .init = std_init,
 204         .cleanup = std_cleanup,
 205         .scan = scan,
 206         .dev_list = std_dev_list,
 207         .dev_clear = std_dev_clear,
 208         .config_get = config_get,
 209         .config_set = config_set,
 210         .config_list = config_list,
 211         .dev_open = std_serial_dev_open,
 212         .dev_close = std_serial_dev_close,
 213         .dev_acquisition_start = dev_acquisition_start,
 214         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 215         .context = NULL,
 216 };
 217 SR_REGISTER_DEV_DRIVER(mastech_ms6514_driver_info);