]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/ikalogic-scanaplus/api.c
drivers: Provide proper drvopts.
[libsigrok.git] / src / hardware / ikalogic-scanaplus / api.c
index 3bd1b2733c0fb1e34d08e08398a7b35fae47da86..67da9b39c1a3952533aeaa5992e2f78846aef104 100644 (file)
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include "protocol.h"
 
 #define USB_VENDOR_ID                  0x0403
 
 #define SAMPLE_BUF_SIZE                        (8 * 1024 * 1024)
 
-static const uint32_t devopts[] = {
+static const uint32_t drvopts[] = {
        SR_CONF_LOGIC_ANALYZER,
+};
+
+static const uint32_t devopts[] = {
        SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
        SR_CONF_LIMIT_MSEC | SR_CONF_SET,
        SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
@@ -38,54 +41,32 @@ static const uint32_t devopts[] = {
 /* Channels are numbered 1-9. */
 static const char *channel_names[] = {
        "1", "2", "3", "4", "5", "6", "7", "8", "9",
-       NULL,
 };
 
 /* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
-static uint64_t samplerates[1] = { SR_MHZ(100) };
-
-SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
-static struct sr_dev_driver *di = &ikalogic_scanaplus_driver_info;
-
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
+static const uint64_t samplerates[1] = { SR_MHZ(100) };
 
-static void clear_helper(void *priv)
+static void clear_helper(struct dev_context *devc)
 {
-       struct dev_context *devc;
-
-       devc = priv;
-
        ftdi_free(devc->ftdic);
        g_free(devc->compressed_buf);
        g_free(devc->sample_buf);
-       g_free(devc);
 }
 
-static int dev_clear(void)
+static int dev_clear(const struct sr_dev_driver *di)
 {
-       return std_dev_clear(di, clear_helper);
+       return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 }
 
-static int init(struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
-
-static GSList *scan(GSList *options)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        struct sr_dev_inst *sdi;
-       struct drv_context *drvc;
        struct dev_context *devc;
-       GSList *devices;
        unsigned int i;
        int ret;
 
        (void)options;
 
-       drvc = di->priv;
-
-       devices = NULL;
-
        /* Allocate memory for our private device context. */
        devc = g_malloc0(sizeof(struct dev_context));
 
@@ -120,23 +101,18 @@ static GSList *scan(GSList *options)
 
        /* Register the device with libsigrok. */
        sdi = g_malloc0(sizeof(struct sr_dev_inst));
-       sdi->status = SR_ST_INITIALIZING;
+       sdi->status = SR_ST_INACTIVE;
        sdi->vendor = g_strdup(USB_VENDOR_NAME);
        sdi->model = g_strdup(USB_MODEL_NAME);
-       sdi->driver = di;
        sdi->priv = devc;
 
-       for (i = 0; channel_names[i]; i++)
-               sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
-                                   channel_names[i]);
-
-       devices = g_slist_append(devices, sdi);
-       drvc->instances = g_slist_append(drvc->instances, sdi);
+       for (i = 0; i < ARRAY_SIZE(channel_names); i++)
+               sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
 
        /* Close device. We'll reopen it again when we need it. */
        scanaplus_close(devc);
 
-       return devices;
+       return std_scan_complete(di, g_slist_append(NULL, sdi));
 
        scanaplus_close(devc);
 err_free_ftdic:
@@ -151,11 +127,6 @@ err_free_devc:
        return NULL;
 }
 
-static GSList *dev_list(void)
-{
-       return ((struct drv_context *)(di->priv))->instances;
-}
-
 static int dev_open(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
@@ -170,7 +141,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ftdi_get_error_string(devc->ftdic));
                return SR_ERR;
        }
-       sr_dbg("FTDI chip interface A set successfully.");
 
        /* Open the device. */
        ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
@@ -180,7 +150,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ftdi_get_error_string(devc->ftdic));
                return SR_ERR;
        }
-       sr_dbg("FTDI device opened successfully.");
 
        /* Purge RX/TX buffers in the FTDI chip. */
        if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
