src/hardware/ipdbg-la/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2016 Eva Kissling <eva.kissling@bluewin.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 drvopts[] = {
  24         SR_CONF_LOGIC_ANALYZER,
  25 };
  26
  27 static const uint32_t scanopts[] = {
  28         SR_CONF_CONN,
  29 };
  30
  31 static const uint32_t devopts[] = {
  32         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  33         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
  34         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  35 };
  36
  37 static const int32_t trigger_matches[] = {
  38         SR_TRIGGER_ZERO,
  39         SR_TRIGGER_ONE,
  40         SR_TRIGGER_RISING,
  41         SR_TRIGGER_FALLING,
  42         SR_TRIGGER_EDGE,
  43 };
  44
  45 SR_PRIV struct sr_dev_driver ipdbg_la_driver_info;
  46
  47 static void ipdbg_la_split_addr_port(const char *conn, char **addr,
  48         char **port)
  49 {
  50         char **strs = g_strsplit(conn, "/", 3);
  51
  52         *addr = g_strdup(strs[1]);
  53         *port = g_strdup(strs[2]);
  54
  55         g_strfreev(strs);
  56 }
  57
  58 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  59 {
  60         struct drv_context *drvc;
  61         GSList *devices;
  62
  63         devices = NULL;
  64         drvc = di->context;
  65         drvc->instances = NULL;
  66         const char *conn;
  67         struct sr_config *src;
  68         GSList *l;
  69
  70         conn = NULL;
  71         for (l = options; l; l = l->next) {
  72                 src = l->data;
  73                 switch (src->key) {
  74                 case SR_CONF_CONN:
  75                         conn = g_variant_get_string(src->data, NULL);
  76                         break;
  77                 }
  78         }
  79
  80         if (!conn)
  81                 return NULL;
  82
  83         struct ipdbg_la_tcp *tcp = ipdbg_la_tcp_new();
  84
  85         ipdbg_la_split_addr_port(conn, &tcp->address, &tcp->port);
  86
  87         if (!tcp->address)
  88                 return NULL;
  89
  90         if (ipdbg_la_tcp_open(tcp) != SR_OK)
  91                 return NULL;
  92
  93         ipdbg_la_send_reset(tcp);
  94         ipdbg_la_send_reset(tcp);
  95
  96         if (ipdbg_la_request_id(tcp) != SR_OK)
  97                 return NULL;
  98
  99         struct sr_dev_inst *sdi = g_malloc0(sizeof(struct sr_dev_inst));
 100         sdi->status = SR_ST_INACTIVE;
 101         sdi->vendor = g_strdup("ipdbg.org");
 102         sdi->model = g_strdup("IPDBG LA");
 103         sdi->version = g_strdup("v1.0");
 104         sdi->driver = di;
 105
 106         struct dev_context *devc = ipdbg_la_dev_new();
 107         sdi->priv = devc;
 108
 109         ipdbg_la_get_addrwidth_and_datawidth(tcp, devc);
 110
 111         sr_dbg("addr_width = %d, data_width = %d\n", devc->ADDR_WIDTH,
 112                 devc->DATA_WIDTH);
 113         sr_dbg("limit samples = %" PRIu64 "\n", devc->limit_samples_max);
 114
 115         for (uint32_t i = 0; i < devc->DATA_WIDTH; i++) {
 116                 const uint8_t buf_size = 16;
 117                 char buf[buf_size];
 118                 snprintf(buf, buf_size, "ch%d", i);
 119                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, buf);
 120         }
 121
 122         sdi->inst_type = SR_INST_USER;
 123         sdi->conn = tcp;
 124
 125         ipdbg_la_tcp_close(tcp);
 126
 127         devices = g_slist_append(devices, sdi);
 128
 129         return std_scan_complete(di, devices);
 130 }
 131
 132 static int dev_clear(const struct sr_dev_driver *di)
 133 {
 134         struct drv_context *drvc = di->context;
 135         struct sr_dev_inst *sdi;
 136         GSList *l;
 137
 138         if (drvc) {
 139                 for (l = drvc->instances; l; l = l->next) {
 140                         sdi = l->data;
 141                         struct ipdbg_la_tcp *tcp = sdi->conn;
 142                         if (tcp) {
 143                                 ipdbg_la_tcp_close(tcp);
 144                                 ipdbg_la_tcp_free(tcp);
 145                                 g_free(tcp);
 146                         }
 147                         sdi->conn = NULL;
 148                 }
 149         }
 150
 151         return std_dev_clear(di);
 152 }
 153
 154 static int dev_open(struct sr_dev_inst *sdi)
 155 {
 156         struct ipdbg_la_tcp *tcp = sdi->conn;
 157
 158         if (!tcp)
 159                 return SR_ERR;
 160
 161         if (ipdbg_la_tcp_open(tcp) != SR_OK)
 162                 return SR_ERR;
 163
 164         return SR_OK;
 165 }
 166
 167 static int dev_close(struct sr_dev_inst *sdi)
 168 {
 169         /* Should be called before a new call to scan(). */
 170         struct ipdbg_la_tcp *tcp = sdi->conn;
 171
 172         if (tcp)
 173                 ipdbg_la_tcp_close(tcp);
 174
 175         sdi->conn = NULL;
 176
 177         return SR_OK;
 178 }
 179
 180 static int config_get(uint32_t key, GVariant **data,
 181         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 182 {
 183         struct dev_context *devc = sdi->priv;
 184
 185         (void)cg;
 186
 187         switch (key) {
 188         case SR_CONF_CAPTURE_RATIO:
 189                 *data = g_variant_new_uint64(devc->capture_ratio);
 190                 break;
 191         case SR_CONF_LIMIT_SAMPLES:
 192                 *data = g_variant_new_uint64(devc->limit_samples);
 193                 break;
 194         default:
 195                 return SR_ERR_NA;
 196         }
 197
 198         return SR_OK;
 199 }
 200
 201 static int config_set(uint32_t key, GVariant *data,
 202         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 203 {
 204         struct dev_context *devc = sdi->priv;
 205
 206         (void)cg;
 207
 208         switch (key) {
 209         case SR_CONF_CAPTURE_RATIO:
 210                 devc->capture_ratio = g_variant_get_uint64(data);
 211                 break;
 212         case SR_CONF_LIMIT_SAMPLES:
 213                 devc->limit_samples = g_variant_get_uint64(data);
 214                 break;
 215         default:
 216                 return SR_ERR_NA;
 217         }
 218
 219         return SR_OK;
 220 }
 221
 222 static int config_list(uint32_t key, GVariant **data,
 223         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 224 {
 225         switch (key) {
 226         case SR_CONF_SCAN_OPTIONS:
 227         case SR_CONF_DEVICE_OPTIONS:
 228                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 229         case SR_CONF_TRIGGER_MATCH:
 230                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
 231                 break;
 232         default:
 233                 return SR_ERR_NA;
 234         }
 235
 236         return SR_OK;
 237 }
 238
 239 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 240 {
 241         return std_init(di, sr_ctx);
 242 }
 243
 244 static GSList *dev_list(const struct sr_dev_driver *di)
 245 {
 246         return ((struct drv_context *)(di->context))->instances;
 247 }
 248
 249 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 250 {
 251         struct ipdbg_la_tcp *tcp = sdi->conn;
 252         struct dev_context *devc = sdi->priv;
 253
 254         ipdbg_la_convert_trigger(sdi);
 255         ipdbg_la_send_trigger(devc, tcp);
 256         ipdbg_la_send_delay(devc, tcp);
 257
 258         /* If the device stops sending for longer than it takes to send a byte,
 259          * that means it's finished. But wait at least 100 ms to be safe.
 260          */
 261         sr_session_source_add(sdi->session, tcp->socket, G_IO_IN, 100,
 262                 ipdbg_la_receive_data, (struct sr_dev_inst *)sdi);
 263
 264         ipdbg_la_send_start(tcp);
 265
 266         return SR_OK;
 267 }
 268
 269 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 270 {
 271         struct ipdbg_la_tcp *tcp = sdi->conn;
 272         struct dev_context *devc = sdi->priv;
 273
 274         uint8_t byte;
 275
 276         if (devc->num_transfers > 0) {
 277                 while (devc->num_transfers <
 278                         (devc->limit_samples_max * devc->DATA_WIDTH_BYTES)) {
 279                         ipdbg_la_tcp_receive(tcp, &byte);
 280                         devc->num_transfers++;
 281                 }
 282         }
 283
 284         ipdbg_la_send_reset(tcp);
 285         ipdbg_la_abort_acquisition(sdi);
 286
 287         return SR_OK;
 288 }
 289
 290 SR_PRIV struct sr_dev_driver ipdbg_la_driver_info = {
 291         .name = "ipdbg-la",
 292         .longname = "IPDBG LA",
 293         .api_version = 1,
 294         .init = init,
 295         .cleanup = std_cleanup,
 296         .scan = scan,
 297         .dev_list = dev_list,
 298         .dev_clear = dev_clear,
 299         .config_get = config_get,
 300         .config_set = config_set,
 301         .config_list = config_list,
 302         .dev_open = dev_open,
 303         .dev_close = dev_close,
 304         .dev_acquisition_start = dev_acquisition_start,
 305         .dev_acquisition_stop = dev_acquisition_stop,
 306         .context = NULL,
 307 };
 308
 309 SR_REGISTER_DEV_DRIVER(ipdbg_la_driver_info);