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         /* We're good to go now */
 161         sdi->status = SR_ST_ACTIVE;
 162         return SR_OK;
 163 }
 164
 165 static int dev_close(struct sr_dev_inst *sdi)
 166 {
 167         struct dev_context *devc = sdi->priv;
 168
 169         if (sdi->status == SR_ST_ACTIVE) {
 170                 /* Close the memory mapping and the file */
 171                 beaglelogic_munmap(devc);
 172                 beaglelogic_close(devc);
 173         }
 174         sdi->status = SR_ST_INACTIVE;
 175         return SR_OK;
 176 }
 177
 178 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 179                 const struct sr_channel_group *cg)
 180 {
 181         struct dev_context *devc = sdi->priv;
 182
 183         (void)cg;
 184
 185         switch (key) {
 186         case SR_CONF_LIMIT_SAMPLES:
 187                 *data = g_variant_new_uint64(devc->limit_samples);
 188                 break;
 189         case SR_CONF_SAMPLERATE:
 190                 *data = g_variant_new_uint64(devc->cur_samplerate);
 191                 break;
 192         case SR_CONF_CAPTURE_RATIO:
 193                 *data = g_variant_new_uint64(devc->capture_ratio);
 194                 break;
 195         case SR_CONF_NUM_LOGIC_CHANNELS:
 196                 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
 197                 break;
 198         default:
 199                 return SR_ERR_NA;
 200         }
 201
 202         return SR_OK;
 203 }
 204
 205 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 206                 const struct sr_channel_group *cg)
 207 {
 208         struct dev_context *devc = sdi->priv;
 209         uint64_t tmp_u64;
 210
 211         (void)cg;
 212
 213         if (sdi->status != SR_ST_ACTIVE)
 214                 return SR_ERR_DEV_CLOSED;
 215
 216         switch (key) {
 217         case SR_CONF_SAMPLERATE:
 218                 devc->cur_samplerate = g_variant_get_uint64(data);
 219                 return beaglelogic_set_samplerate(devc);
 220         case SR_CONF_LIMIT_SAMPLES:
 221                 tmp_u64 = g_variant_get_uint64(data);
 222                 devc->limit_samples = tmp_u64;
 223                 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
 224
 225                 /* Check if we have sufficient buffer size */
 226                 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
 227                 if (tmp_u64 > devc->buffersize) {
 228                         sr_warn("Insufficient buffer space has been allocated.");
 229                         sr_warn("Please use \'echo <size in bytes> > "\
 230                                 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
 231                                 "\' as root to increase the buffer size, this"\
 232                                 " capture is now truncated to %d Msamples",
 233                                 devc->buffersize /
 234                                 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
 235                 }
 236                 return beaglelogic_set_triggerflags(devc);
 237         case SR_CONF_CAPTURE_RATIO:
 238                 devc->capture_ratio = g_variant_get_uint64(data);
 239                 if (devc->capture_ratio > 100)
 240                         return SR_ERR;
 241                 return SR_OK;
 242         default:
 243                 return SR_ERR_NA;
 244         }
 245
 246         return SR_OK;
 247 }
 248
 249 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 250                 const struct sr_channel_group *cg)
 251 {
 252         int ret;
 253         GVariant *gvar;
 254         GVariantBuilder gvb;
 255
 256         (void)sdi;
 257         (void)cg;
 258
 259         ret = SR_OK;
 260         switch (key) {
 261         case SR_CONF_SCAN_OPTIONS:
 262                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 263                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 264                 break;
 265         case SR_CONF_DEVICE_OPTIONS:
 266                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 267                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 268                 break;
 269         case SR_CONF_SAMPLERATE:
 270                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 271                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 272                         samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 273                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 274                 *data = g_variant_builder_end(&gvb);
 275                 break;
 276         case SR_CONF_TRIGGER_MATCH:
 277                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 278                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
 279                                 sizeof(int32_t));
 280                 break;
 281         default:
 282                 return SR_ERR_NA;
 283         }
 284
 285         return ret;
 286 }
 287
 288 /* get a sane timeout for poll() */
 289 #define BUFUNIT_TIMEOUT_MS(devc)        (100 + ((devc->bufunitsize * 1000) / \
 290                                 (uint32_t)(devc->cur_samplerate)))
 291
 292 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 293 {
 294         struct dev_context *devc = sdi->priv;
 295         struct sr_trigger *trigger;
 296
 297         if (sdi->status != SR_ST_ACTIVE)
 298                 return SR_ERR_DEV_CLOSED;
 299
 300         /* Clear capture state */
 301         devc->bytes_read = 0;
 302         devc->offset = 0;
 303
 304         /* Configure channels */
 305         devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
 306                         BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
 307         beaglelogic_set_sampleunit(devc);
 308
 309         /* Configure triggers & send header packet */
 310         if ((trigger = sr_session_trigger_get(sdi->session))) {
 311                 int pre_trigger_samples = 0;
 312                 if (devc->limit_samples > 0)
 313                         pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
 314                 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
 315                 if (!devc->stl)
 316                         return SR_ERR_MALLOC;
 317                 devc->trigger_fired = FALSE;
 318         } else
 319                 devc->trigger_fired = TRUE;
 320         std_session_send_df_header(sdi);
 321
 322         /* Trigger and add poll on file */
 323         beaglelogic_start(devc);
 324         sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
 325                         BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
 326                         (void *)sdi);
 327
 328         return SR_OK;
 329 }
 330
 331 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 332 {
 333         struct dev_context *devc = sdi->priv;
 334
 335         /* Execute a stop on BeagleLogic */
 336         beaglelogic_stop(devc);
 337
 338         /* lseek to offset 0, flushes the cache */
 339         lseek(devc->fd, 0, SEEK_SET);
 340
 341         /* Remove session source and send EOT packet */
 342         sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
 343         std_session_send_df_end(sdi);
 344
 345         return SR_OK;
 346 }
 347
 348 static struct sr_dev_driver beaglelogic_driver_info = {
 349         .name = "beaglelogic",
 350         .longname = "BeagleLogic",
 351         .api_version = 1,
 352         .init = std_init,
 353         .cleanup = std_cleanup,
 354         .scan = scan,
 355         .dev_list = std_dev_list,
 356         .config_get = config_get,
 357         .config_set = config_set,
 358         .config_list = config_list,
 359         .dev_open = dev_open,
 360         .dev_close = dev_close,
 361         .dev_acquisition_start = dev_acquisition_start,
 362         .dev_acquisition_stop = dev_acquisition_stop,
 363         .context = NULL,
 364 };
 365 SR_REGISTER_DEV_DRIVER(beaglelogic_driver_info);