@@ -188,7 +157,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip buffers purged successfully.");
 
        /* Reset the FTDI bitmode. */
        ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
@@ -197,7 +165,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip bitmode reset successfully.");
 
        /* Set FTDI bitmode to "sync FIFO". */
        ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
@@ -206,7 +173,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip sync FIFO mode entered successfully.");
 
        /* Set the FTDI latency timer to 2. */
        ret = ftdi_set_latency_timer(devc->ftdic, 2);
@@ -215,7 +181,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip latency timer set successfully.");
 
        /* Set the FTDI read data chunk size to 64kB. */
        ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
@@ -224,7 +189,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip read data chunk size set successfully.");
 
        /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
        if ((ret = scanaplus_get_device_id(devc)) < 0) {
@@ -234,38 +198,21 @@ static int dev_open(struct sr_dev_inst *sdi)
        sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
               devc->devid[0], devc->devid[1], devc->devid[2]);
 
-       sdi->status = SR_ST_ACTIVE;
-
        return SR_OK;
 
 err_dev_open_close_ftdic:
        scanaplus_close(devc);
+
        return SR_ERR;
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
-       int ret;
        struct dev_context *devc;
 
-       ret = SR_OK;
        devc = sdi->priv;
 
-       if (sdi->status == SR_ST_ACTIVE) {
-               sr_dbg("Status ACTIVE, closing device.");
-               ret = scanaplus_close(devc);
-       } else {
-               sr_spew("Status not ACTIVE, nothing to do.");
-       }
-
-       sdi->status = SR_ST_INACTIVE;
-
-       return ret;
-}
-
-static int cleanup(void)
-{
-       return dev_clear();
+       return scanaplus_close(devc);
 }
 
 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
@@ -293,9 +240,6 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
 
        (void)cg;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
        switch (key) {
@@ -329,14 +273,9 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        GVariant *gvar;
        GVariantBuilder gvb;
 
-       (void)sdi;
-       (void)cg;
-
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
-               break;
+               return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
        case SR_CONF_SAMPLERATE:
                g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
                gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
@@ -352,24 +291,18 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        return SR_OK;
 }
 
-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)
 {
        int ret;
        struct dev_context *devc;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
-       if (!(devc = sdi->priv))
-               return SR_ERR_BUG;
+       devc = sdi->priv;
 
        if (!devc->ftdic)
                return SR_ERR_BUG;
 
        /* TODO: Configure channels later (thresholds etc.). */
 
-       devc->cb_data = cb_data;
-
        /* Properly reset internal variables before every new acquisition. */
        devc->compressed_bytes_ignored = 0;
        devc->samples_sent = 0;
@@ -381,40 +314,30 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        if ((ret = scanaplus_start_acquisition(devc)) < 0)
                return ret;
 
-       /* Send header packet to the session bus. */
-       std_session_send_df_header(sdi, LOG_PREFIX);
+       std_session_send_df_header(sdi);
 
        /* Hook up a dummy handler to receive data from the device. */
-       sr_session_source_add(sdi->session, -1, G_IO_IN, 0, scanaplus_receive_data, (void *)sdi);
+       sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
 
        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 sr_datafeed_packet packet;
-
-       (void)cb_data;
-
-       sr_dbg("Stopping acquisition.");
        sr_session_source_remove(sdi->session, -1);
-
-       /* Send end packet to the session bus. */
-       sr_dbg("Sending SR_DF_END.");
-       packet.type = SR_DF_END;
-       sr_session_send(sdi, &packet);
+       std_session_send_df_end(sdi);
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
+static struct sr_dev_driver ikalogic_scanaplus_driver_info = {
        .name = "ikalogic-scanaplus",
        .longname = "IKALOGIC ScanaPLUS",
        .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,
@@ -423,5 +346,6 @@ SR_PRIV struct sr_dev_driver ikalogic_scanaplus_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(ikalogic_scanaplus_driver_info);