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         if (!sdi) {
 101                 sr_err("no possible to allocate sr_dev_inst");
 102                 return NULL;
 103         }
 104
 105         sdi->status = SR_ST_INACTIVE;
 106         sdi->vendor = g_strdup("ipdbg.org");
 107         sdi->model = g_strdup("IPDBG LA");
 108         sdi->version = g_strdup("v1.0");
 109         sdi->driver = di;
 110
 111         struct dev_context *devc = ipdbg_la_dev_new();
 112         sdi->priv = devc;
 113
 114         ipdbg_la_get_addrwidth_and_datawidth(tcp, devc);
 115
 116         sr_dbg("addr_width = %d, data_width = %d\n", devc->ADDR_WIDTH,
 117                 devc->DATA_WIDTH);
 118         sr_dbg("limit samples = %" PRIu64 "\n", devc->limit_samples_max);
 119
 120         for (uint32_t i = 0; i < devc->DATA_WIDTH; i++) {
 121                 const uint8_t buf_size = 16;
 122                 char buf[buf_size];
 123                 snprintf(buf, buf_size, "ch%d", i);
 124                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, buf);
 125         }
 126
 127         sdi->inst_type = SR_INST_USER;
 128         sdi->conn = tcp;
 129
 130         ipdbg_la_tcp_close(tcp);
 131
 132         devices = g_slist_append(devices, sdi);
 133
 134         return std_scan_complete(di, devices);
 135 }
 136
 137 static int dev_clear(const struct sr_dev_driver *di)
 138 {
 139         struct drv_context *drvc = di->context;
 140         struct sr_dev_inst *sdi;
 141         GSList *l;
 142
 143         if (drvc) {
 144                 for (l = drvc->instances; l; l = l->next) {
 145                         sdi = l->data;
 146                         struct ipdbg_la_tcp *tcp = sdi->conn;
 147                         if (tcp) {
 148                                 ipdbg_la_tcp_close(tcp);
 149                                 ipdbg_la_tcp_free(tcp);
 150                                 g_free(tcp);
 151                         }
 152                         sdi->conn = NULL;
 153                 }
 154         }
 155
 156         return std_dev_clear(di);
 157 }
 158
 159 static int dev_open(struct sr_dev_inst *sdi)
 160 {
 161         struct ipdbg_la_tcp *tcp = sdi->conn;
 162
 163         if (!tcp)
 164                 return SR_ERR;
 165
 166         if (ipdbg_la_tcp_open(tcp) != SR_OK)
 167                 return SR_ERR;
 168
 169         return SR_OK;
 170 }
 171
 172 static int dev_close(struct sr_dev_inst *sdi)
 173 {
 174         /* Should be called before a new call to scan(). */
 175         struct ipdbg_la_tcp *tcp = sdi->conn;
 176
 177         if (tcp)
 178                 ipdbg_la_tcp_close(tcp);
 179
 180         sdi->conn = NULL;
 181
 182         return SR_OK;
 183 }
 184
 185 static int config_get(uint32_t key, GVariant **data,
 186         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 187 {
 188         struct dev_context *devc = sdi->priv;
 189
 190         (void)cg;
 191
 192         switch (key) {
 193         case SR_CONF_CAPTURE_RATIO:
 194                 *data = g_variant_new_uint64(devc->capture_ratio);
 195                 break;
 196         case SR_CONF_LIMIT_SAMPLES:
 197                 *data = g_variant_new_uint64(devc->limit_samples);
 198                 break;
 199         default:
 200                 return SR_ERR_NA;
 201         }
 202
 203         return SR_OK;
 204 }
 205
 206 static int config_set(uint32_t key, GVariant *data,
 207         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 208 {
 209         struct dev_context *devc = sdi->priv;
 210
 211         (void)cg;
 212
 213         switch (key) {
 214         case SR_CONF_CAPTURE_RATIO:
 215                 devc->capture_ratio = g_variant_get_uint64(data);
 216                 break;
 217         case SR_CONF_LIMIT_SAMPLES:
 218                 devc->limit_samples = g_variant_get_uint64(data);
 219                 break;
 220         default:
 221                 return SR_ERR_NA;
 222         }
 223
 224         return SR_OK;
 225 }
 226
 227 static int config_list(uint32_t key, GVariant **data,
 228         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 229 {
 230         switch (key) {
 231         case SR_CONF_SCAN_OPTIONS:
 232         case SR_CONF_DEVICE_OPTIONS:
 233                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 234         case SR_CONF_TRIGGER_MATCH:
 235                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
 236                 break;
 237         default:
 238                 return SR_ERR_NA;
 239         }
 240
 241         return SR_OK;
 242 }
 243
 244 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 245 {
 246         return std_init(di, sr_ctx);
 247 }
 248
 249 static GSList *dev_list(const struct sr_dev_driver *di)
 250 {
 251         return ((struct drv_context *)(di->context))->instances;
 252 }
 253
 254 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 255 {
 256         struct ipdbg_la_tcp *tcp = sdi->conn;
 257         struct dev_context *devc = sdi->priv;
 258
 259         ipdbg_la_convert_trigger(sdi);
 260         ipdbg_la_send_trigger(devc, tcp);
 261         ipdbg_la_send_delay(devc, tcp);
 262
 263         /* If the device stops sending for longer than it takes to send a byte,
 264          * that means it's finished. But wait at least 100 ms to be safe.
 265          */
 266         sr_session_source_add(sdi->session, tcp->socket, G_IO_IN, 100,
 267                 ipdbg_la_receive_data, (struct sr_dev_inst *)sdi);
 268
 269         ipdbg_la_send_start(tcp);
 270
 271         return SR_OK;
 272 }
 273
 274 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 275 {
 276         struct ipdbg_la_tcp *tcp = sdi->conn;
 277         struct dev_context *devc = sdi->priv;
 278
 279         uint8_t byte;
 280
 281         if (devc->num_transfers > 0) {
 282                 while (devc->num_transfers <
 283                         (devc->limit_samples_max * devc->DATA_WIDTH_BYTES)) {
 284                         ipdbg_la_tcp_receive(tcp, &byte);
 285                         devc->num_transfers++;
 286                 }
 287         }
 288
 289         ipdbg_la_send_reset(tcp);
 290         ipdbg_la_abort_acquisition(sdi);
 291
 292         return SR_OK;
 293 }
 294
 295 SR_PRIV struct sr_dev_driver ipdbg_la_driver_info = {
 296         .name = "ipdbg-la",
 297         .longname = "IPDBG LA",
 298         .api_version = 1,
 299         .init = init,
 300         .cleanup = std_cleanup,
 301         .scan = scan,
 302         .dev_list = dev_list,
 303         .dev_clear = dev_clear,
 304         .config_get = config_get,
 305         .config_set = config_set,
 306         .config_list = config_list,
 307         .dev_open = dev_open,
 308         .dev_close = dev_close,
 309         .dev_acquisition_start = dev_acquisition_start,
 310         .dev_acquisition_stop = dev_acquisition_stop,
 311         .context = NULL,
 312 };
 313
 314 SR_REGISTER_DEV_DRIVER(ipdbg_la_driver_info);