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_NUM_LOGIC_CHANNELS | SR_CONF_GET,
  39 };
  40
  41 /* Trigger matching capabilities */
  42 static const int32_t soft_trigger_matches[] = {
  43         SR_TRIGGER_ZERO,
  44         SR_TRIGGER_ONE,
  45         SR_TRIGGER_RISING,
  46         SR_TRIGGER_FALLING,
  47         SR_TRIGGER_EDGE,
  48 };
  49
  50 /* Channels are numbered 0-13 */
  51 SR_PRIV const char *beaglelogic_channel_names[NUM_CHANNELS + 1] = {
  52         "P8_45", "P8_46", "P8_43", "P8_44", "P8_41", "P8_42", "P8_39", "P8_40",
  53         "P8_27", "P8_29", "P8_28", "P8_30", "P8_21", "P8_20", NULL,
  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_context *sr_ctx)
  64 {
  65         return std_init(sr_ctx, di, LOG_PREFIX);
  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(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         struct sr_channel *ch;
  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                 ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
 140                                 beaglelogic_channel_names[i]);
 141                 sdi->channels = g_slist_append(sdi->channels, ch);
 142         }
 143
 144         sdi->priv = devc;
 145         drvc->instances = g_slist_append(drvc->instances, sdi);
 146         devices = g_slist_append(devices, sdi);
 147
 148         return devices;
 149 }
 150
 151 static GSList *dev_list(void)
 152 {
 153         return ((struct drv_context *)(di->priv))->instances;
 154 }
 155
 156 static int dev_clear(void)
 157 {
 158         return std_dev_clear(di, NULL);
 159 }
 160
 161 static int dev_open(struct sr_dev_inst *sdi)
 162 {
 163         struct dev_context *devc = sdi->priv;
 164
 165         /* Open BeagleLogic */
 166         if (beaglelogic_open_nonblock(devc))
 167                 return SR_ERR;
 168
 169         /* Set fd and local attributes */
 170         devc->pollfd.fd = devc->fd;
 171         devc->pollfd.events = G_IO_IN;
 172
 173         /* Get the default attributes */
 174         beaglelogic_get_samplerate(devc);
 175         beaglelogic_get_sampleunit(devc);
 176         beaglelogic_get_triggerflags(devc);
 177         beaglelogic_get_buffersize(devc);
 178         beaglelogic_get_bufunitsize(devc);
 179
 180         /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
 181         if (beaglelogic_mmap(devc) != SR_OK) {
 182                 sr_err("Unable to map capture buffer");
 183                 beaglelogic_close(devc);
 184                 return SR_ERR;
 185         }
 186
 187         /* We're good to go now */
 188         sdi->status = SR_ST_ACTIVE;
 189         return SR_OK;
 190 }
 191
 192 static int dev_close(struct sr_dev_inst *sdi)
 193 {
 194         struct dev_context *devc = sdi->priv;
 195
 196         if (sdi->status == SR_ST_ACTIVE) {
 197                 /* Close the memory mapping and the file */
 198                 beaglelogic_munmap(devc);
 199                 beaglelogic_close(devc);
 200         }
 201         sdi->status = SR_ST_INACTIVE;
 202         return SR_OK;
 203 }
 204
 205 static int cleanup(void)
 206 {
 207         struct drv_context *drvc;
 208         struct sr_dev_inst *sdi;
 209         GSList *l;
 210
 211         /* unused driver */
 212         if (!(drvc = di->priv))
 213                 return SR_OK;
 214
 215         /* Clean up the instances */
 216         for (l = drvc->instances; l; l = l->next) {
 217                 sdi = l->data;
 218                 di->dev_close(sdi);
 219                 g_free(sdi->priv);
 220                 sr_dev_inst_free(sdi);
 221         }
 222         g_slist_free(drvc->instances);
 223         drvc->instances = NULL;
 224
 225         di->priv = NULL;
 226
 227         return SR_OK;
 228 }
 229
 230 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 231                 const struct sr_channel_group *cg)
 232 {
 233         struct dev_context *devc = sdi->priv;
 234         (void)cg;
 235
 236         switch (key) {
 237         case SR_CONF_LIMIT_SAMPLES:
 238                 *data = g_variant_new_uint64(devc->limit_samples);
 239                 break;
 240
 241         case SR_CONF_SAMPLERATE:
 242                 *data = g_variant_new_uint64(devc->cur_samplerate);
 243                 break;
 244
 245         case SR_CONF_NUM_LOGIC_CHANNELS:
 246                 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
 247                 break;
 248
 249         default:
 250                 return SR_ERR_NA;
 251         }
 252
 253         return SR_OK;
 254 }
 255
 256 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 257                 const struct sr_channel_group *cg)
 258 {
 259         struct dev_context *devc = sdi->priv;
 260         uint64_t tmp_u64;
 261         (void)cg;
 262
 263         if (sdi->status != SR_ST_ACTIVE)
 264                 return SR_ERR_DEV_CLOSED;
 265
 266         switch (key) {
 267         case SR_CONF_SAMPLERATE:
 268                 devc->cur_samplerate = g_variant_get_uint64(data);
 269                 return beaglelogic_set_samplerate(devc);
 270
 271         case SR_CONF_LIMIT_SAMPLES:
 272                 tmp_u64 = g_variant_get_uint64(data);
 273                 devc->limit_samples = tmp_u64;
 274                 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
 275
 276                 /* Check if we have sufficient buffer size */
 277                 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
 278                 if (tmp_u64 > devc->buffersize) {
 279                         sr_warn("Insufficient buffer space has been allocated.");
 280                         sr_warn("Please use \'echo <size in bytes> > "\
 281                                 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
 282                                 "\' as root to increase the buffer size, this"\
 283                                 " capture is now truncated to %d Msamples",
 284                                 devc->buffersize /
 285                                 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
 286                 }
 287                 return beaglelogic_set_triggerflags(devc);
 288
 289         default:
 290                 return SR_ERR_NA;
 291         }
 292
 293         return SR_OK;
 294 }
 295
 296 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 297                 const struct sr_channel_group *cg)
 298 {
 299         int ret;
 300         GVariant *gvar;
 301         GVariantBuilder gvb;
 302
 303         (void)sdi;
 304         (void)data;
 305         (void)cg;
 306
 307         ret = SR_OK;
 308         switch (key) {
 309         case SR_CONF_SCAN_OPTIONS:
 310                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 311                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 312                 break;
 313         case SR_CONF_DEVICE_OPTIONS:
 314                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 315                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 316                 break;
 317         case SR_CONF_SAMPLERATE:
 318                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 319                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 320                         samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 321                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 322                 *data = g_variant_builder_end(&gvb);
 323                 break;
 324         case SR_CONF_TRIGGER_MATCH:
 325                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 326                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
 327                                 sizeof(int32_t));
 328                 break;
 329         default:
 330                 return SR_ERR_NA;
 331         }
 332
 333         return ret;
 334 }
 335
 336 /* get a sane timeout for poll() */
 337 #define BUFUNIT_TIMEOUT_MS(devc)        (100 + ((devc->bufunitsize * 1000) / \
 338                                 (uint32_t)(devc->cur_samplerate)))
 339
 340 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 341                                     void *cb_data)
 342 {
 343         (void)cb_data;
 344         struct dev_context *devc = sdi->priv;
 345         struct sr_trigger *trigger;
 346
 347         if (sdi->status != SR_ST_ACTIVE)
 348                 return SR_ERR_DEV_CLOSED;
 349
 350         /* Save user pointer */
 351         devc->cb_data = cb_data;
 352
 353         /* Clear capture state */
 354         devc->bytes_read = 0;
 355         devc->offset = 0;
 356
 357         /* Configure channels */
 358         devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
 359                         BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
 360         beaglelogic_set_sampleunit(devc);
 361
 362         /* Configure triggers & send header packet */
 363         if ((trigger = sr_session_trigger_get(sdi->session))) {
 364                 devc->stl = soft_trigger_logic_new(sdi, trigger);
 365                 devc->trigger_fired = FALSE;
 366         } else
 367                 devc->trigger_fired = TRUE;
 368         std_session_send_df_header(cb_data, LOG_PREFIX);
 369
 370         /* Trigger and add poll on file */
 371         beaglelogic_start(devc);
 372         sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
 373                         BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
 374                         (void *)sdi);
 375
 376         return SR_OK;
 377 }
 378
 379 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 380 {
 381         struct dev_context *devc = sdi->priv;
 382         struct sr_datafeed_packet pkt;
 383
 384         (void)cb_data;
 385
 386         if (sdi->status != SR_ST_ACTIVE)
 387                 return SR_ERR_DEV_CLOSED;
 388
 389         /* Execute a stop on BeagleLogic */
 390         beaglelogic_stop(devc);
 391
 392         /* lseek to offset 0, flushes the cache */
 393         lseek(devc->fd, 0, SEEK_SET);
 394
 395         /* Remove session source and send EOT packet */
 396         sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
 397         pkt.type = SR_DF_END;
 398         pkt.payload = NULL;
 399         sr_session_send(sdi, &pkt);
 400
 401         return SR_OK;
 402 }
 403
 404 SR_PRIV struct sr_dev_driver beaglelogic_driver_info = {
 405         .name = "beaglelogic",
 406         .longname = "BeagleLogic",
 407         .api_version = 1,
 408         .init = init,
 409         .cleanup = cleanup,
 410         .scan = scan,
 411         .dev_list = dev_list,
 412         .dev_clear = dev_clear,
 413         .config_get = config_get,
 414         .config_set = config_set,
 415         .config_list = config_list,
 416         .dev_open = dev_open,
 417         .dev_close = dev_close,
 418         .dev_acquisition_start = dev_acquisition_start,
 419         .dev_acquisition_stop = dev_acquisition_stop,
 420         .priv = NULL,
 421 };