src/hardware/demo/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
   6  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
   7  * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #include <config.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <math.h>
  27 #include <libsigrok/libsigrok.h>
  28 #include "libsigrok-internal.h"
  29 #include "protocol.h"
  30
  31 #define DEFAULT_NUM_LOGIC_CHANNELS      8
  32 #define DEFAULT_ENABLED_LOGIC_CHANNELS  8
  33 #define DEFAULT_LOGIC_PATTERN           PATTERN_SIGROK
  34
  35 #define DEFAULT_NUM_ANALOG_CHANNELS     4
  36 #define DEFAULT_ENABLED_ANALOG_CHANNELS 4
  37 #define DEFAULT_ANALOG_AMPLITUDE        10
  38
  39 static const char *logic_pattern_str[] = {
  40         "sigrok",
  41         "random",
  42         "incremental",
  43         "walking one",
  44         "walking zero",
  45         "all-low",
  46         "all-high",
  47         "squid",
  48 };
  49
  50 static const uint32_t drvopts[] = {
  51         SR_CONF_DEMO_DEV,
  52         SR_CONF_LOGIC_ANALYZER,
  53         SR_CONF_OSCILLOSCOPE,
  54 };
  55
  56 static const uint32_t scanopts[] = {
  57         SR_CONF_NUM_LOGIC_CHANNELS,
  58         SR_CONF_NUM_ANALOG_CHANNELS,
  59 };
  60
  61 static const uint32_t devopts[] = {
  62         SR_CONF_CONTINUOUS,
  63         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  64         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  65         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  66         SR_CONF_AVERAGING | SR_CONF_GET | SR_CONF_SET,
  67         SR_CONF_AVG_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  68 };
  69
  70 static const uint32_t devopts_cg_logic[] = {
  71         SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  72 };
  73
  74 static const uint32_t devopts_cg_analog_group[] = {
  75         SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
  76 };
  77
  78 static const uint32_t devopts_cg_analog_channel[] = {
  79         SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  80         SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
  81 };
  82
  83 static const uint64_t samplerates[] = {
  84         SR_HZ(1),
  85         SR_GHZ(1),
  86         SR_HZ(1),
  87 };
  88
  89 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  90 {
  91         struct dev_context *devc;
  92         struct sr_dev_inst *sdi;
  93         struct sr_channel *ch;
  94         struct sr_channel_group *cg, *acg;
  95         struct sr_config *src;
  96         struct analog_gen *ag;
  97         GSList *l;
  98         int num_logic_channels, num_analog_channels, pattern, i;
  99         char channel_name[16];
 100         gboolean enabled;
 101
 102         num_logic_channels = DEFAULT_NUM_LOGIC_CHANNELS;
 103         num_analog_channels = DEFAULT_NUM_ANALOG_CHANNELS;
 104         for (l = options; l; l = l->next) {
 105                 src = l->data;
 106                 switch (src->key) {
 107                 case SR_CONF_NUM_LOGIC_CHANNELS:
 108                         num_logic_channels = g_variant_get_int32(src->data);
 109                         break;
 110                 case SR_CONF_NUM_ANALOG_CHANNELS:
 111                         num_analog_channels = g_variant_get_int32(src->data);
 112                         break;
 113                 }
 114         }
 115
 116         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 117         sdi->status = SR_ST_INACTIVE;
 118         sdi->model = g_strdup("Demo device");
 119
 120         devc = g_malloc0(sizeof(struct dev_context));
 121         devc->cur_samplerate = SR_KHZ(200);
 122         devc->num_logic_channels = num_logic_channels;
 123         devc->logic_unitsize = (devc->num_logic_channels + 7) / 8;
 124         devc->logic_pattern = DEFAULT_LOGIC_PATTERN;
 125         devc->num_analog_channels = num_analog_channels;
 126
 127         if (num_logic_channels > 0) {
 128                 /* Logic channels, all in one channel group. */
 129                 cg = g_malloc0(sizeof(struct sr_channel_group));
 130                 cg->name = g_strdup("Logic");
 131                 for (i = 0; i < num_logic_channels; i++) {
 132                         sprintf(channel_name, "D%d", i);
 133                         enabled = (i < DEFAULT_ENABLED_LOGIC_CHANNELS) ? TRUE : FALSE;
 134                         ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, enabled, channel_name);
 135                         cg->channels = g_slist_append(cg->channels, ch);
 136                 }
 137                 sdi->channel_groups = g_slist_append(NULL, cg);
 138         }
 139
 140         /* Analog channels, channel groups and pattern generators. */
 141         if (num_analog_channels > 0) {
 142                 pattern = 0;
 143                 /* An "Analog" channel group with all analog channels in it. */
 144                 acg = g_malloc0(sizeof(struct sr_channel_group));
 145                 acg->name = g_strdup("Analog");
 146                 sdi->channel_groups = g_slist_append(sdi->channel_groups, acg);
 147
 148                 devc->ch_ag = g_hash_table_new(g_direct_hash, g_direct_equal);
 149                 for (i = 0; i < num_analog_channels; i++) {
 150                         snprintf(channel_name, 16, "A%d", i);
 151                         enabled = (i < DEFAULT_ENABLED_ANALOG_CHANNELS) ? TRUE : FALSE;
 152                         ch = sr_channel_new(sdi, i + num_logic_channels, SR_CHANNEL_ANALOG,
 153                                         enabled, channel_name);
 154                         acg->channels = g_slist_append(acg->channels, ch);
 155
 156                         /* Every analog channel gets its own channel group as well. */
 157                         cg = g_malloc0(sizeof(struct sr_channel_group));
 158                         cg->name = g_strdup(channel_name);
 159                         cg->channels = g_slist_append(NULL, ch);
 160                         sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 161
 162                         /* Every channel gets a generator struct. */
 163                         ag = g_malloc(sizeof(struct analog_gen));
 164                         ag->amplitude = DEFAULT_ANALOG_AMPLITUDE;
 165                         sr_analog_init(&ag->packet, &ag->encoding, &ag->meaning, &ag->spec, 2);
 166                         ag->packet.meaning->channels = cg->channels;
 167                         ag->packet.meaning->mq = 0;
 168                         ag->packet.meaning->mqflags = 0;
 169                         ag->packet.meaning->unit = SR_UNIT_VOLT;
 170                         ag->packet.data = ag->pattern_data;
 171                         ag->pattern = pattern;
 172                         ag->avg_val = 0.0f;
 173                         ag->num_avgs = 0;
 174                         g_hash_table_insert(devc->ch_ag, ch, ag);
 175
 176                         if (++pattern == ARRAY_SIZE(analog_pattern_str))
 177                                 pattern = 0;
 178                 }
 179         }
 180
 181         sdi->priv = devc;
 182
 183         return std_scan_complete(di, g_slist_append(NULL, sdi));
 184 }
 185
 186 static int dev_open(struct sr_dev_inst *sdi)
 187 {
 188         sdi->status = SR_ST_ACTIVE;
 189
 190         return SR_OK;
 191 }
 192
 193 static int dev_close(struct sr_dev_inst *sdi)
 194 {
 195         sdi->status = SR_ST_INACTIVE;
 196
 197         return SR_OK;
 198 }
 199
 200 static void clear_helper(void *priv)
 201 {
 202         struct dev_context *devc;
 203         GHashTableIter iter;
 204         void *value;
 205
 206         devc = priv;
 207
 208         /* Analog generators. */
 209         g_hash_table_iter_init(&iter, devc->ch_ag);
 210         while (g_hash_table_iter_next(&iter, NULL, &value))
 211                 g_free(value);
 212         g_hash_table_unref(devc->ch_ag);
 213         g_free(devc);
 214 }
 215
 216 static int dev_clear(const struct sr_dev_driver *di)
 217 {
 218         return std_dev_clear(di, clear_helper);
 219 }
 220
 221 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 222                 const struct sr_channel_group *cg)
 223 {
 224         struct dev_context *devc;
 225         struct sr_channel *ch;
 226         struct analog_gen *ag;
 227         int pattern;
 228
 229         if (!sdi)
 230                 return SR_ERR_ARG;
 231
 232         devc = sdi->priv;
 233         switch (key) {
 234         case SR_CONF_SAMPLERATE:
 235                 *data = g_variant_new_uint64(devc->cur_samplerate);
 236                 break;
 237         case SR_CONF_LIMIT_SAMPLES:
 238                 *data = g_variant_new_uint64(devc->limit_samples);
 239                 break;
 240         case SR_CONF_LIMIT_MSEC:
 241                 *data = g_variant_new_uint64(devc->limit_msec);
 242                 break;
 243         case SR_CONF_AVERAGING:
 244                 *data = g_variant_new_boolean(devc->avg);
 245                 break;
 246         case SR_CONF_AVG_SAMPLES:
 247                 *data = g_variant_new_uint64(devc->avg_samples);
 248                 break;
 249         case SR_CONF_PATTERN_MODE:
 250                 if (!cg)
 251                         return SR_ERR_CHANNEL_GROUP;
 252                 /* Any channel in the group will do. */
 253                 ch = cg->channels->data;
 254                 if (ch->type == SR_CHANNEL_LOGIC) {
 255                         pattern = devc->logic_pattern;
 256                         *data = g_variant_new_string(logic_pattern_str[pattern]);
 257                 } else if (ch->type == SR_CHANNEL_ANALOG) {
 258                         ag = g_hash_table_lookup(devc->ch_ag, ch);
 259                         pattern = ag->pattern;
 260                         *data = g_variant_new_string(analog_pattern_str[pattern]);
 261                 } else
 262                         return SR_ERR_BUG;
 263                 break;
 264         case SR_CONF_AMPLITUDE:
 265                 if (!cg)
 266                         return SR_ERR_CHANNEL_GROUP;
 267                 /* Any channel in the group will do. */
 268                 ch = cg->channels->data;
 269                 if (ch->type != SR_CHANNEL_ANALOG)
 270                         return SR_ERR_ARG;
 271                 ag = g_hash_table_lookup(devc->ch_ag, ch);
 272                 *data = g_variant_new_double(ag->amplitude);
 273                 break;
 274         default:
 275                 return SR_ERR_NA;
 276         }
 277
 278         return SR_OK;
 279 }
 280
 281 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 282                 const struct sr_channel_group *cg)
 283 {
 284         struct dev_context *devc;
 285         struct analog_gen *ag;
 286         struct sr_channel *ch;
 287         GSList *l;
 288         int logic_pattern, analog_pattern, ret;
 289         unsigned int i;
 290         const char *stropt;
 291
 292         devc = sdi->priv;
 293
 294         if (sdi->status != SR_ST_ACTIVE)
 295                 return SR_ERR_DEV_CLOSED;
 296
 297         ret = SR_OK;
 298         switch (key) {
 299         case SR_CONF_SAMPLERATE:
 300                 devc->cur_samplerate = g_variant_get_uint64(data);
 301                 break;
 302         case SR_CONF_LIMIT_SAMPLES:
 303                 devc->limit_msec = 0;
 304                 devc->limit_samples = g_variant_get_uint64(data);
 305                 break;
 306         case SR_CONF_LIMIT_MSEC:
 307                 devc->limit_msec = g_variant_get_uint64(data);
 308                 devc->limit_samples = 0;
 309                 break;
 310         case SR_CONF_AVERAGING:
 311                 devc->avg = g_variant_get_boolean(data);
 312                 sr_dbg("%s averaging", devc->avg ? "Enabling" : "Disabling");
 313                 break;
 314         case SR_CONF_AVG_SAMPLES:
 315                 devc->avg_samples = g_variant_get_uint64(data);
 316                 sr_dbg("Setting averaging rate to %" PRIu64, devc->avg_samples);
 317                 break;
 318         case SR_CONF_PATTERN_MODE:
 319                 if (!cg)
 320                         return SR_ERR_CHANNEL_GROUP;
 321                 stropt = g_variant_get_string(data, NULL);
 322                 logic_pattern = analog_pattern = -1;
 323                 for (i = 0; i < ARRAY_SIZE(logic_pattern_str); i++) {
 324                         if (!strcmp(stropt, logic_pattern_str[i])) {
 325                                 logic_pattern = i;
 326                                 break;
 327                         }
 328                 }
 329                 for (i = 0; i < ARRAY_SIZE(analog_pattern_str); i++) {
 330                         if (!strcmp(stropt, analog_pattern_str[i])) {
 331                                 analog_pattern = i;
 332                                 break;
 333                         }
 334                 }
 335                 if (logic_pattern == -1 && analog_pattern == -1)
 336                         return SR_ERR_ARG;
 337                 for (l = cg->channels; l; l = l->next) {
 338                         ch = l->data;
 339                         if (ch->type == SR_CHANNEL_LOGIC) {
 340                                 if (logic_pattern == -1)
 341                                         return SR_ERR_ARG;
 342                                 sr_dbg("Setting logic pattern to %s",
 343                                                 logic_pattern_str[logic_pattern]);
 344                                 devc->logic_pattern = logic_pattern;
 345                                 /* Might as well do this now, these are static. */
 346                                 if (logic_pattern == PATTERN_ALL_LOW)
 347                                         memset(devc->logic_data, 0x00, LOGIC_BUFSIZE);
 348                                 else if (logic_pattern == PATTERN_ALL_HIGH)
 349                                         memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
 350                         } else if (ch->type == SR_CHANNEL_ANALOG) {
 351                                 if (analog_pattern == -1)
 352                                         return SR_ERR_ARG;
 353                                 sr_dbg("Setting analog pattern for channel %s to %s",
 354                                                 ch->name, analog_pattern_str[analog_pattern]);
 355                                 ag = g_hash_table_lookup(devc->ch_ag, ch);
 356                                 ag->pattern = analog_pattern;
 357                         } else
 358                                 return SR_ERR_BUG;
 359                 }
 360                 break;
 361         case SR_CONF_AMPLITUDE:
 362                 if (!cg)
 363                         return SR_ERR_CHANNEL_GROUP;
 364                 for (l = cg->channels; l; l = l->next) {
 365                         ch = l->data;
 366                         if (ch->type != SR_CHANNEL_ANALOG)
 367                                 return SR_ERR_ARG;
 368                         ag = g_hash_table_lookup(devc->ch_ag, ch);
 369                         ag->amplitude = g_variant_get_double(data);
 370                 }
 371                 break;
 372         default:
 373                 ret = SR_ERR_NA;
 374         }
 375
 376         return ret;
 377 }
 378
 379 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 380                 const struct sr_channel_group *cg)
 381 {
 382         struct sr_channel *ch;
 383         GVariant *gvar;
 384         GVariantBuilder gvb;
 385
 386         if (key == SR_CONF_SCAN_OPTIONS) {
 387                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 388                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 389                 return SR_OK;
 390         }
 391
 392         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 393                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 394                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 395                 return SR_OK;
 396         }
 397
 398         if (!sdi)
 399                 return SR_ERR_ARG;
 400
 401         if (!cg) {
 402                 switch (key) {
 403                 case SR_CONF_DEVICE_OPTIONS:
 404                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 405                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 406                         break;
 407                 case SR_CONF_SAMPLERATE:
 408                         g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 409                         gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 410                                         ARRAY_SIZE(samplerates), sizeof(uint64_t));
 411                         g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 412                         *data = g_variant_builder_end(&gvb);
 413                         break;
 414                 default:
 415                         return SR_ERR_NA;
 416                 }
 417         } else {
 418                 ch = cg->channels->data;
 419                 switch (key) {
 420                 case SR_CONF_DEVICE_OPTIONS:
 421                         if (ch->type == SR_CHANNEL_LOGIC)
 422                                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 423                                                 devopts_cg_logic, ARRAY_SIZE(devopts_cg_logic),
 424                                                 sizeof(uint32_t));
 425                         else if (ch->type == SR_CHANNEL_ANALOG) {
 426                                 if (strcmp(cg->name, "Analog") == 0)
 427                                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 428                                                         devopts_cg_analog_group, ARRAY_SIZE(devopts_cg_analog_group),
 429                                                         sizeof(uint32_t));
 430                                 else
 431                                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 432                                                         devopts_cg_analog_channel, ARRAY_SIZE(devopts_cg_analog_channel),
 433                                                         sizeof(uint32_t));
 434                         }
 435                         else
 436                                 return SR_ERR_BUG;
 437                         break;
 438                 case SR_CONF_PATTERN_MODE:
 439                         /* The analog group (with all 4 channels) shall not have a pattern property. */
 440                         if (strcmp(cg->name, "Analog") == 0)
 441                                 return SR_ERR_NA;
 442
 443                         if (ch->type == SR_CHANNEL_LOGIC)
 444                                 *data = g_variant_new_strv(logic_pattern_str,
 445                                                 ARRAY_SIZE(logic_pattern_str));
 446                         else if (ch->type == SR_CHANNEL_ANALOG)
 447                                 *data = g_variant_new_strv(analog_pattern_str,
 448                                                 ARRAY_SIZE(analog_pattern_str));
 449                         else
 450                                 return SR_ERR_BUG;
 451                         break;
 452                 default:
 453                         return SR_ERR_NA;
 454                 }
 455         }
 456
 457         return SR_OK;
 458 }
 459
 460 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 461 {
 462         struct dev_context *devc;
 463         GHashTableIter iter;
 464         void *value;
 465
 466         if (sdi->status != SR_ST_ACTIVE)
 467                 return SR_ERR_DEV_CLOSED;
 468
 469         devc = sdi->priv;
 470         devc->sent_samples = 0;
 471
 472         g_hash_table_iter_init(&iter, devc->ch_ag);
 473         while (g_hash_table_iter_next(&iter, NULL, &value))
 474                 demo_generate_analog_pattern(value, devc->cur_samplerate);
 475
 476         sr_session_source_add(sdi->session, -1, 0, 100,
 477                         demo_prepare_data, (struct sr_dev_inst *)sdi);
 478
 479         std_session_send_df_header(sdi);
 480
 481         /* We use this timestamp to decide how many more samples to send. */
 482         devc->start_us = g_get_monotonic_time();
 483         devc->spent_us = 0;
 484         devc->step = 0;
 485
 486         return SR_OK;
 487 }
 488
 489 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 490 {
 491         sr_dbg("Stopping acquisition.");
 492         sr_session_source_remove(sdi->session, -1);
 493         std_session_send_df_end(sdi);
 494
 495         return SR_OK;
 496 }
 497
 498 static struct sr_dev_driver demo_driver_info = {
 499         .name = "demo",
 500         .longname = "Demo driver and pattern generator",
 501         .api_version = 1,
 502         .init = std_init,
 503         .cleanup = std_cleanup,
 504         .scan = scan,
 505         .dev_list = std_dev_list,
 506         .dev_clear = dev_clear,
 507         .config_get = config_get,
 508         .config_set = config_set,
 509         .config_list = config_list,
 510         .dev_open = dev_open,
 511         .dev_close = dev_close,
 512         .dev_acquisition_start = dev_acquisition_start,
 513         .dev_acquisition_stop = dev_acquisition_stop,
 514         .context = NULL,
 515 };
 516 SR_REGISTER_DEV_DRIVER(demo_driver_info);