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