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         struct drv_context *drvc;
 143
 144         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
 145                 sr_err("Driver context malloc failed.");
 146                 return SR_ERR_MALLOC;
 147         }
 148
 149         drvc->sr_ctx = sr_ctx;
 150         di->priv = drvc;
 151
 152         return SR_OK;
 153 }
 154
 155 static GSList *hw_scan(GSList *options)
 156 {
 157         struct drv_context *drvc;
 158         struct dev_context *devc;
 159         struct sr_dev_inst *sdi;
 160         struct sr_usb_dev_inst *usb;
 161         struct sr_config *src;
 162         struct sr_probe *probe;
 163         libusb_device *dev;
 164         GSList *usb_devices, *devices, *l;
 165         int i;
 166         const char *conn;
 167
 168         (void)options;
 169
 170         if (!(drvc = di->priv)) {
 171                 sr_err("Driver was not initialized.");
 172                 return NULL;
 173         }
 174
 175         /* USB scan is always authoritative. */
 176         clear_instances();
 177
 178         conn = NULL;
 179         for (l = options; l; l = l->next) {
 180                 src = l->data;
 181                 switch (src->key) {
 182                 case SR_CONF_CONN:
 183                         conn = src->value;
 184                         break;
 185                 }
 186         }
 187         if (!conn)
 188                 conn = OSCI_VIDPID;
 189
 190         devices = NULL;
 191         if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
 192                 for (l = usb_devices; l; l = l->next) {
 193                         usb = l->data;
 194                         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
 195                                         OSCI_VENDOR, OSCI_MODEL, OSCI_VERSION)))
 196                                 return NULL;
 197                         sdi->driver = di;
 198                         for (i = 0; probe_names[i]; i++) {
 199                                 if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
 200                                                 probe_names[i])))
 201                                         return NULL;
 202                                 sdi->probes = g_slist_append(sdi->probes, probe);
 203                         }
 204
 205                         if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
 206                                 return NULL;
 207                         sdi->priv = devc;
 208                         devc->usb = usb;
 209
 210                         if (strcmp(conn, OSCI_VIDPID)) {
 211                                 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 212                                         break;
 213                                 dev = libusb_get_device(usb->devhdl);
 214                                 if (ezusb_upload_firmware(dev, 0, OSCI_FIRMWARE) == SR_OK)
 215                                         /* Remember when the firmware on this device was updated */
 216                                         devc->fw_updated = g_get_monotonic_time();
 217                                 else
 218                                         sr_err("Firmware upload failed for device "
 219                                                         "at bus %d address %d.", usb->bus, usb->address);
 220                         }
 221
 222                         drvc->instances = g_slist_append(drvc->instances, sdi);
 223                         devices = g_slist_append(devices, sdi);
 224                 }
 225                 g_slist_free(usb_devices);
 226         } else
 227                 g_slist_free_full(usb_devices, g_free);
 228
 229         return devices;
 230 }
 231
 232 static GSList *hw_dev_list(void)
 233 {
 234         struct drv_context *drvc;
 235
 236         drvc = di->priv;
 237
 238         return drvc->instances;
 239 }
 240
 241 static int hw_dev_open(struct sr_dev_inst *sdi)
 242 {
 243
 244         /* TODO */
 245         (void)sdi;
 246
 247         return SR_OK;
 248 }
 249
 250 static int hw_dev_close(struct sr_dev_inst *sdi)
 251 {
 252
 253         /* TODO */
 254         (void)sdi;
 255
 256         return SR_OK;
 257 }
 258
 259 static int hw_cleanup(void)
 260 {
 261         clear_instances();
 262
 263         /* TODO */
 264
 265         return SR_OK;
 266 }
 267
 268 static int hw_info_get(int info_id, const void **data,
 269                        const struct sr_dev_inst *sdi)
 270 {
 271         /* TODO */
 272         (void)data;
 273         (void)sdi;
 274
 275         switch (info_id) {
 276         default:
 277                 return SR_ERR_ARG;
 278         }
 279
 280         return SR_OK;
 281 }
 282
 283 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 284                              const void *value)
 285 {
 286         int ret;
 287
 288         /* TODO */
 289         (void)value;
 290
 291         if (sdi->status != SR_ST_ACTIVE) {
 292                 sr_err("Device inactive, can't set config options.");
 293                 return SR_ERR;
 294         }
 295
 296         ret = SR_OK;
 297         switch (hwcap) {
 298
 299         default:
 300                 sr_err("Unknown hardware capability: %d.", hwcap);
 301                 ret = SR_ERR_ARG;
 302         }
 303
 304         return ret;
 305 }
 306
 307 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 308                                     void *cb_data)
 309 {
 310         /* TODO */
 311         (void)sdi;
 312         (void)cb_data;
 313
 314         return SR_OK;
 315 }
 316
 317 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 318 {
 319         (void)cb_data;
 320
 321         if (sdi->status != SR_ST_ACTIVE) {
 322                 sr_err("Device inactive, can't stop acquisition.");
 323                 return SR_ERR;
 324         }
 325
 326         /* TODO */
 327
 328         return SR_OK;
 329 }
 330
 331 SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info = {
 332         .name = "nexus-osciprime",
 333         .longname = "Nexus OsciPrime",
 334         .api_version = 1,
 335         .init = hw_init,
 336         .cleanup = hw_cleanup,
 337         .scan = hw_scan,
 338         .dev_list = hw_dev_list,
 339         .dev_clear = clear_instances,
 340         .dev_open = hw_dev_open,
 341         .dev_close = hw_dev_close,
 342         .info_get = hw_info_get,
 343         .dev_config_set = hw_dev_config_set,
 344         .dev_acquisition_start = hw_dev_acquisition_start,
 345         .dev_acquisition_stop = hw_dev_acquisition_stop,
 346         .priv = NULL,
 347 };