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