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         GSList *l;
  77         struct sr_config *src;
  78         struct sr_dev_inst *sdi;
  79         struct dev_context *devc;
  80         int i, maxch;
  81
  82         /* Probe for /dev/beaglelogic */
  83         if (!g_file_test(BEAGLELOGIC_DEV_NODE, G_FILE_TEST_EXISTS))
  84                 return NULL;
  85
  86         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  87         sdi->status = SR_ST_INACTIVE;
  88         sdi->model = g_strdup("BeagleLogic");
  89         sdi->version = g_strdup("1.0");
  90
  91         /* Unless explicitly specified, keep max channels to 8 only */
  92         maxch = 8;
  93         for (l = options; l; l = l->next) {
  94                 src = l->data;
  95                 if (src->key == SR_CONF_NUM_LOGIC_CHANNELS)
  96                         maxch = g_variant_get_int32(src->data);
  97         }
  98
  99         /* We need to test for number of channels by opening the node */
 100         devc = beaglelogic_devc_alloc();
 101
 102         if (beaglelogic_open_nonblock(devc) != SR_OK) {
 103                 g_free(devc);
 104                 sr_dev_inst_free(sdi);
 105
 106                 return NULL;
 107         }
 108
 109         if (maxch > 8) {
 110                 maxch = NUM_CHANNELS;
 111                 devc->sampleunit = BL_SAMPLEUNIT_16_BITS;
 112         } else {
 113                 maxch = 8;
 114                 devc->sampleunit = BL_SAMPLEUNIT_8_BITS;
 115         }
 116
 117         beaglelogic_set_sampleunit(devc);
 118         beaglelogic_close(devc);
 119
 120         /* Signal */
 121         sr_info("BeagleLogic device found at "BEAGLELOGIC_DEV_NODE);
 122
 123         /* Fill the channels */
 124         for (i = 0; i < maxch; i++)
 125                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
 126                                 channel_names[i]);
 127
 128         sdi->priv = devc;
 129
 130         return std_scan_complete(di, g_slist_append(NULL, sdi));
 131 }
 132
 133 static int dev_open(struct sr_dev_inst *sdi)
 134 {
 135         struct dev_context *devc = sdi->priv;
 136
 137         /* Open BeagleLogic */
 138         if (beaglelogic_open_nonblock(devc))
 139                 return SR_ERR;
 140
 141         /* Set fd and local attributes */
 142         devc->pollfd.fd = devc->fd;
 143         devc->pollfd.events = G_IO_IN;
 144         devc->pollfd.revents = 0;
 145
 146         /* Get the default attributes */
 147         beaglelogic_get_samplerate(devc);
 148         beaglelogic_get_sampleunit(devc);
 149         beaglelogic_get_triggerflags(devc);
 150         beaglelogic_get_buffersize(devc);
 151         beaglelogic_get_bufunitsize(devc);
 152
 153         /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
 154         if (beaglelogic_mmap(devc) != SR_OK) {
 155                 sr_err("Unable to map capture buffer");
 156                 beaglelogic_close(devc);
 157                 return SR_ERR;
 158         }
 159
 160         return SR_OK;
 161 }
 162
 163 static int dev_close(struct sr_dev_inst *sdi)
 164 {
 165         struct dev_context *devc = sdi->priv;
 166
 167         /* Close the memory mapping and the file */
 168         beaglelogic_munmap(devc);
 169         beaglelogic_close(devc);
 170
 171         return SR_OK;
 172 }
 173
 174 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 175                 const struct sr_channel_group *cg)
 176 {
 177         struct dev_context *devc = sdi->priv;
 178
 179         (void)cg;
 180
 181         switch (key) {
 182         case SR_CONF_LIMIT_SAMPLES:
 183                 *data = g_variant_new_uint64(devc->limit_samples);
 184                 break;
 185         case SR_CONF_SAMPLERATE:
 186                 *data = g_variant_new_uint64(devc->cur_samplerate);
 187                 break;
 188         case SR_CONF_CAPTURE_RATIO:
 189                 *data = g_variant_new_uint64(devc->capture_ratio);
 190                 break;
 191         case SR_CONF_NUM_LOGIC_CHANNELS:
 192                 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
 193                 break;
 194         default:
 195                 return SR_ERR_NA;
 196         }
 197
 198         return SR_OK;
 199 }
 200
 201 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 202                 const struct sr_channel_group *cg)
 203 {
 204         struct dev_context *devc = sdi->priv;
 205         uint64_t tmp_u64;
 206
 207         (void)cg;
 208
 209         switch (key) {
 210         case SR_CONF_SAMPLERATE:
 211                 devc->cur_samplerate = g_variant_get_uint64(data);
 212                 return beaglelogic_set_samplerate(devc);
 213         case SR_CONF_LIMIT_SAMPLES:
 214                 tmp_u64 = g_variant_get_uint64(data);
 215                 devc->limit_samples = tmp_u64;
 216                 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
 217
 218                 /* Check if we have sufficient buffer size */
 219                 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
 220                 if (tmp_u64 > devc->buffersize) {
 221                         sr_warn("Insufficient buffer space has been allocated.");
 222                         sr_warn("Please use \'echo <size in bytes> > "\
 223                                 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
 224                                 "\' as root to increase the buffer size, this"\
 225                                 " capture is now truncated to %d Msamples",
 226                                 devc->buffersize /
 227                                 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
 228                 }
 229                 return beaglelogic_set_triggerflags(devc);
 230         case SR_CONF_CAPTURE_RATIO:
 231                 devc->capture_ratio = g_variant_get_uint64(data);
 232                 if (devc->capture_ratio > 100)
 233                         return SR_ERR;
 234                 return SR_OK;
 235         default:
 236                 return SR_ERR_NA;
 237         }
 238
 239         return SR_OK;
 240 }
 241
 242 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 243                 const struct sr_channel_group *cg)
 244 {
 245         GVariant *gvar;
 246         GVariantBuilder gvb;
 247
 248         switch (key) {
 249         case SR_CONF_SCAN_OPTIONS:
 250         case SR_CONF_DEVICE_OPTIONS:
 251                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, devopts);
 252         case SR_CONF_SAMPLERATE:
 253                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 254                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 255                         samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 256                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 257                 *data = g_variant_builder_end(&gvb);
 258                 break;
 259         case SR_CONF_TRIGGER_MATCH:
 260                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 261                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
 262                                 sizeof(int32_t));
 263                 break;
 264         default:
 265                 return SR_ERR_NA;
 266         }
 267
 268         return SR_OK;
 269 }
 270
 271 /* get a sane timeout for poll() */
 272 #define BUFUNIT_TIMEOUT_MS(devc)        (100 + ((devc->bufunitsize * 1000) / \
 273                                 (uint32_t)(devc->cur_samplerate)))
 274
 275 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 276 {
 277         struct dev_context *devc = sdi->priv;
 278         struct sr_trigger *trigger;
 279
 280         /* Clear capture state */
 281         devc->bytes_read = 0;
 282         devc->offset = 0;
 283
 284         /* Configure channels */
 285         devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
 286                         BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
 287         beaglelogic_set_sampleunit(devc);
 288
 289         /* Configure triggers & send header packet */
 290         if ((trigger = sr_session_trigger_get(sdi->session))) {
 291                 int pre_trigger_samples = 0;
 292                 if (devc->limit_samples > 0)
 293                         pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
 294                 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
 295                 if (!devc->stl)
 296                         return SR_ERR_MALLOC;
 297                 devc->trigger_fired = FALSE;
 298         } else
 299                 devc->trigger_fired = TRUE;
 300         std_session_send_df_header(sdi);
 301
 302         /* Trigger and add poll on file */
 303         beaglelogic_start(devc);
 304         sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
 305                         BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
 306                         (void *)sdi);
 307
 308         return SR_OK;
 309 }
 310
 311 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 312 {
 313         struct dev_context *devc = sdi->priv;
 314
 315         /* Execute a stop on BeagleLogic */
 316         beaglelogic_stop(devc);
 317
 318         /* lseek to offset 0, flushes the cache */
 319         lseek(devc->fd, 0, SEEK_SET);
 320
 321         /* Remove session source and send EOT packet */
 322         sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
 323         std_session_send_df_end(sdi);
 324
 325         return SR_OK;
 326 }
 327
 328 static struct sr_dev_driver beaglelogic_driver_info = {
 329         .name = "beaglelogic",
 330         .longname = "BeagleLogic",
 331         .api_version = 1,
 332         .init = std_init,
 333         .cleanup = std_cleanup,
 334         .scan = scan,
 335         .dev_list = std_dev_list,
 336         .dev_clear = std_dev_clear,
 337         .config_get = config_get,
 338         .config_set = config_set,
 339         .config_list = config_list,
 340         .dev_open = dev_open,
 341         .dev_close = dev_close,
 342         .dev_acquisition_start = dev_acquisition_start,
 343         .dev_acquisition_stop = dev_acquisition_stop,
 344         .context = NULL,
 345 };
 346 SR_REGISTER_DEV_DRIVER(beaglelogic_driver_info);