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_triggerflags(devc);
 134         beaglelogic_get_buffersize(devc);
 135         beaglelogic_get_bufunitsize(devc);
 136
 137         /* Map the kernel capture FIFO for reads, saves 1 level of memcpy */
 138         if (beaglelogic_mmap(devc) != SR_OK) {
 139                 sr_err("Unable to map capture buffer");
 140                 beaglelogic_close(devc);
 141                 return SR_ERR;
 142         }
 143
 144         return SR_OK;
 145 }
 146
 147 static int dev_close(struct sr_dev_inst *sdi)
 148 {
 149         struct dev_context *devc = sdi->priv;
 150
 151         /* Close the memory mapping and the file */
 152         beaglelogic_munmap(devc);
 153         beaglelogic_close(devc);
 154
 155         return SR_OK;
 156 }
 157
 158 static int config_get(uint32_t key, GVariant **data,
 159         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 160 {
 161         struct dev_context *devc = sdi->priv;
 162
 163         (void)cg;
 164
 165         switch (key) {
 166         case SR_CONF_LIMIT_SAMPLES:
 167                 *data = g_variant_new_uint64(devc->limit_samples);
 168                 break;
 169         case SR_CONF_SAMPLERATE:
 170                 *data = g_variant_new_uint64(devc->cur_samplerate);
 171                 break;
 172         case SR_CONF_CAPTURE_RATIO:
 173                 *data = g_variant_new_uint64(devc->capture_ratio);
 174                 break;
 175         case SR_CONF_NUM_LOGIC_CHANNELS:
 176                 *data = g_variant_new_uint32(g_slist_length(sdi->channels));
 177                 break;
 178         default:
 179                 return SR_ERR_NA;
 180         }
 181
 182         return SR_OK;
 183 }
 184
 185 static int config_set(uint32_t key, GVariant *data,
 186         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 187 {
 188         struct dev_context *devc = sdi->priv;
 189         uint64_t tmp_u64;
 190
 191         (void)cg;
 192
 193         switch (key) {
 194         case SR_CONF_SAMPLERATE:
 195                 devc->cur_samplerate = g_variant_get_uint64(data);
 196                 return beaglelogic_set_samplerate(devc);
 197         case SR_CONF_LIMIT_SAMPLES:
 198                 tmp_u64 = g_variant_get_uint64(data);
 199                 devc->limit_samples = tmp_u64;
 200                 devc->triggerflags = BL_TRIGGERFLAGS_ONESHOT;
 201
 202                 /* Check if we have sufficient buffer size */
 203                 tmp_u64 *= SAMPLEUNIT_TO_BYTES(devc->sampleunit);
 204                 if (tmp_u64 > devc->buffersize) {
 205                         sr_warn("Insufficient buffer space has been allocated.");
 206                         sr_warn("Please use \'echo <size in bytes> > "\
 207                                 BEAGLELOGIC_SYSFS_ATTR(memalloc) \
 208                                 "\' as root to increase the buffer size, this"\
 209                                 " capture is now truncated to %d Msamples",
 210                                 devc->buffersize /
 211                                 (SAMPLEUNIT_TO_BYTES(devc->sampleunit) * 1000000));
 212                 }
 213                 return beaglelogic_set_triggerflags(devc);
 214         case SR_CONF_CAPTURE_RATIO:
 215                 devc->capture_ratio = g_variant_get_uint64(data);
 216                 break;
 217         default:
 218                 return SR_ERR_NA;
 219         }
 220
 221         return SR_OK;
 222 }
 223
 224 static int config_list(uint32_t key, GVariant **data,
 225         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 226 {
 227         switch (key) {
 228         case SR_CONF_SCAN_OPTIONS:
 229         case SR_CONF_DEVICE_OPTIONS:
 230                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 231         case SR_CONF_SAMPLERATE:
 232                 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
 233                 break;
 234         case SR_CONF_TRIGGER_MATCH:
 235                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
 236                 break;
 237         default:
 238                 return SR_ERR_NA;
 239         }
 240
 241         return SR_OK;
 242 }
 243
 244 /* get a sane timeout for poll() */
 245 #define BUFUNIT_TIMEOUT_MS(devc)        (100 + ((devc->bufunitsize * 1000) / \
 246                                 (uint32_t)(devc->cur_samplerate)))
 247
 248 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 249 {
 250         struct dev_context *devc = sdi->priv;
 251         struct sr_trigger *trigger;
 252
 253         /* Clear capture state */
 254         devc->bytes_read = 0;
 255         devc->offset = 0;
 256
 257         /* Configure channels */
 258         devc->sampleunit = g_slist_length(sdi->channels) > 8 ?
 259                         BL_SAMPLEUNIT_16_BITS : BL_SAMPLEUNIT_8_BITS;
 260         beaglelogic_set_sampleunit(devc);
 261
 262         /* Configure triggers & send header packet */
 263         if ((trigger = sr_session_trigger_get(sdi->session))) {
 264                 int pre_trigger_samples = 0;
 265                 if (devc->limit_samples > 0)
 266                         pre_trigger_samples = (devc->capture_ratio * devc->limit_samples) / 100;
 267                 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
 268                 if (!devc->stl)
 269                         return SR_ERR_MALLOC;
 270                 devc->trigger_fired = FALSE;
 271         } else
 272                 devc->trigger_fired = TRUE;
 273         std_session_send_df_header(sdi);
 274
 275         /* Trigger and add poll on file */
 276         beaglelogic_start(devc);
 277         sr_session_source_add_pollfd(sdi->session, &devc->pollfd,
 278                         BUFUNIT_TIMEOUT_MS(devc), beaglelogic_receive_data,
 279                         (void *)sdi);
 280
 281         return SR_OK;
 282 }
 283
 284 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 285 {
 286         struct dev_context *devc = sdi->priv;
 287
 288         /* Execute a stop on BeagleLogic */
 289         beaglelogic_stop(devc);
 290
 291         /* lseek to offset 0, flushes the cache */
 292         lseek(devc->fd, 0, SEEK_SET);
 293
 294         /* Remove session source and send EOT packet */
 295         sr_session_source_remove_pollfd(sdi->session, &devc->pollfd);
 296         std_session_send_df_end(sdi);
 297
 298         return SR_OK;
 299 }
 300
 301 static struct sr_dev_driver beaglelogic_driver_info = {
 302         .name = "beaglelogic",
 303         .longname = "BeagleLogic",
 304         .api_version = 1,
 305         .init = std_init,
 306         .cleanup = std_cleanup,
 307         .scan = scan,
 308         .dev_list = std_dev_list,
 309         .dev_clear = std_dev_clear,
 310         .config_get = config_get,
 311         .config_set = config_set,
 312         .config_list = config_list,
 313         .dev_open = dev_open,
 314         .dev_close = dev_close,
 315         .dev_acquisition_start = dev_acquisition_start,
 316         .dev_acquisition_stop = dev_acquisition_stop,
 317         .context = NULL,
 318 };
 319 SR_REGISTER_DEV_DRIVER(beaglelogic_driver_info);