]> sigrok.org Git - libsigrok.git/blobdiff - hwdriver.c
New driver API function: config_list()
[libsigrok.git] / hwdriver.c
index d739be42c53ba86a680b6cb0c45e3d6f8aeeebd9..439d4c78e9ac6ecdf2a4ef1ead932f288febf798 100644 (file)
  * @{
  */
 
-/* Driver scanning options. */
-static struct sr_hwcap_option sr_drvopts[] = {
-       {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"},
-       {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"},
-       {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"},
-       {0, 0, NULL, NULL},
-};
-
-/* Device instance options. */
-static struct sr_hwcap_option sr_devopts[] = {
-       {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
-       {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
-       {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"},
-       {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
-       {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "Trigger slope", "triggerslope"},
-       {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "Trigger source", "triggersource"},
-       {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position",
-                       "horiz_triggerpos"},
-       {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"},
-       {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"},
-       {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"},
-       {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"},
-       {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"},
-       {0, 0, NULL, NULL},
+static struct sr_config_info sr_config_info_data[] = {
+       {SR_CONF_CONN, SR_T_CHAR, "conn",
+               "Connection", NULL},
+       {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
+               "Serial communication", NULL},
+       {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
+               "Sample rate", NULL},
+       {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
+               "Pre-trigger capture ratio", NULL},
+       {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
+               "Pattern generator mode", NULL},
+       {SR_CONF_RLE, SR_T_BOOL, "rle",
+               "Run Length Encoding", NULL},
+       {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
+               "Trigger slope", NULL},
+       {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
+               "Trigger source", NULL},
+       {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
+               "Horizontal trigger position", NULL},
+       {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
+               "Buffer size", NULL},
+       {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
+               "Time base", NULL},
+       {SR_CONF_FILTER, SR_T_CHAR, "filter",
+               "Filter targets", NULL},
+       {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
+               "Volts/div", NULL},
+       {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
+               "Coupling", NULL},
+       {0, 0, NULL, NULL, NULL},
 };
 
 /** @cond PRIVATE */
+#ifdef HAVE_HW_COLEAD_SLM
+extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
+#endif
 #ifdef HAVE_LA_DEMO
 extern SR_PRIV struct sr_dev_driver demo_driver_info;
 #endif
+#ifdef HAVE_HW_LASCAR_EL_USB
+extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
+#endif
+#ifdef HAVE_HW_NEXUS_OSCIPRIME
+extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
+#endif
 #ifdef HAVE_LA_OLS
 extern SR_PRIV struct sr_dev_driver ols_driver_info;
 #endif
+#ifdef HAVE_HW_RIGOL_DS1XX2
+extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
+#endif
+#ifdef HAVE_HW_TONDAJ_SL_814
+extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
+#endif
+#ifdef HAVE_HW_VICTOR_DMM
+extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
+#endif
 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 #endif
@@ -86,7 +110,7 @@ extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 #ifdef HAVE_LA_LINK_MSO19
 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 #endif
-#ifdef HAVE_LA_ALSA
+#ifdef HAVE_HW_ALSA
 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 #endif
 #ifdef HAVE_LA_FX2LAFW
@@ -95,20 +119,27 @@ extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 #ifdef HAVE_HW_HANTEK_DSO
 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 #endif
-#ifdef HAVE_HW_GENERICDMM
-extern SR_PRIV struct sr_dev_driver genericdmm_driver_info;
-#endif
 #ifdef HAVE_HW_AGILENT_DMM
 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
 #endif
 #ifdef HAVE_HW_FLUKE_DMM
 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
 #endif
-#ifdef HAVE_HW_RADIOSHACK_DMM
-extern SR_PRIV struct sr_dev_driver radioshackdmm_driver_info;
-#endif
-#ifdef HAVE_HW_TEKPOWER_DMM
-extern SR_PRIV struct sr_dev_driver tekpower_dmm_driver_info;
+#ifdef HAVE_HW_SERIAL_DMM
+extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
+extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
+extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
+extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
+extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
+extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
+extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
+extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
+extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
+extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
+extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
+extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
+extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
+extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 #endif
 #ifdef HAVE_HW_UNI_T_DMM
 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
@@ -117,12 +148,30 @@ extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 /** @endcond */
 
 static struct sr_dev_driver *drivers_list[] = {
+#ifdef HAVE_HW_COLEAD_SLM
+       &colead_slm_driver_info,
+#endif
 #ifdef HAVE_LA_DEMO
        &demo_driver_info,
 #endif
+#ifdef HAVE_HW_LASCAR_EL_USB
+       &lascar_el_usb_driver_info,
+#endif
+#ifdef HAVE_HW_NEXUS_OSCIPRIME
+       &nexus_osciprime_driver_info,
+#endif
 #ifdef HAVE_LA_OLS
        &ols_driver_info,
 #endif
+#ifdef HAVE_HW_RIGOL_DS1XX2
+       &rigol_ds1xx2_driver_info,
+#endif
+#ifdef HAVE_HW_TONDAJ_SL_814
+       &tondaj_sl_814_driver_info,
+#endif
+#ifdef HAVE_HW_VICTOR_DMM
+       &victor_dmm_driver_info,
+#endif
 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
        &zeroplus_logic_cube_driver_info,
 #endif
@@ -135,7 +184,7 @@ static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_LA_LINK_MSO19
        &link_mso19_driver_info,
 #endif
-#ifdef HAVE_LA_ALSA
+#ifdef HAVE_HW_ALSA
        &alsa_driver_info,
 #endif
 #ifdef HAVE_LA_FX2LAFW
@@ -144,20 +193,27 @@ static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_HW_HANTEK_DSO
        &hantek_dso_driver_info,
 #endif
-#ifdef HAVE_HW_GENERICDMM
-       &genericdmm_driver_info,
-#endif
 #ifdef HAVE_HW_AGILENT_DMM
        &agdmm_driver_info,
 #endif
 #ifdef HAVE_HW_FLUKE_DMM
        &flukedmm_driver_info,
 #endif
-#ifdef HAVE_HW_RADIOSHACK_DMM
-       &radioshackdmm_driver_info,
-#endif
-#ifdef HAVE_HW_TEKPOWER_DMM
-       &tekpower_dmm_driver_info,
+#ifdef HAVE_HW_SERIAL_DMM
+       &digitek_dt4000zc_driver_info,
+       &tekpower_tp4000zc_driver_info,
+       &metex_me31_driver_info,
+       &peaktech_3410_driver_info,
+       &mastech_mas345_driver_info,
+       &va_va18b_driver_info,
+       &metex_m3640d_driver_info,
+       &peaktech_4370_driver_info,
+       &pce_pce_dm32_driver_info,
+       &radioshack_22_168_driver_info,
+       &radioshack_22_812_driver_info,
+       &voltcraft_vc820_ser_driver_info,
+       &voltcraft_vc840_ser_driver_info,
+       &uni_t_ut61e_ser_driver_info,
 #endif
 #ifdef HAVE_HW_UNI_T_DMM
        &uni_t_ut61d_driver_info,
@@ -180,15 +236,17 @@ SR_API struct sr_dev_driver **sr_driver_list(void)
 /**
  * Initialize a hardware driver.
  *
+ * @param ctx A libsigrok context object allocated by a previous call to
+ *             sr_init().
  * @param driver The driver to initialize.
  *
  * @return SR_OK if all went well, or an error code otherwise.
  */
-SR_API int sr_driver_init(struct sr_dev_driver *driver)
+SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 {
 
        if (driver->init)
-               return driver->init();
+               return driver->init(ctx);
 
        return SR_OK;
 }
@@ -233,11 +291,23 @@ SR_PRIV void sr_hw_cleanup_all(void)
        }
 }
 
+SR_PRIV struct sr_config *sr_config_make(int key, const void *value)
+{
+       struct sr_config *src;
+
+       if (!(src = g_try_malloc(sizeof(struct sr_config))))
+               return NULL;
+       src->key = key;
+       src->value = value;
+
+       return src;
+}
+
 /**
  * Returns information about the given driver or device instance.
  *
  * @param driver The sr_dev_driver struct to query.
- * @param id The type of information, in the form of an SR_HWCAP_* option.
+ * @param id The type of information, in the form of an SR_CONF_* option.
  * @param data Pointer where the value. will be stored. Must not be NULL.
  * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
  *
@@ -254,7 +324,23 @@ SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
        if (driver == NULL || data == NULL)
                return SR_ERR;
 
-       ret = driver->info_get(id, data, sdi);
+       ret = driver->config_get(id, data, sdi);
+
+       return ret;
+}
+
+SR_API int sr_config_list(struct sr_dev_driver *driver, int id,
+               const void **data, const struct sr_dev_inst *sdi)
+{
+       int ret;
+
+       if (driver == NULL || data == NULL)
+               return SR_ERR;
+
+       if (!driver->config_list)
+               return SR_ERR;
+
+       ret = driver->config_list(id, data, sdi);
 
        return ret;
 }
@@ -279,7 +365,7 @@ SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
                return FALSE;
        }
 
-       if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
+       if (driver->config_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
                return FALSE;
 
        for (i = 0; hwcaps[i]; i++) {
@@ -291,80 +377,40 @@ SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 }
 
 /**
- * Get information about a hardware driver option.
- *
- * @param opt The option to get.
- *
- * @return A pointer to a struct sr_hwcap_option, or NULL if the option
- *         was not found.
- */
-SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt)
-{
-       int i;
-
-       for (i = 0; sr_drvopts[i].hwcap; i++) {
-               if (sr_drvopts[i].hwcap == opt)
-                       return &sr_drvopts[i];
-       }
-
-       return NULL;
-}
-
-/**
- * Get information about a hardware driver option, by name.
- *
- * @param optname The name of the option to get.
- *
- * @return A pointer to a struct sr_hwcap_option, or NULL if the option
- *         was not found.
- */
-SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname)
-{
-       int i;
-
-       for (i = 0; sr_drvopts[i].hwcap; i++) {
-               if (!strcmp(sr_drvopts[i].shortname, optname))
-                       return &sr_drvopts[i];
-       }
-
-       return NULL;
-}
-
-/**
- * Get information about a device option.
+ * Get information about an sr_config key.
  *
- * @param opt The option to get.
+ * @param opt The sr_config key.
  *
- * @return A pointer to a struct sr_hwcap_option, or NULL if the option
+ * @return A pointer to a struct sr_config_info, or NULL if the key
  *         was not found.
  */
-SR_API const struct sr_hwcap_option *sr_devopt_get(int opt)
+SR_API const struct sr_config_info *sr_config_info_get(int key)
 {
        int i;
 
-       for (i = 0; sr_devopts[i].hwcap; i++) {
-               if (sr_devopts[i].hwcap == opt)
-                       return &sr_devopts[i];
+       for (i = 0; sr_config_info_data[i].key; i++) {
+               if (sr_config_info_data[i].key == key)
+                       return &sr_config_info_data[i];
        }
 
        return NULL;
 }
 
 /**
- * Get information about a device option, by name.
+ * Get information about an sr_config key, by name.
  *
- * @param optname The name of the option to get.
+ * @param optname The sr_config key.
  *
- * @return A pointer to a struct sr_hwcap_option, or NULL if the option
+ * @return A pointer to a struct sr_config_info, or NULL if the key
  *         was not found.
  */
-SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname)
+SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 {
        int i;
 
-       for (i = 0; sr_devopts[i].hwcap; i++) {
-               if (!strcmp(sr_devopts[i].shortname, optname))
-                       return &sr_devopts[i];
+       for (i = 0; sr_config_info_data[i].key; i++) {
+               if (!strcmp(sr_config_info_data[i].id, optname))
+                       return &sr_config_info_data[i];
        }
 
        return NULL;