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 scanopts[] = {
  50         SR_CONF_NUM_LOGIC_CHANNELS,
  51         SR_CONF_NUM_ANALOG_CHANNELS,
  52 };
  53
  54 static const uint32_t drvopts[] = {
  55         SR_CONF_DEMO_DEV,
  56         SR_CONF_LOGIC_ANALYZER,
  57         SR_CONF_OSCILLOSCOPE,
  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->ch = ch;
 161                         ag->amplitude = DEFAULT_ANALOG_AMPLITUDE;
 162                         sr_analog_init(&ag->packet, &ag->encoding, &ag->meaning, &ag->spec, 2);
 163                         ag->packet.meaning->channels = cg->channels;
 164                         ag->packet.meaning->mq = 0;
 165                         ag->packet.meaning->mqflags = 0;
 166                         ag->packet.meaning->unit = SR_UNIT_VOLT;
 167                         ag->packet.data = ag->pattern_data;
 168                         ag->pattern = pattern;
 169                         ag->avg_val = 0.0f;
 170                         ag->num_avgs = 0;
 171                         g_hash_table_insert(devc->ch_ag, ch, ag);
 172
 173                         if (++pattern == ARRAY_SIZE(analog_pattern_str))
 174                                 pattern = 0;
 175                 }
 176         }
 177
 178         sdi->priv = devc;
 179
 180         return std_scan_complete(di, g_slist_append(NULL, sdi));
 181 }
 182
 183 static void clear_helper(struct dev_context *devc)
 184 {
 185         GHashTableIter iter;
 186         void *value;
 187
 188         /* Analog generators. */
 189         g_hash_table_iter_init(&iter, devc->ch_ag);
 190         while (g_hash_table_iter_next(&iter, NULL, &value))
 191                 g_free(value);
 192         g_hash_table_unref(devc->ch_ag);
 193 }
 194
 195 static int dev_clear(const struct sr_dev_driver *di)
 196 {
 197         return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 198 }
 199
 200 static int config_get(uint32_t key, GVariant **data,
 201         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 202 {
 203         struct dev_context *devc;
 204         struct sr_channel *ch;
 205         struct analog_gen *ag;
 206         int pattern;
 207
 208         if (!sdi)
 209                 return SR_ERR_ARG;
 210
 211         devc = sdi->priv;
 212         switch (key) {
 213         case SR_CONF_SAMPLERATE:
 214                 *data = g_variant_new_uint64(devc->cur_samplerate);
 215                 break;
 216         case SR_CONF_LIMIT_SAMPLES:
 217                 *data = g_variant_new_uint64(devc->limit_samples);
 218                 break;
 219         case SR_CONF_LIMIT_MSEC:
 220                 *data = g_variant_new_uint64(devc->limit_msec);
 221                 break;
 222         case SR_CONF_AVERAGING:
 223                 *data = g_variant_new_boolean(devc->avg);
 224                 break;
 225         case SR_CONF_AVG_SAMPLES:
 226                 *data = g_variant_new_uint64(devc->avg_samples);
 227                 break;
 228         case SR_CONF_PATTERN_MODE:
 229                 if (!cg)
 230                         return SR_ERR_CHANNEL_GROUP;
 231                 /* Any channel in the group will do. */
 232                 ch = cg->channels->data;
 233                 if (ch->type == SR_CHANNEL_LOGIC) {
 234                         pattern = devc->logic_pattern;
 235                         *data = g_variant_new_string(logic_pattern_str[pattern]);
 236                 } else if (ch->type == SR_CHANNEL_ANALOG) {
 237                         ag = g_hash_table_lookup(devc->ch_ag, ch);
 238                         pattern = ag->pattern;
 239                         *data = g_variant_new_string(analog_pattern_str[pattern]);
 240                 } else
 241                         return SR_ERR_BUG;
 242                 break;
 243         case SR_CONF_AMPLITUDE:
 244                 if (!cg)
 245                         return SR_ERR_CHANNEL_GROUP;
 246                 /* Any channel in the group will do. */
 247                 ch = cg->channels->data;
 248                 if (ch->type != SR_CHANNEL_ANALOG)
 249                         return SR_ERR_ARG;
 250                 ag = g_hash_table_lookup(devc->ch_ag, ch);
 251                 *data = g_variant_new_double(ag->amplitude);
 252                 break;
 253         default:
 254                 return SR_ERR_NA;
 255         }
 256
 257         return SR_OK;
 258 }
 259
 260 static int config_set(uint32_t key, GVariant *data,
 261         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 262 {
 263         struct dev_context *devc;
 264         struct analog_gen *ag;
 265         struct sr_channel *ch;
 266         GSList *l;
 267         int logic_pattern, analog_pattern;
 268
 269         devc = sdi->priv;
 270
 271         switch (key) {
 272         case SR_CONF_SAMPLERATE:
 273                 devc->cur_samplerate = g_variant_get_uint64(data);
 274                 break;
 275         case SR_CONF_LIMIT_SAMPLES:
 276                 devc->limit_msec = 0;
 277                 devc->limit_samples = g_variant_get_uint64(data);
 278                 break;
 279         case SR_CONF_LIMIT_MSEC:
 280                 devc->limit_msec = g_variant_get_uint64(data);
 281                 devc->limit_samples = 0;
 282                 break;
 283         case SR_CONF_AVERAGING:
 284                 devc->avg = g_variant_get_boolean(data);
 285                 sr_dbg("%s averaging", devc->avg ? "Enabling" : "Disabling");
 286                 break;
 287         case SR_CONF_AVG_SAMPLES:
 288                 devc->avg_samples = g_variant_get_uint64(data);
 289                 sr_dbg("Setting averaging rate to %" PRIu64, devc->avg_samples);
 290                 break;
 291         case SR_CONF_PATTERN_MODE:
 292                 if (!cg)
 293                         return SR_ERR_CHANNEL_GROUP;
 294                 logic_pattern = std_str_idx(data, ARRAY_AND_SIZE(logic_pattern_str));
 295                 analog_pattern = std_str_idx(data, ARRAY_AND_SIZE(analog_pattern_str));
 296                 if (logic_pattern < 0 && analog_pattern < 0)
 297                         return SR_ERR_ARG;
 298                 for (l = cg->channels; l; l = l->next) {
 299                         ch = l->data;
 300                         if (ch->type == SR_CHANNEL_LOGIC) {
 301                                 if (logic_pattern == -1)
 302                                         return SR_ERR_ARG;
 303                                 sr_dbg("Setting logic pattern to %s",
 304                                                 logic_pattern_str[logic_pattern]);
 305                                 devc->logic_pattern = logic_pattern;
 306                                 /* Might as well do this now, these are static. */
 307                                 if (logic_pattern == PATTERN_ALL_LOW)
 308                                         memset(devc->logic_data, 0x00, LOGIC_BUFSIZE);
 309                                 else if (logic_pattern == PATTERN_ALL_HIGH)
 310                                         memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
 311                         } else if (ch->type == SR_CHANNEL_ANALOG) {
 312                                 if (analog_pattern == -1)
 313                                         return SR_ERR_ARG;
 314                                 sr_dbg("Setting analog pattern for channel %s to %s",
 315                                                 ch->name, analog_pattern_str[analog_pattern]);
 316                                 ag = g_hash_table_lookup(devc->ch_ag, ch);
 317                                 ag->pattern = analog_pattern;
 318                         } else
 319                                 return SR_ERR_BUG;
 320                 }
 321                 break;
 322         case SR_CONF_AMPLITUDE:
 323                 if (!cg)
 324                         return SR_ERR_CHANNEL_GROUP;
 325                 for (l = cg->channels; l; l = l->next) {
 326                         ch = l->data;
 327                         if (ch->type != SR_CHANNEL_ANALOG)
 328                                 return SR_ERR_ARG;
 329                         ag = g_hash_table_lookup(devc->ch_ag, ch);
 330                         ag->amplitude = g_variant_get_double(data);
 331                 }
 332                 break;
 333         default:
 334                 return SR_ERR_NA;
 335         }
 336
 337         return SR_OK;
 338 }
 339
 340 static int config_list(uint32_t key, GVariant **data,
 341         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 342 {
 343         struct sr_channel *ch;
 344
 345         if (!cg) {
 346                 switch (key) {
 347                 case SR_CONF_SCAN_OPTIONS:
 348                 case SR_CONF_DEVICE_OPTIONS:
 349                         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 350                 case SR_CONF_SAMPLERATE:
 351                         *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
 352                         break;
 353                 default:
 354                         return SR_ERR_NA;
 355                 }
 356         } else {
 357                 ch = cg->channels->data;
 358                 switch (key) {
 359                 case SR_CONF_DEVICE_OPTIONS:
 360                         if (ch->type == SR_CHANNEL_LOGIC)
 361                                 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_logic));
 362                         else if (ch->type == SR_CHANNEL_ANALOG) {
 363                                 if (strcmp(cg->name, "Analog") == 0)
 364                                         *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog_group));
 365                                 else
 366                                         *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog_channel));
 367                         }
 368                         else
 369                                 return SR_ERR_BUG;
 370                         break;
 371                 case SR_CONF_PATTERN_MODE:
 372                         /* The analog group (with all 4 channels) shall not have a pattern property. */
 373                         if (strcmp(cg->name, "Analog") == 0)
 374                                 return SR_ERR_NA;
 375
 376                         if (ch->type == SR_CHANNEL_LOGIC)
 377                                 *data = g_variant_new_strv(ARRAY_AND_SIZE(logic_pattern_str));
 378                         else if (ch->type == SR_CHANNEL_ANALOG)
 379                                 *data = g_variant_new_strv(ARRAY_AND_SIZE(analog_pattern_str));
 380                         else
 381                                 return SR_ERR_BUG;
 382                         break;
 383                 default:
 384                         return SR_ERR_NA;
 385                 }
 386         }
 387
 388         return SR_OK;
 389 }
 390
 391 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 392 {
 393         struct dev_context *devc;
 394         GSList *l;
 395         struct sr_channel *ch;
 396         int bitpos;
 397         uint8_t mask;
 398         GHashTableIter iter;
 399         void *value;
 400
 401         devc = sdi->priv;
 402         devc->sent_samples = 0;
 403
 404         /*
 405          * Determine the numbers of logic and analog channels that are
 406          * involved in the acquisition. Determine an offset and a mask to
 407          * remove excess logic data content before datafeed submission.
 408          */
 409         devc->enabled_logic_channels = 0;
 410         devc->enabled_analog_channels = 0;
 411         for (l = sdi->channels; l; l = l->next) {
 412                 ch = l->data;
 413                 if (!ch->enabled)
 414                         continue;
 415                 if (ch->type == SR_CHANNEL_ANALOG) {
 416                         devc->enabled_analog_channels++;
 417                         continue;
 418                 }
 419                 if (ch->type != SR_CHANNEL_LOGIC)
 420                         continue;
 421                 /*
 422                  * TODO: Need we create a channel map here, such that the
 423                  * session datafeed packets will have a dense representation
 424                  * of the enabled channels' data? For example store channels
 425                  * D3 and D5 in bit positions 0 and 1 respectively, when all
 426                  * other channels are disabled? The current implementation
 427                  * generates a sparse layout, might provide data for logic
 428                  * channels that are disabled while it might suppress data
 429                  * from enabled channels at the same time.
 430                  */
 431                 devc->enabled_logic_channels++;
 432         }
 433         devc->first_partial_logic_index = devc->enabled_logic_channels / 8;
 434         bitpos = devc->enabled_logic_channels % 8;
 435         mask = (1 << bitpos) - 1;
 436         devc->first_partial_logic_mask = mask;
 437         sr_dbg("num logic %zu, partial off %zu, mask 0x%02x.",
 438                 devc->enabled_logic_channels,
 439                 devc->first_partial_logic_index,
 440                 devc->first_partial_logic_mask);
 441
 442         /*
 443          * Have the waveform for analog patterns pre-generated. It's
 444          * supposed to be periodic, so the generator just needs to
 445          * access the prepared sample data (DDS style).
 446          */
 447         g_hash_table_iter_init(&iter, devc->ch_ag);
 448         while (g_hash_table_iter_next(&iter, NULL, &value))
 449                 demo_generate_analog_pattern(value, devc->cur_samplerate);
 450
 451         sr_session_source_add(sdi->session, -1, 0, 100,
 452                         demo_prepare_data, (struct sr_dev_inst *)sdi);
 453
 454         std_session_send_df_header(sdi);
 455
 456         /* We use this timestamp to decide how many more samples to send. */
 457         devc->start_us = g_get_monotonic_time();
 458         devc->spent_us = 0;
 459         devc->step = 0;
 460
 461         return SR_OK;
 462 }
 463
 464 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 465 {
 466         sr_session_source_remove(sdi->session, -1);
 467         std_session_send_df_end(sdi);
 468
 469         return SR_OK;
 470 }
 471
 472 static struct sr_dev_driver demo_driver_info = {
 473         .name = "demo",
 474         .longname = "Demo driver and pattern generator",
 475         .api_version = 1,
 476         .init = std_init,
 477         .cleanup = std_cleanup,
 478         .scan = scan,
 479         .dev_list = std_dev_list,
 480         .dev_clear = dev_clear,
 481         .config_get = config_get,
 482         .config_set = config_set,
 483         .config_list = config_list,
 484         .dev_open = std_dummy_dev_open,
 485         .dev_close = std_dummy_dev_close,
 486         .dev_acquisition_start = dev_acquisition_start,
 487         .dev_acquisition_stop = dev_acquisition_stop,
 488         .context = NULL,
 489 };
 490 SR_REGISTER_DEV_DRIVER(demo_driver_info);