]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/hantek-dso/api.c
Put driver pointers into special section
[libsigrok.git] / src / hardware / hantek-dso / api.c
index d2eebfbe55754c74571d7f46313ee41d4846d9cd..275bbf99d5f7775bf72ecbf1b5990764e9e29208 100644 (file)
@@ -17,6 +17,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <stdio.h>
 #include <stdint.h>
 #include <stdlib.h>
@@ -29,7 +30,7 @@
 #include <inttypes.h>
 #include <glib.h>
 #include <libusb.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 #include "dso.h"
 
@@ -40,6 +41,8 @@
 #define NUM_TIMEBASE  10
 #define NUM_VDIV      8
 
+#define NUM_BUFFER_SIZES 2
+
 static const uint32_t scanopts[] = {
        SR_CONF_CONN,
 };
@@ -49,7 +52,7 @@ static const uint32_t drvopts[] = {
 };
 
 static const uint32_t devopts[] = {
-       SR_CONF_CONTINUOUS | SR_CONF_SET,
+       SR_CONF_CONTINUOUS,
        SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
        SR_CONF_CONN | SR_CONF_GET,
        SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
@@ -69,41 +72,40 @@ static const uint32_t devopts_cg[] = {
 
 static const char *channel_names[] = {
        "CH1", "CH2",
-       NULL,
 };
 
 static const uint64_t buffersizes_32k[] = {
-       10240, 32768,
+       (10 * 1024), (32 * 1024),
 };
 static const uint64_t buffersizes_512k[] = {
-       10240, 524288,
+       (10 * 1024), (512 * 1024),
 };
 static const uint64_t buffersizes_14k[] = {
-       10240, 14336,
+       (10 * 1024), (14 * 1024),
 };
 
 static const struct dso_profile dev_profiles[] = {
        {       0x04b4, 0x2090, 0x04b5, 0x2090,
                "Hantek", "DSO-2090",
                buffersizes_32k,
-               FIRMWARE_DIR "/hantek-dso-2090.fw" },
+               "hantek-dso-2090.fw" },
        {       0x04b4, 0x2150, 0x04b5, 0x2150,
                "Hantek", "DSO-2150",
                buffersizes_32k,
-               FIRMWARE_DIR "/hantek-dso-2150.fw" },
+               "hantek-dso-2150.fw" },
        {       0x04b4, 0x2250, 0x04b5, 0x2250,
                "Hantek", "DSO-2250",
                buffersizes_512k,
-               FIRMWARE_DIR "/hantek-dso-2250.fw" },
+               "hantek-dso-2250.fw" },
        {       0x04b4, 0x5200, 0x04b5, 0x5200,
                "Hantek", "DSO-5200",
                buffersizes_14k,
-               FIRMWARE_DIR "/hantek-dso-5200.fw" },
+               "hantek-dso-5200.fw" },
        {       0x04b4, 0x520a, 0x04b5, 0x520a,
                "Hantek", "DSO-5200A",
                buffersizes_512k,
-               FIRMWARE_DIR "/hantek-dso-5200A.fw" },
-       { 0, 0, 0, 0, 0, 0, 0, 0 },
+               "hantek-dso-5200A.fw" },
+       ALL_ZERO
 };
 
 static const uint64_t timebases[][2] = {
@@ -158,11 +160,10 @@ static const char *coupling[] = {
        "GND",
 };
 
-SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
-
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
+static int dev_acquisition_stop(struct sr_dev_inst *sdi);
 
-static struct sr_dev_inst *dso_dev_new(const struct dso_profile *prof)
+static struct sr_dev_inst *dso_dev_new(struct sr_dev_driver *di,
+       const struct dso_profile *prof)
 {
        struct sr_dev_inst *sdi;
        struct sr_channel *ch;
@@ -175,13 +176,13 @@ static struct sr_dev_inst *dso_dev_new(const struct dso_profile *prof)
        sdi->status = SR_ST_INITIALIZING;
        sdi->vendor = g_strdup(prof->vendor);
        sdi->model = g_strdup(prof->model);
-       sdi->driver = &hantek_dso_driver_info;
+       sdi->driver = di;
 
        /*
         * Add only the real channels -- EXT isn't a source of data, only
         * a trigger source internal to the device.
         */
-       for (i = 0; channel_names[i]; i++) {
+       for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
                ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
                cg = g_malloc0(sizeof(struct sr_channel_group));
                cg->name = g_strdup(channel_names[i]);
@@ -207,7 +208,7 @@ static struct sr_dev_inst *dso_dev_new(const struct dso_profile *prof)
        devc->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
        devc->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
        sdi->priv = devc;
-       drvc = hantek_dso_driver_info.priv;
+       drvc = di->context;
        drvc->instances = g_slist_append(drvc->instances, sdi);
 
        return sdi;
@@ -252,11 +253,6 @@ static int dev_clear(const struct sr_dev_driver *di)
        return std_dev_clear(di, clear_dev_context);
 }
 
-static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
-
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        struct drv_context *drvc;
@@ -268,11 +264,11 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        GSList *l, *devices, *conn_devices;
        struct libusb_device_descriptor des;
        libusb_device **devlist;
-       int ret, i, j;
+       int i, j;
        const char *conn;
        char connection_id[64];
 
-       drvc = di->priv;
+       drvc = di->context;
 
        devices = 0;
 
@@ -306,11 +302,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                                continue;
                }
 
-               if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
-                       sr_err("Failed to get device descriptor: %s.",
-                                       libusb_error_name(ret));
-                       continue;
-               }
+               libusb_get_device_descriptor(devlist[i], &des);
 
                usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 
