src/hardware/beaglelogic/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Kumar Abhishek <abhishek@theembeddedkitchen.net>
   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 #include "beaglelogic.h"
  23
  24 SR_PRIV struct sr_dev_driver beaglelogic_driver_info;
  25
  26 /* Scan options */
  27 static const uint32_t scanopts[] = {
  28         SR_CONF_NUM_LOGIC_CHANNELS,
  29 };
  30
  31 /* Hardware capabilities */
  32 static const uint32_t devopts[] = {
  33         SR_CONF_LOGIC_ANALYZER,
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  36         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
  37         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  38         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
  39         SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_GET,
  40 };
  41
  42 /* Trigger matching capabilities */
  43 static const int32_t soft_trigger_matches[] = {
  44         SR_TRIGGER_ZERO,
  45         SR_TRIGGER_ONE,
  46         SR_TRIGGER_RISING,
  47         SR_TRIGGER_FALLING,
  48         SR_TRIGGER_EDGE,
  49 };
  50
  51 SR_PRIV const char *channel_names[] = {
  52         "P8_45", "P8_46", "P8_43", "P8_44", "P8_41", "P8_42", "P8_39",
  53         "P8_40", "P8_27", "P8_29", "P8_28", "P8_30", "P8_21", "P8_20",
  54 };
  55
  56 /* Possible sample rates : 10 Hz to 100 MHz = (100 / x) MHz */
  57 static const uint64_t samplerates[] = {
  58         SR_HZ(10),
  59         SR_MHZ(100),
  60         SR_HZ(1),
  61 };
  62
  63 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  64 {
  65         return std_init(di, sr_ctx);
  66 }
  67
  68 static struct dev_context *beaglelogic_devc_alloc(void)
  69 {
  70         struct dev_context *devc;
  71
  72         devc = g_malloc0(sizeof(struct dev_context));
  73
  74         /* Default non-zero values (if any) */
  75         devc->fd = -1;
  76         devc->limit_samples = (uint64_t)-1;
  77
  78         return devc;
  79 }
  80
  81 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  82 {
  83         struct drv_context *drvc;
  84         GSList *devices, *l;
  85         struct sr_config *src;
  86         struct sr_dev_inst *sdi;
  87         struct dev_context *devc;
  88         int i, maxch;
  89
  90         devices = NULL;
  91         drvc = di->context;
  92         drvc->instances = NULL;
  93
  94         /* Probe for /dev/beaglelogic */
  95         if (!g_file_test(BEAGLELOGIC_DEV_NODE, G_FILE_TEST_EXISTS))
  96                 return NULL;
  97
  98         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  99         sdi->status = SR_ST_INACTIVE;
 100         sdi->model = g_strdup("BeagleLogic");
 101         sdi->version = g_strdup("1.0");
 102         sdi->driver = di;
 103
 104         /* Unless explicitly specified, keep max channels to 8 only */
 105         maxch = 8;
 106         for (l = options; l; l = l->next) {
 107                 src = l->data;
 108                 if (src->key == SR_CONF_NUM_LOGIC_CHANNELS)
 109                         maxch = g_variant_get_int32(src->data);
 110         }
 111
 112         /* We need to test for number of channels by opening the node */
 113         devc = beaglelogic_devc_alloc();
 114
 115         if (beaglelogic_open_nonblock(devc) != SR_OK) {
 116                 g_free(devc);
 117                 sr_dev_inst_free(sdi);
 118
 119                 return NULL;
 120         }
 121
 122         if (maxch > 8) {
 123                 maxch = NUM_CHANNELS;
 124                 devc->sampleunit = BL_SAMPLEUNIT_16_BITS;
 125         } else {
 126                 maxch = 8;
 127                 devc->sampleunit = BL_SAMPLEUNIT_8_BITS;
 128         }
 129
 130         beaglelogic_set_sampleunit(devc);
 131         beaglelogic_close(devc);
 132
 133         /* Signal */
 134         sr_info("BeagleLogic device found at "BEAGLELOGIC_DEV_NODE);
 135
 136         /* Fill the channels */
 137         for (i = 0; i < maxch; i++)
 138                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
 139                                 channel_names[i]);
 140
 141         sdi->priv = devc;
 142         drvc->instances = g_slist_append(drvc->instances, sdi);
 143         devices = g_slist_append(devices, sdi);
 144
 145         return devices;
 146 }
 147
 148 static int dev_open(struct sr_dev_inst *sdi)
 149 {
 150         struct dev_context *devc = sdi->priv;
 151
 152         /* Open BeagleLogic */
 153         if (beaglelogic_open_nonblock(devc))
 154                 return SR_ERR;
 155
 156         /* Set fd and local attributes */
 157         devc->pollfd.fd = devc->fd;
 158         devc->pollfd.events = G_IO_IN;
 159         devc->pollfd.revents = 0;
 160
 161         /* Get the default attributes */
 162         beaglelogic_get_samplerate(devc);
 163         beaglelogic_get_sampleunit(devc);
 164         beaglelogic_get_triggerflags(devc);
 165         beaglelogic_get_buffersize(devc);
 166         beaglelogic_get_bufunitsize(devc);
 167
 168         /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
 169         if (beaglelogic_mmap(devc) != SR_OK) {
 170                 sr_err("Unable to map capture buffer");
 171                 beaglelogic_close(devc);
 172                 return SR_ERR;
 173         }
 174
 175         /* We're good to go now */
 176         sdi->status = SR_ST_ACTIVE;
 177         return SR_OK;
 178 }
 179
 180 static int dev_close(struct sr_dev_inst *sdi)
 181 {
 182         struct dev_context *devc = sdi->priv;
 183
 184         if (sdi->status == SR_ST_ACTIVE) {
 185                 /* Close the memory mapping and the file */
 186                 beaglelogic_munmap(devc);
 187                 beaglelogic_close(devc);
 188         }
 189         sdi->status = SR_ST_INACTIVE;
 190         return SR_OK;
 191 }
 192
 193 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 194                 const struct sr_channel_group *cg)
 195 {
 196         struct dev_context *devc = sdi->priv;
 197
 198         (void)cg;
 199
 200         switch (key) {
 201         case SR_CONF_LIMIT_SAMPLES:
 202                 *data = g_variant_new_uint64(devc->limit_samples);
 203                 break;
 204         case SR_CONF_SAMPLERATE:
 205                 *data = g_variant_new_uint64(devc->cur_samplerate);
 206                 break;
 207         case SR_CONF_CAPTURE_RATIO:
 208                 *data = g_variant_new_uint64(devc->capture_ratio);
 209                 break;
 210         case SR_CONF_NUM_LOGIC_CHANNELS:
 211                 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
 212                 break;
 213         default:
 214                 return SR_ERR_NA;
 215         }
 216
 217         return SR_OK;
 218 }
 219
 220 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 221                 const struct sr_channel_group *cg)
 222 {
 223         struct dev_context *devc = sdi->priv;
 224         uint64_t tmp_u64;
 225
 226         (void)cg;
 227
 228         if (sdi->status != SR_ST_ACTIVE)
 229                 return SR_ERR_DEV_CLOSED;
 230
 231         switch (key) {
 232         case SR_CONF_SAMPLERATE:
 233                 devc->cur_samplerate = g_variant_get_uint64(data);
 234                 return beaglelogic_set_samplerate(devc);
 235         case SR_CONF_LIMIT_SAMPLES:
 236                 tmp_u64 = g_variant_get_uint64(data);
 237                 devc->limit_samples = tmp_u64;
 238                 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
 239
 240                 /* Check if we have sufficient buffer size */
 241                 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
 242                 if (tmp_u64 > devc->buffersize) {
 243                         sr_warn("Insufficient buffer space has been allocated.");
 244                         sr_warn("Please use \'echo <size in bytes> > "\
 245                                 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
 246                                 "\' as root to increase the buffer size, this"\
 247                                 " capture is now truncated to %d Msamples",
 248                                 devc->buffersize /
 249                                 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
 250                 }
 251                 return beaglelogic_set_triggerflags(devc);
 252         case SR_CONF_CAPTURE_RATIO:
 253                 devc->capture_ratio = g_variant_get_uint64(data);
 254                 if (devc->capture_ratio > 100)
 255                         return SR_ERR;
 256                 return SR_OK;
 257         default:
 258                 return SR_ERR_NA;
 259         }
 260
 261         return SR_OK;
 262 }
 263
 264 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 265                 const struct sr_channel_group *cg)
 266 {
 267         int ret;
 268         GVariant *gvar;
 269         GVariantBuilder gvb;
 270
 271         (void)sdi;
 272         (void)cg;
 273
 274         ret = SR_OK;
 275         switch (key) {
 276         case SR_CONF_SCAN_OPTIONS:
 277                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 278                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 279                 break;
 280         case SR_CONF_DEVICE_OPTIONS:
 281                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 282                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 283                 break;
 284         case SR_CONF_SAMPLERATE:
 285                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 286                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 287                         samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 288                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 289                 *data = g_variant_builder_end(&gvb);
 290                 break;
 291         case SR_CONF_TRIGGER_MATCH:
 292                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 293                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
 294                                 sizeof(int32_t));
 295                 break;
 296         default:
 297                 return SR_ERR_NA;
 298         }
 299
 300         return ret;
 301 }
 302
 303 /* get a sane timeout for poll() */
 304 #define BUFUNIT_TIMEOUT_MS(devc)        (100 + ((devc->bufunitsize * 1000) / \
 305                                 (uint32_t)(devc->cur_samplerate)))
 306
 307 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 308 {
 309         struct dev_context *devc = sdi->priv;
 310         struct sr_trigger *trigger;
 311
 312         if (sdi->status != SR_ST_ACTIVE)
 313                 return SR_ERR_DEV_CLOSED;
 314
 315         /* Clear capture state */
 316         devc->bytes_read = 0;
 317         devc->offset = 0;
 318
 319         /* Configure channels */
 320         devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
 321                         BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
 322         beaglelogic_set_sampleunit(devc);
 323
 324         /* Configure triggers & send header packet */
 325         if ((trigger = sr_session_trigger_get(sdi->session))) {
 326                 int pre_trigger_samples = 0;
 327                 if (devc->limit_samples > 0)
 328                         pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
 329                 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
 330                 if (!devc->stl)
 331                         return SR_ERR_MALLOC;
 332                 devc->trigger_fired = FALSE;
 333         } else
 334                 devc->trigger_fired = TRUE;
 335         std_session_send_df_header(sdi, LOG_PREFIX);
 336
 337         /* Trigger and add poll on file */
 338         beaglelogic_start(devc);
 339         sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
 340                         BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
 341                         (void *)sdi);
 342
 343         return SR_OK;
 344 }
 345
 346 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 347 {
 348         struct dev_context *devc = sdi->priv;
 349
 350         if (sdi->status != SR_ST_ACTIVE)
 351                 return SR_ERR_DEV_CLOSED;
 352
 353         /* Execute a stop on BeagleLogic */
 354         beaglelogic_stop(devc);
 355
 356         /* lseek to offset 0, flushes the cache */
 357         lseek(devc->fd, 0, SEEK_SET);
 358
 359         /* Remove session source and send EOT packet */
 360         sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
 361         std_session_send_df_end(sdi, LOG_PREFIX);
 362
 363         return SR_OK;
 364 }
 365
 366 SR_PRIV struct sr_dev_driver beaglelogic_driver_info = {
 367         .name = "beaglelogic",
 368         .longname = "BeagleLogic",
 369         .api_version = 1,
 370         .init = init,
 371         .cleanup = std_cleanup,
 372         .scan = scan,
 373         .dev_list = std_dev_list,
 374         .config_get = config_get,
 375         .config_set = config_set,
 376         .config_list = config_list,
 377         .dev_open = dev_open,
 378         .dev_close = dev_close,
 379         .dev_acquisition_start = dev_acquisition_start,
 380         .dev_acquisition_stop = dev_acquisition_stop,
 381         .context = NULL,
 382 };