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