@@ -321,12 +313,12 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                                /* Device matches the pre-firmware profile. */
                                prof = &dev_profiles[j];
                                sr_dbg("Found a %s %s.", prof->vendor, prof->model);
-                               sdi = dso_dev_new(prof);
+                               sdi = dso_dev_new(di, prof);
                                sdi->connection_id = g_strdup(connection_id);
                                devices = g_slist_append(devices, sdi);
                                devc = sdi->priv;
-                               if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
-                                               prof->firmware) == SR_OK)
+                               if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
+                                               USB_CONFIGURATION, prof->firmware) == SR_OK)
                                        /* Remember when the firmware on this device was updated */
                                        devc->fw_updated = g_get_monotonic_time();
                                else
@@ -340,7 +332,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                                /* Device matches the post-firmware profile. */
                                prof = &dev_profiles[j];
                                sr_dbg("Found a %s %s.", prof->vendor, prof->model);
-                               sdi = dso_dev_new(prof);
+                               sdi = dso_dev_new(di, prof);
                                sdi->connection_id = g_strdup(connection_id);
                                sdi->status = SR_ST_INACTIVE;
                                devices = g_slist_append(devices, sdi);
@@ -360,11 +352,6 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        return devices;
 }
 
-static GSList *dev_list(const struct sr_dev_driver *di)
-{
-       return ((struct drv_context *)(di->priv))->instances;
-}
-
 static int dev_open(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
@@ -393,7 +380,7 @@ static int dev_open(struct sr_dev_inst *sdi)
                        timediff_ms = timediff_us / 1000;
                        sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
                }
-               sr_info("Device came back after %d ms.", timediff_ms);
+               sr_info("Device came back after %" PRIi64 " ms.", timediff_ms);
        } else {
                err = dso_open(sdi);
        }
