]> sigrok.org Git - libsigrok.git/blobdiff - hwdriver.c
brymen-bm86x: actual driver implementation
[libsigrok.git] / hwdriver.c
index 300bfe66aa98b8af2ac8432542814c72f2df749f..b62fdd41c643aee802656409a86fc9e459c2cd17 100644 (file)
@@ -53,7 +53,7 @@ static struct sr_config_info sr_config_info_data[] = {
        {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},
+               "Pattern", NULL},
        {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
                "Trigger types", NULL},
        {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
@@ -62,7 +62,7 @@ static struct sr_config_info sr_config_info_data[] = {
                "Swap channel order", NULL},
        {SR_CONF_RLE, SR_T_BOOL, "rle",
                "Run Length Encoding", NULL},
-       {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
+       {SR_CONF_TRIGGER_SLOPE, SR_T_CHAR, "triggerslope",
                "Trigger slope", NULL},
        {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
                "Trigger source", NULL},
@@ -100,6 +100,26 @@ static struct sr_config_info sr_config_info_data[] = {
                "Number of logic probes", NULL},
        {SR_CONF_NUM_ANALOG_PROBES, SR_T_INT32, "analog_probes",
                "Number of analog probes", NULL},
+       {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage",
+               "Current output voltage", NULL},
+       {SR_CONF_OUTPUT_VOLTAGE_MAX, SR_T_FLOAT, "output_voltage_max",
+               "Maximum output voltage", NULL},
+       {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
+               "Current output current", NULL},
+       {SR_CONF_OUTPUT_CURRENT_MAX, SR_T_FLOAT, "output_current_max",
+               "Maximum output current", NULL},
+       {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
+               "Output enabled", NULL},
+       {SR_CONF_OUTPUT_CHANNEL, SR_T_CHAR, "output_channel",
+               "Output channel modes", NULL},
+       {SR_CONF_OVER_VOLTAGE_PROTECTION, SR_T_BOOL, "ovp",
+               "Over-voltage protection", NULL},
+       {SR_CONF_OVER_CURRENT_PROTECTION, SR_T_BOOL, "ocp",
+               "Over-current protection", NULL},
+       {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
+               "Sample limit", NULL},
+       {SR_CONF_CLOCK_EDGE, SR_T_CHAR, "clock_edge",
+               "Clock edge", NULL},
        {0, 0, NULL, NULL, NULL},
 };
 
@@ -107,6 +127,12 @@ static struct sr_config_info sr_config_info_data[] = {
 #ifdef HAVE_HW_APPA_55II
 extern SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
 #endif
+#ifdef HAVE_HW_ATTEN_PPS3XXX
+extern SR_PRIV struct sr_dev_driver atten_pps3203_driver_info;
+#endif
+#ifdef HAVE_HW_BRYMEN_BM86X
+extern SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info;
+#endif
 #ifdef HAVE_HW_BRYMEN_DMM
 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
 #endif
@@ -120,11 +146,15 @@ extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
 #ifdef HAVE_HW_COLEAD_SLM
 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
 #endif
+#ifdef HAVE_HW_CONRAD_DIGI_35_CPU
+extern SR_PRIV struct sr_dev_driver conrad_digi_35_cpu_driver_info;
+#endif
 #ifdef HAVE_HW_DEMO
 extern SR_PRIV struct sr_dev_driver demo_driver_info;
 #endif
 #ifdef HAVE_HW_GMC_MH_1X_2X
 extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
+extern SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info;
 #endif
 #ifdef HAVE_HW_HAMEG_HMO
 extern SR_PRIV struct sr_dev_driver hameg_hmo_driver_info;
@@ -157,6 +187,9 @@ extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
 #ifdef HAVE_HW_SALEAE_LOGIC16
 extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
 #endif
+#ifdef HAVE_HW_SYSCLK_LWLA
+extern SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
+#endif
 #ifdef HAVE_HW_TELEINFO
 extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
 #endif
@@ -226,6 +259,7 @@ extern SR_PRIV struct sr_dev_driver uni_t_ut61c_ser_driver_info;
 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
+extern SR_PRIV struct sr_dev_driver tenma_72_7745_ser_driver_info;
 extern SR_PRIV struct sr_dev_driver tenma_72_7750_ser_driver_info;
 #endif
 #ifdef HAVE_HW_UNI_T_DMM
@@ -249,6 +283,12 @@ static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_HW_APPA_55II
        &appa_55ii_driver_info,
 #endif
+#ifdef HAVE_HW_ATTEN_PPS3XXX
+       &atten_pps3203_driver_info,
+#endif
+#ifdef HAVE_HW_BRYMEN_BM86X
+       &brymen_bm86x_driver_info,
+#endif
 #ifdef HAVE_HW_BRYMEN_DMM
        &brymen_bm857_driver_info,
 #endif
@@ -262,11 +302,15 @@ static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_HW_COLEAD_SLM
        &colead_slm_driver_info,
 #endif
+#ifdef HAVE_HW_CONRAD_DIGI_35_CPU
+       &conrad_digi_35_cpu_driver_info,
+#endif
 #ifdef HAVE_HW_DEMO
        &demo_driver_info,
 #endif
 #ifdef HAVE_HW_GMC_MH_1X_2X
        &gmc_mh_1x_2x_rs232_driver_info,
+    &gmc_mh_2x_bd232_driver_info,
 #endif
 #ifdef HAVE_HW_HAMEG_HMO
        &hameg_hmo_driver_info,
@@ -299,6 +343,9 @@ static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_HW_SALEAE_LOGIC16
        &saleae_logic16_driver_info,
 #endif
+#ifdef HAVE_HW_SYSCLK_LWLA
+       &sysclk_lwla_driver_info,
+#endif
 #ifdef HAVE_HW_TELEINFO
        &teleinfo_driver_info,
 #endif
@@ -412,9 +459,10 @@ SR_API struct sr_dev_driver **sr_driver_list(void)
  * @param driver The driver to initialize. This must be a pointer to one of
  *               the entries returned by sr_driver_list(). Must not be NULL.
  *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
- *         SR_ERR_BUG upon internal errors, or another negative error code
- *         upon other errors.
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid parameter(s).
+ * @retval SR_ERR_BUG Internal errors.
+ * @retval other Another negative error code upon other errors.
  */
 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 {
@@ -482,7 +530,8 @@ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
        return l;
 }
 
-/** @private */
+/** Call driver cleanup function for all drivers.
+ *  @private */
 SR_PRIV void sr_hw_cleanup_all(void)
 {
        int i;
@@ -495,8 +544,10 @@ SR_PRIV void sr_hw_cleanup_all(void)
        }
 }
 
-/** A floating reference can be passed in for data.
- * @private */
+/** Allocate struct sr_config.
+ *  A floating reference can be passed in for data.
+ *  @private
+ */
 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
 {
        struct sr_config *src;
@@ -509,7 +560,9 @@ SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
        return src;
 }
 
-/** @private */
+/** Free struct sr_config.
+ *  @private
+ */
 SR_PRIV void sr_config_free(struct sr_config *src)
 {
 
@@ -524,25 +577,26 @@ SR_PRIV void sr_config_free(struct sr_config *src)
 }
 
 /**
- * Returns information about the given driver or device instance.
+ * Query value of a configuration key at the given driver or device instance.
  *
- * @param driver The sr_dev_driver struct to query.
- * @param sdi (optional) If the key is specific to a device, this must
+ * @param[in] driver The sr_dev_driver struct to query.
+ * @param[in] sdi (optional) If the key is specific to a device, this must
  *            contain a pointer to the struct sr_dev_inst to be checked.
  *            Otherwise it must be NULL.
- * @param probe_group The probe group on the device for which to list the
+ * @param[in] probe_group The probe group on the device for which to list the
  *                    values, or NULL.
- * @param key The configuration key (SR_CONF_*).
- * @param data Pointer to a GVariant where the value will be stored. Must
- *             not be NULL. The caller is given ownership of the GVariant
+ * @param[in] key The configuration key (SR_CONF_*).
+ * @param[in,out] data Pointer to a GVariant where the value will be stored.
+ *             Must not be NULL. The caller is given ownership of the GVariant
  *             and must thus decrease the refcount after use. However if
  *             this function returns an error code, the field should be
  *             considered unused, and should not be unreferenced.
  *
- * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
- *         may be returned by the driver indicating it doesn't know that key,
- *         but this is not to be flagged as an error by the caller; merely
- *         as an indication that it's not applicable.
+ * @retval SR_OK Success.
+ * @retval SR_ERR Error.
+ * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
+ *          interpreted as an error by the caller; merely as an indication
+ *          that it's not applicable.
  */
 SR_API int sr_config_get(const struct sr_dev_driver *driver,
                const struct sr_dev_inst *sdi,
@@ -567,20 +621,21 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver,
 }
 
 /**
- * Set a configuration key in a device instance.
+ * Set value of a configuration key in a device instance.
  *
- * @param sdi The device instance.
- * @param probe_group The probe group on the device for which to list the
+ * @param[in] sdi The device instance.
+ * @param[in] probe_group The probe group on the device for which to list the
  *                    values, or NULL.
- * @param key The configuration key (SR_CONF_*).
+ * @param[in] key The configuration key (SR_CONF_*).
  * @param data The new value for the key, as a GVariant with GVariantType
  *        appropriate to that key. A floating reference can be passed
  *        in; its refcount will be sunk and unreferenced after use.
  *
- * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
- *         may be returned by the driver indicating it doesn't know that key,
- *         but this is not to be flagged as an error by the caller; merely
- *         as an indication that it's not applicable.
+ * @retval SR_OK Success.
+ * @retval SR_ERR Error.
+ * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
+ *          interpreted as an error by the caller; merely as an indication
+ *          that it's not applicable.
  */
 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
                const struct sr_probe_group *probe_group,
@@ -602,25 +657,47 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi,
        return ret;
 }
 
