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