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