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