hardware/nexus-osciprime/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   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 <string.h>
  21 #include <glib.h>
  22 #include "libsigrok.h"
  23 #include "libsigrok-internal.h"
  24 #include "protocol.h"
  25
  26 #define OSCI_VENDOR "Nexus Computing"
  27 #define OSCI_MODEL "OsciPrime"
  28 #define OSCI_VERSION "1.0"
  29 #define OSCI_FIRMWARE FIRMWARE_DIR "/nexus-osciprime.fw"
  30 #define OSCI_VIDPID "04b4.1004"
  31
  32 static const int hwopts[] = {
  33         SR_CONF_CONN,
  34         SR_CONF_SERIALCOMM,
  35         0,
  36 };
  37
  38 static const int hwcaps[] = {
  39         SR_CONF_OSCILLOSCOPE,
  40         SR_CONF_LIMIT_SAMPLES,
  41         SR_CONF_CONTINUOUS,
  42         SR_CONF_TIMEBASE,
  43         SR_CONF_VDIV,
  44         0,
  45 };
  46
  47 static const struct sr_rational timebases[] = {
  48         /* 24 MHz */
  49         { 42, 1e9 },
  50         /* 12 MHz */
  51         { 83, 1e9 },
  52         /* 6 MHz */
  53         { 167, 1e9 },
  54         /* 3 MHz */
  55         { 333, 1e9 },
  56         /* 1.5 MHz */
  57         { 667, 1e9 },
  58         /* 750 kHz */
  59         { 1333, 1e9 },
  60         /* 375 kHz */
  61         { 2667, 1e9 },
  62         /* 187.5 kHz */
  63         { 5333, 1e9 },
  64         /* 93.25 kHz */
  65         { 10724, 1e9 },
  66         /* 46.875 kHz */
  67         { 21333, 1e9 },
  68         /* 23.4375 kHz */
  69         { 42666, 1e9 },
  70         /* 11.718 kHz */
  71         { 85339, 1e9 },
  72         /* 5.859 kHz */
  73         { 170678, 1e9 },
  74         /* 2.929 kHz */
  75         { 341413, 1e9 },
  76         /* 1.465 kHz */
  77         { 682594, 1e9 },
  78         /* 732 Hz */
  79         { 1366, 1e6 },
  80         /* 366 Hz */
  81         { 2732, 1e6 },
  82         /* 183 Hz */
  83         { 5464, 1e6 },
  84         /* 91 Hz */
  85         { 10989, 1e6 },
  86         /* 46 Hz */
  87         { 21739, 1e6 },
  88         /* 23 Hz */
  89         { 43478, 1e6 },
  90         /* 12 Hz */
  91         { 83333, 1e6 },
  92 };
  93
  94 static const char *probe_names[] = {
  95         "CHA", "CHB",
  96         NULL,
  97 };
  98
  99 static const struct sr_rational vdivs[] = {
 100         { 1, 1 },
 101         { 2, 1 },
 102         { 5, 2 },
 103         { 5, 1 },
 104         { 10, 1 },
 105 };
 106
 107
 108 SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
 109 static struct sr_dev_driver *di = &nexus_osciprime_driver_info;
 110 static int hw_dev_close(struct sr_dev_inst *sdi);
 111
 112 /* Properly close and free all devices. */
 113 static int clear_instances(void)
 114 {
 115         struct sr_dev_inst *sdi;
 116         struct drv_context *drvc;
 117         struct dev_context *devc;
 118         GSList *l;
 119
 120         if (!(drvc = di->priv))
 121                 return SR_OK;
 122
 123         for (l = drvc->instances; l; l = l->next) {
 124                 if (!(sdi = l->data))
 125                         continue;
 126                 if (!(devc = sdi->priv))
 127                         continue;
 128
 129                 hw_dev_close(sdi);
 130                 sr_usb_dev_inst_free(devc->usb);
 131                 sr_dev_inst_free(sdi);
 132         }
 133
 134         g_slist_free(drvc->instances);
 135         drvc->instances = NULL;
 136
 137         return SR_OK;
 138 }
 139
 140 static int hw_init(struct sr_context *sr_ctx)
 141 {
 142         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
 143 }
 144
 145 static GSList *hw_scan(GSList *options)
 146 {
 147         struct drv_context *drvc;
 148         struct dev_context *devc;
 149         struct sr_dev_inst *sdi;
 150         struct sr_usb_dev_inst *usb;
 151         struct sr_config *src;
 152         struct sr_probe *probe;
 153         libusb_device *dev;
 154         GSList *usb_devices, *devices, *l;
 155         int i;
 156         const char *conn;
 157
 158         (void)options;
 159
 160         drvc = di->priv;
 161
 162         /* USB scan is always authoritative. */
 163         clear_instances();
 164
 165         conn = NULL;
 166         for (l = options; l; l = l->next) {
 167                 src = l->data;
 168                 switch (src->key) {
 169                 case SR_CONF_CONN:
 170                         conn = src->value;
 171                         break;
 172                 }
 173         }
 174         if (!conn)
 175                 conn = OSCI_VIDPID;
 176
 177         devices = NULL;
 178         if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
 179                 for (l = usb_devices; l; l = l->next) {
 180                         usb = l->data;
 181                         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
 182                                         OSCI_VENDOR, OSCI_MODEL, OSCI_VERSION)))
 183                                 return NULL;
 184                         sdi->driver = di;
 185                         for (i = 0; probe_names[i]; i++) {
 186                                 if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
 187                                                 probe_names[i])))
 188                                         return NULL;
 189                                 sdi->probes = g_slist_append(sdi->probes, probe);
 190                         }
 191
 192                         if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
 193                                 return NULL;
 194                         sdi->priv = devc;
 195                         devc->usb = usb;
 196
 197                         if (strcmp(conn, OSCI_VIDPID)) {
 198                                 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 199                                         break;
 200                                 dev = libusb_get_device(usb->devhdl);
 201                                 if (ezusb_upload_firmware(dev, 0, OSCI_FIRMWARE) == SR_OK)
 202                                         /* Remember when the firmware on this device was updated */
 203                                         devc->fw_updated = g_get_monotonic_time();
 204                                 else
 205                                         sr_err("Firmware upload failed for device "
 206                                                         "at bus %d address %d.", usb->bus, usb->address);
 207                         }
 208
 209                         drvc->instances = g_slist_append(drvc->instances, sdi);
 210                         devices = g_slist_append(devices, sdi);
 211                 }
 212                 g_slist_free(usb_devices);
 213         } else
 214                 g_slist_free_full(usb_devices, g_free);
 215
 216         return devices;
 217 }
 218
 219 static GSList *hw_dev_list(void)
 220 {
 221         return ((struct drv_context *)(di->priv))->instances;
 222 }
 223
 224 static int hw_dev_open(struct sr_dev_inst *sdi)
 225 {
 226
 227         /* TODO */
 228         (void)sdi;
 229
 230         return SR_OK;
 231 }
 232
 233 static int hw_dev_close(struct sr_dev_inst *sdi)
 234 {
 235
 236         /* TODO */
 237         (void)sdi;
 238
 239         return SR_OK;
 240 }
 241
 242 static int hw_cleanup(void)
 243 {
 244         clear_instances();
 245
 246         /* TODO */
 247
 248         return SR_OK;
 249 }
 250
 251 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 252 {
 253         int ret;
 254
 255         /* TODO */
 256         (void)value;
 257
 258         if (sdi->status != SR_ST_ACTIVE) {
 259                 sr_err("Device inactive, can't set config options.");
 260                 return SR_ERR;
 261         }
 262
 263         ret = SR_OK;
 264         switch (id) {
 265
 266         default:
 267                 sr_err("Unknown hardware capability: %d.", id);
 268                 ret = SR_ERR_ARG;
 269         }
 270
 271         return ret;
 272 }
 273
 274 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 275 {
 276
 277         (void)sdi;
 278
 279         switch (key) {
 280         default:
 281                 return SR_ERR_ARG;
 282         }
 283
 284         return SR_OK;
 285 }
 286
 287 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 288                                     void *cb_data)
 289 {
 290         /* TODO */
 291         (void)sdi;
 292         (void)cb_data;
 293
 294         return SR_OK;
 295 }
 296
 297 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 298 {
 299         (void)cb_data;
 300
 301         if (sdi->status != SR_ST_ACTIVE) {
 302                 sr_err("Device inactive, can't stop acquisition.");
 303                 return SR_ERR;
 304         }
 305
 306         /* TODO */
 307
 308         return SR_OK;
 309 }
 310
 311 SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info = {
 312         .name = "nexus-osciprime",
 313         .longname = "Nexus OsciPrime",
 314         .api_version = 1,
 315         .init = hw_init,
 316         .cleanup = hw_cleanup,
 317         .scan = hw_scan,
 318         .dev_list = hw_dev_list,
 319         .dev_clear = clear_instances,
 320         .config_get = NULL,
 321         .config_set = config_set,
 322         .config_list = config_list,
 323         .dev_open = hw_dev_open,
 324         .dev_close = hw_dev_close,
 325         .dev_acquisition_start = hw_dev_acquisition_start,
 326         .dev_acquisition_stop = hw_dev_acquisition_stop,
 327         .priv = NULL,
 328 };