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