+/**
+ * Apply configuration settings to the device hardware.
+ *
+ * @param sdi The device instance.
+ *
+ * @return SR_OK upon success or SR_ERR in case of error.
+ */
+SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
+{
+       int ret;
+
+       if (!sdi || !sdi->driver)
+               ret = SR_ERR;
+       else if (!sdi->driver->config_commit)
+               ret = SR_OK;
+       else
+               ret = sdi->driver->config_commit(sdi);
+
+       return ret;
+}
+
 /**
  * List all possible values for a configuration key.
  *
- * @param driver The sr_dev_driver struct to query.
- * @param sdi (optional) If the key is specific to a device, this must
+ * @param[in] driver The sr_dev_driver struct to query.
+ * @param[in] sdi (optional) If the key is specific to a device, this must
  *            contain a pointer to the struct sr_dev_inst to be checked.
- * @param probe_group The probe group on the device for which to list the
+ * @param[in] probe_group The probe group on the device for which to list the
  *                    values, or NULL.
- * @param key The configuration key (SR_CONF_*).
- * @param data A pointer to a GVariant where the list will be stored. The
- *             caller is given ownership of the GVariant and must thus
+ * @param[in] key The configuration key (SR_CONF_*).
+ * @param[in,out] data A pointer to a GVariant where the list will be stored.
+ *             The caller is given ownership of the GVariant and must thus
  *             unref the GVariant after use. However if this function
  *             returns an error code, the field should be considered
  *             unused, and should not be unreferenced.
  *
- * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
- *         may be returned by the driver indicating it doesn't know that key,
- *         but this is not to be flagged as an error by the caller; merely
- *         as an indication that it's not applicable.
+ * @retval SR_OK Success.
+ * @retval SR_ERR Error.
+ * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
+ *          interpreted as an error by the caller; merely as an indication
+ *          that it's not applicable.
  */
 SR_API int sr_config_list(const struct sr_dev_driver *driver,
                const struct sr_dev_inst *sdi,
@@ -640,9 +717,9 @@ SR_API int sr_config_list(const struct sr_dev_driver *driver,
 }
 
 /**
- * Get information about a configuration key.
+ * Get information about a configuration key, by key.
  *
- * @param key The configuration key.
+ * @param[in] key The configuration key.
  *
  * @return A pointer to a struct sr_config_info, or NULL if the key
  *         was not found.
@@ -660,9 +737,9 @@ SR_API const struct sr_config_info *sr_config_info_get(int key)
 }
 
 /**
- * Get information about an configuration key, by name.
+ * Get information about a configuration key, by name.
  *
- * @param optname The configuration key.
+ * @param[in] optname The configuration key.
  *
  * @return A pointer to a struct sr_config_info, or NULL if the key
  *         was not found.
@@ -681,13 +758,17 @@ SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 
 /* Unnecessary level of indirection follows. */
 
-/** @private */
+/** @private
+ *  @see sr_session_source_remove()
+ */
 SR_PRIV int sr_source_remove(int fd)
 {
        return sr_session_source_remove(fd);
 }
 
-/** @private */
+/** @private
+ *  @see sr_session_source_add()
+ */
 SR_PRIV int sr_source_add(int fd, int events, int timeout,
                          sr_receive_data_callback_t cb, void *cb_data)
 {