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