@@ -420,17 +407,13 @@ static int dev_close(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static int cleanup(const struct sr_dev_driver *di)
-{
-       return dev_clear(di);
-}
-
 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        struct sr_usb_dev_inst *usb;
-       char str[128], *s;
+       char str[128];
+       const char *s;
        const uint64_t *vdiv;
        int ch_idx;
 
@@ -471,10 +454,7 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                        *data = g_variant_new_string(devc->triggersource);
                        break;
                case SR_CONF_TRIGGER_SLOPE:
-                       if (devc->triggerslope == SLOPE_POSITIVE)
-                               s = "r";
-                       else
-                               s = "f";
+                       s = (devc->triggerslope == SLOPE_POSITIVE) ? "r" : "f";
                        *data = g_variant_new_string(s);
                        break;
                case SR_CONF_HORIZ_TRIGGERPOS:
@@ -490,7 +470,7 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                        ch_idx = 1;
                else
                        return SR_ERR_ARG;
-               switch(key) {
+               switch (key) {
                case SR_CONF_FILTER:
                        *data = g_variant_new_boolean(devc->filter[ch_idx]);
                        break;
@@ -544,13 +524,13 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                        break;
                case SR_CONF_BUFFERSIZE:
                        tmp_u64 = g_variant_get_uint64(data);
-                       for (i = 0; i < 2; i++) {
+                       for (i = 0; i < NUM_BUFFER_SIZES; i++) {
                                if (devc->profile->buffersizes[i] == tmp_u64) {
                                        devc->framesize = tmp_u64;
                                        break;
                                }
                        }
-                       if (i == 2)
+                       if (i == NUM_BUFFER_SIZES)
                                ret = SR_ERR_ARG;
                        break;
                case SR_CONF_TIMEBASE:
@@ -649,7 +629,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                return SR_ERR_ARG;
 
        if (!cg) {
-       switch (key) {
+               switch (key) {
                case SR_CONF_DEVICE_OPTIONS:
                        *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
                                        devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
@@ -659,7 +639,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                                return SR_ERR_ARG;
                        devc = sdi->priv;
                        *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
-                                       devc->profile->buffersizes, 2, sizeof(uint64_t));
+                                       devc->profile->buffersizes, NUM_BUFFER_SIZES, sizeof(uint64_t));
                        break;
                case SR_CONF_TIMEBASE:
                        g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
@@ -683,7 +663,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                        return SR_ERR_NA;
                }
        } else {
-       switch (key) {
+               switch (key) {
                case SR_CONF_DEVICE_OPTIONS:
                        *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
                                        devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
@@ -713,14 +693,14 @@ static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
                int num_samples)
 {
        struct sr_datafeed_packet packet;
-       struct sr_datafeed_analog analog;
+       struct sr_datafeed_analog_old analog;
        struct dev_context *devc;
        float ch1, ch2, range;
        int num_channels, data_offset, i;
 
        devc = sdi->priv;
        num_channels = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
-       packet.type = SR_DF_ANALOG;
+       packet.type = SR_DF_ANALOG_OLD;
        packet.payload = &analog;
        /* TODO: support for 5xxx series 9-bit samples */
        analog.channels = devc->enabled_channels;
@@ -759,7 +739,8 @@ static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
                        analog.data[data_offset++] = ch2;
                }
        }
-       sr_session_send(devc->cb_data, &packet);
+       sr_session_send(sdi, &packet);
+       g_free(analog.data);
 }
 
 /*
@@ -768,7 +749,7 @@ static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
  * queued up beforehand, so this just needs to chuck the incoming data onto
  * the libsigrok session bus.
  */
-static void receive_transfer(struct libusb_transfer *transfer)
+static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
 {
        struct sr_datafeed_packet packet;
        struct sr_dev_inst *sdi;
@@ -777,8 +758,8 @@ static void receive_transfer(struct libusb_transfer *transfer)
 
        sdi = transfer->user_data;
        devc = sdi->priv;
-       sr_spew("receive_transfer(): status %d received %d bytes.",
-                  transfer->status, transfer->actual_length);
+       sr_spew("receive_transfer(): status %s received %d bytes.",
+               libusb_error_name(transfer->status), transfer->actual_length);
 
        if (transfer->actual_length == 0)
                /* Nothing to send to the bus. */
@@ -828,8 +809,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
                }
        } else {
                /* Already past the trigger point, just send it all out. */
-               send_chunk(sdi, transfer->buffer,
-                               num_samples);
+               send_chunk(sdi, transfer->buffer, num_samples);
        }
 
        devc->samp_received += num_samples;
@@ -848,7 +828,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
 
                /* Mark the end of this frame. */
                packet.type = SR_DF_FRAME_END;
-               sr_session_send(devc->cb_data, &packet);
+               sr_session_send(sdi, &packet);
 
                if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
                        /* Terminate session */
@@ -876,7 +856,7 @@ static int handle_event(int fd, int revents, void *cb_data)
 
        sdi = cb_data;
        di = sdi->driver;
-       drvc = di->priv;
+       drvc = di->context;
        devc = sdi->priv;
        if (devc->dev_state == STOPPING) {
                /* We've been told to wind up the acquisition. */
@@ -887,8 +867,7 @@ static int handle_event(int fd, int revents, void *cb_data)
                 */
                usb_source_remove(sdi->session, drvc->sr_ctx);
 
-               packet.type = SR_DF_END;
-               sr_session_send(sdi, &packet);
+               std_session_send_df_end(sdi, LOG_PREFIX);
 
                devc->dev_state = IDLE;
 
@@ -940,8 +919,7 @@ static int handle_event(int fd, int revents, void *cb_data)
                devc->trigger_offset = trigger_offset;
 
                num_channels = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
-               /* TODO: Check malloc return value. */
-               devc->framebuf = g_try_malloc(devc->framesize * num_channels * 2);
+               devc->framebuf = g_malloc(devc->framesize * num_channels * 2);
                devc->samp_buffered = devc->samp_received = 0;
 
                /* Tell the scope to send us the first frame. */
@@ -973,17 +951,16 @@ static int handle_event(int fd, int revents, void *cb_data)
        return TRUE;
 }
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        struct sr_dev_driver *di = sdi->driver;
-       struct drv_context *drvc = di->priv;
+       struct drv_context *drvc = di->context;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
        devc = sdi->priv;
-       devc->cb_data = cb_data;
 
        if (configure_channels(sdi) != SR_OK) {
                sr_err("Failed to configure channels.");
@@ -999,18 +976,15 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        devc->dev_state = CAPTURE;
        usb_source_add(sdi->session, drvc->sr_ctx, TICK, handle_event, (void *)sdi);
 
-       /* Send header packet to the session bus. */
-       std_session_send_df_header(cb_data, LOG_PREFIX);
+       std_session_send_df_header(sdi, LOG_PREFIX);
 
        return SR_OK;
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
-       (void)cb_data;
-
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR;
 
@@ -1020,14 +994,14 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
+static struct sr_dev_driver hantek_dso_driver_info = {
        .name = "hantek-dso",
        .longname = "Hantek DSO",
        .api_version = 1,
-       .init = init,
-       .cleanup = cleanup,
+       .init = std_init,
+       .cleanup = std_cleanup,
        .scan = scan,
-       .dev_list = dev_list,
+       .dev_list = std_dev_list,
        .dev_clear = dev_clear,
        .config_get = config_get,
        .config_set = config_set,
@@ -1036,5 +1010,6 @@ SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
        .dev_close = dev_close,
        .dev_acquisition_start = dev_acquisition_start,
        .dev_acquisition_stop = dev_acquisition_stop,
-       .priv = NULL,
+       .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(hantek_dso_driver_info);