src/hardware/brymen-dmm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
   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 devopts[] = {
  29         SR_CONF_MULTIMETER,
  30         SR_CONF_CONTINUOUS,
  31         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  32         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  33 };
  34
  35 static GSList *brymen_scan(struct sr_dev_driver *di, const char *conn,
  36         const char *serialcomm)
  37 {
  38         struct sr_dev_inst *sdi;
  39         struct dev_context *devc;
  40         struct drv_context *drvc;
  41         struct sr_serial_dev_inst *serial;
  42         GSList *devices;
  43         int ret;
  44         uint8_t buf[128];
  45         size_t len;
  46
  47         serial = sr_serial_dev_inst_new(conn, serialcomm);
  48
  49         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  50                 return NULL;
  51
  52         sr_info("Probing port %s.", conn);
  53
  54         devices = NULL;
  55
  56         /* Request reading */
  57         if ((ret = brymen_packet_request(serial)) < 0) {
  58                 sr_err("Unable to send command: %d.", ret);
  59                 goto scan_cleanup;
  60         }
  61
  62         len = 128;
  63         ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
  64                              brymen_packet_is_valid, 1000, 9600);
  65         if (ret != SR_OK)
  66                 goto scan_cleanup;
  67
  68         sr_info("Found device on port %s.", conn);
  69
  70         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  71         sdi->status = SR_ST_INACTIVE;
  72         sdi->vendor = g_strdup("Brymen");
  73         sdi->model = g_strdup("BM85x");
  74         devc = g_malloc0(sizeof(struct dev_context));
  75         sr_sw_limits_init(&devc->sw_limits);
  76         sdi->inst_type = SR_INST_SERIAL;
  77         sdi->conn = serial;
  78         drvc = di->context;
  79         sdi->priv = devc;
  80         sdi->driver = di;
  81         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
  82         drvc->instances = g_slist_append(drvc->instances, sdi);
  83         devices = g_slist_append(devices, sdi);
  84
  85 scan_cleanup:
  86         serial_close(serial);
  87
  88         return devices;
  89 }
  90
  91 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  92 {
  93         struct drv_context *drvc;
  94         struct sr_config *src;
  95         GSList *devices, *l;
  96         const char *conn, *serialcomm;
  97
  98         devices = NULL;
  99         drvc = di->context;
 100         drvc->instances = NULL;
 101
 102         conn = serialcomm = NULL;
 103         for (l = options; l; l = l->next) {
 104                 src = l->data;
 105                 switch (src->key) {
 106                 case SR_CONF_CONN:
 107                         conn = g_variant_get_string(src->data, NULL);
 108                         break;
 109                 case SR_CONF_SERIALCOMM:
 110                         serialcomm = g_variant_get_string(src->data, NULL);
 111                         break;
 112                 }
 113         }
 114         if (!conn)
 115                 return NULL;
 116
 117         if (serialcomm) {
 118                 /* Use the provided comm specs. */
 119                 devices = brymen_scan(di, conn, serialcomm);
 120         } else {
 121                 /* But 9600/8n1 should work all of the time. */
 122                 devices = brymen_scan(di, conn, "9600/8n1/dtr=1/rts=1");
 123         }
 124
 125         return devices;
 126 }
 127
 128 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 129                 const struct sr_channel_group *cg)
 130 {
 131         struct dev_context *devc;
 132
 133         (void)cg;
 134
 135         if (sdi->status != SR_ST_ACTIVE)
 136                 return SR_ERR_DEV_CLOSED;
 137
 138         devc = sdi->priv;
 139
 140         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 141 }
 142
 143 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 144                 const struct sr_channel_group *cg)
 145 {
 146         (void)sdi;
 147         (void)cg;
 148
 149         switch (key) {
 150         case SR_CONF_SCAN_OPTIONS:
 151                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 152                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 153                 break;
 154         case SR_CONF_DEVICE_OPTIONS:
 155                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 156                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 157                 break;
 158         default:
 159                 return SR_ERR_NA;
 160         }
 161
 162         return SR_OK;
 163 }
 164
 165 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 166 {
 167         struct dev_context *devc;
 168         struct sr_serial_dev_inst *serial;
 169
 170         if (sdi->status != SR_ST_ACTIVE)
 171                 return SR_ERR_DEV_CLOSED;
 172
 173         devc = sdi->priv;
 174
 175         sr_sw_limits_acquisition_start(&devc->sw_limits);
 176         std_session_send_df_header(sdi, LOG_PREFIX);
 177
 178         /* Poll every 50ms, or whenever some data comes in. */
 179         serial = sdi->conn;
 180         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 181                         brymen_dmm_receive_data, (void *)sdi);
 182
 183         return SR_OK;
 184 }
 185
 186 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 187 {
 188         return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
 189                         sdi->conn, LOG_PREFIX);
 190 }
 191
 192 SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
 193         .name = "brymen-bm857",
 194         .longname = "Brymen BM857",
 195         .api_version = 1,
 196         .init = std_init,
 197         .cleanup = std_cleanup,
 198         .scan = scan,
 199         .dev_list = std_dev_list,
 200         .dev_clear = NULL,
 201         .config_get = NULL,
 202         .config_set = config_set,
 203         .config_list = config_list,
 204         .dev_open = std_serial_dev_open,
 205         .dev_close = std_serial_dev_close,
 206         .dev_acquisition_start = dev_acquisition_start,
 207         .dev_acquisition_stop = dev_acquisition_stop,
 208         .context = NULL,
 209 };